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
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * COPYRIGHT: See COPYING in the top level directory
22 * PROJECT: ReactOS kernel
23 * FILE: drivers/fs/cdfs/fsctl.c
24 * PURPOSE: CDROM (ISO 9660) filesystem driver
25 * PROGRAMMER: Art Yerkes
29 /* INCLUDES *****************************************************************/
36 /* FUNCTIONS ****************************************************************/
39 int msf_to_lba (UCHAR m
, UCHAR s
, UCHAR f
)
41 return (((m
* 60) + s
) * 75 + f
) - 150;
46 CdfsGetPVDData(PUCHAR Buffer
,
62 /* Calculate the volume serial number */
64 for (i
= 0; i
< 2048; i
+= 4)
66 /* DON'T optimize this to ULONG!!! (breaks overflow) */
67 Serial
.Part
[0] += Buffer
[i
+3];
68 Serial
.Part
[1] += Buffer
[i
+2];
69 Serial
.Part
[2] += Buffer
[i
+1];
70 Serial
.Part
[3] += Buffer
[i
+0];
72 CdInfo
->SerialNumber
= Serial
.Value
;
74 /* Extract the volume label */
76 pw
= CdInfo
->VolumeLabel
;
77 for (i
= 0; i
< MAXIMUM_VOLUME_LABEL_LENGTH
&& *pc
!= ' '; i
++)
82 CdInfo
->VolumeLabelLength
= i
* sizeof(WCHAR
);
84 CdInfo
->VolumeSpaceSize
= Pvd
->VolumeSpaceSizeL
;
85 CdInfo
->RootStart
= Pvd
->RootDirRecord
.ExtentLocationL
;
86 CdInfo
->RootSize
= Pvd
->RootDirRecord
.DataLengthL
;
88 DPRINT("VolumeSerial: %08lx\n", CdInfo
->SerialNumber
);
89 DPRINT("VolumeLabel: '%S'\n", CdInfo
->VolumeLabel
);
90 DPRINT("VolumeLabelLength: %lu\n", CdInfo
->VolumeLabelLength
);
91 DPRINT("VolumeSize: %lu\n", Pvd
->VolumeSpaceSizeL
);
92 DPRINT("RootStart: %lu\n", Pvd
->RootDirRecord
.ExtentLocationL
);
93 DPRINT("RootSize: %lu\n", Pvd
->RootDirRecord
.DataLengthL
);
94 DPRINT("PathTableSize: %lu\n", Pvd
->PathTableSizeL
);
95 DPRINT("PathTablePos: %lu\n", Pvd
->LPathTablePos
);
96 DPRINT("OptPathTablePos: %lu\n", Pvd
->LOptPathTablePos
);
99 DbgPrint("******** PVD **********\n");
100 DbgPrint("VdType: %d\n", Pvd
->VdType
);
101 DbgPrint("StandardId: '%.*s'\n", 5, Pvd
->StandardId
);
102 DbgPrint("VdVersion: %d\n", Pvd
->VdVersion
);
103 DbgPrint("SystemId: '%.*s'\n", 32, Pvd
->SystemId
);
104 DbgPrint("VolumeId: '%.*s'\n", 32, Pvd
->VolumeId
);
105 DbgPrint("VolumeSpaceSizeL: %d (%x)\n", Pvd
->VolumeSpaceSizeL
, Pvd
->VolumeSpaceSizeL
);
106 DbgPrint("VolumeSpaceSizeM: %d (%x)\n", Pvd
->VolumeSpaceSizeM
, Pvd
->VolumeSpaceSizeM
);
107 DbgPrint("VolumeSetSize: %d (%x)\n", Pvd
->VolumeSequenceNumber
, Pvd
->VolumeSequenceNumber
);
108 DbgPrint("VolumeSequenceNumber: %d (%x)\n", Pvd
->VolumeSequenceNumber
, Pvd
->VolumeSequenceNumber
);
109 DbgPrint("LogicalBlockSize: %d (%x)\n", Pvd
->LogicalBlockSize
, Pvd
->LogicalBlockSize
);
110 DbgPrint("PathTableSizeL: %d (%x)\n", Pvd
->PathTableSizeL
, Pvd
->PathTableSizeL
);
111 DbgPrint("PathTableSizeM: %d (%x)\n", Pvd
->PathTableSizeM
, Pvd
->PathTableSizeM
);
112 DbgPrint("LPathTablePos: %d (%x)\n", Pvd
->LPathTablePos
, Pvd
->LPathTablePos
);
113 DbgPrint("LOptPathTablePos: %d (%x)\n", Pvd
->LOptPathTablePos
, Pvd
->LOptPathTablePos
);
114 DbgPrint("MPathTablePos: %d (%x)\n", Pvd
->MPathTablePos
, Pvd
->MPathTablePos
);
115 DbgPrint("MOptPathTablePos: %d (%x)\n", Pvd
->MOptPathTablePos
, Pvd
->MOptPathTablePos
);
116 DbgPrint("VolumeSetIdentifier: '%.*s'\n", 128, Pvd
->VolumeSetIdentifier
);
117 DbgPrint("PublisherIdentifier: '%.*s'\n", 128, Pvd
->PublisherIdentifier
);
118 DbgPrint("******** Root *********\n");
119 DbgPrint("RecordLength: %d\n", Pvd
->RootDirRecord
.RecordLength
);
120 DbgPrint("ExtAttrRecordLength: %d\n", Pvd
->RootDirRecord
.ExtAttrRecordLength
);
121 DbgPrint("ExtentLocationL: %d\n", Pvd
->RootDirRecord
.ExtentLocationL
);
122 DbgPrint("DataLengthL: %d\n", Pvd
->RootDirRecord
.DataLengthL
);
123 DbgPrint("Year: %d\n", Pvd
->RootDirRecord
.Year
);
124 DbgPrint("Month: %d\n", Pvd
->RootDirRecord
.Month
);
125 DbgPrint("Day: %d\n", Pvd
->RootDirRecord
.Day
);
126 DbgPrint("Hour: %d\n", Pvd
->RootDirRecord
.Hour
);
127 DbgPrint("Minute: %d\n", Pvd
->RootDirRecord
.Minute
);
128 DbgPrint("Second: %d\n", Pvd
->RootDirRecord
.Second
);
129 DbgPrint("TimeZone: %d\n", Pvd
->RootDirRecord
.TimeZone
);
130 DbgPrint("FileFlags: %d\n", Pvd
->RootDirRecord
.FileFlags
);
131 DbgPrint("FileUnitSize: %d\n", Pvd
->RootDirRecord
.FileUnitSize
);
132 DbgPrint("InterleaveGapSize: %d\n", Pvd
->RootDirRecord
.InterleaveGapSize
);
133 DbgPrint("VolumeSequenceNumber: %d\n", Pvd
->RootDirRecord
.VolumeSequenceNumber
);
134 DbgPrint("FileIdLength: %d\n", Pvd
->RootDirRecord
.FileIdLength
);
135 DbgPrint("FileId: '%.*s'\n", Pvd
->RootDirRecord
.FileId
);
136 DbgPrint("***********************\n");
142 CdfsGetSVDData(PUCHAR Buffer
,
146 ULONG JolietLevel
= 0;
150 DPRINT("EscapeSequences: '%.32s'\n", Svd
->EscapeSequences
);
152 if (strncmp((PCHAR
)Svd
->EscapeSequences
, "%/@", 3) == 0)
154 DPRINT("Joliet extension found (UCS-2 Level 1)\n");
157 else if (strncmp((PCHAR
)Svd
->EscapeSequences
, "%/C", 3) == 0)
159 DPRINT("Joliet extension found (UCS-2 Level 2)\n");
162 else if (strncmp((PCHAR
)Svd
->EscapeSequences
, "%/E", 3) == 0)
164 DPRINT("Joliet extension found (UCS-2 Level 3)\n");
168 CdInfo
->JolietLevel
= JolietLevel
;
170 if (JolietLevel
!= 0)
172 CdInfo
->RootStart
= Svd
->RootDirRecord
.ExtentLocationL
;
173 CdInfo
->RootSize
= Svd
->RootDirRecord
.DataLengthL
;
175 DPRINT("RootStart: %lu\n", Svd
->RootDirRecord
.ExtentLocationL
);
176 DPRINT("RootSize: %lu\n", Svd
->RootDirRecord
.DataLengthL
);
182 CdfsGetVolumeData(PDEVICE_OBJECT DeviceObject
,
197 TRACK_DATA TrackData
;
201 DPRINT("CdfsGetVolumeData\n");
203 Buffer
= ExAllocatePool(NonPagedPool
,
206 return STATUS_INSUFFICIENT_RESOURCES
;
209 Status
= CdfsDeviceIoControl(DeviceObject
,
210 IOCTL_CDROM_GET_LAST_SESSION
,
216 if (!NT_SUCCESS(Status
))
222 DPRINT("FirstSession %d, LastSession %d, FirstTrack %d\n",
223 Toc
.FirstSession
, Toc
.LastSession
, Toc
.TrackData
.TrackNumber
);
226 for (i
= 0; i
< 4; i
++)
228 Offset
= (Offset
<< 8) + Toc
.TrackData
.Address
[i
];
230 CdInfo
->VolumeOffset
= Offset
;
232 DPRINT("Offset of first track in last session %d\n", Offset
);
234 CdInfo
->JolietLevel
= 0;
235 VdHeader
= (PVD_HEADER
)Buffer
;
238 for (Sector
= CDFS_PRIMARY_DESCRIPTOR_LOCATION
; Sector
< 100 && Buffer
[0] != 255; Sector
++)
240 /* Read the Primary Volume Descriptor (PVD) */
241 Status
= CdfsReadSectors (DeviceObject
,
246 if (!NT_SUCCESS(Status
))
252 if (Sector
== CDFS_PRIMARY_DESCRIPTOR_LOCATION
)
254 DPRINT("CD-identifier: [%.5s]\n", Buffer
+ 1);
256 if (Buffer
[0] != 1 || Buffer
[1] != 'C' || Buffer
[2] != 'D' ||
257 Buffer
[3] != '0' || Buffer
[4] != '0' || Buffer
[5] != '1')
260 return STATUS_UNRECOGNIZED_VOLUME
;
264 switch (VdHeader
->VdType
)
267 DPRINT("BootVolumeDescriptor found!\n");
271 DPRINT("PrimaryVolumeDescriptor found!\n");
272 CdfsGetPVDData(Buffer
, CdInfo
);
276 DPRINT("SupplementaryVolumeDescriptor found!\n");
277 CdfsGetSVDData(Buffer
, CdInfo
);
281 DPRINT("VolumePartitionDescriptor found!\n");
285 DPRINT("VolumeDescriptorSetTerminator found!\n");
289 DPRINT1("Unknown volume descriptor type %u found!\n", VdHeader
->VdType
);
296 return(STATUS_SUCCESS
);
301 CdfsMountVolume(PDEVICE_OBJECT DeviceObject
,
304 PDEVICE_EXTENSION DeviceExt
= NULL
;
305 PDEVICE_OBJECT NewDeviceObject
= NULL
;
306 PDEVICE_OBJECT DeviceToMount
;
307 PIO_STACK_LOCATION Stack
;
314 DPRINT("CdfsMountVolume() called\n");
316 if (DeviceObject
!= CdfsGlobalData
->DeviceObject
)
318 Status
= STATUS_INVALID_DEVICE_REQUEST
;
322 Stack
= IoGetCurrentIrpStackLocation(Irp
);
323 DeviceToMount
= Stack
->Parameters
.MountVolume
.DeviceObject
;
324 Vpb
= Stack
->Parameters
.MountVolume
.Vpb
;
326 Status
= CdfsGetVolumeData(DeviceToMount
, &CdInfo
);
327 if (!NT_SUCCESS(Status
))
332 Status
= IoCreateDevice(CdfsGlobalData
->DriverObject
,
333 sizeof(DEVICE_EXTENSION
),
335 FILE_DEVICE_FILE_SYSTEM
,
336 // FILE_DEVICE_DISK_FILE_SYSTEM,
340 if (!NT_SUCCESS(Status
))
343 NewDeviceObject
->Flags
= NewDeviceObject
->Flags
| DO_DIRECT_IO
;
344 NewDeviceObject
->Flags
&= ~DO_VERIFY_VOLUME
;
345 DeviceExt
= (PVOID
)NewDeviceObject
->DeviceExtension
;
346 RtlZeroMemory(DeviceExt
,
347 sizeof(DEVICE_EXTENSION
));
349 Vpb
->SerialNumber
= CdInfo
.SerialNumber
;
350 Vpb
->VolumeLabelLength
= CdInfo
.VolumeLabelLength
;
351 RtlCopyMemory(Vpb
->VolumeLabel
, CdInfo
.VolumeLabel
, CdInfo
.VolumeLabelLength
* sizeof(WCHAR
));
352 RtlCopyMemory(&DeviceExt
->CdInfo
, &CdInfo
, sizeof(CDINFO
));
354 NewDeviceObject
->Vpb
= DeviceToMount
->Vpb
;
356 DeviceExt
->VolumeDevice
= NewDeviceObject
;
357 DeviceExt
->StorageDevice
= DeviceToMount
;
358 DeviceExt
->StorageDevice
->Vpb
->DeviceObject
= NewDeviceObject
;
359 DeviceExt
->StorageDevice
->Vpb
->RealDevice
= DeviceExt
->StorageDevice
;
360 DeviceExt
->StorageDevice
->Vpb
->Flags
|= VPB_MOUNTED
;
361 NewDeviceObject
->StackSize
= DeviceExt
->StorageDevice
->StackSize
+ 1;
362 NewDeviceObject
->Flags
&= ~DO_DEVICE_INITIALIZING
;
364 DeviceExt
->StreamFileObject
= IoCreateStreamFileObject(NULL
,
365 DeviceExt
->StorageDevice
);
367 Fcb
= CdfsCreateFCB(NULL
);
370 Status
= STATUS_INSUFFICIENT_RESOURCES
;
374 Ccb
= ExAllocatePoolWithTag(NonPagedPool
,
379 Status
= STATUS_INSUFFICIENT_RESOURCES
;
385 DeviceExt
->StreamFileObject
->FsContext
= Fcb
;
386 DeviceExt
->StreamFileObject
->FsContext2
= Ccb
;
387 DeviceExt
->StreamFileObject
->SectionObjectPointer
= &Fcb
->SectionObjectPointers
;
388 DeviceExt
->StreamFileObject
->PrivateCacheMap
= NULL
;
389 DeviceExt
->StreamFileObject
->Vpb
= DeviceExt
->Vpb
;
390 Ccb
->PtrFileObject
= DeviceExt
->StreamFileObject
;
391 Fcb
->FileObject
= DeviceExt
->StreamFileObject
;
392 Fcb
->DevExt
= (PDEVICE_EXTENSION
)DeviceExt
->StorageDevice
;
394 Fcb
->Flags
= FCB_IS_VOLUME_STREAM
;
396 Fcb
->RFCB
.FileSize
.QuadPart
= (DeviceExt
->CdInfo
.VolumeSpaceSize
+ DeviceExt
->CdInfo
.VolumeOffset
) * BLOCKSIZE
;
397 Fcb
->RFCB
.ValidDataLength
= Fcb
->RFCB
.AllocationSize
= Fcb
->RFCB
.FileSize
;
399 Fcb
->Entry
.ExtentLocationL
= 0;
400 Fcb
->Entry
.DataLengthL
= (DeviceExt
->CdInfo
.VolumeSpaceSize
+ DeviceExt
->CdInfo
.VolumeOffset
) * BLOCKSIZE
;
401 #ifdef USE_ROS_CC_AND_FS
402 Status
= CcRosInitializeFileCache(DeviceExt
->StreamFileObject
,
404 if (!NT_SUCCESS (Status
))
406 DbgPrint("CcRosInitializeFileCache failed\n");
410 CcInitializeCacheMap(DeviceExt
->StreamFileObject
,
411 (PCC_FILE_SIZES
)(&Fcb
->RFCB
.AllocationSize
),
416 ExInitializeResourceLite(&DeviceExt
->VcbResource
);
417 ExInitializeResourceLite(&DeviceExt
->DirResource
);
419 KeInitializeSpinLock(&DeviceExt
->FcbListLock
);
420 InitializeListHead(&DeviceExt
->FcbListHead
);
422 Status
= STATUS_SUCCESS
;
425 if (!NT_SUCCESS(Status
))
428 if (DeviceExt
&& DeviceExt
->StreamFileObject
)
429 ObDereferenceObject(DeviceExt
->StreamFileObject
);
435 IoDeleteDevice(NewDeviceObject
);
438 DPRINT("CdfsMountVolume() done (Status: %lx)\n", Status
);
445 CdfsVerifyVolume(PDEVICE_OBJECT DeviceObject
,
448 PDEVICE_EXTENSION DeviceExt
;
449 PDEVICE_OBJECT DeviceToVerify
;
450 PIO_STACK_LOCATION Stack
;
457 DPRINT1 ("CdfsVerifyVolume() called\n");
460 if (DeviceObject
!= CdfsGlobalData
->DeviceObject
)
462 DPRINT1("DeviceObject != CdfsGlobalData->DeviceObject\n");
463 return(STATUS_INVALID_DEVICE_REQUEST
);
467 DeviceExt
= DeviceObject
->DeviceExtension
;
469 Stack
= IoGetCurrentIrpStackLocation (Irp
);
470 DeviceToVerify
= Stack
->Parameters
.VerifyVolume
.DeviceObject
;
472 ExAcquireResourceExclusiveLite (&DeviceExt
->VcbResource
,
475 if (!(DeviceToVerify
->Flags
& DO_VERIFY_VOLUME
))
477 DPRINT1 ("Volume has been verified!\n");
478 ExReleaseResourceLite (&DeviceExt
->VcbResource
);
479 return STATUS_SUCCESS
;
482 DPRINT1 ("Device object %p Device to verify %p\n", DeviceObject
, DeviceToVerify
);
484 Status
= CdfsGetVolumeData (DeviceToVerify
,
486 if (NT_SUCCESS(Status
) &&
487 CdInfo
.SerialNumber
== DeviceToVerify
->Vpb
->SerialNumber
&&
488 CdInfo
.VolumeLabelLength
== DeviceToVerify
->Vpb
->VolumeLabelLength
&&
489 !wcsncmp (CdInfo
.VolumeLabel
, DeviceToVerify
->Vpb
->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 %S RefCount %ld\n", Fcb
->PathName
, Fcb
->RefCount
);
508 Entry
= Entry
->Flink
;
511 Status
= STATUS_WRONG_VOLUME
;
514 DeviceToVerify
->Flags
&= ~DO_VERIFY_VOLUME
;
516 ExReleaseResourceLite (&DeviceExt
->VcbResource
);
523 CdfsFileSystemControl(PDEVICE_OBJECT DeviceObject
,
526 PIO_STACK_LOCATION Stack
;
529 DPRINT("CdfsFileSystemControl() called\n");
531 Stack
= IoGetCurrentIrpStackLocation(Irp
);
533 switch (Stack
->MinorFunction
)
535 case IRP_MN_USER_FS_REQUEST
:
536 DPRINT1("CDFS: IRP_MN_USER_FS_REQUEST\n");
537 Status
= STATUS_INVALID_DEVICE_REQUEST
;
540 case IRP_MN_MOUNT_VOLUME
:
541 DPRINT("CDFS: IRP_MN_MOUNT_VOLUME\n");
542 Status
= CdfsMountVolume(DeviceObject
, Irp
);
545 case IRP_MN_VERIFY_VOLUME
:
546 DPRINT1("CDFS: IRP_MN_VERIFY_VOLUME\n");
547 Status
= CdfsVerifyVolume(DeviceObject
, Irp
);
551 DPRINT1("CDFS FSC: MinorFunction %d\n", Stack
->MinorFunction
);
552 Status
= STATUS_INVALID_DEVICE_REQUEST
;
556 Irp
->IoStatus
.Status
= Status
;
557 Irp
->IoStatus
.Information
= 0;
559 IoCompleteRequest(Irp
, IO_NO_INCREMENT
);