3 * Main code for the boot menu
5 * Copyright (c) 2006-2010 Christoph Pfisterer
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
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
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.
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.
37 * Modifications copyright (c) 2012-2015 Roderick W. Smith
39 * Modifications distributed under the terms of the GNU General Public
40 * License (GPL) version 3 (GPLv3), a copy of which must be distributed
41 * with this source code or binaries made from it.
54 #include "security_policy.h"
55 #include "driver_support.h"
56 #include "../include/Handle.h"
57 #include "../include/refit_call_wrapper.h"
58 #include "../EfiLib/BdsHelper.h"
59 #include "../EfiLib/legacy.h"
61 #ifdef __MAKEWITH_GNUEFI
62 #ifndef EFI_SECURITY_VIOLATION
63 #define EFI_SECURITY_VIOLATION EFIERR (26)
67 #ifndef EFI_OS_INDICATIONS_BOOT_TO_FW_UI
68 #define EFI_OS_INDICATIONS_BOOT_TO_FW_UI 0x0000000000000001ULL
71 #ifdef __MAKEWITH_TIANO
72 #define LibLocateHandle gBS->LocateHandleBuffer
78 #define MACOSX_LOADER_DIR L"System\\Library\\CoreServices"
79 #define MACOSX_LOADER_PATH ( MACOSX_LOADER_DIR L"\\boot.efi" )
81 #define SHELL_NAMES L"\\EFI\\tools\\shell.efi,\\EFI\\tools\\shellx64.efi,\\shell.efi,\\shellx64.efi"
82 #define GPTSYNC_NAMES L"\\EFI\\tools\\gptsync.efi,\\EFI\\tools\\gptsync_x64.efi"
83 #define GDISK_NAMES L"\\EFI\\tools\\gdisk.efi,\\EFI\\tools\\gdisk_x64.efi"
84 #define NETBOOT_NAMES L"\\EFI\\tools\\ipxe.efi"
85 #define MEMTEST_NAMES L"memtest86.efi,memtest86_x64.efi,memtest86x64.efi,bootx64.efi"
86 #define DRIVER_DIRS L"drivers,drivers_x64"
87 #define FALLBACK_FULLNAME L"EFI\\BOOT\\bootx64.efi"
88 #define FALLBACK_BASENAME L"bootx64.efi"
89 #define EFI_STUB_ARCH 0x8664
90 EFI_GUID gFreedesktopRootGuid
= { 0x4f68bce3, 0xe8cd, 0x4db1, { 0x96, 0xe7, 0xfb, 0xca, 0xf9, 0x84, 0xb7, 0x09 }};
92 #define SHELL_NAMES L"\\EFI\\tools\\shell.efi,\\EFI\\tools\\shellia32.efi,\\shell.efi,\\shellia32.efi"
93 #define GPTSYNC_NAMES L"\\EFI\\tools\\gptsync.efi,\\EFI\\tools\\gptsync_ia32.efi"
94 #define GDISK_NAMES L"\\EFI\\tools\\gdisk.efi,\\EFI\\tools\\gdisk_ia32.efi"
95 #define NETBOOT_NAMES L"\\EFI\\tools\\ipxe.efi"
96 #define MEMTEST_NAMES L"memtest86.efi,memtest86_ia32.efi,memtest86ia32.efi,bootia32.efi"
97 #define DRIVER_DIRS L"drivers,drivers_ia32"
98 #define FALLBACK_FULLNAME L"EFI\\BOOT\\bootia32.efi"
99 #define FALLBACK_BASENAME L"bootia32.efi"
100 #define EFI_STUB_ARCH 0x014c
101 EFI_GUID gFreedesktopRootGuid
= { 0x44479540, 0xf297, 0x41b2, { 0x9a, 0xf7, 0xd1, 0x31, 0xd5, 0xf0, 0x45, 0x8a }};
103 #define SHELL_NAMES L"\\EFI\\tools\\shell.efi,\\shell.efi"
104 #define GPTSYNC_NAMES L"\\EFI\\tools\\gptsync.efi"
105 #define GDISK_NAMES L"\\EFI\\tools\\gdisk.efi"
106 #define NETBOOT_NAMES L"\\EFI\\tools\\ipxe.efi"
107 #define MEMTEST_NAMES L"memtest86.efi"
108 #define DRIVER_DIRS L"drivers"
109 #define FALLBACK_FULLNAME L"EFI\\BOOT\\boot.efi" /* Not really correct */
110 #define FALLBACK_BASENAME L"boot.efi" /* Not really correct */
111 // Below is GUID for ARM64
112 EFI_GUID gFreedesktopRootGuid
= { 0xb921b045, 0x1df0, 0x41c3, { 0xaf, 0x44, 0x4c, 0x6f, 0x28, 0x0d, 0x3f, 0xae }};
114 #define FAT_ARCH 0x0ef1fab9 /* ID for Apple "fat" binary */
116 #define IPXE_DISCOVER_NAME L"\\efi\\tools\\ipxe_discover.efi"
117 #define IPXE_NAME L"\\efi\\tools\\ipxe.efi"
119 // Filename patterns that identify EFI boot loaders. Note that a single case (either L"*.efi" or
120 // L"*.EFI") is fine for most systems; but Gigabyte's buggy Hybrid EFI does a case-sensitive
121 // comparison when it should do a case-insensitive comparison, so I'm doubling this up. It does
122 // no harm on other computers, AFAIK. In theory, every case variation should be done for
123 // completeness, but that's ridiculous....
124 #define LOADER_MATCH_PATTERNS L"*.efi,*.EFI"
126 // Patterns that identify Linux kernels. Added to the loader match pattern when the
127 // scan_all_linux_kernels option is set in the configuration file. Causes kernels WITHOUT
128 // a ".efi" extension to be found when scanning for boot loaders.
129 #define LINUX_MATCH_PATTERNS L"vmlinuz*,bzImage*"
131 static REFIT_MENU_ENTRY MenuEntryAbout
= { L
"About rEFInd", TAG_ABOUT
, 1, 0, 'A', NULL
, NULL
, NULL
};
132 static REFIT_MENU_ENTRY MenuEntryReset
= { L
"Reboot Computer", TAG_REBOOT
, 1, 0, 'R', NULL
, NULL
, NULL
};
133 static REFIT_MENU_ENTRY MenuEntryShutdown
= { L
"Shut Down Computer", TAG_SHUTDOWN
, 1, 0, 'U', NULL
, NULL
, NULL
};
134 REFIT_MENU_ENTRY MenuEntryReturn
= { L
"Return to Main Menu", TAG_RETURN
, 1, 0, 0, NULL
, NULL
, NULL
};
135 static REFIT_MENU_ENTRY MenuEntryExit
= { L
"Exit rEFInd", TAG_EXIT
, 1, 0, 0, NULL
, NULL
, NULL
};
136 static REFIT_MENU_ENTRY MenuEntryFirmware
= { L
"Reboot to Computer Setup Utility", TAG_FIRMWARE
, 1, 0, 0, NULL
, NULL
, NULL
};
138 REFIT_MENU_SCREEN MainMenu
= { L
"Main Menu", NULL
, 0, NULL
, 0, NULL
, 0, L
"Automatic boot",
139 L
"Use arrow keys to move cursor; Enter to boot;",
140 L
"Insert or F2 for more options; Esc to refresh" };
141 static REFIT_MENU_SCREEN AboutMenu
= { L
"About", NULL
, 0, NULL
, 0, NULL
, 0, NULL
, L
"Press Enter to return to main menu", L
"" };
143 REFIT_CONFIG GlobalConfig
= { FALSE
, TRUE
, FALSE
, FALSE
, 0, 0, 0, DONT_CHANGE_TEXT_MODE
, 20, 0, 0, GRAPHICS_FOR_OSX
, LEGACY_TYPE_MAC
,
144 0, 0, { DEFAULT_BIG_ICON_SIZE
/ 4, DEFAULT_SMALL_ICON_SIZE
, DEFAULT_BIG_ICON_SIZE
}, BANNER_NOSCALE
,
145 NULL
, NULL
, NULL
, CONFIG_FILE_NAME
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
, NULL
,
146 { TAG_SHELL
, TAG_MEMTEST
, TAG_GDISK
, TAG_APPLE_RECOVERY
, TAG_WINDOWS_RECOVERY
, TAG_MOK_TOOL
,
147 TAG_ABOUT
, TAG_SHUTDOWN
, TAG_REBOOT
, TAG_FIRMWARE
, 0, 0, 0, 0, 0, 0, 0, 0 }
150 EFI_GUID GlobalGuid
= EFI_GLOBAL_VARIABLE
;
151 EFI_GUID RefindGuid
= REFIND_GUID_VALUE
;
153 GPT_DATA
*gPartitions
= NULL
;
155 // Structure used to hold boot loader filenames and time stamps in
156 // a linked list; used to sort entries within a directory.
160 struct LOADER_LIST
*NextEntry
;
167 static VOID
AboutrEFInd(VOID
)
169 CHAR16
*FirmwareVendor
;
171 if (AboutMenu
.EntryCount
== 0) {
172 AboutMenu
.TitleImage
= BuiltinIcon(BUILTIN_ICON_FUNC_ABOUT
);
173 AddMenuInfoLine(&AboutMenu
, L
"rEFInd Version 0.8.7.12");
174 AddMenuInfoLine(&AboutMenu
, L
"");
175 AddMenuInfoLine(&AboutMenu
, L
"Copyright (c) 2006-2010 Christoph Pfisterer");
176 AddMenuInfoLine(&AboutMenu
, L
"Copyright (c) 2012-2015 Roderick W. Smith");
177 AddMenuInfoLine(&AboutMenu
, L
"Portions Copyright (c) Intel Corporation and others");
178 AddMenuInfoLine(&AboutMenu
, L
"Distributed under the terms of the GNU GPLv3 license");
179 AddMenuInfoLine(&AboutMenu
, L
"");
180 AddMenuInfoLine(&AboutMenu
, L
"Running on:");
181 AddMenuInfoLine(&AboutMenu
, PoolPrint(L
" EFI Revision %d.%02d", ST
->Hdr
.Revision
>> 16, ST
->Hdr
.Revision
& ((1 << 16) - 1)));
183 AddMenuInfoLine(&AboutMenu
, PoolPrint(L
" Platform: x86 (32 bit); Secure Boot %s",
184 secure_mode() ? L
"active" : L
"inactive"));
185 #elif defined(EFIX64)
186 AddMenuInfoLine(&AboutMenu
, PoolPrint(L
" Platform: x86_64 (64 bit); Secure Boot %s",
187 secure_mode() ? L
"active" : L
"inactive"));
189 AddMenuInfoLine(&AboutMenu
, L
" Platform: unknown");
191 FirmwareVendor
= StrDuplicate(ST
->FirmwareVendor
);
192 LimitStringLength(FirmwareVendor
, 65); // More than ~65 causes empty info page on 800x600 display
193 AddMenuInfoLine(&AboutMenu
, PoolPrint(L
" Firmware: %s %d.%02d", FirmwareVendor
, ST
->FirmwareRevision
>> 16,
194 ST
->FirmwareRevision
& ((1 << 16) - 1)));
195 AddMenuInfoLine(&AboutMenu
, PoolPrint(L
" Screen Output: %s", egScreenDescription()));
196 AddMenuInfoLine(&AboutMenu
, L
"");
197 #if defined(__MAKEWITH_GNUEFI)
198 AddMenuInfoLine(&AboutMenu
, L
"Built with GNU-EFI");
200 AddMenuInfoLine(&AboutMenu
, L
"Built with TianoCore EDK2");
202 AddMenuInfoLine(&AboutMenu
, L
"");
203 AddMenuInfoLine(&AboutMenu
, L
"For more information, see the rEFInd Web site:");
204 AddMenuInfoLine(&AboutMenu
, L
"http://www.rodsbooks.com/refind/");
205 AddMenuEntry(&AboutMenu
, &MenuEntryReturn
);
208 RunMenu(&AboutMenu
, NULL
);
209 } /* VOID AboutrEFInd() */
211 static VOID
WarnSecureBootError(CHAR16
*Name
, BOOLEAN Verbose
) {
213 Name
= L
"the loader";
215 refit_call2_wrapper(ST
->ConOut
->SetAttribute
, ST
->ConOut
, ATTR_ERROR
);
216 Print(L
"Secure Boot validation failure loading %s!\n", Name
);
217 refit_call2_wrapper(ST
->ConOut
->SetAttribute
, ST
->ConOut
, ATTR_BASIC
);
218 if (Verbose
&& secure_mode()) {
219 Print(L
"\nThis computer is configured with Secure Boot active, but\n%s has failed validation.\n", Name
);
220 Print(L
"\nYou can:\n * Launch another boot loader\n");
221 Print(L
" * Disable Secure Boot in your firmware\n");
222 Print(L
" * Sign %s with a machine owner key (MOK)\n", Name
);
223 Print(L
" * Use a MOK utility (often present on the second row) to add a MOK with which\n");
224 Print(L
" %s has already been signed.\n", Name
);
225 Print(L
" * Use a MOK utility to register %s (\"enroll its hash\") without\n", Name
);
226 Print(L
" signing it.\n");
227 Print(L
"\nSee http://www.rodsbooks.com/refind/secureboot.html for more information\n");
230 } // VOID WarnSecureBootError()
232 // Returns TRUE if this file is a valid EFI loader file, and is proper ARCH
233 static BOOLEAN
IsValidLoader(EFI_FILE
*RootDir
, CHAR16
*FileName
) {
234 BOOLEAN IsValid
= TRUE
;
235 #if defined (EFIX64) | defined (EFI32)
237 EFI_FILE_HANDLE FileHandle
;
239 UINTN Size
= sizeof(Header
);
241 if ((RootDir
== NULL
) || (FileName
== NULL
)) {
242 // Assume valid here, because Macs produce NULL RootDir (& maybe FileName)
243 // when launching from a Firewire drive. This should be handled better, but
244 // fix would have to be in StartEFIImageList() and/or in FindVolumeAndFilename().
248 Status
= refit_call5_wrapper(RootDir
->Open
, RootDir
, &FileHandle
, FileName
, EFI_FILE_MODE_READ
, 0);
249 if (EFI_ERROR(Status
))
252 Status
= refit_call3_wrapper(FileHandle
->Read
, FileHandle
, &Size
, Header
);
253 refit_call1_wrapper(FileHandle
->Close
, FileHandle
);
255 IsValid
= !EFI_ERROR(Status
) &&
256 Size
== sizeof(Header
) &&
257 ((Header
[0] == 'M' && Header
[1] == 'Z' &&
258 (Size
= *(UINT32
*)&Header
[0x3c]) < 0x180 &&
259 Header
[Size
] == 'P' && Header
[Size
+1] == 'E' &&
260 Header
[Size
+2] == 0 && Header
[Size
+3] == 0 &&
261 *(UINT16
*)&Header
[Size
+4] == EFI_STUB_ARCH
) ||
262 (*(UINT32
*)&Header
== FAT_ARCH
));
265 } // BOOLEAN IsValidLoader()
267 // Launch an EFI binary.
268 EFI_STATUS
StartEFIImageList(IN EFI_DEVICE_PATH
**DevicePaths
,
269 IN CHAR16
*LoadOptions
, IN UINTN LoaderType
,
270 IN CHAR16
*ImageTitle
, IN CHAR8 OSType
,
271 OUT UINTN
*ErrorInStep
,
275 EFI_STATUS Status
, ReturnStatus
;
276 EFI_HANDLE ChildImageHandle
;
277 EFI_LOADED_IMAGE
*ChildLoadedImage
= NULL
;
278 REFIT_VOLUME
*Volume
= NULL
;
279 UINTN DevicePathIndex
;
280 CHAR16 ErrorInfo
[256];
281 CHAR16
*FullLoadOptions
= NULL
;
282 CHAR16
*Filename
= NULL
;
285 if (ErrorInStep
!= NULL
)
289 if (LoadOptions
!= NULL
) {
290 FullLoadOptions
= StrDuplicate(LoadOptions
);
291 if ((LoaderType
== TYPE_EFI
) && (OSType
== 'M')) {
292 MergeStrings(&FullLoadOptions
, L
" ", 0);
293 // NOTE: That last space is also added by the EFI shell and seems to be significant
294 // when passing options to Apple's boot.efi...
296 } // if (LoadOptions != NULL)
298 Print(L
"Starting %s\nUsing load options '%s'\n", ImageTitle
, FullLoadOptions
? FullLoadOptions
: L
"");
300 // load the image into memory (and execute it, in the case of a shim/MOK image).
301 ReturnStatus
= Status
= EFI_NOT_FOUND
; // in case the list is empty
302 for (DevicePathIndex
= 0; DevicePaths
[DevicePathIndex
] != NULL
; DevicePathIndex
++) {
303 FindVolumeAndFilename(DevicePaths
[DevicePathIndex
], &Volume
, &Filename
);
304 // Some EFIs crash if attempting to load driver for invalid architecture, so
305 // protect for this condition; but sometimes Volume comes back NULL, so provide
306 // an exception. (TODO: Handle this special condition better.)
307 if ((LoaderType
== TYPE_LEGACY
) || (Volume
== NULL
) || IsValidLoader(Volume
->RootDir
, Filename
)) {
308 if (Filename
&& (LoaderType
!= TYPE_LEGACY
)) {
309 Temp
= PoolPrint(L
"\\%s %s", Filename
, FullLoadOptions
? FullLoadOptions
: L
"");
311 MyFreePool(FullLoadOptions
);
312 FullLoadOptions
= Temp
;
316 // NOTE: Below commented-out line could be more efficient if file were read ahead of
317 // time and passed as a pre-loaded image to LoadImage(), but it doesn't work on my
318 // 32-bit Mac Mini or my 64-bit Intel box when launching a Linux kernel; the
319 // kernel returns a "Failed to handle fs_proto" error message.
320 // TODO: Track down the cause of this error and fix it, if possible.
321 // ReturnStatus = Status = refit_call6_wrapper(BS->LoadImage, FALSE, SelfImageHandle, DevicePaths[DevicePathIndex],
322 // ImageData, ImageSize, &ChildImageHandle);
323 ReturnStatus
= Status
= refit_call6_wrapper(BS
->LoadImage
, FALSE
, SelfImageHandle
, DevicePaths
[DevicePathIndex
],
324 NULL
, 0, &ChildImageHandle
);
326 Print(L
"Invalid loader file!\n");
327 ReturnStatus
= EFI_LOAD_ERROR
;
329 if (ReturnStatus
!= EFI_NOT_FOUND
) {
333 if ((Status
== EFI_ACCESS_DENIED
) || (Status
== EFI_SECURITY_VIOLATION
)) {
334 WarnSecureBootError(ImageTitle
, Verbose
);
337 SPrint(ErrorInfo
, 255, L
"while loading %s", ImageTitle
);
338 if (CheckError(Status
, ErrorInfo
)) {
339 if (ErrorInStep
!= NULL
)
344 ReturnStatus
= Status
= refit_call3_wrapper(BS
->HandleProtocol
, ChildImageHandle
, &LoadedImageProtocol
,
345 (VOID
**) &ChildLoadedImage
);
346 if (CheckError(Status
, L
"while getting a LoadedImageProtocol handle")) {
347 if (ErrorInStep
!= NULL
)
351 ChildLoadedImage
->LoadOptions
= (VOID
*)FullLoadOptions
;
352 ChildLoadedImage
->LoadOptionsSize
= FullLoadOptions
? ((UINT32
)StrLen(FullLoadOptions
) + 1) * sizeof(CHAR16
) : 0;
353 // turn control over to the image
354 // TODO: (optionally) re-enable the EFI watchdog timer!
356 // close open file handles
358 ReturnStatus
= Status
= refit_call3_wrapper(BS
->StartImage
, ChildImageHandle
, NULL
, NULL
);
360 // control returns here when the child image calls Exit()
361 SPrint(ErrorInfo
, 255, L
"returned from %s", ImageTitle
);
362 if (CheckError(Status
, ErrorInfo
)) {
363 if (ErrorInStep
!= NULL
)
367 // re-open file handles
371 // unload the image, we don't care if it works or not...
373 Status
= refit_call1_wrapper(BS
->UnloadImage
, ChildImageHandle
);
376 MyFreePool(FullLoadOptions
);
378 } /* EFI_STATUS StartEFIImageList() */
380 static EFI_STATUS
StartEFIImage(IN EFI_DEVICE_PATH
*DevicePath
,
381 IN CHAR16
*LoadOptions
, IN UINTN LoaderType
,
382 IN CHAR16
*ImageTitle
, IN CHAR8 OSType
,
383 OUT UINTN
*ErrorInStep
,
388 EFI_DEVICE_PATH
*DevicePaths
[2];
390 DevicePaths
[0] = DevicePath
;
391 DevicePaths
[1] = NULL
;
392 return StartEFIImageList(DevicePaths
, LoadOptions
, LoaderType
, ImageTitle
, OSType
, ErrorInStep
, Verbose
, IsDriver
);
393 } /* static EFI_STATUS StartEFIImage() */
395 // From gummiboot: Reboot the computer into its built-in user interface
396 static EFI_STATUS
RebootIntoFirmware(VOID
) {
402 osind
= EFI_OS_INDICATIONS_BOOT_TO_FW_UI
;
404 err
= EfivarGetRaw(&GlobalGuid
, L
"OsIndications", &b
, &size
);
405 if (err
== EFI_SUCCESS
)
409 err
= EfivarSetRaw(&GlobalGuid
, L
"OsIndications", (CHAR8
*)&osind
, sizeof(UINT64
), TRUE
);
410 if (err
!= EFI_SUCCESS
)
413 refit_call4_wrapper(RT
->ResetSystem
, EfiResetCold
, EFI_SUCCESS
, 0, NULL
);
414 Print(L
"Error calling ResetSystem: %r", err
);
419 // Record the value of the loader's name/description in rEFInd's "PreviousBoot" EFI variable,
420 // if it's different from what's already stored there.
421 VOID
StoreLoaderName(IN CHAR16
*Name
) {
423 CHAR16
*OldName
= NULL
;
427 Status
= EfivarGetRaw(&RefindGuid
, L
"PreviousBoot", (CHAR8
**) &OldName
, &Length
);
428 if ((Status
!= EFI_SUCCESS
) || (StrCmp(OldName
, Name
) != 0)) {
429 EfivarSetRaw(&RefindGuid
, L
"PreviousBoot", (CHAR8
*) Name
, StrLen(Name
) * 2 + 2, TRUE
);
433 } // VOID StoreLoaderName()
436 // EFI OS loader functions
439 // See http://www.thomas-krenn.com/en/wiki/Activating_the_Intel_VT_Virtualization_Feature
440 // for information on Intel VMX features
441 static VOID
DoEnableAndLockVMX(VOID
)
444 UINT32 low_bits
= 0, high_bits
= 0;
447 __asm__
volatile ("rdmsr" : "=a" (low_bits
), "=d" (high_bits
) : "c" (msr
));
449 // enable and lock vmx if not locked
450 if ((low_bits
& 1) == 0) {
454 __asm__
volatile ("wrmsr" : : "c" (msr
), "a" (low_bits
), "d" (high_bits
));
456 } // VOID DoEnableAndLockVMX()
458 static VOID
StartLoader(LOADER_ENTRY
*Entry
, CHAR16
*SelectionName
)
460 UINTN ErrorInStep
= 0;
462 if (GlobalConfig
.EnableAndLockVMX
) {
463 DoEnableAndLockVMX();
466 BeginExternalScreen(Entry
->UseGraphicsMode
, L
"Booting OS");
467 StoreLoaderName(SelectionName
);
468 StartEFIImage(Entry
->DevicePath
, Entry
->LoadOptions
, TYPE_EFI
,
469 Basename(Entry
->LoaderPath
), Entry
->OSType
, &ErrorInStep
, !Entry
->UseGraphicsMode
, FALSE
);
470 FinishExternalScreen();
473 // Locate an initrd or initramfs file that matches the kernel specified by LoaderPath.
474 // The matching file has a name that begins with "init" and includes the same version
475 // number string as is found in LoaderPath -- but not a longer version number string.
476 // For instance, if LoaderPath is \EFI\kernels\bzImage-3.3.0.efi, and if \EFI\kernels
477 // has a file called initramfs-3.3.0.img, this function will return the string
478 // '\EFI\kernels\initramfs-3.3.0.img'. If the directory ALSO contains the file
479 // initramfs-3.3.0-rc7.img or initramfs-13.3.0.img, those files will NOT match;
480 // however, initmine-3.3.0.img might match. (FindInitrd() returns the first match it
481 // finds.) Thus, care should be taken to avoid placing duplicate matching files in
482 // the kernel's directory.
483 // If no matching init file can be found, returns NULL.
484 static CHAR16
* FindInitrd(IN CHAR16
*LoaderPath
, IN REFIT_VOLUME
*Volume
) {
485 CHAR16
*InitrdName
= NULL
, *FileName
, *KernelVersion
, *InitrdVersion
, *Path
;
486 REFIT_DIR_ITER DirIter
;
487 EFI_FILE_INFO
*DirEntry
;
489 FileName
= Basename(LoaderPath
);
490 KernelVersion
= FindNumbers(FileName
);
491 Path
= FindPath(LoaderPath
);
493 // Add trailing backslash for root directory; necessary on some systems, but must
494 // NOT be added to all directories, since on other systems, a trailing backslash on
495 // anything but the root directory causes them to flake out!
496 if (StrLen(Path
) == 0) {
497 MergeStrings(&Path
, L
"\\", 0);
499 DirIterOpen(Volume
->RootDir
, Path
, &DirIter
);
500 // Now add a trailing backslash if it was NOT added earlier, for consistency in
501 // building the InitrdName later....
502 if ((StrLen(Path
) > 0) && (Path
[StrLen(Path
) - 1] != L
'\\'))
503 MergeStrings(&Path
, L
"\\", 0);
504 while ((DirIterNext(&DirIter
, 2, L
"init*", &DirEntry
)) && (InitrdName
== NULL
)) {
505 InitrdVersion
= FindNumbers(DirEntry
->FileName
);
506 if (KernelVersion
!= NULL
) {
507 if (StriCmp(InitrdVersion
, KernelVersion
) == 0) {
508 InitrdName
= PoolPrint(L
"%s%s", Path
, DirEntry
->FileName
);
511 if (InitrdVersion
== NULL
) {
512 InitrdName
= PoolPrint(L
"%s%s", Path
, DirEntry
->FileName
);
515 MyFreePool(InitrdVersion
);
517 DirIterClose(&DirIter
);
519 // Note: Don't FreePool(FileName), since Basename returns a pointer WITHIN the string it's passed.
520 MyFreePool(KernelVersion
);
523 } // static CHAR16 * FindInitrd()
525 LOADER_ENTRY
* AddPreparedLoaderEntry(LOADER_ENTRY
*Entry
) {
526 AddMenuEntry(&MainMenu
, (REFIT_MENU_ENTRY
*)Entry
);
529 } // LOADER_ENTRY * AddPreparedLoaderEntry()
531 // Creates a copy of a menu screen.
532 // Returns a pointer to the copy of the menu screen.
533 static REFIT_MENU_SCREEN
* CopyMenuScreen(REFIT_MENU_SCREEN
*Entry
) {
534 REFIT_MENU_SCREEN
*NewEntry
;
537 NewEntry
= AllocateZeroPool(sizeof(REFIT_MENU_SCREEN
));
538 if ((Entry
!= NULL
) && (NewEntry
!= NULL
)) {
539 CopyMem(NewEntry
, Entry
, sizeof(REFIT_MENU_SCREEN
));
540 NewEntry
->Title
= (Entry
->Title
) ? StrDuplicate(Entry
->Title
) : NULL
;
541 NewEntry
->TimeoutText
= (Entry
->TimeoutText
) ? StrDuplicate(Entry
->TimeoutText
) : NULL
;
542 if (Entry
->TitleImage
!= NULL
) {
543 NewEntry
->TitleImage
= AllocatePool(sizeof(EG_IMAGE
));
544 if (NewEntry
->TitleImage
!= NULL
)
545 CopyMem(NewEntry
->TitleImage
, Entry
->TitleImage
, sizeof(EG_IMAGE
));
547 NewEntry
->InfoLines
= (CHAR16
**) AllocateZeroPool(Entry
->InfoLineCount
* (sizeof(CHAR16
*)));
548 for (i
= 0; i
< Entry
->InfoLineCount
&& NewEntry
->InfoLines
; i
++) {
549 NewEntry
->InfoLines
[i
] = (Entry
->InfoLines
[i
]) ? StrDuplicate(Entry
->InfoLines
[i
]) : NULL
;
551 NewEntry
->Entries
= (REFIT_MENU_ENTRY
**) AllocateZeroPool(Entry
->EntryCount
* (sizeof (REFIT_MENU_ENTRY
*)));
552 for (i
= 0; i
< Entry
->EntryCount
&& NewEntry
->Entries
; i
++) {
553 AddMenuEntry(NewEntry
, Entry
->Entries
[i
]);
555 NewEntry
->Hint1
= (Entry
->Hint1
) ? StrDuplicate(Entry
->Hint1
) : NULL
;
556 NewEntry
->Hint2
= (Entry
->Hint2
) ? StrDuplicate(Entry
->Hint2
) : NULL
;
559 } // static REFIT_MENU_SCREEN* CopyMenuScreen()
561 // Creates a copy of a menu entry. Intended to enable moving a stack-based
562 // menu entry (such as the ones for the "reboot" and "exit" functions) to
563 // to the heap. This enables easier deletion of the whole set of menu
564 // entries when re-scanning.
565 // Returns a pointer to the copy of the menu entry.
566 static REFIT_MENU_ENTRY
* CopyMenuEntry(REFIT_MENU_ENTRY
*Entry
) {
567 REFIT_MENU_ENTRY
*NewEntry
;
569 NewEntry
= AllocateZeroPool(sizeof(REFIT_MENU_ENTRY
));
570 if ((Entry
!= NULL
) && (NewEntry
!= NULL
)) {
571 CopyMem(NewEntry
, Entry
, sizeof(REFIT_MENU_ENTRY
));
572 NewEntry
->Title
= (Entry
->Title
) ? StrDuplicate(Entry
->Title
) : NULL
;
573 if (Entry
->BadgeImage
!= NULL
) {
574 NewEntry
->BadgeImage
= AllocatePool(sizeof(EG_IMAGE
));
575 if (NewEntry
->BadgeImage
!= NULL
)
576 CopyMem(NewEntry
->BadgeImage
, Entry
->BadgeImage
, sizeof(EG_IMAGE
));
578 if (Entry
->Image
!= NULL
) {
579 NewEntry
->Image
= AllocatePool(sizeof(EG_IMAGE
));
580 if (NewEntry
->Image
!= NULL
)
581 CopyMem(NewEntry
->Image
, Entry
->Image
, sizeof(EG_IMAGE
));
583 if (Entry
->SubScreen
!= NULL
) {
584 NewEntry
->SubScreen
= CopyMenuScreen(Entry
->SubScreen
);
588 } // REFIT_MENU_ENTRY* CopyMenuEntry()
590 // Creates a new LOADER_ENTRY data structure and populates it with
591 // default values from the specified Entry, or NULL values if Entry
592 // is unspecified (NULL).
593 // Returns a pointer to the new data structure, or NULL if it
594 // couldn't be allocated
595 LOADER_ENTRY
*InitializeLoaderEntry(IN LOADER_ENTRY
*Entry
) {
596 LOADER_ENTRY
*NewEntry
= NULL
;
598 NewEntry
= AllocateZeroPool(sizeof(LOADER_ENTRY
));
599 if (NewEntry
!= NULL
) {
600 NewEntry
->me
.Title
= NULL
;
601 NewEntry
->me
.Tag
= TAG_LOADER
;
602 NewEntry
->Enabled
= TRUE
;
603 NewEntry
->UseGraphicsMode
= FALSE
;
604 NewEntry
->OSType
= 0;
606 NewEntry
->LoaderPath
= (Entry
->LoaderPath
) ? StrDuplicate(Entry
->LoaderPath
) : NULL
;
607 NewEntry
->VolName
= (Entry
->VolName
) ? StrDuplicate(Entry
->VolName
) : NULL
;
608 NewEntry
->DevicePath
= Entry
->DevicePath
;
609 NewEntry
->UseGraphicsMode
= Entry
->UseGraphicsMode
;
610 NewEntry
->LoadOptions
= (Entry
->LoadOptions
) ? StrDuplicate(Entry
->LoadOptions
) : NULL
;
611 NewEntry
->InitrdPath
= (Entry
->InitrdPath
) ? StrDuplicate(Entry
->InitrdPath
) : NULL
;
615 } // LOADER_ENTRY *InitializeLoaderEntry()
617 // Adds InitrdPath to Options, but only if Options doesn't already include an
618 // initrd= line. Done to enable overriding the default initrd selection in a
619 // refind_linux.conf file's options list.
620 // Returns a pointer to a new string. The calling function is responsible for
621 // freeing its memory.
622 static CHAR16
*AddInitrdToOptions(CHAR16
*Options
, CHAR16
*InitrdPath
) {
623 CHAR16
*NewOptions
= NULL
;
626 NewOptions
= StrDuplicate(Options
);
627 if ((InitrdPath
!= NULL
) && !StriSubCmp(L
"initrd=", Options
)) {
628 MergeStrings(&NewOptions
, L
"initrd=", L
' ');
629 MergeStrings(&NewOptions
, InitrdPath
, 0);
632 } // CHAR16 *AddInitrdToOptions()
634 // Prepare a REFIT_MENU_SCREEN data structure for a subscreen entry. This sets up
635 // the default entry that launches the boot loader using the same options as the
636 // main Entry does. Subsequent options can be added by the calling function.
637 // If a subscreen already exists in the Entry that's passed to this function,
638 // it's left unchanged and a pointer to it is returned.
639 // Returns a pointer to the new subscreen data structure, or NULL if there
640 // were problems allocating memory.
641 REFIT_MENU_SCREEN
*InitializeSubScreen(IN LOADER_ENTRY
*Entry
) {
642 CHAR16
*FileName
, *MainOptions
= NULL
;
643 REFIT_MENU_SCREEN
*SubScreen
= NULL
;
644 LOADER_ENTRY
*SubEntry
;
646 FileName
= Basename(Entry
->LoaderPath
);
647 if (Entry
->me
.SubScreen
== NULL
) { // No subscreen yet; initialize default entry....
648 SubScreen
= AllocateZeroPool(sizeof(REFIT_MENU_SCREEN
));
649 if (SubScreen
!= NULL
) {
650 SubScreen
->Title
= AllocateZeroPool(sizeof(CHAR16
) * 256);
651 SPrint(SubScreen
->Title
, 255, L
"Boot Options for %s on %s",
652 (Entry
->Title
!= NULL
) ? Entry
->Title
: FileName
, Entry
->VolName
);
653 SubScreen
->TitleImage
= Entry
->me
.Image
;
655 SubEntry
= InitializeLoaderEntry(Entry
);
656 if (SubEntry
!= NULL
) {
657 SubEntry
->me
.Title
= StrDuplicate(L
"Boot using default options");
658 MainOptions
= SubEntry
->LoadOptions
;
659 SubEntry
->LoadOptions
= AddInitrdToOptions(MainOptions
, SubEntry
->InitrdPath
);
660 MyFreePool(MainOptions
);
661 AddMenuEntry(SubScreen
, (REFIT_MENU_ENTRY
*)SubEntry
);
662 } // if (SubEntry != NULL)
663 SubScreen
->Hint1
= StrDuplicate(SUBSCREEN_HINT1
);
664 if (GlobalConfig
.HideUIFlags
& HIDEUI_FLAG_EDITOR
) {
665 SubScreen
->Hint2
= StrDuplicate(SUBSCREEN_HINT2_NO_EDITOR
);
667 SubScreen
->Hint2
= StrDuplicate(SUBSCREEN_HINT2
);
669 } // if (SubScreen != NULL)
670 } else { // existing subscreen; less initialization, and just add new entry later....
671 SubScreen
= Entry
->me
.SubScreen
;
674 } // REFIT_MENU_SCREEN *InitializeSubScreen()
676 VOID
GenerateSubScreen(LOADER_ENTRY
*Entry
, IN REFIT_VOLUME
*Volume
) {
677 REFIT_MENU_SCREEN
*SubScreen
;
678 LOADER_ENTRY
*SubEntry
;
680 CHAR16 DiagsFileName
[256];
685 // create the submenu
686 if (StrLen(Entry
->Title
) == 0) {
687 MyFreePool(Entry
->Title
);
690 SubScreen
= InitializeSubScreen(Entry
);
692 // loader-specific submenu entries
693 if (Entry
->OSType
== 'M') { // entries for Mac OS X
695 SubEntry
= InitializeLoaderEntry(Entry
);
696 if (SubEntry
!= NULL
) {
697 SubEntry
->me
.Title
= L
"Boot Mac OS X with a 64-bit kernel";
698 SubEntry
->LoadOptions
= L
"arch=x86_64";
699 SubEntry
->UseGraphicsMode
= GlobalConfig
.GraphicsFor
& GRAPHICS_FOR_OSX
;
700 AddMenuEntry(SubScreen
, (REFIT_MENU_ENTRY
*)SubEntry
);
703 SubEntry
= InitializeLoaderEntry(Entry
);
704 if (SubEntry
!= NULL
) {
705 SubEntry
->me
.Title
= L
"Boot Mac OS X with a 32-bit kernel";
706 SubEntry
->LoadOptions
= L
"arch=i386";
707 SubEntry
->UseGraphicsMode
= GlobalConfig
.GraphicsFor
& GRAPHICS_FOR_OSX
;
708 AddMenuEntry(SubScreen
, (REFIT_MENU_ENTRY
*)SubEntry
);
712 if (!(GlobalConfig
.HideUIFlags
& HIDEUI_FLAG_SINGLEUSER
)) {
713 SubEntry
= InitializeLoaderEntry(Entry
);
714 if (SubEntry
!= NULL
) {
715 SubEntry
->me
.Title
= L
"Boot Mac OS X in verbose mode";
716 SubEntry
->UseGraphicsMode
= FALSE
;
717 SubEntry
->LoadOptions
= L
"-v";
718 AddMenuEntry(SubScreen
, (REFIT_MENU_ENTRY
*)SubEntry
);
722 SubEntry
= InitializeLoaderEntry(Entry
);
723 if (SubEntry
!= NULL
) {
724 SubEntry
->me
.Title
= L
"Boot Mac OS X in verbose mode (64-bit)";
725 SubEntry
->UseGraphicsMode
= FALSE
;
726 SubEntry
->LoadOptions
= L
"-v arch=x86_64";
727 AddMenuEntry(SubScreen
, (REFIT_MENU_ENTRY
*)SubEntry
);
730 SubEntry
= InitializeLoaderEntry(Entry
);
731 if (SubEntry
!= NULL
) {
732 SubEntry
->me
.Title
= L
"Boot Mac OS X in verbose mode (32-bit)";
733 SubEntry
->UseGraphicsMode
= FALSE
;
734 SubEntry
->LoadOptions
= L
"-v arch=i386";
735 AddMenuEntry(SubScreen
, (REFIT_MENU_ENTRY
*)SubEntry
);
739 SubEntry
= InitializeLoaderEntry(Entry
);
740 if (SubEntry
!= NULL
) {
741 SubEntry
->me
.Title
= L
"Boot Mac OS X in single user mode";
742 SubEntry
->UseGraphicsMode
= FALSE
;
743 SubEntry
->LoadOptions
= L
"-v -s";
744 AddMenuEntry(SubScreen
, (REFIT_MENU_ENTRY
*)SubEntry
);
746 } // single-user mode allowed
748 if (!(GlobalConfig
.HideUIFlags
& HIDEUI_FLAG_SAFEMODE
)) {
749 SubEntry
= InitializeLoaderEntry(Entry
);
750 if (SubEntry
!= NULL
) {
751 SubEntry
->me
.Title
= L
"Boot Mac OS X in safe mode";
752 SubEntry
->UseGraphicsMode
= FALSE
;
753 SubEntry
->LoadOptions
= L
"-v -x";
754 AddMenuEntry(SubScreen
, (REFIT_MENU_ENTRY
*)SubEntry
);
756 } // safe mode allowed
758 // check for Apple hardware diagnostics
759 StrCpy(DiagsFileName
, L
"System\\Library\\CoreServices\\.diagnostics\\diags.efi");
760 if (FileExists(Volume
->RootDir
, DiagsFileName
) && !(GlobalConfig
.HideUIFlags
& HIDEUI_FLAG_HWTEST
)) {
761 SubEntry
= InitializeLoaderEntry(Entry
);
762 if (SubEntry
!= NULL
) {
763 SubEntry
->me
.Title
= L
"Run Apple Hardware Test";
764 MyFreePool(SubEntry
->LoaderPath
);
765 SubEntry
->LoaderPath
= StrDuplicate(DiagsFileName
);
766 SubEntry
->DevicePath
= FileDevicePath(Volume
->DeviceHandle
, SubEntry
->LoaderPath
);
767 SubEntry
->UseGraphicsMode
= GlobalConfig
.GraphicsFor
& GRAPHICS_FOR_OSX
;
768 AddMenuEntry(SubScreen
, (REFIT_MENU_ENTRY
*)SubEntry
);
770 } // if diagnostics entry found
772 } else if (Entry
->OSType
== 'L') { // entries for Linux kernels with EFI stub loaders
773 File
= ReadLinuxOptionsFile(Entry
->LoaderPath
, Volume
);
775 InitrdName
= FindInitrd(Entry
->LoaderPath
, Volume
);
776 TokenCount
= ReadTokenLine(File
, &TokenList
);
777 // first entry requires special processing, since it was initially set
778 // up with a default title but correct options by InitializeSubScreen(),
780 if ((TokenCount
> 1) && (SubScreen
->Entries
!= NULL
) && (SubScreen
->Entries
[0] != NULL
)) {
781 MyFreePool(SubScreen
->Entries
[0]->Title
);
782 SubScreen
->Entries
[0]->Title
= TokenList
[0] ? StrDuplicate(TokenList
[0]) : StrDuplicate(L
"Boot Linux");
784 FreeTokenLine(&TokenList
, &TokenCount
);
785 while ((TokenCount
= ReadTokenLine(File
, &TokenList
)) > 1) {
786 SubEntry
= InitializeLoaderEntry(Entry
);
787 SubEntry
->me
.Title
= TokenList
[0] ? StrDuplicate(TokenList
[0]) : StrDuplicate(L
"Boot Linux");
788 MyFreePool(SubEntry
->LoadOptions
);
789 SubEntry
->LoadOptions
= AddInitrdToOptions(TokenList
[1], InitrdName
);
790 FreeTokenLine(&TokenList
, &TokenCount
);
791 SubEntry
->UseGraphicsMode
= GlobalConfig
.GraphicsFor
& GRAPHICS_FOR_LINUX
;
792 AddMenuEntry(SubScreen
, (REFIT_MENU_ENTRY
*)SubEntry
);
794 MyFreePool(InitrdName
);
798 } else if (Entry
->OSType
== 'E') { // entries for ELILO
799 SubEntry
= InitializeLoaderEntry(Entry
);
800 if (SubEntry
!= NULL
) {
801 SubEntry
->me
.Title
= L
"Run ELILO in interactive mode";
802 SubEntry
->LoadOptions
= L
"-p";
803 SubEntry
->UseGraphicsMode
= GlobalConfig
.GraphicsFor
& GRAPHICS_FOR_ELILO
;
804 AddMenuEntry(SubScreen
, (REFIT_MENU_ENTRY
*)SubEntry
);
807 SubEntry
= InitializeLoaderEntry(Entry
);
808 if (SubEntry
!= NULL
) {
809 SubEntry
->me
.Title
= L
"Boot Linux for a 17\" iMac or a 15\" MacBook Pro (*)";
810 SubEntry
->LoadOptions
= L
"-d 0 i17";
811 SubEntry
->UseGraphicsMode
= GlobalConfig
.GraphicsFor
& GRAPHICS_FOR_ELILO
;
812 AddMenuEntry(SubScreen
, (REFIT_MENU_ENTRY
*)SubEntry
);
815 SubEntry
= InitializeLoaderEntry(Entry
);
816 if (SubEntry
!= NULL
) {
817 SubEntry
->me
.Title
= L
"Boot Linux for a 20\" iMac (*)";
818 SubEntry
->LoadOptions
= L
"-d 0 i20";
819 SubEntry
->UseGraphicsMode
= GlobalConfig
.GraphicsFor
& GRAPHICS_FOR_ELILO
;
820 AddMenuEntry(SubScreen
, (REFIT_MENU_ENTRY
*)SubEntry
);
823 SubEntry
= InitializeLoaderEntry(Entry
);
824 if (SubEntry
!= NULL
) {
825 SubEntry
->me
.Title
= L
"Boot Linux for a Mac Mini (*)";
826 SubEntry
->LoadOptions
= L
"-d 0 mini";
827 SubEntry
->UseGraphicsMode
= GlobalConfig
.GraphicsFor
& GRAPHICS_FOR_ELILO
;
828 AddMenuEntry(SubScreen
, (REFIT_MENU_ENTRY
*)SubEntry
);
831 AddMenuInfoLine(SubScreen
, L
"NOTE: This is an example. Entries");
832 AddMenuInfoLine(SubScreen
, L
"marked with (*) may not work.");
834 } else if (Entry
->OSType
== 'X') { // entries for xom.efi
835 // by default, skip the built-in selection and boot from hard disk only
836 Entry
->LoadOptions
= L
"-s -h";
838 SubEntry
= InitializeLoaderEntry(Entry
);
839 if (SubEntry
!= NULL
) {
840 SubEntry
->me
.Title
= L
"Boot Windows from Hard Disk";
841 SubEntry
->LoadOptions
= L
"-s -h";
842 SubEntry
->UseGraphicsMode
= GlobalConfig
.GraphicsFor
& GRAPHICS_FOR_WINDOWS
;
843 AddMenuEntry(SubScreen
, (REFIT_MENU_ENTRY
*)SubEntry
);
846 SubEntry
= InitializeLoaderEntry(Entry
);
847 if (SubEntry
!= NULL
) {
848 SubEntry
->me
.Title
= L
"Boot Windows from CD-ROM";
849 SubEntry
->LoadOptions
= L
"-s -c";
850 SubEntry
->UseGraphicsMode
= GlobalConfig
.GraphicsFor
& GRAPHICS_FOR_WINDOWS
;
851 AddMenuEntry(SubScreen
, (REFIT_MENU_ENTRY
*)SubEntry
);
854 SubEntry
= InitializeLoaderEntry(Entry
);
855 if (SubEntry
!= NULL
) {
856 SubEntry
->me
.Title
= L
"Run XOM in text mode";
857 SubEntry
->LoadOptions
= L
"-v";
858 SubEntry
->UseGraphicsMode
= GlobalConfig
.GraphicsFor
& GRAPHICS_FOR_WINDOWS
;
859 AddMenuEntry(SubScreen
, (REFIT_MENU_ENTRY
*)SubEntry
);
861 } // entries for xom.efi
862 AddMenuEntry(SubScreen
, &MenuEntryReturn
);
863 Entry
->me
.SubScreen
= SubScreen
;
864 } // VOID GenerateSubScreen()
866 // Returns options for a Linux kernel. Reads them from an options file in the
867 // kernel's directory; and if present, adds an initrd= option for an initial
868 // RAM disk file with the same version number as the kernel file.
869 static CHAR16
* GetMainLinuxOptions(IN CHAR16
* LoaderPath
, IN REFIT_VOLUME
*Volume
) {
870 CHAR16
*Options
= NULL
, *InitrdName
, *FullOptions
= NULL
;
872 Options
= GetFirstOptionsFromFile(LoaderPath
, Volume
);
873 InitrdName
= FindInitrd(LoaderPath
, Volume
);
874 FullOptions
= AddInitrdToOptions(Options
, InitrdName
);
877 MyFreePool(InitrdName
);
878 return (FullOptions
);
879 } // static CHAR16 * GetMainLinuxOptions()
881 // Try to guess the name of the Linux distribution & add that name to
883 static VOID
GuessLinuxDistribution(CHAR16
**OSIconName
, REFIT_VOLUME
*Volume
, CHAR16
*LoaderPath
) {
887 UINTN TokenCount
= 0;
889 // If on Linux root fs, /etc/os-release file probably has clues....
890 if (FileExists(Volume
->RootDir
, L
"etc\\os-release") &&
891 (ReadFile(Volume
->RootDir
, L
"etc\\os-release", &File
, &FileSize
) == EFI_SUCCESS
)) {
893 TokenCount
= ReadTokenLine(&File
, &TokenList
);
894 if ((TokenCount
> 1) && ((StriCmp(TokenList
[0], L
"ID") == 0) || (StriCmp(TokenList
[0], L
"NAME") == 0))) {
895 MergeStrings(OSIconName
, TokenList
[1], L
',');
897 FreeTokenLine(&TokenList
, &TokenCount
);
898 } while (TokenCount
> 0);
899 MyFreePool(File
.Buffer
);
902 // Search for clues in the kernel's filename....
903 if (StriSubCmp(L
".fc", LoaderPath
))
904 MergeStrings(OSIconName
, L
"fedora", L
',');
905 if (StriSubCmp(L
".el", LoaderPath
))
906 MergeStrings(OSIconName
, L
"redhat", L
',');
907 } // VOID GuessLinuxDistribution()
909 // Sets a few defaults for a loader entry -- mainly the icon, but also the OS type
910 // code and shortcut letter. For Linux EFI stub loaders, also sets kernel options
911 // that will (with luck) work fairly automatically.
912 VOID
SetLoaderDefaults(LOADER_ENTRY
*Entry
, CHAR16
*LoaderPath
, REFIT_VOLUME
*Volume
) {
913 CHAR16
*NameClues
, *PathOnly
, *NoExtension
, *OSIconName
= NULL
, *Temp
, *SubString
;
914 CHAR16 ShortcutLetter
= 0;
917 NameClues
= Basename(LoaderPath
);
918 PathOnly
= FindPath(LoaderPath
);
919 NoExtension
= StripEfiExtension(NameClues
);
921 if (Volume
->DiskKind
== DISK_KIND_NET
) {
922 MergeStrings(&NameClues
, Entry
->me
.Title
, L
' ');
924 // locate a custom icon for the loader
925 // Anything found here takes precedence over the "hints" in the OSIconName variable
926 if (!Entry
->me
.Image
) {
927 Entry
->me
.Image
= egLoadIconAnyType(Volume
->RootDir
, PathOnly
, NoExtension
, GlobalConfig
.IconSizes
[ICON_SIZE_BIG
]);
929 if (!Entry
->me
.Image
) {
930 Entry
->me
.Image
= egCopyImage(Volume
->VolIconImage
);
933 // Begin creating icon "hints" by using last part of directory path leading
935 Temp
= FindLastDirName(LoaderPath
);
936 MergeStrings(&OSIconName
, Temp
, L
',');
939 if (OSIconName
!= NULL
) {
940 ShortcutLetter
= OSIconName
[0];
943 // Add every "word" in the volume label, delimited by spaces, dashes (-), or
944 // underscores (_), to the list of hints to be used in searching for OS
946 if ((Volume
->VolName
) && (StrLen(Volume
->VolName
) > 0)) {
947 Temp
= SubString
= StrDuplicate(Volume
->VolName
);
949 Length
= StrLen(Temp
);
950 for (i
= 0; i
< Length
; i
++) {
951 if ((Temp
[i
] == L
' ') || (Temp
[i
] == L
'_') || (Temp
[i
] == L
'-')) {
953 if (StrLen(SubString
) > 0)
954 MergeStrings(&OSIconName
, SubString
, L
',');
955 SubString
= Temp
+ i
+ 1;
958 MergeStrings(&OSIconName
, SubString
, L
',');
962 } // if/else network boot
964 // detect specific loaders
965 if (StriSubCmp(L
"bzImage", NameClues
) || StriSubCmp(L
"vmlinuz", NameClues
)) {
966 if (Volume
->DiskKind
!= DISK_KIND_NET
) {
967 GuessLinuxDistribution(&OSIconName
, Volume
, LoaderPath
);
968 Entry
->LoadOptions
= GetMainLinuxOptions(LoaderPath
, Volume
);
970 MergeStrings(&OSIconName
, L
"linux", L
',');
972 if (ShortcutLetter
== 0)
973 ShortcutLetter
= 'L';
974 Entry
->UseGraphicsMode
= GlobalConfig
.GraphicsFor
& GRAPHICS_FOR_LINUX
;
975 } else if (StriSubCmp(L
"refit", LoaderPath
)) {
976 MergeStrings(&OSIconName
, L
"refit", L
',');
978 ShortcutLetter
= 'R';
979 } else if (StriSubCmp(L
"refind", LoaderPath
)) {
980 MergeStrings(&OSIconName
, L
"refind", L
',');
982 ShortcutLetter
= 'R';
983 } else if (StriCmp(LoaderPath
, MACOSX_LOADER_PATH
) == 0) {
984 MergeStrings(&OSIconName
, L
"mac", L
',');
986 ShortcutLetter
= 'M';
987 Entry
->UseGraphicsMode
= GlobalConfig
.GraphicsFor
& GRAPHICS_FOR_OSX
;
988 } else if (StriCmp(NameClues
, L
"diags.efi") == 0) {
989 MergeStrings(&OSIconName
, L
"hwtest", L
',');
990 } else if (StriCmp(NameClues
, L
"e.efi") == 0 || StriCmp(NameClues
, L
"elilo.efi") == 0 || StriSubCmp(L
"elilo", NameClues
)) {
991 MergeStrings(&OSIconName
, L
"elilo,linux", L
',');
993 if (ShortcutLetter
== 0)
994 ShortcutLetter
= 'L';
995 Entry
->UseGraphicsMode
= GlobalConfig
.GraphicsFor
& GRAPHICS_FOR_ELILO
;
996 } else if (StriSubCmp(L
"grub", NameClues
)) {
997 MergeStrings(&OSIconName
, L
"grub,linux", L
',');
999 ShortcutLetter
= 'G';
1000 Entry
->UseGraphicsMode
= GlobalConfig
.GraphicsFor
& GRAPHICS_FOR_GRUB
;
1001 } else if (StriCmp(NameClues
, L
"cdboot.efi") == 0 ||
1002 StriCmp(NameClues
, L
"bootmgr.efi") == 0 ||
1003 StriCmp(NameClues
, L
"bootmgfw.efi") == 0 ||
1004 StriCmp(NameClues
, L
"bkpbootmgfw.efi") == 0) {
1005 MergeStrings(&OSIconName
, L
"win8", L
',');
1006 Entry
->OSType
= 'W';
1007 ShortcutLetter
= 'W';
1008 Entry
->UseGraphicsMode
= GlobalConfig
.GraphicsFor
& GRAPHICS_FOR_WINDOWS
;
1009 } else if (StriCmp(NameClues
, L
"xom.efi") == 0) {
1010 MergeStrings(&OSIconName
, L
"xom,win,win8", L
',');
1011 Entry
->OSType
= 'X';
1012 ShortcutLetter
= 'W';
1013 Entry
->UseGraphicsMode
= GlobalConfig
.GraphicsFor
& GRAPHICS_FOR_WINDOWS
;
1015 else if (StriSubCmp(L
"ipxe", NameClues
)) {
1016 Entry
->OSType
= 'N';
1017 ShortcutLetter
= 'N';
1018 MergeStrings(&OSIconName
, L
"network", L
',');
1021 if ((ShortcutLetter
>= 'a') && (ShortcutLetter
<= 'z'))
1022 ShortcutLetter
= ShortcutLetter
- 'a' + 'A'; // convert lowercase to uppercase
1023 Entry
->me
.ShortcutLetter
= ShortcutLetter
;
1024 if (Entry
->me
.Image
== NULL
)
1025 Entry
->me
.Image
= LoadOSIcon(OSIconName
, L
"unknown", FALSE
);
1026 MyFreePool(PathOnly
);
1027 } // VOID SetLoaderDefaults()
1029 // Add a specified EFI boot loader to the list, using automatic settings
1030 // for icons, options, etc.
1031 LOADER_ENTRY
* AddLoaderEntry(IN CHAR16
*LoaderPath
, IN CHAR16
*LoaderTitle
, IN REFIT_VOLUME
*Volume
) {
1032 LOADER_ENTRY
*Entry
;
1034 CleanUpPathNameSlashes(LoaderPath
);
1035 Entry
= InitializeLoaderEntry(NULL
);
1036 if (Entry
!= NULL
) {
1037 Entry
->Title
= StrDuplicate((LoaderTitle
!= NULL
) ? LoaderTitle
: LoaderPath
);
1038 Entry
->me
.Title
= AllocateZeroPool(sizeof(CHAR16
) * 256);
1039 // Extra space at end of Entry->me.Title enables searching on Volume->VolName even if another volume
1040 // name is identical except for something added to the end (e.g., VolB1 vs. VolB12).
1041 // Note: Volume->VolName will be NULL for network boot programs.
1042 if (Volume
->VolName
)
1043 SPrint(Entry
->me
.Title
, 255, L
"Boot %s from %s ", (LoaderTitle
!= NULL
) ? LoaderTitle
: LoaderPath
, Volume
->VolName
);
1045 SPrint(Entry
->me
.Title
, 255, L
"Boot %s ", (LoaderTitle
!= NULL
) ? LoaderTitle
: LoaderPath
);
1047 Entry
->me
.BadgeImage
= Volume
->VolBadgeImage
;
1048 if ((LoaderPath
!= NULL
) && (LoaderPath
[0] != L
'\\')) {
1049 Entry
->LoaderPath
= StrDuplicate(L
"\\");
1051 Entry
->LoaderPath
= NULL
;
1053 MergeStrings(&(Entry
->LoaderPath
), LoaderPath
, 0);
1054 Entry
->VolName
= Volume
->VolName
;
1055 Entry
->DevicePath
= FileDevicePath(Volume
->DeviceHandle
, Entry
->LoaderPath
);
1056 SetLoaderDefaults(Entry
, LoaderPath
, Volume
);
1057 GenerateSubScreen(Entry
, Volume
);
1058 AddMenuEntry(&MainMenu
, (REFIT_MENU_ENTRY
*)Entry
);
1062 } // LOADER_ENTRY * AddLoaderEntry()
1064 // Returns -1 if (Time1 < Time2), +1 if (Time1 > Time2), or 0 if
1065 // (Time1 == Time2). Precision is only to the nearest second; since
1066 // this is used for sorting boot loader entries, differences smaller
1067 // than this are likely to be meaningless (and unlikely!).
1068 INTN
TimeComp(IN EFI_TIME
*Time1
, IN EFI_TIME
*Time2
) {
1069 INT64 Time1InSeconds
, Time2InSeconds
;
1071 // Following values are overestimates; I'm assuming 31 days in every month.
1072 // This is fine for the purpose of this function, which is limited
1073 Time1InSeconds
= Time1
->Second
+ (Time1
->Minute
* 60) + (Time1
->Hour
* 3600) + (Time1
->Day
* 86400) +
1074 (Time1
->Month
* 2678400) + ((Time1
->Year
- 1998) * 32140800);
1075 Time2InSeconds
= Time2
->Second
+ (Time2
->Minute
* 60) + (Time2
->Hour
* 3600) + (Time2
->Day
* 86400) +
1076 (Time2
->Month
* 2678400) + ((Time2
->Year
- 1998) * 32140800);
1077 if (Time1InSeconds
< Time2InSeconds
)
1079 else if (Time1InSeconds
> Time2InSeconds
)
1083 } // INTN TimeComp()
1085 // Adds a loader list element, keeping it sorted by date. Returns the new
1086 // first element (the one with the most recent date).
1087 static struct LOADER_LIST
* AddLoaderListEntry(struct LOADER_LIST
*LoaderList
, struct LOADER_LIST
*NewEntry
) {
1088 struct LOADER_LIST
*LatestEntry
, *CurrentEntry
, *PrevEntry
= NULL
;
1090 LatestEntry
= CurrentEntry
= LoaderList
;
1091 if (LoaderList
== NULL
) {
1092 LatestEntry
= NewEntry
;
1094 while ((CurrentEntry
!= NULL
) && (TimeComp(&(NewEntry
->TimeStamp
), &(CurrentEntry
->TimeStamp
)) < 0)) {
1095 PrevEntry
= CurrentEntry
;
1096 CurrentEntry
= CurrentEntry
->NextEntry
;
1098 NewEntry
->NextEntry
= CurrentEntry
;
1099 if (PrevEntry
== NULL
) {
1100 LatestEntry
= NewEntry
;
1102 PrevEntry
->NextEntry
= NewEntry
;
1105 return (LatestEntry
);
1106 } // static VOID AddLoaderListEntry()
1108 // Delete the LOADER_LIST linked list
1109 static VOID
CleanUpLoaderList(struct LOADER_LIST
*LoaderList
) {
1110 struct LOADER_LIST
*Temp
;
1112 while (LoaderList
!= NULL
) {
1114 LoaderList
= LoaderList
->NextEntry
;
1115 MyFreePool(Temp
->FileName
);
1118 } // static VOID CleanUpLoaderList()
1120 // Returns FALSE if the specified file/volume matches the GlobalConfig.DontScanDirs
1121 // or GlobalConfig.DontScanVolumes specification, or if Path points to a volume
1122 // other than the one specified by Volume, or if the specified path is SelfDir.
1123 // Returns TRUE if none of these conditions is met -- that is, if the path is
1124 // eligible for scanning.
1125 static BOOLEAN
ShouldScan(REFIT_VOLUME
*Volume
, CHAR16
*Path
) {
1126 CHAR16
*VolName
= NULL
, *DontScanDir
, *PathCopy
= NULL
;
1128 BOOLEAN ScanIt
= TRUE
;
1130 if ((IsIn(Volume
->VolName
, GlobalConfig
.DontScanVolumes
)) || (IsIn(Volume
->PartName
, GlobalConfig
.DontScanVolumes
)))
1133 if ((StriCmp(Path
, SelfDirPath
) == 0) && (Volume
->DeviceHandle
== SelfVolume
->DeviceHandle
))
1136 // See if Path includes an explicit volume declaration that's NOT Volume....
1137 PathCopy
= StrDuplicate(Path
);
1138 if (SplitVolumeAndFilename(&PathCopy
, &VolName
)) {
1139 VolumeNumberToName(Volume
, &VolName
);
1140 if (VolName
&& StriCmp(VolName
, Volume
->VolName
) != 0) {
1143 } // if Path includes volume specification
1144 MyFreePool(PathCopy
);
1145 MyFreePool(VolName
);
1148 // See if Volume is in GlobalConfig.DontScanDirs....
1149 while (ScanIt
&& (DontScanDir
= FindCommaDelimited(GlobalConfig
.DontScanDirs
, i
++))) {
1150 SplitVolumeAndFilename(&DontScanDir
, &VolName
);
1151 CleanUpPathNameSlashes(DontScanDir
);
1152 VolumeNumberToName(Volume
, &VolName
);
1153 if (VolName
!= NULL
) {
1154 if ((StriCmp(VolName
, Volume
->VolName
) == 0) && (StriCmp(DontScanDir
, Path
) == 0))
1157 if (StriCmp(DontScanDir
, Path
) == 0)
1160 MyFreePool(DontScanDir
);
1161 MyFreePool(VolName
);
1167 } // BOOLEAN ShouldScan()
1169 // Returns TRUE if the file is byte-for-byte identical with the fallback file
1170 // on the volume AND if the file is not itself the fallback file; returns
1171 // FALSE if the file is not identical to the fallback file OR if the file
1172 // IS the fallback file. Intended for use in excluding the fallback boot
1173 // loader when it's a duplicate of another boot loader.
1174 static BOOLEAN
DuplicatesFallback(IN REFIT_VOLUME
*Volume
, IN CHAR16
*FileName
) {
1175 CHAR8
*FileContents
, *FallbackContents
;
1176 EFI_FILE_HANDLE FileHandle
, FallbackHandle
;
1177 EFI_FILE_INFO
*FileInfo
, *FallbackInfo
;
1178 UINTN FileSize
= 0, FallbackSize
= 0;
1180 BOOLEAN AreIdentical
= FALSE
;
1182 if (!FileExists(Volume
->RootDir
, FileName
) || !FileExists(Volume
->RootDir
, FALLBACK_FULLNAME
))
1185 CleanUpPathNameSlashes(FileName
);
1187 if (StriCmp(FileName
, FALLBACK_FULLNAME
) == 0)
1188 return FALSE
; // identical filenames, so not a duplicate....
1190 Status
= refit_call5_wrapper(Volume
->RootDir
->Open
, Volume
->RootDir
, &FileHandle
, FileName
, EFI_FILE_MODE_READ
, 0);
1191 if (Status
== EFI_SUCCESS
) {
1192 FileInfo
= LibFileInfo(FileHandle
);
1193 FileSize
= FileInfo
->FileSize
;
1198 Status
= refit_call5_wrapper(Volume
->RootDir
->Open
, Volume
->RootDir
, &FallbackHandle
, FALLBACK_FULLNAME
, EFI_FILE_MODE_READ
, 0);
1199 if (Status
== EFI_SUCCESS
) {
1200 FallbackInfo
= LibFileInfo(FallbackHandle
);
1201 FallbackSize
= FallbackInfo
->FileSize
;
1203 refit_call1_wrapper(FileHandle
->Close
, FileHandle
);
1207 if (FallbackSize
!= FileSize
) { // not same size, so can't be identical
1208 AreIdentical
= FALSE
;
1209 } else { // could be identical; do full check....
1210 FileContents
= AllocatePool(FileSize
);
1211 FallbackContents
= AllocatePool(FallbackSize
);
1212 if (FileContents
&& FallbackContents
) {
1213 Status
= refit_call3_wrapper(FileHandle
->Read
, FileHandle
, &FileSize
, FileContents
);
1214 if (Status
== EFI_SUCCESS
) {
1215 Status
= refit_call3_wrapper(FallbackHandle
->Read
, FallbackHandle
, &FallbackSize
, FallbackContents
);
1217 if (Status
== EFI_SUCCESS
) {
1218 AreIdentical
= (CompareMem(FileContents
, FallbackContents
, FileSize
) == 0);
1221 MyFreePool(FileContents
);
1222 MyFreePool(FallbackContents
);
1225 // BUG ALERT: Some systems (e.g., DUET, some Macs with large displays) crash if the
1226 // following two calls are reversed. Go figure....
1227 refit_call1_wrapper(FileHandle
->Close
, FallbackHandle
);
1228 refit_call1_wrapper(FileHandle
->Close
, FileHandle
);
1229 return AreIdentical
;
1230 } // BOOLEAN DuplicatesFallback()
1232 // Returns FALSE if two measures of file size are identical for a single file,
1233 // TRUE if not or if the file can't be opened and the other measure is non-0.
1234 // Despite the function's name, this isn't really a direct test of symbolic
1235 // link status, since EFI doesn't officially support symlinks. It does seem
1236 // to be a reliable indicator, though. (OTOH, some disk errors might cause a
1237 // file to fail to open, which would return a false positive -- but as I use
1238 // this function to exclude symbolic links from the list of boot loaders,
1239 // that would be fine, since such boot loaders wouldn't work.)
1240 static BOOLEAN
IsSymbolicLink(REFIT_VOLUME
*Volume
, CHAR16
*Path
, EFI_FILE_INFO
*DirEntry
) {
1241 EFI_FILE_HANDLE FileHandle
;
1242 EFI_FILE_INFO
*FileInfo
= NULL
;
1244 UINTN FileSize2
= 0;
1247 FileName
= StrDuplicate(Path
);
1248 MergeStrings(&FileName
, DirEntry
->FileName
, L
'\\');
1249 CleanUpPathNameSlashes(FileName
);
1251 Status
= refit_call5_wrapper(Volume
->RootDir
->Open
, Volume
->RootDir
, &FileHandle
, FileName
, EFI_FILE_MODE_READ
, 0);
1252 if (Status
== EFI_SUCCESS
) {
1253 FileInfo
= LibFileInfo(FileHandle
);
1254 if (FileInfo
!= NULL
)
1255 FileSize2
= FileInfo
->FileSize
;
1258 MyFreePool(FileName
);
1259 MyFreePool(FileInfo
);
1261 return (DirEntry
->FileSize
!= FileSize2
);
1262 } // BOOLEAN IsSymbolicLink()
1264 // Returns TRUE if a file with the same name as the original but with
1265 // ".efi.signed" is also present in the same directory. Ubuntu is using
1266 // this filename as a signed version of the original unsigned kernel, and
1267 // there's no point in cluttering the display with two kernels that will
1268 // behave identically on non-SB systems, or when one will fail when SB
1270 static BOOLEAN
HasSignedCounterpart(IN REFIT_VOLUME
*Volume
, IN CHAR16
*Path
, IN CHAR16
*Filename
) {
1271 CHAR16
*NewFile
= NULL
;
1272 BOOLEAN retval
= FALSE
;
1274 MergeStrings(&NewFile
, Path
, 0);
1275 MergeStrings(&NewFile
, Filename
, L
'\\');
1276 MergeStrings(&NewFile
, L
".efi.signed", 0);
1277 if (NewFile
!= NULL
) {
1278 CleanUpPathNameSlashes(NewFile
);
1279 if (FileExists(Volume
->RootDir
, NewFile
))
1281 MyFreePool(NewFile
);
1285 } // BOOLEAN HasSignedCounterpart()
1287 // Scan an individual directory for EFI boot loader files and, if found,
1288 // add them to the list. Exception: Ignores FALLBACK_FULLNAME, which is picked
1289 // up in ScanEfiFiles(). Sorts the entries within the loader directory so that
1290 // the most recent one appears first in the list.
1291 // Returns TRUE if a duplicate for FALLBACK_FILENAME was found, FALSE if not.
1292 static BOOLEAN
ScanLoaderDir(IN REFIT_VOLUME
*Volume
, IN CHAR16
*Path
, IN CHAR16
*Pattern
)
1295 REFIT_DIR_ITER DirIter
;
1296 EFI_FILE_INFO
*DirEntry
;
1297 CHAR16 FileName
[256], *Extension
;
1298 struct LOADER_LIST
*LoaderList
= NULL
, *NewLoader
;
1299 BOOLEAN FoundFallbackDuplicate
= FALSE
;
1301 if ((!SelfDirPath
|| !Path
|| ((StriCmp(Path
, SelfDirPath
) == 0) && (Volume
->DeviceHandle
!= SelfVolume
->DeviceHandle
)) ||
1302 (StriCmp(Path
, SelfDirPath
) != 0)) && (ShouldScan(Volume
, Path
))) {
1303 // look through contents of the directory
1304 DirIterOpen(Volume
->RootDir
, Path
, &DirIter
);
1305 while (DirIterNext(&DirIter
, 2, Pattern
, &DirEntry
)) {
1306 Extension
= FindExtension(DirEntry
->FileName
);
1307 if (DirEntry
->FileName
[0] == '.' ||
1308 StriCmp(Extension
, L
".icns") == 0 ||
1309 StriCmp(Extension
, L
".png") == 0 ||
1310 (StriCmp(DirEntry
->FileName
, FALLBACK_BASENAME
) == 0 && (StriCmp(Path
, L
"EFI\\BOOT") == 0)) ||
1311 StriSubCmp(L
"shell", DirEntry
->FileName
) ||
1312 IsSymbolicLink(Volume
, Path
, DirEntry
) || /* is symbolic link */
1313 HasSignedCounterpart(Volume
, Path
, DirEntry
->FileName
) || /* a file with same name plus ".efi.signed" is present */
1314 FilenameIn(Volume
, Path
, DirEntry
->FileName
, GlobalConfig
.DontScanFiles
))
1315 continue; // skip this
1318 SPrint(FileName
, 255, L
"\\%s\\%s", Path
, DirEntry
->FileName
);
1320 SPrint(FileName
, 255, L
"\\%s", DirEntry
->FileName
);
1321 CleanUpPathNameSlashes(FileName
);
1323 if(!IsValidLoader(Volume
->RootDir
, FileName
))
1326 NewLoader
= AllocateZeroPool(sizeof(struct LOADER_LIST
));
1327 if (NewLoader
!= NULL
) {
1328 NewLoader
->FileName
= StrDuplicate(FileName
);
1329 NewLoader
->TimeStamp
= DirEntry
->ModificationTime
;
1330 LoaderList
= AddLoaderListEntry(LoaderList
, NewLoader
);
1331 if (DuplicatesFallback(Volume
, FileName
))
1332 FoundFallbackDuplicate
= TRUE
;
1334 MyFreePool(Extension
);
1337 NewLoader
= LoaderList
;
1338 while (NewLoader
!= NULL
) {
1339 AddLoaderEntry(NewLoader
->FileName
, NULL
, Volume
);
1340 NewLoader
= NewLoader
->NextEntry
;
1343 CleanUpLoaderList(LoaderList
);
1344 Status
= DirIterClose(&DirIter
);
1345 // NOTE: EFI_INVALID_PARAMETER really is an error that should be reported;
1346 // but I've gotten reports from users who are getting this error occasionally
1347 // and I can't find anything wrong or reproduce the problem, so I'm putting
1348 // it down to buggy EFI implementations and ignoring that particular error....
1349 if ((Status
!= EFI_NOT_FOUND
) && (Status
!= EFI_INVALID_PARAMETER
)) {
1351 SPrint(FileName
, 255, L
"while scanning the %s directory", Path
);
1353 StrCpy(FileName
, L
"while scanning the root directory");
1354 CheckError(Status
, FileName
);
1355 } // if (Status != EFI_NOT_FOUND)
1356 } // if not scanning a blacklisted directory
1358 return FoundFallbackDuplicate
;
1359 } /* static VOID ScanLoaderDir() */
1361 // Run the IPXE_DISCOVER_NAME program, which obtains the IP address of the boot
1362 // server and the name of the boot file it delivers.
1363 CHAR16
* RuniPXEDiscover(EFI_HANDLE Volume
)
1366 EFI_DEVICE_PATH
*FilePath
;
1367 EFI_HANDLE iPXEHandle
;
1368 CHAR16
*boot_info
= NULL
;
1369 UINTN boot_info_size
= 0;
1371 FilePath
= FileDevicePath (Volume
, IPXE_DISCOVER_NAME
);
1372 Status
= refit_call6_wrapper(BS
->LoadImage
, FALSE
, SelfImageHandle
, FilePath
,
1373 NULL
, 0, &iPXEHandle
);
1377 Status
= refit_call3_wrapper(BS
->StartImage
, iPXEHandle
, &boot_info_size
, &boot_info
);
1380 } // RuniPXEDiscover()
1382 // Scan for network (PXE) boot servers. This function relies on the presence
1383 // of the IPXE_DISCOVER_NAME and IPXE_NAME program files on the volume from
1384 // which rEFInd launched. As of December 6, 2014, these tools aren't entirely
1385 // reliable. See BUILDING.txt for information on building them.
1386 static VOID
ScanNetboot() {
1387 CHAR16
*iPXEFileName
= IPXE_NAME
;
1389 REFIT_VOLUME
*NetVolume
;
1391 if (FileExists(SelfVolume
->RootDir
, IPXE_DISCOVER_NAME
) &&
1392 FileExists(SelfVolume
->RootDir
, IPXE_NAME
) &&
1393 IsValidLoader(SelfVolume
->RootDir
, IPXE_DISCOVER_NAME
) &&
1394 IsValidLoader(SelfVolume
->RootDir
, IPXE_NAME
)) {
1395 Location
= RuniPXEDiscover(SelfVolume
->DeviceHandle
);
1396 if (Location
!= NULL
&& FileExists(SelfVolume
->RootDir
, iPXEFileName
)) {
1397 NetVolume
= AllocatePool(sizeof(REFIT_VOLUME
));
1398 CopyMem(NetVolume
, SelfVolume
, sizeof(REFIT_VOLUME
));
1399 NetVolume
->DiskKind
= DISK_KIND_NET
;
1400 NetVolume
->VolBadgeImage
= BuiltinIcon(BUILTIN_ICON_VOL_NET
);
1401 NetVolume
->PartName
= NetVolume
->VolName
= NULL
;
1402 AddLoaderEntry(iPXEFileName
, Location
, NetVolume
);
1403 MyFreePool(NetVolume
);
1404 } // if support files exist and are valid
1406 } // VOID ScanNetBoot()
1408 static VOID
ScanEfiFiles(REFIT_VOLUME
*Volume
) {
1410 REFIT_DIR_ITER EfiDirIter
;
1411 EFI_FILE_INFO
*EfiDirEntry
;
1412 CHAR16 FileName
[256], *Directory
= NULL
, *MatchPatterns
, *VolName
= NULL
, *SelfPath
;
1414 BOOLEAN ScanFallbackLoader
= TRUE
;
1415 BOOLEAN FoundBRBackup
= FALSE
;
1417 if (Volume
&& (Volume
->RootDir
!= NULL
) && (Volume
->VolName
!= NULL
) && (Volume
->IsReadable
)) {
1418 MatchPatterns
= StrDuplicate(LOADER_MATCH_PATTERNS
);
1419 if (GlobalConfig
.ScanAllLinux
)
1420 MergeStrings(&MatchPatterns
, LINUX_MATCH_PATTERNS
, L
',');
1422 // check for Mac OS X boot loader
1423 if (ShouldScan(Volume
, MACOSX_LOADER_DIR
)) {
1424 StrCpy(FileName
, MACOSX_LOADER_PATH
);
1425 if (FileExists(Volume
->RootDir
, FileName
) && !FilenameIn(Volume
, MACOSX_LOADER_DIR
, L
"boot.efi", GlobalConfig
.DontScanFiles
)) {
1426 AddLoaderEntry(FileName
, L
"Mac OS X", Volume
);
1427 if (DuplicatesFallback(Volume
, FileName
))
1428 ScanFallbackLoader
= FALSE
;
1432 StrCpy(FileName
, L
"System\\Library\\CoreServices\\xom.efi");
1433 if (FileExists(Volume
->RootDir
, FileName
) && !FilenameIn(Volume
, MACOSX_LOADER_DIR
, L
"xom.efi", GlobalConfig
.DontScanFiles
)) {
1434 AddLoaderEntry(FileName
, L
"Windows XP (XoM)", Volume
);
1435 if (DuplicatesFallback(Volume
, FileName
))
1436 ScanFallbackLoader
= FALSE
;
1438 } // if should scan Mac directory
1440 // check for Microsoft boot loader/menu
1441 if (ShouldScan(Volume
, L
"EFI\\Microsoft\\Boot")) {
1442 StrCpy(FileName
, L
"EFI\\Microsoft\\Boot\\bkpbootmgfw.efi");
1443 if (FileExists(Volume
->RootDir
, FileName
) && !FilenameIn(Volume
, L
"EFI\\Microsoft\\Boot", L
"bkpbootmgfw.efi",
1444 GlobalConfig
.DontScanFiles
)) {
1445 AddLoaderEntry(FileName
, L
"Microsoft EFI boot (Boot Repair backup)", Volume
);
1446 FoundBRBackup
= TRUE
;
1447 if (DuplicatesFallback(Volume
, FileName
))
1448 ScanFallbackLoader
= FALSE
;
1450 StrCpy(FileName
, L
"EFI\\Microsoft\\Boot\\bootmgfw.efi");
1451 if (FileExists(Volume
->RootDir
, FileName
) &&
1452 !FilenameIn(Volume
, L
"EFI\\Microsoft\\Boot", L
"bootmgfw.efi", GlobalConfig
.DontScanFiles
)) {
1454 AddLoaderEntry(FileName
, L
"Supposed Microsoft EFI boot (probably GRUB)", Volume
);
1456 AddLoaderEntry(FileName
, L
"Microsoft EFI boot", Volume
);
1457 if (DuplicatesFallback(Volume
, FileName
))
1458 ScanFallbackLoader
= FALSE
;
1462 // scan the root directory for EFI executables
1463 if (ScanLoaderDir(Volume
, L
"\\", MatchPatterns
))
1464 ScanFallbackLoader
= FALSE
;
1466 // scan subdirectories of the EFI directory (as per the standard)
1467 DirIterOpen(Volume
->RootDir
, L
"EFI", &EfiDirIter
);
1468 while (DirIterNext(&EfiDirIter
, 1, NULL
, &EfiDirEntry
)) {
1469 if (StriCmp(EfiDirEntry
->FileName
, L
"tools") == 0 || EfiDirEntry
->FileName
[0] == '.')
1470 continue; // skip this, doesn't contain boot loaders or is scanned later
1471 SPrint(FileName
, 255, L
"EFI\\%s", EfiDirEntry
->FileName
);
1472 if (ScanLoaderDir(Volume
, FileName
, MatchPatterns
))
1473 ScanFallbackLoader
= FALSE
;
1475 Status
= DirIterClose(&EfiDirIter
);
1476 if ((Status
!= EFI_NOT_FOUND
) && (Status
!= EFI_INVALID_PARAMETER
))
1477 CheckError(Status
, L
"while scanning the EFI directory");
1479 // Scan user-specified (or additional default) directories....
1481 while ((Directory
= FindCommaDelimited(GlobalConfig
.AlsoScan
, i
++)) != NULL
) {
1482 if (ShouldScan(Volume
, Directory
)) {
1483 SplitVolumeAndFilename(&Directory
, &VolName
);
1484 CleanUpPathNameSlashes(Directory
);
1485 Length
= StrLen(Directory
);
1486 if ((Length
> 0) && ScanLoaderDir(Volume
, Directory
, MatchPatterns
))
1487 ScanFallbackLoader
= FALSE
;
1488 MyFreePool(VolName
);
1489 } // if should scan dir
1490 MyFreePool(Directory
);
1493 // Don't scan the fallback loader if it's on the same volume and a duplicate of rEFInd itself....
1494 SelfPath
= DevicePathToStr(SelfLoadedImage
->FilePath
);
1495 CleanUpPathNameSlashes(SelfPath
);
1496 if ((Volume
->DeviceHandle
== SelfLoadedImage
->DeviceHandle
) && DuplicatesFallback(Volume
, SelfPath
))
1497 ScanFallbackLoader
= FALSE
;
1499 // If not a duplicate & if it exists & if it's not us, create an entry
1500 // for the fallback boot loader
1501 if (ScanFallbackLoader
&& FileExists(Volume
->RootDir
, FALLBACK_FULLNAME
) && ShouldScan(Volume
, L
"EFI\\BOOT"))
1502 AddLoaderEntry(FALLBACK_FULLNAME
, L
"Fallback boot loader", Volume
);
1504 } // static VOID ScanEfiFiles()
1506 // Scan internal disks for valid EFI boot loaders....
1507 static VOID
ScanInternal(VOID
) {
1510 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
1511 if (Volumes
[VolumeIndex
]->DiskKind
== DISK_KIND_INTERNAL
) {
1512 ScanEfiFiles(Volumes
[VolumeIndex
]);
1515 } // static VOID ScanInternal()
1517 // Scan external disks for valid EFI boot loaders....
1518 static VOID
ScanExternal(VOID
) {
1521 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
1522 if (Volumes
[VolumeIndex
]->DiskKind
== DISK_KIND_EXTERNAL
) {
1523 ScanEfiFiles(Volumes
[VolumeIndex
]);
1526 } // static VOID ScanExternal()
1528 // Scan internal disks for valid EFI boot loaders....
1529 static VOID
ScanOptical(VOID
) {
1532 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
1533 if (Volumes
[VolumeIndex
]->DiskKind
== DISK_KIND_OPTICAL
) {
1534 ScanEfiFiles(Volumes
[VolumeIndex
]);
1537 } // static VOID ScanOptical()
1539 // default volume badge icon based on disk kind
1540 EG_IMAGE
* GetDiskBadge(IN UINTN DiskType
) {
1541 EG_IMAGE
* Badge
= NULL
;
1545 Badge
= BuiltinIcon(BUILTIN_ICON_VOL_INTERNAL
);
1548 Badge
= BuiltinIcon(BUILTIN_ICON_VOL_EXTERNAL
);
1551 Badge
= BuiltinIcon(BUILTIN_ICON_VOL_OPTICAL
);
1555 } // EG_IMAGE * GetDiskBadge()
1558 // pre-boot tool functions
1561 static VOID
StartTool(IN LOADER_ENTRY
*Entry
)
1563 BeginExternalScreen(Entry
->UseGraphicsMode
, Entry
->me
.Title
+ 6); // assumes "Start <title>" as assigned below
1564 StoreLoaderName(Entry
->me
.Title
);
1565 StartEFIImage(Entry
->DevicePath
, Entry
->LoadOptions
, TYPE_EFI
,
1566 Basename(Entry
->LoaderPath
), Entry
->OSType
, NULL
, TRUE
, FALSE
);
1567 FinishExternalScreen();
1568 } /* static VOID StartTool() */
1570 static LOADER_ENTRY
* AddToolEntry(EFI_HANDLE DeviceHandle
, IN CHAR16
*LoaderPath
, IN CHAR16
*LoaderTitle
, IN EG_IMAGE
*Image
,
1571 IN CHAR16 ShortcutLetter
, IN BOOLEAN UseGraphicsMode
)
1573 LOADER_ENTRY
*Entry
;
1574 CHAR16
*TitleStr
= NULL
;
1576 Entry
= AllocateZeroPool(sizeof(LOADER_ENTRY
));
1578 TitleStr
= PoolPrint(L
"Start %s", LoaderTitle
);
1579 Entry
->me
.Title
= TitleStr
;
1580 Entry
->me
.Tag
= TAG_TOOL
;
1582 Entry
->me
.ShortcutLetter
= ShortcutLetter
;
1583 Entry
->me
.Image
= Image
;
1584 Entry
->LoaderPath
= (LoaderPath
) ? StrDuplicate(LoaderPath
) : NULL
;
1585 Entry
->DevicePath
= FileDevicePath(DeviceHandle
, Entry
->LoaderPath
);
1586 Entry
->UseGraphicsMode
= UseGraphicsMode
;
1588 AddMenuEntry(&MainMenu
, (REFIT_MENU_ENTRY
*)Entry
);
1590 } /* static LOADER_ENTRY * AddToolEntry() */
1593 // pre-boot driver functions
1596 static UINTN
ScanDriverDir(IN CHAR16
*Path
)
1599 REFIT_DIR_ITER DirIter
;
1601 EFI_FILE_INFO
*DirEntry
;
1602 CHAR16 FileName
[256];
1604 CleanUpPathNameSlashes(Path
);
1605 // look through contents of the directory
1606 DirIterOpen(SelfRootDir
, Path
, &DirIter
);
1607 while (DirIterNext(&DirIter
, 2, LOADER_MATCH_PATTERNS
, &DirEntry
)) {
1608 if (DirEntry
->FileName
[0] == '.')
1609 continue; // skip this
1611 SPrint(FileName
, 255, L
"%s\\%s", Path
, DirEntry
->FileName
);
1613 Status
= StartEFIImage(FileDevicePath(SelfLoadedImage
->DeviceHandle
, FileName
),
1614 L
"", TYPE_EFI
, DirEntry
->FileName
, 0, NULL
, FALSE
, TRUE
);
1616 Status
= DirIterClose(&DirIter
);
1617 if ((Status
!= EFI_NOT_FOUND
) && (Status
!= EFI_INVALID_PARAMETER
)) {
1618 SPrint(FileName
, 255, L
"while scanning the %s directory", Path
);
1619 CheckError(Status
, FileName
);
1624 #ifdef __MAKEWITH_GNUEFI
1625 static EFI_STATUS
ConnectAllDriversToAllControllers(VOID
)
1628 UINTN AllHandleCount
;
1629 EFI_HANDLE
*AllHandleBuffer
;
1632 EFI_HANDLE
*HandleBuffer
;
1638 Status
= LibLocateHandle(AllHandles
,
1643 if (EFI_ERROR(Status
))
1646 for (Index
= 0; Index
< AllHandleCount
; Index
++) {
1648 // Scan the handle database
1650 Status
= LibScanHandleDatabase(NULL
,
1652 AllHandleBuffer
[Index
],
1657 if (EFI_ERROR (Status
))
1661 if (HandleType
[Index
] & EFI_HANDLE_TYPE_DRIVER_BINDING_HANDLE
)
1663 if (HandleType
[Index
] & EFI_HANDLE_TYPE_IMAGE_HANDLE
)
1668 for (HandleIndex
= 0; HandleIndex
< HandleCount
; HandleIndex
++) {
1669 if (HandleType
[HandleIndex
] & EFI_HANDLE_TYPE_PARENT_HANDLE
)
1674 if (HandleType
[Index
] & EFI_HANDLE_TYPE_DEVICE_HANDLE
) {
1675 Status
= refit_call4_wrapper(BS
->ConnectController
,
1676 AllHandleBuffer
[Index
],
1684 MyFreePool (HandleBuffer
);
1685 MyFreePool (HandleType
);
1689 MyFreePool (AllHandleBuffer
);
1691 } /* EFI_STATUS ConnectAllDriversToAllControllers() */
1693 static EFI_STATUS
ConnectAllDriversToAllControllers(VOID
) {
1694 BdsLibConnectAllDriversToAllControllers();
1699 // Load all EFI drivers from rEFInd's "drivers" subdirectory and from the
1700 // directories specified by the user in the "scan_driver_dirs" configuration
1702 static VOID
LoadDrivers(VOID
)
1704 CHAR16
*Directory
, *SelfDirectory
;
1705 UINTN i
= 0, Length
, NumFound
= 0;
1707 // load drivers from the subdirectories of rEFInd's home directory specified
1708 // in the DRIVER_DIRS constant.
1709 while ((Directory
= FindCommaDelimited(DRIVER_DIRS
, i
++)) != NULL
) {
1710 SelfDirectory
= SelfDirPath
? StrDuplicate(SelfDirPath
) : NULL
;
1711 CleanUpPathNameSlashes(SelfDirectory
);
1712 MergeStrings(&SelfDirectory
, Directory
, L
'\\');
1713 NumFound
+= ScanDriverDir(SelfDirectory
);
1714 MyFreePool(Directory
);
1715 MyFreePool(SelfDirectory
);
1718 // Scan additional user-specified driver directories....
1720 while ((Directory
= FindCommaDelimited(GlobalConfig
.DriverDirs
, i
++)) != NULL
) {
1721 CleanUpPathNameSlashes(Directory
);
1722 Length
= StrLen(Directory
);
1724 NumFound
+= ScanDriverDir(Directory
);
1726 MyFreePool(Directory
);
1729 // connect all devices
1731 ConnectAllDriversToAllControllers();
1733 } /* static VOID LoadDrivers() */
1735 // Locates boot loaders. NOTE: This assumes that GlobalConfig.LegacyType is set correctly.
1736 static VOID
ScanForBootloaders(VOID
) {
1739 BOOLEAN ScanForLegacy
= FALSE
;
1741 // Determine up-front if we'll be scanning for legacy loaders....
1742 for (i
= 0; i
< NUM_SCAN_OPTIONS
; i
++) {
1743 s
= GlobalConfig
.ScanFor
[i
];
1744 if ((s
== 'c') || (s
== 'C') || (s
== 'h') || (s
== 'H') || (s
== 'b') || (s
== 'B'))
1745 ScanForLegacy
= TRUE
;
1748 // If UEFI & scanning for legacy loaders & deep legacy scan, update NVRAM boot manager list
1749 if ((GlobalConfig
.LegacyType
== LEGACY_TYPE_UEFI
) && ScanForLegacy
&& GlobalConfig
.DeepLegacyScan
) {
1750 BdsDeleteAllInvalidLegacyBootOptions();
1751 BdsAddNonExistingLegacyBootOptions();
1754 // scan for loaders and tools, add them to the menu
1755 for (i
= 0; i
< NUM_SCAN_OPTIONS
; i
++) {
1756 switch(GlobalConfig
.ScanFor
[i
]) {
1761 ScanLegacyInternal();
1764 ScanLegacyExternal();
1767 ScanUserConfigured(GlobalConfig
.ConfigFilename
);
1784 // assign shortcut keys
1785 for (i
= 0; i
< MainMenu
.EntryCount
&& MainMenu
.Entries
[i
]->Row
== 0 && i
< 9; i
++)
1786 MainMenu
.Entries
[i
]->ShortcutDigit
= (CHAR16
)('1' + i
);
1788 // wait for user ACK when there were errors
1789 FinishTextScreen(FALSE
);
1790 } // static VOID ScanForBootloaders()
1792 // Locate a single tool from the specified Locations using one of the
1793 // specified Names and add it to the menu.
1794 static VOID
FindTool(CHAR16
*Locations
, CHAR16
*Names
, CHAR16
*Description
, UINTN Icon
) {
1795 UINTN j
= 0, k
, VolumeIndex
;
1796 CHAR16
*DirName
, *FileName
, *PathName
, FullDescription
[256];
1798 while ((DirName
= FindCommaDelimited(Locations
, j
++)) != NULL
) {
1800 while ((FileName
= FindCommaDelimited(Names
, k
++)) != NULL
) {
1801 PathName
= StrDuplicate(DirName
);
1802 MergeStrings(&PathName
, FileName
, (StriCmp(PathName
, L
"\\") == 0) ? 0 : L
'\\');
1803 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
1804 if ((Volumes
[VolumeIndex
]->RootDir
!= NULL
) && (FileExists(Volumes
[VolumeIndex
]->RootDir
, PathName
)) &&
1805 IsValidLoader(Volumes
[VolumeIndex
]->RootDir
, PathName
)) {
1806 SPrint(FullDescription
, 255, L
"%s at %s on %s", Description
, PathName
, Volumes
[VolumeIndex
]->VolName
);
1807 AddToolEntry(Volumes
[VolumeIndex
]->DeviceHandle
, PathName
, FullDescription
, BuiltinIcon(Icon
), 'S', FALSE
);
1810 MyFreePool(PathName
);
1811 MyFreePool(FileName
);
1813 MyFreePool(DirName
);
1814 } // while Locations
1815 } // VOID FindTool()
1817 // Add the second-row tags containing built-in and external tools (EFI shell,
1819 static VOID
ScanForTools(VOID
) {
1820 CHAR16
*FileName
= NULL
, *VolName
= NULL
, *MokLocations
, Description
[256];
1821 REFIT_MENU_ENTRY
*TempMenuEntry
;
1822 UINTN i
, j
, VolumeIndex
;
1826 MokLocations
= StrDuplicate(MOK_LOCATIONS
);
1827 if (MokLocations
!= NULL
)
1828 MergeStrings(&MokLocations
, SelfDirPath
, L
',');
1830 for (i
= 0; i
< NUM_TOOLS
; i
++) {
1831 switch(GlobalConfig
.ShowTools
[i
]) {
1832 // NOTE: Be sure that FileName is NULL at the end of each case.
1834 TempMenuEntry
= CopyMenuEntry(&MenuEntryShutdown
);
1835 TempMenuEntry
->Image
= BuiltinIcon(BUILTIN_ICON_FUNC_SHUTDOWN
);
1836 AddMenuEntry(&MainMenu
, TempMenuEntry
);
1840 TempMenuEntry
= CopyMenuEntry(&MenuEntryReset
);
1841 TempMenuEntry
->Image
= BuiltinIcon(BUILTIN_ICON_FUNC_RESET
);
1842 AddMenuEntry(&MainMenu
, TempMenuEntry
);
1846 TempMenuEntry
= CopyMenuEntry(&MenuEntryAbout
);
1847 TempMenuEntry
->Image
= BuiltinIcon(BUILTIN_ICON_FUNC_ABOUT
);
1848 AddMenuEntry(&MainMenu
, TempMenuEntry
);
1852 TempMenuEntry
= CopyMenuEntry(&MenuEntryExit
);
1853 TempMenuEntry
->Image
= BuiltinIcon(BUILTIN_ICON_FUNC_EXIT
);
1854 AddMenuEntry(&MainMenu
, TempMenuEntry
);
1858 if (EfivarGetRaw(&GlobalGuid
, L
"OsIndicationsSupported", &b
, &j
) == EFI_SUCCESS
) {
1860 if (osind
& EFI_OS_INDICATIONS_BOOT_TO_FW_UI
) {
1861 TempMenuEntry
= CopyMenuEntry(&MenuEntryFirmware
);
1862 TempMenuEntry
->Image
= BuiltinIcon(BUILTIN_ICON_FUNC_FIRMWARE
);
1863 AddMenuEntry(&MainMenu
, TempMenuEntry
);
1870 while ((FileName
= FindCommaDelimited(SHELL_NAMES
, j
++)) != NULL
) {
1871 if (FileExists(SelfRootDir
, FileName
) && IsValidLoader(SelfRootDir
, FileName
)) {
1872 AddToolEntry(SelfLoadedImage
->DeviceHandle
, FileName
, L
"EFI Shell", BuiltinIcon(BUILTIN_ICON_TOOL_SHELL
),
1875 MyFreePool(FileName
);
1881 while ((FileName
= FindCommaDelimited(GPTSYNC_NAMES
, j
++)) != NULL
) {
1882 if (FileExists(SelfRootDir
, FileName
) && IsValidLoader(SelfRootDir
, FileName
)) {
1883 AddToolEntry(SelfLoadedImage
->DeviceHandle
, FileName
, L
"Hybrid MBR tool", BuiltinIcon(BUILTIN_ICON_TOOL_PART
),
1886 MyFreePool(FileName
);
1893 while ((FileName
= FindCommaDelimited(GDISK_NAMES
, j
++)) != NULL
) {
1894 if (FileExists(SelfRootDir
, FileName
) && IsValidLoader(SelfRootDir
, FileName
)) {
1895 AddToolEntry(SelfLoadedImage
->DeviceHandle
, FileName
, L
"disk partitioning tool",
1896 BuiltinIcon(BUILTIN_ICON_TOOL_PART
), 'G', FALSE
);
1898 MyFreePool(FileName
);
1905 while ((FileName
= FindCommaDelimited(NETBOOT_NAMES
, j
++)) != NULL
) {
1906 if (FileExists(SelfRootDir
, FileName
) && IsValidLoader(SelfRootDir
, FileName
)) {
1907 AddToolEntry(SelfLoadedImage
->DeviceHandle
, FileName
, L
"Netboot",
1908 BuiltinIcon(BUILTIN_ICON_TOOL_NETBOOT
), 'N', FALSE
);
1910 MyFreePool(FileName
);
1915 case TAG_APPLE_RECOVERY
:
1916 FileName
= StrDuplicate(L
"\\com.apple.recovery.boot\\boot.efi");
1917 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
1918 if ((Volumes
[VolumeIndex
]->RootDir
!= NULL
) && (FileExists(Volumes
[VolumeIndex
]->RootDir
, FileName
)) &&
1919 IsValidLoader(Volumes
[VolumeIndex
]->RootDir
, FileName
)) {
1920 SPrint(Description
, 255, L
"Apple Recovery on %s", Volumes
[VolumeIndex
]->VolName
);
1921 AddToolEntry(Volumes
[VolumeIndex
]->DeviceHandle
, FileName
, Description
,
1922 BuiltinIcon(BUILTIN_ICON_TOOL_APPLE_RESCUE
), 'R', TRUE
);
1925 MyFreePool(FileName
);
1929 case TAG_WINDOWS_RECOVERY
:
1931 while ((FileName
= FindCommaDelimited(GlobalConfig
.WindowsRecoveryFiles
, j
++)) != NULL
) {
1932 SplitVolumeAndFilename(&FileName
, &VolName
);
1933 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
1934 if ((Volumes
[VolumeIndex
]->RootDir
!= NULL
) && (FileExists(Volumes
[VolumeIndex
]->RootDir
, FileName
)) &&
1935 IsValidLoader(Volumes
[VolumeIndex
]->RootDir
, FileName
) &&
1936 ((VolName
== NULL
) || (StriCmp(VolName
, Volumes
[VolumeIndex
]->VolName
) == 0))) {
1937 SPrint(Description
, 255, L
"Microsoft Recovery on %s", Volumes
[VolumeIndex
]->VolName
);
1938 AddToolEntry(Volumes
[VolumeIndex
]->DeviceHandle
, FileName
, Description
,
1939 BuiltinIcon(BUILTIN_ICON_TOOL_WINDOWS_RESCUE
), 'R', TRUE
);
1943 MyFreePool(FileName
);
1945 MyFreePool(VolName
);
1950 FindTool(MokLocations
, MOK_NAMES
, L
"MOK utility", BUILTIN_ICON_TOOL_MOK_TOOL
);
1954 FindTool(MEMTEST_LOCATIONS
, MEMTEST_NAMES
, L
"Memory test utility", BUILTIN_ICON_TOOL_MEMTEST
);
1959 } // static VOID ScanForTools
1961 // Rescan for boot loaders
1962 static VOID
RescanAll(BOOLEAN DisplayMessage
) {
1970 egDisplayMessage(L
"Scanning for new boot loaders; please wait....", &BGColor
);
1971 FreeList((VOID
***) &(MainMenu
.Entries
), &MainMenu
.EntryCount
);
1972 MainMenu
.Entries
= NULL
;
1973 MainMenu
.EntryCount
= 0;
1974 ReadConfig(GlobalConfig
.ConfigFilename
);
1975 ConnectAllDriversToAllControllers();
1977 ScanForBootloaders();
1980 } // VOID RescanAll()
1982 #ifdef __MAKEWITH_TIANO
1984 // Minimal initialization function
1985 static VOID
InitializeLib(IN EFI_HANDLE ImageHandle
, IN EFI_SYSTEM_TABLE
*SystemTable
) {
1987 // gImageHandle = ImageHandle;
1988 gBS
= SystemTable
->BootServices
;
1989 // gRS = SystemTable->RuntimeServices;
1990 gRT
= SystemTable
->RuntimeServices
; // Some BDS functions need gRT to be set
1991 EfiGetSystemConfigurationTable (&gEfiDxeServicesTableGuid
, (VOID
**) &gDS
);
1993 // InitializeConsoleSim();
1998 // Set up our own Secure Boot extensions....
1999 // Returns TRUE on success, FALSE otherwise
2000 static BOOLEAN
SecureBootSetup(VOID
) {
2002 BOOLEAN Success
= FALSE
;
2004 if (secure_mode() && ShimLoaded()) {
2005 Status
= security_policy_install();
2006 if (Status
== EFI_SUCCESS
) {
2009 Print(L
"Failed to install MOK Secure Boot extensions");
2013 } // VOID SecureBootSetup()
2015 // Remove our own Secure Boot extensions....
2016 // Returns TRUE on success, FALSE otherwise
2017 static BOOLEAN
SecureBootUninstall(VOID
) {
2019 BOOLEAN Success
= TRUE
;
2021 if (secure_mode()) {
2022 Status
= security_policy_uninstall();
2023 if (Status
!= EFI_SUCCESS
) {
2025 BeginTextScreen(L
"Secure Boot Policy Failure");
2026 Print(L
"Failed to uninstall MOK Secure Boot extensions; forcing a reboot.");
2028 refit_call4_wrapper(RT
->ResetSystem
, EfiResetCold
, EFI_SUCCESS
, 0, NULL
);
2032 } // VOID SecureBootUninstall
2034 // Sets the global configuration filename; will be CONFIG_FILE_NAME unless the
2035 // "-c" command-line option is set, in which case that takes precedence.
2036 // If an error is encountered, leaves the value alone (it should be set to
2037 // CONFIG_FILE_NAME when GlobalConfig is initialized).
2038 static VOID
SetConfigFilename(EFI_HANDLE ImageHandle
) {
2039 EFI_LOADED_IMAGE
*Info
;
2040 CHAR16
*Options
, *FileName
;
2044 Status
= refit_call3_wrapper(BS
->HandleProtocol
, ImageHandle
, &LoadedImageProtocol
, (VOID
**) &Info
);
2045 if ((Status
== EFI_SUCCESS
) && (Info
->LoadOptionsSize
> 0)) {
2046 Options
= (CHAR16
*) Info
->LoadOptions
;
2047 Where
= FindSubString(L
" -c ", Options
);
2049 FileName
= StrDuplicate(&Options
[Where
+ 4]);
2050 Where
= FindSubString(L
" ", FileName
);
2052 FileName
[Where
] = L
'\0';
2054 if (FileExists(SelfDir
, FileName
)) {
2055 GlobalConfig
.ConfigFilename
= FileName
;
2057 Print(L
"Specified configuration file (%s) doesn't exist; using\n'refind.conf' default\n", FileName
);
2058 MyFreePool(FileName
);
2062 } // VOID SetConfigFilename()
2069 efi_main (EFI_HANDLE ImageHandle
, EFI_SYSTEM_TABLE
*SystemTable
)
2072 BOOLEAN MainLoopRunning
= TRUE
;
2073 BOOLEAN MokProtocol
;
2074 REFIT_MENU_ENTRY
*ChosenEntry
;
2076 CHAR16
*SelectionName
= NULL
;
2080 InitializeLib(ImageHandle
, SystemTable
);
2081 Status
= InitRefitLib(ImageHandle
);
2082 if (EFI_ERROR(Status
))
2085 // read configuration
2086 CopyMem(GlobalConfig
.ScanFor
, "ieom ", NUM_SCAN_OPTIONS
);
2087 FindLegacyBootType();
2088 if (GlobalConfig
.LegacyType
== LEGACY_TYPE_MAC
)
2089 CopyMem(GlobalConfig
.ScanFor
, "ihebocm ", NUM_SCAN_OPTIONS
);
2090 SetConfigFilename(ImageHandle
);
2091 ReadConfig(GlobalConfig
.ConfigFilename
);
2094 WarnIfLegacyProblems();
2095 MainMenu
.TimeoutSeconds
= GlobalConfig
.Timeout
;
2097 // disable EFI watchdog timer
2098 refit_call4_wrapper(BS
->SetWatchdogTimer
, 0x0000, 0x0000, 0x0000, NULL
);
2100 // further bootstrap (now with config available)
2101 MokProtocol
= SecureBootSetup();
2104 ScanForBootloaders();
2108 if (GlobalConfig
.ScanDelay
> 0) {
2113 if (GlobalConfig
.ScanDelay
> 1)
2114 egDisplayMessage(L
"Pausing before disk scan; please wait....", &BGColor
);
2115 for (i
= 0; i
< GlobalConfig
.ScanDelay
; i
++)
2116 refit_call1_wrapper(BS
->Stall
, 1000000);
2117 RescanAll(GlobalConfig
.ScanDelay
> 1);
2120 if (GlobalConfig
.DefaultSelection
)
2121 SelectionName
= StrDuplicate(GlobalConfig
.DefaultSelection
);
2123 while (MainLoopRunning
) {
2124 MenuExit
= RunMainMenu(&MainMenu
, &SelectionName
, &ChosenEntry
);
2126 // The Escape key triggers a re-scan operation....
2127 if (MenuExit
== MENU_EXIT_ESCAPE
) {
2133 switch (ChosenEntry
->Tag
) {
2135 case TAG_REBOOT
: // Reboot
2137 refit_call4_wrapper(RT
->ResetSystem
, EfiResetCold
, EFI_SUCCESS
, 0, NULL
);
2138 MainLoopRunning
= FALSE
; // just in case we get this far
2141 case TAG_SHUTDOWN
: // Shut Down
2143 refit_call4_wrapper(RT
->ResetSystem
, EfiResetShutdown
, EFI_SUCCESS
, 0, NULL
);
2144 MainLoopRunning
= FALSE
; // just in case we get this far
2147 case TAG_ABOUT
: // About rEFInd
2151 case TAG_LOADER
: // Boot OS via .EFI loader
2152 StartLoader((LOADER_ENTRY
*)ChosenEntry
, SelectionName
);
2155 case TAG_LEGACY
: // Boot legacy OS
2156 StartLegacy((LEGACY_ENTRY
*)ChosenEntry
, SelectionName
);
2159 case TAG_LEGACY_UEFI
: // Boot a legacy OS on a non-Mac
2160 StartLegacyUEFI((LEGACY_ENTRY
*)ChosenEntry
, SelectionName
);
2163 case TAG_TOOL
: // Start a EFI tool
2164 StartTool((LOADER_ENTRY
*)ChosenEntry
);
2167 case TAG_EXIT
: // Terminate rEFInd
2168 if ((MokProtocol
) && !SecureBootUninstall()) {
2169 MainLoopRunning
= FALSE
; // just in case we get this far
2171 BeginTextScreen(L
" ");
2176 case TAG_FIRMWARE
: // Reboot into firmware's user interface
2177 RebootIntoFirmware();
2183 // If we end up here, things have gone wrong. Try to reboot, and if that
2184 // fails, go into an endless loop.
2185 refit_call4_wrapper(RT
->ResetSystem
, EfiResetCold
, EFI_SUCCESS
, 0, NULL
);