]> code.delx.au - refind/blob - refind/lib.c
Can now specify complete paths, optionally including volumes, in
[refind] / refind / lib.c
1 /*
2 * refind/lib.c
3 * General library functions
4 *
5 * Copyright (c) 2006-2009 Christoph Pfisterer
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 *
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
18 * distribution.
19 *
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.
23 *
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.
35 */
36 /*
37 * Modifications copyright (c) 2012-2013 Roderick W. Smith
38 *
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.
42 *
43 */
44
45 #include "global.h"
46 #include "lib.h"
47 #include "icns.h"
48 #include "screen.h"
49 #include "../include/refit_call_wrapper.h"
50 #include "../include/RemovableMedia.h"
51 //#include "../include/UsbMass.h"
52
53 #ifdef __MAKEWITH_GNUEFI
54 #define EfiReallocatePool ReallocatePool
55 #else
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}}
63 };
64
65 //#define EndDevicePath DevicePath
66 #endif
67
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"
77
78 // variables
79
80 EFI_HANDLE SelfImageHandle;
81 EFI_LOADED_IMAGE *SelfLoadedImage;
82 EFI_FILE *SelfRootDir;
83 EFI_FILE *SelfDir;
84 CHAR16 *SelfDirPath;
85
86 REFIT_VOLUME *SelfVolume = NULL;
87 REFIT_VOLUME **Volumes = NULL;
88 UINTN VolumesCount = 0;
89
90 // Maximum size for disk sectors
91 #define SECTOR_SIZE 4096
92
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 */
96
97
98 // functions
99
100 static EFI_STATUS FinishInitRefitLib(VOID);
101
102 static VOID UninitVolumes(VOID);
103
104 //
105 // self recognition stuff
106 //
107
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
115 // isn't present.
116 VOID CleanUpPathNameSlashes(IN OUT CHAR16 *PathName) {
117 CHAR16 *NewName;
118 UINTN i, Length, FinalChar = 0;
119 BOOLEAN LastWasSlash = FALSE;
120
121 Length = StrLen(PathName);
122 NewName = AllocateZeroPool(sizeof(CHAR16) * (Length + 2));
123 if (NewName != NULL) {
124 for (i = 0; i < StrLen(PathName); i++) {
125 if ((PathName[i] == L'/') || (PathName[i] == L'\\')) {
126 if ((!LastWasSlash) && (FinalChar != 0))
127 NewName[FinalChar++] = L'\\';
128 LastWasSlash = TRUE;
129 } else {
130 NewName[FinalChar++] = PathName[i];
131 LastWasSlash = FALSE;
132 } // if/else
133 } // for
134 NewName[FinalChar] = 0;
135 if ((FinalChar > 0) && (NewName[FinalChar - 1] == L'\\'))
136 NewName[--FinalChar] = 0;
137 if (FinalChar == 0) {
138 NewName[0] = L'\\';
139 NewName[1] = 0;
140 }
141 // Copy the transformed name back....
142 StrCpy(PathName, NewName);
143 FreePool(NewName);
144 } // if allocation OK
145 } // CleanUpPathNameSlashes()
146
147 // Splits an EFI device path into device and filename components. For instance, if InString is
148 // PciRoot(0x0)/Pci(0x1f,0x2)/Ata(Secondary,Master,0x0)/HD(2,GPT,8314ae90-ada3-48e9-9c3b-09a88f80d921,0x96028,0xfa000)/\bzImage-3.5.1.efi,
149 // this function will truncate that input to
150 // PciRoot(0x0)/Pci(0x1f,0x2)/Ata(Secondary,Master,0x0)/HD(2,GPT,8314ae90-ada3-48e9-9c3b-09a88f80d921,0x96028,0xfa000)
151 // and return bzImage-3.5.1.efi as its return value.
152 // It does this by searching for the last ")" character in InString, copying everything
153 // after that string (after some cleanup) as the return value, and truncating the original
154 // input value.
155 // If InString contains no ")" character, this function leaves the original input string
156 // unmodified and also returns that string. If InString is NULL, this function returns NULL.
157 static CHAR16* SplitDeviceString(IN OUT CHAR16 *InString) {
158 INTN i;
159 CHAR16 *FileName = NULL;
160 BOOLEAN Found = FALSE;
161
162 if (InString != NULL) {
163 i = StrLen(InString) - 1;
164 while ((i >= 0) && (!Found)) {
165 if (InString[i] == L')') {
166 Found = TRUE;
167 FileName = StrDuplicate(&InString[i + 1]);
168 CleanUpPathNameSlashes(FileName);
169 InString[i + 1] = '\0';
170 } // if
171 i--;
172 } // while
173 if (FileName == NULL)
174 FileName = StrDuplicate(InString);
175 } // if
176 return FileName;
177 } // static CHAR16* SplitDeviceString()
178
179 EFI_STATUS InitRefitLib(IN EFI_HANDLE ImageHandle)
180 {
181 EFI_STATUS Status;
182 CHAR16 *DevicePathAsString, *Temp;
183
184 SelfImageHandle = ImageHandle;
185 Status = refit_call3_wrapper(BS->HandleProtocol, SelfImageHandle, &LoadedImageProtocol, (VOID **) &SelfLoadedImage);
186 if (CheckFatalError(Status, L"while getting a LoadedImageProtocol handle"))
187 return EFI_LOAD_ERROR;
188
189 // find the current directory
190 DevicePathAsString = DevicePathToStr(SelfLoadedImage->FilePath);
191 CleanUpPathNameSlashes(DevicePathAsString);
192 MyFreePool(SelfDirPath);
193 Temp = FindPath(DevicePathAsString);
194 SelfDirPath = SplitDeviceString(Temp);
195 MyFreePool(DevicePathAsString);
196 MyFreePool(Temp);
197
198 return FinishInitRefitLib();
199 }
200
201 // called before running external programs to close open file handles
202 VOID UninitRefitLib(VOID)
203 {
204 // This piece of code was made to correspond to weirdness in ReinitRefitLib().
205 // See the comment on it there.
206 if(SelfRootDir == SelfVolume->RootDir)
207 SelfRootDir=0;
208
209 UninitVolumes();
210
211 if (SelfDir != NULL) {
212 refit_call1_wrapper(SelfDir->Close, SelfDir);
213 SelfDir = NULL;
214 }
215
216 if (SelfRootDir != NULL) {
217 refit_call1_wrapper(SelfRootDir->Close, SelfRootDir);
218 SelfRootDir = NULL;
219 }
220 }
221
222 // called after running external programs to re-open file handles
223 EFI_STATUS ReinitRefitLib(VOID)
224 {
225 ReinitVolumes();
226
227 if ((ST->Hdr.Revision >> 16) == 1) {
228 // Below two lines were in rEFIt, but seem to cause system crashes or
229 // reboots when launching OSes after returning from programs on most
230 // systems. OTOH, my Mac Mini produces errors about "(re)opening our
231 // installation volume" (see the next function) when returning from
232 // programs when these two lines are removed, and it often crashes
233 // when returning from a program or when launching a second program
234 // with these lines removed. Therefore, the preceding if() statement
235 // executes these lines only on EFIs with a major version number of 1
236 // (which Macs have) and not with 2 (which UEFI PCs have). My selection
237 // of hardware on which to test is limited, though, so this may be the
238 // wrong test, or there may be a better way to fix this problem.
239 // TODO: Figure out cause of above weirdness and fix it more
240 // reliably!
241 if (SelfVolume != NULL && SelfVolume->RootDir != NULL)
242 SelfRootDir = SelfVolume->RootDir;
243 } // if
244
245 return FinishInitRefitLib();
246 }
247
248 static EFI_STATUS FinishInitRefitLib(VOID)
249 {
250 EFI_STATUS Status;
251
252 if (SelfRootDir == NULL) {
253 SelfRootDir = LibOpenRoot(SelfLoadedImage->DeviceHandle);
254 if (SelfRootDir == NULL) {
255 CheckError(EFI_LOAD_ERROR, L"while (re)opening our installation volume");
256 return EFI_LOAD_ERROR;
257 }
258 }
259
260 Status = refit_call5_wrapper(SelfRootDir->Open, SelfRootDir, &SelfDir, SelfDirPath, EFI_FILE_MODE_READ, 0);
261 if (CheckFatalError(Status, L"while opening our installation directory"))
262 return EFI_LOAD_ERROR;
263
264 return EFI_SUCCESS;
265 }
266
267 //
268 // list functions
269 //
270
271 VOID CreateList(OUT VOID ***ListPtr, OUT UINTN *ElementCount, IN UINTN InitialElementCount)
272 {
273 UINTN AllocateCount;
274
275 *ElementCount = InitialElementCount;
276 if (*ElementCount > 0) {
277 AllocateCount = (*ElementCount + 7) & ~7; // next multiple of 8
278 *ListPtr = AllocatePool(sizeof(VOID *) * AllocateCount);
279 } else {
280 *ListPtr = NULL;
281 }
282 }
283
284 VOID AddListElement(IN OUT VOID ***ListPtr, IN OUT UINTN *ElementCount, IN VOID *NewElement)
285 {
286 UINTN AllocateCount;
287
288 if ((*ElementCount & 7) == 0) {
289 AllocateCount = *ElementCount + 8;
290 if (*ElementCount == 0)
291 *ListPtr = AllocatePool(sizeof(VOID *) * AllocateCount);
292 else
293 *ListPtr = EfiReallocatePool(*ListPtr, sizeof(VOID *) * (*ElementCount), sizeof(VOID *) * AllocateCount);
294 }
295 (*ListPtr)[*ElementCount] = NewElement;
296 (*ElementCount)++;
297 } /* VOID AddListElement() */
298
299 VOID FreeList(IN OUT VOID ***ListPtr, IN OUT UINTN *ElementCount)
300 {
301 UINTN i;
302
303 if ((*ElementCount > 0) && (**ListPtr != NULL)) {
304 for (i = 0; i < *ElementCount; i++) {
305 // TODO: call a user-provided routine for each element here
306 MyFreePool((*ListPtr)[i]);
307 }
308 MyFreePool(*ListPtr);
309 }
310 } // VOID FreeList()
311
312 //
313 // firmware device path discovery
314 //
315
316 static UINT8 LegacyLoaderMediaPathData[] = {
317 0x04, 0x06, 0x14, 0x00, 0xEB, 0x85, 0x05, 0x2B,
318 0xB8, 0xD8, 0xA9, 0x49, 0x8B, 0x8C, 0xE2, 0x1B,
319 0x01, 0xAE, 0xF2, 0xB7, 0x7F, 0xFF, 0x04, 0x00,
320 };
321 static EFI_DEVICE_PATH *LegacyLoaderMediaPath = (EFI_DEVICE_PATH *)LegacyLoaderMediaPathData;
322
323 VOID ExtractLegacyLoaderPaths(EFI_DEVICE_PATH **PathList, UINTN MaxPaths, EFI_DEVICE_PATH **HardcodedPathList)
324 {
325 EFI_STATUS Status;
326 UINTN HandleCount = 0;
327 UINTN HandleIndex, HardcodedIndex;
328 EFI_HANDLE *Handles;
329 EFI_HANDLE Handle;
330 UINTN PathCount = 0;
331 UINTN PathIndex;
332 EFI_LOADED_IMAGE *LoadedImage;
333 EFI_DEVICE_PATH *DevicePath;
334 BOOLEAN Seen;
335
336 MaxPaths--; // leave space for the terminating NULL pointer
337
338 // get all LoadedImage handles
339 Status = LibLocateHandle(ByProtocol, &LoadedImageProtocol, NULL, &HandleCount, &Handles);
340 if (CheckError(Status, L"while listing LoadedImage handles")) {
341 if (HardcodedPathList) {
342 for (HardcodedIndex = 0; HardcodedPathList[HardcodedIndex] && PathCount < MaxPaths; HardcodedIndex++)
343 PathList[PathCount++] = HardcodedPathList[HardcodedIndex];
344 }
345 PathList[PathCount] = NULL;
346 return;
347 }
348 for (HandleIndex = 0; HandleIndex < HandleCount && PathCount < MaxPaths; HandleIndex++) {
349 Handle = Handles[HandleIndex];
350
351 Status = refit_call3_wrapper(BS->HandleProtocol, Handle, &LoadedImageProtocol, (VOID **) &LoadedImage);
352 if (EFI_ERROR(Status))
353 continue; // This can only happen if the firmware scewed up, ignore it.
354
355 Status = refit_call3_wrapper(BS->HandleProtocol, LoadedImage->DeviceHandle, &DevicePathProtocol, (VOID **) &DevicePath);
356 if (EFI_ERROR(Status))
357 continue; // This happens, ignore it.
358
359 // Only grab memory range nodes
360 if (DevicePathType(DevicePath) != HARDWARE_DEVICE_PATH || DevicePathSubType(DevicePath) != HW_MEMMAP_DP)
361 continue;
362
363 // Check if we have this device path in the list already
364 // WARNING: This assumes the first node in the device path is unique!
365 Seen = FALSE;
366 for (PathIndex = 0; PathIndex < PathCount; PathIndex++) {
367 if (DevicePathNodeLength(DevicePath) != DevicePathNodeLength(PathList[PathIndex]))
368 continue;
369 if (CompareMem(DevicePath, PathList[PathIndex], DevicePathNodeLength(DevicePath)) == 0) {
370 Seen = TRUE;
371 break;
372 }
373 }
374 if (Seen)
375 continue;
376
377 PathList[PathCount++] = AppendDevicePath(DevicePath, LegacyLoaderMediaPath);
378 }
379 MyFreePool(Handles);
380
381 if (HardcodedPathList) {
382 for (HardcodedIndex = 0; HardcodedPathList[HardcodedIndex] && PathCount < MaxPaths; HardcodedIndex++)
383 PathList[PathCount++] = HardcodedPathList[HardcodedIndex];
384 }
385 PathList[PathCount] = NULL;
386 }
387
388 //
389 // volume functions
390 //
391
392 // Return a pointer to a string containing a filesystem type name. If the
393 // filesystem type is unknown, a blank (but non-null) string is returned.
394 // The returned variable is a constant that should NOT be freed.
395 static CHAR16 *FSTypeName(IN UINT32 TypeCode) {
396 CHAR16 *retval = NULL;
397
398 switch (TypeCode) {
399 case FS_TYPE_FAT:
400 retval = L" FAT";
401 break;
402 case FS_TYPE_HFSPLUS:
403 retval = L" HFS+";
404 break;
405 case FS_TYPE_EXT2:
406 retval = L" ext2";
407 break;
408 case FS_TYPE_EXT3:
409 retval = L" ext3";
410 break;
411 case FS_TYPE_EXT4:
412 retval = L" ext4";
413 break;
414 case FS_TYPE_REISERFS:
415 retval = L" ReiserFS";
416 break;
417 case FS_TYPE_BTRFS:
418 retval = L" Btrfs";
419 break;
420 case FS_TYPE_ISO9660:
421 retval = L" ISO-9660";
422 break;
423 default:
424 retval = L"";
425 break;
426 } // switch
427 return retval;
428 } // CHAR16 *FSTypeName()
429
430 // Identify the filesystem type and record the filesystem's UUID/serial number,
431 // if possible. Expects a Buffer containing the first few (normally 4096) bytes
432 // of the filesystem. Sets the filesystem type code in Volume->FSType and the
433 // UUID/serial number in Volume->VolUuid. Note that the UUID value is recognized
434 // differently for each filesystem, and is currently supported only for
435 // ext2/3/4fs and ReiserFS. If the UUID can't be determined, it's set to 0. Also, the UUID
436 // is just read directly into memory; it is *NOT* valid when displayed by
437 // GuidAsString() or used in other GUID/UUID-manipulating functions. (As I
438 // write, it's being used merely to detect partitions that are part of a
439 // RAID 1 array.)
440 static VOID SetFilesystemData(IN UINT8 *Buffer, IN UINTN BufferSize, IN OUT REFIT_VOLUME *Volume) {
441 UINT32 *Ext2Incompat, *Ext2Compat;
442 UINT16 *Magic16;
443 char *MagicString;
444
445 if ((Buffer != NULL) && (Volume != NULL)) {
446 SetMem(&(Volume->VolUuid), sizeof(EFI_GUID), 0);
447 Volume->FSType = FS_TYPE_UNKNOWN;
448
449 if (BufferSize >= 512) {
450 Magic16 = (UINT16*) (Buffer + 510);
451 if (*Magic16 == FAT_MAGIC) {
452 Volume->FSType = FS_TYPE_FAT;
453 return;
454 } // if
455 } // search for FAT magic
456
457 if (BufferSize >= (1024 + 100)) {
458 Magic16 = (UINT16*) (Buffer + 1024 + 56);
459 if (*Magic16 == EXT2_SUPER_MAGIC) { // ext2/3/4
460 Ext2Compat = (UINT32*) (Buffer + 1024 + 92);
461 Ext2Incompat = (UINT32*) (Buffer + 1024 + 96);
462 if ((*Ext2Incompat & 0x0040) || (*Ext2Incompat & 0x0200)) { // check for extents or flex_bg
463 Volume->FSType = FS_TYPE_EXT4;
464 } else if (*Ext2Compat & 0x0004) { // check for journal
465 Volume->FSType = FS_TYPE_EXT3;
466 } else { // none of these features; presume it's ext2...
467 Volume->FSType = FS_TYPE_EXT2;
468 }
469 CopyMem(&(Volume->VolUuid), Buffer + 1024 + 104, sizeof(EFI_GUID));
470 return;
471 }
472 } // search for ext2/3/4 magic
473
474 if (BufferSize >= (65536 + 100)) {
475 MagicString = (char*) (Buffer + 65536 + 52);
476 if ((CompareMem(MagicString, REISERFS_SUPER_MAGIC_STRING, 8) == 0) ||
477 (CompareMem(MagicString, REISER2FS_SUPER_MAGIC_STRING, 9) == 0) ||
478 (CompareMem(MagicString, REISER2FS_JR_SUPER_MAGIC_STRING, 9) == 0)) {
479 Volume->FSType = FS_TYPE_REISERFS;
480 CopyMem(&(Volume->VolUuid), Buffer + 65536 + 84, sizeof(EFI_GUID));
481 return;
482 } // if
483 } // search for ReiserFS magic
484
485 if (BufferSize >= (65536 + 64 + 8)) {
486 MagicString = (char*) (Buffer + 65536 + 64);
487 if (CompareMem(MagicString, BTRFS_SIGNATURE, 8) == 0) {
488 Volume->FSType = FS_TYPE_BTRFS;
489 return;
490 } // if
491 } // search for Btrfs magic
492
493 if (BufferSize >= (1024 + 2)) {
494 Magic16 = (UINT16*) (Buffer + 1024);
495 if ((*Magic16 == HFSPLUS_MAGIC1) || (*Magic16 == HFSPLUS_MAGIC2)) {
496 Volume->FSType = FS_TYPE_HFSPLUS;
497 return;
498 }
499 } // search for HFS+ magic
500 } // if (Buffer != NULL)
501
502 } // UINT32 SetFilesystemData()
503
504 static VOID ScanVolumeBootcode(REFIT_VOLUME *Volume, BOOLEAN *Bootable)
505 {
506 EFI_STATUS Status;
507 UINT8 Buffer[SAMPLE_SIZE];
508 UINTN i;
509 MBR_PARTITION_INFO *MbrTable;
510 BOOLEAN MbrTableFound;
511
512 Volume->HasBootCode = FALSE;
513 Volume->OSIconName = NULL;
514 Volume->OSName = NULL;
515 *Bootable = FALSE;
516
517 if (Volume->BlockIO == NULL)
518 return;
519 if (Volume->BlockIO->Media->BlockSize > SAMPLE_SIZE)
520 return; // our buffer is too small...
521
522 // look at the boot sector (this is used for both hard disks and El Torito images!)
523 Status = refit_call5_wrapper(Volume->BlockIO->ReadBlocks,
524 Volume->BlockIO, Volume->BlockIO->Media->MediaId,
525 Volume->BlockIOOffset, SAMPLE_SIZE, Buffer);
526 if (!EFI_ERROR(Status)) {
527
528 SetFilesystemData(Buffer, SAMPLE_SIZE, Volume);
529 if ((*((UINT16 *)(Buffer + 510)) == 0xaa55 && Buffer[0] != 0) && (FindMem(Buffer, 512, "EXFAT", 5) == -1)) {
530 *Bootable = TRUE;
531 Volume->HasBootCode = TRUE;
532 }
533
534 // detect specific boot codes
535 if (CompareMem(Buffer + 2, "LILO", 4) == 0 ||
536 CompareMem(Buffer + 6, "LILO", 4) == 0 ||
537 CompareMem(Buffer + 3, "SYSLINUX", 8) == 0 ||
538 FindMem(Buffer, SECTOR_SIZE, "ISOLINUX", 8) >= 0) {
539 Volume->HasBootCode = TRUE;
540 Volume->OSIconName = L"linux";
541 Volume->OSName = L"Linux";
542
543 } else if (FindMem(Buffer, 512, "Geom\0Hard Disk\0Read\0 Error", 26) >= 0) { // GRUB
544 Volume->HasBootCode = TRUE;
545 Volume->OSIconName = L"grub,linux";
546 Volume->OSName = L"Linux";
547
548 // // Below doesn't produce a bootable entry, so commented out for the moment....
549 // // GRUB in BIOS boot partition:
550 // } else if (FindMem(Buffer, 512, "Geom\0Read\0 Error", 16) >= 0) {
551 // Volume->HasBootCode = TRUE;
552 // Volume->OSIconName = L"grub,linux";
553 // Volume->OSName = L"Linux";
554 // Volume->VolName = L"BIOS Boot Partition";
555 // *Bootable = TRUE;
556
557 } else if ((*((UINT32 *)(Buffer + 502)) == 0 &&
558 *((UINT32 *)(Buffer + 506)) == 50000 &&
559 *((UINT16 *)(Buffer + 510)) == 0xaa55) ||
560 FindMem(Buffer, SECTOR_SIZE, "Starting the BTX loader", 23) >= 0) {
561 Volume->HasBootCode = TRUE;
562 Volume->OSIconName = L"freebsd";
563 Volume->OSName = L"FreeBSD";
564
565 } else if (FindMem(Buffer, 512, "!Loading", 8) >= 0 ||
566 FindMem(Buffer, SECTOR_SIZE, "/cdboot\0/CDBOOT\0", 16) >= 0) {
567 Volume->HasBootCode = TRUE;
568 Volume->OSIconName = L"openbsd";
569 Volume->OSName = L"OpenBSD";
570
571 } else if (FindMem(Buffer, 512, "Not a bootxx image", 18) >= 0 ||
572 *((UINT32 *)(Buffer + 1028)) == 0x7886b6d1) {
573 Volume->HasBootCode = TRUE;
574 Volume->OSIconName = L"netbsd";
575 Volume->OSName = L"NetBSD";
576
577 } else if (FindMem(Buffer, SECTOR_SIZE, "NTLDR", 5) >= 0) {
578 Volume->HasBootCode = TRUE;
579 Volume->OSIconName = L"win";
580 Volume->OSName = L"Windows";
581
582 } else if (FindMem(Buffer, SECTOR_SIZE, "BOOTMGR", 7) >= 0) {
583 Volume->HasBootCode = TRUE;
584 Volume->OSIconName = L"winvista,win";
585 Volume->OSName = L"Windows";
586
587 } else if (FindMem(Buffer, 512, "CPUBOOT SYS", 11) >= 0 ||
588 FindMem(Buffer, 512, "KERNEL SYS", 11) >= 0) {
589 Volume->HasBootCode = TRUE;
590 Volume->OSIconName = L"freedos";
591 Volume->OSName = L"FreeDOS";
592
593 } else if (FindMem(Buffer, 512, "OS2LDR", 6) >= 0 ||
594 FindMem(Buffer, 512, "OS2BOOT", 7) >= 0) {
595 Volume->HasBootCode = TRUE;
596 Volume->OSIconName = L"ecomstation";
597 Volume->OSName = L"eComStation";
598
599 } else if (FindMem(Buffer, 512, "Be Boot Loader", 14) >= 0) {
600 Volume->HasBootCode = TRUE;
601 Volume->OSIconName = L"beos";
602 Volume->OSName = L"BeOS";
603
604 } else if (FindMem(Buffer, 512, "yT Boot Loader", 14) >= 0) {
605 Volume->HasBootCode = TRUE;
606 Volume->OSIconName = L"zeta,beos";
607 Volume->OSName = L"ZETA";
608
609 } else if (FindMem(Buffer, 512, "\x04" "beos\x06" "system\x05" "zbeos", 18) >= 0 ||
610 FindMem(Buffer, 512, "\x06" "system\x0c" "haiku_loader", 20) >= 0) {
611 Volume->HasBootCode = TRUE;
612 Volume->OSIconName = L"haiku,beos";
613 Volume->OSName = L"Haiku";
614
615 }
616
617 // NOTE: If you add an operating system with a name that starts with 'W' or 'L', you
618 // need to fix AddLegacyEntry in main.c.
619
620 #if REFIT_DEBUG > 0
621 Print(L" Result of bootcode detection: %s %s (%s)\n",
622 Volume->HasBootCode ? L"bootable" : L"non-bootable",
623 Volume->OSName, Volume->OSIconName);
624 #endif
625
626 // dummy FAT boot sector (created by OS X's newfs_msdos)
627 if (FindMem(Buffer, 512, "Non-system disk", 15) >= 0)
628 Volume->HasBootCode = FALSE;
629
630 // dummy FAT boot sector (created by Linux's mkdosfs)
631 if (FindMem(Buffer, 512, "This is not a bootable disk", 27) >= 0)
632 Volume->HasBootCode = FALSE;
633
634 // dummy FAT boot sector (created by Windows)
635 if (FindMem(Buffer, 512, "Press any key to restart", 24) >= 0)
636 Volume->HasBootCode = FALSE;
637
638 // check for MBR partition table
639 if (*((UINT16 *)(Buffer + 510)) == 0xaa55) {
640 MbrTableFound = FALSE;
641 MbrTable = (MBR_PARTITION_INFO *)(Buffer + 446);
642 for (i = 0; i < 4; i++)
643 if (MbrTable[i].StartLBA && MbrTable[i].Size)
644 MbrTableFound = TRUE;
645 for (i = 0; i < 4; i++)
646 if (MbrTable[i].Flags != 0x00 && MbrTable[i].Flags != 0x80)
647 MbrTableFound = FALSE;
648 if (MbrTableFound) {
649 Volume->MbrPartitionTable = AllocatePool(4 * 16);
650 CopyMem(Volume->MbrPartitionTable, MbrTable, 4 * 16);
651 }
652 }
653
654 } else {
655 #if REFIT_DEBUG > 0
656 CheckError(Status, L"while reading boot sector");
657 #endif
658 }
659 } /* VOID ScanVolumeBootcode() */
660
661 // Set default volume badge icon based on /.VolumeBadge.{icns|png} file or disk kind
662 VOID SetVolumeBadgeIcon(REFIT_VOLUME *Volume)
663 {
664 if (Volume->VolBadgeImage == NULL) {
665 Volume->VolBadgeImage = egLoadIconAnyType(Volume->RootDir, L"", L".VolumeBadge", 128);
666 }
667
668 if (Volume->VolBadgeImage == NULL) {
669 switch (Volume->DiskKind) {
670 case DISK_KIND_INTERNAL:
671 Volume->VolBadgeImage = BuiltinIcon(BUILTIN_ICON_VOL_INTERNAL);
672 break;
673 case DISK_KIND_EXTERNAL:
674 Volume->VolBadgeImage = BuiltinIcon(BUILTIN_ICON_VOL_EXTERNAL);
675 break;
676 case DISK_KIND_OPTICAL:
677 Volume->VolBadgeImage = BuiltinIcon(BUILTIN_ICON_VOL_OPTICAL);
678 break;
679 } // switch()
680 }
681 } // VOID SetVolumeBadgeIcon()
682
683 // Return a string representing the input size in IEEE-1541 units.
684 // The calling function is responsible for freeing the allocated memory.
685 static CHAR16 *SizeInIEEEUnits(UINT64 SizeInBytes) {
686 UINT64 SizeInIeee;
687 UINTN Index = 0, NumPrefixes;
688 CHAR16 *Units, *Prefixes = L" KMGTPEZ";
689 CHAR16 *TheValue;
690
691 TheValue = AllocateZeroPool(sizeof(CHAR16) * 256);
692 if (TheValue != NULL) {
693 NumPrefixes = StrLen(Prefixes);
694 SizeInIeee = SizeInBytes;
695 while ((SizeInIeee > 1024) && (Index < (NumPrefixes - 1))) {
696 Index++;
697 SizeInIeee /= 1024;
698 } // while
699 if (Prefixes[Index] == ' ') {
700 Units = StrDuplicate(L"-byte");
701 } else {
702 Units = StrDuplicate(L" iB");
703 Units[1] = Prefixes[Index];
704 } // if/else
705 SPrint(TheValue, 255, L"%ld%s", SizeInIeee, Units);
706 } // if
707 return TheValue;
708 } // CHAR16 *SizeInSIUnits()
709
710 // Return a name for the volume. Ideally this should be the label for the
711 // filesystem it contains, but this function falls back to describing the
712 // filesystem by size (200 MiB, etc.) and/or type (ext2, HFS+, etc.), if
713 // this information can be extracted.
714 // The calling function is responsible for freeing the memory allocated
715 // for the name string.
716 static CHAR16 *GetVolumeName(IN REFIT_VOLUME *Volume) {
717 EFI_FILE_SYSTEM_INFO *FileSystemInfoPtr;
718 CHAR16 *FoundName = NULL;
719 CHAR16 *SISize, *TypeName;
720
721 FileSystemInfoPtr = LibFileSystemInfo(Volume->RootDir);
722 if (FileSystemInfoPtr != NULL) { // we have filesystem information (size, label)....
723 if ((FileSystemInfoPtr->VolumeLabel != NULL) && (StrLen(FileSystemInfoPtr->VolumeLabel) > 0)) {
724 FoundName = StrDuplicate(FileSystemInfoPtr->VolumeLabel);
725 }
726
727 // Special case: rEFInd HFS+ driver always returns label of "HFS+ volume", so wipe
728 // this so that we can build a new name that includes the size....
729 if ((FoundName != NULL) && (StrCmp(FoundName, L"HFS+ volume") == 0) && (Volume->FSType == FS_TYPE_HFSPLUS)) {
730 MyFreePool(FoundName);
731 FoundName = NULL;
732 } // if rEFInd HFS+ driver suspected
733
734 if (FoundName == NULL) { // filesystem has no name, so use fs type and size
735 FoundName = AllocateZeroPool(sizeof(CHAR16) * 256);
736 if (FoundName != NULL) {
737 SISize = SizeInIEEEUnits(FileSystemInfoPtr->VolumeSize);
738 SPrint(FoundName, 255, L"%s%s volume", SISize, FSTypeName(Volume->FSType));
739 MyFreePool(SISize);
740 } // if allocated memory OK
741 } // if (FoundName == NULL)
742
743 FreePool(FileSystemInfoPtr);
744
745 } else { // fs driver not returning info; fall back on our own information....
746 FoundName = AllocateZeroPool(sizeof(CHAR16) * 256);
747 if (FoundName != NULL) {
748 TypeName = FSTypeName(Volume->FSType); // NOTE: Don't free TypeName; function returns constant
749 if (StrLen(TypeName) > 0)
750 SPrint(FoundName, 255, L"%s volume", FSTypeName(Volume->FSType));
751 else
752 SPrint(FoundName, 255, L"unknown volume");
753 } // if allocated memory OK
754 } // if
755
756 // TODO: Above could be improved/extended, in case filesystem name is not found,
757 // such as:
758 // - use partition label
759 // - use or add disk/partition number (e.g., "(hd0,2)")
760
761 // Desperate fallback name....
762 if (FoundName == NULL) {
763 FoundName = StrDuplicate(L"unknown volume");
764 }
765 return FoundName;
766 } // static CHAR16 *GetVolumeName()
767
768 VOID ScanVolume(REFIT_VOLUME *Volume)
769 {
770 EFI_STATUS Status;
771 EFI_DEVICE_PATH *DevicePath, *NextDevicePath;
772 EFI_DEVICE_PATH *DiskDevicePath, *RemainingDevicePath;
773 EFI_HANDLE WholeDiskHandle;
774 UINTN PartialLength;
775 BOOLEAN Bootable;
776
777 // get device path
778 Volume->DevicePath = DuplicateDevicePath(DevicePathFromHandle(Volume->DeviceHandle));
779 #if REFIT_DEBUG > 0
780 if (Volume->DevicePath != NULL) {
781 Print(L"* %s\n", DevicePathToStr(Volume->DevicePath));
782 #if REFIT_DEBUG >= 2
783 DumpHex(1, 0, DevicePathSize(Volume->DevicePath), Volume->DevicePath);
784 #endif
785 }
786 #endif
787
788 Volume->DiskKind = DISK_KIND_INTERNAL; // default
789
790 // get block i/o
791 Status = refit_call3_wrapper(BS->HandleProtocol, Volume->DeviceHandle, &BlockIoProtocol, (VOID **) &(Volume->BlockIO));
792 if (EFI_ERROR(Status)) {
793 Volume->BlockIO = NULL;
794 Print(L"Warning: Can't get BlockIO protocol.\n");
795 } else {
796 if (Volume->BlockIO->Media->BlockSize == 2048)
797 Volume->DiskKind = DISK_KIND_OPTICAL;
798 }
799
800 // scan for bootcode and MBR table
801 Bootable = FALSE;
802 ScanVolumeBootcode(Volume, &Bootable);
803
804 // detect device type
805 DevicePath = Volume->DevicePath;
806 while (DevicePath != NULL && !IsDevicePathEndType(DevicePath)) {
807 NextDevicePath = NextDevicePathNode(DevicePath);
808
809 if (DevicePathType(DevicePath) == MESSAGING_DEVICE_PATH &&
810 (DevicePathSubType(DevicePath) == MSG_USB_DP ||
811 DevicePathSubType(DevicePath) == MSG_USB_CLASS_DP ||
812 DevicePathSubType(DevicePath) == MSG_1394_DP ||
813 DevicePathSubType(DevicePath) == MSG_FIBRECHANNEL_DP))
814 Volume->DiskKind = DISK_KIND_EXTERNAL; // USB/FireWire/FC device -> external
815 if (DevicePathType(DevicePath) == MEDIA_DEVICE_PATH &&
816 DevicePathSubType(DevicePath) == MEDIA_CDROM_DP) {
817 Volume->DiskKind = DISK_KIND_OPTICAL; // El Torito entry -> optical disk
818 Bootable = TRUE;
819 }
820
821 if (DevicePathType(DevicePath) == MEDIA_DEVICE_PATH && DevicePathSubType(DevicePath) == MEDIA_VENDOR_DP) {
822 Volume->IsAppleLegacy = TRUE; // legacy BIOS device entry
823 // TODO: also check for Boot Camp GUID
824 Bootable = FALSE; // this handle's BlockIO is just an alias for the whole device
825 }
826
827 if (DevicePathType(DevicePath) == MESSAGING_DEVICE_PATH) {
828 // make a device path for the whole device
829 PartialLength = (UINT8 *)NextDevicePath - (UINT8 *)(Volume->DevicePath);
830 DiskDevicePath = (EFI_DEVICE_PATH *)AllocatePool(PartialLength + sizeof(EFI_DEVICE_PATH));
831 CopyMem(DiskDevicePath, Volume->DevicePath, PartialLength);
832 CopyMem((UINT8 *)DiskDevicePath + PartialLength, EndDevicePath, sizeof(EFI_DEVICE_PATH));
833
834 // get the handle for that path
835 RemainingDevicePath = DiskDevicePath;
836 Status = refit_call3_wrapper(BS->LocateDevicePath, &BlockIoProtocol, &RemainingDevicePath, &WholeDiskHandle);
837 FreePool(DiskDevicePath);
838
839 if (!EFI_ERROR(Status)) {
840 //Print(L" - original handle: %08x - disk handle: %08x\n", (UINT32)DeviceHandle, (UINT32)WholeDiskHandle);
841
842 // get the device path for later
843 Status = refit_call3_wrapper(BS->HandleProtocol, WholeDiskHandle, &DevicePathProtocol, (VOID **) &DiskDevicePath);
844 if (!EFI_ERROR(Status)) {
845 Volume->WholeDiskDevicePath = DuplicateDevicePath(DiskDevicePath);
846 }
847
848 // look at the BlockIO protocol
849 Status = refit_call3_wrapper(BS->HandleProtocol, WholeDiskHandle, &BlockIoProtocol, (VOID **) &Volume->WholeDiskBlockIO);
850 if (!EFI_ERROR(Status)) {
851
852 // check the media block size
853 if (Volume->WholeDiskBlockIO->Media->BlockSize == 2048)
854 Volume->DiskKind = DISK_KIND_OPTICAL;
855
856 } else {
857 Volume->WholeDiskBlockIO = NULL;
858 //CheckError(Status, L"from HandleProtocol");
859 }
860 } //else
861 // CheckError(Status, L"from LocateDevicePath");
862 }
863
864 DevicePath = NextDevicePath;
865 } // while
866
867 if (!Bootable) {
868 #if REFIT_DEBUG > 0
869 if (Volume->HasBootCode)
870 Print(L" Volume considered non-bootable, but boot code is present\n");
871 #endif
872 Volume->HasBootCode = FALSE;
873 }
874
875 // open the root directory of the volume
876 Volume->RootDir = LibOpenRoot(Volume->DeviceHandle);
877
878 // Set volume icon based on .VolumeBadge icon or disk kind
879 SetVolumeBadgeIcon(Volume);
880
881 if (Volume->RootDir == NULL) {
882 Volume->IsReadable = FALSE;
883 return;
884 } else {
885 Volume->IsReadable = TRUE;
886 }
887
888 Volume->VolName = GetVolumeName(Volume);
889
890 // get custom volume icons if present
891 if (!Volume->VolIconImage)
892 Volume->VolIconImage = egLoadIconAnyType(Volume->RootDir, L"", L".VolumeIcon", 128);
893 } // ScanVolume()
894
895 static VOID ScanExtendedPartition(REFIT_VOLUME *WholeDiskVolume, MBR_PARTITION_INFO *MbrEntry)
896 {
897 EFI_STATUS Status;
898 REFIT_VOLUME *Volume;
899 UINT32 ExtBase, ExtCurrent, NextExtCurrent;
900 UINTN i;
901 UINTN LogicalPartitionIndex = 4;
902 UINT8 SectorBuffer[512];
903 BOOLEAN Bootable;
904 MBR_PARTITION_INFO *EMbrTable;
905
906 ExtBase = MbrEntry->StartLBA;
907
908 for (ExtCurrent = ExtBase; ExtCurrent; ExtCurrent = NextExtCurrent) {
909 // read current EMBR
910 Status = refit_call5_wrapper(WholeDiskVolume->BlockIO->ReadBlocks,
911 WholeDiskVolume->BlockIO,
912 WholeDiskVolume->BlockIO->Media->MediaId,
913 ExtCurrent, 512, SectorBuffer);
914 if (EFI_ERROR(Status))
915 break;
916 if (*((UINT16 *)(SectorBuffer + 510)) != 0xaa55)
917 break;
918 EMbrTable = (MBR_PARTITION_INFO *)(SectorBuffer + 446);
919
920 // scan logical partitions in this EMBR
921 NextExtCurrent = 0;
922 for (i = 0; i < 4; i++) {
923 if ((EMbrTable[i].Flags != 0x00 && EMbrTable[i].Flags != 0x80) ||
924 EMbrTable[i].StartLBA == 0 || EMbrTable[i].Size == 0)
925 break;
926 if (IS_EXTENDED_PART_TYPE(EMbrTable[i].Type)) {
927 // set next ExtCurrent
928 NextExtCurrent = ExtBase + EMbrTable[i].StartLBA;
929 break;
930 } else {
931
932 // found a logical partition
933 Volume = AllocateZeroPool(sizeof(REFIT_VOLUME));
934 Volume->DiskKind = WholeDiskVolume->DiskKind;
935 Volume->IsMbrPartition = TRUE;
936 Volume->MbrPartitionIndex = LogicalPartitionIndex++;
937 Volume->VolName = AllocateZeroPool(256 * sizeof(UINT16));
938 SPrint(Volume->VolName, 255, L"Partition %d", Volume->MbrPartitionIndex + 1);
939 Volume->BlockIO = WholeDiskVolume->BlockIO;
940 Volume->BlockIOOffset = ExtCurrent + EMbrTable[i].StartLBA;
941 Volume->WholeDiskBlockIO = WholeDiskVolume->BlockIO;
942
943 Bootable = FALSE;
944 ScanVolumeBootcode(Volume, &Bootable);
945 if (!Bootable)
946 Volume->HasBootCode = FALSE;
947
948 SetVolumeBadgeIcon(Volume);
949
950 AddListElement((VOID ***) &Volumes, &VolumesCount, Volume);
951
952 }
953 }
954 }
955 } /* VOID ScanExtendedPartition() */
956
957 VOID ScanVolumes(VOID)
958 {
959 EFI_STATUS Status;
960 EFI_HANDLE *Handles;
961 REFIT_VOLUME *Volume, *WholeDiskVolume;
962 MBR_PARTITION_INFO *MbrTable;
963 UINTN HandleCount = 0;
964 UINTN HandleIndex;
965 UINTN VolumeIndex, VolumeIndex2;
966 UINTN PartitionIndex;
967 UINTN SectorSum, i, VolNumber = 0;
968 UINT8 *SectorBuffer1, *SectorBuffer2;
969 EFI_GUID *UuidList;
970 EFI_GUID NullUuid = { 00000000, 0000, 0000, {0000, 0000, 0000, 0000} };
971
972 MyFreePool(Volumes);
973 Volumes = NULL;
974 VolumesCount = 0;
975
976 // get all filesystem handles
977 Status = LibLocateHandle(ByProtocol, &BlockIoProtocol, NULL, &HandleCount, &Handles);
978 UuidList = AllocateZeroPool(sizeof(EFI_GUID) * HandleCount);
979 // was: &FileSystemProtocol
980 if (Status == EFI_NOT_FOUND) {
981 return; // no filesystems. strange, but true...
982 }
983 if (CheckError(Status, L"while listing all file systems"))
984 return;
985
986 // first pass: collect information about all handles
987 for (HandleIndex = 0; HandleIndex < HandleCount; HandleIndex++) {
988 Volume = AllocateZeroPool(sizeof(REFIT_VOLUME));
989 Volume->DeviceHandle = Handles[HandleIndex];
990 ScanVolume(Volume);
991 if (UuidList) {
992 UuidList[HandleIndex] = Volume->VolUuid;
993 for (i = 0; i < HandleIndex; i++) {
994 if ((CompareMem(&(Volume->VolUuid), &(UuidList[i]), sizeof(EFI_GUID)) == 0) &&
995 (CompareMem(&(Volume->VolUuid), &NullUuid, sizeof(EFI_GUID)) != 0)) { // Duplicate filesystem UUID
996 Volume->IsReadable = FALSE;
997 } // if
998 } // for
999 } // if
1000 if (Volume->IsReadable)
1001 Volume->VolNumber = VolNumber++;
1002 else
1003 Volume->VolNumber = VOL_UNREADABLE;
1004
1005 AddListElement((VOID ***) &Volumes, &VolumesCount, Volume);
1006
1007 if (Volume->DeviceHandle == SelfLoadedImage->DeviceHandle)
1008 SelfVolume = Volume;
1009 }
1010 MyFreePool(Handles);
1011
1012 if (SelfVolume == NULL)
1013 Print(L"WARNING: SelfVolume not found");
1014
1015 // second pass: relate partitions and whole disk devices
1016 for (VolumeIndex = 0; VolumeIndex < VolumesCount; VolumeIndex++) {
1017 Volume = Volumes[VolumeIndex];
1018 // check MBR partition table for extended partitions
1019 if (Volume->BlockIO != NULL && Volume->WholeDiskBlockIO != NULL &&
1020 Volume->BlockIO == Volume->WholeDiskBlockIO && Volume->BlockIOOffset == 0 &&
1021 Volume->MbrPartitionTable != NULL) {
1022 MbrTable = Volume->MbrPartitionTable;
1023 for (PartitionIndex = 0; PartitionIndex < 4; PartitionIndex++) {
1024 if (IS_EXTENDED_PART_TYPE(MbrTable[PartitionIndex].Type)) {
1025 ScanExtendedPartition(Volume, MbrTable + PartitionIndex);
1026 }
1027 }
1028 }
1029
1030 // search for corresponding whole disk volume entry
1031 WholeDiskVolume = NULL;
1032 if (Volume->BlockIO != NULL && Volume->WholeDiskBlockIO != NULL &&
1033 Volume->BlockIO != Volume->WholeDiskBlockIO) {
1034 for (VolumeIndex2 = 0; VolumeIndex2 < VolumesCount; VolumeIndex2++) {
1035 if (Volumes[VolumeIndex2]->BlockIO == Volume->WholeDiskBlockIO &&
1036 Volumes[VolumeIndex2]->BlockIOOffset == 0)
1037 WholeDiskVolume = Volumes[VolumeIndex2];
1038 }
1039 }
1040
1041 if (WholeDiskVolume != NULL && WholeDiskVolume->MbrPartitionTable != NULL) {
1042 // check if this volume is one of the partitions in the table
1043 MbrTable = WholeDiskVolume->MbrPartitionTable;
1044 SectorBuffer1 = AllocatePool(512);
1045 SectorBuffer2 = AllocatePool(512);
1046 for (PartitionIndex = 0; PartitionIndex < 4; PartitionIndex++) {
1047 // check size
1048 if ((UINT64)(MbrTable[PartitionIndex].Size) != Volume->BlockIO->Media->LastBlock + 1)
1049 continue;
1050
1051 // compare boot sector read through offset vs. directly
1052 Status = refit_call5_wrapper(Volume->BlockIO->ReadBlocks,
1053 Volume->BlockIO, Volume->BlockIO->Media->MediaId,
1054 Volume->BlockIOOffset, 512, SectorBuffer1);
1055 if (EFI_ERROR(Status))
1056 break;
1057 Status = refit_call5_wrapper(Volume->WholeDiskBlockIO->ReadBlocks,
1058 Volume->WholeDiskBlockIO, Volume->WholeDiskBlockIO->Media->MediaId,
1059 MbrTable[PartitionIndex].StartLBA, 512, SectorBuffer2);
1060 if (EFI_ERROR(Status))
1061 break;
1062 if (CompareMem(SectorBuffer1, SectorBuffer2, 512) != 0)
1063 continue;
1064 SectorSum = 0;
1065 for (i = 0; i < 512; i++)
1066 SectorSum += SectorBuffer1[i];
1067 if (SectorSum < 1000)
1068 continue;
1069
1070 // TODO: mark entry as non-bootable if it is an extended partition
1071
1072 // now we're reasonably sure the association is correct...
1073 Volume->IsMbrPartition = TRUE;
1074 Volume->MbrPartitionIndex = PartitionIndex;
1075 if (Volume->VolName == NULL) {
1076 Volume->VolName = AllocateZeroPool(sizeof(CHAR16) * 256);
1077 SPrint(Volume->VolName, 255, L"Partition %d", PartitionIndex + 1);
1078 }
1079 break;
1080 }
1081
1082 MyFreePool(SectorBuffer1);
1083 MyFreePool(SectorBuffer2);
1084 }
1085
1086 } // for
1087 } /* VOID ScanVolumes() */
1088
1089 static VOID UninitVolumes(VOID)
1090 {
1091 REFIT_VOLUME *Volume;
1092 UINTN VolumeIndex;
1093
1094 for (VolumeIndex = 0; VolumeIndex < VolumesCount; VolumeIndex++) {
1095 Volume = Volumes[VolumeIndex];
1096
1097 if (Volume->RootDir != NULL) {
1098 refit_call1_wrapper(Volume->RootDir->Close, Volume->RootDir);
1099 Volume->RootDir = NULL;
1100 }
1101
1102 Volume->DeviceHandle = NULL;
1103 Volume->BlockIO = NULL;
1104 Volume->WholeDiskBlockIO = NULL;
1105 }
1106 }
1107
1108 VOID ReinitVolumes(VOID)
1109 {
1110 EFI_STATUS Status;
1111 REFIT_VOLUME *Volume;
1112 UINTN VolumeIndex;
1113 EFI_DEVICE_PATH *RemainingDevicePath;
1114 EFI_HANDLE DeviceHandle, WholeDiskHandle;
1115
1116 for (VolumeIndex = 0; VolumeIndex < VolumesCount; VolumeIndex++) {
1117 Volume = Volumes[VolumeIndex];
1118
1119 if (Volume->DevicePath != NULL) {
1120 // get the handle for that path
1121 RemainingDevicePath = Volume->DevicePath;
1122 Status = refit_call3_wrapper(BS->LocateDevicePath, &BlockIoProtocol, &RemainingDevicePath, &DeviceHandle);
1123
1124 if (!EFI_ERROR(Status)) {
1125 Volume->DeviceHandle = DeviceHandle;
1126
1127 // get the root directory
1128 Volume->RootDir = LibOpenRoot(Volume->DeviceHandle);
1129
1130 } else
1131 CheckError(Status, L"from LocateDevicePath");
1132 }
1133
1134 if (Volume->WholeDiskDevicePath != NULL) {
1135 // get the handle for that path
1136 RemainingDevicePath = Volume->WholeDiskDevicePath;
1137 Status = refit_call3_wrapper(BS->LocateDevicePath, &BlockIoProtocol, &RemainingDevicePath, &WholeDiskHandle);
1138
1139 if (!EFI_ERROR(Status)) {
1140 // get the BlockIO protocol
1141 Status = refit_call3_wrapper(BS->HandleProtocol, WholeDiskHandle, &BlockIoProtocol, (VOID **) &Volume->WholeDiskBlockIO);
1142 if (EFI_ERROR(Status)) {
1143 Volume->WholeDiskBlockIO = NULL;
1144 CheckError(Status, L"from HandleProtocol");
1145 }
1146 } else
1147 CheckError(Status, L"from LocateDevicePath");
1148 }
1149 }
1150 }
1151
1152 //
1153 // file and dir functions
1154 //
1155
1156 BOOLEAN FileExists(IN EFI_FILE *BaseDir, IN CHAR16 *RelativePath)
1157 {
1158 EFI_STATUS Status;
1159 EFI_FILE_HANDLE TestFile;
1160
1161 Status = refit_call5_wrapper(BaseDir->Open, BaseDir, &TestFile, RelativePath, EFI_FILE_MODE_READ, 0);
1162 if (Status == EFI_SUCCESS) {
1163 refit_call1_wrapper(TestFile->Close, TestFile);
1164 return TRUE;
1165 }
1166 return FALSE;
1167 }
1168
1169 EFI_STATUS DirNextEntry(IN EFI_FILE *Directory, IN OUT EFI_FILE_INFO **DirEntry, IN UINTN FilterMode)
1170 {
1171 EFI_STATUS Status;
1172 VOID *Buffer;
1173 UINTN LastBufferSize, BufferSize;
1174 INTN IterCount;
1175
1176 for (;;) {
1177
1178 // free pointer from last call
1179 if (*DirEntry != NULL) {
1180 FreePool(*DirEntry);
1181 *DirEntry = NULL;
1182 }
1183
1184 // read next directory entry
1185 LastBufferSize = BufferSize = 256;
1186 Buffer = AllocatePool(BufferSize);
1187 for (IterCount = 0; ; IterCount++) {
1188 Status = refit_call3_wrapper(Directory->Read, Directory, &BufferSize, Buffer);
1189 if (Status != EFI_BUFFER_TOO_SMALL || IterCount >= 4)
1190 break;
1191 if (BufferSize <= LastBufferSize) {
1192 Print(L"FS Driver requests bad buffer size %d (was %d), using %d instead\n", BufferSize, LastBufferSize, LastBufferSize * 2);
1193 BufferSize = LastBufferSize * 2;
1194 #if REFIT_DEBUG > 0
1195 } else {
1196 Print(L"Reallocating buffer from %d to %d\n", LastBufferSize, BufferSize);
1197 #endif
1198 }
1199 Buffer = EfiReallocatePool(Buffer, LastBufferSize, BufferSize);
1200 LastBufferSize = BufferSize;
1201 }
1202 if (EFI_ERROR(Status)) {
1203 MyFreePool(Buffer);
1204 Buffer = NULL;
1205 break;
1206 }
1207
1208 // check for end of listing
1209 if (BufferSize == 0) { // end of directory listing
1210 MyFreePool(Buffer);
1211 Buffer = NULL;
1212 break;
1213 }
1214
1215 // entry is ready to be returned
1216 *DirEntry = (EFI_FILE_INFO *)Buffer;
1217
1218 // filter results
1219 if (FilterMode == 1) { // only return directories
1220 if (((*DirEntry)->Attribute & EFI_FILE_DIRECTORY))
1221 break;
1222 } else if (FilterMode == 2) { // only return files
1223 if (((*DirEntry)->Attribute & EFI_FILE_DIRECTORY) == 0)
1224 break;
1225 } else // no filter or unknown filter -> return everything
1226 break;
1227
1228 }
1229 return Status;
1230 }
1231
1232 VOID DirIterOpen(IN EFI_FILE *BaseDir, IN CHAR16 *RelativePath OPTIONAL, OUT REFIT_DIR_ITER *DirIter)
1233 {
1234 if (RelativePath == NULL) {
1235 DirIter->LastStatus = EFI_SUCCESS;
1236 DirIter->DirHandle = BaseDir;
1237 DirIter->CloseDirHandle = FALSE;
1238 } else {
1239 DirIter->LastStatus = refit_call5_wrapper(BaseDir->Open, BaseDir, &(DirIter->DirHandle), RelativePath, EFI_FILE_MODE_READ, 0);
1240 DirIter->CloseDirHandle = EFI_ERROR(DirIter->LastStatus) ? FALSE : TRUE;
1241 }
1242 DirIter->LastFileInfo = NULL;
1243 }
1244
1245 #ifndef __MAKEWITH_GNUEFI
1246 EFI_UNICODE_COLLATION_PROTOCOL *mUnicodeCollation = NULL;
1247
1248 static EFI_STATUS
1249 InitializeUnicodeCollationProtocol (VOID)
1250 {
1251 EFI_STATUS Status;
1252
1253 if (mUnicodeCollation != NULL) {
1254 return EFI_SUCCESS;
1255 }
1256
1257 //
1258 // BUGBUG: Proper impelmentation is to locate all Unicode Collation Protocol
1259 // instances first and then select one which support English language.
1260 // Current implementation just pick the first instance.
1261 //
1262 Status = gBS->LocateProtocol (
1263 &gEfiUnicodeCollation2ProtocolGuid,
1264 NULL,
1265 (VOID **) &mUnicodeCollation
1266 );
1267 if (EFI_ERROR(Status)) {
1268 Status = gBS->LocateProtocol (
1269 &gEfiUnicodeCollationProtocolGuid,
1270 NULL,
1271 (VOID **) &mUnicodeCollation
1272 );
1273
1274 }
1275 return Status;
1276 }
1277
1278 static BOOLEAN
1279 MetaiMatch (IN CHAR16 *String, IN CHAR16 *Pattern)
1280 {
1281 if (!mUnicodeCollation) {
1282 InitializeUnicodeCollationProtocol();
1283 }
1284 if (mUnicodeCollation)
1285 return mUnicodeCollation->MetaiMatch (mUnicodeCollation, String, Pattern);
1286 return FALSE; // Shouldn't happen
1287 }
1288
1289 static VOID StrLwr (IN OUT CHAR16 *Str) {
1290 if (!mUnicodeCollation) {
1291 InitializeUnicodeCollationProtocol();
1292 }
1293 if (mUnicodeCollation)
1294 mUnicodeCollation->StrLwr (mUnicodeCollation, Str);
1295 }
1296
1297 #endif
1298
1299 BOOLEAN DirIterNext(IN OUT REFIT_DIR_ITER *DirIter, IN UINTN FilterMode, IN CHAR16 *FilePattern OPTIONAL,
1300 OUT EFI_FILE_INFO **DirEntry)
1301 {
1302 BOOLEAN KeepGoing = TRUE;
1303 UINTN i;
1304 CHAR16 *OnePattern;
1305
1306 if (DirIter->LastFileInfo != NULL) {
1307 FreePool(DirIter->LastFileInfo);
1308 DirIter->LastFileInfo = NULL;
1309 }
1310
1311 if (EFI_ERROR(DirIter->LastStatus))
1312 return FALSE; // stop iteration
1313
1314 do {
1315 DirIter->LastStatus = DirNextEntry(DirIter->DirHandle, &(DirIter->LastFileInfo), FilterMode);
1316 if (EFI_ERROR(DirIter->LastStatus))
1317 return FALSE;
1318 if (DirIter->LastFileInfo == NULL) // end of listing
1319 return FALSE;
1320 if (FilePattern != NULL) {
1321 if ((DirIter->LastFileInfo->Attribute & EFI_FILE_DIRECTORY))
1322 KeepGoing = FALSE;
1323 i = 0;
1324 while (KeepGoing && (OnePattern = FindCommaDelimited(FilePattern, i++)) != NULL) {
1325 if (MetaiMatch(DirIter->LastFileInfo->FileName, OnePattern))
1326 KeepGoing = FALSE;
1327 } // while
1328 // else continue loop
1329 } else
1330 break;
1331 } while (KeepGoing && FilePattern);
1332
1333 *DirEntry = DirIter->LastFileInfo;
1334 return TRUE;
1335 }
1336
1337 EFI_STATUS DirIterClose(IN OUT REFIT_DIR_ITER *DirIter)
1338 {
1339 if (DirIter->LastFileInfo != NULL) {
1340 FreePool(DirIter->LastFileInfo);
1341 DirIter->LastFileInfo = NULL;
1342 }
1343 if (DirIter->CloseDirHandle)
1344 refit_call1_wrapper(DirIter->DirHandle->Close, DirIter->DirHandle);
1345 return DirIter->LastStatus;
1346 }
1347
1348 //
1349 // file name manipulation
1350 //
1351
1352 // Returns the filename portion (minus path name) of the
1353 // specified file
1354 CHAR16 * Basename(IN CHAR16 *Path)
1355 {
1356 CHAR16 *FileName;
1357 UINTN i;
1358
1359 FileName = Path;
1360
1361 if (Path != NULL) {
1362 for (i = StrLen(Path); i > 0; i--) {
1363 if (Path[i-1] == '\\' || Path[i-1] == '/') {
1364 FileName = Path + i;
1365 break;
1366 }
1367 }
1368 }
1369
1370 return FileName;
1371 }
1372
1373 // Remove the .efi extension from FileName -- for instance, if FileName is
1374 // "fred.efi", returns "fred". If the filename contains no .efi extension,
1375 // returns a copy of the original input.
1376 CHAR16 * StripEfiExtension(CHAR16 *FileName) {
1377 UINTN Length;
1378 CHAR16 *Copy = NULL;
1379
1380 if ((FileName != NULL) && ((Copy = StrDuplicate(FileName)) != NULL)) {
1381 Length = StrLen(Copy);
1382 // Note: Do StriCmp() twice to work around Gigabyte Hybrid EFI case-sensitivity bug....
1383 if ((Length >= 4) && ((StriCmp(&Copy[Length - 4], L".efi") == 0) || (StriCmp(&Copy[Length - 4], L".EFI") == 0))) {
1384 Copy[Length - 4] = 0;
1385 } // if
1386 } // if
1387 return Copy;
1388 } // CHAR16 * StripExtension()
1389
1390 //
1391 // memory string search
1392 //
1393
1394 INTN FindMem(IN VOID *Buffer, IN UINTN BufferLength, IN VOID *SearchString, IN UINTN SearchStringLength)
1395 {
1396 UINT8 *BufferPtr;
1397 UINTN Offset;
1398
1399 BufferPtr = Buffer;
1400 BufferLength -= SearchStringLength;
1401 for (Offset = 0; Offset < BufferLength; Offset++, BufferPtr++) {
1402 if (CompareMem(BufferPtr, SearchString, SearchStringLength) == 0)
1403 return (INTN)Offset;
1404 }
1405
1406 return -1;
1407 }
1408
1409 // Performs a case-insensitive search of BigStr for SmallStr.
1410 // Returns TRUE if found, FALSE if not.
1411 BOOLEAN StriSubCmp(IN CHAR16 *SmallStr, IN CHAR16 *BigStr) {
1412 CHAR16 *SmallCopy, *BigCopy;
1413 BOOLEAN Found = FALSE;
1414 UINTN StartPoint = 0, NumCompares = 0, SmallLen = 0;
1415
1416 if ((SmallStr != NULL) && (BigStr != NULL) && (StrLen(BigStr) >= StrLen(SmallStr))) {
1417 SmallCopy = StrDuplicate(SmallStr);
1418 BigCopy = StrDuplicate(BigStr);
1419 StrLwr(SmallCopy);
1420 StrLwr(BigCopy);
1421 SmallLen = StrLen(SmallCopy);
1422 NumCompares = StrLen(BigCopy) - SmallLen + 1;
1423 while ((!Found) && (StartPoint < NumCompares)) {
1424 Found = (StrnCmp(SmallCopy, &BigCopy[StartPoint++], SmallLen) == 0);
1425 } // while
1426 MyFreePool(SmallCopy);
1427 MyFreePool(BigCopy);
1428 } // if
1429
1430 return (Found);
1431 } // BOOLEAN StriSubCmp()
1432
1433 // Merges two strings, creating a new one and returning a pointer to it.
1434 // If AddChar != 0, the specified character is placed between the two original
1435 // strings (unless the first string is NULL or empty). The original input
1436 // string *First is de-allocated and replaced by the new merged string.
1437 // This is similar to StrCat, but safer and more flexible because
1438 // MergeStrings allocates memory that's the correct size for the
1439 // new merged string, so it can take a NULL *First and it cleans
1440 // up the old memory. It should *NOT* be used with a constant
1441 // *First, though....
1442 VOID MergeStrings(IN OUT CHAR16 **First, IN CHAR16 *Second, CHAR16 AddChar) {
1443 UINTN Length1 = 0, Length2 = 0;
1444 CHAR16* NewString;
1445
1446 if (*First != NULL)
1447 Length1 = StrLen(*First);
1448 if (Second != NULL)
1449 Length2 = StrLen(Second);
1450 NewString = AllocatePool(sizeof(CHAR16) * (Length1 + Length2 + 2));
1451 if (NewString != NULL) {
1452 if ((*First != NULL) && (StrLen(*First) == 0)) {
1453 MyFreePool(*First);
1454 *First = NULL;
1455 }
1456 NewString[0] = L'\0';
1457 if (*First != NULL) {
1458 StrCat(NewString, *First);
1459 if (AddChar) {
1460 NewString[Length1] = AddChar;
1461 NewString[Length1 + 1] = '\0';
1462 } // if (AddChar)
1463 } // if (*First != NULL)
1464 if (Second != NULL)
1465 StrCat(NewString, Second);
1466 MyFreePool(*First);
1467 *First = NewString;
1468 } else {
1469 Print(L"Error! Unable to allocate memory in MergeStrings()!\n");
1470 } // if/else
1471 } // static CHAR16* MergeStrings()
1472
1473 // Takes an input pathname (*Path) and returns the part of the filename from
1474 // the final dot onwards, converted to lowercase. If the filename includes
1475 // no dots, or if the input is NULL, returns an empty (but allocated) string.
1476 // The calling function is responsible for freeing the memory associated with
1477 // the return value.
1478 CHAR16 *FindExtension(IN CHAR16 *Path) {
1479 CHAR16 *Extension;
1480 BOOLEAN Found = FALSE, FoundSlash = FALSE;
1481 INTN i;
1482
1483 Extension = AllocateZeroPool(sizeof(CHAR16));
1484 if (Path) {
1485 i = StrLen(Path);
1486 while ((!Found) && (!FoundSlash) && (i >= 0)) {
1487 if (Path[i] == L'.')
1488 Found = TRUE;
1489 else if ((Path[i] == L'/') || (Path[i] == L'\\'))
1490 FoundSlash = TRUE;
1491 if (!Found)
1492 i--;
1493 } // while
1494 if (Found) {
1495 MergeStrings(&Extension, &Path[i], 0);
1496 StrLwr(Extension);
1497 } // if (Found)
1498 } // if
1499 return (Extension);
1500 } // CHAR16 *FindExtension
1501
1502 // Takes an input pathname (*Path) and locates the final directory component
1503 // of that name. For instance, if the input path is 'EFI\foo\bar.efi', this
1504 // function returns the string 'foo'.
1505 // Assumes the pathname is separated with backslashes.
1506 CHAR16 *FindLastDirName(IN CHAR16 *Path) {
1507 UINTN i, StartOfElement = 0, EndOfElement = 0, PathLength, CopyLength;
1508 CHAR16 *Found = NULL;
1509
1510 if (Path == NULL)
1511 return NULL;
1512
1513 PathLength = StrLen(Path);
1514 // Find start & end of target element
1515 for (i = 0; i < PathLength; i++) {
1516 if (Path[i] == '\\') {
1517 StartOfElement = EndOfElement;
1518 EndOfElement = i;
1519 } // if
1520 } // for
1521 // Extract the target element
1522 if (EndOfElement > 0) {
1523 while ((StartOfElement < PathLength) && (Path[StartOfElement] == '\\')) {
1524 StartOfElement++;
1525 } // while
1526 EndOfElement--;
1527 if (EndOfElement >= StartOfElement) {
1528 CopyLength = EndOfElement - StartOfElement + 1;
1529 Found = StrDuplicate(&Path[StartOfElement]);
1530 if (Found != NULL)
1531 Found[CopyLength] = 0;
1532 } // if (EndOfElement >= StartOfElement)
1533 } // if (EndOfElement > 0)
1534 return (Found);
1535 } // CHAR16 *FindLastDirName
1536
1537 // Returns the directory portion of a pathname. For instance,
1538 // if FullPath is 'EFI\foo\bar.efi', this function returns the
1539 // string 'EFI\foo'. The calling function is responsible for
1540 // freeing the returned string's memory.
1541 CHAR16 *FindPath(IN CHAR16* FullPath) {
1542 UINTN i, LastBackslash = 0;
1543 CHAR16 *PathOnly = NULL;
1544
1545 if (FullPath != NULL) {
1546 for (i = 0; i < StrLen(FullPath); i++) {
1547 if (FullPath[i] == '\\')
1548 LastBackslash = i;
1549 } // for
1550 PathOnly = StrDuplicate(FullPath);
1551 if (PathOnly != NULL)
1552 PathOnly[LastBackslash] = 0;
1553 } // if
1554 return (PathOnly);
1555 }
1556
1557 // Takes an input loadpath, splits it into disk and filename components, finds a matching
1558 // DeviceVolume, and returns that and the filename (*loader).
1559 VOID FindVolumeAndFilename(IN EFI_DEVICE_PATH *loadpath, OUT REFIT_VOLUME **DeviceVolume, OUT CHAR16 **loader) {
1560 CHAR16 *DeviceString, *VolumeDeviceString, *Temp;
1561 UINTN i = 0;
1562 BOOLEAN Found = FALSE;
1563
1564 MyFreePool(*loader);
1565 MyFreePool(*DeviceVolume);
1566 *DeviceVolume = NULL;
1567 DeviceString = DevicePathToStr(loadpath);
1568 *loader = SplitDeviceString(DeviceString);
1569
1570 while ((i < VolumesCount) && (!Found)) {
1571 VolumeDeviceString = DevicePathToStr(Volumes[i]->DevicePath);
1572 Temp = SplitDeviceString(VolumeDeviceString);
1573 if (StriCmp(DeviceString, VolumeDeviceString) == 0) {
1574 Found = TRUE;
1575 *DeviceVolume = Volumes[i];
1576 }
1577 MyFreePool(Temp);
1578 MyFreePool(VolumeDeviceString);
1579 i++;
1580 } // while
1581
1582 MyFreePool(DeviceString);
1583 } // VOID FindVolumeAndFilename()
1584
1585 // Splits a volume/filename string (e.g., "fs0:\EFI\BOOT") into separate
1586 // volume and filename components (e.g., "fs0" and "\EFI\BOOT"), returning
1587 // the filename component in the original *Path variable and the split-off
1588 // volume component in the *VolName variable.
1589 // Returns TRUE if both components are found, FALSE otherwise.
1590 BOOLEAN SplitVolumeAndFilename(IN OUT CHAR16 **Path, OUT CHAR16 **VolName) {
1591 UINTN i = 0, Length;
1592 CHAR16 *Filename;
1593
1594 if (*Path == NULL)
1595 return FALSE;
1596
1597 if (*VolName != NULL) {
1598 MyFreePool(*VolName);
1599 *VolName = NULL;
1600 }
1601
1602 Length = StrLen(*Path);
1603 while ((i < Length) && ((*Path)[i] != L':')) {
1604 i++;
1605 } // while
1606
1607 if (i < Length) {
1608 Filename = StrDuplicate((*Path) + i + 1);
1609 (*Path)[i] = 0;
1610 *VolName = *Path;
1611 *Path = Filename;
1612 return TRUE;
1613 } else {
1614 return FALSE;
1615 }
1616 } // BOOLEAN SplitVolumeAndFilename()
1617
1618 // Returns all the digits in the input string, including intervening
1619 // non-digit characters. For instance, if InString is "foo-3.3.4-7.img",
1620 // this function returns "3.3.4-7". If InString contains no digits,
1621 // the return value is NULL.
1622 CHAR16 *FindNumbers(IN CHAR16 *InString) {
1623 UINTN i, StartOfElement, EndOfElement = 0, InLength, CopyLength;
1624 CHAR16 *Found = NULL;
1625
1626 if (InString == NULL)
1627 return NULL;
1628
1629 InLength = StartOfElement = StrLen(InString);
1630 // Find start & end of target element
1631 for (i = 0; i < InLength; i++) {
1632 if ((InString[i] >= '0') && (InString[i] <= '9')) {
1633 if (StartOfElement > i)
1634 StartOfElement = i;
1635 if (EndOfElement < i)
1636 EndOfElement = i;
1637 } // if
1638 } // for
1639 // Extract the target element
1640 if (EndOfElement > 0) {
1641 if (EndOfElement >= StartOfElement) {
1642 CopyLength = EndOfElement - StartOfElement + 1;
1643 Found = StrDuplicate(&InString[StartOfElement]);
1644 if (Found != NULL)
1645 Found[CopyLength] = 0;
1646 } // if (EndOfElement >= StartOfElement)
1647 } // if (EndOfElement > 0)
1648 return (Found);
1649 } // CHAR16 *FindNumbers()
1650
1651 // Find the #Index element (numbered from 0) in a comma-delimited string
1652 // of elements.
1653 // Returns the found element, or NULL if Index is out of range or InString
1654 // is NULL. Note that the calling function is responsible for freeing the
1655 // memory associated with the returned string pointer.
1656 CHAR16 *FindCommaDelimited(IN CHAR16 *InString, IN UINTN Index) {
1657 UINTN StartPos = 0, CurPos = 0;
1658 BOOLEAN Found = FALSE;
1659 CHAR16 *FoundString = NULL;
1660
1661 if (InString != NULL) {
1662 // After while() loop, StartPos marks start of item #Index
1663 while ((Index > 0) && (CurPos < StrLen(InString))) {
1664 if (InString[CurPos] == L',') {
1665 Index--;
1666 StartPos = CurPos + 1;
1667 } // if
1668 CurPos++;
1669 } // while
1670 // After while() loop, CurPos is one past the end of the element
1671 while ((CurPos < StrLen(InString)) && (!Found)) {
1672 if (InString[CurPos] == L',')
1673 Found = TRUE;
1674 else
1675 CurPos++;
1676 } // while
1677 if (Index == 0)
1678 FoundString = StrDuplicate(&InString[StartPos]);
1679 if (FoundString != NULL)
1680 FoundString[CurPos - StartPos] = 0;
1681 } // if
1682 return (FoundString);
1683 } // CHAR16 *FindCommaDelimited()
1684
1685 // Return the position of SmallString within BigString, or -1 if
1686 // not found.
1687 INTN FindSubString(IN CHAR16 *SmallString, IN CHAR16 *BigString) {
1688 INTN Position = -1;
1689 UINTN i = 0, SmallSize, BigSize;
1690 BOOLEAN Found = FALSE;
1691
1692 if ((SmallString == NULL) || (BigString == NULL))
1693 return -1;
1694
1695 SmallSize = StrLen(SmallString);
1696 BigSize = StrLen(BigString);
1697 if ((SmallSize > BigSize) || (SmallSize == 0) || (BigSize == 0))
1698 return -1;
1699
1700 while ((i <= (BigSize - SmallSize) && !Found)) {
1701 if (CompareMem(BigString + i, SmallString, SmallSize) == 0) {
1702 Found = TRUE;
1703 Position = i;
1704 } // if
1705 i++;
1706 } // while()
1707 return Position;
1708 } // INTN FindSubString()
1709
1710 // Take an input path name, which may include a volume specification and/or
1711 // a path, and return separate volume, path, and file names. For instance,
1712 // "BIGVOL:\EFI\ubuntu\grubx64.efi" will return a VolName of "BIGVOL", a Path
1713 // of "EFI\ubuntu", and a Filename of "grubx64.efi". If an element is missing,
1714 // the returned pointer is NULL. The calling function is responsible for
1715 // freeing the allocated memory.
1716 VOID SplitPathName(CHAR16 *InPath, CHAR16 **VolName, CHAR16 **Path, CHAR16 **Filename) {
1717 CHAR16 *Temp = NULL;
1718
1719 MyFreePool(*VolName);
1720 MyFreePool(*Path);
1721 MyFreePool(*Filename);
1722 *VolName = *Path = *Filename = NULL;
1723 Temp = StrDuplicate(InPath);
1724 SplitVolumeAndFilename(&Temp, VolName); // VolName is NULL or has volume; Temp has rest of path
1725 CleanUpPathNameSlashes(Temp);
1726 *Path = FindPath(Temp); // *Path has path (may be 0-length); Temp unchanged.
1727 *Filename = StrDuplicate(Temp + StrLen(*Path));
1728 CleanUpPathNameSlashes(*Filename);
1729 if (StrLen(*Path) == 0) {
1730 MyFreePool(*Path);
1731 *Path = NULL;
1732 }
1733 if (StrLen(*Filename) == 0) {
1734 MyFreePool(*Filename);
1735 *Filename = NULL;
1736 }
1737 MyFreePool(Temp);
1738 } // VOID SplitPathName
1739
1740 // Returns TRUE if SmallString is an element in the comma-delimited List,
1741 // FALSE otherwise. Performs comparison case-insensitively (except on
1742 // buggy EFIs with case-sensitive StriCmp() functions).
1743 BOOLEAN IsIn(IN CHAR16 *SmallString, IN CHAR16 *List) {
1744 UINTN i = 0;
1745 BOOLEAN Found = FALSE;
1746 CHAR16 *OneElement;
1747
1748 if (SmallString && List) {
1749 while (!Found && (OneElement = FindCommaDelimited(List, i++))) {
1750 if (StriCmp(OneElement, SmallString) == 0)
1751 Found = TRUE;
1752 } // while
1753 } // if
1754 return Found;
1755 } // BOOLEAN IsIn()
1756
1757 // Returns TRUE if specified Volume, Directory, and Filename correspond to an
1758 // element in the comma-delimited List, FALSE otherwise. Note that Directory and
1759 // Filename must *NOT* include a volume or path specification (that's part of
1760 // the Volume variable), but the List elements may. Performs comparison
1761 // case-insensitively (except on buggy EFIs with case-sensitive StriCmp()
1762 // functions).
1763 BOOLEAN FilenameIn(REFIT_VOLUME *Volume, CHAR16 *Directory, CHAR16 *Filename, CHAR16 *List) {
1764 UINTN i = 0;
1765 BOOLEAN Found = FALSE;
1766 CHAR16 *OneElement;
1767 CHAR16 *TargetVolName = NULL, *TargetPath = NULL, *TargetFilename = NULL;
1768
1769 if (Filename && List) {
1770 while (!Found && (OneElement = FindCommaDelimited(List, i++))) {
1771 Found = TRUE;
1772 SplitPathName(OneElement, &TargetVolName, &TargetPath, &TargetFilename);
1773 VolumeNumberToName(Volume, &TargetVolName);
1774 if (((TargetVolName != NULL) && ((Volume == NULL) || (StriCmp(TargetVolName, Volume->VolName) != 0))) ||
1775 ((TargetPath != NULL) && (StriCmp(TargetPath, Directory) != 0)) ||
1776 ((TargetFilename != NULL) && (StriCmp(TargetFilename, Filename) != 0))) {
1777 Found = FALSE;
1778 } // if
1779 MyFreePool(OneElement);
1780 } // while
1781 } // if
1782
1783 MyFreePool(TargetVolName);
1784 MyFreePool(TargetPath);
1785 MyFreePool(TargetFilename);
1786 return Found;
1787 } // BOOLEAN FilenameIn()
1788
1789 // If *VolName is of the form "fs#", where "#" is a number, and if Volume points
1790 // to this volume number, returns with *VolName changed to the volume name, as
1791 // stored in the Volume data structure.
1792 // Returns TRUE if this substitution was made, FALSE otherwise.
1793 BOOLEAN VolumeNumberToName(REFIT_VOLUME *Volume, CHAR16 **VolName) {
1794 BOOLEAN MadeSubstitution = FALSE;
1795 UINTN VolNum;
1796
1797 if ((VolName == NULL) || (*VolName == NULL))
1798 return FALSE;
1799
1800 if ((StrLen(*VolName) > 2) && (*VolName[0] == L'f') && (*VolName[1] == L's') && (*VolName[2] >= L'0') && (*VolName[2] <= L'9')) {
1801 VolNum = Atoi(*VolName + 2);
1802 if (VolNum == Volume->VolNumber) {
1803 MyFreePool(*VolName);
1804 *VolName = StrDuplicate(Volume->VolName);
1805 MadeSubstitution = TRUE;
1806 } // if
1807 } // if
1808 return MadeSubstitution;
1809 } // BOOLEAN VolumeMatchesNumber()
1810
1811 // Implement FreePool the way it should have been done to begin with, so that
1812 // it doesn't throw an ASSERT message if fed a NULL pointer....
1813 VOID MyFreePool(IN VOID *Pointer) {
1814 if (Pointer != NULL)
1815 FreePool(Pointer);
1816 }
1817
1818 static EFI_GUID AppleRemovableMediaGuid = APPLE_REMOVABLE_MEDIA_PROTOCOL_GUID;
1819
1820 // Eject all removable media.
1821 // Returns TRUE if any media were ejected, FALSE otherwise.
1822 BOOLEAN EjectMedia(VOID) {
1823 EFI_STATUS Status;
1824 UINTN HandleIndex, HandleCount = 0, Ejected = 0;
1825 EFI_HANDLE *Handles, Handle;
1826 APPLE_REMOVABLE_MEDIA_PROTOCOL *Ejectable;
1827
1828 Status = LibLocateHandle(ByProtocol, &AppleRemovableMediaGuid, NULL, &HandleCount, &Handles);
1829 if (EFI_ERROR(Status) || HandleCount == 0)
1830 return (FALSE); // probably not an Apple system
1831
1832 for (HandleIndex = 0; HandleIndex < HandleCount; HandleIndex++) {
1833 Handle = Handles[HandleIndex];
1834 Status = refit_call3_wrapper(BS->HandleProtocol, Handle, &AppleRemovableMediaGuid, (VOID **) &Ejectable);
1835 if (EFI_ERROR(Status))
1836 continue;
1837 Status = refit_call1_wrapper(Ejectable->Eject, Ejectable);
1838 if (!EFI_ERROR(Status))
1839 Ejected++;
1840 }
1841 MyFreePool(Handles);
1842 return (Ejected > 0);
1843 } // VOID EjectMedia()
1844
1845
1846 // Return the GUID as a string, suitable for display to the user. Note that the calling
1847 // function is responsible for freeing the allocated memory.
1848 CHAR16 * GuidAsString(EFI_GUID *GuidData) {
1849 CHAR16 *TheString;
1850
1851 TheString = AllocateZeroPool(42 * sizeof(CHAR16));
1852 if (TheString != 0) {
1853 SPrint (TheString, 82, L"%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x",
1854 (UINTN)GuidData->Data1, (UINTN)GuidData->Data2, (UINTN)GuidData->Data3,
1855 (UINTN)GuidData->Data4[0], (UINTN)GuidData->Data4[1], (UINTN)GuidData->Data4[2],
1856 (UINTN)GuidData->Data4[3], (UINTN)GuidData->Data4[4], (UINTN)GuidData->Data4[5],
1857 (UINTN)GuidData->Data4[6], (UINTN)GuidData->Data4[7]);
1858 }
1859 return TheString;
1860 } // GuidAsString(EFI_GUID *GuidData)