/*
- * refit/config.c
+ * refind/config.c
* Configuration file functions
*
* Copyright (c) 2006 Christoph Pfisterer
*/
/*
- * Modifications copyright (c) 2012 Roderick W. Smith
+ * Modifications copyright (c) 2012-2013 Roderick W. Smith
*
* Modifications distributed under the terms of the GNU General Public
* License (GPL) version 3 (GPLv3), a copy of which must be distributed
// constants
-#define CONFIG_FILE_NAME L"refind.conf"
#define LINUX_OPTIONS_FILENAMES L"refind_linux.conf,refind-linux.conf"
#define MAXCONFIGFILESIZE (128*1024)
// read a file into a buffer
//
-static EFI_STATUS ReadFile(IN EFI_FILE_HANDLE BaseDir, CHAR16 *FileName, REFIT_FILE *File)
+EFI_STATUS ReadFile(IN EFI_FILE_HANDLE BaseDir, IN CHAR16 *FileName, IN OUT REFIT_FILE *File, OUT UINTN *size)
{
EFI_STATUS Status;
EFI_FILE_HANDLE FileHandle;
EFI_FILE_INFO *FileInfo;
UINT64 ReadSize;
+ CHAR16 Message[256];
File->Buffer = NULL;
File->BufferSize = 0;
// read the file, allocating a buffer on the way
Status = refit_call5_wrapper(BaseDir->Open, BaseDir, &FileHandle, FileName, EFI_FILE_MODE_READ, 0);
- if (CheckError(Status, L"while loading the configuration file"))
+ SPrint(Message, 255, L"while loading the file '%s'", FileName);
+ if (CheckError(Status, Message))
return Status;
FileInfo = LibFileInfo(FileHandle);
return EFI_LOAD_ERROR;
}
ReadSize = FileInfo->FileSize;
- if (ReadSize > MAXCONFIGFILESIZE)
- ReadSize = MAXCONFIGFILESIZE;
FreePool(FileInfo);
- File->BufferSize = (UINTN)ReadSize; // was limited to a few K before, so this is safe
+ File->BufferSize = (UINTN)ReadSize;
File->Buffer = AllocatePool(File->BufferSize);
+ if (File->Buffer == NULL) {
+ size = 0;
+ return EFI_OUT_OF_RESOURCES;
+ } else {
+ *size = File->BufferSize;
+ } // if/else
Status = refit_call3_wrapper(FileHandle->Read, FileHandle, &File->BufferSize, File->Buffer);
- if (CheckError(Status, L"while loading the configuration file")) {
+ if (CheckError(Status, Message)) {
MyFreePool(File->Buffer);
File->Buffer = NULL;
refit_call1_wrapper(FileHandle->Close, FileHandle);
}
// TODO: detect other encodings as they are implemented
}
-
+
return EFI_SUCCESS;
}
return Line;
}
+// Returns FALSE if *p points to the end of a token, TRUE otherwise.
+// Also modifies *p **IF** the first and second characters are both
+// quotes ('"'); it deletes one of them.
+static BOOLEAN KeepReading(IN OUT CHAR16 *p, IN OUT BOOLEAN *IsQuoted) {
+ BOOLEAN MoreToRead = FALSE;
+ CHAR16 *Temp = NULL;
+
+ if ((p == NULL) || (IsQuoted == NULL))
+ return FALSE;
+
+ if (*p == L'\0')
+ return FALSE;
+
+ if ((*p != ' ' && *p != '\t' && *p != '=' && *p != '#' && *p != ',') || *IsQuoted) {
+ MoreToRead = TRUE;
+ }
+ if (*p == L'"') {
+ if (p[1] == L'"') {
+ Temp = StrDuplicate(&p[1]);
+ if (Temp != NULL) {
+ StrCpy(p, Temp);
+ FreePool(Temp);
+ }
+ MoreToRead = TRUE;
+ } else {
+ *IsQuoted = !(*IsQuoted);
+ MoreToRead = FALSE;
+ } // if/else second character is a quote
+ } // if first character is a quote
+
+ return MoreToRead;
+} // BOOLEAN KeepReading()
+
//
// get a line of tokens from a file
//
-
UINTN ReadTokenLine(IN REFIT_FILE *File, OUT CHAR16 ***TokenList)
{
BOOLEAN LineFinished, IsQuoted = FALSE;
p = Line;
LineFinished = FALSE;
while (!LineFinished) {
- // skip whitespace
+ // skip whitespace & find start of token
while ((*p == ' ' || *p == '\t' || *p == '=' || *p == ',') && !IsQuoted)
p++;
if (*p == 0 || *p == '#')
Token = p;
// find end of token
- while (*p && *p != '"' && ((*p != ' ' && *p != '\t' && *p != '=' && *p != '#' && *p != ',') || IsQuoted)) {
- if ((*p == '/') && !IsQuoted) // Switch Unix-style to DOS-style directory separators
- *p = '\\';
+ while (KeepReading(p, &IsQuoted)) {
+ if ((*p == L'/') && !IsQuoted) // Switch Unix-style to DOS-style directory separators
+ *p = L'\\';
p++;
- } // if
- if (*p == '"')
- IsQuoted = !IsQuoted;
- if (*p == 0 || *p == '#')
+ } // while
+ if (*p == L'\0' || *p == L'#')
LineFinished = TRUE;
*p++ = 0;
// handle a parameter with a single integer argument
static VOID HandleInt(IN CHAR16 **TokenList, IN UINTN TokenCount, OUT UINTN *Value)
{
- if (TokenCount == 2)
- *Value = Atoi(TokenList[1]);
+ if (TokenCount == 2) {
+ if (StriCmp(TokenList[1], L"-1") == 0)
+ *Value = -1;
+ else
+ *Value = Atoi(TokenList[1]);
+ }
}
// handle a parameter with a single string argument
} // static VOID HandleStrings()
// read config file
-VOID ReadConfig(VOID)
+VOID ReadConfig(CHAR16 *FileName)
{
EFI_STATUS Status;
REFIT_FILE File;
CHAR16 **TokenList;
CHAR16 *FlagName;
+ CHAR16 *TempStr = NULL;
UINTN TokenCount, i;
- if (!FileExists(SelfDir, CONFIG_FILE_NAME)) {
- Print(L"Configuration file missing!\n");
+ // Set a few defaults only if we're loading the default file.
+ if (StriCmp(FileName, CONFIG_FILE_NAME) == 0) {
+ MyFreePool(GlobalConfig.AlsoScan);
+ GlobalConfig.AlsoScan = StrDuplicate(ALSO_SCAN_DIRS);
+ MyFreePool(GlobalConfig.DontScanDirs);
+ if (SelfVolume) {
+ if (SelfVolume->VolName) {
+ TempStr = SelfVolume->VolName ? StrDuplicate(SelfVolume->VolName) : NULL;
+ } else {
+ TempStr = AllocateZeroPool(256 * sizeof(CHAR16));
+ if (TempStr != NULL)
+ SPrint(TempStr, 255, L"fs%d", SelfVolume->VolNumber);
+ } // if/else
+ }
+ MergeStrings(&TempStr, SelfDirPath, L':');
+ MergeStrings(&TempStr, MEMTEST_LOCATIONS, L',');
+ GlobalConfig.DontScanDirs = TempStr;
+ MyFreePool(GlobalConfig.DontScanFiles);
+ GlobalConfig.DontScanFiles = StrDuplicate(DONT_SCAN_FILES);
+ MergeStrings(&(GlobalConfig.DontScanFiles), MOK_NAMES, L',');
+ MyFreePool(GlobalConfig.DontScanVolumes);
+ GlobalConfig.DontScanVolumes = StrDuplicate(DONT_SCAN_VOLUMES);
+ } // if
+
+ if (!FileExists(SelfDir, FileName)) {
+ Print(L"Configuration file '%s' missing!\n", FileName);
return;
}
- Status = ReadFile(SelfDir, CONFIG_FILE_NAME, &File);
+ Status = ReadFile(SelfDir, FileName, &File, &i);
if (EFI_ERROR(Status))
return;
} else if (StriCmp(FlagName, L"label") == 0) {
GlobalConfig.HideUIFlags |= HIDEUI_FLAG_LABEL;
} else if (StriCmp(FlagName, L"singleuser") == 0) {
- GlobalConfig.HideUIFlags |= HIDEUI_FLAG_SINGLEUSER;
+ GlobalConfig.HideUIFlags |= HIDEUI_FLAG_SINGLEUSER;
} else if (StriCmp(FlagName, L"hwtest") == 0) {
- GlobalConfig.HideUIFlags |= HIDEUI_FLAG_HWTEST;
+ GlobalConfig.HideUIFlags |= HIDEUI_FLAG_HWTEST;
} else if (StriCmp(FlagName, L"arrows") == 0) {
GlobalConfig.HideUIFlags |= HIDEUI_FLAG_ARROWS;
+ } else if (StriCmp(FlagName, L"hints") == 0) {
+ GlobalConfig.HideUIFlags |= HIDEUI_FLAG_HINTS;
+ } else if (StriCmp(FlagName, L"editor") == 0) {
+ GlobalConfig.HideUIFlags |= HIDEUI_FLAG_EDITOR;
+ } else if (StriCmp(FlagName, L"safemode") == 0) {
+ GlobalConfig.HideUIFlags |= HIDEUI_FLAG_SAFEMODE;
} else if (StriCmp(FlagName, L"all") == 0) {
- GlobalConfig.HideUIFlags = HIDEUI_ALL;
+ GlobalConfig.HideUIFlags = HIDEUI_FLAG_ALL;
} else {
Print(L" unknown hideui flag: '%s'\n", FlagName);
}
} else if (StriCmp(TokenList[0], L"also_scan_dirs") == 0) {
HandleStrings(TokenList, TokenCount, &(GlobalConfig.AlsoScan));
+ } else if ((StriCmp(TokenList[0], L"don't_scan_volumes") == 0) || (StriCmp(TokenList[0], L"dont_scan_volumes") == 0)) {
+ // Note: Don't use HandleStrings() because it modifies slashes, which might be present in volume name
+ MyFreePool(GlobalConfig.DontScanVolumes);
+ GlobalConfig.DontScanVolumes = NULL;
+ for (i = 1; i < TokenCount; i++) {
+ MergeStrings(&GlobalConfig.DontScanVolumes, TokenList[i], L',');
+ }
+
} else if ((StriCmp(TokenList[0], L"don't_scan_dirs") == 0) || (StriCmp(TokenList[0], L"dont_scan_dirs") == 0)) {
- HandleStrings(TokenList, TokenCount, &(GlobalConfig.DontScan));
+ HandleStrings(TokenList, TokenCount, &(GlobalConfig.DontScanDirs));
+
+ } else if ((StriCmp(TokenList[0], L"don't_scan_files") == 0) || (StriCmp(TokenList[0], L"dont_scan_files") == 0)) {
+ HandleStrings(TokenList, TokenCount, &(GlobalConfig.DontScanFiles));
} else if (StriCmp(TokenList[0], L"scan_driver_dirs") == 0) {
HandleStrings(TokenList, TokenCount, &(GlobalConfig.DriverDirs));
GlobalConfig.ShowTools[i - 1] = TAG_SHUTDOWN;
} else if (StriCmp(FlagName, L"apple_recovery") == 0) {
GlobalConfig.ShowTools[i - 1] = TAG_APPLE_RECOVERY;
+ } else if (StriCmp(FlagName, L"mok_tool") == 0) {
+ GlobalConfig.ShowTools[i - 1] = TAG_MOK_TOOL;
+ } else if (StriCmp(FlagName, L"firmware") == 0) {
+ GlobalConfig.ShowTools[i - 1] = TAG_FIRMWARE;
+ } else if ((StriCmp(FlagName, L"memtest86") == 0) || (StriCmp(FlagName, L"memtest") == 0)) {
+ GlobalConfig.ShowTools[i - 1] = TAG_MEMTEST;
} else {
Print(L" unknown showtools flag: '%s'\n", FlagName);
}
HandleString(TokenList, TokenCount, &(GlobalConfig.DefaultSelection));
} else if (StriCmp(TokenList[0], L"textonly") == 0) {
- GlobalConfig.TextOnly = TRUE;
+ if ((TokenCount >= 2) && (StriCmp(TokenList[1], L"0") == 0)) {
+ GlobalConfig.TextOnly = FALSE;
+ } else {
+ GlobalConfig.TextOnly = TRUE;
+ }
+
+ } else if (StriCmp(TokenList[0], L"textmode") == 0) {
+ HandleInt(TokenList, TokenCount, &(GlobalConfig.RequestedTextMode));
- } else if ((StriCmp(TokenList[0], L"resolution") == 0) && (TokenCount == 3)) {
+ } else if ((StriCmp(TokenList[0], L"resolution") == 0) && ((TokenCount == 2) || (TokenCount == 3))) {
GlobalConfig.RequestedScreenWidth = Atoi(TokenList[1]);
- GlobalConfig.RequestedScreenHeight = Atoi(TokenList[2]);
+ if (TokenCount == 3)
+ GlobalConfig.RequestedScreenHeight = Atoi(TokenList[2]);
+ else
+ GlobalConfig.RequestedScreenHeight = 0;
+
+ } else if (StriCmp(TokenList[0], L"screensaver") == 0) {
+ HandleInt(TokenList, TokenCount, &(GlobalConfig.ScreensaverTime));
} else if (StriCmp(TokenList[0], L"use_graphics_for") == 0) {
GlobalConfig.GraphicsFor = 0;
}
} // for (graphics_on tokens)
+ } else if ((StriCmp(TokenList[0], L"font") == 0) && (TokenCount == 2)) {
+ egLoadFont(TokenList[1]);
+
} else if (StriCmp(TokenList[0], L"scan_all_linux_kernels") == 0) {
- GlobalConfig.ScanAllLinux = TRUE;
+ if ((TokenCount >= 2) && (StriCmp(TokenList[1], L"0") == 0)) {
+ GlobalConfig.ScanAllLinux = FALSE;
+ } else {
+ GlobalConfig.ScanAllLinux = TRUE;
+ }
} else if (StriCmp(TokenList[0], L"max_tags") == 0) {
HandleInt(TokenList, TokenCount, &(GlobalConfig.MaxTags));
+ } else if ((StriCmp(TokenList[0], L"include") == 0) && (TokenCount == 2) && (StriCmp(FileName, CONFIG_FILE_NAME) == 0)) {
+ if (StriCmp(TokenList[1], FileName) != 0) {
+ ReadConfig(TokenList[1]);
+ }
+
}
FreeTokenLine(&TokenList, &TokenCount);
} else if ((StriCmp(TokenList[0], L"icon") == 0) && (TokenCount > 1)) {
MyFreePool(Entry->me.Image);
- Entry->me.Image = LoadIcns(CurrentVolume->RootDir, TokenList[1], 128);
+ Entry->me.Image = egLoadIcon(CurrentVolume->RootDir, TokenList[1], 128);
if (Entry->me.Image == NULL) {
Entry->me.Image = DummyImage(128);
}
} // if
if (!DefaultsSet)
- SetLoaderDefaults(Entry, L"\\EFI\\BOOT\\nemo.efi", CurrentVolume); // user included no entry; use bogus one
+ SetLoaderDefaults(Entry, L"\\EFI\\BOOT\\nemo.efi", CurrentVolume); // user included no "loader" line; use bogus one
return(Entry);
} // static VOID AddStanzaEntries()
-// Read the user-configured loaders file, refind_loaders.conf, and add or delete
+// Read the user-configured menu entries from refind.conf and add or delete
// entries based on the contents of that file....
-VOID ScanUserConfigured(VOID)
+VOID ScanUserConfigured(CHAR16 *FileName)
{
EFI_STATUS Status;
REFIT_FILE File;
REFIT_VOLUME *Volume;
CHAR16 **TokenList;
CHAR16 *Title = NULL;
- UINTN TokenCount;
+ UINTN TokenCount, size;
LOADER_ENTRY *Entry;
- if (FileExists(SelfDir, CONFIG_FILE_NAME)) {
- Status = ReadFile(SelfDir, CONFIG_FILE_NAME, &File);
+ if (FileExists(SelfDir, FileName)) {
+ Status = ReadFile(SelfDir, FileName, &File, &size);
if (EFI_ERROR(Status))
return;
MyFreePool(Entry);
} // if/else
MyFreePool(Title);
- } // if
+
+ } else if ((StriCmp(TokenList[0], L"include") == 0) && (TokenCount == 2) && (StriCmp(FileName, CONFIG_FILE_NAME) == 0)) {
+ if (StriCmp(TokenList[1], FileName) != 0) {
+ ScanUserConfigured(TokenList[1]);
+ }
+
+ } // if/else if...
FreeTokenLine(&TokenList, &TokenCount);
} // while()
} // if()
} // VOID ScanUserConfigured()
+// Create an options file based on /etc/fstab. The resulting file has two options
+// lines, one of which boots the system with "ro root={rootfs}" and the other of
+// which boots the system with "ro root={rootfs} single", where "{rootfs}" is the
+// filesystem identifier associated with the "/" line in /etc/fstab.
+static REFIT_FILE * GenerateOptionsFromEtcFstab(REFIT_VOLUME *Volume) {
+ UINTN TokenCount, i;
+ REFIT_FILE *Options = NULL, *Fstab = NULL;
+ EFI_STATUS Status;
+ CHAR16 **TokenList, *Line, Root[100];
+
+ if (FileExists(Volume->RootDir, L"\\etc\\fstab")) {
+ Options = AllocateZeroPool(sizeof(REFIT_FILE));
+ Fstab = AllocateZeroPool(sizeof(REFIT_FILE));
+ Status = ReadFile(Volume->RootDir, L"\\etc\\fstab", Fstab, &i);
+ if (CheckError(Status, L"while reading /etc/fstab")) {
+ if (Options != NULL)
+ FreePool(Options);
+ if (Fstab != NULL)
+ FreePool(Fstab);
+ Options = NULL;
+ Fstab = NULL;
+ } else { // File read; locate root fs and create entries
+ Options->Encoding = ENCODING_UTF16_LE;
+ while ((TokenCount = ReadTokenLine(Fstab, &TokenList)) > 0) {
+ if (TokenCount > 2) {
+ Root[0] = '\0';
+ if (StriCmp(TokenList[1], L"\\") == 0) {
+ SPrint(Root, 99, L"%s", TokenList[0]);
+ } else if (StriCmp(TokenList[2], L"\\") == 0) {
+ SPrint(Root, 99, L"%s=%s", TokenList[0], TokenList[1]);
+ } // if/elseif/elseif
+ if (Root[0] != L'\0') {
+ for (i = 0; i < StrLen(Root); i++)
+ if (Root[i] == '\\')
+ Root[i] = '/';
+ Line = PoolPrint(L"\"Boot with normal options\" \"ro root=%s\"\n", Root);
+ MergeStrings((CHAR16 **) &(Options->Buffer), Line, 0);
+ MyFreePool(Line);
+ Line = PoolPrint(L"\"Boot into single-user mode\" \"ro root=%s single\"\n", Root);
+ MergeStrings((CHAR16**) &(Options->Buffer), Line, 0);
+ Options->BufferSize = StrLen((CHAR16*) Options->Buffer) * sizeof(CHAR16);
+ } // if
+ } // if
+ FreeTokenLine(&TokenList, &TokenCount);
+ } // while
+
+ Options->Current8Ptr = (CHAR8 *)Options->Buffer;
+ Options->End8Ptr = Options->Current8Ptr + Options->BufferSize;
+ Options->Current16Ptr = (CHAR16 *)Options->Buffer;
+ Options->End16Ptr = Options->Current16Ptr + (Options->BufferSize >> 1);
+
+ MyFreePool(Fstab->Buffer);
+ MyFreePool(Fstab);
+ } // if/else file read error
+ } // if /etc/fstab exists
+ return Options;
+} // GenerateOptionsFromEtcFstab()
+
+
// Read a Linux kernel options file for a Linux boot loader into memory. The LoaderPath
// and Volume variables identify the location of the options file, but not its name --
// you pass this function the filename of the Linux kernel, initial RAM disk, or other
// kernel developers decided to use that name for a similar purpose, but with a
// different file format. Thus, I'm migrating rEFInd to use the name refind_linux.conf,
// but I want a migration period in which both names are used.
+// If a rEFInd options file can't be found, try to generate minimal options from
+// /etc/fstab on the same volume as the kernel. This typically works only if the
+// kernel is being read from the Linux root filesystem.
//
// The return value is a pointer to the REFIT_FILE handle for the file, or NULL if
// it wasn't found.
REFIT_FILE * ReadLinuxOptionsFile(IN CHAR16 *LoaderPath, IN REFIT_VOLUME *Volume) {
CHAR16 *OptionsFilename, *FullFilename;
- BOOLEAN GoOn = TRUE;
- UINTN i = 0;
+ BOOLEAN GoOn = TRUE, FileFound = FALSE;
+ UINTN i = 0, size;
REFIT_FILE *File = NULL;
EFI_STATUS Status;
MergeStrings(&FullFilename, OptionsFilename, '\\');
if (FileExists(Volume->RootDir, FullFilename)) {
File = AllocateZeroPool(sizeof(REFIT_FILE));
- Status = ReadFile(Volume->RootDir, FullFilename, File);
- GoOn = FALSE;
+ Status = ReadFile(Volume->RootDir, FullFilename, File, &size);
if (CheckError(Status, L"while loading the Linux options file")) {
if (File != NULL)
FreePool(File);
File = NULL;
- GoOn = TRUE;
- } // if error
+ } else {
+ GoOn = FALSE;
+ FileFound = TRUE;
+ } // if/else error
} // if file exists
} else { // a filename string is NULL
GoOn = FALSE;
} // if/else
+ if (!FileFound)
+ File = GenerateOptionsFromEtcFstab(Volume);
MyFreePool(OptionsFilename);
MyFreePool(FullFilename);
OptionsFilename = FullFilename = NULL;