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
;
967 return EFI_INVALID_PARAMETER
;
970 Status
= EFI_SUCCESS
;
973 case LONG_ADS_SEQUENCE
:
974 case SHORT_ADS_SEQUENCE
:
976 // This FE/EFE contains a run of Allocation Descriptors. Get data + size
977 // for start reading them out.
979 GetAdsInformation (FileEntryData
, &Data
, &Length
);
986 Status
= GetAllocationDescriptor (
993 if (Status
== EFI_DEVICE_ERROR
) {
994 Status
= EFI_SUCCESS
;
999 // Check if AD is an indirect AD. If so, read Allocation Extent
1000 // Descriptor and its extents (ADs).
1002 if (GET_EXTENT_FLAGS (RecordingFlags
, Ad
) == EXTENT_IS_NEXT_EXTENT
) {
1009 Status
= GetAedAdsData (
1019 if (EFI_ERROR (Status
)) {
1027 ExtentLength
= GET_EXTENT_LENGTH (RecordingFlags
, Ad
);
1029 Lsn
= GetAllocationDescriptorLsn (RecordingFlags
,
1034 switch (ReadFileInfo
->Flags
) {
1035 case READ_FILE_GET_FILESIZE
:
1036 ReadFileInfo
->ReadLength
+= ExtentLength
;
1038 case READ_FILE_ALLOCATE_AND_READ
:
1040 // Increase FileData (if necessary) to read next extent.
1042 Status
= GrowUpBufferToNextAd (
1045 &ReadFileInfo
->FileData
,
1046 ReadFileInfo
->ReadLength
1048 if (EFI_ERROR (Status
)) {
1049 goto Error_Alloc_Buffer_To_Next_Ad
;
1053 // Read extent's data into FileData.
1055 Status
= DiskIo
->ReadDisk (
1057 BlockIo
->Media
->MediaId
,
1058 MultU64x32 (Lsn
, LogicalBlockSize
),
1060 (VOID
*)((UINT8
*)ReadFileInfo
->FileData
+
1061 ReadFileInfo
->ReadLength
)
1063 if (EFI_ERROR (Status
)) {
1064 goto Error_Read_Disk_Blk
;
1067 ReadFileInfo
->ReadLength
+= ExtentLength
;
1069 case READ_FILE_SEEK_AND_READ
:
1071 // Seek file first before reading in its data.
1073 if (FinishedSeeking
) {
1075 goto Skip_File_Seek
;
1078 if (FilePosition
+ ExtentLength
< ReadFileInfo
->FilePosition
) {
1079 FilePosition
+= ExtentLength
;
1083 if (FilePosition
+ ExtentLength
> ReadFileInfo
->FilePosition
) {
1084 Offset
= ReadFileInfo
->FilePosition
- FilePosition
;
1090 // Done with seeking file. Start reading its data.
1092 FinishedSeeking
= TRUE
;
1096 // Make sure we don't read more data than really wanted.
1098 if (ExtentLength
- Offset
> BytesLeft
) {
1099 DataLength
= BytesLeft
;
1101 DataLength
= ExtentLength
- Offset
;
1105 // Read extent's data into FileData.
1107 Status
= DiskIo
->ReadDisk (
1109 BlockIo
->Media
->MediaId
,
1110 Offset
+ MultU64x32 (Lsn
, LogicalBlockSize
),
1112 (VOID
*)((UINT8
*)ReadFileInfo
->FileData
+
1115 if (EFI_ERROR (Status
)) {
1116 goto Error_Read_Disk_Blk
;
1120 // Update current file's position.
1122 DataOffset
+= DataLength
;
1123 ReadFileInfo
->FilePosition
+= DataLength
;
1125 BytesLeft
-= DataLength
;
1126 if (BytesLeft
== 0) {
1128 // There is no more file data to read.
1130 Status
= EFI_SUCCESS
;
1139 // Point to the next AD (extent).
1141 AdOffset
+= AD_LENGTH (RecordingFlags
);
1145 case EXTENDED_ADS_SEQUENCE
:
1146 // FIXME: Not supported. Got no volume with it, yet.
1148 Status
= EFI_UNSUPPORTED
;
1153 // A flag value reserved by the ECMA-167 standard (3rd Edition - June
1154 // 1997); 14.6 ICB Tag; 14.6.8 Flags (RBP 18); was found.
1156 Status
= EFI_UNSUPPORTED
;
1167 Error_Read_Disk_Blk
:
1168 Error_Alloc_Buffer_To_Next_Ad
:
1169 if (ReadFileInfo
->Flags
!= READ_FILE_SEEK_AND_READ
) {
1170 FreePool (ReadFileInfo
->FileData
);
1182 // Find a file by its filename from a given Parent file.
1186 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
1187 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
1188 IN UDF_VOLUME_INFO
*Volume
,
1189 IN CHAR16
*FileName
,
1190 IN UDF_FILE_INFO
*Parent
,
1191 IN UDF_LONG_ALLOCATION_DESCRIPTOR
*Icb
,
1192 OUT UDF_FILE_INFO
*File
1196 UDF_FILE_IDENTIFIER_DESCRIPTOR
*FileIdentifierDesc
;
1197 UDF_READ_DIRECTORY_INFO ReadDirInfo
;
1199 CHAR16 FoundFileName
[UDF_FILENAME_LENGTH
];
1200 VOID
*CompareFileEntry
;
1203 // Check if parent file is really directory.
1205 if (!IS_FE_DIRECTORY (Parent
->FileEntry
)) {
1206 return EFI_NOT_FOUND
;
1210 // If FileName is current file or working directory, just duplicate Parent's
1211 // FE/EFE and FID descriptors.
1213 if (StrCmp (FileName
, L
".") == 0) {
1214 DuplicateFe (BlockIo
, Volume
, Parent
->FileEntry
, &File
->FileEntry
);
1215 DuplicateFid (Parent
->FileIdentifierDesc
, &File
->FileIdentifierDesc
);
1221 // Start directory listing.
1223 ZeroMem ((VOID
*)&ReadDirInfo
, sizeof (UDF_READ_DIRECTORY_INFO
));
1227 Status
= ReadDirectoryEntry (
1231 Parent
->FileIdentifierDesc
?
1232 &Parent
->FileIdentifierDesc
->Icb
:
1238 if (EFI_ERROR (Status
)) {
1239 if (Status
== EFI_DEVICE_ERROR
) {
1240 Status
= EFI_NOT_FOUND
;
1246 if (IS_FID_PARENT_FILE (FileIdentifierDesc
)) {
1248 // This FID contains the location (FE/EFE) of the parent directory of this
1249 // directory (Parent), and if FileName is either ".." or "\\", then it's
1250 // the expected FID.
1252 if (StrCmp (FileName
, L
"..") == 0 || StrCmp (FileName
, L
"\\") == 0) {
1257 Status
= GetFileNameFromFid (FileIdentifierDesc
, FoundFileName
);
1258 if (EFI_ERROR (Status
)) {
1262 if (StrCmp (FileName
, FoundFileName
) == 0) {
1264 // FID has been found. Prepare to find its respective FE/EFE.
1271 FreePool ((VOID
*)FileIdentifierDesc
);
1274 if (ReadDirInfo
.DirectoryData
!= NULL
) {
1276 // Free all allocated resources for the directory listing.
1278 FreePool (ReadDirInfo
.DirectoryData
);
1282 Status
= EFI_SUCCESS
;
1284 File
->FileIdentifierDesc
= FileIdentifierDesc
;
1287 // If the requested file is root directory, then the FE/EFE was already
1288 // retrieved in UdfOpenVolume() function, thus no need to find it again.
1290 // Otherwise, find FE/EFE from the respective FID.
1292 if (StrCmp (FileName
, L
"\\") != 0) {
1293 Status
= FindFileEntry (
1297 &FileIdentifierDesc
->Icb
,
1300 if (EFI_ERROR (Status
)) {
1305 // Make sure that both Parent's FE/EFE and found FE/EFE are not equal.
1307 if (CompareMem ((VOID
*)Parent
->FileEntry
, (VOID
*)CompareFileEntry
,
1308 Volume
->FileEntrySize
) != 0) {
1309 File
->FileEntry
= CompareFileEntry
;
1311 FreePool ((VOID
*)FileIdentifierDesc
);
1312 FreePool ((VOID
*)CompareFileEntry
);
1313 Status
= EFI_NOT_FOUND
;
1321 FreePool ((VOID
*)FileIdentifierDesc
);
1327 Read volume information on a medium which contains a valid UDF file system.
1329 @param[in] BlockIo BlockIo interface.
1330 @param[in] DiskIo DiskIo interface.
1331 @param[out] Volume UDF volume information structure.
1333 @retval EFI_SUCCESS Volume information read.
1334 @retval EFI_NO_MEDIA The device has no media.
1335 @retval EFI_DEVICE_ERROR The device reported an error.
1336 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1337 @retval EFI_OUT_OF_RESOURCES The volume was not read due to lack of resources.
1341 ReadUdfVolumeInformation (
1342 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
1343 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
1344 OUT UDF_VOLUME_INFO
*Volume
1349 Status
= ReadVolumeFileStructure (
1354 if (EFI_ERROR (Status
)) {
1358 Status
= GetFileSetDescriptors (
1363 if (EFI_ERROR (Status
)) {
1364 CleanupVolumeInformation (Volume
);
1371 Find the root directory on an UDF volume.
1373 @param[in] BlockIo BlockIo interface.
1374 @param[in] DiskIo DiskIo interface.
1375 @param[in] Volume UDF volume information structure.
1376 @param[out] File Root directory file.
1378 @retval EFI_SUCCESS Root directory found.
1379 @retval EFI_NO_MEDIA The device has no media.
1380 @retval EFI_DEVICE_ERROR The device reported an error.
1381 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1382 @retval EFI_OUT_OF_RESOURCES The root directory was not found due to lack of
1388 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
1389 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
1390 IN UDF_VOLUME_INFO
*Volume
,
1391 OUT UDF_FILE_INFO
*File
1395 UDF_FILE_INFO Parent
;
1397 Status
= FindFileEntry (
1401 &Volume
->FileSetDescs
[0]->RootDirectoryIcb
,
1404 if (EFI_ERROR (Status
)) {
1408 Parent
.FileEntry
= File
->FileEntry
;
1409 Parent
.FileIdentifierDesc
= NULL
;
1418 &Volume
->FileSetDescs
[0]->RootDirectoryIcb
,
1421 if (EFI_ERROR (Status
)) {
1422 FreePool (File
->FileEntry
);
1429 Find either a File Entry or a Extended File Entry from a given ICB.
1431 @param[in] BlockIo BlockIo interface.
1432 @param[in] DiskIo DiskIo interface.
1433 @param[in] Volume UDF volume information structure.
1434 @param[in] Icb ICB of the FID.
1435 @param[out] FileEntry File Entry or Extended File Entry.
1437 @retval EFI_SUCCESS File Entry or Extended File Entry found.
1438 @retval EFI_NO_MEDIA The device has no media.
1439 @retval EFI_DEVICE_ERROR The device reported an error.
1440 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1441 @retval EFI_OUT_OF_RESOURCES The FE/EFE entry was not found due to lack of
1447 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
1448 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
1449 IN UDF_VOLUME_INFO
*Volume
,
1450 IN UDF_LONG_ALLOCATION_DESCRIPTOR
*Icb
,
1451 OUT VOID
**FileEntry
1456 UINT32 LogicalBlockSize
;
1458 Lsn
= GetLongAdLsn (Volume
, Icb
);
1459 LogicalBlockSize
= LV_BLOCK_SIZE (Volume
, UDF_DEFAULT_LV_NUM
);
1461 *FileEntry
= AllocateZeroPool (Volume
->FileEntrySize
);
1462 if (*FileEntry
== NULL
) {
1463 return EFI_OUT_OF_RESOURCES
;
1469 Status
= DiskIo
->ReadDisk (
1471 BlockIo
->Media
->MediaId
,
1472 MultU64x32 (Lsn
, LogicalBlockSize
),
1473 Volume
->FileEntrySize
,
1476 if (EFI_ERROR (Status
)) {
1477 goto Error_Read_Disk_Blk
;
1481 // Check if the read extent contains a valid Tag Identifier for the expected
1484 if (!IS_FE (*FileEntry
) && !IS_EFE (*FileEntry
)) {
1485 Status
= EFI_VOLUME_CORRUPTED
;
1486 goto Error_Invalid_Fe
;
1492 Error_Read_Disk_Blk
:
1493 FreePool (*FileEntry
);
1499 Find a file given its absolute path on an UDF volume.
1501 @param[in] BlockIo BlockIo interface.
1502 @param[in] DiskIo DiskIo interface.
1503 @param[in] Volume UDF volume information structure.
1504 @param[in] FilePath File's absolute path.
1505 @param[in] Root Root directory file.
1506 @param[in] Parent Parent directory file.
1507 @param[out] File Found file.
1509 @retval EFI_SUCCESS @p FilePath was found.
1510 @retval EFI_NO_MEDIA The device has no media.
1511 @retval EFI_DEVICE_ERROR The device reported an error.
1512 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1513 @retval EFI_OUT_OF_RESOURCES The @p FilePath file was not found due to lack of
1519 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
1520 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
1521 IN UDF_VOLUME_INFO
*Volume
,
1522 IN CHAR16
*FilePath
,
1523 IN UDF_FILE_INFO
*Root
,
1524 IN UDF_FILE_INFO
*Parent
,
1525 IN UDF_LONG_ALLOCATION_DESCRIPTOR
*Icb
,
1526 OUT UDF_FILE_INFO
*File
1530 CHAR16 FileName
[UDF_FILENAME_LENGTH
];
1531 CHAR16
*FileNamePointer
;
1532 UDF_FILE_INFO PreviousFile
;
1535 Status
= EFI_NOT_FOUND
;
1537 CopyMem ((VOID
*)&PreviousFile
, (VOID
*)Parent
, sizeof (UDF_FILE_INFO
));
1538 while (*FilePath
!= L
'\0') {
1539 FileNamePointer
= FileName
;
1540 while (*FilePath
!= L
'\0' && *FilePath
!= L
'\\') {
1541 *FileNamePointer
++ = *FilePath
++;
1544 *FileNamePointer
= L
'\0';
1545 if (FileName
[0] == L
'\0') {
1547 // Open root directory.
1551 // There is no file found for the root directory yet. So, find only its
1554 // See UdfOpenVolume() function.
1556 Status
= InternalFindFile (BlockIo
,
1565 // We've already a file pointer (Root) for the root directory. Duplicate
1566 // its FE/EFE and FID descriptors.
1568 DuplicateFe (BlockIo
, Volume
, Root
->FileEntry
, &File
->FileEntry
);
1569 DuplicateFid (Root
->FileIdentifierDesc
, &File
->FileIdentifierDesc
);
1570 Status
= EFI_SUCCESS
;
1574 // No root directory. Find filename from the current directory.
1576 Status
= InternalFindFile (BlockIo
,
1585 if (EFI_ERROR (Status
)) {
1590 // If the found file is a symlink, then find its respective FE/EFE and
1593 if (IS_FE_SYMLINK (File
->FileEntry
)) {
1594 FreePool ((VOID
*)File
->FileIdentifierDesc
);
1596 FileEntry
= File
->FileEntry
;
1598 Status
= ResolveSymlink (BlockIo
,
1605 FreePool (FileEntry
);
1607 if (EFI_ERROR (Status
)) {
1612 if (CompareMem ((VOID
*)&PreviousFile
, (VOID
*)Parent
,
1613 sizeof (UDF_FILE_INFO
)) != 0) {
1614 CleanupFileInformation (&PreviousFile
);
1617 CopyMem ((VOID
*)&PreviousFile
, (VOID
*)File
, sizeof (UDF_FILE_INFO
));
1618 if (*FilePath
!= L
'\0' && *FilePath
== L
'\\') {
1627 Read a directory entry at a time on an UDF volume.
1629 @param[in] BlockIo BlockIo interface.
1630 @param[in] DiskIo DiskIo interface.
1631 @param[in] Volume UDF volume information structure.
1632 @param[in] ParentIcb ICB of the parent file.
1633 @param[in] FileEntryData FE/EFE of the parent file.
1634 @param[in out] ReadDirInfo Next read directory listing structure
1636 @param[out] FoundFid File Identifier Descriptor pointer.
1638 @retval EFI_SUCCESS Directory entry read.
1639 @retval EFI_UNSUPPORTED Extended Allocation Descriptors not supported.
1640 @retval EFI_NO_MEDIA The device has no media.
1641 @retval EFI_DEVICE_ERROR The device reported an error.
1642 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1643 @retval EFI_OUT_OF_RESOURCES The directory entry was not read due to lack of
1648 ReadDirectoryEntry (
1649 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
1650 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
1651 IN UDF_VOLUME_INFO
*Volume
,
1652 IN UDF_LONG_ALLOCATION_DESCRIPTOR
*ParentIcb
,
1653 IN VOID
*FileEntryData
,
1654 IN OUT UDF_READ_DIRECTORY_INFO
*ReadDirInfo
,
1655 OUT UDF_FILE_IDENTIFIER_DESCRIPTOR
**FoundFid
1659 UDF_READ_FILE_INFO ReadFileInfo
;
1660 UDF_FILE_IDENTIFIER_DESCRIPTOR
*FileIdentifierDesc
;
1662 if (ReadDirInfo
->DirectoryData
== NULL
) {
1664 // The directory's recorded data has not been read yet. So let's cache it
1665 // into memory and the next calls won't need to read it again.
1667 ReadFileInfo
.Flags
= READ_FILE_ALLOCATE_AND_READ
;
1677 if (EFI_ERROR (Status
)) {
1682 // Fill in ReadDirInfo structure with the read directory's data information.
1684 ReadDirInfo
->DirectoryData
= ReadFileInfo
.FileData
;
1685 ReadDirInfo
->DirectoryLength
= ReadFileInfo
.ReadLength
;
1689 if (ReadDirInfo
->FidOffset
>= ReadDirInfo
->DirectoryLength
) {
1691 // There are no longer FIDs for this directory. By returning
1692 // EFI_DEVICE_ERROR to the callee will indicate end of directory
1695 return EFI_DEVICE_ERROR
;
1699 // Get FID for this entry.
1701 FileIdentifierDesc
= GET_FID_FROM_ADS (ReadDirInfo
->DirectoryData
,
1702 ReadDirInfo
->FidOffset
);
1704 // Update FidOffset to point to next FID.
1706 ReadDirInfo
->FidOffset
+= GetFidDescriptorLength (FileIdentifierDesc
);
1707 } while (IS_FID_DELETED_FILE (FileIdentifierDesc
));
1709 DuplicateFid (FileIdentifierDesc
, FoundFid
);
1715 Get a filename (encoded in OSTA-compressed format) from a File Identifier
1716 Descriptor on an UDF volume.
1718 @param[in] FileIdentifierDesc File Identifier Descriptor pointer.
1719 @param[out] FileName Decoded filename.
1721 @retval EFI_SUCCESS Filename decoded and read.
1722 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1725 GetFileNameFromFid (
1726 IN UDF_FILE_IDENTIFIER_DESCRIPTOR
*FileIdentifierDesc
,
1727 OUT CHAR16
*FileName
1730 UINT8
*OstaCompressed
;
1731 UINT8 CompressionId
;
1737 (UINT8
*)FileIdentifierDesc
->Data
+
1738 FileIdentifierDesc
->LengthOfImplementationUse
1741 CompressionId
= OstaCompressed
[0];
1742 if (!IS_VALID_COMPRESSION_ID (CompressionId
)) {
1743 return EFI_VOLUME_CORRUPTED
;
1749 Length
= FileIdentifierDesc
->LengthOfFileIdentifier
;
1750 for (Index
= 1; Index
< Length
; Index
++) {
1751 if (CompressionId
== 16) {
1752 *FileName
= OstaCompressed
[Index
++] << 8;
1757 if (Index
< Length
) {
1758 *FileName
|= OstaCompressed
[Index
];
1770 Resolve a symlink file on an UDF volume.
1772 @param[in] BlockIo BlockIo interface.
1773 @param[in] DiskIo DiskIo interface.
1774 @param[in] Volume UDF volume information structure.
1775 @param[in] Parent Parent file.
1776 @param[in] FileEntryData FE/EFE structure pointer.
1777 @param[out] File Resolved file.
1779 @retval EFI_SUCCESS Symlink file resolved.
1780 @retval EFI_UNSUPPORTED Extended Allocation Descriptors not supported.
1781 @retval EFI_NO_MEDIA The device has no media.
1782 @retval EFI_DEVICE_ERROR The device reported an error.
1783 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1784 @retval EFI_OUT_OF_RESOURCES The symlink file was not resolved due to lack of
1790 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
1791 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
1792 IN UDF_VOLUME_INFO
*Volume
,
1793 IN UDF_FILE_INFO
*Parent
,
1794 IN VOID
*FileEntryData
,
1795 OUT UDF_FILE_INFO
*File
1799 UDF_READ_FILE_INFO ReadFileInfo
;
1803 UDF_PATH_COMPONENT
*PathComp
;
1804 UINT8 PathCompLength
;
1805 CHAR16 FileName
[UDF_FILENAME_LENGTH
];
1808 UINT8 CompressionId
;
1809 UDF_FILE_INFO PreviousFile
;
1812 // Symlink files on UDF volumes do not contain so much data other than
1813 // Path Components which resolves to real filenames, so it's OK to read in
1814 // all its data here -- usually the data will be inline with the FE/EFE for
1817 ReadFileInfo
.Flags
= READ_FILE_ALLOCATE_AND_READ
;
1823 &Parent
->FileIdentifierDesc
->Icb
,
1827 if (EFI_ERROR (Status
)) {
1831 Length
= ReadFileInfo
.ReadLength
;
1833 Data
= (UINT8
*)ReadFileInfo
.FileData
;
1834 EndData
= Data
+ Length
;
1836 CopyMem ((VOID
*)&PreviousFile
, (VOID
*)Parent
, sizeof (UDF_FILE_INFO
));
1839 PathComp
= (UDF_PATH_COMPONENT
*)Data
;
1841 PathCompLength
= PathComp
->LengthOfComponentIdentifier
;
1843 switch (PathComp
->ComponentType
) {
1846 // This Path Component specifies the root directory hierarchy subject to
1847 // agreement between the originator and recipient of the medium. Skip it.
1853 // "\\." of the current directory. Read next Path Component.
1855 goto Next_Path_Component
;
1858 // ".." (parent directory). Go to it.
1860 CopyMem ((VOID
*)FileName
, L
"..", 6);
1864 // "." (current file). Duplicate both FE/EFE and FID of this file.
1866 DuplicateFe (BlockIo
, Volume
, PreviousFile
.FileEntry
, &File
->FileEntry
);
1867 DuplicateFid (PreviousFile
.FileIdentifierDesc
,
1868 &File
->FileIdentifierDesc
);
1869 goto Next_Path_Component
;
1872 // This Path Component identifies an object, either a file or a
1873 // directory or an alias.
1875 // Decode it from the compressed data in ComponentIdentifier and find
1878 CompressionId
= PathComp
->ComponentIdentifier
[0];
1879 if (!IS_VALID_COMPRESSION_ID (CompressionId
)) {
1880 return EFI_VOLUME_CORRUPTED
;
1884 for (Index
= 1; Index
< PathCompLength
; Index
++) {
1885 if (CompressionId
== 16) {
1886 *C
= *(UINT8
*)((UINT8
*)PathComp
->ComponentIdentifier
+
1893 if (Index
< Length
) {
1894 *C
|= *(UINT8
*)((UINT8
*)PathComp
->ComponentIdentifier
+ Index
);
1905 // Find file from the read filename in symlink's file data.
1907 Status
= InternalFindFile (
1916 if (EFI_ERROR (Status
)) {
1917 goto Error_Find_File
;
1920 Next_Path_Component
:
1921 Data
+= sizeof (UDF_PATH_COMPONENT
) + PathCompLength
;
1922 if (Data
>= EndData
) {
1926 if (CompareMem ((VOID
*)&PreviousFile
, (VOID
*)Parent
,
1927 sizeof (UDF_FILE_INFO
)) != 0) {
1928 CleanupFileInformation (&PreviousFile
);
1931 CopyMem ((VOID
*)&PreviousFile
, (VOID
*)File
, sizeof (UDF_FILE_INFO
));
1935 // Unmap the symlink file.
1937 FreePool (ReadFileInfo
.FileData
);
1942 if (CompareMem ((VOID
*)&PreviousFile
, (VOID
*)Parent
,
1943 sizeof (UDF_FILE_INFO
)) != 0) {
1944 CleanupFileInformation (&PreviousFile
);
1947 FreePool (ReadFileInfo
.FileData
);
1953 Clean up in-memory UDF volume information.
1955 @param[in] Volume Volume information pointer.
1959 CleanupVolumeInformation (
1960 IN UDF_VOLUME_INFO
*Volume
1965 if (Volume
->LogicalVolDescs
!= NULL
) {
1966 for (Index
= 0; Index
< Volume
->LogicalVolDescsNo
; Index
++) {
1967 FreePool ((VOID
*)Volume
->LogicalVolDescs
[Index
]);
1969 FreePool ((VOID
*)Volume
->LogicalVolDescs
);
1972 if (Volume
->PartitionDescs
!= NULL
) {
1973 for (Index
= 0; Index
< Volume
->PartitionDescsNo
; Index
++) {
1974 FreePool ((VOID
*)Volume
->PartitionDescs
[Index
]);
1976 FreePool ((VOID
*)Volume
->PartitionDescs
);
1979 if (Volume
->FileSetDescs
!= NULL
) {
1980 for (Index
= 0; Index
< Volume
->FileSetDescsNo
; Index
++) {
1981 FreePool ((VOID
*)Volume
->FileSetDescs
[Index
]);
1983 FreePool ((VOID
*)Volume
->FileSetDescs
);
1986 ZeroMem ((VOID
*)Volume
, sizeof (UDF_VOLUME_INFO
));
1990 Clean up in-memory UDF file information.
1992 @param[in] File File information pointer.
1996 CleanupFileInformation (
1997 IN UDF_FILE_INFO
*File
2000 if (File
->FileEntry
!= NULL
) {
2001 FreePool (File
->FileEntry
);
2003 if (File
->FileIdentifierDesc
!= NULL
) {
2004 FreePool ((VOID
*)File
->FileIdentifierDesc
);
2007 ZeroMem ((VOID
*)File
, sizeof (UDF_FILE_INFO
));
2011 Find a file from its absolute path on an UDF volume.
2013 @param[in] BlockIo BlockIo interface.
2014 @param[in] DiskIo DiskIo interface.
2015 @param[in] Volume UDF volume information structure.
2016 @param[in] File File information structure.
2017 @param[out] Size Size of the file.
2019 @retval EFI_SUCCESS File size calculated and set in @p Size.
2020 @retval EFI_UNSUPPORTED Extended Allocation Descriptors not supported.
2021 @retval EFI_NO_MEDIA The device has no media.
2022 @retval EFI_DEVICE_ERROR The device reported an error.
2023 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
2024 @retval EFI_OUT_OF_RESOURCES The file size was not calculated due to lack of
2030 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
2031 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
2032 IN UDF_VOLUME_INFO
*Volume
,
2033 IN UDF_FILE_INFO
*File
,
2038 UDF_READ_FILE_INFO ReadFileInfo
;
2040 ReadFileInfo
.Flags
= READ_FILE_GET_FILESIZE
;
2046 &File
->FileIdentifierDesc
->Icb
,
2050 if (EFI_ERROR (Status
)) {
2054 *Size
= ReadFileInfo
.ReadLength
;
2060 Set information about a file on an UDF volume.
2062 @param[in] File File pointer.
2063 @param[in] FileSize Size of the file.
2064 @param[in] FileName Filename of the file.
2065 @param[in out] BufferSize Size of the returned file infomation.
2066 @param[out] Buffer Data of the returned file information.
2068 @retval EFI_SUCCESS File information set.
2069 @retval EFI_NO_MEDIA The device has no media.
2070 @retval EFI_DEVICE_ERROR The device reported an error.
2071 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
2072 @retval EFI_OUT_OF_RESOURCES The file information was not set due to lack of
2078 IN UDF_FILE_INFO
*File
,
2080 IN CHAR16
*FileName
,
2081 IN OUT UINTN
*BufferSize
,
2085 UINTN FileInfoLength
;
2086 EFI_FILE_INFO
*FileInfo
;
2087 UDF_FILE_ENTRY
*FileEntry
;
2088 UDF_EXTENDED_FILE_ENTRY
*ExtendedFileEntry
;
2091 // Calculate the needed size for the EFI_FILE_INFO structure.
2093 FileInfoLength
= sizeof (EFI_FILE_INFO
) + (FileName
?
2094 StrSize (FileName
) :
2096 if (*BufferSize
< FileInfoLength
) {
2098 // The given Buffer has no size enough for EFI_FILE_INFO structure.
2100 *BufferSize
= FileInfoLength
;
2101 return EFI_BUFFER_TOO_SMALL
;
2105 // Buffer now contains room enough to store EFI_FILE_INFO structure.
2106 // Now, fill it in with all necessary information about the file.
2108 FileInfo
= (EFI_FILE_INFO
*)Buffer
;
2109 FileInfo
->Size
= FileInfoLength
;
2110 FileInfo
->Attribute
&= ~EFI_FILE_VALID_ATTR
;
2111 FileInfo
->Attribute
|= EFI_FILE_READ_ONLY
;
2113 if (IS_FID_DIRECTORY_FILE (File
->FileIdentifierDesc
)) {
2114 FileInfo
->Attribute
|= EFI_FILE_DIRECTORY
;
2115 } else if (IS_FID_NORMAL_FILE (File
->FileIdentifierDesc
)) {
2116 FileInfo
->Attribute
|= EFI_FILE_ARCHIVE
;
2119 if (IS_FID_HIDDEN_FILE (File
->FileIdentifierDesc
)) {
2120 FileInfo
->Attribute
|= EFI_FILE_HIDDEN
;
2123 if (IS_FE (File
->FileEntry
)) {
2124 FileEntry
= (UDF_FILE_ENTRY
*)File
->FileEntry
;
2127 // Check if FE has the system attribute set.
2129 if (FileEntry
->IcbTag
.Flags
& (1 << 10)) {
2130 FileInfo
->Attribute
|= EFI_FILE_SYSTEM
;
2133 FileInfo
->FileSize
= FileSize
;
2134 FileInfo
->PhysicalSize
= FileSize
;
2136 FileInfo
->CreateTime
.Year
= FileEntry
->AccessTime
.Year
;
2137 FileInfo
->CreateTime
.Month
= FileEntry
->AccessTime
.Month
;
2138 FileInfo
->CreateTime
.Day
= FileEntry
->AccessTime
.Day
;
2139 FileInfo
->CreateTime
.Hour
= FileEntry
->AccessTime
.Hour
;
2140 FileInfo
->CreateTime
.Minute
= FileEntry
->AccessTime
.Second
;
2141 FileInfo
->CreateTime
.Second
= FileEntry
->AccessTime
.Second
;
2142 FileInfo
->CreateTime
.Nanosecond
=
2143 FileEntry
->AccessTime
.HundredsOfMicroseconds
;
2145 FileInfo
->LastAccessTime
.Year
=
2146 FileEntry
->AccessTime
.Year
;
2147 FileInfo
->LastAccessTime
.Month
=
2148 FileEntry
->AccessTime
.Month
;
2149 FileInfo
->LastAccessTime
.Day
=
2150 FileEntry
->AccessTime
.Day
;
2151 FileInfo
->LastAccessTime
.Hour
=
2152 FileEntry
->AccessTime
.Hour
;
2153 FileInfo
->LastAccessTime
.Minute
=
2154 FileEntry
->AccessTime
.Minute
;
2155 FileInfo
->LastAccessTime
.Second
=
2156 FileEntry
->AccessTime
.Second
;
2157 FileInfo
->LastAccessTime
.Nanosecond
=
2158 FileEntry
->AccessTime
.HundredsOfMicroseconds
;
2159 } else if (IS_EFE (File
->FileEntry
)) {
2160 ExtendedFileEntry
= (UDF_EXTENDED_FILE_ENTRY
*)File
->FileEntry
;
2163 // Check if EFE has the system attribute set.
2165 if (ExtendedFileEntry
->IcbTag
.Flags
& (1 << 10)) {
2166 FileInfo
->Attribute
|= EFI_FILE_SYSTEM
;
2169 FileInfo
->FileSize
= FileSize
;
2170 FileInfo
->PhysicalSize
= FileSize
;
2172 FileInfo
->CreateTime
.Year
= ExtendedFileEntry
->CreationTime
.Year
;
2173 FileInfo
->CreateTime
.Month
= ExtendedFileEntry
->CreationTime
.Month
;
2174 FileInfo
->CreateTime
.Day
= ExtendedFileEntry
->CreationTime
.Day
;
2175 FileInfo
->CreateTime
.Hour
= ExtendedFileEntry
->CreationTime
.Hour
;
2176 FileInfo
->CreateTime
.Minute
= ExtendedFileEntry
->CreationTime
.Second
;
2177 FileInfo
->CreateTime
.Second
= ExtendedFileEntry
->CreationTime
.Second
;
2178 FileInfo
->CreateTime
.Nanosecond
=
2179 ExtendedFileEntry
->AccessTime
.HundredsOfMicroseconds
;
2181 FileInfo
->LastAccessTime
.Year
=
2182 ExtendedFileEntry
->AccessTime
.Year
;
2183 FileInfo
->LastAccessTime
.Month
=
2184 ExtendedFileEntry
->AccessTime
.Month
;
2185 FileInfo
->LastAccessTime
.Day
=
2186 ExtendedFileEntry
->AccessTime
.Day
;
2187 FileInfo
->LastAccessTime
.Hour
=
2188 ExtendedFileEntry
->AccessTime
.Hour
;
2189 FileInfo
->LastAccessTime
.Minute
=
2190 ExtendedFileEntry
->AccessTime
.Minute
;
2191 FileInfo
->LastAccessTime
.Second
=
2192 ExtendedFileEntry
->AccessTime
.Second
;
2193 FileInfo
->LastAccessTime
.Nanosecond
=
2194 ExtendedFileEntry
->AccessTime
.HundredsOfMicroseconds
;
2197 FileInfo
->CreateTime
.TimeZone
= EFI_UNSPECIFIED_TIMEZONE
;
2198 FileInfo
->CreateTime
.Daylight
= EFI_TIME_ADJUST_DAYLIGHT
;
2199 FileInfo
->LastAccessTime
.TimeZone
= EFI_UNSPECIFIED_TIMEZONE
;
2200 FileInfo
->LastAccessTime
.Daylight
= EFI_TIME_ADJUST_DAYLIGHT
;
2202 CopyMem ((VOID
*)&FileInfo
->ModificationTime
,
2203 (VOID
*)&FileInfo
->LastAccessTime
,
2206 if (FileName
!= NULL
) {
2207 StrCpyS (FileInfo
->FileName
, StrLen (FileName
) + 1, FileName
);
2209 FileInfo
->FileName
[0] = '\0';
2212 *BufferSize
= FileInfoLength
;
2218 Get volume and free space size information of an UDF volume.
2220 @param[in] BlockIo BlockIo interface.
2221 @param[in] DiskIo DiskIo interface.
2222 @param[in] Volume UDF volume information structure.
2223 @param[out] VolumeSize Volume size.
2224 @param[out] FreeSpaceSize Free space size.
2226 @retval EFI_SUCCESS Volume and free space size calculated.
2227 @retval EFI_NO_MEDIA The device has no media.
2228 @retval EFI_DEVICE_ERROR The device reported an error.
2229 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
2230 @retval EFI_OUT_OF_RESOURCES The volume and free space size were not
2231 calculated due to lack of resources.
2236 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
2237 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
2238 IN UDF_VOLUME_INFO
*Volume
,
2239 OUT UINT64
*VolumeSize
,
2240 OUT UINT64
*FreeSpaceSize
2243 UDF_EXTENT_AD ExtentAd
;
2244 UINT32 LogicalBlockSize
;
2247 UDF_LOGICAL_VOLUME_INTEGRITY
*LogicalVolInt
;
2255 for (Index
= 0; Index
< Volume
->LogicalVolDescsNo
; Index
++) {
2256 CopyMem ((VOID
*)&ExtentAd
,
2257 (VOID
*)&Volume
->LogicalVolDescs
[Index
]->IntegritySequenceExtent
,
2258 sizeof (UDF_EXTENT_AD
));
2259 if (ExtentAd
.ExtentLength
== 0) {
2263 LogicalBlockSize
= LV_BLOCK_SIZE (Volume
, Index
);
2266 LogicalVolInt
= (UDF_LOGICAL_VOLUME_INTEGRITY
*)
2267 AllocatePool (ExtentAd
.ExtentLength
);
2268 if (LogicalVolInt
== NULL
) {
2269 return EFI_OUT_OF_RESOURCES
;
2272 Lsn
= (UINT64
)ExtentAd
.ExtentLocation
;
2274 Status
= DiskIo
->ReadDisk (
2276 BlockIo
->Media
->MediaId
,
2277 MultU64x32 (Lsn
, LogicalBlockSize
),
2278 ExtentAd
.ExtentLength
,
2279 (VOID
*)LogicalVolInt
2281 if (EFI_ERROR (Status
)) {
2282 FreePool ((VOID
*)LogicalVolInt
);
2286 if (!IS_LVID (LogicalVolInt
)) {
2287 FreePool ((VOID
*)LogicalVolInt
);
2288 return EFI_VOLUME_CORRUPTED
;
2291 Length
= LogicalVolInt
->NumberOfPartitions
;
2292 for (Index
= 0; Index
< Length
; Index
+= sizeof (UINT32
)) {
2293 LsnsNo
= *(UINT32
*)((UINT8
*)LogicalVolInt
->Data
+ Index
);
2294 if (LsnsNo
== 0xFFFFFFFFUL
) {
2296 // Size not specified.
2301 *FreeSpaceSize
+= MultU64x32 ((UINT64
)LsnsNo
, LogicalBlockSize
);
2304 Length
= (LogicalVolInt
->NumberOfPartitions
* sizeof (UINT32
)) << 1;
2305 for (; Index
< Length
; Index
+= sizeof (UINT32
)) {
2306 LsnsNo
= *(UINT32
*)((UINT8
*)LogicalVolInt
->Data
+ Index
);
2307 if (LsnsNo
== 0xFFFFFFFFUL
) {
2309 // Size not specified.
2314 *VolumeSize
+= MultU64x32 ((UINT64
)LsnsNo
, LogicalBlockSize
);
2317 CopyMem ((VOID
*)&ExtentAd
,(VOID
*)&LogicalVolInt
->NextIntegrityExtent
,
2318 sizeof (UDF_EXTENT_AD
));
2319 if (ExtentAd
.ExtentLength
> 0) {
2320 FreePool ((VOID
*)LogicalVolInt
);
2321 goto Read_Next_Sequence
;
2324 FreePool ((VOID
*)LogicalVolInt
);
2331 Seek a file and read its data into memory on an UDF volume.
2333 @param[in] BlockIo BlockIo interface.
2334 @param[in] DiskIo DiskIo interface.
2335 @param[in] Volume UDF volume information structure.
2336 @param[in] File File information structure.
2337 @param[in] FileSize Size of the file.
2338 @param[in out] FilePosition File position.
2339 @param[in out] Buffer File data.
2340 @param[in out] BufferSize Read size.
2342 @retval EFI_SUCCESS File seeked and read.
2343 @retval EFI_UNSUPPORTED Extended Allocation Descriptors not supported.
2344 @retval EFI_NO_MEDIA The device has no media.
2345 @retval EFI_DEVICE_ERROR The device reported an error.
2346 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
2347 @retval EFI_OUT_OF_RESOURCES The file's recorded data was not read due to lack
2353 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
2354 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
2355 IN UDF_VOLUME_INFO
*Volume
,
2356 IN UDF_FILE_INFO
*File
,
2358 IN OUT UINT64
*FilePosition
,
2359 IN OUT VOID
*Buffer
,
2360 IN OUT UINT64
*BufferSize
2364 UDF_READ_FILE_INFO ReadFileInfo
;
2366 ReadFileInfo
.Flags
= READ_FILE_SEEK_AND_READ
;
2367 ReadFileInfo
.FilePosition
= *FilePosition
;
2368 ReadFileInfo
.FileData
= Buffer
;
2369 ReadFileInfo
.FileDataSize
= *BufferSize
;
2370 ReadFileInfo
.FileSize
= FileSize
;
2376 &File
->FileIdentifierDesc
->Icb
,
2380 if (EFI_ERROR (Status
)) {
2384 *BufferSize
= ReadFileInfo
.FileDataSize
;
2385 *FilePosition
= ReadFileInfo
.FilePosition
;
2391 Check if ControllerHandle supports an UDF file system.
2393 @param[in] This Protocol instance pointer.
2394 @param[in] ControllerHandle Handle of device to test.
2396 @retval EFI_SUCCESS UDF file system found.
2397 @retval EFI_UNSUPPORTED UDF file system not found.
2401 SupportUdfFileSystem (
2402 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
2403 IN EFI_HANDLE ControllerHandle
2407 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2408 EFI_DEVICE_PATH_PROTOCOL
*DevicePathNode
;
2409 EFI_DEVICE_PATH_PROTOCOL
*LastDevicePathNode
;
2410 EFI_GUID
*VendorDefinedGuid
;
2411 EFI_GUID UdfDevPathGuid
= EFI_UDF_DEVICE_PATH_GUID
;
2414 // Open Device Path protocol on ControllerHandle
2416 Status
= gBS
->OpenProtocol (
2418 &gEfiDevicePathProtocolGuid
,
2419 (VOID
**)&DevicePath
,
2420 This
->DriverBindingHandle
,
2422 EFI_OPEN_PROTOCOL_GET_PROTOCOL
2424 if (EFI_ERROR (Status
)) {
2425 return EFI_UNSUPPORTED
;
2428 Status
= EFI_UNSUPPORTED
;
2431 // Get last Device Path node
2433 LastDevicePathNode
= NULL
;
2434 DevicePathNode
= DevicePath
;
2435 while (!IsDevicePathEnd (DevicePathNode
)) {
2436 LastDevicePathNode
= DevicePathNode
;
2437 DevicePathNode
= NextDevicePathNode (DevicePathNode
);
2440 // Check if last Device Path node contains a Vendor-Defined Media Device Path
2441 // of an UDF file system.
2443 if (LastDevicePathNode
!= NULL
&&
2444 DevicePathType (LastDevicePathNode
) == MEDIA_DEVICE_PATH
&&
2445 DevicePathSubType (LastDevicePathNode
) == MEDIA_VENDOR_DP
) {
2446 VendorDefinedGuid
= (EFI_GUID
*)((UINTN
)LastDevicePathNode
+
2447 OFFSET_OF (VENDOR_DEVICE_PATH
, Guid
));
2448 if (CompareGuid (VendorDefinedGuid
, &UdfDevPathGuid
)) {
2449 Status
= EFI_SUCCESS
;
2454 // Close Device Path protocol on ControllerHandle
2456 gBS
->CloseProtocol (
2458 &gEfiDevicePathProtocolGuid
,
2459 This
->DriverBindingHandle
,