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