HFSVolumes.h

Go to the documentation of this file.

 
#ifndef __HFSVOLUMES__
#define __HFSVOLUMES__
 
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
 
#ifndef __FILES__
#include <Files.h>
#endif
 
#ifndef __FINDER__
#include <Finder.h>
#endif
 
#if PRAGMA_ONCE
#pragma once
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if PRAGMA_IMPORT
#pragma import on
#endif
 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = mac68k
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(push, 2)
#elif PRAGMA_STRUCT_PACK
#pragma pack(2)
#endif
 
enum {
  kHFSSigWord = 0x4244,     
  kHFSPlusSigWord = 0x482B, 
  kHFSPlusVersion = 0x0004, 
  kHFSPlusMountVersion =
      FOUR_CHAR_CODE('8.10') 
};
 
typedef UInt32 HFSCatalogNodeID;
enum {
  kHFSMaxVolumeNameChars = 27,
  kHFSMaxFileNameChars = 31,
  kHFSPlusMaxFileNameChars = 255
};
 
struct HFSExtentKey {
  UInt8 keyLength;         
  UInt8 forkType;          
  HFSCatalogNodeID fileID; 
  UInt16 startBlock; 
};
typedef struct HFSExtentKey HFSExtentKey;
struct HFSPlusExtentKey {
  UInt16 keyLength;        
  UInt8 forkType;          
  UInt8 pad;               
  HFSCatalogNodeID fileID; 
  UInt32 startBlock; 
};
typedef struct HFSPlusExtentKey HFSPlusExtentKey;
enum { kHFSExtentDensity = 3, kHFSPlusExtentDensity = 8 };
 
struct HFSExtentDescriptor {
  UInt16 startBlock; 
  UInt16 blockCount; 
};
typedef struct HFSExtentDescriptor HFSExtentDescriptor;
struct HFSPlusExtentDescriptor {
  UInt32 startBlock; 
  UInt32 blockCount; 
};
typedef struct HFSPlusExtentDescriptor HFSPlusExtentDescriptor;
typedef HFSExtentDescriptor HFSExtentRecord[3];
typedef HFSPlusExtentDescriptor HFSPlusExtentRecord[8];
 
struct HFSPlusForkData {
  UInt64 logicalSize;          
  UInt32 clumpSize;            
  UInt32 totalBlocks;          
  HFSPlusExtentRecord extents; 
};
typedef struct HFSPlusForkData HFSPlusForkData;
struct HFSPlusPermissions {
  UInt32 ownerID;     
  UInt32 groupID;     
  UInt32 permissions; 
  UInt32 specialDevice; 
};
typedef struct HFSPlusPermissions HFSPlusPermissions;
enum {
  kHFSRootParentID = 1,   
  kHFSRootFolderID = 2,   
  kHFSExtentsFileID = 3,  
  kHFSCatalogFileID = 4,  
  kHFSBadBlockFileID = 5, 
  kHFSAllocationFileID =
      6,                 
  kHFSStartupFileID = 7, 
  kHFSAttributesFileID = 8, 
  kHFSBogusExtentFileID = 15, 
  kHFSFirstUserCatalogNodeID = 16
};
 
struct HFSCatalogKey {
  UInt8 keyLength;           
  UInt8 reserved;            
  HFSCatalogNodeID parentID; 
  Str31 nodeName;            
};
typedef struct HFSCatalogKey HFSCatalogKey;
struct HFSPlusCatalogKey {
  UInt16 keyLength;          
  HFSCatalogNodeID parentID; 
  HFSUniStr255 nodeName;     
};
typedef struct HFSPlusCatalogKey HFSPlusCatalogKey;
 
enum {
  kHFSFolderRecord = 0x0100,       
  kHFSFileRecord = 0x0200,         
  kHFSFolderThreadRecord = 0x0300, 
  kHFSFileThreadRecord = 0x0400,   
  kHFSPlusFolderRecord = 1,        
  kHFSPlusFileRecord = 2,          
  kHFSPlusFolderThreadRecord = 3,  
  kHFSPlusFileThreadRecord = 4     
};
 
enum {
  kHFSFileLockedBit = 0x0000, 
  kHFSFileLockedMask = 0x0001,
  kHFSThreadExistsBit = 0x0001, 
  kHFSThreadExistsMask = 0x0002
};
 
struct HFSCatalogFolder {
  SInt16 recordType;         
  UInt16 flags;              
  UInt16 valence;            
  HFSCatalogNodeID folderID; 
  UInt32 createDate;         
  UInt32 modifyDate;         
  UInt32 backupDate;         
  DInfo userInfo;            
  DXInfo finderInfo;         
  UInt32 reserved[4];        
};
typedef struct HFSCatalogFolder HFSCatalogFolder;
struct HFSPlusCatalogFolder {
  SInt16 recordType;         
  UInt16 flags;              
  UInt32 valence;            
  HFSCatalogNodeID folderID; 
  UInt32 createDate;         
  UInt32 contentModDate;     
  UInt32 attributeModDate;   
  UInt32 accessDate;         
  UInt32 backupDate;         
  HFSPlusPermissions permissions; 
  DInfo userInfo;                 
  DXInfo finderInfo;              
  UInt32 textEncoding;            
  UInt32 reserved;                
};
typedef struct HFSPlusCatalogFolder HFSPlusCatalogFolder;
struct HFSCatalogFile {
  SInt16 recordType;           
  UInt8 flags;                 
  SInt8 fileType;              
  FInfo userInfo;              
  HFSCatalogNodeID fileID;     
  UInt16 dataStartBlock;       
  SInt32 dataLogicalSize;      
  SInt32 dataPhysicalSize;     
  UInt16 rsrcStartBlock;       
  SInt32 rsrcLogicalSize;      
  SInt32 rsrcPhysicalSize;     
  UInt32 createDate;           
  UInt32 modifyDate;           
  UInt32 backupDate;           
  FXInfo finderInfo;           
  UInt16 clumpSize;            
  HFSExtentRecord dataExtents; 
  HFSExtentRecord rsrcExtents; 
  UInt32 reserved;             
};
typedef struct HFSCatalogFile HFSCatalogFile;
struct HFSPlusCatalogFile {
  SInt16 recordType;       
  UInt16 flags;            
  UInt32 reserved1;        
  HFSCatalogNodeID fileID; 
  UInt32 createDate;       
  UInt32 contentModDate;   
  UInt32 attributeModDate; 
  UInt32 accessDate;       
  UInt32 backupDate;       
  HFSPlusPermissions permissions; 
  FInfo userInfo;                 
  FXInfo finderInfo;              
  UInt32 textEncoding;            
  UInt32 reserved2;               
  HFSPlusForkData dataFork;     
  HFSPlusForkData resourceFork; 
};
typedef struct HFSPlusCatalogFile HFSPlusCatalogFile;
struct HFSCatalogThread {
  SInt16 recordType;         
  SInt32 reserved[2];        
  HFSCatalogNodeID parentID; 
  Str31 nodeName;            
};
typedef struct HFSCatalogThread HFSCatalogThread;
struct HFSPlusCatalogThread {
  SInt16 recordType;         
  SInt16 reserved;           
  HFSCatalogNodeID parentID; 
  HFSUniStr255 nodeName;     
};
typedef struct HFSPlusCatalogThread HFSPlusCatalogThread;
 
enum {
  kHFSPlusAttrInlineData = 0x10, 
  kHFSPlusAttrForkData = 0x20,   
  kHFSPlusAttrExtents = 0x30     
};
 
struct HFSPlusAttrInlineData {
  UInt32 recordType; 
  UInt32 reserved;
  UInt32 logicalSize; 
  UInt8 userData[2];  
};
typedef struct HFSPlusAttrInlineData HFSPlusAttrInlineData;
struct HFSPlusAttrForkData {
  UInt32 recordType; 
  UInt32 reserved;
  HFSPlusForkData theFork; 
};
typedef struct HFSPlusAttrForkData HFSPlusAttrForkData;
struct HFSPlusAttrExtents {
  UInt32 recordType; 
  UInt32 reserved;
  HFSPlusExtentRecord extents; 
};
typedef struct HFSPlusAttrExtents HFSPlusAttrExtents;
union HFSPlusAttrRecord {
  UInt32 recordType;
  HFSPlusAttrInlineData inlineData;
  HFSPlusAttrForkData forkData;
  HFSPlusAttrExtents overflowExtents;
};
typedef union HFSPlusAttrRecord HFSPlusAttrRecord;
enum {
  kHFSPlusExtentKeyMaximumLength = sizeof(HFSPlusExtentKey) - sizeof(UInt16),
  kHFSExtentKeyMaximumLength = sizeof(HFSExtentKey) - sizeof(UInt8),
  kHFSPlusCatalogKeyMaximumLength = sizeof(HFSPlusCatalogKey) - sizeof(UInt16),
  kHFSPlusCatalogKeyMinimumLength =
      kHFSPlusCatalogKeyMaximumLength - sizeof(HFSUniStr255) + sizeof(UInt16),
  kHFSCatalogKeyMaximumLength = sizeof(HFSCatalogKey) - sizeof(UInt8),
  kHFSCatalogKeyMinimumLength =
      kHFSCatalogKeyMaximumLength - sizeof(Str31) + sizeof(UInt8),
  kHFSPlusCatalogMinNodeSize = 4096,
  kHFSPlusExtentMinNodeSize = 512,
  kHFSPlusAttrMinNodeSize = 4096
};
 
enum {
  kHFSVolumeHardwareLockBit = 7, 
  kHFSVolumeUnmountedBit = 8,    
  kHFSVolumeSparedBlocksBit = 9, 
  kHFSVolumeNoCacheRequiredBit =
      10, 
  kHFSBootVolumeInconsistentBit =
      11, 
  kHFSVolumeSoftwareLockBit = 15, 
  kHFSVolumeHardwareLockMask = 1 << kHFSVolumeHardwareLockBit,
  kHFSVolumeUnmountedMask = 1 << kHFSVolumeUnmountedBit,
  kHFSVolumeSparedBlocksMask = 1 << kHFSVolumeSparedBlocksBit,
  kHFSVolumeNoCacheRequiredMask = 1 << kHFSVolumeNoCacheRequiredBit,
  kHFSBootVolumeInconsistentMask = 1 << kHFSBootVolumeInconsistentBit,
  kHFSVolumeSoftwareLockMask = 1 << kHFSVolumeSoftwareLockBit,
  kHFSMDBAttributesMask = 0x8380
};
 
enum {
  kHFSCatalogNodeIDsReusedBit = 12, 
  kHFSCatalogNodeIDsReusedMask = 1 << kHFSCatalogNodeIDsReusedBit
};
 
struct HFSMasterDirectoryBlock {
 
  UInt16 drSigWord;  
  UInt32 drCrDate;   
  UInt32 drLsMod;    
  UInt16 drAtrb;     
  UInt16 drNmFls;    
  UInt16 drVBMSt;    
  UInt16 drAllocPtr; 
  UInt16 drNmAlBlks; 
  UInt32 drAlBlkSiz; 
  UInt32 drClpSiz;   
  UInt16 drAlBlSt;   
  UInt32 drNxtCNID;  
  UInt16 drFreeBks;  
  Str27 drVN;        
  UInt32 drVolBkUp;      
  UInt16 drVSeqNum;      
  UInt32 drWrCnt;        
  UInt32 drXTClpSiz;     
  UInt32 drCTClpSiz;     
  UInt16 drNmRtDirs;     
  UInt32 drFilCnt;       
  UInt32 drDirCnt;       
  SInt32 drFndrInfo[8];  
  UInt16 drEmbedSigWord; 
  HFSExtentDescriptor drEmbedExtent; 
  UInt32 drXTFlSize;                 
  HFSExtentRecord drXTExtRec; 
  UInt32 drCTFlSize;          
  HFSExtentRecord drCTExtRec; 
};
typedef struct HFSMasterDirectoryBlock HFSMasterDirectoryBlock;
struct HFSPlusVolumeHeader {
  UInt16 signature;          
  UInt16 version;            
  UInt32 attributes;         
  UInt32 lastMountedVersion; 
  UInt32 reserved;           
  UInt32 createDate;  
  UInt32 modifyDate;  
  UInt32 backupDate;  
  UInt32 checkedDate; 
  UInt32 fileCount;   
  UInt32 folderCount; 
  UInt32 blockSize;   
  UInt32 totalBlocks; 
  UInt32 freeBlocks;  
  UInt32 nextAllocation;          
  UInt32 rsrcClumpSize;           
  UInt32 dataClumpSize;           
  HFSCatalogNodeID nextCatalogID; 
  UInt32 writeCount;      
  UInt64 encodingsBitmap; 
  UInt8 finderInfo[32]; 
  HFSPlusForkData allocationFile; 
  HFSPlusForkData extentsFile;    
  HFSPlusForkData catalogFile;    
  HFSPlusForkData attributesFile; 
  HFSPlusForkData startupFile;    
};
typedef struct HFSPlusVolumeHeader HFSPlusVolumeHeader;
struct BTNodeDescriptor {
  UInt32 fLink; 
  UInt32 bLink; 
  SInt8 kind;   
  UInt8 height; 
  UInt16 numRecords; 
  UInt16 reserved;   
};
typedef struct BTNodeDescriptor BTNodeDescriptor;
enum { kBTLeafNode = -1, kBTIndexNode = 0, kBTHeaderNode = 1, kBTMapNode = 2 };
 
struct BTHeaderRec {
  UInt16 treeDepth;     
  UInt32 rootNode;      
  UInt32 leafRecords;   
  UInt32 firstLeafNode; 
  UInt32 lastLeafNode;  
  UInt16 nodeSize;      
  UInt16 maxKeyLength;  
  UInt32 totalNodes;    
  UInt32 freeNodes;     
  UInt16 reserved1;     
  UInt32 clumpSize;     
  UInt8 btreeType;      
  UInt8 reserved2;      
  UInt32 attributes;    
  UInt32 reserved3[16]; 
};
typedef struct BTHeaderRec BTHeaderRec;
enum {
  kBTBadCloseMask = 0x00000001, 
  kBTBigKeysMask = 0x00000002,  
  kBTVariableIndexKeysMask =
      0x00000004 
};
 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = reset
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(pop)
#elif PRAGMA_STRUCT_PACK
#pragma pack()
#endif
 
#ifdef PRAGMA_IMPORT_OFF
#pragma import off
#elif PRAGMA_IMPORT
#pragma import reset
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif