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 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 static REFIT_MENU_ENTRY MenuEntryReturn
= { L
"Return to Main Menu", TAG_RETURN
, 0, 0, 0, NULL
, NULL
, NULL
};
66 // read a file into a buffer
69 EFI_STATUS
ReadFile(IN EFI_FILE_HANDLE BaseDir
, IN CHAR16
*FileName
, IN OUT REFIT_FILE
*File
, OUT UINTN
*size
)
72 EFI_FILE_HANDLE FileHandle
;
73 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 SPrint(Message
, 255, L
"while loading the file '%s'", FileName
);
83 if (CheckError(Status
, Message
))
86 FileInfo
= LibFileInfo(FileHandle
);
87 if (FileInfo
== NULL
) {
88 // TODO: print and register the error
89 refit_call1_wrapper(FileHandle
->Close
, FileHandle
);
90 return EFI_LOAD_ERROR
;
92 ReadSize
= FileInfo
->FileSize
;
95 File
->BufferSize
= (UINTN
)ReadSize
;
96 File
->Buffer
= AllocatePool(File
->BufferSize
);
97 if (File
->Buffer
== NULL
) {
99 return EFI_OUT_OF_RESOURCES
;
101 *size
= File
->BufferSize
;
103 Status
= refit_call3_wrapper(FileHandle
->Read
, FileHandle
, &File
->BufferSize
, File
->Buffer
);
104 if (CheckError(Status
, Message
)) {
105 MyFreePool(File
->Buffer
);
107 refit_call1_wrapper(FileHandle
->Close
, FileHandle
);
110 Status
= refit_call1_wrapper(FileHandle
->Close
, FileHandle
);
113 File
->Current8Ptr
= (CHAR8
*)File
->Buffer
;
114 File
->End8Ptr
= File
->Current8Ptr
+ File
->BufferSize
;
115 File
->Current16Ptr
= (CHAR16
*)File
->Buffer
;
116 File
->End16Ptr
= File
->Current16Ptr
+ (File
->BufferSize
>> 1);
119 File
->Encoding
= ENCODING_ISO8859_1
; // default: 1:1 translation of CHAR8 to CHAR16
120 if (File
->BufferSize
>= 4) {
121 if (File
->Buffer
[0] == 0xFF && File
->Buffer
[1] == 0xFE) {
122 // BOM in UTF-16 little endian (or UTF-32 little endian)
123 File
->Encoding
= ENCODING_UTF16_LE
; // use CHAR16 as is
124 File
->Current16Ptr
++;
125 } else if (File
->Buffer
[0] == 0xEF && File
->Buffer
[1] == 0xBB && File
->Buffer
[2] == 0xBF) {
127 File
->Encoding
= ENCODING_UTF8
; // translate from UTF-8 to UTF-16
128 File
->Current8Ptr
+= 3;
129 } else if (File
->Buffer
[1] == 0 && File
->Buffer
[3] == 0) {
130 File
->Encoding
= ENCODING_UTF16_LE
; // use CHAR16 as is
132 // TODO: detect other encodings as they are implemented
139 // get a single line of text from a file
142 static CHAR16
*ReadLine(REFIT_FILE
*File
)
147 if (File
->Buffer
== NULL
)
150 if (File
->Encoding
== ENCODING_ISO8859_1
|| File
->Encoding
== ENCODING_UTF8
) {
152 CHAR8
*p
, *LineStart
, *LineEnd
;
154 p
= File
->Current8Ptr
;
155 if (p
>= File
->End8Ptr
)
159 for (; p
< File
->End8Ptr
; p
++)
160 if (*p
== 13 || *p
== 10)
163 for (; p
< File
->End8Ptr
; p
++)
164 if (*p
!= 13 && *p
!= 10)
166 File
->Current8Ptr
= p
;
168 LineLength
= (UINTN
)(LineEnd
- LineStart
) + 1;
169 Line
= AllocatePool(LineLength
* sizeof(CHAR16
));
174 if (File
->Encoding
== ENCODING_ISO8859_1
) {
175 for (p
= LineStart
; p
< LineEnd
; )
177 } else if (File
->Encoding
== ENCODING_UTF8
) {
178 // TODO: actually handle UTF-8
179 for (p
= LineStart
; p
< LineEnd
; )
184 } else if (File
->Encoding
== ENCODING_UTF16_LE
) {
186 CHAR16
*p
, *LineStart
, *LineEnd
;
188 p
= File
->Current16Ptr
;
189 if (p
>= File
->End16Ptr
)
193 for (; p
< File
->End16Ptr
; p
++)
194 if (*p
== 13 || *p
== 10)
197 for (; p
< File
->End16Ptr
; p
++)
198 if (*p
!= 13 && *p
!= 10)
200 File
->Current16Ptr
= p
;
202 LineLength
= (UINTN
)(LineEnd
- LineStart
) + 1;
203 Line
= AllocatePool(LineLength
* sizeof(CHAR16
));
207 for (p
= LineStart
, q
= Line
; p
< LineEnd
; )
212 return NULL
; // unsupported encoding
217 // Returns FALSE if *p points to the end of a token, TRUE otherwise.
218 // Also modifies *p **IF** the first and second characters are both
219 // quotes ('"'); it deletes one of them.
220 static BOOLEAN
KeepReading(IN OUT CHAR16
*p
, IN OUT BOOLEAN
*IsQuoted
) {
221 BOOLEAN MoreToRead
= FALSE
;
223 // while (*p && *p != '"' && ((*p != ' ' && *p != '\t' && *p != '=' && *p != '#' && *p != ',') || IsQuoted)) {
225 if ((p
== NULL
) || (IsQuoted
== NULL
))
231 if ((*p
!= ' ' && *p
!= '\t' && *p
!= '=' && *p
!= '#' && *p
!= ',') || *IsQuoted
) {
236 Temp
= StrDuplicate(&p
[1]);
243 *IsQuoted
= !(*IsQuoted
);
245 } // if/else second character is a quote
246 } // if first character is a quote
249 } // BOOLEAN KeepReading()
252 // get a line of tokens from a file
254 UINTN
ReadTokenLine(IN REFIT_FILE
*File
, OUT CHAR16
***TokenList
)
256 BOOLEAN LineFinished
, IsQuoted
= FALSE
;
257 CHAR16
*Line
, *Token
, *p
;
258 UINTN TokenCount
= 0;
262 while (TokenCount
== 0) {
263 Line
= ReadLine(File
);
268 LineFinished
= FALSE
;
269 while (!LineFinished
) {
270 // skip whitespace & find start of token
271 while ((*p
== ' ' || *p
== '\t' || *p
== '=' || *p
== ',') && !IsQuoted
)
273 if (*p
== 0 || *p
== '#')
277 IsQuoted
= !IsQuoted
;
283 while (KeepReading(p
, &IsQuoted
)) {
284 if ((*p
== L
'/') && !IsQuoted
) // Switch Unix-style to DOS-style directory separators
288 if (*p
== L
'\0' || *p
== L
'#')
292 AddListElement((VOID
***)TokenList
, &TokenCount
, (VOID
*)StrDuplicate(Token
));
298 } /* ReadTokenLine() */
300 VOID
FreeTokenLine(IN OUT CHAR16
***TokenList
, IN OUT UINTN
*TokenCount
)
302 // TODO: also free the items
303 FreeList((VOID
***)TokenList
, TokenCount
);
306 // handle a parameter with a single integer argument
307 static VOID
HandleInt(IN CHAR16
**TokenList
, IN UINTN TokenCount
, OUT UINTN
*Value
)
310 *Value
= Atoi(TokenList
[1]);
313 // handle a parameter with a single string argument
314 static VOID
HandleString(IN CHAR16
**TokenList
, IN UINTN TokenCount
, OUT CHAR16
**Target
) {
315 if (TokenCount
== 2) {
317 *Target
= StrDuplicate(TokenList
[1]);
319 } // static VOID HandleString()
321 // Handle a parameter with a series of string arguments, to be added to a comma-delimited
322 // list. Passes each token through the CleanUpPathNameSlashes() function to ensure
323 // consistency in subsequent comparisons of filenames.
324 static VOID
HandleStrings(IN CHAR16
**TokenList
, IN UINTN TokenCount
, OUT CHAR16
**Target
) {
327 if (*Target
!= NULL
) {
331 for (i
= 1; i
< TokenCount
; i
++) {
332 CleanUpPathNameSlashes(TokenList
[i
]);
333 MergeStrings(Target
, TokenList
[i
], L
',');
335 } // static VOID HandleStrings()
338 VOID
ReadConfig(CHAR16
*FileName
)
344 CHAR16
*SelfPath
= NULL
;
347 // Set a few defaults only if we're loading the default file.
348 if (StriCmp(FileName
, CONFIG_FILE_NAME
) == 0) {
349 MyFreePool(GlobalConfig
.AlsoScan
);
350 GlobalConfig
.AlsoScan
= StrDuplicate(ALSO_SCAN_DIRS
);
351 MyFreePool(GlobalConfig
.DontScanDirs
);
353 if (SelfVolume
->VolName
) {
354 SelfPath
= StrDuplicate(SelfVolume
->VolName
);
356 SelfPath
= AllocateZeroPool(256 * sizeof(CHAR16
));
357 if (SelfPath
!= NULL
)
358 SPrint(SelfPath
, 255, L
"fs%d", SelfVolume
->VolNumber
);
361 MergeStrings(&SelfPath
, SelfDirPath
, L
':');
362 GlobalConfig
.DontScanDirs
= SelfPath
;
363 MyFreePool(GlobalConfig
.DontScanFiles
);
364 GlobalConfig
.DontScanFiles
= StrDuplicate(DONT_SCAN_FILES
);
367 if (!FileExists(SelfDir
, FileName
)) {
368 Print(L
"Configuration file '%s' missing!\n", FileName
);
372 Status
= ReadFile(SelfDir
, FileName
, &File
, &i
);
373 if (EFI_ERROR(Status
))
377 TokenCount
= ReadTokenLine(&File
, &TokenList
);
381 if (StriCmp(TokenList
[0], L
"timeout") == 0) {
382 HandleInt(TokenList
, TokenCount
, &(GlobalConfig
.Timeout
));
384 } else if (StriCmp(TokenList
[0], L
"hideui") == 0) {
385 for (i
= 1; i
< TokenCount
; i
++) {
386 FlagName
= TokenList
[i
];
387 if (StriCmp(FlagName
, L
"banner") == 0) {
388 GlobalConfig
.HideUIFlags
|= HIDEUI_FLAG_BANNER
;
389 } else if (StriCmp(FlagName
, L
"label") == 0) {
390 GlobalConfig
.HideUIFlags
|= HIDEUI_FLAG_LABEL
;
391 } else if (StriCmp(FlagName
, L
"singleuser") == 0) {
392 GlobalConfig
.HideUIFlags
|= HIDEUI_FLAG_SINGLEUSER
;
393 } else if (StriCmp(FlagName
, L
"hwtest") == 0) {
394 GlobalConfig
.HideUIFlags
|= HIDEUI_FLAG_HWTEST
;
395 } else if (StriCmp(FlagName
, L
"arrows") == 0) {
396 GlobalConfig
.HideUIFlags
|= HIDEUI_FLAG_ARROWS
;
397 } else if (StriCmp(FlagName
, L
"hints") == 0) {
398 GlobalConfig
.HideUIFlags
|= HIDEUI_FLAG_HINTS
;
399 } else if (StriCmp(FlagName
, L
"editor") == 0) {
400 GlobalConfig
.HideUIFlags
|= HIDEUI_FLAG_EDITOR
;
401 } else if (StriCmp(FlagName
, L
"all") == 0) {
402 GlobalConfig
.HideUIFlags
= HIDEUI_FLAG_ALL
;
404 Print(L
" unknown hideui flag: '%s'\n", FlagName
);
408 } else if (StriCmp(TokenList
[0], L
"icons_dir") == 0) {
409 HandleString(TokenList
, TokenCount
, &(GlobalConfig
.IconsDir
));
411 } else if (StriCmp(TokenList
[0], L
"scanfor") == 0) {
412 for (i
= 0; i
< NUM_SCAN_OPTIONS
; i
++) {
414 GlobalConfig
.ScanFor
[i
] = TokenList
[i
][0];
416 GlobalConfig
.ScanFor
[i
] = ' ';
419 } else if ((StriCmp(TokenList
[0], L
"scan_delay") == 0) && (TokenCount
== 2)) {
420 HandleInt(TokenList
, TokenCount
, &(GlobalConfig
.ScanDelay
));
422 } else if (StriCmp(TokenList
[0], L
"also_scan_dirs") == 0) {
423 HandleStrings(TokenList
, TokenCount
, &(GlobalConfig
.AlsoScan
));
425 } else if ((StriCmp(TokenList
[0], L
"don't_scan_volumes") == 0) || (StriCmp(TokenList
[0], L
"dont_scan_volumes") == 0)) {
426 HandleStrings(TokenList
, TokenCount
, &(GlobalConfig
.AlsoScan
));
427 // Note: Don't use HandleStrings() because it modifies slashes, which might be present in volume name
428 MyFreePool(GlobalConfig
.DontScanVolumes
);
429 GlobalConfig
.DontScanVolumes
= NULL
;
430 for (i
= 1; i
< TokenCount
; i
++) {
431 MergeStrings(&GlobalConfig
.DontScanVolumes
, TokenList
[i
], L
',');
434 } else if ((StriCmp(TokenList
[0], L
"don't_scan_dirs") == 0) || (StriCmp(TokenList
[0], L
"dont_scan_dirs") == 0)) {
435 HandleStrings(TokenList
, TokenCount
, &(GlobalConfig
.DontScanDirs
));
437 } else if ((StriCmp(TokenList
[0], L
"don't_scan_files") == 0) || (StriCmp(TokenList
[0], L
"dont_scan_files") == 0)) {
438 HandleStrings(TokenList
, TokenCount
, &(GlobalConfig
.DontScanFiles
));
440 } else if (StriCmp(TokenList
[0], L
"scan_driver_dirs") == 0) {
441 HandleStrings(TokenList
, TokenCount
, &(GlobalConfig
.DriverDirs
));
443 } else if (StriCmp(TokenList
[0], L
"showtools") == 0) {
444 SetMem(GlobalConfig
.ShowTools
, NUM_TOOLS
* sizeof(UINTN
), 0);
445 for (i
= 1; (i
< TokenCount
) && (i
< NUM_TOOLS
); i
++) {
446 FlagName
= TokenList
[i
];
447 if (StriCmp(FlagName
, L
"shell") == 0) {
448 GlobalConfig
.ShowTools
[i
- 1] = TAG_SHELL
;
449 } else if (StriCmp(FlagName
, L
"gptsync") == 0) {
450 GlobalConfig
.ShowTools
[i
- 1] = TAG_GPTSYNC
;
451 } else if (StriCmp(FlagName
, L
"about") == 0) {
452 GlobalConfig
.ShowTools
[i
- 1] = TAG_ABOUT
;
453 } else if (StriCmp(FlagName
, L
"exit") == 0) {
454 GlobalConfig
.ShowTools
[i
- 1] = TAG_EXIT
;
455 } else if (StriCmp(FlagName
, L
"reboot") == 0) {
456 GlobalConfig
.ShowTools
[i
- 1] = TAG_REBOOT
;
457 } else if (StriCmp(FlagName
, L
"shutdown") == 0) {
458 GlobalConfig
.ShowTools
[i
- 1] = TAG_SHUTDOWN
;
459 } else if (StriCmp(FlagName
, L
"apple_recovery") == 0) {
460 GlobalConfig
.ShowTools
[i
- 1] = TAG_APPLE_RECOVERY
;
461 } else if (StriCmp(FlagName
, L
"mok_tool") == 0) {
462 GlobalConfig
.ShowTools
[i
- 1] = TAG_MOK_TOOL
;
464 Print(L
" unknown showtools flag: '%s'\n", FlagName
);
466 } // showtools options
468 } else if (StriCmp(TokenList
[0], L
"banner") == 0) {
469 HandleString(TokenList
, TokenCount
, &(GlobalConfig
.BannerFileName
));
471 } else if (StriCmp(TokenList
[0], L
"selection_small") == 0) {
472 HandleString(TokenList
, TokenCount
, &(GlobalConfig
.SelectionSmallFileName
));
474 } else if (StriCmp(TokenList
[0], L
"selection_big") == 0) {
475 HandleString(TokenList
, TokenCount
, &(GlobalConfig
.SelectionBigFileName
));
477 } else if (StriCmp(TokenList
[0], L
"default_selection") == 0) {
478 HandleString(TokenList
, TokenCount
, &(GlobalConfig
.DefaultSelection
));
480 } else if (StriCmp(TokenList
[0], L
"textonly") == 0) {
481 if ((TokenCount
>= 2) && (StriCmp(TokenList
[1], L
"0") == 0)) {
482 GlobalConfig
.TextOnly
= FALSE
;
484 GlobalConfig
.TextOnly
= TRUE
;
487 } else if (StriCmp(TokenList
[0], L
"textmode") == 0) {
488 HandleInt(TokenList
, TokenCount
, &(GlobalConfig
.RequestedTextMode
));
490 } else if ((StriCmp(TokenList
[0], L
"resolution") == 0) && ((TokenCount
== 2) || (TokenCount
== 3))) {
491 GlobalConfig
.RequestedScreenWidth
= Atoi(TokenList
[1]);
493 GlobalConfig
.RequestedScreenHeight
= Atoi(TokenList
[2]);
495 GlobalConfig
.RequestedScreenHeight
= 0;
497 } else if (StriCmp(TokenList
[0], L
"use_graphics_for") == 0) {
498 GlobalConfig
.GraphicsFor
= 0;
499 for (i
= 1; i
< TokenCount
; i
++) {
500 if (StriCmp(TokenList
[i
], L
"osx") == 0) {
501 GlobalConfig
.GraphicsFor
|= GRAPHICS_FOR_OSX
;
502 } else if (StriCmp(TokenList
[i
], L
"linux") == 0) {
503 GlobalConfig
.GraphicsFor
|= GRAPHICS_FOR_LINUX
;
504 } else if (StriCmp(TokenList
[i
], L
"elilo") == 0) {
505 GlobalConfig
.GraphicsFor
|= GRAPHICS_FOR_ELILO
;
506 } else if (StriCmp(TokenList
[i
], L
"grub") == 0) {
507 GlobalConfig
.GraphicsFor
|= GRAPHICS_FOR_GRUB
;
508 } else if (StriCmp(TokenList
[i
], L
"windows") == 0) {
509 GlobalConfig
.GraphicsFor
|= GRAPHICS_FOR_WINDOWS
;
511 } // for (graphics_on tokens)
513 } else if (StriCmp(TokenList
[0], L
"scan_all_linux_kernels") == 0) {
514 if ((TokenCount
>= 2) && (StriCmp(TokenList
[1], L
"0") == 0)) {
515 GlobalConfig
.ScanAllLinux
= FALSE
;
517 GlobalConfig
.ScanAllLinux
= TRUE
;
520 } else if (StriCmp(TokenList
[0], L
"max_tags") == 0) {
521 HandleInt(TokenList
, TokenCount
, &(GlobalConfig
.MaxTags
));
523 } else if ((StriCmp(TokenList
[0], L
"include") == 0) && (TokenCount
== 2) && (StriCmp(FileName
, CONFIG_FILE_NAME
) == 0)) {
524 if (StriCmp(TokenList
[1], FileName
) != 0) {
525 ReadConfig(TokenList
[1]);
530 FreeTokenLine(&TokenList
, &TokenCount
);
532 MyFreePool(File
.Buffer
);
533 } /* VOID ReadConfig() */
535 // Finds a volume with the specified Identifier (a volume label or a number
536 // followed by a colon, for the moment). If found, sets *Volume to point to
537 // that volume. If not, leaves it unchanged.
538 // Returns TRUE if a match was found, FALSE if not.
539 static BOOLEAN
FindVolume(REFIT_VOLUME
**Volume
, CHAR16
*Identifier
) {
540 UINTN i
= 0, CountedVolumes
= 0;
542 BOOLEAN Found
= FALSE
;
544 if ((StrLen(Identifier
) >= 2) && (Identifier
[StrLen(Identifier
) - 1] == L
':') &&
545 (Identifier
[0] >= L
'0') && (Identifier
[0] <= L
'9')) {
546 Number
= (INTN
) Atoi(Identifier
);
548 while ((i
< VolumesCount
) && (!Found
)) {
549 if (Number
>= 0) { // User specified a volume by number
550 if (Volumes
[i
]->IsReadable
) {
551 if (CountedVolumes
== Number
) {
552 *Volume
= Volumes
[i
];
557 } else { // User specified a volume by label
558 if (StriCmp(Identifier
, Volumes
[i
]->VolName
) == 0) {
559 *Volume
= Volumes
[i
];
566 } // static VOID FindVolume()
568 static VOID
AddSubmenu(LOADER_ENTRY
*Entry
, REFIT_FILE
*File
, REFIT_VOLUME
*Volume
, CHAR16
*Title
) {
569 REFIT_MENU_SCREEN
*SubScreen
;
570 LOADER_ENTRY
*SubEntry
;
574 SubScreen
= InitializeSubScreen(Entry
);
576 // Set defaults for the new entry; will be modified based on lines read from the config. file....
577 SubEntry
= InitializeLoaderEntry(Entry
);
579 if ((SubEntry
== NULL
) || (SubScreen
== NULL
))
581 SubEntry
->me
.Title
= StrDuplicate(Title
);
583 while (((TokenCount
= ReadTokenLine(File
, &TokenList
)) > 0) && (StriCmp(TokenList
[0], L
"}") != 0)) {
585 if ((StriCmp(TokenList
[0], L
"loader") == 0) && (TokenCount
> 1)) { // set the boot loader filename
586 MyFreePool(SubEntry
->LoaderPath
);
587 SubEntry
->LoaderPath
= StrDuplicate(TokenList
[1]);
588 SubEntry
->DevicePath
= FileDevicePath(Volume
->DeviceHandle
, SubEntry
->LoaderPath
);
590 } else if ((StriCmp(TokenList
[0], L
"volume") == 0) && (TokenCount
> 1)) {
591 if (FindVolume(&Volume
, TokenList
[1])) {
592 MyFreePool(SubEntry
->me
.Title
);
593 SubEntry
->me
.Title
= AllocateZeroPool(256 * sizeof(CHAR16
));
594 SPrint(SubEntry
->me
.Title
, 255, L
"Boot %s from %s", (Title
!= NULL
) ? Title
: L
"Unknown", Volume
->VolName
);
595 SubEntry
->me
.BadgeImage
= Volume
->VolBadgeImage
;
596 SubEntry
->VolName
= Volume
->VolName
;
599 } else if (StriCmp(TokenList
[0], L
"initrd") == 0) {
600 MyFreePool(SubEntry
->InitrdPath
);
601 SubEntry
->InitrdPath
= NULL
;
602 if (TokenCount
> 1) {
603 SubEntry
->InitrdPath
= StrDuplicate(TokenList
[1]);
606 } else if (StriCmp(TokenList
[0], L
"options") == 0) {
607 MyFreePool(SubEntry
->LoadOptions
);
608 SubEntry
->LoadOptions
= NULL
;
609 if (TokenCount
> 1) {
610 SubEntry
->LoadOptions
= StrDuplicate(TokenList
[1]);
613 } else if ((StriCmp(TokenList
[0], L
"add_options") == 0) && (TokenCount
> 1)) {
614 MergeStrings(&SubEntry
->LoadOptions
, TokenList
[1], L
' ');
616 } else if ((StriCmp(TokenList
[0], L
"graphics") == 0) && (TokenCount
> 1)) {
617 SubEntry
->UseGraphicsMode
= (StriCmp(TokenList
[1], L
"on") == 0);
619 } else if (StriCmp(TokenList
[0], L
"disabled") == 0) {
620 SubEntry
->Enabled
= FALSE
;
623 FreeTokenLine(&TokenList
, &TokenCount
);
626 if (SubEntry
->InitrdPath
!= NULL
) {
627 MergeStrings(&SubEntry
->LoadOptions
, L
"initrd=", L
' ');
628 MergeStrings(&SubEntry
->LoadOptions
, SubEntry
->InitrdPath
, 0);
629 MyFreePool(SubEntry
->InitrdPath
);
630 SubEntry
->InitrdPath
= NULL
;
632 if (SubEntry
->Enabled
== TRUE
) {
633 AddMenuEntry(SubScreen
, (REFIT_MENU_ENTRY
*)SubEntry
);
635 Entry
->me
.SubScreen
= SubScreen
;
636 } // VOID AddSubmenu()
638 // Adds the options from a SINGLE refind.conf stanza to a new loader entry and returns
639 // that entry. The calling function is then responsible for adding the entry to the
641 static LOADER_ENTRY
* AddStanzaEntries(REFIT_FILE
*File
, REFIT_VOLUME
*Volume
, CHAR16
*Title
) {
645 BOOLEAN DefaultsSet
= FALSE
, AddedSubmenu
= FALSE
;
646 REFIT_VOLUME
*CurrentVolume
= Volume
;
648 // prepare the menu entry
649 Entry
= InitializeLoaderEntry(NULL
);
653 Entry
->Title
= StrDuplicate(Title
);
654 Entry
->me
.Title
= AllocateZeroPool(256 * sizeof(CHAR16
));
655 SPrint(Entry
->me
.Title
, 255, L
"Boot %s from %s", (Title
!= NULL
) ? Title
: L
"Unknown", CurrentVolume
->VolName
);
657 Entry
->me
.BadgeImage
= CurrentVolume
->VolBadgeImage
;
658 Entry
->VolName
= CurrentVolume
->VolName
;
660 // Parse the config file to add options for a single stanza, terminating when the token
661 // is "}" or when the end of file is reached.
662 while (((TokenCount
= ReadTokenLine(File
, &TokenList
)) > 0) && (StriCmp(TokenList
[0], L
"}") != 0)) {
663 if ((StriCmp(TokenList
[0], L
"loader") == 0) && (TokenCount
> 1)) { // set the boot loader filename
664 Entry
->LoaderPath
= StrDuplicate(TokenList
[1]);
665 Entry
->DevicePath
= FileDevicePath(CurrentVolume
->DeviceHandle
, Entry
->LoaderPath
);
666 SetLoaderDefaults(Entry
, TokenList
[1], CurrentVolume
);
667 MyFreePool(Entry
->LoadOptions
);
668 Entry
->LoadOptions
= NULL
; // Discard default options, if any
671 } else if ((StriCmp(TokenList
[0], L
"volume") == 0) && (TokenCount
> 1)) {
672 if (FindVolume(&CurrentVolume
, TokenList
[1])) {
673 MyFreePool(Entry
->me
.Title
);
674 Entry
->me
.Title
= AllocateZeroPool(256 * sizeof(CHAR16
));
675 SPrint(Entry
->me
.Title
, 255, L
"Boot %s from %s", (Title
!= NULL
) ? Title
: L
"Unknown", CurrentVolume
->VolName
);
676 Entry
->me
.BadgeImage
= CurrentVolume
->VolBadgeImage
;
677 Entry
->VolName
= CurrentVolume
->VolName
;
680 } else if ((StriCmp(TokenList
[0], L
"icon") == 0) && (TokenCount
> 1)) {
681 MyFreePool(Entry
->me
.Image
);
682 Entry
->me
.Image
= LoadIcns(CurrentVolume
->RootDir
, TokenList
[1], 128);
683 if (Entry
->me
.Image
== NULL
) {
684 Entry
->me
.Image
= DummyImage(128);
687 } else if ((StriCmp(TokenList
[0], L
"initrd") == 0) && (TokenCount
> 1)) {
688 MyFreePool(Entry
->InitrdPath
);
689 Entry
->InitrdPath
= StrDuplicate(TokenList
[1]);
691 } else if ((StriCmp(TokenList
[0], L
"options") == 0) && (TokenCount
> 1)) {
692 MyFreePool(Entry
->LoadOptions
);
693 Entry
->LoadOptions
= StrDuplicate(TokenList
[1]);
695 } else if ((StriCmp(TokenList
[0], L
"ostype") == 0) && (TokenCount
> 1)) {
696 if (TokenCount
> 1) {
697 Entry
->OSType
= TokenList
[1][0];
700 } else if ((StriCmp(TokenList
[0], L
"graphics") == 0) && (TokenCount
> 1)) {
701 Entry
->UseGraphicsMode
= (StriCmp(TokenList
[1], L
"on") == 0);
703 } else if (StriCmp(TokenList
[0], L
"disabled") == 0) {
704 Entry
->Enabled
= FALSE
;
706 } else if ((StriCmp(TokenList
[0], L
"submenuentry") == 0) && (TokenCount
> 1)) {
707 AddSubmenu(Entry
, File
, CurrentVolume
, TokenList
[1]);
710 } // set options to pass to the loader program
711 FreeTokenLine(&TokenList
, &TokenCount
);
715 AddMenuEntry(Entry
->me
.SubScreen
, &MenuEntryReturn
);
717 if (Entry
->InitrdPath
) {
718 MergeStrings(&Entry
->LoadOptions
, L
"initrd=", L
' ');
719 MergeStrings(&Entry
->LoadOptions
, Entry
->InitrdPath
, 0);
720 MyFreePool(Entry
->InitrdPath
);
721 Entry
->InitrdPath
= NULL
;
725 SetLoaderDefaults(Entry
, L
"\\EFI\\BOOT\\nemo.efi", CurrentVolume
); // user included no entry; use bogus one
728 } // static VOID AddStanzaEntries()
730 // Read the user-configured menu entries from refind.conf and add or delete
731 // entries based on the contents of that file....
732 VOID
ScanUserConfigured(VOID
)
736 REFIT_VOLUME
*Volume
;
738 CHAR16
*Title
= NULL
;
739 UINTN TokenCount
, size
;
742 if (FileExists(SelfDir
, CONFIG_FILE_NAME
)) {
743 Status
= ReadFile(SelfDir
, CONFIG_FILE_NAME
, &File
, &size
);
744 if (EFI_ERROR(Status
))
749 while ((TokenCount
= ReadTokenLine(&File
, &TokenList
)) > 0) {
750 if ((StriCmp(TokenList
[0], L
"menuentry") == 0) && (TokenCount
> 1)) {
751 Title
= StrDuplicate(TokenList
[1]);
752 Entry
= AddStanzaEntries(&File
, Volume
, TokenList
[1]);
753 if (Entry
->Enabled
) {
754 if (Entry
->me
.SubScreen
== NULL
)
755 GenerateSubScreen(Entry
, Volume
);
756 AddPreparedLoaderEntry(Entry
);
762 FreeTokenLine(&TokenList
, &TokenCount
);
765 } // VOID ScanUserConfigured()
767 // Read a Linux kernel options file for a Linux boot loader into memory. The LoaderPath
768 // and Volume variables identify the location of the options file, but not its name --
769 // you pass this function the filename of the Linux kernel, initial RAM disk, or other
770 // file in the target directory, and this function finds the file with a name in the
771 // comma-delimited list of names specified by LINUX_OPTIONS_FILENAMES within that
772 // directory and loads it. This function tries multiple files because I originally
773 // used the filename linux.conf, but close on the heels of that decision, the Linux
774 // kernel developers decided to use that name for a similar purpose, but with a
775 // different file format. Thus, I'm migrating rEFInd to use the name refind_linux.conf,
776 // but I want a migration period in which both names are used.
778 // The return value is a pointer to the REFIT_FILE handle for the file, or NULL if
780 REFIT_FILE
* ReadLinuxOptionsFile(IN CHAR16
*LoaderPath
, IN REFIT_VOLUME
*Volume
) {
781 CHAR16
*OptionsFilename
, *FullFilename
;
784 REFIT_FILE
*File
= NULL
;
788 OptionsFilename
= FindCommaDelimited(LINUX_OPTIONS_FILENAMES
, i
++);
789 FullFilename
= FindPath(LoaderPath
);
790 if ((OptionsFilename
!= NULL
) && (FullFilename
!= NULL
)) {
791 MergeStrings(&FullFilename
, OptionsFilename
, '\\');
792 if (FileExists(Volume
->RootDir
, FullFilename
)) {
793 File
= AllocateZeroPool(sizeof(REFIT_FILE
));
794 Status
= ReadFile(Volume
->RootDir
, FullFilename
, File
, &size
);
796 if (CheckError(Status
, L
"while loading the Linux options file")) {
803 } else { // a filename string is NULL
806 MyFreePool(OptionsFilename
);
807 MyFreePool(FullFilename
);
808 OptionsFilename
= FullFilename
= NULL
;
811 } // static REFIT_FILE * ReadLinuxOptionsFile()
813 // Retrieve a single line of options from a Linux kernel options file
814 CHAR16
* GetFirstOptionsFromFile(IN CHAR16
*LoaderPath
, IN REFIT_VOLUME
*Volume
) {
816 CHAR16
*Options
= NULL
;
820 File
= ReadLinuxOptionsFile(LoaderPath
, Volume
);
822 TokenCount
= ReadTokenLine(File
, &TokenList
);
824 Options
= StrDuplicate(TokenList
[1]);
825 FreeTokenLine(&TokenList
, &TokenCount
);
829 } // static CHAR16 * GetOptionsFile()