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-2013 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 LINUX_OPTIONS_FILENAMES L"refind_linux.conf,refind-linux.conf"
57 #define MAXCONFIGFILESIZE (128*1024)
59 #define ENCODING_ISO8859_1 (0)
60 #define ENCODING_UTF8 (1)
61 #define ENCODING_UTF16_LE (2)
63 #define GetTime ST->RuntimeServices->GetTime
64 #define LAST_MINUTE 1439 /* Last minute of a day */
66 static REFIT_MENU_ENTRY MenuEntryReturn
= { L
"Return to Main Menu", TAG_RETURN
, 0, 0, 0, NULL
, NULL
, NULL
};
69 // read a file into a buffer
72 EFI_STATUS
ReadFile(IN EFI_FILE_HANDLE BaseDir
, IN CHAR16
*FileName
, IN OUT REFIT_FILE
*File
, OUT UINTN
*size
)
75 EFI_FILE_HANDLE FileHandle
;
76 EFI_FILE_INFO
*FileInfo
;
83 // read the file, allocating a buffer on the way
84 Status
= refit_call5_wrapper(BaseDir
->Open
, BaseDir
, &FileHandle
, FileName
, EFI_FILE_MODE_READ
, 0);
85 SPrint(Message
, 255, L
"while loading the file '%s'", FileName
);
86 if (CheckError(Status
, Message
))
89 FileInfo
= LibFileInfo(FileHandle
);
90 if (FileInfo
== NULL
) {
91 // TODO: print and register the error
92 refit_call1_wrapper(FileHandle
->Close
, FileHandle
);
93 return EFI_LOAD_ERROR
;
95 ReadSize
= FileInfo
->FileSize
;
98 File
->BufferSize
= (UINTN
)ReadSize
;
99 File
->Buffer
= AllocatePool(File
->BufferSize
);
100 if (File
->Buffer
== NULL
) {
102 return EFI_OUT_OF_RESOURCES
;
104 *size
= File
->BufferSize
;
106 Status
= refit_call3_wrapper(FileHandle
->Read
, FileHandle
, &File
->BufferSize
, File
->Buffer
);
107 if (CheckError(Status
, Message
)) {
108 MyFreePool(File
->Buffer
);
110 refit_call1_wrapper(FileHandle
->Close
, FileHandle
);
113 Status
= refit_call1_wrapper(FileHandle
->Close
, FileHandle
);
116 File
->Current8Ptr
= (CHAR8
*)File
->Buffer
;
117 File
->End8Ptr
= File
->Current8Ptr
+ File
->BufferSize
;
118 File
->Current16Ptr
= (CHAR16
*)File
->Buffer
;
119 File
->End16Ptr
= File
->Current16Ptr
+ (File
->BufferSize
>> 1);
122 File
->Encoding
= ENCODING_ISO8859_1
; // default: 1:1 translation of CHAR8 to CHAR16
123 if (File
->BufferSize
>= 4) {
124 if (File
->Buffer
[0] == 0xFF && File
->Buffer
[1] == 0xFE) {
125 // BOM in UTF-16 little endian (or UTF-32 little endian)
126 File
->Encoding
= ENCODING_UTF16_LE
; // use CHAR16 as is
127 File
->Current16Ptr
++;
128 } else if (File
->Buffer
[0] == 0xEF && File
->Buffer
[1] == 0xBB && File
->Buffer
[2] == 0xBF) {
130 File
->Encoding
= ENCODING_UTF8
; // translate from UTF-8 to UTF-16
131 File
->Current8Ptr
+= 3;
132 } else if (File
->Buffer
[1] == 0 && File
->Buffer
[3] == 0) {
133 File
->Encoding
= ENCODING_UTF16_LE
; // use CHAR16 as is
135 // TODO: detect other encodings as they are implemented
142 // get a single line of text from a file
145 static CHAR16
*ReadLine(REFIT_FILE
*File
)
150 if (File
->Buffer
== NULL
)
153 if (File
->Encoding
== ENCODING_ISO8859_1
|| File
->Encoding
== ENCODING_UTF8
) {
155 CHAR8
*p
, *LineStart
, *LineEnd
;
157 p
= File
->Current8Ptr
;
158 if (p
>= File
->End8Ptr
)
162 for (; p
< File
->End8Ptr
; p
++)
163 if (*p
== 13 || *p
== 10)
166 for (; p
< File
->End8Ptr
; p
++)
167 if (*p
!= 13 && *p
!= 10)
169 File
->Current8Ptr
= p
;
171 LineLength
= (UINTN
)(LineEnd
- LineStart
) + 1;
172 Line
= AllocatePool(LineLength
* sizeof(CHAR16
));
177 if (File
->Encoding
== ENCODING_ISO8859_1
) {
178 for (p
= LineStart
; p
< LineEnd
; )
180 } else if (File
->Encoding
== ENCODING_UTF8
) {
181 // TODO: actually handle UTF-8
182 for (p
= LineStart
; p
< LineEnd
; )
187 } else if (File
->Encoding
== ENCODING_UTF16_LE
) {
189 CHAR16
*p
, *LineStart
, *LineEnd
;
191 p
= File
->Current16Ptr
;
192 if (p
>= File
->End16Ptr
)
196 for (; p
< File
->End16Ptr
; p
++)
197 if (*p
== 13 || *p
== 10)
200 for (; p
< File
->End16Ptr
; p
++)
201 if (*p
!= 13 && *p
!= 10)
203 File
->Current16Ptr
= p
;
205 LineLength
= (UINTN
)(LineEnd
- LineStart
) + 1;
206 Line
= AllocatePool(LineLength
* sizeof(CHAR16
));
210 for (p
= LineStart
, q
= Line
; p
< LineEnd
; )
215 return NULL
; // unsupported encoding
220 // Returns FALSE if *p points to the end of a token, TRUE otherwise.
221 // Also modifies *p **IF** the first and second characters are both
222 // quotes ('"'); it deletes one of them.
223 static BOOLEAN
KeepReading(IN OUT CHAR16
*p
, IN OUT BOOLEAN
*IsQuoted
) {
224 BOOLEAN MoreToRead
= FALSE
;
227 if ((p
== NULL
) || (IsQuoted
== NULL
))
233 if ((*p
!= ' ' && *p
!= '\t' && *p
!= '=' && *p
!= '#' && *p
!= ',') || *IsQuoted
) {
238 Temp
= StrDuplicate(&p
[1]);
245 *IsQuoted
= !(*IsQuoted
);
247 } // if/else second character is a quote
248 } // if first character is a quote
251 } // BOOLEAN KeepReading()
254 // get a line of tokens from a file
256 UINTN
ReadTokenLine(IN REFIT_FILE
*File
, OUT CHAR16
***TokenList
)
258 BOOLEAN LineFinished
, IsQuoted
= FALSE
;
259 CHAR16
*Line
, *Token
, *p
;
260 UINTN TokenCount
= 0;
264 while (TokenCount
== 0) {
265 Line
= ReadLine(File
);
270 LineFinished
= FALSE
;
271 while (!LineFinished
) {
272 // skip whitespace & find start of token
273 while ((*p
== ' ' || *p
== '\t' || *p
== '=' || *p
== ',') && !IsQuoted
)
275 if (*p
== 0 || *p
== '#')
279 IsQuoted
= !IsQuoted
;
285 while (KeepReading(p
, &IsQuoted
)) {
286 if ((*p
== L
'/') && !IsQuoted
) // Switch Unix-style to DOS-style directory separators
290 if (*p
== L
'\0' || *p
== L
'#')
294 AddListElement((VOID
***)TokenList
, &TokenCount
, (VOID
*)StrDuplicate(Token
));
300 } /* ReadTokenLine() */
302 VOID
FreeTokenLine(IN OUT CHAR16
***TokenList
, IN OUT UINTN
*TokenCount
)
304 // TODO: also free the items
305 FreeList((VOID
***)TokenList
, TokenCount
);
308 // handle a parameter with a single integer argument
309 static VOID
HandleInt(IN CHAR16
**TokenList
, IN UINTN TokenCount
, OUT UINTN
*Value
)
311 if (TokenCount
== 2) {
312 if (StriCmp(TokenList
[1], L
"-1") == 0)
315 *Value
= Atoi(TokenList
[1]);
319 // handle a parameter with a single string argument
320 static VOID
HandleString(IN CHAR16
**TokenList
, IN UINTN TokenCount
, OUT CHAR16
**Target
) {
321 if (TokenCount
== 2) {
323 *Target
= StrDuplicate(TokenList
[1]);
325 } // static VOID HandleString()
327 // Handle a parameter with a series of string arguments, to be added to a comma-delimited
328 // list. Passes each token through the CleanUpPathNameSlashes() function to ensure
329 // consistency in subsequent comparisons of filenames.
330 static VOID
HandleStrings(IN CHAR16
**TokenList
, IN UINTN TokenCount
, OUT CHAR16
**Target
) {
333 if (*Target
!= NULL
) {
337 for (i
= 1; i
< TokenCount
; i
++) {
338 CleanUpPathNameSlashes(TokenList
[i
]);
339 MergeStrings(Target
, TokenList
[i
], L
',');
341 } // static VOID HandleStrings()
343 // Convert TimeString (in "HH:MM" format) to a pure-minute format. Values should be
344 // in the range from 0 (for 00:00, or midnight) to 1439 (for 23:59; aka LAST_MINUTE).
345 // Any value outside that range denotes an error in the specification. Note that if
346 // the input is a number that includes no colon, this function will return the original
347 // number in UINTN form.
348 static UINTN
HandleTime(IN CHAR16
*TimeString
) {
349 UINTN Hour
= 0, Minute
= 0, TimeLength
, i
= 0;
351 TimeLength
= StrLen(TimeString
);
352 while (i
< TimeLength
) {
353 if (TimeString
[i
] == L
':') {
357 if ((TimeString
[i
] >= L
'0') && (TimeString
[i
] <= '9')) {
359 Minute
+= (TimeString
[i
] - L
'0');
363 return (Hour
* 60 + Minute
);
364 } // BOOLEAN HandleTime()
366 // Sets the default boot loader IF the current time is within the bounds
367 // defined by the third and fourth tokens in the TokenList.
368 static VOID
SetDefaultByTime(IN CHAR16
**TokenList
, OUT CHAR16
**Default
) {
370 EFI_TIME CurrentTime
;
371 UINTN StartTime
= LAST_MINUTE
+ 1, EndTime
= LAST_MINUTE
+ 1, Now
;
372 BOOLEAN SetIt
= FALSE
;
374 StartTime
= HandleTime(TokenList
[2]);
375 EndTime
= HandleTime(TokenList
[3]);
377 if ((StartTime
<= LAST_MINUTE
) && (EndTime
<= LAST_MINUTE
)) {
378 Status
= refit_call2_wrapper(GetTime
, &CurrentTime
, NULL
);
379 if (Status
!= EFI_SUCCESS
)
381 Now
= CurrentTime
.Hour
* 60 + CurrentTime
.Minute
;
383 if (Now
> LAST_MINUTE
) { // Shouldn't happen; just being paranoid
384 Print(L
"Warning: Impossible system time: %d:%d\n", CurrentTime
.Hour
, CurrentTime
.Minute
);
386 } // if impossible time
388 if (StartTime
< EndTime
) { // Time range does NOT cross midnight
389 if ((Now
>= StartTime
) && (Now
<= EndTime
))
391 } else { // Time range DOES cross midnight
392 if ((Now
>= StartTime
) && (Now
<= EndTime
))
394 } // if/else time range crosses midnight
397 MyFreePool(*Default
);
398 *Default
= StrDuplicate(TokenList
[1]);
400 } // if ((StartTime <= LAST_MINUTE) && (EndTime <= LAST_MINUTE))
401 } // VOID SetDefaultByTime()
404 VOID
ReadConfig(CHAR16
*FileName
)
410 CHAR16
*TempStr
= NULL
;
413 // Set a few defaults only if we're loading the default file.
414 if (StriCmp(FileName
, GlobalConfig
.ConfigFilename
) == 0) {
415 MyFreePool(GlobalConfig
.AlsoScan
);
416 GlobalConfig
.AlsoScan
= StrDuplicate(ALSO_SCAN_DIRS
);
417 MyFreePool(GlobalConfig
.DontScanDirs
);
419 if (SelfVolume
->VolName
) {
420 TempStr
= SelfVolume
->VolName
? StrDuplicate(SelfVolume
->VolName
) : NULL
;
422 TempStr
= AllocateZeroPool(256 * sizeof(CHAR16
));
424 SPrint(TempStr
, 255, L
"fs%d", SelfVolume
->VolNumber
);
427 MergeStrings(&TempStr
, SelfDirPath
, L
':');
428 MergeStrings(&TempStr
, MEMTEST_LOCATIONS
, L
',');
429 GlobalConfig
.DontScanDirs
= TempStr
;
430 MyFreePool(GlobalConfig
.DontScanFiles
);
431 GlobalConfig
.DontScanFiles
= StrDuplicate(DONT_SCAN_FILES
);
432 MergeStrings(&(GlobalConfig
.DontScanFiles
), MOK_NAMES
, L
',');
433 MyFreePool(GlobalConfig
.DontScanVolumes
);
434 GlobalConfig
.DontScanVolumes
= StrDuplicate(DONT_SCAN_VOLUMES
);
437 if (!FileExists(SelfDir
, FileName
)) {
438 Print(L
"Configuration file '%s' missing!\n", FileName
);
442 Status
= ReadFile(SelfDir
, FileName
, &File
, &i
);
443 if (EFI_ERROR(Status
))
447 TokenCount
= ReadTokenLine(&File
, &TokenList
);
451 if (StriCmp(TokenList
[0], L
"timeout") == 0) {
452 HandleInt(TokenList
, TokenCount
, &(GlobalConfig
.Timeout
));
454 } else if (StriCmp(TokenList
[0], L
"hideui") == 0) {
455 for (i
= 1; i
< TokenCount
; i
++) {
456 FlagName
= TokenList
[i
];
457 if (StriCmp(FlagName
, L
"banner") == 0) {
458 GlobalConfig
.HideUIFlags
|= HIDEUI_FLAG_BANNER
;
459 } else if (StriCmp(FlagName
, L
"label") == 0) {
460 GlobalConfig
.HideUIFlags
|= HIDEUI_FLAG_LABEL
;
461 } else if (StriCmp(FlagName
, L
"singleuser") == 0) {
462 GlobalConfig
.HideUIFlags
|= HIDEUI_FLAG_SINGLEUSER
;
463 } else if (StriCmp(FlagName
, L
"hwtest") == 0) {
464 GlobalConfig
.HideUIFlags
|= HIDEUI_FLAG_HWTEST
;
465 } else if (StriCmp(FlagName
, L
"arrows") == 0) {
466 GlobalConfig
.HideUIFlags
|= HIDEUI_FLAG_ARROWS
;
467 } else if (StriCmp(FlagName
, L
"hints") == 0) {
468 GlobalConfig
.HideUIFlags
|= HIDEUI_FLAG_HINTS
;
469 } else if (StriCmp(FlagName
, L
"editor") == 0) {
470 GlobalConfig
.HideUIFlags
|= HIDEUI_FLAG_EDITOR
;
471 } else if (StriCmp(FlagName
, L
"safemode") == 0) {
472 GlobalConfig
.HideUIFlags
|= HIDEUI_FLAG_SAFEMODE
;
473 } else if (StriCmp(FlagName
, L
"all") == 0) {
474 GlobalConfig
.HideUIFlags
= HIDEUI_FLAG_ALL
;
476 Print(L
" unknown hideui flag: '%s'\n", FlagName
);
480 } else if (StriCmp(TokenList
[0], L
"icons_dir") == 0) {
481 HandleString(TokenList
, TokenCount
, &(GlobalConfig
.IconsDir
));
483 } else if (StriCmp(TokenList
[0], L
"scanfor") == 0) {
484 for (i
= 0; i
< NUM_SCAN_OPTIONS
; i
++) {
486 GlobalConfig
.ScanFor
[i
] = TokenList
[i
][0];
488 GlobalConfig
.ScanFor
[i
] = ' ';
491 } else if ((StriCmp(TokenList
[0], L
"scan_delay") == 0) && (TokenCount
== 2)) {
492 HandleInt(TokenList
, TokenCount
, &(GlobalConfig
.ScanDelay
));
494 } else if (StriCmp(TokenList
[0], L
"also_scan_dirs") == 0) {
495 HandleStrings(TokenList
, TokenCount
, &(GlobalConfig
.AlsoScan
));
497 } else if ((StriCmp(TokenList
[0], L
"don't_scan_volumes") == 0) || (StriCmp(TokenList
[0], L
"dont_scan_volumes") == 0)) {
498 // Note: Don't use HandleStrings() because it modifies slashes, which might be present in volume name
499 MyFreePool(GlobalConfig
.DontScanVolumes
);
500 GlobalConfig
.DontScanVolumes
= NULL
;
501 for (i
= 1; i
< TokenCount
; i
++) {
502 MergeStrings(&GlobalConfig
.DontScanVolumes
, TokenList
[i
], L
',');
505 } else if ((StriCmp(TokenList
[0], L
"don't_scan_dirs") == 0) || (StriCmp(TokenList
[0], L
"dont_scan_dirs") == 0)) {
506 HandleStrings(TokenList
, TokenCount
, &(GlobalConfig
.DontScanDirs
));
508 } else if ((StriCmp(TokenList
[0], L
"don't_scan_files") == 0) || (StriCmp(TokenList
[0], L
"dont_scan_files") == 0)) {
509 HandleStrings(TokenList
, TokenCount
, &(GlobalConfig
.DontScanFiles
));
511 } else if (StriCmp(TokenList
[0], L
"scan_driver_dirs") == 0) {
512 HandleStrings(TokenList
, TokenCount
, &(GlobalConfig
.DriverDirs
));
514 } else if (StriCmp(TokenList
[0], L
"showtools") == 0) {
515 SetMem(GlobalConfig
.ShowTools
, NUM_TOOLS
* sizeof(UINTN
), 0);
516 for (i
= 1; (i
< TokenCount
) && (i
< NUM_TOOLS
); i
++) {
517 FlagName
= TokenList
[i
];
518 if (StriCmp(FlagName
, L
"shell") == 0) {
519 GlobalConfig
.ShowTools
[i
- 1] = TAG_SHELL
;
520 } else if (StriCmp(FlagName
, L
"gptsync") == 0) {
521 GlobalConfig
.ShowTools
[i
- 1] = TAG_GPTSYNC
;
522 } else if (StriCmp(FlagName
, L
"about") == 0) {
523 GlobalConfig
.ShowTools
[i
- 1] = TAG_ABOUT
;
524 } else if (StriCmp(FlagName
, L
"exit") == 0) {
525 GlobalConfig
.ShowTools
[i
- 1] = TAG_EXIT
;
526 } else if (StriCmp(FlagName
, L
"reboot") == 0) {
527 GlobalConfig
.ShowTools
[i
- 1] = TAG_REBOOT
;
528 } else if (StriCmp(FlagName
, L
"shutdown") == 0) {
529 GlobalConfig
.ShowTools
[i
- 1] = TAG_SHUTDOWN
;
530 } else if (StriCmp(FlagName
, L
"apple_recovery") == 0) {
531 GlobalConfig
.ShowTools
[i
- 1] = TAG_APPLE_RECOVERY
;
532 } else if (StriCmp(FlagName
, L
"mok_tool") == 0) {
533 GlobalConfig
.ShowTools
[i
- 1] = TAG_MOK_TOOL
;
534 } else if (StriCmp(FlagName
, L
"firmware") == 0) {
535 GlobalConfig
.ShowTools
[i
- 1] = TAG_FIRMWARE
;
536 } else if ((StriCmp(FlagName
, L
"memtest86") == 0) || (StriCmp(FlagName
, L
"memtest") == 0)) {
537 GlobalConfig
.ShowTools
[i
- 1] = TAG_MEMTEST
;
539 Print(L
" unknown showtools flag: '%s'\n", FlagName
);
541 } // showtools options
543 } else if (StriCmp(TokenList
[0], L
"banner") == 0) {
544 HandleString(TokenList
, TokenCount
, &(GlobalConfig
.BannerFileName
));
546 } else if (StriCmp(TokenList
[0], L
"selection_small") == 0) {
547 HandleString(TokenList
, TokenCount
, &(GlobalConfig
.SelectionSmallFileName
));
549 } else if (StriCmp(TokenList
[0], L
"selection_big") == 0) {
550 HandleString(TokenList
, TokenCount
, &(GlobalConfig
.SelectionBigFileName
));
552 } else if (StriCmp(TokenList
[0], L
"default_selection") == 0) {
553 if (TokenCount
== 4) {
554 SetDefaultByTime(TokenList
, &(GlobalConfig
.DefaultSelection
));
556 HandleString(TokenList
, TokenCount
, &(GlobalConfig
.DefaultSelection
));
559 } else if (StriCmp(TokenList
[0], L
"textonly") == 0) {
560 if ((TokenCount
>= 2) && (StriCmp(TokenList
[1], L
"0") == 0)) {
561 GlobalConfig
.TextOnly
= FALSE
;
563 GlobalConfig
.TextOnly
= TRUE
;
566 } else if (StriCmp(TokenList
[0], L
"textmode") == 0) {
567 HandleInt(TokenList
, TokenCount
, &(GlobalConfig
.RequestedTextMode
));
569 } else if ((StriCmp(TokenList
[0], L
"resolution") == 0) && ((TokenCount
== 2) || (TokenCount
== 3))) {
570 GlobalConfig
.RequestedScreenWidth
= Atoi(TokenList
[1]);
572 GlobalConfig
.RequestedScreenHeight
= Atoi(TokenList
[2]);
574 GlobalConfig
.RequestedScreenHeight
= 0;
576 } else if (StriCmp(TokenList
[0], L
"screensaver") == 0) {
577 HandleInt(TokenList
, TokenCount
, &(GlobalConfig
.ScreensaverTime
));
579 } else if (StriCmp(TokenList
[0], L
"use_graphics_for") == 0) {
580 GlobalConfig
.GraphicsFor
= 0;
581 for (i
= 1; i
< TokenCount
; i
++) {
582 if (StriCmp(TokenList
[i
], L
"osx") == 0) {
583 GlobalConfig
.GraphicsFor
|= GRAPHICS_FOR_OSX
;
584 } else if (StriCmp(TokenList
[i
], L
"linux") == 0) {
585 GlobalConfig
.GraphicsFor
|= GRAPHICS_FOR_LINUX
;
586 } else if (StriCmp(TokenList
[i
], L
"elilo") == 0) {
587 GlobalConfig
.GraphicsFor
|= GRAPHICS_FOR_ELILO
;
588 } else if (StriCmp(TokenList
[i
], L
"grub") == 0) {
589 GlobalConfig
.GraphicsFor
|= GRAPHICS_FOR_GRUB
;
590 } else if (StriCmp(TokenList
[i
], L
"windows") == 0) {
591 GlobalConfig
.GraphicsFor
|= GRAPHICS_FOR_WINDOWS
;
593 } // for (graphics_on tokens)
595 } else if ((StriCmp(TokenList
[0], L
"font") == 0) && (TokenCount
== 2)) {
596 egLoadFont(TokenList
[1]);
598 } else if (StriCmp(TokenList
[0], L
"scan_all_linux_kernels") == 0) {
599 if ((TokenCount
>= 2) && (StriCmp(TokenList
[1], L
"0") == 0)) {
600 GlobalConfig
.ScanAllLinux
= FALSE
;
602 GlobalConfig
.ScanAllLinux
= TRUE
;
605 } else if (StriCmp(TokenList
[0], L
"max_tags") == 0) {
606 HandleInt(TokenList
, TokenCount
, &(GlobalConfig
.MaxTags
));
608 } else if ((StriCmp(TokenList
[0], L
"include") == 0) && (TokenCount
== 2) &&
609 (StriCmp(FileName
, GlobalConfig
.ConfigFilename
) == 0)) {
610 if (StriCmp(TokenList
[1], FileName
) != 0) {
611 ReadConfig(TokenList
[1]);
616 FreeTokenLine(&TokenList
, &TokenCount
);
618 MyFreePool(File
.Buffer
);
619 } /* VOID ReadConfig() */
621 // Finds a volume with the specified Identifier (a volume label or a number
622 // followed by a colon, for the moment). If found, sets *Volume to point to
623 // that volume. If not, leaves it unchanged.
624 // Returns TRUE if a match was found, FALSE if not.
625 static BOOLEAN
FindVolume(REFIT_VOLUME
**Volume
, CHAR16
*Identifier
) {
626 UINTN i
= 0, CountedVolumes
= 0;
628 BOOLEAN Found
= FALSE
;
630 if ((StrLen(Identifier
) >= 2) && (Identifier
[StrLen(Identifier
) - 1] == L
':') &&
631 (Identifier
[0] >= L
'0') && (Identifier
[0] <= L
'9')) {
632 Number
= (INTN
) Atoi(Identifier
);
634 while ((i
< VolumesCount
) && (!Found
)) {
635 if (Number
>= 0) { // User specified a volume by number
636 if (Volumes
[i
]->IsReadable
) {
637 if (CountedVolumes
== Number
) {
638 *Volume
= Volumes
[i
];
643 } else { // User specified a volume by label
644 if (StriCmp(Identifier
, Volumes
[i
]->VolName
) == 0) {
645 *Volume
= Volumes
[i
];
652 } // static VOID FindVolume()
654 static VOID
AddSubmenu(LOADER_ENTRY
*Entry
, REFIT_FILE
*File
, REFIT_VOLUME
*Volume
, CHAR16
*Title
) {
655 REFIT_MENU_SCREEN
*SubScreen
;
656 LOADER_ENTRY
*SubEntry
;
660 SubScreen
= InitializeSubScreen(Entry
);
662 // Set defaults for the new entry; will be modified based on lines read from the config. file....
663 SubEntry
= InitializeLoaderEntry(Entry
);
665 if ((SubEntry
== NULL
) || (SubScreen
== NULL
))
667 SubEntry
->me
.Title
= StrDuplicate(Title
);
669 while (((TokenCount
= ReadTokenLine(File
, &TokenList
)) > 0) && (StriCmp(TokenList
[0], L
"}") != 0)) {
671 if ((StriCmp(TokenList
[0], L
"loader") == 0) && (TokenCount
> 1)) { // set the boot loader filename
672 MyFreePool(SubEntry
->LoaderPath
);
673 SubEntry
->LoaderPath
= StrDuplicate(TokenList
[1]);
674 SubEntry
->DevicePath
= FileDevicePath(Volume
->DeviceHandle
, SubEntry
->LoaderPath
);
676 } else if ((StriCmp(TokenList
[0], L
"volume") == 0) && (TokenCount
> 1)) {
677 if (FindVolume(&Volume
, TokenList
[1])) {
678 MyFreePool(SubEntry
->me
.Title
);
679 SubEntry
->me
.Title
= AllocateZeroPool(256 * sizeof(CHAR16
));
680 SPrint(SubEntry
->me
.Title
, 255, L
"Boot %s from %s", (Title
!= NULL
) ? Title
: L
"Unknown", Volume
->VolName
);
681 SubEntry
->me
.BadgeImage
= Volume
->VolBadgeImage
;
682 SubEntry
->VolName
= Volume
->VolName
;
685 } else if (StriCmp(TokenList
[0], L
"initrd") == 0) {
686 MyFreePool(SubEntry
->InitrdPath
);
687 SubEntry
->InitrdPath
= NULL
;
688 if (TokenCount
> 1) {
689 SubEntry
->InitrdPath
= StrDuplicate(TokenList
[1]);
692 } else if (StriCmp(TokenList
[0], L
"options") == 0) {
693 MyFreePool(SubEntry
->LoadOptions
);
694 SubEntry
->LoadOptions
= NULL
;
695 if (TokenCount
> 1) {
696 SubEntry
->LoadOptions
= StrDuplicate(TokenList
[1]);
699 } else if ((StriCmp(TokenList
[0], L
"add_options") == 0) && (TokenCount
> 1)) {
700 MergeStrings(&SubEntry
->LoadOptions
, TokenList
[1], L
' ');
702 } else if ((StriCmp(TokenList
[0], L
"graphics") == 0) && (TokenCount
> 1)) {
703 SubEntry
->UseGraphicsMode
= (StriCmp(TokenList
[1], L
"on") == 0);
705 } else if (StriCmp(TokenList
[0], L
"disabled") == 0) {
706 SubEntry
->Enabled
= FALSE
;
709 FreeTokenLine(&TokenList
, &TokenCount
);
712 if (SubEntry
->InitrdPath
!= NULL
) {
713 MergeStrings(&SubEntry
->LoadOptions
, L
"initrd=", L
' ');
714 MergeStrings(&SubEntry
->LoadOptions
, SubEntry
->InitrdPath
, 0);
715 MyFreePool(SubEntry
->InitrdPath
);
716 SubEntry
->InitrdPath
= NULL
;
718 if (SubEntry
->Enabled
== TRUE
) {
719 AddMenuEntry(SubScreen
, (REFIT_MENU_ENTRY
*)SubEntry
);
721 Entry
->me
.SubScreen
= SubScreen
;
722 } // VOID AddSubmenu()
724 // Adds the options from a SINGLE refind.conf stanza to a new loader entry and returns
725 // that entry. The calling function is then responsible for adding the entry to the
727 static LOADER_ENTRY
* AddStanzaEntries(REFIT_FILE
*File
, REFIT_VOLUME
*Volume
, CHAR16
*Title
) {
731 BOOLEAN DefaultsSet
= FALSE
, AddedSubmenu
= FALSE
;
732 REFIT_VOLUME
*CurrentVolume
= Volume
;
734 // prepare the menu entry
735 Entry
= InitializeLoaderEntry(NULL
);
739 Entry
->Title
= StrDuplicate(Title
);
740 Entry
->me
.Title
= AllocateZeroPool(256 * sizeof(CHAR16
));
741 SPrint(Entry
->me
.Title
, 255, L
"Boot %s from %s", (Title
!= NULL
) ? Title
: L
"Unknown", CurrentVolume
->VolName
);
743 Entry
->me
.BadgeImage
= CurrentVolume
->VolBadgeImage
;
744 Entry
->VolName
= CurrentVolume
->VolName
;
746 // Parse the config file to add options for a single stanza, terminating when the token
747 // is "}" or when the end of file is reached.
748 while (((TokenCount
= ReadTokenLine(File
, &TokenList
)) > 0) && (StriCmp(TokenList
[0], L
"}") != 0)) {
749 if ((StriCmp(TokenList
[0], L
"loader") == 0) && (TokenCount
> 1)) { // set the boot loader filename
750 Entry
->LoaderPath
= StrDuplicate(TokenList
[1]);
751 Entry
->DevicePath
= FileDevicePath(CurrentVolume
->DeviceHandle
, Entry
->LoaderPath
);
752 SetLoaderDefaults(Entry
, TokenList
[1], CurrentVolume
);
753 MyFreePool(Entry
->LoadOptions
);
754 Entry
->LoadOptions
= NULL
; // Discard default options, if any
757 } else if ((StriCmp(TokenList
[0], L
"volume") == 0) && (TokenCount
> 1)) {
758 if (FindVolume(&CurrentVolume
, TokenList
[1])) {
759 MyFreePool(Entry
->me
.Title
);
760 Entry
->me
.Title
= AllocateZeroPool(256 * sizeof(CHAR16
));
761 SPrint(Entry
->me
.Title
, 255, L
"Boot %s from %s", (Title
!= NULL
) ? Title
: L
"Unknown", CurrentVolume
->VolName
);
762 Entry
->me
.BadgeImage
= CurrentVolume
->VolBadgeImage
;
763 Entry
->VolName
= CurrentVolume
->VolName
;
766 } else if ((StriCmp(TokenList
[0], L
"icon") == 0) && (TokenCount
> 1)) {
767 MyFreePool(Entry
->me
.Image
);
768 Entry
->me
.Image
= egLoadIcon(CurrentVolume
->RootDir
, TokenList
[1], 128);
769 if (Entry
->me
.Image
== NULL
) {
770 Entry
->me
.Image
= DummyImage(128);
773 } else if ((StriCmp(TokenList
[0], L
"initrd") == 0) && (TokenCount
> 1)) {
774 MyFreePool(Entry
->InitrdPath
);
775 Entry
->InitrdPath
= StrDuplicate(TokenList
[1]);
777 } else if ((StriCmp(TokenList
[0], L
"options") == 0) && (TokenCount
> 1)) {
778 MyFreePool(Entry
->LoadOptions
);
779 Entry
->LoadOptions
= StrDuplicate(TokenList
[1]);
781 } else if ((StriCmp(TokenList
[0], L
"ostype") == 0) && (TokenCount
> 1)) {
782 if (TokenCount
> 1) {
783 Entry
->OSType
= TokenList
[1][0];
786 } else if ((StriCmp(TokenList
[0], L
"graphics") == 0) && (TokenCount
> 1)) {
787 Entry
->UseGraphicsMode
= (StriCmp(TokenList
[1], L
"on") == 0);
789 } else if (StriCmp(TokenList
[0], L
"disabled") == 0) {
790 Entry
->Enabled
= FALSE
;
792 } else if ((StriCmp(TokenList
[0], L
"submenuentry") == 0) && (TokenCount
> 1)) {
793 AddSubmenu(Entry
, File
, CurrentVolume
, TokenList
[1]);
796 } // set options to pass to the loader program
797 FreeTokenLine(&TokenList
, &TokenCount
);
801 AddMenuEntry(Entry
->me
.SubScreen
, &MenuEntryReturn
);
803 if (Entry
->InitrdPath
) {
804 MergeStrings(&Entry
->LoadOptions
, L
"initrd=", L
' ');
805 MergeStrings(&Entry
->LoadOptions
, Entry
->InitrdPath
, 0);
806 MyFreePool(Entry
->InitrdPath
);
807 Entry
->InitrdPath
= NULL
;
811 SetLoaderDefaults(Entry
, L
"\\EFI\\BOOT\\nemo.efi", CurrentVolume
); // user included no "loader" line; use bogus one
814 } // static VOID AddStanzaEntries()
816 // Read the user-configured menu entries from refind.conf and add or delete
817 // entries based on the contents of that file....
818 VOID
ScanUserConfigured(CHAR16
*FileName
)
822 REFIT_VOLUME
*Volume
;
824 CHAR16
*Title
= NULL
;
825 UINTN TokenCount
, size
;
828 if (FileExists(SelfDir
, FileName
)) {
829 Status
= ReadFile(SelfDir
, FileName
, &File
, &size
);
830 if (EFI_ERROR(Status
))
835 while ((TokenCount
= ReadTokenLine(&File
, &TokenList
)) > 0) {
836 if ((StriCmp(TokenList
[0], L
"menuentry") == 0) && (TokenCount
> 1)) {
837 Title
= StrDuplicate(TokenList
[1]);
838 Entry
= AddStanzaEntries(&File
, Volume
, TokenList
[1]);
839 if (Entry
->Enabled
) {
840 if (Entry
->me
.SubScreen
== NULL
)
841 GenerateSubScreen(Entry
, Volume
);
842 AddPreparedLoaderEntry(Entry
);
848 } else if ((StriCmp(TokenList
[0], L
"include") == 0) && (TokenCount
== 2) &&
849 (StriCmp(FileName
, GlobalConfig
.ConfigFilename
) == 0)) {
850 if (StriCmp(TokenList
[1], FileName
) != 0) {
851 ScanUserConfigured(TokenList
[1]);
855 FreeTokenLine(&TokenList
, &TokenCount
);
858 } // VOID ScanUserConfigured()
860 // Create an options file based on /etc/fstab. The resulting file has two options
861 // lines, one of which boots the system with "ro root={rootfs}" and the other of
862 // which boots the system with "ro root={rootfs} single", where "{rootfs}" is the
863 // filesystem identifier associated with the "/" line in /etc/fstab.
864 static REFIT_FILE
* GenerateOptionsFromEtcFstab(REFIT_VOLUME
*Volume
) {
866 REFIT_FILE
*Options
= NULL
, *Fstab
= NULL
;
868 CHAR16
**TokenList
, *Line
, Root
[100];
870 if (FileExists(Volume
->RootDir
, L
"\\etc\\fstab")) {
871 Options
= AllocateZeroPool(sizeof(REFIT_FILE
));
872 Fstab
= AllocateZeroPool(sizeof(REFIT_FILE
));
873 Status
= ReadFile(Volume
->RootDir
, L
"\\etc\\fstab", Fstab
, &i
);
874 if (CheckError(Status
, L
"while reading /etc/fstab")) {
881 } else { // File read; locate root fs and create entries
882 Options
->Encoding
= ENCODING_UTF16_LE
;
883 while ((TokenCount
= ReadTokenLine(Fstab
, &TokenList
)) > 0) {
884 if (TokenCount
> 2) {
886 if (StriCmp(TokenList
[1], L
"\\") == 0) {
887 SPrint(Root
, 99, L
"%s", TokenList
[0]);
888 } else if (StriCmp(TokenList
[2], L
"\\") == 0) {
889 SPrint(Root
, 99, L
"%s=%s", TokenList
[0], TokenList
[1]);
890 } // if/elseif/elseif
891 if (Root
[0] != L
'\0') {
892 for (i
= 0; i
< StrLen(Root
); i
++)
895 Line
= PoolPrint(L
"\"Boot with normal options\" \"ro root=%s\"\n", Root
);
896 MergeStrings((CHAR16
**) &(Options
->Buffer
), Line
, 0);
898 Line
= PoolPrint(L
"\"Boot into single-user mode\" \"ro root=%s single\"\n", Root
);
899 MergeStrings((CHAR16
**) &(Options
->Buffer
), Line
, 0);
900 Options
->BufferSize
= StrLen((CHAR16
*) Options
->Buffer
) * sizeof(CHAR16
);
903 FreeTokenLine(&TokenList
, &TokenCount
);
906 Options
->Current8Ptr
= (CHAR8
*)Options
->Buffer
;
907 Options
->End8Ptr
= Options
->Current8Ptr
+ Options
->BufferSize
;
908 Options
->Current16Ptr
= (CHAR16
*)Options
->Buffer
;
909 Options
->End16Ptr
= Options
->Current16Ptr
+ (Options
->BufferSize
>> 1);
911 MyFreePool(Fstab
->Buffer
);
913 } // if/else file read error
914 } // if /etc/fstab exists
916 } // GenerateOptionsFromEtcFstab()
919 // Read a Linux kernel options file for a Linux boot loader into memory. The LoaderPath
920 // and Volume variables identify the location of the options file, but not its name --
921 // you pass this function the filename of the Linux kernel, initial RAM disk, or other
922 // file in the target directory, and this function finds the file with a name in the
923 // comma-delimited list of names specified by LINUX_OPTIONS_FILENAMES within that
924 // directory and loads it. This function tries multiple files because I originally
925 // used the filename linux.conf, but close on the heels of that decision, the Linux
926 // kernel developers decided to use that name for a similar purpose, but with a
927 // different file format. Thus, I'm migrating rEFInd to use the name refind_linux.conf,
928 // but I want a migration period in which both names are used.
929 // If a rEFInd options file can't be found, try to generate minimal options from
930 // /etc/fstab on the same volume as the kernel. This typically works only if the
931 // kernel is being read from the Linux root filesystem.
933 // The return value is a pointer to the REFIT_FILE handle for the file, or NULL if
935 REFIT_FILE
* ReadLinuxOptionsFile(IN CHAR16
*LoaderPath
, IN REFIT_VOLUME
*Volume
) {
936 CHAR16
*OptionsFilename
, *FullFilename
;
937 BOOLEAN GoOn
= TRUE
, FileFound
= FALSE
;
939 REFIT_FILE
*File
= NULL
;
943 OptionsFilename
= FindCommaDelimited(LINUX_OPTIONS_FILENAMES
, i
++);
944 FullFilename
= FindPath(LoaderPath
);
945 if ((OptionsFilename
!= NULL
) && (FullFilename
!= NULL
)) {
946 MergeStrings(&FullFilename
, OptionsFilename
, '\\');
947 if (FileExists(Volume
->RootDir
, FullFilename
)) {
948 File
= AllocateZeroPool(sizeof(REFIT_FILE
));
949 Status
= ReadFile(Volume
->RootDir
, FullFilename
, File
, &size
);
950 if (CheckError(Status
, L
"while loading the Linux options file")) {
959 } else { // a filename string is NULL
963 File
= GenerateOptionsFromEtcFstab(Volume
);
964 MyFreePool(OptionsFilename
);
965 MyFreePool(FullFilename
);
966 OptionsFilename
= FullFilename
= NULL
;
969 } // static REFIT_FILE * ReadLinuxOptionsFile()
971 // Retrieve a single line of options from a Linux kernel options file
972 CHAR16
* GetFirstOptionsFromFile(IN CHAR16
*LoaderPath
, IN REFIT_VOLUME
*Volume
) {
974 CHAR16
*Options
= NULL
;
978 File
= ReadLinuxOptionsFile(LoaderPath
, Volume
);
980 TokenCount
= ReadTokenLine(File
, &TokenList
);
982 Options
= StrDuplicate(TokenList
[1]);
983 FreeTokenLine(&TokenList
, &TokenCount
);
987 } // static CHAR16 * GetOptionsFile()