drivers/filesystems/cdfs/cdfs.h

   1 #ifndef CDFS_H
   2 #define CDFS_H
   3
   4 #include <ntifs.h>
   5 #include <ntddk.h>
   6 #include <ntddcdrm.h>
   7
   8 #define CDFS_BASIC_SECTOR 2048
   9 #define CDFS_PRIMARY_DESCRIPTOR_LOCATION 16
  10 #define BLOCKSIZE CDFS_BASIC_SECTOR
  11 #define CDFS_MAX_NAME_LEN 256
  12
  13
  14 /* Volume descriptor types (VdType) */
  15 #define BOOT_VOLUME_DESCRIPTOR_TYPE             0
  16 #define PRIMARY_VOLUME_DESCRIPTOR_TYPE          1
  17 #define SUPPLEMENTARY_VOLUME_DESCRIPTOR_TYPE    2
  18 #define VOLUME_PARTITION_DESCRIPTOR_TYPE        3
  19 #define VOLUME_DESCRIPTOR_SET_TERMINATOR        255
  20
  21 #include <pshpack1.h>
  22 struct _DIR_RECORD
  23 {
  24   UCHAR  RecordLength;                  // 1
  25   UCHAR  ExtAttrRecordLength;           // 2
  26   ULONG  ExtentLocationL;               // 3-6
  27   ULONG  ExtentLocationM;               // 7-10
  28   ULONG  DataLengthL;                   // 11-14
  29   ULONG  DataLengthM;                   // 15-18
  30   UCHAR  Year;                          // 19
  31   UCHAR  Month;                         // 20
  32   UCHAR  Day;                           // 21
  33   UCHAR  Hour;                          // 22
  34   UCHAR  Minute;                        // 23
  35   UCHAR  Second;                        // 24
  36   UCHAR  TimeZone;                      // 25
  37   UCHAR  FileFlags;                     // 26
  38   UCHAR  FileUnitSize;                  // 27
  39   UCHAR  InterleaveGapSize;             // 28
  40   ULONG  VolumeSequenceNumber;          // 29-32
  41   UCHAR  FileIdLength;                  // 33
  42   UCHAR  FileId[1];                     // 34
  43 };
  44 #include <poppack.h>
  45
  46 typedef struct _DIR_RECORD DIR_RECORD, *PDIR_RECORD;
  47
  48 /* DIR_RECORD.FileFlags */
  49 #define FILE_FLAG_HIDDEN    0x01
  50 #define FILE_FLAG_DIRECTORY 0x02
  51 #define FILE_FLAG_SYSTEM    0x04
  52 #define FILE_FLAG_READONLY  0x10
  53
  54
  55 /* Volume Descriptor header*/
  56 #include <pshpack1.h>
  57 struct _VD_HEADER
  58 {
  59   UCHAR  VdType;                        // 1
  60   UCHAR  StandardId[5];                 // 2-6
  61   UCHAR  VdVersion;                     // 7
  62 };
  63
  64 typedef struct _VD_HEADER VD_HEADER, *PVD_HEADER;
  65
  66
  67
  68 /* Primary Volume Descriptor */
  69 struct _PVD
  70 {
  71   UCHAR  VdType;                        // 1
  72   UCHAR  StandardId[5];                 // 2-6
  73   UCHAR  VdVersion;                     // 7
  74   UCHAR  unused0;                       // 8
  75   UCHAR  SystemId[32];                  // 9-40
  76   UCHAR  VolumeId[32];                  // 41-72
  77   UCHAR  unused1[8];                    // 73-80
  78   ULONG  VolumeSpaceSizeL;              // 81-84
  79   ULONG  VolumeSpaceSizeM;              // 85-88
  80   UCHAR  unused2[32];                   // 89-120
  81   ULONG  VolumeSetSize;                 // 121-124
  82   ULONG  VolumeSequenceNumber;          // 125-128
  83   ULONG  LogicalBlockSize;              // 129-132
  84   ULONG  PathTableSizeL;                // 133-136
  85   ULONG  PathTableSizeM;                // 137-140
  86   ULONG  LPathTablePos;                 // 141-144
  87   ULONG  LOptPathTablePos;              // 145-148
  88   ULONG  MPathTablePos;                 // 149-152
  89   ULONG  MOptPathTablePos;              // 153-156
  90   DIR_RECORD RootDirRecord;             // 157-190
  91   UCHAR  VolumeSetIdentifier[128];      // 191-318
  92   UCHAR  PublisherIdentifier[128];      // 319-446
  93
  94   /* more data ... */
  95
  96 };
  97 typedef struct _PVD PVD, *PPVD;
  98
  99
 100 /* Supplementary Volume Descriptor */
 101 struct _SVD
 102 {
 103   UCHAR  VdType;                        // 1
 104   UCHAR  StandardId[5];                 // 2-6
 105   UCHAR  VdVersion;                     // 7
 106   UCHAR  VolumeFlags;                   // 8
 107   UCHAR  SystemId[32];                  // 9-40
 108   UCHAR  VolumeId[32];                  // 41-72
 109   UCHAR  unused1[8];                    // 73-80
 110   ULONG  VolumeSpaceSizeL;              // 81-84
 111   ULONG  VolumeSpaceSizeM;              // 85-88
 112   UCHAR  EscapeSequences[32];           // 89-120
 113   ULONG  VolumeSetSize;                 // 121-124
 114   ULONG  VolumeSequenceNumber;          // 125-128
 115   ULONG  LogicalBlockSize;              // 129-132
 116   ULONG  PathTableSizeL;                // 133-136
 117   ULONG  PathTableSizeM;                // 137-140
 118   ULONG  LPathTablePos;                 // 141-144
 119   ULONG  LOptPathTablePos;              // 145-148
 120   ULONG  MPathTablePos;                 // 149-152
 121   ULONG  MOptPathTablePos;              // 153-156
 122   DIR_RECORD RootDirRecord;             // 157-190
 123   UCHAR  VolumeSetIdentifier[128];      // 191-318
 124   UCHAR  PublisherIdentifier[128];      // 319-446
 125
 126  // more data ...
 127 };
 128 #include <poppack.h>
 129
 130 typedef struct _SVD SVD, *PSVD;
 131
 132
 133
 134
 135
 136
 137
 138 typedef struct _CDINFO
 139 {
 140   ULONG VolumeOffset;
 141   ULONG VolumeSpaceSize;
 142   ULONG JolietLevel;
 143   ULONG RootStart;
 144   ULONG RootSize;
 145   WCHAR VolumeLabel[MAXIMUM_VOLUME_LABEL_LENGTH];
 146   ULONG VolumeLabelLength;
 147   ULONG SerialNumber;
 148 } CDINFO, *PCDINFO;
 149
 150
 151 typedef struct
 152 {
 153   ERESOURCE VcbResource;
 154   ERESOURCE DirResource;
 155
 156   KSPIN_LOCK FcbListLock;
 157   LIST_ENTRY FcbListHead;
 158
 159   PVPB Vpb;
 160   PDEVICE_OBJECT VolumeDevice;
 161   PDEVICE_OBJECT StorageDevice;
 162   PFILE_OBJECT StreamFileObject;
 163
 164   CDINFO CdInfo;
 165
 166
 167 } DEVICE_EXTENSION, *PDEVICE_EXTENSION, VCB, *PVCB;
 168
 169
 170 #define FCB_CACHE_INITIALIZED   0x0001
 171 #define FCB_IS_VOLUME_STREAM    0x0002
 172 #define FCB_IS_VOLUME           0x0004
 173
 174 #define MAX_PATH                260
 175
 176 typedef struct _FCB
 177 {
 178   FSRTL_COMMON_FCB_HEADER RFCB;
 179   SECTION_OBJECT_POINTERS SectionObjectPointers;
 180   ERESOURCE MainResource;
 181   ERESOURCE PagingIoResource;
 182
 183   PFILE_OBJECT FileObject;
 184   PDEVICE_EXTENSION DevExt;
 185
 186   UNICODE_STRING ShortNameU;
 187
 188   WCHAR *ObjectName;            /* point on filename (250 chars max) in PathName */
 189   WCHAR PathName[MAX_PATH];     /* path+filename 260 max */
 190   WCHAR ShortNameBuffer[13];
 191
 192   LIST_ENTRY FcbListEntry;
 193   struct _FCB* ParentFcb;
 194
 195   ULONG DirIndex;
 196
 197   LARGE_INTEGER IndexNumber;    /* HighPart: Parent directory start sector */
 198                                 /* LowPart: Directory record offset in the parent directory file */
 199
 200   LONG RefCount;
 201   ULONG Flags;
 202
 203   DIR_RECORD Entry;
 204 } FCB, *PFCB;
 205
 206
 207 typedef struct _CCB
 208 {
 209   LIST_ENTRY     NextCCB;
 210   PFILE_OBJECT   PtrFileObject;
 211   LARGE_INTEGER  CurrentByteOffset;
 212   /* for DirectoryControl */
 213   ULONG Entry;
 214   ULONG Offset;
 215   /* for DirectoryControl */
 216   UNICODE_STRING DirectorySearchPattern;
 217   ULONG LastCluster;
 218   ULONG LastOffset;
 219 } CCB, *PCCB;
 220
 221 #ifndef TAG
 222 #define TAG(A, B, C, D) (ULONG)(((A)<<0) + ((B)<<8) + ((C)<<16) + ((D)<<24))
 223 #endif
 224
 225 #define TAG_CCB TAG('I', 'C', 'C', 'B')
 226
 227
 228
 229 typedef struct
 230 {
 231   PDRIVER_OBJECT DriverObject;
 232   PDEVICE_OBJECT DeviceObject;
 233   ULONG Flags;
 234   CACHE_MANAGER_CALLBACKS CacheMgrCallbacks;
 235 } CDFS_GLOBAL_DATA, *PCDFS_GLOBAL_DATA;
 236
 237 extern PCDFS_GLOBAL_DATA CdfsGlobalData;
 238
 239
 240 /* cleanup.c */
 241
 242 NTSTATUS STDCALL
 243 CdfsCleanup(PDEVICE_OBJECT DeviceObject,
 244             PIRP Irp);
 245
 246
 247 /* close.c */
 248
 249 NTSTATUS STDCALL
 250 CdfsClose(PDEVICE_OBJECT DeviceObject,
 251           PIRP Irp);
 252
 253 NTSTATUS
 254 CdfsCloseFile(PDEVICE_EXTENSION DeviceExt,
 255               PFILE_OBJECT FileObject);
 256
 257
 258 /* common.c */
 259
 260 NTSTATUS
 261 CdfsReadSectors(IN PDEVICE_OBJECT DeviceObject,
 262                 IN ULONG DiskSector,
 263                 IN ULONG SectorCount,
 264                 IN OUT PUCHAR Buffer,
 265                 IN BOOLEAN Override);
 266
 267 NTSTATUS
 268 CdfsDeviceIoControl (IN PDEVICE_OBJECT DeviceObject,
 269                      IN ULONG CtlCode,
 270                      IN PVOID InputBuffer,
 271                      IN ULONG InputBufferSize,
 272                      IN OUT PVOID OutputBuffer,
 273                      IN OUT PULONG pOutputBufferSize,
 274                      IN BOOLEAN Override);
 275
 276
 277 /* create.c */
 278
 279 NTSTATUS STDCALL
 280 CdfsCreate(PDEVICE_OBJECT DeviceObject,
 281            PIRP Irp);
 282
 283
 284 /* dirctl.c */
 285
 286 NTSTATUS STDCALL
 287 CdfsDirectoryControl(PDEVICE_OBJECT DeviceObject,
 288                      PIRP Irp);
 289
 290
 291 /* fcb.c */
 292
 293 PFCB
 294 CdfsCreateFCB(PCWSTR FileName);
 295
 296 VOID
 297 CdfsDestroyFCB(PFCB Fcb);
 298
 299 BOOLEAN
 300 CdfsFCBIsDirectory(PFCB Fcb);
 301
 302 BOOLEAN
 303 CdfsFCBIsRoot(PFCB Fcb);
 304
 305 VOID
 306 CdfsGrabFCB(PDEVICE_EXTENSION Vcb,
 307             PFCB Fcb);
 308
 309 VOID
 310 CdfsReleaseFCB(PDEVICE_EXTENSION Vcb,
 311                PFCB Fcb);
 312
 313 VOID
 314 CdfsAddFCBToTable(PDEVICE_EXTENSION Vcb,
 315                   PFCB Fcb);
 316
 317 PFCB
 318 CdfsGrabFCBFromTable(PDEVICE_EXTENSION Vcb,
 319                      PUNICODE_STRING FileName);
 320
 321 NTSTATUS
 322 CdfsFCBInitializeCache(PVCB Vcb,
 323                        PFCB Fcb);
 324
 325 PFCB
 326 CdfsMakeRootFCB(PDEVICE_EXTENSION Vcb);
 327
 328 PFCB
 329 CdfsOpenRootFCB(PDEVICE_EXTENSION Vcb);
 330
 331 NTSTATUS
 332 CdfsMakeFCBFromDirEntry(PVCB Vcb,
 333                         PFCB DirectoryFCB,
 334                         PWSTR LongName,
 335                         PWSTR ShortName,
 336                         PDIR_RECORD Record,
 337                         ULONG DirectorySector,
 338                         ULONG DirectoryOffset,
 339                         PFCB * fileFCB);
 340
 341 NTSTATUS
 342 CdfsAttachFCBToFileObject(PDEVICE_EXTENSION Vcb,
 343                           PFCB Fcb,
 344                           PFILE_OBJECT FileObject);
 345
 346 NTSTATUS
 347 CdfsDirFindFile(PDEVICE_EXTENSION DeviceExt,
 348                 PFCB DirectoryFcb,
 349                 PUNICODE_STRING FileToFind,
 350                 PFCB *FoundFCB);
 351
 352 NTSTATUS
 353 CdfsGetFCBForFile(PDEVICE_EXTENSION Vcb,
 354                   PFCB *pParentFCB,
 355                   PFCB *pFCB,
 356                   PUNICODE_STRING FileName);
 357
 358
 359 /* finfo.c */
 360
 361 NTSTATUS STDCALL
 362 CdfsQueryInformation(PDEVICE_OBJECT DeviceObject,
 363                      PIRP Irp);
 364
 365 NTSTATUS STDCALL
 366 CdfsSetInformation(PDEVICE_OBJECT DeviceObject,
 367                    PIRP Irp);
 368
 369
 370 /* fsctl.c */
 371
 372 NTSTATUS STDCALL
 373 CdfsFileSystemControl(PDEVICE_OBJECT DeviceObject,
 374                       PIRP Irp);
 375
 376
 377 /* misc.c */
 378
 379 VOID
 380 CdfsSwapString(PWCHAR Out,
 381                PUCHAR In,
 382                ULONG Count);
 383
 384 VOID
 385 CdfsDateTimeToSystemTime(PFCB Fcb,
 386                          PLARGE_INTEGER SystemTime);
 387
 388 VOID
 389 CdfsFileFlagsToAttributes(PFCB Fcb,
 390                           PULONG FileAttributes);
 391
 392
 393 /* rw.c */
 394
 395 NTSTATUS STDCALL
 396 CdfsRead(PDEVICE_OBJECT DeviceObject,
 397         PIRP Irp);
 398
 399 NTSTATUS STDCALL
 400 CdfsWrite(PDEVICE_OBJECT DeviceObject,
 401           PIRP Irp);
 402
 403
 404 /* volinfo.c */
 405
 406 NTSTATUS STDCALL
 407 CdfsQueryVolumeInformation(PDEVICE_OBJECT DeviceObject,
 408                            PIRP Irp);
 409
 410 NTSTATUS STDCALL
 411 CdfsSetVolumeInformation(PDEVICE_OBJECT DeviceObject,
 412                          PIRP Irp);
 413
 414 /* cdfs.c */
 415
 416 NTSTATUS STDCALL
 417 DriverEntry(PDRIVER_OBJECT DriverObject,
 418             PUNICODE_STRING RegistryPath);
 419
 420 BOOLEAN NTAPI
 421 CdfsAcquireForLazyWrite(IN PVOID Context,
 422                         IN BOOLEAN Wait);
 423
 424 VOID NTAPI
 425 CdfsReleaseFromLazyWrite(IN PVOID Context);
 426
 427 #endif //CDFS_H