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-2015 Roderick W. Smith
39 * Modifications distributed under the terms of the GNU General Public
40 * License (GPL) version 3 (GPLv3), a copy of which must be distributed
41 * with this source code or binaries made from it.
49 #include "../include/refit_call_wrapper.h"
50 #include "../include/RemovableMedia.h"
53 #include "../EfiLib/LegacyBios.h"
55 #ifdef __MAKEWITH_GNUEFI
56 #define EfiReallocatePool ReallocatePool
58 #define LibLocateHandle gBS->LocateHandleBuffer
59 #define DevicePathProtocol gEfiDevicePathProtocolGuid
60 #define BlockIoProtocol gEfiBlockIoProtocolGuid
61 #define LibFileSystemInfo EfiLibFileSystemInfo
62 #define LibOpenRoot EfiLibOpenRoot
63 EFI_DEVICE_PATH EndDevicePath
[] = {
64 {END_DEVICE_PATH_TYPE
, END_ENTIRE_DEVICE_PATH_SUBTYPE
, {END_DEVICE_PATH_LENGTH
, 0}}
67 //#define EndDevicePath DevicePath
70 // "Magic" signatures for various filesystems
71 #define FAT_MAGIC 0xAA55
72 #define EXT2_SUPER_MAGIC 0xEF53
73 #define HFSPLUS_MAGIC1 0x2B48
74 #define HFSPLUS_MAGIC2 0x5848
75 #define REISERFS_SUPER_MAGIC_STRING "ReIsErFs"
76 #define REISER2FS_SUPER_MAGIC_STRING "ReIsEr2Fs"
77 #define REISER2FS_JR_SUPER_MAGIC_STRING "ReIsEr3Fs"
78 #define BTRFS_SIGNATURE "_BHRfS_M"
79 #define XFS_SIGNATURE "XFSB"
80 #define NTFS_SIGNATURE "NTFS "
84 EFI_HANDLE SelfImageHandle
;
85 EFI_LOADED_IMAGE
*SelfLoadedImage
;
86 EFI_FILE
*SelfRootDir
;
90 REFIT_VOLUME
*SelfVolume
= NULL
;
91 REFIT_VOLUME
**Volumes
= NULL
;
92 UINTN VolumesCount
= 0;
93 extern GPT_DATA
*gPartitions
;
95 // Maximum size for disk sectors
96 #define SECTOR_SIZE 4096
98 // Number of bytes to read from a partition to determine its filesystem type
99 // and identify its boot loader, and hence probable BIOS-mode OS installation
100 #define SAMPLE_SIZE 69632 /* 68 KiB -- ReiserFS superblock begins at 64 KiB */
105 static EFI_STATUS
FinishInitRefitLib(VOID
);
107 static VOID
UninitVolumes(VOID
);
110 // self recognition stuff
113 // Converts forward slashes to backslashes, removes duplicate slashes, and
114 // removes slashes from both the start and end of the pathname.
115 // Necessary because some (buggy?) EFI implementations produce "\/" strings
116 // in pathnames, because some user inputs can produce duplicate directory
117 // separators, and because we want consistent start and end slashes for
118 // directory comparisons. A special case: If the PathName refers to root,
119 // return "/", since some firmware implementations flake out if this
121 VOID
CleanUpPathNameSlashes(IN OUT CHAR16
*PathName
) {
123 UINTN i
, Length
, FinalChar
= 0;
124 BOOLEAN LastWasSlash
= FALSE
;
126 Length
= StrLen(PathName
);
127 NewName
= AllocateZeroPool(sizeof(CHAR16
) * (Length
+ 2));
128 if (NewName
!= NULL
) {
129 for (i
= 0; i
< StrLen(PathName
); i
++) {
130 if ((PathName
[i
] == L
'/') || (PathName
[i
] == L
'\\')) {
131 if ((!LastWasSlash
) && (FinalChar
!= 0))
132 NewName
[FinalChar
++] = L
'\\';
135 NewName
[FinalChar
++] = PathName
[i
];
136 LastWasSlash
= FALSE
;
139 NewName
[FinalChar
] = 0;
140 if ((FinalChar
> 0) && (NewName
[FinalChar
- 1] == L
'\\'))
141 NewName
[--FinalChar
] = 0;
142 if (FinalChar
== 0) {
146 // Copy the transformed name back....
147 StrCpy(PathName
, NewName
);
149 } // if allocation OK
150 } // CleanUpPathNameSlashes()
152 // Splits an EFI device path into device and filename components. For instance, if InString is
153 // PciRoot(0x0)/Pci(0x1f,0x2)/Ata(Secondary,Master,0x0)/HD(2,GPT,8314ae90-ada3-48e9-9c3b-09a88f80d921,0x96028,0xfa000)/\bzImage-3.5.1.efi,
154 // this function will truncate that input to
155 // PciRoot(0x0)/Pci(0x1f,0x2)/Ata(Secondary,Master,0x0)/HD(2,GPT,8314ae90-ada3-48e9-9c3b-09a88f80d921,0x96028,0xfa000)
156 // and return bzImage-3.5.1.efi as its return value.
157 // It does this by searching for the last ")" character in InString, copying everything
158 // after that string (after some cleanup) as the return value, and truncating the original
160 // If InString contains no ")" character, this function leaves the original input string
161 // unmodified and also returns that string. If InString is NULL, this function returns NULL.
162 static CHAR16
* SplitDeviceString(IN OUT CHAR16
*InString
) {
164 CHAR16
*FileName
= NULL
;
165 BOOLEAN Found
= FALSE
;
167 if (InString
!= NULL
) {
168 i
= StrLen(InString
) - 1;
169 while ((i
>= 0) && (!Found
)) {
170 if (InString
[i
] == L
')') {
172 FileName
= StrDuplicate(&InString
[i
+ 1]);
173 CleanUpPathNameSlashes(FileName
);
174 InString
[i
+ 1] = '\0';
178 if (FileName
== NULL
)
179 FileName
= StrDuplicate(InString
);
182 } // static CHAR16* SplitDeviceString()
184 EFI_STATUS
InitRefitLib(IN EFI_HANDLE ImageHandle
)
187 CHAR16
*DevicePathAsString
, *Temp
;
189 SelfImageHandle
= ImageHandle
;
190 Status
= refit_call3_wrapper(BS
->HandleProtocol
, SelfImageHandle
, &LoadedImageProtocol
, (VOID
**) &SelfLoadedImage
);
191 if (CheckFatalError(Status
, L
"while getting a LoadedImageProtocol handle"))
192 return EFI_LOAD_ERROR
;
194 // find the current directory
195 DevicePathAsString
= DevicePathToStr(SelfLoadedImage
->FilePath
);
196 CleanUpPathNameSlashes(DevicePathAsString
);
197 MyFreePool(SelfDirPath
);
198 Temp
= FindPath(DevicePathAsString
);
199 SelfDirPath
= SplitDeviceString(Temp
);
200 MyFreePool(DevicePathAsString
);
203 return FinishInitRefitLib();
206 // called before running external programs to close open file handles
207 VOID
UninitRefitLib(VOID
)
209 // This piece of code was made to correspond to weirdness in ReinitRefitLib().
210 // See the comment on it there.
211 if(SelfRootDir
== SelfVolume
->RootDir
)
216 if (SelfDir
!= NULL
) {
217 refit_call1_wrapper(SelfDir
->Close
, SelfDir
);
221 if (SelfRootDir
!= NULL
) {
222 refit_call1_wrapper(SelfRootDir
->Close
, SelfRootDir
);
227 // called after running external programs to re-open file handles
228 EFI_STATUS
ReinitRefitLib(VOID
)
232 if ((ST
->Hdr
.Revision
>> 16) == 1) {
233 // Below two lines were in rEFIt, but seem to cause system crashes or
234 // reboots when launching OSes after returning from programs on most
235 // systems. OTOH, my Mac Mini produces errors about "(re)opening our
236 // installation volume" (see the next function) when returning from
237 // programs when these two lines are removed, and it often crashes
238 // when returning from a program or when launching a second program
239 // with these lines removed. Therefore, the preceding if() statement
240 // executes these lines only on EFIs with a major version number of 1
241 // (which Macs have) and not with 2 (which UEFI PCs have). My selection
242 // of hardware on which to test is limited, though, so this may be the
243 // wrong test, or there may be a better way to fix this problem.
244 // TODO: Figure out cause of above weirdness and fix it more
246 if (SelfVolume
!= NULL
&& SelfVolume
->RootDir
!= NULL
)
247 SelfRootDir
= SelfVolume
->RootDir
;
250 return FinishInitRefitLib();
253 static EFI_STATUS
FinishInitRefitLib(VOID
)
257 if (SelfRootDir
== NULL
) {
258 SelfRootDir
= LibOpenRoot(SelfLoadedImage
->DeviceHandle
);
259 if (SelfRootDir
== NULL
) {
260 CheckError(EFI_LOAD_ERROR
, L
"while (re)opening our installation volume");
261 return EFI_LOAD_ERROR
;
265 Status
= refit_call5_wrapper(SelfRootDir
->Open
, SelfRootDir
, &SelfDir
, SelfDirPath
, EFI_FILE_MODE_READ
, 0);
266 if (CheckFatalError(Status
, L
"while opening our installation directory"))
267 return EFI_LOAD_ERROR
;
273 // EFI variable read and write functions
276 // From gummiboot: Retrieve a raw EFI variable.
277 // Returns EFI status
278 EFI_STATUS
EfivarGetRaw(EFI_GUID
*vendor
, CHAR16
*name
, CHAR8
**buffer
, UINTN
*size
) {
283 l
= sizeof(CHAR16
*) * EFI_MAXIMUM_VARIABLE_SIZE
;
284 buf
= AllocatePool(l
);
286 return EFI_OUT_OF_RESOURCES
;
288 err
= refit_call5_wrapper(RT
->GetVariable
, name
, vendor
, NULL
, &l
, buf
);
289 if (EFI_ERROR(err
) == EFI_SUCCESS
) {
296 } // EFI_STATUS EfivarGetRaw()
298 // From gummiboot: Set an EFI variable
299 EFI_STATUS
EfivarSetRaw(EFI_GUID
*vendor
, CHAR16
*name
, CHAR8
*buf
, UINTN size
, BOOLEAN persistent
) {
302 flags
= EFI_VARIABLE_BOOTSERVICE_ACCESS
|EFI_VARIABLE_RUNTIME_ACCESS
;
304 flags
|= EFI_VARIABLE_NON_VOLATILE
;
306 return refit_call5_wrapper(RT
->SetVariable
, name
, vendor
, flags
, size
, buf
);
307 } // EFI_STATUS EfivarSetRaw()
313 VOID
AddListElement(IN OUT VOID
***ListPtr
, IN OUT UINTN
*ElementCount
, IN VOID
*NewElement
)
317 if ((*ElementCount
& 15) == 0) {
318 AllocateCount
= *ElementCount
+ 16;
319 if (*ElementCount
== 0)
320 *ListPtr
= AllocatePool(sizeof(VOID
*) * AllocateCount
);
322 *ListPtr
= EfiReallocatePool(*ListPtr
, sizeof(VOID
*) * (*ElementCount
), sizeof(VOID
*) * AllocateCount
);
324 (*ListPtr
)[*ElementCount
] = NewElement
;
326 } /* VOID AddListElement() */
328 VOID
FreeList(IN OUT VOID
***ListPtr
, IN OUT UINTN
*ElementCount
)
332 if ((*ElementCount
> 0) && (**ListPtr
!= NULL
)) {
333 for (i
= 0; i
< *ElementCount
; i
++) {
334 // TODO: call a user-provided routine for each element here
335 MyFreePool((*ListPtr
)[i
]);
337 MyFreePool(*ListPtr
);
342 // firmware device path discovery
345 static UINT8 LegacyLoaderMediaPathData
[] = {
346 0x04, 0x06, 0x14, 0x00, 0xEB, 0x85, 0x05, 0x2B,
347 0xB8, 0xD8, 0xA9, 0x49, 0x8B, 0x8C, 0xE2, 0x1B,
348 0x01, 0xAE, 0xF2, 0xB7, 0x7F, 0xFF, 0x04, 0x00,
350 static EFI_DEVICE_PATH
*LegacyLoaderMediaPath
= (EFI_DEVICE_PATH
*)LegacyLoaderMediaPathData
;
352 VOID
ExtractLegacyLoaderPaths(EFI_DEVICE_PATH
**PathList
, UINTN MaxPaths
, EFI_DEVICE_PATH
**HardcodedPathList
)
355 UINTN HandleCount
= 0;
356 UINTN HandleIndex
, HardcodedIndex
;
361 EFI_LOADED_IMAGE
*LoadedImage
;
362 EFI_DEVICE_PATH
*DevicePath
;
365 MaxPaths
--; // leave space for the terminating NULL pointer
367 // get all LoadedImage handles
368 Status
= LibLocateHandle(ByProtocol
, &LoadedImageProtocol
, NULL
, &HandleCount
, &Handles
);
369 if (CheckError(Status
, L
"while listing LoadedImage handles")) {
370 if (HardcodedPathList
) {
371 for (HardcodedIndex
= 0; HardcodedPathList
[HardcodedIndex
] && PathCount
< MaxPaths
; HardcodedIndex
++)
372 PathList
[PathCount
++] = HardcodedPathList
[HardcodedIndex
];
374 PathList
[PathCount
] = NULL
;
377 for (HandleIndex
= 0; HandleIndex
< HandleCount
&& PathCount
< MaxPaths
; HandleIndex
++) {
378 Handle
= Handles
[HandleIndex
];
380 Status
= refit_call3_wrapper(BS
->HandleProtocol
, Handle
, &LoadedImageProtocol
, (VOID
**) &LoadedImage
);
381 if (EFI_ERROR(Status
))
382 continue; // This can only happen if the firmware scewed up, ignore it.
384 Status
= refit_call3_wrapper(BS
->HandleProtocol
, LoadedImage
->DeviceHandle
, &DevicePathProtocol
, (VOID
**) &DevicePath
);
385 if (EFI_ERROR(Status
))
386 continue; // This happens, ignore it.
388 // Only grab memory range nodes
389 if (DevicePathType(DevicePath
) != HARDWARE_DEVICE_PATH
|| DevicePathSubType(DevicePath
) != HW_MEMMAP_DP
)
392 // Check if we have this device path in the list already
393 // WARNING: This assumes the first node in the device path is unique!
395 for (PathIndex
= 0; PathIndex
< PathCount
; PathIndex
++) {
396 if (DevicePathNodeLength(DevicePath
) != DevicePathNodeLength(PathList
[PathIndex
]))
398 if (CompareMem(DevicePath
, PathList
[PathIndex
], DevicePathNodeLength(DevicePath
)) == 0) {
406 PathList
[PathCount
++] = AppendDevicePath(DevicePath
, LegacyLoaderMediaPath
);
410 if (HardcodedPathList
) {
411 for (HardcodedIndex
= 0; HardcodedPathList
[HardcodedIndex
] && PathCount
< MaxPaths
; HardcodedIndex
++)
412 PathList
[PathCount
++] = HardcodedPathList
[HardcodedIndex
];
414 PathList
[PathCount
] = NULL
;
421 // Return a pointer to a string containing a filesystem type name. If the
422 // filesystem type is unknown, a blank (but non-null) string is returned.
423 // The returned variable is a constant that should NOT be freed.
424 static CHAR16
*FSTypeName(IN UINT32 TypeCode
) {
425 CHAR16
*retval
= NULL
;
428 case FS_TYPE_WHOLEDISK
:
429 retval
= L
" whole disk";
434 case FS_TYPE_HFSPLUS
:
446 case FS_TYPE_REISERFS
:
447 retval
= L
" ReiserFS";
455 case FS_TYPE_ISO9660
:
456 retval
= L
" ISO-9660";
466 } // CHAR16 *FSTypeName()
468 // Identify the filesystem type and record the filesystem's UUID/serial number,
469 // if possible. Expects a Buffer containing the first few (normally at least
470 // 4096) bytes of the filesystem. Sets the filesystem type code in Volume->FSType
471 // and the UUID/serial number in Volume->VolUuid. Note that the UUID value is
472 // recognized differently for each filesystem, and is currently supported only
473 // for NTFS, ext2/3/4fs, and ReiserFS (and for NTFS it's really a 64-bit serial
474 // number not a UUID or GUID). If the UUID can't be determined, it's set to 0.
475 // Also, the UUID is just read directly into memory; it is *NOT* valid when
476 // displayed by GuidAsString() or used in other GUID/UUID-manipulating
477 // functions. (As I write, it's being used merely to detect partitions that are
478 // part of a RAID 1 array.)
479 static VOID
SetFilesystemData(IN UINT8
*Buffer
, IN UINTN BufferSize
, IN OUT REFIT_VOLUME
*Volume
) {
480 UINT32
*Ext2Incompat
, *Ext2Compat
;
485 if ((Buffer
!= NULL
) && (Volume
!= NULL
)) {
486 SetMem(&(Volume
->VolUuid
), sizeof(EFI_GUID
), 0);
487 Volume
->FSType
= FS_TYPE_UNKNOWN
;
489 if (BufferSize
>= (1024 + 100)) {
490 Magic16
= (UINT16
*) (Buffer
+ 1024 + 56);
491 if (*Magic16
== EXT2_SUPER_MAGIC
) { // ext2/3/4
492 Ext2Compat
= (UINT32
*) (Buffer
+ 1024 + 92);
493 Ext2Incompat
= (UINT32
*) (Buffer
+ 1024 + 96);
494 if ((*Ext2Incompat
& 0x0040) || (*Ext2Incompat
& 0x0200)) { // check for extents or flex_bg
495 Volume
->FSType
= FS_TYPE_EXT4
;
496 } else if (*Ext2Compat
& 0x0004) { // check for journal
497 Volume
->FSType
= FS_TYPE_EXT3
;
498 } else { // none of these features; presume it's ext2...
499 Volume
->FSType
= FS_TYPE_EXT2
;
501 CopyMem(&(Volume
->VolUuid
), Buffer
+ 1024 + 104, sizeof(EFI_GUID
));
504 } // search for ext2/3/4 magic
506 if (BufferSize
>= (65536 + 100)) {
507 MagicString
= (char*) (Buffer
+ 65536 + 52);
508 if ((CompareMem(MagicString
, REISERFS_SUPER_MAGIC_STRING
, 8) == 0) ||
509 (CompareMem(MagicString
, REISER2FS_SUPER_MAGIC_STRING
, 9) == 0) ||
510 (CompareMem(MagicString
, REISER2FS_JR_SUPER_MAGIC_STRING
, 9) == 0)) {
511 Volume
->FSType
= FS_TYPE_REISERFS
;
512 CopyMem(&(Volume
->VolUuid
), Buffer
+ 65536 + 84, sizeof(EFI_GUID
));
515 } // search for ReiserFS magic
517 if (BufferSize
>= (65536 + 64 + 8)) {
518 MagicString
= (char*) (Buffer
+ 65536 + 64);
519 if (CompareMem(MagicString
, BTRFS_SIGNATURE
, 8) == 0) {
520 Volume
->FSType
= FS_TYPE_BTRFS
;
523 } // search for Btrfs magic
525 if (BufferSize
>= 512) {
526 MagicString
= (char*) Buffer
;
527 if (CompareMem(MagicString
, XFS_SIGNATURE
, 4) == 0) {
528 Volume
->FSType
= FS_TYPE_XFS
;
531 } // search for XFS magic
533 if (BufferSize
>= (1024 + 2)) {
534 Magic16
= (UINT16
*) (Buffer
+ 1024);
535 if ((*Magic16
== HFSPLUS_MAGIC1
) || (*Magic16
== HFSPLUS_MAGIC2
)) {
536 Volume
->FSType
= FS_TYPE_HFSPLUS
;
539 } // search for HFS+ magic
541 if (BufferSize
>= 512) {
542 // Search for NTFS, FAT, and MBR/EBR.
543 // These all have 0xAA55 at the end of the first sector, but FAT and
544 // MBR/EBR are not easily distinguished. Thus, we first look for NTFS
545 // "magic"; then check to see if the volume can be mounted, thus
546 // relying on the EFI's built-in FAT driver to identify FAT; and then
547 // check to see if the "volume" is in fact a whole-disk device.
548 Magic16
= (UINT16
*) (Buffer
+ 510);
549 if (*Magic16
== FAT_MAGIC
) {
550 MagicString
= (char*) (Buffer
+ 3);
551 if (CompareMem(MagicString
, NTFS_SIGNATURE
, 8) == 0) {
552 Volume
->FSType
= FS_TYPE_NTFS
;
553 CopyMem(&(Volume
->VolUuid
), Buffer
+ 0x48, sizeof(UINT64
));
555 RootDir
= LibOpenRoot(Volume
->DeviceHandle
);
556 if (RootDir
!= NULL
) {
557 Volume
->FSType
= FS_TYPE_FAT
;
558 } else if (!Volume
->BlockIO
->Media
->LogicalPartition
) {
559 Volume
->FSType
= FS_TYPE_WHOLEDISK
;
564 } // search for FAT and NTFS magic
566 // If no other filesystem is identified and block size is right, assume
568 if (Volume
->BlockIO
->Media
->BlockSize
== 2048) {
569 Volume
->FSType
= FS_TYPE_ISO9660
;
573 } // if ((Buffer != NULL) && (Volume != NULL))
575 } // UINT32 SetFilesystemData()
577 static VOID
ScanVolumeBootcode(REFIT_VOLUME
*Volume
, BOOLEAN
*Bootable
)
580 UINT8 Buffer
[SAMPLE_SIZE
];
582 MBR_PARTITION_INFO
*MbrTable
;
583 BOOLEAN MbrTableFound
= FALSE
;
585 Volume
->HasBootCode
= FALSE
;
586 Volume
->OSIconName
= NULL
;
587 Volume
->OSName
= NULL
;
590 if (Volume
->BlockIO
== NULL
)
592 if (Volume
->BlockIO
->Media
->BlockSize
> SAMPLE_SIZE
)
593 return; // our buffer is too small...
595 // look at the boot sector (this is used for both hard disks and El Torito images!)
596 Status
= refit_call5_wrapper(Volume
->BlockIO
->ReadBlocks
,
597 Volume
->BlockIO
, Volume
->BlockIO
->Media
->MediaId
,
598 Volume
->BlockIOOffset
, SAMPLE_SIZE
, Buffer
);
599 if (!EFI_ERROR(Status
)) {
600 SetFilesystemData(Buffer
, SAMPLE_SIZE
, Volume
);
602 if ((Status
== EFI_SUCCESS
) && (GlobalConfig
.LegacyType
== LEGACY_TYPE_MAC
)) {
603 if ((*((UINT16
*)(Buffer
+ 510)) == 0xaa55 && Buffer
[0] != 0) && (FindMem(Buffer
, 512, "EXFAT", 5) == -1)) {
605 Volume
->HasBootCode
= TRUE
;
608 // detect specific boot codes
609 if (CompareMem(Buffer
+ 2, "LILO", 4) == 0 ||
610 CompareMem(Buffer
+ 6, "LILO", 4) == 0 ||
611 CompareMem(Buffer
+ 3, "SYSLINUX", 8) == 0 ||
612 FindMem(Buffer
, SECTOR_SIZE
, "ISOLINUX", 8) >= 0) {
613 Volume
->HasBootCode
= TRUE
;
614 Volume
->OSIconName
= L
"linux";
615 Volume
->OSName
= L
"Linux";
617 } else if (FindMem(Buffer
, 512, "Geom\0Hard Disk\0Read\0 Error", 26) >= 0) { // GRUB
618 Volume
->HasBootCode
= TRUE
;
619 Volume
->OSIconName
= L
"grub,linux";
620 Volume
->OSName
= L
"Linux";
622 } else if ((*((UINT32
*)(Buffer
+ 502)) == 0 &&
623 *((UINT32
*)(Buffer
+ 506)) == 50000 &&
624 *((UINT16
*)(Buffer
+ 510)) == 0xaa55) ||
625 FindMem(Buffer
, SECTOR_SIZE
, "Starting the BTX loader", 23) >= 0) {
626 Volume
->HasBootCode
= TRUE
;
627 Volume
->OSIconName
= L
"freebsd";
628 Volume
->OSName
= L
"FreeBSD";
630 // If more differentiation needed, also search for
631 // "Invalid partition table" &/or "Missing boot loader".
632 } else if ((*((UINT16
*)(Buffer
+ 510)) == 0xaa55) &&
633 (FindMem(Buffer
, SECTOR_SIZE
, "Boot loader too large", 21) >= 0) &&
634 (FindMem(Buffer
, SECTOR_SIZE
, "I/O error loading boot loader", 29) >= 0)) {
635 Volume
->HasBootCode
= TRUE
;
636 Volume
->OSIconName
= L
"freebsd";
637 Volume
->OSName
= L
"FreeBSD";
639 } else if (FindMem(Buffer
, 512, "!Loading", 8) >= 0 ||
640 FindMem(Buffer
, SECTOR_SIZE
, "/cdboot\0/CDBOOT\0", 16) >= 0) {
641 Volume
->HasBootCode
= TRUE
;
642 Volume
->OSIconName
= L
"openbsd";
643 Volume
->OSName
= L
"OpenBSD";
645 } else if (FindMem(Buffer
, 512, "Not a bootxx image", 18) >= 0 ||
646 *((UINT32
*)(Buffer
+ 1028)) == 0x7886b6d1) {
647 Volume
->HasBootCode
= TRUE
;
648 Volume
->OSIconName
= L
"netbsd";
649 Volume
->OSName
= L
"NetBSD";
651 // Windows NT/200x/XP
652 } else if (FindMem(Buffer
, SECTOR_SIZE
, "NTLDR", 5) >= 0) {
653 Volume
->HasBootCode
= TRUE
;
654 Volume
->OSIconName
= L
"win";
655 Volume
->OSName
= L
"Windows";
658 } else if (FindMem(Buffer
, SECTOR_SIZE
, "BOOTMGR", 7) >= 0) {
659 Volume
->HasBootCode
= TRUE
;
660 Volume
->OSIconName
= L
"win8,win";
661 Volume
->OSName
= L
"Windows";
663 } else if (FindMem(Buffer
, 512, "CPUBOOT SYS", 11) >= 0 ||
664 FindMem(Buffer
, 512, "KERNEL SYS", 11) >= 0) {
665 Volume
->HasBootCode
= TRUE
;
666 Volume
->OSIconName
= L
"freedos";
667 Volume
->OSName
= L
"FreeDOS";
669 } else if (FindMem(Buffer
, 512, "OS2LDR", 6) >= 0 ||
670 FindMem(Buffer
, 512, "OS2BOOT", 7) >= 0) {
671 Volume
->HasBootCode
= TRUE
;
672 Volume
->OSIconName
= L
"ecomstation";
673 Volume
->OSName
= L
"eComStation";
675 } else if (FindMem(Buffer
, 512, "Be Boot Loader", 14) >= 0) {
676 Volume
->HasBootCode
= TRUE
;
677 Volume
->OSIconName
= L
"beos";
678 Volume
->OSName
= L
"BeOS";
680 } else if (FindMem(Buffer
, 512, "yT Boot Loader", 14) >= 0) {
681 Volume
->HasBootCode
= TRUE
;
682 Volume
->OSIconName
= L
"zeta,beos";
683 Volume
->OSName
= L
"ZETA";
685 } else if (FindMem(Buffer
, 512, "\x04" "beos\x06" "system\x05" "zbeos", 18) >= 0 ||
686 FindMem(Buffer
, 512, "\x06" "system\x0c" "haiku_loader", 20) >= 0) {
687 Volume
->HasBootCode
= TRUE
;
688 Volume
->OSIconName
= L
"haiku,beos";
689 Volume
->OSName
= L
"Haiku";
693 // NOTE: If you add an operating system with a name that starts with 'W' or 'L', you
694 // need to fix AddLegacyEntry in refind/legacy.c.
697 Print(L
" Result of bootcode detection: %s %s (%s)\n",
698 Volume
->HasBootCode
? L
"bootable" : L
"non-bootable",
699 Volume
->OSName
, Volume
->OSIconName
);
702 // dummy FAT boot sector (created by OS X's newfs_msdos)
703 if (FindMem(Buffer
, 512, "Non-system disk", 15) >= 0)
704 Volume
->HasBootCode
= FALSE
;
706 // dummy FAT boot sector (created by Linux's mkdosfs)
707 if (FindMem(Buffer
, 512, "This is not a bootable disk", 27) >= 0)
708 Volume
->HasBootCode
= FALSE
;
710 // dummy FAT boot sector (created by Windows)
711 if (FindMem(Buffer
, 512, "Press any key to restart", 24) >= 0)
712 Volume
->HasBootCode
= FALSE
;
714 // check for MBR partition table
715 if (*((UINT16
*)(Buffer
+ 510)) == 0xaa55) {
716 MbrTable
= (MBR_PARTITION_INFO
*)(Buffer
+ 446);
717 for (i
= 0; i
< 4; i
++)
718 if (MbrTable
[i
].StartLBA
&& MbrTable
[i
].Size
)
719 MbrTableFound
= TRUE
;
720 for (i
= 0; i
< 4; i
++)
721 if (MbrTable
[i
].Flags
!= 0x00 && MbrTable
[i
].Flags
!= 0x80)
722 MbrTableFound
= FALSE
;
724 Volume
->MbrPartitionTable
= AllocatePool(4 * 16);
725 CopyMem(Volume
->MbrPartitionTable
, MbrTable
, 4 * 16);
731 CheckError(Status
, L
"while reading boot sector");
734 } /* VOID ScanVolumeBootcode() */
736 // Set default volume badge icon based on /.VolumeBadge.{icns|png} file or disk kind
737 VOID
SetVolumeBadgeIcon(REFIT_VOLUME
*Volume
)
739 if (GlobalConfig
.HideUIFlags
& HIDEUI_FLAG_BADGES
)
742 if (Volume
->VolBadgeImage
== NULL
) {
743 Volume
->VolBadgeImage
= egLoadIconAnyType(Volume
->RootDir
, L
"", L
".VolumeBadge", GlobalConfig
.IconSizes
[ICON_SIZE_BADGE
]);
746 if (Volume
->VolBadgeImage
== NULL
) {
747 switch (Volume
->DiskKind
) {
748 case DISK_KIND_INTERNAL
:
749 Volume
->VolBadgeImage
= BuiltinIcon(BUILTIN_ICON_VOL_INTERNAL
);
751 case DISK_KIND_EXTERNAL
:
752 Volume
->VolBadgeImage
= BuiltinIcon(BUILTIN_ICON_VOL_EXTERNAL
);
754 case DISK_KIND_OPTICAL
:
755 Volume
->VolBadgeImage
= BuiltinIcon(BUILTIN_ICON_VOL_OPTICAL
);
758 Volume
->VolBadgeImage
= BuiltinIcon(BUILTIN_ICON_VOL_NET
);
762 } // VOID SetVolumeBadgeIcon()
764 // Return a string representing the input size in IEEE-1541 units.
765 // The calling function is responsible for freeing the allocated memory.
766 static CHAR16
*SizeInIEEEUnits(UINT64 SizeInBytes
) {
768 UINTN Index
= 0, NumPrefixes
;
769 CHAR16
*Units
, *Prefixes
= L
" KMGTPEZ";
772 TheValue
= AllocateZeroPool(sizeof(CHAR16
) * 256);
773 if (TheValue
!= NULL
) {
774 NumPrefixes
= StrLen(Prefixes
);
775 SizeInIeee
= SizeInBytes
;
776 while ((SizeInIeee
> 1024) && (Index
< (NumPrefixes
- 1))) {
780 if (Prefixes
[Index
] == ' ') {
781 Units
= StrDuplicate(L
"-byte");
783 Units
= StrDuplicate(L
" iB");
784 Units
[1] = Prefixes
[Index
];
786 SPrint(TheValue
, 255, L
"%ld%s", SizeInIeee
, Units
);
789 } // CHAR16 *SizeInIEEEUnits()
791 // Return a name for the volume. Ideally this should be the label for the
792 // filesystem or volume, but this function falls back to describing the
793 // filesystem by size (200 MiB, etc.) and/or type (ext2, HFS+, etc.), if
794 // this information can be extracted.
795 // The calling function is responsible for freeing the memory allocated
796 // for the name string.
797 static CHAR16
*GetVolumeName(REFIT_VOLUME
*Volume
) {
798 EFI_FILE_SYSTEM_INFO
*FileSystemInfoPtr
= NULL
;
799 CHAR16
*FoundName
= NULL
;
800 CHAR16
*SISize
, *TypeName
;
802 if (Volume
->RootDir
!= NULL
) {
803 FileSystemInfoPtr
= LibFileSystemInfo(Volume
->RootDir
);
806 if ((FileSystemInfoPtr
!= NULL
) && (FileSystemInfoPtr
->VolumeLabel
!= NULL
) &&
807 (StrLen(FileSystemInfoPtr
->VolumeLabel
) > 0)) {
808 FoundName
= StrDuplicate(FileSystemInfoPtr
->VolumeLabel
);
811 // If no filesystem name, try to use the partition name....
812 if ((FoundName
== NULL
) && (Volume
->PartName
!= NULL
) && (StrLen(Volume
->PartName
) > 0) &&
813 !IsIn(Volume
->PartName
, IGNORE_PARTITION_NAMES
)) {
814 FoundName
= StrDuplicate(Volume
->PartName
);
815 } // if use partition name
817 // No filesystem or acceptable partition name, so use fs type and size
818 if ((FoundName
== NULL
) && (FileSystemInfoPtr
!= NULL
)) {
819 FoundName
= AllocateZeroPool(sizeof(CHAR16
) * 256);
820 if (FoundName
!= NULL
) {
821 SISize
= SizeInIEEEUnits(FileSystemInfoPtr
->VolumeSize
);
822 SPrint(FoundName
, 255, L
"%s%s volume", SISize
, FSTypeName(Volume
->FSType
));
824 } // if allocated memory OK
825 } // if (FoundName == NULL)
827 MyFreePool(FileSystemInfoPtr
);
829 if (FoundName
== NULL
) {
830 FoundName
= AllocateZeroPool(sizeof(CHAR16
) * 256);
831 if (FoundName
!= NULL
) {
832 TypeName
= FSTypeName(Volume
->FSType
); // NOTE: Don't free TypeName; function returns constant
833 if (StrLen(TypeName
) > 0)
834 SPrint(FoundName
, 255, L
"%s volume", TypeName
);
836 SPrint(FoundName
, 255, L
"unknown volume");
837 } // if allocated memory OK
840 // TODO: Above could be improved/extended, in case filesystem name is not found,
842 // - use or add disk/partition number (e.g., "(hd0,2)")
844 // Desperate fallback name....
845 if (FoundName
== NULL
) {
846 FoundName
= StrDuplicate(L
"unknown volume");
849 } // static CHAR16 *GetVolumeName()
851 // Determine the unique GUID, type code GUID, and name of the volume and store them.
852 static VOID
SetPartGuidAndName(REFIT_VOLUME
*Volume
, EFI_DEVICE_PATH_PROTOCOL
*DevicePath
) {
853 HARDDRIVE_DEVICE_PATH
*HdDevicePath
;
856 if ((Volume
== NULL
) || (DevicePath
== NULL
))
859 if ((DevicePath
->Type
== MEDIA_DEVICE_PATH
) && (DevicePath
->SubType
== MEDIA_HARDDRIVE_DP
)) {
860 HdDevicePath
= (HARDDRIVE_DEVICE_PATH
*) DevicePath
;
861 if (HdDevicePath
->SignatureType
== SIGNATURE_TYPE_GUID
) {
862 Volume
->PartGuid
= *((EFI_GUID
*) HdDevicePath
->Signature
);
863 PartInfo
= FindPartWithGuid(&(Volume
->PartGuid
));
865 Volume
->PartName
= StrDuplicate(PartInfo
->name
);
866 CopyMem(&(Volume
->PartTypeGuid
), PartInfo
->type_guid
, sizeof(EFI_GUID
));
867 if (GuidsAreEqual (&(Volume
->PartTypeGuid
), &gFreedesktopRootGuid
)) {
868 GlobalConfig
.DiscoveredRoot
= Volume
;
869 } // if (GUIDs match)
870 } // if (PartInfo exists)
872 } // if (disk device)
873 } // VOID SetPartGuid()
875 // Return TRUE if NTFS boot files are found or if Volume is unreadable,
876 // FALSE otherwise. The idea is to weed out non-boot NTFS volumes from
877 // BIOS/legacy boot list on Macs. We can't assume NTFS will be readable,
878 // so return TRUE if it's unreadable; but if it IS readable, return
879 // TRUE only if Windows boot files are found.
880 static BOOLEAN
HasWindowsBiosBootFiles(REFIT_VOLUME
*Volume
) {
881 BOOLEAN FilesFound
= TRUE
;
883 if (Volume
->RootDir
!= NULL
) {
884 FilesFound
= FileExists(Volume
->RootDir
, L
"NTLDR") || // Windows NT/200x/XP boot file
885 FileExists(Volume
->RootDir
, L
"bootmgr"); // Windows Vista/7/8 boot file
888 } // static VOID HasWindowsBiosBootFiles()
890 VOID
ScanVolume(REFIT_VOLUME
*Volume
)
893 EFI_DEVICE_PATH
*DevicePath
, *NextDevicePath
;
894 EFI_DEVICE_PATH
*DiskDevicePath
, *RemainingDevicePath
;
895 EFI_HANDLE WholeDiskHandle
;
900 Volume
->DevicePath
= DuplicateDevicePath(DevicePathFromHandle(Volume
->DeviceHandle
));
902 if (Volume
->DevicePath
!= NULL
) {
903 Print(L
"* %s\n", DevicePathToStr(Volume
->DevicePath
));
905 DumpHex(1, 0, DevicePathSize(Volume
->DevicePath
), Volume
->DevicePath
);
910 Volume
->DiskKind
= DISK_KIND_INTERNAL
; // default
913 Status
= refit_call3_wrapper(BS
->HandleProtocol
, Volume
->DeviceHandle
, &BlockIoProtocol
, (VOID
**) &(Volume
->BlockIO
));
914 if (EFI_ERROR(Status
)) {
915 Volume
->BlockIO
= NULL
;
916 Print(L
"Warning: Can't get BlockIO protocol.\n");
918 if (Volume
->BlockIO
->Media
->BlockSize
== 2048)
919 Volume
->DiskKind
= DISK_KIND_OPTICAL
;
922 // scan for bootcode and MBR table
924 ScanVolumeBootcode(Volume
, &Bootable
);
926 // detect device type
927 DevicePath
= Volume
->DevicePath
;
928 while (DevicePath
!= NULL
&& !IsDevicePathEndType(DevicePath
)) {
929 NextDevicePath
= NextDevicePathNode(DevicePath
);
931 if (DevicePathType(DevicePath
) == MEDIA_DEVICE_PATH
) {
932 SetPartGuidAndName(Volume
, DevicePath
);
934 if (DevicePathType(DevicePath
) == MESSAGING_DEVICE_PATH
&&
935 (DevicePathSubType(DevicePath
) == MSG_USB_DP
||
936 DevicePathSubType(DevicePath
) == MSG_USB_CLASS_DP
||
937 DevicePathSubType(DevicePath
) == MSG_1394_DP
||
938 DevicePathSubType(DevicePath
) == MSG_FIBRECHANNEL_DP
))
939 Volume
->DiskKind
= DISK_KIND_EXTERNAL
; // USB/FireWire/FC device -> external
940 if (DevicePathType(DevicePath
) == MEDIA_DEVICE_PATH
&&
941 DevicePathSubType(DevicePath
) == MEDIA_CDROM_DP
) {
942 Volume
->DiskKind
= DISK_KIND_OPTICAL
; // El Torito entry -> optical disk
946 if (DevicePathType(DevicePath
) == MEDIA_DEVICE_PATH
&& DevicePathSubType(DevicePath
) == MEDIA_VENDOR_DP
) {
947 Volume
->IsAppleLegacy
= TRUE
; // legacy BIOS device entry
948 // TODO: also check for Boot Camp GUID
949 Bootable
= FALSE
; // this handle's BlockIO is just an alias for the whole device
952 if (DevicePathType(DevicePath
) == MESSAGING_DEVICE_PATH
) {
953 // make a device path for the whole device
954 PartialLength
= (UINT8
*)NextDevicePath
- (UINT8
*)(Volume
->DevicePath
);
955 DiskDevicePath
= (EFI_DEVICE_PATH
*)AllocatePool(PartialLength
+ sizeof(EFI_DEVICE_PATH
));
956 CopyMem(DiskDevicePath
, Volume
->DevicePath
, PartialLength
);
957 CopyMem((UINT8
*)DiskDevicePath
+ PartialLength
, EndDevicePath
, sizeof(EFI_DEVICE_PATH
));
959 // get the handle for that path
960 RemainingDevicePath
= DiskDevicePath
;
961 Status
= refit_call3_wrapper(BS
->LocateDevicePath
, &BlockIoProtocol
, &RemainingDevicePath
, &WholeDiskHandle
);
962 FreePool(DiskDevicePath
);
964 if (!EFI_ERROR(Status
)) {
965 //Print(L" - original handle: %08x - disk handle: %08x\n", (UINT32)DeviceHandle, (UINT32)WholeDiskHandle);
967 // get the device path for later
968 Status
= refit_call3_wrapper(BS
->HandleProtocol
, WholeDiskHandle
, &DevicePathProtocol
, (VOID
**) &DiskDevicePath
);
969 if (!EFI_ERROR(Status
)) {
970 Volume
->WholeDiskDevicePath
= DuplicateDevicePath(DiskDevicePath
);
973 // look at the BlockIO protocol
974 Status
= refit_call3_wrapper(BS
->HandleProtocol
, WholeDiskHandle
, &BlockIoProtocol
,
975 (VOID
**) &Volume
->WholeDiskBlockIO
);
976 if (!EFI_ERROR(Status
)) {
978 // check the media block size
979 if (Volume
->WholeDiskBlockIO
->Media
->BlockSize
== 2048)
980 Volume
->DiskKind
= DISK_KIND_OPTICAL
;
983 Volume
->WholeDiskBlockIO
= NULL
;
984 //CheckError(Status, L"from HandleProtocol");
987 // CheckError(Status, L"from LocateDevicePath");
990 DevicePath
= NextDevicePath
;
995 if (Volume
->HasBootCode
)
996 Print(L
" Volume considered non-bootable, but boot code is present\n");
998 Volume
->HasBootCode
= FALSE
;
1001 // open the root directory of the volume
1002 Volume
->RootDir
= LibOpenRoot(Volume
->DeviceHandle
);
1004 // Set volume icon based on .VolumeBadge icon or disk kind
1005 SetVolumeBadgeIcon(Volume
);
1007 Volume
->VolName
= GetVolumeName(Volume
);
1009 if (Volume
->RootDir
== NULL
) {
1010 Volume
->IsReadable
= FALSE
;
1013 Volume
->IsReadable
= TRUE
;
1014 if ((GlobalConfig
.LegacyType
== LEGACY_TYPE_MAC
) && (Volume
->FSType
== FS_TYPE_NTFS
) && Volume
->HasBootCode
) {
1015 // VBR boot code found on NTFS, but volume is not actually bootable
1016 // unless there are actual boot file, so check for them....
1017 Volume
->HasBootCode
= HasWindowsBiosBootFiles(Volume
);
1021 // get custom volume icons if present
1022 if (!Volume
->VolIconImage
) {
1023 Volume
->VolIconImage
= egLoadIconAnyType(Volume
->RootDir
, L
"", L
".VolumeIcon", GlobalConfig
.IconSizes
[ICON_SIZE_BIG
]);
1027 static VOID
ScanExtendedPartition(REFIT_VOLUME
*WholeDiskVolume
, MBR_PARTITION_INFO
*MbrEntry
)
1030 REFIT_VOLUME
*Volume
;
1031 UINT32 ExtBase
, ExtCurrent
, NextExtCurrent
;
1033 UINTN LogicalPartitionIndex
= 4;
1034 UINT8 SectorBuffer
[512];
1036 MBR_PARTITION_INFO
*EMbrTable
;
1038 ExtBase
= MbrEntry
->StartLBA
;
1040 for (ExtCurrent
= ExtBase
; ExtCurrent
; ExtCurrent
= NextExtCurrent
) {
1041 // read current EMBR
1042 Status
= refit_call5_wrapper(WholeDiskVolume
->BlockIO
->ReadBlocks
,
1043 WholeDiskVolume
->BlockIO
,
1044 WholeDiskVolume
->BlockIO
->Media
->MediaId
,
1045 ExtCurrent
, 512, SectorBuffer
);
1046 if (EFI_ERROR(Status
))
1048 if (*((UINT16
*)(SectorBuffer
+ 510)) != 0xaa55)
1050 EMbrTable
= (MBR_PARTITION_INFO
*)(SectorBuffer
+ 446);
1052 // scan logical partitions in this EMBR
1054 for (i
= 0; i
< 4; i
++) {
1055 if ((EMbrTable
[i
].Flags
!= 0x00 && EMbrTable
[i
].Flags
!= 0x80) ||
1056 EMbrTable
[i
].StartLBA
== 0 || EMbrTable
[i
].Size
== 0)
1058 if (IS_EXTENDED_PART_TYPE(EMbrTable
[i
].Type
)) {
1059 // set next ExtCurrent
1060 NextExtCurrent
= ExtBase
+ EMbrTable
[i
].StartLBA
;
1064 // found a logical partition
1065 Volume
= AllocateZeroPool(sizeof(REFIT_VOLUME
));
1066 Volume
->DiskKind
= WholeDiskVolume
->DiskKind
;
1067 Volume
->IsMbrPartition
= TRUE
;
1068 Volume
->MbrPartitionIndex
= LogicalPartitionIndex
++;
1069 Volume
->VolName
= AllocateZeroPool(256 * sizeof(UINT16
));
1070 SPrint(Volume
->VolName
, 255, L
"Partition %d", Volume
->MbrPartitionIndex
+ 1);
1071 Volume
->BlockIO
= WholeDiskVolume
->BlockIO
;
1072 Volume
->BlockIOOffset
= ExtCurrent
+ EMbrTable
[i
].StartLBA
;
1073 Volume
->WholeDiskBlockIO
= WholeDiskVolume
->BlockIO
;
1076 ScanVolumeBootcode(Volume
, &Bootable
);
1078 Volume
->HasBootCode
= FALSE
;
1080 SetVolumeBadgeIcon(Volume
);
1082 AddListElement((VOID
***) &Volumes
, &VolumesCount
, Volume
);
1087 } /* VOID ScanExtendedPartition() */
1089 VOID
ScanVolumes(VOID
)
1092 EFI_HANDLE
*Handles
;
1093 REFIT_VOLUME
*Volume
, *WholeDiskVolume
;
1094 MBR_PARTITION_INFO
*MbrTable
;
1095 UINTN HandleCount
= 0;
1097 UINTN VolumeIndex
, VolumeIndex2
;
1098 UINTN PartitionIndex
;
1099 UINTN SectorSum
, i
, VolNumber
= 0;
1100 UINT8
*SectorBuffer1
, *SectorBuffer2
;
1102 EFI_GUID NullUuid
= NULL_GUID_VALUE
;
1104 MyFreePool(Volumes
);
1107 ForgetPartitionTables();
1109 // get all filesystem handles
1110 Status
= LibLocateHandle(ByProtocol
, &BlockIoProtocol
, NULL
, &HandleCount
, &Handles
);
1111 UuidList
= AllocateZeroPool(sizeof(EFI_GUID
) * HandleCount
);
1112 if (Status
== EFI_NOT_FOUND
) {
1113 return; // no filesystems. strange, but true...
1115 if (CheckError(Status
, L
"while listing all file systems"))
1118 // first pass: collect information about all handles
1119 for (HandleIndex
= 0; HandleIndex
< HandleCount
; HandleIndex
++) {
1120 Volume
= AllocateZeroPool(sizeof(REFIT_VOLUME
));
1121 Volume
->DeviceHandle
= Handles
[HandleIndex
];
1122 AddPartitionTable(Volume
);
1125 UuidList
[HandleIndex
] = Volume
->VolUuid
;
1126 for (i
= 0; i
< HandleIndex
; i
++) {
1127 if ((CompareMem(&(Volume
->VolUuid
), &(UuidList
[i
]), sizeof(EFI_GUID
)) == 0) &&
1128 (CompareMem(&(Volume
->VolUuid
), &NullUuid
, sizeof(EFI_GUID
)) != 0)) { // Duplicate filesystem UUID
1129 Volume
->IsReadable
= FALSE
;
1133 if (Volume
->IsReadable
)
1134 Volume
->VolNumber
= VolNumber
++;
1136 Volume
->VolNumber
= VOL_UNREADABLE
;
1138 AddListElement((VOID
***) &Volumes
, &VolumesCount
, Volume
);
1140 if (Volume
->DeviceHandle
== SelfLoadedImage
->DeviceHandle
)
1141 SelfVolume
= Volume
;
1143 MyFreePool(Handles
);
1145 if (SelfVolume
== NULL
)
1146 Print(L
"WARNING: SelfVolume not found");
1148 // second pass: relate partitions and whole disk devices
1149 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
1150 Volume
= Volumes
[VolumeIndex
];
1151 // check MBR partition table for extended partitions
1152 if (Volume
->BlockIO
!= NULL
&& Volume
->WholeDiskBlockIO
!= NULL
&&
1153 Volume
->BlockIO
== Volume
->WholeDiskBlockIO
&& Volume
->BlockIOOffset
== 0 &&
1154 Volume
->MbrPartitionTable
!= NULL
) {
1155 MbrTable
= Volume
->MbrPartitionTable
;
1156 for (PartitionIndex
= 0; PartitionIndex
< 4; PartitionIndex
++) {
1157 if (IS_EXTENDED_PART_TYPE(MbrTable
[PartitionIndex
].Type
)) {
1158 ScanExtendedPartition(Volume
, MbrTable
+ PartitionIndex
);
1163 // search for corresponding whole disk volume entry
1164 WholeDiskVolume
= NULL
;
1165 if (Volume
->BlockIO
!= NULL
&& Volume
->WholeDiskBlockIO
!= NULL
&&
1166 Volume
->BlockIO
!= Volume
->WholeDiskBlockIO
) {
1167 for (VolumeIndex2
= 0; VolumeIndex2
< VolumesCount
; VolumeIndex2
++) {
1168 if (Volumes
[VolumeIndex2
]->BlockIO
== Volume
->WholeDiskBlockIO
&&
1169 Volumes
[VolumeIndex2
]->BlockIOOffset
== 0) {
1170 WholeDiskVolume
= Volumes
[VolumeIndex2
];
1175 if (WholeDiskVolume
!= NULL
&& WholeDiskVolume
->MbrPartitionTable
!= NULL
) {
1176 // check if this volume is one of the partitions in the table
1177 MbrTable
= WholeDiskVolume
->MbrPartitionTable
;
1178 SectorBuffer1
= AllocatePool(512);
1179 SectorBuffer2
= AllocatePool(512);
1180 for (PartitionIndex
= 0; PartitionIndex
< 4; PartitionIndex
++) {
1182 if ((UINT64
)(MbrTable
[PartitionIndex
].Size
) != Volume
->BlockIO
->Media
->LastBlock
+ 1)
1185 // compare boot sector read through offset vs. directly
1186 Status
= refit_call5_wrapper(Volume
->BlockIO
->ReadBlocks
,
1187 Volume
->BlockIO
, Volume
->BlockIO
->Media
->MediaId
,
1188 Volume
->BlockIOOffset
, 512, SectorBuffer1
);
1189 if (EFI_ERROR(Status
))
1191 Status
= refit_call5_wrapper(Volume
->WholeDiskBlockIO
->ReadBlocks
,
1192 Volume
->WholeDiskBlockIO
, Volume
->WholeDiskBlockIO
->Media
->MediaId
,
1193 MbrTable
[PartitionIndex
].StartLBA
, 512, SectorBuffer2
);
1194 if (EFI_ERROR(Status
))
1196 if (CompareMem(SectorBuffer1
, SectorBuffer2
, 512) != 0)
1199 for (i
= 0; i
< 512; i
++)
1200 SectorSum
+= SectorBuffer1
[i
];
1201 if (SectorSum
< 1000)
1204 // TODO: mark entry as non-bootable if it is an extended partition
1206 // now we're reasonably sure the association is correct...
1207 Volume
->IsMbrPartition
= TRUE
;
1208 Volume
->MbrPartitionIndex
= PartitionIndex
;
1209 if (Volume
->VolName
== NULL
) {
1210 Volume
->VolName
= AllocateZeroPool(sizeof(CHAR16
) * 256);
1211 SPrint(Volume
->VolName
, 255, L
"Partition %d", PartitionIndex
+ 1);
1216 MyFreePool(SectorBuffer1
);
1217 MyFreePool(SectorBuffer2
);
1220 } /* VOID ScanVolumes() */
1222 static VOID
UninitVolumes(VOID
)
1224 REFIT_VOLUME
*Volume
;
1227 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
1228 Volume
= Volumes
[VolumeIndex
];
1230 if (Volume
->RootDir
!= NULL
) {
1231 refit_call1_wrapper(Volume
->RootDir
->Close
, Volume
->RootDir
);
1232 Volume
->RootDir
= NULL
;
1235 Volume
->DeviceHandle
= NULL
;
1236 Volume
->BlockIO
= NULL
;
1237 Volume
->WholeDiskBlockIO
= NULL
;
1241 VOID
ReinitVolumes(VOID
)
1244 REFIT_VOLUME
*Volume
;
1246 EFI_DEVICE_PATH
*RemainingDevicePath
;
1247 EFI_HANDLE DeviceHandle
, WholeDiskHandle
;
1249 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
1250 Volume
= Volumes
[VolumeIndex
];
1252 if (Volume
->DevicePath
!= NULL
) {
1253 // get the handle for that path
1254 RemainingDevicePath
= Volume
->DevicePath
;
1255 Status
= refit_call3_wrapper(BS
->LocateDevicePath
, &BlockIoProtocol
, &RemainingDevicePath
, &DeviceHandle
);
1257 if (!EFI_ERROR(Status
)) {
1258 Volume
->DeviceHandle
= DeviceHandle
;
1260 // get the root directory
1261 Volume
->RootDir
= LibOpenRoot(Volume
->DeviceHandle
);
1264 CheckError(Status
, L
"from LocateDevicePath");
1267 if (Volume
->WholeDiskDevicePath
!= NULL
) {
1268 // get the handle for that path
1269 RemainingDevicePath
= Volume
->WholeDiskDevicePath
;
1270 Status
= refit_call3_wrapper(BS
->LocateDevicePath
, &BlockIoProtocol
, &RemainingDevicePath
, &WholeDiskHandle
);
1272 if (!EFI_ERROR(Status
)) {
1273 // get the BlockIO protocol
1274 Status
= refit_call3_wrapper(BS
->HandleProtocol
, WholeDiskHandle
, &BlockIoProtocol
,
1275 (VOID
**) &Volume
->WholeDiskBlockIO
);
1276 if (EFI_ERROR(Status
)) {
1277 Volume
->WholeDiskBlockIO
= NULL
;
1278 CheckError(Status
, L
"from HandleProtocol");
1281 CheckError(Status
, L
"from LocateDevicePath");
1287 // file and dir functions
1290 BOOLEAN
FileExists(IN EFI_FILE
*BaseDir
, IN CHAR16
*RelativePath
)
1293 EFI_FILE_HANDLE TestFile
;
1295 if (BaseDir
!= NULL
) {
1296 Status
= refit_call5_wrapper(BaseDir
->Open
, BaseDir
, &TestFile
, RelativePath
, EFI_FILE_MODE_READ
, 0);
1297 if (Status
== EFI_SUCCESS
) {
1298 refit_call1_wrapper(TestFile
->Close
, TestFile
);
1305 EFI_STATUS
DirNextEntry(IN EFI_FILE
*Directory
, IN OUT EFI_FILE_INFO
**DirEntry
, IN UINTN FilterMode
)
1309 UINTN LastBufferSize
, BufferSize
;
1314 // free pointer from last call
1315 if (*DirEntry
!= NULL
) {
1316 FreePool(*DirEntry
);
1320 // read next directory entry
1321 LastBufferSize
= BufferSize
= 256;
1322 Buffer
= AllocatePool(BufferSize
);
1323 for (IterCount
= 0; ; IterCount
++) {
1324 Status
= refit_call3_wrapper(Directory
->Read
, Directory
, &BufferSize
, Buffer
);
1325 if (Status
!= EFI_BUFFER_TOO_SMALL
|| IterCount
>= 4)
1327 if (BufferSize
<= LastBufferSize
) {
1328 Print(L
"FS Driver requests bad buffer size %d (was %d), using %d instead\n", BufferSize
, LastBufferSize
, LastBufferSize
* 2);
1329 BufferSize
= LastBufferSize
* 2;
1332 Print(L
"Reallocating buffer from %d to %d\n", LastBufferSize
, BufferSize
);
1335 Buffer
= EfiReallocatePool(Buffer
, LastBufferSize
, BufferSize
);
1336 LastBufferSize
= BufferSize
;
1338 if (EFI_ERROR(Status
)) {
1344 // check for end of listing
1345 if (BufferSize
== 0) { // end of directory listing
1351 // entry is ready to be returned
1352 *DirEntry
= (EFI_FILE_INFO
*)Buffer
;
1355 if (FilterMode
== 1) { // only return directories
1356 if (((*DirEntry
)->Attribute
& EFI_FILE_DIRECTORY
))
1358 } else if (FilterMode
== 2) { // only return files
1359 if (((*DirEntry
)->Attribute
& EFI_FILE_DIRECTORY
) == 0)
1361 } else // no filter or unknown filter -> return everything
1368 VOID
DirIterOpen(IN EFI_FILE
*BaseDir
, IN CHAR16
*RelativePath OPTIONAL
, OUT REFIT_DIR_ITER
*DirIter
)
1370 if (RelativePath
== NULL
) {
1371 DirIter
->LastStatus
= EFI_SUCCESS
;
1372 DirIter
->DirHandle
= BaseDir
;
1373 DirIter
->CloseDirHandle
= FALSE
;
1375 DirIter
->LastStatus
= refit_call5_wrapper(BaseDir
->Open
, BaseDir
, &(DirIter
->DirHandle
), RelativePath
, EFI_FILE_MODE_READ
, 0);
1376 DirIter
->CloseDirHandle
= EFI_ERROR(DirIter
->LastStatus
) ? FALSE
: TRUE
;
1378 DirIter
->LastFileInfo
= NULL
;
1381 #ifndef __MAKEWITH_GNUEFI
1382 EFI_UNICODE_COLLATION_PROTOCOL
*mUnicodeCollation
= NULL
;
1385 InitializeUnicodeCollationProtocol (VOID
)
1389 if (mUnicodeCollation
!= NULL
) {
1394 // BUGBUG: Proper impelmentation is to locate all Unicode Collation Protocol
1395 // instances first and then select one which support English language.
1396 // Current implementation just pick the first instance.
1398 Status
= gBS
->LocateProtocol (
1399 &gEfiUnicodeCollation2ProtocolGuid
,
1401 (VOID
**) &mUnicodeCollation
1403 if (EFI_ERROR(Status
)) {
1404 Status
= gBS
->LocateProtocol (
1405 &gEfiUnicodeCollationProtocolGuid
,
1407 (VOID
**) &mUnicodeCollation
1415 MetaiMatch (IN CHAR16
*String
, IN CHAR16
*Pattern
)
1417 if (!mUnicodeCollation
) {
1418 InitializeUnicodeCollationProtocol();
1420 if (mUnicodeCollation
)
1421 return mUnicodeCollation
->MetaiMatch (mUnicodeCollation
, String
, Pattern
);
1422 return FALSE
; // Shouldn't happen
1427 BOOLEAN
DirIterNext(IN OUT REFIT_DIR_ITER
*DirIter
, IN UINTN FilterMode
, IN CHAR16
*FilePattern OPTIONAL
,
1428 OUT EFI_FILE_INFO
**DirEntry
)
1430 BOOLEAN KeepGoing
= TRUE
;
1434 if (DirIter
->LastFileInfo
!= NULL
) {
1435 FreePool(DirIter
->LastFileInfo
);
1436 DirIter
->LastFileInfo
= NULL
;
1439 if (EFI_ERROR(DirIter
->LastStatus
))
1440 return FALSE
; // stop iteration
1443 DirIter
->LastStatus
= DirNextEntry(DirIter
->DirHandle
, &(DirIter
->LastFileInfo
), FilterMode
);
1444 if (EFI_ERROR(DirIter
->LastStatus
))
1446 if (DirIter
->LastFileInfo
== NULL
) // end of listing
1448 if (FilePattern
!= NULL
) {
1449 if ((DirIter
->LastFileInfo
->Attribute
& EFI_FILE_DIRECTORY
))
1452 while (KeepGoing
&& (OnePattern
= FindCommaDelimited(FilePattern
, i
++)) != NULL
) {
1453 if (MetaiMatch(DirIter
->LastFileInfo
->FileName
, OnePattern
))
1456 // else continue loop
1459 } while (KeepGoing
&& FilePattern
);
1461 *DirEntry
= DirIter
->LastFileInfo
;
1465 EFI_STATUS
DirIterClose(IN OUT REFIT_DIR_ITER
*DirIter
)
1467 if (DirIter
->LastFileInfo
!= NULL
) {
1468 FreePool(DirIter
->LastFileInfo
);
1469 DirIter
->LastFileInfo
= NULL
;
1471 if (DirIter
->CloseDirHandle
)
1472 refit_call1_wrapper(DirIter
->DirHandle
->Close
, DirIter
->DirHandle
);
1473 return DirIter
->LastStatus
;
1477 // file name manipulation
1480 // Returns the filename portion (minus path name) of the
1482 CHAR16
* Basename(IN CHAR16
*Path
)
1490 for (i
= StrLen(Path
); i
> 0; i
--) {
1491 if (Path
[i
-1] == '\\' || Path
[i
-1] == '/') {
1492 FileName
= Path
+ i
;
1501 // Remove the .efi extension from FileName -- for instance, if FileName is
1502 // "fred.efi", returns "fred". If the filename contains no .efi extension,
1503 // returns a copy of the original input.
1504 CHAR16
* StripEfiExtension(CHAR16
*FileName
) {
1506 CHAR16
*Copy
= NULL
;
1508 if ((FileName
!= NULL
) && ((Copy
= StrDuplicate(FileName
)) != NULL
)) {
1509 Length
= StrLen(Copy
);
1510 if ((Length
>= 4) && MyStriCmp(&Copy
[Length
- 4], L
".efi")) {
1511 Copy
[Length
- 4] = 0;
1515 } // CHAR16 * StripExtension()
1518 // memory string search
1521 INTN
FindMem(IN VOID
*Buffer
, IN UINTN BufferLength
, IN VOID
*SearchString
, IN UINTN SearchStringLength
)
1527 BufferLength
-= SearchStringLength
;
1528 for (Offset
= 0; Offset
< BufferLength
; Offset
++, BufferPtr
++) {
1529 if (CompareMem(BufferPtr
, SearchString
, SearchStringLength
) == 0)
1530 return (INTN
)Offset
;
1536 BOOLEAN
StriSubCmp(IN CHAR16
*SmallStr
, IN CHAR16
*BigStr
) {
1537 BOOLEAN Found
= 0, Terminate
= 0;
1538 UINTN BigIndex
= 0, SmallIndex
= 0, BigStart
= 0;
1540 if (SmallStr
&& BigStr
) {
1541 while (!Terminate
) {
1542 if (BigStr
[BigIndex
] == '\0') {
1545 if (SmallStr
[SmallIndex
] == '\0') {
1549 if ((SmallStr
[SmallIndex
] & ~0x20) == (BigStr
[BigIndex
] & ~0x20)) {
1555 BigIndex
= BigStart
;
1560 } // BOOLEAN StriSubCmp()
1562 // Performs a case-insensitive string comparison. This function is necesary
1563 // because some EFIs have buggy StriCmp() functions that actually perform
1564 // case-sensitive comparisons.
1565 // Returns TRUE if strings are identical, FALSE otherwise.
1566 BOOLEAN
MyStriCmp(IN CONST CHAR16
*FirstString
, IN CONST CHAR16
*SecondString
) {
1567 if (FirstString
&& SecondString
) {
1568 while ((*FirstString
!= L
'\0') && ((*FirstString
& ~0x20) == (*SecondString
& ~0x20))) {
1572 return (*FirstString
== *SecondString
);
1576 } // BOOLEAN MyStriCmp()
1578 // Convert input string to all-lowercase.
1579 // DO NOT USE the standard StrLwr() function, since it's broken on some EFIs!
1580 VOID
ToLower(CHAR16
* MyString
) {
1584 while (MyString
[i
] != L
'\0') {
1585 if ((MyString
[i
] >= L
'A') && (MyString
[i
] <= L
'Z'))
1586 MyString
[i
] = MyString
[i
] - L
'A' + L
'a';
1592 // Merges two strings, creating a new one and returning a pointer to it.
1593 // If AddChar != 0, the specified character is placed between the two original
1594 // strings (unless the first string is NULL or empty). The original input
1595 // string *First is de-allocated and replaced by the new merged string.
1596 // This is similar to StrCat, but safer and more flexible because
1597 // MergeStrings allocates memory that's the correct size for the
1598 // new merged string, so it can take a NULL *First and it cleans
1599 // up the old memory. It should *NOT* be used with a constant
1600 // *First, though....
1601 VOID
MergeStrings(IN OUT CHAR16
**First
, IN CHAR16
*Second
, CHAR16 AddChar
) {
1602 UINTN Length1
= 0, Length2
= 0;
1606 Length1
= StrLen(*First
);
1608 Length2
= StrLen(Second
);
1609 NewString
= AllocatePool(sizeof(CHAR16
) * (Length1
+ Length2
+ 2));
1610 if (NewString
!= NULL
) {
1611 if ((*First
!= NULL
) && (Length1
== 0)) {
1615 NewString
[0] = L
'\0';
1616 if (*First
!= NULL
) {
1617 StrCat(NewString
, *First
);
1619 NewString
[Length1
] = AddChar
;
1620 NewString
[Length1
+ 1] = '\0';
1622 } // if (*First != NULL)
1624 StrCat(NewString
, Second
);
1628 Print(L
"Error! Unable to allocate memory in MergeStrings()!\n");
1630 } // VOID MergeStrings()
1632 // Similar to MergeStrings, but breaks the input string into word chunks and
1633 // merges each word separately. Words are defined as string fragments separated
1634 // by ' ', '_', or '-'.
1635 VOID
MergeWords(CHAR16
**MergeTo
, CHAR16
*SourceString
, CHAR16 AddChar
) {
1636 CHAR16
*Temp
, *Word
, *p
;
1637 BOOLEAN LineFinished
= FALSE
;
1640 Temp
= Word
= p
= StrDuplicate(SourceString
);
1642 while (!LineFinished
) {
1643 if ((*p
== L
' ') || (*p
== L
'_') || (*p
== L
'-') || (*p
== L
'\0')) {
1645 LineFinished
= TRUE
;
1648 MergeStrings(MergeTo
, Word
, AddChar
);
1655 Print(L
"Error! Unable to allocate memory in MergeWords()!\n");
1658 } // VOID MergeWords()
1660 // Takes an input pathname (*Path) and returns the part of the filename from
1661 // the final dot onwards, converted to lowercase. If the filename includes
1662 // no dots, or if the input is NULL, returns an empty (but allocated) string.
1663 // The calling function is responsible for freeing the memory associated with
1664 // the return value.
1665 CHAR16
*FindExtension(IN CHAR16
*Path
) {
1667 BOOLEAN Found
= FALSE
, FoundSlash
= FALSE
;
1670 Extension
= AllocateZeroPool(sizeof(CHAR16
));
1673 while ((!Found
) && (!FoundSlash
) && (i
>= 0)) {
1674 if (Path
[i
] == L
'.')
1676 else if ((Path
[i
] == L
'/') || (Path
[i
] == L
'\\'))
1682 MergeStrings(&Extension
, &Path
[i
], 0);
1687 } // CHAR16 *FindExtension
1689 // Takes an input pathname (*Path) and locates the final directory component
1690 // of that name. For instance, if the input path is 'EFI\foo\bar.efi', this
1691 // function returns the string 'foo'.
1692 // Assumes the pathname is separated with backslashes.
1693 CHAR16
*FindLastDirName(IN CHAR16
*Path
) {
1694 UINTN i
, StartOfElement
= 0, EndOfElement
= 0, PathLength
, CopyLength
;
1695 CHAR16
*Found
= NULL
;
1700 PathLength
= StrLen(Path
);
1701 // Find start & end of target element
1702 for (i
= 0; i
< PathLength
; i
++) {
1703 if (Path
[i
] == '\\') {
1704 StartOfElement
= EndOfElement
;
1708 // Extract the target element
1709 if (EndOfElement
> 0) {
1710 while ((StartOfElement
< PathLength
) && (Path
[StartOfElement
] == '\\')) {
1714 if (EndOfElement
>= StartOfElement
) {
1715 CopyLength
= EndOfElement
- StartOfElement
+ 1;
1716 Found
= StrDuplicate(&Path
[StartOfElement
]);
1718 Found
[CopyLength
] = 0;
1719 } // if (EndOfElement >= StartOfElement)
1720 } // if (EndOfElement > 0)
1722 } // CHAR16 *FindLastDirName
1724 // Returns the directory portion of a pathname. For instance,
1725 // if FullPath is 'EFI\foo\bar.efi', this function returns the
1726 // string 'EFI\foo'. The calling function is responsible for
1727 // freeing the returned string's memory.
1728 CHAR16
*FindPath(IN CHAR16
* FullPath
) {
1729 UINTN i
, LastBackslash
= 0;
1730 CHAR16
*PathOnly
= NULL
;
1732 if (FullPath
!= NULL
) {
1733 for (i
= 0; i
< StrLen(FullPath
); i
++) {
1734 if (FullPath
[i
] == '\\')
1737 PathOnly
= StrDuplicate(FullPath
);
1738 if (PathOnly
!= NULL
)
1739 PathOnly
[LastBackslash
] = 0;
1746 * Routine Description:
1752 * String - Null-terminated string to search.
1753 * StrCharSet - Null-terminated string to search for.
1756 * The address of the first occurrence of the matching substring if successful, or NULL otherwise.
1758 CHAR16
* MyStrStr (CHAR16
*String
, CHAR16
*StrCharSet
)
1763 if ((String
== NULL
) || (StrCharSet
== NULL
))
1769 while ((*String
!= L
'\0') && (*StrCharSet
!= L
'\0')) {
1770 if (*String
++ != *StrCharSet
) {
1777 if (*StrCharSet
== L
'\0') {
1782 } // CHAR16 *MyStrStr()
1784 // Restrict TheString to at most Limit characters.
1785 // Does this in two ways:
1786 // - Locates stretches of two or more spaces and compresses
1787 // them down to one space.
1788 // - Truncates TheString
1789 // Returns TRUE if changes were made, FALSE otherwise
1790 BOOLEAN
LimitStringLength(CHAR16
*TheString
, UINTN Limit
) {
1791 CHAR16
*SubString
, *TempString
;
1793 BOOLEAN HasChanged
= FALSE
;
1795 // SubString will be NULL or point WITHIN TheString
1796 SubString
= MyStrStr(TheString
, L
" ");
1797 while (SubString
!= NULL
) {
1799 while (SubString
[i
] == L
' ')
1801 if (i
>= StrLen(SubString
)) {
1802 SubString
[0] = '\0';
1805 TempString
= StrDuplicate(&SubString
[i
]);
1806 if (TempString
!= NULL
) {
1807 StrCpy(&SubString
[1], TempString
);
1808 MyFreePool(TempString
);
1811 // memory allocation problem; abort to avoid potentially infinite loop!
1815 SubString
= MyStrStr(TheString
, L
" ");
1818 // If the string is still too long, truncate it....
1819 if (StrLen(TheString
) > Limit
) {
1820 TheString
[Limit
] = '\0';
1825 } // BOOLEAN LimitStringLength()
1827 // Takes an input loadpath, splits it into disk and filename components, finds a matching
1828 // DeviceVolume, and returns that and the filename (*loader).
1829 VOID
FindVolumeAndFilename(IN EFI_DEVICE_PATH
*loadpath
, OUT REFIT_VOLUME
**DeviceVolume
, OUT CHAR16
**loader
) {
1830 CHAR16
*DeviceString
, *VolumeDeviceString
, *Temp
;
1832 BOOLEAN Found
= FALSE
;
1834 MyFreePool(*loader
);
1835 MyFreePool(*DeviceVolume
);
1836 *DeviceVolume
= NULL
;
1837 DeviceString
= DevicePathToStr(loadpath
);
1838 *loader
= SplitDeviceString(DeviceString
);
1840 while ((i
< VolumesCount
) && (!Found
)) {
1841 VolumeDeviceString
= DevicePathToStr(Volumes
[i
]->DevicePath
);
1842 Temp
= SplitDeviceString(VolumeDeviceString
);
1843 if (MyStriCmp(DeviceString
, VolumeDeviceString
)) {
1845 *DeviceVolume
= Volumes
[i
];
1848 MyFreePool(VolumeDeviceString
);
1852 MyFreePool(DeviceString
);
1853 } // VOID FindVolumeAndFilename()
1855 // Splits a volume/filename string (e.g., "fs0:\EFI\BOOT") into separate
1856 // volume and filename components (e.g., "fs0" and "\EFI\BOOT"), returning
1857 // the filename component in the original *Path variable and the split-off
1858 // volume component in the *VolName variable.
1859 // Returns TRUE if both components are found, FALSE otherwise.
1860 BOOLEAN
SplitVolumeAndFilename(IN OUT CHAR16
**Path
, OUT CHAR16
**VolName
) {
1861 UINTN i
= 0, Length
;
1867 if (*VolName
!= NULL
) {
1868 MyFreePool(*VolName
);
1872 Length
= StrLen(*Path
);
1873 while ((i
< Length
) && ((*Path
)[i
] != L
':')) {
1878 Filename
= StrDuplicate((*Path
) + i
+ 1);
1886 } // BOOLEAN SplitVolumeAndFilename()
1888 // Returns all the digits in the input string, including intervening
1889 // non-digit characters. For instance, if InString is "foo-3.3.4-7.img",
1890 // this function returns "3.3.4-7". If InString contains no digits,
1891 // the return value is NULL.
1892 CHAR16
*FindNumbers(IN CHAR16
*InString
) {
1893 UINTN i
, StartOfElement
, EndOfElement
= 0, InLength
, CopyLength
;
1894 CHAR16
*Found
= NULL
;
1896 if (InString
== NULL
)
1899 InLength
= StartOfElement
= StrLen(InString
);
1900 // Find start & end of target element
1901 for (i
= 0; i
< InLength
; i
++) {
1902 if ((InString
[i
] >= '0') && (InString
[i
] <= '9')) {
1903 if (StartOfElement
> i
)
1905 if (EndOfElement
< i
)
1909 // Extract the target element
1910 if (EndOfElement
> 0) {
1911 if (EndOfElement
>= StartOfElement
) {
1912 CopyLength
= EndOfElement
- StartOfElement
+ 1;
1913 Found
= StrDuplicate(&InString
[StartOfElement
]);
1915 Found
[CopyLength
] = 0;
1916 } // if (EndOfElement >= StartOfElement)
1917 } // if (EndOfElement > 0)
1919 } // CHAR16 *FindNumbers()
1921 // Find the #Index element (numbered from 0) in a comma-delimited string
1923 // Returns the found element, or NULL if Index is out of range or InString
1924 // is NULL. Note that the calling function is responsible for freeing the
1925 // memory associated with the returned string pointer.
1926 CHAR16
*FindCommaDelimited(IN CHAR16
*InString
, IN UINTN Index
) {
1927 UINTN StartPos
= 0, CurPos
= 0;
1928 BOOLEAN Found
= FALSE
;
1929 CHAR16
*FoundString
= NULL
;
1931 if (InString
!= NULL
) {
1932 // After while() loop, StartPos marks start of item #Index
1933 while ((Index
> 0) && (CurPos
< StrLen(InString
))) {
1934 if (InString
[CurPos
] == L
',') {
1936 StartPos
= CurPos
+ 1;
1940 // After while() loop, CurPos is one past the end of the element
1941 while ((CurPos
< StrLen(InString
)) && (!Found
)) {
1942 if (InString
[CurPos
] == L
',')
1948 FoundString
= StrDuplicate(&InString
[StartPos
]);
1949 if (FoundString
!= NULL
)
1950 FoundString
[CurPos
- StartPos
] = 0;
1952 return (FoundString
);
1953 } // CHAR16 *FindCommaDelimited()
1955 // Return the position of SmallString within BigString, or -1 if
1957 INTN
FindSubString(IN CHAR16
*SmallString
, IN CHAR16
*BigString
) {
1959 UINTN i
= 0, SmallSize
, BigSize
;
1960 BOOLEAN Found
= FALSE
;
1962 if ((SmallString
== NULL
) || (BigString
== NULL
))
1965 SmallSize
= StrLen(SmallString
);
1966 BigSize
= StrLen(BigString
);
1967 if ((SmallSize
> BigSize
) || (SmallSize
== 0) || (BigSize
== 0))
1970 while ((i
<= (BigSize
- SmallSize
) && !Found
)) {
1971 if (CompareMem(BigString
+ i
, SmallString
, SmallSize
) == 0) {
1978 } // INTN FindSubString()
1980 // Take an input path name, which may include a volume specification and/or
1981 // a path, and return separate volume, path, and file names. For instance,
1982 // "BIGVOL:\EFI\ubuntu\grubx64.efi" will return a VolName of "BIGVOL", a Path
1983 // of "EFI\ubuntu", and a Filename of "grubx64.efi". If an element is missing,
1984 // the returned pointer is NULL. The calling function is responsible for
1985 // freeing the allocated memory.
1986 VOID
SplitPathName(CHAR16
*InPath
, CHAR16
**VolName
, CHAR16
**Path
, CHAR16
**Filename
) {
1987 CHAR16
*Temp
= NULL
;
1989 MyFreePool(*VolName
);
1991 MyFreePool(*Filename
);
1992 *VolName
= *Path
= *Filename
= NULL
;
1993 Temp
= StrDuplicate(InPath
);
1994 SplitVolumeAndFilename(&Temp
, VolName
); // VolName is NULL or has volume; Temp has rest of path
1995 CleanUpPathNameSlashes(Temp
);
1996 *Path
= FindPath(Temp
); // *Path has path (may be 0-length); Temp unchanged.
1997 *Filename
= StrDuplicate(Temp
+ StrLen(*Path
));
1998 CleanUpPathNameSlashes(*Filename
);
1999 if (StrLen(*Path
) == 0) {
2003 if (StrLen(*Filename
) == 0) {
2004 MyFreePool(*Filename
);
2008 } // VOID SplitPathName
2010 // Returns TRUE if SmallString is an element in the comma-delimited List,
2011 // FALSE otherwise. Performs comparison case-insensitively.
2012 BOOLEAN
IsIn(IN CHAR16
*SmallString
, IN CHAR16
*List
) {
2014 BOOLEAN Found
= FALSE
;
2017 if (SmallString
&& List
) {
2018 while (!Found
&& (OneElement
= FindCommaDelimited(List
, i
++))) {
2019 if (MyStriCmp(OneElement
, SmallString
))
2026 // Returns TRUE if any element of List can be found as a substring of
2027 // BigString, FALSE otherwise. Performs comparisons case-insensitively.
2028 BOOLEAN
IsInSubstring(IN CHAR16
*BigString
, IN CHAR16
*List
) {
2029 UINTN i
= 0, ElementLength
;
2030 BOOLEAN Found
= FALSE
;
2033 if (BigString
&& List
) {
2034 while (!Found
&& (OneElement
= FindCommaDelimited(List
, i
++))) {
2035 ElementLength
= StrLen(OneElement
);
2036 if ((ElementLength
<= StrLen(BigString
)) && (StriSubCmp(OneElement
, BigString
)))
2041 } // BOOLEAN IsSubstringIn()
2043 // Returns TRUE if specified Volume, Directory, and Filename correspond to an
2044 // element in the comma-delimited List, FALSE otherwise. Note that Directory and
2045 // Filename must *NOT* include a volume or path specification (that's part of
2046 // the Volume variable), but the List elements may. Performs comparison
2047 // case-insensitively.
2048 BOOLEAN
FilenameIn(REFIT_VOLUME
*Volume
, CHAR16
*Directory
, CHAR16
*Filename
, CHAR16
*List
) {
2050 BOOLEAN Found
= FALSE
;
2052 CHAR16
*TargetVolName
= NULL
, *TargetPath
= NULL
, *TargetFilename
= NULL
;
2054 if (Filename
&& List
) {
2055 while (!Found
&& (OneElement
= FindCommaDelimited(List
, i
++))) {
2057 SplitPathName(OneElement
, &TargetVolName
, &TargetPath
, &TargetFilename
);
2058 VolumeNumberToName(Volume
, &TargetVolName
);
2059 if (((TargetVolName
!= NULL
) && ((Volume
== NULL
) || (!MyStriCmp(TargetVolName
, Volume
->VolName
)))) ||
2060 ((TargetPath
!= NULL
) && (!MyStriCmp(TargetPath
, Directory
))) ||
2061 ((TargetFilename
!= NULL
) && (!MyStriCmp(TargetFilename
, Filename
)))) {
2064 MyFreePool(OneElement
);
2068 MyFreePool(TargetVolName
);
2069 MyFreePool(TargetPath
);
2070 MyFreePool(TargetFilename
);
2072 } // BOOLEAN FilenameIn()
2074 // If *VolName is of the form "fs#", where "#" is a number, and if Volume points
2075 // to this volume number, returns with *VolName changed to the volume name, as
2076 // stored in the Volume data structure.
2077 // Returns TRUE if this substitution was made, FALSE otherwise.
2078 BOOLEAN
VolumeNumberToName(REFIT_VOLUME
*Volume
, CHAR16
**VolName
) {
2079 BOOLEAN MadeSubstitution
= FALSE
;
2082 if ((VolName
== NULL
) || (*VolName
== NULL
))
2085 if ((StrLen(*VolName
) > 2) && (*VolName
[0] == L
'f') && (*VolName
[1] == L
's') && (*VolName
[2] >= L
'0') && (*VolName
[2] <= L
'9')) {
2086 VolNum
= Atoi(*VolName
+ 2);
2087 if (VolNum
== Volume
->VolNumber
) {
2088 MyFreePool(*VolName
);
2089 *VolName
= StrDuplicate(Volume
->VolName
);
2090 MadeSubstitution
= TRUE
;
2093 return MadeSubstitution
;
2094 } // BOOLEAN VolumeMatchesNumber()
2096 // Implement FreePool the way it should have been done to begin with, so that
2097 // it doesn't throw an ASSERT message if fed a NULL pointer....
2098 VOID
MyFreePool(IN VOID
*Pointer
) {
2099 if (Pointer
!= NULL
)
2103 static EFI_GUID AppleRemovableMediaGuid
= APPLE_REMOVABLE_MEDIA_PROTOCOL_GUID
;
2105 // Eject all removable media.
2106 // Returns TRUE if any media were ejected, FALSE otherwise.
2107 BOOLEAN
EjectMedia(VOID
) {
2109 UINTN HandleIndex
, HandleCount
= 0, Ejected
= 0;
2110 EFI_HANDLE
*Handles
, Handle
;
2111 APPLE_REMOVABLE_MEDIA_PROTOCOL
*Ejectable
;
2113 Status
= LibLocateHandle(ByProtocol
, &AppleRemovableMediaGuid
, NULL
, &HandleCount
, &Handles
);
2114 if (EFI_ERROR(Status
) || HandleCount
== 0)
2115 return (FALSE
); // probably not an Apple system
2117 for (HandleIndex
= 0; HandleIndex
< HandleCount
; HandleIndex
++) {
2118 Handle
= Handles
[HandleIndex
];
2119 Status
= refit_call3_wrapper(BS
->HandleProtocol
, Handle
, &AppleRemovableMediaGuid
, (VOID
**) &Ejectable
);
2120 if (EFI_ERROR(Status
))
2122 Status
= refit_call1_wrapper(Ejectable
->Eject
, Ejectable
);
2123 if (!EFI_ERROR(Status
))
2126 MyFreePool(Handles
);
2127 return (Ejected
> 0);
2128 } // VOID EjectMedia()
2130 // Converts consecutive characters in the input string into a
2131 // number, interpreting the string as a hexadecimal number, starting
2132 // at the specified position and continuing for the specified number
2133 // of characters or until the end of the string, whichever is first.
2134 // NumChars must be between 1 and 16. Ignores invalid characters.
2135 UINT64
StrToHex(CHAR16
*Input
, UINTN Pos
, UINTN NumChars
) {
2136 UINT64 retval
= 0x00;
2140 if ((Input
== NULL
) || (StrLen(Input
) < Pos
) || (NumChars
== 0) || (NumChars
> 16)) {
2144 while ((StrLen(Input
) >= Pos
) && (NumDone
< NumChars
)) {
2146 if ((a
>= '0') && (a
<= '9')) {
2148 retval
+= (a
- '0');
2151 if ((a
>= 'a') && (a
<= 'f')) {
2153 retval
+= (a
- 'a' + 0x0a);
2156 if ((a
>= 'A') && (a
<= 'F')) {
2158 retval
+= (a
- 'A' + 0x0a);
2166 // Returns TRUE if UnknownString can be interpreted as a GUID, FALSE otherwise.
2167 // Note that the input string must have no extraneous spaces and must be
2168 // conventionally formatted as a 36-character GUID, complete with dashes in
2169 // appropriate places.
2170 BOOLEAN
IsGuid(CHAR16
*UnknownString
) {
2172 BOOLEAN retval
= TRUE
;
2175 if (UnknownString
== NULL
)
2178 Length
= StrLen(UnknownString
);
2182 for (i
= 0; i
< Length
; i
++) {
2183 a
= UnknownString
[i
];
2184 if ((i
== 8) || (i
== 13) || (i
== 18) || (i
== 23)) {
2187 } else if (((a
< 'a') || (a
> 'f')) && ((a
< 'A') || (a
> 'F')) && ((a
< '0') && (a
> '9'))) {
2192 } // BOOLEAN IsGuid()
2194 // Return the GUID as a string, suitable for display to the user. Note that the calling
2195 // function is responsible for freeing the allocated memory.
2196 CHAR16
* GuidAsString(EFI_GUID
*GuidData
) {
2199 TheString
= AllocateZeroPool(42 * sizeof(CHAR16
));
2200 if (TheString
!= 0) {
2201 SPrint (TheString
, 82, L
"%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x",
2202 (UINTN
)GuidData
->Data1
, (UINTN
)GuidData
->Data2
, (UINTN
)GuidData
->Data3
,
2203 (UINTN
)GuidData
->Data4
[0], (UINTN
)GuidData
->Data4
[1], (UINTN
)GuidData
->Data4
[2],
2204 (UINTN
)GuidData
->Data4
[3], (UINTN
)GuidData
->Data4
[4], (UINTN
)GuidData
->Data4
[5],
2205 (UINTN
)GuidData
->Data4
[6], (UINTN
)GuidData
->Data4
[7]);
2208 } // GuidAsString(EFI_GUID *GuidData)
2210 EFI_GUID
StringAsGuid(CHAR16
* InString
) {
2211 EFI_GUID Guid
= NULL_GUID_VALUE
;
2213 if (!IsGuid(InString
)) {
2217 Guid
.Data1
= (UINT32
) StrToHex(InString
, 0, 8);
2218 Guid
.Data2
= (UINT16
) StrToHex(InString
, 9, 4);
2219 Guid
.Data3
= (UINT16
) StrToHex(InString
, 14, 4);
2220 Guid
.Data4
[0] = (UINT8
) StrToHex(InString
, 19, 2);
2221 Guid
.Data4
[1] = (UINT8
) StrToHex(InString
, 21, 2);
2222 Guid
.Data4
[2] = (UINT8
) StrToHex(InString
, 23, 2);
2223 Guid
.Data4
[3] = (UINT8
) StrToHex(InString
, 26, 2);
2224 Guid
.Data4
[4] = (UINT8
) StrToHex(InString
, 28, 2);
2225 Guid
.Data4
[5] = (UINT8
) StrToHex(InString
, 30, 2);
2226 Guid
.Data4
[6] = (UINT8
) StrToHex(InString
, 32, 2);
2227 Guid
.Data4
[7] = (UINT8
) StrToHex(InString
, 34, 2);
2230 } // EFI_GUID StringAsGuid()
2232 // Returns TRUE if the two GUIDs are equal, FALSE otherwise
2233 BOOLEAN
GuidsAreEqual(EFI_GUID
*Guid1
, EFI_GUID
*Guid2
) {
2234 return (CompareMem(Guid1
, Guid2
, 16) == 0);
2235 } // BOOLEAN GuidsAreEqual()