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-2014 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"
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;
89 extern GPT_DATA
*gPartitions
;
91 // Maximum size for disk sectors
92 #define SECTOR_SIZE 4096
94 // Number of bytes to read from a partition to determine its filesystem type
95 // and identify its boot loader, and hence probable BIOS-mode OS installation
96 #define SAMPLE_SIZE 69632 /* 68 KiB -- ReiserFS superblock begins at 64 KiB */
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
, Length
, FinalChar
= 0;
120 BOOLEAN LastWasSlash
= FALSE
;
122 Length
= StrLen(PathName
);
123 NewName
= AllocateZeroPool(sizeof(CHAR16
) * (Length
+ 2));
124 if (NewName
!= NULL
) {
125 for (i
= 0; i
< StrLen(PathName
); i
++) {
126 if ((PathName
[i
] == L
'/') || (PathName
[i
] == L
'\\')) {
127 if ((!LastWasSlash
) && (FinalChar
!= 0))
128 NewName
[FinalChar
++] = L
'\\';
131 NewName
[FinalChar
++] = PathName
[i
];
132 LastWasSlash
= FALSE
;
135 NewName
[FinalChar
] = 0;
136 if ((FinalChar
> 0) && (NewName
[FinalChar
- 1] == L
'\\'))
137 NewName
[--FinalChar
] = 0;
138 if (FinalChar
== 0) {
142 // Copy the transformed name back....
143 StrCpy(PathName
, NewName
);
145 } // if allocation OK
146 } // CleanUpPathNameSlashes()
148 // Splits an EFI device path into device and filename components. For instance, if InString is
149 // PciRoot(0x0)/Pci(0x1f,0x2)/Ata(Secondary,Master,0x0)/HD(2,GPT,8314ae90-ada3-48e9-9c3b-09a88f80d921,0x96028,0xfa000)/\bzImage-3.5.1.efi,
150 // this function will truncate that input to
151 // PciRoot(0x0)/Pci(0x1f,0x2)/Ata(Secondary,Master,0x0)/HD(2,GPT,8314ae90-ada3-48e9-9c3b-09a88f80d921,0x96028,0xfa000)
152 // and return bzImage-3.5.1.efi as its return value.
153 // It does this by searching for the last ")" character in InString, copying everything
154 // after that string (after some cleanup) as the return value, and truncating the original
156 // If InString contains no ")" character, this function leaves the original input string
157 // unmodified and also returns that string. If InString is NULL, this function returns NULL.
158 static CHAR16
* SplitDeviceString(IN OUT CHAR16
*InString
) {
160 CHAR16
*FileName
= NULL
;
161 BOOLEAN Found
= FALSE
;
163 if (InString
!= NULL
) {
164 i
= StrLen(InString
) - 1;
165 while ((i
>= 0) && (!Found
)) {
166 if (InString
[i
] == L
')') {
168 FileName
= StrDuplicate(&InString
[i
+ 1]);
169 CleanUpPathNameSlashes(FileName
);
170 InString
[i
+ 1] = '\0';
174 if (FileName
== NULL
)
175 FileName
= StrDuplicate(InString
);
178 } // static CHAR16* SplitDeviceString()
180 EFI_STATUS
InitRefitLib(IN EFI_HANDLE ImageHandle
)
183 CHAR16
*DevicePathAsString
, *Temp
;
185 SelfImageHandle
= ImageHandle
;
186 Status
= refit_call3_wrapper(BS
->HandleProtocol
, SelfImageHandle
, &LoadedImageProtocol
, (VOID
**) &SelfLoadedImage
);
187 if (CheckFatalError(Status
, L
"while getting a LoadedImageProtocol handle"))
188 return EFI_LOAD_ERROR
;
190 // find the current directory
191 DevicePathAsString
= DevicePathToStr(SelfLoadedImage
->FilePath
);
192 CleanUpPathNameSlashes(DevicePathAsString
);
193 MyFreePool(SelfDirPath
);
194 Temp
= FindPath(DevicePathAsString
);
195 SelfDirPath
= SplitDeviceString(Temp
);
196 MyFreePool(DevicePathAsString
);
199 return FinishInitRefitLib();
202 // called before running external programs to close open file handles
203 VOID
UninitRefitLib(VOID
)
205 // This piece of code was made to correspond to weirdness in ReinitRefitLib().
206 // See the comment on it there.
207 if(SelfRootDir
== SelfVolume
->RootDir
)
212 if (SelfDir
!= NULL
) {
213 refit_call1_wrapper(SelfDir
->Close
, SelfDir
);
217 if (SelfRootDir
!= NULL
) {
218 refit_call1_wrapper(SelfRootDir
->Close
, SelfRootDir
);
223 // called after running external programs to re-open file handles
224 EFI_STATUS
ReinitRefitLib(VOID
)
228 if ((ST
->Hdr
.Revision
>> 16) == 1) {
229 // Below two lines were in rEFIt, but seem to cause system crashes or
230 // reboots when launching OSes after returning from programs on most
231 // systems. OTOH, my Mac Mini produces errors about "(re)opening our
232 // installation volume" (see the next function) when returning from
233 // programs when these two lines are removed, and it often crashes
234 // when returning from a program or when launching a second program
235 // with these lines removed. Therefore, the preceding if() statement
236 // executes these lines only on EFIs with a major version number of 1
237 // (which Macs have) and not with 2 (which UEFI PCs have). My selection
238 // of hardware on which to test is limited, though, so this may be the
239 // wrong test, or there may be a better way to fix this problem.
240 // TODO: Figure out cause of above weirdness and fix it more
242 if (SelfVolume
!= NULL
&& SelfVolume
->RootDir
!= NULL
)
243 SelfRootDir
= SelfVolume
->RootDir
;
246 return FinishInitRefitLib();
249 static EFI_STATUS
FinishInitRefitLib(VOID
)
253 if (SelfRootDir
== NULL
) {
254 SelfRootDir
= LibOpenRoot(SelfLoadedImage
->DeviceHandle
);
255 if (SelfRootDir
== NULL
) {
256 CheckError(EFI_LOAD_ERROR
, L
"while (re)opening our installation volume");
257 return EFI_LOAD_ERROR
;
261 Status
= refit_call5_wrapper(SelfRootDir
->Open
, SelfRootDir
, &SelfDir
, SelfDirPath
, EFI_FILE_MODE_READ
, 0);
262 if (CheckFatalError(Status
, L
"while opening our installation directory"))
263 return EFI_LOAD_ERROR
;
272 VOID
CreateList(OUT VOID
***ListPtr
, OUT UINTN
*ElementCount
, IN UINTN InitialElementCount
)
276 *ElementCount
= InitialElementCount
;
277 if (*ElementCount
> 0) {
278 AllocateCount
= (*ElementCount
+ 7) & ~7; // next multiple of 8
279 *ListPtr
= AllocatePool(sizeof(VOID
*) * AllocateCount
);
285 VOID
AddListElement(IN OUT VOID
***ListPtr
, IN OUT UINTN
*ElementCount
, IN VOID
*NewElement
)
289 if ((*ElementCount
& 7) == 0) {
290 AllocateCount
= *ElementCount
+ 8;
291 if (*ElementCount
== 0)
292 *ListPtr
= AllocatePool(sizeof(VOID
*) * AllocateCount
);
294 *ListPtr
= EfiReallocatePool(*ListPtr
, sizeof(VOID
*) * (*ElementCount
), sizeof(VOID
*) * AllocateCount
);
296 (*ListPtr
)[*ElementCount
] = NewElement
;
298 } /* VOID AddListElement() */
300 VOID
FreeList(IN OUT VOID
***ListPtr
, IN OUT UINTN
*ElementCount
)
304 if ((*ElementCount
> 0) && (**ListPtr
!= NULL
)) {
305 for (i
= 0; i
< *ElementCount
; i
++) {
306 // TODO: call a user-provided routine for each element here
307 MyFreePool((*ListPtr
)[i
]);
309 MyFreePool(*ListPtr
);
314 // firmware device path discovery
317 static UINT8 LegacyLoaderMediaPathData
[] = {
318 0x04, 0x06, 0x14, 0x00, 0xEB, 0x85, 0x05, 0x2B,
319 0xB8, 0xD8, 0xA9, 0x49, 0x8B, 0x8C, 0xE2, 0x1B,
320 0x01, 0xAE, 0xF2, 0xB7, 0x7F, 0xFF, 0x04, 0x00,
322 static EFI_DEVICE_PATH
*LegacyLoaderMediaPath
= (EFI_DEVICE_PATH
*)LegacyLoaderMediaPathData
;
324 VOID
ExtractLegacyLoaderPaths(EFI_DEVICE_PATH
**PathList
, UINTN MaxPaths
, EFI_DEVICE_PATH
**HardcodedPathList
)
327 UINTN HandleCount
= 0;
328 UINTN HandleIndex
, HardcodedIndex
;
333 EFI_LOADED_IMAGE
*LoadedImage
;
334 EFI_DEVICE_PATH
*DevicePath
;
337 MaxPaths
--; // leave space for the terminating NULL pointer
339 // get all LoadedImage handles
340 Status
= LibLocateHandle(ByProtocol
, &LoadedImageProtocol
, NULL
, &HandleCount
, &Handles
);
341 if (CheckError(Status
, L
"while listing LoadedImage handles")) {
342 if (HardcodedPathList
) {
343 for (HardcodedIndex
= 0; HardcodedPathList
[HardcodedIndex
] && PathCount
< MaxPaths
; HardcodedIndex
++)
344 PathList
[PathCount
++] = HardcodedPathList
[HardcodedIndex
];
346 PathList
[PathCount
] = NULL
;
349 for (HandleIndex
= 0; HandleIndex
< HandleCount
&& PathCount
< MaxPaths
; HandleIndex
++) {
350 Handle
= Handles
[HandleIndex
];
352 Status
= refit_call3_wrapper(BS
->HandleProtocol
, Handle
, &LoadedImageProtocol
, (VOID
**) &LoadedImage
);
353 if (EFI_ERROR(Status
))
354 continue; // This can only happen if the firmware scewed up, ignore it.
356 Status
= refit_call3_wrapper(BS
->HandleProtocol
, LoadedImage
->DeviceHandle
, &DevicePathProtocol
, (VOID
**) &DevicePath
);
357 if (EFI_ERROR(Status
))
358 continue; // This happens, ignore it.
360 // Only grab memory range nodes
361 if (DevicePathType(DevicePath
) != HARDWARE_DEVICE_PATH
|| DevicePathSubType(DevicePath
) != HW_MEMMAP_DP
)
364 // Check if we have this device path in the list already
365 // WARNING: This assumes the first node in the device path is unique!
367 for (PathIndex
= 0; PathIndex
< PathCount
; PathIndex
++) {
368 if (DevicePathNodeLength(DevicePath
) != DevicePathNodeLength(PathList
[PathIndex
]))
370 if (CompareMem(DevicePath
, PathList
[PathIndex
], DevicePathNodeLength(DevicePath
)) == 0) {
378 PathList
[PathCount
++] = AppendDevicePath(DevicePath
, LegacyLoaderMediaPath
);
382 if (HardcodedPathList
) {
383 for (HardcodedIndex
= 0; HardcodedPathList
[HardcodedIndex
] && PathCount
< MaxPaths
; HardcodedIndex
++)
384 PathList
[PathCount
++] = HardcodedPathList
[HardcodedIndex
];
386 PathList
[PathCount
] = NULL
;
393 // Return a pointer to a string containing a filesystem type name. If the
394 // filesystem type is unknown, a blank (but non-null) string is returned.
395 // The returned variable is a constant that should NOT be freed.
396 static CHAR16
*FSTypeName(IN UINT32 TypeCode
) {
397 CHAR16
*retval
= NULL
;
403 case FS_TYPE_HFSPLUS
:
415 case FS_TYPE_REISERFS
:
416 retval
= L
" ReiserFS";
421 case FS_TYPE_ISO9660
:
422 retval
= L
" ISO-9660";
429 } // CHAR16 *FSTypeName()
431 // Identify the filesystem type and record the filesystem's UUID/serial number,
432 // if possible. Expects a Buffer containing the first few (normally 4096) bytes
433 // of the filesystem. Sets the filesystem type code in Volume->FSType and the
434 // UUID/serial number in Volume->VolUuid. Note that the UUID value is recognized
435 // differently for each filesystem, and is currently supported only for
436 // ext2/3/4fs and ReiserFS. If the UUID can't be determined, it's set to 0. Also, the UUID
437 // is just read directly into memory; it is *NOT* valid when displayed by
438 // GuidAsString() or used in other GUID/UUID-manipulating functions. (As I
439 // write, it's being used merely to detect partitions that are part of a
441 static VOID
SetFilesystemData(IN UINT8
*Buffer
, IN UINTN BufferSize
, IN OUT REFIT_VOLUME
*Volume
) {
442 UINT32
*Ext2Incompat
, *Ext2Compat
;
446 if ((Buffer
!= NULL
) && (Volume
!= NULL
)) {
447 SetMem(&(Volume
->VolUuid
), sizeof(EFI_GUID
), 0);
448 Volume
->FSType
= FS_TYPE_UNKNOWN
;
450 if (BufferSize
>= 512) {
451 Magic16
= (UINT16
*) (Buffer
+ 510);
452 if (*Magic16
== FAT_MAGIC
) {
453 Volume
->FSType
= FS_TYPE_FAT
;
456 } // search for FAT magic
458 if (BufferSize
>= (1024 + 100)) {
459 Magic16
= (UINT16
*) (Buffer
+ 1024 + 56);
460 if (*Magic16
== EXT2_SUPER_MAGIC
) { // ext2/3/4
461 Ext2Compat
= (UINT32
*) (Buffer
+ 1024 + 92);
462 Ext2Incompat
= (UINT32
*) (Buffer
+ 1024 + 96);
463 if ((*Ext2Incompat
& 0x0040) || (*Ext2Incompat
& 0x0200)) { // check for extents or flex_bg
464 Volume
->FSType
= FS_TYPE_EXT4
;
465 } else if (*Ext2Compat
& 0x0004) { // check for journal
466 Volume
->FSType
= FS_TYPE_EXT3
;
467 } else { // none of these features; presume it's ext2...
468 Volume
->FSType
= FS_TYPE_EXT2
;
470 CopyMem(&(Volume
->VolUuid
), Buffer
+ 1024 + 104, sizeof(EFI_GUID
));
473 } // search for ext2/3/4 magic
475 if (BufferSize
>= (65536 + 100)) {
476 MagicString
= (char*) (Buffer
+ 65536 + 52);
477 if ((CompareMem(MagicString
, REISERFS_SUPER_MAGIC_STRING
, 8) == 0) ||
478 (CompareMem(MagicString
, REISER2FS_SUPER_MAGIC_STRING
, 9) == 0) ||
479 (CompareMem(MagicString
, REISER2FS_JR_SUPER_MAGIC_STRING
, 9) == 0)) {
480 Volume
->FSType
= FS_TYPE_REISERFS
;
481 CopyMem(&(Volume
->VolUuid
), Buffer
+ 65536 + 84, sizeof(EFI_GUID
));
484 } // search for ReiserFS magic
486 if (BufferSize
>= (65536 + 64 + 8)) {
487 MagicString
= (char*) (Buffer
+ 65536 + 64);
488 if (CompareMem(MagicString
, BTRFS_SIGNATURE
, 8) == 0) {
489 Volume
->FSType
= FS_TYPE_BTRFS
;
492 } // search for Btrfs magic
494 if (BufferSize
>= (1024 + 2)) {
495 Magic16
= (UINT16
*) (Buffer
+ 1024);
496 if ((*Magic16
== HFSPLUS_MAGIC1
) || (*Magic16
== HFSPLUS_MAGIC2
)) {
497 Volume
->FSType
= FS_TYPE_HFSPLUS
;
500 } // search for HFS+ magic
501 } // if (Buffer != NULL)
503 } // UINT32 SetFilesystemData()
505 static VOID
ScanVolumeBootcode(REFIT_VOLUME
*Volume
, BOOLEAN
*Bootable
)
508 UINT8 Buffer
[SAMPLE_SIZE
];
510 MBR_PARTITION_INFO
*MbrTable
;
511 BOOLEAN MbrTableFound
= FALSE
;
513 Volume
->HasBootCode
= FALSE
;
514 Volume
->OSIconName
= NULL
;
515 Volume
->OSName
= NULL
;
518 if (Volume
->BlockIO
== NULL
)
520 if (Volume
->BlockIO
->Media
->BlockSize
> SAMPLE_SIZE
)
521 return; // our buffer is too small...
523 // look at the boot sector (this is used for both hard disks and El Torito images!)
524 Status
= refit_call5_wrapper(Volume
->BlockIO
->ReadBlocks
,
525 Volume
->BlockIO
, Volume
->BlockIO
->Media
->MediaId
,
526 Volume
->BlockIOOffset
, SAMPLE_SIZE
, Buffer
);
527 if (!EFI_ERROR(Status
)) {
529 SetFilesystemData(Buffer
, SAMPLE_SIZE
, Volume
);
530 if ((*((UINT16
*)(Buffer
+ 510)) == 0xaa55 && Buffer
[0] != 0) && (FindMem(Buffer
, 512, "EXFAT", 5) == -1)) {
532 Volume
->HasBootCode
= TRUE
;
535 // detect specific boot codes
536 if (CompareMem(Buffer
+ 2, "LILO", 4) == 0 ||
537 CompareMem(Buffer
+ 6, "LILO", 4) == 0 ||
538 CompareMem(Buffer
+ 3, "SYSLINUX", 8) == 0 ||
539 FindMem(Buffer
, SECTOR_SIZE
, "ISOLINUX", 8) >= 0) {
540 Volume
->HasBootCode
= TRUE
;
541 Volume
->OSIconName
= L
"linux";
542 Volume
->OSName
= L
"Linux";
544 } else if (FindMem(Buffer
, 512, "Geom\0Hard Disk\0Read\0 Error", 26) >= 0) { // GRUB
545 Volume
->HasBootCode
= TRUE
;
546 Volume
->OSIconName
= L
"grub,linux";
547 Volume
->OSName
= L
"Linux";
549 // // Below doesn't produce a bootable entry, so commented out for the moment....
550 // // GRUB in BIOS boot partition:
551 // } else if (FindMem(Buffer, 512, "Geom\0Read\0 Error", 16) >= 0) {
552 // Volume->HasBootCode = TRUE;
553 // Volume->OSIconName = L"grub,linux";
554 // Volume->OSName = L"Linux";
555 // Volume->VolName = L"BIOS Boot Partition";
558 } else if ((*((UINT32
*)(Buffer
+ 502)) == 0 &&
559 *((UINT32
*)(Buffer
+ 506)) == 50000 &&
560 *((UINT16
*)(Buffer
+ 510)) == 0xaa55) ||
561 FindMem(Buffer
, SECTOR_SIZE
, "Starting the BTX loader", 23) >= 0) {
562 Volume
->HasBootCode
= TRUE
;
563 Volume
->OSIconName
= L
"freebsd";
564 Volume
->OSName
= L
"FreeBSD";
566 } else if (FindMem(Buffer
, 512, "!Loading", 8) >= 0 ||
567 FindMem(Buffer
, SECTOR_SIZE
, "/cdboot\0/CDBOOT\0", 16) >= 0) {
568 Volume
->HasBootCode
= TRUE
;
569 Volume
->OSIconName
= L
"openbsd";
570 Volume
->OSName
= L
"OpenBSD";
572 } else if (FindMem(Buffer
, 512, "Not a bootxx image", 18) >= 0 ||
573 *((UINT32
*)(Buffer
+ 1028)) == 0x7886b6d1) {
574 Volume
->HasBootCode
= TRUE
;
575 Volume
->OSIconName
= L
"netbsd";
576 Volume
->OSName
= L
"NetBSD";
578 } else if (FindMem(Buffer
, SECTOR_SIZE
, "NTLDR", 5) >= 0) {
579 Volume
->HasBootCode
= TRUE
;
580 Volume
->OSIconName
= L
"win";
581 Volume
->OSName
= L
"Windows";
583 } else if (FindMem(Buffer
, SECTOR_SIZE
, "BOOTMGR", 7) >= 0) {
584 Volume
->HasBootCode
= TRUE
;
585 Volume
->OSIconName
= L
"winvista,win";
586 Volume
->OSName
= L
"Windows";
588 } else if (FindMem(Buffer
, 512, "CPUBOOT SYS", 11) >= 0 ||
589 FindMem(Buffer
, 512, "KERNEL SYS", 11) >= 0) {
590 Volume
->HasBootCode
= TRUE
;
591 Volume
->OSIconName
= L
"freedos";
592 Volume
->OSName
= L
"FreeDOS";
594 } else if (FindMem(Buffer
, 512, "OS2LDR", 6) >= 0 ||
595 FindMem(Buffer
, 512, "OS2BOOT", 7) >= 0) {
596 Volume
->HasBootCode
= TRUE
;
597 Volume
->OSIconName
= L
"ecomstation";
598 Volume
->OSName
= L
"eComStation";
600 } else if (FindMem(Buffer
, 512, "Be Boot Loader", 14) >= 0) {
601 Volume
->HasBootCode
= TRUE
;
602 Volume
->OSIconName
= L
"beos";
603 Volume
->OSName
= L
"BeOS";
605 } else if (FindMem(Buffer
, 512, "yT Boot Loader", 14) >= 0) {
606 Volume
->HasBootCode
= TRUE
;
607 Volume
->OSIconName
= L
"zeta,beos";
608 Volume
->OSName
= L
"ZETA";
610 } else if (FindMem(Buffer
, 512, "\x04" "beos\x06" "system\x05" "zbeos", 18) >= 0 ||
611 FindMem(Buffer
, 512, "\x06" "system\x0c" "haiku_loader", 20) >= 0) {
612 Volume
->HasBootCode
= TRUE
;
613 Volume
->OSIconName
= L
"haiku,beos";
614 Volume
->OSName
= L
"Haiku";
618 // NOTE: If you add an operating system with a name that starts with 'W' or 'L', you
619 // need to fix AddLegacyEntry in main.c.
622 Print(L
" Result of bootcode detection: %s %s (%s)\n",
623 Volume
->HasBootCode
? L
"bootable" : L
"non-bootable",
624 Volume
->OSName
, Volume
->OSIconName
);
627 // dummy FAT boot sector (created by OS X's newfs_msdos)
628 if (FindMem(Buffer
, 512, "Non-system disk", 15) >= 0)
629 Volume
->HasBootCode
= FALSE
;
631 // dummy FAT boot sector (created by Linux's mkdosfs)
632 if (FindMem(Buffer
, 512, "This is not a bootable disk", 27) >= 0)
633 Volume
->HasBootCode
= FALSE
;
635 // dummy FAT boot sector (created by Windows)
636 if (FindMem(Buffer
, 512, "Press any key to restart", 24) >= 0)
637 Volume
->HasBootCode
= FALSE
;
639 // check for MBR partition table
640 if (*((UINT16
*)(Buffer
+ 510)) == 0xaa55) {
641 MbrTable
= (MBR_PARTITION_INFO
*)(Buffer
+ 446);
642 for (i
= 0; i
< 4; i
++)
643 if (MbrTable
[i
].StartLBA
&& MbrTable
[i
].Size
)
644 MbrTableFound
= TRUE
;
645 for (i
= 0; i
< 4; i
++)
646 if (MbrTable
[i
].Flags
!= 0x00 && MbrTable
[i
].Flags
!= 0x80)
647 MbrTableFound
= FALSE
;
649 Volume
->MbrPartitionTable
= AllocatePool(4 * 16);
650 CopyMem(Volume
->MbrPartitionTable
, MbrTable
, 4 * 16);
656 CheckError(Status
, L
"while reading boot sector");
659 } /* VOID ScanVolumeBootcode() */
661 // Set default volume badge icon based on /.VolumeBadge.{icns|png} file or disk kind
662 VOID
SetVolumeBadgeIcon(REFIT_VOLUME
*Volume
)
664 if (Volume
->VolBadgeImage
== NULL
) {
665 Volume
->VolBadgeImage
= egLoadIconAnyType(Volume
->RootDir
, L
"", L
".VolumeBadge", GlobalConfig
.IconSizes
[ICON_SIZE_BADGE
]);
668 if (Volume
->VolBadgeImage
== NULL
) {
669 switch (Volume
->DiskKind
) {
670 case DISK_KIND_INTERNAL
:
671 Volume
->VolBadgeImage
= BuiltinIcon(BUILTIN_ICON_VOL_INTERNAL
);
673 case DISK_KIND_EXTERNAL
:
674 Volume
->VolBadgeImage
= BuiltinIcon(BUILTIN_ICON_VOL_EXTERNAL
);
676 case DISK_KIND_OPTICAL
:
677 Volume
->VolBadgeImage
= BuiltinIcon(BUILTIN_ICON_VOL_OPTICAL
);
681 } // VOID SetVolumeBadgeIcon()
683 // Return a string representing the input size in IEEE-1541 units.
684 // The calling function is responsible for freeing the allocated memory.
685 static CHAR16
*SizeInIEEEUnits(UINT64 SizeInBytes
) {
687 UINTN Index
= 0, NumPrefixes
;
688 CHAR16
*Units
, *Prefixes
= L
" KMGTPEZ";
691 TheValue
= AllocateZeroPool(sizeof(CHAR16
) * 256);
692 if (TheValue
!= NULL
) {
693 NumPrefixes
= StrLen(Prefixes
);
694 SizeInIeee
= SizeInBytes
;
695 while ((SizeInIeee
> 1024) && (Index
< (NumPrefixes
- 1))) {
699 if (Prefixes
[Index
] == ' ') {
700 Units
= StrDuplicate(L
"-byte");
702 Units
= StrDuplicate(L
" iB");
703 Units
[1] = Prefixes
[Index
];
705 SPrint(TheValue
, 255, L
"%ld%s", SizeInIeee
, Units
);
708 } // CHAR16 *SizeInIEEEUnits()
710 // Return a name for the volume. Ideally this should be the label for the
711 // filesystem it contains, but this function falls back to describing the
712 // filesystem by size (200 MiB, etc.) and/or type (ext2, HFS+, etc.), if
713 // this information can be extracted.
714 // The calling function is responsible for freeing the memory allocated
715 // for the name string.
716 static CHAR16
*GetVolumeName(REFIT_VOLUME
*Volume
) {
717 EFI_FILE_SYSTEM_INFO
*FileSystemInfoPtr
;
718 CHAR16
*FoundName
= NULL
;
719 CHAR16
*SISize
, *TypeName
;
721 FileSystemInfoPtr
= LibFileSystemInfo(Volume
->RootDir
);
722 if (FileSystemInfoPtr
!= NULL
) { // we have filesystem information (size, label)....
723 if ((FileSystemInfoPtr
->VolumeLabel
!= NULL
) && (StrLen(FileSystemInfoPtr
->VolumeLabel
) > 0)) {
724 FoundName
= StrDuplicate(FileSystemInfoPtr
->VolumeLabel
);
727 // Special case: Old versions of the rEFInd HFS+ driver always returns label of "HFS+ volume", so wipe
728 // this so that we can build a new name that includes the size....
729 if ((FoundName
!= NULL
) && (StrCmp(FoundName
, L
"HFS+ volume") == 0) && (Volume
->FSType
== FS_TYPE_HFSPLUS
)) {
730 MyFreePool(FoundName
);
732 } // if rEFInd HFS+ driver suspected
734 // If no filesystem name, try to use the partition name....
735 if ((FoundName
== NULL
) && (Volume
->PartName
!= NULL
) && (StrLen(Volume
->PartName
) > 0) &&
736 !IsIn(Volume
->PartName
, IGNORE_PARTITION_NAMES
)) {
737 FoundName
= StrDuplicate(Volume
->PartName
);
738 } // if use partition name
740 // No filesystem or acceptable partition name, so use fs type and size
741 if (FoundName
== NULL
) {
742 FoundName
= AllocateZeroPool(sizeof(CHAR16
) * 256);
743 if (FoundName
!= NULL
) {
744 SISize
= SizeInIEEEUnits(FileSystemInfoPtr
->VolumeSize
);
745 SPrint(FoundName
, 255, L
"%s%s volume", SISize
, FSTypeName(Volume
->FSType
));
747 } // if allocated memory OK
748 } // if (FoundName == NULL)
750 FreePool(FileSystemInfoPtr
);
752 } else { // fs driver not returning info; fall back on our own information....
753 FoundName
= AllocateZeroPool(sizeof(CHAR16
) * 256);
754 if (FoundName
!= NULL
) {
755 TypeName
= FSTypeName(Volume
->FSType
); // NOTE: Don't free TypeName; function returns constant
756 if (StrLen(TypeName
) > 0)
757 SPrint(FoundName
, 255, L
"%s volume", TypeName
);
759 SPrint(FoundName
, 255, L
"unknown volume");
760 } // if allocated memory OK
763 // TODO: Above could be improved/extended, in case filesystem name is not found,
765 // - use partition label
766 // - use or add disk/partition number (e.g., "(hd0,2)")
768 // Desperate fallback name....
769 if (FoundName
== NULL
) {
770 FoundName
= StrDuplicate(L
"unknown volume");
773 } // static CHAR16 *GetVolumeName()
775 // Determine the unique GUID of the volume and store it.
776 static VOID
SetPartGuidAndName(REFIT_VOLUME
*Volume
, EFI_DEVICE_PATH_PROTOCOL
*DevicePath
) {
777 HARDDRIVE_DEVICE_PATH
*HdDevicePath
;
782 if ((DevicePath
->Type
== MEDIA_DEVICE_PATH
) && (DevicePath
->SubType
== MEDIA_HARDDRIVE_DP
)) {
783 HdDevicePath
= (HARDDRIVE_DEVICE_PATH
*) DevicePath
;
784 if (HdDevicePath
->SignatureType
== SIGNATURE_TYPE_GUID
) {
785 Volume
->PartGuid
= *((EFI_GUID
*) HdDevicePath
->Signature
);
786 Volume
->PartName
= PartNameFromGuid(&(Volume
->PartGuid
));
789 } // VOID SetPartGuid()
791 VOID
ScanVolume(REFIT_VOLUME
*Volume
)
794 EFI_DEVICE_PATH
*DevicePath
, *NextDevicePath
;
795 EFI_DEVICE_PATH
*DiskDevicePath
, *RemainingDevicePath
;
796 EFI_HANDLE WholeDiskHandle
;
801 Volume
->DevicePath
= DuplicateDevicePath(DevicePathFromHandle(Volume
->DeviceHandle
));
803 if (Volume
->DevicePath
!= NULL
) {
804 Print(L
"* %s\n", DevicePathToStr(Volume
->DevicePath
));
806 DumpHex(1, 0, DevicePathSize(Volume
->DevicePath
), Volume
->DevicePath
);
811 Volume
->DiskKind
= DISK_KIND_INTERNAL
; // default
814 Status
= refit_call3_wrapper(BS
->HandleProtocol
, Volume
->DeviceHandle
, &BlockIoProtocol
, (VOID
**) &(Volume
->BlockIO
));
815 if (EFI_ERROR(Status
)) {
816 Volume
->BlockIO
= NULL
;
817 Print(L
"Warning: Can't get BlockIO protocol.\n");
819 if (Volume
->BlockIO
->Media
->BlockSize
== 2048)
820 Volume
->DiskKind
= DISK_KIND_OPTICAL
;
823 // scan for bootcode and MBR table
825 ScanVolumeBootcode(Volume
, &Bootable
);
827 // detect device type
828 DevicePath
= Volume
->DevicePath
;
829 while (DevicePath
!= NULL
&& !IsDevicePathEndType(DevicePath
)) {
830 NextDevicePath
= NextDevicePathNode(DevicePath
);
832 if (DevicePathType(DevicePath
) == MEDIA_DEVICE_PATH
) {
833 SetPartGuidAndName(Volume
, DevicePath
);
835 if (DevicePathType(DevicePath
) == MESSAGING_DEVICE_PATH
&&
836 (DevicePathSubType(DevicePath
) == MSG_USB_DP
||
837 DevicePathSubType(DevicePath
) == MSG_USB_CLASS_DP
||
838 DevicePathSubType(DevicePath
) == MSG_1394_DP
||
839 DevicePathSubType(DevicePath
) == MSG_FIBRECHANNEL_DP
))
840 Volume
->DiskKind
= DISK_KIND_EXTERNAL
; // USB/FireWire/FC device -> external
841 if (DevicePathType(DevicePath
) == MEDIA_DEVICE_PATH
&&
842 DevicePathSubType(DevicePath
) == MEDIA_CDROM_DP
) {
843 Volume
->DiskKind
= DISK_KIND_OPTICAL
; // El Torito entry -> optical disk
847 if (DevicePathType(DevicePath
) == MEDIA_DEVICE_PATH
&& DevicePathSubType(DevicePath
) == MEDIA_VENDOR_DP
) {
848 Volume
->IsAppleLegacy
= TRUE
; // legacy BIOS device entry
849 // TODO: also check for Boot Camp GUID
850 Bootable
= FALSE
; // this handle's BlockIO is just an alias for the whole device
853 if (DevicePathType(DevicePath
) == MESSAGING_DEVICE_PATH
) {
854 // make a device path for the whole device
855 PartialLength
= (UINT8
*)NextDevicePath
- (UINT8
*)(Volume
->DevicePath
);
856 DiskDevicePath
= (EFI_DEVICE_PATH
*)AllocatePool(PartialLength
+ sizeof(EFI_DEVICE_PATH
));
857 CopyMem(DiskDevicePath
, Volume
->DevicePath
, PartialLength
);
858 CopyMem((UINT8
*)DiskDevicePath
+ PartialLength
, EndDevicePath
, sizeof(EFI_DEVICE_PATH
));
860 // get the handle for that path
861 RemainingDevicePath
= DiskDevicePath
;
862 Status
= refit_call3_wrapper(BS
->LocateDevicePath
, &BlockIoProtocol
, &RemainingDevicePath
, &WholeDiskHandle
);
863 FreePool(DiskDevicePath
);
865 if (!EFI_ERROR(Status
)) {
866 //Print(L" - original handle: %08x - disk handle: %08x\n", (UINT32)DeviceHandle, (UINT32)WholeDiskHandle);
868 // get the device path for later
869 Status
= refit_call3_wrapper(BS
->HandleProtocol
, WholeDiskHandle
, &DevicePathProtocol
, (VOID
**) &DiskDevicePath
);
870 if (!EFI_ERROR(Status
)) {
871 Volume
->WholeDiskDevicePath
= DuplicateDevicePath(DiskDevicePath
);
874 // look at the BlockIO protocol
875 Status
= refit_call3_wrapper(BS
->HandleProtocol
, WholeDiskHandle
, &BlockIoProtocol
,
876 (VOID
**) &Volume
->WholeDiskBlockIO
);
877 if (!EFI_ERROR(Status
)) {
879 // check the media block size
880 if (Volume
->WholeDiskBlockIO
->Media
->BlockSize
== 2048)
881 Volume
->DiskKind
= DISK_KIND_OPTICAL
;
884 Volume
->WholeDiskBlockIO
= NULL
;
885 //CheckError(Status, L"from HandleProtocol");
888 // CheckError(Status, L"from LocateDevicePath");
891 DevicePath
= NextDevicePath
;
896 if (Volume
->HasBootCode
)
897 Print(L
" Volume considered non-bootable, but boot code is present\n");
899 Volume
->HasBootCode
= FALSE
;
902 // open the root directory of the volume
903 Volume
->RootDir
= LibOpenRoot(Volume
->DeviceHandle
);
905 // Set volume icon based on .VolumeBadge icon or disk kind
906 SetVolumeBadgeIcon(Volume
);
908 if (Volume
->RootDir
== NULL
) {
909 Volume
->IsReadable
= FALSE
;
912 Volume
->IsReadable
= TRUE
;
915 Volume
->VolName
= GetVolumeName(Volume
);
917 // get custom volume icons if present
918 if (!Volume
->VolIconImage
)
919 Volume
->VolIconImage
= egLoadIconAnyType(Volume
->RootDir
, L
"", L
".VolumeIcon", GlobalConfig
.IconSizes
[ICON_SIZE_BIG
]);
922 static VOID
ScanExtendedPartition(REFIT_VOLUME
*WholeDiskVolume
, MBR_PARTITION_INFO
*MbrEntry
)
925 REFIT_VOLUME
*Volume
;
926 UINT32 ExtBase
, ExtCurrent
, NextExtCurrent
;
928 UINTN LogicalPartitionIndex
= 4;
929 UINT8 SectorBuffer
[512];
931 MBR_PARTITION_INFO
*EMbrTable
;
933 ExtBase
= MbrEntry
->StartLBA
;
935 for (ExtCurrent
= ExtBase
; ExtCurrent
; ExtCurrent
= NextExtCurrent
) {
937 Status
= refit_call5_wrapper(WholeDiskVolume
->BlockIO
->ReadBlocks
,
938 WholeDiskVolume
->BlockIO
,
939 WholeDiskVolume
->BlockIO
->Media
->MediaId
,
940 ExtCurrent
, 512, SectorBuffer
);
941 if (EFI_ERROR(Status
))
943 if (*((UINT16
*)(SectorBuffer
+ 510)) != 0xaa55)
945 EMbrTable
= (MBR_PARTITION_INFO
*)(SectorBuffer
+ 446);
947 // scan logical partitions in this EMBR
949 for (i
= 0; i
< 4; i
++) {
950 if ((EMbrTable
[i
].Flags
!= 0x00 && EMbrTable
[i
].Flags
!= 0x80) ||
951 EMbrTable
[i
].StartLBA
== 0 || EMbrTable
[i
].Size
== 0)
953 if (IS_EXTENDED_PART_TYPE(EMbrTable
[i
].Type
)) {
954 // set next ExtCurrent
955 NextExtCurrent
= ExtBase
+ EMbrTable
[i
].StartLBA
;
959 // found a logical partition
960 Volume
= AllocateZeroPool(sizeof(REFIT_VOLUME
));
961 Volume
->DiskKind
= WholeDiskVolume
->DiskKind
;
962 Volume
->IsMbrPartition
= TRUE
;
963 Volume
->MbrPartitionIndex
= LogicalPartitionIndex
++;
964 Volume
->VolName
= AllocateZeroPool(256 * sizeof(UINT16
));
965 SPrint(Volume
->VolName
, 255, L
"Partition %d", Volume
->MbrPartitionIndex
+ 1);
966 Volume
->BlockIO
= WholeDiskVolume
->BlockIO
;
967 Volume
->BlockIOOffset
= ExtCurrent
+ EMbrTable
[i
].StartLBA
;
968 Volume
->WholeDiskBlockIO
= WholeDiskVolume
->BlockIO
;
971 ScanVolumeBootcode(Volume
, &Bootable
);
973 Volume
->HasBootCode
= FALSE
;
975 SetVolumeBadgeIcon(Volume
);
977 AddListElement((VOID
***) &Volumes
, &VolumesCount
, Volume
);
982 } /* VOID ScanExtendedPartition() */
984 VOID
ScanVolumes(VOID
)
988 REFIT_VOLUME
*Volume
, *WholeDiskVolume
;
989 MBR_PARTITION_INFO
*MbrTable
;
990 UINTN HandleCount
= 0;
992 UINTN VolumeIndex
, VolumeIndex2
;
993 UINTN PartitionIndex
;
994 UINTN SectorSum
, i
, VolNumber
= 0;
995 UINT8
*SectorBuffer1
, *SectorBuffer2
;
997 EFI_GUID NullUuid
= NULL_GUID_VALUE
;
1002 ForgetPartitionTables();
1004 // get all filesystem handles
1005 Status
= LibLocateHandle(ByProtocol
, &BlockIoProtocol
, NULL
, &HandleCount
, &Handles
);
1006 UuidList
= AllocateZeroPool(sizeof(EFI_GUID
) * HandleCount
);
1007 if (Status
== EFI_NOT_FOUND
) {
1008 return; // no filesystems. strange, but true...
1010 if (CheckError(Status
, L
"while listing all file systems"))
1013 // first pass: collect information about all handles
1014 for (HandleIndex
= 0; HandleIndex
< HandleCount
; HandleIndex
++) {
1015 Volume
= AllocateZeroPool(sizeof(REFIT_VOLUME
));
1016 Volume
->DeviceHandle
= Handles
[HandleIndex
];
1017 AddPartitionTable(Volume
);
1020 UuidList
[HandleIndex
] = Volume
->VolUuid
;
1021 for (i
= 0; i
< HandleIndex
; i
++) {
1022 if ((CompareMem(&(Volume
->VolUuid
), &(UuidList
[i
]), sizeof(EFI_GUID
)) == 0) &&
1023 (CompareMem(&(Volume
->VolUuid
), &NullUuid
, sizeof(EFI_GUID
)) != 0)) { // Duplicate filesystem UUID
1024 Volume
->IsReadable
= FALSE
;
1028 if (Volume
->IsReadable
)
1029 Volume
->VolNumber
= VolNumber
++;
1031 Volume
->VolNumber
= VOL_UNREADABLE
;
1033 AddListElement((VOID
***) &Volumes
, &VolumesCount
, Volume
);
1035 if (Volume
->DeviceHandle
== SelfLoadedImage
->DeviceHandle
)
1036 SelfVolume
= Volume
;
1038 MyFreePool(Handles
);
1040 if (SelfVolume
== NULL
)
1041 Print(L
"WARNING: SelfVolume not found");
1043 // second pass: relate partitions and whole disk devices
1044 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
1045 Volume
= Volumes
[VolumeIndex
];
1046 // check MBR partition table for extended partitions
1047 if (Volume
->BlockIO
!= NULL
&& Volume
->WholeDiskBlockIO
!= NULL
&&
1048 Volume
->BlockIO
== Volume
->WholeDiskBlockIO
&& Volume
->BlockIOOffset
== 0 &&
1049 Volume
->MbrPartitionTable
!= NULL
) {
1050 MbrTable
= Volume
->MbrPartitionTable
;
1051 for (PartitionIndex
= 0; PartitionIndex
< 4; PartitionIndex
++) {
1052 if (IS_EXTENDED_PART_TYPE(MbrTable
[PartitionIndex
].Type
)) {
1053 ScanExtendedPartition(Volume
, MbrTable
+ PartitionIndex
);
1058 // search for corresponding whole disk volume entry
1059 WholeDiskVolume
= NULL
;
1060 if (Volume
->BlockIO
!= NULL
&& Volume
->WholeDiskBlockIO
!= NULL
&&
1061 Volume
->BlockIO
!= Volume
->WholeDiskBlockIO
) {
1062 for (VolumeIndex2
= 0; VolumeIndex2
< VolumesCount
; VolumeIndex2
++) {
1063 if (Volumes
[VolumeIndex2
]->BlockIO
== Volume
->WholeDiskBlockIO
&&
1064 Volumes
[VolumeIndex2
]->BlockIOOffset
== 0)
1065 WholeDiskVolume
= Volumes
[VolumeIndex2
];
1069 if (WholeDiskVolume
!= NULL
&& WholeDiskVolume
->MbrPartitionTable
!= NULL
) {
1070 // check if this volume is one of the partitions in the table
1071 MbrTable
= WholeDiskVolume
->MbrPartitionTable
;
1072 SectorBuffer1
= AllocatePool(512);
1073 SectorBuffer2
= AllocatePool(512);
1074 for (PartitionIndex
= 0; PartitionIndex
< 4; PartitionIndex
++) {
1076 if ((UINT64
)(MbrTable
[PartitionIndex
].Size
) != Volume
->BlockIO
->Media
->LastBlock
+ 1)
1079 // compare boot sector read through offset vs. directly
1080 Status
= refit_call5_wrapper(Volume
->BlockIO
->ReadBlocks
,
1081 Volume
->BlockIO
, Volume
->BlockIO
->Media
->MediaId
,
1082 Volume
->BlockIOOffset
, 512, SectorBuffer1
);
1083 if (EFI_ERROR(Status
))
1085 Status
= refit_call5_wrapper(Volume
->WholeDiskBlockIO
->ReadBlocks
,
1086 Volume
->WholeDiskBlockIO
, Volume
->WholeDiskBlockIO
->Media
->MediaId
,
1087 MbrTable
[PartitionIndex
].StartLBA
, 512, SectorBuffer2
);
1088 if (EFI_ERROR(Status
))
1090 if (CompareMem(SectorBuffer1
, SectorBuffer2
, 512) != 0)
1093 for (i
= 0; i
< 512; i
++)
1094 SectorSum
+= SectorBuffer1
[i
];
1095 if (SectorSum
< 1000)
1098 // TODO: mark entry as non-bootable if it is an extended partition
1100 // now we're reasonably sure the association is correct...
1101 Volume
->IsMbrPartition
= TRUE
;
1102 Volume
->MbrPartitionIndex
= PartitionIndex
;
1103 if (Volume
->VolName
== NULL
) {
1104 Volume
->VolName
= AllocateZeroPool(sizeof(CHAR16
) * 256);
1105 SPrint(Volume
->VolName
, 255, L
"Partition %d", PartitionIndex
+ 1);
1110 MyFreePool(SectorBuffer1
);
1111 MyFreePool(SectorBuffer2
);
1114 } /* VOID ScanVolumes() */
1116 static VOID
UninitVolumes(VOID
)
1118 REFIT_VOLUME
*Volume
;
1121 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
1122 Volume
= Volumes
[VolumeIndex
];
1124 if (Volume
->RootDir
!= NULL
) {
1125 refit_call1_wrapper(Volume
->RootDir
->Close
, Volume
->RootDir
);
1126 Volume
->RootDir
= NULL
;
1129 Volume
->DeviceHandle
= NULL
;
1130 Volume
->BlockIO
= NULL
;
1131 Volume
->WholeDiskBlockIO
= NULL
;
1135 VOID
ReinitVolumes(VOID
)
1138 REFIT_VOLUME
*Volume
;
1140 EFI_DEVICE_PATH
*RemainingDevicePath
;
1141 EFI_HANDLE DeviceHandle
, WholeDiskHandle
;
1143 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
1144 Volume
= Volumes
[VolumeIndex
];
1146 if (Volume
->DevicePath
!= NULL
) {
1147 // get the handle for that path
1148 RemainingDevicePath
= Volume
->DevicePath
;
1149 Status
= refit_call3_wrapper(BS
->LocateDevicePath
, &BlockIoProtocol
, &RemainingDevicePath
, &DeviceHandle
);
1151 if (!EFI_ERROR(Status
)) {
1152 Volume
->DeviceHandle
= DeviceHandle
;
1154 // get the root directory
1155 Volume
->RootDir
= LibOpenRoot(Volume
->DeviceHandle
);
1158 CheckError(Status
, L
"from LocateDevicePath");
1161 if (Volume
->WholeDiskDevicePath
!= NULL
) {
1162 // get the handle for that path
1163 RemainingDevicePath
= Volume
->WholeDiskDevicePath
;
1164 Status
= refit_call3_wrapper(BS
->LocateDevicePath
, &BlockIoProtocol
, &RemainingDevicePath
, &WholeDiskHandle
);
1166 if (!EFI_ERROR(Status
)) {
1167 // get the BlockIO protocol
1168 Status
= refit_call3_wrapper(BS
->HandleProtocol
, WholeDiskHandle
, &BlockIoProtocol
,
1169 (VOID
**) &Volume
->WholeDiskBlockIO
);
1170 if (EFI_ERROR(Status
)) {
1171 Volume
->WholeDiskBlockIO
= NULL
;
1172 CheckError(Status
, L
"from HandleProtocol");
1175 CheckError(Status
, L
"from LocateDevicePath");
1181 // file and dir functions
1184 BOOLEAN
FileExists(IN EFI_FILE
*BaseDir
, IN CHAR16
*RelativePath
)
1187 EFI_FILE_HANDLE TestFile
;
1189 Status
= refit_call5_wrapper(BaseDir
->Open
, BaseDir
, &TestFile
, RelativePath
, EFI_FILE_MODE_READ
, 0);
1190 if (Status
== EFI_SUCCESS
) {
1191 refit_call1_wrapper(TestFile
->Close
, TestFile
);
1197 EFI_STATUS
DirNextEntry(IN EFI_FILE
*Directory
, IN OUT EFI_FILE_INFO
**DirEntry
, IN UINTN FilterMode
)
1201 UINTN LastBufferSize
, BufferSize
;
1206 // free pointer from last call
1207 if (*DirEntry
!= NULL
) {
1208 FreePool(*DirEntry
);
1212 // read next directory entry
1213 LastBufferSize
= BufferSize
= 256;
1214 Buffer
= AllocatePool(BufferSize
);
1215 for (IterCount
= 0; ; IterCount
++) {
1216 Status
= refit_call3_wrapper(Directory
->Read
, Directory
, &BufferSize
, Buffer
);
1217 if (Status
!= EFI_BUFFER_TOO_SMALL
|| IterCount
>= 4)
1219 if (BufferSize
<= LastBufferSize
) {
1220 Print(L
"FS Driver requests bad buffer size %d (was %d), using %d instead\n", BufferSize
, LastBufferSize
, LastBufferSize
* 2);
1221 BufferSize
= LastBufferSize
* 2;
1224 Print(L
"Reallocating buffer from %d to %d\n", LastBufferSize
, BufferSize
);
1227 Buffer
= EfiReallocatePool(Buffer
, LastBufferSize
, BufferSize
);
1228 LastBufferSize
= BufferSize
;
1230 if (EFI_ERROR(Status
)) {
1236 // check for end of listing
1237 if (BufferSize
== 0) { // end of directory listing
1243 // entry is ready to be returned
1244 *DirEntry
= (EFI_FILE_INFO
*)Buffer
;
1247 if (FilterMode
== 1) { // only return directories
1248 if (((*DirEntry
)->Attribute
& EFI_FILE_DIRECTORY
))
1250 } else if (FilterMode
== 2) { // only return files
1251 if (((*DirEntry
)->Attribute
& EFI_FILE_DIRECTORY
) == 0)
1253 } else // no filter or unknown filter -> return everything
1260 VOID
DirIterOpen(IN EFI_FILE
*BaseDir
, IN CHAR16
*RelativePath OPTIONAL
, OUT REFIT_DIR_ITER
*DirIter
)
1262 if (RelativePath
== NULL
) {
1263 DirIter
->LastStatus
= EFI_SUCCESS
;
1264 DirIter
->DirHandle
= BaseDir
;
1265 DirIter
->CloseDirHandle
= FALSE
;
1267 DirIter
->LastStatus
= refit_call5_wrapper(BaseDir
->Open
, BaseDir
, &(DirIter
->DirHandle
), RelativePath
, EFI_FILE_MODE_READ
, 0);
1268 DirIter
->CloseDirHandle
= EFI_ERROR(DirIter
->LastStatus
) ? FALSE
: TRUE
;
1270 DirIter
->LastFileInfo
= NULL
;
1273 #ifndef __MAKEWITH_GNUEFI
1274 EFI_UNICODE_COLLATION_PROTOCOL
*mUnicodeCollation
= NULL
;
1277 InitializeUnicodeCollationProtocol (VOID
)
1281 if (mUnicodeCollation
!= NULL
) {
1286 // BUGBUG: Proper impelmentation is to locate all Unicode Collation Protocol
1287 // instances first and then select one which support English language.
1288 // Current implementation just pick the first instance.
1290 Status
= gBS
->LocateProtocol (
1291 &gEfiUnicodeCollation2ProtocolGuid
,
1293 (VOID
**) &mUnicodeCollation
1295 if (EFI_ERROR(Status
)) {
1296 Status
= gBS
->LocateProtocol (
1297 &gEfiUnicodeCollationProtocolGuid
,
1299 (VOID
**) &mUnicodeCollation
1307 MetaiMatch (IN CHAR16
*String
, IN CHAR16
*Pattern
)
1309 if (!mUnicodeCollation
) {
1310 InitializeUnicodeCollationProtocol();
1312 if (mUnicodeCollation
)
1313 return mUnicodeCollation
->MetaiMatch (mUnicodeCollation
, String
, Pattern
);
1314 return FALSE
; // Shouldn't happen
1317 static VOID
StrLwr (IN OUT CHAR16
*Str
) {
1318 if (!mUnicodeCollation
) {
1319 InitializeUnicodeCollationProtocol();
1321 if (mUnicodeCollation
)
1322 mUnicodeCollation
->StrLwr (mUnicodeCollation
, Str
);
1327 BOOLEAN
DirIterNext(IN OUT REFIT_DIR_ITER
*DirIter
, IN UINTN FilterMode
, IN CHAR16
*FilePattern OPTIONAL
,
1328 OUT EFI_FILE_INFO
**DirEntry
)
1330 BOOLEAN KeepGoing
= TRUE
;
1334 if (DirIter
->LastFileInfo
!= NULL
) {
1335 FreePool(DirIter
->LastFileInfo
);
1336 DirIter
->LastFileInfo
= NULL
;
1339 if (EFI_ERROR(DirIter
->LastStatus
))
1340 return FALSE
; // stop iteration
1343 DirIter
->LastStatus
= DirNextEntry(DirIter
->DirHandle
, &(DirIter
->LastFileInfo
), FilterMode
);
1344 if (EFI_ERROR(DirIter
->LastStatus
))
1346 if (DirIter
->LastFileInfo
== NULL
) // end of listing
1348 if (FilePattern
!= NULL
) {
1349 if ((DirIter
->LastFileInfo
->Attribute
& EFI_FILE_DIRECTORY
))
1352 while (KeepGoing
&& (OnePattern
= FindCommaDelimited(FilePattern
, i
++)) != NULL
) {
1353 if (MetaiMatch(DirIter
->LastFileInfo
->FileName
, OnePattern
))
1356 // else continue loop
1359 } while (KeepGoing
&& FilePattern
);
1361 *DirEntry
= DirIter
->LastFileInfo
;
1365 EFI_STATUS
DirIterClose(IN OUT REFIT_DIR_ITER
*DirIter
)
1367 if (DirIter
->LastFileInfo
!= NULL
) {
1368 FreePool(DirIter
->LastFileInfo
);
1369 DirIter
->LastFileInfo
= NULL
;
1371 if (DirIter
->CloseDirHandle
)
1372 refit_call1_wrapper(DirIter
->DirHandle
->Close
, DirIter
->DirHandle
);
1373 return DirIter
->LastStatus
;
1377 // file name manipulation
1380 // Returns the filename portion (minus path name) of the
1382 CHAR16
* Basename(IN CHAR16
*Path
)
1390 for (i
= StrLen(Path
); i
> 0; i
--) {
1391 if (Path
[i
-1] == '\\' || Path
[i
-1] == '/') {
1392 FileName
= Path
+ i
;
1401 // Remove the .efi extension from FileName -- for instance, if FileName is
1402 // "fred.efi", returns "fred". If the filename contains no .efi extension,
1403 // returns a copy of the original input.
1404 CHAR16
* StripEfiExtension(CHAR16
*FileName
) {
1406 CHAR16
*Copy
= NULL
;
1408 if ((FileName
!= NULL
) && ((Copy
= StrDuplicate(FileName
)) != NULL
)) {
1409 Length
= StrLen(Copy
);
1410 // Note: Do StriCmp() twice to work around Gigabyte Hybrid EFI case-sensitivity bug....
1411 if ((Length
>= 4) && ((StriCmp(&Copy
[Length
- 4], L
".efi") == 0) || (StriCmp(&Copy
[Length
- 4], L
".EFI") == 0))) {
1412 Copy
[Length
- 4] = 0;
1416 } // CHAR16 * StripExtension()
1419 // memory string search
1422 INTN
FindMem(IN VOID
*Buffer
, IN UINTN BufferLength
, IN VOID
*SearchString
, IN UINTN SearchStringLength
)
1428 BufferLength
-= SearchStringLength
;
1429 for (Offset
= 0; Offset
< BufferLength
; Offset
++, BufferPtr
++) {
1430 if (CompareMem(BufferPtr
, SearchString
, SearchStringLength
) == 0)
1431 return (INTN
)Offset
;
1437 // Performs a case-insensitive search of BigStr for SmallStr.
1438 // Returns TRUE if found, FALSE if not.
1439 BOOLEAN
StriSubCmp(IN CHAR16
*SmallStr
, IN CHAR16
*BigStr
) {
1440 CHAR16
*SmallCopy
, *BigCopy
;
1441 BOOLEAN Found
= FALSE
;
1442 UINTN StartPoint
= 0, NumCompares
= 0, SmallLen
= 0;
1444 if ((SmallStr
!= NULL
) && (BigStr
!= NULL
) && (StrLen(BigStr
) >= StrLen(SmallStr
))) {
1445 SmallCopy
= StrDuplicate(SmallStr
);
1446 BigCopy
= StrDuplicate(BigStr
);
1449 SmallLen
= StrLen(SmallCopy
);
1450 NumCompares
= StrLen(BigCopy
) - SmallLen
+ 1;
1451 while ((!Found
) && (StartPoint
< NumCompares
)) {
1452 Found
= (StrnCmp(SmallCopy
, &BigCopy
[StartPoint
++], SmallLen
) == 0);
1454 MyFreePool(SmallCopy
);
1455 MyFreePool(BigCopy
);
1459 } // BOOLEAN StriSubCmp()
1461 // Merges two strings, creating a new one and returning a pointer to it.
1462 // If AddChar != 0, the specified character is placed between the two original
1463 // strings (unless the first string is NULL or empty). The original input
1464 // string *First is de-allocated and replaced by the new merged string.
1465 // This is similar to StrCat, but safer and more flexible because
1466 // MergeStrings allocates memory that's the correct size for the
1467 // new merged string, so it can take a NULL *First and it cleans
1468 // up the old memory. It should *NOT* be used with a constant
1469 // *First, though....
1470 VOID
MergeStrings(IN OUT CHAR16
**First
, IN CHAR16
*Second
, CHAR16 AddChar
) {
1471 UINTN Length1
= 0, Length2
= 0;
1475 Length1
= StrLen(*First
);
1477 Length2
= StrLen(Second
);
1478 NewString
= AllocatePool(sizeof(CHAR16
) * (Length1
+ Length2
+ 2));
1479 if (NewString
!= NULL
) {
1480 if ((*First
!= NULL
) && (StrLen(*First
) == 0)) {
1484 NewString
[0] = L
'\0';
1485 if (*First
!= NULL
) {
1486 StrCat(NewString
, *First
);
1488 NewString
[Length1
] = AddChar
;
1489 NewString
[Length1
+ 1] = '\0';
1491 } // if (*First != NULL)
1493 StrCat(NewString
, Second
);
1497 Print(L
"Error! Unable to allocate memory in MergeStrings()!\n");
1499 } // static CHAR16* MergeStrings()
1501 // Takes an input pathname (*Path) and returns the part of the filename from
1502 // the final dot onwards, converted to lowercase. If the filename includes
1503 // no dots, or if the input is NULL, returns an empty (but allocated) string.
1504 // The calling function is responsible for freeing the memory associated with
1505 // the return value.
1506 CHAR16
*FindExtension(IN CHAR16
*Path
) {
1508 BOOLEAN Found
= FALSE
, FoundSlash
= FALSE
;
1511 Extension
= AllocateZeroPool(sizeof(CHAR16
));
1514 while ((!Found
) && (!FoundSlash
) && (i
>= 0)) {
1515 if (Path
[i
] == L
'.')
1517 else if ((Path
[i
] == L
'/') || (Path
[i
] == L
'\\'))
1523 MergeStrings(&Extension
, &Path
[i
], 0);
1528 } // CHAR16 *FindExtension
1530 // Takes an input pathname (*Path) and locates the final directory component
1531 // of that name. For instance, if the input path is 'EFI\foo\bar.efi', this
1532 // function returns the string 'foo'.
1533 // Assumes the pathname is separated with backslashes.
1534 CHAR16
*FindLastDirName(IN CHAR16
*Path
) {
1535 UINTN i
, StartOfElement
= 0, EndOfElement
= 0, PathLength
, CopyLength
;
1536 CHAR16
*Found
= NULL
;
1541 PathLength
= StrLen(Path
);
1542 // Find start & end of target element
1543 for (i
= 0; i
< PathLength
; i
++) {
1544 if (Path
[i
] == '\\') {
1545 StartOfElement
= EndOfElement
;
1549 // Extract the target element
1550 if (EndOfElement
> 0) {
1551 while ((StartOfElement
< PathLength
) && (Path
[StartOfElement
] == '\\')) {
1555 if (EndOfElement
>= StartOfElement
) {
1556 CopyLength
= EndOfElement
- StartOfElement
+ 1;
1557 Found
= StrDuplicate(&Path
[StartOfElement
]);
1559 Found
[CopyLength
] = 0;
1560 } // if (EndOfElement >= StartOfElement)
1561 } // if (EndOfElement > 0)
1563 } // CHAR16 *FindLastDirName
1565 // Returns the directory portion of a pathname. For instance,
1566 // if FullPath is 'EFI\foo\bar.efi', this function returns the
1567 // string 'EFI\foo'. The calling function is responsible for
1568 // freeing the returned string's memory.
1569 CHAR16
*FindPath(IN CHAR16
* FullPath
) {
1570 UINTN i
, LastBackslash
= 0;
1571 CHAR16
*PathOnly
= NULL
;
1573 if (FullPath
!= NULL
) {
1574 for (i
= 0; i
< StrLen(FullPath
); i
++) {
1575 if (FullPath
[i
] == '\\')
1578 PathOnly
= StrDuplicate(FullPath
);
1579 if (PathOnly
!= NULL
)
1580 PathOnly
[LastBackslash
] = 0;
1587 * Routine Description:
1593 * String - Null-terminated string to search.
1594 * StrCharSet - Null-terminated string to search for.
1597 * The address of the first occurrence of the matching substring if successful, or NULL otherwise.
1599 CHAR16
* MyStrStr (CHAR16
*String
, CHAR16
*StrCharSet
)
1604 if ((String
== NULL
) || (StrCharSet
== NULL
))
1610 while ((*String
!= L
'\0') && (*StrCharSet
!= L
'\0')) {
1611 if (*String
++ != *StrCharSet
) {
1618 if (*StrCharSet
== L
'\0') {
1623 } // CHAR16 *MyStrStr()
1625 // Restrict TheString to at most Limit characters.
1626 // Does this in two ways:
1627 // - Locates stretches of two or more spaces and compresses
1628 // them down to one space.
1629 // - Truncates TheString
1630 // Returns TRUE if changes were made, FALSE otherwise
1631 BOOLEAN
LimitStringLength(CHAR16
*TheString
, UINTN Limit
) {
1632 CHAR16
*SubString
, *TempString
;
1634 BOOLEAN HasChanged
= FALSE
;
1636 // SubString will be NULL or point WITHIN TheString
1637 SubString
= MyStrStr(TheString
, L
" ");
1638 while (SubString
!= NULL
) {
1640 while (SubString
[i
] == L
' ')
1642 if (i
>= StrLen(SubString
)) {
1643 SubString
[0] = '\0';
1646 TempString
= StrDuplicate(&SubString
[i
]);
1647 if (TempString
!= NULL
) {
1648 StrCpy(&SubString
[1], TempString
);
1649 MyFreePool(TempString
);
1652 // memory allocation problem; abort to avoid potentially infinite loop!
1656 SubString
= MyStrStr(TheString
, L
" ");
1659 // If the string is still too long, truncate it....
1660 if (StrLen(TheString
) > Limit
) {
1661 TheString
[Limit
] = '\0';
1666 } // BOOLEAN LimitStringLength()
1668 // Takes an input loadpath, splits it into disk and filename components, finds a matching
1669 // DeviceVolume, and returns that and the filename (*loader).
1670 VOID
FindVolumeAndFilename(IN EFI_DEVICE_PATH
*loadpath
, OUT REFIT_VOLUME
**DeviceVolume
, OUT CHAR16
**loader
) {
1671 CHAR16
*DeviceString
, *VolumeDeviceString
, *Temp
;
1673 BOOLEAN Found
= FALSE
;
1675 MyFreePool(*loader
);
1676 MyFreePool(*DeviceVolume
);
1677 *DeviceVolume
= NULL
;
1678 DeviceString
= DevicePathToStr(loadpath
);
1679 *loader
= SplitDeviceString(DeviceString
);
1681 while ((i
< VolumesCount
) && (!Found
)) {
1682 VolumeDeviceString
= DevicePathToStr(Volumes
[i
]->DevicePath
);
1683 Temp
= SplitDeviceString(VolumeDeviceString
);
1684 if (StriCmp(DeviceString
, VolumeDeviceString
) == 0) {
1686 *DeviceVolume
= Volumes
[i
];
1689 MyFreePool(VolumeDeviceString
);
1693 MyFreePool(DeviceString
);
1694 } // VOID FindVolumeAndFilename()
1696 // Splits a volume/filename string (e.g., "fs0:\EFI\BOOT") into separate
1697 // volume and filename components (e.g., "fs0" and "\EFI\BOOT"), returning
1698 // the filename component in the original *Path variable and the split-off
1699 // volume component in the *VolName variable.
1700 // Returns TRUE if both components are found, FALSE otherwise.
1701 BOOLEAN
SplitVolumeAndFilename(IN OUT CHAR16
**Path
, OUT CHAR16
**VolName
) {
1702 UINTN i
= 0, Length
;
1708 if (*VolName
!= NULL
) {
1709 MyFreePool(*VolName
);
1713 Length
= StrLen(*Path
);
1714 while ((i
< Length
) && ((*Path
)[i
] != L
':')) {
1719 Filename
= StrDuplicate((*Path
) + i
+ 1);
1727 } // BOOLEAN SplitVolumeAndFilename()
1729 // Returns all the digits in the input string, including intervening
1730 // non-digit characters. For instance, if InString is "foo-3.3.4-7.img",
1731 // this function returns "3.3.4-7". If InString contains no digits,
1732 // the return value is NULL.
1733 CHAR16
*FindNumbers(IN CHAR16
*InString
) {
1734 UINTN i
, StartOfElement
, EndOfElement
= 0, InLength
, CopyLength
;
1735 CHAR16
*Found
= NULL
;
1737 if (InString
== NULL
)
1740 InLength
= StartOfElement
= StrLen(InString
);
1741 // Find start & end of target element
1742 for (i
= 0; i
< InLength
; i
++) {
1743 if ((InString
[i
] >= '0') && (InString
[i
] <= '9')) {
1744 if (StartOfElement
> i
)
1746 if (EndOfElement
< i
)
1750 // Extract the target element
1751 if (EndOfElement
> 0) {
1752 if (EndOfElement
>= StartOfElement
) {
1753 CopyLength
= EndOfElement
- StartOfElement
+ 1;
1754 Found
= StrDuplicate(&InString
[StartOfElement
]);
1756 Found
[CopyLength
] = 0;
1757 } // if (EndOfElement >= StartOfElement)
1758 } // if (EndOfElement > 0)
1760 } // CHAR16 *FindNumbers()
1762 // Find the #Index element (numbered from 0) in a comma-delimited string
1764 // Returns the found element, or NULL if Index is out of range or InString
1765 // is NULL. Note that the calling function is responsible for freeing the
1766 // memory associated with the returned string pointer.
1767 CHAR16
*FindCommaDelimited(IN CHAR16
*InString
, IN UINTN Index
) {
1768 UINTN StartPos
= 0, CurPos
= 0;
1769 BOOLEAN Found
= FALSE
;
1770 CHAR16
*FoundString
= NULL
;
1772 if (InString
!= NULL
) {
1773 // After while() loop, StartPos marks start of item #Index
1774 while ((Index
> 0) && (CurPos
< StrLen(InString
))) {
1775 if (InString
[CurPos
] == L
',') {
1777 StartPos
= CurPos
+ 1;
1781 // After while() loop, CurPos is one past the end of the element
1782 while ((CurPos
< StrLen(InString
)) && (!Found
)) {
1783 if (InString
[CurPos
] == L
',')
1789 FoundString
= StrDuplicate(&InString
[StartPos
]);
1790 if (FoundString
!= NULL
)
1791 FoundString
[CurPos
- StartPos
] = 0;
1793 return (FoundString
);
1794 } // CHAR16 *FindCommaDelimited()
1796 // Return the position of SmallString within BigString, or -1 if
1798 INTN
FindSubString(IN CHAR16
*SmallString
, IN CHAR16
*BigString
) {
1800 UINTN i
= 0, SmallSize
, BigSize
;
1801 BOOLEAN Found
= FALSE
;
1803 if ((SmallString
== NULL
) || (BigString
== NULL
))
1806 SmallSize
= StrLen(SmallString
);
1807 BigSize
= StrLen(BigString
);
1808 if ((SmallSize
> BigSize
) || (SmallSize
== 0) || (BigSize
== 0))
1811 while ((i
<= (BigSize
- SmallSize
) && !Found
)) {
1812 if (CompareMem(BigString
+ i
, SmallString
, SmallSize
) == 0) {
1819 } // INTN FindSubString()
1821 // Take an input path name, which may include a volume specification and/or
1822 // a path, and return separate volume, path, and file names. For instance,
1823 // "BIGVOL:\EFI\ubuntu\grubx64.efi" will return a VolName of "BIGVOL", a Path
1824 // of "EFI\ubuntu", and a Filename of "grubx64.efi". If an element is missing,
1825 // the returned pointer is NULL. The calling function is responsible for
1826 // freeing the allocated memory.
1827 VOID
SplitPathName(CHAR16
*InPath
, CHAR16
**VolName
, CHAR16
**Path
, CHAR16
**Filename
) {
1828 CHAR16
*Temp
= NULL
;
1830 MyFreePool(*VolName
);
1832 MyFreePool(*Filename
);
1833 *VolName
= *Path
= *Filename
= NULL
;
1834 Temp
= StrDuplicate(InPath
);
1835 SplitVolumeAndFilename(&Temp
, VolName
); // VolName is NULL or has volume; Temp has rest of path
1836 CleanUpPathNameSlashes(Temp
);
1837 *Path
= FindPath(Temp
); // *Path has path (may be 0-length); Temp unchanged.
1838 *Filename
= StrDuplicate(Temp
+ StrLen(*Path
));
1839 CleanUpPathNameSlashes(*Filename
);
1840 if (StrLen(*Path
) == 0) {
1844 if (StrLen(*Filename
) == 0) {
1845 MyFreePool(*Filename
);
1849 } // VOID SplitPathName
1851 // Returns TRUE if SmallString is an element in the comma-delimited List,
1852 // FALSE otherwise. Performs comparison case-insensitively (except on
1853 // buggy EFIs with case-sensitive StriCmp() functions).
1854 BOOLEAN
IsIn(IN CHAR16
*SmallString
, IN CHAR16
*List
) {
1856 BOOLEAN Found
= FALSE
;
1859 if (SmallString
&& List
) {
1860 while (!Found
&& (OneElement
= FindCommaDelimited(List
, i
++))) {
1861 if (StriCmp(OneElement
, SmallString
) == 0)
1868 // Returns TRUE if specified Volume, Directory, and Filename correspond to an
1869 // element in the comma-delimited List, FALSE otherwise. Note that Directory and
1870 // Filename must *NOT* include a volume or path specification (that's part of
1871 // the Volume variable), but the List elements may. Performs comparison
1872 // case-insensitively (except on buggy EFIs with case-sensitive StriCmp()
1874 BOOLEAN
FilenameIn(REFIT_VOLUME
*Volume
, CHAR16
*Directory
, CHAR16
*Filename
, CHAR16
*List
) {
1876 BOOLEAN Found
= FALSE
;
1878 CHAR16
*TargetVolName
= NULL
, *TargetPath
= NULL
, *TargetFilename
= NULL
;
1880 if (Filename
&& List
) {
1881 while (!Found
&& (OneElement
= FindCommaDelimited(List
, i
++))) {
1883 SplitPathName(OneElement
, &TargetVolName
, &TargetPath
, &TargetFilename
);
1884 VolumeNumberToName(Volume
, &TargetVolName
);
1885 if (((TargetVolName
!= NULL
) && ((Volume
== NULL
) || (StriCmp(TargetVolName
, Volume
->VolName
) != 0))) ||
1886 ((TargetPath
!= NULL
) && (StriCmp(TargetPath
, Directory
) != 0)) ||
1887 ((TargetFilename
!= NULL
) && (StriCmp(TargetFilename
, Filename
) != 0))) {
1890 MyFreePool(OneElement
);
1894 MyFreePool(TargetVolName
);
1895 MyFreePool(TargetPath
);
1896 MyFreePool(TargetFilename
);
1898 } // BOOLEAN FilenameIn()
1900 // If *VolName is of the form "fs#", where "#" is a number, and if Volume points
1901 // to this volume number, returns with *VolName changed to the volume name, as
1902 // stored in the Volume data structure.
1903 // Returns TRUE if this substitution was made, FALSE otherwise.
1904 BOOLEAN
VolumeNumberToName(REFIT_VOLUME
*Volume
, CHAR16
**VolName
) {
1905 BOOLEAN MadeSubstitution
= FALSE
;
1908 if ((VolName
== NULL
) || (*VolName
== NULL
))
1911 if ((StrLen(*VolName
) > 2) && (*VolName
[0] == L
'f') && (*VolName
[1] == L
's') && (*VolName
[2] >= L
'0') && (*VolName
[2] <= L
'9')) {
1912 VolNum
= Atoi(*VolName
+ 2);
1913 if (VolNum
== Volume
->VolNumber
) {
1914 MyFreePool(*VolName
);
1915 *VolName
= StrDuplicate(Volume
->VolName
);
1916 MadeSubstitution
= TRUE
;
1919 return MadeSubstitution
;
1920 } // BOOLEAN VolumeMatchesNumber()
1922 // Implement FreePool the way it should have been done to begin with, so that
1923 // it doesn't throw an ASSERT message if fed a NULL pointer....
1924 VOID
MyFreePool(IN VOID
*Pointer
) {
1925 if (Pointer
!= NULL
)
1929 static EFI_GUID AppleRemovableMediaGuid
= APPLE_REMOVABLE_MEDIA_PROTOCOL_GUID
;
1931 // Eject all removable media.
1932 // Returns TRUE if any media were ejected, FALSE otherwise.
1933 BOOLEAN
EjectMedia(VOID
) {
1935 UINTN HandleIndex
, HandleCount
= 0, Ejected
= 0;
1936 EFI_HANDLE
*Handles
, Handle
;
1937 APPLE_REMOVABLE_MEDIA_PROTOCOL
*Ejectable
;
1939 Status
= LibLocateHandle(ByProtocol
, &AppleRemovableMediaGuid
, NULL
, &HandleCount
, &Handles
);
1940 if (EFI_ERROR(Status
) || HandleCount
== 0)
1941 return (FALSE
); // probably not an Apple system
1943 for (HandleIndex
= 0; HandleIndex
< HandleCount
; HandleIndex
++) {
1944 Handle
= Handles
[HandleIndex
];
1945 Status
= refit_call3_wrapper(BS
->HandleProtocol
, Handle
, &AppleRemovableMediaGuid
, (VOID
**) &Ejectable
);
1946 if (EFI_ERROR(Status
))
1948 Status
= refit_call1_wrapper(Ejectable
->Eject
, Ejectable
);
1949 if (!EFI_ERROR(Status
))
1952 MyFreePool(Handles
);
1953 return (Ejected
> 0);
1954 } // VOID EjectMedia()
1956 // Converts consecutive characters in the input string into a
1957 // number, interpreting the string as a hexadecimal number, starting
1958 // at the specified position and continuing for the specified number
1959 // of characters or until the end of the string, whichever is first.
1960 // NumChars must be between 1 and 16. Ignores invalid characters.
1961 UINT64
StrToHex(CHAR16
*Input
, UINTN Pos
, UINTN NumChars
) {
1962 UINT64 retval
= 0x00;
1966 if ((Input
== NULL
) || (StrLen(Input
) < Pos
) || (NumChars
== 0) || (NumChars
> 16)) {
1970 while ((StrLen(Input
) >= Pos
) && (NumDone
< NumChars
)) {
1972 if ((a
>= '0') && (a
<= '9')) {
1974 retval
+= (a
- '0');
1977 if ((a
>= 'a') && (a
<= 'f')) {
1979 retval
+= (a
- 'a' + 0x0a);
1982 if ((a
>= 'A') && (a
<= 'F')) {
1984 retval
+= (a
- 'A' + 0x0a);
1992 // Returns TRUE if UnknownString can be interpreted as a GUID, FALSE otherwise.
1993 // Note that the input string must have no extraneous spaces and must be
1994 // conventionally formatted as a 36-character GUID, complete with dashes in
1995 // appropriate places.
1996 BOOLEAN
IsGuid(CHAR16
*UnknownString
) {
1998 BOOLEAN retval
= TRUE
;
2001 if (UnknownString
== NULL
)
2004 Length
= StrLen(UnknownString
);
2008 for (i
= 0; i
< Length
; i
++) {
2009 a
= UnknownString
[i
];
2010 if (((i
== 8) || (i
== 13) || (i
== 18) || (i
== 23)) && (a
!= '-')) {
2012 } else if (((a
< 'a') || (a
> 'f')) && ((a
< 'A') || (a
> 'F')) && ((a
< '0') && (a
> '9'))) {
2017 } // BOOLEAN IsGuid()
2019 // Return the GUID as a string, suitable for display to the user. Note that the calling
2020 // function is responsible for freeing the allocated memory.
2021 CHAR16
* GuidAsString(EFI_GUID
*GuidData
) {
2024 TheString
= AllocateZeroPool(42 * sizeof(CHAR16
));
2025 if (TheString
!= 0) {
2026 SPrint (TheString
, 82, L
"%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x",
2027 (UINTN
)GuidData
->Data1
, (UINTN
)GuidData
->Data2
, (UINTN
)GuidData
->Data3
,
2028 (UINTN
)GuidData
->Data4
[0], (UINTN
)GuidData
->Data4
[1], (UINTN
)GuidData
->Data4
[2],
2029 (UINTN
)GuidData
->Data4
[3], (UINTN
)GuidData
->Data4
[4], (UINTN
)GuidData
->Data4
[5],
2030 (UINTN
)GuidData
->Data4
[6], (UINTN
)GuidData
->Data4
[7]);
2033 } // GuidAsString(EFI_GUID *GuidData)
2035 EFI_GUID
StringAsGuid(CHAR16
* InString
) {
2036 EFI_GUID Guid
= NULL_GUID_VALUE
;
2038 if (!IsGuid(InString
)) {
2042 Guid
.Data1
= (UINT32
) StrToHex(InString
, 0, 8);
2043 Guid
.Data2
= (UINT16
) StrToHex(InString
, 9, 4);
2044 Guid
.Data3
= (UINT16
) StrToHex(InString
, 14, 4);
2045 Guid
.Data4
[0] = (UINT8
) StrToHex(InString
, 19, 2);
2046 Guid
.Data4
[1] = (UINT8
) StrToHex(InString
, 21, 2);
2047 Guid
.Data4
[2] = (UINT8
) StrToHex(InString
, 23, 2);
2048 Guid
.Data4
[3] = (UINT8
) StrToHex(InString
, 26, 2);
2049 Guid
.Data4
[4] = (UINT8
) StrToHex(InString
, 28, 2);
2050 Guid
.Data4
[5] = (UINT8
) StrToHex(InString
, 30, 2);
2051 Guid
.Data4
[6] = (UINT8
) StrToHex(InString
, 32, 2);
2052 Guid
.Data4
[7] = (UINT8
) StrToHex(InString
, 34, 2);
2055 } // EFI_GUID StringAsGuid()
2057 // Returns TRUE if the two GUIDs are equal, FALSE otherwise
2058 BOOLEAN
GuidsAreEqual(EFI_GUID
*Guid1
, EFI_GUID
*Guid2
) {
2059 return (CompareMem(Guid1
, Guid2
, 16) == 0);
2060 } // BOOLEAN CompareGuids()