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
[3] += Buffer
[i
+0];
67 Serial
.Part
[2] += Buffer
[i
+1];
68 Serial
.Part
[1] += Buffer
[i
+2];
69 Serial
.Part
[0] += Buffer
[i
+3];
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
,
205 DPRINT("CdfsGetVolumeData\n");
207 Buffer
= ExAllocatePool(NonPagedPool
,
210 return STATUS_INSUFFICIENT_RESOURCES
;
213 Status
= CdfsDeviceIoControl(DeviceObject
,
214 IOCTL_CDROM_READ_TOC
,
220 if (!NT_SUCCESS(Status
))
226 DPRINT("FirstTrack %u, LastTrack %u, TrackNumber %u\n",
227 Toc
.FirstTrack
, Toc
.LastTrack
, Toc
.TrackData
[0].TrackNumber
);
229 Offset
= Toc
.TrackData
[0].Address
[1] * 60 * 75;
230 Offset
+= Toc
.TrackData
[0].Address
[2] * 75;
231 Offset
+= Toc
.TrackData
[0].Address
[3];
234 /* Remove MSF numbering offset of first frame */
235 /* FIXME: should be done only for real cdroms? */
238 CdInfo
->VolumeOffset
= Offset
;
240 DPRINT("Offset of first track in last session %u\n", Offset
);
242 CdInfo
->JolietLevel
= 0;
243 VdHeader
= (PVD_HEADER
)Buffer
;
246 for (Sector
= CDFS_PRIMARY_DESCRIPTOR_LOCATION
; Sector
< 100 && Buffer
[0] != 255; Sector
++)
248 /* Read the Primary Volume Descriptor (PVD) */
249 Status
= CdfsReadSectors (DeviceObject
,
254 if (!NT_SUCCESS(Status
))
260 if (Sector
== CDFS_PRIMARY_DESCRIPTOR_LOCATION
)
262 DPRINT("CD-identifier: [%.5s]\n", Buffer
+ 1);
264 if (Buffer
[0] != 1 || Buffer
[1] != 'C' || Buffer
[2] != 'D' ||
265 Buffer
[3] != '0' || Buffer
[4] != '0' || Buffer
[5] != '1')
268 return STATUS_UNRECOGNIZED_VOLUME
;
272 switch (VdHeader
->VdType
)
275 DPRINT("BootVolumeDescriptor found!\n");
279 DPRINT("PrimaryVolumeDescriptor found!\n");
280 CdfsGetPVDData(Buffer
, CdInfo
);
284 DPRINT("SupplementaryVolumeDescriptor found!\n");
285 CdfsGetSVDData(Buffer
, CdInfo
);
289 DPRINT("VolumePartitionDescriptor found!\n");
293 DPRINT("VolumeDescriptorSetTerminator found!\n");
297 DPRINT1("Unknown volume descriptor type %u found!\n", VdHeader
->VdType
);
304 return(STATUS_SUCCESS
);
309 CdfsMountVolume(PDEVICE_OBJECT DeviceObject
,
312 PDEVICE_EXTENSION DeviceExt
= NULL
;
313 PDEVICE_OBJECT NewDeviceObject
= NULL
;
314 PDEVICE_OBJECT DeviceToMount
;
315 PIO_STACK_LOCATION Stack
;
322 DPRINT("CdfsMountVolume() called\n");
324 if (DeviceObject
!= CdfsGlobalData
->DeviceObject
)
326 Status
= STATUS_INVALID_DEVICE_REQUEST
;
330 Stack
= IoGetCurrentIrpStackLocation(Irp
);
331 DeviceToMount
= Stack
->Parameters
.MountVolume
.DeviceObject
;
332 Vpb
= Stack
->Parameters
.MountVolume
.Vpb
;
334 Status
= CdfsGetVolumeData(DeviceToMount
, &CdInfo
);
335 if (!NT_SUCCESS(Status
))
340 Status
= IoCreateDevice(CdfsGlobalData
->DriverObject
,
341 sizeof(DEVICE_EXTENSION
),
343 FILE_DEVICE_CD_ROM_FILE_SYSTEM
,
344 DeviceToMount
->Characteristics
,
347 if (!NT_SUCCESS(Status
))
350 NewDeviceObject
->Flags
= NewDeviceObject
->Flags
| DO_DIRECT_IO
;
351 NewDeviceObject
->Flags
&= ~DO_VERIFY_VOLUME
;
352 DeviceExt
= (PVOID
)NewDeviceObject
->DeviceExtension
;
353 RtlZeroMemory(DeviceExt
,
354 sizeof(DEVICE_EXTENSION
));
356 Vpb
->SerialNumber
= CdInfo
.SerialNumber
;
357 Vpb
->VolumeLabelLength
= CdInfo
.VolumeLabelLength
;
358 RtlCopyMemory(Vpb
->VolumeLabel
, CdInfo
.VolumeLabel
, CdInfo
.VolumeLabelLength
);
359 RtlCopyMemory(&DeviceExt
->CdInfo
, &CdInfo
, sizeof(CDINFO
));
361 NewDeviceObject
->Vpb
= DeviceToMount
->Vpb
;
363 DeviceExt
->VolumeDevice
= NewDeviceObject
;
364 DeviceExt
->StorageDevice
= DeviceToMount
;
365 DeviceExt
->StorageDevice
->Vpb
->DeviceObject
= NewDeviceObject
;
366 DeviceExt
->StorageDevice
->Vpb
->RealDevice
= DeviceExt
->StorageDevice
;
367 DeviceExt
->StorageDevice
->Vpb
->Flags
|= VPB_MOUNTED
;
368 NewDeviceObject
->StackSize
= DeviceExt
->StorageDevice
->StackSize
+ 1;
369 NewDeviceObject
->Flags
&= ~DO_DEVICE_INITIALIZING
;
371 /* Close (and cleanup) might be called from IoCreateStreamFileObject
372 * but we use this resource from CdfsCleanup, therefore it should be
373 * initialized no later than this. */
374 ExInitializeResourceLite(&DeviceExt
->DirResource
);
376 DeviceExt
->StreamFileObject
= IoCreateStreamFileObject(NULL
,
377 DeviceExt
->StorageDevice
);
379 Fcb
= CdfsCreateFCB(NULL
);
382 Status
= STATUS_INSUFFICIENT_RESOURCES
;
386 Ccb
= ExAllocatePoolWithTag(NonPagedPool
,
391 Status
= STATUS_INSUFFICIENT_RESOURCES
;
397 DeviceExt
->StreamFileObject
->ReadAccess
= TRUE
;
398 DeviceExt
->StreamFileObject
->WriteAccess
= FALSE
;
399 DeviceExt
->StreamFileObject
->DeleteAccess
= FALSE
;
400 DeviceExt
->StreamFileObject
->FsContext
= Fcb
;
401 DeviceExt
->StreamFileObject
->FsContext2
= Ccb
;
402 DeviceExt
->StreamFileObject
->SectionObjectPointer
= &Fcb
->SectionObjectPointers
;
403 DeviceExt
->StreamFileObject
->PrivateCacheMap
= NULL
;
404 DeviceExt
->StreamFileObject
->Vpb
= DeviceExt
->Vpb
;
405 Ccb
->PtrFileObject
= DeviceExt
->StreamFileObject
;
406 Fcb
->FileObject
= DeviceExt
->StreamFileObject
;
407 Fcb
->DevExt
= (PDEVICE_EXTENSION
)DeviceExt
->StorageDevice
;
409 Fcb
->Flags
= FCB_IS_VOLUME_STREAM
;
411 Fcb
->RFCB
.FileSize
.QuadPart
= (DeviceExt
->CdInfo
.VolumeSpaceSize
+ DeviceExt
->CdInfo
.VolumeOffset
) * BLOCKSIZE
;
412 Fcb
->RFCB
.ValidDataLength
= Fcb
->RFCB
.AllocationSize
= Fcb
->RFCB
.FileSize
;
414 Fcb
->Entry
.ExtentLocationL
= 0;
415 Fcb
->Entry
.DataLengthL
= (DeviceExt
->CdInfo
.VolumeSpaceSize
+ DeviceExt
->CdInfo
.VolumeOffset
) * BLOCKSIZE
;
417 CcInitializeCacheMap(DeviceExt
->StreamFileObject
,
418 (PCC_FILE_SIZES
)(&Fcb
->RFCB
.AllocationSize
),
420 &(CdfsGlobalData
->CacheMgrCallbacks
),
423 ExInitializeResourceLite(&DeviceExt
->VcbResource
);
425 KeInitializeSpinLock(&DeviceExt
->FcbListLock
);
426 InitializeListHead(&DeviceExt
->FcbListHead
);
428 FsRtlNotifyInitializeSync(&DeviceExt
->NotifySync
);
429 InitializeListHead(&DeviceExt
->NotifyList
);
431 Status
= STATUS_SUCCESS
;
434 if (!NT_SUCCESS(Status
))
437 if (DeviceExt
&& DeviceExt
->StreamFileObject
)
438 ObDereferenceObject(DeviceExt
->StreamFileObject
);
442 IoDeleteDevice(NewDeviceObject
);
445 DPRINT("CdfsMountVolume() done (Status: %lx)\n", Status
);
452 CdfsVerifyVolume(PDEVICE_OBJECT DeviceObject
,
455 PDEVICE_EXTENSION DeviceExt
;
456 PIO_STACK_LOCATION Stack
;
463 DPRINT1 ("CdfsVerifyVolume() called\n");
465 DeviceExt
= DeviceObject
->DeviceExtension
;
467 Stack
= IoGetCurrentIrpStackLocation (Irp
);
468 VpbToVerify
= Stack
->Parameters
.VerifyVolume
.Vpb
;
470 FsRtlEnterFileSystem();
471 ExAcquireResourceExclusiveLite (&DeviceExt
->VcbResource
,
474 if (!(VpbToVerify
->RealDevice
->Flags
& DO_VERIFY_VOLUME
))
476 DPRINT1 ("Volume has been verified!\n");
477 ExReleaseResourceLite (&DeviceExt
->VcbResource
);
478 FsRtlExitFileSystem();
479 return STATUS_SUCCESS
;
482 DPRINT1("Device object %p Device to verify %p\n", DeviceObject
, VpbToVerify
->RealDevice
);
484 Status
= CdfsGetVolumeData(VpbToVerify
->RealDevice
,
486 if (NT_SUCCESS(Status
) &&
487 CdInfo
.SerialNumber
== VpbToVerify
->SerialNumber
&&
488 CdInfo
.VolumeLabelLength
== VpbToVerify
->VolumeLabelLength
&&
489 !wcsncmp(CdInfo
.VolumeLabel
, VpbToVerify
->VolumeLabel
, CdInfo
.VolumeLabelLength
))
491 DPRINT1 ("Same volume!\n");
493 /* FIXME: Flush and purge metadata */
495 Status
= STATUS_SUCCESS
;
499 DPRINT1 ("Different volume!\n");
501 /* FIXME: force volume dismount */
502 Entry
= DeviceExt
->FcbListHead
.Flink
;
503 while (Entry
!= &DeviceExt
->FcbListHead
)
505 Fcb
= (PFCB
)CONTAINING_RECORD(Entry
, FCB
, FcbListEntry
);
506 DPRINT1("OpenFile %wZ RefCount %ld\n", &Fcb
->PathName
, Fcb
->RefCount
);
508 Entry
= Entry
->Flink
;
511 Status
= STATUS_WRONG_VOLUME
;
514 VpbToVerify
->RealDevice
->Flags
&= ~DO_VERIFY_VOLUME
;
516 ExReleaseResourceLite (&DeviceExt
->VcbResource
);
517 FsRtlExitFileSystem();
525 IN PDEVICE_OBJECT DeviceObject
,
528 PIO_STACK_LOCATION Stack
;
529 USHORT CompressionState
;
531 UNREFERENCED_PARAMETER(DeviceObject
);
533 Stack
= IoGetCurrentIrpStackLocation(Irp
);
535 if (Stack
->Parameters
.DeviceIoControl
.InputBufferLength
!= sizeof(CompressionState
))
536 return STATUS_INVALID_DEVICE_REQUEST
;
538 CompressionState
= *(USHORT
*)Irp
->AssociatedIrp
.SystemBuffer
;
539 if (CompressionState
!= COMPRESSION_FORMAT_NONE
)
540 return STATUS_INVALID_PARAMETER
;
542 return STATUS_SUCCESS
;
547 CdfsFileSystemControl(PDEVICE_OBJECT DeviceObject
,
550 PIO_STACK_LOCATION Stack
;
553 DPRINT("CdfsFileSystemControl() called\n");
555 Stack
= IoGetCurrentIrpStackLocation(Irp
);
557 switch (Stack
->MinorFunction
)
559 case IRP_MN_KERNEL_CALL
:
560 case IRP_MN_USER_FS_REQUEST
:
561 switch (Stack
->Parameters
.DeviceIoControl
.IoControlCode
)
563 case FSCTL_SET_COMPRESSION
:
564 DPRINT("CDFS: IRP_MN_USER_FS_REQUEST / FSCTL_SET_COMPRESSION\n");
565 Status
= CdfsSetCompression(DeviceObject
, Irp
);
569 DPRINT1("CDFS: IRP_MN_USER_FS_REQUEST / Unknown IoControlCode 0x%x\n",
570 Stack
->Parameters
.DeviceIoControl
.IoControlCode
);
571 Status
= STATUS_INVALID_DEVICE_REQUEST
;
575 case IRP_MN_MOUNT_VOLUME
:
576 DPRINT("CDFS: IRP_MN_MOUNT_VOLUME\n");
577 Status
= CdfsMountVolume(DeviceObject
, Irp
);
580 case IRP_MN_VERIFY_VOLUME
:
581 DPRINT1("CDFS: IRP_MN_VERIFY_VOLUME\n");
582 Status
= CdfsVerifyVolume(DeviceObject
, Irp
);
586 DPRINT1("CDFS FSC: MinorFunction %u\n", Stack
->MinorFunction
);
587 Status
= STATUS_INVALID_DEVICE_REQUEST
;
591 Irp
->IoStatus
.Status
= Status
;
592 Irp
->IoStatus
.Information
= 0;
594 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);