udf_rel.h

Go to the documentation of this file.

 
// Copyright (C) Alexander Telyatnikov, Ivan Keliukh, Yegor Anchishkin, SKIF Software, 1999-2013. Kiev, Ukraine
// All rights reserved
// This file was released under the GPLv2 on June 2015.
/*
 
 Module Name: udf_rel.h
 
 Abstract:
 
    Contains udf related structures.
 
 Environment:
 
    Both kernel and user mode
 
*/
 
#ifndef _UDF_REL_H_
#define _UDF_REL_H_
 
#include "Include/platform.h"
#include "ecma_167.h"
 
#ifdef UDF_LIMIT_DIR_SIZE
typedef uint8 uint_di;
#else //UDF_LIMIT_DIR_SIZE
typedef uint32 uint_di;
#endif //UDF_LIMIT_DIR_SIZE
 
typedef struct _UDFTrackMap {
    uint32 FirstLba;
    uint32 LastLba;
    uint32 NWA;
    uint32 PacketSize;
    uint32 Session;
    uint8  TrackParam;
    uint8  DataParam;
    uint8  NWA_V;
 
    uint8  Flags;
#define     TrackMap_AllowCopyBit_variated     0x01
#define     TrackMap_CopyBit_variated          0x02
#define     TrackMap_Try_variation             0x04
#define     TrackMap_Use_variation             0x08
#define     TrackMap_FixFPAddressing           0x10
#define     TrackMap_FixMRWAddressing          0x20
 
    // are used only if FixFPAddressing is enabled
    uint32 TrackFPOffset;
    uint32 PacketFPOffset;
 
} UDFTrackMap, *PUDFTrackMap;
 
typedef struct _UDFSparingData
{
    uint32     SparingLocation;
    uint16     SparingPLength;
} UDFSparingData, *PUDFSparingData;
 
#define PACK_MAPPING_THRESHOLD      (sizeof(EXTENT_MAP)*8)
 
typedef struct _EXTENT_INFO {
    uint32      Offset;
    PEXTENT_MAP Mapping;
    int64       Length;   // user data
    BOOLEAN     Modified; // mapping
    UCHAR       Flags;
/*
    UCHAR       Reserved[2];
    PVOID       Cache;
*/
} EXTENT_INFO, *PEXTENT_INFO;
 
#define EXTENT_FLAG_ALLOC_STD             0x00
#define EXTENT_FLAG_ALLOC_SEQUENTIAL      0x01
#define EXTENT_FLAG_ALLOC_MASK            0x03
#define EXTENT_FLAG_PREALLOCATED          0x80
#define EXTENT_FLAG_CUT_PREALLOCATED      0x40
#define EXTENT_FLAG_VERIFY                0x20
#define EXTENT_FLAG_2K_COMPAT             0x10
 
typedef struct _UDFPartMap
{
    uint32  UspaceBitmap; // Lba
    uint32  FspaceBitmap; // Lba
    uint32  AccessType;
    uint32  PartitionRoot;
    uint32  PartitionLen;
    uint16  PartitionType;
    uint16  PartitionNum;
    uint16  VolumeSeqNum;
} UDFPartMap, *PUDFPartMap;
 
 
#define VDS_POS_PRIMARY_VOL_DESC    0
#define VDS_POS_UNALLOC_SPACE_DESC  1
#define VDS_POS_LOGICAL_VOL_DESC    2
#define VDS_POS_PARTITION_DESC      3
#define VDS_POS_IMP_USE_VOL_DESC    4
#define VDS_POS_VOL_DESC_PTR        5
#define VDS_POS_TERMINATING_DESC    6
#define VDS_POS_RECURSION_COUNTER   7
#define VDS_POS_LENGTH              8
 
typedef struct _UDF_VDS_RECORD {
    uint32 block;
    uint32 volDescSeqNum;
} UDF_VDS_RECORD, *PUDF_VDS_RECORD;
 
#define VRS_NSR02_FOUND         0x0001
#define VRS_NSR03_FOUND         0x0002
#define VRS_ISO9660_FOUND       0x0004
 
#define EXTENT_MAP_GRAN         (8*sizeof(LONG_AD))
#define DIR_INDEX_MAP_GRAN      (8*sizeof(DIR_INDEX))
#define SHORT_AD_GRAN           (8*sizeof(SHORT_AD))
#define RELOC_MAP_GRAN          (8*sizeof(EXT_RELOCATION_ENTRY))
#define ALLOC_DESC_MAX_RECURSE  256
 
struct _UDF_FILE_INFO;
struct _DIR_INDEX_ITEM;
 
#define UDF_DIR_INDEX_MT PagedPool
#define UDF_FILENAME_MT PagedPool
 
typedef struct _HASH_ENTRY {
    uint32 hDos;                       // hash for Dos-name
    uint32 hLfn;                       // hash for Upcased Lfn
    uint32 hPosix;                     // hash for Posix Lfn
} HASH_ENTRY, *PHASH_ENTRY;
 
typedef struct _DIR_INDEX_HDR {
    uint_di     FirstFree;
    uint_di     LastUsed;
    uint_di     FrameCount;
    uint_di     LastFrameCount;  // in items
    uint_di     DelCount;
    EXTENT_INFO FECharge;        // file entry charge
    EXTENT_INFO FEChargeSDir;    // file entry charge for streams
    ULONG       DIFlags;
//    struct _DIR_INDEX_ITEM* FrameList[0];
} DIR_INDEX_HDR, *PDIR_INDEX_HDR;
 
// Initial location of directory data extent in IN_ICB
#define UDF_DI_FLAG_INIT_IN_ICB  (0x01)
 
typedef struct _DIR_INDEX_ITEM {
    // FSD-specific data
    uint32 Offset;                      // File Ident offset in extent
    uint32 Length;                      // Its length
    UNICODE_STRING FName;              // Filename
    lb_addr FileEntryLoc;              // pointer to FileEntry
    uint8 FileCharacteristics;
    uint8 FI_Flags;                    // FileIdent-related flags
    struct _UDF_FILE_INFO* FileInfo;   // associated FileInfo (if opened)
    // search hashes
    HASH_ENTRY hashes;
    // attributes (System-specific format)
    uint32 SysAttr;
    int64 CreationTime;
    int64 LastWriteTime;
    int64 LastAccessTime;
    int64 ChangeTime;
    int64 FileSize;
    int64 AllocationSize;
} DIR_INDEX_ITEM, *PDIR_INDEX_ITEM;
#define UDF_FI_FLAG_FI_MODIFIED  (0x01)
#define UDF_FI_FLAG_SYS_ATTR     (0x02)// cached flags in system-specific format
#define UDF_FI_FLAG_FI_INTERNAL  (0x04)
#define UDF_FI_FLAG_LINKED       (0x08)
 
#define UDF_FI_FLAG_DOS          (0x10)// Lfn-style name is equal to DOS-style (case insensetive)
#define UDF_FI_FLAG_KEEP_NAME    (0x20)
 
#define UDF_DATALOC_INFO_MT PagedPool
 
typedef struct _UDF_DATALOC_INFO {
 
    struct _UDFNTRequiredFCB* CommonFcb; // pointer to corresponding NtReqFcb
    EXTENT_INFO DataLoc;               // user data
    EXTENT_INFO AllocLoc;              // allocation descriptors (if any)
    EXTENT_INFO FELoc;                 // file entry location
    tag*        FileEntry;             // file entry data
    uint32      FileEntryLen;
    uint32      FE_Flags;              // FileEntry flags
    uint32      LinkRefCount;
    PDIR_INDEX_HDR DirIndex;           // for Directory objects only
    struct _UDF_FILE_INFO* LinkedFileInfo;
    struct _UDF_FILE_INFO* SDirInfo;
} UDF_DATALOC_INFO, *PUDF_DATALOC_INFO;
 
#define UDF_FE_FLAG_FE_MODIFIED  (0x01)
#define UDF_FE_FLAG_HAS_SDIR     (0x02)
#define UDF_FE_FLAG_IS_SDIR      (0x04)
#define UDF_FE_FLAG_DIR_MODIFIED (0x08)
#define UDF_FE_FLAG_HAS_DEL_SDIR (0x10)
#define UDF_FE_FLAG_IS_DEL_SDIR  (0x20)
#define UDF_FE_FLAG_UNDER_INIT   (0x40)
 
 
#define UDF_FILE_INFO_MT PagedPool
 
 
typedef struct _UDF_FILE_INFO {
#ifdef VALIDATE_STRUCTURES
    uint32       IntegrityTag;
#endif
    struct _UDFFileControlBlock* Fcb;  // pointer to corresponding Fcb (null if absent)
    PUDF_DATALOC_INFO Dloc;            // actual data location descriptor
    PFILE_IDENT_DESC FileIdent;        // file ident data
    uint32       FileIdentLen;
    struct _UDF_FILE_INFO* ParentFile; // parent (directory) if any
    uint_di      Index;                // index in parent directory
    uint32       RefCount;             // number of references
    uint32       OpenCount;            // number of opened files in Dir
    struct _UDF_FILE_INFO* NextLinkedFile; //
    struct _UDF_FILE_INFO* PrevLinkedFile; //
 
    struct _FE_LIST_ENTRY*  ListPtr;
} UDF_FILE_INFO, *PUDF_FILE_INFO;
 
typedef struct _FE_LIST_ENTRY {
    PUDF_FILE_INFO FileInfo;
    ULONG EntryRefCount;
} FE_LIST_ENTRY, *PFE_LIST_ENTRY;
 
#define DOS_NAME_LEN 8
#define DOS_EXT_LEN 3
#define ILLEGAL_CHAR_MARK 0x005F
#define UNICODE_CRC_MARK  0x0023
#define UNICODE_PERIOD    0x002E
#define UNICODE_SPACE     0x0020
 
#define LBA_OUT_OF_EXTENT       ((ULONG)(-1))
#define LBA_NOT_ALLOCATED       ((ULONG)(-2))
 
typedef struct _EXT_RELOCATION_ENTRY {
    uint32 extLength;
    uint32 extLocation;
    uint32 extRedir;
} EXT_RELOCATION_ENTRY, *PEXT_RELOCATION_ENTRY;
 
typedef struct _UDF_DATALOC_INDEX {
    uint32 Lba;
    PUDF_DATALOC_INFO Dloc;
} UDF_DATALOC_INDEX, *PUDF_DATALOC_INDEX;
 
typedef struct _UDF_DIR_SCAN_CONTEXT {
    PUDF_FILE_INFO DirInfo;
    PDIR_INDEX_HDR hDirNdx;
    PDIR_INDEX_ITEM DirNdx;
    uint32  frame;
    uint_di j;
    uint32  d;
    uint_di i;
} UDF_DIR_SCAN_CONTEXT, *PUDF_DIR_SCAN_CONTEXT;
 
typedef EXT_RELOCATION_ENTRY  EXT_RELOC_MAP;
typedef PEXT_RELOCATION_ENTRY PEXT_RELOC_MAP;
 
typedef struct _UDF_ALLOCATION_CACHE_ITEM {
    lba_t       ParentLocation;
    uint32      Items;
    EXTENT_INFO Ext;
} UDF_ALLOCATION_CACHE_ITEM, *PUDF_ALLOCATION_CACHE_ITEM;
 
/*
#define MEM_DIR_HDR_TAG     (ULONG)"DirHdr"
#define MEM_DIR_NDX_TAG     (ULONG)"DirNdx"
#define MEM_DLOC_NDX_TAG    (ULONG)"DlocNdx"
#define MEM_DLOC_INF_TAG    (ULONG)"DlocInf"
#define MEM_FNAME_TAG       (ULONG)"FName"
#define MEM_FNAME16_TAG     (ULONG)"FName16"
#define MEM_FNAMECPY_TAG    (ULONG)"FNameC"
#define MEM_FE_TAG          (ULONG)"FE"
#define MEM_XFE_TAG         (ULONG)"xFE"
#define MEM_FID_TAG         (ULONG)"FID"
#define MEM_FINF_TAG        (ULONG)"FInf"
#define MEM_VATFINF_TAG     (ULONG)"FInfVat"
#define MEM_SDFINF_TAG      (ULONG)"SDirFInf"
#define MEM_EXTMAP_TAG      (ULONG)"ExtMap"
#define MEM_ALLOCDESC_TAG   (ULONG)"AllocDesc"
#define MEM_SHAD_TAG        (ULONG)"SHAD"
#define MEM_LNGAD_TAG       (ULONG)"LNGAD"
*/
 
#define MEM_DIR_HDR_TAG     'DirH'
#define MEM_DIR_NDX_TAG     'DirN'
#define MEM_DLOC_NDX_TAG    'Dloc'
#define MEM_DLOC_INF_TAG    'Dloc'
#define MEM_FNAME_TAG       'FNam'
#define MEM_FNAME16_TAG     'FNam'
#define MEM_FNAMECPY_TAG    'FNam'
#define MEM_FE_TAG          'FE'
#define MEM_XFE_TAG         'xFE"'
#define MEM_FID_TAG         'FID'
#define MEM_FINF_TAG        'FInf'
#define MEM_VATFINF_TAG     'FInf'
#define MEM_SDFINF_TAG      'SDir'
#define MEM_EXTMAP_TAG      'ExtM'
#define MEM_ALLOCDESC_TAG   'Allo'
#define MEM_SHAD_TAG        'SHAD'
#define MEM_LNGAD_TAG       'LNGA'
#define MEM_ALLOC_CACHE_TAG 'hcCA'
 
#define UDF_DEFAULT_LAST_LBA_CD     276159
#define UDF_DEFAULT_LAST_LBA_DVD    0x23053f
#define UDF_DEFAULT_FE_CHARGE       128
#define UDF_DEFAULT_FE_CHARGE_SDIR  1
#define UDF_WRITE_MAX_RETRY         4
#define UDF_READ_MAX_RETRY          4
#define UDF_READY_MAX_RETRY         5
 
#define ICB_FLAG_AD_DEFAULT_ALLOC_MODE     (UCHAR)(0xff)
 
#define UDF_INVALID_LINK_COUNT      0xffff
#define UDF_MAX_LINK_COUNT          0x7fff
 
#define UDF_MAX_EXTENT_LENGTH       (UDF_EXTENT_LENGTH_MASK & ~(2048-1))
 
#define UDF_MAX_READ_REVISION       0x0260
#define UDF_MAX_WRITE_REVISION      0x0201
 
#define UDF_MAX_LVID_CHAIN_LENGTH   1024
#define UDF_LVID_TTL                1024
 
#define UDF_NO_EXTENT_MAP           ((PEXTENT_MAP)(ULONG_PTR)~0ULL)
 
#define UDF_FLUSH_FLAGS_LITE        (0x80000000)
 
#if defined UDF_DBG || defined _CONSOLE
//#define UDF_CHECK_DISK_ALLOCATION
 
//#define UDF_TRACK_ONDISK_ALLOCATION
 
//#define UDF_TRACK_ONDISK_ALLOCATION_OWNERS
//#define UDF_TRACK_ONDISK_ALLOCATION_OWNERS_INTERNAL
 
//#define UDF_TRACK_EXTENT_TO_MAPPING
 
//#define UDF_TRACK_ALLOC_FREE_EXTENT
 
//#define UDF_CHECK_EXTENT_SIZE_ALIGNMENT
 
// dependences:
 
#ifdef UDF_TRACK_ALLOC_FREE_EXTENT
  #define UDF_TRACK_EXTENT_TO_MAPPING
#endif //UDF_TRACK_ALLOC_FREE_EXTENT
 
#endif //UDF_DBG
 
typedef struct _UDF_VERIFY_CTX {
    uint8*     StoredBitMap;
    ULONG      ItemCount;
    LIST_ENTRY vrfList;
    ERESOURCE  VerifyLock;
    KEVENT     vrfEvent;
    uint32     WaiterCount;
    uint32     QueuedCount;
    BOOLEAN    VInited;
} UDF_VERIFY_CTX, *PUDF_VERIFY_CTX;
 
#endif /* _UDF_REL_H_ */