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
;
269 // EFI variable read and write functions
272 // From gummiboot: Retrieve a raw EFI variable.
273 // Returns EFI status
274 EFI_STATUS
EfivarGetRaw(EFI_GUID
*vendor
, CHAR16
*name
, CHAR8
**buffer
, UINTN
*size
) {
279 l
= sizeof(CHAR16
*) * EFI_MAXIMUM_VARIABLE_SIZE
;
280 buf
= AllocatePool(l
);
282 return EFI_OUT_OF_RESOURCES
;
284 err
= refit_call5_wrapper(RT
->GetVariable
, name
, vendor
, NULL
, &l
, buf
);
285 if (EFI_ERROR(err
) == EFI_SUCCESS
) {
292 } // EFI_STATUS EfivarGetRaw()
294 // From gummiboot: Set an EFI variable
295 EFI_STATUS
EfivarSetRaw(EFI_GUID
*vendor
, CHAR16
*name
, CHAR8
*buf
, UINTN size
, BOOLEAN persistent
) {
298 flags
= EFI_VARIABLE_BOOTSERVICE_ACCESS
|EFI_VARIABLE_RUNTIME_ACCESS
;
300 flags
|= EFI_VARIABLE_NON_VOLATILE
;
302 return refit_call5_wrapper(RT
->SetVariable
, name
, vendor
, flags
, size
, buf
);
303 } // EFI_STATUS EfivarSetRaw()
309 VOID
CreateList(OUT VOID
***ListPtr
, OUT UINTN
*ElementCount
, IN UINTN InitialElementCount
)
313 *ElementCount
= InitialElementCount
;
314 if (*ElementCount
> 0) {
315 AllocateCount
= (*ElementCount
+ 7) & ~7; // next multiple of 8
316 *ListPtr
= AllocatePool(sizeof(VOID
*) * AllocateCount
);
322 VOID
AddListElement(IN OUT VOID
***ListPtr
, IN OUT UINTN
*ElementCount
, IN VOID
*NewElement
)
326 if ((*ElementCount
& 7) == 0) {
327 AllocateCount
= *ElementCount
+ 8;
328 if (*ElementCount
== 0)
329 *ListPtr
= AllocatePool(sizeof(VOID
*) * AllocateCount
);
331 *ListPtr
= EfiReallocatePool(*ListPtr
, sizeof(VOID
*) * (*ElementCount
), sizeof(VOID
*) * AllocateCount
);
333 (*ListPtr
)[*ElementCount
] = NewElement
;
335 } /* VOID AddListElement() */
337 VOID
FreeList(IN OUT VOID
***ListPtr
, IN OUT UINTN
*ElementCount
)
341 if ((*ElementCount
> 0) && (**ListPtr
!= NULL
)) {
342 for (i
= 0; i
< *ElementCount
; i
++) {
343 // TODO: call a user-provided routine for each element here
344 MyFreePool((*ListPtr
)[i
]);
346 MyFreePool(*ListPtr
);
351 // firmware device path discovery
354 static UINT8 LegacyLoaderMediaPathData
[] = {
355 0x04, 0x06, 0x14, 0x00, 0xEB, 0x85, 0x05, 0x2B,
356 0xB8, 0xD8, 0xA9, 0x49, 0x8B, 0x8C, 0xE2, 0x1B,
357 0x01, 0xAE, 0xF2, 0xB7, 0x7F, 0xFF, 0x04, 0x00,
359 static EFI_DEVICE_PATH
*LegacyLoaderMediaPath
= (EFI_DEVICE_PATH
*)LegacyLoaderMediaPathData
;
361 VOID
ExtractLegacyLoaderPaths(EFI_DEVICE_PATH
**PathList
, UINTN MaxPaths
, EFI_DEVICE_PATH
**HardcodedPathList
)
364 UINTN HandleCount
= 0;
365 UINTN HandleIndex
, HardcodedIndex
;
370 EFI_LOADED_IMAGE
*LoadedImage
;
371 EFI_DEVICE_PATH
*DevicePath
;
374 MaxPaths
--; // leave space for the terminating NULL pointer
376 // get all LoadedImage handles
377 Status
= LibLocateHandle(ByProtocol
, &LoadedImageProtocol
, NULL
, &HandleCount
, &Handles
);
378 if (CheckError(Status
, L
"while listing LoadedImage handles")) {
379 if (HardcodedPathList
) {
380 for (HardcodedIndex
= 0; HardcodedPathList
[HardcodedIndex
] && PathCount
< MaxPaths
; HardcodedIndex
++)
381 PathList
[PathCount
++] = HardcodedPathList
[HardcodedIndex
];
383 PathList
[PathCount
] = NULL
;
386 for (HandleIndex
= 0; HandleIndex
< HandleCount
&& PathCount
< MaxPaths
; HandleIndex
++) {
387 Handle
= Handles
[HandleIndex
];
389 Status
= refit_call3_wrapper(BS
->HandleProtocol
, Handle
, &LoadedImageProtocol
, (VOID
**) &LoadedImage
);
390 if (EFI_ERROR(Status
))
391 continue; // This can only happen if the firmware scewed up, ignore it.
393 Status
= refit_call3_wrapper(BS
->HandleProtocol
, LoadedImage
->DeviceHandle
, &DevicePathProtocol
, (VOID
**) &DevicePath
);
394 if (EFI_ERROR(Status
))
395 continue; // This happens, ignore it.
397 // Only grab memory range nodes
398 if (DevicePathType(DevicePath
) != HARDWARE_DEVICE_PATH
|| DevicePathSubType(DevicePath
) != HW_MEMMAP_DP
)
401 // Check if we have this device path in the list already
402 // WARNING: This assumes the first node in the device path is unique!
404 for (PathIndex
= 0; PathIndex
< PathCount
; PathIndex
++) {
405 if (DevicePathNodeLength(DevicePath
) != DevicePathNodeLength(PathList
[PathIndex
]))
407 if (CompareMem(DevicePath
, PathList
[PathIndex
], DevicePathNodeLength(DevicePath
)) == 0) {
415 PathList
[PathCount
++] = AppendDevicePath(DevicePath
, LegacyLoaderMediaPath
);
419 if (HardcodedPathList
) {
420 for (HardcodedIndex
= 0; HardcodedPathList
[HardcodedIndex
] && PathCount
< MaxPaths
; HardcodedIndex
++)
421 PathList
[PathCount
++] = HardcodedPathList
[HardcodedIndex
];
423 PathList
[PathCount
] = NULL
;
430 // Return a pointer to a string containing a filesystem type name. If the
431 // filesystem type is unknown, a blank (but non-null) string is returned.
432 // The returned variable is a constant that should NOT be freed.
433 static CHAR16
*FSTypeName(IN UINT32 TypeCode
) {
434 CHAR16
*retval
= NULL
;
440 case FS_TYPE_HFSPLUS
:
452 case FS_TYPE_REISERFS
:
453 retval
= L
" ReiserFS";
458 case FS_TYPE_ISO9660
:
459 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 4096) bytes
470 // of the filesystem. Sets the filesystem type code in Volume->FSType and the
471 // UUID/serial number in Volume->VolUuid. Note that the UUID value is recognized
472 // differently for each filesystem, and is currently supported only for
473 // ext2/3/4fs and ReiserFS. If the UUID can't be determined, it's set to 0. Also, the UUID
474 // is just read directly into memory; it is *NOT* valid when displayed by
475 // GuidAsString() or used in other GUID/UUID-manipulating functions. (As I
476 // write, it's being used merely to detect partitions that are part of a
478 static VOID
SetFilesystemData(IN UINT8
*Buffer
, IN UINTN BufferSize
, IN OUT REFIT_VOLUME
*Volume
) {
479 UINT32
*Ext2Incompat
, *Ext2Compat
;
483 if ((Buffer
!= NULL
) && (Volume
!= NULL
)) {
484 SetMem(&(Volume
->VolUuid
), sizeof(EFI_GUID
), 0);
485 Volume
->FSType
= FS_TYPE_UNKNOWN
;
487 if (BufferSize
>= 512) {
488 Magic16
= (UINT16
*) (Buffer
+ 510);
489 if (*Magic16
== FAT_MAGIC
) {
490 Volume
->FSType
= FS_TYPE_FAT
;
493 } // search for FAT magic
495 if (BufferSize
>= (1024 + 100)) {
496 Magic16
= (UINT16
*) (Buffer
+ 1024 + 56);
497 if (*Magic16
== EXT2_SUPER_MAGIC
) { // ext2/3/4
498 Ext2Compat
= (UINT32
*) (Buffer
+ 1024 + 92);
499 Ext2Incompat
= (UINT32
*) (Buffer
+ 1024 + 96);
500 if ((*Ext2Incompat
& 0x0040) || (*Ext2Incompat
& 0x0200)) { // check for extents or flex_bg
501 Volume
->FSType
= FS_TYPE_EXT4
;
502 } else if (*Ext2Compat
& 0x0004) { // check for journal
503 Volume
->FSType
= FS_TYPE_EXT3
;
504 } else { // none of these features; presume it's ext2...
505 Volume
->FSType
= FS_TYPE_EXT2
;
507 CopyMem(&(Volume
->VolUuid
), Buffer
+ 1024 + 104, sizeof(EFI_GUID
));
510 } // search for ext2/3/4 magic
512 if (BufferSize
>= (65536 + 100)) {
513 MagicString
= (char*) (Buffer
+ 65536 + 52);
514 if ((CompareMem(MagicString
, REISERFS_SUPER_MAGIC_STRING
, 8) == 0) ||
515 (CompareMem(MagicString
, REISER2FS_SUPER_MAGIC_STRING
, 9) == 0) ||
516 (CompareMem(MagicString
, REISER2FS_JR_SUPER_MAGIC_STRING
, 9) == 0)) {
517 Volume
->FSType
= FS_TYPE_REISERFS
;
518 CopyMem(&(Volume
->VolUuid
), Buffer
+ 65536 + 84, sizeof(EFI_GUID
));
521 } // search for ReiserFS magic
523 if (BufferSize
>= (65536 + 64 + 8)) {
524 MagicString
= (char*) (Buffer
+ 65536 + 64);
525 if (CompareMem(MagicString
, BTRFS_SIGNATURE
, 8) == 0) {
526 Volume
->FSType
= FS_TYPE_BTRFS
;
529 } // search for Btrfs magic
531 if (BufferSize
>= (1024 + 2)) {
532 Magic16
= (UINT16
*) (Buffer
+ 1024);
533 if ((*Magic16
== HFSPLUS_MAGIC1
) || (*Magic16
== HFSPLUS_MAGIC2
)) {
534 Volume
->FSType
= FS_TYPE_HFSPLUS
;
537 } // search for HFS+ magic
538 } // if (Buffer != NULL)
540 } // UINT32 SetFilesystemData()
542 static VOID
ScanVolumeBootcode(REFIT_VOLUME
*Volume
, BOOLEAN
*Bootable
)
545 UINT8 Buffer
[SAMPLE_SIZE
];
547 MBR_PARTITION_INFO
*MbrTable
;
548 BOOLEAN MbrTableFound
= FALSE
;
550 Volume
->HasBootCode
= FALSE
;
551 Volume
->OSIconName
= NULL
;
552 Volume
->OSName
= NULL
;
555 if (Volume
->BlockIO
== NULL
)
557 if (Volume
->BlockIO
->Media
->BlockSize
> SAMPLE_SIZE
)
558 return; // our buffer is too small...
560 // look at the boot sector (this is used for both hard disks and El Torito images!)
561 Status
= refit_call5_wrapper(Volume
->BlockIO
->ReadBlocks
,
562 Volume
->BlockIO
, Volume
->BlockIO
->Media
->MediaId
,
563 Volume
->BlockIOOffset
, SAMPLE_SIZE
, Buffer
);
564 if (!EFI_ERROR(Status
)) {
566 SetFilesystemData(Buffer
, SAMPLE_SIZE
, Volume
);
567 if ((*((UINT16
*)(Buffer
+ 510)) == 0xaa55 && Buffer
[0] != 0) && (FindMem(Buffer
, 512, "EXFAT", 5) == -1)) {
569 Volume
->HasBootCode
= TRUE
;
572 // detect specific boot codes
573 if (CompareMem(Buffer
+ 2, "LILO", 4) == 0 ||
574 CompareMem(Buffer
+ 6, "LILO", 4) == 0 ||
575 CompareMem(Buffer
+ 3, "SYSLINUX", 8) == 0 ||
576 FindMem(Buffer
, SECTOR_SIZE
, "ISOLINUX", 8) >= 0) {
577 Volume
->HasBootCode
= TRUE
;
578 Volume
->OSIconName
= L
"linux";
579 Volume
->OSName
= L
"Linux";
581 } else if (FindMem(Buffer
, 512, "Geom\0Hard Disk\0Read\0 Error", 26) >= 0) { // GRUB
582 Volume
->HasBootCode
= TRUE
;
583 Volume
->OSIconName
= L
"grub,linux";
584 Volume
->OSName
= L
"Linux";
586 // // Below doesn't produce a bootable entry, so commented out for the moment....
587 // // GRUB in BIOS boot partition:
588 // } else if (FindMem(Buffer, 512, "Geom\0Read\0 Error", 16) >= 0) {
589 // Volume->HasBootCode = TRUE;
590 // Volume->OSIconName = L"grub,linux";
591 // Volume->OSName = L"Linux";
592 // Volume->VolName = L"BIOS Boot Partition";
595 } else if ((*((UINT32
*)(Buffer
+ 502)) == 0 &&
596 *((UINT32
*)(Buffer
+ 506)) == 50000 &&
597 *((UINT16
*)(Buffer
+ 510)) == 0xaa55) ||
598 FindMem(Buffer
, SECTOR_SIZE
, "Starting the BTX loader", 23) >= 0) {
599 Volume
->HasBootCode
= TRUE
;
600 Volume
->OSIconName
= L
"freebsd";
601 Volume
->OSName
= L
"FreeBSD";
603 } else if (FindMem(Buffer
, 512, "!Loading", 8) >= 0 ||
604 FindMem(Buffer
, SECTOR_SIZE
, "/cdboot\0/CDBOOT\0", 16) >= 0) {
605 Volume
->HasBootCode
= TRUE
;
606 Volume
->OSIconName
= L
"openbsd";
607 Volume
->OSName
= L
"OpenBSD";
609 } else if (FindMem(Buffer
, 512, "Not a bootxx image", 18) >= 0 ||
610 *((UINT32
*)(Buffer
+ 1028)) == 0x7886b6d1) {
611 Volume
->HasBootCode
= TRUE
;
612 Volume
->OSIconName
= L
"netbsd";
613 Volume
->OSName
= L
"NetBSD";
615 } else if (FindMem(Buffer
, SECTOR_SIZE
, "NTLDR", 5) >= 0) {
616 Volume
->HasBootCode
= TRUE
;
617 Volume
->OSIconName
= L
"win";
618 Volume
->OSName
= L
"Windows";
620 } else if (FindMem(Buffer
, SECTOR_SIZE
, "BOOTMGR", 7) >= 0) {
621 Volume
->HasBootCode
= TRUE
;
622 Volume
->OSIconName
= L
"winvista,win";
623 Volume
->OSName
= L
"Windows";
625 } else if (FindMem(Buffer
, 512, "CPUBOOT SYS", 11) >= 0 ||
626 FindMem(Buffer
, 512, "KERNEL SYS", 11) >= 0) {
627 Volume
->HasBootCode
= TRUE
;
628 Volume
->OSIconName
= L
"freedos";
629 Volume
->OSName
= L
"FreeDOS";
631 } else if (FindMem(Buffer
, 512, "OS2LDR", 6) >= 0 ||
632 FindMem(Buffer
, 512, "OS2BOOT", 7) >= 0) {
633 Volume
->HasBootCode
= TRUE
;
634 Volume
->OSIconName
= L
"ecomstation";
635 Volume
->OSName
= L
"eComStation";
637 } else if (FindMem(Buffer
, 512, "Be Boot Loader", 14) >= 0) {
638 Volume
->HasBootCode
= TRUE
;
639 Volume
->OSIconName
= L
"beos";
640 Volume
->OSName
= L
"BeOS";
642 } else if (FindMem(Buffer
, 512, "yT Boot Loader", 14) >= 0) {
643 Volume
->HasBootCode
= TRUE
;
644 Volume
->OSIconName
= L
"zeta,beos";
645 Volume
->OSName
= L
"ZETA";
647 } else if (FindMem(Buffer
, 512, "\x04" "beos\x06" "system\x05" "zbeos", 18) >= 0 ||
648 FindMem(Buffer
, 512, "\x06" "system\x0c" "haiku_loader", 20) >= 0) {
649 Volume
->HasBootCode
= TRUE
;
650 Volume
->OSIconName
= L
"haiku,beos";
651 Volume
->OSName
= L
"Haiku";
655 // NOTE: If you add an operating system with a name that starts with 'W' or 'L', you
656 // need to fix AddLegacyEntry in main.c.
659 Print(L
" Result of bootcode detection: %s %s (%s)\n",
660 Volume
->HasBootCode
? L
"bootable" : L
"non-bootable",
661 Volume
->OSName
, Volume
->OSIconName
);
664 // dummy FAT boot sector (created by OS X's newfs_msdos)
665 if (FindMem(Buffer
, 512, "Non-system disk", 15) >= 0)
666 Volume
->HasBootCode
= FALSE
;
668 // dummy FAT boot sector (created by Linux's mkdosfs)
669 if (FindMem(Buffer
, 512, "This is not a bootable disk", 27) >= 0)
670 Volume
->HasBootCode
= FALSE
;
672 // dummy FAT boot sector (created by Windows)
673 if (FindMem(Buffer
, 512, "Press any key to restart", 24) >= 0)
674 Volume
->HasBootCode
= FALSE
;
676 // check for MBR partition table
677 if (*((UINT16
*)(Buffer
+ 510)) == 0xaa55) {
678 MbrTable
= (MBR_PARTITION_INFO
*)(Buffer
+ 446);
679 for (i
= 0; i
< 4; i
++)
680 if (MbrTable
[i
].StartLBA
&& MbrTable
[i
].Size
)
681 MbrTableFound
= TRUE
;
682 for (i
= 0; i
< 4; i
++)
683 if (MbrTable
[i
].Flags
!= 0x00 && MbrTable
[i
].Flags
!= 0x80)
684 MbrTableFound
= FALSE
;
686 Volume
->MbrPartitionTable
= AllocatePool(4 * 16);
687 CopyMem(Volume
->MbrPartitionTable
, MbrTable
, 4 * 16);
693 CheckError(Status
, L
"while reading boot sector");
696 } /* VOID ScanVolumeBootcode() */
698 // Set default volume badge icon based on /.VolumeBadge.{icns|png} file or disk kind
699 VOID
SetVolumeBadgeIcon(REFIT_VOLUME
*Volume
)
701 if (Volume
->VolBadgeImage
== NULL
) {
702 Volume
->VolBadgeImage
= egLoadIconAnyType(Volume
->RootDir
, L
"", L
".VolumeBadge", GlobalConfig
.IconSizes
[ICON_SIZE_BADGE
]);
705 if (Volume
->VolBadgeImage
== NULL
) {
706 switch (Volume
->DiskKind
) {
707 case DISK_KIND_INTERNAL
:
708 Volume
->VolBadgeImage
= BuiltinIcon(BUILTIN_ICON_VOL_INTERNAL
);
710 case DISK_KIND_EXTERNAL
:
711 Volume
->VolBadgeImage
= BuiltinIcon(BUILTIN_ICON_VOL_EXTERNAL
);
713 case DISK_KIND_OPTICAL
:
714 Volume
->VolBadgeImage
= BuiltinIcon(BUILTIN_ICON_VOL_OPTICAL
);
717 Volume
->VolBadgeImage
= BuiltinIcon(BUILTIN_ICON_VOL_NET
);
721 } // VOID SetVolumeBadgeIcon()
723 // Return a string representing the input size in IEEE-1541 units.
724 // The calling function is responsible for freeing the allocated memory.
725 static CHAR16
*SizeInIEEEUnits(UINT64 SizeInBytes
) {
727 UINTN Index
= 0, NumPrefixes
;
728 CHAR16
*Units
, *Prefixes
= L
" KMGTPEZ";
731 TheValue
= AllocateZeroPool(sizeof(CHAR16
) * 256);
732 if (TheValue
!= NULL
) {
733 NumPrefixes
= StrLen(Prefixes
);
734 SizeInIeee
= SizeInBytes
;
735 while ((SizeInIeee
> 1024) && (Index
< (NumPrefixes
- 1))) {
739 if (Prefixes
[Index
] == ' ') {
740 Units
= StrDuplicate(L
"-byte");
742 Units
= StrDuplicate(L
" iB");
743 Units
[1] = Prefixes
[Index
];
745 SPrint(TheValue
, 255, L
"%ld%s", SizeInIeee
, Units
);
748 } // CHAR16 *SizeInIEEEUnits()
750 // Return a name for the volume. Ideally this should be the label for the
751 // filesystem it contains, but this function falls back to describing the
752 // filesystem by size (200 MiB, etc.) and/or type (ext2, HFS+, etc.), if
753 // this information can be extracted.
754 // The calling function is responsible for freeing the memory allocated
755 // for the name string.
756 static CHAR16
*GetVolumeName(REFIT_VOLUME
*Volume
) {
757 EFI_FILE_SYSTEM_INFO
*FileSystemInfoPtr
= NULL
;
758 CHAR16
*FoundName
= NULL
;
759 CHAR16
*SISize
, *TypeName
;
761 if (Volume
->RootDir
!= NULL
) {
762 FileSystemInfoPtr
= LibFileSystemInfo(Volume
->RootDir
);
765 if ((FileSystemInfoPtr
!= NULL
) && (FileSystemInfoPtr
->VolumeLabel
!= NULL
) &&
766 (StrLen(FileSystemInfoPtr
->VolumeLabel
) > 0)) {
767 FoundName
= StrDuplicate(FileSystemInfoPtr
->VolumeLabel
);
770 // Special case: Old versions of the rEFInd HFS+ driver always returns label of "HFS+ volume", so wipe
771 // this so that we can build a new name that includes the size....
772 if ((FoundName
!= NULL
) && (StrCmp(FoundName
, L
"HFS+ volume") == 0) && (Volume
->FSType
== FS_TYPE_HFSPLUS
)) {
773 MyFreePool(FoundName
);
775 } // if rEFInd HFS+ driver suspected
777 // If no filesystem name, try to use the partition name....
778 if ((FoundName
== NULL
) && (Volume
->PartName
!= NULL
) && (StrLen(Volume
->PartName
) > 0) &&
779 !IsIn(Volume
->PartName
, IGNORE_PARTITION_NAMES
)) {
780 FoundName
= StrDuplicate(Volume
->PartName
);
781 } // if use partition name
783 // No filesystem or acceptable partition name, so use fs type and size
784 if ((FoundName
== NULL
) && (FileSystemInfoPtr
!= NULL
)) {
785 FoundName
= AllocateZeroPool(sizeof(CHAR16
) * 256);
786 if (FoundName
!= NULL
) {
787 SISize
= SizeInIEEEUnits(FileSystemInfoPtr
->VolumeSize
);
788 SPrint(FoundName
, 255, L
"%s%s volume", SISize
, FSTypeName(Volume
->FSType
));
790 } // if allocated memory OK
791 } // if (FoundName == NULL)
793 MyFreePool(FileSystemInfoPtr
);
795 if (FoundName
== NULL
) {
796 FoundName
= AllocateZeroPool(sizeof(CHAR16
) * 256);
797 if (FoundName
!= NULL
) {
798 TypeName
= FSTypeName(Volume
->FSType
); // NOTE: Don't free TypeName; function returns constant
799 if (StrLen(TypeName
) > 0)
800 SPrint(FoundName
, 255, L
"%s volume", TypeName
);
802 SPrint(FoundName
, 255, L
"unknown volume");
803 } // if allocated memory OK
806 // TODO: Above could be improved/extended, in case filesystem name is not found,
808 // - use or add disk/partition number (e.g., "(hd0,2)")
810 // Desperate fallback name....
811 if (FoundName
== NULL
) {
812 FoundName
= StrDuplicate(L
"unknown volume");
815 } // static CHAR16 *GetVolumeName()
817 // Determine the unique GUID of the volume and store it.
818 static VOID
SetPartGuidAndName(REFIT_VOLUME
*Volume
, EFI_DEVICE_PATH_PROTOCOL
*DevicePath
) {
819 HARDDRIVE_DEVICE_PATH
*HdDevicePath
;
824 if ((DevicePath
->Type
== MEDIA_DEVICE_PATH
) && (DevicePath
->SubType
== MEDIA_HARDDRIVE_DP
)) {
825 HdDevicePath
= (HARDDRIVE_DEVICE_PATH
*) DevicePath
;
826 if (HdDevicePath
->SignatureType
== SIGNATURE_TYPE_GUID
) {
827 Volume
->PartGuid
= *((EFI_GUID
*) HdDevicePath
->Signature
);
828 Volume
->PartName
= PartNameFromGuid(&(Volume
->PartGuid
));
831 } // VOID SetPartGuid()
833 VOID
ScanVolume(REFIT_VOLUME
*Volume
)
836 EFI_DEVICE_PATH
*DevicePath
, *NextDevicePath
;
837 EFI_DEVICE_PATH
*DiskDevicePath
, *RemainingDevicePath
;
838 EFI_HANDLE WholeDiskHandle
;
843 Volume
->DevicePath
= DuplicateDevicePath(DevicePathFromHandle(Volume
->DeviceHandle
));
845 if (Volume
->DevicePath
!= NULL
) {
846 Print(L
"* %s\n", DevicePathToStr(Volume
->DevicePath
));
848 DumpHex(1, 0, DevicePathSize(Volume
->DevicePath
), Volume
->DevicePath
);
853 Volume
->DiskKind
= DISK_KIND_INTERNAL
; // default
856 Status
= refit_call3_wrapper(BS
->HandleProtocol
, Volume
->DeviceHandle
, &BlockIoProtocol
, (VOID
**) &(Volume
->BlockIO
));
857 if (EFI_ERROR(Status
)) {
858 Volume
->BlockIO
= NULL
;
859 Print(L
"Warning: Can't get BlockIO protocol.\n");
861 if (Volume
->BlockIO
->Media
->BlockSize
== 2048)
862 Volume
->DiskKind
= DISK_KIND_OPTICAL
;
865 // scan for bootcode and MBR table
867 ScanVolumeBootcode(Volume
, &Bootable
);
869 // detect device type
870 DevicePath
= Volume
->DevicePath
;
871 while (DevicePath
!= NULL
&& !IsDevicePathEndType(DevicePath
)) {
872 NextDevicePath
= NextDevicePathNode(DevicePath
);
874 if (DevicePathType(DevicePath
) == MEDIA_DEVICE_PATH
) {
875 SetPartGuidAndName(Volume
, DevicePath
);
877 if (DevicePathType(DevicePath
) == MESSAGING_DEVICE_PATH
&&
878 (DevicePathSubType(DevicePath
) == MSG_USB_DP
||
879 DevicePathSubType(DevicePath
) == MSG_USB_CLASS_DP
||
880 DevicePathSubType(DevicePath
) == MSG_1394_DP
||
881 DevicePathSubType(DevicePath
) == MSG_FIBRECHANNEL_DP
))
882 Volume
->DiskKind
= DISK_KIND_EXTERNAL
; // USB/FireWire/FC device -> external
883 if (DevicePathType(DevicePath
) == MEDIA_DEVICE_PATH
&&
884 DevicePathSubType(DevicePath
) == MEDIA_CDROM_DP
) {
885 Volume
->DiskKind
= DISK_KIND_OPTICAL
; // El Torito entry -> optical disk
889 if (DevicePathType(DevicePath
) == MEDIA_DEVICE_PATH
&& DevicePathSubType(DevicePath
) == MEDIA_VENDOR_DP
) {
890 Volume
->IsAppleLegacy
= TRUE
; // legacy BIOS device entry
891 // TODO: also check for Boot Camp GUID
892 Bootable
= FALSE
; // this handle's BlockIO is just an alias for the whole device
895 if (DevicePathType(DevicePath
) == MESSAGING_DEVICE_PATH
) {
896 // make a device path for the whole device
897 PartialLength
= (UINT8
*)NextDevicePath
- (UINT8
*)(Volume
->DevicePath
);
898 DiskDevicePath
= (EFI_DEVICE_PATH
*)AllocatePool(PartialLength
+ sizeof(EFI_DEVICE_PATH
));
899 CopyMem(DiskDevicePath
, Volume
->DevicePath
, PartialLength
);
900 CopyMem((UINT8
*)DiskDevicePath
+ PartialLength
, EndDevicePath
, sizeof(EFI_DEVICE_PATH
));
902 // get the handle for that path
903 RemainingDevicePath
= DiskDevicePath
;
904 Status
= refit_call3_wrapper(BS
->LocateDevicePath
, &BlockIoProtocol
, &RemainingDevicePath
, &WholeDiskHandle
);
905 FreePool(DiskDevicePath
);
907 if (!EFI_ERROR(Status
)) {
908 //Print(L" - original handle: %08x - disk handle: %08x\n", (UINT32)DeviceHandle, (UINT32)WholeDiskHandle);
910 // get the device path for later
911 Status
= refit_call3_wrapper(BS
->HandleProtocol
, WholeDiskHandle
, &DevicePathProtocol
, (VOID
**) &DiskDevicePath
);
912 if (!EFI_ERROR(Status
)) {
913 Volume
->WholeDiskDevicePath
= DuplicateDevicePath(DiskDevicePath
);
916 // look at the BlockIO protocol
917 Status
= refit_call3_wrapper(BS
->HandleProtocol
, WholeDiskHandle
, &BlockIoProtocol
,
918 (VOID
**) &Volume
->WholeDiskBlockIO
);
919 if (!EFI_ERROR(Status
)) {
921 // check the media block size
922 if (Volume
->WholeDiskBlockIO
->Media
->BlockSize
== 2048)
923 Volume
->DiskKind
= DISK_KIND_OPTICAL
;
926 Volume
->WholeDiskBlockIO
= NULL
;
927 //CheckError(Status, L"from HandleProtocol");
930 // CheckError(Status, L"from LocateDevicePath");
933 DevicePath
= NextDevicePath
;
938 if (Volume
->HasBootCode
)
939 Print(L
" Volume considered non-bootable, but boot code is present\n");
941 Volume
->HasBootCode
= FALSE
;
944 // open the root directory of the volume
945 Volume
->RootDir
= LibOpenRoot(Volume
->DeviceHandle
);
947 // Set volume icon based on .VolumeBadge icon or disk kind
948 SetVolumeBadgeIcon(Volume
);
950 Volume
->VolName
= GetVolumeName(Volume
);
952 if (Volume
->RootDir
== NULL
) {
953 Volume
->IsReadable
= FALSE
;
956 Volume
->IsReadable
= TRUE
;
959 // get custom volume icons if present
960 if (!Volume
->VolIconImage
)
961 Volume
->VolIconImage
= egLoadIconAnyType(Volume
->RootDir
, L
"", L
".VolumeIcon", GlobalConfig
.IconSizes
[ICON_SIZE_BIG
]);
964 static VOID
ScanExtendedPartition(REFIT_VOLUME
*WholeDiskVolume
, MBR_PARTITION_INFO
*MbrEntry
)
967 REFIT_VOLUME
*Volume
;
968 UINT32 ExtBase
, ExtCurrent
, NextExtCurrent
;
970 UINTN LogicalPartitionIndex
= 4;
971 UINT8 SectorBuffer
[512];
973 MBR_PARTITION_INFO
*EMbrTable
;
975 ExtBase
= MbrEntry
->StartLBA
;
977 for (ExtCurrent
= ExtBase
; ExtCurrent
; ExtCurrent
= NextExtCurrent
) {
979 Status
= refit_call5_wrapper(WholeDiskVolume
->BlockIO
->ReadBlocks
,
980 WholeDiskVolume
->BlockIO
,
981 WholeDiskVolume
->BlockIO
->Media
->MediaId
,
982 ExtCurrent
, 512, SectorBuffer
);
983 if (EFI_ERROR(Status
))
985 if (*((UINT16
*)(SectorBuffer
+ 510)) != 0xaa55)
987 EMbrTable
= (MBR_PARTITION_INFO
*)(SectorBuffer
+ 446);
989 // scan logical partitions in this EMBR
991 for (i
= 0; i
< 4; i
++) {
992 if ((EMbrTable
[i
].Flags
!= 0x00 && EMbrTable
[i
].Flags
!= 0x80) ||
993 EMbrTable
[i
].StartLBA
== 0 || EMbrTable
[i
].Size
== 0)
995 if (IS_EXTENDED_PART_TYPE(EMbrTable
[i
].Type
)) {
996 // set next ExtCurrent
997 NextExtCurrent
= ExtBase
+ EMbrTable
[i
].StartLBA
;
1001 // found a logical partition
1002 Volume
= AllocateZeroPool(sizeof(REFIT_VOLUME
));
1003 Volume
->DiskKind
= WholeDiskVolume
->DiskKind
;
1004 Volume
->IsMbrPartition
= TRUE
;
1005 Volume
->MbrPartitionIndex
= LogicalPartitionIndex
++;
1006 Volume
->VolName
= AllocateZeroPool(256 * sizeof(UINT16
));
1007 SPrint(Volume
->VolName
, 255, L
"Partition %d", Volume
->MbrPartitionIndex
+ 1);
1008 Volume
->BlockIO
= WholeDiskVolume
->BlockIO
;
1009 Volume
->BlockIOOffset
= ExtCurrent
+ EMbrTable
[i
].StartLBA
;
1010 Volume
->WholeDiskBlockIO
= WholeDiskVolume
->BlockIO
;
1013 ScanVolumeBootcode(Volume
, &Bootable
);
1015 Volume
->HasBootCode
= FALSE
;
1017 SetVolumeBadgeIcon(Volume
);
1019 AddListElement((VOID
***) &Volumes
, &VolumesCount
, Volume
);
1024 } /* VOID ScanExtendedPartition() */
1026 VOID
ScanVolumes(VOID
)
1029 EFI_HANDLE
*Handles
;
1030 REFIT_VOLUME
*Volume
, *WholeDiskVolume
;
1031 MBR_PARTITION_INFO
*MbrTable
;
1032 UINTN HandleCount
= 0;
1034 UINTN VolumeIndex
, VolumeIndex2
;
1035 UINTN PartitionIndex
;
1036 UINTN SectorSum
, i
, VolNumber
= 0;
1037 UINT8
*SectorBuffer1
, *SectorBuffer2
;
1039 EFI_GUID NullUuid
= NULL_GUID_VALUE
;
1041 MyFreePool(Volumes
);
1044 ForgetPartitionTables();
1046 // get all filesystem handles
1047 Status
= LibLocateHandle(ByProtocol
, &BlockIoProtocol
, NULL
, &HandleCount
, &Handles
);
1048 UuidList
= AllocateZeroPool(sizeof(EFI_GUID
) * HandleCount
);
1049 if (Status
== EFI_NOT_FOUND
) {
1050 return; // no filesystems. strange, but true...
1052 if (CheckError(Status
, L
"while listing all file systems"))
1055 // first pass: collect information about all handles
1056 for (HandleIndex
= 0; HandleIndex
< HandleCount
; HandleIndex
++) {
1057 Volume
= AllocateZeroPool(sizeof(REFIT_VOLUME
));
1058 Volume
->DeviceHandle
= Handles
[HandleIndex
];
1059 AddPartitionTable(Volume
);
1062 UuidList
[HandleIndex
] = Volume
->VolUuid
;
1063 for (i
= 0; i
< HandleIndex
; i
++) {
1064 if ((CompareMem(&(Volume
->VolUuid
), &(UuidList
[i
]), sizeof(EFI_GUID
)) == 0) &&
1065 (CompareMem(&(Volume
->VolUuid
), &NullUuid
, sizeof(EFI_GUID
)) != 0)) { // Duplicate filesystem UUID
1066 Volume
->IsReadable
= FALSE
;
1070 if (Volume
->IsReadable
)
1071 Volume
->VolNumber
= VolNumber
++;
1073 Volume
->VolNumber
= VOL_UNREADABLE
;
1075 AddListElement((VOID
***) &Volumes
, &VolumesCount
, Volume
);
1077 if (Volume
->DeviceHandle
== SelfLoadedImage
->DeviceHandle
)
1078 SelfVolume
= Volume
;
1080 MyFreePool(Handles
);
1082 if (SelfVolume
== NULL
)
1083 Print(L
"WARNING: SelfVolume not found");
1085 // second pass: relate partitions and whole disk devices
1086 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
1087 Volume
= Volumes
[VolumeIndex
];
1088 // check MBR partition table for extended partitions
1089 if (Volume
->BlockIO
!= NULL
&& Volume
->WholeDiskBlockIO
!= NULL
&&
1090 Volume
->BlockIO
== Volume
->WholeDiskBlockIO
&& Volume
->BlockIOOffset
== 0 &&
1091 Volume
->MbrPartitionTable
!= NULL
) {
1092 MbrTable
= Volume
->MbrPartitionTable
;
1093 for (PartitionIndex
= 0; PartitionIndex
< 4; PartitionIndex
++) {
1094 if (IS_EXTENDED_PART_TYPE(MbrTable
[PartitionIndex
].Type
)) {
1095 ScanExtendedPartition(Volume
, MbrTable
+ PartitionIndex
);
1100 // search for corresponding whole disk volume entry
1101 WholeDiskVolume
= NULL
;
1102 if (Volume
->BlockIO
!= NULL
&& Volume
->WholeDiskBlockIO
!= NULL
&&
1103 Volume
->BlockIO
!= Volume
->WholeDiskBlockIO
) {
1104 for (VolumeIndex2
= 0; VolumeIndex2
< VolumesCount
; VolumeIndex2
++) {
1105 if (Volumes
[VolumeIndex2
]->BlockIO
== Volume
->WholeDiskBlockIO
&&
1106 Volumes
[VolumeIndex2
]->BlockIOOffset
== 0) {
1107 WholeDiskVolume
= Volumes
[VolumeIndex2
];
1112 if (WholeDiskVolume
!= NULL
&& WholeDiskVolume
->MbrPartitionTable
!= NULL
) {
1113 // check if this volume is one of the partitions in the table
1114 MbrTable
= WholeDiskVolume
->MbrPartitionTable
;
1115 SectorBuffer1
= AllocatePool(512);
1116 SectorBuffer2
= AllocatePool(512);
1117 for (PartitionIndex
= 0; PartitionIndex
< 4; PartitionIndex
++) {
1119 if ((UINT64
)(MbrTable
[PartitionIndex
].Size
) != Volume
->BlockIO
->Media
->LastBlock
+ 1)
1122 // compare boot sector read through offset vs. directly
1123 Status
= refit_call5_wrapper(Volume
->BlockIO
->ReadBlocks
,
1124 Volume
->BlockIO
, Volume
->BlockIO
->Media
->MediaId
,
1125 Volume
->BlockIOOffset
, 512, SectorBuffer1
);
1126 if (EFI_ERROR(Status
))
1128 Status
= refit_call5_wrapper(Volume
->WholeDiskBlockIO
->ReadBlocks
,
1129 Volume
->WholeDiskBlockIO
, Volume
->WholeDiskBlockIO
->Media
->MediaId
,
1130 MbrTable
[PartitionIndex
].StartLBA
, 512, SectorBuffer2
);
1131 if (EFI_ERROR(Status
))
1133 if (CompareMem(SectorBuffer1
, SectorBuffer2
, 512) != 0)
1136 for (i
= 0; i
< 512; i
++)
1137 SectorSum
+= SectorBuffer1
[i
];
1138 if (SectorSum
< 1000)
1141 // TODO: mark entry as non-bootable if it is an extended partition
1143 // now we're reasonably sure the association is correct...
1144 Volume
->IsMbrPartition
= TRUE
;
1145 Volume
->MbrPartitionIndex
= PartitionIndex
;
1146 if (Volume
->VolName
== NULL
) {
1147 Volume
->VolName
= AllocateZeroPool(sizeof(CHAR16
) * 256);
1148 SPrint(Volume
->VolName
, 255, L
"Partition %d", PartitionIndex
+ 1);
1153 MyFreePool(SectorBuffer1
);
1154 MyFreePool(SectorBuffer2
);
1157 } /* VOID ScanVolumes() */
1159 static VOID
UninitVolumes(VOID
)
1161 REFIT_VOLUME
*Volume
;
1164 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
1165 Volume
= Volumes
[VolumeIndex
];
1167 if (Volume
->RootDir
!= NULL
) {
1168 refit_call1_wrapper(Volume
->RootDir
->Close
, Volume
->RootDir
);
1169 Volume
->RootDir
= NULL
;
1172 Volume
->DeviceHandle
= NULL
;
1173 Volume
->BlockIO
= NULL
;
1174 Volume
->WholeDiskBlockIO
= NULL
;
1178 VOID
ReinitVolumes(VOID
)
1181 REFIT_VOLUME
*Volume
;
1183 EFI_DEVICE_PATH
*RemainingDevicePath
;
1184 EFI_HANDLE DeviceHandle
, WholeDiskHandle
;
1186 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
1187 Volume
= Volumes
[VolumeIndex
];
1189 if (Volume
->DevicePath
!= NULL
) {
1190 // get the handle for that path
1191 RemainingDevicePath
= Volume
->DevicePath
;
1192 Status
= refit_call3_wrapper(BS
->LocateDevicePath
, &BlockIoProtocol
, &RemainingDevicePath
, &DeviceHandle
);
1194 if (!EFI_ERROR(Status
)) {
1195 Volume
->DeviceHandle
= DeviceHandle
;
1197 // get the root directory
1198 Volume
->RootDir
= LibOpenRoot(Volume
->DeviceHandle
);
1201 CheckError(Status
, L
"from LocateDevicePath");
1204 if (Volume
->WholeDiskDevicePath
!= NULL
) {
1205 // get the handle for that path
1206 RemainingDevicePath
= Volume
->WholeDiskDevicePath
;
1207 Status
= refit_call3_wrapper(BS
->LocateDevicePath
, &BlockIoProtocol
, &RemainingDevicePath
, &WholeDiskHandle
);
1209 if (!EFI_ERROR(Status
)) {
1210 // get the BlockIO protocol
1211 Status
= refit_call3_wrapper(BS
->HandleProtocol
, WholeDiskHandle
, &BlockIoProtocol
,
1212 (VOID
**) &Volume
->WholeDiskBlockIO
);
1213 if (EFI_ERROR(Status
)) {
1214 Volume
->WholeDiskBlockIO
= NULL
;
1215 CheckError(Status
, L
"from HandleProtocol");
1218 CheckError(Status
, L
"from LocateDevicePath");
1224 // file and dir functions
1227 BOOLEAN
FileExists(IN EFI_FILE
*BaseDir
, IN CHAR16
*RelativePath
)
1230 EFI_FILE_HANDLE TestFile
;
1232 Status
= refit_call5_wrapper(BaseDir
->Open
, BaseDir
, &TestFile
, RelativePath
, EFI_FILE_MODE_READ
, 0);
1233 if (Status
== EFI_SUCCESS
) {
1234 refit_call1_wrapper(TestFile
->Close
, TestFile
);
1240 EFI_STATUS
DirNextEntry(IN EFI_FILE
*Directory
, IN OUT EFI_FILE_INFO
**DirEntry
, IN UINTN FilterMode
)
1244 UINTN LastBufferSize
, BufferSize
;
1249 // free pointer from last call
1250 if (*DirEntry
!= NULL
) {
1251 FreePool(*DirEntry
);
1255 // read next directory entry
1256 LastBufferSize
= BufferSize
= 256;
1257 Buffer
= AllocatePool(BufferSize
);
1258 for (IterCount
= 0; ; IterCount
++) {
1259 Status
= refit_call3_wrapper(Directory
->Read
, Directory
, &BufferSize
, Buffer
);
1260 if (Status
!= EFI_BUFFER_TOO_SMALL
|| IterCount
>= 4)
1262 if (BufferSize
<= LastBufferSize
) {
1263 Print(L
"FS Driver requests bad buffer size %d (was %d), using %d instead\n", BufferSize
, LastBufferSize
, LastBufferSize
* 2);
1264 BufferSize
= LastBufferSize
* 2;
1267 Print(L
"Reallocating buffer from %d to %d\n", LastBufferSize
, BufferSize
);
1270 Buffer
= EfiReallocatePool(Buffer
, LastBufferSize
, BufferSize
);
1271 LastBufferSize
= BufferSize
;
1273 if (EFI_ERROR(Status
)) {
1279 // check for end of listing
1280 if (BufferSize
== 0) { // end of directory listing
1286 // entry is ready to be returned
1287 *DirEntry
= (EFI_FILE_INFO
*)Buffer
;
1290 if (FilterMode
== 1) { // only return directories
1291 if (((*DirEntry
)->Attribute
& EFI_FILE_DIRECTORY
))
1293 } else if (FilterMode
== 2) { // only return files
1294 if (((*DirEntry
)->Attribute
& EFI_FILE_DIRECTORY
) == 0)
1296 } else // no filter or unknown filter -> return everything
1303 VOID
DirIterOpen(IN EFI_FILE
*BaseDir
, IN CHAR16
*RelativePath OPTIONAL
, OUT REFIT_DIR_ITER
*DirIter
)
1305 if (RelativePath
== NULL
) {
1306 DirIter
->LastStatus
= EFI_SUCCESS
;
1307 DirIter
->DirHandle
= BaseDir
;
1308 DirIter
->CloseDirHandle
= FALSE
;
1310 DirIter
->LastStatus
= refit_call5_wrapper(BaseDir
->Open
, BaseDir
, &(DirIter
->DirHandle
), RelativePath
, EFI_FILE_MODE_READ
, 0);
1311 DirIter
->CloseDirHandle
= EFI_ERROR(DirIter
->LastStatus
) ? FALSE
: TRUE
;
1313 DirIter
->LastFileInfo
= NULL
;
1316 #ifndef __MAKEWITH_GNUEFI
1317 EFI_UNICODE_COLLATION_PROTOCOL
*mUnicodeCollation
= NULL
;
1320 InitializeUnicodeCollationProtocol (VOID
)
1324 if (mUnicodeCollation
!= NULL
) {
1329 // BUGBUG: Proper impelmentation is to locate all Unicode Collation Protocol
1330 // instances first and then select one which support English language.
1331 // Current implementation just pick the first instance.
1333 Status
= gBS
->LocateProtocol (
1334 &gEfiUnicodeCollation2ProtocolGuid
,
1336 (VOID
**) &mUnicodeCollation
1338 if (EFI_ERROR(Status
)) {
1339 Status
= gBS
->LocateProtocol (
1340 &gEfiUnicodeCollationProtocolGuid
,
1342 (VOID
**) &mUnicodeCollation
1350 MetaiMatch (IN CHAR16
*String
, IN CHAR16
*Pattern
)
1352 if (!mUnicodeCollation
) {
1353 InitializeUnicodeCollationProtocol();
1355 if (mUnicodeCollation
)
1356 return mUnicodeCollation
->MetaiMatch (mUnicodeCollation
, String
, Pattern
);
1357 return FALSE
; // Shouldn't happen
1360 static VOID
StrLwr (IN OUT CHAR16
*Str
) {
1361 if (!mUnicodeCollation
) {
1362 InitializeUnicodeCollationProtocol();
1364 if (mUnicodeCollation
)
1365 mUnicodeCollation
->StrLwr (mUnicodeCollation
, Str
);
1370 BOOLEAN
DirIterNext(IN OUT REFIT_DIR_ITER
*DirIter
, IN UINTN FilterMode
, IN CHAR16
*FilePattern OPTIONAL
,
1371 OUT EFI_FILE_INFO
**DirEntry
)
1373 BOOLEAN KeepGoing
= TRUE
;
1377 if (DirIter
->LastFileInfo
!= NULL
) {
1378 FreePool(DirIter
->LastFileInfo
);
1379 DirIter
->LastFileInfo
= NULL
;
1382 if (EFI_ERROR(DirIter
->LastStatus
))
1383 return FALSE
; // stop iteration
1386 DirIter
->LastStatus
= DirNextEntry(DirIter
->DirHandle
, &(DirIter
->LastFileInfo
), FilterMode
);
1387 if (EFI_ERROR(DirIter
->LastStatus
))
1389 if (DirIter
->LastFileInfo
== NULL
) // end of listing
1391 if (FilePattern
!= NULL
) {
1392 if ((DirIter
->LastFileInfo
->Attribute
& EFI_FILE_DIRECTORY
))
1395 while (KeepGoing
&& (OnePattern
= FindCommaDelimited(FilePattern
, i
++)) != NULL
) {
1396 if (MetaiMatch(DirIter
->LastFileInfo
->FileName
, OnePattern
))
1399 // else continue loop
1402 } while (KeepGoing
&& FilePattern
);
1404 *DirEntry
= DirIter
->LastFileInfo
;
1408 EFI_STATUS
DirIterClose(IN OUT REFIT_DIR_ITER
*DirIter
)
1410 if (DirIter
->LastFileInfo
!= NULL
) {
1411 FreePool(DirIter
->LastFileInfo
);
1412 DirIter
->LastFileInfo
= NULL
;
1414 if (DirIter
->CloseDirHandle
)
1415 refit_call1_wrapper(DirIter
->DirHandle
->Close
, DirIter
->DirHandle
);
1416 return DirIter
->LastStatus
;
1420 // file name manipulation
1423 // Returns the filename portion (minus path name) of the
1425 CHAR16
* Basename(IN CHAR16
*Path
)
1433 for (i
= StrLen(Path
); i
> 0; i
--) {
1434 if (Path
[i
-1] == '\\' || Path
[i
-1] == '/') {
1435 FileName
= Path
+ i
;
1444 // Remove the .efi extension from FileName -- for instance, if FileName is
1445 // "fred.efi", returns "fred". If the filename contains no .efi extension,
1446 // returns a copy of the original input.
1447 CHAR16
* StripEfiExtension(CHAR16
*FileName
) {
1449 CHAR16
*Copy
= NULL
;
1451 if ((FileName
!= NULL
) && ((Copy
= StrDuplicate(FileName
)) != NULL
)) {
1452 Length
= StrLen(Copy
);
1453 // Note: Do StriCmp() twice to work around Gigabyte Hybrid EFI case-sensitivity bug....
1454 if ((Length
>= 4) && ((StriCmp(&Copy
[Length
- 4], L
".efi") == 0) || (StriCmp(&Copy
[Length
- 4], L
".EFI") == 0))) {
1455 Copy
[Length
- 4] = 0;
1459 } // CHAR16 * StripExtension()
1462 // memory string search
1465 INTN
FindMem(IN VOID
*Buffer
, IN UINTN BufferLength
, IN VOID
*SearchString
, IN UINTN SearchStringLength
)
1471 BufferLength
-= SearchStringLength
;
1472 for (Offset
= 0; Offset
< BufferLength
; Offset
++, BufferPtr
++) {
1473 if (CompareMem(BufferPtr
, SearchString
, SearchStringLength
) == 0)
1474 return (INTN
)Offset
;
1480 // Performs a case-insensitive search of BigStr for SmallStr.
1481 // Returns TRUE if found, FALSE if not.
1482 BOOLEAN
StriSubCmp(IN CHAR16
*SmallStr
, IN CHAR16
*BigStr
) {
1483 CHAR16
*SmallCopy
, *BigCopy
;
1484 BOOLEAN Found
= FALSE
;
1485 UINTN StartPoint
= 0, NumCompares
= 0, SmallLen
= 0;
1487 if ((SmallStr
!= NULL
) && (BigStr
!= NULL
) && (StrLen(BigStr
) >= StrLen(SmallStr
))) {
1488 SmallCopy
= StrDuplicate(SmallStr
);
1489 BigCopy
= StrDuplicate(BigStr
);
1492 SmallLen
= StrLen(SmallCopy
);
1493 NumCompares
= StrLen(BigCopy
) - SmallLen
+ 1;
1494 while ((!Found
) && (StartPoint
< NumCompares
)) {
1495 Found
= (StrnCmp(SmallCopy
, &BigCopy
[StartPoint
++], SmallLen
) == 0);
1497 MyFreePool(SmallCopy
);
1498 MyFreePool(BigCopy
);
1502 } // BOOLEAN StriSubCmp()
1504 // Merges two strings, creating a new one and returning a pointer to it.
1505 // If AddChar != 0, the specified character is placed between the two original
1506 // strings (unless the first string is NULL or empty). The original input
1507 // string *First is de-allocated and replaced by the new merged string.
1508 // This is similar to StrCat, but safer and more flexible because
1509 // MergeStrings allocates memory that's the correct size for the
1510 // new merged string, so it can take a NULL *First and it cleans
1511 // up the old memory. It should *NOT* be used with a constant
1512 // *First, though....
1513 VOID
MergeStrings(IN OUT CHAR16
**First
, IN CHAR16
*Second
, CHAR16 AddChar
) {
1514 UINTN Length1
= 0, Length2
= 0;
1518 Length1
= StrLen(*First
);
1520 Length2
= StrLen(Second
);
1521 NewString
= AllocatePool(sizeof(CHAR16
) * (Length1
+ Length2
+ 2));
1522 if (NewString
!= NULL
) {
1523 if ((*First
!= NULL
) && (StrLen(*First
) == 0)) {
1527 NewString
[0] = L
'\0';
1528 if (*First
!= NULL
) {
1529 StrCat(NewString
, *First
);
1531 NewString
[Length1
] = AddChar
;
1532 NewString
[Length1
+ 1] = '\0';
1534 } // if (*First != NULL)
1536 StrCat(NewString
, Second
);
1540 Print(L
"Error! Unable to allocate memory in MergeStrings()!\n");
1542 } // static CHAR16* MergeStrings()
1544 // Takes an input pathname (*Path) and returns the part of the filename from
1545 // the final dot onwards, converted to lowercase. If the filename includes
1546 // no dots, or if the input is NULL, returns an empty (but allocated) string.
1547 // The calling function is responsible for freeing the memory associated with
1548 // the return value.
1549 CHAR16
*FindExtension(IN CHAR16
*Path
) {
1551 BOOLEAN Found
= FALSE
, FoundSlash
= FALSE
;
1554 Extension
= AllocateZeroPool(sizeof(CHAR16
));
1557 while ((!Found
) && (!FoundSlash
) && (i
>= 0)) {
1558 if (Path
[i
] == L
'.')
1560 else if ((Path
[i
] == L
'/') || (Path
[i
] == L
'\\'))
1566 MergeStrings(&Extension
, &Path
[i
], 0);
1571 } // CHAR16 *FindExtension
1573 // Takes an input pathname (*Path) and locates the final directory component
1574 // of that name. For instance, if the input path is 'EFI\foo\bar.efi', this
1575 // function returns the string 'foo'.
1576 // Assumes the pathname is separated with backslashes.
1577 CHAR16
*FindLastDirName(IN CHAR16
*Path
) {
1578 UINTN i
, StartOfElement
= 0, EndOfElement
= 0, PathLength
, CopyLength
;
1579 CHAR16
*Found
= NULL
;
1584 PathLength
= StrLen(Path
);
1585 // Find start & end of target element
1586 for (i
= 0; i
< PathLength
; i
++) {
1587 if (Path
[i
] == '\\') {
1588 StartOfElement
= EndOfElement
;
1592 // Extract the target element
1593 if (EndOfElement
> 0) {
1594 while ((StartOfElement
< PathLength
) && (Path
[StartOfElement
] == '\\')) {
1598 if (EndOfElement
>= StartOfElement
) {
1599 CopyLength
= EndOfElement
- StartOfElement
+ 1;
1600 Found
= StrDuplicate(&Path
[StartOfElement
]);
1602 Found
[CopyLength
] = 0;
1603 } // if (EndOfElement >= StartOfElement)
1604 } // if (EndOfElement > 0)
1606 } // CHAR16 *FindLastDirName
1608 // Returns the directory portion of a pathname. For instance,
1609 // if FullPath is 'EFI\foo\bar.efi', this function returns the
1610 // string 'EFI\foo'. The calling function is responsible for
1611 // freeing the returned string's memory.
1612 CHAR16
*FindPath(IN CHAR16
* FullPath
) {
1613 UINTN i
, LastBackslash
= 0;
1614 CHAR16
*PathOnly
= NULL
;
1616 if (FullPath
!= NULL
) {
1617 for (i
= 0; i
< StrLen(FullPath
); i
++) {
1618 if (FullPath
[i
] == '\\')
1621 PathOnly
= StrDuplicate(FullPath
);
1622 if (PathOnly
!= NULL
)
1623 PathOnly
[LastBackslash
] = 0;
1630 * Routine Description:
1636 * String - Null-terminated string to search.
1637 * StrCharSet - Null-terminated string to search for.
1640 * The address of the first occurrence of the matching substring if successful, or NULL otherwise.
1642 CHAR16
* MyStrStr (CHAR16
*String
, CHAR16
*StrCharSet
)
1647 if ((String
== NULL
) || (StrCharSet
== NULL
))
1653 while ((*String
!= L
'\0') && (*StrCharSet
!= L
'\0')) {
1654 if (*String
++ != *StrCharSet
) {
1661 if (*StrCharSet
== L
'\0') {
1666 } // CHAR16 *MyStrStr()
1668 // Restrict TheString to at most Limit characters.
1669 // Does this in two ways:
1670 // - Locates stretches of two or more spaces and compresses
1671 // them down to one space.
1672 // - Truncates TheString
1673 // Returns TRUE if changes were made, FALSE otherwise
1674 BOOLEAN
LimitStringLength(CHAR16
*TheString
, UINTN Limit
) {
1675 CHAR16
*SubString
, *TempString
;
1677 BOOLEAN HasChanged
= FALSE
;
1679 // SubString will be NULL or point WITHIN TheString
1680 SubString
= MyStrStr(TheString
, L
" ");
1681 while (SubString
!= NULL
) {
1683 while (SubString
[i
] == L
' ')
1685 if (i
>= StrLen(SubString
)) {
1686 SubString
[0] = '\0';
1689 TempString
= StrDuplicate(&SubString
[i
]);
1690 if (TempString
!= NULL
) {
1691 StrCpy(&SubString
[1], TempString
);
1692 MyFreePool(TempString
);
1695 // memory allocation problem; abort to avoid potentially infinite loop!
1699 SubString
= MyStrStr(TheString
, L
" ");
1702 // If the string is still too long, truncate it....
1703 if (StrLen(TheString
) > Limit
) {
1704 TheString
[Limit
] = '\0';
1709 } // BOOLEAN LimitStringLength()
1711 // Takes an input loadpath, splits it into disk and filename components, finds a matching
1712 // DeviceVolume, and returns that and the filename (*loader).
1713 VOID
FindVolumeAndFilename(IN EFI_DEVICE_PATH
*loadpath
, OUT REFIT_VOLUME
**DeviceVolume
, OUT CHAR16
**loader
) {
1714 CHAR16
*DeviceString
, *VolumeDeviceString
, *Temp
;
1716 BOOLEAN Found
= FALSE
;
1718 MyFreePool(*loader
);
1719 MyFreePool(*DeviceVolume
);
1720 *DeviceVolume
= NULL
;
1721 DeviceString
= DevicePathToStr(loadpath
);
1722 *loader
= SplitDeviceString(DeviceString
);
1724 while ((i
< VolumesCount
) && (!Found
)) {
1725 VolumeDeviceString
= DevicePathToStr(Volumes
[i
]->DevicePath
);
1726 Temp
= SplitDeviceString(VolumeDeviceString
);
1727 if (StriCmp(DeviceString
, VolumeDeviceString
) == 0) {
1729 *DeviceVolume
= Volumes
[i
];
1732 MyFreePool(VolumeDeviceString
);
1736 MyFreePool(DeviceString
);
1737 } // VOID FindVolumeAndFilename()
1739 // Splits a volume/filename string (e.g., "fs0:\EFI\BOOT") into separate
1740 // volume and filename components (e.g., "fs0" and "\EFI\BOOT"), returning
1741 // the filename component in the original *Path variable and the split-off
1742 // volume component in the *VolName variable.
1743 // Returns TRUE if both components are found, FALSE otherwise.
1744 BOOLEAN
SplitVolumeAndFilename(IN OUT CHAR16
**Path
, OUT CHAR16
**VolName
) {
1745 UINTN i
= 0, Length
;
1751 if (*VolName
!= NULL
) {
1752 MyFreePool(*VolName
);
1756 Length
= StrLen(*Path
);
1757 while ((i
< Length
) && ((*Path
)[i
] != L
':')) {
1762 Filename
= StrDuplicate((*Path
) + i
+ 1);
1770 } // BOOLEAN SplitVolumeAndFilename()
1772 // Returns all the digits in the input string, including intervening
1773 // non-digit characters. For instance, if InString is "foo-3.3.4-7.img",
1774 // this function returns "3.3.4-7". If InString contains no digits,
1775 // the return value is NULL.
1776 CHAR16
*FindNumbers(IN CHAR16
*InString
) {
1777 UINTN i
, StartOfElement
, EndOfElement
= 0, InLength
, CopyLength
;
1778 CHAR16
*Found
= NULL
;
1780 if (InString
== NULL
)
1783 InLength
= StartOfElement
= StrLen(InString
);
1784 // Find start & end of target element
1785 for (i
= 0; i
< InLength
; i
++) {
1786 if ((InString
[i
] >= '0') && (InString
[i
] <= '9')) {
1787 if (StartOfElement
> i
)
1789 if (EndOfElement
< i
)
1793 // Extract the target element
1794 if (EndOfElement
> 0) {
1795 if (EndOfElement
>= StartOfElement
) {
1796 CopyLength
= EndOfElement
- StartOfElement
+ 1;
1797 Found
= StrDuplicate(&InString
[StartOfElement
]);
1799 Found
[CopyLength
] = 0;
1800 } // if (EndOfElement >= StartOfElement)
1801 } // if (EndOfElement > 0)
1803 } // CHAR16 *FindNumbers()
1805 // Find the #Index element (numbered from 0) in a comma-delimited string
1807 // Returns the found element, or NULL if Index is out of range or InString
1808 // is NULL. Note that the calling function is responsible for freeing the
1809 // memory associated with the returned string pointer.
1810 CHAR16
*FindCommaDelimited(IN CHAR16
*InString
, IN UINTN Index
) {
1811 UINTN StartPos
= 0, CurPos
= 0;
1812 BOOLEAN Found
= FALSE
;
1813 CHAR16
*FoundString
= NULL
;
1815 if (InString
!= NULL
) {
1816 // After while() loop, StartPos marks start of item #Index
1817 while ((Index
> 0) && (CurPos
< StrLen(InString
))) {
1818 if (InString
[CurPos
] == L
',') {
1820 StartPos
= CurPos
+ 1;
1824 // After while() loop, CurPos is one past the end of the element
1825 while ((CurPos
< StrLen(InString
)) && (!Found
)) {
1826 if (InString
[CurPos
] == L
',')
1832 FoundString
= StrDuplicate(&InString
[StartPos
]);
1833 if (FoundString
!= NULL
)
1834 FoundString
[CurPos
- StartPos
] = 0;
1836 return (FoundString
);
1837 } // CHAR16 *FindCommaDelimited()
1839 // Return the position of SmallString within BigString, or -1 if
1841 INTN
FindSubString(IN CHAR16
*SmallString
, IN CHAR16
*BigString
) {
1843 UINTN i
= 0, SmallSize
, BigSize
;
1844 BOOLEAN Found
= FALSE
;
1846 if ((SmallString
== NULL
) || (BigString
== NULL
))
1849 SmallSize
= StrLen(SmallString
);
1850 BigSize
= StrLen(BigString
);
1851 if ((SmallSize
> BigSize
) || (SmallSize
== 0) || (BigSize
== 0))
1854 while ((i
<= (BigSize
- SmallSize
) && !Found
)) {
1855 if (CompareMem(BigString
+ i
, SmallString
, SmallSize
) == 0) {
1862 } // INTN FindSubString()
1864 // Take an input path name, which may include a volume specification and/or
1865 // a path, and return separate volume, path, and file names. For instance,
1866 // "BIGVOL:\EFI\ubuntu\grubx64.efi" will return a VolName of "BIGVOL", a Path
1867 // of "EFI\ubuntu", and a Filename of "grubx64.efi". If an element is missing,
1868 // the returned pointer is NULL. The calling function is responsible for
1869 // freeing the allocated memory.
1870 VOID
SplitPathName(CHAR16
*InPath
, CHAR16
**VolName
, CHAR16
**Path
, CHAR16
**Filename
) {
1871 CHAR16
*Temp
= NULL
;
1873 MyFreePool(*VolName
);
1875 MyFreePool(*Filename
);
1876 *VolName
= *Path
= *Filename
= NULL
;
1877 Temp
= StrDuplicate(InPath
);
1878 SplitVolumeAndFilename(&Temp
, VolName
); // VolName is NULL or has volume; Temp has rest of path
1879 CleanUpPathNameSlashes(Temp
);
1880 *Path
= FindPath(Temp
); // *Path has path (may be 0-length); Temp unchanged.
1881 *Filename
= StrDuplicate(Temp
+ StrLen(*Path
));
1882 CleanUpPathNameSlashes(*Filename
);
1883 if (StrLen(*Path
) == 0) {
1887 if (StrLen(*Filename
) == 0) {
1888 MyFreePool(*Filename
);
1892 } // VOID SplitPathName
1894 // Returns TRUE if SmallString is an element in the comma-delimited List,
1895 // FALSE otherwise. Performs comparison case-insensitively (except on
1896 // buggy EFIs with case-sensitive StriCmp() functions).
1897 BOOLEAN
IsIn(IN CHAR16
*SmallString
, IN CHAR16
*List
) {
1899 BOOLEAN Found
= FALSE
;
1902 if (SmallString
&& List
) {
1903 while (!Found
&& (OneElement
= FindCommaDelimited(List
, i
++))) {
1904 if (StriCmp(OneElement
, SmallString
) == 0)
1911 // Returns TRUE if any element of List can be found as a substring of
1912 // BigString, FALSE otherwise. Performs comparisons case-insensitively.
1913 BOOLEAN
IsInSubstring(IN CHAR16
*BigString
, IN CHAR16
*List
) {
1914 UINTN i
= 0, ElementLength
;
1915 BOOLEAN Found
= FALSE
;
1918 if (BigString
&& List
) {
1919 while (!Found
&& (OneElement
= FindCommaDelimited(List
, i
++))) {
1920 ElementLength
= StrLen(OneElement
);
1921 if ((ElementLength
<= StrLen(BigString
)) && (StriSubCmp(OneElement
, BigString
)))
1926 } // BOOLEAN IsSubstringIn()
1928 // Returns TRUE if specified Volume, Directory, and Filename correspond to an
1929 // element in the comma-delimited List, FALSE otherwise. Note that Directory and
1930 // Filename must *NOT* include a volume or path specification (that's part of
1931 // the Volume variable), but the List elements may. Performs comparison
1932 // case-insensitively (except on buggy EFIs with case-sensitive StriCmp()
1934 BOOLEAN
FilenameIn(REFIT_VOLUME
*Volume
, CHAR16
*Directory
, CHAR16
*Filename
, CHAR16
*List
) {
1936 BOOLEAN Found
= FALSE
;
1938 CHAR16
*TargetVolName
= NULL
, *TargetPath
= NULL
, *TargetFilename
= NULL
;
1940 if (Filename
&& List
) {
1941 while (!Found
&& (OneElement
= FindCommaDelimited(List
, i
++))) {
1943 SplitPathName(OneElement
, &TargetVolName
, &TargetPath
, &TargetFilename
);
1944 VolumeNumberToName(Volume
, &TargetVolName
);
1945 if (((TargetVolName
!= NULL
) && ((Volume
== NULL
) || (StriCmp(TargetVolName
, Volume
->VolName
) != 0))) ||
1946 ((TargetPath
!= NULL
) && (StriCmp(TargetPath
, Directory
) != 0)) ||
1947 ((TargetFilename
!= NULL
) && (StriCmp(TargetFilename
, Filename
) != 0))) {
1950 MyFreePool(OneElement
);
1954 MyFreePool(TargetVolName
);
1955 MyFreePool(TargetPath
);
1956 MyFreePool(TargetFilename
);
1958 } // BOOLEAN FilenameIn()
1960 // If *VolName is of the form "fs#", where "#" is a number, and if Volume points
1961 // to this volume number, returns with *VolName changed to the volume name, as
1962 // stored in the Volume data structure.
1963 // Returns TRUE if this substitution was made, FALSE otherwise.
1964 BOOLEAN
VolumeNumberToName(REFIT_VOLUME
*Volume
, CHAR16
**VolName
) {
1965 BOOLEAN MadeSubstitution
= FALSE
;
1968 if ((VolName
== NULL
) || (*VolName
== NULL
))
1971 if ((StrLen(*VolName
) > 2) && (*VolName
[0] == L
'f') && (*VolName
[1] == L
's') && (*VolName
[2] >= L
'0') && (*VolName
[2] <= L
'9')) {
1972 VolNum
= Atoi(*VolName
+ 2);
1973 if (VolNum
== Volume
->VolNumber
) {
1974 MyFreePool(*VolName
);
1975 *VolName
= StrDuplicate(Volume
->VolName
);
1976 MadeSubstitution
= TRUE
;
1979 return MadeSubstitution
;
1980 } // BOOLEAN VolumeMatchesNumber()
1982 // Implement FreePool the way it should have been done to begin with, so that
1983 // it doesn't throw an ASSERT message if fed a NULL pointer....
1984 VOID
MyFreePool(IN VOID
*Pointer
) {
1985 if (Pointer
!= NULL
)
1989 static EFI_GUID AppleRemovableMediaGuid
= APPLE_REMOVABLE_MEDIA_PROTOCOL_GUID
;
1991 // Eject all removable media.
1992 // Returns TRUE if any media were ejected, FALSE otherwise.
1993 BOOLEAN
EjectMedia(VOID
) {
1995 UINTN HandleIndex
, HandleCount
= 0, Ejected
= 0;
1996 EFI_HANDLE
*Handles
, Handle
;
1997 APPLE_REMOVABLE_MEDIA_PROTOCOL
*Ejectable
;
1999 Status
= LibLocateHandle(ByProtocol
, &AppleRemovableMediaGuid
, NULL
, &HandleCount
, &Handles
);
2000 if (EFI_ERROR(Status
) || HandleCount
== 0)
2001 return (FALSE
); // probably not an Apple system
2003 for (HandleIndex
= 0; HandleIndex
< HandleCount
; HandleIndex
++) {
2004 Handle
= Handles
[HandleIndex
];
2005 Status
= refit_call3_wrapper(BS
->HandleProtocol
, Handle
, &AppleRemovableMediaGuid
, (VOID
**) &Ejectable
);
2006 if (EFI_ERROR(Status
))
2008 Status
= refit_call1_wrapper(Ejectable
->Eject
, Ejectable
);
2009 if (!EFI_ERROR(Status
))
2012 MyFreePool(Handles
);
2013 return (Ejected
> 0);
2014 } // VOID EjectMedia()
2016 // Converts consecutive characters in the input string into a
2017 // number, interpreting the string as a hexadecimal number, starting
2018 // at the specified position and continuing for the specified number
2019 // of characters or until the end of the string, whichever is first.
2020 // NumChars must be between 1 and 16. Ignores invalid characters.
2021 UINT64
StrToHex(CHAR16
*Input
, UINTN Pos
, UINTN NumChars
) {
2022 UINT64 retval
= 0x00;
2026 if ((Input
== NULL
) || (StrLen(Input
) < Pos
) || (NumChars
== 0) || (NumChars
> 16)) {
2030 while ((StrLen(Input
) >= Pos
) && (NumDone
< NumChars
)) {
2032 if ((a
>= '0') && (a
<= '9')) {
2034 retval
+= (a
- '0');
2037 if ((a
>= 'a') && (a
<= 'f')) {
2039 retval
+= (a
- 'a' + 0x0a);
2042 if ((a
>= 'A') && (a
<= 'F')) {
2044 retval
+= (a
- 'A' + 0x0a);
2052 // Returns TRUE if UnknownString can be interpreted as a GUID, FALSE otherwise.
2053 // Note that the input string must have no extraneous spaces and must be
2054 // conventionally formatted as a 36-character GUID, complete with dashes in
2055 // appropriate places.
2056 BOOLEAN
IsGuid(CHAR16
*UnknownString
) {
2058 BOOLEAN retval
= TRUE
;
2061 if (UnknownString
== NULL
)
2064 Length
= StrLen(UnknownString
);
2068 for (i
= 0; i
< Length
; i
++) {
2069 a
= UnknownString
[i
];
2070 if ((i
== 8) || (i
== 13) || (i
== 18) || (i
== 23)) {
2073 } else if (((a
< 'a') || (a
> 'f')) && ((a
< 'A') || (a
> 'F')) && ((a
< '0') && (a
> '9'))) {
2078 } // BOOLEAN IsGuid()
2080 // Return the GUID as a string, suitable for display to the user. Note that the calling
2081 // function is responsible for freeing the allocated memory.
2082 CHAR16
* GuidAsString(EFI_GUID
*GuidData
) {
2085 TheString
= AllocateZeroPool(42 * sizeof(CHAR16
));
2086 if (TheString
!= 0) {
2087 SPrint (TheString
, 82, L
"%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x",
2088 (UINTN
)GuidData
->Data1
, (UINTN
)GuidData
->Data2
, (UINTN
)GuidData
->Data3
,
2089 (UINTN
)GuidData
->Data4
[0], (UINTN
)GuidData
->Data4
[1], (UINTN
)GuidData
->Data4
[2],
2090 (UINTN
)GuidData
->Data4
[3], (UINTN
)GuidData
->Data4
[4], (UINTN
)GuidData
->Data4
[5],
2091 (UINTN
)GuidData
->Data4
[6], (UINTN
)GuidData
->Data4
[7]);
2094 } // GuidAsString(EFI_GUID *GuidData)
2096 EFI_GUID
StringAsGuid(CHAR16
* InString
) {
2097 EFI_GUID Guid
= NULL_GUID_VALUE
;
2099 if (!IsGuid(InString
)) {
2103 Guid
.Data1
= (UINT32
) StrToHex(InString
, 0, 8);
2104 Guid
.Data2
= (UINT16
) StrToHex(InString
, 9, 4);
2105 Guid
.Data3
= (UINT16
) StrToHex(InString
, 14, 4);
2106 Guid
.Data4
[0] = (UINT8
) StrToHex(InString
, 19, 2);
2107 Guid
.Data4
[1] = (UINT8
) StrToHex(InString
, 21, 2);
2108 Guid
.Data4
[2] = (UINT8
) StrToHex(InString
, 23, 2);
2109 Guid
.Data4
[3] = (UINT8
) StrToHex(InString
, 26, 2);
2110 Guid
.Data4
[4] = (UINT8
) StrToHex(InString
, 28, 2);
2111 Guid
.Data4
[5] = (UINT8
) StrToHex(InString
, 30, 2);
2112 Guid
.Data4
[6] = (UINT8
) StrToHex(InString
, 32, 2);
2113 Guid
.Data4
[7] = (UINT8
) StrToHex(InString
, 34, 2);
2116 } // EFI_GUID StringAsGuid()
2118 // Returns TRUE if the two GUIDs are equal, FALSE otherwise
2119 BOOLEAN
GuidsAreEqual(EFI_GUID
*Guid1
, EFI_GUID
*Guid2
) {
2120 return (CompareMem(Guid1
, Guid2
, 16) == 0);
2121 } // BOOLEAN CompareGuids()