code.delx.au - refind/blob - refind/config.c

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