3 * Configuration file functions
5 * Copyright (c) 2006 Christoph Pfisterer
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the
20 * * Neither the name of Christoph Pfisterer nor the names of the
21 * contributors may be used to endorse or promote products derived
22 * from this software without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 * Modifications copyright (c) 2012 Roderick W. Smith
40 * Modifications distributed under the terms of the GNU General Public
41 * License (GPL) version 3 (GPLv3), a copy of which must be distributed
42 * with this source code or binaries made from it.
52 #include "../include/refit_call_wrapper.h"
56 #define CONFIG_FILE_NAME L"refind.conf"
57 #define LINUX_OPTIONS_FILENAMES L"refind_linux.conf,refind-linux.conf"
58 #define MAXCONFIGFILESIZE (128*1024)
60 #define ENCODING_ISO8859_1 (0)
61 #define ENCODING_UTF8 (1)
62 #define ENCODING_UTF16_LE (2)
64 static REFIT_MENU_ENTRY MenuEntryReturn
= { L
"Return to Main Menu", TAG_RETURN
, 0, 0, 0, NULL
, NULL
, NULL
};
67 // read a file into a buffer
70 static EFI_STATUS
ReadFile(IN EFI_FILE_HANDLE BaseDir
, CHAR16
*FileName
, REFIT_FILE
*File
)
73 EFI_FILE_HANDLE FileHandle
;
74 EFI_FILE_INFO
*FileInfo
;
80 // read the file, allocating a buffer on the way
81 Status
= refit_call5_wrapper(BaseDir
->Open
, BaseDir
, &FileHandle
, FileName
, EFI_FILE_MODE_READ
, 0);
82 if (CheckError(Status
, L
"while loading the configuration file"))
85 FileInfo
= LibFileInfo(FileHandle
);
86 if (FileInfo
== NULL
) {
87 // TODO: print and register the error
88 refit_call1_wrapper(FileHandle
->Close
, FileHandle
);
89 return EFI_LOAD_ERROR
;
91 ReadSize
= FileInfo
->FileSize
;
92 if (ReadSize
> MAXCONFIGFILESIZE
)
93 ReadSize
= MAXCONFIGFILESIZE
;
96 File
->BufferSize
= (UINTN
)ReadSize
; // was limited to a few K before, so this is safe
97 File
->Buffer
= AllocatePool(File
->BufferSize
);
98 Status
= refit_call3_wrapper(FileHandle
->Read
, FileHandle
, &File
->BufferSize
, File
->Buffer
);
99 if (CheckError(Status
, L
"while loading the configuration file")) {
100 MyFreePool(File
->Buffer
);
102 refit_call1_wrapper(FileHandle
->Close
, FileHandle
);
105 Status
= refit_call1_wrapper(FileHandle
->Close
, FileHandle
);
108 File
->Current8Ptr
= (CHAR8
*)File
->Buffer
;
109 File
->End8Ptr
= File
->Current8Ptr
+ File
->BufferSize
;
110 File
->Current16Ptr
= (CHAR16
*)File
->Buffer
;
111 File
->End16Ptr
= File
->Current16Ptr
+ (File
->BufferSize
>> 1);
114 File
->Encoding
= ENCODING_ISO8859_1
; // default: 1:1 translation of CHAR8 to CHAR16
115 if (File
->BufferSize
>= 4) {
116 if (File
->Buffer
[0] == 0xFF && File
->Buffer
[1] == 0xFE) {
117 // BOM in UTF-16 little endian (or UTF-32 little endian)
118 File
->Encoding
= ENCODING_UTF16_LE
; // use CHAR16 as is
119 File
->Current16Ptr
++;
120 } else if (File
->Buffer
[0] == 0xEF && File
->Buffer
[1] == 0xBB && File
->Buffer
[2] == 0xBF) {
122 File
->Encoding
= ENCODING_UTF8
; // translate from UTF-8 to UTF-16
123 File
->Current8Ptr
+= 3;
124 } else if (File
->Buffer
[1] == 0 && File
->Buffer
[3] == 0) {
125 File
->Encoding
= ENCODING_UTF16_LE
; // use CHAR16 as is
127 // TODO: detect other encodings as they are implemented
134 // get a single line of text from a file
137 static CHAR16
*ReadLine(REFIT_FILE
*File
)
142 if (File
->Buffer
== NULL
)
145 if (File
->Encoding
== ENCODING_ISO8859_1
|| File
->Encoding
== ENCODING_UTF8
) {
147 CHAR8
*p
, *LineStart
, *LineEnd
;
149 p
= File
->Current8Ptr
;
150 if (p
>= File
->End8Ptr
)
154 for (; p
< File
->End8Ptr
; p
++)
155 if (*p
== 13 || *p
== 10)
158 for (; p
< File
->End8Ptr
; p
++)
159 if (*p
!= 13 && *p
!= 10)
161 File
->Current8Ptr
= p
;
163 LineLength
= (UINTN
)(LineEnd
- LineStart
) + 1;
164 Line
= AllocatePool(LineLength
* sizeof(CHAR16
));
169 if (File
->Encoding
== ENCODING_ISO8859_1
) {
170 for (p
= LineStart
; p
< LineEnd
; )
172 } else if (File
->Encoding
== ENCODING_UTF8
) {
173 // TODO: actually handle UTF-8
174 for (p
= LineStart
; p
< LineEnd
; )
179 } else if (File
->Encoding
== ENCODING_UTF16_LE
) {
181 CHAR16
*p
, *LineStart
, *LineEnd
;
183 p
= File
->Current16Ptr
;
184 if (p
>= File
->End16Ptr
)
188 for (; p
< File
->End16Ptr
; p
++)
189 if (*p
== 13 || *p
== 10)
192 for (; p
< File
->End16Ptr
; p
++)
193 if (*p
!= 13 && *p
!= 10)
195 File
->Current16Ptr
= p
;
197 LineLength
= (UINTN
)(LineEnd
- LineStart
) + 1;
198 Line
= AllocatePool(LineLength
* sizeof(CHAR16
));
202 for (p
= LineStart
, q
= Line
; p
< LineEnd
; )
207 return NULL
; // unsupported encoding
213 // get a line of tokens from a file
216 UINTN
ReadTokenLine(IN REFIT_FILE
*File
, OUT CHAR16
***TokenList
)
218 BOOLEAN LineFinished
, IsQuoted
= FALSE
;
219 CHAR16
*Line
, *Token
, *p
;
220 UINTN TokenCount
= 0;
224 while (TokenCount
== 0) {
225 Line
= ReadLine(File
);
230 LineFinished
= FALSE
;
231 while (!LineFinished
) {
233 while ((*p
== ' ' || *p
== '\t' || *p
== '=' || *p
== ',') && !IsQuoted
)
235 if (*p
== 0 || *p
== '#')
239 IsQuoted
= !IsQuoted
;
245 while (*p
&& *p
!= '"' && ((*p
!= ' ' && *p
!= '\t' && *p
!= '=' && *p
!= '#' && *p
!= ',') || IsQuoted
)) {
246 if ((*p
== '/') && !IsQuoted
) // Switch Unix-style to DOS-style directory separators
251 IsQuoted
= !IsQuoted
;
252 if (*p
== 0 || *p
== '#')
256 AddListElement((VOID
***)TokenList
, &TokenCount
, (VOID
*)StrDuplicate(Token
));
262 } /* ReadTokenLine() */
264 VOID
FreeTokenLine(IN OUT CHAR16
***TokenList
, IN OUT UINTN
*TokenCount
)
266 // TODO: also free the items
267 FreeList((VOID
***)TokenList
, TokenCount
);
270 // handle a parameter with a single integer argument
271 static VOID
HandleInt(IN CHAR16
**TokenList
, IN UINTN TokenCount
, OUT UINTN
*Value
)
274 *Value
= Atoi(TokenList
[1]);
277 // handle a parameter with a single string argument
278 static VOID
HandleString(IN CHAR16
**TokenList
, IN UINTN TokenCount
, OUT CHAR16
**Target
) {
279 if (TokenCount
== 2) {
281 *Target
= StrDuplicate(TokenList
[1]);
283 } // static VOID HandleString()
285 // Handle a parameter with a series of string arguments, to be added to a comma-delimited
286 // list. Passes each token through the CleanUpPathNameSlashes() function to ensure
287 // consistency in subsequent comparisons of filenames.
288 static VOID
HandleStrings(IN CHAR16
**TokenList
, IN UINTN TokenCount
, OUT CHAR16
**Target
) {
291 if (*Target
!= NULL
) {
295 for (i
= 1; i
< TokenCount
; i
++) {
296 CleanUpPathNameSlashes(TokenList
[i
]);
297 MergeStrings(Target
, TokenList
[i
], L
',');
299 } // static VOID HandleStrings()
302 VOID
ReadConfig(VOID
)
310 if (!FileExists(SelfDir
, CONFIG_FILE_NAME
)) {
311 Print(L
"Configuration file missing!\n");
315 Status
= ReadFile(SelfDir
, CONFIG_FILE_NAME
, &File
);
316 if (EFI_ERROR(Status
))
320 TokenCount
= ReadTokenLine(&File
, &TokenList
);
324 if (StriCmp(TokenList
[0], L
"timeout") == 0) {
325 HandleInt(TokenList
, TokenCount
, &(GlobalConfig
.Timeout
));
327 } else if (StriCmp(TokenList
[0], L
"hideui") == 0) {
328 for (i
= 1; i
< TokenCount
; i
++) {
329 FlagName
= TokenList
[i
];
330 if (StriCmp(FlagName
, L
"banner") == 0) {
331 GlobalConfig
.HideUIFlags
|= HIDEUI_FLAG_BANNER
;
332 } else if (StriCmp(FlagName
, L
"label") == 0) {
333 GlobalConfig
.HideUIFlags
|= HIDEUI_FLAG_LABEL
;
334 } else if (StriCmp(FlagName
, L
"singleuser") == 0) {
335 GlobalConfig
.HideUIFlags
|= HIDEUI_FLAG_SINGLEUSER
;
336 } else if (StriCmp(FlagName
, L
"hwtest") == 0) {
337 GlobalConfig
.HideUIFlags
|= HIDEUI_FLAG_HWTEST
;
338 } else if (StriCmp(FlagName
, L
"arrows") == 0) {
339 GlobalConfig
.HideUIFlags
|= HIDEUI_FLAG_ARROWS
;
340 } else if (StriCmp(FlagName
, L
"all") == 0) {
341 GlobalConfig
.HideUIFlags
= HIDEUI_ALL
;
343 Print(L
" unknown hideui flag: '%s'\n", FlagName
);
347 } else if (StriCmp(TokenList
[0], L
"icons_dir") == 0) {
348 HandleString(TokenList
, TokenCount
, &(GlobalConfig
.IconsDir
));
350 } else if (StriCmp(TokenList
[0], L
"scanfor") == 0) {
351 for (i
= 0; i
< NUM_SCAN_OPTIONS
; i
++) {
353 GlobalConfig
.ScanFor
[i
] = TokenList
[i
][0];
355 GlobalConfig
.ScanFor
[i
] = ' ';
358 } else if ((StriCmp(TokenList
[0], L
"scan_delay") == 0) && (TokenCount
== 2)) {
359 HandleInt(TokenList
, TokenCount
, &(GlobalConfig
.ScanDelay
));
361 } else if (StriCmp(TokenList
[0], L
"also_scan_dirs") == 0) {
362 HandleStrings(TokenList
, TokenCount
, &(GlobalConfig
.AlsoScan
));
364 } else if ((StriCmp(TokenList
[0], L
"don't_scan_dirs") == 0) || (StriCmp(TokenList
[0], L
"dont_scan_dirs") == 0)) {
365 HandleStrings(TokenList
, TokenCount
, &(GlobalConfig
.DontScan
));
367 } else if (StriCmp(TokenList
[0], L
"scan_driver_dirs") == 0) {
368 HandleStrings(TokenList
, TokenCount
, &(GlobalConfig
.DriverDirs
));
370 } else if (StriCmp(TokenList
[0], L
"showtools") == 0) {
371 SetMem(GlobalConfig
.ShowTools
, NUM_TOOLS
* sizeof(UINTN
), 0);
372 for (i
= 1; (i
< TokenCount
) && (i
< NUM_TOOLS
); i
++) {
373 FlagName
= TokenList
[i
];
374 if (StriCmp(FlagName
, L
"shell") == 0) {
375 GlobalConfig
.ShowTools
[i
- 1] = TAG_SHELL
;
376 } else if (StriCmp(FlagName
, L
"gptsync") == 0) {
377 GlobalConfig
.ShowTools
[i
- 1] = TAG_GPTSYNC
;
378 } else if (StriCmp(FlagName
, L
"about") == 0) {
379 GlobalConfig
.ShowTools
[i
- 1] = TAG_ABOUT
;
380 } else if (StriCmp(FlagName
, L
"exit") == 0) {
381 GlobalConfig
.ShowTools
[i
- 1] = TAG_EXIT
;
382 } else if (StriCmp(FlagName
, L
"reboot") == 0) {
383 GlobalConfig
.ShowTools
[i
- 1] = TAG_REBOOT
;
384 } else if (StriCmp(FlagName
, L
"shutdown") == 0) {
385 GlobalConfig
.ShowTools
[i
- 1] = TAG_SHUTDOWN
;
386 } else if (StriCmp(FlagName
, L
"apple_recovery") == 0) {
387 GlobalConfig
.ShowTools
[i
- 1] = TAG_APPLE_RECOVERY
;
389 Print(L
" unknown showtools flag: '%s'\n", FlagName
);
391 } // showtools options
393 } else if (StriCmp(TokenList
[0], L
"banner") == 0) {
394 HandleString(TokenList
, TokenCount
, &(GlobalConfig
.BannerFileName
));
396 } else if (StriCmp(TokenList
[0], L
"selection_small") == 0) {
397 HandleString(TokenList
, TokenCount
, &(GlobalConfig
.SelectionSmallFileName
));
399 } else if (StriCmp(TokenList
[0], L
"selection_big") == 0) {
400 HandleString(TokenList
, TokenCount
, &(GlobalConfig
.SelectionBigFileName
));
402 } else if (StriCmp(TokenList
[0], L
"default_selection") == 0) {
403 HandleString(TokenList
, TokenCount
, &(GlobalConfig
.DefaultSelection
));
405 } else if (StriCmp(TokenList
[0], L
"textonly") == 0) {
406 GlobalConfig
.TextOnly
= TRUE
;
408 } else if ((StriCmp(TokenList
[0], L
"resolution") == 0) && (TokenCount
== 3)) {
409 GlobalConfig
.RequestedScreenWidth
= Atoi(TokenList
[1]);
410 GlobalConfig
.RequestedScreenHeight
= Atoi(TokenList
[2]);
412 } else if (StriCmp(TokenList
[0], L
"use_graphics_for") == 0) {
413 GlobalConfig
.GraphicsFor
= 0;
414 for (i
= 1; i
< TokenCount
; i
++) {
415 if (StriCmp(TokenList
[i
], L
"osx") == 0) {
416 GlobalConfig
.GraphicsFor
|= GRAPHICS_FOR_OSX
;
417 } else if (StriCmp(TokenList
[i
], L
"linux") == 0) {
418 GlobalConfig
.GraphicsFor
|= GRAPHICS_FOR_LINUX
;
419 } else if (StriCmp(TokenList
[i
], L
"elilo") == 0) {
420 GlobalConfig
.GraphicsFor
|= GRAPHICS_FOR_ELILO
;
421 } else if (StriCmp(TokenList
[i
], L
"grub") == 0) {
422 GlobalConfig
.GraphicsFor
|= GRAPHICS_FOR_GRUB
;
423 } else if (StriCmp(TokenList
[i
], L
"windows") == 0) {
424 GlobalConfig
.GraphicsFor
|= GRAPHICS_FOR_WINDOWS
;
426 } // for (graphics_on tokens)
428 } else if (StriCmp(TokenList
[0], L
"scan_all_linux_kernels") == 0) {
429 GlobalConfig
.ScanAllLinux
= TRUE
;
431 } else if (StriCmp(TokenList
[0], L
"max_tags") == 0) {
432 HandleInt(TokenList
, TokenCount
, &(GlobalConfig
.MaxTags
));
436 FreeTokenLine(&TokenList
, &TokenCount
);
438 MyFreePool(File
.Buffer
);
439 } /* VOID ReadConfig() */
441 // Finds a volume with the specified Identifier (a volume label or a number
442 // followed by a colon, for the moment). If found, sets *Volume to point to
443 // that volume. If not, leaves it unchanged.
444 // Returns TRUE if a match was found, FALSE if not.
445 static BOOLEAN
FindVolume(REFIT_VOLUME
**Volume
, CHAR16
*Identifier
) {
446 UINTN i
= 0, CountedVolumes
= 0;
448 BOOLEAN Found
= FALSE
;
450 if ((StrLen(Identifier
) >= 2) && (Identifier
[StrLen(Identifier
) - 1] == L
':') &&
451 (Identifier
[0] >= L
'0') && (Identifier
[0] <= L
'9')) {
452 Number
= (INTN
) Atoi(Identifier
);
454 while ((i
< VolumesCount
) && (!Found
)) {
455 if (Number
>= 0) { // User specified a volume by number
456 if (Volumes
[i
]->IsReadable
) {
457 if (CountedVolumes
== Number
) {
458 *Volume
= Volumes
[i
];
463 } else { // User specified a volume by label
464 if (StriCmp(Identifier
, Volumes
[i
]->VolName
) == 0) {
465 *Volume
= Volumes
[i
];
472 } // static VOID FindVolume()
474 static VOID
AddSubmenu(LOADER_ENTRY
*Entry
, REFIT_FILE
*File
, REFIT_VOLUME
*Volume
, CHAR16
*Title
) {
475 REFIT_MENU_SCREEN
*SubScreen
;
476 LOADER_ENTRY
*SubEntry
;
480 SubScreen
= InitializeSubScreen(Entry
);
482 // Set defaults for the new entry; will be modified based on lines read from the config. file....
483 SubEntry
= InitializeLoaderEntry(Entry
);
485 if ((SubEntry
== NULL
) || (SubScreen
== NULL
))
487 SubEntry
->me
.Title
= StrDuplicate(Title
);
489 while (((TokenCount
= ReadTokenLine(File
, &TokenList
)) > 0) && (StriCmp(TokenList
[0], L
"}") != 0)) {
491 if ((StriCmp(TokenList
[0], L
"loader") == 0) && (TokenCount
> 1)) { // set the boot loader filename
492 MyFreePool(SubEntry
->LoaderPath
);
493 SubEntry
->LoaderPath
= StrDuplicate(TokenList
[1]);
494 SubEntry
->DevicePath
= FileDevicePath(Volume
->DeviceHandle
, SubEntry
->LoaderPath
);
496 } else if ((StriCmp(TokenList
[0], L
"volume") == 0) && (TokenCount
> 1)) {
497 if (FindVolume(&Volume
, TokenList
[1])) {
498 MyFreePool(SubEntry
->me
.Title
);
499 SubEntry
->me
.Title
= AllocateZeroPool(256 * sizeof(CHAR16
));
500 SPrint(SubEntry
->me
.Title
, 255, L
"Boot %s from %s", (Title
!= NULL
) ? Title
: L
"Unknown", Volume
->VolName
);
501 SubEntry
->me
.BadgeImage
= Volume
->VolBadgeImage
;
502 SubEntry
->VolName
= Volume
->VolName
;
505 } else if (StriCmp(TokenList
[0], L
"initrd") == 0) {
506 MyFreePool(SubEntry
->InitrdPath
);
507 SubEntry
->InitrdPath
= NULL
;
508 if (TokenCount
> 1) {
509 SubEntry
->InitrdPath
= StrDuplicate(TokenList
[1]);
512 } else if (StriCmp(TokenList
[0], L
"options") == 0) {
513 MyFreePool(SubEntry
->LoadOptions
);
514 SubEntry
->LoadOptions
= NULL
;
515 if (TokenCount
> 1) {
516 SubEntry
->LoadOptions
= StrDuplicate(TokenList
[1]);
519 } else if ((StriCmp(TokenList
[0], L
"add_options") == 0) && (TokenCount
> 1)) {
520 MergeStrings(&SubEntry
->LoadOptions
, TokenList
[1], L
' ');
522 } else if ((StriCmp(TokenList
[0], L
"graphics") == 0) && (TokenCount
> 1)) {
523 SubEntry
->UseGraphicsMode
= (StriCmp(TokenList
[1], L
"on") == 0);
525 } else if (StriCmp(TokenList
[0], L
"disabled") == 0) {
526 SubEntry
->Enabled
= FALSE
;
529 FreeTokenLine(&TokenList
, &TokenCount
);
532 if (SubEntry
->InitrdPath
!= NULL
) {
533 MergeStrings(&SubEntry
->LoadOptions
, L
"initrd=", L
' ');
534 MergeStrings(&SubEntry
->LoadOptions
, SubEntry
->InitrdPath
, 0);
535 MyFreePool(SubEntry
->InitrdPath
);
536 SubEntry
->InitrdPath
= NULL
;
538 if (SubEntry
->Enabled
== TRUE
) {
539 AddMenuEntry(SubScreen
, (REFIT_MENU_ENTRY
*)SubEntry
);
541 Entry
->me
.SubScreen
= SubScreen
;
542 } // VOID AddSubmenu()
544 // Adds the options from a SINGLE refind.conf stanza to a new loader entry and returns
545 // that entry. The calling function is then responsible for adding the entry to the
547 static LOADER_ENTRY
* AddStanzaEntries(REFIT_FILE
*File
, REFIT_VOLUME
*Volume
, CHAR16
*Title
) {
551 BOOLEAN DefaultsSet
= FALSE
, AddedSubmenu
= FALSE
;
552 REFIT_VOLUME
*CurrentVolume
= Volume
;
554 // prepare the menu entry
555 Entry
= InitializeLoaderEntry(NULL
);
559 Entry
->Title
= StrDuplicate(Title
);
560 Entry
->me
.Title
= AllocateZeroPool(256 * sizeof(CHAR16
));
561 SPrint(Entry
->me
.Title
, 255, L
"Boot %s from %s", (Title
!= NULL
) ? Title
: L
"Unknown", CurrentVolume
->VolName
);
563 Entry
->me
.BadgeImage
= CurrentVolume
->VolBadgeImage
;
564 Entry
->VolName
= CurrentVolume
->VolName
;
566 // Parse the config file to add options for a single stanza, terminating when the token
567 // is "}" or when the end of file is reached.
568 while (((TokenCount
= ReadTokenLine(File
, &TokenList
)) > 0) && (StriCmp(TokenList
[0], L
"}") != 0)) {
569 if ((StriCmp(TokenList
[0], L
"loader") == 0) && (TokenCount
> 1)) { // set the boot loader filename
570 Entry
->LoaderPath
= StrDuplicate(TokenList
[1]);
571 Entry
->DevicePath
= FileDevicePath(CurrentVolume
->DeviceHandle
, Entry
->LoaderPath
);
572 SetLoaderDefaults(Entry
, TokenList
[1], CurrentVolume
);
573 MyFreePool(Entry
->LoadOptions
);
574 Entry
->LoadOptions
= NULL
; // Discard default options, if any
577 } else if ((StriCmp(TokenList
[0], L
"volume") == 0) && (TokenCount
> 1)) {
578 if (FindVolume(&CurrentVolume
, TokenList
[1])) {
579 MyFreePool(Entry
->me
.Title
);
580 Entry
->me
.Title
= AllocateZeroPool(256 * sizeof(CHAR16
));
581 SPrint(Entry
->me
.Title
, 255, L
"Boot %s from %s", (Title
!= NULL
) ? Title
: L
"Unknown", CurrentVolume
->VolName
);
582 Entry
->me
.BadgeImage
= CurrentVolume
->VolBadgeImage
;
583 Entry
->VolName
= CurrentVolume
->VolName
;
586 } else if ((StriCmp(TokenList
[0], L
"icon") == 0) && (TokenCount
> 1)) {
587 MyFreePool(Entry
->me
.Image
);
588 Entry
->me
.Image
= LoadIcns(CurrentVolume
->RootDir
, TokenList
[1], 128);
589 if (Entry
->me
.Image
== NULL
) {
590 Entry
->me
.Image
= DummyImage(128);
593 } else if ((StriCmp(TokenList
[0], L
"initrd") == 0) && (TokenCount
> 1)) {
594 MyFreePool(Entry
->InitrdPath
);
595 Entry
->InitrdPath
= StrDuplicate(TokenList
[1]);
597 } else if ((StriCmp(TokenList
[0], L
"options") == 0) && (TokenCount
> 1)) {
598 MyFreePool(Entry
->LoadOptions
);
599 Entry
->LoadOptions
= StrDuplicate(TokenList
[1]);
601 } else if ((StriCmp(TokenList
[0], L
"ostype") == 0) && (TokenCount
> 1)) {
602 if (TokenCount
> 1) {
603 Entry
->OSType
= TokenList
[1][0];
606 } else if ((StriCmp(TokenList
[0], L
"graphics") == 0) && (TokenCount
> 1)) {
607 Entry
->UseGraphicsMode
= (StriCmp(TokenList
[1], L
"on") == 0);
609 } else if (StriCmp(TokenList
[0], L
"disabled") == 0) {
610 Entry
->Enabled
= FALSE
;
612 } else if ((StriCmp(TokenList
[0], L
"submenuentry") == 0) && (TokenCount
> 1)) {
613 AddSubmenu(Entry
, File
, CurrentVolume
, TokenList
[1]);
616 } // set options to pass to the loader program
617 FreeTokenLine(&TokenList
, &TokenCount
);
621 AddMenuEntry(Entry
->me
.SubScreen
, &MenuEntryReturn
);
623 if (Entry
->InitrdPath
) {
624 MergeStrings(&Entry
->LoadOptions
, L
"initrd=", L
' ');
625 MergeStrings(&Entry
->LoadOptions
, Entry
->InitrdPath
, 0);
626 MyFreePool(Entry
->InitrdPath
);
627 Entry
->InitrdPath
= NULL
;
631 SetLoaderDefaults(Entry
, L
"\\EFI\\BOOT\\nemo.efi", CurrentVolume
); // user included no entry; use bogus one
634 } // static VOID AddStanzaEntries()
636 // Read the user-configured loaders file, refind_loaders.conf, and add or delete
637 // entries based on the contents of that file....
638 VOID
ScanUserConfigured(VOID
)
642 REFIT_VOLUME
*Volume
;
644 CHAR16
*Title
= NULL
;
648 if (FileExists(SelfDir
, CONFIG_FILE_NAME
)) {
649 Status
= ReadFile(SelfDir
, CONFIG_FILE_NAME
, &File
);
650 if (EFI_ERROR(Status
))
655 while ((TokenCount
= ReadTokenLine(&File
, &TokenList
)) > 0) {
656 if ((StriCmp(TokenList
[0], L
"menuentry") == 0) && (TokenCount
> 1)) {
657 Title
= StrDuplicate(TokenList
[1]);
658 Entry
= AddStanzaEntries(&File
, Volume
, TokenList
[1]);
659 if (Entry
->Enabled
) {
660 if (Entry
->me
.SubScreen
== NULL
)
661 GenerateSubScreen(Entry
, Volume
);
662 AddPreparedLoaderEntry(Entry
);
668 FreeTokenLine(&TokenList
, &TokenCount
);
671 } // VOID ScanUserConfigured()
673 // Read a Linux kernel options file for a Linux boot loader into memory. The LoaderPath
674 // and Volume variables identify the location of the options file, but not its name --
675 // you pass this function the filename of the Linux kernel, initial RAM disk, or other
676 // file in the target directory, and this function finds the file with a name in the
677 // comma-delimited list of names specified by LINUX_OPTIONS_FILENAMES within that
678 // directory and loads it. This function tries multiple files because I originally
679 // used the filename linux.conf, but close on the heels of that decision, the Linux
680 // kernel developers decided to use that name for a similar purpose, but with a
681 // different file format. Thus, I'm migrating rEFInd to use the name refind_linux.conf,
682 // but I want a migration period in which both names are used.
684 // The return value is a pointer to the REFIT_FILE handle for the file, or NULL if
686 REFIT_FILE
* ReadLinuxOptionsFile(IN CHAR16
*LoaderPath
, IN REFIT_VOLUME
*Volume
) {
687 CHAR16
*OptionsFilename
, *FullFilename
;
690 REFIT_FILE
*File
= NULL
;
694 OptionsFilename
= FindCommaDelimited(LINUX_OPTIONS_FILENAMES
, i
++);
695 FullFilename
= FindPath(LoaderPath
);
696 if ((OptionsFilename
!= NULL
) && (FullFilename
!= NULL
)) {
697 MergeStrings(&FullFilename
, OptionsFilename
, '\\');
698 if (FileExists(Volume
->RootDir
, FullFilename
)) {
699 File
= AllocateZeroPool(sizeof(REFIT_FILE
));
700 Status
= ReadFile(Volume
->RootDir
, FullFilename
, File
);
702 if (CheckError(Status
, L
"while loading the Linux options file")) {
709 } else { // a filename string is NULL
712 MyFreePool(OptionsFilename
);
713 MyFreePool(FullFilename
);
714 OptionsFilename
= FullFilename
= NULL
;
717 } // static REFIT_FILE * ReadLinuxOptionsFile()
719 // Retrieve a single line of options from a Linux kernel options file
720 CHAR16
* GetFirstOptionsFromFile(IN CHAR16
*LoaderPath
, IN REFIT_VOLUME
*Volume
) {
722 CHAR16
*Options
= NULL
;
726 File
= ReadLinuxOptionsFile(LoaderPath
, Volume
);
728 TokenCount
= ReadTokenLine(File
, &TokenList
);
730 Options
= StrDuplicate(TokenList
[1]);
731 FreeTokenLine(&TokenList
, &TokenCount
);
735 } // static CHAR16 * GetOptionsFile()