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
;
971 case LONG_ADS_SEQUENCE
:
972 case SHORT_ADS_SEQUENCE
:
974 // This FE/EFE contains a run of Allocation Descriptors. Get data + size
975 // for start reading them out.
977 GetAdsInformation (FileEntryData
, &Data
, &Length
);
984 Status
= GetAllocationDescriptor (
991 if (Status
== EFI_DEVICE_ERROR
) {
992 Status
= EFI_SUCCESS
;
997 // Check if AD is an indirect AD. If so, read Allocation Extent
998 // Descriptor and its extents (ADs).
1000 if (GET_EXTENT_FLAGS (RecordingFlags
, Ad
) == EXTENT_IS_NEXT_EXTENT
) {
1007 Status
= GetAedAdsData (
1017 if (EFI_ERROR (Status
)) {
1025 ExtentLength
= GET_EXTENT_LENGTH (RecordingFlags
, Ad
);
1027 Lsn
= GetAllocationDescriptorLsn (RecordingFlags
,
1032 switch (ReadFileInfo
->Flags
) {
1033 case READ_FILE_GET_FILESIZE
:
1034 ReadFileInfo
->ReadLength
+= ExtentLength
;
1036 case READ_FILE_ALLOCATE_AND_READ
:
1038 // Increase FileData (if necessary) to read next extent.
1040 Status
= GrowUpBufferToNextAd (
1043 &ReadFileInfo
->FileData
,
1044 ReadFileInfo
->ReadLength
1046 if (EFI_ERROR (Status
)) {
1047 goto Error_Alloc_Buffer_To_Next_Ad
;
1051 // Read extent's data into FileData.
1053 Status
= DiskIo
->ReadDisk (
1055 BlockIo
->Media
->MediaId
,
1056 MultU64x32 (Lsn
, LogicalBlockSize
),
1058 (VOID
*)((UINT8
*)ReadFileInfo
->FileData
+
1059 ReadFileInfo
->ReadLength
)
1061 if (EFI_ERROR (Status
)) {
1062 goto Error_Read_Disk_Blk
;
1065 ReadFileInfo
->ReadLength
+= ExtentLength
;
1067 case READ_FILE_SEEK_AND_READ
:
1069 // Seek file first before reading in its data.
1071 if (FinishedSeeking
) {
1073 goto Skip_File_Seek
;
1076 if (FilePosition
+ ExtentLength
< ReadFileInfo
->FilePosition
) {
1077 FilePosition
+= ExtentLength
;
1081 if (FilePosition
+ ExtentLength
> ReadFileInfo
->FilePosition
) {
1082 Offset
= ReadFileInfo
->FilePosition
- FilePosition
;
1091 // Done with seeking file. Start reading its data.
1093 FinishedSeeking
= TRUE
;
1097 // Make sure we don't read more data than really wanted.
1099 if (ExtentLength
- Offset
> BytesLeft
) {
1100 DataLength
= BytesLeft
;
1102 DataLength
= ExtentLength
- Offset
;
1106 // Read extent's data into FileData.
1108 Status
= DiskIo
->ReadDisk (
1110 BlockIo
->Media
->MediaId
,
1111 Offset
+ MultU64x32 (Lsn
, LogicalBlockSize
),
1113 (VOID
*)((UINT8
*)ReadFileInfo
->FileData
+
1116 if (EFI_ERROR (Status
)) {
1117 goto Error_Read_Disk_Blk
;
1121 // Update current file's position.
1123 DataOffset
+= DataLength
;
1124 ReadFileInfo
->FilePosition
+= DataLength
;
1126 BytesLeft
-= DataLength
;
1127 if (BytesLeft
== 0) {
1129 // There is no more file data to read.
1131 Status
= EFI_SUCCESS
;
1140 // Point to the next AD (extent).
1142 AdOffset
+= AD_LENGTH (RecordingFlags
);
1146 case EXTENDED_ADS_SEQUENCE
:
1147 // FIXME: Not supported. Got no volume with it, yet.
1149 Status
= EFI_UNSUPPORTED
;
1160 Error_Read_Disk_Blk
:
1161 Error_Alloc_Buffer_To_Next_Ad
:
1162 if (ReadFileInfo
->Flags
!= READ_FILE_SEEK_AND_READ
) {
1163 FreePool (ReadFileInfo
->FileData
);
1175 // Find a file by its filename from a given Parent file.
1179 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
1180 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
1181 IN UDF_VOLUME_INFO
*Volume
,
1182 IN CHAR16
*FileName
,
1183 IN UDF_FILE_INFO
*Parent
,
1184 IN UDF_LONG_ALLOCATION_DESCRIPTOR
*Icb
,
1185 OUT UDF_FILE_INFO
*File
1189 UDF_FILE_IDENTIFIER_DESCRIPTOR
*FileIdentifierDesc
;
1190 UDF_READ_DIRECTORY_INFO ReadDirInfo
;
1192 CHAR16 FoundFileName
[UDF_FILENAME_LENGTH
];
1193 VOID
*CompareFileEntry
;
1196 // Check if parent file is really directory.
1198 if (!IS_FE_DIRECTORY (Parent
->FileEntry
)) {
1199 return EFI_NOT_FOUND
;
1203 // If FileName is current file or working directory, just duplicate Parent's
1204 // FE/EFE and FID descriptors.
1206 if (StrCmp (FileName
, L
".") == 0) {
1207 DuplicateFe (BlockIo
, Volume
, Parent
->FileEntry
, &File
->FileEntry
);
1208 DuplicateFid (Parent
->FileIdentifierDesc
, &File
->FileIdentifierDesc
);
1214 // Start directory listing.
1216 ZeroMem ((VOID
*)&ReadDirInfo
, sizeof (UDF_READ_DIRECTORY_INFO
));
1220 Status
= ReadDirectoryEntry (
1224 Parent
->FileIdentifierDesc
?
1225 &Parent
->FileIdentifierDesc
->Icb
:
1231 if (EFI_ERROR (Status
)) {
1232 if (Status
== EFI_DEVICE_ERROR
) {
1233 Status
= EFI_NOT_FOUND
;
1239 if (IS_FID_PARENT_FILE (FileIdentifierDesc
)) {
1241 // This FID contains the location (FE/EFE) of the parent directory of this
1242 // directory (Parent), and if FileName is either ".." or "\\", then it's
1243 // the expected FID.
1245 if (StrCmp (FileName
, L
"..") == 0 || StrCmp (FileName
, L
"\\") == 0) {
1250 Status
= GetFileNameFromFid (FileIdentifierDesc
, FoundFileName
);
1251 if (EFI_ERROR (Status
)) {
1255 if (StrCmp (FileName
, FoundFileName
) == 0) {
1257 // FID has been found. Prepare to find its respective FE/EFE.
1264 FreePool ((VOID
*)FileIdentifierDesc
);
1267 if (ReadDirInfo
.DirectoryData
!= NULL
) {
1269 // Free all allocated resources for the directory listing.
1271 FreePool (ReadDirInfo
.DirectoryData
);
1275 Status
= EFI_SUCCESS
;
1277 File
->FileIdentifierDesc
= FileIdentifierDesc
;
1280 // If the requested file is root directory, then the FE/EFE was already
1281 // retrieved in UdfOpenVolume() function, thus no need to find it again.
1283 // Otherwise, find FE/EFE from the respective FID.
1285 if (StrCmp (FileName
, L
"\\") != 0) {
1286 Status
= FindFileEntry (
1290 &FileIdentifierDesc
->Icb
,
1293 if (EFI_ERROR (Status
)) {
1298 // Make sure that both Parent's FE/EFE and found FE/EFE are not equal.
1300 if (CompareMem ((VOID
*)Parent
->FileEntry
, (VOID
*)CompareFileEntry
,
1301 Volume
->FileEntrySize
) != 0) {
1302 File
->FileEntry
= CompareFileEntry
;
1304 FreePool ((VOID
*)FileIdentifierDesc
);
1305 FreePool ((VOID
*)CompareFileEntry
);
1306 Status
= EFI_NOT_FOUND
;
1314 FreePool ((VOID
*)FileIdentifierDesc
);
1320 Read volume information on a medium which contains a valid UDF file system.
1322 @param[in] BlockIo BlockIo interface.
1323 @param[in] DiskIo DiskIo interface.
1324 @param[out] Volume UDF volume information structure.
1326 @retval EFI_SUCCESS Volume information read.
1327 @retval EFI_NO_MEDIA The device has no media.
1328 @retval EFI_DEVICE_ERROR The device reported an error.
1329 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1330 @retval EFI_OUT_OF_RESOURCES The volume was not read due to lack of resources.
1334 ReadUdfVolumeInformation (
1335 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
1336 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
1337 OUT UDF_VOLUME_INFO
*Volume
1342 Status
= ReadVolumeFileStructure (
1347 if (EFI_ERROR (Status
)) {
1351 Status
= GetFileSetDescriptors (
1356 if (EFI_ERROR (Status
)) {
1357 CleanupVolumeInformation (Volume
);
1364 Find the root directory on an UDF volume.
1366 @param[in] BlockIo BlockIo interface.
1367 @param[in] DiskIo DiskIo interface.
1368 @param[in] Volume UDF volume information structure.
1369 @param[out] File Root directory file.
1371 @retval EFI_SUCCESS Root directory found.
1372 @retval EFI_NO_MEDIA The device has no media.
1373 @retval EFI_DEVICE_ERROR The device reported an error.
1374 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1375 @retval EFI_OUT_OF_RESOURCES The root directory was not found due to lack of
1381 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
1382 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
1383 IN UDF_VOLUME_INFO
*Volume
,
1384 OUT UDF_FILE_INFO
*File
1388 UDF_FILE_INFO Parent
;
1390 Status
= FindFileEntry (
1394 &Volume
->FileSetDescs
[0]->RootDirectoryIcb
,
1397 if (EFI_ERROR (Status
)) {
1401 Parent
.FileEntry
= File
->FileEntry
;
1402 Parent
.FileIdentifierDesc
= NULL
;
1411 &Volume
->FileSetDescs
[0]->RootDirectoryIcb
,
1414 if (EFI_ERROR (Status
)) {
1415 FreePool (File
->FileEntry
);
1422 Find either a File Entry or a Extended File Entry from a given ICB.
1424 @param[in] BlockIo BlockIo interface.
1425 @param[in] DiskIo DiskIo interface.
1426 @param[in] Volume UDF volume information structure.
1427 @param[in] Icb ICB of the FID.
1428 @param[out] FileEntry File Entry or Extended File Entry.
1430 @retval EFI_SUCCESS File Entry or Extended File Entry found.
1431 @retval EFI_NO_MEDIA The device has no media.
1432 @retval EFI_DEVICE_ERROR The device reported an error.
1433 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1434 @retval EFI_OUT_OF_RESOURCES The FE/EFE entry was not found due to lack of
1440 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
1441 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
1442 IN UDF_VOLUME_INFO
*Volume
,
1443 IN UDF_LONG_ALLOCATION_DESCRIPTOR
*Icb
,
1444 OUT VOID
**FileEntry
1449 UINT32 LogicalBlockSize
;
1451 Lsn
= GetLongAdLsn (Volume
, Icb
);
1452 LogicalBlockSize
= LV_BLOCK_SIZE (Volume
, UDF_DEFAULT_LV_NUM
);
1454 *FileEntry
= AllocateZeroPool (Volume
->FileEntrySize
);
1455 if (*FileEntry
== NULL
) {
1456 return EFI_OUT_OF_RESOURCES
;
1462 Status
= DiskIo
->ReadDisk (
1464 BlockIo
->Media
->MediaId
,
1465 MultU64x32 (Lsn
, LogicalBlockSize
),
1466 Volume
->FileEntrySize
,
1469 if (EFI_ERROR (Status
)) {
1470 goto Error_Read_Disk_Blk
;
1474 // Check if the read extent contains a valid Tag Identifier for the expected
1477 if (!IS_FE (*FileEntry
) && !IS_EFE (*FileEntry
)) {
1478 Status
= EFI_VOLUME_CORRUPTED
;
1479 goto Error_Invalid_Fe
;
1485 Error_Read_Disk_Blk
:
1486 FreePool (*FileEntry
);
1492 Find a file given its absolute path on an UDF volume.
1494 @param[in] BlockIo BlockIo interface.
1495 @param[in] DiskIo DiskIo interface.
1496 @param[in] Volume UDF volume information structure.
1497 @param[in] FilePath File's absolute path.
1498 @param[in] Root Root directory file.
1499 @param[in] Parent Parent directory file.
1500 @param[out] File Found file.
1502 @retval EFI_SUCCESS @p FilePath was found.
1503 @retval EFI_NO_MEDIA The device has no media.
1504 @retval EFI_DEVICE_ERROR The device reported an error.
1505 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1506 @retval EFI_OUT_OF_RESOURCES The @p FilePath file was not found due to lack of
1512 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
1513 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
1514 IN UDF_VOLUME_INFO
*Volume
,
1515 IN CHAR16
*FilePath
,
1516 IN UDF_FILE_INFO
*Root
,
1517 IN UDF_FILE_INFO
*Parent
,
1518 IN UDF_LONG_ALLOCATION_DESCRIPTOR
*Icb
,
1519 OUT UDF_FILE_INFO
*File
1523 CHAR16 FileName
[UDF_FILENAME_LENGTH
];
1524 CHAR16
*FileNamePointer
;
1525 UDF_FILE_INFO PreviousFile
;
1528 Status
= EFI_NOT_FOUND
;
1530 CopyMem ((VOID
*)&PreviousFile
, (VOID
*)Parent
, sizeof (UDF_FILE_INFO
));
1531 while (*FilePath
!= L
'\0') {
1532 FileNamePointer
= FileName
;
1533 while (*FilePath
!= L
'\0' && *FilePath
!= L
'\\') {
1534 *FileNamePointer
++ = *FilePath
++;
1537 *FileNamePointer
= L
'\0';
1538 if (FileName
[0] == L
'\0') {
1540 // Open root directory.
1544 // There is no file found for the root directory yet. So, find only its
1547 // See UdfOpenVolume() function.
1549 Status
= InternalFindFile (BlockIo
,
1558 // We've already a file pointer (Root) for the root directory. Duplicate
1559 // its FE/EFE and FID descriptors.
1561 DuplicateFe (BlockIo
, Volume
, Root
->FileEntry
, &File
->FileEntry
);
1562 DuplicateFid (Root
->FileIdentifierDesc
, &File
->FileIdentifierDesc
);
1563 Status
= EFI_SUCCESS
;
1567 // No root directory. Find filename from the current directory.
1569 Status
= InternalFindFile (BlockIo
,
1578 if (EFI_ERROR (Status
)) {
1583 // If the found file is a symlink, then find its respective FE/EFE and
1586 if (IS_FE_SYMLINK (File
->FileEntry
)) {
1587 FreePool ((VOID
*)File
->FileIdentifierDesc
);
1589 FileEntry
= File
->FileEntry
;
1591 Status
= ResolveSymlink (BlockIo
,
1598 FreePool (FileEntry
);
1600 if (EFI_ERROR (Status
)) {
1605 if (CompareMem ((VOID
*)&PreviousFile
, (VOID
*)Parent
,
1606 sizeof (UDF_FILE_INFO
)) != 0) {
1607 CleanupFileInformation (&PreviousFile
);
1610 CopyMem ((VOID
*)&PreviousFile
, (VOID
*)File
, sizeof (UDF_FILE_INFO
));
1611 if (*FilePath
!= L
'\0' && *FilePath
== L
'\\') {
1620 Read a directory entry at a time on an UDF volume.
1622 @param[in] BlockIo BlockIo interface.
1623 @param[in] DiskIo DiskIo interface.
1624 @param[in] Volume UDF volume information structure.
1625 @param[in] ParentIcb ICB of the parent file.
1626 @param[in] FileEntryData FE/EFE of the parent file.
1627 @param[in out] ReadDirInfo Next read directory listing structure
1629 @param[out] FoundFid File Identifier Descriptor pointer.
1631 @retval EFI_SUCCESS Directory entry read.
1632 @retval EFI_UNSUPPORTED Extended Allocation Descriptors not supported.
1633 @retval EFI_NO_MEDIA The device has no media.
1634 @retval EFI_DEVICE_ERROR The device reported an error.
1635 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1636 @retval EFI_OUT_OF_RESOURCES The directory entry was not read due to lack of
1641 ReadDirectoryEntry (
1642 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
1643 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
1644 IN UDF_VOLUME_INFO
*Volume
,
1645 IN UDF_LONG_ALLOCATION_DESCRIPTOR
*ParentIcb
,
1646 IN VOID
*FileEntryData
,
1647 IN OUT UDF_READ_DIRECTORY_INFO
*ReadDirInfo
,
1648 OUT UDF_FILE_IDENTIFIER_DESCRIPTOR
**FoundFid
1652 UDF_READ_FILE_INFO ReadFileInfo
;
1653 UDF_FILE_IDENTIFIER_DESCRIPTOR
*FileIdentifierDesc
;
1655 if (ReadDirInfo
->DirectoryData
== NULL
) {
1657 // The directory's recorded data has not been read yet. So let's cache it
1658 // into memory and the next calls won't need to read it again.
1660 ReadFileInfo
.Flags
= READ_FILE_ALLOCATE_AND_READ
;
1670 if (EFI_ERROR (Status
)) {
1675 // Fill in ReadDirInfo structure with the read directory's data information.
1677 ReadDirInfo
->DirectoryData
= ReadFileInfo
.FileData
;
1678 ReadDirInfo
->DirectoryLength
= ReadFileInfo
.ReadLength
;
1682 if (ReadDirInfo
->FidOffset
>= ReadDirInfo
->DirectoryLength
) {
1684 // There are no longer FIDs for this directory. By returning
1685 // EFI_DEVICE_ERROR to the callee will indicate end of directory
1688 return EFI_DEVICE_ERROR
;
1692 // Get FID for this entry.
1694 FileIdentifierDesc
= GET_FID_FROM_ADS (ReadDirInfo
->DirectoryData
,
1695 ReadDirInfo
->FidOffset
);
1697 // Update FidOffset to point to next FID.
1699 ReadDirInfo
->FidOffset
+= GetFidDescriptorLength (FileIdentifierDesc
);
1700 } while (IS_FID_DELETED_FILE (FileIdentifierDesc
));
1702 DuplicateFid (FileIdentifierDesc
, FoundFid
);
1708 Get a filename (encoded in OSTA-compressed format) from a File Identifier
1709 Descriptor on an UDF volume.
1711 @param[in] FileIdentifierDesc File Identifier Descriptor pointer.
1712 @param[out] FileName Decoded filename.
1714 @retval EFI_SUCCESS Filename decoded and read.
1715 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1718 GetFileNameFromFid (
1719 IN UDF_FILE_IDENTIFIER_DESCRIPTOR
*FileIdentifierDesc
,
1720 OUT CHAR16
*FileName
1723 UINT8
*OstaCompressed
;
1724 UINT8 CompressionId
;
1730 (UINT8
*)FileIdentifierDesc
->Data
+
1731 FileIdentifierDesc
->LengthOfImplementationUse
1734 CompressionId
= OstaCompressed
[0];
1735 if (!IS_VALID_COMPRESSION_ID (CompressionId
)) {
1736 return EFI_VOLUME_CORRUPTED
;
1742 Length
= FileIdentifierDesc
->LengthOfFileIdentifier
;
1743 for (Index
= 1; Index
< Length
; Index
++) {
1744 if (CompressionId
== 16) {
1745 *FileName
= OstaCompressed
[Index
++] << 8;
1750 if (Index
< Length
) {
1751 *FileName
|= OstaCompressed
[Index
];
1763 Resolve a symlink file on an UDF volume.
1765 @param[in] BlockIo BlockIo interface.
1766 @param[in] DiskIo DiskIo interface.
1767 @param[in] Volume UDF volume information structure.
1768 @param[in] Parent Parent file.
1769 @param[in] FileEntryData FE/EFE structure pointer.
1770 @param[out] File Resolved file.
1772 @retval EFI_SUCCESS Symlink file resolved.
1773 @retval EFI_UNSUPPORTED Extended Allocation Descriptors not supported.
1774 @retval EFI_NO_MEDIA The device has no media.
1775 @retval EFI_DEVICE_ERROR The device reported an error.
1776 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1777 @retval EFI_OUT_OF_RESOURCES The symlink file was not resolved due to lack of
1783 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
1784 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
1785 IN UDF_VOLUME_INFO
*Volume
,
1786 IN UDF_FILE_INFO
*Parent
,
1787 IN VOID
*FileEntryData
,
1788 OUT UDF_FILE_INFO
*File
1792 UDF_READ_FILE_INFO ReadFileInfo
;
1796 UDF_PATH_COMPONENT
*PathComp
;
1797 UINT8 PathCompLength
;
1798 CHAR16 FileName
[UDF_FILENAME_LENGTH
];
1801 UINT8 CompressionId
;
1802 UDF_FILE_INFO PreviousFile
;
1805 // Symlink files on UDF volumes do not contain so much data other than
1806 // Path Components which resolves to real filenames, so it's OK to read in
1807 // all its data here -- usually the data will be inline with the FE/EFE for
1810 ReadFileInfo
.Flags
= READ_FILE_ALLOCATE_AND_READ
;
1816 &Parent
->FileIdentifierDesc
->Icb
,
1820 if (EFI_ERROR (Status
)) {
1824 Length
= ReadFileInfo
.ReadLength
;
1826 Data
= (UINT8
*)ReadFileInfo
.FileData
;
1827 EndData
= Data
+ Length
;
1829 CopyMem ((VOID
*)&PreviousFile
, (VOID
*)Parent
, sizeof (UDF_FILE_INFO
));
1832 PathComp
= (UDF_PATH_COMPONENT
*)Data
;
1834 PathCompLength
= PathComp
->LengthOfComponentIdentifier
;
1836 switch (PathComp
->ComponentType
) {
1839 // This Path Component specifies the root directory hierarchy subject to
1840 // agreement between the originator and recipient of the medium. Skip it.
1846 // "\\." of the current directory. Read next Path Component.
1848 goto Next_Path_Component
;
1851 // ".." (parent directory). Go to it.
1853 CopyMem ((VOID
*)FileName
, L
"..", 6);
1857 // "." (current file). Duplicate both FE/EFE and FID of this file.
1859 DuplicateFe (BlockIo
, Volume
, PreviousFile
.FileEntry
, &File
->FileEntry
);
1860 DuplicateFid (PreviousFile
.FileIdentifierDesc
,
1861 &File
->FileIdentifierDesc
);
1862 goto Next_Path_Component
;
1865 // This Path Component identifies an object, either a file or a
1866 // directory or an alias.
1868 // Decode it from the compressed data in ComponentIdentifier and find
1871 CompressionId
= PathComp
->ComponentIdentifier
[0];
1872 if (!IS_VALID_COMPRESSION_ID (CompressionId
)) {
1873 return EFI_VOLUME_CORRUPTED
;
1877 for (Index
= 1; Index
< PathCompLength
; Index
++) {
1878 if (CompressionId
== 16) {
1879 *C
= *(UINT8
*)((UINT8
*)PathComp
->ComponentIdentifier
+
1886 if (Index
< Length
) {
1887 *C
|= *(UINT8
*)((UINT8
*)PathComp
->ComponentIdentifier
+ Index
);
1898 // Find file from the read filename in symlink's file data.
1900 Status
= InternalFindFile (
1909 if (EFI_ERROR (Status
)) {
1910 goto Error_Find_File
;
1913 Next_Path_Component
:
1914 Data
+= sizeof (UDF_PATH_COMPONENT
) + PathCompLength
;
1915 if (Data
>= EndData
) {
1919 if (CompareMem ((VOID
*)&PreviousFile
, (VOID
*)Parent
,
1920 sizeof (UDF_FILE_INFO
)) != 0) {
1921 CleanupFileInformation (&PreviousFile
);
1924 CopyMem ((VOID
*)&PreviousFile
, (VOID
*)File
, sizeof (UDF_FILE_INFO
));
1928 // Unmap the symlink file.
1930 FreePool (ReadFileInfo
.FileData
);
1935 if (CompareMem ((VOID
*)&PreviousFile
, (VOID
*)Parent
,
1936 sizeof (UDF_FILE_INFO
)) != 0) {
1937 CleanupFileInformation (&PreviousFile
);
1940 FreePool (ReadFileInfo
.FileData
);
1946 Clean up in-memory UDF volume information.
1948 @param[in] Volume Volume information pointer.
1952 CleanupVolumeInformation (
1953 IN UDF_VOLUME_INFO
*Volume
1958 if (Volume
->LogicalVolDescs
!= NULL
) {
1959 for (Index
= 0; Index
< Volume
->LogicalVolDescsNo
; Index
++) {
1960 FreePool ((VOID
*)Volume
->LogicalVolDescs
[Index
]);
1962 FreePool ((VOID
*)Volume
->LogicalVolDescs
);
1965 if (Volume
->PartitionDescs
!= NULL
) {
1966 for (Index
= 0; Index
< Volume
->PartitionDescsNo
; Index
++) {
1967 FreePool ((VOID
*)Volume
->PartitionDescs
[Index
]);
1969 FreePool ((VOID
*)Volume
->PartitionDescs
);
1972 if (Volume
->FileSetDescs
!= NULL
) {
1973 for (Index
= 0; Index
< Volume
->FileSetDescsNo
; Index
++) {
1974 FreePool ((VOID
*)Volume
->FileSetDescs
[Index
]);
1976 FreePool ((VOID
*)Volume
->FileSetDescs
);
1979 ZeroMem ((VOID
*)Volume
, sizeof (UDF_VOLUME_INFO
));
1983 Clean up in-memory UDF file information.
1985 @param[in] File File information pointer.
1989 CleanupFileInformation (
1990 IN UDF_FILE_INFO
*File
1993 if (File
->FileEntry
!= NULL
) {
1994 FreePool (File
->FileEntry
);
1996 if (File
->FileIdentifierDesc
!= NULL
) {
1997 FreePool ((VOID
*)File
->FileIdentifierDesc
);
2000 ZeroMem ((VOID
*)File
, sizeof (UDF_FILE_INFO
));
2004 Find a file from its absolute path on an UDF volume.
2006 @param[in] BlockIo BlockIo interface.
2007 @param[in] DiskIo DiskIo interface.
2008 @param[in] Volume UDF volume information structure.
2009 @param[in] File File information structure.
2010 @param[out] Size Size of the file.
2012 @retval EFI_SUCCESS File size calculated and set in @p Size.
2013 @retval EFI_UNSUPPORTED Extended Allocation Descriptors not supported.
2014 @retval EFI_NO_MEDIA The device has no media.
2015 @retval EFI_DEVICE_ERROR The device reported an error.
2016 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
2017 @retval EFI_OUT_OF_RESOURCES The file size was not calculated due to lack of
2023 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
2024 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
2025 IN UDF_VOLUME_INFO
*Volume
,
2026 IN UDF_FILE_INFO
*File
,
2031 UDF_READ_FILE_INFO ReadFileInfo
;
2033 ReadFileInfo
.Flags
= READ_FILE_GET_FILESIZE
;
2039 &File
->FileIdentifierDesc
->Icb
,
2043 if (EFI_ERROR (Status
)) {
2047 *Size
= ReadFileInfo
.ReadLength
;
2053 Set information about a file on an UDF volume.
2055 @param[in] File File pointer.
2056 @param[in] FileSize Size of the file.
2057 @param[in] FileName Filename of the file.
2058 @param[in out] BufferSize Size of the returned file infomation.
2059 @param[out] Buffer Data of the returned file information.
2061 @retval EFI_SUCCESS File information set.
2062 @retval EFI_NO_MEDIA The device has no media.
2063 @retval EFI_DEVICE_ERROR The device reported an error.
2064 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
2065 @retval EFI_OUT_OF_RESOURCES The file information was not set due to lack of
2071 IN UDF_FILE_INFO
*File
,
2073 IN CHAR16
*FileName
,
2074 IN OUT UINTN
*BufferSize
,
2078 UINTN FileInfoLength
;
2079 EFI_FILE_INFO
*FileInfo
;
2080 UDF_FILE_ENTRY
*FileEntry
;
2081 UDF_EXTENDED_FILE_ENTRY
*ExtendedFileEntry
;
2084 // Calculate the needed size for the EFI_FILE_INFO structure.
2086 FileInfoLength
= sizeof (EFI_FILE_INFO
) + (FileName
?
2087 StrSize (FileName
) :
2089 if (*BufferSize
< FileInfoLength
) {
2091 // The given Buffer has no size enough for EFI_FILE_INFO structure.
2093 *BufferSize
= FileInfoLength
;
2094 return EFI_BUFFER_TOO_SMALL
;
2098 // Buffer now contains room enough to store EFI_FILE_INFO structure.
2099 // Now, fill it in with all necessary information about the file.
2101 FileInfo
= (EFI_FILE_INFO
*)Buffer
;
2102 FileInfo
->Size
= FileInfoLength
;
2103 FileInfo
->Attribute
&= ~EFI_FILE_VALID_ATTR
;
2104 FileInfo
->Attribute
|= EFI_FILE_READ_ONLY
;
2106 if (IS_FID_DIRECTORY_FILE (File
->FileIdentifierDesc
)) {
2107 FileInfo
->Attribute
|= EFI_FILE_DIRECTORY
;
2108 } else if (IS_FID_NORMAL_FILE (File
->FileIdentifierDesc
)) {
2109 FileInfo
->Attribute
|= EFI_FILE_ARCHIVE
;
2112 if (IS_FID_HIDDEN_FILE (File
->FileIdentifierDesc
)) {
2113 FileInfo
->Attribute
|= EFI_FILE_HIDDEN
;
2116 if (IS_FE (File
->FileEntry
)) {
2117 FileEntry
= (UDF_FILE_ENTRY
*)File
->FileEntry
;
2120 // Check if FE has the system attribute set.
2122 if (FileEntry
->IcbTag
.Flags
& (1 << 10)) {
2123 FileInfo
->Attribute
|= EFI_FILE_SYSTEM
;
2126 FileInfo
->FileSize
= FileSize
;
2127 FileInfo
->PhysicalSize
= FileSize
;
2129 FileInfo
->CreateTime
.Year
= FileEntry
->AccessTime
.Year
;
2130 FileInfo
->CreateTime
.Month
= FileEntry
->AccessTime
.Month
;
2131 FileInfo
->CreateTime
.Day
= FileEntry
->AccessTime
.Day
;
2132 FileInfo
->CreateTime
.Hour
= FileEntry
->AccessTime
.Hour
;
2133 FileInfo
->CreateTime
.Minute
= FileEntry
->AccessTime
.Second
;
2134 FileInfo
->CreateTime
.Second
= FileEntry
->AccessTime
.Second
;
2135 FileInfo
->CreateTime
.Nanosecond
=
2136 FileEntry
->AccessTime
.HundredsOfMicroseconds
;
2138 FileInfo
->LastAccessTime
.Year
=
2139 FileEntry
->AccessTime
.Year
;
2140 FileInfo
->LastAccessTime
.Month
=
2141 FileEntry
->AccessTime
.Month
;
2142 FileInfo
->LastAccessTime
.Day
=
2143 FileEntry
->AccessTime
.Day
;
2144 FileInfo
->LastAccessTime
.Hour
=
2145 FileEntry
->AccessTime
.Hour
;
2146 FileInfo
->LastAccessTime
.Minute
=
2147 FileEntry
->AccessTime
.Minute
;
2148 FileInfo
->LastAccessTime
.Second
=
2149 FileEntry
->AccessTime
.Second
;
2150 FileInfo
->LastAccessTime
.Nanosecond
=
2151 FileEntry
->AccessTime
.HundredsOfMicroseconds
;
2152 } else if (IS_EFE (File
->FileEntry
)) {
2153 ExtendedFileEntry
= (UDF_EXTENDED_FILE_ENTRY
*)File
->FileEntry
;
2156 // Check if EFE has the system attribute set.
2158 if (ExtendedFileEntry
->IcbTag
.Flags
& (1 << 10)) {
2159 FileInfo
->Attribute
|= EFI_FILE_SYSTEM
;
2162 FileInfo
->FileSize
= FileSize
;
2163 FileInfo
->PhysicalSize
= FileSize
;
2165 FileInfo
->CreateTime
.Year
= ExtendedFileEntry
->CreationTime
.Year
;
2166 FileInfo
->CreateTime
.Month
= ExtendedFileEntry
->CreationTime
.Month
;
2167 FileInfo
->CreateTime
.Day
= ExtendedFileEntry
->CreationTime
.Day
;
2168 FileInfo
->CreateTime
.Hour
= ExtendedFileEntry
->CreationTime
.Hour
;
2169 FileInfo
->CreateTime
.Minute
= ExtendedFileEntry
->CreationTime
.Second
;
2170 FileInfo
->CreateTime
.Second
= ExtendedFileEntry
->CreationTime
.Second
;
2171 FileInfo
->CreateTime
.Nanosecond
=
2172 ExtendedFileEntry
->AccessTime
.HundredsOfMicroseconds
;
2174 FileInfo
->LastAccessTime
.Year
=
2175 ExtendedFileEntry
->AccessTime
.Year
;
2176 FileInfo
->LastAccessTime
.Month
=
2177 ExtendedFileEntry
->AccessTime
.Month
;
2178 FileInfo
->LastAccessTime
.Day
=
2179 ExtendedFileEntry
->AccessTime
.Day
;
2180 FileInfo
->LastAccessTime
.Hour
=
2181 ExtendedFileEntry
->AccessTime
.Hour
;
2182 FileInfo
->LastAccessTime
.Minute
=
2183 ExtendedFileEntry
->AccessTime
.Minute
;
2184 FileInfo
->LastAccessTime
.Second
=
2185 ExtendedFileEntry
->AccessTime
.Second
;
2186 FileInfo
->LastAccessTime
.Nanosecond
=
2187 ExtendedFileEntry
->AccessTime
.HundredsOfMicroseconds
;
2190 FileInfo
->CreateTime
.TimeZone
= EFI_UNSPECIFIED_TIMEZONE
;
2191 FileInfo
->CreateTime
.Daylight
= EFI_TIME_ADJUST_DAYLIGHT
;
2192 FileInfo
->LastAccessTime
.TimeZone
= EFI_UNSPECIFIED_TIMEZONE
;
2193 FileInfo
->LastAccessTime
.Daylight
= EFI_TIME_ADJUST_DAYLIGHT
;
2195 CopyMem ((VOID
*)&FileInfo
->ModificationTime
,
2196 (VOID
*)&FileInfo
->LastAccessTime
,
2199 if (FileName
!= NULL
) {
2200 StrCpyS (FileInfo
->FileName
, StrLen (FileName
) + 1, FileName
);
2202 FileInfo
->FileName
[0] = '\0';
2205 *BufferSize
= FileInfoLength
;
2211 Get volume and free space size information of an UDF volume.
2213 @param[in] BlockIo BlockIo interface.
2214 @param[in] DiskIo DiskIo interface.
2215 @param[in] Volume UDF volume information structure.
2216 @param[out] VolumeSize Volume size.
2217 @param[out] FreeSpaceSize Free space size.
2219 @retval EFI_SUCCESS Volume and free space size calculated.
2220 @retval EFI_NO_MEDIA The device has no media.
2221 @retval EFI_DEVICE_ERROR The device reported an error.
2222 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
2223 @retval EFI_OUT_OF_RESOURCES The volume and free space size were not
2224 calculated due to lack of resources.
2229 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
2230 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
2231 IN UDF_VOLUME_INFO
*Volume
,
2232 OUT UINT64
*VolumeSize
,
2233 OUT UINT64
*FreeSpaceSize
2236 UDF_EXTENT_AD ExtentAd
;
2237 UINT32 LogicalBlockSize
;
2240 UDF_LOGICAL_VOLUME_INTEGRITY
*LogicalVolInt
;
2248 for (Index
= 0; Index
< Volume
->LogicalVolDescsNo
; Index
++) {
2249 CopyMem ((VOID
*)&ExtentAd
,
2250 (VOID
*)&Volume
->LogicalVolDescs
[Index
]->IntegritySequenceExtent
,
2251 sizeof (UDF_EXTENT_AD
));
2252 if (ExtentAd
.ExtentLength
== 0) {
2256 LogicalBlockSize
= LV_BLOCK_SIZE (Volume
, Index
);
2259 LogicalVolInt
= (UDF_LOGICAL_VOLUME_INTEGRITY
*)
2260 AllocatePool (ExtentAd
.ExtentLength
);
2261 if (LogicalVolInt
== NULL
) {
2262 return EFI_OUT_OF_RESOURCES
;
2265 Lsn
= (UINT64
)ExtentAd
.ExtentLocation
;
2267 Status
= DiskIo
->ReadDisk (
2269 BlockIo
->Media
->MediaId
,
2270 MultU64x32 (Lsn
, LogicalBlockSize
),
2271 ExtentAd
.ExtentLength
,
2272 (VOID
*)LogicalVolInt
2274 if (EFI_ERROR (Status
)) {
2275 FreePool ((VOID
*)LogicalVolInt
);
2279 if (!IS_LVID (LogicalVolInt
)) {
2280 FreePool ((VOID
*)LogicalVolInt
);
2281 return EFI_VOLUME_CORRUPTED
;
2284 Length
= LogicalVolInt
->NumberOfPartitions
;
2285 for (Index
= 0; Index
< Length
; Index
+= sizeof (UINT32
)) {
2286 LsnsNo
= *(UINT32
*)((UINT8
*)LogicalVolInt
->Data
+ Index
);
2287 if (LsnsNo
== 0xFFFFFFFFUL
) {
2289 // Size not specified.
2294 *FreeSpaceSize
+= MultU64x32 ((UINT64
)LsnsNo
, LogicalBlockSize
);
2297 Length
= (LogicalVolInt
->NumberOfPartitions
* sizeof (UINT32
)) << 1;
2298 for (; Index
< Length
; Index
+= sizeof (UINT32
)) {
2299 LsnsNo
= *(UINT32
*)((UINT8
*)LogicalVolInt
->Data
+ Index
);
2300 if (LsnsNo
== 0xFFFFFFFFUL
) {
2302 // Size not specified.
2307 *VolumeSize
+= MultU64x32 ((UINT64
)LsnsNo
, LogicalBlockSize
);
2310 CopyMem ((VOID
*)&ExtentAd
,(VOID
*)&LogicalVolInt
->NextIntegrityExtent
,
2311 sizeof (UDF_EXTENT_AD
));
2312 if (ExtentAd
.ExtentLength
> 0) {
2313 FreePool ((VOID
*)LogicalVolInt
);
2314 goto Read_Next_Sequence
;
2317 FreePool ((VOID
*)LogicalVolInt
);
2324 Seek a file and read its data into memory on an UDF volume.
2326 @param[in] BlockIo BlockIo interface.
2327 @param[in] DiskIo DiskIo interface.
2328 @param[in] Volume UDF volume information structure.
2329 @param[in] File File information structure.
2330 @param[in] FileSize Size of the file.
2331 @param[in out] FilePosition File position.
2332 @param[in out] Buffer File data.
2333 @param[in out] BufferSize Read size.
2335 @retval EFI_SUCCESS File seeked and read.
2336 @retval EFI_UNSUPPORTED Extended Allocation Descriptors not supported.
2337 @retval EFI_NO_MEDIA The device has no media.
2338 @retval EFI_DEVICE_ERROR The device reported an error.
2339 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
2340 @retval EFI_OUT_OF_RESOURCES The file's recorded data was not read due to lack
2346 IN EFI_BLOCK_IO_PROTOCOL
*BlockIo
,
2347 IN EFI_DISK_IO_PROTOCOL
*DiskIo
,
2348 IN UDF_VOLUME_INFO
*Volume
,
2349 IN UDF_FILE_INFO
*File
,
2351 IN OUT UINT64
*FilePosition
,
2352 IN OUT VOID
*Buffer
,
2353 IN OUT UINT64
*BufferSize
2357 UDF_READ_FILE_INFO ReadFileInfo
;
2359 ReadFileInfo
.Flags
= READ_FILE_SEEK_AND_READ
;
2360 ReadFileInfo
.FilePosition
= *FilePosition
;
2361 ReadFileInfo
.FileData
= Buffer
;
2362 ReadFileInfo
.FileDataSize
= *BufferSize
;
2363 ReadFileInfo
.FileSize
= FileSize
;
2369 &File
->FileIdentifierDesc
->Icb
,
2373 if (EFI_ERROR (Status
)) {
2377 *BufferSize
= ReadFileInfo
.FileDataSize
;
2378 *FilePosition
= ReadFileInfo
.FilePosition
;
2384 Check if ControllerHandle supports an UDF file system.
2386 @param[in] This Protocol instance pointer.
2387 @param[in] ControllerHandle Handle of device to test.
2389 @retval EFI_SUCCESS UDF file system found.
2390 @retval EFI_UNSUPPORTED UDF file system not found.
2394 SupportUdfFileSystem (
2395 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
2396 IN EFI_HANDLE ControllerHandle
2400 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
2401 EFI_DEVICE_PATH_PROTOCOL
*DevicePathNode
;
2402 EFI_DEVICE_PATH_PROTOCOL
*LastDevicePathNode
;
2403 EFI_GUID
*VendorDefinedGuid
;
2404 EFI_GUID UdfDevPathGuid
= EFI_UDF_DEVICE_PATH_GUID
;
2407 // Open Device Path protocol on ControllerHandle
2409 Status
= gBS
->OpenProtocol (
2411 &gEfiDevicePathProtocolGuid
,
2412 (VOID
**)&DevicePath
,
2413 This
->DriverBindingHandle
,
2415 EFI_OPEN_PROTOCOL_GET_PROTOCOL
2417 if (EFI_ERROR (Status
)) {
2418 return EFI_UNSUPPORTED
;
2421 Status
= EFI_UNSUPPORTED
;
2424 // Get last Device Path node
2426 LastDevicePathNode
= NULL
;
2427 DevicePathNode
= DevicePath
;
2428 while (!IsDevicePathEnd (DevicePathNode
)) {
2429 LastDevicePathNode
= DevicePathNode
;
2430 DevicePathNode
= NextDevicePathNode (DevicePathNode
);
2433 // Check if last Device Path node contains a Vendor-Defined Media Device Path
2434 // of an UDF file system.
2436 if (LastDevicePathNode
!= NULL
&&
2437 DevicePathType (LastDevicePathNode
) == MEDIA_DEVICE_PATH
&&
2438 DevicePathSubType (LastDevicePathNode
) == MEDIA_VENDOR_DP
) {
2439 VendorDefinedGuid
= (EFI_GUID
*)((UINTN
)LastDevicePathNode
+
2440 OFFSET_OF (VENDOR_DEVICE_PATH
, Guid
));
2441 if (CompareGuid (VendorDefinedGuid
, &UdfDevPathGuid
)) {
2442 Status
= EFI_SUCCESS
;
2447 // Close Device Path protocol on ControllerHandle
2449 gBS
->CloseProtocol (
2451 &gEfiDevicePathProtocolGuid
,
2452 This
->DriverBindingHandle
,