2 Handle on-disk format and volume structures in UDF/ECMA-167 file systems.
4 Copyright (C) 2014-2017 Paulo Alcantara <pcacjr@zytor.com>
6 This program and the accompanying materials are licensed and made available
7 under the terms and conditions of the BSD License which accompanies this
8 distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT
12 WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 FindAnchorVolumeDescriptorPointer (
19 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
20 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
21 OUT UDF_ANCHOR_VOLUME_DESCRIPTOR_POINTER
*AnchorPoint
27 EFI_LBA DescriptorLBAs
[4];
30 BlockSize
= BlockIo
->Media
->BlockSize
;
31 EndLBA
= BlockIo
->Media
->LastBlock
;
32 DescriptorLBAs
[0] = 256;
33 DescriptorLBAs
[1] = EndLBA
- 256;
34 DescriptorLBAs
[2] = EndLBA
;
35 DescriptorLBAs
[3] = 512;
37 for (Index
= 0; Index
< ARRAY_SIZE (DescriptorLBAs
); Index
++) {
38 Status
= DiskIo
->ReadDisk (
40 BlockIo
->Media
->MediaId
,
41 MultU64x32 (DescriptorLBAs
[Index
], BlockSize
),
42 sizeof (UDF_ANCHOR_VOLUME_DESCRIPTOR_POINTER
),
45 if (EFI_ERROR (Status
)) {
49 // Check if read LBA has a valid AVDP descriptor.
51 if (IS_AVDP (AnchorPoint
)) {
58 return EFI_VOLUME_CORRUPTED
;
62 StartMainVolumeDescriptorSequence (
63 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
64 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
65 IN UDF_ANCHOR_VOLUME_DESCRIPTOR_POINTER
*AnchorPoint
,
66 OUT UDF_VOLUME_INFO
*Volume
71 UDF_EXTENT_AD
*ExtentAd
;
75 UDF_LOGICAL_VOLUME_DESCRIPTOR
*LogicalVolDesc
;
76 UDF_PARTITION_DESCRIPTOR
*PartitionDesc
;
78 UINT32 LogicalBlockSize
;
81 // We've already found an ADVP on the volume. It contains the extent
82 // (MainVolumeDescriptorSequenceExtent) where the Main Volume Descriptor
83 // Sequence starts. Therefore, we'll look for Logical Volume Descriptors and
84 // Partitions Descriptors and save them in memory, accordingly.
86 // Note also that each descriptor will be aligned on a block size (BlockSize)
87 // boundary, so we need to read one block at a time.
89 BlockSize
= BlockIo
->Media
->BlockSize
;
90 ExtentAd
= &AnchorPoint
->MainVolumeDescriptorSequenceExtent
;
91 StartingLsn
= (UINT64
)ExtentAd
->ExtentLocation
;
92 EndingLsn
= StartingLsn
+ DivU64x32 (
93 (UINT64
)ExtentAd
->ExtentLength
,
97 Volume
->LogicalVolDescs
=
98 (UDF_LOGICAL_VOLUME_DESCRIPTOR
**)AllocateZeroPool (ExtentAd
->ExtentLength
);
99 if (Volume
->LogicalVolDescs
== NULL
) {
100 return EFI_OUT_OF_RESOURCES
;
103 Volume
->PartitionDescs
=
104 (UDF_PARTITION_DESCRIPTOR
**)AllocateZeroPool (ExtentAd
->ExtentLength
);
105 if (Volume
->PartitionDescs
== NULL
) {
106 Status
= EFI_OUT_OF_RESOURCES
;
107 goto Error_Alloc_Pds
;
110 Buffer
= AllocateZeroPool (BlockSize
);
111 if (Buffer
== NULL
) {
112 Status
= EFI_OUT_OF_RESOURCES
;
113 goto Error_Alloc_Buf
;
116 Volume
->LogicalVolDescsNo
= 0;
117 Volume
->PartitionDescsNo
= 0;
119 while (StartingLsn
<= EndingLsn
) {
120 Status
= DiskIo
->ReadDisk (
122 BlockIo
->Media
->MediaId
,
123 MultU64x32 (StartingLsn
, BlockSize
),
127 if (EFI_ERROR (Status
)) {
128 goto Error_Read_Disk_Blk
;
131 if (IS_TD (Buffer
)) {
133 // Found a Terminating Descriptor. Stop the sequence then.
138 if (IS_LVD (Buffer
)) {
140 // Found a Logical Volume Descriptor.
143 (UDF_LOGICAL_VOLUME_DESCRIPTOR
*)
144 AllocateZeroPool (sizeof (UDF_LOGICAL_VOLUME_DESCRIPTOR
));
145 if (LogicalVolDesc
== NULL
) {
146 Status
= EFI_OUT_OF_RESOURCES
;
147 goto Error_Alloc_Lvd
;
150 CopyMem ((VOID
*)LogicalVolDesc
, Buffer
,
151 sizeof (UDF_LOGICAL_VOLUME_DESCRIPTOR
));
152 Volume
->LogicalVolDescs
[Volume
->LogicalVolDescsNo
++] = LogicalVolDesc
;
153 } else if (IS_PD (Buffer
)) {
155 // Found a Partition Descriptor.
158 (UDF_PARTITION_DESCRIPTOR
*)
159 AllocateZeroPool (sizeof (UDF_PARTITION_DESCRIPTOR
));
160 if (PartitionDesc
== NULL
) {
161 Status
= EFI_OUT_OF_RESOURCES
;
165 CopyMem ((VOID
*)PartitionDesc
, Buffer
,
166 sizeof (UDF_PARTITION_DESCRIPTOR
));
167 Volume
->PartitionDescs
[Volume
->PartitionDescsNo
++] = PartitionDesc
;
174 // When an UDF volume (revision 2.00 or higher) contains a File Entry rather
175 // than an Extended File Entry (which is not recommended as per spec), we need
176 // to make sure the size of a FE will be _at least_ 2048
177 // (UDF_LOGICAL_SECTOR_SIZE) bytes long to keep backward compatibility.
179 LogicalBlockSize
= LV_BLOCK_SIZE (Volume
, UDF_DEFAULT_LV_NUM
);
180 if (LogicalBlockSize
>= UDF_LOGICAL_SECTOR_SIZE
) {
181 Volume
->FileEntrySize
= LogicalBlockSize
;
183 Volume
->FileEntrySize
= UDF_LOGICAL_SECTOR_SIZE
;
192 for (Index
= 0; Index
< Volume
->PartitionDescsNo
; Index
++) {
193 FreePool ((VOID
*)Volume
->PartitionDescs
[Index
]);
196 for (Index
= 0; Index
< Volume
->LogicalVolDescsNo
; Index
++) {
197 FreePool ((VOID
*)Volume
->LogicalVolDescs
[Index
]);
204 FreePool ((VOID
*)Volume
->PartitionDescs
);
205 Volume
->PartitionDescs
= NULL
;
208 FreePool ((VOID
*)Volume
->LogicalVolDescs
);
209 Volume
->LogicalVolDescs
= NULL
;
215 // Return a Partition Descriptor given a Long Allocation Descriptor. This is
216 // necessary to calculate the right extent (LongAd) offset which is added up
217 // with partition's starting location.
219 UDF_PARTITION_DESCRIPTOR
*
221 IN UDF_VOLUME_INFO
*Volume
,
222 IN UDF_LONG_ALLOCATION_DESCRIPTOR
*LongAd
225 UDF_LOGICAL_VOLUME_DESCRIPTOR
*LogicalVolDesc
;
227 UDF_PARTITION_DESCRIPTOR
*PartitionDesc
;
230 LogicalVolDesc
= Volume
->LogicalVolDescs
[UDF_DEFAULT_LV_NUM
];
232 switch (LV_UDF_REVISION (LogicalVolDesc
)) {
235 // As per UDF 1.02 specification:
237 // There shall be exactly one prevailing Logical Volume Descriptor recorded
238 // per Volume Set. The Partition Maps field shall contain only Type 1
241 PartitionNum
= *(UINT16
*)((UINTN
)&LogicalVolDesc
->PartitionMaps
[4]);
245 // Ensure Type 1 Partition map. Other types aren't supported in this
248 if (LogicalVolDesc
->PartitionMaps
[0] != 1 ||
249 LogicalVolDesc
->PartitionMaps
[1] != 6) {
252 PartitionNum
= *(UINT16
*)((UINTN
)&LogicalVolDesc
->PartitionMaps
[4]);
259 PartitionNum
= LongAd
->ExtentLocation
.PartitionReferenceNumber
;
263 for (Index
= 0; Index
< Volume
->PartitionDescsNo
; Index
++) {
264 PartitionDesc
= Volume
->PartitionDescs
[Index
];
265 if (PartitionDesc
->PartitionNumber
== PartitionNum
) {
266 return PartitionDesc
;
274 // Return logical sector number of a given Long Allocation Descriptor.
278 IN UDF_VOLUME_INFO
*Volume
,
279 IN UDF_LONG_ALLOCATION_DESCRIPTOR
*LongAd
282 UDF_PARTITION_DESCRIPTOR
*PartitionDesc
;
284 PartitionDesc
= GetPdFromLongAd (Volume
, LongAd
);
285 ASSERT (PartitionDesc
!= NULL
);
287 return (UINT64
)PartitionDesc
->PartitionStartingLocation
+
288 LongAd
->ExtentLocation
.LogicalBlockNumber
;
292 // Return logical sector number of a given Short Allocation Descriptor.
296 IN UDF_PARTITION_DESCRIPTOR
*PartitionDesc
,
297 IN UDF_SHORT_ALLOCATION_DESCRIPTOR
*ShortAd
300 return (UINT64
)PartitionDesc
->PartitionStartingLocation
+
301 ShortAd
->ExtentPosition
;
305 // Find File Set Descriptor of a given Logical Volume Descriptor.
307 // The found FSD will contain the extent (LogicalVolumeContentsUse) where our
308 // root directory is.
311 FindFileSetDescriptor (
312 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
313 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
314 IN UDF_VOLUME_INFO
*Volume
,
315 IN UINTN LogicalVolDescNum
,
316 OUT UDF_FILE_SET_DESCRIPTOR
*FileSetDesc
321 UDF_LOGICAL_VOLUME_DESCRIPTOR
*LogicalVolDesc
;
323 LogicalVolDesc
= Volume
->LogicalVolDescs
[LogicalVolDescNum
];
324 Lsn
= GetLongAdLsn (Volume
, &LogicalVolDesc
->LogicalVolumeContentsUse
);
327 // Read extent (Long Ad).
329 Status
= DiskIo
->ReadDisk (
331 BlockIo
->Media
->MediaId
,
332 MultU64x32 (Lsn
, LogicalVolDesc
->LogicalBlockSize
),
333 sizeof (UDF_FILE_SET_DESCRIPTOR
),
336 if (EFI_ERROR (Status
)) {
341 // Check if the read extent contains a valid FSD's tag identifier.
343 if (!IS_FSD (FileSetDesc
)) {
344 return EFI_VOLUME_CORRUPTED
;
351 // Get all File Set Descriptors for each Logical Volume Descriptor.
354 GetFileSetDescriptors (
355 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
356 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
357 IN OUT UDF_VOLUME_INFO
*Volume
362 UDF_FILE_SET_DESCRIPTOR
*FileSetDesc
;
365 Volume
->FileSetDescs
=
366 (UDF_FILE_SET_DESCRIPTOR
**)AllocateZeroPool (
367 Volume
->LogicalVolDescsNo
* sizeof (UDF_FILE_SET_DESCRIPTOR
));
368 if (Volume
->FileSetDescs
== NULL
) {
369 return EFI_OUT_OF_RESOURCES
;
372 for (Index
= 0; Index
< Volume
->LogicalVolDescsNo
; Index
++) {
373 FileSetDesc
= AllocateZeroPool (sizeof (UDF_FILE_SET_DESCRIPTOR
));
374 if (FileSetDesc
== NULL
) {
375 Status
= EFI_OUT_OF_RESOURCES
;
376 goto Error_Alloc_Fsd
;
380 // Find a FSD for this LVD.
382 Status
= FindFileSetDescriptor (
389 if (EFI_ERROR (Status
)) {
396 Volume
->FileSetDescs
[Index
] = FileSetDesc
;
399 Volume
->FileSetDescsNo
= Volume
->LogicalVolDescsNo
;
404 for (Index
= 0; Index
< Count
; Index
++) {
405 FreePool ((VOID
*)Volume
->FileSetDescs
[Index
]);
408 FreePool ((VOID
*)Volume
->FileSetDescs
);
409 Volume
->FileSetDescs
= NULL
;
416 // Read Volume and File Structure on an UDF file system.
419 ReadVolumeFileStructure (
420 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
421 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
422 OUT UDF_VOLUME_INFO
*Volume
426 UDF_ANCHOR_VOLUME_DESCRIPTOR_POINTER AnchorPoint
;
431 Status
= FindAnchorVolumeDescriptorPointer (
436 if (EFI_ERROR (Status
)) {
441 // AVDP has been found. Start MVDS.
443 Status
= StartMainVolumeDescriptorSequence (
449 if (EFI_ERROR (Status
)) {
457 // Calculate length of a given File Identifier Descriptor.
460 GetFidDescriptorLength (
461 IN UDF_FILE_IDENTIFIER_DESCRIPTOR
*FileIdentifierDesc
465 (INTN
)((OFFSET_OF (UDF_FILE_IDENTIFIER_DESCRIPTOR
, Data
[0]) + 3 +
466 FileIdentifierDesc
->LengthOfFileIdentifier
+
467 FileIdentifierDesc
->LengthOfImplementationUse
) >> 2) << 2
472 // Duplicate a given File Identifier Descriptor.
476 IN UDF_FILE_IDENTIFIER_DESCRIPTOR
*FileIdentifierDesc
,
477 OUT UDF_FILE_IDENTIFIER_DESCRIPTOR
**NewFileIdentifierDesc
480 *NewFileIdentifierDesc
=
481 (UDF_FILE_IDENTIFIER_DESCRIPTOR
*)AllocateCopyPool (
482 (UINTN
) GetFidDescriptorLength (FileIdentifierDesc
), FileIdentifierDesc
);
486 // Duplicate either a given File Entry or a given Extended File Entry.
490 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
491 IN UDF_VOLUME_INFO
*Volume
,
493 OUT VOID
**NewFileEntry
496 *NewFileEntry
= AllocateCopyPool (Volume
->FileEntrySize
, FileEntry
);
500 // Get raw data + length of a given File Entry or Extended File Entry.
502 // The file's recorded data can contain either real file content (inline) or
503 // a sequence of extents (or Allocation Descriptors) which tells where file's
504 // content is stored in.
506 // NOTE: The FE/EFE can be thought it was an inode.
510 IN VOID
*FileEntryData
,
515 UDF_EXTENDED_FILE_ENTRY
*ExtendedFileEntry
;
516 UDF_FILE_ENTRY
*FileEntry
;
518 if (IS_EFE (FileEntryData
)) {
519 ExtendedFileEntry
= (UDF_EXTENDED_FILE_ENTRY
*)FileEntryData
;
521 *Length
= ExtendedFileEntry
->InformationLength
;
522 *Data
= (VOID
*)((UINT8
*)ExtendedFileEntry
->Data
+
523 ExtendedFileEntry
->LengthOfExtendedAttributes
);
524 } else if (IS_FE (FileEntryData
)) {
525 FileEntry
= (UDF_FILE_ENTRY
*)FileEntryData
;
527 *Length
= FileEntry
->InformationLength
;
528 *Data
= (VOID
*)((UINT8
*)FileEntry
->Data
+
529 FileEntry
->LengthOfExtendedAttributes
);
534 // Get Allocation Descriptors' data information from a given FE/EFE.
538 IN VOID
*FileEntryData
,
543 UDF_EXTENDED_FILE_ENTRY
*ExtendedFileEntry
;
544 UDF_FILE_ENTRY
*FileEntry
;
546 if (IS_EFE (FileEntryData
)) {
547 ExtendedFileEntry
= (UDF_EXTENDED_FILE_ENTRY
*)FileEntryData
;
549 *Length
= ExtendedFileEntry
->LengthOfAllocationDescriptors
;
550 *AdsData
= (VOID
*)((UINT8
*)ExtendedFileEntry
->Data
+
551 ExtendedFileEntry
->LengthOfExtendedAttributes
);
552 } else if (IS_FE (FileEntryData
)) {
553 FileEntry
= (UDF_FILE_ENTRY
*)FileEntryData
;
555 *Length
= FileEntry
->LengthOfAllocationDescriptors
;
556 *AdsData
= (VOID
*)((UINT8
*)FileEntry
->Data
+
557 FileEntry
->LengthOfExtendedAttributes
);
562 // Read next Long Allocation Descriptor from a given file's data.
567 IN OUT UINT64
*Offset
,
569 OUT UDF_LONG_ALLOCATION_DESCRIPTOR
**FoundLongAd
572 UDF_LONG_ALLOCATION_DESCRIPTOR
*LongAd
;
573 UDF_EXTENT_FLAGS ExtentFlags
;
576 if (*Offset
>= Length
) {
578 // No more Long Allocation Descriptors.
580 return EFI_DEVICE_ERROR
;
584 (UDF_LONG_ALLOCATION_DESCRIPTOR
*)((UINT8
*)Data
+ *Offset
);
587 // If it's either an indirect AD (Extended Alllocation Descriptor) or an
588 // allocated AD, then return it.
590 ExtentFlags
= GET_EXTENT_FLAGS (LONG_ADS_SEQUENCE
, LongAd
);
591 if (ExtentFlags
== EXTENT_IS_NEXT_EXTENT
||
592 ExtentFlags
== EXTENT_RECORDED_AND_ALLOCATED
) {
597 // This AD is either not recorded but allocated, or not recorded and not
598 // allocated. Skip it.
600 *Offset
+= AD_LENGTH (LONG_ADS_SEQUENCE
);
603 *FoundLongAd
= LongAd
;
609 // Read next Short Allocation Descriptor from a given file's data.
614 IN OUT UINT64
*Offset
,
616 OUT UDF_SHORT_ALLOCATION_DESCRIPTOR
**FoundShortAd
619 UDF_SHORT_ALLOCATION_DESCRIPTOR
*ShortAd
;
620 UDF_EXTENT_FLAGS ExtentFlags
;
623 if (*Offset
>= Length
) {
625 // No more Short Allocation Descriptors.
627 return EFI_DEVICE_ERROR
;
631 (UDF_SHORT_ALLOCATION_DESCRIPTOR
*)((UINT8
*)Data
+ *Offset
);
634 // If it's either an indirect AD (Extended Alllocation Descriptor) or an
635 // allocated AD, then return it.
637 ExtentFlags
= GET_EXTENT_FLAGS (SHORT_ADS_SEQUENCE
, ShortAd
);
638 if (ExtentFlags
== EXTENT_IS_NEXT_EXTENT
||
639 ExtentFlags
== EXTENT_RECORDED_AND_ALLOCATED
) {
644 // This AD is either not recorded but allocated, or not recorded and not
645 // allocated. Skip it.
647 *Offset
+= AD_LENGTH (SHORT_ADS_SEQUENCE
);
650 *FoundShortAd
= ShortAd
;
656 // Get either a Short Allocation Descriptor or a Long Allocation Descriptor from
660 GetAllocationDescriptor (
661 IN UDF_FE_RECORDING_FLAGS RecordingFlags
,
663 IN OUT UINT64
*Offset
,
668 if (RecordingFlags
== LONG_ADS_SEQUENCE
) {
669 return GetLongAdFromAds (
673 (UDF_LONG_ALLOCATION_DESCRIPTOR
**)FoundAd
675 } else if (RecordingFlags
== SHORT_ADS_SEQUENCE
) {
676 return GetShortAdFromAds (
680 (UDF_SHORT_ALLOCATION_DESCRIPTOR
**)FoundAd
684 return EFI_DEVICE_ERROR
;
688 // Return logical sector number of either Short or Long Allocation Descriptor.
691 GetAllocationDescriptorLsn (
692 IN UDF_FE_RECORDING_FLAGS RecordingFlags
,
693 IN UDF_VOLUME_INFO
*Volume
,
694 IN UDF_LONG_ALLOCATION_DESCRIPTOR
*ParentIcb
,
698 if (RecordingFlags
== LONG_ADS_SEQUENCE
) {
699 return GetLongAdLsn (Volume
, (UDF_LONG_ALLOCATION_DESCRIPTOR
*)Ad
);
700 } else if (RecordingFlags
== SHORT_ADS_SEQUENCE
) {
701 return GetShortAdLsn (
702 GetPdFromLongAd (Volume
, ParentIcb
),
703 (UDF_SHORT_ALLOCATION_DESCRIPTOR
*)Ad
711 // Return offset + length of a given indirect Allocation Descriptor (AED).
715 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
716 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
717 IN UDF_VOLUME_INFO
*Volume
,
718 IN UDF_LONG_ALLOCATION_DESCRIPTOR
*ParentIcb
,
719 IN UDF_FE_RECORDING_FLAGS RecordingFlags
,
729 UINT32 LogicalBlockSize
;
730 UDF_ALLOCATION_EXTENT_DESCRIPTOR
*AllocExtDesc
;
732 ExtentLength
= GET_EXTENT_LENGTH (RecordingFlags
, Ad
);
733 Lsn
= GetAllocationDescriptorLsn (RecordingFlags
,
738 Data
= AllocatePool (ExtentLength
);
740 return EFI_OUT_OF_RESOURCES
;
743 LogicalBlockSize
= LV_BLOCK_SIZE (Volume
, UDF_DEFAULT_LV_NUM
);
748 Status
= DiskIo
->ReadDisk (
750 BlockIo
->Media
->MediaId
,
751 MultU64x32 (Lsn
, LogicalBlockSize
),
755 if (EFI_ERROR (Status
)) {
760 // Check if read extent contains a valid tag identifier for AED.
762 AllocExtDesc
= (UDF_ALLOCATION_EXTENT_DESCRIPTOR
*)Data
;
763 if (!IS_AED (AllocExtDesc
)) {
764 Status
= EFI_VOLUME_CORRUPTED
;
769 // Get AED's block offset and its length.
771 *Offset
= MultU64x32 (Lsn
, LogicalBlockSize
) +
772 sizeof (UDF_ALLOCATION_EXTENT_DESCRIPTOR
);
773 *Length
= AllocExtDesc
->LengthOfAllocationDescriptors
;
782 // Read Allocation Extent Descriptor into memory.
786 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
787 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
788 IN UDF_VOLUME_INFO
*Volume
,
789 IN UDF_LONG_ALLOCATION_DESCRIPTOR
*ParentIcb
,
790 IN UDF_FE_RECORDING_FLAGS RecordingFlags
,
800 // Get AED's offset + length.
802 Status
= GetAedAdsOffset (
812 if (EFI_ERROR (Status
)) {
817 // Allocate buffer to read in AED's data.
819 *Data
= AllocatePool ((UINTN
) (*Length
));
821 return EFI_OUT_OF_RESOURCES
;
824 return DiskIo
->ReadDisk (
826 BlockIo
->Media
->MediaId
,
834 // Function used to serialise reads of Allocation Descriptors.
837 GrowUpBufferToNextAd (
838 IN UDF_FE_RECORDING_FLAGS RecordingFlags
,
840 IN OUT VOID
**Buffer
,
846 ExtentLength
= GET_EXTENT_LENGTH (RecordingFlags
, Ad
);
848 if (*Buffer
== NULL
) {
849 *Buffer
= AllocatePool (ExtentLength
);
850 if (*Buffer
== NULL
) {
851 return EFI_OUT_OF_RESOURCES
;
854 *Buffer
= ReallocatePool ((UINTN
) Length
, (UINTN
) (Length
+ ExtentLength
), *Buffer
);
855 if (*Buffer
== NULL
) {
856 return EFI_OUT_OF_RESOURCES
;
864 // Read data or size of either a File Entry or an Extended File Entry.
868 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
869 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
870 IN UDF_VOLUME_INFO
*Volume
,
871 IN UDF_LONG_ALLOCATION_DESCRIPTOR
*ParentIcb
,
872 IN VOID
*FileEntryData
,
873 IN OUT UDF_READ_FILE_INFO
*ReadFileInfo
877 UINT32 LogicalBlockSize
;
889 BOOLEAN FinishedSeeking
;
891 UDF_FE_RECORDING_FLAGS RecordingFlags
;
893 LogicalBlockSize
= LV_BLOCK_SIZE (Volume
, UDF_DEFAULT_LV_NUM
);
896 switch (ReadFileInfo
->Flags
) {
897 case READ_FILE_GET_FILESIZE
:
898 case READ_FILE_ALLOCATE_AND_READ
:
900 // Initialise ReadFileInfo structure for either getting file size, or
901 // reading file's recorded data.
903 ReadFileInfo
->ReadLength
= 0;
904 ReadFileInfo
->FileData
= NULL
;
906 case READ_FILE_SEEK_AND_READ
:
908 // About to seek a file and/or read its data.
910 Length
= ReadFileInfo
->FileSize
- ReadFileInfo
->FilePosition
;
911 if (ReadFileInfo
->FileDataSize
> Length
) {
913 // About to read beyond the EOF -- truncate it.
915 ReadFileInfo
->FileDataSize
= Length
;
919 // Initialise data to start seeking and/or reading a file.
921 BytesLeft
= ReadFileInfo
->FileDataSize
;
924 FinishedSeeking
= FALSE
;
929 RecordingFlags
= GET_FE_RECORDING_FLAGS (FileEntryData
);
930 switch (RecordingFlags
) {
933 // There are no extents for this FE/EFE. All data is inline.
935 GetFileEntryData (FileEntryData
, &Data
, &Length
);
937 if (ReadFileInfo
->Flags
== READ_FILE_GET_FILESIZE
) {
938 ReadFileInfo
->ReadLength
= Length
;
939 } else if (ReadFileInfo
->Flags
== READ_FILE_ALLOCATE_AND_READ
) {
941 // Allocate buffer for starting read data.
943 ReadFileInfo
->FileData
= AllocatePool ((UINTN
) Length
);
944 if (ReadFileInfo
->FileData
== NULL
) {
945 return EFI_OUT_OF_RESOURCES
;
949 // Read all inline data into ReadFileInfo->FileData
951 CopyMem (ReadFileInfo
->FileData
, Data
, (UINTN
) Length
);
952 ReadFileInfo
->ReadLength
= Length
;
953 } else if (ReadFileInfo
->Flags
== READ_FILE_SEEK_AND_READ
) {
955 // If FilePosition is non-zero, seek file to FilePosition, read
956 // FileDataSize bytes and then updates FilePosition.
959 ReadFileInfo
->FileData
,
960 (VOID
*)((UINT8
*)Data
+ ReadFileInfo
->FilePosition
),
961 (UINTN
) ReadFileInfo
->FileDataSize
964 ReadFileInfo
->FilePosition
+= ReadFileInfo
->FileDataSize
;
968 case LONG_ADS_SEQUENCE
:
969 case SHORT_ADS_SEQUENCE
:
971 // This FE/EFE contains a run of Allocation Descriptors. Get data + size
972 // for start reading them out.
974 GetAdsInformation (FileEntryData
, &Data
, &Length
);
981 Status
= GetAllocationDescriptor (
988 if (Status
== EFI_DEVICE_ERROR
) {
989 Status
= EFI_SUCCESS
;
994 // Check if AD is an indirect AD. If so, read Allocation Extent
995 // Descriptor and its extents (ADs).
997 if (GET_EXTENT_FLAGS (RecordingFlags
, Ad
) == EXTENT_IS_NEXT_EXTENT
) {
1004 Status
= GetAedAdsData (
1014 if (EFI_ERROR (Status
)) {
1022 ExtentLength
= GET_EXTENT_LENGTH (RecordingFlags
, Ad
);
1024 Lsn
= GetAllocationDescriptorLsn (RecordingFlags
,
1029 switch (ReadFileInfo
->Flags
) {
1030 case READ_FILE_GET_FILESIZE
:
1031 ReadFileInfo
->ReadLength
+= ExtentLength
;
1033 case READ_FILE_ALLOCATE_AND_READ
:
1035 // Increase FileData (if necessary) to read next extent.
1037 Status
= GrowUpBufferToNextAd (
1040 &ReadFileInfo
->FileData
,
1041 ReadFileInfo
->ReadLength
1043 if (EFI_ERROR (Status
)) {
1044 goto Error_Alloc_Buffer_To_Next_Ad
;
1048 // Read extent's data into FileData.
1050 Status
= DiskIo
->ReadDisk (
1052 BlockIo
->Media
->MediaId
,
1053 MultU64x32 (Lsn
, LogicalBlockSize
),
1055 (VOID
*)((UINT8
*)ReadFileInfo
->FileData
+
1056 ReadFileInfo
->ReadLength
)
1058 if (EFI_ERROR (Status
)) {
1059 goto Error_Read_Disk_Blk
;
1062 ReadFileInfo
->ReadLength
+= ExtentLength
;
1064 case READ_FILE_SEEK_AND_READ
:
1066 // Seek file first before reading in its data.
1068 if (FinishedSeeking
) {
1070 goto Skip_File_Seek
;
1073 if (FilePosition
+ ExtentLength
< ReadFileInfo
->FilePosition
) {
1074 FilePosition
+= ExtentLength
;
1078 if (FilePosition
+ ExtentLength
> ReadFileInfo
->FilePosition
) {
1079 Offset
= ReadFileInfo
->FilePosition
- FilePosition
;
1088 // Done with seeking file. Start reading its data.
1090 FinishedSeeking
= TRUE
;
1094 // Make sure we don't read more data than really wanted.
1096 if (ExtentLength
- Offset
> BytesLeft
) {
1097 DataLength
= BytesLeft
;
1099 DataLength
= ExtentLength
- Offset
;
1103 // Read extent's data into FileData.
1105 Status
= DiskIo
->ReadDisk (
1107 BlockIo
->Media
->MediaId
,
1108 Offset
+ MultU64x32 (Lsn
, LogicalBlockSize
),
1110 (VOID
*)((UINT8
*)ReadFileInfo
->FileData
+
1113 if (EFI_ERROR (Status
)) {
1114 goto Error_Read_Disk_Blk
;
1118 // Update current file's position.
1120 DataOffset
+= DataLength
;
1121 ReadFileInfo
->FilePosition
+= DataLength
;
1123 BytesLeft
-= DataLength
;
1124 if (BytesLeft
== 0) {
1126 // There is no more file data to read.
1128 Status
= EFI_SUCCESS
;
1137 // Point to the next AD (extent).
1139 AdOffset
+= AD_LENGTH (RecordingFlags
);
1143 case EXTENDED_ADS_SEQUENCE
:
1144 // FIXME: Not supported. Got no volume with it, yet.
1146 Status
= EFI_UNSUPPORTED
;
1157 Error_Read_Disk_Blk
:
1158 Error_Alloc_Buffer_To_Next_Ad
:
1159 if (ReadFileInfo
->Flags
!= READ_FILE_SEEK_AND_READ
) {
1160 FreePool (ReadFileInfo
->FileData
);
1172 // Find a file by its filename from a given Parent file.
1176 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
1177 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
1178 IN UDF_VOLUME_INFO
*Volume
,
1179 IN CHAR16
*FileName
,
1180 IN UDF_FILE_INFO
*Parent
,
1181 IN UDF_LONG_ALLOCATION_DESCRIPTOR
*Icb
,
1182 OUT UDF_FILE_INFO
*File
1186 UDF_FILE_IDENTIFIER_DESCRIPTOR
*FileIdentifierDesc
;
1187 UDF_READ_DIRECTORY_INFO ReadDirInfo
;
1189 CHAR16 FoundFileName
[UDF_FILENAME_LENGTH
];
1190 VOID
*CompareFileEntry
;
1193 // Check if parent file is really directory.
1195 if (!IS_FE_DIRECTORY (Parent
->FileEntry
)) {
1196 return EFI_NOT_FOUND
;
1200 // If FileName is current file or working directory, just duplicate Parent's
1201 // FE/EFE and FID descriptors.
1203 if (StrCmp (FileName
, L
".") == 0) {
1204 DuplicateFe (BlockIo
, Volume
, Parent
->FileEntry
, &File
->FileEntry
);
1205 DuplicateFid (Parent
->FileIdentifierDesc
, &File
->FileIdentifierDesc
);
1211 // Start directory listing.
1213 ZeroMem ((VOID
*)&ReadDirInfo
, sizeof (UDF_READ_DIRECTORY_INFO
));
1217 Status
= ReadDirectoryEntry (
1221 Parent
->FileIdentifierDesc
?
1222 &Parent
->FileIdentifierDesc
->Icb
:
1228 if (EFI_ERROR (Status
)) {
1229 if (Status
== EFI_DEVICE_ERROR
) {
1230 Status
= EFI_NOT_FOUND
;
1236 if (IS_FID_PARENT_FILE (FileIdentifierDesc
)) {
1238 // This FID contains the location (FE/EFE) of the parent directory of this
1239 // directory (Parent), and if FileName is either ".." or "\\", then it's
1240 // the expected FID.
1242 if (StrCmp (FileName
, L
"..") == 0 || StrCmp (FileName
, L
"\\") == 0) {
1247 Status
= GetFileNameFromFid (FileIdentifierDesc
, FoundFileName
);
1248 if (EFI_ERROR (Status
)) {
1252 if (StrCmp (FileName
, FoundFileName
) == 0) {
1254 // FID has been found. Prepare to find its respective FE/EFE.
1261 FreePool ((VOID
*)FileIdentifierDesc
);
1264 if (ReadDirInfo
.DirectoryData
!= NULL
) {
1266 // Free all allocated resources for the directory listing.
1268 FreePool (ReadDirInfo
.DirectoryData
);
1272 Status
= EFI_SUCCESS
;
1274 File
->FileIdentifierDesc
= FileIdentifierDesc
;
1277 // If the requested file is root directory, then the FE/EFE was already
1278 // retrieved in UdfOpenVolume() function, thus no need to find it again.
1280 // Otherwise, find FE/EFE from the respective FID.
1282 if (StrCmp (FileName
, L
"\\") != 0) {
1283 Status
= FindFileEntry (
1287 &FileIdentifierDesc
->Icb
,
1290 if (EFI_ERROR (Status
)) {
1295 // Make sure that both Parent's FE/EFE and found FE/EFE are not equal.
1297 if (CompareMem ((VOID
*)Parent
->FileEntry
, (VOID
*)CompareFileEntry
,
1298 Volume
->FileEntrySize
) != 0) {
1299 File
->FileEntry
= CompareFileEntry
;
1301 FreePool ((VOID
*)FileIdentifierDesc
);
1302 FreePool ((VOID
*)CompareFileEntry
);
1303 Status
= EFI_NOT_FOUND
;
1311 FreePool ((VOID
*)FileIdentifierDesc
);
1317 Read volume information on a medium which contains a valid UDF file system.
1319 @param[in] BlockIo BlockIo interface.
1320 @param[in] DiskIo DiskIo interface.
1321 @param[out] Volume UDF volume information structure.
1323 @retval EFI_SUCCESS Volume information read.
1324 @retval EFI_NO_MEDIA The device has no media.
1325 @retval EFI_DEVICE_ERROR The device reported an error.
1326 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1327 @retval EFI_OUT_OF_RESOURCES The volume was not read due to lack of resources.
1331 ReadUdfVolumeInformation (
1332 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
1333 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
1334 OUT UDF_VOLUME_INFO
*Volume
1339 Status
= ReadVolumeFileStructure (
1344 if (EFI_ERROR (Status
)) {
1348 Status
= GetFileSetDescriptors (
1353 if (EFI_ERROR (Status
)) {
1354 CleanupVolumeInformation (Volume
);
1361 Find the root directory on an UDF volume.
1363 @param[in] BlockIo BlockIo interface.
1364 @param[in] DiskIo DiskIo interface.
1365 @param[in] Volume UDF volume information structure.
1366 @param[out] File Root directory file.
1368 @retval EFI_SUCCESS Root directory found.
1369 @retval EFI_NO_MEDIA The device has no media.
1370 @retval EFI_DEVICE_ERROR The device reported an error.
1371 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1372 @retval EFI_OUT_OF_RESOURCES The root directory was not found due to lack of
1378 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
1379 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
1380 IN UDF_VOLUME_INFO
*Volume
,
1381 OUT UDF_FILE_INFO
*File
1385 UDF_FILE_INFO Parent
;
1387 Status
= FindFileEntry (
1391 &Volume
->FileSetDescs
[0]->RootDirectoryIcb
,
1394 if (EFI_ERROR (Status
)) {
1398 Parent
.FileEntry
= File
->FileEntry
;
1399 Parent
.FileIdentifierDesc
= NULL
;
1408 &Volume
->FileSetDescs
[0]->RootDirectoryIcb
,
1411 if (EFI_ERROR (Status
)) {
1412 FreePool (File
->FileEntry
);
1419 Find either a File Entry or a Extended File Entry from a given ICB.
1421 @param[in] BlockIo BlockIo interface.
1422 @param[in] DiskIo DiskIo interface.
1423 @param[in] Volume UDF volume information structure.
1424 @param[in] Icb ICB of the FID.
1425 @param[out] FileEntry File Entry or Extended File Entry.
1427 @retval EFI_SUCCESS File Entry or Extended File Entry found.
1428 @retval EFI_NO_MEDIA The device has no media.
1429 @retval EFI_DEVICE_ERROR The device reported an error.
1430 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1431 @retval EFI_OUT_OF_RESOURCES The FE/EFE entry was not found due to lack of
1437 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
1438 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
1439 IN UDF_VOLUME_INFO
*Volume
,
1440 IN UDF_LONG_ALLOCATION_DESCRIPTOR
*Icb
,
1441 OUT VOID
**FileEntry
1446 UINT32 LogicalBlockSize
;
1448 Lsn
= GetLongAdLsn (Volume
, Icb
);
1449 LogicalBlockSize
= LV_BLOCK_SIZE (Volume
, UDF_DEFAULT_LV_NUM
);
1451 *FileEntry
= AllocateZeroPool (Volume
->FileEntrySize
);
1452 if (*FileEntry
== NULL
) {
1453 return EFI_OUT_OF_RESOURCES
;
1459 Status
= DiskIo
->ReadDisk (
1461 BlockIo
->Media
->MediaId
,
1462 MultU64x32 (Lsn
, LogicalBlockSize
),
1463 Volume
->FileEntrySize
,
1466 if (EFI_ERROR (Status
)) {
1467 goto Error_Read_Disk_Blk
;
1471 // Check if the read extent contains a valid Tag Identifier for the expected
1474 if (!IS_FE (*FileEntry
) && !IS_EFE (*FileEntry
)) {
1475 Status
= EFI_VOLUME_CORRUPTED
;
1476 goto Error_Invalid_Fe
;
1482 Error_Read_Disk_Blk
:
1483 FreePool (*FileEntry
);
1489 Find a file given its absolute path on an UDF volume.
1491 @param[in] BlockIo BlockIo interface.
1492 @param[in] DiskIo DiskIo interface.
1493 @param[in] Volume UDF volume information structure.
1494 @param[in] FilePath File's absolute path.
1495 @param[in] Root Root directory file.
1496 @param[in] Parent Parent directory file.
1497 @param[out] File Found file.
1499 @retval EFI_SUCCESS @p FilePath was found.
1500 @retval EFI_NO_MEDIA The device has no media.
1501 @retval EFI_DEVICE_ERROR The device reported an error.
1502 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1503 @retval EFI_OUT_OF_RESOURCES The @p FilePath file was not found due to lack of
1509 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
1510 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
1511 IN UDF_VOLUME_INFO
*Volume
,
1512 IN CHAR16
*FilePath
,
1513 IN UDF_FILE_INFO
*Root
,
1514 IN UDF_FILE_INFO
*Parent
,
1515 IN UDF_LONG_ALLOCATION_DESCRIPTOR
*Icb
,
1516 OUT UDF_FILE_INFO
*File
1520 CHAR16 FileName
[UDF_FILENAME_LENGTH
];
1521 CHAR16
*FileNamePointer
;
1522 UDF_FILE_INFO PreviousFile
;
1525 Status
= EFI_NOT_FOUND
;
1527 CopyMem ((VOID
*)&PreviousFile
, (VOID
*)Parent
, sizeof (UDF_FILE_INFO
));
1528 while (*FilePath
!= L
'\0') {
1529 FileNamePointer
= FileName
;
1530 while (*FilePath
!= L
'\0' && *FilePath
!= L
'\\') {
1531 *FileNamePointer
++ = *FilePath
++;
1534 *FileNamePointer
= L
'\0';
1535 if (FileName
[0] == L
'\0') {
1537 // Open root directory.
1541 // There is no file found for the root directory yet. So, find only its
1544 // See UdfOpenVolume() function.
1546 Status
= InternalFindFile (BlockIo
,
1555 // We've already a file pointer (Root) for the root directory. Duplicate
1556 // its FE/EFE and FID descriptors.
1558 DuplicateFe (BlockIo
, Volume
, Root
->FileEntry
, &File
->FileEntry
);
1559 DuplicateFid (Root
->FileIdentifierDesc
, &File
->FileIdentifierDesc
);
1560 Status
= EFI_SUCCESS
;
1564 // No root directory. Find filename from the current directory.
1566 Status
= InternalFindFile (BlockIo
,
1575 if (EFI_ERROR (Status
)) {
1580 // If the found file is a symlink, then find its respective FE/EFE and
1583 if (IS_FE_SYMLINK (File
->FileEntry
)) {
1584 FreePool ((VOID
*)File
->FileIdentifierDesc
);
1586 FileEntry
= File
->FileEntry
;
1588 Status
= ResolveSymlink (BlockIo
,
1595 FreePool (FileEntry
);
1597 if (EFI_ERROR (Status
)) {
1602 if (CompareMem ((VOID
*)&PreviousFile
, (VOID
*)Parent
,
1603 sizeof (UDF_FILE_INFO
)) != 0) {
1604 CleanupFileInformation (&PreviousFile
);
1607 CopyMem ((VOID
*)&PreviousFile
, (VOID
*)File
, sizeof (UDF_FILE_INFO
));
1608 if (*FilePath
!= L
'\0' && *FilePath
== L
'\\') {
1617 Read a directory entry at a time on an UDF volume.
1619 @param[in] BlockIo BlockIo interface.
1620 @param[in] DiskIo DiskIo interface.
1621 @param[in] Volume UDF volume information structure.
1622 @param[in] ParentIcb ICB of the parent file.
1623 @param[in] FileEntryData FE/EFE of the parent file.
1624 @param[in out] ReadDirInfo Next read directory listing structure
1626 @param[out] FoundFid File Identifier Descriptor pointer.
1628 @retval EFI_SUCCESS Directory entry read.
1629 @retval EFI_UNSUPPORTED Extended Allocation Descriptors not supported.
1630 @retval EFI_NO_MEDIA The device has no media.
1631 @retval EFI_DEVICE_ERROR The device reported an error.
1632 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1633 @retval EFI_OUT_OF_RESOURCES The directory entry was not read due to lack of
1638 ReadDirectoryEntry (
1639 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
1640 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
1641 IN UDF_VOLUME_INFO
*Volume
,
1642 IN UDF_LONG_ALLOCATION_DESCRIPTOR
*ParentIcb
,
1643 IN VOID
*FileEntryData
,
1644 IN OUT UDF_READ_DIRECTORY_INFO
*ReadDirInfo
,
1645 OUT UDF_FILE_IDENTIFIER_DESCRIPTOR
**FoundFid
1649 UDF_READ_FILE_INFO ReadFileInfo
;
1650 UDF_FILE_IDENTIFIER_DESCRIPTOR
*FileIdentifierDesc
;
1652 if (ReadDirInfo
->DirectoryData
== NULL
) {
1654 // The directory's recorded data has not been read yet. So let's cache it
1655 // into memory and the next calls won't need to read it again.
1657 ReadFileInfo
.Flags
= READ_FILE_ALLOCATE_AND_READ
;
1667 if (EFI_ERROR (Status
)) {
1672 // Fill in ReadDirInfo structure with the read directory's data information.
1674 ReadDirInfo
->DirectoryData
= ReadFileInfo
.FileData
;
1675 ReadDirInfo
->DirectoryLength
= ReadFileInfo
.ReadLength
;
1679 if (ReadDirInfo
->FidOffset
>= ReadDirInfo
->DirectoryLength
) {
1681 // There are no longer FIDs for this directory. By returning
1682 // EFI_DEVICE_ERROR to the callee will indicate end of directory
1685 return EFI_DEVICE_ERROR
;
1689 // Get FID for this entry.
1691 FileIdentifierDesc
= GET_FID_FROM_ADS (ReadDirInfo
->DirectoryData
,
1692 ReadDirInfo
->FidOffset
);
1694 // Update FidOffset to point to next FID.
1696 ReadDirInfo
->FidOffset
+= GetFidDescriptorLength (FileIdentifierDesc
);
1697 } while (IS_FID_DELETED_FILE (FileIdentifierDesc
));
1699 DuplicateFid (FileIdentifierDesc
, FoundFid
);
1705 Get a filename (encoded in OSTA-compressed format) from a File Identifier
1706 Descriptor on an UDF volume.
1708 @param[in] FileIdentifierDesc File Identifier Descriptor pointer.
1709 @param[out] FileName Decoded filename.
1711 @retval EFI_SUCCESS Filename decoded and read.
1712 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1715 GetFileNameFromFid (
1716 IN UDF_FILE_IDENTIFIER_DESCRIPTOR
*FileIdentifierDesc
,
1717 OUT CHAR16
*FileName
1720 UINT8
*OstaCompressed
;
1721 UINT8 CompressionId
;
1727 (UINT8
*)FileIdentifierDesc
->Data
+
1728 FileIdentifierDesc
->LengthOfImplementationUse
1731 CompressionId
= OstaCompressed
[0];
1732 if (!IS_VALID_COMPRESSION_ID (CompressionId
)) {
1733 return EFI_VOLUME_CORRUPTED
;
1739 Length
= FileIdentifierDesc
->LengthOfFileIdentifier
;
1740 for (Index
= 1; Index
< Length
; Index
++) {
1741 if (CompressionId
== 16) {
1742 *FileName
= OstaCompressed
[Index
++] << 8;
1747 if (Index
< Length
) {
1748 *FileName
|= OstaCompressed
[Index
];
1760 Resolve a symlink file on an UDF volume.
1762 @param[in] BlockIo BlockIo interface.
1763 @param[in] DiskIo DiskIo interface.
1764 @param[in] Volume UDF volume information structure.
1765 @param[in] Parent Parent file.
1766 @param[in] FileEntryData FE/EFE structure pointer.
1767 @param[out] File Resolved file.
1769 @retval EFI_SUCCESS Symlink file resolved.
1770 @retval EFI_UNSUPPORTED Extended Allocation Descriptors not supported.
1771 @retval EFI_NO_MEDIA The device has no media.
1772 @retval EFI_DEVICE_ERROR The device reported an error.
1773 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1774 @retval EFI_OUT_OF_RESOURCES The symlink file was not resolved due to lack of
1780 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
1781 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
1782 IN UDF_VOLUME_INFO
*Volume
,
1783 IN UDF_FILE_INFO
*Parent
,
1784 IN VOID
*FileEntryData
,
1785 OUT UDF_FILE_INFO
*File
1789 UDF_READ_FILE_INFO ReadFileInfo
;
1793 UDF_PATH_COMPONENT
*PathComp
;
1794 UINT8 PathCompLength
;
1795 CHAR16 FileName
[UDF_FILENAME_LENGTH
];
1798 UINT8 CompressionId
;
1799 UDF_FILE_INFO PreviousFile
;
1802 // Symlink files on UDF volumes do not contain so much data other than
1803 // Path Components which resolves to real filenames, so it's OK to read in
1804 // all its data here -- usually the data will be inline with the FE/EFE for
1807 ReadFileInfo
.Flags
= READ_FILE_ALLOCATE_AND_READ
;
1813 &Parent
->FileIdentifierDesc
->Icb
,
1817 if (EFI_ERROR (Status
)) {
1821 Length
= ReadFileInfo
.ReadLength
;
1823 Data
= (UINT8
*)ReadFileInfo
.FileData
;
1824 EndData
= Data
+ Length
;
1826 CopyMem ((VOID
*)&PreviousFile
, (VOID
*)Parent
, sizeof (UDF_FILE_INFO
));
1829 PathComp
= (UDF_PATH_COMPONENT
*)Data
;
1831 PathCompLength
= PathComp
->LengthOfComponentIdentifier
;
1833 switch (PathComp
->ComponentType
) {
1836 // This Path Component specifies the root directory hierarchy subject to
1837 // agreement between the originator and recipient of the medium. Skip it.
1843 // "\\." of the current directory. Read next Path Component.
1845 goto Next_Path_Component
;
1848 // ".." (parent directory). Go to it.
1850 CopyMem ((VOID
*)FileName
, L
"..", 6);
1854 // "." (current file). Duplicate both FE/EFE and FID of this file.
1856 DuplicateFe (BlockIo
, Volume
, PreviousFile
.FileEntry
, &File
->FileEntry
);
1857 DuplicateFid (PreviousFile
.FileIdentifierDesc
,
1858 &File
->FileIdentifierDesc
);
1859 goto Next_Path_Component
;
1862 // This Path Component identifies an object, either a file or a
1863 // directory or an alias.
1865 // Decode it from the compressed data in ComponentIdentifier and find
1868 CompressionId
= PathComp
->ComponentIdentifier
[0];
1869 if (!IS_VALID_COMPRESSION_ID (CompressionId
)) {
1870 return EFI_VOLUME_CORRUPTED
;
1874 for (Index
= 1; Index
< PathCompLength
; Index
++) {
1875 if (CompressionId
== 16) {
1876 *C
= *(UINT8
*)((UINT8
*)PathComp
->ComponentIdentifier
+
1883 if (Index
< Length
) {
1884 *C
|= *(UINT8
*)((UINT8
*)PathComp
->ComponentIdentifier
+ Index
);
1895 // Find file from the read filename in symlink's file data.
1897 Status
= InternalFindFile (
1906 if (EFI_ERROR (Status
)) {
1907 goto Error_Find_File
;
1910 Next_Path_Component
:
1911 Data
+= sizeof (UDF_PATH_COMPONENT
) + PathCompLength
;
1912 if (Data
>= EndData
) {
1916 if (CompareMem ((VOID
*)&PreviousFile
, (VOID
*)Parent
,
1917 sizeof (UDF_FILE_INFO
)) != 0) {
1918 CleanupFileInformation (&PreviousFile
);
1921 CopyMem ((VOID
*)&PreviousFile
, (VOID
*)File
, sizeof (UDF_FILE_INFO
));
1925 // Unmap the symlink file.
1927 FreePool (ReadFileInfo
.FileData
);
1932 if (CompareMem ((VOID
*)&PreviousFile
, (VOID
*)Parent
,
1933 sizeof (UDF_FILE_INFO
)) != 0) {
1934 CleanupFileInformation (&PreviousFile
);
1937 FreePool (ReadFileInfo
.FileData
);
1943 Clean up in-memory UDF volume information.
1945 @param[in] Volume Volume information pointer.
1949 CleanupVolumeInformation (
1950 IN UDF_VOLUME_INFO
*Volume
1955 if (Volume
->LogicalVolDescs
!= NULL
) {
1956 for (Index
= 0; Index
< Volume
->LogicalVolDescsNo
; Index
++) {
1957 FreePool ((VOID
*)Volume
->LogicalVolDescs
[Index
]);
1959 FreePool ((VOID
*)Volume
->LogicalVolDescs
);
1962 if (Volume
->PartitionDescs
!= NULL
) {
1963 for (Index
= 0; Index
< Volume
->PartitionDescsNo
; Index
++) {
1964 FreePool ((VOID
*)Volume
->PartitionDescs
[Index
]);
1966 FreePool ((VOID
*)Volume
->PartitionDescs
);
1969 if (Volume
->FileSetDescs
!= NULL
) {
1970 for (Index
= 0; Index
< Volume
->FileSetDescsNo
; Index
++) {
1971 FreePool ((VOID
*)Volume
->FileSetDescs
[Index
]);
1973 FreePool ((VOID
*)Volume
->FileSetDescs
);
1976 ZeroMem ((VOID
*)Volume
, sizeof (UDF_VOLUME_INFO
));
1980 Clean up in-memory UDF file information.
1982 @param[in] File File information pointer.
1986 CleanupFileInformation (
1987 IN UDF_FILE_INFO
*File
1990 if (File
->FileEntry
!= NULL
) {
1991 FreePool (File
->FileEntry
);
1993 if (File
->FileIdentifierDesc
!= NULL
) {
1994 FreePool ((VOID
*)File
->FileIdentifierDesc
);
1997 ZeroMem ((VOID
*)File
, sizeof (UDF_FILE_INFO
));
2001 Find a file from its absolute path on an UDF volume.
2003 @param[in] BlockIo BlockIo interface.
2004 @param[in] DiskIo DiskIo interface.
2005 @param[in] Volume UDF volume information structure.
2006 @param[in] File File information structure.
2007 @param[out] Size Size of the file.
2009 @retval EFI_SUCCESS File size calculated and set in @p Size.
2010 @retval EFI_UNSUPPORTED Extended Allocation Descriptors not supported.
2011 @retval EFI_NO_MEDIA The device has no media.
2012 @retval EFI_DEVICE_ERROR The device reported an error.
2013 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
2014 @retval EFI_OUT_OF_RESOURCES The file size was not calculated due to lack of
2020 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
2021 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
2022 IN UDF_VOLUME_INFO
*Volume
,
2023 IN UDF_FILE_INFO
*File
,
2028 UDF_READ_FILE_INFO ReadFileInfo
;
2030 ReadFileInfo
.Flags
= READ_FILE_GET_FILESIZE
;
2036 &File
->FileIdentifierDesc
->Icb
,
2040 if (EFI_ERROR (Status
)) {
2044 *Size
= ReadFileInfo
.ReadLength
;
2050 Set information about a file on an UDF volume.
2052 @param[in] File File pointer.
2053 @param[in] FileSize Size of the file.
2054 @param[in] FileName Filename of the file.
2055 @param[in out] BufferSize Size of the returned file infomation.
2056 @param[out] Buffer Data of the returned file information.
2058 @retval EFI_SUCCESS File information set.
2059 @retval EFI_NO_MEDIA The device has no media.
2060 @retval EFI_DEVICE_ERROR The device reported an error.
2061 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
2062 @retval EFI_OUT_OF_RESOURCES The file information was not set due to lack of
2068 IN UDF_FILE_INFO
*File
,
2070 IN CHAR16
*FileName
,
2071 IN OUT UINTN
*BufferSize
,
2075 UINTN FileInfoLength
;
2076 EFI_FILE_INFO
*FileInfo
;
2077 UDF_FILE_ENTRY
*FileEntry
;
2078 UDF_EXTENDED_FILE_ENTRY
*ExtendedFileEntry
;
2081 // Calculate the needed size for the EFI_FILE_INFO structure.
2083 FileInfoLength
= sizeof (EFI_FILE_INFO
) + (FileName
?
2084 StrSize (FileName
) :
2086 if (*BufferSize
< FileInfoLength
) {
2088 // The given Buffer has no size enough for EFI_FILE_INFO structure.
2090 *BufferSize
= FileInfoLength
;
2091 return EFI_BUFFER_TOO_SMALL
;
2095 // Buffer now contains room enough to store EFI_FILE_INFO structure.
2096 // Now, fill it in with all necessary information about the file.
2098 FileInfo
= (EFI_FILE_INFO
*)Buffer
;
2099 FileInfo
->Size
= FileInfoLength
;
2100 FileInfo
->Attribute
&= ~EFI_FILE_VALID_ATTR
;
2101 FileInfo
->Attribute
|= EFI_FILE_READ_ONLY
;
2103 if (IS_FID_DIRECTORY_FILE (File
->FileIdentifierDesc
)) {
2104 FileInfo
->Attribute
|= EFI_FILE_DIRECTORY
;
2105 } else if (IS_FID_NORMAL_FILE (File
->FileIdentifierDesc
)) {
2106 FileInfo
->Attribute
|= EFI_FILE_ARCHIVE
;
2109 if (IS_FID_HIDDEN_FILE (File
->FileIdentifierDesc
)) {
2110 FileInfo
->Attribute
|= EFI_FILE_HIDDEN
;
2113 if (IS_FE (File
->FileEntry
)) {
2114 FileEntry
= (UDF_FILE_ENTRY
*)File
->FileEntry
;
2117 // Check if FE has the system attribute set.
2119 if (FileEntry
->IcbTag
.Flags
& (1 << 10)) {
2120 FileInfo
->Attribute
|= EFI_FILE_SYSTEM
;
2123 FileInfo
->FileSize
= FileSize
;
2124 FileInfo
->PhysicalSize
= FileSize
;
2126 FileInfo
->CreateTime
.Year
= FileEntry
->AccessTime
.Year
;
2127 FileInfo
->CreateTime
.Month
= FileEntry
->AccessTime
.Month
;
2128 FileInfo
->CreateTime
.Day
= FileEntry
->AccessTime
.Day
;
2129 FileInfo
->CreateTime
.Hour
= FileEntry
->AccessTime
.Hour
;
2130 FileInfo
->CreateTime
.Minute
= FileEntry
->AccessTime
.Second
;
2131 FileInfo
->CreateTime
.Second
= FileEntry
->AccessTime
.Second
;
2132 FileInfo
->CreateTime
.Nanosecond
=
2133 FileEntry
->AccessTime
.HundredsOfMicroseconds
;
2135 FileInfo
->LastAccessTime
.Year
=
2136 FileEntry
->AccessTime
.Year
;
2137 FileInfo
->LastAccessTime
.Month
=
2138 FileEntry
->AccessTime
.Month
;
2139 FileInfo
->LastAccessTime
.Day
=
2140 FileEntry
->AccessTime
.Day
;
2141 FileInfo
->LastAccessTime
.Hour
=
2142 FileEntry
->AccessTime
.Hour
;
2143 FileInfo
->LastAccessTime
.Minute
=
2144 FileEntry
->AccessTime
.Minute
;
2145 FileInfo
->LastAccessTime
.Second
=
2146 FileEntry
->AccessTime
.Second
;
2147 FileInfo
->LastAccessTime
.Nanosecond
=
2148 FileEntry
->AccessTime
.HundredsOfMicroseconds
;
2149 } else if (IS_EFE (File
->FileEntry
)) {
2150 ExtendedFileEntry
= (UDF_EXTENDED_FILE_ENTRY
*)File
->FileEntry
;
2153 // Check if EFE has the system attribute set.
2155 if (ExtendedFileEntry
->IcbTag
.Flags
& (1 << 10)) {
2156 FileInfo
->Attribute
|= EFI_FILE_SYSTEM
;
2159 FileInfo
->FileSize
= FileSize
;
2160 FileInfo
->PhysicalSize
= FileSize
;
2162 FileInfo
->CreateTime
.Year
= ExtendedFileEntry
->CreationTime
.Year
;
2163 FileInfo
->CreateTime
.Month
= ExtendedFileEntry
->CreationTime
.Month
;
2164 FileInfo
->CreateTime
.Day
= ExtendedFileEntry
->CreationTime
.Day
;
2165 FileInfo
->CreateTime
.Hour
= ExtendedFileEntry
->CreationTime
.Hour
;
2166 FileInfo
->CreateTime
.Minute
= ExtendedFileEntry
->CreationTime
.Second
;
2167 FileInfo
->CreateTime
.Second
= ExtendedFileEntry
->CreationTime
.Second
;
2168 FileInfo
->CreateTime
.Nanosecond
=
2169 ExtendedFileEntry
->AccessTime
.HundredsOfMicroseconds
;
2171 FileInfo
->LastAccessTime
.Year
=
2172 ExtendedFileEntry
->AccessTime
.Year
;
2173 FileInfo
->LastAccessTime
.Month
=
2174 ExtendedFileEntry
->AccessTime
.Month
;
2175 FileInfo
->LastAccessTime
.Day
=
2176 ExtendedFileEntry
->AccessTime
.Day
;
2177 FileInfo
->LastAccessTime
.Hour
=
2178 ExtendedFileEntry
->AccessTime
.Hour
;
2179 FileInfo
->LastAccessTime
.Minute
=
2180 ExtendedFileEntry
->AccessTime
.Minute
;
2181 FileInfo
->LastAccessTime
.Second
=
2182 ExtendedFileEntry
->AccessTime
.Second
;
2183 FileInfo
->LastAccessTime
.Nanosecond
=
2184 ExtendedFileEntry
->AccessTime
.HundredsOfMicroseconds
;
2187 FileInfo
->CreateTime
.TimeZone
= EFI_UNSPECIFIED_TIMEZONE
;
2188 FileInfo
->CreateTime
.Daylight
= EFI_TIME_ADJUST_DAYLIGHT
;
2189 FileInfo
->LastAccessTime
.TimeZone
= EFI_UNSPECIFIED_TIMEZONE
;
2190 FileInfo
->LastAccessTime
.Daylight
= EFI_TIME_ADJUST_DAYLIGHT
;
2192 CopyMem ((VOID
*)&FileInfo
->ModificationTime
,
2193 (VOID
*)&FileInfo
->LastAccessTime
,
2196 if (FileName
!= NULL
) {
2197 StrCpyS (FileInfo
->FileName
, StrLen (FileName
) + 1, FileName
);
2199 FileInfo
->FileName
[0] = '\0';
2202 *BufferSize
= FileInfoLength
;
2208 Get volume and free space size information of an UDF volume.
2210 @param[in] BlockIo BlockIo interface.
2211 @param[in] DiskIo DiskIo interface.
2212 @param[in] Volume UDF volume information structure.
2213 @param[out] VolumeSize Volume size.
2214 @param[out] FreeSpaceSize Free space size.
2216 @retval EFI_SUCCESS Volume and free space size calculated.
2217 @retval EFI_NO_MEDIA The device has no media.
2218 @retval EFI_DEVICE_ERROR The device reported an error.
2219 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
2220 @retval EFI_OUT_OF_RESOURCES The volume and free space size were not
2221 calculated due to lack of resources.
2226 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
2227 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
2228 IN UDF_VOLUME_INFO
*Volume
,
2229 OUT UINT64
*VolumeSize
,
2230 OUT UINT64
*FreeSpaceSize
2233 UDF_EXTENT_AD ExtentAd
;
2234 UINT32 LogicalBlockSize
;
2237 UDF_LOGICAL_VOLUME_INTEGRITY
*LogicalVolInt
;
2245 for (Index
= 0; Index
< Volume
->LogicalVolDescsNo
; Index
++) {
2246 CopyMem ((VOID
*)&ExtentAd
,
2247 (VOID
*)&Volume
->LogicalVolDescs
[Index
]->IntegritySequenceExtent
,
2248 sizeof (UDF_EXTENT_AD
));
2249 if (ExtentAd
.ExtentLength
== 0) {
2253 LogicalBlockSize
= LV_BLOCK_SIZE (Volume
, Index
);
2256 LogicalVolInt
= (UDF_LOGICAL_VOLUME_INTEGRITY
*)
2257 AllocatePool (ExtentAd
.ExtentLength
);
2258 if (LogicalVolInt
== NULL
) {
2259 return EFI_OUT_OF_RESOURCES
;
2262 Lsn
= (UINT64
)ExtentAd
.ExtentLocation
;
2264 Status
= DiskIo
->ReadDisk (
2266 BlockIo
->Media
->MediaId
,
2267 MultU64x32 (Lsn
, LogicalBlockSize
),
2268 ExtentAd
.ExtentLength
,
2269 (VOID
*)LogicalVolInt
2271 if (EFI_ERROR (Status
)) {
2272 FreePool ((VOID
*)LogicalVolInt
);
2276 if (!IS_LVID (LogicalVolInt
)) {
2277 FreePool ((VOID
*)LogicalVolInt
);
2278 return EFI_VOLUME_CORRUPTED
;
2281 Length
= LogicalVolInt
->NumberOfPartitions
;
2282 for (Index
= 0; Index
< Length
; Index
+= sizeof (UINT32
)) {
2283 LsnsNo
= *(UINT32
*)((UINT8
*)LogicalVolInt
->Data
+ Index
);
2284 if (LsnsNo
== 0xFFFFFFFFUL
) {
2286 // Size not specified.
2291 *FreeSpaceSize
+= MultU64x32 ((UINT64
)LsnsNo
, LogicalBlockSize
);
2294 Length
= (LogicalVolInt
->NumberOfPartitions
* sizeof (UINT32
)) << 1;
2295 for (; Index
< Length
; Index
+= sizeof (UINT32
)) {
2296 LsnsNo
= *(UINT32
*)((UINT8
*)LogicalVolInt
->Data
+ Index
);
2297 if (LsnsNo
== 0xFFFFFFFFUL
) {
2299 // Size not specified.
2304 *VolumeSize
+= MultU64x32 ((UINT64
)LsnsNo
, LogicalBlockSize
);
2307 CopyMem ((VOID
*)&ExtentAd
,(VOID
*)&LogicalVolInt
->NextIntegrityExtent
,
2308 sizeof (UDF_EXTENT_AD
));
2309 if (ExtentAd
.ExtentLength
> 0) {
2310 FreePool ((VOID
*)LogicalVolInt
);
2311 goto Read_Next_Sequence
;
2314 FreePool ((VOID
*)LogicalVolInt
);
2321 Seek a file and read its data into memory on an UDF volume.
2323 @param[in] BlockIo BlockIo interface.
2324 @param[in] DiskIo DiskIo interface.
2325 @param[in] Volume UDF volume information structure.
2326 @param[in] File File information structure.
2327 @param[in] FileSize Size of the file.
2328 @param[in out] FilePosition File position.
2329 @param[in out] Buffer File data.
2330 @param[in out] BufferSize Read size.
2332 @retval EFI_SUCCESS File seeked and read.
2333 @retval EFI_UNSUPPORTED Extended Allocation Descriptors not supported.
2334 @retval EFI_NO_MEDIA The device has no media.
2335 @retval EFI_DEVICE_ERROR The device reported an error.
2336 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
2337 @retval EFI_OUT_OF_RESOURCES The file's recorded data was not read due to lack
2343 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
2344 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
2345 IN UDF_VOLUME_INFO
*Volume
,
2346 IN UDF_FILE_INFO
*File
,
2348 IN OUT UINT64
*FilePosition
,
2349 IN OUT VOID
*Buffer
,
2350 IN OUT UINT64
*BufferSize
2354 UDF_READ_FILE_INFO ReadFileInfo
;
2356 ReadFileInfo
.Flags
= READ_FILE_SEEK_AND_READ
;
2357 ReadFileInfo
.FilePosition
= *FilePosition
;
2358 ReadFileInfo
.FileData
= Buffer
;
2359 ReadFileInfo
.FileDataSize
= *BufferSize
;
2360 ReadFileInfo
.FileSize
= FileSize
;
2366 &File
->FileIdentifierDesc
->Icb
,
2370 if (EFI_ERROR (Status
)) {
2374 *BufferSize
= ReadFileInfo
.FileDataSize
;
2375 *FilePosition
= ReadFileInfo
.FilePosition
;
2381 Check if ControllerHandle supports an UDF file system.
2383 @param[in] This Protocol instance pointer.
2384 @param[in] ControllerHandle Handle of device to test.
2386 @retval EFI_SUCCESS UDF file system found.
2387 @retval EFI_UNSUPPORTED UDF file system not found.
2391 SupportUdfFileSystem (
2392 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
2393 IN EFI_HANDLE ControllerHandle
2397 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2398 EFI_DEVICE_PATH_PROTOCOL
*DevicePathNode
;
2399 EFI_DEVICE_PATH_PROTOCOL
*LastDevicePathNode
;
2400 EFI_GUID
*VendorDefinedGuid
;
2401 EFI_GUID UdfDevPathGuid
= EFI_UDF_DEVICE_PATH_GUID
;
2404 // Open Device Path protocol on ControllerHandle
2406 Status
= gBS
->OpenProtocol (
2408 &gEfiDevicePathProtocolGuid
,
2409 (VOID
**)&DevicePath
,
2410 This
->DriverBindingHandle
,
2412 EFI_OPEN_PROTOCOL_GET_PROTOCOL
2414 if (EFI_ERROR (Status
)) {
2415 return EFI_UNSUPPORTED
;
2418 Status
= EFI_UNSUPPORTED
;
2421 // Get last Device Path node
2423 LastDevicePathNode
= NULL
;
2424 DevicePathNode
= DevicePath
;
2425 while (!IsDevicePathEnd (DevicePathNode
)) {
2426 LastDevicePathNode
= DevicePathNode
;
2427 DevicePathNode
= NextDevicePathNode (DevicePathNode
);
2430 // Check if last Device Path node contains a Vendor-Defined Media Device Path
2431 // of an UDF file system.
2433 if (LastDevicePathNode
!= NULL
&&
2434 DevicePathType (LastDevicePathNode
) == MEDIA_DEVICE_PATH
&&
2435 DevicePathSubType (LastDevicePathNode
) == MEDIA_VENDOR_DP
) {
2436 VendorDefinedGuid
= (EFI_GUID
*)((UINTN
)LastDevicePathNode
+
2437 OFFSET_OF (VENDOR_DEVICE_PATH
, Guid
));
2438 if (CompareGuid (VendorDefinedGuid
, &UdfDevPathGuid
)) {
2439 Status
= EFI_SUCCESS
;
2444 // Close Device Path protocol on ControllerHandle
2446 gBS
->CloseProtocol (
2448 &gEfiDevicePathProtocolGuid
,
2449 This
->DriverBindingHandle
,