3 * General library functions
5 * Copyright (c) 2006-2009 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-2013 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.
49 #include "../include/refit_call_wrapper.h"
50 #include "../include/RemovableMedia.h"
51 //#include "../include/UsbMass.h"
53 #ifdef __MAKEWITH_GNUEFI
54 #define EfiReallocatePool ReallocatePool
56 #define LibLocateHandle gBS->LocateHandleBuffer
57 #define DevicePathProtocol gEfiDevicePathProtocolGuid
58 #define BlockIoProtocol gEfiBlockIoProtocolGuid
59 #define LibFileSystemInfo EfiLibFileSystemInfo
60 #define LibOpenRoot EfiLibOpenRoot
61 EFI_DEVICE_PATH EndDevicePath
[] = {
62 {END_DEVICE_PATH_TYPE
, END_ENTIRE_DEVICE_PATH_SUBTYPE
, {END_DEVICE_PATH_LENGTH
, 0}}
65 //#define EndDevicePath DevicePath
68 // "Magic" signatures for various filesystems
69 #define FAT_MAGIC 0xAA55
70 #define EXT2_SUPER_MAGIC 0xEF53
71 #define HFSPLUS_MAGIC1 0x2B48
72 #define HFSPLUS_MAGIC2 0x5848
73 #define REISERFS_SUPER_MAGIC_STRING "ReIsErFs"
74 #define REISER2FS_SUPER_MAGIC_STRING "ReIsEr2Fs"
75 #define REISER2FS_JR_SUPER_MAGIC_STRING "ReIsEr3Fs"
76 #define BTRFS_SIGNATURE "_BHRfS_M"
80 EFI_HANDLE SelfImageHandle
;
81 EFI_LOADED_IMAGE
*SelfLoadedImage
;
82 EFI_FILE
*SelfRootDir
;
86 REFIT_VOLUME
*SelfVolume
= NULL
;
87 REFIT_VOLUME
**Volumes
= NULL
;
88 UINTN VolumesCount
= 0;
90 // Maximum size for disk sectors
91 #define SECTOR_SIZE 4096
93 // Number of bytes to read from a partition to determine its filesystem type
94 // and identify its boot loader, and hence probable BIOS-mode OS installation
95 #define SAMPLE_SIZE 69632 /* 68 KiB -- ReiserFS superblock begins at 64 KiB */
100 static EFI_STATUS
FinishInitRefitLib(VOID
);
102 static VOID
UninitVolumes(VOID
);
105 // self recognition stuff
108 // Converts forward slashes to backslashes, removes duplicate slashes, and
109 // removes slashes from both the start and end of the pathname.
110 // Necessary because some (buggy?) EFI implementations produce "\/" strings
111 // in pathnames, because some user inputs can produce duplicate directory
112 // separators, and because we want consistent start and end slashes for
113 // directory comparisons. A special case: If the PathName refers to root,
114 // return "/", since some firmware implementations flake out if this
116 VOID
CleanUpPathNameSlashes(IN OUT CHAR16
*PathName
) {
118 UINTN i
, Length
, FinalChar
= 0;
119 BOOLEAN LastWasSlash
= FALSE
;
121 Length
= StrLen(PathName
);
122 NewName
= AllocateZeroPool(sizeof(CHAR16
) * (Length
+ 2));
123 if (NewName
!= NULL
) {
124 for (i
= 0; i
< StrLen(PathName
); i
++) {
125 if ((PathName
[i
] == L
'/') || (PathName
[i
] == L
'\\')) {
126 if ((!LastWasSlash
) && (FinalChar
!= 0))
127 NewName
[FinalChar
++] = L
'\\';
130 NewName
[FinalChar
++] = PathName
[i
];
131 LastWasSlash
= FALSE
;
134 NewName
[FinalChar
] = 0;
135 if ((FinalChar
> 0) && (NewName
[FinalChar
- 1] == L
'\\'))
136 NewName
[--FinalChar
] = 0;
137 if (FinalChar
== 0) {
141 // Copy the transformed name back....
142 StrCpy(PathName
, NewName
);
144 } // if allocation OK
145 } // CleanUpPathNameSlashes()
147 // Splits an EFI device path into device and filename components. For instance, if InString is
148 // PciRoot(0x0)/Pci(0x1f,0x2)/Ata(Secondary,Master,0x0)/HD(2,GPT,8314ae90-ada3-48e9-9c3b-09a88f80d921,0x96028,0xfa000)/\bzImage-3.5.1.efi,
149 // this function will truncate that input to
150 // PciRoot(0x0)/Pci(0x1f,0x2)/Ata(Secondary,Master,0x0)/HD(2,GPT,8314ae90-ada3-48e9-9c3b-09a88f80d921,0x96028,0xfa000)
151 // and return bzImage-3.5.1.efi as its return value.
152 // It does this by searching for the last ")" character in InString, copying everything
153 // after that string (after some cleanup) as the return value, and truncating the original
155 // If InString contains no ")" character, this function leaves the original input string
156 // unmodified and also returns that string. If InString is NULL, this function returns NULL.
157 static CHAR16
* SplitDeviceString(IN OUT CHAR16
*InString
) {
159 CHAR16
*FileName
= NULL
;
160 BOOLEAN Found
= FALSE
;
162 if (InString
!= NULL
) {
163 i
= StrLen(InString
) - 1;
164 while ((i
>= 0) && (!Found
)) {
165 if (InString
[i
] == L
')') {
167 FileName
= StrDuplicate(&InString
[i
+ 1]);
168 CleanUpPathNameSlashes(FileName
);
169 InString
[i
+ 1] = '\0';
173 if (FileName
== NULL
)
174 FileName
= StrDuplicate(InString
);
177 } // static CHAR16* SplitDeviceString()
179 EFI_STATUS
InitRefitLib(IN EFI_HANDLE ImageHandle
)
182 CHAR16
*DevicePathAsString
, *Temp
;
184 SelfImageHandle
= ImageHandle
;
185 Status
= refit_call3_wrapper(BS
->HandleProtocol
, SelfImageHandle
, &LoadedImageProtocol
, (VOID
**) &SelfLoadedImage
);
186 if (CheckFatalError(Status
, L
"while getting a LoadedImageProtocol handle"))
187 return EFI_LOAD_ERROR
;
189 // find the current directory
190 DevicePathAsString
= DevicePathToStr(SelfLoadedImage
->FilePath
);
191 CleanUpPathNameSlashes(DevicePathAsString
);
192 MyFreePool(SelfDirPath
);
193 Temp
= FindPath(DevicePathAsString
);
194 SelfDirPath
= SplitDeviceString(Temp
);
195 MyFreePool(DevicePathAsString
);
198 return FinishInitRefitLib();
201 // called before running external programs to close open file handles
202 VOID
UninitRefitLib(VOID
)
204 // This piece of code was made to correspond to weirdness in ReinitRefitLib().
205 // See the comment on it there.
206 if(SelfRootDir
== SelfVolume
->RootDir
)
211 if (SelfDir
!= NULL
) {
212 refit_call1_wrapper(SelfDir
->Close
, SelfDir
);
216 if (SelfRootDir
!= NULL
) {
217 refit_call1_wrapper(SelfRootDir
->Close
, SelfRootDir
);
222 // called after running external programs to re-open file handles
223 EFI_STATUS
ReinitRefitLib(VOID
)
227 if ((ST
->Hdr
.Revision
>> 16) == 1) {
228 // Below two lines were in rEFIt, but seem to cause system crashes or
229 // reboots when launching OSes after returning from programs on most
230 // systems. OTOH, my Mac Mini produces errors about "(re)opening our
231 // installation volume" (see the next function) when returning from
232 // programs when these two lines are removed, and it often crashes
233 // when returning from a program or when launching a second program
234 // with these lines removed. Therefore, the preceding if() statement
235 // executes these lines only on EFIs with a major version number of 1
236 // (which Macs have) and not with 2 (which UEFI PCs have). My selection
237 // of hardware on which to test is limited, though, so this may be the
238 // wrong test, or there may be a better way to fix this problem.
239 // TODO: Figure out cause of above weirdness and fix it more
241 if (SelfVolume
!= NULL
&& SelfVolume
->RootDir
!= NULL
)
242 SelfRootDir
= SelfVolume
->RootDir
;
245 return FinishInitRefitLib();
248 static EFI_STATUS
FinishInitRefitLib(VOID
)
252 if (SelfRootDir
== NULL
) {
253 SelfRootDir
= LibOpenRoot(SelfLoadedImage
->DeviceHandle
);
254 if (SelfRootDir
== NULL
) {
255 CheckError(EFI_LOAD_ERROR
, L
"while (re)opening our installation volume");
256 return EFI_LOAD_ERROR
;
260 Status
= refit_call5_wrapper(SelfRootDir
->Open
, SelfRootDir
, &SelfDir
, SelfDirPath
, EFI_FILE_MODE_READ
, 0);
261 if (CheckFatalError(Status
, L
"while opening our installation directory"))
262 return EFI_LOAD_ERROR
;
271 VOID
CreateList(OUT VOID
***ListPtr
, OUT UINTN
*ElementCount
, IN UINTN InitialElementCount
)
275 *ElementCount
= InitialElementCount
;
276 if (*ElementCount
> 0) {
277 AllocateCount
= (*ElementCount
+ 7) & ~7; // next multiple of 8
278 *ListPtr
= AllocatePool(sizeof(VOID
*) * AllocateCount
);
284 VOID
AddListElement(IN OUT VOID
***ListPtr
, IN OUT UINTN
*ElementCount
, IN VOID
*NewElement
)
288 if ((*ElementCount
& 7) == 0) {
289 AllocateCount
= *ElementCount
+ 8;
290 if (*ElementCount
== 0)
291 *ListPtr
= AllocatePool(sizeof(VOID
*) * AllocateCount
);
293 *ListPtr
= EfiReallocatePool(*ListPtr
, sizeof(VOID
*) * (*ElementCount
), sizeof(VOID
*) * AllocateCount
);
295 (*ListPtr
)[*ElementCount
] = NewElement
;
297 } /* VOID AddListElement() */
299 VOID
FreeList(IN OUT VOID
***ListPtr
, IN OUT UINTN
*ElementCount
)
303 if ((*ElementCount
> 0) && (**ListPtr
!= NULL
)) {
304 for (i
= 0; i
< *ElementCount
; i
++) {
305 // TODO: call a user-provided routine for each element here
306 MyFreePool((*ListPtr
)[i
]);
308 MyFreePool(*ListPtr
);
313 // firmware device path discovery
316 static UINT8 LegacyLoaderMediaPathData
[] = {
317 0x04, 0x06, 0x14, 0x00, 0xEB, 0x85, 0x05, 0x2B,
318 0xB8, 0xD8, 0xA9, 0x49, 0x8B, 0x8C, 0xE2, 0x1B,
319 0x01, 0xAE, 0xF2, 0xB7, 0x7F, 0xFF, 0x04, 0x00,
321 static EFI_DEVICE_PATH
*LegacyLoaderMediaPath
= (EFI_DEVICE_PATH
*)LegacyLoaderMediaPathData
;
323 VOID
ExtractLegacyLoaderPaths(EFI_DEVICE_PATH
**PathList
, UINTN MaxPaths
, EFI_DEVICE_PATH
**HardcodedPathList
)
326 UINTN HandleCount
= 0;
327 UINTN HandleIndex
, HardcodedIndex
;
332 EFI_LOADED_IMAGE
*LoadedImage
;
333 EFI_DEVICE_PATH
*DevicePath
;
336 MaxPaths
--; // leave space for the terminating NULL pointer
338 // get all LoadedImage handles
339 Status
= LibLocateHandle(ByProtocol
, &LoadedImageProtocol
, NULL
, &HandleCount
, &Handles
);
340 if (CheckError(Status
, L
"while listing LoadedImage handles")) {
341 if (HardcodedPathList
) {
342 for (HardcodedIndex
= 0; HardcodedPathList
[HardcodedIndex
] && PathCount
< MaxPaths
; HardcodedIndex
++)
343 PathList
[PathCount
++] = HardcodedPathList
[HardcodedIndex
];
345 PathList
[PathCount
] = NULL
;
348 for (HandleIndex
= 0; HandleIndex
< HandleCount
&& PathCount
< MaxPaths
; HandleIndex
++) {
349 Handle
= Handles
[HandleIndex
];
351 Status
= refit_call3_wrapper(BS
->HandleProtocol
, Handle
, &LoadedImageProtocol
, (VOID
**) &LoadedImage
);
352 if (EFI_ERROR(Status
))
353 continue; // This can only happen if the firmware scewed up, ignore it.
355 Status
= refit_call3_wrapper(BS
->HandleProtocol
, LoadedImage
->DeviceHandle
, &DevicePathProtocol
, (VOID
**) &DevicePath
);
356 if (EFI_ERROR(Status
))
357 continue; // This happens, ignore it.
359 // Only grab memory range nodes
360 if (DevicePathType(DevicePath
) != HARDWARE_DEVICE_PATH
|| DevicePathSubType(DevicePath
) != HW_MEMMAP_DP
)
363 // Check if we have this device path in the list already
364 // WARNING: This assumes the first node in the device path is unique!
366 for (PathIndex
= 0; PathIndex
< PathCount
; PathIndex
++) {
367 if (DevicePathNodeLength(DevicePath
) != DevicePathNodeLength(PathList
[PathIndex
]))
369 if (CompareMem(DevicePath
, PathList
[PathIndex
], DevicePathNodeLength(DevicePath
)) == 0) {
377 PathList
[PathCount
++] = AppendDevicePath(DevicePath
, LegacyLoaderMediaPath
);
381 if (HardcodedPathList
) {
382 for (HardcodedIndex
= 0; HardcodedPathList
[HardcodedIndex
] && PathCount
< MaxPaths
; HardcodedIndex
++)
383 PathList
[PathCount
++] = HardcodedPathList
[HardcodedIndex
];
385 PathList
[PathCount
] = NULL
;
392 // Return a pointer to a string containing a filesystem type name. If the
393 // filesystem type is unknown, a blank (but non-null) string is returned.
394 // The returned variable is a constant that should NOT be freed.
395 static CHAR16
*FSTypeName(IN UINT32 TypeCode
) {
396 CHAR16
*retval
= NULL
;
402 case FS_TYPE_HFSPLUS
:
414 case FS_TYPE_REISERFS
:
415 retval
= L
" ReiserFS";
420 case FS_TYPE_ISO9660
:
421 retval
= L
" ISO-9660";
428 } // CHAR16 *FSTypeName()
430 // Identify the filesystem type and record the filesystem's UUID/serial number,
431 // if possible. Expects a Buffer containing the first few (normally 4096) bytes
432 // of the filesystem. Sets the filesystem type code in Volume->FSType and the
433 // UUID/serial number in Volume->VolUuid. Note that the UUID value is recognized
434 // differently for each filesystem, and is currently supported only for
435 // ext2/3/4fs and ReiserFS. If the UUID can't be determined, it's set to 0. Also, the UUID
436 // is just read directly into memory; it is *NOT* valid when displayed by
437 // GuidAsString() or used in other GUID/UUID-manipulating functions. (As I
438 // write, it's being used merely to detect partitions that are part of a
440 static VOID
SetFilesystemData(IN UINT8
*Buffer
, IN UINTN BufferSize
, IN OUT REFIT_VOLUME
*Volume
) {
441 UINT32
*Ext2Incompat
, *Ext2Compat
;
445 if ((Buffer
!= NULL
) && (Volume
!= NULL
)) {
446 SetMem(&(Volume
->VolUuid
), sizeof(EFI_GUID
), 0);
447 Volume
->FSType
= FS_TYPE_UNKNOWN
;
449 if (BufferSize
>= 512) {
450 Magic16
= (UINT16
*) (Buffer
+ 510);
451 if (*Magic16
== FAT_MAGIC
) {
452 Volume
->FSType
= FS_TYPE_FAT
;
455 } // search for FAT magic
457 if (BufferSize
>= (1024 + 100)) {
458 Magic16
= (UINT16
*) (Buffer
+ 1024 + 56);
459 if (*Magic16
== EXT2_SUPER_MAGIC
) { // ext2/3/4
460 Ext2Compat
= (UINT32
*) (Buffer
+ 1024 + 92);
461 Ext2Incompat
= (UINT32
*) (Buffer
+ 1024 + 96);
462 if ((*Ext2Incompat
& 0x0040) || (*Ext2Incompat
& 0x0200)) { // check for extents or flex_bg
463 Volume
->FSType
= FS_TYPE_EXT4
;
464 } else if (*Ext2Compat
& 0x0004) { // check for journal
465 Volume
->FSType
= FS_TYPE_EXT3
;
466 } else { // none of these features; presume it's ext2...
467 Volume
->FSType
= FS_TYPE_EXT2
;
469 CopyMem(&(Volume
->VolUuid
), Buffer
+ 1024 + 104, sizeof(EFI_GUID
));
472 } // search for ext2/3/4 magic
474 if (BufferSize
>= (65536 + 62)) {
475 MagicString
= (char*) (Buffer
+ 65536 + 52);
476 if ((CompareMem(MagicString
, REISERFS_SUPER_MAGIC_STRING
, 8) == 0) ||
477 (CompareMem(MagicString
, REISER2FS_SUPER_MAGIC_STRING
, 9) == 0) ||
478 (CompareMem(MagicString
, REISER2FS_JR_SUPER_MAGIC_STRING
, 9) == 0)) {
479 Volume
->FSType
= FS_TYPE_REISERFS
;
480 CopyMem(&(Volume
->VolUuid
), Buffer
+ 65536 + 84, sizeof(EFI_GUID
));
481 Print(L
"Found ReiserFS UUID: %s\n", GuidAsString(&(Volume
->VolUuid
)));
485 } // search for ReiserFS magic
487 if (BufferSize
>= (65536 + 64 + 8)) {
488 MagicString
= (char*) (Buffer
+ 65536 + 64);
489 if (CompareMem(MagicString
, BTRFS_SIGNATURE
, 8) == 0) {
490 Volume
->FSType
= FS_TYPE_BTRFS
;
493 } // search for Btrfs magic
495 if (BufferSize
>= (1024 + 2)) {
496 Magic16
= (UINT16
*) (Buffer
+ 1024);
497 if ((*Magic16
== HFSPLUS_MAGIC1
) || (*Magic16
== HFSPLUS_MAGIC2
)) {
498 Volume
->FSType
= FS_TYPE_HFSPLUS
;
501 } // search for HFS+ magic
502 } // if (Buffer != NULL)
504 } // UINT32 SetFilesystemData()
506 static VOID
ScanVolumeBootcode(REFIT_VOLUME
*Volume
, BOOLEAN
*Bootable
)
509 UINT8 Buffer
[SAMPLE_SIZE
];
511 MBR_PARTITION_INFO
*MbrTable
;
512 BOOLEAN MbrTableFound
;
514 Volume
->HasBootCode
= FALSE
;
515 Volume
->OSIconName
= NULL
;
516 Volume
->OSName
= NULL
;
519 if (Volume
->BlockIO
== NULL
)
521 if (Volume
->BlockIO
->Media
->BlockSize
> SAMPLE_SIZE
)
522 return; // our buffer is too small...
524 // look at the boot sector (this is used for both hard disks and El Torito images!)
525 Status
= refit_call5_wrapper(Volume
->BlockIO
->ReadBlocks
,
526 Volume
->BlockIO
, Volume
->BlockIO
->Media
->MediaId
,
527 Volume
->BlockIOOffset
, SAMPLE_SIZE
, Buffer
);
528 if (!EFI_ERROR(Status
)) {
530 SetFilesystemData(Buffer
, SAMPLE_SIZE
, Volume
);
531 if ((*((UINT16
*)(Buffer
+ 510)) == 0xaa55 && Buffer
[0] != 0) && (FindMem(Buffer
, 512, "EXFAT", 5) == -1)) {
533 Volume
->HasBootCode
= TRUE
;
536 // detect specific boot codes
537 if (CompareMem(Buffer
+ 2, "LILO", 4) == 0 ||
538 CompareMem(Buffer
+ 6, "LILO", 4) == 0 ||
539 CompareMem(Buffer
+ 3, "SYSLINUX", 8) == 0 ||
540 FindMem(Buffer
, SECTOR_SIZE
, "ISOLINUX", 8) >= 0) {
541 Volume
->HasBootCode
= TRUE
;
542 Volume
->OSIconName
= L
"linux";
543 Volume
->OSName
= L
"Linux";
545 } else if (FindMem(Buffer
, 512, "Geom\0Hard Disk\0Read\0 Error", 26) >= 0) { // GRUB
546 Volume
->HasBootCode
= TRUE
;
547 Volume
->OSIconName
= L
"grub,linux";
548 Volume
->OSName
= L
"Linux";
550 // // Below doesn't produce a bootable entry, so commented out for the moment....
551 // // GRUB in BIOS boot partition:
552 // } else if (FindMem(Buffer, 512, "Geom\0Read\0 Error", 16) >= 0) {
553 // Volume->HasBootCode = TRUE;
554 // Volume->OSIconName = L"grub,linux";
555 // Volume->OSName = L"Linux";
556 // Volume->VolName = L"BIOS Boot Partition";
559 } else if ((*((UINT32
*)(Buffer
+ 502)) == 0 &&
560 *((UINT32
*)(Buffer
+ 506)) == 50000 &&
561 *((UINT16
*)(Buffer
+ 510)) == 0xaa55) ||
562 FindMem(Buffer
, SECTOR_SIZE
, "Starting the BTX loader", 23) >= 0) {
563 Volume
->HasBootCode
= TRUE
;
564 Volume
->OSIconName
= L
"freebsd";
565 Volume
->OSName
= L
"FreeBSD";
567 } else if (FindMem(Buffer
, 512, "!Loading", 8) >= 0 ||
568 FindMem(Buffer
, SECTOR_SIZE
, "/cdboot\0/CDBOOT\0", 16) >= 0) {
569 Volume
->HasBootCode
= TRUE
;
570 Volume
->OSIconName
= L
"openbsd";
571 Volume
->OSName
= L
"OpenBSD";
573 } else if (FindMem(Buffer
, 512, "Not a bootxx image", 18) >= 0 ||
574 *((UINT32
*)(Buffer
+ 1028)) == 0x7886b6d1) {
575 Volume
->HasBootCode
= TRUE
;
576 Volume
->OSIconName
= L
"netbsd";
577 Volume
->OSName
= L
"NetBSD";
579 } else if (FindMem(Buffer
, SECTOR_SIZE
, "NTLDR", 5) >= 0) {
580 Volume
->HasBootCode
= TRUE
;
581 Volume
->OSIconName
= L
"win";
582 Volume
->OSName
= L
"Windows";
584 } else if (FindMem(Buffer
, SECTOR_SIZE
, "BOOTMGR", 7) >= 0) {
585 Volume
->HasBootCode
= TRUE
;
586 Volume
->OSIconName
= L
"winvista,win";
587 Volume
->OSName
= L
"Windows";
589 } else if (FindMem(Buffer
, 512, "CPUBOOT SYS", 11) >= 0 ||
590 FindMem(Buffer
, 512, "KERNEL SYS", 11) >= 0) {
591 Volume
->HasBootCode
= TRUE
;
592 Volume
->OSIconName
= L
"freedos";
593 Volume
->OSName
= L
"FreeDOS";
595 } else if (FindMem(Buffer
, 512, "OS2LDR", 6) >= 0 ||
596 FindMem(Buffer
, 512, "OS2BOOT", 7) >= 0) {
597 Volume
->HasBootCode
= TRUE
;
598 Volume
->OSIconName
= L
"ecomstation";
599 Volume
->OSName
= L
"eComStation";
601 } else if (FindMem(Buffer
, 512, "Be Boot Loader", 14) >= 0) {
602 Volume
->HasBootCode
= TRUE
;
603 Volume
->OSIconName
= L
"beos";
604 Volume
->OSName
= L
"BeOS";
606 } else if (FindMem(Buffer
, 512, "yT Boot Loader", 14) >= 0) {
607 Volume
->HasBootCode
= TRUE
;
608 Volume
->OSIconName
= L
"zeta,beos";
609 Volume
->OSName
= L
"ZETA";
611 } else if (FindMem(Buffer
, 512, "\x04" "beos\x06" "system\x05" "zbeos", 18) >= 0 ||
612 FindMem(Buffer
, 512, "\x06" "system\x0c" "haiku_loader", 20) >= 0) {
613 Volume
->HasBootCode
= TRUE
;
614 Volume
->OSIconName
= L
"haiku,beos";
615 Volume
->OSName
= L
"Haiku";
619 // NOTE: If you add an operating system with a name that starts with 'W' or 'L', you
620 // need to fix AddLegacyEntry in main.c.
623 Print(L
" Result of bootcode detection: %s %s (%s)\n",
624 Volume
->HasBootCode
? L
"bootable" : L
"non-bootable",
625 Volume
->OSName
, Volume
->OSIconName
);
628 // dummy FAT boot sector (created by OS X's newfs_msdos)
629 if (FindMem(Buffer
, 512, "Non-system disk", 15) >= 0)
630 Volume
->HasBootCode
= FALSE
;
632 // dummy FAT boot sector (created by Linux's mkdosfs)
633 if (FindMem(Buffer
, 512, "This is not a bootable disk", 27) >= 0)
634 Volume
->HasBootCode
= FALSE
;
636 // dummy FAT boot sector (created by Windows)
637 if (FindMem(Buffer
, 512, "Press any key to restart", 24) >= 0)
638 Volume
->HasBootCode
= FALSE
;
640 // check for MBR partition table
641 if (*((UINT16
*)(Buffer
+ 510)) == 0xaa55) {
642 MbrTableFound
= FALSE
;
643 MbrTable
= (MBR_PARTITION_INFO
*)(Buffer
+ 446);
644 for (i
= 0; i
< 4; i
++)
645 if (MbrTable
[i
].StartLBA
&& MbrTable
[i
].Size
)
646 MbrTableFound
= TRUE
;
647 for (i
= 0; i
< 4; i
++)
648 if (MbrTable
[i
].Flags
!= 0x00 && MbrTable
[i
].Flags
!= 0x80)
649 MbrTableFound
= FALSE
;
651 Volume
->MbrPartitionTable
= AllocatePool(4 * 16);
652 CopyMem(Volume
->MbrPartitionTable
, MbrTable
, 4 * 16);
658 CheckError(Status
, L
"while reading boot sector");
661 } /* VOID ScanVolumeBootcode() */
663 // Set default volume badge icon based on /.VolumeBadge.{icns|png} file or disk kind
664 VOID
SetVolumeBadgeIcon(REFIT_VOLUME
*Volume
)
666 if (Volume
->VolBadgeImage
== NULL
) {
667 Volume
->VolBadgeImage
= egLoadIconAnyType(Volume
->RootDir
, L
"", L
".VolumeBadge", 128);
670 if (Volume
->VolBadgeImage
== NULL
) {
671 switch (Volume
->DiskKind
) {
672 case DISK_KIND_INTERNAL
:
673 Volume
->VolBadgeImage
= BuiltinIcon(BUILTIN_ICON_VOL_INTERNAL
);
675 case DISK_KIND_EXTERNAL
:
676 Volume
->VolBadgeImage
= BuiltinIcon(BUILTIN_ICON_VOL_EXTERNAL
);
678 case DISK_KIND_OPTICAL
:
679 Volume
->VolBadgeImage
= BuiltinIcon(BUILTIN_ICON_VOL_OPTICAL
);
683 } // VOID SetVolumeBadgeIcon()
685 // Return a string representing the input size in IEEE-1541 units.
686 // The calling function is responsible for freeing the allocated memory.
687 static CHAR16
*SizeInIEEEUnits(UINT64 SizeInBytes
) {
689 UINTN Index
= 0, NumPrefixes
;
690 CHAR16
*Units
, *Prefixes
= L
" KMGTPEZ";
693 TheValue
= AllocateZeroPool(sizeof(CHAR16
) * 256);
694 if (TheValue
!= NULL
) {
695 NumPrefixes
= StrLen(Prefixes
);
696 SizeInIeee
= SizeInBytes
;
697 while ((SizeInIeee
> 1024) && (Index
< (NumPrefixes
- 1))) {
701 if (Prefixes
[Index
] == ' ') {
702 Units
= StrDuplicate(L
"-byte");
704 Units
= StrDuplicate(L
" iB");
705 Units
[1] = Prefixes
[Index
];
707 SPrint(TheValue
, 255, L
"%ld%s", SizeInIeee
, Units
);
710 } // CHAR16 *SizeInSIUnits()
712 // Return a name for the volume. Ideally this should be the label for the
713 // filesystem it contains, but this function falls back to describing the
714 // filesystem by size (200 MiB, etc.) and/or type (ext2, HFS+, etc.), if
715 // this information can be extracted.
716 // The calling function is responsible for freeing the memory allocated
717 // for the name string.
718 static CHAR16
*GetVolumeName(IN REFIT_VOLUME
*Volume
) {
719 EFI_FILE_SYSTEM_INFO
*FileSystemInfoPtr
;
720 CHAR16
*FoundName
= NULL
;
721 CHAR16
*SISize
, *TypeName
;
723 FileSystemInfoPtr
= LibFileSystemInfo(Volume
->RootDir
);
724 if (FileSystemInfoPtr
!= NULL
) { // we have filesystem information (size, label)....
725 if ((FileSystemInfoPtr
->VolumeLabel
!= NULL
) && (StrLen(FileSystemInfoPtr
->VolumeLabel
) > 0)) {
726 FoundName
= StrDuplicate(FileSystemInfoPtr
->VolumeLabel
);
729 // Special case: rEFInd HFS+ driver always returns label of "HFS+ volume", so wipe
730 // this so that we can build a new name that includes the size....
731 if ((FoundName
!= NULL
) && (StrCmp(FoundName
, L
"HFS+ volume") == 0) && (Volume
->FSType
== FS_TYPE_HFSPLUS
)) {
732 MyFreePool(FoundName
);
734 } // if rEFInd HFS+ driver suspected
736 if (FoundName
== NULL
) { // filesystem has no name, so use fs type and size
737 FoundName
= AllocateZeroPool(sizeof(CHAR16
) * 256);
738 if (FoundName
!= NULL
) {
739 SISize
= SizeInIEEEUnits(FileSystemInfoPtr
->VolumeSize
);
740 SPrint(FoundName
, 255, L
"%s%s volume", SISize
, FSTypeName(Volume
->FSType
));
742 } // if allocated memory OK
743 } // if (FoundName == NULL)
745 FreePool(FileSystemInfoPtr
);
747 } else { // fs driver not returning info; fall back on our own information....
748 FoundName
= AllocateZeroPool(sizeof(CHAR16
) * 256);
749 if (FoundName
!= NULL
) {
750 TypeName
= FSTypeName(Volume
->FSType
); // NOTE: Don't free TypeName; function returns constant
751 if (StrLen(TypeName
) > 0)
752 SPrint(FoundName
, 255, L
"%s volume", FSTypeName(Volume
->FSType
));
754 SPrint(FoundName
, 255, L
"unknown volume");
755 } // if allocated memory OK
758 // TODO: Above could be improved/extended, in case filesystem name is not found,
760 // - use partition label
761 // - use or add disk/partition number (e.g., "(hd0,2)")
763 // Desperate fallback name....
764 if (FoundName
== NULL
) {
765 FoundName
= StrDuplicate(L
"unknown volume");
768 } // static CHAR16 *GetVolumeName()
770 VOID
ScanVolume(REFIT_VOLUME
*Volume
)
773 EFI_DEVICE_PATH
*DevicePath
, *NextDevicePath
;
774 EFI_DEVICE_PATH
*DiskDevicePath
, *RemainingDevicePath
;
775 EFI_HANDLE WholeDiskHandle
;
780 Volume
->DevicePath
= DuplicateDevicePath(DevicePathFromHandle(Volume
->DeviceHandle
));
782 if (Volume
->DevicePath
!= NULL
) {
783 Print(L
"* %s\n", DevicePathToStr(Volume
->DevicePath
));
785 DumpHex(1, 0, DevicePathSize(Volume
->DevicePath
), Volume
->DevicePath
);
790 Volume
->DiskKind
= DISK_KIND_INTERNAL
; // default
793 Status
= refit_call3_wrapper(BS
->HandleProtocol
, Volume
->DeviceHandle
, &BlockIoProtocol
, (VOID
**) &(Volume
->BlockIO
));
794 if (EFI_ERROR(Status
)) {
795 Volume
->BlockIO
= NULL
;
796 Print(L
"Warning: Can't get BlockIO protocol.\n");
798 if (Volume
->BlockIO
->Media
->BlockSize
== 2048)
799 Volume
->DiskKind
= DISK_KIND_OPTICAL
;
802 // scan for bootcode and MBR table
804 ScanVolumeBootcode(Volume
, &Bootable
);
806 // detect device type
807 DevicePath
= Volume
->DevicePath
;
808 while (DevicePath
!= NULL
&& !IsDevicePathEndType(DevicePath
)) {
809 NextDevicePath
= NextDevicePathNode(DevicePath
);
811 if (DevicePathType(DevicePath
) == MESSAGING_DEVICE_PATH
&&
812 (DevicePathSubType(DevicePath
) == MSG_USB_DP
||
813 DevicePathSubType(DevicePath
) == MSG_USB_CLASS_DP
||
814 DevicePathSubType(DevicePath
) == MSG_1394_DP
||
815 DevicePathSubType(DevicePath
) == MSG_FIBRECHANNEL_DP
))
816 Volume
->DiskKind
= DISK_KIND_EXTERNAL
; // USB/FireWire/FC device -> external
817 if (DevicePathType(DevicePath
) == MEDIA_DEVICE_PATH
&&
818 DevicePathSubType(DevicePath
) == MEDIA_CDROM_DP
) {
819 Volume
->DiskKind
= DISK_KIND_OPTICAL
; // El Torito entry -> optical disk
823 if (DevicePathType(DevicePath
) == MEDIA_DEVICE_PATH
&& DevicePathSubType(DevicePath
) == MEDIA_VENDOR_DP
) {
824 Volume
->IsAppleLegacy
= TRUE
; // legacy BIOS device entry
825 // TODO: also check for Boot Camp GUID
826 Bootable
= FALSE
; // this handle's BlockIO is just an alias for the whole device
829 if (DevicePathType(DevicePath
) == MESSAGING_DEVICE_PATH
) {
830 // make a device path for the whole device
831 PartialLength
= (UINT8
*)NextDevicePath
- (UINT8
*)(Volume
->DevicePath
);
832 DiskDevicePath
= (EFI_DEVICE_PATH
*)AllocatePool(PartialLength
+ sizeof(EFI_DEVICE_PATH
));
833 CopyMem(DiskDevicePath
, Volume
->DevicePath
, PartialLength
);
834 CopyMem((UINT8
*)DiskDevicePath
+ PartialLength
, EndDevicePath
, sizeof(EFI_DEVICE_PATH
));
836 // get the handle for that path
837 RemainingDevicePath
= DiskDevicePath
;
838 Status
= refit_call3_wrapper(BS
->LocateDevicePath
, &BlockIoProtocol
, &RemainingDevicePath
, &WholeDiskHandle
);
839 FreePool(DiskDevicePath
);
841 if (!EFI_ERROR(Status
)) {
842 //Print(L" - original handle: %08x - disk handle: %08x\n", (UINT32)DeviceHandle, (UINT32)WholeDiskHandle);
844 // get the device path for later
845 Status
= refit_call3_wrapper(BS
->HandleProtocol
, WholeDiskHandle
, &DevicePathProtocol
, (VOID
**) &DiskDevicePath
);
846 if (!EFI_ERROR(Status
)) {
847 Volume
->WholeDiskDevicePath
= DuplicateDevicePath(DiskDevicePath
);
850 // look at the BlockIO protocol
851 Status
= refit_call3_wrapper(BS
->HandleProtocol
, WholeDiskHandle
, &BlockIoProtocol
, (VOID
**) &Volume
->WholeDiskBlockIO
);
852 if (!EFI_ERROR(Status
)) {
854 // check the media block size
855 if (Volume
->WholeDiskBlockIO
->Media
->BlockSize
== 2048)
856 Volume
->DiskKind
= DISK_KIND_OPTICAL
;
859 Volume
->WholeDiskBlockIO
= NULL
;
860 //CheckError(Status, L"from HandleProtocol");
863 // CheckError(Status, L"from LocateDevicePath");
866 DevicePath
= NextDevicePath
;
871 if (Volume
->HasBootCode
)
872 Print(L
" Volume considered non-bootable, but boot code is present\n");
874 Volume
->HasBootCode
= FALSE
;
877 // open the root directory of the volume
878 Volume
->RootDir
= LibOpenRoot(Volume
->DeviceHandle
);
880 // Set volume icon based on .VolumeBadge icon or disk kind
881 SetVolumeBadgeIcon(Volume
);
883 if (Volume
->RootDir
== NULL
) {
884 Volume
->IsReadable
= FALSE
;
887 Volume
->IsReadable
= TRUE
;
890 Volume
->VolName
= GetVolumeName(Volume
);
892 // get custom volume icons if present
893 if (!Volume
->VolIconImage
)
894 Volume
->VolIconImage
= egLoadIconAnyType(Volume
->RootDir
, L
"", L
".VolumeIcon", 128);
897 static VOID
ScanExtendedPartition(REFIT_VOLUME
*WholeDiskVolume
, MBR_PARTITION_INFO
*MbrEntry
)
900 REFIT_VOLUME
*Volume
;
901 UINT32 ExtBase
, ExtCurrent
, NextExtCurrent
;
903 UINTN LogicalPartitionIndex
= 4;
904 UINT8 SectorBuffer
[512];
906 MBR_PARTITION_INFO
*EMbrTable
;
908 ExtBase
= MbrEntry
->StartLBA
;
910 for (ExtCurrent
= ExtBase
; ExtCurrent
; ExtCurrent
= NextExtCurrent
) {
912 Status
= refit_call5_wrapper(WholeDiskVolume
->BlockIO
->ReadBlocks
,
913 WholeDiskVolume
->BlockIO
,
914 WholeDiskVolume
->BlockIO
->Media
->MediaId
,
915 ExtCurrent
, 512, SectorBuffer
);
916 if (EFI_ERROR(Status
))
918 if (*((UINT16
*)(SectorBuffer
+ 510)) != 0xaa55)
920 EMbrTable
= (MBR_PARTITION_INFO
*)(SectorBuffer
+ 446);
922 // scan logical partitions in this EMBR
924 for (i
= 0; i
< 4; i
++) {
925 if ((EMbrTable
[i
].Flags
!= 0x00 && EMbrTable
[i
].Flags
!= 0x80) ||
926 EMbrTable
[i
].StartLBA
== 0 || EMbrTable
[i
].Size
== 0)
928 if (IS_EXTENDED_PART_TYPE(EMbrTable
[i
].Type
)) {
929 // set next ExtCurrent
930 NextExtCurrent
= ExtBase
+ EMbrTable
[i
].StartLBA
;
934 // found a logical partition
935 Volume
= AllocateZeroPool(sizeof(REFIT_VOLUME
));
936 Volume
->DiskKind
= WholeDiskVolume
->DiskKind
;
937 Volume
->IsMbrPartition
= TRUE
;
938 Volume
->MbrPartitionIndex
= LogicalPartitionIndex
++;
939 Volume
->VolName
= AllocateZeroPool(256 * sizeof(UINT16
));
940 SPrint(Volume
->VolName
, 255, L
"Partition %d", Volume
->MbrPartitionIndex
+ 1);
941 Volume
->BlockIO
= WholeDiskVolume
->BlockIO
;
942 Volume
->BlockIOOffset
= ExtCurrent
+ EMbrTable
[i
].StartLBA
;
943 Volume
->WholeDiskBlockIO
= WholeDiskVolume
->BlockIO
;
946 ScanVolumeBootcode(Volume
, &Bootable
);
948 Volume
->HasBootCode
= FALSE
;
950 SetVolumeBadgeIcon(Volume
);
952 AddListElement((VOID
***) &Volumes
, &VolumesCount
, Volume
);
957 } /* VOID ScanExtendedPartition() */
959 VOID
ScanVolumes(VOID
)
963 REFIT_VOLUME
*Volume
, *WholeDiskVolume
;
964 MBR_PARTITION_INFO
*MbrTable
;
965 UINTN HandleCount
= 0;
967 UINTN VolumeIndex
, VolumeIndex2
;
968 UINTN PartitionIndex
;
969 UINTN SectorSum
, i
, VolNumber
= 0;
970 UINT8
*SectorBuffer1
, *SectorBuffer2
;
972 EFI_GUID NullUuid
= { 00000000, 0000, 0000, {0000, 0000, 0000, 0000} };
978 // get all filesystem handles
979 Status
= LibLocateHandle(ByProtocol
, &BlockIoProtocol
, NULL
, &HandleCount
, &Handles
);
980 UuidList
= AllocateZeroPool(sizeof(EFI_GUID
) * HandleCount
);
981 // was: &FileSystemProtocol
982 if (Status
== EFI_NOT_FOUND
) {
983 return; // no filesystems. strange, but true...
985 if (CheckError(Status
, L
"while listing all file systems"))
988 // first pass: collect information about all handles
989 for (HandleIndex
= 0; HandleIndex
< HandleCount
; HandleIndex
++) {
990 Volume
= AllocateZeroPool(sizeof(REFIT_VOLUME
));
991 Volume
->DeviceHandle
= Handles
[HandleIndex
];
994 UuidList
[HandleIndex
] = Volume
->VolUuid
;
995 for (i
= 0; i
< HandleIndex
; i
++) {
996 if ((CompareMem(&(Volume
->VolUuid
), &(UuidList
[i
]), sizeof(EFI_GUID
)) == 0) &&
997 (CompareMem(&(Volume
->VolUuid
), &NullUuid
, sizeof(EFI_GUID
)) != 0)) { // Duplicate filesystem UUID
998 Volume
->IsReadable
= FALSE
;
1002 if (Volume
->IsReadable
)
1003 Volume
->VolNumber
= VolNumber
++;
1005 Volume
->VolNumber
= VOL_UNREADABLE
;
1007 AddListElement((VOID
***) &Volumes
, &VolumesCount
, Volume
);
1009 if (Volume
->DeviceHandle
== SelfLoadedImage
->DeviceHandle
)
1010 SelfVolume
= Volume
;
1012 MyFreePool(Handles
);
1014 if (SelfVolume
== NULL
)
1015 Print(L
"WARNING: SelfVolume not found");
1017 // second pass: relate partitions and whole disk devices
1018 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
1019 Volume
= Volumes
[VolumeIndex
];
1020 // check MBR partition table for extended partitions
1021 if (Volume
->BlockIO
!= NULL
&& Volume
->WholeDiskBlockIO
!= NULL
&&
1022 Volume
->BlockIO
== Volume
->WholeDiskBlockIO
&& Volume
->BlockIOOffset
== 0 &&
1023 Volume
->MbrPartitionTable
!= NULL
) {
1024 MbrTable
= Volume
->MbrPartitionTable
;
1025 for (PartitionIndex
= 0; PartitionIndex
< 4; PartitionIndex
++) {
1026 if (IS_EXTENDED_PART_TYPE(MbrTable
[PartitionIndex
].Type
)) {
1027 ScanExtendedPartition(Volume
, MbrTable
+ PartitionIndex
);
1032 // search for corresponding whole disk volume entry
1033 WholeDiskVolume
= NULL
;
1034 if (Volume
->BlockIO
!= NULL
&& Volume
->WholeDiskBlockIO
!= NULL
&&
1035 Volume
->BlockIO
!= Volume
->WholeDiskBlockIO
) {
1036 for (VolumeIndex2
= 0; VolumeIndex2
< VolumesCount
; VolumeIndex2
++) {
1037 if (Volumes
[VolumeIndex2
]->BlockIO
== Volume
->WholeDiskBlockIO
&&
1038 Volumes
[VolumeIndex2
]->BlockIOOffset
== 0)
1039 WholeDiskVolume
= Volumes
[VolumeIndex2
];
1043 if (WholeDiskVolume
!= NULL
&& WholeDiskVolume
->MbrPartitionTable
!= NULL
) {
1044 // check if this volume is one of the partitions in the table
1045 MbrTable
= WholeDiskVolume
->MbrPartitionTable
;
1046 SectorBuffer1
= AllocatePool(512);
1047 SectorBuffer2
= AllocatePool(512);
1048 for (PartitionIndex
= 0; PartitionIndex
< 4; PartitionIndex
++) {
1050 if ((UINT64
)(MbrTable
[PartitionIndex
].Size
) != Volume
->BlockIO
->Media
->LastBlock
+ 1)
1053 // compare boot sector read through offset vs. directly
1054 Status
= refit_call5_wrapper(Volume
->BlockIO
->ReadBlocks
,
1055 Volume
->BlockIO
, Volume
->BlockIO
->Media
->MediaId
,
1056 Volume
->BlockIOOffset
, 512, SectorBuffer1
);
1057 if (EFI_ERROR(Status
))
1059 Status
= refit_call5_wrapper(Volume
->WholeDiskBlockIO
->ReadBlocks
,
1060 Volume
->WholeDiskBlockIO
, Volume
->WholeDiskBlockIO
->Media
->MediaId
,
1061 MbrTable
[PartitionIndex
].StartLBA
, 512, SectorBuffer2
);
1062 if (EFI_ERROR(Status
))
1064 if (CompareMem(SectorBuffer1
, SectorBuffer2
, 512) != 0)
1067 for (i
= 0; i
< 512; i
++)
1068 SectorSum
+= SectorBuffer1
[i
];
1069 if (SectorSum
< 1000)
1072 // TODO: mark entry as non-bootable if it is an extended partition
1074 // now we're reasonably sure the association is correct...
1075 Volume
->IsMbrPartition
= TRUE
;
1076 Volume
->MbrPartitionIndex
= PartitionIndex
;
1077 if (Volume
->VolName
== NULL
) {
1078 Volume
->VolName
= AllocateZeroPool(sizeof(CHAR16
) * 256);
1079 SPrint(Volume
->VolName
, 255, L
"Partition %d", PartitionIndex
+ 1);
1084 MyFreePool(SectorBuffer1
);
1085 MyFreePool(SectorBuffer2
);
1089 } /* VOID ScanVolumes() */
1091 static VOID
UninitVolumes(VOID
)
1093 REFIT_VOLUME
*Volume
;
1096 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
1097 Volume
= Volumes
[VolumeIndex
];
1099 if (Volume
->RootDir
!= NULL
) {
1100 refit_call1_wrapper(Volume
->RootDir
->Close
, Volume
->RootDir
);
1101 Volume
->RootDir
= NULL
;
1104 Volume
->DeviceHandle
= NULL
;
1105 Volume
->BlockIO
= NULL
;
1106 Volume
->WholeDiskBlockIO
= NULL
;
1110 VOID
ReinitVolumes(VOID
)
1113 REFIT_VOLUME
*Volume
;
1115 EFI_DEVICE_PATH
*RemainingDevicePath
;
1116 EFI_HANDLE DeviceHandle
, WholeDiskHandle
;
1118 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
1119 Volume
= Volumes
[VolumeIndex
];
1121 if (Volume
->DevicePath
!= NULL
) {
1122 // get the handle for that path
1123 RemainingDevicePath
= Volume
->DevicePath
;
1124 Status
= refit_call3_wrapper(BS
->LocateDevicePath
, &BlockIoProtocol
, &RemainingDevicePath
, &DeviceHandle
);
1126 if (!EFI_ERROR(Status
)) {
1127 Volume
->DeviceHandle
= DeviceHandle
;
1129 // get the root directory
1130 Volume
->RootDir
= LibOpenRoot(Volume
->DeviceHandle
);
1133 CheckError(Status
, L
"from LocateDevicePath");
1136 if (Volume
->WholeDiskDevicePath
!= NULL
) {
1137 // get the handle for that path
1138 RemainingDevicePath
= Volume
->WholeDiskDevicePath
;
1139 Status
= refit_call3_wrapper(BS
->LocateDevicePath
, &BlockIoProtocol
, &RemainingDevicePath
, &WholeDiskHandle
);
1141 if (!EFI_ERROR(Status
)) {
1142 // get the BlockIO protocol
1143 Status
= refit_call3_wrapper(BS
->HandleProtocol
, WholeDiskHandle
, &BlockIoProtocol
, (VOID
**) &Volume
->WholeDiskBlockIO
);
1144 if (EFI_ERROR(Status
)) {
1145 Volume
->WholeDiskBlockIO
= NULL
;
1146 CheckError(Status
, L
"from HandleProtocol");
1149 CheckError(Status
, L
"from LocateDevicePath");
1155 // file and dir functions
1158 BOOLEAN
FileExists(IN EFI_FILE
*BaseDir
, IN CHAR16
*RelativePath
)
1161 EFI_FILE_HANDLE TestFile
;
1163 Status
= refit_call5_wrapper(BaseDir
->Open
, BaseDir
, &TestFile
, RelativePath
, EFI_FILE_MODE_READ
, 0);
1164 if (Status
== EFI_SUCCESS
) {
1165 refit_call1_wrapper(TestFile
->Close
, TestFile
);
1171 EFI_STATUS
DirNextEntry(IN EFI_FILE
*Directory
, IN OUT EFI_FILE_INFO
**DirEntry
, IN UINTN FilterMode
)
1175 UINTN LastBufferSize
, BufferSize
;
1180 // free pointer from last call
1181 if (*DirEntry
!= NULL
) {
1182 FreePool(*DirEntry
);
1186 // read next directory entry
1187 LastBufferSize
= BufferSize
= 256;
1188 Buffer
= AllocatePool(BufferSize
);
1189 for (IterCount
= 0; ; IterCount
++) {
1190 Status
= refit_call3_wrapper(Directory
->Read
, Directory
, &BufferSize
, Buffer
);
1191 if (Status
!= EFI_BUFFER_TOO_SMALL
|| IterCount
>= 4)
1193 if (BufferSize
<= LastBufferSize
) {
1194 Print(L
"FS Driver requests bad buffer size %d (was %d), using %d instead\n", BufferSize
, LastBufferSize
, LastBufferSize
* 2);
1195 BufferSize
= LastBufferSize
* 2;
1198 Print(L
"Reallocating buffer from %d to %d\n", LastBufferSize
, BufferSize
);
1201 Buffer
= EfiReallocatePool(Buffer
, LastBufferSize
, BufferSize
);
1202 LastBufferSize
= BufferSize
;
1204 if (EFI_ERROR(Status
)) {
1210 // check for end of listing
1211 if (BufferSize
== 0) { // end of directory listing
1217 // entry is ready to be returned
1218 *DirEntry
= (EFI_FILE_INFO
*)Buffer
;
1221 if (FilterMode
== 1) { // only return directories
1222 if (((*DirEntry
)->Attribute
& EFI_FILE_DIRECTORY
))
1224 } else if (FilterMode
== 2) { // only return files
1225 if (((*DirEntry
)->Attribute
& EFI_FILE_DIRECTORY
) == 0)
1227 } else // no filter or unknown filter -> return everything
1234 VOID
DirIterOpen(IN EFI_FILE
*BaseDir
, IN CHAR16
*RelativePath OPTIONAL
, OUT REFIT_DIR_ITER
*DirIter
)
1236 if (RelativePath
== NULL
) {
1237 DirIter
->LastStatus
= EFI_SUCCESS
;
1238 DirIter
->DirHandle
= BaseDir
;
1239 DirIter
->CloseDirHandle
= FALSE
;
1241 DirIter
->LastStatus
= refit_call5_wrapper(BaseDir
->Open
, BaseDir
, &(DirIter
->DirHandle
), RelativePath
, EFI_FILE_MODE_READ
, 0);
1242 DirIter
->CloseDirHandle
= EFI_ERROR(DirIter
->LastStatus
) ? FALSE
: TRUE
;
1244 DirIter
->LastFileInfo
= NULL
;
1247 #ifndef __MAKEWITH_GNUEFI
1248 EFI_UNICODE_COLLATION_PROTOCOL
*mUnicodeCollation
= NULL
;
1251 InitializeUnicodeCollationProtocol (VOID
)
1255 if (mUnicodeCollation
!= NULL
) {
1260 // BUGBUG: Proper impelmentation is to locate all Unicode Collation Protocol
1261 // instances first and then select one which support English language.
1262 // Current implementation just pick the first instance.
1264 Status
= gBS
->LocateProtocol (
1265 &gEfiUnicodeCollation2ProtocolGuid
,
1267 (VOID
**) &mUnicodeCollation
1269 if (EFI_ERROR(Status
)) {
1270 Status
= gBS
->LocateProtocol (
1271 &gEfiUnicodeCollationProtocolGuid
,
1273 (VOID
**) &mUnicodeCollation
1281 MetaiMatch (IN CHAR16
*String
, IN CHAR16
*Pattern
)
1283 if (!mUnicodeCollation
) {
1284 InitializeUnicodeCollationProtocol();
1286 if (mUnicodeCollation
)
1287 return mUnicodeCollation
->MetaiMatch (mUnicodeCollation
, String
, Pattern
);
1288 return FALSE
; // Shouldn't happen
1291 static VOID
StrLwr (IN OUT CHAR16
*Str
) {
1292 if (!mUnicodeCollation
) {
1293 InitializeUnicodeCollationProtocol();
1295 if (mUnicodeCollation
)
1296 mUnicodeCollation
->StrLwr (mUnicodeCollation
, Str
);
1301 BOOLEAN
DirIterNext(IN OUT REFIT_DIR_ITER
*DirIter
, IN UINTN FilterMode
, IN CHAR16
*FilePattern OPTIONAL
,
1302 OUT EFI_FILE_INFO
**DirEntry
)
1304 BOOLEAN KeepGoing
= TRUE
;
1308 if (DirIter
->LastFileInfo
!= NULL
) {
1309 FreePool(DirIter
->LastFileInfo
);
1310 DirIter
->LastFileInfo
= NULL
;
1313 if (EFI_ERROR(DirIter
->LastStatus
))
1314 return FALSE
; // stop iteration
1317 DirIter
->LastStatus
= DirNextEntry(DirIter
->DirHandle
, &(DirIter
->LastFileInfo
), FilterMode
);
1318 if (EFI_ERROR(DirIter
->LastStatus
))
1320 if (DirIter
->LastFileInfo
== NULL
) // end of listing
1322 if (FilePattern
!= NULL
) {
1323 if ((DirIter
->LastFileInfo
->Attribute
& EFI_FILE_DIRECTORY
))
1326 while (KeepGoing
&& (OnePattern
= FindCommaDelimited(FilePattern
, i
++)) != NULL
) {
1327 if (MetaiMatch(DirIter
->LastFileInfo
->FileName
, OnePattern
))
1330 // else continue loop
1333 } while (KeepGoing
&& FilePattern
);
1335 *DirEntry
= DirIter
->LastFileInfo
;
1339 EFI_STATUS
DirIterClose(IN OUT REFIT_DIR_ITER
*DirIter
)
1341 if (DirIter
->LastFileInfo
!= NULL
) {
1342 FreePool(DirIter
->LastFileInfo
);
1343 DirIter
->LastFileInfo
= NULL
;
1345 if (DirIter
->CloseDirHandle
)
1346 refit_call1_wrapper(DirIter
->DirHandle
->Close
, DirIter
->DirHandle
);
1347 return DirIter
->LastStatus
;
1351 // file name manipulation
1354 // Returns the filename portion (minus path name) of the
1356 CHAR16
* Basename(IN CHAR16
*Path
)
1364 for (i
= StrLen(Path
); i
> 0; i
--) {
1365 if (Path
[i
-1] == '\\' || Path
[i
-1] == '/') {
1366 FileName
= Path
+ i
;
1375 // Remove the .efi extension from FileName -- for instance, if FileName is
1376 // "fred.efi", returns "fred". If the filename contains no .efi extension,
1377 // returns a copy of the original input.
1378 CHAR16
* StripEfiExtension(CHAR16
*FileName
) {
1380 CHAR16
*Copy
= NULL
;
1382 if ((FileName
!= NULL
) && ((Copy
= StrDuplicate(FileName
)) != NULL
)) {
1383 Length
= StrLen(Copy
);
1384 // Note: Do StriCmp() twice to work around Gigabyte Hybrid EFI case-sensitivity bug....
1385 if ((Length
>= 4) && ((StriCmp(&Copy
[Length
- 4], L
".efi") == 0) || (StriCmp(&Copy
[Length
- 4], L
".EFI") == 0))) {
1386 Copy
[Length
- 4] = 0;
1390 } // CHAR16 * StripExtension()
1393 // memory string search
1396 INTN
FindMem(IN VOID
*Buffer
, IN UINTN BufferLength
, IN VOID
*SearchString
, IN UINTN SearchStringLength
)
1402 BufferLength
-= SearchStringLength
;
1403 for (Offset
= 0; Offset
< BufferLength
; Offset
++, BufferPtr
++) {
1404 if (CompareMem(BufferPtr
, SearchString
, SearchStringLength
) == 0)
1405 return (INTN
)Offset
;
1411 // Performs a case-insensitive search of BigStr for SmallStr.
1412 // Returns TRUE if found, FALSE if not.
1413 BOOLEAN
StriSubCmp(IN CHAR16
*SmallStr
, IN CHAR16
*BigStr
) {
1414 CHAR16
*SmallCopy
, *BigCopy
;
1415 BOOLEAN Found
= FALSE
;
1416 UINTN StartPoint
= 0, NumCompares
= 0, SmallLen
= 0;
1418 if ((SmallStr
!= NULL
) && (BigStr
!= NULL
) && (StrLen(BigStr
) >= StrLen(SmallStr
))) {
1419 SmallCopy
= StrDuplicate(SmallStr
);
1420 BigCopy
= StrDuplicate(BigStr
);
1423 SmallLen
= StrLen(SmallCopy
);
1424 NumCompares
= StrLen(BigCopy
) - SmallLen
+ 1;
1425 while ((!Found
) && (StartPoint
< NumCompares
)) {
1426 Found
= (StrnCmp(SmallCopy
, &BigCopy
[StartPoint
++], SmallLen
) == 0);
1428 MyFreePool(SmallCopy
);
1429 MyFreePool(BigCopy
);
1433 } // BOOLEAN StriSubCmp()
1435 // Merges two strings, creating a new one and returning a pointer to it.
1436 // If AddChar != 0, the specified character is placed between the two original
1437 // strings (unless the first string is NULL or empty). The original input
1438 // string *First is de-allocated and replaced by the new merged string.
1439 // This is similar to StrCat, but safer and more flexible because
1440 // MergeStrings allocates memory that's the correct size for the
1441 // new merged string, so it can take a NULL *First and it cleans
1442 // up the old memory. It should *NOT* be used with a constant
1443 // *First, though....
1444 VOID
MergeStrings(IN OUT CHAR16
**First
, IN CHAR16
*Second
, CHAR16 AddChar
) {
1445 UINTN Length1
= 0, Length2
= 0;
1449 Length1
= StrLen(*First
);
1451 Length2
= StrLen(Second
);
1452 NewString
= AllocatePool(sizeof(CHAR16
) * (Length1
+ Length2
+ 2));
1453 if (NewString
!= NULL
) {
1454 if ((*First
!= NULL
) && (StrLen(*First
) == 0)) {
1458 NewString
[0] = L
'\0';
1459 if (*First
!= NULL
) {
1460 StrCat(NewString
, *First
);
1462 NewString
[Length1
] = AddChar
;
1463 NewString
[Length1
+ 1] = '\0';
1465 } // if (*First != NULL)
1467 StrCat(NewString
, Second
);
1471 Print(L
"Error! Unable to allocate memory in MergeStrings()!\n");
1473 } // static CHAR16* MergeStrings()
1475 // Takes an input pathname (*Path) and returns the part of the filename from
1476 // the final dot onwards, converted to lowercase. If the filename includes
1477 // no dots, or if the input is NULL, returns an empty (but allocated) string.
1478 // The calling function is responsible for freeing the memory associated with
1479 // the return value.
1480 CHAR16
*FindExtension(IN CHAR16
*Path
) {
1482 BOOLEAN Found
= FALSE
, FoundSlash
= FALSE
;
1485 Extension
= AllocateZeroPool(sizeof(CHAR16
));
1488 while ((!Found
) && (!FoundSlash
) && (i
>= 0)) {
1489 if (Path
[i
] == L
'.')
1491 else if ((Path
[i
] == L
'/') || (Path
[i
] == L
'\\'))
1497 MergeStrings(&Extension
, &Path
[i
], 0);
1502 } // CHAR16 *FindExtension
1504 // Takes an input pathname (*Path) and locates the final directory component
1505 // of that name. For instance, if the input path is 'EFI\foo\bar.efi', this
1506 // function returns the string 'foo'.
1507 // Assumes the pathname is separated with backslashes.
1508 CHAR16
*FindLastDirName(IN CHAR16
*Path
) {
1509 UINTN i
, StartOfElement
= 0, EndOfElement
= 0, PathLength
, CopyLength
;
1510 CHAR16
*Found
= NULL
;
1515 PathLength
= StrLen(Path
);
1516 // Find start & end of target element
1517 for (i
= 0; i
< PathLength
; i
++) {
1518 if (Path
[i
] == '\\') {
1519 StartOfElement
= EndOfElement
;
1523 // Extract the target element
1524 if (EndOfElement
> 0) {
1525 while ((StartOfElement
< PathLength
) && (Path
[StartOfElement
] == '\\')) {
1529 if (EndOfElement
>= StartOfElement
) {
1530 CopyLength
= EndOfElement
- StartOfElement
+ 1;
1531 Found
= StrDuplicate(&Path
[StartOfElement
]);
1533 Found
[CopyLength
] = 0;
1534 } // if (EndOfElement >= StartOfElement)
1535 } // if (EndOfElement > 0)
1537 } // CHAR16 *FindLastDirName
1539 // Returns the directory portion of a pathname. For instance,
1540 // if FullPath is 'EFI\foo\bar.efi', this function returns the
1541 // string 'EFI\foo'. The calling function is responsible for
1542 // freeing the returned string's memory.
1543 CHAR16
*FindPath(IN CHAR16
* FullPath
) {
1544 UINTN i
, LastBackslash
= 0;
1545 CHAR16
*PathOnly
= NULL
;
1547 if (FullPath
!= NULL
) {
1548 for (i
= 0; i
< StrLen(FullPath
); i
++) {
1549 if (FullPath
[i
] == '\\')
1552 PathOnly
= StrDuplicate(FullPath
);
1553 PathOnly
[LastBackslash
] = 0;
1558 // Takes an input loadpath, splits it into disk and filename components, finds a matching
1559 // DeviceVolume, and returns that and the filename (*loader).
1560 VOID
FindVolumeAndFilename(IN EFI_DEVICE_PATH
*loadpath
, OUT REFIT_VOLUME
**DeviceVolume
, OUT CHAR16
**loader
) {
1561 CHAR16
*DeviceString
, *VolumeDeviceString
, *Temp
;
1563 BOOLEAN Found
= FALSE
;
1565 MyFreePool(*loader
);
1566 MyFreePool(*DeviceVolume
);
1567 *DeviceVolume
= NULL
;
1568 DeviceString
= DevicePathToStr(loadpath
);
1569 *loader
= SplitDeviceString(DeviceString
);
1571 while ((i
< VolumesCount
) && (!Found
)) {
1572 VolumeDeviceString
= DevicePathToStr(Volumes
[i
]->DevicePath
);
1573 Temp
= SplitDeviceString(VolumeDeviceString
);
1574 if (StriCmp(DeviceString
, VolumeDeviceString
) == 0) {
1576 *DeviceVolume
= Volumes
[i
];
1579 MyFreePool(VolumeDeviceString
);
1583 MyFreePool(DeviceString
);
1584 } // VOID FindVolumeAndFilename()
1586 // Splits a volume/filename string (e.g., "fs0:\EFI\BOOT") into separate
1587 // volume and filename components (e.g., "fs0" and "\EFI\BOOT"), returning
1588 // the filename component in the original *Path variable and the split-off
1589 // volume component in the *VolName variable.
1590 // Returns TRUE if both components are found, FALSE otherwise.
1591 BOOLEAN
SplitVolumeAndFilename(IN OUT CHAR16
**Path
, OUT CHAR16
**VolName
) {
1592 UINTN i
= 0, Length
;
1598 if (*VolName
!= NULL
) {
1599 MyFreePool(*VolName
);
1603 Length
= StrLen(*Path
);
1604 while ((i
< Length
) && ((*Path
)[i
] != L
':')) {
1609 Filename
= StrDuplicate((*Path
) + i
+ 1);
1617 } // BOOLEAN SplitVolumeAndFilename()
1619 // Returns all the digits in the input string, including intervening
1620 // non-digit characters. For instance, if InString is "foo-3.3.4-7.img",
1621 // this function returns "3.3.4-7". If InString contains no digits,
1622 // the return value is NULL.
1623 CHAR16
*FindNumbers(IN CHAR16
*InString
) {
1624 UINTN i
, StartOfElement
, EndOfElement
= 0, InLength
, CopyLength
;
1625 CHAR16
*Found
= NULL
;
1627 if (InString
== NULL
)
1630 InLength
= StartOfElement
= StrLen(InString
);
1631 // Find start & end of target element
1632 for (i
= 0; i
< InLength
; i
++) {
1633 if ((InString
[i
] >= '0') && (InString
[i
] <= '9')) {
1634 if (StartOfElement
> i
)
1636 if (EndOfElement
< i
)
1640 // Extract the target element
1641 if (EndOfElement
> 0) {
1642 if (EndOfElement
>= StartOfElement
) {
1643 CopyLength
= EndOfElement
- StartOfElement
+ 1;
1644 Found
= StrDuplicate(&InString
[StartOfElement
]);
1646 Found
[CopyLength
] = 0;
1647 } // if (EndOfElement >= StartOfElement)
1648 } // if (EndOfElement > 0)
1650 } // CHAR16 *FindNumbers()
1652 // Find the #Index element (numbered from 0) in a comma-delimited string
1654 // Returns the found element, or NULL if Index is out of range or InString
1655 // is NULL. Note that the calling function is responsible for freeing the
1656 // memory associated with the returned string pointer.
1657 CHAR16
*FindCommaDelimited(IN CHAR16
*InString
, IN UINTN Index
) {
1658 UINTN StartPos
= 0, CurPos
= 0;
1659 BOOLEAN Found
= FALSE
;
1660 CHAR16
*FoundString
= NULL
;
1662 if (InString
!= NULL
) {
1663 // After while() loop, StartPos marks start of item #Index
1664 while ((Index
> 0) && (CurPos
< StrLen(InString
))) {
1665 if (InString
[CurPos
] == L
',') {
1667 StartPos
= CurPos
+ 1;
1671 // After while() loop, CurPos is one past the end of the element
1672 while ((CurPos
< StrLen(InString
)) && (!Found
)) {
1673 if (InString
[CurPos
] == L
',')
1679 FoundString
= StrDuplicate(&InString
[StartPos
]);
1680 if (FoundString
!= NULL
)
1681 FoundString
[CurPos
- StartPos
] = 0;
1683 return (FoundString
);
1684 } // CHAR16 *FindCommaDelimited()
1686 // Returns TRUE if SmallString is an element in the comma-delimited List,
1687 // FALSE otherwise. Performs comparison case-insensitively (except on
1688 // buggy EFIs with case-sensitive StriCmp() functions).
1689 BOOLEAN
IsIn(IN CHAR16
*SmallString
, IN CHAR16
*List
) {
1691 BOOLEAN Found
= FALSE
;
1694 if (SmallString
&& List
) {
1695 while (!Found
&& (OneElement
= FindCommaDelimited(List
, i
++))) {
1696 if (StriCmp(OneElement
, SmallString
) == 0)
1703 // Implement FreePool the way it should have been done to begin with, so that
1704 // it doesn't throw an ASSERT message if fed a NULL pointer....
1705 VOID
MyFreePool(IN VOID
*Pointer
) {
1706 if (Pointer
!= NULL
)
1710 static EFI_GUID AppleRemovableMediaGuid
= APPLE_REMOVABLE_MEDIA_PROTOCOL_GUID
;
1712 // Eject all removable media.
1713 // Returns TRUE if any media were ejected, FALSE otherwise.
1714 BOOLEAN
EjectMedia(VOID
) {
1716 UINTN HandleIndex
, HandleCount
= 0, Ejected
= 0;
1717 EFI_HANDLE
*Handles
, Handle
;
1718 APPLE_REMOVABLE_MEDIA_PROTOCOL
*Ejectable
;
1720 Status
= LibLocateHandle(ByProtocol
, &AppleRemovableMediaGuid
, NULL
, &HandleCount
, &Handles
);
1721 if (EFI_ERROR(Status
) || HandleCount
== 0)
1722 return (FALSE
); // probably not an Apple system
1724 for (HandleIndex
= 0; HandleIndex
< HandleCount
; HandleIndex
++) {
1725 Handle
= Handles
[HandleIndex
];
1726 Status
= refit_call3_wrapper(BS
->HandleProtocol
, Handle
, &AppleRemovableMediaGuid
, (VOID
**) &Ejectable
);
1727 if (EFI_ERROR(Status
))
1729 Status
= refit_call1_wrapper(Ejectable
->Eject
, Ejectable
);
1730 if (!EFI_ERROR(Status
))
1733 MyFreePool(Handles
);
1734 return (Ejected
> 0);
1735 } // VOID EjectMedia()
1738 // Return the GUID as a string, suitable for display to the user. Note that the calling
1739 // function is responsible for freeing the allocated memory.
1740 CHAR16
* GuidAsString(EFI_GUID
*GuidData
) {
1743 TheString
= AllocateZeroPool(42 * sizeof(CHAR16
));
1744 if (TheString
!= 0) {
1745 SPrint (TheString
, 82, L
"%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x",
1746 (UINTN
)GuidData
->Data1
, (UINTN
)GuidData
->Data2
, (UINTN
)GuidData
->Data3
,
1747 (UINTN
)GuidData
->Data4
[0], (UINTN
)GuidData
->Data4
[1], (UINTN
)GuidData
->Data4
[2],
1748 (UINTN
)GuidData
->Data4
[3], (UINTN
)GuidData
->Data4
[4], (UINTN
)GuidData
->Data4
[5],
1749 (UINTN
)GuidData
->Data4
[6], (UINTN
)GuidData
->Data4
[7]);
1752 } // GuidAsString(EFI_GUID *GuidData)