code.delx.au - refind/blob - refind/lib.c

   1 /*
   2  * refit/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 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 "refit_call_wrapper.h"
  50
  51 // variables
  52
  53 EFI_HANDLE       SelfImageHandle;
  54 EFI_LOADED_IMAGE *SelfLoadedImage;
  55 EFI_FILE         *SelfRootDir;
  56 EFI_FILE         *SelfDir;
  57 CHAR16           *SelfDirPath;
  58
  59 REFIT_VOLUME     *SelfVolume = NULL;
  60 REFIT_VOLUME     **Volumes = NULL;
  61 UINTN            VolumesCount = 0;
  62
  63 // Maximum size for disk sectors
  64 #define SECTOR_SIZE 4096
  65
  66 // Default names for volume badges (mini-icon to define disk type) and icons
  67 #define VOLUME_BADGE_NAME L".VolumeBadge.icns"
  68 #define VOLUME_ICON_NAME L".VolumeIcon.icns"
  69
  70 // functions
  71
  72 static EFI_STATUS FinishInitRefitLib(VOID);
  73
  74 static VOID UninitVolumes(VOID);
  75
  76 //
  77 // self recognition stuff
  78 //
  79
  80 // Converts forward slashes to backslashes and removes duplicate slashes.
  81 // Necessary because some (buggy?) EFI implementations produce "\/" strings
  82 // in pathnames and because some user inputs can produce duplicate directory
  83 // separators
  84 VOID CleanUpPathNameSlashes(IN OUT CHAR16 *PathName) {
  85    CHAR16   *NewName;
  86    UINTN    i, j = 0;
  87    BOOLEAN  LastWasSlash = FALSE;
  88
  89    NewName = AllocateZeroPool(sizeof(CHAR16) * (StrLen(PathName) + 1));
  90    if (NewName != NULL) {
  91       for (i = 0; i < StrLen(PathName); i++) {
  92          if ((PathName[i] == L'/') || (PathName[i] == L'\\')) {
  93             if (!LastWasSlash)
  94                NewName[j++] = L'\\';
  95             LastWasSlash = TRUE;
  96          } else {
  97             NewName[j++] = PathName[i];
  98             LastWasSlash = FALSE;
  99          } // if/else
 100       } // for
 101       NewName[j] = 0;
 102       // Copy the transformed name back....
 103       StrCpy(PathName, NewName);
 104       FreePool(NewName);
 105    } // if allocation OK
 106 } // CleanUpPathNameSlashes()
 107
 108 EFI_STATUS InitRefitLib(IN EFI_HANDLE ImageHandle)
 109 {
 110     EFI_STATUS  Status;
 111     CHAR16      *DevicePathAsString;
 112     UINTN       i;
 113
 114     SelfImageHandle = ImageHandle;
 115     Status = refit_call3_wrapper(BS->HandleProtocol, SelfImageHandle, &LoadedImageProtocol, (VOID **) &SelfLoadedImage);
 116     if (CheckFatalError(Status, L"while getting a LoadedImageProtocol handle"))
 117         return EFI_LOAD_ERROR;
 118
 119     // find the current directory
 120     DevicePathAsString = DevicePathToStr(SelfLoadedImage->FilePath);
 121     CleanUpPathNameSlashes(DevicePathAsString);
 122     if (DevicePathAsString != NULL) {
 123         for (i = StrLen(DevicePathAsString); (i > 0) && (DevicePathAsString[i] != '\\'); i--) ;
 124         DevicePathAsString[i] = 0;
 125     } else
 126         DevicePathAsString[0] = 0;
 127     SelfDirPath = StrDuplicate(DevicePathAsString);
 128     FreePool(DevicePathAsString);
 129
 130     return FinishInitRefitLib();
 131 }
 132
 133 // called before running external programs to close open file handles
 134 VOID UninitRefitLib(VOID)
 135 {
 136     UninitVolumes();
 137
 138     if (SelfDir != NULL) {
 139         refit_call1_wrapper(SelfDir->Close, SelfDir);
 140         SelfDir = NULL;
 141     }
 142
 143     if (SelfRootDir != NULL) {
 144        refit_call1_wrapper(SelfRootDir->Close, SelfRootDir);
 145        SelfRootDir = NULL;
 146     }
 147 }
 148
 149 // called after running external programs to re-open file handles
 150 EFI_STATUS ReinitRefitLib(VOID)
 151 {
 152     ReinitVolumes();
 153
 154     // Below two lines were in rEFIt, but seem to cause problems on
 155     // most systems. OTOH, my Mac Mini produces (apparently harmless)
 156     // errors about "(re)opening our installation volume" (see the
 157     // next function) when returning from programs when these two lines
 158     // are removed. On the gripping hand, the Mac SOMETIMES crashes
 159     // when launching a second program even with these lines removed.
 160     // TODO: Figure out cause of above weirdness and fix it more
 161     // reliably!
 162     /* if (SelfVolume != NULL && SelfVolume->RootDir != NULL)
 163        SelfRootDir = SelfVolume->RootDir; */
 164
 165     return FinishInitRefitLib();
 166 }
 167
 168 static EFI_STATUS FinishInitRefitLib(VOID)
 169 {
 170     EFI_STATUS  Status;
 171
 172     if (SelfRootDir == NULL) {
 173         SelfRootDir = LibOpenRoot(SelfLoadedImage->DeviceHandle);
 174         if (SelfRootDir == NULL) {
 175             CheckError(EFI_LOAD_ERROR, L"while (re)opening our installation volume");
 176             return EFI_LOAD_ERROR;
 177         }
 178     }
 179
 180     Status = refit_call5_wrapper(SelfRootDir->Open, SelfRootDir, &SelfDir, SelfDirPath, EFI_FILE_MODE_READ, 0);
 181     if (CheckFatalError(Status, L"while opening our installation directory"))
 182         return EFI_LOAD_ERROR;
 183
 184     return EFI_SUCCESS;
 185 }
 186
 187 //
 188 // list functions
 189 //
 190
 191 VOID CreateList(OUT VOID ***ListPtr, OUT UINTN *ElementCount, IN UINTN InitialElementCount)
 192 {
 193     UINTN AllocateCount;
 194
 195     *ElementCount = InitialElementCount;
 196     if (*ElementCount > 0) {
 197         AllocateCount = (*ElementCount + 7) & ~7;   // next multiple of 8
 198         *ListPtr = AllocatePool(sizeof(VOID *) * AllocateCount);
 199     } else {
 200         *ListPtr = NULL;
 201     }
 202 }
 203
 204 VOID AddListElement(IN OUT VOID ***ListPtr, IN OUT UINTN *ElementCount, IN VOID *NewElement)
 205 {
 206     UINTN AllocateCount;
 207
 208     if ((*ElementCount & 7) == 0) {
 209         AllocateCount = *ElementCount + 8;
 210         if (*ElementCount == 0)
 211             *ListPtr = AllocatePool(sizeof(VOID *) * AllocateCount);
 212         else
 213             *ListPtr = ReallocatePool(*ListPtr, sizeof(VOID *) * (*ElementCount), sizeof(VOID *) * AllocateCount);
 214     }
 215     (*ListPtr)[*ElementCount] = NewElement;
 216     (*ElementCount)++;
 217 } /* VOID AddListElement() */
 218
 219 VOID FreeList(IN OUT VOID ***ListPtr, IN OUT UINTN *ElementCount)
 220 {
 221     UINTN i;
 222
 223     if (*ElementCount > 0) {
 224         for (i = 0; i < *ElementCount; i++) {
 225             // TODO: call a user-provided routine for each element here
 226             FreePool((*ListPtr)[i]);
 227         }
 228         FreePool(*ListPtr);
 229     }
 230 }
 231
 232 //
 233 // firmware device path discovery
 234 //
 235
 236 static UINT8 LegacyLoaderMediaPathData[] = {
 237     0x04, 0x06, 0x14, 0x00, 0xEB, 0x85, 0x05, 0x2B,
 238     0xB8, 0xD8, 0xA9, 0x49, 0x8B, 0x8C, 0xE2, 0x1B,
 239     0x01, 0xAE, 0xF2, 0xB7, 0x7F, 0xFF, 0x04, 0x00,
 240 };
 241 static EFI_DEVICE_PATH *LegacyLoaderMediaPath = (EFI_DEVICE_PATH *)LegacyLoaderMediaPathData;
 242
 243 VOID ExtractLegacyLoaderPaths(EFI_DEVICE_PATH **PathList, UINTN MaxPaths, EFI_DEVICE_PATH **HardcodedPathList)
 244 {
 245     EFI_STATUS          Status;
 246     UINTN               HandleCount = 0;
 247     UINTN               HandleIndex, HardcodedIndex;
 248     EFI_HANDLE          *Handles;
 249     EFI_HANDLE          Handle;
 250     UINTN               PathCount = 0;
 251     UINTN               PathIndex;
 252     EFI_LOADED_IMAGE    *LoadedImage;
 253     EFI_DEVICE_PATH     *DevicePath;
 254     BOOLEAN             Seen;
 255
 256     MaxPaths--;  // leave space for the terminating NULL pointer
 257
 258     // get all LoadedImage handles
 259     Status = LibLocateHandle(ByProtocol, &LoadedImageProtocol, NULL,
 260                              &HandleCount, &Handles);
 261     if (CheckError(Status, L"while listing LoadedImage handles")) {
 262         if (HardcodedPathList) {
 263             for (HardcodedIndex = 0; HardcodedPathList[HardcodedIndex] && PathCount < MaxPaths; HardcodedIndex++)
 264                 PathList[PathCount++] = HardcodedPathList[HardcodedIndex];
 265         }
 266         PathList[PathCount] = NULL;
 267         return;
 268     }
 269     for (HandleIndex = 0; HandleIndex < HandleCount && PathCount < MaxPaths; HandleIndex++) {
 270         Handle = Handles[HandleIndex];
 271
 272         Status = refit_call3_wrapper(BS->HandleProtocol, Handle, &LoadedImageProtocol, (VOID **) &LoadedImage);
 273         if (EFI_ERROR(Status))
 274             continue;  // This can only happen if the firmware scewed up, ignore it.
 275
 276         Status = refit_call3_wrapper(BS->HandleProtocol, LoadedImage->DeviceHandle, &DevicePathProtocol, (VOID **) &DevicePath);
 277         if (EFI_ERROR(Status))
 278             continue;  // This happens, ignore it.
 279
 280         // Only grab memory range nodes
 281         if (DevicePathType(DevicePath) != HARDWARE_DEVICE_PATH || DevicePathSubType(DevicePath) != HW_MEMMAP_DP)
 282             continue;
 283
 284         // Check if we have this device path in the list already
 285         // WARNING: This assumes the first node in the device path is unique!
 286         Seen = FALSE;
 287         for (PathIndex = 0; PathIndex < PathCount; PathIndex++) {
 288             if (DevicePathNodeLength(DevicePath) != DevicePathNodeLength(PathList[PathIndex]))
 289                 continue;
 290             if (CompareMem(DevicePath, PathList[PathIndex], DevicePathNodeLength(DevicePath)) == 0) {
 291                 Seen = TRUE;
 292                 break;
 293             }
 294         }
 295         if (Seen)
 296             continue;
 297
 298         PathList[PathCount++] = AppendDevicePath(DevicePath, LegacyLoaderMediaPath);
 299     }
 300     FreePool(Handles);
 301
 302     if (HardcodedPathList) {
 303         for (HardcodedIndex = 0; HardcodedPathList[HardcodedIndex] && PathCount < MaxPaths; HardcodedIndex++)
 304             PathList[PathCount++] = HardcodedPathList[HardcodedIndex];
 305     }
 306     PathList[PathCount] = NULL;
 307 }
 308
 309 //
 310 // volume functions
 311 //
 312
 313 static VOID ScanVolumeBootcode(IN OUT REFIT_VOLUME *Volume, OUT BOOLEAN *Bootable)
 314 {
 315     EFI_STATUS              Status;
 316     UINT8                   SectorBuffer[SECTOR_SIZE];
 317     UINTN                   i;
 318     MBR_PARTITION_INFO      *MbrTable;
 319     BOOLEAN                 MbrTableFound;
 320
 321     Volume->HasBootCode = FALSE;
 322     Volume->OSIconName = NULL;
 323     Volume->OSName = NULL;
 324     *Bootable = FALSE;
 325
 326     if (Volume->BlockIO == NULL)
 327         return;
 328     if (Volume->BlockIO->Media->BlockSize > SECTOR_SIZE)
 329         return;   // our buffer is too small...
 330
 331     // look at the boot sector (this is used for both hard disks and El Torito images!)
 332     Status = refit_call5_wrapper(Volume->BlockIO->ReadBlocks,
 333                                  Volume->BlockIO, Volume->BlockIO->Media->MediaId,
 334                                  Volume->BlockIOOffset, SECTOR_SIZE, SectorBuffer);
 335     if (!EFI_ERROR(Status)) {
 336
 337         if (*((UINT16 *)(SectorBuffer + 510)) == 0xaa55 && SectorBuffer[0] != 0) {
 338             *Bootable = TRUE;
 339             Volume->HasBootCode = TRUE;
 340         }
 341
 342         // detect specific boot codes
 343         if (CompareMem(SectorBuffer + 2, "LILO", 4) == 0 ||
 344             CompareMem(SectorBuffer + 6, "LILO", 4) == 0 ||
 345             CompareMem(SectorBuffer + 3, "SYSLINUX", 8) == 0 ||
 346             FindMem(SectorBuffer, SECTOR_SIZE, "ISOLINUX", 8) >= 0) {
 347             Volume->HasBootCode = TRUE;
 348             Volume->OSIconName = L"linux";
 349             Volume->OSName = L"Linux";
 350
 351         } else if (FindMem(SectorBuffer, 512, "Geom\0Hard Disk\0Read\0 Error", 26) >= 0) {   // GRUB
 352             Volume->HasBootCode = TRUE;
 353             Volume->OSIconName = L"grub,linux";
 354             Volume->OSName = L"Linux";
 355
 356         } else if ((*((UINT32 *)(SectorBuffer + 502)) == 0 &&
 357                     *((UINT32 *)(SectorBuffer + 506)) == 50000 &&
 358                     *((UINT16 *)(SectorBuffer + 510)) == 0xaa55) ||
 359                     FindMem(SectorBuffer, SECTOR_SIZE, "Starting the BTX loader", 23) >= 0) {
 360             Volume->HasBootCode = TRUE;
 361             Volume->OSIconName = L"freebsd";
 362             Volume->OSName = L"FreeBSD";
 363
 364         } else if (FindMem(SectorBuffer, 512, "!Loading", 8) >= 0 ||
 365                    FindMem(SectorBuffer, SECTOR_SIZE, "/cdboot\0/CDBOOT\0", 16) >= 0) {
 366             Volume->HasBootCode = TRUE;
 367             Volume->OSIconName = L"openbsd";
 368             Volume->OSName = L"OpenBSD";
 369
 370         } else if (FindMem(SectorBuffer, 512, "Not a bootxx image", 18) >= 0 ||
 371                    *((UINT32 *)(SectorBuffer + 1028)) == 0x7886b6d1) {
 372             Volume->HasBootCode = TRUE;
 373             Volume->OSIconName = L"netbsd";
 374             Volume->OSName = L"NetBSD";
 375
 376         } else if (FindMem(SectorBuffer, SECTOR_SIZE, "NTLDR", 5) >= 0) {
 377             Volume->HasBootCode = TRUE;
 378             Volume->OSIconName = L"win";
 379             Volume->OSName = L"Windows";
 380
 381         } else if (FindMem(SectorBuffer, SECTOR_SIZE, "BOOTMGR", 7) >= 0) {
 382             Volume->HasBootCode = TRUE;
 383             Volume->OSIconName = L"winvista,win";
 384             Volume->OSName = L"Windows";
 385
 386         } else if (FindMem(SectorBuffer, 512, "CPUBOOT SYS", 11) >= 0 ||
 387                    FindMem(SectorBuffer, 512, "KERNEL  SYS", 11) >= 0) {
 388             Volume->HasBootCode = TRUE;
 389             Volume->OSIconName = L"freedos";
 390             Volume->OSName = L"FreeDOS";
 391
 392         } else if (FindMem(SectorBuffer, 512, "OS2LDR", 6) >= 0 ||
 393                    FindMem(SectorBuffer, 512, "OS2BOOT", 7) >= 0) {
 394             Volume->HasBootCode = TRUE;
 395             Volume->OSIconName = L"ecomstation";
 396             Volume->OSName = L"eComStation";
 397
 398         } else if (FindMem(SectorBuffer, 512, "Be Boot Loader", 14) >= 0) {
 399             Volume->HasBootCode = TRUE;
 400             Volume->OSIconName = L"beos";
 401             Volume->OSName = L"BeOS";
 402
 403         } else if (FindMem(SectorBuffer, 512, "yT Boot Loader", 14) >= 0) {
 404             Volume->HasBootCode = TRUE;
 405             Volume->OSIconName = L"zeta,beos";
 406             Volume->OSName = L"ZETA";
 407
 408         } else if (FindMem(SectorBuffer, 512, "\x04" "beos\x06" "system\x05" "zbeos", 18) >= 0 ||
 409                    FindMem(SectorBuffer, 512, "\x06" "system\x0c" "haiku_loader", 20) >= 0) {
 410             Volume->HasBootCode = TRUE;
 411             Volume->OSIconName = L"haiku,beos";
 412             Volume->OSName = L"Haiku";
 413
 414         }
 415
 416         // NOTE: If you add an operating system with a name that starts with 'W' or 'L', you
 417         //  need to fix AddLegacyEntry in main.c.
 418
 419 #if REFIT_DEBUG > 0
 420         Print(L"  Result of bootcode detection: %s %s (%s)\n",
 421               Volume->HasBootCode ? L"bootable" : L"non-bootable",
 422               Volume->OSName, Volume->OSIconName);
 423 #endif
 424
 425         if (FindMem(SectorBuffer, 512, "Non-system disk", 15) >= 0)   // dummy FAT boot sector
 426             Volume->HasBootCode = FALSE;
 427
 428         // check for MBR partition table
 429         if (*((UINT16 *)(SectorBuffer + 510)) == 0xaa55) {
 430             MbrTableFound = FALSE;
 431             MbrTable = (MBR_PARTITION_INFO *)(SectorBuffer + 446);
 432             for (i = 0; i < 4; i++)
 433                 if (MbrTable[i].StartLBA && MbrTable[i].Size)
 434                     MbrTableFound = TRUE;
 435             for (i = 0; i < 4; i++)
 436                 if (MbrTable[i].Flags != 0x00 && MbrTable[i].Flags != 0x80)
 437                     MbrTableFound = FALSE;
 438             if (MbrTableFound) {
 439                 Volume->MbrPartitionTable = AllocatePool(4 * 16);
 440                 CopyMem(Volume->MbrPartitionTable, MbrTable, 4 * 16);
 441             }
 442         }
 443
 444     } else {
 445 #if REFIT_DEBUG > 0
 446         CheckError(Status, L"while reading boot sector");
 447 #endif
 448     }
 449 }
 450
 451 // default volume icon based on disk kind
 452 static VOID ScanVolumeDefaultIcon(IN OUT REFIT_VOLUME *Volume)
 453 {
 454     switch (Volume->DiskKind) {
 455        case DISK_KIND_INTERNAL:
 456           Volume->VolBadgeImage = BuiltinIcon(BUILTIN_ICON_VOL_INTERNAL);
 457           break;
 458        case DISK_KIND_EXTERNAL:
 459           Volume->VolBadgeImage = BuiltinIcon(BUILTIN_ICON_VOL_EXTERNAL);
 460           break;
 461        case DISK_KIND_OPTICAL:
 462           Volume->VolBadgeImage = BuiltinIcon(BUILTIN_ICON_VOL_OPTICAL);
 463           break;
 464     } // switch()
 465 }
 466
 467 static VOID ScanVolume(IN OUT REFIT_VOLUME *Volume)
 468 {
 469     EFI_STATUS              Status;
 470     EFI_DEVICE_PATH         *DevicePath, *NextDevicePath;
 471     EFI_DEVICE_PATH         *DiskDevicePath, *RemainingDevicePath;
 472     EFI_HANDLE              WholeDiskHandle;
 473     UINTN                   PartialLength;
 474     EFI_FILE_SYSTEM_INFO    *FileSystemInfoPtr;
 475     BOOLEAN                 Bootable;
 476
 477     // get device path
 478     Volume->DevicePath = DuplicateDevicePath(DevicePathFromHandle(Volume->DeviceHandle));
 479 #if REFIT_DEBUG > 0
 480     if (Volume->DevicePath != NULL) {
 481         Print(L"* %s\n", DevicePathToStr(Volume->DevicePath));
 482 #if REFIT_DEBUG >= 2
 483         DumpHex(1, 0, DevicePathSize(Volume->DevicePath), Volume->DevicePath);
 484 #endif
 485     }
 486 #endif
 487
 488     Volume->DiskKind = DISK_KIND_INTERNAL;  // default
 489
 490     // get block i/o
 491     Status = refit_call3_wrapper(BS->HandleProtocol, Volume->DeviceHandle, &BlockIoProtocol, (VOID **) &(Volume->BlockIO));
 492     if (EFI_ERROR(Status)) {
 493         Volume->BlockIO = NULL;
 494         Print(L"Warning: Can't get BlockIO protocol.\n");
 495     } else {
 496         if (Volume->BlockIO->Media->BlockSize == 2048)
 497             Volume->DiskKind = DISK_KIND_OPTICAL;
 498     }
 499
 500     // scan for bootcode and MBR table
 501     Bootable = FALSE;
 502     ScanVolumeBootcode(Volume, &Bootable);
 503
 504     // detect device type
 505     DevicePath = Volume->DevicePath;
 506     while (DevicePath != NULL && !IsDevicePathEndType(DevicePath)) {
 507         NextDevicePath = NextDevicePathNode(DevicePath);
 508
 509         if (DevicePathType(DevicePath) == MESSAGING_DEVICE_PATH &&
 510             (DevicePathSubType(DevicePath) == MSG_USB_DP ||
 511              DevicePathSubType(DevicePath) == MSG_USB_CLASS_DP ||
 512              DevicePathSubType(DevicePath) == MSG_1394_DP ||
 513              DevicePathSubType(DevicePath) == MSG_FIBRECHANNEL_DP))
 514             Volume->DiskKind = DISK_KIND_EXTERNAL;    // USB/FireWire/FC device -> external
 515         if (DevicePathType(DevicePath) == MEDIA_DEVICE_PATH &&
 516             DevicePathSubType(DevicePath) == MEDIA_CDROM_DP) {
 517             Volume->DiskKind = DISK_KIND_OPTICAL;     // El Torito entry -> optical disk
 518             Bootable = TRUE;
 519         }
 520
 521         if (DevicePathType(DevicePath) == MEDIA_DEVICE_PATH && DevicePathSubType(DevicePath) == MEDIA_VENDOR_DP) {
 522             Volume->IsAppleLegacy = TRUE;             // legacy BIOS device entry
 523             // TODO: also check for Boot Camp GUID
 524             Bootable = FALSE;   // this handle's BlockIO is just an alias for the whole device
 525         }
 526
 527         if (DevicePathType(DevicePath) == MESSAGING_DEVICE_PATH) {
 528             // make a device path for the whole device
 529             PartialLength = (UINT8 *)NextDevicePath - (UINT8 *)(Volume->DevicePath);
 530             DiskDevicePath = (EFI_DEVICE_PATH *)AllocatePool(PartialLength + sizeof(EFI_DEVICE_PATH));
 531             CopyMem(DiskDevicePath, Volume->DevicePath, PartialLength);
 532             CopyMem((UINT8 *)DiskDevicePath + PartialLength, EndDevicePath, sizeof(EFI_DEVICE_PATH));
 533
 534             // get the handle for that path
 535             RemainingDevicePath = DiskDevicePath;
 536             //Print(L"  * looking at %s\n", DevicePathToStr(RemainingDevicePath));
 537             Status = refit_call3_wrapper(BS->LocateDevicePath, &BlockIoProtocol, &RemainingDevicePath, &WholeDiskHandle);
 538             //Print(L"  * remaining: %s\n", DevicePathToStr(RemainingDevicePath));
 539             FreePool(DiskDevicePath);
 540
 541             if (!EFI_ERROR(Status)) {
 542                 //Print(L"  - original handle: %08x - disk handle: %08x\n", (UINT32)DeviceHandle, (UINT32)WholeDiskHandle);
 543
 544                 // get the device path for later
 545                 Status = refit_call3_wrapper(BS->HandleProtocol, WholeDiskHandle, &DevicePathProtocol, (VOID **) &DiskDevicePath);
 546                 if (!EFI_ERROR(Status)) {
 547                     Volume->WholeDiskDevicePath = DuplicateDevicePath(DiskDevicePath);
 548                 }
 549
 550                 // look at the BlockIO protocol
 551                 Status = refit_call3_wrapper(BS->HandleProtocol, WholeDiskHandle, &BlockIoProtocol, (VOID **) &Volume->WholeDiskBlockIO);
 552                 if (!EFI_ERROR(Status)) {
 553
 554                     // check the media block size
 555                     if (Volume->WholeDiskBlockIO->Media->BlockSize == 2048)
 556                         Volume->DiskKind = DISK_KIND_OPTICAL;
 557
 558                 } else {
 559                     Volume->WholeDiskBlockIO = NULL;
 560                     //CheckError(Status, L"from HandleProtocol");
 561                 }
 562             } //else
 563               //  CheckError(Status, L"from LocateDevicePath");
 564         }
 565
 566         DevicePath = NextDevicePath;
 567     } // while
 568
 569     if (!Bootable) {
 570 #if REFIT_DEBUG > 0
 571         if (Volume->HasBootCode)
 572             Print(L"  Volume considered non-bootable, but boot code is present\n");
 573 #endif
 574         Volume->HasBootCode = FALSE;
 575     }
 576
 577     // default volume icon based on disk kind
 578     ScanVolumeDefaultIcon(Volume);
 579
 580     // open the root directory of the volume
 581     Volume->RootDir = LibOpenRoot(Volume->DeviceHandle);
 582     if (Volume->RootDir == NULL) {
 583         Volume->IsReadable = FALSE;
 584         return;
 585     } else {
 586         Volume->IsReadable = TRUE;
 587     }
 588
 589     // get volume name
 590     FileSystemInfoPtr = LibFileSystemInfo(Volume->RootDir);
 591     if (FileSystemInfoPtr != NULL) {
 592         Volume->VolName = StrDuplicate(FileSystemInfoPtr->VolumeLabel);
 593         FreePool(FileSystemInfoPtr);
 594     }
 595
 596     // TODO: if no official volume name is found or it is empty, use something else, e.g.:
 597     //   - name from bytes 3 to 10 of the boot sector
 598     //   - partition number
 599     //   - name derived from file system type or partition type
 600
 601     // get custom volume icon if present
 602     if (FileExists(Volume->RootDir, VOLUME_BADGE_NAME))
 603         Volume->VolBadgeImage = LoadIcns(Volume->RootDir, VOLUME_BADGE_NAME, 32);
 604     if (FileExists(Volume->RootDir, VOLUME_ICON_NAME)) {
 605        Volume->VolIconImage = LoadIcns(Volume->RootDir, VOLUME_ICON_NAME, 128);
 606     }
 607 }
 608
 609 static VOID ScanExtendedPartition(REFIT_VOLUME *WholeDiskVolume, MBR_PARTITION_INFO *MbrEntry)
 610 {
 611     EFI_STATUS              Status;
 612     REFIT_VOLUME            *Volume;
 613     UINT32                  ExtBase, ExtCurrent, NextExtCurrent;
 614     UINTN                   i;
 615     UINTN                   LogicalPartitionIndex = 4;
 616     UINT8                   SectorBuffer[512];
 617     BOOLEAN                 Bootable;
 618     MBR_PARTITION_INFO      *EMbrTable;
 619
 620     ExtBase = MbrEntry->StartLBA;
 621
 622     for (ExtCurrent = ExtBase; ExtCurrent; ExtCurrent = NextExtCurrent) {
 623         // read current EMBR
 624       Status = refit_call5_wrapper(WholeDiskVolume->BlockIO->ReadBlocks,
 625                                    WholeDiskVolume->BlockIO,
 626                                    WholeDiskVolume->BlockIO->Media->MediaId,
 627                                    ExtCurrent, 512, SectorBuffer);
 628         if (EFI_ERROR(Status))
 629             break;
 630         if (*((UINT16 *)(SectorBuffer + 510)) != 0xaa55)
 631             break;
 632         EMbrTable = (MBR_PARTITION_INFO *)(SectorBuffer + 446);
 633
 634         // scan logical partitions in this EMBR
 635         NextExtCurrent = 0;
 636         for (i = 0; i < 4; i++) {
 637             if ((EMbrTable[i].Flags != 0x00 && EMbrTable[i].Flags != 0x80) ||
 638                 EMbrTable[i].StartLBA == 0 || EMbrTable[i].Size == 0)
 639                 break;
 640             if (IS_EXTENDED_PART_TYPE(EMbrTable[i].Type)) {
 641                 // set next ExtCurrent
 642                 NextExtCurrent = ExtBase + EMbrTable[i].StartLBA;
 643                 break;
 644             } else {
 645
 646                 // found a logical partition
 647                 Volume = AllocateZeroPool(sizeof(REFIT_VOLUME));
 648                 Volume->DiskKind = WholeDiskVolume->DiskKind;
 649                 Volume->IsMbrPartition = TRUE;
 650                 Volume->MbrPartitionIndex = LogicalPartitionIndex++;
 651                 Volume->VolName = PoolPrint(L"Partition %d", Volume->MbrPartitionIndex + 1);
 652                 Volume->BlockIO = WholeDiskVolume->BlockIO;
 653                 Volume->BlockIOOffset = ExtCurrent + EMbrTable[i].StartLBA;
 654                 Volume->WholeDiskBlockIO = WholeDiskVolume->BlockIO;
 655
 656                 Bootable = FALSE;
 657                 ScanVolumeBootcode(Volume, &Bootable);
 658                 if (!Bootable)
 659                     Volume->HasBootCode = FALSE;
 660
 661                 ScanVolumeDefaultIcon(Volume);
 662
 663                 AddListElement((VOID ***) &Volumes, &VolumesCount, Volume);
 664
 665             }
 666         }
 667     }
 668 }
 669
 670 VOID ScanVolumes(VOID)
 671 {
 672     EFI_STATUS              Status;
 673     UINTN                   HandleCount = 0;
 674     UINTN                   HandleIndex;
 675     EFI_HANDLE              *Handles;
 676     REFIT_VOLUME            *Volume, *WholeDiskVolume;
 677     UINTN                   VolumeIndex, VolumeIndex2;
 678     MBR_PARTITION_INFO      *MbrTable;
 679     UINTN                   PartitionIndex;
 680     UINT8                   *SectorBuffer1, *SectorBuffer2;
 681     UINTN                   SectorSum, i;
 682
 683     FreePool(Volumes);
 684     Volumes = NULL;
 685     VolumesCount = 0;
 686
 687     // get all filesystem handles
 688     Status = LibLocateHandle(ByProtocol, &BlockIoProtocol, NULL, &HandleCount, &Handles);
 689     // was: &FileSystemProtocol
 690     if (Status == EFI_NOT_FOUND)
 691         return;  // no filesystems. strange, but true...
 692     if (CheckError(Status, L"while listing all file systems"))
 693         return;
 694
 695     // first pass: collect information about all handles
 696     for (HandleIndex = 0; HandleIndex < HandleCount; HandleIndex++) {
 697         Volume = AllocateZeroPool(sizeof(REFIT_VOLUME));
 698         Volume->DeviceHandle = Handles[HandleIndex];
 699         ScanVolume(Volume);
 700
 701         AddListElement((VOID ***) &Volumes, &VolumesCount, Volume);
 702
 703         if (Volume->DeviceHandle == SelfLoadedImage->DeviceHandle)
 704             SelfVolume = Volume;
 705     }
 706     FreePool(Handles);
 707
 708     if (SelfVolume == NULL)
 709         Print(L"WARNING: SelfVolume not found");
 710
 711     // second pass: relate partitions and whole disk devices
 712     for (VolumeIndex = 0; VolumeIndex < VolumesCount; VolumeIndex++) {
 713         Volume = Volumes[VolumeIndex];
 714         // check MBR partition table for extended partitions
 715         if (Volume->BlockIO != NULL && Volume->WholeDiskBlockIO != NULL &&
 716             Volume->BlockIO == Volume->WholeDiskBlockIO && Volume->BlockIOOffset == 0 &&
 717             Volume->MbrPartitionTable != NULL) {
 718             MbrTable = Volume->MbrPartitionTable;
 719             for (PartitionIndex = 0; PartitionIndex < 4; PartitionIndex++) {
 720                 if (IS_EXTENDED_PART_TYPE(MbrTable[PartitionIndex].Type)) {
 721                    ScanExtendedPartition(Volume, MbrTable + PartitionIndex);
 722                 }
 723             }
 724         }
 725
 726         // search for corresponding whole disk volume entry
 727         WholeDiskVolume = NULL;
 728         if (Volume->BlockIO != NULL && Volume->WholeDiskBlockIO != NULL &&
 729             Volume->BlockIO != Volume->WholeDiskBlockIO) {
 730             for (VolumeIndex2 = 0; VolumeIndex2 < VolumesCount; VolumeIndex2++) {
 731                 if (Volumes[VolumeIndex2]->BlockIO == Volume->WholeDiskBlockIO &&
 732                     Volumes[VolumeIndex2]->BlockIOOffset == 0)
 733                     WholeDiskVolume = Volumes[VolumeIndex2];
 734             }
 735         }
 736
 737         if (WholeDiskVolume != NULL && WholeDiskVolume->MbrPartitionTable != NULL) {
 738             // check if this volume is one of the partitions in the table
 739             MbrTable = WholeDiskVolume->MbrPartitionTable;
 740             SectorBuffer1 = AllocatePool(512);
 741             SectorBuffer2 = AllocatePool(512);
 742             for (PartitionIndex = 0; PartitionIndex < 4; PartitionIndex++) {
 743                 // check size
 744                 if ((UINT64)(MbrTable[PartitionIndex].Size) != Volume->BlockIO->Media->LastBlock + 1)
 745                     continue;
 746
 747                 // compare boot sector read through offset vs. directly
 748                 Status = refit_call5_wrapper(Volume->BlockIO->ReadBlocks,
 749                                              Volume->BlockIO, Volume->BlockIO->Media->MediaId,
 750                                              Volume->BlockIOOffset, 512, SectorBuffer1);
 751                 if (EFI_ERROR(Status))
 752                     break;
 753                 Status = refit_call5_wrapper(Volume->WholeDiskBlockIO->ReadBlocks,
 754                                              Volume->WholeDiskBlockIO, Volume->WholeDiskBlockIO->Media->MediaId,
 755                                              MbrTable[PartitionIndex].StartLBA, 512, SectorBuffer2);
 756                 if (EFI_ERROR(Status))
 757                     break;
 758                 if (CompareMem(SectorBuffer1, SectorBuffer2, 512) != 0)
 759                     continue;
 760                 SectorSum = 0;
 761                 for (i = 0; i < 512; i++)
 762                     SectorSum += SectorBuffer1[i];
 763                 if (SectorSum < 1000)
 764                     continue;
 765
 766                 // TODO: mark entry as non-bootable if it is an extended partition
 767
 768                 // now we're reasonably sure the association is correct...
 769                 Volume->IsMbrPartition = TRUE;
 770                 Volume->MbrPartitionIndex = PartitionIndex;
 771                 if (Volume->VolName == NULL)
 772                     Volume->VolName = PoolPrint(L"Partition %d", PartitionIndex + 1);
 773                 break;
 774             }
 775
 776             FreePool(SectorBuffer1);
 777             FreePool(SectorBuffer2);
 778         }
 779
 780     }
 781 } /* VOID ScanVolumes() */
 782
 783 static VOID UninitVolumes(VOID)
 784 {
 785     REFIT_VOLUME            *Volume;
 786     UINTN                   VolumeIndex;
 787
 788     for (VolumeIndex = 0; VolumeIndex < VolumesCount; VolumeIndex++) {
 789         Volume = Volumes[VolumeIndex];
 790
 791         if (Volume->RootDir != NULL) {
 792             refit_call1_wrapper(Volume->RootDir->Close, Volume->RootDir);
 793             Volume->RootDir = NULL;
 794         }
 795
 796         Volume->DeviceHandle = NULL;
 797         Volume->BlockIO = NULL;
 798         Volume->WholeDiskBlockIO = NULL;
 799     }
 800 }
 801
 802 VOID ReinitVolumes(VOID)
 803 {
 804     EFI_STATUS              Status;
 805     REFIT_VOLUME            *Volume;
 806     UINTN                   VolumeIndex;
 807     EFI_DEVICE_PATH         *RemainingDevicePath;
 808     EFI_HANDLE              DeviceHandle, WholeDiskHandle;
 809
 810     for (VolumeIndex = 0; VolumeIndex < VolumesCount; VolumeIndex++) {
 811         Volume = Volumes[VolumeIndex];
 812
 813         if (Volume->DevicePath != NULL) {
 814             // get the handle for that path
 815             RemainingDevicePath = Volume->DevicePath;
 816             Status = refit_call3_wrapper(BS->LocateDevicePath, &BlockIoProtocol, &RemainingDevicePath, &DeviceHandle);
 817
 818             if (!EFI_ERROR(Status)) {
 819                 Volume->DeviceHandle = DeviceHandle;
 820
 821                 // get the root directory
 822                 Volume->RootDir = LibOpenRoot(Volume->DeviceHandle);
 823
 824             } else
 825                 CheckError(Status, L"from LocateDevicePath");
 826         }
 827
 828         if (Volume->WholeDiskDevicePath != NULL) {
 829             // get the handle for that path
 830             RemainingDevicePath = Volume->WholeDiskDevicePath;
 831             Status = refit_call3_wrapper(BS->LocateDevicePath, &BlockIoProtocol, &RemainingDevicePath, &WholeDiskHandle);
 832
 833             if (!EFI_ERROR(Status)) {
 834                 // get the BlockIO protocol
 835                 Status = refit_call3_wrapper(BS->HandleProtocol, WholeDiskHandle, &BlockIoProtocol, (VOID **) &Volume->WholeDiskBlockIO);
 836                 if (EFI_ERROR(Status)) {
 837                     Volume->WholeDiskBlockIO = NULL;
 838                     CheckError(Status, L"from HandleProtocol");
 839                 }
 840             } else
 841                 CheckError(Status, L"from LocateDevicePath");
 842         }
 843     }
 844 }
 845
 846 //
 847 // file and dir functions
 848 //
 849
 850 BOOLEAN FileExists(IN EFI_FILE *BaseDir, IN CHAR16 *RelativePath)
 851 {
 852     EFI_STATUS         Status;
 853     EFI_FILE_HANDLE    TestFile;
 854
 855     Status = refit_call5_wrapper(BaseDir->Open, BaseDir, &TestFile, RelativePath, EFI_FILE_MODE_READ, 0);
 856     if (Status == EFI_SUCCESS) {
 857         refit_call1_wrapper(TestFile->Close, TestFile);
 858         return TRUE;
 859     }
 860     return FALSE;
 861 }
 862
 863 EFI_STATUS DirNextEntry(IN EFI_FILE *Directory, IN OUT EFI_FILE_INFO **DirEntry, IN UINTN FilterMode)
 864 {
 865     EFI_STATUS Status;
 866     VOID *Buffer;
 867     UINTN LastBufferSize, BufferSize;
 868     INTN IterCount;
 869
 870     for (;;) {
 871
 872         // free pointer from last call
 873         if (*DirEntry != NULL) {
 874             FreePool(*DirEntry);
 875             *DirEntry = NULL;
 876         }
 877
 878         // read next directory entry
 879         LastBufferSize = BufferSize = 256;
 880         Buffer = AllocatePool(BufferSize);
 881         for (IterCount = 0; ; IterCount++) {
 882             Status = refit_call3_wrapper(Directory->Read, Directory, &BufferSize, Buffer);
 883             if (Status != EFI_BUFFER_TOO_SMALL || IterCount >= 4)
 884                 break;
 885             if (BufferSize <= LastBufferSize) {
 886                 Print(L"FS Driver requests bad buffer size %d (was %d), using %d instead\n", BufferSize, LastBufferSize, LastBufferSize * 2);
 887                 BufferSize = LastBufferSize * 2;
 888 #if REFIT_DEBUG > 0
 889             } else {
 890                 Print(L"Reallocating buffer from %d to %d\n", LastBufferSize, BufferSize);
 891 #endif
 892             }
 893             Buffer = ReallocatePool(Buffer, LastBufferSize, BufferSize);
 894             LastBufferSize = BufferSize;
 895         }
 896         if (EFI_ERROR(Status)) {
 897             FreePool(Buffer);
 898             break;
 899         }
 900
 901         // check for end of listing
 902         if (BufferSize == 0) {    // end of directory listing
 903             FreePool(Buffer);
 904             break;
 905         }
 906
 907         // entry is ready to be returned
 908         *DirEntry = (EFI_FILE_INFO *)Buffer;
 909
 910         // filter results
 911         if (FilterMode == 1) {   // only return directories
 912             if (((*DirEntry)->Attribute & EFI_FILE_DIRECTORY))
 913                 break;
 914         } else if (FilterMode == 2) {   // only return files
 915             if (((*DirEntry)->Attribute & EFI_FILE_DIRECTORY) == 0)
 916                 break;
 917         } else                   // no filter or unknown filter -> return everything
 918             break;
 919
 920     }
 921     return Status;
 922 }
 923
 924 VOID DirIterOpen(IN EFI_FILE *BaseDir, IN CHAR16 *RelativePath OPTIONAL, OUT REFIT_DIR_ITER *DirIter)
 925 {
 926     if (RelativePath == NULL) {
 927         DirIter->LastStatus = EFI_SUCCESS;
 928         DirIter->DirHandle = BaseDir;
 929         DirIter->CloseDirHandle = FALSE;
 930     } else {
 931         DirIter->LastStatus = refit_call5_wrapper(BaseDir->Open, BaseDir, &(DirIter->DirHandle), RelativePath, EFI_FILE_MODE_READ, 0);
 932         DirIter->CloseDirHandle = EFI_ERROR(DirIter->LastStatus) ? FALSE : TRUE;
 933     }
 934     DirIter->LastFileInfo = NULL;
 935 }
 936
 937 BOOLEAN DirIterNext(IN OUT REFIT_DIR_ITER *DirIter, IN UINTN FilterMode, IN CHAR16 *FilePattern OPTIONAL,
 938                     OUT EFI_FILE_INFO **DirEntry)
 939 {
 940     if (DirIter->LastFileInfo != NULL) {
 941         FreePool(DirIter->LastFileInfo);
 942         DirIter->LastFileInfo = NULL;
 943     }
 944
 945     if (EFI_ERROR(DirIter->LastStatus))
 946         return FALSE;   // stop iteration
 947
 948     for (;;) {
 949         DirIter->LastStatus = DirNextEntry(DirIter->DirHandle, &(DirIter->LastFileInfo), FilterMode);
 950         if (EFI_ERROR(DirIter->LastStatus))
 951             return FALSE;
 952         if (DirIter->LastFileInfo == NULL)  // end of listing
 953             return FALSE;
 954         if (FilePattern != NULL) {
 955             if ((DirIter->LastFileInfo->Attribute & EFI_FILE_DIRECTORY))
 956                 break;
 957             if (MetaiMatch(DirIter->LastFileInfo->FileName, FilePattern))
 958                 break;
 959             // else continue loop
 960         } else
 961             break;
 962     }
 963
 964     *DirEntry = DirIter->LastFileInfo;
 965     return TRUE;
 966 }
 967
 968 EFI_STATUS DirIterClose(IN OUT REFIT_DIR_ITER *DirIter)
 969 {
 970     if (DirIter->LastFileInfo != NULL) {
 971         FreePool(DirIter->LastFileInfo);
 972         DirIter->LastFileInfo = NULL;
 973     }
 974     if (DirIter->CloseDirHandle)
 975         refit_call1_wrapper(DirIter->DirHandle->Close, DirIter->DirHandle);
 976     return DirIter->LastStatus;
 977 }
 978
 979 //
 980 // file name manipulation
 981 //
 982
 983 // Returns the filename portion (minus path name) of the
 984 // specified file
 985 CHAR16 * Basename(IN CHAR16 *Path)
 986 {
 987     CHAR16  *FileName;
 988     UINTN   i;
 989
 990     FileName = Path;
 991
 992     if (Path != NULL) {
 993         for (i = StrLen(Path); i > 0; i--) {
 994             if (Path[i-1] == '\\' || Path[i-1] == '/') {
 995                 FileName = Path + i;
 996                 break;
 997             }
 998         }
 999     }
1000
1001     return FileName;
1002 }
1003
1004 VOID ReplaceExtension(IN OUT CHAR16 *Path, IN CHAR16 *Extension)
1005 {
1006     UINTN i;
1007
1008     for (i = StrLen(Path); i >= 0; i--) {
1009         if (Path[i] == '.') {
1010             Path[i] = 0;
1011             break;
1012         }
1013         if (Path[i] == '\\' || Path[i] == '/')
1014             break;
1015     }
1016     StrCat(Path, Extension);
1017 }
1018
1019 //
1020 // memory string search
1021 //
1022
1023 INTN FindMem(IN VOID *Buffer, IN UINTN BufferLength, IN VOID *SearchString, IN UINTN SearchStringLength)
1024 {
1025     UINT8 *BufferPtr;
1026     UINTN Offset;
1027
1028     BufferPtr = Buffer;
1029     BufferLength -= SearchStringLength;
1030     for (Offset = 0; Offset < BufferLength; Offset++, BufferPtr++) {
1031         if (CompareMem(BufferPtr, SearchString, SearchStringLength) == 0)
1032             return (INTN)Offset;
1033     }
1034
1035     return -1;
1036 }
1037
1038 // Performs a case-insensitive search of BigStr for SmallStr.
1039 // Returns TRUE if found, FALSE if not.
1040 BOOLEAN StriSubCmp(IN CHAR16 *SmallStr, IN CHAR16 *BigStr) {
1041    CHAR16 *SmallCopy, *BigCopy;
1042    BOOLEAN Found = FALSE;
1043    UINTN StartPoint = 0, NumCompares = 0, SmallLen = 0;
1044
1045    if ((SmallStr != NULL) && (BigStr != NULL) && (StrLen(BigStr) >= StrLen(SmallStr))) {
1046       SmallCopy = StrDuplicate(SmallStr);
1047       BigCopy = StrDuplicate(BigStr);
1048       StrLwr(SmallCopy);
1049       StrLwr(BigCopy);
1050       SmallLen = StrLen(SmallCopy);
1051       NumCompares = StrLen(BigCopy) - SmallLen + 1;
1052       while ((!Found) && (StartPoint < NumCompares)) {
1053          Found = (StrnCmp(SmallCopy, &BigCopy[StartPoint++], SmallLen) == 0);
1054       } // while
1055       FreePool(SmallCopy);
1056       FreePool(BigCopy);
1057    } // if
1058
1059    return (Found);
1060 } // BOOLEAN StriSubCmp()
1061
1062 // Merges two strings, creating a new one and returning a pointer to it.
1063 // If AddChar != 0, the specified character is placed between the two original
1064 // strings (unless the first string is NULL). The original input string
1065 // *First is de-allocated and replaced by the new merged string.
1066 // This is similar to StrCat, but safer and more flexible because
1067 // MergeStrings allocates memory that's the correct size for the
1068 // new merged string, so it can take a NULL *First and it cleans
1069 // up the old memory. It should *NOT* be used with a constant
1070 // *First, though....
1071 VOID MergeStrings(IN OUT CHAR16 **First, IN CHAR16 *Second, CHAR16 AddChar) {
1072    UINTN Length1 = 0, Length2 = 0;
1073    CHAR16* NewString;
1074
1075    if (*First != NULL)
1076       Length1 = StrLen(*First);
1077    if (Second != NULL)
1078       Length2 = StrLen(Second);
1079    NewString = AllocatePool(sizeof(CHAR16) * (Length1 + Length2 + 2));
1080    if (NewString != NULL) {
1081       NewString[0] = L'\0';
1082       if (*First != NULL) {
1083          StrCat(NewString, *First);
1084          if (AddChar) {
1085             NewString[Length1] = AddChar;
1086             NewString[Length1 + 1] = 0;
1087          } // if (AddChar)
1088       } // if (*First != NULL)
1089       if (Second != NULL)
1090          StrCat(NewString, Second);
1091       FreePool(*First);
1092       *First = NewString;
1093    } else {
1094       Print(L"Error! Unable to allocate memory in MergeStrings()!\n");
1095    } // if/else
1096 } // static CHAR16* MergeStrings()
1097
1098 // Takes an input pathname (*Path) and locates the final directory component
1099 // of that name. For instance, if the input path is 'EFI\foo\bar.efi', this
1100 // function returns the string 'foo'.
1101 // Assumes the pathname is separated with backslashes.
1102 CHAR16 *FindLastDirName(IN CHAR16 *Path) {
1103    UINTN i, StartOfElement = 0, EndOfElement = 0, PathLength, CopyLength;
1104    CHAR16 *Found = NULL;
1105
1106    PathLength = StrLen(Path);
1107    // Find start & end of target element
1108    for (i = 0; i < PathLength; i++) {
1109       if (Path[i] == '\\') {
1110          StartOfElement = EndOfElement;
1111          EndOfElement = i;
1112       } // if
1113    } // for
1114    // Extract the target element
1115    if (EndOfElement > 0) {
1116       while ((StartOfElement < PathLength) && (Path[StartOfElement] == '\\')) {
1117          StartOfElement++;
1118       } // while
1119       EndOfElement--;
1120       if (EndOfElement >= StartOfElement) {
1121          CopyLength = EndOfElement - StartOfElement + 1;
1122          Found = StrDuplicate(&Path[StartOfElement]);
1123          if (Found != NULL)
1124             Found[CopyLength] = 0;
1125       } // if (EndOfElement >= StartOfElement)
1126    } // if (EndOfElement > 0)
1127    return (Found);
1128 } // CHAR16 *FindLastDirName
1129
1130 // Returns the directory portion of a pathname. For instance,
1131 // if FullPath is 'EFI\foo\bar.efi', this function returns the
1132 // string 'EFI\foo'.
1133 CHAR16 *FindPath(IN CHAR16* FullPath) {
1134    UINTN i, LastBackslash = 0;
1135    CHAR16 *PathOnly;
1136
1137    for (i = 0; i < StrLen(FullPath); i++) {
1138       if (FullPath[i] == '\\')
1139          LastBackslash = i;
1140    } // for
1141    PathOnly = StrDuplicate(FullPath);
1142    PathOnly[LastBackslash] = 0;
1143    return (PathOnly);
1144 }
1145
1146 // Returns all the digits in the input string, including intervening
1147 // non-digit characters. For instance, if InString is "foo-3.3.4-7.img",
1148 // this function returns "3.3.4-7". If InString contains no digits,
1149 // the return value is NULL.
1150 CHAR16 *FindNumbers(IN CHAR16 *InString) {
1151    UINTN i, StartOfElement, EndOfElement = 0, InLength, CopyLength;
1152    CHAR16 *Found = NULL;
1153
1154    InLength = StartOfElement = StrLen(InString);
1155    // Find start & end of target element
1156    for (i = 0; i < InLength; i++) {
1157       if ((InString[i] >= '0') && (InString[i] <= '9')) {
1158          if (StartOfElement > i)
1159             StartOfElement = i;
1160          if (EndOfElement < i)
1161             EndOfElement = i;
1162       } // if
1163    } // for
1164    // Extract the target element
1165    if (EndOfElement > 0) {
1166       if (EndOfElement >= StartOfElement) {
1167          CopyLength = EndOfElement - StartOfElement + 1;
1168          Found = StrDuplicate(&InString[StartOfElement]);
1169          if (Found != NULL)
1170             Found[CopyLength] = 0;
1171       } // if (EndOfElement >= StartOfElement)
1172    } // if (EndOfElement > 0)
1173    return (Found);
1174 } // CHAR16 *FindNumbers()
1175
1176 // Find the #Index element (numbered from 0) in a comma-delimited string
1177 // of elements.
1178 // Returns the found element, or NULL if Index is out of range or InString
1179 // is NULL.
1180 CHAR16 *FindCommaDelimited(IN CHAR16 *InString, IN UINTN Index) {
1181    UINTN    StartPos = 0, CurPos = 0;
1182    BOOLEAN  Found = FALSE;
1183    CHAR16   *FoundString = NULL;
1184
1185    if (InString != NULL) {
1186       // After while() loop, StartPos marks start of item #Index
1187       while ((Index > 0) && (CurPos < StrLen(InString))) {
1188          if (InString[CurPos] == L',') {
1189             Index--;
1190             StartPos = CurPos + 1;
1191          } // if
1192          CurPos++;
1193       } // while
1194       // After while() loop, CurPos is one past the end of the element
1195       while ((CurPos < StrLen(InString)) && (!Found)) {
1196          if (InString[CurPos] == L',')
1197             Found = TRUE;
1198          else
1199             CurPos++;
1200       } // while
1201       if (Index == 0)
1202          FoundString = StrDuplicate(&InString[StartPos]);
1203       if (FoundString != NULL)
1204          FoundString[CurPos - StartPos] = 0;
1205    } // if
1206    return (FoundString);
1207 } // CHAR16 *FindCommaDelimited()