3 * General library functions
5 * Copyright (c) 2006-2009 Christoph Pfisterer
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
15 * * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the
20 * * Neither the name of Christoph Pfisterer nor the names of the
21 * contributors may be used to endorse or promote products derived
22 * from this software without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 * Modifications copyright (c) 2012 Roderick W. Smith
39 * Modifications distributed under the terms of the GNU General Public
40 * License (GPL) version 3 (GPLv3), a copy of which must be distributed
41 * with this source code or binaries made from it.
49 #include "../include/refit_call_wrapper.h"
50 #include "../include/RemovableMedia.h"
52 #ifdef __MAKEWITH_GNUEFI
53 #define EfiReallocatePool ReallocatePool
55 #define LibLocateHandle gBS->LocateHandleBuffer
56 #define DevicePathProtocol gEfiDevicePathProtocolGuid
57 #define BlockIoProtocol gEfiBlockIoProtocolGuid
58 #define LibFileSystemInfo EfiLibFileSystemInfo
59 #define LibOpenRoot EfiLibOpenRoot
60 EFI_DEVICE_PATH EndDevicePath
[] = {
61 {END_DEVICE_PATH_TYPE
, END_ENTIRE_DEVICE_PATH_SUBTYPE
, {END_DEVICE_PATH_LENGTH
, 0}}
64 //#define EndDevicePath DevicePath
69 EFI_HANDLE SelfImageHandle
;
70 EFI_LOADED_IMAGE
*SelfLoadedImage
;
71 EFI_FILE
*SelfRootDir
;
75 REFIT_VOLUME
*SelfVolume
= NULL
;
76 REFIT_VOLUME
**Volumes
= NULL
;
77 UINTN VolumesCount
= 0;
79 // Maximum size for disk sectors
80 #define SECTOR_SIZE 4096
82 // Default names for volume badges (mini-icon to define disk type) and icons
83 #define VOLUME_BADGE_NAME L".VolumeBadge.icns"
84 #define VOLUME_ICON_NAME L".VolumeIcon.icns"
88 static EFI_STATUS
FinishInitRefitLib(VOID
);
90 static VOID
UninitVolumes(VOID
);
93 // self recognition stuff
96 // Converts forward slashes to backslashes, removes duplicate slashes, and
97 // removes slashes from both the start and end of the pathname.
98 // Necessary because some (buggy?) EFI implementations produce "\/" strings
99 // in pathnames, because some user inputs can produce duplicate directory
100 // separators, and because we want consistent start and end slashes for
101 // directory comparisons. A special case: If the PathName refers to root,
102 // return "/", since some firmware implementations flake out if this
104 VOID
CleanUpPathNameSlashes(IN OUT CHAR16
*PathName
) {
106 UINTN i
, FinalChar
= 0;
107 BOOLEAN LastWasSlash
= FALSE
;
109 NewName
= AllocateZeroPool(sizeof(CHAR16
) * (StrLen(PathName
) + 2));
110 if (NewName
!= NULL
) {
111 for (i
= 0; i
< StrLen(PathName
); i
++) {
112 if ((PathName
[i
] == L
'/') || (PathName
[i
] == L
'\\')) {
113 if ((!LastWasSlash
) && (FinalChar
!= 0))
114 NewName
[FinalChar
++] = L
'\\';
117 NewName
[FinalChar
++] = PathName
[i
];
118 LastWasSlash
= FALSE
;
121 NewName
[FinalChar
] = 0;
122 if ((FinalChar
> 0) && (NewName
[FinalChar
- 1] == L
'\\'))
123 NewName
[--FinalChar
] = 0;
124 if (FinalChar
== 0) {
128 // Copy the transformed name back....
129 StrCpy(PathName
, NewName
);
131 } // if allocation OK
132 } // CleanUpPathNameSlashes()
134 EFI_STATUS
InitRefitLib(IN EFI_HANDLE ImageHandle
)
137 CHAR16
*DevicePathAsString
;
139 SelfImageHandle
= ImageHandle
;
140 Status
= refit_call3_wrapper(BS
->HandleProtocol
, SelfImageHandle
, &LoadedImageProtocol
, (VOID
**) &SelfLoadedImage
);
141 if (CheckFatalError(Status
, L
"while getting a LoadedImageProtocol handle"))
142 return EFI_LOAD_ERROR
;
144 // find the current directory
145 DevicePathAsString
= DevicePathToStr(SelfLoadedImage
->FilePath
);
146 // Print(L"DevicePathAsString is '%s'\n", DevicePathAsString);
147 CleanUpPathNameSlashes(DevicePathAsString
);
148 if (SelfDirPath
!= NULL
)
149 FreePool(SelfDirPath
);
150 SelfDirPath
= FindPath(DevicePathAsString
);
151 // Print(L"SelfDirPath is '%s'\n", SelfDirPath);
153 FreePool(DevicePathAsString
);
155 return FinishInitRefitLib();
158 // called before running external programs to close open file handles
159 VOID
UninitRefitLib(VOID
)
163 if (SelfDir
!= NULL
) {
164 refit_call1_wrapper(SelfDir
->Close
, SelfDir
);
168 if (SelfRootDir
!= NULL
) {
169 refit_call1_wrapper(SelfRootDir
->Close
, SelfRootDir
);
174 // called after running external programs to re-open file handles
175 EFI_STATUS
ReinitRefitLib(VOID
)
179 if ((ST
->Hdr
.Revision
>> 16) == 1) {
180 // Below two lines were in rEFIt, but seem to cause system crashes or
181 // reboots when launching OSes after returning from programs on most
182 // systems. OTOH, my Mac Mini produces errors about "(re)opening our
183 // installation volume" (see the next function) when returning from
184 // programs when these two lines are removed, and it often crashes
185 // when returning from a program or when launching a second program
186 // with these lines removed. Therefore, the preceding if() statement
187 // executes these lines only on EFIs with a major version number of 1
188 // (which Macs have) and not with 2 (which UEFI PCs have). My selection
189 // of hardware on which to test is limited, though, so this may be the
190 // wrong test, or there may be a better way to fix this problem.
191 // TODO: Figure out cause of above weirdness and fix it more
193 if (SelfVolume
!= NULL
&& SelfVolume
->RootDir
!= NULL
)
194 SelfRootDir
= SelfVolume
->RootDir
;
197 return FinishInitRefitLib();
200 static EFI_STATUS
FinishInitRefitLib(VOID
)
204 if (SelfRootDir
== NULL
) {
205 SelfRootDir
= LibOpenRoot(SelfLoadedImage
->DeviceHandle
);
206 if (SelfRootDir
== NULL
) {
207 CheckError(EFI_LOAD_ERROR
, L
"while (re)opening our installation volume");
208 return EFI_LOAD_ERROR
;
212 Status
= refit_call5_wrapper(SelfRootDir
->Open
, SelfRootDir
, &SelfDir
, SelfDirPath
, EFI_FILE_MODE_READ
, 0);
213 if (CheckFatalError(Status
, L
"while opening our installation directory"))
214 return EFI_LOAD_ERROR
;
223 VOID
CreateList(OUT VOID
***ListPtr
, OUT UINTN
*ElementCount
, IN UINTN InitialElementCount
)
227 *ElementCount
= InitialElementCount
;
228 if (*ElementCount
> 0) {
229 AllocateCount
= (*ElementCount
+ 7) & ~7; // next multiple of 8
230 *ListPtr
= AllocatePool(sizeof(VOID
*) * AllocateCount
);
236 VOID
AddListElement(IN OUT VOID
***ListPtr
, IN OUT UINTN
*ElementCount
, IN VOID
*NewElement
)
240 if ((*ElementCount
& 7) == 0) {
241 AllocateCount
= *ElementCount
+ 8;
242 if (*ElementCount
== 0)
243 *ListPtr
= AllocatePool(sizeof(VOID
*) * AllocateCount
);
245 *ListPtr
= EfiReallocatePool(*ListPtr
, sizeof(VOID
*) * (*ElementCount
), sizeof(VOID
*) * AllocateCount
);
247 (*ListPtr
)[*ElementCount
] = NewElement
;
249 } /* VOID AddListElement() */
251 VOID
FreeList(IN OUT VOID
***ListPtr
, IN OUT UINTN
*ElementCount
)
255 if (*ElementCount
> 0) {
256 for (i
= 0; i
< *ElementCount
; i
++) {
257 // TODO: call a user-provided routine for each element here
258 FreePool((*ListPtr
)[i
]);
265 // firmware device path discovery
268 static UINT8 LegacyLoaderMediaPathData
[] = {
269 0x04, 0x06, 0x14, 0x00, 0xEB, 0x85, 0x05, 0x2B,
270 0xB8, 0xD8, 0xA9, 0x49, 0x8B, 0x8C, 0xE2, 0x1B,
271 0x01, 0xAE, 0xF2, 0xB7, 0x7F, 0xFF, 0x04, 0x00,
273 static EFI_DEVICE_PATH
*LegacyLoaderMediaPath
= (EFI_DEVICE_PATH
*)LegacyLoaderMediaPathData
;
275 VOID
ExtractLegacyLoaderPaths(EFI_DEVICE_PATH
**PathList
, UINTN MaxPaths
, EFI_DEVICE_PATH
**HardcodedPathList
)
278 UINTN HandleCount
= 0;
279 UINTN HandleIndex
, HardcodedIndex
;
284 EFI_LOADED_IMAGE
*LoadedImage
;
285 EFI_DEVICE_PATH
*DevicePath
;
288 MaxPaths
--; // leave space for the terminating NULL pointer
290 // get all LoadedImage handles
291 Status
= LibLocateHandle(ByProtocol
, &LoadedImageProtocol
, NULL
, &HandleCount
, &Handles
);
292 if (CheckError(Status
, L
"while listing LoadedImage handles")) {
293 if (HardcodedPathList
) {
294 for (HardcodedIndex
= 0; HardcodedPathList
[HardcodedIndex
] && PathCount
< MaxPaths
; HardcodedIndex
++)
295 PathList
[PathCount
++] = HardcodedPathList
[HardcodedIndex
];
297 PathList
[PathCount
] = NULL
;
300 for (HandleIndex
= 0; HandleIndex
< HandleCount
&& PathCount
< MaxPaths
; HandleIndex
++) {
301 Handle
= Handles
[HandleIndex
];
303 Status
= refit_call3_wrapper(BS
->HandleProtocol
, Handle
, &LoadedImageProtocol
, (VOID
**) &LoadedImage
);
304 if (EFI_ERROR(Status
))
305 continue; // This can only happen if the firmware scewed up, ignore it.
307 Status
= refit_call3_wrapper(BS
->HandleProtocol
, LoadedImage
->DeviceHandle
, &DevicePathProtocol
, (VOID
**) &DevicePath
);
308 if (EFI_ERROR(Status
))
309 continue; // This happens, ignore it.
311 // Only grab memory range nodes
312 if (DevicePathType(DevicePath
) != HARDWARE_DEVICE_PATH
|| DevicePathSubType(DevicePath
) != HW_MEMMAP_DP
)
315 // Check if we have this device path in the list already
316 // WARNING: This assumes the first node in the device path is unique!
318 for (PathIndex
= 0; PathIndex
< PathCount
; PathIndex
++) {
319 if (DevicePathNodeLength(DevicePath
) != DevicePathNodeLength(PathList
[PathIndex
]))
321 if (CompareMem(DevicePath
, PathList
[PathIndex
], DevicePathNodeLength(DevicePath
)) == 0) {
329 PathList
[PathCount
++] = AppendDevicePath(DevicePath
, LegacyLoaderMediaPath
);
333 if (HardcodedPathList
) {
334 for (HardcodedIndex
= 0; HardcodedPathList
[HardcodedIndex
] && PathCount
< MaxPaths
; HardcodedIndex
++)
335 PathList
[PathCount
++] = HardcodedPathList
[HardcodedIndex
];
337 PathList
[PathCount
] = NULL
;
344 static VOID
ScanVolumeBootcode(IN OUT REFIT_VOLUME
*Volume
, OUT BOOLEAN
*Bootable
)
347 UINT8 SectorBuffer
[SECTOR_SIZE
];
349 MBR_PARTITION_INFO
*MbrTable
;
350 BOOLEAN MbrTableFound
;
352 Volume
->HasBootCode
= FALSE
;
353 Volume
->OSIconName
= NULL
;
354 Volume
->OSName
= NULL
;
357 if (Volume
->BlockIO
== NULL
)
359 if (Volume
->BlockIO
->Media
->BlockSize
> SECTOR_SIZE
)
360 return; // our buffer is too small...
362 // look at the boot sector (this is used for both hard disks and El Torito images!)
363 Status
= refit_call5_wrapper(Volume
->BlockIO
->ReadBlocks
,
364 Volume
->BlockIO
, Volume
->BlockIO
->Media
->MediaId
,
365 Volume
->BlockIOOffset
, SECTOR_SIZE
, SectorBuffer
);
366 if (!EFI_ERROR(Status
)) {
368 if (*((UINT16
*)(SectorBuffer
+ 510)) == 0xaa55 && SectorBuffer
[0] != 0) {
370 Volume
->HasBootCode
= TRUE
;
373 // detect specific boot codes
374 if (CompareMem(SectorBuffer
+ 2, "LILO", 4) == 0 ||
375 CompareMem(SectorBuffer
+ 6, "LILO", 4) == 0 ||
376 CompareMem(SectorBuffer
+ 3, "SYSLINUX", 8) == 0 ||
377 FindMem(SectorBuffer
, SECTOR_SIZE
, "ISOLINUX", 8) >= 0) {
378 Volume
->HasBootCode
= TRUE
;
379 Volume
->OSIconName
= L
"linux";
380 Volume
->OSName
= L
"Linux";
382 } else if (FindMem(SectorBuffer
, 512, "Geom\0Hard Disk\0Read\0 Error", 26) >= 0) { // GRUB
383 Volume
->HasBootCode
= TRUE
;
384 Volume
->OSIconName
= L
"grub,linux";
385 Volume
->OSName
= L
"Linux";
387 // // Below doesn't produce a bootable entry, so commented out for the moment....
388 // // GRUB in BIOS boot partition:
389 // } else if (FindMem(SectorBuffer, 512, "Geom\0Read\0 Error", 16) >= 0) {
390 // Volume->HasBootCode = TRUE;
391 // Volume->OSIconName = L"grub,linux";
392 // Volume->OSName = L"Linux";
393 // Volume->VolName = L"BIOS Boot Partition";
396 } else if ((*((UINT32
*)(SectorBuffer
+ 502)) == 0 &&
397 *((UINT32
*)(SectorBuffer
+ 506)) == 50000 &&
398 *((UINT16
*)(SectorBuffer
+ 510)) == 0xaa55) ||
399 FindMem(SectorBuffer
, SECTOR_SIZE
, "Starting the BTX loader", 23) >= 0) {
400 Volume
->HasBootCode
= TRUE
;
401 Volume
->OSIconName
= L
"freebsd";
402 Volume
->OSName
= L
"FreeBSD";
404 } else if (FindMem(SectorBuffer
, 512, "!Loading", 8) >= 0 ||
405 FindMem(SectorBuffer
, SECTOR_SIZE
, "/cdboot\0/CDBOOT\0", 16) >= 0) {
406 Volume
->HasBootCode
= TRUE
;
407 Volume
->OSIconName
= L
"openbsd";
408 Volume
->OSName
= L
"OpenBSD";
410 } else if (FindMem(SectorBuffer
, 512, "Not a bootxx image", 18) >= 0 ||
411 *((UINT32
*)(SectorBuffer
+ 1028)) == 0x7886b6d1) {
412 Volume
->HasBootCode
= TRUE
;
413 Volume
->OSIconName
= L
"netbsd";
414 Volume
->OSName
= L
"NetBSD";
416 } else if (FindMem(SectorBuffer
, SECTOR_SIZE
, "NTLDR", 5) >= 0) {
417 Volume
->HasBootCode
= TRUE
;
418 Volume
->OSIconName
= L
"win";
419 Volume
->OSName
= L
"Windows";
421 } else if (FindMem(SectorBuffer
, SECTOR_SIZE
, "BOOTMGR", 7) >= 0) {
422 Volume
->HasBootCode
= TRUE
;
423 Volume
->OSIconName
= L
"winvista,win";
424 Volume
->OSName
= L
"Windows";
426 } else if (FindMem(SectorBuffer
, 512, "CPUBOOT SYS", 11) >= 0 ||
427 FindMem(SectorBuffer
, 512, "KERNEL SYS", 11) >= 0) {
428 Volume
->HasBootCode
= TRUE
;
429 Volume
->OSIconName
= L
"freedos";
430 Volume
->OSName
= L
"FreeDOS";
432 } else if (FindMem(SectorBuffer
, 512, "OS2LDR", 6) >= 0 ||
433 FindMem(SectorBuffer
, 512, "OS2BOOT", 7) >= 0) {
434 Volume
->HasBootCode
= TRUE
;
435 Volume
->OSIconName
= L
"ecomstation";
436 Volume
->OSName
= L
"eComStation";
438 } else if (FindMem(SectorBuffer
, 512, "Be Boot Loader", 14) >= 0) {
439 Volume
->HasBootCode
= TRUE
;
440 Volume
->OSIconName
= L
"beos";
441 Volume
->OSName
= L
"BeOS";
443 } else if (FindMem(SectorBuffer
, 512, "yT Boot Loader", 14) >= 0) {
444 Volume
->HasBootCode
= TRUE
;
445 Volume
->OSIconName
= L
"zeta,beos";
446 Volume
->OSName
= L
"ZETA";
448 } else if (FindMem(SectorBuffer
, 512, "\x04" "beos\x06" "system\x05" "zbeos", 18) >= 0 ||
449 FindMem(SectorBuffer
, 512, "\x06" "system\x0c" "haiku_loader", 20) >= 0) {
450 Volume
->HasBootCode
= TRUE
;
451 Volume
->OSIconName
= L
"haiku,beos";
452 Volume
->OSName
= L
"Haiku";
456 // NOTE: If you add an operating system with a name that starts with 'W' or 'L', you
457 // need to fix AddLegacyEntry in main.c.
460 Print(L
" Result of bootcode detection: %s %s (%s)\n",
461 Volume
->HasBootCode
? L
"bootable" : L
"non-bootable",
462 Volume
->OSName
, Volume
->OSIconName
);
465 // dummy FAT boot sector (created by OS X's newfs_msdos)
466 if (FindMem(SectorBuffer
, 512, "Non-system disk", 15) >= 0)
467 Volume
->HasBootCode
= FALSE
;
469 // dummy FAT boot sector (created by Linux's mkdosfs)
470 if (FindMem(SectorBuffer
, 512, "This is not a bootable disk", 27) >= 0)
471 Volume
->HasBootCode
= FALSE
;
473 // dummy FAT boot sector (created by Windows)
474 if (FindMem(SectorBuffer
, 512, "Press any key to restart", 24) >= 0)
475 Volume
->HasBootCode
= FALSE
;
477 // check for MBR partition table
478 if (*((UINT16
*)(SectorBuffer
+ 510)) == 0xaa55) {
479 MbrTableFound
= FALSE
;
480 MbrTable
= (MBR_PARTITION_INFO
*)(SectorBuffer
+ 446);
481 for (i
= 0; i
< 4; i
++)
482 if (MbrTable
[i
].StartLBA
&& MbrTable
[i
].Size
)
483 MbrTableFound
= TRUE
;
484 for (i
= 0; i
< 4; i
++)
485 if (MbrTable
[i
].Flags
!= 0x00 && MbrTable
[i
].Flags
!= 0x80)
486 MbrTableFound
= FALSE
;
488 Volume
->MbrPartitionTable
= AllocatePool(4 * 16);
489 CopyMem(Volume
->MbrPartitionTable
, MbrTable
, 4 * 16);
495 CheckError(Status
, L
"while reading boot sector");
500 // default volume badge icon based on disk kind
501 static VOID
ScanVolumeDefaultIcon(IN OUT REFIT_VOLUME
*Volume
)
503 switch (Volume
->DiskKind
) {
504 case DISK_KIND_INTERNAL
:
505 Volume
->VolBadgeImage
= BuiltinIcon(BUILTIN_ICON_VOL_INTERNAL
);
507 case DISK_KIND_EXTERNAL
:
508 Volume
->VolBadgeImage
= BuiltinIcon(BUILTIN_ICON_VOL_EXTERNAL
);
510 case DISK_KIND_OPTICAL
:
511 Volume
->VolBadgeImage
= BuiltinIcon(BUILTIN_ICON_VOL_OPTICAL
);
516 static VOID
ScanVolume(IN OUT REFIT_VOLUME
*Volume
)
519 EFI_DEVICE_PATH
*DevicePath
, *NextDevicePath
;
520 EFI_DEVICE_PATH
*DiskDevicePath
, *RemainingDevicePath
;
521 EFI_HANDLE WholeDiskHandle
;
523 EFI_FILE_SYSTEM_INFO
*FileSystemInfoPtr
;
527 Volume
->DevicePath
= DuplicateDevicePath(DevicePathFromHandle(Volume
->DeviceHandle
));
529 if (Volume
->DevicePath
!= NULL
) {
530 Print(L
"* %s\n", DevicePathToStr(Volume
->DevicePath
));
532 DumpHex(1, 0, DevicePathSize(Volume
->DevicePath
), Volume
->DevicePath
);
537 Volume
->DiskKind
= DISK_KIND_INTERNAL
; // default
540 Status
= refit_call3_wrapper(BS
->HandleProtocol
, Volume
->DeviceHandle
, &BlockIoProtocol
, (VOID
**) &(Volume
->BlockIO
));
541 if (EFI_ERROR(Status
)) {
542 Volume
->BlockIO
= NULL
;
543 Print(L
"Warning: Can't get BlockIO protocol.\n");
545 if (Volume
->BlockIO
->Media
->BlockSize
== 2048)
546 Volume
->DiskKind
= DISK_KIND_OPTICAL
;
549 // scan for bootcode and MBR table
551 ScanVolumeBootcode(Volume
, &Bootable
);
553 // detect device type
554 DevicePath
= Volume
->DevicePath
;
555 while (DevicePath
!= NULL
&& !IsDevicePathEndType(DevicePath
)) {
556 NextDevicePath
= NextDevicePathNode(DevicePath
);
558 if (DevicePathType(DevicePath
) == MESSAGING_DEVICE_PATH
&&
559 (DevicePathSubType(DevicePath
) == MSG_USB_DP
||
560 DevicePathSubType(DevicePath
) == MSG_USB_CLASS_DP
||
561 DevicePathSubType(DevicePath
) == MSG_1394_DP
||
562 DevicePathSubType(DevicePath
) == MSG_FIBRECHANNEL_DP
))
563 Volume
->DiskKind
= DISK_KIND_EXTERNAL
; // USB/FireWire/FC device -> external
564 if (DevicePathType(DevicePath
) == MEDIA_DEVICE_PATH
&&
565 DevicePathSubType(DevicePath
) == MEDIA_CDROM_DP
) {
566 Volume
->DiskKind
= DISK_KIND_OPTICAL
; // El Torito entry -> optical disk
570 if (DevicePathType(DevicePath
) == MEDIA_DEVICE_PATH
&& DevicePathSubType(DevicePath
) == MEDIA_VENDOR_DP
) {
571 Volume
->IsAppleLegacy
= TRUE
; // legacy BIOS device entry
572 // TODO: also check for Boot Camp GUID
573 Bootable
= FALSE
; // this handle's BlockIO is just an alias for the whole device
576 if (DevicePathType(DevicePath
) == MESSAGING_DEVICE_PATH
) {
577 // make a device path for the whole device
578 PartialLength
= (UINT8
*)NextDevicePath
- (UINT8
*)(Volume
->DevicePath
);
579 DiskDevicePath
= (EFI_DEVICE_PATH
*)AllocatePool(PartialLength
+ sizeof(EFI_DEVICE_PATH
));
580 CopyMem(DiskDevicePath
, Volume
->DevicePath
, PartialLength
);
581 CopyMem((UINT8
*)DiskDevicePath
+ PartialLength
, EndDevicePath
, sizeof(EFI_DEVICE_PATH
));
583 // get the handle for that path
584 RemainingDevicePath
= DiskDevicePath
;
585 //Print(L" * looking at %s\n", DevicePathToStr(RemainingDevicePath));
586 Status
= refit_call3_wrapper(BS
->LocateDevicePath
, &BlockIoProtocol
, &RemainingDevicePath
, &WholeDiskHandle
);
587 //Print(L" * remaining: %s\n", DevicePathToStr(RemainingDevicePath));
588 FreePool(DiskDevicePath
);
590 if (!EFI_ERROR(Status
)) {
591 //Print(L" - original handle: %08x - disk handle: %08x\n", (UINT32)DeviceHandle, (UINT32)WholeDiskHandle);
593 // get the device path for later
594 Status
= refit_call3_wrapper(BS
->HandleProtocol
, WholeDiskHandle
, &DevicePathProtocol
, (VOID
**) &DiskDevicePath
);
595 if (!EFI_ERROR(Status
)) {
596 Volume
->WholeDiskDevicePath
= DuplicateDevicePath(DiskDevicePath
);
599 // look at the BlockIO protocol
600 Status
= refit_call3_wrapper(BS
->HandleProtocol
, WholeDiskHandle
, &BlockIoProtocol
, (VOID
**) &Volume
->WholeDiskBlockIO
);
601 if (!EFI_ERROR(Status
)) {
603 // check the media block size
604 if (Volume
->WholeDiskBlockIO
->Media
->BlockSize
== 2048)
605 Volume
->DiskKind
= DISK_KIND_OPTICAL
;
608 Volume
->WholeDiskBlockIO
= NULL
;
609 //CheckError(Status, L"from HandleProtocol");
612 // CheckError(Status, L"from LocateDevicePath");
615 DevicePath
= NextDevicePath
;
620 if (Volume
->HasBootCode
)
621 Print(L
" Volume considered non-bootable, but boot code is present\n");
623 Volume
->HasBootCode
= FALSE
;
626 // default volume icon based on disk kind
627 ScanVolumeDefaultIcon(Volume
);
629 // open the root directory of the volume
630 Volume
->RootDir
= LibOpenRoot(Volume
->DeviceHandle
);
631 if (Volume
->RootDir
== NULL
) {
632 Volume
->IsReadable
= FALSE
;
635 Volume
->IsReadable
= TRUE
;
639 FileSystemInfoPtr
= LibFileSystemInfo(Volume
->RootDir
);
640 if (FileSystemInfoPtr
!= NULL
) {
641 Volume
->VolName
= StrDuplicate(FileSystemInfoPtr
->VolumeLabel
);
642 FreePool(FileSystemInfoPtr
);
645 if (Volume
->VolName
== NULL
) {
646 Volume
->VolName
= StrDuplicate(L
"Unknown");
648 // TODO: if no official volume name is found or it is empty, use something else, e.g.:
649 // - name from bytes 3 to 10 of the boot sector
650 // - partition number
651 // - name derived from file system type or partition type
653 // get custom volume icon if present
654 if (FileExists(Volume
->RootDir
, VOLUME_BADGE_NAME
))
655 Volume
->VolBadgeImage
= LoadIcns(Volume
->RootDir
, VOLUME_BADGE_NAME
, 32);
656 if (FileExists(Volume
->RootDir
, VOLUME_ICON_NAME
)) {
657 Volume
->VolIconImage
= LoadIcns(Volume
->RootDir
, VOLUME_ICON_NAME
, 128);
661 static VOID
ScanExtendedPartition(REFIT_VOLUME
*WholeDiskVolume
, MBR_PARTITION_INFO
*MbrEntry
)
664 REFIT_VOLUME
*Volume
;
665 UINT32 ExtBase
, ExtCurrent
, NextExtCurrent
;
667 UINTN LogicalPartitionIndex
= 4;
668 UINT8 SectorBuffer
[512];
670 MBR_PARTITION_INFO
*EMbrTable
;
672 ExtBase
= MbrEntry
->StartLBA
;
674 for (ExtCurrent
= ExtBase
; ExtCurrent
; ExtCurrent
= NextExtCurrent
) {
676 Status
= refit_call5_wrapper(WholeDiskVolume
->BlockIO
->ReadBlocks
,
677 WholeDiskVolume
->BlockIO
,
678 WholeDiskVolume
->BlockIO
->Media
->MediaId
,
679 ExtCurrent
, 512, SectorBuffer
);
680 if (EFI_ERROR(Status
))
682 if (*((UINT16
*)(SectorBuffer
+ 510)) != 0xaa55)
684 EMbrTable
= (MBR_PARTITION_INFO
*)(SectorBuffer
+ 446);
686 // scan logical partitions in this EMBR
688 for (i
= 0; i
< 4; i
++) {
689 if ((EMbrTable
[i
].Flags
!= 0x00 && EMbrTable
[i
].Flags
!= 0x80) ||
690 EMbrTable
[i
].StartLBA
== 0 || EMbrTable
[i
].Size
== 0)
692 if (IS_EXTENDED_PART_TYPE(EMbrTable
[i
].Type
)) {
693 // set next ExtCurrent
694 NextExtCurrent
= ExtBase
+ EMbrTable
[i
].StartLBA
;
698 // found a logical partition
699 Volume
= AllocateZeroPool(sizeof(REFIT_VOLUME
));
700 Volume
->DiskKind
= WholeDiskVolume
->DiskKind
;
701 Volume
->IsMbrPartition
= TRUE
;
702 Volume
->MbrPartitionIndex
= LogicalPartitionIndex
++;
703 Volume
->VolName
= AllocateZeroPool(256 * sizeof(UINT16
));
704 SPrint(Volume
->VolName
, 255, L
"Partition %d", Volume
->MbrPartitionIndex
+ 1);
705 Volume
->BlockIO
= WholeDiskVolume
->BlockIO
;
706 Volume
->BlockIOOffset
= ExtCurrent
+ EMbrTable
[i
].StartLBA
;
707 Volume
->WholeDiskBlockIO
= WholeDiskVolume
->BlockIO
;
710 ScanVolumeBootcode(Volume
, &Bootable
);
712 Volume
->HasBootCode
= FALSE
;
714 ScanVolumeDefaultIcon(Volume
);
716 AddListElement((VOID
***) &Volumes
, &VolumesCount
, Volume
);
723 VOID
ScanVolumes(VOID
)
726 UINTN HandleCount
= 0;
729 REFIT_VOLUME
*Volume
, *WholeDiskVolume
;
730 UINTN VolumeIndex
, VolumeIndex2
;
731 MBR_PARTITION_INFO
*MbrTable
;
732 UINTN PartitionIndex
;
733 UINT8
*SectorBuffer1
, *SectorBuffer2
;
740 // get all filesystem handles
741 Status
= LibLocateHandle(ByProtocol
, &BlockIoProtocol
, NULL
, &HandleCount
, &Handles
);
742 // was: &FileSystemProtocol
743 if (Status
== EFI_NOT_FOUND
) {
744 return; // no filesystems. strange, but true...
746 if (CheckError(Status
, L
"while listing all file systems"))
749 // first pass: collect information about all handles
750 for (HandleIndex
= 0; HandleIndex
< HandleCount
; HandleIndex
++) {
751 Volume
= AllocateZeroPool(sizeof(REFIT_VOLUME
));
752 Volume
->DeviceHandle
= Handles
[HandleIndex
];
755 AddListElement((VOID
***) &Volumes
, &VolumesCount
, Volume
);
757 if (Volume
->DeviceHandle
== SelfLoadedImage
->DeviceHandle
)
762 if (SelfVolume
== NULL
)
763 Print(L
"WARNING: SelfVolume not found");
765 // second pass: relate partitions and whole disk devices
766 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
767 Volume
= Volumes
[VolumeIndex
];
768 // check MBR partition table for extended partitions
769 if (Volume
->BlockIO
!= NULL
&& Volume
->WholeDiskBlockIO
!= NULL
&&
770 Volume
->BlockIO
== Volume
->WholeDiskBlockIO
&& Volume
->BlockIOOffset
== 0 &&
771 Volume
->MbrPartitionTable
!= NULL
) {
772 MbrTable
= Volume
->MbrPartitionTable
;
773 for (PartitionIndex
= 0; PartitionIndex
< 4; PartitionIndex
++) {
774 if (IS_EXTENDED_PART_TYPE(MbrTable
[PartitionIndex
].Type
)) {
775 ScanExtendedPartition(Volume
, MbrTable
+ PartitionIndex
);
780 // search for corresponding whole disk volume entry
781 WholeDiskVolume
= NULL
;
782 if (Volume
->BlockIO
!= NULL
&& Volume
->WholeDiskBlockIO
!= NULL
&&
783 Volume
->BlockIO
!= Volume
->WholeDiskBlockIO
) {
784 for (VolumeIndex2
= 0; VolumeIndex2
< VolumesCount
; VolumeIndex2
++) {
785 if (Volumes
[VolumeIndex2
]->BlockIO
== Volume
->WholeDiskBlockIO
&&
786 Volumes
[VolumeIndex2
]->BlockIOOffset
== 0)
787 WholeDiskVolume
= Volumes
[VolumeIndex2
];
791 if (WholeDiskVolume
!= NULL
&& WholeDiskVolume
->MbrPartitionTable
!= NULL
) {
792 // check if this volume is one of the partitions in the table
793 MbrTable
= WholeDiskVolume
->MbrPartitionTable
;
794 SectorBuffer1
= AllocatePool(512);
795 SectorBuffer2
= AllocatePool(512);
796 for (PartitionIndex
= 0; PartitionIndex
< 4; PartitionIndex
++) {
798 if ((UINT64
)(MbrTable
[PartitionIndex
].Size
) != Volume
->BlockIO
->Media
->LastBlock
+ 1)
801 // compare boot sector read through offset vs. directly
802 Status
= refit_call5_wrapper(Volume
->BlockIO
->ReadBlocks
,
803 Volume
->BlockIO
, Volume
->BlockIO
->Media
->MediaId
,
804 Volume
->BlockIOOffset
, 512, SectorBuffer1
);
805 if (EFI_ERROR(Status
))
807 Status
= refit_call5_wrapper(Volume
->WholeDiskBlockIO
->ReadBlocks
,
808 Volume
->WholeDiskBlockIO
, Volume
->WholeDiskBlockIO
->Media
->MediaId
,
809 MbrTable
[PartitionIndex
].StartLBA
, 512, SectorBuffer2
);
810 if (EFI_ERROR(Status
))
812 if (CompareMem(SectorBuffer1
, SectorBuffer2
, 512) != 0)
815 for (i
= 0; i
< 512; i
++)
816 SectorSum
+= SectorBuffer1
[i
];
817 if (SectorSum
< 1000)
820 // TODO: mark entry as non-bootable if it is an extended partition
822 // now we're reasonably sure the association is correct...
823 Volume
->IsMbrPartition
= TRUE
;
824 Volume
->MbrPartitionIndex
= PartitionIndex
;
825 if (Volume
->VolName
== NULL
) {
826 Volume
->VolName
= AllocateZeroPool(sizeof(CHAR16
) * 256);
827 SPrint(Volume
->VolName
, 255, L
"Partition %d", PartitionIndex
+ 1);
832 FreePool(SectorBuffer1
);
833 FreePool(SectorBuffer2
);
837 } /* VOID ScanVolumes() */
839 static VOID
UninitVolumes(VOID
)
841 REFIT_VOLUME
*Volume
;
844 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
845 Volume
= Volumes
[VolumeIndex
];
847 if (Volume
->RootDir
!= NULL
) {
848 refit_call1_wrapper(Volume
->RootDir
->Close
, Volume
->RootDir
);
849 Volume
->RootDir
= NULL
;
852 Volume
->DeviceHandle
= NULL
;
853 Volume
->BlockIO
= NULL
;
854 Volume
->WholeDiskBlockIO
= NULL
;
858 VOID
ReinitVolumes(VOID
)
861 REFIT_VOLUME
*Volume
;
863 EFI_DEVICE_PATH
*RemainingDevicePath
;
864 EFI_HANDLE DeviceHandle
, WholeDiskHandle
;
866 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
867 Volume
= Volumes
[VolumeIndex
];
869 if (Volume
->DevicePath
!= NULL
) {
870 // get the handle for that path
871 RemainingDevicePath
= Volume
->DevicePath
;
872 Status
= refit_call3_wrapper(BS
->LocateDevicePath
, &BlockIoProtocol
, &RemainingDevicePath
, &DeviceHandle
);
874 if (!EFI_ERROR(Status
)) {
875 Volume
->DeviceHandle
= DeviceHandle
;
877 // get the root directory
878 Volume
->RootDir
= LibOpenRoot(Volume
->DeviceHandle
);
881 CheckError(Status
, L
"from LocateDevicePath");
884 if (Volume
->WholeDiskDevicePath
!= NULL
) {
885 // get the handle for that path
886 RemainingDevicePath
= Volume
->WholeDiskDevicePath
;
887 Status
= refit_call3_wrapper(BS
->LocateDevicePath
, &BlockIoProtocol
, &RemainingDevicePath
, &WholeDiskHandle
);
889 if (!EFI_ERROR(Status
)) {
890 // get the BlockIO protocol
891 Status
= refit_call3_wrapper(BS
->HandleProtocol
, WholeDiskHandle
, &BlockIoProtocol
, (VOID
**) &Volume
->WholeDiskBlockIO
);
892 if (EFI_ERROR(Status
)) {
893 Volume
->WholeDiskBlockIO
= NULL
;
894 CheckError(Status
, L
"from HandleProtocol");
897 CheckError(Status
, L
"from LocateDevicePath");
903 // file and dir functions
906 BOOLEAN
FileExists(IN EFI_FILE
*BaseDir
, IN CHAR16
*RelativePath
)
909 EFI_FILE_HANDLE TestFile
;
911 Status
= refit_call5_wrapper(BaseDir
->Open
, BaseDir
, &TestFile
, RelativePath
, EFI_FILE_MODE_READ
, 0);
912 if (Status
== EFI_SUCCESS
) {
913 refit_call1_wrapper(TestFile
->Close
, TestFile
);
919 EFI_STATUS
DirNextEntry(IN EFI_FILE
*Directory
, IN OUT EFI_FILE_INFO
**DirEntry
, IN UINTN FilterMode
)
923 UINTN LastBufferSize
, BufferSize
;
928 // free pointer from last call
929 if (*DirEntry
!= NULL
) {
934 // read next directory entry
935 LastBufferSize
= BufferSize
= 256;
936 Buffer
= AllocatePool(BufferSize
);
937 for (IterCount
= 0; ; IterCount
++) {
938 Status
= refit_call3_wrapper(Directory
->Read
, Directory
, &BufferSize
, Buffer
);
939 if (Status
!= EFI_BUFFER_TOO_SMALL
|| IterCount
>= 4)
941 if (BufferSize
<= LastBufferSize
) {
942 Print(L
"FS Driver requests bad buffer size %d (was %d), using %d instead\n", BufferSize
, LastBufferSize
, LastBufferSize
* 2);
943 BufferSize
= LastBufferSize
* 2;
946 Print(L
"Reallocating buffer from %d to %d\n", LastBufferSize
, BufferSize
);
949 Buffer
= EfiReallocatePool(Buffer
, LastBufferSize
, BufferSize
);
950 LastBufferSize
= BufferSize
;
952 if (EFI_ERROR(Status
)) {
957 // check for end of listing
958 if (BufferSize
== 0) { // end of directory listing
963 // entry is ready to be returned
964 *DirEntry
= (EFI_FILE_INFO
*)Buffer
;
967 if (FilterMode
== 1) { // only return directories
968 if (((*DirEntry
)->Attribute
& EFI_FILE_DIRECTORY
))
970 } else if (FilterMode
== 2) { // only return files
971 if (((*DirEntry
)->Attribute
& EFI_FILE_DIRECTORY
) == 0)
973 } else // no filter or unknown filter -> return everything
980 VOID
DirIterOpen(IN EFI_FILE
*BaseDir
, IN CHAR16
*RelativePath OPTIONAL
, OUT REFIT_DIR_ITER
*DirIter
)
982 if (RelativePath
== NULL
) {
983 DirIter
->LastStatus
= EFI_SUCCESS
;
984 DirIter
->DirHandle
= BaseDir
;
985 DirIter
->CloseDirHandle
= FALSE
;
987 DirIter
->LastStatus
= refit_call5_wrapper(BaseDir
->Open
, BaseDir
, &(DirIter
->DirHandle
), RelativePath
, EFI_FILE_MODE_READ
, 0);
988 DirIter
->CloseDirHandle
= EFI_ERROR(DirIter
->LastStatus
) ? FALSE
: TRUE
;
990 DirIter
->LastFileInfo
= NULL
;
993 #ifndef __MAKEWITH_GNUEFI
994 EFI_UNICODE_COLLATION_PROTOCOL
*mUnicodeCollation
= NULL
;
997 InitializeUnicodeCollationProtocol (VOID
)
1001 if (mUnicodeCollation
!= NULL
) {
1006 // BUGBUG: Proper impelmentation is to locate all Unicode Collation Protocol
1007 // instances first and then select one which support English language.
1008 // Current implementation just pick the first instance.
1010 Status
= gBS
->LocateProtocol (
1011 &gEfiUnicodeCollation2ProtocolGuid
,
1013 (VOID
**) &mUnicodeCollation
1015 if (EFI_ERROR(Status
)) {
1016 Status
= gBS
->LocateProtocol (
1017 &gEfiUnicodeCollationProtocolGuid
,
1019 (VOID
**) &mUnicodeCollation
1027 MetaiMatch (IN CHAR16
*String
, IN CHAR16
*Pattern
)
1029 if (!mUnicodeCollation
) {
1030 InitializeUnicodeCollationProtocol();
1032 if (mUnicodeCollation
)
1033 return mUnicodeCollation
->MetaiMatch (mUnicodeCollation
, String
, Pattern
);
1034 return FALSE
; // Shouldn't happen
1037 static VOID
StrLwr (IN OUT CHAR16
*Str
) {
1038 if (!mUnicodeCollation
) {
1039 InitializeUnicodeCollationProtocol();
1041 if (mUnicodeCollation
)
1042 mUnicodeCollation
->StrLwr (mUnicodeCollation
, Str
);
1047 BOOLEAN
DirIterNext(IN OUT REFIT_DIR_ITER
*DirIter
, IN UINTN FilterMode
, IN CHAR16
*FilePattern OPTIONAL
,
1048 OUT EFI_FILE_INFO
**DirEntry
)
1050 BOOLEAN KeepGoing
= TRUE
;
1054 if (DirIter
->LastFileInfo
!= NULL
) {
1055 FreePool(DirIter
->LastFileInfo
);
1056 DirIter
->LastFileInfo
= NULL
;
1059 if (EFI_ERROR(DirIter
->LastStatus
))
1060 return FALSE
; // stop iteration
1063 DirIter
->LastStatus
= DirNextEntry(DirIter
->DirHandle
, &(DirIter
->LastFileInfo
), FilterMode
);
1064 if (EFI_ERROR(DirIter
->LastStatus
))
1066 if (DirIter
->LastFileInfo
== NULL
) // end of listing
1068 if (FilePattern
!= NULL
) {
1069 if ((DirIter
->LastFileInfo
->Attribute
& EFI_FILE_DIRECTORY
))
1072 while (KeepGoing
&& (OnePattern
= FindCommaDelimited(FilePattern
, i
++)) != NULL
) {
1073 if (MetaiMatch(DirIter
->LastFileInfo
->FileName
, OnePattern
))
1076 // else continue loop
1079 } while (KeepGoing
);
1081 *DirEntry
= DirIter
->LastFileInfo
;
1085 EFI_STATUS
DirIterClose(IN OUT REFIT_DIR_ITER
*DirIter
)
1087 if (DirIter
->LastFileInfo
!= NULL
) {
1088 FreePool(DirIter
->LastFileInfo
);
1089 DirIter
->LastFileInfo
= NULL
;
1091 if (DirIter
->CloseDirHandle
)
1092 refit_call1_wrapper(DirIter
->DirHandle
->Close
, DirIter
->DirHandle
);
1093 return DirIter
->LastStatus
;
1097 // file name manipulation
1100 // Returns the filename portion (minus path name) of the
1102 CHAR16
* Basename(IN CHAR16
*Path
)
1110 for (i
= StrLen(Path
); i
> 0; i
--) {
1111 if (Path
[i
-1] == '\\' || Path
[i
-1] == '/') {
1112 FileName
= Path
+ i
;
1121 // Replaces a filename extension of ".efi" with the specified string
1122 // (Extension). If the input Path doesn't end in ".efi", Extension
1123 // is added to the existing filename.
1124 VOID
ReplaceEfiExtension(IN OUT CHAR16
*Path
, IN CHAR16
*Extension
)
1128 PathLen
= StrLen(Path
);
1129 // Note: Do StriCmp() twice to work around Gigabyte Hybrid EFI case-sensitivity bug....
1130 if ((PathLen
>= 4) && ((StriCmp(&Path
[PathLen
- 4], L
".efi") == 0) || (StriCmp(&Path
[PathLen
- 4], L
".EFI") == 0))) {
1131 Path
[PathLen
- 4] = 0;
1133 StrCat(Path
, Extension
);
1134 } // VOID ReplaceEfiExtension()
1137 // memory string search
1140 INTN
FindMem(IN VOID
*Buffer
, IN UINTN BufferLength
, IN VOID
*SearchString
, IN UINTN SearchStringLength
)
1146 BufferLength
-= SearchStringLength
;
1147 for (Offset
= 0; Offset
< BufferLength
; Offset
++, BufferPtr
++) {
1148 if (CompareMem(BufferPtr
, SearchString
, SearchStringLength
) == 0)
1149 return (INTN
)Offset
;
1155 // Performs a case-insensitive search of BigStr for SmallStr.
1156 // Returns TRUE if found, FALSE if not.
1157 BOOLEAN
StriSubCmp(IN CHAR16
*SmallStr
, IN CHAR16
*BigStr
) {
1158 CHAR16
*SmallCopy
, *BigCopy
;
1159 BOOLEAN Found
= FALSE
;
1160 UINTN StartPoint
= 0, NumCompares
= 0, SmallLen
= 0;
1162 if ((SmallStr
!= NULL
) && (BigStr
!= NULL
) && (StrLen(BigStr
) >= StrLen(SmallStr
))) {
1163 SmallCopy
= StrDuplicate(SmallStr
);
1164 BigCopy
= StrDuplicate(BigStr
);
1167 SmallLen
= StrLen(SmallCopy
);
1168 NumCompares
= StrLen(BigCopy
) - SmallLen
+ 1;
1169 while ((!Found
) && (StartPoint
< NumCompares
)) {
1170 Found
= (StrnCmp(SmallCopy
, &BigCopy
[StartPoint
++], SmallLen
) == 0);
1172 FreePool(SmallCopy
);
1177 } // BOOLEAN StriSubCmp()
1179 // Merges two strings, creating a new one and returning a pointer to it.
1180 // If AddChar != 0, the specified character is placed between the two original
1181 // strings (unless the first string is NULL). The original input string
1182 // *First is de-allocated and replaced by the new merged string.
1183 // This is similar to StrCat, but safer and more flexible because
1184 // MergeStrings allocates memory that's the correct size for the
1185 // new merged string, so it can take a NULL *First and it cleans
1186 // up the old memory. It should *NOT* be used with a constant
1187 // *First, though....
1188 VOID
MergeStrings(IN OUT CHAR16
**First
, IN CHAR16
*Second
, CHAR16 AddChar
) {
1189 UINTN Length1
= 0, Length2
= 0;
1193 Length1
= StrLen(*First
);
1195 Length2
= StrLen(Second
);
1196 NewString
= AllocatePool(sizeof(CHAR16
) * (Length1
+ Length2
+ 2));
1197 if (NewString
!= NULL
) {
1198 NewString
[0] = L
'\0';
1199 if (*First
!= NULL
) {
1200 StrCat(NewString
, *First
);
1202 NewString
[Length1
] = AddChar
;
1203 NewString
[Length1
+ 1] = 0;
1205 } // if (*First != NULL)
1207 StrCat(NewString
, Second
);
1211 Print(L
"Error! Unable to allocate memory in MergeStrings()!\n");
1213 } // static CHAR16* MergeStrings()
1215 // Takes an input pathname (*Path) and returns the part of the filename from
1216 // the final dot onwards, converted to lowercase. If the filename includes
1217 // no dots, or if the input is NULL, returns an empty (but allocated) string.
1218 // The calling function is responsible for freeing the memory associated with
1219 // the return value.
1220 CHAR16
*FindExtension(IN CHAR16
*Path
) {
1222 BOOLEAN Found
= FALSE
, FoundSlash
= FALSE
;
1225 Extension
= AllocateZeroPool(sizeof(CHAR16
));
1228 while ((!Found
) && (!FoundSlash
) && (i
>= 0)) {
1229 if (Path
[i
] == L
'.')
1231 else if ((Path
[i
] == L
'/') || (Path
[i
] == L
'\\'))
1237 MergeStrings(&Extension
, &Path
[i
], 0);
1242 } // CHAR16 *FindExtension
1244 // Takes an input pathname (*Path) and locates the final directory component
1245 // of that name. For instance, if the input path is 'EFI\foo\bar.efi', this
1246 // function returns the string 'foo'.
1247 // Assumes the pathname is separated with backslashes.
1248 CHAR16
*FindLastDirName(IN CHAR16
*Path
) {
1249 UINTN i
, StartOfElement
= 0, EndOfElement
= 0, PathLength
, CopyLength
;
1250 CHAR16
*Found
= NULL
;
1252 PathLength
= StrLen(Path
);
1253 // Find start & end of target element
1254 for (i
= 0; i
< PathLength
; i
++) {
1255 if (Path
[i
] == '\\') {
1256 StartOfElement
= EndOfElement
;
1260 // Extract the target element
1261 if (EndOfElement
> 0) {
1262 while ((StartOfElement
< PathLength
) && (Path
[StartOfElement
] == '\\')) {
1266 if (EndOfElement
>= StartOfElement
) {
1267 CopyLength
= EndOfElement
- StartOfElement
+ 1;
1268 Found
= StrDuplicate(&Path
[StartOfElement
]);
1270 Found
[CopyLength
] = 0;
1271 } // if (EndOfElement >= StartOfElement)
1272 } // if (EndOfElement > 0)
1274 } // CHAR16 *FindLastDirName
1276 // Returns the directory portion of a pathname. For instance,
1277 // if FullPath is 'EFI\foo\bar.efi', this function returns the
1278 // string 'EFI\foo'. The calling function is responsible for
1279 // freeing the returned string's memory.
1280 CHAR16
*FindPath(IN CHAR16
* FullPath
) {
1281 UINTN i
, LastBackslash
= 0;
1284 for (i
= 0; i
< StrLen(FullPath
); i
++) {
1285 if (FullPath
[i
] == '\\')
1288 PathOnly
= StrDuplicate(FullPath
);
1289 PathOnly
[LastBackslash
] = 0;
1293 // Returns all the digits in the input string, including intervening
1294 // non-digit characters. For instance, if InString is "foo-3.3.4-7.img",
1295 // this function returns "3.3.4-7". If InString contains no digits,
1296 // the return value is NULL.
1297 CHAR16
*FindNumbers(IN CHAR16
*InString
) {
1298 UINTN i
, StartOfElement
, EndOfElement
= 0, InLength
, CopyLength
;
1299 CHAR16
*Found
= NULL
;
1301 InLength
= StartOfElement
= StrLen(InString
);
1302 // Find start & end of target element
1303 for (i
= 0; i
< InLength
; i
++) {
1304 if ((InString
[i
] >= '0') && (InString
[i
] <= '9')) {
1305 if (StartOfElement
> i
)
1307 if (EndOfElement
< i
)
1311 // Extract the target element
1312 if (EndOfElement
> 0) {
1313 if (EndOfElement
>= StartOfElement
) {
1314 CopyLength
= EndOfElement
- StartOfElement
+ 1;
1315 Found
= StrDuplicate(&InString
[StartOfElement
]);
1317 Found
[CopyLength
] = 0;
1318 } // if (EndOfElement >= StartOfElement)
1319 } // if (EndOfElement > 0)
1321 } // CHAR16 *FindNumbers()
1323 // Find the #Index element (numbered from 0) in a comma-delimited string
1325 // Returns the found element, or NULL if Index is out of range or InString
1326 // is NULL. Note that the calling function is responsible for freeing the
1327 // memory associated with the returned string pointer.
1328 CHAR16
*FindCommaDelimited(IN CHAR16
*InString
, IN UINTN Index
) {
1329 UINTN StartPos
= 0, CurPos
= 0;
1330 BOOLEAN Found
= FALSE
;
1331 CHAR16
*FoundString
= NULL
;
1333 if (InString
!= NULL
) {
1334 // After while() loop, StartPos marks start of item #Index
1335 while ((Index
> 0) && (CurPos
< StrLen(InString
))) {
1336 if (InString
[CurPos
] == L
',') {
1338 StartPos
= CurPos
+ 1;
1342 // After while() loop, CurPos is one past the end of the element
1343 while ((CurPos
< StrLen(InString
)) && (!Found
)) {
1344 if (InString
[CurPos
] == L
',')
1350 FoundString
= StrDuplicate(&InString
[StartPos
]);
1351 if (FoundString
!= NULL
)
1352 FoundString
[CurPos
- StartPos
] = 0;
1354 return (FoundString
);
1355 } // CHAR16 *FindCommaDelimited()
1357 // Returns TRUE if SmallString is an element in the comma-delimited List,
1358 // FALSE otherwise. Performs comparison case-insensitively (except on
1359 // buggy EFIs with case-sensitive StriCmp() functions).
1360 BOOLEAN
IsIn(IN CHAR16
*SmallString
, IN CHAR16
*List
) {
1362 BOOLEAN Found
= FALSE
;
1365 if (SmallString
&& List
) {
1366 while (!Found
&& (OneElement
= FindCommaDelimited(List
, i
++))) {
1367 if (StriCmp(OneElement
, SmallString
) == 0)
1374 static EFI_GUID AppleRemovableMediaGuid
= APPLE_REMOVABLE_MEDIA_PROTOCOL_GUID
;
1376 // Eject all removable media.
1377 // Returns TRUE if any media were ejected, FALSE otherwise.
1378 BOOLEAN
EjectMedia(VOID
) {
1380 UINTN HandleIndex
, HandleCount
= 0, Ejected
= 0;
1381 EFI_HANDLE
*Handles
, Handle
;
1382 APPLE_REMOVABLE_MEDIA_PROTOCOL
*Ejectable
;
1384 Status
= LibLocateHandle(ByProtocol
, &AppleRemovableMediaGuid
, NULL
, &HandleCount
, &Handles
);
1385 if (EFI_ERROR(Status
) || HandleCount
== 0)
1386 return (FALSE
); // probably not an Apple system
1388 for (HandleIndex
= 0; HandleIndex
< HandleCount
; HandleIndex
++) {
1389 Handle
= Handles
[HandleIndex
];
1390 Status
= refit_call3_wrapper(BS
->HandleProtocol
, Handle
, &AppleRemovableMediaGuid
, (VOID
**) &Ejectable
);
1391 if (EFI_ERROR(Status
))
1393 Status
= refit_call1_wrapper(Ejectable
->Eject
, Ejectable
);
1394 if (!EFI_ERROR(Status
))
1398 return (Ejected
> 0);
1399 } // VOID EjectMedia()