3 * Copyright (C) 2002, 2003 ReactOS Team
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 * COPYRIGHT: See COPYING in the top level directory
21 * PROJECT: ReactOS kernel
22 * FILE: drivers/fs/cdfs/fsctl.c
23 * PURPOSE: CDROM (ISO 9660) filesystem driver
24 * PROGRAMMER: Art Yerkes
28 /* INCLUDES *****************************************************************/
35 /* FUNCTIONS ****************************************************************/
38 int msf_to_lba (UCHAR m
, UCHAR s
, UCHAR f
)
40 return (((m
* 60) + s
) * 75 + f
) - 150;
45 CdfsGetPVDData(PUCHAR Buffer
,
61 /* Calculate the volume serial number */
63 for (i
= 0; i
< 2048; i
+= 4)
65 /* DON'T optimize this to ULONG!!! (breaks overflow) */
66 Serial
.Part
[0] += Buffer
[i
+3];
67 Serial
.Part
[1] += Buffer
[i
+2];
68 Serial
.Part
[2] += Buffer
[i
+1];
69 Serial
.Part
[3] += Buffer
[i
+0];
71 CdInfo
->SerialNumber
= Serial
.Value
;
73 /* Extract the volume label */
75 pw
= CdInfo
->VolumeLabel
;
76 for (i
= 0; i
< (MAXIMUM_VOLUME_LABEL_LENGTH
/ sizeof(WCHAR
)) - 1; i
++)
82 /* Trim trailing spaces */
83 while (pw
> CdInfo
->VolumeLabel
)
85 if (*--pw
!= ' ') break;
87 /* Remove the space */
94 CdInfo
->VolumeLabelLength
= i
* sizeof(WCHAR
);
96 CdInfo
->VolumeSpaceSize
= Pvd
->VolumeSpaceSizeL
;
97 CdInfo
->RootStart
= Pvd
->RootDirRecord
.ExtentLocationL
;
98 CdInfo
->RootSize
= Pvd
->RootDirRecord
.DataLengthL
;
100 DPRINT("VolumeSerial: %08lx\n", CdInfo
->SerialNumber
);
101 DPRINT("VolumeLabel: '%S'\n", CdInfo
->VolumeLabel
);
102 DPRINT("VolumeLabelLength: %lu\n", CdInfo
->VolumeLabelLength
);
103 DPRINT("VolumeSize: %lu\n", Pvd
->VolumeSpaceSizeL
);
104 DPRINT("RootStart: %lu\n", Pvd
->RootDirRecord
.ExtentLocationL
);
105 DPRINT("RootSize: %lu\n", Pvd
->RootDirRecord
.DataLengthL
);
106 DPRINT("PathTableSize: %lu\n", Pvd
->PathTableSizeL
);
107 DPRINT("PathTablePos: %lu\n", Pvd
->LPathTablePos
);
108 DPRINT("OptPathTablePos: %lu\n", Pvd
->LOptPathTablePos
);
111 DbgPrint("******** PVD **********\n");
112 DbgPrint("VdType: %d\n", Pvd
->VdType
);
113 DbgPrint("StandardId: '%.*s'\n", 5, Pvd
->StandardId
);
114 DbgPrint("VdVersion: %d\n", Pvd
->VdVersion
);
115 DbgPrint("SystemId: '%.*s'\n", 32, Pvd
->SystemId
);
116 DbgPrint("VolumeId: '%.*s'\n", 32, Pvd
->VolumeId
);
117 DbgPrint("VolumeSpaceSizeL: %d (%x)\n", Pvd
->VolumeSpaceSizeL
, Pvd
->VolumeSpaceSizeL
);
118 DbgPrint("VolumeSpaceSizeM: %d (%x)\n", Pvd
->VolumeSpaceSizeM
, Pvd
->VolumeSpaceSizeM
);
119 DbgPrint("VolumeSetSize: %d (%x)\n", Pvd
->VolumeSequenceNumber
, Pvd
->VolumeSequenceNumber
);
120 DbgPrint("VolumeSequenceNumber: %d (%x)\n", Pvd
->VolumeSequenceNumber
, Pvd
->VolumeSequenceNumber
);
121 DbgPrint("LogicalBlockSize: %d (%x)\n", Pvd
->LogicalBlockSize
, Pvd
->LogicalBlockSize
);
122 DbgPrint("PathTableSizeL: %d (%x)\n", Pvd
->PathTableSizeL
, Pvd
->PathTableSizeL
);
123 DbgPrint("PathTableSizeM: %d (%x)\n", Pvd
->PathTableSizeM
, Pvd
->PathTableSizeM
);
124 DbgPrint("LPathTablePos: %d (%x)\n", Pvd
->LPathTablePos
, Pvd
->LPathTablePos
);
125 DbgPrint("LOptPathTablePos: %d (%x)\n", Pvd
->LOptPathTablePos
, Pvd
->LOptPathTablePos
);
126 DbgPrint("MPathTablePos: %d (%x)\n", Pvd
->MPathTablePos
, Pvd
->MPathTablePos
);
127 DbgPrint("MOptPathTablePos: %d (%x)\n", Pvd
->MOptPathTablePos
, Pvd
->MOptPathTablePos
);
128 DbgPrint("VolumeSetIdentifier: '%.*s'\n", 128, Pvd
->VolumeSetIdentifier
);
129 DbgPrint("PublisherIdentifier: '%.*s'\n", 128, Pvd
->PublisherIdentifier
);
130 DbgPrint("******** Root *********\n");
131 DbgPrint("RecordLength: %d\n", Pvd
->RootDirRecord
.RecordLength
);
132 DbgPrint("ExtAttrRecordLength: %d\n", Pvd
->RootDirRecord
.ExtAttrRecordLength
);
133 DbgPrint("ExtentLocationL: %d\n", Pvd
->RootDirRecord
.ExtentLocationL
);
134 DbgPrint("DataLengthL: %d\n", Pvd
->RootDirRecord
.DataLengthL
);
135 DbgPrint("Year: %d\n", Pvd
->RootDirRecord
.Year
);
136 DbgPrint("Month: %d\n", Pvd
->RootDirRecord
.Month
);
137 DbgPrint("Day: %d\n", Pvd
->RootDirRecord
.Day
);
138 DbgPrint("Hour: %d\n", Pvd
->RootDirRecord
.Hour
);
139 DbgPrint("Minute: %d\n", Pvd
->RootDirRecord
.Minute
);
140 DbgPrint("Second: %d\n", Pvd
->RootDirRecord
.Second
);
141 DbgPrint("TimeZone: %d\n", Pvd
->RootDirRecord
.TimeZone
);
142 DbgPrint("FileFlags: %d\n", Pvd
->RootDirRecord
.FileFlags
);
143 DbgPrint("FileUnitSize: %d\n", Pvd
->RootDirRecord
.FileUnitSize
);
144 DbgPrint("InterleaveGapSize: %d\n", Pvd
->RootDirRecord
.InterleaveGapSize
);
145 DbgPrint("VolumeSequenceNumber: %d\n", Pvd
->RootDirRecord
.VolumeSequenceNumber
);
146 DbgPrint("FileIdLength: %d\n", Pvd
->RootDirRecord
.FileIdLength
);
147 DbgPrint("FileId: '%.*s'\n", Pvd
->RootDirRecord
.FileId
);
148 DbgPrint("***********************\n");
154 CdfsGetSVDData(PUCHAR Buffer
,
158 ULONG JolietLevel
= 0;
162 DPRINT("EscapeSequences: '%.32s'\n", Svd
->EscapeSequences
);
164 if (strncmp((PCHAR
)Svd
->EscapeSequences
, "%/@", 3) == 0)
166 DPRINT("Joliet extension found (UCS-2 Level 1)\n");
169 else if (strncmp((PCHAR
)Svd
->EscapeSequences
, "%/C", 3) == 0)
171 DPRINT("Joliet extension found (UCS-2 Level 2)\n");
174 else if (strncmp((PCHAR
)Svd
->EscapeSequences
, "%/E", 3) == 0)
176 DPRINT("Joliet extension found (UCS-2 Level 3)\n");
180 CdInfo
->JolietLevel
= JolietLevel
;
182 if (JolietLevel
!= 0)
184 CdInfo
->RootStart
= Svd
->RootDirRecord
.ExtentLocationL
;
185 CdInfo
->RootSize
= Svd
->RootDirRecord
.DataLengthL
;
187 DPRINT("RootStart: %lu\n", Svd
->RootDirRecord
.ExtentLocationL
);
188 DPRINT("RootSize: %lu\n", Svd
->RootDirRecord
.DataLengthL
);
194 CdfsGetVolumeData(PDEVICE_OBJECT DeviceObject
,
209 TRACK_DATA TrackData
;
213 DPRINT("CdfsGetVolumeData\n");
215 Buffer
= ExAllocatePool(NonPagedPool
,
218 return STATUS_INSUFFICIENT_RESOURCES
;
221 Status
= CdfsDeviceIoControl(DeviceObject
,
222 IOCTL_CDROM_GET_LAST_SESSION
,
228 if (!NT_SUCCESS(Status
))
234 DPRINT("FirstSession %d, LastSession %d, FirstTrack %d\n",
235 Toc
.FirstSession
, Toc
.LastSession
, Toc
.TrackData
.TrackNumber
);
238 for (i
= 0; i
< 4; i
++)
240 Offset
= (Offset
<< 8) + Toc
.TrackData
.Address
[i
];
242 CdInfo
->VolumeOffset
= Offset
;
244 DPRINT("Offset of first track in last session %d\n", Offset
);
246 CdInfo
->JolietLevel
= 0;
247 VdHeader
= (PVD_HEADER
)Buffer
;
250 for (Sector
= CDFS_PRIMARY_DESCRIPTOR_LOCATION
; Sector
< 100 && Buffer
[0] != 255; Sector
++)
252 /* Read the Primary Volume Descriptor (PVD) */
253 Status
= CdfsReadSectors (DeviceObject
,
258 if (!NT_SUCCESS(Status
))
264 if (Sector
== CDFS_PRIMARY_DESCRIPTOR_LOCATION
)
266 DPRINT("CD-identifier: [%.5s]\n", Buffer
+ 1);
268 if (Buffer
[0] != 1 || Buffer
[1] != 'C' || Buffer
[2] != 'D' ||
269 Buffer
[3] != '0' || Buffer
[4] != '0' || Buffer
[5] != '1')
272 return STATUS_UNRECOGNIZED_VOLUME
;
276 switch (VdHeader
->VdType
)
279 DPRINT("BootVolumeDescriptor found!\n");
283 DPRINT("PrimaryVolumeDescriptor found!\n");
284 CdfsGetPVDData(Buffer
, CdInfo
);
288 DPRINT("SupplementaryVolumeDescriptor found!\n");
289 CdfsGetSVDData(Buffer
, CdInfo
);
293 DPRINT("VolumePartitionDescriptor found!\n");
297 DPRINT("VolumeDescriptorSetTerminator found!\n");
301 DPRINT1("Unknown volume descriptor type %u found!\n", VdHeader
->VdType
);
308 return(STATUS_SUCCESS
);
313 CdfsMountVolume(PDEVICE_OBJECT DeviceObject
,
316 PDEVICE_EXTENSION DeviceExt
= NULL
;
317 PDEVICE_OBJECT NewDeviceObject
= NULL
;
318 PDEVICE_OBJECT DeviceToMount
;
319 PIO_STACK_LOCATION Stack
;
326 DPRINT("CdfsMountVolume() called\n");
328 if (DeviceObject
!= CdfsGlobalData
->DeviceObject
)
330 Status
= STATUS_INVALID_DEVICE_REQUEST
;
334 Stack
= IoGetCurrentIrpStackLocation(Irp
);
335 DeviceToMount
= Stack
->Parameters
.MountVolume
.DeviceObject
;
336 Vpb
= Stack
->Parameters
.MountVolume
.Vpb
;
338 Status
= CdfsGetVolumeData(DeviceToMount
, &CdInfo
);
339 if (!NT_SUCCESS(Status
))
344 Status
= IoCreateDevice(CdfsGlobalData
->DriverObject
,
345 sizeof(DEVICE_EXTENSION
),
347 FILE_DEVICE_CD_ROM_FILE_SYSTEM
,
348 DeviceToMount
->Characteristics
,
351 if (!NT_SUCCESS(Status
))
354 NewDeviceObject
->Flags
= NewDeviceObject
->Flags
| DO_DIRECT_IO
;
355 NewDeviceObject
->Flags
&= ~DO_VERIFY_VOLUME
;
356 DeviceExt
= (PVOID
)NewDeviceObject
->DeviceExtension
;
357 RtlZeroMemory(DeviceExt
,
358 sizeof(DEVICE_EXTENSION
));
360 Vpb
->SerialNumber
= CdInfo
.SerialNumber
;
361 Vpb
->VolumeLabelLength
= CdInfo
.VolumeLabelLength
;
362 RtlCopyMemory(Vpb
->VolumeLabel
, CdInfo
.VolumeLabel
, CdInfo
.VolumeLabelLength
);
363 RtlCopyMemory(&DeviceExt
->CdInfo
, &CdInfo
, sizeof(CDINFO
));
365 NewDeviceObject
->Vpb
= DeviceToMount
->Vpb
;
367 DeviceExt
->VolumeDevice
= NewDeviceObject
;
368 DeviceExt
->StorageDevice
= DeviceToMount
;
369 DeviceExt
->StorageDevice
->Vpb
->DeviceObject
= NewDeviceObject
;
370 DeviceExt
->StorageDevice
->Vpb
->RealDevice
= DeviceExt
->StorageDevice
;
371 DeviceExt
->StorageDevice
->Vpb
->Flags
|= VPB_MOUNTED
;
372 NewDeviceObject
->StackSize
= DeviceExt
->StorageDevice
->StackSize
+ 1;
373 NewDeviceObject
->Flags
&= ~DO_DEVICE_INITIALIZING
;
375 /* Close (and cleanup) might be called from IoCreateStreamFileObject
376 * but we use this resource from CdfsCleanup, therefore it should be
377 * initialized no later than this. */
378 ExInitializeResourceLite(&DeviceExt
->DirResource
);
380 DeviceExt
->StreamFileObject
= IoCreateStreamFileObject(NULL
,
381 DeviceExt
->StorageDevice
);
383 Fcb
= CdfsCreateFCB(NULL
);
386 Status
= STATUS_INSUFFICIENT_RESOURCES
;
390 Ccb
= ExAllocatePoolWithTag(NonPagedPool
,
395 Status
= STATUS_INSUFFICIENT_RESOURCES
;
401 DeviceExt
->StreamFileObject
->ReadAccess
= TRUE
;
402 DeviceExt
->StreamFileObject
->WriteAccess
= FALSE
;
403 DeviceExt
->StreamFileObject
->DeleteAccess
= FALSE
;
404 DeviceExt
->StreamFileObject
->FsContext
= Fcb
;
405 DeviceExt
->StreamFileObject
->FsContext2
= Ccb
;
406 DeviceExt
->StreamFileObject
->SectionObjectPointer
= &Fcb
->SectionObjectPointers
;
407 DeviceExt
->StreamFileObject
->PrivateCacheMap
= NULL
;
408 DeviceExt
->StreamFileObject
->Vpb
= DeviceExt
->Vpb
;
409 Ccb
->PtrFileObject
= DeviceExt
->StreamFileObject
;
410 Fcb
->FileObject
= DeviceExt
->StreamFileObject
;
411 Fcb
->DevExt
= (PDEVICE_EXTENSION
)DeviceExt
->StorageDevice
;
413 Fcb
->Flags
= FCB_IS_VOLUME_STREAM
;
415 Fcb
->RFCB
.FileSize
.QuadPart
= (DeviceExt
->CdInfo
.VolumeSpaceSize
+ DeviceExt
->CdInfo
.VolumeOffset
) * BLOCKSIZE
;
416 Fcb
->RFCB
.ValidDataLength
= Fcb
->RFCB
.AllocationSize
= Fcb
->RFCB
.FileSize
;
418 Fcb
->Entry
.ExtentLocationL
= 0;
419 Fcb
->Entry
.DataLengthL
= (DeviceExt
->CdInfo
.VolumeSpaceSize
+ DeviceExt
->CdInfo
.VolumeOffset
) * BLOCKSIZE
;
421 CcInitializeCacheMap(DeviceExt
->StreamFileObject
,
422 (PCC_FILE_SIZES
)(&Fcb
->RFCB
.AllocationSize
),
424 &(CdfsGlobalData
->CacheMgrCallbacks
),
427 ExInitializeResourceLite(&DeviceExt
->VcbResource
);
429 KeInitializeSpinLock(&DeviceExt
->FcbListLock
);
430 InitializeListHead(&DeviceExt
->FcbListHead
);
432 Status
= STATUS_SUCCESS
;
435 if (!NT_SUCCESS(Status
))
438 if (DeviceExt
&& DeviceExt
->StreamFileObject
)
439 ObDereferenceObject(DeviceExt
->StreamFileObject
);
445 IoDeleteDevice(NewDeviceObject
);
448 DPRINT("CdfsMountVolume() done (Status: %lx)\n", Status
);
455 CdfsVerifyVolume(PDEVICE_OBJECT DeviceObject
,
458 PDEVICE_EXTENSION DeviceExt
;
459 PDEVICE_OBJECT DeviceToVerify
;
460 PIO_STACK_LOCATION Stack
;
467 DPRINT1 ("CdfsVerifyVolume() called\n");
470 if (DeviceObject
!= CdfsGlobalData
->DeviceObject
)
472 DPRINT1("DeviceObject != CdfsGlobalData->DeviceObject\n");
473 return(STATUS_INVALID_DEVICE_REQUEST
);
477 DeviceExt
= DeviceObject
->DeviceExtension
;
479 Stack
= IoGetCurrentIrpStackLocation (Irp
);
480 DeviceToVerify
= Stack
->Parameters
.VerifyVolume
.DeviceObject
;
482 FsRtlEnterFileSystem();
483 ExAcquireResourceExclusiveLite (&DeviceExt
->VcbResource
,
486 if (!(DeviceToVerify
->Flags
& DO_VERIFY_VOLUME
))
488 DPRINT1 ("Volume has been verified!\n");
489 ExReleaseResourceLite (&DeviceExt
->VcbResource
);
490 FsRtlExitFileSystem();
491 return STATUS_SUCCESS
;
494 DPRINT1 ("Device object %p Device to verify %p\n", DeviceObject
, DeviceToVerify
);
496 Status
= CdfsGetVolumeData (DeviceToVerify
,
498 if (NT_SUCCESS(Status
) &&
499 CdInfo
.SerialNumber
== DeviceToVerify
->Vpb
->SerialNumber
&&
500 CdInfo
.VolumeLabelLength
== DeviceToVerify
->Vpb
->VolumeLabelLength
&&
501 !wcsncmp (CdInfo
.VolumeLabel
, DeviceToVerify
->Vpb
->VolumeLabel
, CdInfo
.VolumeLabelLength
))
503 DPRINT1 ("Same volume!\n");
505 /* FIXME: Flush and purge metadata */
507 Status
= STATUS_SUCCESS
;
511 DPRINT1 ("Different volume!\n");
513 /* FIXME: force volume dismount */
514 Entry
= DeviceExt
->FcbListHead
.Flink
;
515 while (Entry
!= &DeviceExt
->FcbListHead
)
517 Fcb
= (PFCB
)CONTAINING_RECORD(Entry
, FCB
, FcbListEntry
);
518 DPRINT1("OpenFile %S RefCount %ld\n", Fcb
->PathName
, Fcb
->RefCount
);
520 Entry
= Entry
->Flink
;
523 Status
= STATUS_WRONG_VOLUME
;
526 DeviceToVerify
->Flags
&= ~DO_VERIFY_VOLUME
;
528 ExReleaseResourceLite (&DeviceExt
->VcbResource
);
529 FsRtlExitFileSystem();
537 IN PDEVICE_OBJECT DeviceObject
,
540 PIO_STACK_LOCATION Stack
;
541 USHORT CompressionState
;
543 Stack
= IoGetCurrentIrpStackLocation(Irp
);
545 if (Stack
->Parameters
.DeviceIoControl
.InputBufferLength
!= sizeof(CompressionState
))
546 return STATUS_INVALID_DEVICE_REQUEST
;
548 CompressionState
= *(USHORT
*)Irp
->AssociatedIrp
.SystemBuffer
;
549 if (CompressionState
!= COMPRESSION_FORMAT_NONE
)
550 return STATUS_INVALID_PARAMETER
;
552 return STATUS_SUCCESS
;
557 CdfsFileSystemControl(PDEVICE_OBJECT DeviceObject
,
560 PIO_STACK_LOCATION Stack
;
563 DPRINT("CdfsFileSystemControl() called\n");
565 Stack
= IoGetCurrentIrpStackLocation(Irp
);
567 switch (Stack
->MinorFunction
)
569 case IRP_MN_USER_FS_REQUEST
:
570 switch (Stack
->Parameters
.DeviceIoControl
.IoControlCode
)
572 case FSCTL_SET_COMPRESSION
:
573 DPRINT("CDFS: IRP_MN_USER_FS_REQUEST / FSCTL_SET_COMPRESSION\n");
574 Status
= CdfsSetCompression(DeviceObject
, Irp
);
578 DPRINT1("CDFS: IRP_MN_USER_FS_REQUEST / Unknown IoControlCode 0x%x\n",
579 Stack
->Parameters
.DeviceIoControl
.IoControlCode
);
580 Status
= STATUS_INVALID_DEVICE_REQUEST
;
584 case IRP_MN_MOUNT_VOLUME
:
585 DPRINT("CDFS: IRP_MN_MOUNT_VOLUME\n");
586 Status
= CdfsMountVolume(DeviceObject
, Irp
);
589 case IRP_MN_VERIFY_VOLUME
:
590 DPRINT1("CDFS: IRP_MN_VERIFY_VOLUME\n");
591 Status
= CdfsVerifyVolume(DeviceObject
, Irp
);
595 DPRINT1("CDFS FSC: MinorFunction %d\n", Stack
->MinorFunction
);
596 Status
= STATUS_INVALID_DEVICE_REQUEST
;
600 Irp
->IoStatus
.Status
= Status
;
601 Irp
->IoStatus
.Information
= 0;
603 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);