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-2013 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"
51 //#include "../include/UsbMass.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;
90 // Maximum size for disk sectors
91 #define SECTOR_SIZE 4096
93 // Number of bytes to read from a partition to determine its filesystem type
94 // and identify its boot loader, and hence probable BIOS-mode OS installation
95 #define SAMPLE_SIZE 69632 /* 68 KiB -- ReiserFS superblock begins at 64 KiB */
100 static EFI_STATUS
FinishInitRefitLib(VOID
);
102 static VOID
UninitVolumes(VOID
);
105 // self recognition stuff
108 // Converts forward slashes to backslashes, removes duplicate slashes, and
109 // removes slashes from both the start and end of the pathname.
110 // Necessary because some (buggy?) EFI implementations produce "\/" strings
111 // in pathnames, because some user inputs can produce duplicate directory
112 // separators, and because we want consistent start and end slashes for
113 // directory comparisons. A special case: If the PathName refers to root,
114 // return "/", since some firmware implementations flake out if this
116 VOID
CleanUpPathNameSlashes(IN OUT CHAR16
*PathName
) {
118 UINTN i
, FinalChar
= 0;
119 BOOLEAN LastWasSlash
= FALSE
;
121 NewName
= AllocateZeroPool(sizeof(CHAR16
) * (StrLen(PathName
) + 2));
122 if (NewName
!= NULL
) {
123 for (i
= 0; i
< StrLen(PathName
); i
++) {
124 if ((PathName
[i
] == L
'/') || (PathName
[i
] == L
'\\')) {
125 if ((!LastWasSlash
) && (FinalChar
!= 0))
126 NewName
[FinalChar
++] = L
'\\';
129 NewName
[FinalChar
++] = PathName
[i
];
130 LastWasSlash
= FALSE
;
133 NewName
[FinalChar
] = 0;
134 if ((FinalChar
> 0) && (NewName
[FinalChar
- 1] == L
'\\'))
135 NewName
[--FinalChar
] = 0;
136 if (FinalChar
== 0) {
140 // Copy the transformed name back....
141 StrCpy(PathName
, NewName
);
143 } // if allocation OK
144 } // CleanUpPathNameSlashes()
146 // Splits an EFI device path into device and filename components. For instance, if InString is
147 // PciRoot(0x0)/Pci(0x1f,0x2)/Ata(Secondary,Master,0x0)/HD(2,GPT,8314ae90-ada3-48e9-9c3b-09a88f80d921,0x96028,0xfa000)/\bzImage-3.5.1.efi,
148 // this function will truncate that input to
149 // PciRoot(0x0)/Pci(0x1f,0x2)/Ata(Secondary,Master,0x0)/HD(2,GPT,8314ae90-ada3-48e9-9c3b-09a88f80d921,0x96028,0xfa000)
150 // and return bzImage-3.5.1.efi as its return value.
151 // It does this by searching for the last ")" character in InString, copying everything
152 // after that string (after some cleanup) as the return value, and truncating the original
154 // If InString contains no ")" character, this function leaves the original input string
155 // unmodified and also returns that string. If InString is NULL, this function returns NULL.
156 static CHAR16
* SplitDeviceString(IN OUT CHAR16
*InString
) {
158 CHAR16
*FileName
= NULL
;
159 BOOLEAN Found
= FALSE
;
161 if (InString
!= NULL
) {
162 i
= StrLen(InString
) - 1;
163 while ((i
>= 0) && (!Found
)) {
164 if (InString
[i
] == L
')') {
166 FileName
= StrDuplicate(&InString
[i
+ 1]);
167 CleanUpPathNameSlashes(FileName
);
168 InString
[i
+ 1] = '\0';
172 if (FileName
== NULL
)
173 FileName
= StrDuplicate(InString
);
176 } // static CHAR16* SplitDeviceString()
178 EFI_STATUS
InitRefitLib(IN EFI_HANDLE ImageHandle
)
181 CHAR16
*DevicePathAsString
, *Temp
;
183 SelfImageHandle
= ImageHandle
;
184 Status
= refit_call3_wrapper(BS
->HandleProtocol
, SelfImageHandle
, &LoadedImageProtocol
, (VOID
**) &SelfLoadedImage
);
185 if (CheckFatalError(Status
, L
"while getting a LoadedImageProtocol handle"))
186 return EFI_LOAD_ERROR
;
188 // find the current directory
189 DevicePathAsString
= DevicePathToStr(SelfLoadedImage
->FilePath
);
190 CleanUpPathNameSlashes(DevicePathAsString
);
191 MyFreePool(SelfDirPath
);
192 Temp
= FindPath(DevicePathAsString
);
193 SelfDirPath
= SplitDeviceString(Temp
);
194 MyFreePool(DevicePathAsString
);
197 return FinishInitRefitLib();
200 // called before running external programs to close open file handles
201 VOID
UninitRefitLib(VOID
)
205 if (SelfDir
!= NULL
) {
206 refit_call1_wrapper(SelfDir
->Close
, SelfDir
);
210 if (SelfRootDir
!= NULL
) {
211 refit_call1_wrapper(SelfRootDir
->Close
, SelfRootDir
);
216 // called after running external programs to re-open file handles
217 EFI_STATUS
ReinitRefitLib(VOID
)
221 if ((ST
->Hdr
.Revision
>> 16) == 1) {
222 // Below two lines were in rEFIt, but seem to cause system crashes or
223 // reboots when launching OSes after returning from programs on most
224 // systems. OTOH, my Mac Mini produces errors about "(re)opening our
225 // installation volume" (see the next function) when returning from
226 // programs when these two lines are removed, and it often crashes
227 // when returning from a program or when launching a second program
228 // with these lines removed. Therefore, the preceding if() statement
229 // executes these lines only on EFIs with a major version number of 1
230 // (which Macs have) and not with 2 (which UEFI PCs have). My selection
231 // of hardware on which to test is limited, though, so this may be the
232 // wrong test, or there may be a better way to fix this problem.
233 // TODO: Figure out cause of above weirdness and fix it more
235 if (SelfVolume
!= NULL
&& SelfVolume
->RootDir
!= NULL
)
236 SelfRootDir
= SelfVolume
->RootDir
;
239 return FinishInitRefitLib();
242 static EFI_STATUS
FinishInitRefitLib(VOID
)
246 if (SelfRootDir
== NULL
) {
247 SelfRootDir
= LibOpenRoot(SelfLoadedImage
->DeviceHandle
);
248 if (SelfRootDir
== NULL
) {
249 CheckError(EFI_LOAD_ERROR
, L
"while (re)opening our installation volume");
250 return EFI_LOAD_ERROR
;
254 Status
= refit_call5_wrapper(SelfRootDir
->Open
, SelfRootDir
, &SelfDir
, SelfDirPath
, EFI_FILE_MODE_READ
, 0);
255 if (CheckFatalError(Status
, L
"while opening our installation directory"))
256 return EFI_LOAD_ERROR
;
265 VOID
CreateList(OUT VOID
***ListPtr
, OUT UINTN
*ElementCount
, IN UINTN InitialElementCount
)
269 *ElementCount
= InitialElementCount
;
270 if (*ElementCount
> 0) {
271 AllocateCount
= (*ElementCount
+ 7) & ~7; // next multiple of 8
272 *ListPtr
= AllocatePool(sizeof(VOID
*) * AllocateCount
);
278 VOID
AddListElement(IN OUT VOID
***ListPtr
, IN OUT UINTN
*ElementCount
, IN VOID
*NewElement
)
282 if ((*ElementCount
& 7) == 0) {
283 AllocateCount
= *ElementCount
+ 8;
284 if (*ElementCount
== 0)
285 *ListPtr
= AllocatePool(sizeof(VOID
*) * AllocateCount
);
287 *ListPtr
= EfiReallocatePool(*ListPtr
, sizeof(VOID
*) * (*ElementCount
), sizeof(VOID
*) * AllocateCount
);
289 (*ListPtr
)[*ElementCount
] = NewElement
;
291 } /* VOID AddListElement() */
293 VOID
FreeList(IN OUT VOID
***ListPtr
, IN OUT UINTN
*ElementCount
)
297 if ((*ElementCount
> 0) && (**ListPtr
!= NULL
)) {
298 for (i
= 0; i
< *ElementCount
; i
++) {
299 // TODO: call a user-provided routine for each element here
300 MyFreePool((*ListPtr
)[i
]);
302 MyFreePool(*ListPtr
);
307 // firmware device path discovery
310 static UINT8 LegacyLoaderMediaPathData
[] = {
311 0x04, 0x06, 0x14, 0x00, 0xEB, 0x85, 0x05, 0x2B,
312 0xB8, 0xD8, 0xA9, 0x49, 0x8B, 0x8C, 0xE2, 0x1B,
313 0x01, 0xAE, 0xF2, 0xB7, 0x7F, 0xFF, 0x04, 0x00,
315 static EFI_DEVICE_PATH
*LegacyLoaderMediaPath
= (EFI_DEVICE_PATH
*)LegacyLoaderMediaPathData
;
317 VOID
ExtractLegacyLoaderPaths(EFI_DEVICE_PATH
**PathList
, UINTN MaxPaths
, EFI_DEVICE_PATH
**HardcodedPathList
)
320 UINTN HandleCount
= 0;
321 UINTN HandleIndex
, HardcodedIndex
;
326 EFI_LOADED_IMAGE
*LoadedImage
;
327 EFI_DEVICE_PATH
*DevicePath
;
330 MaxPaths
--; // leave space for the terminating NULL pointer
332 // get all LoadedImage handles
333 Status
= LibLocateHandle(ByProtocol
, &LoadedImageProtocol
, NULL
, &HandleCount
, &Handles
);
334 if (CheckError(Status
, L
"while listing LoadedImage handles")) {
335 if (HardcodedPathList
) {
336 for (HardcodedIndex
= 0; HardcodedPathList
[HardcodedIndex
] && PathCount
< MaxPaths
; HardcodedIndex
++)
337 PathList
[PathCount
++] = HardcodedPathList
[HardcodedIndex
];
339 PathList
[PathCount
] = NULL
;
342 for (HandleIndex
= 0; HandleIndex
< HandleCount
&& PathCount
< MaxPaths
; HandleIndex
++) {
343 Handle
= Handles
[HandleIndex
];
345 Status
= refit_call3_wrapper(BS
->HandleProtocol
, Handle
, &LoadedImageProtocol
, (VOID
**) &LoadedImage
);
346 if (EFI_ERROR(Status
))
347 continue; // This can only happen if the firmware scewed up, ignore it.
349 Status
= refit_call3_wrapper(BS
->HandleProtocol
, LoadedImage
->DeviceHandle
, &DevicePathProtocol
, (VOID
**) &DevicePath
);
350 if (EFI_ERROR(Status
))
351 continue; // This happens, ignore it.
353 // Only grab memory range nodes
354 if (DevicePathType(DevicePath
) != HARDWARE_DEVICE_PATH
|| DevicePathSubType(DevicePath
) != HW_MEMMAP_DP
)
357 // Check if we have this device path in the list already
358 // WARNING: This assumes the first node in the device path is unique!
360 for (PathIndex
= 0; PathIndex
< PathCount
; PathIndex
++) {
361 if (DevicePathNodeLength(DevicePath
) != DevicePathNodeLength(PathList
[PathIndex
]))
363 if (CompareMem(DevicePath
, PathList
[PathIndex
], DevicePathNodeLength(DevicePath
)) == 0) {
371 PathList
[PathCount
++] = AppendDevicePath(DevicePath
, LegacyLoaderMediaPath
);
375 if (HardcodedPathList
) {
376 for (HardcodedIndex
= 0; HardcodedPathList
[HardcodedIndex
] && PathCount
< MaxPaths
; HardcodedIndex
++)
377 PathList
[PathCount
++] = HardcodedPathList
[HardcodedIndex
];
379 PathList
[PathCount
] = NULL
;
386 // Return a pointer to a string containing a filesystem type name. If the
387 // filesystem type is unknown, a blank (but non-null) string is returned.
388 // The returned variable is a constant that should NOT be freed.
389 static CHAR16
*FSTypeName(IN UINT32 TypeCode
) {
390 CHAR16
*retval
= NULL
;
396 case FS_TYPE_HFSPLUS
:
408 case FS_TYPE_REISERFS
:
409 retval
= L
" ReiserFS";
414 case FS_TYPE_ISO9660
:
415 retval
= L
" ISO-9660";
422 } // CHAR16 *FSTypeName()
424 // Identify the filesystem type, if possible. Expects a Buffer containing
425 // the first few (normally 4096) bytes of the filesystem, and outputs a
426 // code representing the identified filesystem type.
427 static UINT32
IdentifyFilesystemType(IN UINT8
*Buffer
, IN UINTN BufferSize
) {
428 UINT32 FoundType
= FS_TYPE_UNKNOWN
;
429 UINT32
*Ext2Incompat
, *Ext2Compat
;
433 if (Buffer
!= NULL
) {
435 if (BufferSize
>= 512) {
436 Magic16
= (UINT16
*) (Buffer
+ 510);
437 if (*Magic16
== FAT_MAGIC
)
439 } // search for FAT magic
441 if (BufferSize
>= (1024 + 100)) {
442 Magic16
= (UINT16
*) (Buffer
+ 1024 + 56);
443 if (*Magic16
== EXT2_SUPER_MAGIC
) { // ext2/3/4
444 Ext2Compat
= (UINT32
*) (Buffer
+ 1024 + 92);
445 Ext2Incompat
= (UINT32
*) (Buffer
+ 1024 + 96);
446 if ((*Ext2Incompat
& 0x0040) || (*Ext2Incompat
& 0x0200)) { // check for extents or flex_bg
448 } else if (*Ext2Compat
& 0x0004) { // check for journal
450 } else { // none of these features; presume it's ext2...
454 } // search for ext2/3/4 magic
456 if (BufferSize
>= (65536 + 62)) {
457 MagicString
= (char*) (Buffer
+ 65536 + 52);
458 if ((CompareMem(MagicString
, REISERFS_SUPER_MAGIC_STRING
, 8) == 0) ||
459 (CompareMem(MagicString
, REISER2FS_SUPER_MAGIC_STRING
, 9) == 0) ||
460 (CompareMem(MagicString
, REISER2FS_JR_SUPER_MAGIC_STRING
, 9) == 0)) {
461 return FS_TYPE_REISERFS
;
463 } // search for ReiserFS magic
465 if (BufferSize
>= (65536 + 64 + 8)) {
466 MagicString
= (char*) (Buffer
+ 65536 + 64);
467 if (CompareMem(MagicString
, BTRFS_SIGNATURE
, 8) == 0)
468 return FS_TYPE_BTRFS
;
469 } // search for Btrfs magic
471 if (BufferSize
>= (1024 + 2)) {
472 Magic16
= (UINT16
*) (Buffer
+ 1024);
473 if ((*Magic16
== HFSPLUS_MAGIC1
) || (*Magic16
== HFSPLUS_MAGIC2
)) {
474 return FS_TYPE_HFSPLUS
;
476 } // search for HFS+ magic
477 } // if (Buffer != NULL)
480 } // UINT32 IdentifyFilesystemType()
482 static VOID
ScanVolumeBootcode(REFIT_VOLUME
*Volume
, BOOLEAN
*Bootable
)
485 UINT8 Buffer
[SAMPLE_SIZE
];
487 MBR_PARTITION_INFO
*MbrTable
;
488 BOOLEAN MbrTableFound
;
490 Volume
->HasBootCode
= FALSE
;
491 Volume
->OSIconName
= NULL
;
492 Volume
->OSName
= NULL
;
495 if (Volume
->BlockIO
== NULL
)
497 if (Volume
->BlockIO
->Media
->BlockSize
> SAMPLE_SIZE
)
498 return; // our buffer is too small...
500 // look at the boot sector (this is used for both hard disks and El Torito images!)
501 Status
= refit_call5_wrapper(Volume
->BlockIO
->ReadBlocks
,
502 Volume
->BlockIO
, Volume
->BlockIO
->Media
->MediaId
,
503 Volume
->BlockIOOffset
, SAMPLE_SIZE
, Buffer
);
504 if (!EFI_ERROR(Status
)) {
506 Volume
->FSType
= IdentifyFilesystemType(Buffer
, SAMPLE_SIZE
);
507 if (*((UINT16
*)(Buffer
+ 510)) == 0xaa55 && Buffer
[0] != 0) {
509 Volume
->HasBootCode
= TRUE
;
512 // detect specific boot codes
513 if (CompareMem(Buffer
+ 2, "LILO", 4) == 0 ||
514 CompareMem(Buffer
+ 6, "LILO", 4) == 0 ||
515 CompareMem(Buffer
+ 3, "SYSLINUX", 8) == 0 ||
516 FindMem(Buffer
, SECTOR_SIZE
, "ISOLINUX", 8) >= 0) {
517 Volume
->HasBootCode
= TRUE
;
518 Volume
->OSIconName
= L
"linux";
519 Volume
->OSName
= L
"Linux";
521 } else if (FindMem(Buffer
, 512, "Geom\0Hard Disk\0Read\0 Error", 26) >= 0) { // GRUB
522 Volume
->HasBootCode
= TRUE
;
523 Volume
->OSIconName
= L
"grub,linux";
524 Volume
->OSName
= L
"Linux";
526 // // Below doesn't produce a bootable entry, so commented out for the moment....
527 // // GRUB in BIOS boot partition:
528 // } else if (FindMem(Buffer, 512, "Geom\0Read\0 Error", 16) >= 0) {
529 // Volume->HasBootCode = TRUE;
530 // Volume->OSIconName = L"grub,linux";
531 // Volume->OSName = L"Linux";
532 // Volume->VolName = L"BIOS Boot Partition";
535 } else if ((*((UINT32
*)(Buffer
+ 502)) == 0 &&
536 *((UINT32
*)(Buffer
+ 506)) == 50000 &&
537 *((UINT16
*)(Buffer
+ 510)) == 0xaa55) ||
538 FindMem(Buffer
, SECTOR_SIZE
, "Starting the BTX loader", 23) >= 0) {
539 Volume
->HasBootCode
= TRUE
;
540 Volume
->OSIconName
= L
"freebsd";
541 Volume
->OSName
= L
"FreeBSD";
543 } else if (FindMem(Buffer
, 512, "!Loading", 8) >= 0 ||
544 FindMem(Buffer
, SECTOR_SIZE
, "/cdboot\0/CDBOOT\0", 16) >= 0) {
545 Volume
->HasBootCode
= TRUE
;
546 Volume
->OSIconName
= L
"openbsd";
547 Volume
->OSName
= L
"OpenBSD";
549 } else if (FindMem(Buffer
, 512, "Not a bootxx image", 18) >= 0 ||
550 *((UINT32
*)(Buffer
+ 1028)) == 0x7886b6d1) {
551 Volume
->HasBootCode
= TRUE
;
552 Volume
->OSIconName
= L
"netbsd";
553 Volume
->OSName
= L
"NetBSD";
555 } else if (FindMem(Buffer
, SECTOR_SIZE
, "NTLDR", 5) >= 0) {
556 Volume
->HasBootCode
= TRUE
;
557 Volume
->OSIconName
= L
"win";
558 Volume
->OSName
= L
"Windows";
560 } else if (FindMem(Buffer
, SECTOR_SIZE
, "BOOTMGR", 7) >= 0) {
561 Volume
->HasBootCode
= TRUE
;
562 Volume
->OSIconName
= L
"winvista,win";
563 Volume
->OSName
= L
"Windows";
565 } else if (FindMem(Buffer
, 512, "CPUBOOT SYS", 11) >= 0 ||
566 FindMem(Buffer
, 512, "KERNEL SYS", 11) >= 0) {
567 Volume
->HasBootCode
= TRUE
;
568 Volume
->OSIconName
= L
"freedos";
569 Volume
->OSName
= L
"FreeDOS";
571 } else if (FindMem(Buffer
, 512, "OS2LDR", 6) >= 0 ||
572 FindMem(Buffer
, 512, "OS2BOOT", 7) >= 0) {
573 Volume
->HasBootCode
= TRUE
;
574 Volume
->OSIconName
= L
"ecomstation";
575 Volume
->OSName
= L
"eComStation";
577 } else if (FindMem(Buffer
, 512, "Be Boot Loader", 14) >= 0) {
578 Volume
->HasBootCode
= TRUE
;
579 Volume
->OSIconName
= L
"beos";
580 Volume
->OSName
= L
"BeOS";
582 } else if (FindMem(Buffer
, 512, "yT Boot Loader", 14) >= 0) {
583 Volume
->HasBootCode
= TRUE
;
584 Volume
->OSIconName
= L
"zeta,beos";
585 Volume
->OSName
= L
"ZETA";
587 } else if (FindMem(Buffer
, 512, "\x04" "beos\x06" "system\x05" "zbeos", 18) >= 0 ||
588 FindMem(Buffer
, 512, "\x06" "system\x0c" "haiku_loader", 20) >= 0) {
589 Volume
->HasBootCode
= TRUE
;
590 Volume
->OSIconName
= L
"haiku,beos";
591 Volume
->OSName
= L
"Haiku";
595 // NOTE: If you add an operating system with a name that starts with 'W' or 'L', you
596 // need to fix AddLegacyEntry in main.c.
599 Print(L
" Result of bootcode detection: %s %s (%s)\n",
600 Volume
->HasBootCode
? L
"bootable" : L
"non-bootable",
601 Volume
->OSName
, Volume
->OSIconName
);
604 // dummy FAT boot sector (created by OS X's newfs_msdos)
605 if (FindMem(Buffer
, 512, "Non-system disk", 15) >= 0)
606 Volume
->HasBootCode
= FALSE
;
608 // dummy FAT boot sector (created by Linux's mkdosfs)
609 if (FindMem(Buffer
, 512, "This is not a bootable disk", 27) >= 0)
610 Volume
->HasBootCode
= FALSE
;
612 // dummy FAT boot sector (created by Windows)
613 if (FindMem(Buffer
, 512, "Press any key to restart", 24) >= 0)
614 Volume
->HasBootCode
= FALSE
;
616 // check for MBR partition table
617 if (*((UINT16
*)(Buffer
+ 510)) == 0xaa55) {
618 MbrTableFound
= FALSE
;
619 MbrTable
= (MBR_PARTITION_INFO
*)(Buffer
+ 446);
620 for (i
= 0; i
< 4; i
++)
621 if (MbrTable
[i
].StartLBA
&& MbrTable
[i
].Size
)
622 MbrTableFound
= TRUE
;
623 for (i
= 0; i
< 4; i
++)
624 if (MbrTable
[i
].Flags
!= 0x00 && MbrTable
[i
].Flags
!= 0x80)
625 MbrTableFound
= FALSE
;
627 Volume
->MbrPartitionTable
= AllocatePool(4 * 16);
628 CopyMem(Volume
->MbrPartitionTable
, MbrTable
, 4 * 16);
634 CheckError(Status
, L
"while reading boot sector");
637 } /* VOID ScanVolumeBootcode() */
639 // default volume badge icon based on disk kind
640 static VOID
ScanVolumeDefaultIcon(IN OUT REFIT_VOLUME
*Volume
)
642 switch (Volume
->DiskKind
) {
643 case DISK_KIND_INTERNAL
:
644 Volume
->VolBadgeImage
= BuiltinIcon(BUILTIN_ICON_VOL_INTERNAL
);
646 case DISK_KIND_EXTERNAL
:
647 Volume
->VolBadgeImage
= BuiltinIcon(BUILTIN_ICON_VOL_EXTERNAL
);
649 case DISK_KIND_OPTICAL
:
650 Volume
->VolBadgeImage
= BuiltinIcon(BUILTIN_ICON_VOL_OPTICAL
);
655 // Return a string representing the input size in IEEE-1541 units.
656 // The calling function is responsible for freeing the allocated memory.
657 static CHAR16
*SizeInIEEEUnits(UINT64 SizeInBytes
) {
659 UINTN Index
= 0, NumPrefixes
;
660 CHAR16
*Units
, *Prefixes
= L
" KMGTPEZ";
663 TheValue
= AllocateZeroPool(sizeof(CHAR16
) * 256);
664 if (TheValue
!= NULL
) {
665 NumPrefixes
= StrLen(Prefixes
);
666 SizeInIeee
= SizeInBytes
;
667 while ((SizeInIeee
> 1024) && (Index
< (NumPrefixes
- 1))) {
671 if (Prefixes
[Index
] == ' ') {
672 Units
= StrDuplicate(L
"-byte");
674 Units
= StrDuplicate(L
" iB");
675 Units
[1] = Prefixes
[Index
];
677 SPrint(TheValue
, 255, L
"%ld%s", SizeInIeee
, Units
);
680 } // CHAR16 *SizeInSIUnits()
682 // Return a name for the volume. Ideally this should be the label for the
683 // filesystem it contains, but this function falls back to describing the
684 // filesystem by size (200 MiB, etc.) and/or type (ext2, HFS+, etc.), if
685 // this information can be extracted.
686 // The calling function is responsible for freeing the memory allocated
687 // for the name string.
688 static CHAR16
*GetVolumeName(IN REFIT_VOLUME
*Volume
) {
689 EFI_FILE_SYSTEM_INFO
*FileSystemInfoPtr
;
690 CHAR16
*FoundName
= NULL
;
691 CHAR16
*SISize
, *TypeName
;
693 FileSystemInfoPtr
= LibFileSystemInfo(Volume
->RootDir
);
694 if (FileSystemInfoPtr
!= NULL
) { // we have filesystem information (size, label)....
695 if ((FileSystemInfoPtr
->VolumeLabel
!= NULL
) && (StrLen(FileSystemInfoPtr
->VolumeLabel
) > 0)) {
696 FoundName
= StrDuplicate(FileSystemInfoPtr
->VolumeLabel
);
699 // Special case: rEFInd HFS+ driver always returns label of "HFS+ volume", so wipe
700 // this so that we can build a new name that includes the size....
701 if ((FoundName
!= NULL
) && (StrCmp(FoundName
, L
"HFS+ volume") == 0) && (Volume
->FSType
== FS_TYPE_HFSPLUS
)) {
702 MyFreePool(FoundName
);
704 } // if rEFInd HFS+ driver suspected
706 if (FoundName
== NULL
) { // filesystem has no name, so use fs type and size
707 FoundName
= AllocateZeroPool(sizeof(CHAR16
) * 256);
708 if (FoundName
!= NULL
) {
709 SISize
= SizeInIEEEUnits(FileSystemInfoPtr
->VolumeSize
);
710 SPrint(FoundName
, 255, L
"%s%s volume", SISize
, FSTypeName(Volume
->FSType
));
712 } // if allocated memory OK
713 } // if (FoundName == NULL)
715 FreePool(FileSystemInfoPtr
);
717 } else { // fs driver not returning info; fall back on our own information....
718 FoundName
= AllocateZeroPool(sizeof(CHAR16
) * 256);
719 if (FoundName
!= NULL
) {
720 TypeName
= FSTypeName(Volume
->FSType
); // NOTE: Don't free TypeName; function returns constant
721 if (StrLen(TypeName
) > 0)
722 SPrint(FoundName
, 255, L
"%s volume", FSTypeName(Volume
->FSType
));
724 SPrint(FoundName
, 255, L
"unknown volume");
725 } // if allocated memory OK
728 // TODO: Above could be improved/extended, in case filesystem name is not found,
730 // - use partition label
731 // - use or add disk/partition number (e.g., "(hd0,2)")
733 // Desperate fallback name....
734 if (FoundName
== NULL
) {
735 FoundName
= StrDuplicate(L
"unknown volume");
738 } // static CHAR16 *GetVolumeName()
740 VOID
ScanVolume(REFIT_VOLUME
*Volume
)
743 EFI_DEVICE_PATH
*DevicePath
, *NextDevicePath
;
744 EFI_DEVICE_PATH
*DiskDevicePath
, *RemainingDevicePath
;
745 EFI_HANDLE WholeDiskHandle
;
750 Volume
->DevicePath
= DuplicateDevicePath(DevicePathFromHandle(Volume
->DeviceHandle
));
752 if (Volume
->DevicePath
!= NULL
) {
753 Print(L
"* %s\n", DevicePathToStr(Volume
->DevicePath
));
755 DumpHex(1, 0, DevicePathSize(Volume
->DevicePath
), Volume
->DevicePath
);
760 Volume
->DiskKind
= DISK_KIND_INTERNAL
; // default
763 Status
= refit_call3_wrapper(BS
->HandleProtocol
, Volume
->DeviceHandle
, &BlockIoProtocol
, (VOID
**) &(Volume
->BlockIO
));
764 if (EFI_ERROR(Status
)) {
765 Volume
->BlockIO
= NULL
;
766 Print(L
"Warning: Can't get BlockIO protocol.\n");
768 if (Volume
->BlockIO
->Media
->BlockSize
== 2048)
769 Volume
->DiskKind
= DISK_KIND_OPTICAL
;
772 // scan for bootcode and MBR table
774 ScanVolumeBootcode(Volume
, &Bootable
);
776 // detect device type
777 DevicePath
= Volume
->DevicePath
;
778 while (DevicePath
!= NULL
&& !IsDevicePathEndType(DevicePath
)) {
779 NextDevicePath
= NextDevicePathNode(DevicePath
);
781 if (DevicePathType(DevicePath
) == MESSAGING_DEVICE_PATH
&&
782 (DevicePathSubType(DevicePath
) == MSG_USB_DP
||
783 DevicePathSubType(DevicePath
) == MSG_USB_CLASS_DP
||
784 DevicePathSubType(DevicePath
) == MSG_1394_DP
||
785 DevicePathSubType(DevicePath
) == MSG_FIBRECHANNEL_DP
))
786 Volume
->DiskKind
= DISK_KIND_EXTERNAL
; // USB/FireWire/FC device -> external
787 if (DevicePathType(DevicePath
) == MEDIA_DEVICE_PATH
&&
788 DevicePathSubType(DevicePath
) == MEDIA_CDROM_DP
) {
789 Volume
->DiskKind
= DISK_KIND_OPTICAL
; // El Torito entry -> optical disk
793 if (DevicePathType(DevicePath
) == MEDIA_DEVICE_PATH
&& DevicePathSubType(DevicePath
) == MEDIA_VENDOR_DP
) {
794 Volume
->IsAppleLegacy
= TRUE
; // legacy BIOS device entry
795 // TODO: also check for Boot Camp GUID
796 Bootable
= FALSE
; // this handle's BlockIO is just an alias for the whole device
799 if (DevicePathType(DevicePath
) == MESSAGING_DEVICE_PATH
) {
800 // make a device path for the whole device
801 PartialLength
= (UINT8
*)NextDevicePath
- (UINT8
*)(Volume
->DevicePath
);
802 DiskDevicePath
= (EFI_DEVICE_PATH
*)AllocatePool(PartialLength
+ sizeof(EFI_DEVICE_PATH
));
803 CopyMem(DiskDevicePath
, Volume
->DevicePath
, PartialLength
);
804 CopyMem((UINT8
*)DiskDevicePath
+ PartialLength
, EndDevicePath
, sizeof(EFI_DEVICE_PATH
));
806 // get the handle for that path
807 RemainingDevicePath
= DiskDevicePath
;
808 Status
= refit_call3_wrapper(BS
->LocateDevicePath
, &BlockIoProtocol
, &RemainingDevicePath
, &WholeDiskHandle
);
809 FreePool(DiskDevicePath
);
811 if (!EFI_ERROR(Status
)) {
812 //Print(L" - original handle: %08x - disk handle: %08x\n", (UINT32)DeviceHandle, (UINT32)WholeDiskHandle);
814 // get the device path for later
815 Status
= refit_call3_wrapper(BS
->HandleProtocol
, WholeDiskHandle
, &DevicePathProtocol
, (VOID
**) &DiskDevicePath
);
816 if (!EFI_ERROR(Status
)) {
817 Volume
->WholeDiskDevicePath
= DuplicateDevicePath(DiskDevicePath
);
820 // look at the BlockIO protocol
821 Status
= refit_call3_wrapper(BS
->HandleProtocol
, WholeDiskHandle
, &BlockIoProtocol
, (VOID
**) &Volume
->WholeDiskBlockIO
);
822 if (!EFI_ERROR(Status
)) {
824 // check the media block size
825 if (Volume
->WholeDiskBlockIO
->Media
->BlockSize
== 2048)
826 Volume
->DiskKind
= DISK_KIND_OPTICAL
;
829 Volume
->WholeDiskBlockIO
= NULL
;
830 //CheckError(Status, L"from HandleProtocol");
833 // CheckError(Status, L"from LocateDevicePath");
836 DevicePath
= NextDevicePath
;
841 if (Volume
->HasBootCode
)
842 Print(L
" Volume considered non-bootable, but boot code is present\n");
844 Volume
->HasBootCode
= FALSE
;
847 // default volume icon based on disk kind
848 ScanVolumeDefaultIcon(Volume
);
850 // open the root directory of the volume
851 Volume
->RootDir
= LibOpenRoot(Volume
->DeviceHandle
);
852 if (Volume
->RootDir
== NULL
) {
853 Volume
->IsReadable
= FALSE
;
856 Volume
->IsReadable
= TRUE
;
859 Volume
->VolName
= GetVolumeName(Volume
);
861 // get custom volume icon if present
862 if (!Volume
->VolBadgeImage
)
863 Volume
->VolBadgeImage
= egLoadIconAnyType(Volume
->RootDir
, L
"", L
".VolumeBadge", 32);
864 if (!Volume
->VolIconImage
)
865 Volume
->VolIconImage
= egLoadIconAnyType(Volume
->RootDir
, L
"", L
".VolumeIcon", 128);
868 static VOID
ScanExtendedPartition(REFIT_VOLUME
*WholeDiskVolume
, MBR_PARTITION_INFO
*MbrEntry
)
871 REFIT_VOLUME
*Volume
;
872 UINT32 ExtBase
, ExtCurrent
, NextExtCurrent
;
874 UINTN LogicalPartitionIndex
= 4;
875 UINT8 SectorBuffer
[512];
877 MBR_PARTITION_INFO
*EMbrTable
;
879 ExtBase
= MbrEntry
->StartLBA
;
881 for (ExtCurrent
= ExtBase
; ExtCurrent
; ExtCurrent
= NextExtCurrent
) {
883 Status
= refit_call5_wrapper(WholeDiskVolume
->BlockIO
->ReadBlocks
,
884 WholeDiskVolume
->BlockIO
,
885 WholeDiskVolume
->BlockIO
->Media
->MediaId
,
886 ExtCurrent
, 512, SectorBuffer
);
887 if (EFI_ERROR(Status
))
889 if (*((UINT16
*)(SectorBuffer
+ 510)) != 0xaa55)
891 EMbrTable
= (MBR_PARTITION_INFO
*)(SectorBuffer
+ 446);
893 // scan logical partitions in this EMBR
895 for (i
= 0; i
< 4; i
++) {
896 if ((EMbrTable
[i
].Flags
!= 0x00 && EMbrTable
[i
].Flags
!= 0x80) ||
897 EMbrTable
[i
].StartLBA
== 0 || EMbrTable
[i
].Size
== 0)
899 if (IS_EXTENDED_PART_TYPE(EMbrTable
[i
].Type
)) {
900 // set next ExtCurrent
901 NextExtCurrent
= ExtBase
+ EMbrTable
[i
].StartLBA
;
905 // found a logical partition
906 Volume
= AllocateZeroPool(sizeof(REFIT_VOLUME
));
907 Volume
->DiskKind
= WholeDiskVolume
->DiskKind
;
908 Volume
->IsMbrPartition
= TRUE
;
909 Volume
->MbrPartitionIndex
= LogicalPartitionIndex
++;
910 Volume
->VolName
= AllocateZeroPool(256 * sizeof(UINT16
));
911 SPrint(Volume
->VolName
, 255, L
"Partition %d", Volume
->MbrPartitionIndex
+ 1);
912 Volume
->BlockIO
= WholeDiskVolume
->BlockIO
;
913 Volume
->BlockIOOffset
= ExtCurrent
+ EMbrTable
[i
].StartLBA
;
914 Volume
->WholeDiskBlockIO
= WholeDiskVolume
->BlockIO
;
917 ScanVolumeBootcode(Volume
, &Bootable
);
919 Volume
->HasBootCode
= FALSE
;
921 ScanVolumeDefaultIcon(Volume
);
923 AddListElement((VOID
***) &Volumes
, &VolumesCount
, Volume
);
928 } /* VOID ScanExtendedPartition() */
930 VOID
ScanVolumes(VOID
)
934 REFIT_VOLUME
*Volume
, *WholeDiskVolume
;
935 MBR_PARTITION_INFO
*MbrTable
;
936 UINTN HandleCount
= 0;
938 UINTN VolumeIndex
, VolumeIndex2
;
939 UINTN PartitionIndex
;
940 UINTN SectorSum
, i
, VolNumber
= 0;
941 UINT8
*SectorBuffer1
, *SectorBuffer2
;
947 // get all filesystem handles
948 Status
= LibLocateHandle(ByProtocol
, &BlockIoProtocol
, NULL
, &HandleCount
, &Handles
);
949 // was: &FileSystemProtocol
950 if (Status
== EFI_NOT_FOUND
) {
951 return; // no filesystems. strange, but true...
953 if (CheckError(Status
, L
"while listing all file systems"))
956 // first pass: collect information about all handles
957 for (HandleIndex
= 0; HandleIndex
< HandleCount
; HandleIndex
++) {
958 Volume
= AllocateZeroPool(sizeof(REFIT_VOLUME
));
959 Volume
->DeviceHandle
= Handles
[HandleIndex
];
961 if (Volume
->IsReadable
)
962 Volume
->VolNumber
= VolNumber
++;
964 Volume
->VolNumber
= VOL_UNREADABLE
;
966 AddListElement((VOID
***) &Volumes
, &VolumesCount
, Volume
);
968 if (Volume
->DeviceHandle
== SelfLoadedImage
->DeviceHandle
)
973 if (SelfVolume
== NULL
)
974 Print(L
"WARNING: SelfVolume not found");
976 // second pass: relate partitions and whole disk devices
977 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
978 Volume
= Volumes
[VolumeIndex
];
979 // check MBR partition table for extended partitions
980 if (Volume
->BlockIO
!= NULL
&& Volume
->WholeDiskBlockIO
!= NULL
&&
981 Volume
->BlockIO
== Volume
->WholeDiskBlockIO
&& Volume
->BlockIOOffset
== 0 &&
982 Volume
->MbrPartitionTable
!= NULL
) {
983 MbrTable
= Volume
->MbrPartitionTable
;
984 for (PartitionIndex
= 0; PartitionIndex
< 4; PartitionIndex
++) {
985 if (IS_EXTENDED_PART_TYPE(MbrTable
[PartitionIndex
].Type
)) {
986 ScanExtendedPartition(Volume
, MbrTable
+ PartitionIndex
);
991 // search for corresponding whole disk volume entry
992 WholeDiskVolume
= NULL
;
993 if (Volume
->BlockIO
!= NULL
&& Volume
->WholeDiskBlockIO
!= NULL
&&
994 Volume
->BlockIO
!= Volume
->WholeDiskBlockIO
) {
995 for (VolumeIndex2
= 0; VolumeIndex2
< VolumesCount
; VolumeIndex2
++) {
996 if (Volumes
[VolumeIndex2
]->BlockIO
== Volume
->WholeDiskBlockIO
&&
997 Volumes
[VolumeIndex2
]->BlockIOOffset
== 0)
998 WholeDiskVolume
= Volumes
[VolumeIndex2
];
1002 if (WholeDiskVolume
!= NULL
&& WholeDiskVolume
->MbrPartitionTable
!= NULL
) {
1003 // check if this volume is one of the partitions in the table
1004 MbrTable
= WholeDiskVolume
->MbrPartitionTable
;
1005 SectorBuffer1
= AllocatePool(512);
1006 SectorBuffer2
= AllocatePool(512);
1007 for (PartitionIndex
= 0; PartitionIndex
< 4; PartitionIndex
++) {
1009 if ((UINT64
)(MbrTable
[PartitionIndex
].Size
) != Volume
->BlockIO
->Media
->LastBlock
+ 1)
1012 // compare boot sector read through offset vs. directly
1013 Status
= refit_call5_wrapper(Volume
->BlockIO
->ReadBlocks
,
1014 Volume
->BlockIO
, Volume
->BlockIO
->Media
->MediaId
,
1015 Volume
->BlockIOOffset
, 512, SectorBuffer1
);
1016 if (EFI_ERROR(Status
))
1018 Status
= refit_call5_wrapper(Volume
->WholeDiskBlockIO
->ReadBlocks
,
1019 Volume
->WholeDiskBlockIO
, Volume
->WholeDiskBlockIO
->Media
->MediaId
,
1020 MbrTable
[PartitionIndex
].StartLBA
, 512, SectorBuffer2
);
1021 if (EFI_ERROR(Status
))
1023 if (CompareMem(SectorBuffer1
, SectorBuffer2
, 512) != 0)
1026 for (i
= 0; i
< 512; i
++)
1027 SectorSum
+= SectorBuffer1
[i
];
1028 if (SectorSum
< 1000)
1031 // TODO: mark entry as non-bootable if it is an extended partition
1033 // now we're reasonably sure the association is correct...
1034 Volume
->IsMbrPartition
= TRUE
;
1035 Volume
->MbrPartitionIndex
= PartitionIndex
;
1036 if (Volume
->VolName
== NULL
) {
1037 Volume
->VolName
= AllocateZeroPool(sizeof(CHAR16
) * 256);
1038 SPrint(Volume
->VolName
, 255, L
"Partition %d", PartitionIndex
+ 1);
1043 MyFreePool(SectorBuffer1
);
1044 MyFreePool(SectorBuffer2
);
1048 } /* VOID ScanVolumes() */
1050 static VOID
UninitVolumes(VOID
)
1052 REFIT_VOLUME
*Volume
;
1055 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
1056 Volume
= Volumes
[VolumeIndex
];
1058 if (Volume
->RootDir
!= NULL
) {
1059 refit_call1_wrapper(Volume
->RootDir
->Close
, Volume
->RootDir
);
1060 Volume
->RootDir
= NULL
;
1063 Volume
->DeviceHandle
= NULL
;
1064 Volume
->BlockIO
= NULL
;
1065 Volume
->WholeDiskBlockIO
= NULL
;
1069 VOID
ReinitVolumes(VOID
)
1072 REFIT_VOLUME
*Volume
;
1074 EFI_DEVICE_PATH
*RemainingDevicePath
;
1075 EFI_HANDLE DeviceHandle
, WholeDiskHandle
;
1077 for (VolumeIndex
= 0; VolumeIndex
< VolumesCount
; VolumeIndex
++) {
1078 Volume
= Volumes
[VolumeIndex
];
1080 if (Volume
->DevicePath
!= NULL
) {
1081 // get the handle for that path
1082 RemainingDevicePath
= Volume
->DevicePath
;
1083 Status
= refit_call3_wrapper(BS
->LocateDevicePath
, &BlockIoProtocol
, &RemainingDevicePath
, &DeviceHandle
);
1085 if (!EFI_ERROR(Status
)) {
1086 Volume
->DeviceHandle
= DeviceHandle
;
1088 // get the root directory
1089 Volume
->RootDir
= LibOpenRoot(Volume
->DeviceHandle
);
1092 CheckError(Status
, L
"from LocateDevicePath");
1095 if (Volume
->WholeDiskDevicePath
!= NULL
) {
1096 // get the handle for that path
1097 RemainingDevicePath
= Volume
->WholeDiskDevicePath
;
1098 Status
= refit_call3_wrapper(BS
->LocateDevicePath
, &BlockIoProtocol
, &RemainingDevicePath
, &WholeDiskHandle
);
1100 if (!EFI_ERROR(Status
)) {
1101 // get the BlockIO protocol
1102 Status
= refit_call3_wrapper(BS
->HandleProtocol
, WholeDiskHandle
, &BlockIoProtocol
, (VOID
**) &Volume
->WholeDiskBlockIO
);
1103 if (EFI_ERROR(Status
)) {
1104 Volume
->WholeDiskBlockIO
= NULL
;
1105 CheckError(Status
, L
"from HandleProtocol");
1108 CheckError(Status
, L
"from LocateDevicePath");
1114 // file and dir functions
1117 BOOLEAN
FileExists(IN EFI_FILE
*BaseDir
, IN CHAR16
*RelativePath
)
1120 EFI_FILE_HANDLE TestFile
;
1122 Status
= refit_call5_wrapper(BaseDir
->Open
, BaseDir
, &TestFile
, RelativePath
, EFI_FILE_MODE_READ
, 0);
1123 if (Status
== EFI_SUCCESS
) {
1124 refit_call1_wrapper(TestFile
->Close
, TestFile
);
1130 EFI_STATUS
DirNextEntry(IN EFI_FILE
*Directory
, IN OUT EFI_FILE_INFO
**DirEntry
, IN UINTN FilterMode
)
1134 UINTN LastBufferSize
, BufferSize
;
1139 // free pointer from last call
1140 if (*DirEntry
!= NULL
) {
1141 FreePool(*DirEntry
);
1145 // read next directory entry
1146 LastBufferSize
= BufferSize
= 256;
1147 Buffer
= AllocatePool(BufferSize
);
1148 for (IterCount
= 0; ; IterCount
++) {
1149 Status
= refit_call3_wrapper(Directory
->Read
, Directory
, &BufferSize
, Buffer
);
1150 if (Status
!= EFI_BUFFER_TOO_SMALL
|| IterCount
>= 4)
1152 if (BufferSize
<= LastBufferSize
) {
1153 Print(L
"FS Driver requests bad buffer size %d (was %d), using %d instead\n", BufferSize
, LastBufferSize
, LastBufferSize
* 2);
1154 BufferSize
= LastBufferSize
* 2;
1157 Print(L
"Reallocating buffer from %d to %d\n", LastBufferSize
, BufferSize
);
1160 Buffer
= EfiReallocatePool(Buffer
, LastBufferSize
, BufferSize
);
1161 LastBufferSize
= BufferSize
;
1163 if (EFI_ERROR(Status
)) {
1169 // check for end of listing
1170 if (BufferSize
== 0) { // end of directory listing
1176 // entry is ready to be returned
1177 *DirEntry
= (EFI_FILE_INFO
*)Buffer
;
1180 if (FilterMode
== 1) { // only return directories
1181 if (((*DirEntry
)->Attribute
& EFI_FILE_DIRECTORY
))
1183 } else if (FilterMode
== 2) { // only return files
1184 if (((*DirEntry
)->Attribute
& EFI_FILE_DIRECTORY
) == 0)
1186 } else // no filter or unknown filter -> return everything
1193 VOID
DirIterOpen(IN EFI_FILE
*BaseDir
, IN CHAR16
*RelativePath OPTIONAL
, OUT REFIT_DIR_ITER
*DirIter
)
1195 if (RelativePath
== NULL
) {
1196 DirIter
->LastStatus
= EFI_SUCCESS
;
1197 DirIter
->DirHandle
= BaseDir
;
1198 DirIter
->CloseDirHandle
= FALSE
;
1200 DirIter
->LastStatus
= refit_call5_wrapper(BaseDir
->Open
, BaseDir
, &(DirIter
->DirHandle
), RelativePath
, EFI_FILE_MODE_READ
, 0);
1201 DirIter
->CloseDirHandle
= EFI_ERROR(DirIter
->LastStatus
) ? FALSE
: TRUE
;
1203 DirIter
->LastFileInfo
= NULL
;
1206 #ifndef __MAKEWITH_GNUEFI
1207 EFI_UNICODE_COLLATION_PROTOCOL
*mUnicodeCollation
= NULL
;
1210 InitializeUnicodeCollationProtocol (VOID
)
1214 if (mUnicodeCollation
!= NULL
) {
1219 // BUGBUG: Proper impelmentation is to locate all Unicode Collation Protocol
1220 // instances first and then select one which support English language.
1221 // Current implementation just pick the first instance.
1223 Status
= gBS
->LocateProtocol (
1224 &gEfiUnicodeCollation2ProtocolGuid
,
1226 (VOID
**) &mUnicodeCollation
1228 if (EFI_ERROR(Status
)) {
1229 Status
= gBS
->LocateProtocol (
1230 &gEfiUnicodeCollationProtocolGuid
,
1232 (VOID
**) &mUnicodeCollation
1240 MetaiMatch (IN CHAR16
*String
, IN CHAR16
*Pattern
)
1242 if (!mUnicodeCollation
) {
1243 InitializeUnicodeCollationProtocol();
1245 if (mUnicodeCollation
)
1246 return mUnicodeCollation
->MetaiMatch (mUnicodeCollation
, String
, Pattern
);
1247 return FALSE
; // Shouldn't happen
1250 static VOID
StrLwr (IN OUT CHAR16
*Str
) {
1251 if (!mUnicodeCollation
) {
1252 InitializeUnicodeCollationProtocol();
1254 if (mUnicodeCollation
)
1255 mUnicodeCollation
->StrLwr (mUnicodeCollation
, Str
);
1260 BOOLEAN
DirIterNext(IN OUT REFIT_DIR_ITER
*DirIter
, IN UINTN FilterMode
, IN CHAR16
*FilePattern OPTIONAL
,
1261 OUT EFI_FILE_INFO
**DirEntry
)
1263 BOOLEAN KeepGoing
= TRUE
;
1267 if (DirIter
->LastFileInfo
!= NULL
) {
1268 FreePool(DirIter
->LastFileInfo
);
1269 DirIter
->LastFileInfo
= NULL
;
1272 if (EFI_ERROR(DirIter
->LastStatus
))
1273 return FALSE
; // stop iteration
1276 DirIter
->LastStatus
= DirNextEntry(DirIter
->DirHandle
, &(DirIter
->LastFileInfo
), FilterMode
);
1277 if (EFI_ERROR(DirIter
->LastStatus
))
1279 if (DirIter
->LastFileInfo
== NULL
) // end of listing
1281 if (FilePattern
!= NULL
) {
1282 if ((DirIter
->LastFileInfo
->Attribute
& EFI_FILE_DIRECTORY
))
1285 while (KeepGoing
&& (OnePattern
= FindCommaDelimited(FilePattern
, i
++)) != NULL
) {
1286 if (MetaiMatch(DirIter
->LastFileInfo
->FileName
, OnePattern
))
1289 // else continue loop
1292 } while (KeepGoing
&& FilePattern
);
1294 *DirEntry
= DirIter
->LastFileInfo
;
1298 EFI_STATUS
DirIterClose(IN OUT REFIT_DIR_ITER
*DirIter
)
1300 if (DirIter
->LastFileInfo
!= NULL
) {
1301 FreePool(DirIter
->LastFileInfo
);
1302 DirIter
->LastFileInfo
= NULL
;
1304 if (DirIter
->CloseDirHandle
)
1305 refit_call1_wrapper(DirIter
->DirHandle
->Close
, DirIter
->DirHandle
);
1306 return DirIter
->LastStatus
;
1310 // file name manipulation
1313 // Returns the filename portion (minus path name) of the
1315 CHAR16
* Basename(IN CHAR16
*Path
)
1323 for (i
= StrLen(Path
); i
> 0; i
--) {
1324 if (Path
[i
-1] == '\\' || Path
[i
-1] == '/') {
1325 FileName
= Path
+ i
;
1334 // Remove the .efi extension from FileName -- for instance, if FileName is
1335 // "fred.efi", returns "fred". If the filename contains no .efi extension,
1336 // returns a copy of the original input.
1337 CHAR16
* StripEfiExtension(CHAR16
*FileName
) {
1339 CHAR16
*Copy
= NULL
;
1341 if ((FileName
!= NULL
) && ((Copy
= StrDuplicate(FileName
)) != NULL
)) {
1342 Length
= StrLen(Copy
);
1343 // Note: Do StriCmp() twice to work around Gigabyte Hybrid EFI case-sensitivity bug....
1344 if ((Length
>= 4) && ((StriCmp(&Copy
[Length
- 4], L
".efi") == 0) || (StriCmp(&Copy
[Length
- 4], L
".EFI") == 0))) {
1345 Copy
[Length
- 4] = 0;
1349 } // CHAR16 * StripExtension()
1352 // memory string search
1355 INTN
FindMem(IN VOID
*Buffer
, IN UINTN BufferLength
, IN VOID
*SearchString
, IN UINTN SearchStringLength
)
1361 BufferLength
-= SearchStringLength
;
1362 for (Offset
= 0; Offset
< BufferLength
; Offset
++, BufferPtr
++) {
1363 if (CompareMem(BufferPtr
, SearchString
, SearchStringLength
) == 0)
1364 return (INTN
)Offset
;
1370 // Performs a case-insensitive search of BigStr for SmallStr.
1371 // Returns TRUE if found, FALSE if not.
1372 BOOLEAN
StriSubCmp(IN CHAR16
*SmallStr
, IN CHAR16
*BigStr
) {
1373 CHAR16
*SmallCopy
, *BigCopy
;
1374 BOOLEAN Found
= FALSE
;
1375 UINTN StartPoint
= 0, NumCompares
= 0, SmallLen
= 0;
1377 if ((SmallStr
!= NULL
) && (BigStr
!= NULL
) && (StrLen(BigStr
) >= StrLen(SmallStr
))) {
1378 SmallCopy
= StrDuplicate(SmallStr
);
1379 BigCopy
= StrDuplicate(BigStr
);
1382 SmallLen
= StrLen(SmallCopy
);
1383 NumCompares
= StrLen(BigCopy
) - SmallLen
+ 1;
1384 while ((!Found
) && (StartPoint
< NumCompares
)) {
1385 Found
= (StrnCmp(SmallCopy
, &BigCopy
[StartPoint
++], SmallLen
) == 0);
1387 MyFreePool(SmallCopy
);
1388 MyFreePool(BigCopy
);
1392 } // BOOLEAN StriSubCmp()
1394 // Merges two strings, creating a new one and returning a pointer to it.
1395 // If AddChar != 0, the specified character is placed between the two original
1396 // strings (unless the first string is NULL or empty). The original input
1397 // string *First is de-allocated and replaced by the new merged string.
1398 // This is similar to StrCat, but safer and more flexible because
1399 // MergeStrings allocates memory that's the correct size for the
1400 // new merged string, so it can take a NULL *First and it cleans
1401 // up the old memory. It should *NOT* be used with a constant
1402 // *First, though....
1403 VOID
MergeStrings(IN OUT CHAR16
**First
, IN CHAR16
*Second
, CHAR16 AddChar
) {
1404 UINTN Length1
= 0, Length2
= 0;
1408 Length1
= StrLen(*First
);
1410 Length2
= StrLen(Second
);
1411 NewString
= AllocatePool(sizeof(CHAR16
) * (Length1
+ Length2
+ 2));
1412 if (NewString
!= NULL
) {
1413 if ((*First
!= NULL
) && (StrLen(*First
) == 0)) {
1417 NewString
[0] = L
'\0';
1418 if (*First
!= NULL
) {
1419 StrCat(NewString
, *First
);
1421 NewString
[Length1
] = AddChar
;
1422 NewString
[Length1
+ 1] = '\0';
1424 } // if (*First != NULL)
1426 StrCat(NewString
, Second
);
1430 Print(L
"Error! Unable to allocate memory in MergeStrings()!\n");
1432 } // static CHAR16* MergeStrings()
1434 // Takes an input pathname (*Path) and returns the part of the filename from
1435 // the final dot onwards, converted to lowercase. If the filename includes
1436 // no dots, or if the input is NULL, returns an empty (but allocated) string.
1437 // The calling function is responsible for freeing the memory associated with
1438 // the return value.
1439 CHAR16
*FindExtension(IN CHAR16
*Path
) {
1441 BOOLEAN Found
= FALSE
, FoundSlash
= FALSE
;
1444 Extension
= AllocateZeroPool(sizeof(CHAR16
));
1447 while ((!Found
) && (!FoundSlash
) && (i
>= 0)) {
1448 if (Path
[i
] == L
'.')
1450 else if ((Path
[i
] == L
'/') || (Path
[i
] == L
'\\'))
1456 MergeStrings(&Extension
, &Path
[i
], 0);
1461 } // CHAR16 *FindExtension
1463 // Takes an input pathname (*Path) and locates the final directory component
1464 // of that name. For instance, if the input path is 'EFI\foo\bar.efi', this
1465 // function returns the string 'foo'.
1466 // Assumes the pathname is separated with backslashes.
1467 CHAR16
*FindLastDirName(IN CHAR16
*Path
) {
1468 UINTN i
, StartOfElement
= 0, EndOfElement
= 0, PathLength
, CopyLength
;
1469 CHAR16
*Found
= NULL
;
1474 PathLength
= StrLen(Path
);
1475 // Find start & end of target element
1476 for (i
= 0; i
< PathLength
; i
++) {
1477 if (Path
[i
] == '\\') {
1478 StartOfElement
= EndOfElement
;
1482 // Extract the target element
1483 if (EndOfElement
> 0) {
1484 while ((StartOfElement
< PathLength
) && (Path
[StartOfElement
] == '\\')) {
1488 if (EndOfElement
>= StartOfElement
) {
1489 CopyLength
= EndOfElement
- StartOfElement
+ 1;
1490 Found
= StrDuplicate(&Path
[StartOfElement
]);
1492 Found
[CopyLength
] = 0;
1493 } // if (EndOfElement >= StartOfElement)
1494 } // if (EndOfElement > 0)
1496 } // CHAR16 *FindLastDirName
1498 // Returns the directory portion of a pathname. For instance,
1499 // if FullPath is 'EFI\foo\bar.efi', this function returns the
1500 // string 'EFI\foo'. The calling function is responsible for
1501 // freeing the returned string's memory.
1502 CHAR16
*FindPath(IN CHAR16
* FullPath
) {
1503 UINTN i
, LastBackslash
= 0;
1504 CHAR16
*PathOnly
= NULL
;
1506 if (FullPath
!= NULL
) {
1507 for (i
= 0; i
< StrLen(FullPath
); i
++) {
1508 if (FullPath
[i
] == '\\')
1511 PathOnly
= StrDuplicate(FullPath
);
1512 PathOnly
[LastBackslash
] = 0;
1517 // Takes an input loadpath, splits it into disk and filename components, finds a matching
1518 // DeviceVolume, and returns that and the filename (*loader).
1519 VOID
FindVolumeAndFilename(IN EFI_DEVICE_PATH
*loadpath
, OUT REFIT_VOLUME
**DeviceVolume
, OUT CHAR16
**loader
) {
1520 CHAR16
*DeviceString
, *VolumeDeviceString
, *Temp
;
1522 BOOLEAN Found
= FALSE
;
1524 MyFreePool(*loader
);
1525 MyFreePool(*DeviceVolume
);
1526 *DeviceVolume
= NULL
;
1527 DeviceString
= DevicePathToStr(loadpath
);
1528 *loader
= SplitDeviceString(DeviceString
);
1530 while ((i
< VolumesCount
) && (!Found
)) {
1531 VolumeDeviceString
= DevicePathToStr(Volumes
[i
]->DevicePath
);
1532 Temp
= SplitDeviceString(VolumeDeviceString
);
1533 if (StriCmp(DeviceString
, VolumeDeviceString
) == 0) {
1535 *DeviceVolume
= Volumes
[i
];
1538 MyFreePool(VolumeDeviceString
);
1542 MyFreePool(DeviceString
);
1543 } // VOID FindVolumeAndFilename()
1545 // Splits a volume/filename string (e.g., "fs0:\EFI\BOOT") into separate
1546 // volume and filename components (e.g., "fs0" and "\EFI\BOOT"), returning
1547 // the filename component in the original *Path variable and the split-off
1548 // volume component in the *VolName variable.
1549 // Returns TRUE if both components are found, FALSE otherwise.
1550 BOOLEAN
SplitVolumeAndFilename(IN OUT CHAR16
**Path
, OUT CHAR16
**VolName
) {
1551 UINTN i
= 0, Length
;
1557 if (*VolName
!= NULL
) {
1558 MyFreePool(*VolName
);
1562 Length
= StrLen(*Path
);
1563 while ((i
< Length
) && ((*Path
)[i
] != L
':')) {
1568 Filename
= StrDuplicate((*Path
) + i
+ 1);
1576 } // BOOLEAN SplitVolumeAndFilename()
1578 // Returns all the digits in the input string, including intervening
1579 // non-digit characters. For instance, if InString is "foo-3.3.4-7.img",
1580 // this function returns "3.3.4-7". If InString contains no digits,
1581 // the return value is NULL.
1582 CHAR16
*FindNumbers(IN CHAR16
*InString
) {
1583 UINTN i
, StartOfElement
, EndOfElement
= 0, InLength
, CopyLength
;
1584 CHAR16
*Found
= NULL
;
1586 if (InString
== NULL
)
1589 InLength
= StartOfElement
= StrLen(InString
);
1590 // Find start & end of target element
1591 for (i
= 0; i
< InLength
; i
++) {
1592 if ((InString
[i
] >= '0') && (InString
[i
] <= '9')) {
1593 if (StartOfElement
> i
)
1595 if (EndOfElement
< i
)
1599 // Extract the target element
1600 if (EndOfElement
> 0) {
1601 if (EndOfElement
>= StartOfElement
) {
1602 CopyLength
= EndOfElement
- StartOfElement
+ 1;
1603 Found
= StrDuplicate(&InString
[StartOfElement
]);
1605 Found
[CopyLength
] = 0;
1606 } // if (EndOfElement >= StartOfElement)
1607 } // if (EndOfElement > 0)
1609 } // CHAR16 *FindNumbers()
1611 // Find the #Index element (numbered from 0) in a comma-delimited string
1613 // Returns the found element, or NULL if Index is out of range or InString
1614 // is NULL. Note that the calling function is responsible for freeing the
1615 // memory associated with the returned string pointer.
1616 CHAR16
*FindCommaDelimited(IN CHAR16
*InString
, IN UINTN Index
) {
1617 UINTN StartPos
= 0, CurPos
= 0;
1618 BOOLEAN Found
= FALSE
;
1619 CHAR16
*FoundString
= NULL
;
1621 if (InString
!= NULL
) {
1622 // After while() loop, StartPos marks start of item #Index
1623 while ((Index
> 0) && (CurPos
< StrLen(InString
))) {
1624 if (InString
[CurPos
] == L
',') {
1626 StartPos
= CurPos
+ 1;
1630 // After while() loop, CurPos is one past the end of the element
1631 while ((CurPos
< StrLen(InString
)) && (!Found
)) {
1632 if (InString
[CurPos
] == L
',')
1638 FoundString
= StrDuplicate(&InString
[StartPos
]);
1639 if (FoundString
!= NULL
)
1640 FoundString
[CurPos
- StartPos
] = 0;
1642 return (FoundString
);
1643 } // CHAR16 *FindCommaDelimited()
1645 // Returns TRUE if SmallString is an element in the comma-delimited List,
1646 // FALSE otherwise. Performs comparison case-insensitively (except on
1647 // buggy EFIs with case-sensitive StriCmp() functions).
1648 BOOLEAN
IsIn(IN CHAR16
*SmallString
, IN CHAR16
*List
) {
1650 BOOLEAN Found
= FALSE
;
1653 if (SmallString
&& List
) {
1654 while (!Found
&& (OneElement
= FindCommaDelimited(List
, i
++))) {
1655 if (StriCmp(OneElement
, SmallString
) == 0)
1662 // Implement FreePool the way it should have been done to begin with, so that
1663 // it doesn't throw an ASSERT message if fed a NULL pointer....
1664 VOID
MyFreePool(IN VOID
*Pointer
) {
1665 if (Pointer
!= NULL
)
1669 static EFI_GUID AppleRemovableMediaGuid
= APPLE_REMOVABLE_MEDIA_PROTOCOL_GUID
;
1671 // Eject all removable media.
1672 // Returns TRUE if any media were ejected, FALSE otherwise.
1673 BOOLEAN
EjectMedia(VOID
) {
1675 UINTN HandleIndex
, HandleCount
= 0, Ejected
= 0;
1676 EFI_HANDLE
*Handles
, Handle
;
1677 APPLE_REMOVABLE_MEDIA_PROTOCOL
*Ejectable
;
1679 Status
= LibLocateHandle(ByProtocol
, &AppleRemovableMediaGuid
, NULL
, &HandleCount
, &Handles
);
1680 if (EFI_ERROR(Status
) || HandleCount
== 0)
1681 return (FALSE
); // probably not an Apple system
1683 for (HandleIndex
= 0; HandleIndex
< HandleCount
; HandleIndex
++) {
1684 Handle
= Handles
[HandleIndex
];
1685 Status
= refit_call3_wrapper(BS
->HandleProtocol
, Handle
, &AppleRemovableMediaGuid
, (VOID
**) &Ejectable
);
1686 if (EFI_ERROR(Status
))
1688 Status
= refit_call1_wrapper(Ejectable
->Eject
, Ejectable
);
1689 if (!EFI_ERROR(Status
))
1692 MyFreePool(Handles
);
1693 return (Ejected
> 0);
1694 } // VOID EjectMedia()
1697 // Return the GUID as a string, suitable for display to the user. Note that the calling
1698 // function is responsible for freeing the allocated memory.
1699 CHAR16
* GuidAsString(EFI_GUID
*GuidData
) {
1702 TheString
= AllocateZeroPool(42 * sizeof(CHAR16
));
1703 if (TheString
!= 0) {
1704 SPrint (TheString
, 82, L
"%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x",
1705 (UINTN
)GuidData
->Data1
, (UINTN
)GuidData
->Data2
, (UINTN
)GuidData
->Data3
,
1706 (UINTN
)GuidData
->Data4
[0], (UINTN
)GuidData
->Data4
[1], (UINTN
)GuidData
->Data4
[2],
1707 (UINTN
)GuidData
->Data4
[3], (UINTN
)GuidData
->Data4
[4], (UINTN
)GuidData
->Data4
[5],
1708 (UINTN
)GuidData
->Data4
[6], (UINTN
)GuidData
->Data4
[7]);
1711 } // GuidAsString(EFI_GUID *GuidData)