]> code.delx.au - refind/blob - refind/config.c
delx.au / code / refind / blob
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
Return of PoolPrint() function; modified launch code to include
[refind] / refind / config.c
1 /*
2 * refind/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 *TempStr = 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 TempStr = SelfVolume->VolName ? StrDuplicate(SelfVolume->VolName) : NULL;
354 } else {
355 TempStr = AllocateZeroPool(256 * sizeof(CHAR16));
356 if (TempStr != NULL)
357 SPrint(TempStr, 255, L"fs%d", SelfVolume->VolNumber);
358 } // if/else
359 }
360 MergeStrings(&TempStr, SelfDirPath, L':');
361 MergeStrings(&TempStr, MEMTEST_LOCATIONS, L',');
362 GlobalConfig.DontScanDirs = TempStr;
363 MyFreePool(GlobalConfig.DontScanFiles);
364 GlobalConfig.DontScanFiles = StrDuplicate(DONT_SCAN_FILES);
365 MergeStrings(&(GlobalConfig.DontScanFiles), MOK_NAMES, L',');
366 MyFreePool(GlobalConfig.DontScanVolumes);
367 GlobalConfig.DontScanVolumes = StrDuplicate(DONT_SCAN_VOLUMES);
368 } // if
369
370 if (!FileExists(SelfDir, FileName)) {
371 Print(L"Configuration file '%s' missing!\n", FileName);
372 return;
373 }
374
375 Status = ReadFile(SelfDir, FileName, &File, &i);
376 if (EFI_ERROR(Status))
377 return;
378
379 for (;;) {
380 TokenCount = ReadTokenLine(&File, &TokenList);
381 if (TokenCount == 0)
382 break;
383
384 if (StriCmp(TokenList[0], L"timeout") == 0) {
385 HandleInt(TokenList, TokenCount, &(GlobalConfig.Timeout));
386
387 } else if (StriCmp(TokenList[0], L"hideui") == 0) {
388 for (i = 1; i < TokenCount; i++) {
389 FlagName = TokenList[i];
390 if (StriCmp(FlagName, L"banner") == 0) {
391 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_BANNER;
392 } else if (StriCmp(FlagName, L"label") == 0) {
393 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_LABEL;
394 } else if (StriCmp(FlagName, L"singleuser") == 0) {
395 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_SINGLEUSER;
396 } else if (StriCmp(FlagName, L"hwtest") == 0) {
397 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_HWTEST;
398 } else if (StriCmp(FlagName, L"arrows") == 0) {
399 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_ARROWS;
400 } else if (StriCmp(FlagName, L"hints") == 0) {
401 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_HINTS;
402 } else if (StriCmp(FlagName, L"editor") == 0) {
403 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_EDITOR;
404 } else if (StriCmp(FlagName, L"safemode") == 0) {
405 GlobalConfig.HideUIFlags |= HIDEUI_FLAG_SAFEMODE;
406 } else if (StriCmp(FlagName, L"all") == 0) {
407 GlobalConfig.HideUIFlags = HIDEUI_FLAG_ALL;
408 } else {
409 Print(L" unknown hideui flag: '%s'\n", FlagName);
410 }
411 }
412
413 } else if (StriCmp(TokenList[0], L"icons_dir") == 0) {
414 HandleString(TokenList, TokenCount, &(GlobalConfig.IconsDir));
415
416 } else if (StriCmp(TokenList[0], L"scanfor") == 0) {
417 for (i = 0; i < NUM_SCAN_OPTIONS; i++) {
418 if (i < TokenCount)
419 GlobalConfig.ScanFor[i] = TokenList[i][0];
420 else
421 GlobalConfig.ScanFor[i] = ' ';
422 }
423
424 } else if ((StriCmp(TokenList[0], L"scan_delay") == 0) && (TokenCount == 2)) {
425 HandleInt(TokenList, TokenCount, &(GlobalConfig.ScanDelay));
426
427 } else if (StriCmp(TokenList[0], L"also_scan_dirs") == 0) {
428 HandleStrings(TokenList, TokenCount, &(GlobalConfig.AlsoScan));
429
430 } else if ((StriCmp(TokenList[0], L"don't_scan_volumes") == 0) || (StriCmp(TokenList[0], L"dont_scan_volumes") == 0)) {
431 // Note: Don't use HandleStrings() because it modifies slashes, which might be present in volume name
432 MyFreePool(GlobalConfig.DontScanVolumes);
433 GlobalConfig.DontScanVolumes = NULL;
434 for (i = 1; i < TokenCount; i++) {
435 MergeStrings(&GlobalConfig.DontScanVolumes, TokenList[i], L',');
436 }
437
438 } else if ((StriCmp(TokenList[0], L"don't_scan_dirs") == 0) || (StriCmp(TokenList[0], L"dont_scan_dirs") == 0)) {
439 HandleStrings(TokenList, TokenCount, &(GlobalConfig.DontScanDirs));
440
441 } else if ((StriCmp(TokenList[0], L"don't_scan_files") == 0) || (StriCmp(TokenList[0], L"dont_scan_files") == 0)) {
442 HandleStrings(TokenList, TokenCount, &(GlobalConfig.DontScanFiles));
443
444 } else if (StriCmp(TokenList[0], L"scan_driver_dirs") == 0) {
445 HandleStrings(TokenList, TokenCount, &(GlobalConfig.DriverDirs));
446
447 } else if (StriCmp(TokenList[0], L"showtools") == 0) {
448 SetMem(GlobalConfig.ShowTools, NUM_TOOLS * sizeof(UINTN), 0);
449 for (i = 1; (i < TokenCount) && (i < NUM_TOOLS); i++) {
450 FlagName = TokenList[i];
451 if (StriCmp(FlagName, L"shell") == 0) {
452 GlobalConfig.ShowTools[i - 1] = TAG_SHELL;
453 } else if (StriCmp(FlagName, L"gptsync") == 0) {
454 GlobalConfig.ShowTools[i - 1] = TAG_GPTSYNC;
455 } else if (StriCmp(FlagName, L"about") == 0) {
456 GlobalConfig.ShowTools[i - 1] = TAG_ABOUT;
457 } else if (StriCmp(FlagName, L"exit") == 0) {
458 GlobalConfig.ShowTools[i - 1] = TAG_EXIT;
459 } else if (StriCmp(FlagName, L"reboot") == 0) {
460 GlobalConfig.ShowTools[i - 1] = TAG_REBOOT;
461 } else if (StriCmp(FlagName, L"shutdown") == 0) {
462 GlobalConfig.ShowTools[i - 1] = TAG_SHUTDOWN;
463 } else if (StriCmp(FlagName, L"apple_recovery") == 0) {
464 GlobalConfig.ShowTools[i - 1] = TAG_APPLE_RECOVERY;
465 } else if (StriCmp(FlagName, L"mok_tool") == 0) {
466 GlobalConfig.ShowTools[i - 1] = TAG_MOK_TOOL;
467 } else if (StriCmp(FlagName, L"firmware") == 0) {
468 GlobalConfig.ShowTools[i - 1] = TAG_FIRMWARE;
469 } else if ((StriCmp(FlagName, L"memtest86") == 0) || (StriCmp(FlagName, L"memtest") == 0)) {
470 GlobalConfig.ShowTools[i - 1] = TAG_MEMTEST;
471 } else {
472 Print(L" unknown showtools flag: '%s'\n", FlagName);
473 }
474 } // showtools options
475
476 } else if (StriCmp(TokenList[0], L"banner") == 0) {
477 HandleString(TokenList, TokenCount, &(GlobalConfig.BannerFileName));
478
479 } else if (StriCmp(TokenList[0], L"selection_small") == 0) {
480 HandleString(TokenList, TokenCount, &(GlobalConfig.SelectionSmallFileName));
481
482 } else if (StriCmp(TokenList[0], L"selection_big") == 0) {
483 HandleString(TokenList, TokenCount, &(GlobalConfig.SelectionBigFileName));
484
485 } else if (StriCmp(TokenList[0], L"default_selection") == 0) {
486 HandleString(TokenList, TokenCount, &(GlobalConfig.DefaultSelection));
487
488 } else if (StriCmp(TokenList[0], L"textonly") == 0) {
489 if ((TokenCount >= 2) && (StriCmp(TokenList[1], L"0") == 0)) {
490 GlobalConfig.TextOnly = FALSE;
491 } else {
492 GlobalConfig.TextOnly = TRUE;
493 }
494
495 } else if (StriCmp(TokenList[0], L"textmode") == 0) {
496 HandleInt(TokenList, TokenCount, &(GlobalConfig.RequestedTextMode));
497
498 } else if ((StriCmp(TokenList[0], L"resolution") == 0) && ((TokenCount == 2) || (TokenCount == 3))) {
499 GlobalConfig.RequestedScreenWidth = Atoi(TokenList[1]);
500 if (TokenCount == 3)
501 GlobalConfig.RequestedScreenHeight = Atoi(TokenList[2]);
502 else
503 GlobalConfig.RequestedScreenHeight = 0;
504
505 } else if (StriCmp(TokenList[0], L"screensaver") == 0) {
506 HandleInt(TokenList, TokenCount, &(GlobalConfig.ScreensaverTime));
507
508 } else if (StriCmp(TokenList[0], L"use_graphics_for") == 0) {
509 GlobalConfig.GraphicsFor = 0;
510 for (i = 1; i < TokenCount; i++) {
511 if (StriCmp(TokenList[i], L"osx") == 0) {
512 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_OSX;
513 } else if (StriCmp(TokenList[i], L"linux") == 0) {
514 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_LINUX;
515 } else if (StriCmp(TokenList[i], L"elilo") == 0) {
516 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_ELILO;
517 } else if (StriCmp(TokenList[i], L"grub") == 0) {
518 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_GRUB;
519 } else if (StriCmp(TokenList[i], L"windows") == 0) {
520 GlobalConfig.GraphicsFor |= GRAPHICS_FOR_WINDOWS;
521 }
522 } // for (graphics_on tokens)
523
524 } else if ((StriCmp(TokenList[0], L"font") == 0) && (TokenCount == 2)) {
525 egLoadFont(TokenList[1]);
526
527 } else if (StriCmp(TokenList[0], L"scan_all_linux_kernels") == 0) {
528 if ((TokenCount >= 2) && (StriCmp(TokenList[1], L"0") == 0)) {
529 GlobalConfig.ScanAllLinux = FALSE;
530 } else {
531 GlobalConfig.ScanAllLinux = TRUE;
532 }
533
534 } else if (StriCmp(TokenList[0], L"max_tags") == 0) {
535 HandleInt(TokenList, TokenCount, &(GlobalConfig.MaxTags));
536
537 } else if ((StriCmp(TokenList[0], L"include") == 0) && (TokenCount == 2) && (StriCmp(FileName, CONFIG_FILE_NAME) == 0)) {
538 if (StriCmp(TokenList[1], FileName) != 0) {
539 ReadConfig(TokenList[1]);
540 }
541
542 }
543
544 FreeTokenLine(&TokenList, &TokenCount);
545 }
546 MyFreePool(File.Buffer);
547 } /* VOID ReadConfig() */
548
549 // Finds a volume with the specified Identifier (a volume label or a number
550 // followed by a colon, for the moment). If found, sets *Volume to point to
551 // that volume. If not, leaves it unchanged.
552 // Returns TRUE if a match was found, FALSE if not.
553 static BOOLEAN FindVolume(REFIT_VOLUME **Volume, CHAR16 *Identifier) {
554 UINTN i = 0, CountedVolumes = 0;
555 INTN Number = -1;
556 BOOLEAN Found = FALSE;
557
558 if ((StrLen(Identifier) >= 2) && (Identifier[StrLen(Identifier) - 1] == L':') &&
559 (Identifier[0] >= L'0') && (Identifier[0] <= L'9')) {
560 Number = (INTN) Atoi(Identifier);
561 }
562 while ((i < VolumesCount) && (!Found)) {
563 if (Number >= 0) { // User specified a volume by number
564 if (Volumes[i]->IsReadable) {
565 if (CountedVolumes == Number) {
566 *Volume = Volumes[i];
567 Found = TRUE;
568 }
569 CountedVolumes++;
570 } // if
571 } else { // User specified a volume by label
572 if (StriCmp(Identifier, Volumes[i]->VolName) == 0) {
573 *Volume = Volumes[i];
574 Found = TRUE;
575 } // if
576 } // if/else
577 i++;
578 } // while()
579 return (Found);
580 } // static VOID FindVolume()
581
582 static VOID AddSubmenu(LOADER_ENTRY *Entry, REFIT_FILE *File, REFIT_VOLUME *Volume, CHAR16 *Title) {
583 REFIT_MENU_SCREEN *SubScreen;
584 LOADER_ENTRY *SubEntry;
585 UINTN TokenCount;
586 CHAR16 **TokenList;
587
588 SubScreen = InitializeSubScreen(Entry);
589
590 // Set defaults for the new entry; will be modified based on lines read from the config. file....
591 SubEntry = InitializeLoaderEntry(Entry);
592
593 if ((SubEntry == NULL) || (SubScreen == NULL))
594 return;
595 SubEntry->me.Title = StrDuplicate(Title);
596
597 while (((TokenCount = ReadTokenLine(File, &TokenList)) > 0) && (StriCmp(TokenList[0], L"}") != 0)) {
598
599 if ((StriCmp(TokenList[0], L"loader") == 0) && (TokenCount > 1)) { // set the boot loader filename
600 MyFreePool(SubEntry->LoaderPath);
601 SubEntry->LoaderPath = StrDuplicate(TokenList[1]);
602 SubEntry->DevicePath = FileDevicePath(Volume->DeviceHandle, SubEntry->LoaderPath);
603
604 } else if ((StriCmp(TokenList[0], L"volume") == 0) && (TokenCount > 1)) {
605 if (FindVolume(&Volume, TokenList[1])) {
606 MyFreePool(SubEntry->me.Title);
607 SubEntry->me.Title = AllocateZeroPool(256 * sizeof(CHAR16));
608 SPrint(SubEntry->me.Title, 255, L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", Volume->VolName);
609 SubEntry->me.BadgeImage = Volume->VolBadgeImage;
610 SubEntry->VolName = Volume->VolName;
611 } // if match found
612
613 } else if (StriCmp(TokenList[0], L"initrd") == 0) {
614 MyFreePool(SubEntry->InitrdPath);
615 SubEntry->InitrdPath = NULL;
616 if (TokenCount > 1) {
617 SubEntry->InitrdPath = StrDuplicate(TokenList[1]);
618 }
619
620 } else if (StriCmp(TokenList[0], L"options") == 0) {
621 MyFreePool(SubEntry->LoadOptions);
622 SubEntry->LoadOptions = NULL;
623 if (TokenCount > 1) {
624 SubEntry->LoadOptions = StrDuplicate(TokenList[1]);
625 } // if/else
626
627 } else if ((StriCmp(TokenList[0], L"add_options") == 0) && (TokenCount > 1)) {
628 MergeStrings(&SubEntry->LoadOptions, TokenList[1], L' ');
629
630 } else if ((StriCmp(TokenList[0], L"graphics") == 0) && (TokenCount > 1)) {
631 SubEntry->UseGraphicsMode = (StriCmp(TokenList[1], L"on") == 0);
632
633 } else if (StriCmp(TokenList[0], L"disabled") == 0) {
634 SubEntry->Enabled = FALSE;
635 } // ief/elseif
636
637 FreeTokenLine(&TokenList, &TokenCount);
638 } // while()
639
640 if (SubEntry->InitrdPath != NULL) {
641 MergeStrings(&SubEntry->LoadOptions, L"initrd=", L' ');
642 MergeStrings(&SubEntry->LoadOptions, SubEntry->InitrdPath, 0);
643 MyFreePool(SubEntry->InitrdPath);
644 SubEntry->InitrdPath = NULL;
645 } // if
646 if (SubEntry->Enabled == TRUE) {
647 AddMenuEntry(SubScreen, (REFIT_MENU_ENTRY *)SubEntry);
648 }
649 Entry->me.SubScreen = SubScreen;
650 } // VOID AddSubmenu()
651
652 // Adds the options from a SINGLE refind.conf stanza to a new loader entry and returns
653 // that entry. The calling function is then responsible for adding the entry to the
654 // list of entries.
655 static LOADER_ENTRY * AddStanzaEntries(REFIT_FILE *File, REFIT_VOLUME *Volume, CHAR16 *Title) {
656 CHAR16 **TokenList;
657 UINTN TokenCount;
658 LOADER_ENTRY *Entry;
659 BOOLEAN DefaultsSet = FALSE, AddedSubmenu = FALSE;
660 REFIT_VOLUME *CurrentVolume = Volume;
661
662 // prepare the menu entry
663 Entry = InitializeLoaderEntry(NULL);
664 if (Entry == NULL)
665 return NULL;
666
667 Entry->Title = StrDuplicate(Title);
668 Entry->me.Title = AllocateZeroPool(256 * sizeof(CHAR16));
669 SPrint(Entry->me.Title, 255, L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", CurrentVolume->VolName);
670 Entry->me.Row = 0;
671 Entry->me.BadgeImage = CurrentVolume->VolBadgeImage;
672 Entry->VolName = CurrentVolume->VolName;
673
674 // Parse the config file to add options for a single stanza, terminating when the token
675 // is "}" or when the end of file is reached.
676 while (((TokenCount = ReadTokenLine(File, &TokenList)) > 0) && (StriCmp(TokenList[0], L"}") != 0)) {
677 if ((StriCmp(TokenList[0], L"loader") == 0) && (TokenCount > 1)) { // set the boot loader filename
678 Entry->LoaderPath = StrDuplicate(TokenList[1]);
679 Entry->DevicePath = FileDevicePath(CurrentVolume->DeviceHandle, Entry->LoaderPath);
680 SetLoaderDefaults(Entry, TokenList[1], CurrentVolume);
681 MyFreePool(Entry->LoadOptions);
682 Entry->LoadOptions = NULL; // Discard default options, if any
683 DefaultsSet = TRUE;
684
685 } else if ((StriCmp(TokenList[0], L"volume") == 0) && (TokenCount > 1)) {
686 if (FindVolume(&CurrentVolume, TokenList[1])) {
687 MyFreePool(Entry->me.Title);
688 Entry->me.Title = AllocateZeroPool(256 * sizeof(CHAR16));
689 SPrint(Entry->me.Title, 255, L"Boot %s from %s", (Title != NULL) ? Title : L"Unknown", CurrentVolume->VolName);
690 Entry->me.BadgeImage = CurrentVolume->VolBadgeImage;
691 Entry->VolName = CurrentVolume->VolName;
692 } // if match found
693
694 } else if ((StriCmp(TokenList[0], L"icon") == 0) && (TokenCount > 1)) {
695 MyFreePool(Entry->me.Image);
696 Entry->me.Image = egLoadIcon(CurrentVolume->RootDir, TokenList[1], 128);
697 if (Entry->me.Image == NULL) {
698 Entry->me.Image = DummyImage(128);
699 }
700
701 } else if ((StriCmp(TokenList[0], L"initrd") == 0) && (TokenCount > 1)) {
702 MyFreePool(Entry->InitrdPath);
703 Entry->InitrdPath = StrDuplicate(TokenList[1]);
704
705 } else if ((StriCmp(TokenList[0], L"options") == 0) && (TokenCount > 1)) {
706 MyFreePool(Entry->LoadOptions);
707 Entry->LoadOptions = StrDuplicate(TokenList[1]);
708
709 } else if ((StriCmp(TokenList[0], L"ostype") == 0) && (TokenCount > 1)) {
710 if (TokenCount > 1) {
711 Entry->OSType = TokenList[1][0];
712 }
713
714 } else if ((StriCmp(TokenList[0], L"graphics") == 0) && (TokenCount > 1)) {
715 Entry->UseGraphicsMode = (StriCmp(TokenList[1], L"on") == 0);
716
717 } else if (StriCmp(TokenList[0], L"disabled") == 0) {
718 Entry->Enabled = FALSE;
719
720 } else if ((StriCmp(TokenList[0], L"submenuentry") == 0) && (TokenCount > 1)) {
721 AddSubmenu(Entry, File, CurrentVolume, TokenList[1]);
722 AddedSubmenu = TRUE;
723
724 } // set options to pass to the loader program
725 FreeTokenLine(&TokenList, &TokenCount);
726 } // while()
727
728 if (AddedSubmenu)
729 AddMenuEntry(Entry->me.SubScreen, &MenuEntryReturn);
730
731 if (Entry->InitrdPath) {
732 MergeStrings(&Entry->LoadOptions, L"initrd=", L' ');
733 MergeStrings(&Entry->LoadOptions, Entry->InitrdPath, 0);
734 MyFreePool(Entry->InitrdPath);
735 Entry->InitrdPath = NULL;
736 } // if
737
738 if (!DefaultsSet)
739 SetLoaderDefaults(Entry, L"\\EFI\\BOOT\\nemo.efi", CurrentVolume); // user included no "loader" line; use bogus one
740
741 return(Entry);
742 } // static VOID AddStanzaEntries()
743
744 // Read the user-configured menu entries from refind.conf and add or delete
745 // entries based on the contents of that file....
746 VOID ScanUserConfigured(CHAR16 *FileName)
747 {
748 EFI_STATUS Status;
749 REFIT_FILE File;
750 REFIT_VOLUME *Volume;
751 CHAR16 **TokenList;
752 CHAR16 *Title = NULL;
753 UINTN TokenCount, size;
754 LOADER_ENTRY *Entry;
755
756 if (FileExists(SelfDir, FileName)) {
757 Status = ReadFile(SelfDir, FileName, &File, &size);
758 if (EFI_ERROR(Status))
759 return;
760
761 Volume = SelfVolume;
762
763 while ((TokenCount = ReadTokenLine(&File, &TokenList)) > 0) {
764 if ((StriCmp(TokenList[0], L"menuentry") == 0) && (TokenCount > 1)) {
765 Title = StrDuplicate(TokenList[1]);
766 Entry = AddStanzaEntries(&File, Volume, TokenList[1]);
767 if (Entry->Enabled) {
768 if (Entry->me.SubScreen == NULL)
769 GenerateSubScreen(Entry, Volume);
770 AddPreparedLoaderEntry(Entry);
771 } else {
772 MyFreePool(Entry);
773 } // if/else
774 MyFreePool(Title);
775
776 } else if ((StriCmp(TokenList[0], L"include") == 0) && (TokenCount == 2) && (StriCmp(FileName, CONFIG_FILE_NAME) == 0)) {
777 if (StriCmp(TokenList[1], FileName) != 0) {
778 ScanUserConfigured(TokenList[1]);
779 }
780
781 } // if/else if...
782 FreeTokenLine(&TokenList, &TokenCount);
783 } // while()
784 } // if()
785 } // VOID ScanUserConfigured()
786
787 // Create an options file based on /etc/fstab. The resulting file has two options
788 // lines, one of which boots the system with "ro root={rootfs}" and the other of
789 // which boots the system with "ro root={rootfs} single", where "{rootfs}" is the
790 // filesystem identifier associated with the "/" line in /etc/fstab.
791 static REFIT_FILE * GenerateOptionsFromEtcFstab(REFIT_VOLUME *Volume) {
792 UINTN TokenCount, i;
793 REFIT_FILE *Options = NULL, *Fstab = NULL;
794 EFI_STATUS Status;
795 CHAR16 **TokenList, *Line, Root[100];
796
797 if (FileExists(Volume->RootDir, L"\\etc\\fstab")) {
798 Options = AllocateZeroPool(sizeof(REFIT_FILE));
799 Fstab = AllocateZeroPool(sizeof(REFIT_FILE));
800 Status = ReadFile(Volume->RootDir, L"\\etc\\fstab", Fstab, &i);
801 if (CheckError(Status, L"while reading /etc/fstab")) {
802 if (Options != NULL)
803 FreePool(Options);
804 if (Fstab != NULL)
805 FreePool(Fstab);
806 Options = NULL;
807 Fstab = NULL;
808 } else { // File read; locate root fs and create entries
809 Options->Encoding = ENCODING_UTF16_LE;
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 Line = PoolPrint(L"\"Boot with normal options\" \"ro root=%s\"\n", Root);
823 MergeStrings((CHAR16 **) &(Options->Buffer), Line, 0);
824 MyFreePool(Line);
825 Line = PoolPrint(L"\"Boot into single-user mode\" \"ro root=%s single\"\n", Root);
826 MergeStrings((CHAR16**) &(Options->Buffer), Line, 0);
827 Options->BufferSize = StrLen((CHAR16*) Options->Buffer) * sizeof(CHAR16);
828 } // if
829 } // if
830 FreeTokenLine(&TokenList, &TokenCount);
831 } // while
832
833 Options->Current8Ptr = (CHAR8 *)Options->Buffer;
834 Options->End8Ptr = Options->Current8Ptr + Options->BufferSize;
835 Options->Current16Ptr = (CHAR16 *)Options->Buffer;
836 Options->End16Ptr = Options->Current16Ptr + (Options->BufferSize >> 1);
837
838 MyFreePool(Fstab->Buffer);
839 MyFreePool(Fstab);
840 } // if/else file read error
841 } // if /etc/fstab exists
842 return Options;
843 } // GenerateOptionsFromEtcFstab()
844
845
846 // Read a Linux kernel options file for a Linux boot loader into memory. The LoaderPath
847 // and Volume variables identify the location of the options file, but not its name --
848 // you pass this function the filename of the Linux kernel, initial RAM disk, or other
849 // file in the target directory, and this function finds the file with a name in the
850 // comma-delimited list of names specified by LINUX_OPTIONS_FILENAMES within that
851 // directory and loads it. This function tries multiple files because I originally
852 // used the filename linux.conf, but close on the heels of that decision, the Linux
853 // kernel developers decided to use that name for a similar purpose, but with a
854 // different file format. Thus, I'm migrating rEFInd to use the name refind_linux.conf,
855 // but I want a migration period in which both names are used.
856 // If a rEFInd options file can't be found, try to generate minimal options from
857 // /etc/fstab on the same volume as the kernel. This typically works only if the
858 // kernel is being read from the Linux root filesystem.
859 //
860 // The return value is a pointer to the REFIT_FILE handle for the file, or NULL if
861 // it wasn't found.
862 REFIT_FILE * ReadLinuxOptionsFile(IN CHAR16 *LoaderPath, IN REFIT_VOLUME *Volume) {
863 CHAR16 *OptionsFilename, *FullFilename;
864 BOOLEAN GoOn = TRUE, FileFound = FALSE;
865 UINTN i = 0, size;
866 REFIT_FILE *File = NULL;
867 EFI_STATUS Status;
868
869 do {
870 OptionsFilename = FindCommaDelimited(LINUX_OPTIONS_FILENAMES, i++);
871 FullFilename = FindPath(LoaderPath);
872 if ((OptionsFilename != NULL) && (FullFilename != NULL)) {
873 MergeStrings(&FullFilename, OptionsFilename, '\\');
874 if (FileExists(Volume->RootDir, FullFilename)) {
875 File = AllocateZeroPool(sizeof(REFIT_FILE));
876 Status = ReadFile(Volume->RootDir, FullFilename, File, &size);
877 if (CheckError(Status, L"while loading the Linux options file")) {
878 if (File != NULL)
879 FreePool(File);
880 File = NULL;
881 } else {
882 GoOn = FALSE;
883 FileFound = TRUE;
884 } // if/else error
885 } // if file exists
886 } else { // a filename string is NULL
887 GoOn = FALSE;
888 } // if/else
889 if (!FileFound)
890 File = GenerateOptionsFromEtcFstab(Volume);
891 MyFreePool(OptionsFilename);
892 MyFreePool(FullFilename);
893 OptionsFilename = FullFilename = NULL;
894 } while (GoOn);
895 return (File);
896 } // static REFIT_FILE * ReadLinuxOptionsFile()
897
898 // Retrieve a single line of options from a Linux kernel options file
899 CHAR16 * GetFirstOptionsFromFile(IN CHAR16 *LoaderPath, IN REFIT_VOLUME *Volume) {
900 UINTN TokenCount;
901 CHAR16 *Options = NULL;
902 CHAR16 **TokenList;
903 REFIT_FILE *File;
904
905 File = ReadLinuxOptionsFile(LoaderPath, Volume);
906 if (File != NULL) {
907 TokenCount = ReadTokenLine(File, &TokenList);
908 if (TokenCount > 1)
909 Options = StrDuplicate(TokenList[1]);
910 FreeTokenLine(&TokenList, &TokenCount);
911 FreePool(File);
912 } // if
913 return Options;
914 } // static CHAR16 * GetOptionsFile()
915