CloverBootloader/rEFIt_UEFI/Platform/Volumes.h

/*
 * Volumes.h
 *
 *  Created on: Feb 4, 2021
 *      Author: jief
 */

#ifndef PLATFORM_VOLUMES_H_
#define PLATFORM_VOLUMES_H_

#include <Efi.h>
#include "../cpp_foundation/XString.h"
#include "../libeg/libeg.h"

extern "C" {
//#include <Library/OcConfigurationLib.h>
  #include <Guid/AppleApfsInfo.h>
}



class LEGACY_OS
{
public:
  UINT8         Type;
  XStringW      IconName;
  XStringW      Name;

  LEGACY_OS() : Type(0), IconName(), Name() {}
  LEGACY_OS(const LEGACY_OS& other) = delete; // Can be defined if needed
  const LEGACY_OS& operator = ( const LEGACY_OS & ) = delete; // Can be defined if needed
  ~LEGACY_OS() {}
} ;

class REFIT_VOLUME {
public:
  EFI_DEVICE_PATH     *DevicePath = 0;
  EFI_HANDLE          DeviceHandle = 0;
  EFI_FILE            *RootDir = 0;
  XStringW            DevicePathString = XStringW();
  XStringW            VolName = XStringW(); // comes from EfiLibFileSystemInfo, EfiLibFileSystemVolumeLabelInfo, "EFI" if gEfiPartTypeSystemPartGuid or "Unknown HD"
  XStringW            VolLabel = XStringW(); // comes from \\.VolumeLabel.txt, or empty.
  UINT8               DiskKind = 0;
  LEGACY_OS           *LegacyOS = 0;
  BOOLEAN             Hidden = 0;
  UINT8               BootType = 0;
  BOOLEAN             IsAppleLegacy = 0;
  BOOLEAN             HasBootCode = 0;
  BOOLEAN             IsMbrPartition = 0;
  UINTN               MbrPartitionIndex = 0;
  EFI_BLOCK_IO        *BlockIO = 0;
  UINT64              BlockIOOffset = 0;
  EFI_BLOCK_IO        *WholeDiskBlockIO = 0;
  EFI_DEVICE_PATH     *WholeDiskDevicePath = 0;
  EFI_HANDLE          WholeDiskDeviceHandle = 0;
  MBR_PARTITION_INFO  *MbrPartitionTable = 0;
  UINT32              DriveCRC32 = 0;
  EFI_GUID            RootUUID = EFI_GUID({0,0,0,{0,0,0,0,0,0,0,0}}); //for recovery it is UUID of parent partition
  UINT64              SleepImageOffset = 0;
  XStringW            osxVolumeName = XStringW(); // comes from \\System\\Library\\CoreServices\\.disk_label.contentDetails, or empty.
  XString8            ApfsFileSystemUUID = XString8(); // apfs file system UUID of that partition. It's not the UUID of subfolder like in Preboot.
  XString8            ApfsContainerUUID = XString8();
  APPLE_APFS_VOLUME_ROLE  ApfsRole = 0;
  XString8Array        ApfsTargetUUIDArray = XString8Array(); // this is the array of folders that are named as UUID

//  REFIT_VOLUME() : DevicePath(0), DeviceHandle(0), RootDir(0), DevicePathString(), VolName(), VolLabel(), DiskKind(0), LegacyOS(0), Hidden(0), BootType(0), IsAppleLegacy(0), HasBootCode(0),
//                   IsMbrPartition(0), MbrPartitionIndex(0), BlockIO(0), BlockIOOffset(0), WholeDiskBlockIO(0), WholeDiskDevicePath(0), WholeDiskDeviceHandle(0),
//                   MbrPartitionTable(0), DriveCRC32(0), RootUUID({0,0,0,{0,0,0,0,0,0,0,0}}), SleepImageOffset(0), ApfsFileSystemUUID(), ApfsTargetUUIDArray()
//                 {}
  REFIT_VOLUME() {};
  REFIT_VOLUME(const REFIT_VOLUME& other) = delete; // Can be defined if needed
  const REFIT_VOLUME& operator = ( const REFIT_VOLUME & ) = delete; // Can be defined if needed
  ~REFIT_VOLUME() {}

  const XStringW getVolLabelOrOSXVolumeNameOrVolName() {
    if ( VolLabel.notEmpty() ) return VolLabel;
    if ( osxVolumeName.notEmpty() ) return osxVolumeName;
    return VolName;
  }
};



class VolumesArrayClass : public XObjArray<REFIT_VOLUME>
{
  public:
//    REFIT_VOLUME* getApfsPartitionWithUUID(const XString8& ApfsContainerUUID, const XString8& APFSTargetUUID);
    REFIT_VOLUME* getVolumeWithApfsContainerUUIDAndFileSystemUUID(const XString8& ApfsContainerUUID, const XString8& ApfsFileSystemUUID);
    /*
     * Return : NULL if not found OR more than one partition with this role is found in this container
     */
    REFIT_VOLUME* getVolumeWithApfsContainerUUIDAndRole(const XString8& ApfsContainerUUID, APPLE_APFS_VOLUME_ROLE roleMask);

};

extern VolumesArrayClass Volumes;
extern REFIT_VOLUME     *SelfVolume;




#endif /* PLATFORM_VOLUMES_H_ */