]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/Disk/UdfDxe/FileSystemOperations.c
MdeModulePkg/UdfDxe: ASSERT() valid ReadFileInfo Flags for INLINE_DATA req
[mirror_edk2.git] / MdeModulePkg / Universal / Disk / UdfDxe / FileSystemOperations.c
1 /** @file
2 Handle on-disk format and volume structures in UDF/ECMA-167 file systems.
3
4 Copyright (C) 2014-2017 Paulo Alcantara <pcacjr@zytor.com>
5
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
10
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.
13 **/
14
15 #include "Udf.h"
16
17 EFI_STATUS
18 FindAnchorVolumeDescriptorPointer (
19 IN EFI_BLOCK_IO_PROTOCOL *BlockIo,
20 IN EFI_DISK_IO_PROTOCOL *DiskIo,
21 OUT UDF_ANCHOR_VOLUME_DESCRIPTOR_POINTER *AnchorPoint
22 )
23 {
24 EFI_STATUS Status;
25 UINT32 BlockSize;
26 EFI_LBA EndLBA;
27 EFI_LBA DescriptorLBAs[4];
28 UINTN Index;
29
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;
36
37 for (Index = 0; Index < ARRAY_SIZE (DescriptorLBAs); Index++) {
38 Status = DiskIo->ReadDisk (
39 DiskIo,
40 BlockIo->Media->MediaId,
41 MultU64x32 (DescriptorLBAs[Index], BlockSize),
42 sizeof (UDF_ANCHOR_VOLUME_DESCRIPTOR_POINTER),
43 (VOID *)AnchorPoint
44 );
45 if (EFI_ERROR (Status)) {
46 return Status;
47 }
48 //
49 // Check if read LBA has a valid AVDP descriptor.
50 //
51 if (IS_AVDP (AnchorPoint)) {
52 return EFI_SUCCESS;
53 }
54 }
55 //
56 // No AVDP found.
57 //
58 return EFI_VOLUME_CORRUPTED;
59 }
60
61 EFI_STATUS
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
67 )
68 {
69 EFI_STATUS Status;
70 UINT32 BlockSize;
71 UDF_EXTENT_AD *ExtentAd;
72 UINT64 StartingLsn;
73 UINT64 EndingLsn;
74 VOID *Buffer;
75 UDF_LOGICAL_VOLUME_DESCRIPTOR *LogicalVolDesc;
76 UDF_PARTITION_DESCRIPTOR *PartitionDesc;
77 UINTN Index;
78 UINT32 LogicalBlockSize;
79
80 //
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.
85 //
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.
88 //
89 BlockSize = BlockIo->Media->BlockSize;
90 ExtentAd = &AnchorPoint->MainVolumeDescriptorSequenceExtent;
91 StartingLsn = (UINT64)ExtentAd->ExtentLocation;
92 EndingLsn = StartingLsn + DivU64x32 (
93 (UINT64)ExtentAd->ExtentLength,
94 BlockSize
95 );
96
97 Volume->LogicalVolDescs =
98 (UDF_LOGICAL_VOLUME_DESCRIPTOR **)AllocateZeroPool (ExtentAd->ExtentLength);
99 if (Volume->LogicalVolDescs == NULL) {
100 return EFI_OUT_OF_RESOURCES;
101 }
102
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;
108 }
109
110 Buffer = AllocateZeroPool (BlockSize);
111 if (Buffer == NULL) {
112 Status = EFI_OUT_OF_RESOURCES;
113 goto Error_Alloc_Buf;
114 }
115
116 Volume->LogicalVolDescsNo = 0;
117 Volume->PartitionDescsNo = 0;
118
119 while (StartingLsn <= EndingLsn) {
120 Status = DiskIo->ReadDisk (
121 DiskIo,
122 BlockIo->Media->MediaId,
123 MultU64x32 (StartingLsn, BlockSize),
124 BlockSize,
125 Buffer
126 );
127 if (EFI_ERROR (Status)) {
128 goto Error_Read_Disk_Blk;
129 }
130
131 if (IS_TD (Buffer)) {
132 //
133 // Found a Terminating Descriptor. Stop the sequence then.
134 //
135 break;
136 }
137
138 if (IS_LVD (Buffer)) {
139 //
140 // Found a Logical Volume Descriptor.
141 //
142 LogicalVolDesc =
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;
148 }
149
150 CopyMem ((VOID *)LogicalVolDesc, Buffer,
151 sizeof (UDF_LOGICAL_VOLUME_DESCRIPTOR));
152 Volume->LogicalVolDescs[Volume->LogicalVolDescsNo++] = LogicalVolDesc;
153 } else if (IS_PD (Buffer)) {
154 //
155 // Found a Partition Descriptor.
156 //
157 PartitionDesc =
158 (UDF_PARTITION_DESCRIPTOR *)
159 AllocateZeroPool (sizeof (UDF_PARTITION_DESCRIPTOR));
160 if (PartitionDesc == NULL) {
161 Status = EFI_OUT_OF_RESOURCES;
162 goto Error_Alloc_Pd;
163 }
164
165 CopyMem ((VOID *)PartitionDesc, Buffer,
166 sizeof (UDF_PARTITION_DESCRIPTOR));
167 Volume->PartitionDescs[Volume->PartitionDescsNo++] = PartitionDesc;
168 }
169
170 StartingLsn++;
171 }
172
173 //
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.
178 //
179 LogicalBlockSize = LV_BLOCK_SIZE (Volume, UDF_DEFAULT_LV_NUM);
180 if (LogicalBlockSize >= UDF_LOGICAL_SECTOR_SIZE) {
181 Volume->FileEntrySize = LogicalBlockSize;
182 } else {
183 Volume->FileEntrySize = UDF_LOGICAL_SECTOR_SIZE;
184 }
185
186 FreePool (Buffer);
187
188 return EFI_SUCCESS;
189
190 Error_Alloc_Pd:
191 Error_Alloc_Lvd:
192 for (Index = 0; Index < Volume->PartitionDescsNo; Index++) {
193 FreePool ((VOID *)Volume->PartitionDescs[Index]);
194 }
195
196 for (Index = 0; Index < Volume->LogicalVolDescsNo; Index++) {
197 FreePool ((VOID *)Volume->LogicalVolDescs[Index]);
198 }
199
200 Error_Read_Disk_Blk:
201 FreePool (Buffer);
202
203 Error_Alloc_Buf:
204 FreePool ((VOID *)Volume->PartitionDescs);
205 Volume->PartitionDescs = NULL;
206
207 Error_Alloc_Pds:
208 FreePool ((VOID *)Volume->LogicalVolDescs);
209 Volume->LogicalVolDescs = NULL;
210
211 return Status;
212 }
213
214 //
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.
218 //
219 UDF_PARTITION_DESCRIPTOR *
220 GetPdFromLongAd (
221 IN UDF_VOLUME_INFO *Volume,
222 IN UDF_LONG_ALLOCATION_DESCRIPTOR *LongAd
223 )
224 {
225 UDF_LOGICAL_VOLUME_DESCRIPTOR *LogicalVolDesc;
226 UINTN Index;
227 UDF_PARTITION_DESCRIPTOR *PartitionDesc;
228 UINT16 PartitionNum;
229
230 LogicalVolDesc = Volume->LogicalVolDescs[UDF_DEFAULT_LV_NUM];
231
232 switch (LV_UDF_REVISION (LogicalVolDesc)) {
233 case 0x0102:
234 //
235 // As per UDF 1.02 specification:
236 //
237 // There shall be exactly one prevailing Logical Volume Descriptor recorded
238 // per Volume Set. The Partition Maps field shall contain only Type 1
239 // Partition Maps.
240 //
241 PartitionNum = *(UINT16 *)((UINTN)&LogicalVolDesc->PartitionMaps[4]);
242 break;
243 case 0x0150:
244 //
245 // Ensure Type 1 Partition map. Other types aren't supported in this
246 // implementation.
247 //
248 if (LogicalVolDesc->PartitionMaps[0] != 1 ||
249 LogicalVolDesc->PartitionMaps[1] != 6) {
250 return NULL;
251 }
252 PartitionNum = *(UINT16 *)((UINTN)&LogicalVolDesc->PartitionMaps[4]);
253 break;
254 case 0x0260:
255 //
256 // Fall through.
257 //
258 default:
259 PartitionNum = LongAd->ExtentLocation.PartitionReferenceNumber;
260 break;
261 }
262
263 for (Index = 0; Index < Volume->PartitionDescsNo; Index++) {
264 PartitionDesc = Volume->PartitionDescs[Index];
265 if (PartitionDesc->PartitionNumber == PartitionNum) {
266 return PartitionDesc;
267 }
268 }
269
270 return NULL;
271 }
272
273 //
274 // Return logical sector number of a given Long Allocation Descriptor.
275 //
276 UINT64
277 GetLongAdLsn (
278 IN UDF_VOLUME_INFO *Volume,
279 IN UDF_LONG_ALLOCATION_DESCRIPTOR *LongAd
280 )
281 {
282 UDF_PARTITION_DESCRIPTOR *PartitionDesc;
283
284 PartitionDesc = GetPdFromLongAd (Volume, LongAd);
285 ASSERT (PartitionDesc != NULL);
286
287 return (UINT64)PartitionDesc->PartitionStartingLocation +
288 LongAd->ExtentLocation.LogicalBlockNumber;
289 }
290
291 //
292 // Return logical sector number of a given Short Allocation Descriptor.
293 //
294 UINT64
295 GetShortAdLsn (
296 IN UDF_PARTITION_DESCRIPTOR *PartitionDesc,
297 IN UDF_SHORT_ALLOCATION_DESCRIPTOR *ShortAd
298 )
299 {
300 return (UINT64)PartitionDesc->PartitionStartingLocation +
301 ShortAd->ExtentPosition;
302 }
303
304 //
305 // Find File Set Descriptor of a given Logical Volume Descriptor.
306 //
307 // The found FSD will contain the extent (LogicalVolumeContentsUse) where our
308 // root directory is.
309 //
310 EFI_STATUS
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
317 )
318 {
319 EFI_STATUS Status;
320 UINT64 Lsn;
321 UDF_LOGICAL_VOLUME_DESCRIPTOR *LogicalVolDesc;
322
323 LogicalVolDesc = Volume->LogicalVolDescs[LogicalVolDescNum];
324 Lsn = GetLongAdLsn (Volume, &LogicalVolDesc->LogicalVolumeContentsUse);
325
326 //
327 // Read extent (Long Ad).
328 //
329 Status = DiskIo->ReadDisk (
330 DiskIo,
331 BlockIo->Media->MediaId,
332 MultU64x32 (Lsn, LogicalVolDesc->LogicalBlockSize),
333 sizeof (UDF_FILE_SET_DESCRIPTOR),
334 (VOID *)FileSetDesc
335 );
336 if (EFI_ERROR (Status)) {
337 return Status;
338 }
339
340 //
341 // Check if the read extent contains a valid FSD's tag identifier.
342 //
343 if (!IS_FSD (FileSetDesc)) {
344 return EFI_VOLUME_CORRUPTED;
345 }
346
347 return EFI_SUCCESS;
348 }
349
350 //
351 // Get all File Set Descriptors for each Logical Volume Descriptor.
352 //
353 EFI_STATUS
354 GetFileSetDescriptors (
355 IN EFI_BLOCK_IO_PROTOCOL *BlockIo,
356 IN EFI_DISK_IO_PROTOCOL *DiskIo,
357 IN OUT UDF_VOLUME_INFO *Volume
358 )
359 {
360 EFI_STATUS Status;
361 UINTN Index;
362 UDF_FILE_SET_DESCRIPTOR *FileSetDesc;
363 UINTN Count;
364
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;
370 }
371
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;
377 }
378
379 //
380 // Find a FSD for this LVD.
381 //
382 Status = FindFileSetDescriptor (
383 BlockIo,
384 DiskIo,
385 Volume,
386 Index,
387 FileSetDesc
388 );
389 if (EFI_ERROR (Status)) {
390 goto Error_Find_Fsd;
391 }
392
393 //
394 // Got one. Save it.
395 //
396 Volume->FileSetDescs[Index] = FileSetDesc;
397 }
398
399 Volume->FileSetDescsNo = Volume->LogicalVolDescsNo;
400 return EFI_SUCCESS;
401
402 Error_Find_Fsd:
403 Count = Index + 1;
404 for (Index = 0; Index < Count; Index++) {
405 FreePool ((VOID *)Volume->FileSetDescs[Index]);
406 }
407
408 FreePool ((VOID *)Volume->FileSetDescs);
409 Volume->FileSetDescs = NULL;
410
411 Error_Alloc_Fsd:
412 return Status;
413 }
414
415 //
416 // Read Volume and File Structure on an UDF file system.
417 //
418 EFI_STATUS
419 ReadVolumeFileStructure (
420 IN EFI_BLOCK_IO_PROTOCOL *BlockIo,
421 IN EFI_DISK_IO_PROTOCOL *DiskIo,
422 OUT UDF_VOLUME_INFO *Volume
423 )
424 {
425 EFI_STATUS Status;
426 UDF_ANCHOR_VOLUME_DESCRIPTOR_POINTER AnchorPoint;
427
428 //
429 // Find an AVDP.
430 //
431 Status = FindAnchorVolumeDescriptorPointer (
432 BlockIo,
433 DiskIo,
434 &AnchorPoint
435 );
436 if (EFI_ERROR (Status)) {
437 return Status;
438 }
439
440 //
441 // AVDP has been found. Start MVDS.
442 //
443 Status = StartMainVolumeDescriptorSequence (
444 BlockIo,
445 DiskIo,
446 &AnchorPoint,
447 Volume
448 );
449 if (EFI_ERROR (Status)) {
450 return Status;
451 }
452
453 return Status;
454 }
455
456 //
457 // Calculate length of a given File Identifier Descriptor.
458 //
459 UINT64
460 GetFidDescriptorLength (
461 IN UDF_FILE_IDENTIFIER_DESCRIPTOR *FileIdentifierDesc
462 )
463 {
464 return (UINT64)(
465 (INTN)((OFFSET_OF (UDF_FILE_IDENTIFIER_DESCRIPTOR, Data[0]) + 3 +
466 FileIdentifierDesc->LengthOfFileIdentifier +
467 FileIdentifierDesc->LengthOfImplementationUse) >> 2) << 2
468 );
469 }
470
471 //
472 // Duplicate a given File Identifier Descriptor.
473 //
474 VOID
475 DuplicateFid (
476 IN UDF_FILE_IDENTIFIER_DESCRIPTOR *FileIdentifierDesc,
477 OUT UDF_FILE_IDENTIFIER_DESCRIPTOR **NewFileIdentifierDesc
478 )
479 {
480 *NewFileIdentifierDesc =
481 (UDF_FILE_IDENTIFIER_DESCRIPTOR *)AllocateCopyPool (
482 (UINTN) GetFidDescriptorLength (FileIdentifierDesc), FileIdentifierDesc);
483 }
484
485 //
486 // Duplicate either a given File Entry or a given Extended File Entry.
487 //
488 VOID
489 DuplicateFe (
490 IN EFI_BLOCK_IO_PROTOCOL *BlockIo,
491 IN UDF_VOLUME_INFO *Volume,
492 IN VOID *FileEntry,
493 OUT VOID **NewFileEntry
494 )
495 {
496 *NewFileEntry = AllocateCopyPool (Volume->FileEntrySize, FileEntry);
497 }
498
499 //
500 // Get raw data + length of a given File Entry or Extended File Entry.
501 //
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.
505 //
506 // NOTE: The FE/EFE can be thought it was an inode.
507 //
508 VOID
509 GetFileEntryData (
510 IN VOID *FileEntryData,
511 OUT VOID **Data,
512 OUT UINT64 *Length
513 )
514 {
515 UDF_EXTENDED_FILE_ENTRY *ExtendedFileEntry;
516 UDF_FILE_ENTRY *FileEntry;
517
518 if (IS_EFE (FileEntryData)) {
519 ExtendedFileEntry = (UDF_EXTENDED_FILE_ENTRY *)FileEntryData;
520
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;
526
527 *Length = FileEntry->InformationLength;
528 *Data = (VOID *)((UINT8 *)FileEntry->Data +
529 FileEntry->LengthOfExtendedAttributes);
530 }
531 }
532
533 //
534 // Get Allocation Descriptors' data information from a given FE/EFE.
535 //
536 VOID
537 GetAdsInformation (
538 IN VOID *FileEntryData,
539 OUT VOID **AdsData,
540 OUT UINT64 *Length
541 )
542 {
543 UDF_EXTENDED_FILE_ENTRY *ExtendedFileEntry;
544 UDF_FILE_ENTRY *FileEntry;
545
546 if (IS_EFE (FileEntryData)) {
547 ExtendedFileEntry = (UDF_EXTENDED_FILE_ENTRY *)FileEntryData;
548
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;
554
555 *Length = FileEntry->LengthOfAllocationDescriptors;
556 *AdsData = (VOID *)((UINT8 *)FileEntry->Data +
557 FileEntry->LengthOfExtendedAttributes);
558 }
559 }
560
561 //
562 // Read next Long Allocation Descriptor from a given file's data.
563 //
564 EFI_STATUS
565 GetLongAdFromAds (
566 IN VOID *Data,
567 IN OUT UINT64 *Offset,
568 IN UINT64 Length,
569 OUT UDF_LONG_ALLOCATION_DESCRIPTOR **FoundLongAd
570 )
571 {
572 UDF_LONG_ALLOCATION_DESCRIPTOR *LongAd;
573 UDF_EXTENT_FLAGS ExtentFlags;
574
575 for (;;) {
576 if (*Offset >= Length) {
577 //
578 // No more Long Allocation Descriptors.
579 //
580 return EFI_DEVICE_ERROR;
581 }
582
583 LongAd =
584 (UDF_LONG_ALLOCATION_DESCRIPTOR *)((UINT8 *)Data + *Offset);
585
586 //
587 // If it's either an indirect AD (Extended Alllocation Descriptor) or an
588 // allocated AD, then return it.
589 //
590 ExtentFlags = GET_EXTENT_FLAGS (LONG_ADS_SEQUENCE, LongAd);
591 if (ExtentFlags == EXTENT_IS_NEXT_EXTENT ||
592 ExtentFlags == EXTENT_RECORDED_AND_ALLOCATED) {
593 break;
594 }
595
596 //
597 // This AD is either not recorded but allocated, or not recorded and not
598 // allocated. Skip it.
599 //
600 *Offset += AD_LENGTH (LONG_ADS_SEQUENCE);
601 }
602
603 *FoundLongAd = LongAd;
604
605 return EFI_SUCCESS;
606 }
607
608 //
609 // Read next Short Allocation Descriptor from a given file's data.
610 //
611 EFI_STATUS
612 GetShortAdFromAds (
613 IN VOID *Data,
614 IN OUT UINT64 *Offset,
615 IN UINT64 Length,
616 OUT UDF_SHORT_ALLOCATION_DESCRIPTOR **FoundShortAd
617 )
618 {
619 UDF_SHORT_ALLOCATION_DESCRIPTOR *ShortAd;
620 UDF_EXTENT_FLAGS ExtentFlags;
621
622 for (;;) {
623 if (*Offset >= Length) {
624 //
625 // No more Short Allocation Descriptors.
626 //
627 return EFI_DEVICE_ERROR;
628 }
629
630 ShortAd =
631 (UDF_SHORT_ALLOCATION_DESCRIPTOR *)((UINT8 *)Data + *Offset);
632
633 //
634 // If it's either an indirect AD (Extended Alllocation Descriptor) or an
635 // allocated AD, then return it.
636 //
637 ExtentFlags = GET_EXTENT_FLAGS (SHORT_ADS_SEQUENCE, ShortAd);
638 if (ExtentFlags == EXTENT_IS_NEXT_EXTENT ||
639 ExtentFlags == EXTENT_RECORDED_AND_ALLOCATED) {
640 break;
641 }
642
643 //
644 // This AD is either not recorded but allocated, or not recorded and not
645 // allocated. Skip it.
646 //
647 *Offset += AD_LENGTH (SHORT_ADS_SEQUENCE);
648 }
649
650 *FoundShortAd = ShortAd;
651
652 return EFI_SUCCESS;
653 }
654
655 //
656 // Get either a Short Allocation Descriptor or a Long Allocation Descriptor from
657 // file's data.
658 //
659 EFI_STATUS
660 GetAllocationDescriptor (
661 IN UDF_FE_RECORDING_FLAGS RecordingFlags,
662 IN VOID *Data,
663 IN OUT UINT64 *Offset,
664 IN UINT64 Length,
665 OUT VOID **FoundAd
666 )
667 {
668 if (RecordingFlags == LONG_ADS_SEQUENCE) {
669 return GetLongAdFromAds (
670 Data,
671 Offset,
672 Length,
673 (UDF_LONG_ALLOCATION_DESCRIPTOR **)FoundAd
674 );
675 } else if (RecordingFlags == SHORT_ADS_SEQUENCE) {
676 return GetShortAdFromAds (
677 Data,
678 Offset,
679 Length,
680 (UDF_SHORT_ALLOCATION_DESCRIPTOR **)FoundAd
681 );
682 }
683
684 return EFI_DEVICE_ERROR;
685 }
686
687 //
688 // Return logical sector number of either Short or Long Allocation Descriptor.
689 //
690 UINT64
691 GetAllocationDescriptorLsn (
692 IN UDF_FE_RECORDING_FLAGS RecordingFlags,
693 IN UDF_VOLUME_INFO *Volume,
694 IN UDF_LONG_ALLOCATION_DESCRIPTOR *ParentIcb,
695 IN VOID *Ad
696 )
697 {
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
704 );
705 }
706
707 return 0;
708 }
709
710 //
711 // Return offset + length of a given indirect Allocation Descriptor (AED).
712 //
713 EFI_STATUS
714 GetAedAdsOffset (
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,
720 IN VOID *Ad,
721 OUT UINT64 *Offset,
722 OUT UINT64 *Length
723 )
724 {
725 EFI_STATUS Status;
726 UINT32 ExtentLength;
727 UINT64 Lsn;
728 VOID *Data;
729 UINT32 LogicalBlockSize;
730 UDF_ALLOCATION_EXTENT_DESCRIPTOR *AllocExtDesc;
731
732 ExtentLength = GET_EXTENT_LENGTH (RecordingFlags, Ad);
733 Lsn = GetAllocationDescriptorLsn (RecordingFlags,
734 Volume,
735 ParentIcb,
736 Ad);
737
738 Data = AllocatePool (ExtentLength);
739 if (Data == NULL) {
740 return EFI_OUT_OF_RESOURCES;
741 }
742
743 LogicalBlockSize = LV_BLOCK_SIZE (Volume, UDF_DEFAULT_LV_NUM);
744
745 //
746 // Read extent.
747 //
748 Status = DiskIo->ReadDisk (
749 DiskIo,
750 BlockIo->Media->MediaId,
751 MultU64x32 (Lsn, LogicalBlockSize),
752 ExtentLength,
753 Data
754 );
755 if (EFI_ERROR (Status)) {
756 goto Exit;
757 }
758
759 //
760 // Check if read extent contains a valid tag identifier for AED.
761 //
762 AllocExtDesc = (UDF_ALLOCATION_EXTENT_DESCRIPTOR *)Data;
763 if (!IS_AED (AllocExtDesc)) {
764 Status = EFI_VOLUME_CORRUPTED;
765 goto Exit;
766 }
767
768 //
769 // Get AED's block offset and its length.
770 //
771 *Offset = MultU64x32 (Lsn, LogicalBlockSize) +
772 sizeof (UDF_ALLOCATION_EXTENT_DESCRIPTOR);
773 *Length = AllocExtDesc->LengthOfAllocationDescriptors;
774
775 Exit:
776 FreePool (Data);
777
778 return Status;
779 }
780
781 //
782 // Read Allocation Extent Descriptor into memory.
783 //
784 EFI_STATUS
785 GetAedAdsData (
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,
791 IN VOID *Ad,
792 OUT VOID **Data,
793 OUT UINT64 *Length
794 )
795 {
796 EFI_STATUS Status;
797 UINT64 Offset;
798
799 //
800 // Get AED's offset + length.
801 //
802 Status = GetAedAdsOffset (
803 BlockIo,
804 DiskIo,
805 Volume,
806 ParentIcb,
807 RecordingFlags,
808 Ad,
809 &Offset,
810 Length
811 );
812 if (EFI_ERROR (Status)) {
813 return Status;
814 }
815
816 //
817 // Allocate buffer to read in AED's data.
818 //
819 *Data = AllocatePool ((UINTN) (*Length));
820 if (*Data == NULL) {
821 return EFI_OUT_OF_RESOURCES;
822 }
823
824 return DiskIo->ReadDisk (
825 DiskIo,
826 BlockIo->Media->MediaId,
827 Offset,
828 (UINTN) (*Length),
829 *Data
830 );
831 }
832
833 //
834 // Function used to serialise reads of Allocation Descriptors.
835 //
836 EFI_STATUS
837 GrowUpBufferToNextAd (
838 IN UDF_FE_RECORDING_FLAGS RecordingFlags,
839 IN VOID *Ad,
840 IN OUT VOID **Buffer,
841 IN UINT64 Length
842 )
843 {
844 UINT32 ExtentLength;
845
846 ExtentLength = GET_EXTENT_LENGTH (RecordingFlags, Ad);
847
848 if (*Buffer == NULL) {
849 *Buffer = AllocatePool (ExtentLength);
850 if (*Buffer == NULL) {
851 return EFI_OUT_OF_RESOURCES;
852 }
853 } else {
854 *Buffer = ReallocatePool ((UINTN) Length, (UINTN) (Length + ExtentLength), *Buffer);
855 if (*Buffer == NULL) {
856 return EFI_OUT_OF_RESOURCES;
857 }
858 }
859
860 return EFI_SUCCESS;
861 }
862
863 //
864 // Read data or size of either a File Entry or an Extended File Entry.
865 //
866 EFI_STATUS
867 ReadFile (
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
874 )
875 {
876 EFI_STATUS Status;
877 UINT32 LogicalBlockSize;
878 VOID *Data;
879 UINT64 Length;
880 VOID *Ad;
881 UINT64 AdOffset;
882 UINT64 Lsn;
883 BOOLEAN DoFreeAed;
884 UINT64 FilePosition;
885 UINT64 Offset;
886 UINT64 DataOffset;
887 UINT64 BytesLeft;
888 UINT64 DataLength;
889 BOOLEAN FinishedSeeking;
890 UINT32 ExtentLength;
891 UDF_FE_RECORDING_FLAGS RecordingFlags;
892
893 LogicalBlockSize = LV_BLOCK_SIZE (Volume, UDF_DEFAULT_LV_NUM);
894 DoFreeAed = FALSE;
895
896 switch (ReadFileInfo->Flags) {
897 case READ_FILE_GET_FILESIZE:
898 case READ_FILE_ALLOCATE_AND_READ:
899 //
900 // Initialise ReadFileInfo structure for either getting file size, or
901 // reading file's recorded data.
902 //
903 ReadFileInfo->ReadLength = 0;
904 ReadFileInfo->FileData = NULL;
905 break;
906 case READ_FILE_SEEK_AND_READ:
907 //
908 // About to seek a file and/or read its data.
909 //
910 Length = ReadFileInfo->FileSize - ReadFileInfo->FilePosition;
911 if (ReadFileInfo->FileDataSize > Length) {
912 //
913 // About to read beyond the EOF -- truncate it.
914 //
915 ReadFileInfo->FileDataSize = Length;
916 }
917
918 //
919 // Initialise data to start seeking and/or reading a file.
920 //
921 BytesLeft = ReadFileInfo->FileDataSize;
922 DataOffset = 0;
923 FilePosition = 0;
924 FinishedSeeking = FALSE;
925
926 break;
927 }
928
929 RecordingFlags = GET_FE_RECORDING_FLAGS (FileEntryData);
930 switch (RecordingFlags) {
931 case INLINE_DATA:
932 //
933 // There are no extents for this FE/EFE. All data is inline.
934 //
935 GetFileEntryData (FileEntryData, &Data, &Length);
936
937 if (ReadFileInfo->Flags == READ_FILE_GET_FILESIZE) {
938 ReadFileInfo->ReadLength = Length;
939 } else if (ReadFileInfo->Flags == READ_FILE_ALLOCATE_AND_READ) {
940 //
941 // Allocate buffer for starting read data.
942 //
943 ReadFileInfo->FileData = AllocatePool ((UINTN) Length);
944 if (ReadFileInfo->FileData == NULL) {
945 return EFI_OUT_OF_RESOURCES;
946 }
947
948 //
949 // Read all inline data into ReadFileInfo->FileData
950 //
951 CopyMem (ReadFileInfo->FileData, Data, (UINTN) Length);
952 ReadFileInfo->ReadLength = Length;
953 } else if (ReadFileInfo->Flags == READ_FILE_SEEK_AND_READ) {
954 //
955 // If FilePosition is non-zero, seek file to FilePosition, read
956 // FileDataSize bytes and then updates FilePosition.
957 //
958 CopyMem (
959 ReadFileInfo->FileData,
960 (VOID *)((UINT8 *)Data + ReadFileInfo->FilePosition),
961 (UINTN) ReadFileInfo->FileDataSize
962 );
963
964 ReadFileInfo->FilePosition += ReadFileInfo->FileDataSize;
965 } else {
966 ASSERT (FALSE);
967 return EFI_INVALID_PARAMETER;
968 }
969
970 break;
971 case LONG_ADS_SEQUENCE:
972 case SHORT_ADS_SEQUENCE:
973 //
974 // This FE/EFE contains a run of Allocation Descriptors. Get data + size
975 // for start reading them out.
976 //
977 GetAdsInformation (FileEntryData, &Data, &Length);
978 AdOffset = 0;
979
980 for (;;) {
981 //
982 // Read AD.
983 //
984 Status = GetAllocationDescriptor (
985 RecordingFlags,
986 Data,
987 &AdOffset,
988 Length,
989 &Ad
990 );
991 if (Status == EFI_DEVICE_ERROR) {
992 Status = EFI_SUCCESS;
993 goto Done;
994 }
995
996 //
997 // Check if AD is an indirect AD. If so, read Allocation Extent
998 // Descriptor and its extents (ADs).
999 //
1000 if (GET_EXTENT_FLAGS (RecordingFlags, Ad) == EXTENT_IS_NEXT_EXTENT) {
1001 if (!DoFreeAed) {
1002 DoFreeAed = TRUE;
1003 } else {
1004 FreePool (Data);
1005 }
1006
1007 Status = GetAedAdsData (
1008 BlockIo,
1009 DiskIo,
1010 Volume,
1011 ParentIcb,
1012 RecordingFlags,
1013 Ad,
1014 &Data,
1015 &Length
1016 );
1017 if (EFI_ERROR (Status)) {
1018 goto Error_Get_Aed;
1019 }
1020
1021 AdOffset = 0;
1022 continue;
1023 }
1024
1025 ExtentLength = GET_EXTENT_LENGTH (RecordingFlags, Ad);
1026
1027 Lsn = GetAllocationDescriptorLsn (RecordingFlags,
1028 Volume,
1029 ParentIcb,
1030 Ad);
1031
1032 switch (ReadFileInfo->Flags) {
1033 case READ_FILE_GET_FILESIZE:
1034 ReadFileInfo->ReadLength += ExtentLength;
1035 break;
1036 case READ_FILE_ALLOCATE_AND_READ:
1037 //
1038 // Increase FileData (if necessary) to read next extent.
1039 //
1040 Status = GrowUpBufferToNextAd (
1041 RecordingFlags,
1042 Ad,
1043 &ReadFileInfo->FileData,
1044 ReadFileInfo->ReadLength
1045 );
1046 if (EFI_ERROR (Status)) {
1047 goto Error_Alloc_Buffer_To_Next_Ad;
1048 }
1049
1050 //
1051 // Read extent's data into FileData.
1052 //
1053 Status = DiskIo->ReadDisk (
1054 DiskIo,
1055 BlockIo->Media->MediaId,
1056 MultU64x32 (Lsn, LogicalBlockSize),
1057 ExtentLength,
1058 (VOID *)((UINT8 *)ReadFileInfo->FileData +
1059 ReadFileInfo->ReadLength)
1060 );
1061 if (EFI_ERROR (Status)) {
1062 goto Error_Read_Disk_Blk;
1063 }
1064
1065 ReadFileInfo->ReadLength += ExtentLength;
1066 break;
1067 case READ_FILE_SEEK_AND_READ:
1068 //
1069 // Seek file first before reading in its data.
1070 //
1071 if (FinishedSeeking) {
1072 Offset = 0;
1073 goto Skip_File_Seek;
1074 }
1075
1076 if (FilePosition + ExtentLength < ReadFileInfo->FilePosition) {
1077 FilePosition += ExtentLength;
1078 goto Skip_Ad;
1079 }
1080
1081 if (FilePosition + ExtentLength > ReadFileInfo->FilePosition) {
1082 Offset = ReadFileInfo->FilePosition - FilePosition;
1083 if (Offset < 0) {
1084 Offset = -(Offset);
1085 }
1086 } else {
1087 Offset = 0;
1088 }
1089
1090 //
1091 // Done with seeking file. Start reading its data.
1092 //
1093 FinishedSeeking = TRUE;
1094
1095 Skip_File_Seek:
1096 //
1097 // Make sure we don't read more data than really wanted.
1098 //
1099 if (ExtentLength - Offset > BytesLeft) {
1100 DataLength = BytesLeft;
1101 } else {
1102 DataLength = ExtentLength - Offset;
1103 }
1104
1105 //
1106 // Read extent's data into FileData.
1107 //
1108 Status = DiskIo->ReadDisk (
1109 DiskIo,
1110 BlockIo->Media->MediaId,
1111 Offset + MultU64x32 (Lsn, LogicalBlockSize),
1112 (UINTN) DataLength,
1113 (VOID *)((UINT8 *)ReadFileInfo->FileData +
1114 DataOffset)
1115 );
1116 if (EFI_ERROR (Status)) {
1117 goto Error_Read_Disk_Blk;
1118 }
1119
1120 //
1121 // Update current file's position.
1122 //
1123 DataOffset += DataLength;
1124 ReadFileInfo->FilePosition += DataLength;
1125
1126 BytesLeft -= DataLength;
1127 if (BytesLeft == 0) {
1128 //
1129 // There is no more file data to read.
1130 //
1131 Status = EFI_SUCCESS;
1132 goto Done;
1133 }
1134
1135 break;
1136 }
1137
1138 Skip_Ad:
1139 //
1140 // Point to the next AD (extent).
1141 //
1142 AdOffset += AD_LENGTH (RecordingFlags);
1143 }
1144
1145 break;
1146 case EXTENDED_ADS_SEQUENCE:
1147 // FIXME: Not supported. Got no volume with it, yet.
1148 ASSERT (FALSE);
1149 Status = EFI_UNSUPPORTED;
1150 break;
1151 }
1152
1153 Done:
1154 if (DoFreeAed) {
1155 FreePool (Data);
1156 }
1157
1158 return Status;
1159
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);
1164 }
1165
1166 if (DoFreeAed) {
1167 FreePool (Data);
1168 }
1169
1170 Error_Get_Aed:
1171 return Status;
1172 }
1173
1174 //
1175 // Find a file by its filename from a given Parent file.
1176 //
1177 EFI_STATUS
1178 InternalFindFile (
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
1186 )
1187 {
1188 EFI_STATUS Status;
1189 UDF_FILE_IDENTIFIER_DESCRIPTOR *FileIdentifierDesc;
1190 UDF_READ_DIRECTORY_INFO ReadDirInfo;
1191 BOOLEAN Found;
1192 CHAR16 FoundFileName[UDF_FILENAME_LENGTH];
1193 VOID *CompareFileEntry;
1194
1195 //
1196 // Check if parent file is really directory.
1197 //
1198 if (!IS_FE_DIRECTORY (Parent->FileEntry)) {
1199 return EFI_NOT_FOUND;
1200 }
1201
1202 //
1203 // If FileName is current file or working directory, just duplicate Parent's
1204 // FE/EFE and FID descriptors.
1205 //
1206 if (StrCmp (FileName, L".") == 0) {
1207 DuplicateFe (BlockIo, Volume, Parent->FileEntry, &File->FileEntry);
1208 DuplicateFid (Parent->FileIdentifierDesc, &File->FileIdentifierDesc);
1209
1210 return EFI_SUCCESS;
1211 }
1212
1213 //
1214 // Start directory listing.
1215 //
1216 ZeroMem ((VOID *)&ReadDirInfo, sizeof (UDF_READ_DIRECTORY_INFO));
1217 Found = FALSE;
1218
1219 for (;;) {
1220 Status = ReadDirectoryEntry (
1221 BlockIo,
1222 DiskIo,
1223 Volume,
1224 Parent->FileIdentifierDesc ?
1225 &Parent->FileIdentifierDesc->Icb :
1226 Icb,
1227 Parent->FileEntry,
1228 &ReadDirInfo,
1229 &FileIdentifierDesc
1230 );
1231 if (EFI_ERROR (Status)) {
1232 if (Status == EFI_DEVICE_ERROR) {
1233 Status = EFI_NOT_FOUND;
1234 }
1235
1236 break;
1237 }
1238
1239 if (IS_FID_PARENT_FILE (FileIdentifierDesc)) {
1240 //
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.
1244 //
1245 if (StrCmp (FileName, L"..") == 0 || StrCmp (FileName, L"\\") == 0) {
1246 Found = TRUE;
1247 break;
1248 }
1249 } else {
1250 Status = GetFileNameFromFid (FileIdentifierDesc, FoundFileName);
1251 if (EFI_ERROR (Status)) {
1252 break;
1253 }
1254
1255 if (StrCmp (FileName, FoundFileName) == 0) {
1256 //
1257 // FID has been found. Prepare to find its respective FE/EFE.
1258 //
1259 Found = TRUE;
1260 break;
1261 }
1262 }
1263
1264 FreePool ((VOID *)FileIdentifierDesc);
1265 }
1266
1267 if (ReadDirInfo.DirectoryData != NULL) {
1268 //
1269 // Free all allocated resources for the directory listing.
1270 //
1271 FreePool (ReadDirInfo.DirectoryData);
1272 }
1273
1274 if (Found) {
1275 Status = EFI_SUCCESS;
1276
1277 File->FileIdentifierDesc = FileIdentifierDesc;
1278
1279 //
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.
1282 //
1283 // Otherwise, find FE/EFE from the respective FID.
1284 //
1285 if (StrCmp (FileName, L"\\") != 0) {
1286 Status = FindFileEntry (
1287 BlockIo,
1288 DiskIo,
1289 Volume,
1290 &FileIdentifierDesc->Icb,
1291 &CompareFileEntry
1292 );
1293 if (EFI_ERROR (Status)) {
1294 goto Error_Find_Fe;
1295 }
1296
1297 //
1298 // Make sure that both Parent's FE/EFE and found FE/EFE are not equal.
1299 //
1300 if (CompareMem ((VOID *)Parent->FileEntry, (VOID *)CompareFileEntry,
1301 Volume->FileEntrySize) != 0) {
1302 File->FileEntry = CompareFileEntry;
1303 } else {
1304 FreePool ((VOID *)FileIdentifierDesc);
1305 FreePool ((VOID *)CompareFileEntry);
1306 Status = EFI_NOT_FOUND;
1307 }
1308 }
1309 }
1310
1311 return Status;
1312
1313 Error_Find_Fe:
1314 FreePool ((VOID *)FileIdentifierDesc);
1315
1316 return Status;
1317 }
1318
1319 /**
1320 Read volume information on a medium which contains a valid UDF file system.
1321
1322 @param[in] BlockIo BlockIo interface.
1323 @param[in] DiskIo DiskIo interface.
1324 @param[out] Volume UDF volume information structure.
1325
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.
1331
1332 **/
1333 EFI_STATUS
1334 ReadUdfVolumeInformation (
1335 IN EFI_BLOCK_IO_PROTOCOL *BlockIo,
1336 IN EFI_DISK_IO_PROTOCOL *DiskIo,
1337 OUT UDF_VOLUME_INFO *Volume
1338 )
1339 {
1340 EFI_STATUS Status;
1341
1342 Status = ReadVolumeFileStructure (
1343 BlockIo,
1344 DiskIo,
1345 Volume
1346 );
1347 if (EFI_ERROR (Status)) {
1348 return Status;
1349 }
1350
1351 Status = GetFileSetDescriptors (
1352 BlockIo,
1353 DiskIo,
1354 Volume
1355 );
1356 if (EFI_ERROR (Status)) {
1357 CleanupVolumeInformation (Volume);
1358 }
1359
1360 return Status;
1361 }
1362
1363 /**
1364 Find the root directory on an UDF volume.
1365
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.
1370
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
1376 resources.
1377
1378 **/
1379 EFI_STATUS
1380 FindRootDirectory (
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
1385 )
1386 {
1387 EFI_STATUS Status;
1388 UDF_FILE_INFO Parent;
1389
1390 Status = FindFileEntry (
1391 BlockIo,
1392 DiskIo,
1393 Volume,
1394 &Volume->FileSetDescs[0]->RootDirectoryIcb,
1395 &File->FileEntry
1396 );
1397 if (EFI_ERROR (Status)) {
1398 return Status;
1399 }
1400
1401 Parent.FileEntry = File->FileEntry;
1402 Parent.FileIdentifierDesc = NULL;
1403
1404 Status = FindFile (
1405 BlockIo,
1406 DiskIo,
1407 Volume,
1408 L"\\",
1409 NULL,
1410 &Parent,
1411 &Volume->FileSetDescs[0]->RootDirectoryIcb,
1412 File
1413 );
1414 if (EFI_ERROR (Status)) {
1415 FreePool (File->FileEntry);
1416 }
1417
1418 return Status;
1419 }
1420
1421 /**
1422 Find either a File Entry or a Extended File Entry from a given ICB.
1423
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.
1429
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
1435 resources.
1436
1437 **/
1438 EFI_STATUS
1439 FindFileEntry (
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
1445 )
1446 {
1447 EFI_STATUS Status;
1448 UINT64 Lsn;
1449 UINT32 LogicalBlockSize;
1450
1451 Lsn = GetLongAdLsn (Volume, Icb);
1452 LogicalBlockSize = LV_BLOCK_SIZE (Volume, UDF_DEFAULT_LV_NUM);
1453
1454 *FileEntry = AllocateZeroPool (Volume->FileEntrySize);
1455 if (*FileEntry == NULL) {
1456 return EFI_OUT_OF_RESOURCES;
1457 }
1458
1459 //
1460 // Read extent.
1461 //
1462 Status = DiskIo->ReadDisk (
1463 DiskIo,
1464 BlockIo->Media->MediaId,
1465 MultU64x32 (Lsn, LogicalBlockSize),
1466 Volume->FileEntrySize,
1467 *FileEntry
1468 );
1469 if (EFI_ERROR (Status)) {
1470 goto Error_Read_Disk_Blk;
1471 }
1472
1473 //
1474 // Check if the read extent contains a valid Tag Identifier for the expected
1475 // FE/EFE.
1476 //
1477 if (!IS_FE (*FileEntry) && !IS_EFE (*FileEntry)) {
1478 Status = EFI_VOLUME_CORRUPTED;
1479 goto Error_Invalid_Fe;
1480 }
1481
1482 return EFI_SUCCESS;
1483
1484 Error_Invalid_Fe:
1485 Error_Read_Disk_Blk:
1486 FreePool (*FileEntry);
1487
1488 return Status;
1489 }
1490
1491 /**
1492 Find a file given its absolute path on an UDF volume.
1493
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.
1501
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
1507 resources.
1508
1509 **/
1510 EFI_STATUS
1511 FindFile (
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
1520 )
1521 {
1522 EFI_STATUS Status;
1523 CHAR16 FileName[UDF_FILENAME_LENGTH];
1524 CHAR16 *FileNamePointer;
1525 UDF_FILE_INFO PreviousFile;
1526 VOID *FileEntry;
1527
1528 Status = EFI_NOT_FOUND;
1529
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++;
1535 }
1536
1537 *FileNamePointer = L'\0';
1538 if (FileName[0] == L'\0') {
1539 //
1540 // Open root directory.
1541 //
1542 if (Root == NULL) {
1543 //
1544 // There is no file found for the root directory yet. So, find only its
1545 // FID by now.
1546 //
1547 // See UdfOpenVolume() function.
1548 //
1549 Status = InternalFindFile (BlockIo,
1550 DiskIo,
1551 Volume,
1552 L"\\",
1553 &PreviousFile,
1554 Icb,
1555 File);
1556 } else {
1557 //
1558 // We've already a file pointer (Root) for the root directory. Duplicate
1559 // its FE/EFE and FID descriptors.
1560 //
1561 DuplicateFe (BlockIo, Volume, Root->FileEntry, &File->FileEntry);
1562 DuplicateFid (Root->FileIdentifierDesc, &File->FileIdentifierDesc);
1563 Status = EFI_SUCCESS;
1564 }
1565 } else {
1566 //
1567 // No root directory. Find filename from the current directory.
1568 //
1569 Status = InternalFindFile (BlockIo,
1570 DiskIo,
1571 Volume,
1572 FileName,
1573 &PreviousFile,
1574 Icb,
1575 File);
1576 }
1577
1578 if (EFI_ERROR (Status)) {
1579 return Status;
1580 }
1581
1582 //
1583 // If the found file is a symlink, then find its respective FE/EFE and
1584 // FID descriptors.
1585 //
1586 if (IS_FE_SYMLINK (File->FileEntry)) {
1587 FreePool ((VOID *)File->FileIdentifierDesc);
1588
1589 FileEntry = File->FileEntry;
1590
1591 Status = ResolveSymlink (BlockIo,
1592 DiskIo,
1593 Volume,
1594 &PreviousFile,
1595 FileEntry,
1596 File);
1597
1598 FreePool (FileEntry);
1599
1600 if (EFI_ERROR (Status)) {
1601 return Status;
1602 }
1603 }
1604
1605 if (CompareMem ((VOID *)&PreviousFile, (VOID *)Parent,
1606 sizeof (UDF_FILE_INFO)) != 0) {
1607 CleanupFileInformation (&PreviousFile);
1608 }
1609
1610 CopyMem ((VOID *)&PreviousFile, (VOID *)File, sizeof (UDF_FILE_INFO));
1611 if (*FilePath != L'\0' && *FilePath == L'\\') {
1612 FilePath++;
1613 }
1614 }
1615
1616 return Status;
1617 }
1618
1619 /**
1620 Read a directory entry at a time on an UDF volume.
1621
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
1628 information.
1629 @param[out] FoundFid File Identifier Descriptor pointer.
1630
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
1637 resources.
1638
1639 **/
1640 EFI_STATUS
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
1649 )
1650 {
1651 EFI_STATUS Status;
1652 UDF_READ_FILE_INFO ReadFileInfo;
1653 UDF_FILE_IDENTIFIER_DESCRIPTOR *FileIdentifierDesc;
1654
1655 if (ReadDirInfo->DirectoryData == NULL) {
1656 //
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.
1659 //
1660 ReadFileInfo.Flags = READ_FILE_ALLOCATE_AND_READ;
1661
1662 Status = ReadFile (
1663 BlockIo,
1664 DiskIo,
1665 Volume,
1666 ParentIcb,
1667 FileEntryData,
1668 &ReadFileInfo
1669 );
1670 if (EFI_ERROR (Status)) {
1671 return Status;
1672 }
1673
1674 //
1675 // Fill in ReadDirInfo structure with the read directory's data information.
1676 //
1677 ReadDirInfo->DirectoryData = ReadFileInfo.FileData;
1678 ReadDirInfo->DirectoryLength = ReadFileInfo.ReadLength;
1679 }
1680
1681 do {
1682 if (ReadDirInfo->FidOffset >= ReadDirInfo->DirectoryLength) {
1683 //
1684 // There are no longer FIDs for this directory. By returning
1685 // EFI_DEVICE_ERROR to the callee will indicate end of directory
1686 // listening.
1687 //
1688 return EFI_DEVICE_ERROR;
1689 }
1690
1691 //
1692 // Get FID for this entry.
1693 //
1694 FileIdentifierDesc = GET_FID_FROM_ADS (ReadDirInfo->DirectoryData,
1695 ReadDirInfo->FidOffset);
1696 //
1697 // Update FidOffset to point to next FID.
1698 //
1699 ReadDirInfo->FidOffset += GetFidDescriptorLength (FileIdentifierDesc);
1700 } while (IS_FID_DELETED_FILE (FileIdentifierDesc));
1701
1702 DuplicateFid (FileIdentifierDesc, FoundFid);
1703
1704 return EFI_SUCCESS;
1705 }
1706
1707 /**
1708 Get a filename (encoded in OSTA-compressed format) from a File Identifier
1709 Descriptor on an UDF volume.
1710
1711 @param[in] FileIdentifierDesc File Identifier Descriptor pointer.
1712 @param[out] FileName Decoded filename.
1713
1714 @retval EFI_SUCCESS Filename decoded and read.
1715 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1716 **/
1717 EFI_STATUS
1718 GetFileNameFromFid (
1719 IN UDF_FILE_IDENTIFIER_DESCRIPTOR *FileIdentifierDesc,
1720 OUT CHAR16 *FileName
1721 )
1722 {
1723 UINT8 *OstaCompressed;
1724 UINT8 CompressionId;
1725 UINT8 Length;
1726 UINTN Index;
1727
1728 OstaCompressed =
1729 (UINT8 *)(
1730 (UINT8 *)FileIdentifierDesc->Data +
1731 FileIdentifierDesc->LengthOfImplementationUse
1732 );
1733
1734 CompressionId = OstaCompressed[0];
1735 if (!IS_VALID_COMPRESSION_ID (CompressionId)) {
1736 return EFI_VOLUME_CORRUPTED;
1737 }
1738
1739 //
1740 // Decode filename.
1741 //
1742 Length = FileIdentifierDesc->LengthOfFileIdentifier;
1743 for (Index = 1; Index < Length; Index++) {
1744 if (CompressionId == 16) {
1745 *FileName = OstaCompressed[Index++] << 8;
1746 } else {
1747 *FileName = 0;
1748 }
1749
1750 if (Index < Length) {
1751 *FileName |= OstaCompressed[Index];
1752 }
1753
1754 FileName++;
1755 }
1756
1757 *FileName = L'\0';
1758
1759 return EFI_SUCCESS;
1760 }
1761
1762 /**
1763 Resolve a symlink file on an UDF volume.
1764
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.
1771
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
1778 resources.
1779
1780 **/
1781 EFI_STATUS
1782 ResolveSymlink (
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
1789 )
1790 {
1791 EFI_STATUS Status;
1792 UDF_READ_FILE_INFO ReadFileInfo;
1793 UINT8 *Data;
1794 UINT64 Length;
1795 UINT8 *EndData;
1796 UDF_PATH_COMPONENT *PathComp;
1797 UINT8 PathCompLength;
1798 CHAR16 FileName[UDF_FILENAME_LENGTH];
1799 CHAR16 *C;
1800 UINTN Index;
1801 UINT8 CompressionId;
1802 UDF_FILE_INFO PreviousFile;
1803
1804 //
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
1808 // lower filenames.
1809 //
1810 ReadFileInfo.Flags = READ_FILE_ALLOCATE_AND_READ;
1811
1812 Status = ReadFile (
1813 BlockIo,
1814 DiskIo,
1815 Volume,
1816 &Parent->FileIdentifierDesc->Icb,
1817 FileEntryData,
1818 &ReadFileInfo
1819 );
1820 if (EFI_ERROR (Status)) {
1821 return Status;
1822 }
1823
1824 Length = ReadFileInfo.ReadLength;
1825
1826 Data = (UINT8 *)ReadFileInfo.FileData;
1827 EndData = Data + Length;
1828
1829 CopyMem ((VOID *)&PreviousFile, (VOID *)Parent, sizeof (UDF_FILE_INFO));
1830
1831 for (;;) {
1832 PathComp = (UDF_PATH_COMPONENT *)Data;
1833
1834 PathCompLength = PathComp->LengthOfComponentIdentifier;
1835
1836 switch (PathComp->ComponentType) {
1837 case 1:
1838 //
1839 // This Path Component specifies the root directory hierarchy subject to
1840 // agreement between the originator and recipient of the medium. Skip it.
1841 //
1842 // Fall through.
1843 //
1844 case 2:
1845 //
1846 // "\\." of the current directory. Read next Path Component.
1847 //
1848 goto Next_Path_Component;
1849 case 3:
1850 //
1851 // ".." (parent directory). Go to it.
1852 //
1853 CopyMem ((VOID *)FileName, L"..", 6);
1854 break;
1855 case 4:
1856 //
1857 // "." (current file). Duplicate both FE/EFE and FID of this file.
1858 //
1859 DuplicateFe (BlockIo, Volume, PreviousFile.FileEntry, &File->FileEntry);
1860 DuplicateFid (PreviousFile.FileIdentifierDesc,
1861 &File->FileIdentifierDesc);
1862 goto Next_Path_Component;
1863 case 5:
1864 //
1865 // This Path Component identifies an object, either a file or a
1866 // directory or an alias.
1867 //
1868 // Decode it from the compressed data in ComponentIdentifier and find
1869 // respective path.
1870 //
1871 CompressionId = PathComp->ComponentIdentifier[0];
1872 if (!IS_VALID_COMPRESSION_ID (CompressionId)) {
1873 return EFI_VOLUME_CORRUPTED;
1874 }
1875
1876 C = FileName;
1877 for (Index = 1; Index < PathCompLength; Index++) {
1878 if (CompressionId == 16) {
1879 *C = *(UINT8 *)((UINT8 *)PathComp->ComponentIdentifier +
1880 Index) << 8;
1881 Index++;
1882 } else {
1883 *C = 0;
1884 }
1885
1886 if (Index < Length) {
1887 *C |= *(UINT8 *)((UINT8 *)PathComp->ComponentIdentifier + Index);
1888 }
1889
1890 C++;
1891 }
1892
1893 *C = L'\0';
1894 break;
1895 }
1896
1897 //
1898 // Find file from the read filename in symlink's file data.
1899 //
1900 Status = InternalFindFile (
1901 BlockIo,
1902 DiskIo,
1903 Volume,
1904 FileName,
1905 &PreviousFile,
1906 NULL,
1907 File
1908 );
1909 if (EFI_ERROR (Status)) {
1910 goto Error_Find_File;
1911 }
1912
1913 Next_Path_Component:
1914 Data += sizeof (UDF_PATH_COMPONENT) + PathCompLength;
1915 if (Data >= EndData) {
1916 break;
1917 }
1918
1919 if (CompareMem ((VOID *)&PreviousFile, (VOID *)Parent,
1920 sizeof (UDF_FILE_INFO)) != 0) {
1921 CleanupFileInformation (&PreviousFile);
1922 }
1923
1924 CopyMem ((VOID *)&PreviousFile, (VOID *)File, sizeof (UDF_FILE_INFO));
1925 }
1926
1927 //
1928 // Unmap the symlink file.
1929 //
1930 FreePool (ReadFileInfo.FileData);
1931
1932 return EFI_SUCCESS;
1933
1934 Error_Find_File:
1935 if (CompareMem ((VOID *)&PreviousFile, (VOID *)Parent,
1936 sizeof (UDF_FILE_INFO)) != 0) {
1937 CleanupFileInformation (&PreviousFile);
1938 }
1939
1940 FreePool (ReadFileInfo.FileData);
1941
1942 return Status;
1943 }
1944
1945 /**
1946 Clean up in-memory UDF volume information.
1947
1948 @param[in] Volume Volume information pointer.
1949
1950 **/
1951 VOID
1952 CleanupVolumeInformation (
1953 IN UDF_VOLUME_INFO *Volume
1954 )
1955 {
1956 UINTN Index;
1957
1958 if (Volume->LogicalVolDescs != NULL) {
1959 for (Index = 0; Index < Volume->LogicalVolDescsNo; Index++) {
1960 FreePool ((VOID *)Volume->LogicalVolDescs[Index]);
1961 }
1962 FreePool ((VOID *)Volume->LogicalVolDescs);
1963 }
1964
1965 if (Volume->PartitionDescs != NULL) {
1966 for (Index = 0; Index < Volume->PartitionDescsNo; Index++) {
1967 FreePool ((VOID *)Volume->PartitionDescs[Index]);
1968 }
1969 FreePool ((VOID *)Volume->PartitionDescs);
1970 }
1971
1972 if (Volume->FileSetDescs != NULL) {
1973 for (Index = 0; Index < Volume->FileSetDescsNo; Index++) {
1974 FreePool ((VOID *)Volume->FileSetDescs[Index]);
1975 }
1976 FreePool ((VOID *)Volume->FileSetDescs);
1977 }
1978
1979 ZeroMem ((VOID *)Volume, sizeof (UDF_VOLUME_INFO));
1980 }
1981
1982 /**
1983 Clean up in-memory UDF file information.
1984
1985 @param[in] File File information pointer.
1986
1987 **/
1988 VOID
1989 CleanupFileInformation (
1990 IN UDF_FILE_INFO *File
1991 )
1992 {
1993 if (File->FileEntry != NULL) {
1994 FreePool (File->FileEntry);
1995 }
1996 if (File->FileIdentifierDesc != NULL) {
1997 FreePool ((VOID *)File->FileIdentifierDesc);
1998 }
1999
2000 ZeroMem ((VOID *)File, sizeof (UDF_FILE_INFO));
2001 }
2002
2003 /**
2004 Find a file from its absolute path on an UDF volume.
2005
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.
2011
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
2018 resources.
2019
2020 **/
2021 EFI_STATUS
2022 GetFileSize (
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,
2027 OUT UINT64 *Size
2028 )
2029 {
2030 EFI_STATUS Status;
2031 UDF_READ_FILE_INFO ReadFileInfo;
2032
2033 ReadFileInfo.Flags = READ_FILE_GET_FILESIZE;
2034
2035 Status = ReadFile (
2036 BlockIo,
2037 DiskIo,
2038 Volume,
2039 &File->FileIdentifierDesc->Icb,
2040 File->FileEntry,
2041 &ReadFileInfo
2042 );
2043 if (EFI_ERROR (Status)) {
2044 return Status;
2045 }
2046
2047 *Size = ReadFileInfo.ReadLength;
2048
2049 return EFI_SUCCESS;
2050 }
2051
2052 /**
2053 Set information about a file on an UDF volume.
2054
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.
2060
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
2066 resources.
2067
2068 **/
2069 EFI_STATUS
2070 SetFileInfo (
2071 IN UDF_FILE_INFO *File,
2072 IN UINT64 FileSize,
2073 IN CHAR16 *FileName,
2074 IN OUT UINTN *BufferSize,
2075 OUT VOID *Buffer
2076 )
2077 {
2078 UINTN FileInfoLength;
2079 EFI_FILE_INFO *FileInfo;
2080 UDF_FILE_ENTRY *FileEntry;
2081 UDF_EXTENDED_FILE_ENTRY *ExtendedFileEntry;
2082
2083 //
2084 // Calculate the needed size for the EFI_FILE_INFO structure.
2085 //
2086 FileInfoLength = sizeof (EFI_FILE_INFO) + (FileName ?
2087 StrSize (FileName) :
2088 sizeof (CHAR16));
2089 if (*BufferSize < FileInfoLength) {
2090 //
2091 // The given Buffer has no size enough for EFI_FILE_INFO structure.
2092 //
2093 *BufferSize = FileInfoLength;
2094 return EFI_BUFFER_TOO_SMALL;
2095 }
2096
2097 //
2098 // Buffer now contains room enough to store EFI_FILE_INFO structure.
2099 // Now, fill it in with all necessary information about the file.
2100 //
2101 FileInfo = (EFI_FILE_INFO *)Buffer;
2102 FileInfo->Size = FileInfoLength;
2103 FileInfo->Attribute &= ~EFI_FILE_VALID_ATTR;
2104 FileInfo->Attribute |= EFI_FILE_READ_ONLY;
2105
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;
2110 }
2111
2112 if (IS_FID_HIDDEN_FILE (File->FileIdentifierDesc)) {
2113 FileInfo->Attribute |= EFI_FILE_HIDDEN;
2114 }
2115
2116 if (IS_FE (File->FileEntry)) {
2117 FileEntry = (UDF_FILE_ENTRY *)File->FileEntry;
2118
2119 //
2120 // Check if FE has the system attribute set.
2121 //
2122 if (FileEntry->IcbTag.Flags & (1 << 10)) {
2123 FileInfo->Attribute |= EFI_FILE_SYSTEM;
2124 }
2125
2126 FileInfo->FileSize = FileSize;
2127 FileInfo->PhysicalSize = FileSize;
2128
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;
2137
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;
2154
2155 //
2156 // Check if EFE has the system attribute set.
2157 //
2158 if (ExtendedFileEntry->IcbTag.Flags & (1 << 10)) {
2159 FileInfo->Attribute |= EFI_FILE_SYSTEM;
2160 }
2161
2162 FileInfo->FileSize = FileSize;
2163 FileInfo->PhysicalSize = FileSize;
2164
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;
2173
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;
2188 }
2189
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;
2194
2195 CopyMem ((VOID *)&FileInfo->ModificationTime,
2196 (VOID *)&FileInfo->LastAccessTime,
2197 sizeof (EFI_TIME));
2198
2199 if (FileName != NULL) {
2200 StrCpyS (FileInfo->FileName, StrLen (FileName) + 1, FileName);
2201 } else {
2202 FileInfo->FileName[0] = '\0';
2203 }
2204
2205 *BufferSize = FileInfoLength;
2206
2207 return EFI_SUCCESS;
2208 }
2209
2210 /**
2211 Get volume and free space size information of an UDF volume.
2212
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.
2218
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.
2225
2226 **/
2227 EFI_STATUS
2228 GetVolumeSize (
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
2234 )
2235 {
2236 UDF_EXTENT_AD ExtentAd;
2237 UINT32 LogicalBlockSize;
2238 UINT64 Lsn;
2239 EFI_STATUS Status;
2240 UDF_LOGICAL_VOLUME_INTEGRITY *LogicalVolInt;
2241 UINTN Index;
2242 UINTN Length;
2243 UINT32 LsnsNo;
2244
2245 *VolumeSize = 0;
2246 *FreeSpaceSize = 0;
2247
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) {
2253 continue;
2254 }
2255
2256 LogicalBlockSize = LV_BLOCK_SIZE (Volume, Index);
2257
2258 Read_Next_Sequence:
2259 LogicalVolInt = (UDF_LOGICAL_VOLUME_INTEGRITY *)
2260 AllocatePool (ExtentAd.ExtentLength);
2261 if (LogicalVolInt == NULL) {
2262 return EFI_OUT_OF_RESOURCES;
2263 }
2264
2265 Lsn = (UINT64)ExtentAd.ExtentLocation;
2266
2267 Status = DiskIo->ReadDisk (
2268 DiskIo,
2269 BlockIo->Media->MediaId,
2270 MultU64x32 (Lsn, LogicalBlockSize),
2271 ExtentAd.ExtentLength,
2272 (VOID *)LogicalVolInt
2273 );
2274 if (EFI_ERROR (Status)) {
2275 FreePool ((VOID *)LogicalVolInt);
2276 return Status;
2277 }
2278
2279 if (!IS_LVID (LogicalVolInt)) {
2280 FreePool ((VOID *)LogicalVolInt);
2281 return EFI_VOLUME_CORRUPTED;
2282 }
2283
2284 Length = LogicalVolInt->NumberOfPartitions;
2285 for (Index = 0; Index < Length; Index += sizeof (UINT32)) {
2286 LsnsNo = *(UINT32 *)((UINT8 *)LogicalVolInt->Data + Index);
2287 if (LsnsNo == 0xFFFFFFFFUL) {
2288 //
2289 // Size not specified.
2290 //
2291 continue;
2292 }
2293
2294 *FreeSpaceSize += MultU64x32 ((UINT64)LsnsNo, LogicalBlockSize);
2295 }
2296
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) {
2301 //
2302 // Size not specified.
2303 //
2304 continue;
2305 }
2306
2307 *VolumeSize += MultU64x32 ((UINT64)LsnsNo, LogicalBlockSize);
2308 }
2309
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;
2315 }
2316
2317 FreePool ((VOID *)LogicalVolInt);
2318 }
2319
2320 return EFI_SUCCESS;
2321 }
2322
2323 /**
2324 Seek a file and read its data into memory on an UDF volume.
2325
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.
2334
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
2341 of resources.
2342
2343 **/
2344 EFI_STATUS
2345 ReadFileData (
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,
2350 IN UINT64 FileSize,
2351 IN OUT UINT64 *FilePosition,
2352 IN OUT VOID *Buffer,
2353 IN OUT UINT64 *BufferSize
2354 )
2355 {
2356 EFI_STATUS Status;
2357 UDF_READ_FILE_INFO ReadFileInfo;
2358
2359 ReadFileInfo.Flags = READ_FILE_SEEK_AND_READ;
2360 ReadFileInfo.FilePosition = *FilePosition;
2361 ReadFileInfo.FileData = Buffer;
2362 ReadFileInfo.FileDataSize = *BufferSize;
2363 ReadFileInfo.FileSize = FileSize;
2364
2365 Status = ReadFile (
2366 BlockIo,
2367 DiskIo,
2368 Volume,
2369 &File->FileIdentifierDesc->Icb,
2370 File->FileEntry,
2371 &ReadFileInfo
2372 );
2373 if (EFI_ERROR (Status)) {
2374 return Status;
2375 }
2376
2377 *BufferSize = ReadFileInfo.FileDataSize;
2378 *FilePosition = ReadFileInfo.FilePosition;
2379
2380 return EFI_SUCCESS;
2381 }
2382
2383 /**
2384 Check if ControllerHandle supports an UDF file system.
2385
2386 @param[in] This Protocol instance pointer.
2387 @param[in] ControllerHandle Handle of device to test.
2388
2389 @retval EFI_SUCCESS UDF file system found.
2390 @retval EFI_UNSUPPORTED UDF file system not found.
2391
2392 **/
2393 EFI_STATUS
2394 SupportUdfFileSystem (
2395 IN EFI_DRIVER_BINDING_PROTOCOL *This,
2396 IN EFI_HANDLE ControllerHandle
2397 )
2398 {
2399 EFI_STATUS Status;
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;
2405
2406 //
2407 // Open Device Path protocol on ControllerHandle
2408 //
2409 Status = gBS->OpenProtocol (
2410 ControllerHandle,
2411 &gEfiDevicePathProtocolGuid,
2412 (VOID **)&DevicePath,
2413 This->DriverBindingHandle,
2414 ControllerHandle,
2415 EFI_OPEN_PROTOCOL_GET_PROTOCOL
2416 );
2417 if (EFI_ERROR (Status)) {
2418 return EFI_UNSUPPORTED;
2419 }
2420
2421 Status = EFI_UNSUPPORTED;
2422
2423 //
2424 // Get last Device Path node
2425 //
2426 LastDevicePathNode = NULL;
2427 DevicePathNode = DevicePath;
2428 while (!IsDevicePathEnd (DevicePathNode)) {
2429 LastDevicePathNode = DevicePathNode;
2430 DevicePathNode = NextDevicePathNode (DevicePathNode);
2431 }
2432 //
2433 // Check if last Device Path node contains a Vendor-Defined Media Device Path
2434 // of an UDF file system.
2435 //
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;
2443 }
2444 }
2445
2446 //
2447 // Close Device Path protocol on ControllerHandle
2448 //
2449 gBS->CloseProtocol (
2450 ControllerHandle,
2451 &gEfiDevicePathProtocolGuid,
2452 This->DriverBindingHandle,
2453 ControllerHandle
2454 );
2455
2456 return Status;
2457 }