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 EFI_STATUS
ReadFile(IN EFI_FILE_HANDLE BaseDir
, IN CHAR16
*FileName
, IN OUT REFIT_FILE
*File
, OUT UINTN
*size
)
73 EFI_FILE_HANDLE FileHandle
;
74 EFI_FILE_INFO
*FileInfo
;
81 // read the file, allocating a buffer on the way
82 Status
= refit_call5_wrapper(BaseDir
->Open
, BaseDir
, &FileHandle
, FileName
, EFI_FILE_MODE_READ
, 0);
83 SPrint(Message
, 255, L
"while loading the file '%s'", FileName
);
84 if (CheckError(Status
, Message
))
87 FileInfo
= LibFileInfo(FileHandle
);
88 if (FileInfo
== NULL
) {
89 // TODO: print and register the error
90 refit_call1_wrapper(FileHandle
->Close
, FileHandle
);
91 return EFI_LOAD_ERROR
;
93 ReadSize
= FileInfo
->FileSize
;
96 File
->BufferSize
= (UINTN
)ReadSize
;
97 File
->Buffer
= AllocatePool(File
->BufferSize
);
98 if (File
->Buffer
== NULL
) {
100 return EFI_OUT_OF_RESOURCES
;
102 *size
= File
->BufferSize
;
104 Status
= refit_call3_wrapper(FileHandle
->Read
, FileHandle
, &File
->BufferSize
, File
->Buffer
);
105 if (CheckError(Status
, Message
)) {
106 MyFreePool(File
->Buffer
);
108 refit_call1_wrapper(FileHandle
->Close
, FileHandle
);
111 Status
= refit_call1_wrapper(FileHandle
->Close
, FileHandle
);
114 File
->Current8Ptr
= (CHAR8
*)File
->Buffer
;
115 File
->End8Ptr
= File
->Current8Ptr
+ File
->BufferSize
;
116 File
->Current16Ptr
= (CHAR16
*)File
->Buffer
;
117 File
->End16Ptr
= File
->Current16Ptr
+ (File
->BufferSize
>> 1);
120 File
->Encoding
= ENCODING_ISO8859_1
; // default: 1:1 translation of CHAR8 to CHAR16
121 if (File
->BufferSize
>= 4) {
122 if (File
->Buffer
[0] == 0xFF && File
->Buffer
[1] == 0xFE) {
123 // BOM in UTF-16 little endian (or UTF-32 little endian)
124 File
->Encoding
= ENCODING_UTF16_LE
; // use CHAR16 as is
125 File
->Current16Ptr
++;
126 } else if (File
->Buffer
[0] == 0xEF && File
->Buffer
[1] == 0xBB && File
->Buffer
[2] == 0xBF) {
128 File
->Encoding
= ENCODING_UTF8
; // translate from UTF-8 to UTF-16
129 File
->Current8Ptr
+= 3;
130 } else if (File
->Buffer
[1] == 0 && File
->Buffer
[3] == 0) {
131 File
->Encoding
= ENCODING_UTF16_LE
; // use CHAR16 as is
133 // TODO: detect other encodings as they are implemented
140 // get a single line of text from a file
143 static CHAR16
*ReadLine(REFIT_FILE
*File
)
148 if (File
->Buffer
== NULL
)
151 if (File
->Encoding
== ENCODING_ISO8859_1
|| File
->Encoding
== ENCODING_UTF8
) {
153 CHAR8
*p
, *LineStart
, *LineEnd
;
155 p
= File
->Current8Ptr
;
156 if (p
>= File
->End8Ptr
)
160 for (; p
< File
->End8Ptr
; p
++)
161 if (*p
== 13 || *p
== 10)
164 for (; p
< File
->End8Ptr
; p
++)
165 if (*p
!= 13 && *p
!= 10)
167 File
->Current8Ptr
= p
;
169 LineLength
= (UINTN
)(LineEnd
- LineStart
) + 1;
170 Line
= AllocatePool(LineLength
* sizeof(CHAR16
));
175 if (File
->Encoding
== ENCODING_ISO8859_1
) {
176 for (p
= LineStart
; p
< LineEnd
; )
178 } else if (File
->Encoding
== ENCODING_UTF8
) {
179 // TODO: actually handle UTF-8
180 for (p
= LineStart
; p
< LineEnd
; )
185 } else if (File
->Encoding
== ENCODING_UTF16_LE
) {
187 CHAR16
*p
, *LineStart
, *LineEnd
;
189 p
= File
->Current16Ptr
;
190 if (p
>= File
->End16Ptr
)
194 for (; p
< File
->End16Ptr
; p
++)
195 if (*p
== 13 || *p
== 10)
198 for (; p
< File
->End16Ptr
; p
++)
199 if (*p
!= 13 && *p
!= 10)
201 File
->Current16Ptr
= p
;
203 LineLength
= (UINTN
)(LineEnd
- LineStart
) + 1;
204 Line
= AllocatePool(LineLength
* sizeof(CHAR16
));
208 for (p
= LineStart
, q
= Line
; p
< LineEnd
; )
213 return NULL
; // unsupported encoding
218 // Returns FALSE if *p points to the end of a token, TRUE otherwise.
219 // Also modifies *p **IF** the first and second characters are both
220 // quotes ('"'); it deletes one of them.
221 static BOOLEAN
KeepReading(IN OUT CHAR16
*p
, IN OUT BOOLEAN
*IsQuoted
) {
222 BOOLEAN MoreToRead
= FALSE
;
224 // while (*p && *p != '"' && ((*p != ' ' && *p != '\t' && *p != '=' && *p != '#' && *p != ',') || IsQuoted)) {
226 if ((p
== NULL
) || (IsQuoted
== NULL
))
232 if ((*p
!= ' ' && *p
!= '\t' && *p
!= '=' && *p
!= '#' && *p
!= ',') || *IsQuoted
) {
237 Temp
= StrDuplicate(&p
[1]);
244 *IsQuoted
= !(*IsQuoted
);
246 } // if/else second character is a quote
247 } // if first character is a quote
250 } // BOOLEAN KeepReading()
253 // get a line of tokens from a file
255 UINTN
ReadTokenLine(IN REFIT_FILE
*File
, OUT CHAR16
***TokenList
)
257 BOOLEAN LineFinished
, IsQuoted
= FALSE
;
258 CHAR16
*Line
, *Token
, *p
;
259 UINTN TokenCount
= 0;
263 while (TokenCount
== 0) {
264 Line
= ReadLine(File
);
269 LineFinished
= FALSE
;
270 while (!LineFinished
) {
271 // skip whitespace & find start of token
272 while ((*p
== ' ' || *p
== '\t' || *p
== '=' || *p
== ',') && !IsQuoted
)
274 if (*p
== 0 || *p
== '#')
278 IsQuoted
= !IsQuoted
;
284 while (KeepReading(p
, &IsQuoted
)) {
285 if ((*p
== L
'/') && !IsQuoted
) // Switch Unix-style to DOS-style directory separators
289 if (*p
== L
'\0' || *p
== L
'#')
293 AddListElement((VOID
***)TokenList
, &TokenCount
, (VOID
*)StrDuplicate(Token
));
299 } /* ReadTokenLine() */
301 VOID
FreeTokenLine(IN OUT CHAR16
***TokenList
, IN OUT UINTN
*TokenCount
)
303 // TODO: also free the items
304 FreeList((VOID
***)TokenList
, TokenCount
);
307 // handle a parameter with a single integer argument
308 static VOID
HandleInt(IN CHAR16
**TokenList
, IN UINTN TokenCount
, OUT UINTN
*Value
)
311 *Value
= Atoi(TokenList
[1]);
314 // handle a parameter with a single string argument
315 static VOID
HandleString(IN CHAR16
**TokenList
, IN UINTN TokenCount
, OUT CHAR16
**Target
) {
316 if (TokenCount
== 2) {
318 *Target
= StrDuplicate(TokenList
[1]);
320 } // static VOID HandleString()
322 // Handle a parameter with a series of string arguments, to be added to a comma-delimited
323 // list. Passes each token through the CleanUpPathNameSlashes() function to ensure
324 // consistency in subsequent comparisons of filenames.
325 static VOID
HandleStrings(IN CHAR16
**TokenList
, IN UINTN TokenCount
, OUT CHAR16
**Target
) {
328 if (*Target
!= NULL
) {
332 for (i
= 1; i
< TokenCount
; i
++) {
333 CleanUpPathNameSlashes(TokenList
[i
]);
334 MergeStrings(Target
, TokenList
[i
], L
',');
336 } // static VOID HandleStrings()
339 VOID
ReadConfig(VOID
)
347 if (!FileExists(SelfDir
, CONFIG_FILE_NAME
)) {
348 Print(L
"Configuration file missing!\n");
352 Status
= ReadFile(SelfDir
, CONFIG_FILE_NAME
, &File
, &i
);
353 if (EFI_ERROR(Status
))
356 MyFreePool(GlobalConfig
.DontScanDirs
);
357 GlobalConfig
.DontScanDirs
= StrDuplicate(SelfDirPath
);
358 MyFreePool(GlobalConfig
.DontScanFiles
);
359 GlobalConfig
.DontScanFiles
= StrDuplicate(DONT_SCAN_FILES
);
362 TokenCount
= ReadTokenLine(&File
, &TokenList
);
366 if (StriCmp(TokenList
[0], L
"timeout") == 0) {
367 HandleInt(TokenList
, TokenCount
, &(GlobalConfig
.Timeout
));
369 } else if (StriCmp(TokenList
[0], L
"hideui") == 0) {
370 for (i
= 1; i
< TokenCount
; i
++) {
371 FlagName
= TokenList
[i
];
372 if (StriCmp(FlagName
, L
"banner") == 0) {
373 GlobalConfig
.HideUIFlags
|= HIDEUI_FLAG_BANNER
;
374 } else if (StriCmp(FlagName
, L
"label") == 0) {
375 GlobalConfig
.HideUIFlags
|= HIDEUI_FLAG_LABEL
;
376 } else if (StriCmp(FlagName
, L
"singleuser") == 0) {
377 GlobalConfig
.HideUIFlags
|= HIDEUI_FLAG_SINGLEUSER
;
378 } else if (StriCmp(FlagName
, L
"hwtest") == 0) {
379 GlobalConfig
.HideUIFlags
|= HIDEUI_FLAG_HWTEST
;
380 } else if (StriCmp(FlagName
, L
"arrows") == 0) {
381 GlobalConfig
.HideUIFlags
|= HIDEUI_FLAG_ARROWS
;
382 } else if (StriCmp(FlagName
, L
"all") == 0) {
383 GlobalConfig
.HideUIFlags
= HIDEUI_ALL
;
385 Print(L
" unknown hideui flag: '%s'\n", FlagName
);
389 } else if (StriCmp(TokenList
[0], L
"icons_dir") == 0) {
390 HandleString(TokenList
, TokenCount
, &(GlobalConfig
.IconsDir
));
392 } else if (StriCmp(TokenList
[0], L
"scanfor") == 0) {
393 for (i
= 0; i
< NUM_SCAN_OPTIONS
; i
++) {
395 GlobalConfig
.ScanFor
[i
] = TokenList
[i
][0];
397 GlobalConfig
.ScanFor
[i
] = ' ';
400 } else if ((StriCmp(TokenList
[0], L
"scan_delay") == 0) && (TokenCount
== 2)) {
401 HandleInt(TokenList
, TokenCount
, &(GlobalConfig
.ScanDelay
));
403 } else if (StriCmp(TokenList
[0], L
"also_scan_dirs") == 0) {
404 HandleStrings(TokenList
, TokenCount
, &(GlobalConfig
.AlsoScan
));
406 } else if ((StriCmp(TokenList
[0], L
"don't_scan_dirs") == 0) || (StriCmp(TokenList
[0], L
"dont_scan_dirs") == 0)) {
407 HandleStrings(TokenList
, TokenCount
, &(GlobalConfig
.DontScanDirs
));
409 } else if ((StriCmp(TokenList
[0], L
"don't_scan_files") == 0) || (StriCmp(TokenList
[0], L
"dont_scan_files") == 0)) {
410 HandleStrings(TokenList
, TokenCount
, &(GlobalConfig
.DontScanFiles
));
412 } else if (StriCmp(TokenList
[0], L
"scan_driver_dirs") == 0) {
413 HandleStrings(TokenList
, TokenCount
, &(GlobalConfig
.DriverDirs
));
415 } else if (StriCmp(TokenList
[0], L
"showtools") == 0) {
416 SetMem(GlobalConfig
.ShowTools
, NUM_TOOLS
* sizeof(UINTN
), 0);
417 for (i
= 1; (i
< TokenCount
) && (i
< NUM_TOOLS
); i
++) {
418 FlagName
= TokenList
[i
];
419 if (StriCmp(FlagName
, L
"shell") == 0) {
420 GlobalConfig
.ShowTools
[i
- 1] = TAG_SHELL
;
421 } else if (StriCmp(FlagName
, L
"gptsync") == 0) {
422 GlobalConfig
.ShowTools
[i
- 1] = TAG_GPTSYNC
;
423 } else if (StriCmp(FlagName
, L
"about") == 0) {
424 GlobalConfig
.ShowTools
[i
- 1] = TAG_ABOUT
;
425 } else if (StriCmp(FlagName
, L
"exit") == 0) {
426 GlobalConfig
.ShowTools
[i
- 1] = TAG_EXIT
;
427 } else if (StriCmp(FlagName
, L
"reboot") == 0) {
428 GlobalConfig
.ShowTools
[i
- 1] = TAG_REBOOT
;
429 } else if (StriCmp(FlagName
, L
"shutdown") == 0) {
430 GlobalConfig
.ShowTools
[i
- 1] = TAG_SHUTDOWN
;
431 } else if (StriCmp(FlagName
, L
"apple_recovery") == 0) {
432 GlobalConfig
.ShowTools
[i
- 1] = TAG_APPLE_RECOVERY
;
433 } else if (StriCmp(FlagName
, L
"mok_tool") == 0) {
434 GlobalConfig
.ShowTools
[i
- 1] = TAG_MOK_TOOL
;
436 Print(L
" unknown showtools flag: '%s'\n", FlagName
);
438 } // showtools options
440 } else if (StriCmp(TokenList
[0], L
"banner") == 0) {
441 HandleString(TokenList
, TokenCount
, &(GlobalConfig
.BannerFileName
));
443 } else if (StriCmp(TokenList
[0], L
"selection_small") == 0) {
444 HandleString(TokenList
, TokenCount
, &(GlobalConfig
.SelectionSmallFileName
));
446 } else if (StriCmp(TokenList
[0], L
"selection_big") == 0) {
447 HandleString(TokenList
, TokenCount
, &(GlobalConfig
.SelectionBigFileName
));
449 } else if (StriCmp(TokenList
[0], L
"default_selection") == 0) {
450 HandleString(TokenList
, TokenCount
, &(GlobalConfig
.DefaultSelection
));
452 } else if (StriCmp(TokenList
[0], L
"textonly") == 0) {
453 GlobalConfig
.TextOnly
= TRUE
;
455 } else if ((StriCmp(TokenList
[0], L
"resolution") == 0) && (TokenCount
== 3)) {
456 GlobalConfig
.RequestedScreenWidth
= Atoi(TokenList
[1]);
457 GlobalConfig
.RequestedScreenHeight
= Atoi(TokenList
[2]);
459 } else if (StriCmp(TokenList
[0], L
"use_graphics_for") == 0) {
460 GlobalConfig
.GraphicsFor
= 0;
461 for (i
= 1; i
< TokenCount
; i
++) {
462 if (StriCmp(TokenList
[i
], L
"osx") == 0) {
463 GlobalConfig
.GraphicsFor
|= GRAPHICS_FOR_OSX
;
464 } else if (StriCmp(TokenList
[i
], L
"linux") == 0) {
465 GlobalConfig
.GraphicsFor
|= GRAPHICS_FOR_LINUX
;
466 } else if (StriCmp(TokenList
[i
], L
"elilo") == 0) {
467 GlobalConfig
.GraphicsFor
|= GRAPHICS_FOR_ELILO
;
468 } else if (StriCmp(TokenList
[i
], L
"grub") == 0) {
469 GlobalConfig
.GraphicsFor
|= GRAPHICS_FOR_GRUB
;
470 } else if (StriCmp(TokenList
[i
], L
"windows") == 0) {
471 GlobalConfig
.GraphicsFor
|= GRAPHICS_FOR_WINDOWS
;
473 } // for (graphics_on tokens)
475 } else if (StriCmp(TokenList
[0], L
"scan_all_linux_kernels") == 0) {
476 GlobalConfig
.ScanAllLinux
= TRUE
;
478 } else if (StriCmp(TokenList
[0], L
"max_tags") == 0) {
479 HandleInt(TokenList
, TokenCount
, &(GlobalConfig
.MaxTags
));
483 FreeTokenLine(&TokenList
, &TokenCount
);
485 MyFreePool(File
.Buffer
);
486 } /* VOID ReadConfig() */
488 // Finds a volume with the specified Identifier (a volume label or a number
489 // followed by a colon, for the moment). If found, sets *Volume to point to
490 // that volume. If not, leaves it unchanged.
491 // Returns TRUE if a match was found, FALSE if not.
492 static BOOLEAN
FindVolume(REFIT_VOLUME
**Volume
, CHAR16
*Identifier
) {
493 UINTN i
= 0, CountedVolumes
= 0;
495 BOOLEAN Found
= FALSE
;
497 if ((StrLen(Identifier
) >= 2) && (Identifier
[StrLen(Identifier
) - 1] == L
':') &&
498 (Identifier
[0] >= L
'0') && (Identifier
[0] <= L
'9')) {
499 Number
= (INTN
) Atoi(Identifier
);
501 while ((i
< VolumesCount
) && (!Found
)) {
502 if (Number
>= 0) { // User specified a volume by number
503 if (Volumes
[i
]->IsReadable
) {
504 if (CountedVolumes
== Number
) {
505 *Volume
= Volumes
[i
];
510 } else { // User specified a volume by label
511 if (StriCmp(Identifier
, Volumes
[i
]->VolName
) == 0) {
512 *Volume
= Volumes
[i
];
519 } // static VOID FindVolume()
521 static VOID
AddSubmenu(LOADER_ENTRY
*Entry
, REFIT_FILE
*File
, REFIT_VOLUME
*Volume
, CHAR16
*Title
) {
522 REFIT_MENU_SCREEN
*SubScreen
;
523 LOADER_ENTRY
*SubEntry
;
527 SubScreen
= InitializeSubScreen(Entry
);
529 // Set defaults for the new entry; will be modified based on lines read from the config. file....
530 SubEntry
= InitializeLoaderEntry(Entry
);
532 if ((SubEntry
== NULL
) || (SubScreen
== NULL
))
534 SubEntry
->me
.Title
= StrDuplicate(Title
);
536 while (((TokenCount
= ReadTokenLine(File
, &TokenList
)) > 0) && (StriCmp(TokenList
[0], L
"}") != 0)) {
538 if ((StriCmp(TokenList
[0], L
"loader") == 0) && (TokenCount
> 1)) { // set the boot loader filename
539 MyFreePool(SubEntry
->LoaderPath
);
540 SubEntry
->LoaderPath
= StrDuplicate(TokenList
[1]);
541 SubEntry
->DevicePath
= FileDevicePath(Volume
->DeviceHandle
, SubEntry
->LoaderPath
);
543 } else if ((StriCmp(TokenList
[0], L
"volume") == 0) && (TokenCount
> 1)) {
544 if (FindVolume(&Volume
, TokenList
[1])) {
545 MyFreePool(SubEntry
->me
.Title
);
546 SubEntry
->me
.Title
= AllocateZeroPool(256 * sizeof(CHAR16
));
547 SPrint(SubEntry
->me
.Title
, 255, L
"Boot %s from %s", (Title
!= NULL
) ? Title
: L
"Unknown", Volume
->VolName
);
548 SubEntry
->me
.BadgeImage
= Volume
->VolBadgeImage
;
549 SubEntry
->VolName
= Volume
->VolName
;
552 } else if (StriCmp(TokenList
[0], L
"initrd") == 0) {
553 MyFreePool(SubEntry
->InitrdPath
);
554 SubEntry
->InitrdPath
= NULL
;
555 if (TokenCount
> 1) {
556 SubEntry
->InitrdPath
= StrDuplicate(TokenList
[1]);
559 } else if (StriCmp(TokenList
[0], L
"options") == 0) {
560 MyFreePool(SubEntry
->LoadOptions
);
561 SubEntry
->LoadOptions
= NULL
;
562 if (TokenCount
> 1) {
563 SubEntry
->LoadOptions
= StrDuplicate(TokenList
[1]);
566 } else if ((StriCmp(TokenList
[0], L
"add_options") == 0) && (TokenCount
> 1)) {
567 MergeStrings(&SubEntry
->LoadOptions
, TokenList
[1], L
' ');
569 } else if ((StriCmp(TokenList
[0], L
"graphics") == 0) && (TokenCount
> 1)) {
570 SubEntry
->UseGraphicsMode
= (StriCmp(TokenList
[1], L
"on") == 0);
572 } else if (StriCmp(TokenList
[0], L
"disabled") == 0) {
573 SubEntry
->Enabled
= FALSE
;
576 FreeTokenLine(&TokenList
, &TokenCount
);
579 if (SubEntry
->InitrdPath
!= NULL
) {
580 MergeStrings(&SubEntry
->LoadOptions
, L
"initrd=", L
' ');
581 MergeStrings(&SubEntry
->LoadOptions
, SubEntry
->InitrdPath
, 0);
582 MyFreePool(SubEntry
->InitrdPath
);
583 SubEntry
->InitrdPath
= NULL
;
585 if (SubEntry
->Enabled
== TRUE
) {
586 AddMenuEntry(SubScreen
, (REFIT_MENU_ENTRY
*)SubEntry
);
588 Entry
->me
.SubScreen
= SubScreen
;
589 } // VOID AddSubmenu()
591 // Adds the options from a SINGLE refind.conf stanza to a new loader entry and returns
592 // that entry. The calling function is then responsible for adding the entry to the
594 static LOADER_ENTRY
* AddStanzaEntries(REFIT_FILE
*File
, REFIT_VOLUME
*Volume
, CHAR16
*Title
) {
598 BOOLEAN DefaultsSet
= FALSE
, AddedSubmenu
= FALSE
;
599 REFIT_VOLUME
*CurrentVolume
= Volume
;
601 // prepare the menu entry
602 Entry
= InitializeLoaderEntry(NULL
);
606 Entry
->Title
= StrDuplicate(Title
);
607 Entry
->me
.Title
= AllocateZeroPool(256 * sizeof(CHAR16
));
608 SPrint(Entry
->me
.Title
, 255, L
"Boot %s from %s", (Title
!= NULL
) ? Title
: L
"Unknown", CurrentVolume
->VolName
);
610 Entry
->me
.BadgeImage
= CurrentVolume
->VolBadgeImage
;
611 Entry
->VolName
= CurrentVolume
->VolName
;
613 // Parse the config file to add options for a single stanza, terminating when the token
614 // is "}" or when the end of file is reached.
615 while (((TokenCount
= ReadTokenLine(File
, &TokenList
)) > 0) && (StriCmp(TokenList
[0], L
"}") != 0)) {
616 if ((StriCmp(TokenList
[0], L
"loader") == 0) && (TokenCount
> 1)) { // set the boot loader filename
617 Entry
->LoaderPath
= StrDuplicate(TokenList
[1]);
618 Entry
->DevicePath
= FileDevicePath(CurrentVolume
->DeviceHandle
, Entry
->LoaderPath
);
619 SetLoaderDefaults(Entry
, TokenList
[1], CurrentVolume
);
620 MyFreePool(Entry
->LoadOptions
);
621 Entry
->LoadOptions
= NULL
; // Discard default options, if any
624 } else if ((StriCmp(TokenList
[0], L
"volume") == 0) && (TokenCount
> 1)) {
625 if (FindVolume(&CurrentVolume
, TokenList
[1])) {
626 MyFreePool(Entry
->me
.Title
);
627 Entry
->me
.Title
= AllocateZeroPool(256 * sizeof(CHAR16
));
628 SPrint(Entry
->me
.Title
, 255, L
"Boot %s from %s", (Title
!= NULL
) ? Title
: L
"Unknown", CurrentVolume
->VolName
);
629 Entry
->me
.BadgeImage
= CurrentVolume
->VolBadgeImage
;
630 Entry
->VolName
= CurrentVolume
->VolName
;
633 } else if ((StriCmp(TokenList
[0], L
"icon") == 0) && (TokenCount
> 1)) {
634 MyFreePool(Entry
->me
.Image
);
635 Entry
->me
.Image
= LoadIcns(CurrentVolume
->RootDir
, TokenList
[1], 128);
636 if (Entry
->me
.Image
== NULL
) {
637 Entry
->me
.Image
= DummyImage(128);
640 } else if ((StriCmp(TokenList
[0], L
"initrd") == 0) && (TokenCount
> 1)) {
641 MyFreePool(Entry
->InitrdPath
);
642 Entry
->InitrdPath
= StrDuplicate(TokenList
[1]);
644 } else if ((StriCmp(TokenList
[0], L
"options") == 0) && (TokenCount
> 1)) {
645 MyFreePool(Entry
->LoadOptions
);
646 Entry
->LoadOptions
= StrDuplicate(TokenList
[1]);
648 } else if ((StriCmp(TokenList
[0], L
"ostype") == 0) && (TokenCount
> 1)) {
649 if (TokenCount
> 1) {
650 Entry
->OSType
= TokenList
[1][0];
653 } else if ((StriCmp(TokenList
[0], L
"graphics") == 0) && (TokenCount
> 1)) {
654 Entry
->UseGraphicsMode
= (StriCmp(TokenList
[1], L
"on") == 0);
656 } else if (StriCmp(TokenList
[0], L
"disabled") == 0) {
657 Entry
->Enabled
= FALSE
;
659 } else if ((StriCmp(TokenList
[0], L
"submenuentry") == 0) && (TokenCount
> 1)) {
660 AddSubmenu(Entry
, File
, CurrentVolume
, TokenList
[1]);
663 } // set options to pass to the loader program
664 FreeTokenLine(&TokenList
, &TokenCount
);
668 AddMenuEntry(Entry
->me
.SubScreen
, &MenuEntryReturn
);
670 if (Entry
->InitrdPath
) {
671 MergeStrings(&Entry
->LoadOptions
, L
"initrd=", L
' ');
672 MergeStrings(&Entry
->LoadOptions
, Entry
->InitrdPath
, 0);
673 MyFreePool(Entry
->InitrdPath
);
674 Entry
->InitrdPath
= NULL
;
678 SetLoaderDefaults(Entry
, L
"\\EFI\\BOOT\\nemo.efi", CurrentVolume
); // user included no entry; use bogus one
681 } // static VOID AddStanzaEntries()
683 // Read the user-configured menu entries from refind.conf and add or delete
684 // entries based on the contents of that file....
685 VOID
ScanUserConfigured(VOID
)
689 REFIT_VOLUME
*Volume
;
691 CHAR16
*Title
= NULL
;
692 UINTN TokenCount
, size
;
694 // REFIT_MENU_SCREEN *SubScreen;
696 if (FileExists(SelfDir
, CONFIG_FILE_NAME
)) {
697 Status
= ReadFile(SelfDir
, CONFIG_FILE_NAME
, &File
, &size
);
698 if (EFI_ERROR(Status
))
703 while ((TokenCount
= ReadTokenLine(&File
, &TokenList
)) > 0) {
704 if ((StriCmp(TokenList
[0], L
"menuentry") == 0) && (TokenCount
> 1)) {
705 Title
= StrDuplicate(TokenList
[1]);
706 Entry
= AddStanzaEntries(&File
, Volume
, TokenList
[1]);
707 if (Entry
->Enabled
) {
708 if (Entry
->me
.SubScreen
== NULL
)
709 GenerateSubScreen(Entry
, Volume
);
710 AddPreparedLoaderEntry(Entry
);
716 FreeTokenLine(&TokenList
, &TokenCount
);
719 } // VOID ScanUserConfigured()
721 // Read a Linux kernel options file for a Linux boot loader into memory. The LoaderPath
722 // and Volume variables identify the location of the options file, but not its name --
723 // you pass this function the filename of the Linux kernel, initial RAM disk, or other
724 // file in the target directory, and this function finds the file with a name in the
725 // comma-delimited list of names specified by LINUX_OPTIONS_FILENAMES within that
726 // directory and loads it. This function tries multiple files because I originally
727 // used the filename linux.conf, but close on the heels of that decision, the Linux
728 // kernel developers decided to use that name for a similar purpose, but with a
729 // different file format. Thus, I'm migrating rEFInd to use the name refind_linux.conf,
730 // but I want a migration period in which both names are used.
732 // The return value is a pointer to the REFIT_FILE handle for the file, or NULL if
734 REFIT_FILE
* ReadLinuxOptionsFile(IN CHAR16
*LoaderPath
, IN REFIT_VOLUME
*Volume
) {
735 CHAR16
*OptionsFilename
, *FullFilename
;
738 REFIT_FILE
*File
= NULL
;
742 OptionsFilename
= FindCommaDelimited(LINUX_OPTIONS_FILENAMES
, i
++);
743 FullFilename
= FindPath(LoaderPath
);
744 if ((OptionsFilename
!= NULL
) && (FullFilename
!= NULL
)) {
745 MergeStrings(&FullFilename
, OptionsFilename
, '\\');
746 if (FileExists(Volume
->RootDir
, FullFilename
)) {
747 File
= AllocateZeroPool(sizeof(REFIT_FILE
));
748 Status
= ReadFile(Volume
->RootDir
, FullFilename
, File
, &size
);
750 if (CheckError(Status
, L
"while loading the Linux options file")) {
757 } else { // a filename string is NULL
760 MyFreePool(OptionsFilename
);
761 MyFreePool(FullFilename
);
762 OptionsFilename
= FullFilename
= NULL
;
765 } // static REFIT_FILE * ReadLinuxOptionsFile()
767 // Retrieve a single line of options from a Linux kernel options file
768 CHAR16
* GetFirstOptionsFromFile(IN CHAR16
*LoaderPath
, IN REFIT_VOLUME
*Volume
) {
770 CHAR16
*Options
= NULL
;
774 File
= ReadLinuxOptionsFile(LoaderPath
, Volume
);
776 TokenCount
= ReadTokenLine(File
, &TokenList
);
778 Options
= StrDuplicate(TokenList
[1]);
779 FreeTokenLine(&TokenList
, &TokenCount
);
783 } // static CHAR16 * GetOptionsFile()