]> code.delx.au - refind/blob - refind/config.c
delx.au / code / refind / blob
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
Version supports Secure Boot/MOK verification of binaries.
[refind] / refind / config.c
1 /*
2 * refit/config.c
3 * Configuration file functions
4 *
5 * Copyright (c) 2006 Christoph Pfisterer
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 *
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
18 * distribution.
19 *
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.
23 *
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.
35 */
36
37 /*
38 * Modifications copyright (c) 2012 Roderick W. Smith
39 *
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.
43 *
44 */
45
46 #include "global.h"
47 #include "lib.h"
48 #include "icns.h"
49 #include "menu.h"
50 #include "config.h"
51 #include "screen.h"
52 #include "../include/refit_call_wrapper.h"
53
54 // constants
55
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)
59
60 #define ENCODING_ISO8859_1 (0)
61 #define ENCODING_UTF8 (1)
62 #define ENCODING_UTF16_LE (2)
63
64 static REFIT_MENU_ENTRY MenuEntryReturn = { L"Return to Main Menu", TAG_RETURN, 0, 0, 0, NULL, NULL, NULL };
65
66 //
67 // read a file into a buffer
68 //
69
70 EFI_STATUS ReadFile(IN EFI_FILE_HANDLE BaseDir, IN CHAR16 *FileName, IN OUT REFIT_FILE *File, OUT UINTN *size)
71 {
72 EFI_STATUS Status;
73 EFI_FILE_HANDLE FileHandle;
74 EFI_FILE_INFO *FileInfo;
75 UINT64 ReadSize;
76 CHAR16 Message[256];
77
78 File->Buffer = NULL;
79 File->BufferSize = 0;
80
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))
85 return Status;
86
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;
92 }
93 ReadSize = FileInfo->FileSize;
94 FreePool(FileInfo);
95
96 File->BufferSize = (UINTN)ReadSize;
97 File->Buffer = AllocatePool(File->BufferSize);
98 if (File->Buffer == NULL) {
99 size = 0;
100 return EFI_OUT_OF_RESOURCES;
101 } else {
102 *size = File->BufferSize;
103 } // if/else
104 Status = refit_call3_wrapper(FileHandle->Read, FileHandle, &File->BufferSize, File->Buffer);
105 if (CheckError(Status, Message)) {
106 MyFreePool(File->Buffer);
107 File->Buffer = NULL;
108 refit_call1_wrapper(FileHandle->Close, FileHandle);
109 return Status;
110 }
111 Status = refit_call1_wrapper(FileHandle->Close, FileHandle);
112
113 // setup for reading
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);
118
119 // detect encoding
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) {
127 // BOM in UTF-8
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
132 }
133 // TODO: detect other encodings as they are implemented
134 }
135
136 return EFI_SUCCESS;
137 }
138
139 //
140 // get a single line of text from a file
141 //
142
143 static CHAR16 *ReadLine(REFIT_FILE *File)
144 {
145 CHAR16 *Line, *q;
146 UINTN LineLength;
147
148 if (File->Buffer == NULL)
149 return NULL;
150
151 if (File->Encoding == ENCODING_ISO8859_1 || File->Encoding == ENCODING_UTF8) {
152
153 CHAR8 *p, *LineStart, *LineEnd;
154
155 p = File->Current8Ptr;
156 if (p >= File->End8Ptr)
157 return NULL;
158
159 LineStart = p;
160 for (; p < File->End8Ptr; p++)
161 if (*p == 13 || *p == 10)
162 break;
163 LineEnd = p;
164 for (; p < File->End8Ptr; p++)
165 if (*p != 13 && *p != 10)
166 break;
167 File->Current8Ptr = p;
168
169 LineLength = (UINTN)(LineEnd - LineStart) + 1;
170 Line = AllocatePool(LineLength * sizeof(CHAR16));
171 if (Line == NULL)
172 return NULL;
173
174 q = Line;
175 if (File->Encoding == ENCODING_ISO8859_1) {
176 for (p = LineStart; p < LineEnd; )
177 *q++ = *p++;
178 } else if (File->Encoding == ENCODING_UTF8) {
179 // TODO: actually handle UTF-8
180 for (p = LineStart; p < LineEnd; )
181 *q++ = *p++;
182 }
183 *q = 0;
184
185 } else if (File->Encoding == ENCODING_UTF16_LE) {
186
187 CHAR16 *p, *LineStart, *LineEnd;
188
189 p = File->Current16Ptr;
190 if (p >= File->End16Ptr)
191 return NULL;
192
193 LineStart = p;
194 for (; p < File->End16Ptr; p++)
195 if (*p == 13 || *p == 10)
196 break;
197 LineEnd = p;
198 for (; p < File->End16Ptr; p++)
199 if (*p != 13 && *p != 10)
200 break;
201 File->Current16Ptr = p;
202
203 LineLength = (UINTN)(LineEnd - LineStart) + 1;
204 Line = AllocatePool(LineLength * sizeof(CHAR16));
205 if (Line == NULL)
206 return NULL;
207
208 for (p = LineStart, q = Line; p < LineEnd; )
209 *q++ = *p++;
210 *q = 0;
211
212 } else
213 return NULL; // unsupported encoding
214
215 return Line;
216 }
217
218 //
219 // get a line of tokens from a file
220 //
221
222 UINTN ReadTokenLine(IN REFIT_FILE *File, OUT CHAR16 ***TokenList)
223 {
224 BOOLEAN LineFinished, IsQuoted = FALSE;
225 CHAR16 *Line, *Token, *p;
226 UINTN TokenCount = 0;
227
228 *TokenList = NULL;
229
230 while (TokenCount == 0) {
231 Line = ReadLine(File);
232 if (Line == NULL)
233 return(0);
234
235 p = Line;
236 LineFinished = FALSE;
237 while (!LineFinished) {
238 // skip whitespace
239 while ((*p == ' ' || *p == '\t' || *p == '=' || *p == ',') && !IsQuoted)
240 p++;
241 if (*p == 0 || *p == '#')
242 break;
243
244 if (*p == '"') {
245 IsQuoted = !IsQuoted;
246 p++;
247 } // if
248 Token = p;
249
250 // find end of token
251 while (*p && *p != '"' && ((*p != ' ' && *p != '\t' && *p != '=' && *p != '#' && *p != ',') || IsQuoted)) {
252 if ((*p == '/') && !IsQuoted) // Switch Unix-style to DOS-style directory separators
253 *p = '\\';
254 p++;
255 } // if
256 if (*p == '"')
257 IsQuoted = !IsQuoted;
258 if (*p == 0 || *p == '#')
259 LineFinished = TRUE;
260 *p++ = 0;
261
262 AddListElement((VOID ***)TokenList, &TokenCount, (VOID *)StrDuplicate(Token));
263 }
264
265 FreePool(Line);
266 }
267 return (TokenCount);
268 } /* ReadTokenLine() */
269
270 VOID FreeTokenLine(IN OUT CHAR16 ***TokenList, IN OUT UINTN *TokenCount)
271 {
272 // TODO: also free the items
273 FreeList((VOID ***)TokenList, TokenCount);
274 }
275
276 // handle a parameter with a single integer argument
277 static VOID HandleInt(IN CHAR16 **TokenList, IN UINTN TokenCount, OUT UINTN *Value)
278 {
279 if (TokenCount == 2)
280 *Value = Atoi(TokenList[1]);
281 }
282
283 // handle a parameter with a single string argument
284 static VOID HandleString(IN CHAR16 **TokenList, IN UINTN TokenCount, OUT CHAR16 **Target) {
285 if (TokenCount == 2) {
286 MyFreePool(*Target);
287 *Target = StrDuplicate(TokenList[1]);
288 } // if
289 } // static VOID HandleString()
290
291 // Handle a parameter with a series of string arguments, to be added to a comma-delimited
292 // list. Passes each token through the CleanUpPathNameSlashes() function to ensure
293 // consistency in subsequent comparisons of filenames.
294 static VOID HandleStrings(IN CHAR16 **TokenList, IN UINTN TokenCount, OUT CHAR16 **Target) {
295 UINTN i;
296
297 if (*Target != NULL) {
298 FreePool(*Target);
299 *Target = NULL;
300 } // if
301 for (i = 1; i < TokenCount; i++) {
302 CleanUpPathNameSlashes(TokenList[i]);
303 MergeStrings(Target, TokenList[i], L',');
304 }
305 } // static VOID HandleStrings()
306
307 // read config file
308 VOID ReadConfig(VOID)
309 {
310 EFI_STATUS Status;
311 REFIT_FILE File;
312 CHAR16 **TokenList;
313 CHAR16 *FlagName;
314 UINTN TokenCount, i;
315
316 if (!FileExists(SelfDir, CONFIG_FILE_NAME)) {
317 Print(L"Configuration file missing!\n");
318 return;
319 }
320
321 Status = ReadFile(SelfDir, CONFIG_FILE_NAME, &File, &i);
322 if (EFI_ERROR(Status))
323 return;
324
325 GlobalConfig.DontScan = StrDuplicate(SelfDirPath);
326
327 for (;;) {
328 TokenCount = ReadTokenLine(&File, &TokenList);
329 if (TokenCount == 0)
330 break;
331
332 if (StriCmp(TokenList[0], L"timeout") == 0) {
333 HandleInt(TokenList, TokenCount, &(GlobalConfig.Timeout));
334
335 } else if (StriCmp(TokenList[0], L"hideui") == 0) {
336 for (i = 1; i < TokenCount; i++) {
337 FlagName = TokenList[i];
338 if (StriCmp(FlagName, L"banner") == 0) {
339 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_BANNER;
340 } else if (StriCmp(FlagName, L"label") == 0) {
341 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_LABEL;
342 } else if (StriCmp(FlagName, L"singleuser") == 0) {
343 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_SINGLEUSER;
344 } else if (StriCmp(FlagName, L"hwtest") == 0) {
345 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_HWTEST;
346 } else if (StriCmp(FlagName, L"arrows") == 0) {
347 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_ARROWS;
348 } else if (StriCmp(FlagName, L"all") == 0) {
349 GlobalConfig.HideUIFlags = HIDEUI_ALL;
350 } else {
351 Print(L" unknown hideui flag: '%s'\n", FlagName);
352 }
353 }
354
355 } else if (StriCmp(TokenList[0], L"icons_dir") == 0) {
356 HandleString(TokenList, TokenCount, &(GlobalConfig.IconsDir));
357
358 } else if (StriCmp(TokenList[0], L"scanfor") == 0) {
359 for (i = 0; i < NUM_SCAN_OPTIONS; i++) {
360 if (i < TokenCount)
361 GlobalConfig.ScanFor[i] = TokenList[i][0];
362 else
363 GlobalConfig.ScanFor[i] = ' ';
364 }
365
366 } else if ((StriCmp(TokenList[0], L"scan_delay") == 0) && (TokenCount == 2)) {
367 HandleInt(TokenList, TokenCount, &(GlobalConfig.ScanDelay));
368
369 } else if (StriCmp(TokenList[0], L"also_scan_dirs") == 0) {
370 HandleStrings(TokenList, TokenCount, &(GlobalConfig.AlsoScan));
371
372 } else if ((StriCmp(TokenList[0], L"don't_scan_dirs") == 0) || (StriCmp(TokenList[0], L"dont_scan_dirs") == 0)) {
373 HandleStrings(TokenList, TokenCount, &(GlobalConfig.DontScan));
374
375 } else if (StriCmp(TokenList[0], L"scan_driver_dirs") == 0) {
376 HandleStrings(TokenList, TokenCount, &(GlobalConfig.DriverDirs));
377
378 } else if (StriCmp(TokenList[0], L"showtools") == 0) {
379 SetMem(GlobalConfig.ShowTools, NUM_TOOLS * sizeof(UINTN), 0);
380 for (i = 1; (i < TokenCount) && (i < NUM_TOOLS); i++) {
381 FlagName = TokenList[i];
382 if (StriCmp(FlagName, L"shell") == 0) {
383 GlobalConfig.ShowTools[i - 1] = TAG_SHELL;
384 } else if (StriCmp(FlagName, L"gptsync") == 0) {
385 GlobalConfig.ShowTools[i - 1] = TAG_GPTSYNC;
386 } else if (StriCmp(FlagName, L"about") == 0) {
387 GlobalConfig.ShowTools[i - 1] = TAG_ABOUT;
388 } else if (StriCmp(FlagName, L"exit") == 0) {
389 GlobalConfig.ShowTools[i - 1] = TAG_EXIT;
390 } else if (StriCmp(FlagName, L"reboot") == 0) {
391 GlobalConfig.ShowTools[i - 1] = TAG_REBOOT;
392 } else if (StriCmp(FlagName, L"shutdown") == 0) {
393 GlobalConfig.ShowTools[i - 1] = TAG_SHUTDOWN;
394 } else if (StriCmp(FlagName, L"apple_recovery") == 0) {
395 GlobalConfig.ShowTools[i - 1] = TAG_APPLE_RECOVERY;
396 } else if (StriCmp(FlagName, L"mok_tool") == 0) {
397 GlobalConfig.ShowTools[i - 1] = TAG_MOK_TOOL;
398 } else {
399 Print(L" unknown showtools flag: '%s'\n", FlagName);
400 }
401 } // showtools options
402
403 } else if (StriCmp(TokenList[0], L"banner") == 0) {
404 HandleString(TokenList, TokenCount, &(GlobalConfig.BannerFileName));
405
406 } else if (StriCmp(TokenList[0], L"selection_small") == 0) {
407 HandleString(TokenList, TokenCount, &(GlobalConfig.SelectionSmallFileName));
408
409 } else if (StriCmp(TokenList[0], L"selection_big") == 0) {
410 HandleString(TokenList, TokenCount, &(GlobalConfig.SelectionBigFileName));
411
412 } else if (StriCmp(TokenList[0], L"default_selection") == 0) {
413 HandleString(TokenList, TokenCount, &(GlobalConfig.DefaultSelection));
414
415 } else if (StriCmp(TokenList[0], L"textonly") == 0) {
416 GlobalConfig.TextOnly = TRUE;
417
418 } else if ((StriCmp(TokenList[0], L"resolution") == 0) && (TokenCount == 3)) {
419 GlobalConfig.RequestedScreenWidth = Atoi(TokenList[1]);
420 GlobalConfig.RequestedScreenHeight = Atoi(TokenList[2]);
421
422 } else if (StriCmp(TokenList[0], L"use_graphics_for") == 0) {
423 GlobalConfig.GraphicsFor = 0;
424 for (i = 1; i < TokenCount; i++) {
425 if (StriCmp(TokenList[i], L"osx") == 0) {
426 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_OSX;
427 } else if (StriCmp(TokenList[i], L"linux") == 0) {
428 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_LINUX;
429 } else if (StriCmp(TokenList[i], L"elilo") == 0) {
430 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_ELILO;
431 } else if (StriCmp(TokenList[i], L"grub") == 0) {
432 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_GRUB;
433 } else if (StriCmp(TokenList[i], L"windows") == 0) {
434 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_WINDOWS;
435 }
436 } // for (graphics_on tokens)
437
438 } else if (StriCmp(TokenList[0], L"scan_all_linux_kernels") == 0) {
439 GlobalConfig.ScanAllLinux = TRUE;
440
441 } else if (StriCmp(TokenList[0], L"max_tags") == 0) {
442 HandleInt(TokenList, TokenCount, &(GlobalConfig.MaxTags));
443
444 }
445
446 FreeTokenLine(&TokenList, &TokenCount);
447 }
448 MyFreePool(File.Buffer);
449 } /* VOID ReadConfig() */
450
451 // Finds a volume with the specified Identifier (a volume label or a number
452 // followed by a colon, for the moment). If found, sets *Volume to point to
453 // that volume. If not, leaves it unchanged.
454 // Returns TRUE if a match was found, FALSE if not.
455 static BOOLEAN FindVolume(REFIT_VOLUME **Volume, CHAR16 *Identifier) {
456 UINTN i = 0, CountedVolumes = 0;
457 INTN Number = -1;
458 BOOLEAN Found = FALSE;
459
460 if ((StrLen(Identifier) >= 2) && (Identifier[StrLen(Identifier) - 1] == L':') &&
461 (Identifier[0] >= L'0') && (Identifier[0] <= L'9')) {
462 Number = (INTN) Atoi(Identifier);
463 }
464 while ((i < VolumesCount) && (!Found)) {
465 if (Number >= 0) { // User specified a volume by number
466 if (Volumes[i]->IsReadable) {
467 if (CountedVolumes == Number) {
468 *Volume = Volumes[i];
469 Found = TRUE;
470 }
471 CountedVolumes++;
472 } // if
473 } else { // User specified a volume by label
474 if (StriCmp(Identifier, Volumes[i]->VolName) == 0) {
475 *Volume = Volumes[i];
476 Found = TRUE;
477 } // if
478 } // if/else
479 i++;
480 } // while()
481 return (Found);
482 } // static VOID FindVolume()
483
484 static VOID AddSubmenu(LOADER_ENTRY *Entry, REFIT_FILE *File, REFIT_VOLUME *Volume, CHAR16 *Title) {
485 REFIT_MENU_SCREEN *SubScreen;
486 LOADER_ENTRY *SubEntry;
487 UINTN TokenCount;
488 CHAR16 **TokenList;
489
490 SubScreen = InitializeSubScreen(Entry);
491
492 // Set defaults for the new entry; will be modified based on lines read from the config. file....
493 SubEntry = InitializeLoaderEntry(Entry);
494
495 if ((SubEntry == NULL) || (SubScreen == NULL))
496 return;
497 SubEntry->me.Title = StrDuplicate(Title);
498
499 while (((TokenCount = ReadTokenLine(File, &TokenList)) > 0) && (StriCmp(TokenList[0], L"}") != 0)) {
500
501 if ((StriCmp(TokenList[0], L"loader") == 0) && (TokenCount > 1)) { // set the boot loader filename
502 MyFreePool(SubEntry->LoaderPath);
503 SubEntry->LoaderPath = StrDuplicate(TokenList[1]);
504 SubEntry->DevicePath = FileDevicePath(Volume->DeviceHandle, SubEntry->LoaderPath);
505
506 } else if ((StriCmp(TokenList[0], L"volume") == 0) && (TokenCount > 1)) {
507 if (FindVolume(&Volume, TokenList[1])) {
508 MyFreePool(SubEntry->me.Title);
509 SubEntry->me.Title = AllocateZeroPool(256 * sizeof(CHAR16));
510 SPrint(SubEntry->me.Title, 255, L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", Volume->VolName);
511 SubEntry->me.BadgeImage = Volume->VolBadgeImage;
512 SubEntry->VolName = Volume->VolName;
513 } // if match found
514
515 } else if (StriCmp(TokenList[0], L"initrd") == 0) {
516 MyFreePool(SubEntry->InitrdPath);
517 SubEntry->InitrdPath = NULL;
518 if (TokenCount > 1) {
519 SubEntry->InitrdPath = StrDuplicate(TokenList[1]);
520 }
521
522 } else if (StriCmp(TokenList[0], L"options") == 0) {
523 MyFreePool(SubEntry->LoadOptions);
524 SubEntry->LoadOptions = NULL;
525 if (TokenCount > 1) {
526 SubEntry->LoadOptions = StrDuplicate(TokenList[1]);
527 } // if/else
528
529 } else if ((StriCmp(TokenList[0], L"add_options") == 0) && (TokenCount > 1)) {
530 MergeStrings(&SubEntry->LoadOptions, TokenList[1], L' ');
531
532 } else if ((StriCmp(TokenList[0], L"graphics") == 0) && (TokenCount > 1)) {
533 SubEntry->UseGraphicsMode = (StriCmp(TokenList[1], L"on") == 0);
534
535 } else if (StriCmp(TokenList[0], L"disabled") == 0) {
536 SubEntry->Enabled = FALSE;
537 } // ief/elseif
538
539 FreeTokenLine(&TokenList, &TokenCount);
540 } // while()
541
542 if (SubEntry->InitrdPath != NULL) {
543 MergeStrings(&SubEntry->LoadOptions, L"initrd=", L' ');
544 MergeStrings(&SubEntry->LoadOptions, SubEntry->InitrdPath, 0);
545 MyFreePool(SubEntry->InitrdPath);
546 SubEntry->InitrdPath = NULL;
547 } // if
548 if (SubEntry->Enabled == TRUE) {
549 AddMenuEntry(SubScreen, (REFIT_MENU_ENTRY *)SubEntry);
550 }
551 Entry->me.SubScreen = SubScreen;
552 } // VOID AddSubmenu()
553
554 // Adds the options from a SINGLE refind.conf stanza to a new loader entry and returns
555 // that entry. The calling function is then responsible for adding the entry to the
556 // list of entries.
557 static LOADER_ENTRY * AddStanzaEntries(REFIT_FILE *File, REFIT_VOLUME *Volume, CHAR16 *Title) {
558 CHAR16 **TokenList;
559 UINTN TokenCount;
560 LOADER_ENTRY *Entry;
561 BOOLEAN DefaultsSet = FALSE, AddedSubmenu = FALSE;
562 REFIT_VOLUME *CurrentVolume = Volume;
563
564 // prepare the menu entry
565 Entry = InitializeLoaderEntry(NULL);
566 if (Entry == NULL)
567 return NULL;
568
569 Entry->Title = StrDuplicate(Title);
570 Entry->me.Title = AllocateZeroPool(256 * sizeof(CHAR16));
571 SPrint(Entry->me.Title, 255, L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", CurrentVolume->VolName);
572 Entry->me.Row = 0;
573 Entry->me.BadgeImage = CurrentVolume->VolBadgeImage;
574 Entry->VolName = CurrentVolume->VolName;
575
576 // Parse the config file to add options for a single stanza, terminating when the token
577 // is "}" or when the end of file is reached.
578 while (((TokenCount = ReadTokenLine(File, &TokenList)) > 0) && (StriCmp(TokenList[0], L"}") != 0)) {
579 if ((StriCmp(TokenList[0], L"loader") == 0) && (TokenCount > 1)) { // set the boot loader filename
580 Entry->LoaderPath = StrDuplicate(TokenList[1]);
581 Entry->DevicePath = FileDevicePath(CurrentVolume->DeviceHandle, Entry->LoaderPath);
582 SetLoaderDefaults(Entry, TokenList[1], CurrentVolume);
583 MyFreePool(Entry->LoadOptions);
584 Entry->LoadOptions = NULL; // Discard default options, if any
585 DefaultsSet = TRUE;
586
587 } else if ((StriCmp(TokenList[0], L"volume") == 0) && (TokenCount > 1)) {
588 if (FindVolume(&CurrentVolume, TokenList[1])) {
589 MyFreePool(Entry->me.Title);
590 Entry->me.Title = AllocateZeroPool(256 * sizeof(CHAR16));
591 SPrint(Entry->me.Title, 255, L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", CurrentVolume->VolName);
592 Entry->me.BadgeImage = CurrentVolume->VolBadgeImage;
593 Entry->VolName = CurrentVolume->VolName;
594 } // if match found
595
596 } else if ((StriCmp(TokenList[0], L"icon") == 0) && (TokenCount > 1)) {
597 MyFreePool(Entry->me.Image);
598 Entry->me.Image = LoadIcns(CurrentVolume->RootDir, TokenList[1], 128);
599 if (Entry->me.Image == NULL) {
600 Entry->me.Image = DummyImage(128);
601 }
602
603 } else if ((StriCmp(TokenList[0], L"initrd") == 0) && (TokenCount > 1)) {
604 MyFreePool(Entry->InitrdPath);
605 Entry->InitrdPath = StrDuplicate(TokenList[1]);
606
607 } else if ((StriCmp(TokenList[0], L"options") == 0) && (TokenCount > 1)) {
608 MyFreePool(Entry->LoadOptions);
609 Entry->LoadOptions = StrDuplicate(TokenList[1]);
610
611 } else if ((StriCmp(TokenList[0], L"ostype") == 0) && (TokenCount > 1)) {
612 if (TokenCount > 1) {
613 Entry->OSType = TokenList[1][0];
614 }
615
616 } else if ((StriCmp(TokenList[0], L"graphics") == 0) && (TokenCount > 1)) {
617 Entry->UseGraphicsMode = (StriCmp(TokenList[1], L"on") == 0);
618
619 } else if (StriCmp(TokenList[0], L"disabled") == 0) {
620 Entry->Enabled = FALSE;
621
622 } else if ((StriCmp(TokenList[0], L"submenuentry") == 0) && (TokenCount > 1)) {
623 AddSubmenu(Entry, File, CurrentVolume, TokenList[1]);
624 AddedSubmenu = TRUE;
625
626 } // set options to pass to the loader program
627 FreeTokenLine(&TokenList, &TokenCount);
628 } // while()
629
630 if (AddedSubmenu)
631 AddMenuEntry(Entry->me.SubScreen, &MenuEntryReturn);
632
633 if (Entry->InitrdPath) {
634 MergeStrings(&Entry->LoadOptions, L"initrd=", L' ');
635 MergeStrings(&Entry->LoadOptions, Entry->InitrdPath, 0);
636 MyFreePool(Entry->InitrdPath);
637 Entry->InitrdPath = NULL;
638 } // if
639
640 if (!DefaultsSet)
641 SetLoaderDefaults(Entry, L"\\EFI\\BOOT\\nemo.efi", CurrentVolume); // user included no entry; use bogus one
642
643 return(Entry);
644 } // static VOID AddStanzaEntries()
645
646 // Read the user-configured loaders file, refind_loaders.conf, and add or delete
647 // entries based on the contents of that file....
648 VOID ScanUserConfigured(VOID)
649 {
650 EFI_STATUS Status;
651 REFIT_FILE File;
652 REFIT_VOLUME *Volume;
653 CHAR16 **TokenList;
654 CHAR16 *Title = NULL;
655 UINTN TokenCount, size;
656 LOADER_ENTRY *Entry;
657
658 if (FileExists(SelfDir, CONFIG_FILE_NAME)) {
659 Status = ReadFile(SelfDir, CONFIG_FILE_NAME, &File, &size);
660 if (EFI_ERROR(Status))
661 return;
662
663 Volume = SelfVolume;
664
665 while ((TokenCount = ReadTokenLine(&File, &TokenList)) > 0) {
666 if ((StriCmp(TokenList[0], L"menuentry") == 0) && (TokenCount > 1)) {
667 Title = StrDuplicate(TokenList[1]);
668 Entry = AddStanzaEntries(&File, Volume, TokenList[1]);
669 if (Entry->Enabled) {
670 if (Entry->me.SubScreen == NULL)
671 GenerateSubScreen(Entry, Volume);
672 AddPreparedLoaderEntry(Entry);
673 } else {
674 MyFreePool(Entry);
675 } // if/else
676 MyFreePool(Title);
677 } // if
678 FreeTokenLine(&TokenList, &TokenCount);
679 } // while()
680 } // if()
681 } // VOID ScanUserConfigured()
682
683 // Read a Linux kernel options file for a Linux boot loader into memory. The LoaderPath
684 // and Volume variables identify the location of the options file, but not its name --
685 // you pass this function the filename of the Linux kernel, initial RAM disk, or other
686 // file in the target directory, and this function finds the file with a name in the
687 // comma-delimited list of names specified by LINUX_OPTIONS_FILENAMES within that
688 // directory and loads it. This function tries multiple files because I originally
689 // used the filename linux.conf, but close on the heels of that decision, the Linux
690 // kernel developers decided to use that name for a similar purpose, but with a
691 // different file format. Thus, I'm migrating rEFInd to use the name refind_linux.conf,
692 // but I want a migration period in which both names are used.
693 //
694 // The return value is a pointer to the REFIT_FILE handle for the file, or NULL if
695 // it wasn't found.
696 REFIT_FILE * ReadLinuxOptionsFile(IN CHAR16 *LoaderPath, IN REFIT_VOLUME *Volume) {
697 CHAR16 *OptionsFilename, *FullFilename;
698 BOOLEAN GoOn = TRUE;
699 UINTN i = 0, size;
700 REFIT_FILE *File = NULL;
701 EFI_STATUS Status;
702
703 do {
704 OptionsFilename = FindCommaDelimited(LINUX_OPTIONS_FILENAMES, i++);
705 FullFilename = FindPath(LoaderPath);
706 if ((OptionsFilename != NULL) && (FullFilename != NULL)) {
707 MergeStrings(&FullFilename, OptionsFilename, '\\');
708 if (FileExists(Volume->RootDir, FullFilename)) {
709 File = AllocateZeroPool(sizeof(REFIT_FILE));
710 Status = ReadFile(Volume->RootDir, FullFilename, File, &size);
711 GoOn = FALSE;
712 if (CheckError(Status, L"while loading the Linux options file")) {
713 if (File != NULL)
714 FreePool(File);
715 File = NULL;
716 GoOn = TRUE;
717 } // if error
718 } // if file exists
719 } else { // a filename string is NULL
720 GoOn = FALSE;
721 } // if/else
722 MyFreePool(OptionsFilename);
723 MyFreePool(FullFilename);
724 OptionsFilename = FullFilename = NULL;
725 } while (GoOn);
726 return (File);
727 } // static REFIT_FILE * ReadLinuxOptionsFile()
728
729 // Retrieve a single line of options from a Linux kernel options file
730 CHAR16 * GetFirstOptionsFromFile(IN CHAR16 *LoaderPath, IN REFIT_VOLUME *Volume) {
731 UINTN TokenCount;
732 CHAR16 *Options = NULL;
733 CHAR16 **TokenList;
734 REFIT_FILE *File;
735
736 File = ReadLinuxOptionsFile(LoaderPath, Volume);
737 if (File != NULL) {
738 TokenCount = ReadTokenLine(File, &TokenList);
739 if (TokenCount > 1)
740 Options = StrDuplicate(TokenList[1]);
741 FreeTokenLine(&TokenList, &TokenCount);
742 FreePool(File);
743 } // if
744 return Options;
745 } // static CHAR16 * GetOptionsFile()
746