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