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 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"
52 #ifdef __MAKEWITH_GNUEFI
53 #define EfiReallocatePool ReallocatePool
55 #define LibLocateHandle gBS->LocateHandleBuffer
56 #define DevicePathProtocol gEfiDevicePathProtocolGuid
57 #define BlockIoProtocol gEfiBlockIoProtocolGuid
58 #define LibFileSystemInfo EfiLibFileSystemInfo
59 #define LibOpenRoot EfiLibOpenRoot
60 EFI_DEVICE_PATH EndDevicePath
[] = {
61 {END_DEVICE_PATH_TYPE
, END_ENTIRE_DEVICE_PATH_SUBTYPE
, {END_DEVICE_PATH_LENGTH
, 0}}
64 //#define EndDevicePath DevicePath
67 // "Magic" signatures for various filesystems
68 #define FAT_MAGIC 0xAA55
69 #define EXT2_SUPER_MAGIC 0xEF53
70 #define HFSPLUS_MAGIC1 0x2B48
71 #define HFSPLUS_MAGIC2 0x5848
72 #define REISERFS_SUPER_MAGIC_STRING "ReIsErFs"
73 #define REISER2FS_SUPER_MAGIC_STRING "ReIsEr2Fs"
74 #define REISER2FS_JR_SUPER_MAGIC_STRING "ReIsEr3Fs"
78 EFI_HANDLE SelfImageHandle
;
79 EFI_LOADED_IMAGE
*SelfLoadedImage
;
80 EFI_FILE
*SelfRootDir
;
84 REFIT_VOLUME
*SelfVolume
= NULL
;
85 REFIT_VOLUME
**Volumes
= NULL
;
86 UINTN VolumesCount
= 0;
88 // Maximum size for disk sectors
89 #define SECTOR_SIZE 4096
91 // Number of bytes to read from a partition to determine its filesystem type
92 // and identify its boot loader, and hence probable BIOS-mode OS installation
93 #define SAMPLE_SIZE 69632 /* 68 KiB -- ReiserFS superblock begins at 64 KiB */
95 // Default names for volume badges (mini-icon to define disk type) and icons
96 #define VOLUME_BADGE_NAME L".VolumeBadge.icns"
97 #define VOLUME_ICON_NAME L".VolumeIcon.icns"
101 static EFI_STATUS
FinishInitRefitLib(VOID
);
103 static VOID
UninitVolumes(VOID
);
106 // self recognition stuff
109 // Converts forward slashes to backslashes, removes duplicate slashes, and
110 // removes slashes from both the start and end of the pathname.
111 // Necessary because some (buggy?) EFI implementations produce "\/" strings
112 // in pathnames, because some user inputs can produce duplicate directory
113 // separators, and because we want consistent start and end slashes for
114 // directory comparisons. A special case: If the PathName refers to root,
115 // return "/", since some firmware implementations flake out if this
117 VOID
CleanUpPathNameSlashes(IN OUT CHAR16
*PathName
) {
119 UINTN i
, FinalChar
= 0;
120 BOOLEAN LastWasSlash
= FALSE
;
122 NewName
= AllocateZeroPool(sizeof(CHAR16
) * (StrLen(PathName
) + 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.
157 static CHAR16
* SplitDeviceString(IN OUT CHAR16
*InString
) {
159 CHAR16
*FileName
= NULL
;
160 BOOLEAN Found
= FALSE
;
162 i
= StrLen(InString
) - 1;
163 while ((i
>= 0) && (!Found
)) {
164 if (InString
[i
] == L
')') {
166 FileName
= StrDuplicate(&InString
[i
+ 1]);
167 CleanUpPathNameSlashes(FileName
);
168 InString
[i
+ 1] = '\0';
172 if (FileName
== NULL
)
173 FileName
= StrDuplicate(InString
);
175 } // static CHAR16* SplitDeviceString()
177 EFI_STATUS
InitRefitLib(IN EFI_HANDLE ImageHandle
)
180 CHAR16
*DevicePathAsString
, *Temp
;
182 SelfImageHandle
= ImageHandle
;
183 Status
= refit_call3_wrapper(BS
->HandleProtocol
, SelfImageHandle
, &LoadedImageProtocol
, (VOID
**) &SelfLoadedImage
);
184 if (CheckFatalError(Status
, L
"while getting a LoadedImageProtocol handle"))
185 return EFI_LOAD_ERROR
;
187 // find the current directory
188 DevicePathAsString
= DevicePathToStr(SelfLoadedImage
->FilePath
);
189 CleanUpPathNameSlashes(DevicePathAsString
);
190 MyFreePool(SelfDirPath
);
191 Temp
= FindPath(DevicePathAsString
);
192 SelfDirPath
= SplitDeviceString(Temp
);
193 MyFreePool(DevicePathAsString
);
196 return FinishInitRefitLib();
199 // called before running external programs to close open file handles
200 VOID
UninitRefitLib(VOID
)
204 if (SelfDir
!= NULL
) {
205 refit_call1_wrapper(SelfDir
->Close
, SelfDir
);
209 if (SelfRootDir
!= NULL
) {
210 refit_call1_wrapper(SelfRootDir
->Close
, SelfRootDir
);
215 // called after running external programs to re-open file handles
216 EFI_STATUS
ReinitRefitLib(VOID
)
220 if ((ST
->Hdr
.Revision
>> 16) == 1) {
221 // Below two lines were in rEFIt, but seem to cause system crashes or
222 // reboots when launching OSes after returning from programs on most
223 // systems. OTOH, my Mac Mini produces errors about "(re)opening our
224 // installation volume" (see the next function) when returning from
225 // programs when these two lines are removed, and it often crashes
226 // when returning from a program or when launching a second program
227 // with these lines removed. Therefore, the preceding if() statement
228 // executes these lines only on EFIs with a major version number of 1
229 // (which Macs have) and not with 2 (which UEFI PCs have). My selection
230 // of hardware on which to test is limited, though, so this may be the
231 // wrong test, or there may be a better way to fix this problem.
232 // TODO: Figure out cause of above weirdness and fix it more
234 if (SelfVolume
!= NULL
&& SelfVolume
->RootDir
!= NULL
)
235 SelfRootDir
= SelfVolume
->RootDir
;
238 return FinishInitRefitLib();
241 static EFI_STATUS
FinishInitRefitLib(VOID
)
245 if (SelfRootDir
== NULL
) {
246 SelfRootDir
= LibOpenRoot(SelfLoadedImage
->DeviceHandle
);
247 if (SelfRootDir
== NULL
) {
248 CheckError(EFI_LOAD_ERROR
, L
"while (re)opening our installation volume");
249 return EFI_LOAD_ERROR
;
253 Status
= refit_call5_wrapper(SelfRootDir
->Open
, SelfRootDir
, &SelfDir
, SelfDirPath
, EFI_FILE_MODE_READ
, 0);
254 if (CheckFatalError(Status
, L
"while opening our installation directory"))
255 return EFI_LOAD_ERROR
;
264 VOID
CreateList(OUT VOID
***ListPtr
, OUT UINTN
*ElementCount
, IN UINTN InitialElementCount
)
268 *ElementCount
= InitialElementCount
;
269 if (*ElementCount
> 0) {
270 AllocateCount
= (*ElementCount
+ 7) & ~7; // next multiple of 8
271 *ListPtr
= AllocatePool(sizeof(VOID
*) * AllocateCount
);
277 VOID
AddListElement(IN OUT VOID
***ListPtr
, IN OUT UINTN
*ElementCount
, IN VOID
*NewElement
)
281 if ((*ElementCount
& 7) == 0) {
282 AllocateCount
= *ElementCount
+ 8;
283 if (*ElementCount
== 0)
284 *ListPtr
= AllocatePool(sizeof(VOID
*) * AllocateCount
);
286 *ListPtr
= EfiReallocatePool(*ListPtr
, sizeof(VOID
*) * (*ElementCount
), sizeof(VOID
*) * AllocateCount
);
288 (*ListPtr
)[*ElementCount
] = NewElement
;
290 } /* VOID AddListElement() */
292 VOID
FreeList(IN OUT VOID
***ListPtr
, IN OUT UINTN
*ElementCount
)
296 if ((*ElementCount
> 0) && (**ListPtr
!= NULL
)) {
297 for (i
= 0; i
< *ElementCount
; i
++) {
298 // TODO: call a user-provided routine for each element here
299 MyFreePool((*ListPtr
)[i
]);
301 MyFreePool(*ListPtr
);
306 // firmware device path discovery
309 static UINT8 LegacyLoaderMediaPathData
[] = {
310 0x04, 0x06, 0x14, 0x00, 0xEB, 0x85, 0x05, 0x2B,
311 0xB8, 0xD8, 0xA9, 0x49, 0x8B, 0x8C, 0xE2, 0x1B,
312 0x01, 0xAE, 0xF2, 0xB7, 0x7F, 0xFF, 0x04, 0x00,
314 static EFI_DEVICE_PATH
*LegacyLoaderMediaPath
= (EFI_DEVICE_PATH
*)LegacyLoaderMediaPathData
;
316 VOID
ExtractLegacyLoaderPaths(EFI_DEVICE_PATH
**PathList
, UINTN MaxPaths
, EFI_DEVICE_PATH
**HardcodedPathList
)
319 UINTN HandleCount
= 0;
320 UINTN HandleIndex
, HardcodedIndex
;
325 EFI_LOADED_IMAGE
*LoadedImage
;
326 EFI_DEVICE_PATH
*DevicePath
;
329 MaxPaths
--; // leave space for the terminating NULL pointer
331 // get all LoadedImage handles
332 Status
= LibLocateHandle(ByProtocol
, &LoadedImageProtocol
, NULL
, &HandleCount
, &Handles
);
333 if (CheckError(Status
, L
"while listing LoadedImage handles")) {
334 if (HardcodedPathList
) {
335 for (HardcodedIndex
= 0; HardcodedPathList
[HardcodedIndex
] && PathCount
< MaxPaths
; HardcodedIndex
++)
336 PathList
[PathCount
++] = HardcodedPathList
[HardcodedIndex
];
338 PathList
[PathCount
] = NULL
;
341 for (HandleIndex
= 0; HandleIndex
< HandleCount
&& PathCount
< MaxPaths
; HandleIndex
++) {
342 Handle
= Handles
[HandleIndex
];
344 Status
= refit_call3_wrapper(BS
->HandleProtocol
, Handle
, &LoadedImageProtocol
, (VOID
**) &LoadedImage
);
345 if (EFI_ERROR(Status
))
346 continue; // This can only happen if the firmware scewed up, ignore it.
348 Status
= refit_call3_wrapper(BS
->HandleProtocol
, LoadedImage
->DeviceHandle
, &DevicePathProtocol
, (VOID
**) &DevicePath
);
349 if (EFI_ERROR(Status
))
350 continue; // This happens, ignore it.
352 // Only grab memory range nodes
353 if (DevicePathType(DevicePath
) != HARDWARE_DEVICE_PATH
|| DevicePathSubType(DevicePath
) != HW_MEMMAP_DP
)
356 // Check if we have this device path in the list already
357 // WARNING: This assumes the first node in the device path is unique!
359 for (PathIndex
= 0; PathIndex
< PathCount
; PathIndex
++) {
360 if (DevicePathNodeLength(DevicePath
) != DevicePathNodeLength(PathList
[PathIndex
]))
362 if (CompareMem(DevicePath
, PathList
[PathIndex
], DevicePathNodeLength(DevicePath
)) == 0) {
370 PathList
[PathCount
++] = AppendDevicePath(DevicePath
, LegacyLoaderMediaPath
);
374 if (HardcodedPathList
) {
375 for (HardcodedIndex
= 0; HardcodedPathList
[HardcodedIndex
] && PathCount
< MaxPaths
; HardcodedIndex
++)
376 PathList
[PathCount
++] = HardcodedPathList
[HardcodedIndex
];
378 PathList
[PathCount
] = NULL
;
385 // Return a pointer to a string containing a filesystem type name. If the
386 // filesystem type is unknown, a blank (but non-null) string is returned.
387 // The returned variable is a constant that should NOT be freed.
388 static CHAR16
*FSTypeName(IN UINT32 TypeCode
) {
389 CHAR16
*retval
= NULL
;
395 case FS_TYPE_HFSPLUS
:
407 case FS_TYPE_REISERFS
:
408 retval
= L
" ReiserFS";
410 case FS_TYPE_ISO9660
:
411 retval
= L
" ISO-9660";
418 } // CHAR16 *FSTypeName()
420 // Identify the filesystem type, if possible. Expects a Buffer containing
421 // the first few (normally 4096) bytes of the filesystem, and outputs a
422 // code representing the identified filesystem type.
423 static UINT32
IdentifyFilesystemType(IN UINT8
*Buffer
, IN UINTN BufferSize
) {
424 UINT32 FoundType
= FS_TYPE_UNKNOWN
;
425 UINT32
*Ext2Incompat
, *Ext2Compat
;
429 if (Buffer
!= NULL
) {
431 if (BufferSize
>= 512) {
432 Magic16
= (UINT16
*) (Buffer
+ 510);
433 if (*Magic16
== FAT_MAGIC
)
435 } // search for FAT magic
437 if (BufferSize
>= (1024 + 100)) {
438 Magic16
= (UINT16
*) (Buffer
+ 1024 + 56);
439 if (*Magic16
== EXT2_SUPER_MAGIC
) { // ext2/3/4
440 Ext2Compat
= (UINT32
*) (Buffer
+ 1024 + 92);
441 Ext2Incompat
= (UINT32
*) (Buffer
+ 1024 + 96);
442 if ((*Ext2Incompat
& 0x0040) || (*Ext2Incompat
& 0x0200)) { // check for extents or flex_bg
444 } else if (*Ext2Compat
& 0x0004) { // check for journal
446 } else { // none of these features; presume it's ext2...
450 } // search for ext2/3/4 magic
452 if (BufferSize
>= (65536 + 62)) {
453 MagicString
= (char*) (Buffer
+ 65536 + 52);
454 if ((CompareMem(MagicString
, REISERFS_SUPER_MAGIC_STRING
, 8) == 0) ||
455 (CompareMem(MagicString
, REISER2FS_SUPER_MAGIC_STRING
, 9) == 0) ||
456 (CompareMem(MagicString
, REISER2FS_JR_SUPER_MAGIC_STRING
, 9) == 0)) {
457 return FS_TYPE_REISERFS
;
459 } // search for ReiserFS magic
461 if (BufferSize
>= (1024 + 2)) {
462 Magic16
= (UINT16
*) (Buffer
+ 1024);
463 if ((*Magic16
== HFSPLUS_MAGIC1
) || (*Magic16
== HFSPLUS_MAGIC2
)) {
464 return FS_TYPE_HFSPLUS
;
466 } // search for HFS+ magic
467 } // if (Buffer != NULL)
472 static VOID
ScanVolumeBootcode(REFIT_VOLUME
*Volume
, BOOLEAN
*Bootable
)
475 UINT8 Buffer
[SAMPLE_SIZE
];
477 MBR_PARTITION_INFO
*MbrTable
;
478 BOOLEAN MbrTableFound
;
480 Volume
->HasBootCode
= FALSE
;
481 Volume
->OSIconName
= NULL
;
482 Volume
->OSName
= NULL
;
485 if (Volume
->BlockIO
== NULL
)
487 if (Volume
->BlockIO
->Media
->BlockSize
> SAMPLE_SIZE
)
488 return; // our buffer is too small...
490 // look at the boot sector (this is used for both hard disks and El Torito images!)
491 Status
= refit_call5_wrapper(Volume
->BlockIO
->ReadBlocks
,
492 Volume
->BlockIO
, Volume
->BlockIO
->Media
->MediaId
,
493 Volume
->BlockIOOffset
, SAMPLE_SIZE
, Buffer
);
494 if (!EFI_ERROR(Status
)) {
496 Volume
->FSType
= IdentifyFilesystemType(Buffer
, SAMPLE_SIZE
);
497 if (*((UINT16
*)(Buffer
+ 510)) == 0xaa55 && Buffer
[0] != 0) {
499 Volume
->HasBootCode
= TRUE
;
502 // detect specific boot codes
503 if (CompareMem(Buffer
+ 2, "LILO", 4) == 0 ||
504 CompareMem(Buffer
+ 6, "LILO", 4) == 0 ||
505 CompareMem(Buffer
+ 3, "SYSLINUX", 8) == 0 ||
506 FindMem(Buffer
, SECTOR_SIZE
, "ISOLINUX", 8) >= 0) {
507 Volume
->HasBootCode
= TRUE
;
508 Volume
->OSIconName
= L
"linux";
509 Volume
->OSName
= L
"Linux";
511 } else if (FindMem(Buffer
, 512, "Geom\0Hard Disk\0Read\0 Error", 26) >= 0) { // GRUB
512 Volume
->HasBootCode
= TRUE
;
513 Volume
->OSIconName
= L
"grub,linux";
514 Volume
->OSName
= L
"Linux";
516 // // Below doesn't produce a bootable entry, so commented out for the moment....
517 // // GRUB in BIOS boot partition:
518 // } else if (FindMem(Buffer, 512, "Geom\0Read\0 Error", 16) >= 0) {
519 // Volume->HasBootCode = TRUE;
520 // Volume->OSIconName = L"grub,linux";
521 // Volume->OSName = L"Linux";
522 // Volume->VolName = L"BIOS Boot Partition";
525 } else if ((*((UINT32
*)(Buffer
+ 502)) == 0 &&
526 *((UINT32
*)(Buffer
+ 506)) == 50000 &&
527 *((UINT16
*)(Buffer
+ 510)) == 0xaa55) ||
528 FindMem(Buffer
, SECTOR_SIZE
, "Starting the BTX loader", 23) >= 0) {
529 Volume
->HasBootCode
= TRUE
;
530 Volume
->OSIconName
= L
"freebsd";
531 Volume
->OSName
= L
"FreeBSD";
533 } else if (FindMem(Buffer
, 512, "!Loading", 8) >= 0 ||
534 FindMem(Buffer
, SECTOR_SIZE
, "/cdboot\0/CDBOOT\0", 16) >= 0) {
535 Volume
->HasBootCode
= TRUE
;
536 Volume
->OSIconName
= L
"openbsd";
537 Volume
->OSName
= L
"OpenBSD";
539 } else if (FindMem(Buffer
, 512, "Not a bootxx image", 18) >= 0 ||
540 *((UINT32
*)(Buffer
+ 1028)) == 0x7886b6d1) {
541 Volume
->HasBootCode
= TRUE
;
542 Volume
->OSIconName
= L
"netbsd";
543 Volume
->OSName
= L
"NetBSD";
545 } else if (FindMem(Buffer
, SECTOR_SIZE
, "NTLDR", 5) >= 0) {
546 Volume
->HasBootCode
= TRUE
;
547 Volume
->OSIconName
= L
"win";
548 Volume
->OSName
= L
"Windows";
550 } else if (FindMem(Buffer
, SECTOR_SIZE
, "BOOTMGR", 7) >= 0) {
551 Volume
->HasBootCode
= TRUE
;
552 Volume
->OSIconName
= L
"winvista,win";
553 Volume
->OSName
= L
"Windows";
555 } else if (FindMem(Buffer
, 512, "CPUBOOT SYS", 11) >= 0 ||
556 FindMem(Buffer
, 512, "KERNEL SYS", 11) >= 0) {
557 Volume
->HasBootCode
= TRUE
;
558 Volume
->OSIconName
= L
"freedos";
559 Volume
->OSName
= L
"FreeDOS";
561 } else if (FindMem(Buffer
, 512, "OS2LDR", 6) >= 0 ||
562 FindMem(Buffer
, 512, "OS2BOOT", 7) >= 0) {
563 Volume
->HasBootCode
= TRUE
;
564 Volume
->OSIconName
= L
"ecomstation";
565 Volume
->OSName
= L
"eComStation";
567 } else if (FindMem(Buffer
, 512, "Be Boot Loader", 14) >= 0) {
568 Volume
->HasBootCode
= TRUE
;
569 Volume
->OSIconName
= L
"beos";
570 Volume
->OSName
= L
"BeOS";
572 } else if (FindMem(Buffer
, 512, "yT Boot Loader", 14) >= 0) {
573 Volume
->HasBootCode
= TRUE
;
574 Volume
->OSIconName
= L
"zeta,beos";
575 Volume
->OSName
= L
"ZETA";
577 } else if (FindMem(Buffer
, 512, "\x04" "beos\x06" "system\x05" "zbeos", 18) >= 0 ||
578 FindMem(Buffer
, 512, "\x06" "system\x0c" "haiku_loader", 20) >= 0) {
579 Volume
->HasBootCode
= TRUE
;
580 Volume
->OSIconName
= L
"haiku,beos";
581 Volume
->OSName
= L
"Haiku";
585 // NOTE: If you add an operating system with a name that starts with 'W' or 'L', you
586 // need to fix AddLegacyEntry in main.c.
589 Print(L
" Result of bootcode detection: %s %s (%s)\n",
590 Volume
->HasBootCode
? L
"bootable" : L
"non-bootable",
591 Volume
->OSName
, Volume
->OSIconName
);
594 // dummy FAT boot sector (created by OS X's newfs_msdos)
595 if (FindMem(Buffer
, 512, "Non-system disk", 15) >= 0)
596 Volume
->HasBootCode
= FALSE
;
598 // dummy FAT boot sector (created by Linux's mkdosfs)
599 if (FindMem(Buffer
, 512, "This is not a bootable disk", 27) >= 0)
600 Volume
->HasBootCode
= FALSE
;
602 // dummy FAT boot sector (created by Windows)
603 if (FindMem(Buffer
, 512, "Press any key to restart", 24) >= 0)
604 Volume
->HasBootCode
= FALSE
;
606 // check for MBR partition table
607 if (*((UINT16
*)(Buffer
+ 510)) == 0xaa55) {
608 MbrTableFound
= FALSE
;
609 MbrTable
= (MBR_PARTITION_INFO
*)(Buffer
+ 446);
610 for (i
= 0; i
< 4; i
++)
611 if (MbrTable
[i
].StartLBA
&& MbrTable
[i
].Size
)
612 MbrTableFound
= TRUE
;
613 for (i
= 0; i
< 4; i
++)
614 if (MbrTable
[i
].Flags
!= 0x00 && MbrTable
[i
].Flags
!= 0x80)
615 MbrTableFound
= FALSE
;
617 Volume
->MbrPartitionTable
= AllocatePool(4 * 16);
618 CopyMem(Volume
->MbrPartitionTable
, MbrTable
, 4 * 16);
624 CheckError(Status
, L
"while reading boot sector");
627 } /* VOID ScanVolumeBootcode() */
629 // default volume badge icon based on disk kind
630 static VOID
ScanVolumeDefaultIcon(IN OUT REFIT_VOLUME
*Volume
)
632 switch (Volume
->DiskKind
) {
633 case DISK_KIND_INTERNAL
:
634 Volume
->VolBadgeImage
= BuiltinIcon(BUILTIN_ICON_VOL_INTERNAL
);
636 case DISK_KIND_EXTERNAL
:
637 Volume
->VolBadgeImage
= BuiltinIcon(BUILTIN_ICON_VOL_EXTERNAL
);
639 case DISK_KIND_OPTICAL
:
640 Volume
->VolBadgeImage
= BuiltinIcon(BUILTIN_ICON_VOL_OPTICAL
);
645 // Return a string representing the input size in IEEE-1541 units.
646 // The calling function is responsible for freeing the allocated memory.
647 static CHAR16
*SizeInIEEEUnits(UINT64 SizeInBytes
) {
649 UINTN Index
= 0, NumPrefixes
;
650 CHAR16
*Units
, *Prefixes
= L
" KMGTPEZ";
653 TheValue
= AllocateZeroPool(sizeof(CHAR16
) * 256);
654 if (TheValue
!= NULL
) {
655 NumPrefixes
= StrLen(Prefixes
);
656 SizeInIeee
= SizeInBytes
;
657 while ((SizeInIeee
> 1024) && (Index
< (NumPrefixes
- 1))) {
661 if (Prefixes
[Index
] == ' ') {
662 Units
= StrDuplicate(L
"-byte");
664 Units
= StrDuplicate(L
" iB");
665 Units
[1] = Prefixes
[Index
];
667 SPrint(TheValue
, 255, L
"%ld%s", SizeInIeee
, Units
);
670 } // CHAR16 *SizeInSIUnits()
672 // Return a name for the volume. Ideally this should be the label for the
673 // filesystem it contains, but this function falls back to describing the
674 // filesystem by size (200 MiB, etc.) and/or type (ext2, HFS+, etc.), if
675 // this information can be extracted.
676 // The calling function is responsible for freeing the memory allocated
677 // for the name string.
678 static CHAR16
*GetVolumeName(IN REFIT_VOLUME
*Volume
) {
679 EFI_FILE_SYSTEM_INFO
*FileSystemInfoPtr
;
680 CHAR16
*FoundName
= NULL
;
681 CHAR16
*SISize
, *TypeName
;
683 FileSystemInfoPtr
= LibFileSystemInfo(Volume
->RootDir
);
684 if (FileSystemInfoPtr
!= NULL
) { // we have filesystem information (size, label)....
685 if ((FileSystemInfoPtr
->VolumeLabel
!= NULL
) && (StrLen(FileSystemInfoPtr
->VolumeLabel
) > 0)) {
686 FoundName
= StrDuplicate(FileSystemInfoPtr
->VolumeLabel
);
689 // Special case: rEFInd HFS+ driver always returns label of "HFS+ volume", so wipe
690 // this so that we can build a new name that includes the size....
691 if ((FoundName
!= NULL
) && (StrCmp(FoundName
, L
"HFS+ volume") == 0) && (Volume
->FSType
== FS_TYPE_HFSPLUS
)) {
692 MyFreePool(FoundName
);
694 } // if rEFInd HFS+ driver suspected
696 if (FoundName
== NULL
) { // filesystem has no name, so use fs type and size
697 FoundName
= AllocateZeroPool(sizeof(CHAR16
) * 256);
698 if (FoundName
!= NULL
) {
699 SISize
= SizeInIEEEUnits(FileSystemInfoPtr
->VolumeSize
);
700 SPrint(FoundName
, 255, L
"%s%s volume", SISize
, FSTypeName(Volume
->FSType
));
702 } // if allocated memory OK
703 } // if (FoundName == NULL)
705 FreePool(FileSystemInfoPtr
);
707 } else { // fs driver not returning info; fall back on our own information....
708 FoundName
= AllocateZeroPool(sizeof(CHAR16
) * 256);
709 if (FoundName
!= NULL
) {
710 TypeName
= FSTypeName(Volume
->FSType
); // NOTE: Don't free TypeName; function returns constant
711 if (StrLen(TypeName
) > 0)
712 SPrint(FoundName
, 255, L
"%s volume", FSTypeName(Volume
->FSType
));
714 SPrint(FoundName
, 255, L
"unknown volume");
715 } // if allocated memory OK
718 // TODO: Above could be improved/extended, in case filesystem name is not found,
720 // - use partition label
721 // - use or add disk/partition number (e.g., "(hd0,2)")
723 // Desperate fallback name....
724 if (FoundName
== NULL
) {
725 FoundName
= StrDuplicate(L
"unknown volume");
728 } // static CHAR16 *GetVolumeName()
730 VOID
ScanVolume(REFIT_VOLUME
*Volume
)
733 EFI_DEVICE_PATH
*DevicePath
, *NextDevicePath
;
734 EFI_DEVICE_PATH
*DiskDevicePath
, *RemainingDevicePath
;
735 EFI_HANDLE WholeDiskHandle
;
740 Volume
->DevicePath
= DuplicateDevicePath(DevicePathFromHandle(Volume
->DeviceHandle
));
742 if (Volume
->DevicePath
!= NULL
) {
743 Print(L
"* %s\n", DevicePathToStr(Volume
->DevicePath
));
745 DumpHex(1, 0, DevicePathSize(Volume
->DevicePath
), Volume
->DevicePath
);
750 Volume
->DiskKind
= DISK_KIND_INTERNAL
; // default
753 Status
= refit_call3_wrapper(BS
->HandleProtocol
, Volume
->DeviceHandle
, &BlockIoProtocol
, (VOID
**) &(Volume
->BlockIO
));
754 if (EFI_ERROR(Status
)) {
755 Volume
->BlockIO
= NULL
;
756 Print(L
"Warning: Can't get BlockIO protocol.\n");
758 if (Volume
->BlockIO
->Media
->BlockSize
== 2048)
759 Volume
->DiskKind
= DISK_KIND_OPTICAL
;
762 // scan for bootcode and MBR table
764 ScanVolumeBootcode(Volume
, &Bootable
);
766 // detect device type
767 DevicePath
= Volume
->DevicePath
;
768 while (DevicePath
!= NULL
&& !IsDevicePathEndType(DevicePath
)) {
769 NextDevicePath
= NextDevicePathNode(DevicePath
);
771 if (DevicePathType(DevicePath
) == MESSAGING_DEVICE_PATH
&&
772 (DevicePathSubType(DevicePath
) == MSG_USB_DP
||
773 DevicePathSubType(DevicePath
) == MSG_USB_CLASS_DP
||
774 DevicePathSubType(DevicePath
) == MSG_1394_DP
||
775 DevicePathSubType(DevicePath
) == MSG_FIBRECHANNEL_DP
))
776 Volume
->DiskKind
= DISK_KIND_EXTERNAL
; // USB/FireWire/FC device -> external
777 if (DevicePathType(DevicePath
) == MEDIA_DEVICE_PATH
&&
778 DevicePathSubType(DevicePath
) == MEDIA_CDROM_DP
) {
779 Volume
->DiskKind
= DISK_KIND_OPTICAL
; // El Torito entry -> optical disk
783 if (DevicePathType(DevicePath
) == MEDIA_DEVICE_PATH
&& DevicePathSubType(DevicePath
) == MEDIA_VENDOR_DP
) {
784 Volume
->IsAppleLegacy
= TRUE
; // legacy BIOS device entry
785 // TODO: also check for Boot Camp GUID
786 Bootable
= FALSE
; // this handle's BlockIO is just an alias for the whole device
789 if (DevicePathType(DevicePath
) == MESSAGING_DEVICE_PATH
) {
790 // make a device path for the whole device
791 PartialLength
= (UINT8
*)NextDevicePath
- (UINT8
*)(Volume
->DevicePath
);
792 DiskDevicePath
= (EFI_DEVICE_PATH
*)AllocatePool(PartialLength
+ sizeof(EFI_DEVICE_PATH
));
793 CopyMem(DiskDevicePath
, Volume
->DevicePath
, PartialLength
);
794 CopyMem((UINT8
*)DiskDevicePath
+ PartialLength
, EndDevicePath
, sizeof(EFI_DEVICE_PATH
));
796 // get the handle for that path
797 RemainingDevicePath
= DiskDevicePath
;
798 Status
= refit_call3_wrapper(BS
->LocateDevicePath
, &BlockIoProtocol
, &RemainingDevicePath
, &WholeDiskHandle
);
799 FreePool(DiskDevicePath
);
801 if (!EFI_ERROR(Status
)) {
802 //Print(L" - original handle: %08x - disk handle: %08x\n", (UINT32)DeviceHandle, (UINT32)WholeDiskHandle);
804 // get the device path for later
805 Status
= refit_call3_wrapper(BS
->HandleProtocol
, WholeDiskHandle
, &DevicePathProtocol
, (VOID
**) &DiskDevicePath
);
806 if (!EFI_ERROR(Status
)) {
807 Volume
->WholeDiskDevicePath
= DuplicateDevicePath(DiskDevicePath
);
810 // look at the BlockIO protocol
811 Status
= refit_call3_wrapper(BS
->HandleProtocol
, WholeDiskHandle
, &BlockIoProtocol
, (VOID
**) &Volume
->WholeDiskBlockIO
);
812 if (!EFI_ERROR(Status
)) {
814 // check the media block size
815 if (Volume
->WholeDiskBlockIO
->Media
->BlockSize
== 2048)
816 Volume
->DiskKind
= DISK_KIND_OPTICAL
;
819 Volume
->WholeDiskBlockIO
= NULL
;
820 //CheckError(Status, L"from HandleProtocol");
823 // CheckError(Status, L"from LocateDevicePath");
826 DevicePath
= NextDevicePath
;
831 if (Volume
->HasBootCode
)
832 Print(L
" Volume considered non-bootable, but boot code is present\n");
834 Volume
->HasBootCode
= FALSE
;
837 // default volume icon based on disk kind
838 ScanVolumeDefaultIcon(Volume
);
840 // open the root directory of the volume
841 Volume
->RootDir
= LibOpenRoot(Volume
->DeviceHandle
);
842 if (Volume
->RootDir
== NULL
) {
843 Volume
->IsReadable
= FALSE
;
846 Volume
->IsReadable
= TRUE
;
849 Volume
->VolName
= GetVolumeName(Volume
);
851 // get custom volume icon if present
852 if (FileExists(Volume
->RootDir
, VOLUME_BADGE_NAME
))
853 Volume
->VolBadgeImage
= LoadIcns(Volume
->RootDir
, VOLUME_BADGE_NAME
, 32);
854 if (FileExists(Volume
->RootDir
, VOLUME_ICON_NAME
)) {
855 Volume
->VolIconImage
= LoadIcns(Volume
->RootDir
, VOLUME_ICON_NAME
, 128);
859 static VOID
ScanExtendedPartition(REFIT_VOLUME
*WholeDiskVolume
, MBR_PARTITION_INFO
*MbrEntry
)
862 REFIT_VOLUME
*Volume
;
863 UINT32 ExtBase
, ExtCurrent
, NextExtCurrent
;
865 UINTN LogicalPartitionIndex
= 4;
866 UINT8 SectorBuffer
[512];
868 MBR_PARTITION_INFO
*EMbrTable
;
870 ExtBase
= MbrEntry
->StartLBA
;
872 for (ExtCurrent
= ExtBase
; ExtCurrent
; ExtCurrent
= NextExtCurrent
) {
874 Status
= refit_call5_wrapper(WholeDiskVolume
->BlockIO
->ReadBlocks
,
875 WholeDiskVolume
->BlockIO
,
876 WholeDiskVolume
->BlockIO
->Media
->MediaId
,
877 ExtCurrent
, 512, SectorBuffer
);
878 if (EFI_ERROR(Status
))
880 if (*((UINT16
*)(SectorBuffer
+ 510)) != 0xaa55)
882 EMbrTable
= (MBR_PARTITION_INFO
*)(SectorBuffer
+ 446);
884 // scan logical partitions in this EMBR
886 for (i
= 0; i
< 4; i
++) {
887 if ((EMbrTable
[i
].Flags
!= 0x00 && EMbrTable
[i
].Flags
!= 0x80) ||
888 EMbrTable
[i
].StartLBA
== 0 || EMbrTable
[i
].Size
== 0)
890 if (IS_EXTENDED_PART_TYPE(EMbrTable
[i
].Type
)) {
891 // set next ExtCurrent
892 NextExtCurrent
= ExtBase
+ EMbrTable
[i
].StartLBA
;
896 // found a logical partition
897 Volume
= AllocateZeroPool(sizeof(REFIT_VOLUME
));
898 Volume
->DiskKind
= WholeDiskVolume
->DiskKind
;
899 Volume
->IsMbrPartition
= TRUE
;
900 Volume
->MbrPartitionIndex
= LogicalPartitionIndex
++;
901 Volume
->VolName
= AllocateZeroPool(256 * sizeof(UINT16
));
902 SPrint(Volume
->VolName
, 255, L
"Partition %d", Volume
->MbrPartitionIndex
+ 1);
903 Volume
->BlockIO
= WholeDiskVolume
->BlockIO
;
904 Volume
->BlockIOOffset
= ExtCurrent
+ EMbrTable
[i
].StartLBA
;
905 Volume
->WholeDiskBlockIO
= WholeDiskVolume
->BlockIO
;
908 ScanVolumeBootcode(Volume
, &Bootable
);
910 Volume
->HasBootCode
= FALSE
;
912 ScanVolumeDefaultIcon(Volume
);
914 AddListElement((VOID
***) &Volumes
, &VolumesCount
, Volume
);
919 } /* VOID ScanExtendedPartition() */
921 VOID
ScanVolumes(VOID
)
924 UINTN HandleCount
= 0;
927 REFIT_VOLUME
*Volume
, *WholeDiskVolume
;
928 UINTN VolumeIndex
, VolumeIndex2
;
929 MBR_PARTITION_INFO
*MbrTable
;
930 UINTN PartitionIndex
;
931 UINT8
*SectorBuffer1
, *SectorBuffer2
;
932 UINTN SectorSum
, i
, VolNumber
= 0;
938 // get all filesystem handles
939 Status
= LibLocateHandle(ByProtocol
, &BlockIoProtocol
, NULL
, &HandleCount
, &Handles
);
940 // was: &FileSystemProtocol
941 if (Status
== EFI_NOT_FOUND
) {
942 return; // no filesystems. strange, but true...
944 if (CheckError(Status
, L
"while listing all file systems"))
947 // first pass: collect information about all handles
948 for (HandleIndex
= 0; HandleIndex
< HandleCount
; HandleIndex
++) {
949 Volume
= AllocateZeroPool(sizeof(REFIT_VOLUME
));
950 Volume
->DeviceHandle
= Handles
[HandleIndex
];
952 if (Volume
->IsReadable
)
953 Volume
->VolNumber
= VolNumber
++;
955 AddListElement((VOID
***) &Volumes
, &VolumesCount
, Volume
);
957 if (Volume
->DeviceHandle
== SelfLoadedImage
->DeviceHandle
)
962 if (SelfVolume
== NULL
)
963 Print(L
"WARNING: SelfVolume not found");
965 // second pass: relate partitions and whole disk devices
966 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
967 Volume
= Volumes
[VolumeIndex
];
968 // check MBR partition table for extended partitions
969 if (Volume
->BlockIO
!= NULL
&& Volume
->WholeDiskBlockIO
!= NULL
&&
970 Volume
->BlockIO
== Volume
->WholeDiskBlockIO
&& Volume
->BlockIOOffset
== 0 &&
971 Volume
->MbrPartitionTable
!= NULL
) {
972 MbrTable
= Volume
->MbrPartitionTable
;
973 for (PartitionIndex
= 0; PartitionIndex
< 4; PartitionIndex
++) {
974 if (IS_EXTENDED_PART_TYPE(MbrTable
[PartitionIndex
].Type
)) {
975 ScanExtendedPartition(Volume
, MbrTable
+ PartitionIndex
);
980 // search for corresponding whole disk volume entry
981 WholeDiskVolume
= NULL
;
982 if (Volume
->BlockIO
!= NULL
&& Volume
->WholeDiskBlockIO
!= NULL
&&
983 Volume
->BlockIO
!= Volume
->WholeDiskBlockIO
) {
984 for (VolumeIndex2
= 0; VolumeIndex2
< VolumesCount
; VolumeIndex2
++) {
985 if (Volumes
[VolumeIndex2
]->BlockIO
== Volume
->WholeDiskBlockIO
&&
986 Volumes
[VolumeIndex2
]->BlockIOOffset
== 0)
987 WholeDiskVolume
= Volumes
[VolumeIndex2
];
991 if (WholeDiskVolume
!= NULL
&& WholeDiskVolume
->MbrPartitionTable
!= NULL
) {
992 // check if this volume is one of the partitions in the table
993 MbrTable
= WholeDiskVolume
->MbrPartitionTable
;
994 SectorBuffer1
= AllocatePool(512);
995 SectorBuffer2
= AllocatePool(512);
996 for (PartitionIndex
= 0; PartitionIndex
< 4; PartitionIndex
++) {
998 if ((UINT64
)(MbrTable
[PartitionIndex
].Size
) != Volume
->BlockIO
->Media
->LastBlock
+ 1)
1001 // compare boot sector read through offset vs. directly
1002 Status
= refit_call5_wrapper(Volume
->BlockIO
->ReadBlocks
,
1003 Volume
->BlockIO
, Volume
->BlockIO
->Media
->MediaId
,
1004 Volume
->BlockIOOffset
, 512, SectorBuffer1
);
1005 if (EFI_ERROR(Status
))
1007 Status
= refit_call5_wrapper(Volume
->WholeDiskBlockIO
->ReadBlocks
,
1008 Volume
->WholeDiskBlockIO
, Volume
->WholeDiskBlockIO
->Media
->MediaId
,
1009 MbrTable
[PartitionIndex
].StartLBA
, 512, SectorBuffer2
);
1010 if (EFI_ERROR(Status
))
1012 if (CompareMem(SectorBuffer1
, SectorBuffer2
, 512) != 0)
1015 for (i
= 0; i
< 512; i
++)
1016 SectorSum
+= SectorBuffer1
[i
];
1017 if (SectorSum
< 1000)
1020 // TODO: mark entry as non-bootable if it is an extended partition
1022 // now we're reasonably sure the association is correct...
1023 Volume
->IsMbrPartition
= TRUE
;
1024 Volume
->MbrPartitionIndex
= PartitionIndex
;
1025 if (Volume
->VolName
== NULL
) {
1026 Volume
->VolName
= AllocateZeroPool(sizeof(CHAR16
) * 256);
1027 SPrint(Volume
->VolName
, 255, L
"Partition %d", PartitionIndex
+ 1);
1032 MyFreePool(SectorBuffer1
);
1033 MyFreePool(SectorBuffer2
);
1037 } /* VOID ScanVolumes() */
1039 static VOID
UninitVolumes(VOID
)
1041 REFIT_VOLUME
*Volume
;
1044 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
1045 Volume
= Volumes
[VolumeIndex
];
1047 if (Volume
->RootDir
!= NULL
) {
1048 refit_call1_wrapper(Volume
->RootDir
->Close
, Volume
->RootDir
);
1049 Volume
->RootDir
= NULL
;
1052 Volume
->DeviceHandle
= NULL
;
1053 Volume
->BlockIO
= NULL
;
1054 Volume
->WholeDiskBlockIO
= NULL
;
1058 VOID
ReinitVolumes(VOID
)
1061 REFIT_VOLUME
*Volume
;
1063 EFI_DEVICE_PATH
*RemainingDevicePath
;
1064 EFI_HANDLE DeviceHandle
, WholeDiskHandle
;
1066 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
1067 Volume
= Volumes
[VolumeIndex
];
1069 if (Volume
->DevicePath
!= NULL
) {
1070 // get the handle for that path
1071 RemainingDevicePath
= Volume
->DevicePath
;
1072 Status
= refit_call3_wrapper(BS
->LocateDevicePath
, &BlockIoProtocol
, &RemainingDevicePath
, &DeviceHandle
);
1074 if (!EFI_ERROR(Status
)) {
1075 Volume
->DeviceHandle
= DeviceHandle
;
1077 // get the root directory
1078 Volume
->RootDir
= LibOpenRoot(Volume
->DeviceHandle
);
1081 CheckError(Status
, L
"from LocateDevicePath");
1084 if (Volume
->WholeDiskDevicePath
!= NULL
) {
1085 // get the handle for that path
1086 RemainingDevicePath
= Volume
->WholeDiskDevicePath
;
1087 Status
= refit_call3_wrapper(BS
->LocateDevicePath
, &BlockIoProtocol
, &RemainingDevicePath
, &WholeDiskHandle
);
1089 if (!EFI_ERROR(Status
)) {
1090 // get the BlockIO protocol
1091 Status
= refit_call3_wrapper(BS
->HandleProtocol
, WholeDiskHandle
, &BlockIoProtocol
, (VOID
**) &Volume
->WholeDiskBlockIO
);
1092 if (EFI_ERROR(Status
)) {
1093 Volume
->WholeDiskBlockIO
= NULL
;
1094 CheckError(Status
, L
"from HandleProtocol");
1097 CheckError(Status
, L
"from LocateDevicePath");
1103 // file and dir functions
1106 BOOLEAN
FileExists(IN EFI_FILE
*BaseDir
, IN CHAR16
*RelativePath
)
1109 EFI_FILE_HANDLE TestFile
;
1111 Status
= refit_call5_wrapper(BaseDir
->Open
, BaseDir
, &TestFile
, RelativePath
, EFI_FILE_MODE_READ
, 0);
1112 if (Status
== EFI_SUCCESS
) {
1113 refit_call1_wrapper(TestFile
->Close
, TestFile
);
1119 EFI_STATUS
DirNextEntry(IN EFI_FILE
*Directory
, IN OUT EFI_FILE_INFO
**DirEntry
, IN UINTN FilterMode
)
1123 UINTN LastBufferSize
, BufferSize
;
1128 // free pointer from last call
1129 if (*DirEntry
!= NULL
) {
1130 FreePool(*DirEntry
);
1134 // read next directory entry
1135 LastBufferSize
= BufferSize
= 256;
1136 Buffer
= AllocatePool(BufferSize
);
1137 for (IterCount
= 0; ; IterCount
++) {
1138 Status
= refit_call3_wrapper(Directory
->Read
, Directory
, &BufferSize
, Buffer
);
1139 if (Status
!= EFI_BUFFER_TOO_SMALL
|| IterCount
>= 4)
1141 if (BufferSize
<= LastBufferSize
) {
1142 Print(L
"FS Driver requests bad buffer size %d (was %d), using %d instead\n", BufferSize
, LastBufferSize
, LastBufferSize
* 2);
1143 BufferSize
= LastBufferSize
* 2;
1146 Print(L
"Reallocating buffer from %d to %d\n", LastBufferSize
, BufferSize
);
1149 Buffer
= EfiReallocatePool(Buffer
, LastBufferSize
, BufferSize
);
1150 LastBufferSize
= BufferSize
;
1152 if (EFI_ERROR(Status
)) {
1157 // check for end of listing
1158 if (BufferSize
== 0) { // end of directory listing
1163 // entry is ready to be returned
1164 *DirEntry
= (EFI_FILE_INFO
*)Buffer
;
1167 if (FilterMode
== 1) { // only return directories
1168 if (((*DirEntry
)->Attribute
& EFI_FILE_DIRECTORY
))
1170 } else if (FilterMode
== 2) { // only return files
1171 if (((*DirEntry
)->Attribute
& EFI_FILE_DIRECTORY
) == 0)
1173 } else // no filter or unknown filter -> return everything
1180 VOID
DirIterOpen(IN EFI_FILE
*BaseDir
, IN CHAR16
*RelativePath OPTIONAL
, OUT REFIT_DIR_ITER
*DirIter
)
1182 if (RelativePath
== NULL
) {
1183 DirIter
->LastStatus
= EFI_SUCCESS
;
1184 DirIter
->DirHandle
= BaseDir
;
1185 DirIter
->CloseDirHandle
= FALSE
;
1187 DirIter
->LastStatus
= refit_call5_wrapper(BaseDir
->Open
, BaseDir
, &(DirIter
->DirHandle
), RelativePath
, EFI_FILE_MODE_READ
, 0);
1188 DirIter
->CloseDirHandle
= EFI_ERROR(DirIter
->LastStatus
) ? FALSE
: TRUE
;
1190 DirIter
->LastFileInfo
= NULL
;
1193 #ifndef __MAKEWITH_GNUEFI
1194 EFI_UNICODE_COLLATION_PROTOCOL
*mUnicodeCollation
= NULL
;
1197 InitializeUnicodeCollationProtocol (VOID
)
1201 if (mUnicodeCollation
!= NULL
) {
1206 // BUGBUG: Proper impelmentation is to locate all Unicode Collation Protocol
1207 // instances first and then select one which support English language.
1208 // Current implementation just pick the first instance.
1210 Status
= gBS
->LocateProtocol (
1211 &gEfiUnicodeCollation2ProtocolGuid
,
1213 (VOID
**) &mUnicodeCollation
1215 if (EFI_ERROR(Status
)) {
1216 Status
= gBS
->LocateProtocol (
1217 &gEfiUnicodeCollationProtocolGuid
,
1219 (VOID
**) &mUnicodeCollation
1227 MetaiMatch (IN CHAR16
*String
, IN CHAR16
*Pattern
)
1229 if (!mUnicodeCollation
) {
1230 InitializeUnicodeCollationProtocol();
1232 if (mUnicodeCollation
)
1233 return mUnicodeCollation
->MetaiMatch (mUnicodeCollation
, String
, Pattern
);
1234 return FALSE
; // Shouldn't happen
1237 static VOID
StrLwr (IN OUT CHAR16
*Str
) {
1238 if (!mUnicodeCollation
) {
1239 InitializeUnicodeCollationProtocol();
1241 if (mUnicodeCollation
)
1242 mUnicodeCollation
->StrLwr (mUnicodeCollation
, Str
);
1247 BOOLEAN
DirIterNext(IN OUT REFIT_DIR_ITER
*DirIter
, IN UINTN FilterMode
, IN CHAR16
*FilePattern OPTIONAL
,
1248 OUT EFI_FILE_INFO
**DirEntry
)
1250 BOOLEAN KeepGoing
= TRUE
;
1254 if (DirIter
->LastFileInfo
!= NULL
) {
1255 FreePool(DirIter
->LastFileInfo
);
1256 DirIter
->LastFileInfo
= NULL
;
1259 if (EFI_ERROR(DirIter
->LastStatus
))
1260 return FALSE
; // stop iteration
1263 DirIter
->LastStatus
= DirNextEntry(DirIter
->DirHandle
, &(DirIter
->LastFileInfo
), FilterMode
);
1264 if (EFI_ERROR(DirIter
->LastStatus
))
1266 if (DirIter
->LastFileInfo
== NULL
) // end of listing
1268 if (FilePattern
!= NULL
) {
1269 if ((DirIter
->LastFileInfo
->Attribute
& EFI_FILE_DIRECTORY
))
1272 while (KeepGoing
&& (OnePattern
= FindCommaDelimited(FilePattern
, i
++)) != NULL
) {
1273 if (MetaiMatch(DirIter
->LastFileInfo
->FileName
, OnePattern
))
1276 // else continue loop
1279 } while (KeepGoing
);
1281 *DirEntry
= DirIter
->LastFileInfo
;
1285 EFI_STATUS
DirIterClose(IN OUT REFIT_DIR_ITER
*DirIter
)
1287 if (DirIter
->LastFileInfo
!= NULL
) {
1288 FreePool(DirIter
->LastFileInfo
);
1289 DirIter
->LastFileInfo
= NULL
;
1291 if (DirIter
->CloseDirHandle
)
1292 refit_call1_wrapper(DirIter
->DirHandle
->Close
, DirIter
->DirHandle
);
1293 return DirIter
->LastStatus
;
1297 // file name manipulation
1300 // Returns the filename portion (minus path name) of the
1302 CHAR16
* Basename(IN CHAR16
*Path
)
1310 for (i
= StrLen(Path
); i
> 0; i
--) {
1311 if (Path
[i
-1] == '\\' || Path
[i
-1] == '/') {
1312 FileName
= Path
+ i
;
1321 // Replaces a filename extension of ".efi" with the specified string
1322 // (Extension). If the input Path doesn't end in ".efi", Extension
1323 // is added to the existing filename.
1324 VOID
ReplaceEfiExtension(IN OUT CHAR16
*Path
, IN CHAR16
*Extension
)
1328 PathLen
= StrLen(Path
);
1329 // Note: Do StriCmp() twice to work around Gigabyte Hybrid EFI case-sensitivity bug....
1330 if ((PathLen
>= 4) && ((StriCmp(&Path
[PathLen
- 4], L
".efi") == 0) || (StriCmp(&Path
[PathLen
- 4], L
".EFI") == 0))) {
1331 Path
[PathLen
- 4] = 0;
1333 StrCat(Path
, Extension
);
1334 } // VOID ReplaceEfiExtension()
1337 // memory string search
1340 INTN
FindMem(IN VOID
*Buffer
, IN UINTN BufferLength
, IN VOID
*SearchString
, IN UINTN SearchStringLength
)
1346 BufferLength
-= SearchStringLength
;
1347 for (Offset
= 0; Offset
< BufferLength
; Offset
++, BufferPtr
++) {
1348 if (CompareMem(BufferPtr
, SearchString
, SearchStringLength
) == 0)
1349 return (INTN
)Offset
;
1355 // Performs a case-insensitive search of BigStr for SmallStr.
1356 // Returns TRUE if found, FALSE if not.
1357 BOOLEAN
StriSubCmp(IN CHAR16
*SmallStr
, IN CHAR16
*BigStr
) {
1358 CHAR16
*SmallCopy
, *BigCopy
;
1359 BOOLEAN Found
= FALSE
;
1360 UINTN StartPoint
= 0, NumCompares
= 0, SmallLen
= 0;
1362 if ((SmallStr
!= NULL
) && (BigStr
!= NULL
) && (StrLen(BigStr
) >= StrLen(SmallStr
))) {
1363 SmallCopy
= StrDuplicate(SmallStr
);
1364 BigCopy
= StrDuplicate(BigStr
);
1367 SmallLen
= StrLen(SmallCopy
);
1368 NumCompares
= StrLen(BigCopy
) - SmallLen
+ 1;
1369 while ((!Found
) && (StartPoint
< NumCompares
)) {
1370 Found
= (StrnCmp(SmallCopy
, &BigCopy
[StartPoint
++], SmallLen
) == 0);
1372 MyFreePool(SmallCopy
);
1373 MyFreePool(BigCopy
);
1377 } // BOOLEAN StriSubCmp()
1379 // Merges two strings, creating a new one and returning a pointer to it.
1380 // If AddChar != 0, the specified character is placed between the two original
1381 // strings (unless the first string is NULL or empty). The original input
1382 // string *First is de-allocated and replaced by the new merged string.
1383 // This is similar to StrCat, but safer and more flexible because
1384 // MergeStrings allocates memory that's the correct size for the
1385 // new merged string, so it can take a NULL *First and it cleans
1386 // up the old memory. It should *NOT* be used with a constant
1387 // *First, though....
1388 VOID
MergeStrings(IN OUT CHAR16
**First
, IN CHAR16
*Second
, CHAR16 AddChar
) {
1389 UINTN Length1
= 0, Length2
= 0;
1393 Length1
= StrLen(*First
);
1395 Length2
= StrLen(Second
);
1396 NewString
= AllocatePool(sizeof(CHAR16
) * (Length1
+ Length2
+ 2));
1397 if (NewString
!= NULL
) {
1398 if ((*First
!= NULL
) && (StrLen(*First
) == 0)) {
1402 NewString
[0] = L
'\0';
1403 if (*First
!= NULL
) {
1404 StrCat(NewString
, *First
);
1406 NewString
[Length1
] = AddChar
;
1407 NewString
[Length1
+ 1] = '\0';
1409 } // if (*First != NULL)
1411 StrCat(NewString
, Second
);
1415 Print(L
"Error! Unable to allocate memory in MergeStrings()!\n");
1417 } // static CHAR16* MergeStrings()
1419 // Takes an input pathname (*Path) and returns the part of the filename from
1420 // the final dot onwards, converted to lowercase. If the filename includes
1421 // no dots, or if the input is NULL, returns an empty (but allocated) string.
1422 // The calling function is responsible for freeing the memory associated with
1423 // the return value.
1424 CHAR16
*FindExtension(IN CHAR16
*Path
) {
1426 BOOLEAN Found
= FALSE
, FoundSlash
= FALSE
;
1429 Extension
= AllocateZeroPool(sizeof(CHAR16
));
1432 while ((!Found
) && (!FoundSlash
) && (i
>= 0)) {
1433 if (Path
[i
] == L
'.')
1435 else if ((Path
[i
] == L
'/') || (Path
[i
] == L
'\\'))
1441 MergeStrings(&Extension
, &Path
[i
], 0);
1446 } // CHAR16 *FindExtension
1448 // Takes an input pathname (*Path) and locates the final directory component
1449 // of that name. For instance, if the input path is 'EFI\foo\bar.efi', this
1450 // function returns the string 'foo'.
1451 // Assumes the pathname is separated with backslashes.
1452 CHAR16
*FindLastDirName(IN CHAR16
*Path
) {
1453 UINTN i
, StartOfElement
= 0, EndOfElement
= 0, PathLength
, CopyLength
;
1454 CHAR16
*Found
= NULL
;
1456 PathLength
= StrLen(Path
);
1457 // Find start & end of target element
1458 for (i
= 0; i
< PathLength
; i
++) {
1459 if (Path
[i
] == '\\') {
1460 StartOfElement
= EndOfElement
;
1464 // Extract the target element
1465 if (EndOfElement
> 0) {
1466 while ((StartOfElement
< PathLength
) && (Path
[StartOfElement
] == '\\')) {
1470 if (EndOfElement
>= StartOfElement
) {
1471 CopyLength
= EndOfElement
- StartOfElement
+ 1;
1472 Found
= StrDuplicate(&Path
[StartOfElement
]);
1474 Found
[CopyLength
] = 0;
1475 } // if (EndOfElement >= StartOfElement)
1476 } // if (EndOfElement > 0)
1478 } // CHAR16 *FindLastDirName
1480 // Returns the directory portion of a pathname. For instance,
1481 // if FullPath is 'EFI\foo\bar.efi', this function returns the
1482 // string 'EFI\foo'. The calling function is responsible for
1483 // freeing the returned string's memory.
1484 CHAR16
*FindPath(IN CHAR16
* FullPath
) {
1485 UINTN i
, LastBackslash
= 0;
1488 for (i
= 0; i
< StrLen(FullPath
); i
++) {
1489 if (FullPath
[i
] == '\\')
1492 PathOnly
= StrDuplicate(FullPath
);
1493 PathOnly
[LastBackslash
] = 0;
1497 // Takes an input loadpath, splits it into disk and filename components, finds a matching
1498 // DeviceVolume, and returns that and the filename (*loader).
1499 VOID
FindVolumeAndFilename(IN EFI_DEVICE_PATH
*loadpath
, OUT REFIT_VOLUME
**DeviceVolume
, OUT CHAR16
**loader
) {
1500 CHAR16
*DeviceString
, *VolumeDeviceString
, *Temp
;
1502 BOOLEAN Found
= FALSE
;
1504 MyFreePool(*loader
);
1505 MyFreePool(*DeviceVolume
);
1506 *DeviceVolume
= NULL
;
1507 DeviceString
= DevicePathToStr(loadpath
);
1508 *loader
= SplitDeviceString(DeviceString
);
1510 while ((i
< VolumesCount
) && (!Found
)) {
1511 VolumeDeviceString
= DevicePathToStr(Volumes
[i
]->DevicePath
);
1512 Temp
= SplitDeviceString(VolumeDeviceString
);
1513 if (StriCmp(DeviceString
, VolumeDeviceString
) == 0) {
1515 *DeviceVolume
= Volumes
[i
];
1518 MyFreePool(VolumeDeviceString
);
1522 MyFreePool(DeviceString
);
1523 } // VOID FindVolumeAndFilename()
1525 // Splits a volume/filename string (e.g., "fs0:\EFI\BOOT") into separate
1526 // volume and filename components (e.g., "fs0" and "\EFI\BOOT"), returning
1527 // the filename component in the original *Path variable and the split-off
1528 // volume component in the *VolName variable.
1529 // Returns TRUE if both components are found, FALSE otherwise.
1530 BOOLEAN
SplitVolumeAndFilename(IN OUT CHAR16
**Path
, OUT CHAR16
**VolName
) {
1531 UINTN i
= 0, Length
;
1537 if (*VolName
!= NULL
) {
1538 MyFreePool(*VolName
);
1542 Length
= StrLen(*Path
);
1543 while ((i
< Length
) && ((*Path
)[i
] != L
':')) {
1548 Filename
= StrDuplicate((*Path
) + i
+ 1);
1556 } // BOOLEAN SplitVolumeAndFilename()
1558 // Returns all the digits in the input string, including intervening
1559 // non-digit characters. For instance, if InString is "foo-3.3.4-7.img",
1560 // this function returns "3.3.4-7". If InString contains no digits,
1561 // the return value is NULL.
1562 CHAR16
*FindNumbers(IN CHAR16
*InString
) {
1563 UINTN i
, StartOfElement
, EndOfElement
= 0, InLength
, CopyLength
;
1564 CHAR16
*Found
= NULL
;
1566 InLength
= StartOfElement
= StrLen(InString
);
1567 // Find start & end of target element
1568 for (i
= 0; i
< InLength
; i
++) {
1569 if ((InString
[i
] >= '0') && (InString
[i
] <= '9')) {
1570 if (StartOfElement
> i
)
1572 if (EndOfElement
< i
)
1576 // Extract the target element
1577 if (EndOfElement
> 0) {
1578 if (EndOfElement
>= StartOfElement
) {
1579 CopyLength
= EndOfElement
- StartOfElement
+ 1;
1580 Found
= StrDuplicate(&InString
[StartOfElement
]);
1582 Found
[CopyLength
] = 0;
1583 } // if (EndOfElement >= StartOfElement)
1584 } // if (EndOfElement > 0)
1586 } // CHAR16 *FindNumbers()
1588 // Find the #Index element (numbered from 0) in a comma-delimited string
1590 // Returns the found element, or NULL if Index is out of range or InString
1591 // is NULL. Note that the calling function is responsible for freeing the
1592 // memory associated with the returned string pointer.
1593 CHAR16
*FindCommaDelimited(IN CHAR16
*InString
, IN UINTN Index
) {
1594 UINTN StartPos
= 0, CurPos
= 0;
1595 BOOLEAN Found
= FALSE
;
1596 CHAR16
*FoundString
= NULL
;
1598 if (InString
!= NULL
) {
1599 // After while() loop, StartPos marks start of item #Index
1600 while ((Index
> 0) && (CurPos
< StrLen(InString
))) {
1601 if (InString
[CurPos
] == L
',') {
1603 StartPos
= CurPos
+ 1;
1607 // After while() loop, CurPos is one past the end of the element
1608 while ((CurPos
< StrLen(InString
)) && (!Found
)) {
1609 if (InString
[CurPos
] == L
',')
1615 FoundString
= StrDuplicate(&InString
[StartPos
]);
1616 if (FoundString
!= NULL
)
1617 FoundString
[CurPos
- StartPos
] = 0;
1619 return (FoundString
);
1620 } // CHAR16 *FindCommaDelimited()
1622 // Returns TRUE if SmallString is an element in the comma-delimited List,
1623 // FALSE otherwise. Performs comparison case-insensitively (except on
1624 // buggy EFIs with case-sensitive StriCmp() functions).
1625 BOOLEAN
IsIn(IN CHAR16
*SmallString
, IN CHAR16
*List
) {
1627 BOOLEAN Found
= FALSE
;
1630 if (SmallString
&& List
) {
1631 while (!Found
&& (OneElement
= FindCommaDelimited(List
, i
++))) {
1632 if (StriCmp(OneElement
, SmallString
) == 0)
1639 // Implement FreePool the way it should have been done to begin with, so that
1640 // it doesn't throw an ASSERT message if fed a NULL pointer....
1641 VOID
MyFreePool(IN OUT VOID
*Pointer
) {
1642 if (Pointer
!= NULL
)
1646 static EFI_GUID AppleRemovableMediaGuid
= APPLE_REMOVABLE_MEDIA_PROTOCOL_GUID
;
1648 // Eject all removable media.
1649 // Returns TRUE if any media were ejected, FALSE otherwise.
1650 BOOLEAN
EjectMedia(VOID
) {
1652 UINTN HandleIndex
, HandleCount
= 0, Ejected
= 0;
1653 EFI_HANDLE
*Handles
, Handle
;
1654 APPLE_REMOVABLE_MEDIA_PROTOCOL
*Ejectable
;
1656 Status
= LibLocateHandle(ByProtocol
, &AppleRemovableMediaGuid
, NULL
, &HandleCount
, &Handles
);
1657 if (EFI_ERROR(Status
) || HandleCount
== 0)
1658 return (FALSE
); // probably not an Apple system
1660 for (HandleIndex
= 0; HandleIndex
< HandleCount
; HandleIndex
++) {
1661 Handle
= Handles
[HandleIndex
];
1662 Status
= refit_call3_wrapper(BS
->HandleProtocol
, Handle
, &AppleRemovableMediaGuid
, (VOID
**) &Ejectable
);
1663 if (EFI_ERROR(Status
))
1665 Status
= refit_call1_wrapper(Ejectable
->Eject
, Ejectable
);
1666 if (!EFI_ERROR(Status
))
1669 MyFreePool(Handles
);
1670 return (Ejected
> 0);
1671 } // VOID EjectMedia()
1674 // Return the GUID as a string, suitable for display to the user. Note that the calling
1675 // function is responsible for freeing the allocated memory.
1676 CHAR16
* GuidAsString(EFI_GUID
*GuidData
) {
1679 TheString
= AllocateZeroPool(42 * sizeof(CHAR16
));
1680 if (TheString
!= 0) {
1681 SPrint (TheString
, 82, L
"%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x",
1682 (UINTN
)GuidData
->Data1
, (UINTN
)GuidData
->Data2
, (UINTN
)GuidData
->Data3
,
1683 (UINTN
)GuidData
->Data4
[0], (UINTN
)GuidData
->Data4
[1], (UINTN
)GuidData
->Data4
[2],
1684 (UINTN
)GuidData
->Data4
[3], (UINTN
)GuidData
->Data4
[4], (UINTN
)GuidData
->Data4
[5],
1685 (UINTN
)GuidData
->Data4
[6], (UINTN
)GuidData
->Data4
[7]);
1688 } // GuidAsString(EFI_GUID *GuidData)