]> code.delx.au - refind/blob - refind/config.c
delx.au / code / refind / blob
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
Support for memtest86 as a second-row item.
[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-2013 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 LINUX_OPTIONS_FILENAMES L"refind_linux.conf,refind-linux.conf"
57 #define MAXCONFIGFILESIZE (128*1024)
58
59 #define ENCODING_ISO8859_1 (0)
60 #define ENCODING_UTF8 (1)
61 #define ENCODING_UTF16_LE (2)
62
63 static REFIT_MENU_ENTRY MenuEntryReturn = { L"Return to Main Menu", TAG_RETURN, 0, 0, 0, NULL, NULL, NULL };
64
65 //
66 // read a file into a buffer
67 //
68
69 EFI_STATUS ReadFile(IN EFI_FILE_HANDLE BaseDir, IN CHAR16 *FileName, IN OUT REFIT_FILE *File, OUT UINTN *size)
70 {
71 EFI_STATUS Status;
72 EFI_FILE_HANDLE FileHandle;
73 EFI_FILE_INFO *FileInfo;
74 UINT64 ReadSize;
75 CHAR16 Message[256];
76
77 File->Buffer = NULL;
78 File->BufferSize = 0;
79
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))
84 return Status;
85
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;
91 }
92 ReadSize = FileInfo->FileSize;
93 FreePool(FileInfo);
94
95 File->BufferSize = (UINTN)ReadSize;
96 File->Buffer = AllocatePool(File->BufferSize);
97 if (File->Buffer == NULL) {
98 size = 0;
99 return EFI_OUT_OF_RESOURCES;
100 } else {
101 *size = File->BufferSize;
102 } // if/else
103 Status = refit_call3_wrapper(FileHandle->Read, FileHandle, &File->BufferSize, File->Buffer);
104 if (CheckError(Status, Message)) {
105 MyFreePool(File->Buffer);
106 File->Buffer = NULL;
107 refit_call1_wrapper(FileHandle->Close, FileHandle);
108 return Status;
109 }
110 Status = refit_call1_wrapper(FileHandle->Close, FileHandle);
111
112 // setup for reading
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);
117
118 // detect encoding
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) {
126 // BOM in UTF-8
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
131 }
132 // TODO: detect other encodings as they are implemented
133 }
134
135 return EFI_SUCCESS;
136 }
137
138 //
139 // get a single line of text from a file
140 //
141
142 static CHAR16 *ReadLine(REFIT_FILE *File)
143 {
144 CHAR16 *Line, *q;
145 UINTN LineLength;
146
147 if (File->Buffer == NULL)
148 return NULL;
149
150 if (File->Encoding == ENCODING_ISO8859_1 || File->Encoding == ENCODING_UTF8) {
151
152 CHAR8 *p, *LineStart, *LineEnd;
153
154 p = File->Current8Ptr;
155 if (p >= File->End8Ptr)
156 return NULL;
157
158 LineStart = p;
159 for (; p < File->End8Ptr; p++)
160 if (*p == 13 || *p == 10)
161 break;
162 LineEnd = p;
163 for (; p < File->End8Ptr; p++)
164 if (*p != 13 && *p != 10)
165 break;
166 File->Current8Ptr = p;
167
168 LineLength = (UINTN)(LineEnd - LineStart) + 1;
169 Line = AllocatePool(LineLength * sizeof(CHAR16));
170 if (Line == NULL)
171 return NULL;
172
173 q = Line;
174 if (File->Encoding == ENCODING_ISO8859_1) {
175 for (p = LineStart; p < LineEnd; )
176 *q++ = *p++;
177 } else if (File->Encoding == ENCODING_UTF8) {
178 // TODO: actually handle UTF-8
179 for (p = LineStart; p < LineEnd; )
180 *q++ = *p++;
181 }
182 *q = 0;
183
184 } else if (File->Encoding == ENCODING_UTF16_LE) {
185
186 CHAR16 *p, *LineStart, *LineEnd;
187
188 p = File->Current16Ptr;
189 if (p >= File->End16Ptr)
190 return NULL;
191
192 LineStart = p;
193 for (; p < File->End16Ptr; p++)
194 if (*p == 13 || *p == 10)
195 break;
196 LineEnd = p;
197 for (; p < File->End16Ptr; p++)
198 if (*p != 13 && *p != 10)
199 break;
200 File->Current16Ptr = p;
201
202 LineLength = (UINTN)(LineEnd - LineStart) + 1;
203 Line = AllocatePool(LineLength * sizeof(CHAR16));
204 if (Line == NULL)
205 return NULL;
206
207 for (p = LineStart, q = Line; p < LineEnd; )
208 *q++ = *p++;
209 *q = 0;
210
211 } else
212 return NULL; // unsupported encoding
213
214 return Line;
215 }
216
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;
222 CHAR16 *Temp = NULL;
223
224 if ((p == NULL) || (IsQuoted == NULL))
225 return FALSE;
226
227 if (*p == L'\0')
228 return FALSE;
229
230 if ((*p != ' ' && *p != '\t' && *p != '=' && *p != '#' && *p != ',') || *IsQuoted) {
231 MoreToRead = TRUE;
232 }
233 if (*p == L'"') {
234 if (p[1] == L'"') {
235 Temp = StrDuplicate(&p[1]);
236 if (Temp != NULL) {
237 StrCpy(p, Temp);
238 FreePool(Temp);
239 }
240 MoreToRead = TRUE;
241 } else {
242 *IsQuoted = !(*IsQuoted);
243 MoreToRead = FALSE;
244 } // if/else second character is a quote
245 } // if first character is a quote
246
247 return MoreToRead;
248 } // BOOLEAN KeepReading()
249
250 //
251 // get a line of tokens from a file
252 //
253 UINTN ReadTokenLine(IN REFIT_FILE *File, OUT CHAR16 ***TokenList)
254 {
255 BOOLEAN LineFinished, IsQuoted = FALSE;
256 CHAR16 *Line, *Token, *p;
257 UINTN TokenCount = 0;
258
259 *TokenList = NULL;
260
261 while (TokenCount == 0) {
262 Line = ReadLine(File);
263 if (Line == NULL)
264 return(0);
265
266 p = Line;
267 LineFinished = FALSE;
268 while (!LineFinished) {
269 // skip whitespace & find start of token
270 while ((*p == ' ' || *p == '\t' || *p == '=' || *p == ',') && !IsQuoted)
271 p++;
272 if (*p == 0 || *p == '#')
273 break;
274
275 if (*p == '"') {
276 IsQuoted = !IsQuoted;
277 p++;
278 } // if
279 Token = p;
280
281 // find end of token
282 while (KeepReading(p, &IsQuoted)) {
283 if ((*p == L'/') && !IsQuoted) // Switch Unix-style to DOS-style directory separators
284 *p = L'\\';
285 p++;
286 } // while
287 if (*p == L'\0' || *p == L'#')
288 LineFinished = TRUE;
289 *p++ = 0;
290
291 AddListElement((VOID ***)TokenList, &TokenCount, (VOID *)StrDuplicate(Token));
292 }
293
294 FreePool(Line);
295 }
296 return (TokenCount);
297 } /* ReadTokenLine() */
298
299 VOID FreeTokenLine(IN OUT CHAR16 ***TokenList, IN OUT UINTN *TokenCount)
300 {
301 // TODO: also free the items
302 FreeList((VOID ***)TokenList, TokenCount);
303 }
304
305 // handle a parameter with a single integer argument
306 static VOID HandleInt(IN CHAR16 **TokenList, IN UINTN TokenCount, OUT UINTN *Value)
307 {
308 if (TokenCount == 2)
309 *Value = Atoi(TokenList[1]);
310 }
311
312 // handle a parameter with a single string argument
313 static VOID HandleString(IN CHAR16 **TokenList, IN UINTN TokenCount, OUT CHAR16 **Target) {
314 if (TokenCount == 2) {
315 MyFreePool(*Target);
316 *Target = StrDuplicate(TokenList[1]);
317 } // if
318 } // static VOID HandleString()
319
320 // Handle a parameter with a series of string arguments, to be added to a comma-delimited
321 // list. Passes each token through the CleanUpPathNameSlashes() function to ensure
322 // consistency in subsequent comparisons of filenames.
323 static VOID HandleStrings(IN CHAR16 **TokenList, IN UINTN TokenCount, OUT CHAR16 **Target) {
324 UINTN i;
325
326 if (*Target != NULL) {
327 FreePool(*Target);
328 *Target = NULL;
329 } // if
330 for (i = 1; i < TokenCount; i++) {
331 CleanUpPathNameSlashes(TokenList[i]);
332 MergeStrings(Target, TokenList[i], L',');
333 }
334 } // static VOID HandleStrings()
335
336 // read config file
337 VOID ReadConfig(CHAR16 *FileName)
338 {
339 EFI_STATUS Status;
340 REFIT_FILE File;
341 CHAR16 **TokenList;
342 CHAR16 *FlagName;
343 CHAR16 *SelfPath = NULL;
344 UINTN TokenCount, i;
345
346 // Set a few defaults only if we're loading the default file.
347 if (StriCmp(FileName, CONFIG_FILE_NAME) == 0) {
348 MyFreePool(GlobalConfig.AlsoScan);
349 GlobalConfig.AlsoScan = StrDuplicate(ALSO_SCAN_DIRS);
350 MyFreePool(GlobalConfig.DontScanDirs);
351 if (SelfVolume) {
352 if (SelfVolume->VolName) {
353 SelfPath = SelfVolume->VolName ? StrDuplicate(SelfVolume->VolName) : NULL;
354 } else {
355 SelfPath = AllocateZeroPool(256 * sizeof(CHAR16));
356 if (SelfPath != NULL)
357 SPrint(SelfPath, 255, L"fs%d", SelfVolume->VolNumber);
358 } // if/else
359 }
360 MergeStrings(&SelfPath, SelfDirPath, L':');
361 GlobalConfig.DontScanDirs = SelfPath;
362 MyFreePool(GlobalConfig.DontScanFiles);
363 GlobalConfig.DontScanFiles = StrDuplicate(DONT_SCAN_FILES);
364 MergeStrings(&(GlobalConfig.DontScanFiles), MOK_NAMES, L',');
365 MyFreePool(GlobalConfig.DontScanVolumes);
366 GlobalConfig.DontScanVolumes = StrDuplicate(DONT_SCAN_VOLUMES);
367 } // if
368
369 if (!FileExists(SelfDir, FileName)) {
370 Print(L"Configuration file '%s' missing!\n", FileName);
371 return;
372 }
373
374 Status = ReadFile(SelfDir, FileName, &File, &i);
375 if (EFI_ERROR(Status))
376 return;
377
378 for (;;) {
379 TokenCount = ReadTokenLine(&File, &TokenList);
380 if (TokenCount == 0)
381 break;
382
383 if (StriCmp(TokenList[0], L"timeout") == 0) {
384 HandleInt(TokenList, TokenCount, &(GlobalConfig.Timeout));
385
386 } else if (StriCmp(TokenList[0], L"hideui") == 0) {
387 for (i = 1; i < TokenCount; i++) {
388 FlagName = TokenList[i];
389 if (StriCmp(FlagName, L"banner") == 0) {
390 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_BANNER;
391 } else if (StriCmp(FlagName, L"label") == 0) {
392 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_LABEL;
393 } else if (StriCmp(FlagName, L"singleuser") == 0) {
394 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_SINGLEUSER;
395 } else if (StriCmp(FlagName, L"hwtest") == 0) {
396 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_HWTEST;
397 } else if (StriCmp(FlagName, L"arrows") == 0) {
398 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_ARROWS;
399 } else if (StriCmp(FlagName, L"hints") == 0) {
400 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_HINTS;
401 } else if (StriCmp(FlagName, L"editor") == 0) {
402 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_EDITOR;
403 } else if (StriCmp(FlagName, L"safemode") == 0) {
404 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_SAFEMODE;
405 } else if (StriCmp(FlagName, L"all") == 0) {
406 GlobalConfig.HideUIFlags = HIDEUI_FLAG_ALL;
407 } else {
408 Print(L" unknown hideui flag: '%s'\n", FlagName);
409 }
410 }
411
412 } else if (StriCmp(TokenList[0], L"icons_dir") == 0) {
413 HandleString(TokenList, TokenCount, &(GlobalConfig.IconsDir));
414
415 } else if (StriCmp(TokenList[0], L"scanfor") == 0) {
416 for (i = 0; i < NUM_SCAN_OPTIONS; i++) {
417 if (i < TokenCount)
418 GlobalConfig.ScanFor[i] = TokenList[i][0];
419 else
420 GlobalConfig.ScanFor[i] = ' ';
421 }
422
423 } else if ((StriCmp(TokenList[0], L"scan_delay") == 0) && (TokenCount == 2)) {
424 HandleInt(TokenList, TokenCount, &(GlobalConfig.ScanDelay));
425
426 } else if (StriCmp(TokenList[0], L"also_scan_dirs") == 0) {
427 HandleStrings(TokenList, TokenCount, &(GlobalConfig.AlsoScan));
428
429 } else if ((StriCmp(TokenList[0], L"don't_scan_volumes") == 0) || (StriCmp(TokenList[0], L"dont_scan_volumes") == 0)) {
430 // Note: Don't use HandleStrings() because it modifies slashes, which might be present in volume name
431 MyFreePool(GlobalConfig.DontScanVolumes);
432 GlobalConfig.DontScanVolumes = NULL;
433 for (i = 1; i < TokenCount; i++) {
434 MergeStrings(&GlobalConfig.DontScanVolumes, TokenList[i], L',');
435 }
436
437 } else if ((StriCmp(TokenList[0], L"don't_scan_dirs") == 0) || (StriCmp(TokenList[0], L"dont_scan_dirs") == 0)) {
438 HandleStrings(TokenList, TokenCount, &(GlobalConfig.DontScanDirs));
439
440 } else if ((StriCmp(TokenList[0], L"don't_scan_files") == 0) || (StriCmp(TokenList[0], L"dont_scan_files") == 0)) {
441 HandleStrings(TokenList, TokenCount, &(GlobalConfig.DontScanFiles));
442
443 } else if (StriCmp(TokenList[0], L"scan_driver_dirs") == 0) {
444 HandleStrings(TokenList, TokenCount, &(GlobalConfig.DriverDirs));
445
446 } else if (StriCmp(TokenList[0], L"showtools") == 0) {
447 SetMem(GlobalConfig.ShowTools, NUM_TOOLS * sizeof(UINTN), 0);
448 for (i = 1; (i < TokenCount) && (i < NUM_TOOLS); i++) {
449 FlagName = TokenList[i];
450 if (StriCmp(FlagName, L"shell") == 0) {
451 GlobalConfig.ShowTools[i - 1] = TAG_SHELL;
452 } else if (StriCmp(FlagName, L"gptsync") == 0) {
453 GlobalConfig.ShowTools[i - 1] = TAG_GPTSYNC;
454 } else if (StriCmp(FlagName, L"about") == 0) {
455 GlobalConfig.ShowTools[i - 1] = TAG_ABOUT;
456 } else if (StriCmp(FlagName, L"exit") == 0) {
457 GlobalConfig.ShowTools[i - 1] = TAG_EXIT;
458 } else if (StriCmp(FlagName, L"reboot") == 0) {
459 GlobalConfig.ShowTools[i - 1] = TAG_REBOOT;
460 } else if (StriCmp(FlagName, L"shutdown") == 0) {
461 GlobalConfig.ShowTools[i - 1] = TAG_SHUTDOWN;
462 } else if (StriCmp(FlagName, L"apple_recovery") == 0) {
463 GlobalConfig.ShowTools[i - 1] = TAG_APPLE_RECOVERY;
464 } else if (StriCmp(FlagName, L"mok_tool") == 0) {
465 GlobalConfig.ShowTools[i - 1] = TAG_MOK_TOOL;
466 } else if (StriCmp(FlagName, L"firmware") == 0) {
467 GlobalConfig.ShowTools[i - 1] = TAG_FIRMWARE;
468 } else if ((StriCmp(FlagName, L"memtest86") == 0) || (StriCmp(FlagName, L"memtest") == 0)) {
469 GlobalConfig.ShowTools[i - 1] = TAG_MEMTEST;
470 } else {
471 Print(L" unknown showtools flag: '%s'\n", FlagName);
472 }
473 } // showtools options
474
475 } else if (StriCmp(TokenList[0], L"banner") == 0) {
476 HandleString(TokenList, TokenCount, &(GlobalConfig.BannerFileName));
477
478 } else if (StriCmp(TokenList[0], L"selection_small") == 0) {
479 HandleString(TokenList, TokenCount, &(GlobalConfig.SelectionSmallFileName));
480
481 } else if (StriCmp(TokenList[0], L"selection_big") == 0) {
482 HandleString(TokenList, TokenCount, &(GlobalConfig.SelectionBigFileName));
483
484 } else if (StriCmp(TokenList[0], L"default_selection") == 0) {
485 HandleString(TokenList, TokenCount, &(GlobalConfig.DefaultSelection));
486
487 } else if (StriCmp(TokenList[0], L"textonly") == 0) {
488 if ((TokenCount >= 2) && (StriCmp(TokenList[1], L"0") == 0)) {
489 GlobalConfig.TextOnly = FALSE;
490 } else {
491 GlobalConfig.TextOnly = TRUE;
492 }
493
494 } else if (StriCmp(TokenList[0], L"textmode") == 0) {
495 HandleInt(TokenList, TokenCount, &(GlobalConfig.RequestedTextMode));
496
497 } else if ((StriCmp(TokenList[0], L"resolution") == 0) && ((TokenCount == 2) || (TokenCount == 3))) {
498 GlobalConfig.RequestedScreenWidth = Atoi(TokenList[1]);
499 if (TokenCount == 3)
500 GlobalConfig.RequestedScreenHeight = Atoi(TokenList[2]);
501 else
502 GlobalConfig.RequestedScreenHeight = 0;
503
504 } else if (StriCmp(TokenList[0], L"screensaver") == 0) {
505 HandleInt(TokenList, TokenCount, &(GlobalConfig.ScreensaverTime));
506
507 } else if (StriCmp(TokenList[0], L"use_graphics_for") == 0) {
508 GlobalConfig.GraphicsFor = 0;
509 for (i = 1; i < TokenCount; i++) {
510 if (StriCmp(TokenList[i], L"osx") == 0) {
511 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_OSX;
512 } else if (StriCmp(TokenList[i], L"linux") == 0) {
513 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_LINUX;
514 } else if (StriCmp(TokenList[i], L"elilo") == 0) {
515 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_ELILO;
516 } else if (StriCmp(TokenList[i], L"grub") == 0) {
517 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_GRUB;
518 } else if (StriCmp(TokenList[i], L"windows") == 0) {
519 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_WINDOWS;
520 }
521 } // for (graphics_on tokens)
522
523 } else if ((StriCmp(TokenList[0], L"font") == 0) && (TokenCount == 2)) {
524 egLoadFont(TokenList[1]);
525
526 } else if (StriCmp(TokenList[0], L"scan_all_linux_kernels") == 0) {
527 if ((TokenCount >= 2) && (StriCmp(TokenList[1], L"0") == 0)) {
528 GlobalConfig.ScanAllLinux = FALSE;
529 } else {
530 GlobalConfig.ScanAllLinux = TRUE;
531 }
532
533 } else if (StriCmp(TokenList[0], L"max_tags") == 0) {
534 HandleInt(TokenList, TokenCount, &(GlobalConfig.MaxTags));
535
536 } else if ((StriCmp(TokenList[0], L"include") == 0) && (TokenCount == 2) && (StriCmp(FileName, CONFIG_FILE_NAME) == 0)) {
537 if (StriCmp(TokenList[1], FileName) != 0) {
538 ReadConfig(TokenList[1]);
539 }
540
541 }
542
543 FreeTokenLine(&TokenList, &TokenCount);
544 }
545 MyFreePool(File.Buffer);
546 } /* VOID ReadConfig() */
547
548 // Finds a volume with the specified Identifier (a volume label or a number
549 // followed by a colon, for the moment). If found, sets *Volume to point to
550 // that volume. If not, leaves it unchanged.
551 // Returns TRUE if a match was found, FALSE if not.
552 static BOOLEAN FindVolume(REFIT_VOLUME **Volume, CHAR16 *Identifier) {
553 UINTN i = 0, CountedVolumes = 0;
554 INTN Number = -1;
555 BOOLEAN Found = FALSE;
556
557 if ((StrLen(Identifier) >= 2) && (Identifier[StrLen(Identifier) - 1] == L':') &&
558 (Identifier[0] >= L'0') && (Identifier[0] <= L'9')) {
559 Number = (INTN) Atoi(Identifier);
560 }
561 while ((i < VolumesCount) && (!Found)) {
562 if (Number >= 0) { // User specified a volume by number
563 if (Volumes[i]->IsReadable) {
564 if (CountedVolumes == Number) {
565 *Volume = Volumes[i];
566 Found = TRUE;
567 }
568 CountedVolumes++;
569 } // if
570 } else { // User specified a volume by label
571 if (StriCmp(Identifier, Volumes[i]->VolName) == 0) {
572 *Volume = Volumes[i];
573 Found = TRUE;
574 } // if
575 } // if/else
576 i++;
577 } // while()
578 return (Found);
579 } // static VOID FindVolume()
580
581 static VOID AddSubmenu(LOADER_ENTRY *Entry, REFIT_FILE *File, REFIT_VOLUME *Volume, CHAR16 *Title) {
582 REFIT_MENU_SCREEN *SubScreen;
583 LOADER_ENTRY *SubEntry;
584 UINTN TokenCount;
585 CHAR16 **TokenList;
586
587 SubScreen = InitializeSubScreen(Entry);
588
589 // Set defaults for the new entry; will be modified based on lines read from the config. file....
590 SubEntry = InitializeLoaderEntry(Entry);
591
592 if ((SubEntry == NULL) || (SubScreen == NULL))
593 return;
594 SubEntry->me.Title = StrDuplicate(Title);
595
596 while (((TokenCount = ReadTokenLine(File, &TokenList)) > 0) && (StriCmp(TokenList[0], L"}") != 0)) {
597
598 if ((StriCmp(TokenList[0], L"loader") == 0) && (TokenCount > 1)) { // set the boot loader filename
599 MyFreePool(SubEntry->LoaderPath);
600 SubEntry->LoaderPath = StrDuplicate(TokenList[1]);
601 SubEntry->DevicePath = FileDevicePath(Volume->DeviceHandle, SubEntry->LoaderPath);
602
603 } else if ((StriCmp(TokenList[0], L"volume") == 0) && (TokenCount > 1)) {
604 if (FindVolume(&Volume, TokenList[1])) {
605 MyFreePool(SubEntry->me.Title);
606 SubEntry->me.Title = AllocateZeroPool(256 * sizeof(CHAR16));
607 SPrint(SubEntry->me.Title, 255, L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", Volume->VolName);
608 SubEntry->me.BadgeImage = Volume->VolBadgeImage;
609 SubEntry->VolName = Volume->VolName;
610 } // if match found
611
612 } else if (StriCmp(TokenList[0], L"initrd") == 0) {
613 MyFreePool(SubEntry->InitrdPath);
614 SubEntry->InitrdPath = NULL;
615 if (TokenCount > 1) {
616 SubEntry->InitrdPath = StrDuplicate(TokenList[1]);
617 }
618
619 } else if (StriCmp(TokenList[0], L"options") == 0) {
620 MyFreePool(SubEntry->LoadOptions);
621 SubEntry->LoadOptions = NULL;
622 if (TokenCount > 1) {
623 SubEntry->LoadOptions = StrDuplicate(TokenList[1]);
624 } // if/else
625
626 } else if ((StriCmp(TokenList[0], L"add_options") == 0) && (TokenCount > 1)) {
627 MergeStrings(&SubEntry->LoadOptions, TokenList[1], L' ');
628
629 } else if ((StriCmp(TokenList[0], L"graphics") == 0) && (TokenCount > 1)) {
630 SubEntry->UseGraphicsMode = (StriCmp(TokenList[1], L"on") == 0);
631
632 } else if (StriCmp(TokenList[0], L"disabled") == 0) {
633 SubEntry->Enabled = FALSE;
634 } // ief/elseif
635
636 FreeTokenLine(&TokenList, &TokenCount);
637 } // while()
638
639 if (SubEntry->InitrdPath != NULL) {
640 MergeStrings(&SubEntry->LoadOptions, L"initrd=", L' ');
641 MergeStrings(&SubEntry->LoadOptions, SubEntry->InitrdPath, 0);
642 MyFreePool(SubEntry->InitrdPath);
643 SubEntry->InitrdPath = NULL;
644 } // if
645 if (SubEntry->Enabled == TRUE) {
646 AddMenuEntry(SubScreen, (REFIT_MENU_ENTRY *)SubEntry);
647 }
648 Entry->me.SubScreen = SubScreen;
649 } // VOID AddSubmenu()
650
651 // Adds the options from a SINGLE refind.conf stanza to a new loader entry and returns
652 // that entry. The calling function is then responsible for adding the entry to the
653 // list of entries.
654 static LOADER_ENTRY * AddStanzaEntries(REFIT_FILE *File, REFIT_VOLUME *Volume, CHAR16 *Title) {
655 CHAR16 **TokenList;
656 UINTN TokenCount;
657 LOADER_ENTRY *Entry;
658 BOOLEAN DefaultsSet = FALSE, AddedSubmenu = FALSE;
659 REFIT_VOLUME *CurrentVolume = Volume;
660
661 // prepare the menu entry
662 Entry = InitializeLoaderEntry(NULL);
663 if (Entry == NULL)
664 return NULL;
665
666 Entry->Title = StrDuplicate(Title);
667 Entry->me.Title = AllocateZeroPool(256 * sizeof(CHAR16));
668 SPrint(Entry->me.Title, 255, L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", CurrentVolume->VolName);
669 Entry->me.Row = 0;
670 Entry->me.BadgeImage = CurrentVolume->VolBadgeImage;
671 Entry->VolName = CurrentVolume->VolName;
672
673 // Parse the config file to add options for a single stanza, terminating when the token
674 // is "}" or when the end of file is reached.
675 while (((TokenCount = ReadTokenLine(File, &TokenList)) > 0) && (StriCmp(TokenList[0], L"}") != 0)) {
676 if ((StriCmp(TokenList[0], L"loader") == 0) && (TokenCount > 1)) { // set the boot loader filename
677 Entry->LoaderPath = StrDuplicate(TokenList[1]);
678 Entry->DevicePath = FileDevicePath(CurrentVolume->DeviceHandle, Entry->LoaderPath);
679 SetLoaderDefaults(Entry, TokenList[1], CurrentVolume);
680 MyFreePool(Entry->LoadOptions);
681 Entry->LoadOptions = NULL; // Discard default options, if any
682 DefaultsSet = TRUE;
683
684 } else if ((StriCmp(TokenList[0], L"volume") == 0) && (TokenCount > 1)) {
685 if (FindVolume(&CurrentVolume, TokenList[1])) {
686 MyFreePool(Entry->me.Title);
687 Entry->me.Title = AllocateZeroPool(256 * sizeof(CHAR16));
688 SPrint(Entry->me.Title, 255, L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", CurrentVolume->VolName);
689 Entry->me.BadgeImage = CurrentVolume->VolBadgeImage;
690 Entry->VolName = CurrentVolume->VolName;
691 } // if match found
692
693 } else if ((StriCmp(TokenList[0], L"icon") == 0) && (TokenCount > 1)) {
694 MyFreePool(Entry->me.Image);
695 Entry->me.Image = egLoadIcon(CurrentVolume->RootDir, TokenList[1], 128);
696 if (Entry->me.Image == NULL) {
697 Entry->me.Image = DummyImage(128);
698 }
699
700 } else if ((StriCmp(TokenList[0], L"initrd") == 0) && (TokenCount > 1)) {
701 MyFreePool(Entry->InitrdPath);
702 Entry->InitrdPath = StrDuplicate(TokenList[1]);
703
704 } else if ((StriCmp(TokenList[0], L"options") == 0) && (TokenCount > 1)) {
705 MyFreePool(Entry->LoadOptions);
706 Entry->LoadOptions = StrDuplicate(TokenList[1]);
707
708 } else if ((StriCmp(TokenList[0], L"ostype") == 0) && (TokenCount > 1)) {
709 if (TokenCount > 1) {
710 Entry->OSType = TokenList[1][0];
711 }
712
713 } else if ((StriCmp(TokenList[0], L"graphics") == 0) && (TokenCount > 1)) {
714 Entry->UseGraphicsMode = (StriCmp(TokenList[1], L"on") == 0);
715
716 } else if (StriCmp(TokenList[0], L"disabled") == 0) {
717 Entry->Enabled = FALSE;
718
719 } else if ((StriCmp(TokenList[0], L"submenuentry") == 0) && (TokenCount > 1)) {
720 AddSubmenu(Entry, File, CurrentVolume, TokenList[1]);
721 AddedSubmenu = TRUE;
722
723 } // set options to pass to the loader program
724 FreeTokenLine(&TokenList, &TokenCount);
725 } // while()
726
727 if (AddedSubmenu)
728 AddMenuEntry(Entry->me.SubScreen, &MenuEntryReturn);
729
730 if (Entry->InitrdPath) {
731 MergeStrings(&Entry->LoadOptions, L"initrd=", L' ');
732 MergeStrings(&Entry->LoadOptions, Entry->InitrdPath, 0);
733 MyFreePool(Entry->InitrdPath);
734 Entry->InitrdPath = NULL;
735 } // if
736
737 if (!DefaultsSet)
738 SetLoaderDefaults(Entry, L"\\EFI\\BOOT\\nemo.efi", CurrentVolume); // user included no "loader" line; use bogus one
739
740 return(Entry);
741 } // static VOID AddStanzaEntries()
742
743 // Read the user-configured menu entries from refind.conf and add or delete
744 // entries based on the contents of that file....
745 VOID ScanUserConfigured(CHAR16 *FileName)
746 {
747 EFI_STATUS Status;
748 REFIT_FILE File;
749 REFIT_VOLUME *Volume;
750 CHAR16 **TokenList;
751 CHAR16 *Title = NULL;
752 UINTN TokenCount, size;
753 LOADER_ENTRY *Entry;
754
755 if (FileExists(SelfDir, FileName)) {
756 Status = ReadFile(SelfDir, FileName, &File, &size);
757 if (EFI_ERROR(Status))
758 return;
759
760 Volume = SelfVolume;
761
762 while ((TokenCount = ReadTokenLine(&File, &TokenList)) > 0) {
763 if ((StriCmp(TokenList[0], L"menuentry") == 0) && (TokenCount > 1)) {
764 Title = StrDuplicate(TokenList[1]);
765 Entry = AddStanzaEntries(&File, Volume, TokenList[1]);
766 if (Entry->Enabled) {
767 if (Entry->me.SubScreen == NULL)
768 GenerateSubScreen(Entry, Volume);
769 AddPreparedLoaderEntry(Entry);
770 } else {
771 MyFreePool(Entry);
772 } // if/else
773 MyFreePool(Title);
774
775 } else if ((StriCmp(TokenList[0], L"include") == 0) && (TokenCount == 2) && (StriCmp(FileName, CONFIG_FILE_NAME) == 0)) {
776 if (StriCmp(TokenList[1], FileName) != 0) {
777 ScanUserConfigured(TokenList[1]);
778 }
779
780 } // if/else if...
781 FreeTokenLine(&TokenList, &TokenCount);
782 } // while()
783 } // if()
784 } // VOID ScanUserConfigured()
785
786 // Create an options file based on /etc/fstab. The resulting file has two options
787 // lines, one of which boots the system with "ro root={rootfs}" and the other of
788 // which boots the system with "ro root={rootfs} single", where "{rootfs}" is the
789 // filesystem identifier associated with the "/" line in /etc/fstab.
790 static REFIT_FILE * GenerateOptionsFromEtcFstab(REFIT_VOLUME *Volume) {
791 UINTN TokenCount, i;
792 REFIT_FILE *Options = NULL, *Fstab = NULL;
793 EFI_STATUS Status;
794 CHAR16 **TokenList, Line[513], Root[100];
795
796 if (FileExists(Volume->RootDir, L"\\etc\\fstab")) {
797 Options = AllocateZeroPool(sizeof(REFIT_FILE));
798 Fstab = AllocateZeroPool(sizeof(REFIT_FILE));
799 Status = ReadFile(Volume->RootDir, L"\\etc\\fstab", Fstab, &i);
800 if (CheckError(Status, L"while reading /etc/fstab")) {
801 if (Options != NULL)
802 FreePool(Options);
803 if (Fstab != NULL)
804 FreePool(Fstab);
805 Options = NULL;
806 Fstab = NULL;
807 } else { // File read; locate root fs and create entries
808 Options->Encoding = ENCODING_UTF16_LE;
809 Line[0] = '\0';
810 while ((TokenCount = ReadTokenLine(Fstab, &TokenList)) > 0) {
811 if (TokenCount > 2) {
812 Root[0] = '\0';
813 if (StriCmp(TokenList[1], L"\\") == 0) {
814 SPrint(Root, 99, L"%s", TokenList[0]);
815 } else if (StriCmp(TokenList[2], L"\\") == 0) {
816 SPrint(Root, 99, L"%s=%s", TokenList[0], TokenList[1]);
817 } // if/elseif/elseif
818 if (Root[0] != L'\0') {
819 for (i = 0; i < StrLen(Root); i++)
820 if (Root[i] == '\\')
821 Root[i] = '/';
822 SPrint(Line, 512, L"\"Boot with normal options\" \"ro root=%s\"\n", Root);
823 MergeStrings((CHAR16 **) &(Options->Buffer), Line, 0);
824 SPrint(Line, 512, L"\"Boot into single-user mode\" \"ro root=%s single\"\n", Root);
825 MergeStrings((CHAR16**) &(Options->Buffer), Line, 0);
826 Options->BufferSize = StrLen((CHAR16*) Options->Buffer) * sizeof(CHAR16);
827 } // if
828 } // if
829 FreeTokenLine(&TokenList, &TokenCount);
830 } // while
831
832 Options->Current8Ptr = (CHAR8 *)Options->Buffer;
833 Options->End8Ptr = Options->Current8Ptr + Options->BufferSize;
834 Options->Current16Ptr = (CHAR16 *)Options->Buffer;
835 Options->End16Ptr = Options->Current16Ptr + (Options->BufferSize >> 1);
836
837 MyFreePool(Fstab->Buffer);
838 MyFreePool(Fstab);
839 } // if/else file read error
840 } // if /etc/fstab exists
841 return Options;
842 } // GenerateOptionsFromEtcFstab()
843
844
845 // Read a Linux kernel options file for a Linux boot loader into memory. The LoaderPath
846 // and Volume variables identify the location of the options file, but not its name --
847 // you pass this function the filename of the Linux kernel, initial RAM disk, or other
848 // file in the target directory, and this function finds the file with a name in the
849 // comma-delimited list of names specified by LINUX_OPTIONS_FILENAMES within that
850 // directory and loads it. This function tries multiple files because I originally
851 // used the filename linux.conf, but close on the heels of that decision, the Linux
852 // kernel developers decided to use that name for a similar purpose, but with a
853 // different file format. Thus, I'm migrating rEFInd to use the name refind_linux.conf,
854 // but I want a migration period in which both names are used.
855 // If a rEFInd options file can't be found, try to generate minimal options from
856 // /etc/fstab on the same volume as the kernel. This typically works only if the
857 // kernel is being read from the Linux root filesystem.
858 //
859 // The return value is a pointer to the REFIT_FILE handle for the file, or NULL if
860 // it wasn't found.
861 REFIT_FILE * ReadLinuxOptionsFile(IN CHAR16 *LoaderPath, IN REFIT_VOLUME *Volume) {
862 CHAR16 *OptionsFilename, *FullFilename;
863 BOOLEAN GoOn = TRUE, FileFound = FALSE;
864 UINTN i = 0, size;
865 REFIT_FILE *File = NULL;
866 EFI_STATUS Status;
867
868 do {
869 OptionsFilename = FindCommaDelimited(LINUX_OPTIONS_FILENAMES, i++);
870 FullFilename = FindPath(LoaderPath);
871 if ((OptionsFilename != NULL) && (FullFilename != NULL)) {
872 MergeStrings(&FullFilename, OptionsFilename, '\\');
873 if (FileExists(Volume->RootDir, FullFilename)) {
874 File = AllocateZeroPool(sizeof(REFIT_FILE));
875 Status = ReadFile(Volume->RootDir, FullFilename, File, &size);
876 if (CheckError(Status, L"while loading the Linux options file")) {
877 if (File != NULL)
878 FreePool(File);
879 File = NULL;
880 } else {
881 GoOn = FALSE;
882 FileFound = TRUE;
883 } // if/else error
884 } // if file exists
885 } else { // a filename string is NULL
886 GoOn = FALSE;
887 } // if/else
888 if (!FileFound)
889 File = GenerateOptionsFromEtcFstab(Volume);
890 MyFreePool(OptionsFilename);
891 MyFreePool(FullFilename);
892 OptionsFilename = FullFilename = NULL;
893 } while (GoOn);
894 return (File);
895 } // static REFIT_FILE * ReadLinuxOptionsFile()
896
897 // Retrieve a single line of options from a Linux kernel options file
898 CHAR16 * GetFirstOptionsFromFile(IN CHAR16 *LoaderPath, IN REFIT_VOLUME *Volume) {
899 UINTN TokenCount;
900 CHAR16 *Options = NULL;
901 CHAR16 **TokenList;
902 REFIT_FILE *File;
903
904 File = ReadLinuxOptionsFile(LoaderPath, Volume);
905 if (File != NULL) {
906 TokenCount = ReadTokenLine(File, &TokenList);
907 if (TokenCount > 1)
908 Options = StrDuplicate(TokenList[1]);
909 FreeTokenLine(&TokenList, &TokenCount);
910 FreePool(File);
911 } // if
912 return Options;
913 } // static CHAR16 * GetOptionsFile()
914