]> git.proxmox.com Git - mirror_edk2.git/blob - MdeModulePkg/Universal/Disk/UdfDxe/FileSystemOperations.c
MdeModulePkg/UdfDxe: Initialize the array after declaration
[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 }
966
967 break;
968 case LONG_ADS_SEQUENCE:
969 case SHORT_ADS_SEQUENCE:
970 //
971 // This FE/EFE contains a run of Allocation Descriptors. Get data + size
972 // for start reading them out.
973 //
974 GetAdsInformation (FileEntryData, &Data, &Length);
975 AdOffset = 0;
976
977 for (;;) {
978 //
979 // Read AD.
980 //
981 Status = GetAllocationDescriptor (
982 RecordingFlags,
983 Data,
984 &AdOffset,
985 Length,
986 &Ad
987 );
988 if (Status == EFI_DEVICE_ERROR) {
989 Status = EFI_SUCCESS;
990 goto Done;
991 }
992
993 //
994 // Check if AD is an indirect AD. If so, read Allocation Extent
995 // Descriptor and its extents (ADs).
996 //
997 if (GET_EXTENT_FLAGS (RecordingFlags, Ad) == EXTENT_IS_NEXT_EXTENT) {
998 if (!DoFreeAed) {
999 DoFreeAed = TRUE;
1000 } else {
1001 FreePool (Data);
1002 }
1003
1004 Status = GetAedAdsData (
1005 BlockIo,
1006 DiskIo,
1007 Volume,
1008 ParentIcb,
1009 RecordingFlags,
1010 Ad,
1011 &Data,
1012 &Length
1013 );
1014 if (EFI_ERROR (Status)) {
1015 goto Error_Get_Aed;
1016 }
1017
1018 AdOffset = 0;
1019 continue;
1020 }
1021
1022 ExtentLength = GET_EXTENT_LENGTH (RecordingFlags, Ad);
1023
1024 Lsn = GetAllocationDescriptorLsn (RecordingFlags,
1025 Volume,
1026 ParentIcb,
1027 Ad);
1028
1029 switch (ReadFileInfo->Flags) {
1030 case READ_FILE_GET_FILESIZE:
1031 ReadFileInfo->ReadLength += ExtentLength;
1032 break;
1033 case READ_FILE_ALLOCATE_AND_READ:
1034 //
1035 // Increase FileData (if necessary) to read next extent.
1036 //
1037 Status = GrowUpBufferToNextAd (
1038 RecordingFlags,
1039 Ad,
1040 &ReadFileInfo->FileData,
1041 ReadFileInfo->ReadLength
1042 );
1043 if (EFI_ERROR (Status)) {
1044 goto Error_Alloc_Buffer_To_Next_Ad;
1045 }
1046
1047 //
1048 // Read extent's data into FileData.
1049 //
1050 Status = DiskIo->ReadDisk (
1051 DiskIo,
1052 BlockIo->Media->MediaId,
1053 MultU64x32 (Lsn, LogicalBlockSize),
1054 ExtentLength,
1055 (VOID *)((UINT8 *)ReadFileInfo->FileData +
1056 ReadFileInfo->ReadLength)
1057 );
1058 if (EFI_ERROR (Status)) {
1059 goto Error_Read_Disk_Blk;
1060 }
1061
1062 ReadFileInfo->ReadLength += ExtentLength;
1063 break;
1064 case READ_FILE_SEEK_AND_READ:
1065 //
1066 // Seek file first before reading in its data.
1067 //
1068 if (FinishedSeeking) {
1069 Offset = 0;
1070 goto Skip_File_Seek;
1071 }
1072
1073 if (FilePosition + ExtentLength < ReadFileInfo->FilePosition) {
1074 FilePosition += ExtentLength;
1075 goto Skip_Ad;
1076 }
1077
1078 if (FilePosition + ExtentLength > ReadFileInfo->FilePosition) {
1079 Offset = ReadFileInfo->FilePosition - FilePosition;
1080 if (Offset < 0) {
1081 Offset = -(Offset);
1082 }
1083 } else {
1084 Offset = 0;
1085 }
1086
1087 //
1088 // Done with seeking file. Start reading its data.
1089 //
1090 FinishedSeeking = TRUE;
1091
1092 Skip_File_Seek:
1093 //
1094 // Make sure we don't read more data than really wanted.
1095 //
1096 if (ExtentLength - Offset > BytesLeft) {
1097 DataLength = BytesLeft;
1098 } else {
1099 DataLength = ExtentLength - Offset;
1100 }
1101
1102 //
1103 // Read extent's data into FileData.
1104 //
1105 Status = DiskIo->ReadDisk (
1106 DiskIo,
1107 BlockIo->Media->MediaId,
1108 Offset + MultU64x32 (Lsn, LogicalBlockSize),
1109 (UINTN) DataLength,
1110 (VOID *)((UINT8 *)ReadFileInfo->FileData +
1111 DataOffset)
1112 );
1113 if (EFI_ERROR (Status)) {
1114 goto Error_Read_Disk_Blk;
1115 }
1116
1117 //
1118 // Update current file's position.
1119 //
1120 DataOffset += DataLength;
1121 ReadFileInfo->FilePosition += DataLength;
1122
1123 BytesLeft -= DataLength;
1124 if (BytesLeft == 0) {
1125 //
1126 // There is no more file data to read.
1127 //
1128 Status = EFI_SUCCESS;
1129 goto Done;
1130 }
1131
1132 break;
1133 }
1134
1135 Skip_Ad:
1136 //
1137 // Point to the next AD (extent).
1138 //
1139 AdOffset += AD_LENGTH (RecordingFlags);
1140 }
1141
1142 break;
1143 case EXTENDED_ADS_SEQUENCE:
1144 // FIXME: Not supported. Got no volume with it, yet.
1145 ASSERT (FALSE);
1146 Status = EFI_UNSUPPORTED;
1147 break;
1148 }
1149
1150 Done:
1151 if (DoFreeAed) {
1152 FreePool (Data);
1153 }
1154
1155 return Status;
1156
1157 Error_Read_Disk_Blk:
1158 Error_Alloc_Buffer_To_Next_Ad:
1159 if (ReadFileInfo->Flags != READ_FILE_SEEK_AND_READ) {
1160 FreePool (ReadFileInfo->FileData);
1161 }
1162
1163 if (DoFreeAed) {
1164 FreePool (Data);
1165 }
1166
1167 Error_Get_Aed:
1168 return Status;
1169 }
1170
1171 //
1172 // Find a file by its filename from a given Parent file.
1173 //
1174 EFI_STATUS
1175 InternalFindFile (
1176 IN EFI_BLOCK_IO_PROTOCOL *BlockIo,
1177 IN EFI_DISK_IO_PROTOCOL *DiskIo,
1178 IN UDF_VOLUME_INFO *Volume,
1179 IN CHAR16 *FileName,
1180 IN UDF_FILE_INFO *Parent,
1181 IN UDF_LONG_ALLOCATION_DESCRIPTOR *Icb,
1182 OUT UDF_FILE_INFO *File
1183 )
1184 {
1185 EFI_STATUS Status;
1186 UDF_FILE_IDENTIFIER_DESCRIPTOR *FileIdentifierDesc;
1187 UDF_READ_DIRECTORY_INFO ReadDirInfo;
1188 BOOLEAN Found;
1189 CHAR16 FoundFileName[UDF_FILENAME_LENGTH];
1190 VOID *CompareFileEntry;
1191
1192 //
1193 // Check if parent file is really directory.
1194 //
1195 if (!IS_FE_DIRECTORY (Parent->FileEntry)) {
1196 return EFI_NOT_FOUND;
1197 }
1198
1199 //
1200 // If FileName is current file or working directory, just duplicate Parent's
1201 // FE/EFE and FID descriptors.
1202 //
1203 if (StrCmp (FileName, L".") == 0) {
1204 DuplicateFe (BlockIo, Volume, Parent->FileEntry, &File->FileEntry);
1205 DuplicateFid (Parent->FileIdentifierDesc, &File->FileIdentifierDesc);
1206
1207 return EFI_SUCCESS;
1208 }
1209
1210 //
1211 // Start directory listing.
1212 //
1213 ZeroMem ((VOID *)&ReadDirInfo, sizeof (UDF_READ_DIRECTORY_INFO));
1214 Found = FALSE;
1215
1216 for (;;) {
1217 Status = ReadDirectoryEntry (
1218 BlockIo,
1219 DiskIo,
1220 Volume,
1221 Parent->FileIdentifierDesc ?
1222 &Parent->FileIdentifierDesc->Icb :
1223 Icb,
1224 Parent->FileEntry,
1225 &ReadDirInfo,
1226 &FileIdentifierDesc
1227 );
1228 if (EFI_ERROR (Status)) {
1229 if (Status == EFI_DEVICE_ERROR) {
1230 Status = EFI_NOT_FOUND;
1231 }
1232
1233 break;
1234 }
1235
1236 if (IS_FID_PARENT_FILE (FileIdentifierDesc)) {
1237 //
1238 // This FID contains the location (FE/EFE) of the parent directory of this
1239 // directory (Parent), and if FileName is either ".." or "\\", then it's
1240 // the expected FID.
1241 //
1242 if (StrCmp (FileName, L"..") == 0 || StrCmp (FileName, L"\\") == 0) {
1243 Found = TRUE;
1244 break;
1245 }
1246 } else {
1247 Status = GetFileNameFromFid (FileIdentifierDesc, FoundFileName);
1248 if (EFI_ERROR (Status)) {
1249 break;
1250 }
1251
1252 if (StrCmp (FileName, FoundFileName) == 0) {
1253 //
1254 // FID has been found. Prepare to find its respective FE/EFE.
1255 //
1256 Found = TRUE;
1257 break;
1258 }
1259 }
1260
1261 FreePool ((VOID *)FileIdentifierDesc);
1262 }
1263
1264 if (ReadDirInfo.DirectoryData != NULL) {
1265 //
1266 // Free all allocated resources for the directory listing.
1267 //
1268 FreePool (ReadDirInfo.DirectoryData);
1269 }
1270
1271 if (Found) {
1272 Status = EFI_SUCCESS;
1273
1274 File->FileIdentifierDesc = FileIdentifierDesc;
1275
1276 //
1277 // If the requested file is root directory, then the FE/EFE was already
1278 // retrieved in UdfOpenVolume() function, thus no need to find it again.
1279 //
1280 // Otherwise, find FE/EFE from the respective FID.
1281 //
1282 if (StrCmp (FileName, L"\\") != 0) {
1283 Status = FindFileEntry (
1284 BlockIo,
1285 DiskIo,
1286 Volume,
1287 &FileIdentifierDesc->Icb,
1288 &CompareFileEntry
1289 );
1290 if (EFI_ERROR (Status)) {
1291 goto Error_Find_Fe;
1292 }
1293
1294 //
1295 // Make sure that both Parent's FE/EFE and found FE/EFE are not equal.
1296 //
1297 if (CompareMem ((VOID *)Parent->FileEntry, (VOID *)CompareFileEntry,
1298 Volume->FileEntrySize) != 0) {
1299 File->FileEntry = CompareFileEntry;
1300 } else {
1301 FreePool ((VOID *)FileIdentifierDesc);
1302 FreePool ((VOID *)CompareFileEntry);
1303 Status = EFI_NOT_FOUND;
1304 }
1305 }
1306 }
1307
1308 return Status;
1309
1310 Error_Find_Fe:
1311 FreePool ((VOID *)FileIdentifierDesc);
1312
1313 return Status;
1314 }
1315
1316 /**
1317 Read volume information on a medium which contains a valid UDF file system.
1318
1319 @param[in] BlockIo BlockIo interface.
1320 @param[in] DiskIo DiskIo interface.
1321 @param[out] Volume UDF volume information structure.
1322
1323 @retval EFI_SUCCESS Volume information read.
1324 @retval EFI_NO_MEDIA The device has no media.
1325 @retval EFI_DEVICE_ERROR The device reported an error.
1326 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1327 @retval EFI_OUT_OF_RESOURCES The volume was not read due to lack of resources.
1328
1329 **/
1330 EFI_STATUS
1331 ReadUdfVolumeInformation (
1332 IN EFI_BLOCK_IO_PROTOCOL *BlockIo,
1333 IN EFI_DISK_IO_PROTOCOL *DiskIo,
1334 OUT UDF_VOLUME_INFO *Volume
1335 )
1336 {
1337 EFI_STATUS Status;
1338
1339 Status = ReadVolumeFileStructure (
1340 BlockIo,
1341 DiskIo,
1342 Volume
1343 );
1344 if (EFI_ERROR (Status)) {
1345 return Status;
1346 }
1347
1348 Status = GetFileSetDescriptors (
1349 BlockIo,
1350 DiskIo,
1351 Volume
1352 );
1353 if (EFI_ERROR (Status)) {
1354 CleanupVolumeInformation (Volume);
1355 }
1356
1357 return Status;
1358 }
1359
1360 /**
1361 Find the root directory on an UDF volume.
1362
1363 @param[in] BlockIo BlockIo interface.
1364 @param[in] DiskIo DiskIo interface.
1365 @param[in] Volume UDF volume information structure.
1366 @param[out] File Root directory file.
1367
1368 @retval EFI_SUCCESS Root directory found.
1369 @retval EFI_NO_MEDIA The device has no media.
1370 @retval EFI_DEVICE_ERROR The device reported an error.
1371 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1372 @retval EFI_OUT_OF_RESOURCES The root directory was not found due to lack of
1373 resources.
1374
1375 **/
1376 EFI_STATUS
1377 FindRootDirectory (
1378 IN EFI_BLOCK_IO_PROTOCOL *BlockIo,
1379 IN EFI_DISK_IO_PROTOCOL *DiskIo,
1380 IN UDF_VOLUME_INFO *Volume,
1381 OUT UDF_FILE_INFO *File
1382 )
1383 {
1384 EFI_STATUS Status;
1385 UDF_FILE_INFO Parent;
1386
1387 Status = FindFileEntry (
1388 BlockIo,
1389 DiskIo,
1390 Volume,
1391 &Volume->FileSetDescs[0]->RootDirectoryIcb,
1392 &File->FileEntry
1393 );
1394 if (EFI_ERROR (Status)) {
1395 return Status;
1396 }
1397
1398 Parent.FileEntry = File->FileEntry;
1399 Parent.FileIdentifierDesc = NULL;
1400
1401 Status = FindFile (
1402 BlockIo,
1403 DiskIo,
1404 Volume,
1405 L"\\",
1406 NULL,
1407 &Parent,
1408 &Volume->FileSetDescs[0]->RootDirectoryIcb,
1409 File
1410 );
1411 if (EFI_ERROR (Status)) {
1412 FreePool (File->FileEntry);
1413 }
1414
1415 return Status;
1416 }
1417
1418 /**
1419 Find either a File Entry or a Extended File Entry from a given ICB.
1420
1421 @param[in] BlockIo BlockIo interface.
1422 @param[in] DiskIo DiskIo interface.
1423 @param[in] Volume UDF volume information structure.
1424 @param[in] Icb ICB of the FID.
1425 @param[out] FileEntry File Entry or Extended File Entry.
1426
1427 @retval EFI_SUCCESS File Entry or Extended File Entry found.
1428 @retval EFI_NO_MEDIA The device has no media.
1429 @retval EFI_DEVICE_ERROR The device reported an error.
1430 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1431 @retval EFI_OUT_OF_RESOURCES The FE/EFE entry was not found due to lack of
1432 resources.
1433
1434 **/
1435 EFI_STATUS
1436 FindFileEntry (
1437 IN EFI_BLOCK_IO_PROTOCOL *BlockIo,
1438 IN EFI_DISK_IO_PROTOCOL *DiskIo,
1439 IN UDF_VOLUME_INFO *Volume,
1440 IN UDF_LONG_ALLOCATION_DESCRIPTOR *Icb,
1441 OUT VOID **FileEntry
1442 )
1443 {
1444 EFI_STATUS Status;
1445 UINT64 Lsn;
1446 UINT32 LogicalBlockSize;
1447
1448 Lsn = GetLongAdLsn (Volume, Icb);
1449 LogicalBlockSize = LV_BLOCK_SIZE (Volume, UDF_DEFAULT_LV_NUM);
1450
1451 *FileEntry = AllocateZeroPool (Volume->FileEntrySize);
1452 if (*FileEntry == NULL) {
1453 return EFI_OUT_OF_RESOURCES;
1454 }
1455
1456 //
1457 // Read extent.
1458 //
1459 Status = DiskIo->ReadDisk (
1460 DiskIo,
1461 BlockIo->Media->MediaId,
1462 MultU64x32 (Lsn, LogicalBlockSize),
1463 Volume->FileEntrySize,
1464 *FileEntry
1465 );
1466 if (EFI_ERROR (Status)) {
1467 goto Error_Read_Disk_Blk;
1468 }
1469
1470 //
1471 // Check if the read extent contains a valid Tag Identifier for the expected
1472 // FE/EFE.
1473 //
1474 if (!IS_FE (*FileEntry) && !IS_EFE (*FileEntry)) {
1475 Status = EFI_VOLUME_CORRUPTED;
1476 goto Error_Invalid_Fe;
1477 }
1478
1479 return EFI_SUCCESS;
1480
1481 Error_Invalid_Fe:
1482 Error_Read_Disk_Blk:
1483 FreePool (*FileEntry);
1484
1485 return Status;
1486 }
1487
1488 /**
1489 Find a file given its absolute path on an UDF volume.
1490
1491 @param[in] BlockIo BlockIo interface.
1492 @param[in] DiskIo DiskIo interface.
1493 @param[in] Volume UDF volume information structure.
1494 @param[in] FilePath File's absolute path.
1495 @param[in] Root Root directory file.
1496 @param[in] Parent Parent directory file.
1497 @param[out] File Found file.
1498
1499 @retval EFI_SUCCESS @p FilePath was found.
1500 @retval EFI_NO_MEDIA The device has no media.
1501 @retval EFI_DEVICE_ERROR The device reported an error.
1502 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1503 @retval EFI_OUT_OF_RESOURCES The @p FilePath file was not found due to lack of
1504 resources.
1505
1506 **/
1507 EFI_STATUS
1508 FindFile (
1509 IN EFI_BLOCK_IO_PROTOCOL *BlockIo,
1510 IN EFI_DISK_IO_PROTOCOL *DiskIo,
1511 IN UDF_VOLUME_INFO *Volume,
1512 IN CHAR16 *FilePath,
1513 IN UDF_FILE_INFO *Root,
1514 IN UDF_FILE_INFO *Parent,
1515 IN UDF_LONG_ALLOCATION_DESCRIPTOR *Icb,
1516 OUT UDF_FILE_INFO *File
1517 )
1518 {
1519 EFI_STATUS Status;
1520 CHAR16 FileName[UDF_FILENAME_LENGTH];
1521 CHAR16 *FileNamePointer;
1522 UDF_FILE_INFO PreviousFile;
1523 VOID *FileEntry;
1524
1525 Status = EFI_NOT_FOUND;
1526
1527 CopyMem ((VOID *)&PreviousFile, (VOID *)Parent, sizeof (UDF_FILE_INFO));
1528 while (*FilePath != L'\0') {
1529 FileNamePointer = FileName;
1530 while (*FilePath != L'\0' && *FilePath != L'\\') {
1531 *FileNamePointer++ = *FilePath++;
1532 }
1533
1534 *FileNamePointer = L'\0';
1535 if (FileName[0] == L'\0') {
1536 //
1537 // Open root directory.
1538 //
1539 if (Root == NULL) {
1540 //
1541 // There is no file found for the root directory yet. So, find only its
1542 // FID by now.
1543 //
1544 // See UdfOpenVolume() function.
1545 //
1546 Status = InternalFindFile (BlockIo,
1547 DiskIo,
1548 Volume,
1549 L"\\",
1550 &PreviousFile,
1551 Icb,
1552 File);
1553 } else {
1554 //
1555 // We've already a file pointer (Root) for the root directory. Duplicate
1556 // its FE/EFE and FID descriptors.
1557 //
1558 DuplicateFe (BlockIo, Volume, Root->FileEntry, &File->FileEntry);
1559 DuplicateFid (Root->FileIdentifierDesc, &File->FileIdentifierDesc);
1560 Status = EFI_SUCCESS;
1561 }
1562 } else {
1563 //
1564 // No root directory. Find filename from the current directory.
1565 //
1566 Status = InternalFindFile (BlockIo,
1567 DiskIo,
1568 Volume,
1569 FileName,
1570 &PreviousFile,
1571 Icb,
1572 File);
1573 }
1574
1575 if (EFI_ERROR (Status)) {
1576 return Status;
1577 }
1578
1579 //
1580 // If the found file is a symlink, then find its respective FE/EFE and
1581 // FID descriptors.
1582 //
1583 if (IS_FE_SYMLINK (File->FileEntry)) {
1584 FreePool ((VOID *)File->FileIdentifierDesc);
1585
1586 FileEntry = File->FileEntry;
1587
1588 Status = ResolveSymlink (BlockIo,
1589 DiskIo,
1590 Volume,
1591 &PreviousFile,
1592 FileEntry,
1593 File);
1594
1595 FreePool (FileEntry);
1596
1597 if (EFI_ERROR (Status)) {
1598 return Status;
1599 }
1600 }
1601
1602 if (CompareMem ((VOID *)&PreviousFile, (VOID *)Parent,
1603 sizeof (UDF_FILE_INFO)) != 0) {
1604 CleanupFileInformation (&PreviousFile);
1605 }
1606
1607 CopyMem ((VOID *)&PreviousFile, (VOID *)File, sizeof (UDF_FILE_INFO));
1608 if (*FilePath != L'\0' && *FilePath == L'\\') {
1609 FilePath++;
1610 }
1611 }
1612
1613 return Status;
1614 }
1615
1616 /**
1617 Read a directory entry at a time on an UDF volume.
1618
1619 @param[in] BlockIo BlockIo interface.
1620 @param[in] DiskIo DiskIo interface.
1621 @param[in] Volume UDF volume information structure.
1622 @param[in] ParentIcb ICB of the parent file.
1623 @param[in] FileEntryData FE/EFE of the parent file.
1624 @param[in out] ReadDirInfo Next read directory listing structure
1625 information.
1626 @param[out] FoundFid File Identifier Descriptor pointer.
1627
1628 @retval EFI_SUCCESS Directory entry read.
1629 @retval EFI_UNSUPPORTED Extended Allocation Descriptors not supported.
1630 @retval EFI_NO_MEDIA The device has no media.
1631 @retval EFI_DEVICE_ERROR The device reported an error.
1632 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1633 @retval EFI_OUT_OF_RESOURCES The directory entry was not read due to lack of
1634 resources.
1635
1636 **/
1637 EFI_STATUS
1638 ReadDirectoryEntry (
1639 IN EFI_BLOCK_IO_PROTOCOL *BlockIo,
1640 IN EFI_DISK_IO_PROTOCOL *DiskIo,
1641 IN UDF_VOLUME_INFO *Volume,
1642 IN UDF_LONG_ALLOCATION_DESCRIPTOR *ParentIcb,
1643 IN VOID *FileEntryData,
1644 IN OUT UDF_READ_DIRECTORY_INFO *ReadDirInfo,
1645 OUT UDF_FILE_IDENTIFIER_DESCRIPTOR **FoundFid
1646 )
1647 {
1648 EFI_STATUS Status;
1649 UDF_READ_FILE_INFO ReadFileInfo;
1650 UDF_FILE_IDENTIFIER_DESCRIPTOR *FileIdentifierDesc;
1651
1652 if (ReadDirInfo->DirectoryData == NULL) {
1653 //
1654 // The directory's recorded data has not been read yet. So let's cache it
1655 // into memory and the next calls won't need to read it again.
1656 //
1657 ReadFileInfo.Flags = READ_FILE_ALLOCATE_AND_READ;
1658
1659 Status = ReadFile (
1660 BlockIo,
1661 DiskIo,
1662 Volume,
1663 ParentIcb,
1664 FileEntryData,
1665 &ReadFileInfo
1666 );
1667 if (EFI_ERROR (Status)) {
1668 return Status;
1669 }
1670
1671 //
1672 // Fill in ReadDirInfo structure with the read directory's data information.
1673 //
1674 ReadDirInfo->DirectoryData = ReadFileInfo.FileData;
1675 ReadDirInfo->DirectoryLength = ReadFileInfo.ReadLength;
1676 }
1677
1678 do {
1679 if (ReadDirInfo->FidOffset >= ReadDirInfo->DirectoryLength) {
1680 //
1681 // There are no longer FIDs for this directory. By returning
1682 // EFI_DEVICE_ERROR to the callee will indicate end of directory
1683 // listening.
1684 //
1685 return EFI_DEVICE_ERROR;
1686 }
1687
1688 //
1689 // Get FID for this entry.
1690 //
1691 FileIdentifierDesc = GET_FID_FROM_ADS (ReadDirInfo->DirectoryData,
1692 ReadDirInfo->FidOffset);
1693 //
1694 // Update FidOffset to point to next FID.
1695 //
1696 ReadDirInfo->FidOffset += GetFidDescriptorLength (FileIdentifierDesc);
1697 } while (IS_FID_DELETED_FILE (FileIdentifierDesc));
1698
1699 DuplicateFid (FileIdentifierDesc, FoundFid);
1700
1701 return EFI_SUCCESS;
1702 }
1703
1704 /**
1705 Get a filename (encoded in OSTA-compressed format) from a File Identifier
1706 Descriptor on an UDF volume.
1707
1708 @param[in] FileIdentifierDesc File Identifier Descriptor pointer.
1709 @param[out] FileName Decoded filename.
1710
1711 @retval EFI_SUCCESS Filename decoded and read.
1712 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1713 **/
1714 EFI_STATUS
1715 GetFileNameFromFid (
1716 IN UDF_FILE_IDENTIFIER_DESCRIPTOR *FileIdentifierDesc,
1717 OUT CHAR16 *FileName
1718 )
1719 {
1720 UINT8 *OstaCompressed;
1721 UINT8 CompressionId;
1722 UINT8 Length;
1723 UINTN Index;
1724
1725 OstaCompressed =
1726 (UINT8 *)(
1727 (UINT8 *)FileIdentifierDesc->Data +
1728 FileIdentifierDesc->LengthOfImplementationUse
1729 );
1730
1731 CompressionId = OstaCompressed[0];
1732 if (!IS_VALID_COMPRESSION_ID (CompressionId)) {
1733 return EFI_VOLUME_CORRUPTED;
1734 }
1735
1736 //
1737 // Decode filename.
1738 //
1739 Length = FileIdentifierDesc->LengthOfFileIdentifier;
1740 for (Index = 1; Index < Length; Index++) {
1741 if (CompressionId == 16) {
1742 *FileName = OstaCompressed[Index++] << 8;
1743 } else {
1744 *FileName = 0;
1745 }
1746
1747 if (Index < Length) {
1748 *FileName |= OstaCompressed[Index];
1749 }
1750
1751 FileName++;
1752 }
1753
1754 *FileName = L'\0';
1755
1756 return EFI_SUCCESS;
1757 }
1758
1759 /**
1760 Resolve a symlink file on an UDF volume.
1761
1762 @param[in] BlockIo BlockIo interface.
1763 @param[in] DiskIo DiskIo interface.
1764 @param[in] Volume UDF volume information structure.
1765 @param[in] Parent Parent file.
1766 @param[in] FileEntryData FE/EFE structure pointer.
1767 @param[out] File Resolved file.
1768
1769 @retval EFI_SUCCESS Symlink file resolved.
1770 @retval EFI_UNSUPPORTED Extended Allocation Descriptors not supported.
1771 @retval EFI_NO_MEDIA The device has no media.
1772 @retval EFI_DEVICE_ERROR The device reported an error.
1773 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
1774 @retval EFI_OUT_OF_RESOURCES The symlink file was not resolved due to lack of
1775 resources.
1776
1777 **/
1778 EFI_STATUS
1779 ResolveSymlink (
1780 IN EFI_BLOCK_IO_PROTOCOL *BlockIo,
1781 IN EFI_DISK_IO_PROTOCOL *DiskIo,
1782 IN UDF_VOLUME_INFO *Volume,
1783 IN UDF_FILE_INFO *Parent,
1784 IN VOID *FileEntryData,
1785 OUT UDF_FILE_INFO *File
1786 )
1787 {
1788 EFI_STATUS Status;
1789 UDF_READ_FILE_INFO ReadFileInfo;
1790 UINT8 *Data;
1791 UINT64 Length;
1792 UINT8 *EndData;
1793 UDF_PATH_COMPONENT *PathComp;
1794 UINT8 PathCompLength;
1795 CHAR16 FileName[UDF_FILENAME_LENGTH];
1796 CHAR16 *C;
1797 UINTN Index;
1798 UINT8 CompressionId;
1799 UDF_FILE_INFO PreviousFile;
1800
1801 //
1802 // Symlink files on UDF volumes do not contain so much data other than
1803 // Path Components which resolves to real filenames, so it's OK to read in
1804 // all its data here -- usually the data will be inline with the FE/EFE for
1805 // lower filenames.
1806 //
1807 ReadFileInfo.Flags = READ_FILE_ALLOCATE_AND_READ;
1808
1809 Status = ReadFile (
1810 BlockIo,
1811 DiskIo,
1812 Volume,
1813 &Parent->FileIdentifierDesc->Icb,
1814 FileEntryData,
1815 &ReadFileInfo
1816 );
1817 if (EFI_ERROR (Status)) {
1818 return Status;
1819 }
1820
1821 Length = ReadFileInfo.ReadLength;
1822
1823 Data = (UINT8 *)ReadFileInfo.FileData;
1824 EndData = Data + Length;
1825
1826 CopyMem ((VOID *)&PreviousFile, (VOID *)Parent, sizeof (UDF_FILE_INFO));
1827
1828 for (;;) {
1829 PathComp = (UDF_PATH_COMPONENT *)Data;
1830
1831 PathCompLength = PathComp->LengthOfComponentIdentifier;
1832
1833 switch (PathComp->ComponentType) {
1834 case 1:
1835 //
1836 // This Path Component specifies the root directory hierarchy subject to
1837 // agreement between the originator and recipient of the medium. Skip it.
1838 //
1839 // Fall through.
1840 //
1841 case 2:
1842 //
1843 // "\\." of the current directory. Read next Path Component.
1844 //
1845 goto Next_Path_Component;
1846 case 3:
1847 //
1848 // ".." (parent directory). Go to it.
1849 //
1850 CopyMem ((VOID *)FileName, L"..", 6);
1851 break;
1852 case 4:
1853 //
1854 // "." (current file). Duplicate both FE/EFE and FID of this file.
1855 //
1856 DuplicateFe (BlockIo, Volume, PreviousFile.FileEntry, &File->FileEntry);
1857 DuplicateFid (PreviousFile.FileIdentifierDesc,
1858 &File->FileIdentifierDesc);
1859 goto Next_Path_Component;
1860 case 5:
1861 //
1862 // This Path Component identifies an object, either a file or a
1863 // directory or an alias.
1864 //
1865 // Decode it from the compressed data in ComponentIdentifier and find
1866 // respective path.
1867 //
1868 CompressionId = PathComp->ComponentIdentifier[0];
1869 if (!IS_VALID_COMPRESSION_ID (CompressionId)) {
1870 return EFI_VOLUME_CORRUPTED;
1871 }
1872
1873 C = FileName;
1874 for (Index = 1; Index < PathCompLength; Index++) {
1875 if (CompressionId == 16) {
1876 *C = *(UINT8 *)((UINT8 *)PathComp->ComponentIdentifier +
1877 Index) << 8;
1878 Index++;
1879 } else {
1880 *C = 0;
1881 }
1882
1883 if (Index < Length) {
1884 *C |= *(UINT8 *)((UINT8 *)PathComp->ComponentIdentifier + Index);
1885 }
1886
1887 C++;
1888 }
1889
1890 *C = L'\0';
1891 break;
1892 }
1893
1894 //
1895 // Find file from the read filename in symlink's file data.
1896 //
1897 Status = InternalFindFile (
1898 BlockIo,
1899 DiskIo,
1900 Volume,
1901 FileName,
1902 &PreviousFile,
1903 NULL,
1904 File
1905 );
1906 if (EFI_ERROR (Status)) {
1907 goto Error_Find_File;
1908 }
1909
1910 Next_Path_Component:
1911 Data += sizeof (UDF_PATH_COMPONENT) + PathCompLength;
1912 if (Data >= EndData) {
1913 break;
1914 }
1915
1916 if (CompareMem ((VOID *)&PreviousFile, (VOID *)Parent,
1917 sizeof (UDF_FILE_INFO)) != 0) {
1918 CleanupFileInformation (&PreviousFile);
1919 }
1920
1921 CopyMem ((VOID *)&PreviousFile, (VOID *)File, sizeof (UDF_FILE_INFO));
1922 }
1923
1924 //
1925 // Unmap the symlink file.
1926 //
1927 FreePool (ReadFileInfo.FileData);
1928
1929 return EFI_SUCCESS;
1930
1931 Error_Find_File:
1932 if (CompareMem ((VOID *)&PreviousFile, (VOID *)Parent,
1933 sizeof (UDF_FILE_INFO)) != 0) {
1934 CleanupFileInformation (&PreviousFile);
1935 }
1936
1937 FreePool (ReadFileInfo.FileData);
1938
1939 return Status;
1940 }
1941
1942 /**
1943 Clean up in-memory UDF volume information.
1944
1945 @param[in] Volume Volume information pointer.
1946
1947 **/
1948 VOID
1949 CleanupVolumeInformation (
1950 IN UDF_VOLUME_INFO *Volume
1951 )
1952 {
1953 UINTN Index;
1954
1955 if (Volume->LogicalVolDescs != NULL) {
1956 for (Index = 0; Index < Volume->LogicalVolDescsNo; Index++) {
1957 FreePool ((VOID *)Volume->LogicalVolDescs[Index]);
1958 }
1959 FreePool ((VOID *)Volume->LogicalVolDescs);
1960 }
1961
1962 if (Volume->PartitionDescs != NULL) {
1963 for (Index = 0; Index < Volume->PartitionDescsNo; Index++) {
1964 FreePool ((VOID *)Volume->PartitionDescs[Index]);
1965 }
1966 FreePool ((VOID *)Volume->PartitionDescs);
1967 }
1968
1969 if (Volume->FileSetDescs != NULL) {
1970 for (Index = 0; Index < Volume->FileSetDescsNo; Index++) {
1971 FreePool ((VOID *)Volume->FileSetDescs[Index]);
1972 }
1973 FreePool ((VOID *)Volume->FileSetDescs);
1974 }
1975
1976 ZeroMem ((VOID *)Volume, sizeof (UDF_VOLUME_INFO));
1977 }
1978
1979 /**
1980 Clean up in-memory UDF file information.
1981
1982 @param[in] File File information pointer.
1983
1984 **/
1985 VOID
1986 CleanupFileInformation (
1987 IN UDF_FILE_INFO *File
1988 )
1989 {
1990 if (File->FileEntry != NULL) {
1991 FreePool (File->FileEntry);
1992 }
1993 if (File->FileIdentifierDesc != NULL) {
1994 FreePool ((VOID *)File->FileIdentifierDesc);
1995 }
1996
1997 ZeroMem ((VOID *)File, sizeof (UDF_FILE_INFO));
1998 }
1999
2000 /**
2001 Find a file from its absolute path on an UDF volume.
2002
2003 @param[in] BlockIo BlockIo interface.
2004 @param[in] DiskIo DiskIo interface.
2005 @param[in] Volume UDF volume information structure.
2006 @param[in] File File information structure.
2007 @param[out] Size Size of the file.
2008
2009 @retval EFI_SUCCESS File size calculated and set in @p Size.
2010 @retval EFI_UNSUPPORTED Extended Allocation Descriptors not supported.
2011 @retval EFI_NO_MEDIA The device has no media.
2012 @retval EFI_DEVICE_ERROR The device reported an error.
2013 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
2014 @retval EFI_OUT_OF_RESOURCES The file size was not calculated due to lack of
2015 resources.
2016
2017 **/
2018 EFI_STATUS
2019 GetFileSize (
2020 IN EFI_BLOCK_IO_PROTOCOL *BlockIo,
2021 IN EFI_DISK_IO_PROTOCOL *DiskIo,
2022 IN UDF_VOLUME_INFO *Volume,
2023 IN UDF_FILE_INFO *File,
2024 OUT UINT64 *Size
2025 )
2026 {
2027 EFI_STATUS Status;
2028 UDF_READ_FILE_INFO ReadFileInfo;
2029
2030 ReadFileInfo.Flags = READ_FILE_GET_FILESIZE;
2031
2032 Status = ReadFile (
2033 BlockIo,
2034 DiskIo,
2035 Volume,
2036 &File->FileIdentifierDesc->Icb,
2037 File->FileEntry,
2038 &ReadFileInfo
2039 );
2040 if (EFI_ERROR (Status)) {
2041 return Status;
2042 }
2043
2044 *Size = ReadFileInfo.ReadLength;
2045
2046 return EFI_SUCCESS;
2047 }
2048
2049 /**
2050 Set information about a file on an UDF volume.
2051
2052 @param[in] File File pointer.
2053 @param[in] FileSize Size of the file.
2054 @param[in] FileName Filename of the file.
2055 @param[in out] BufferSize Size of the returned file infomation.
2056 @param[out] Buffer Data of the returned file information.
2057
2058 @retval EFI_SUCCESS File information set.
2059 @retval EFI_NO_MEDIA The device has no media.
2060 @retval EFI_DEVICE_ERROR The device reported an error.
2061 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
2062 @retval EFI_OUT_OF_RESOURCES The file information was not set due to lack of
2063 resources.
2064
2065 **/
2066 EFI_STATUS
2067 SetFileInfo (
2068 IN UDF_FILE_INFO *File,
2069 IN UINT64 FileSize,
2070 IN CHAR16 *FileName,
2071 IN OUT UINTN *BufferSize,
2072 OUT VOID *Buffer
2073 )
2074 {
2075 UINTN FileInfoLength;
2076 EFI_FILE_INFO *FileInfo;
2077 UDF_FILE_ENTRY *FileEntry;
2078 UDF_EXTENDED_FILE_ENTRY *ExtendedFileEntry;
2079
2080 //
2081 // Calculate the needed size for the EFI_FILE_INFO structure.
2082 //
2083 FileInfoLength = sizeof (EFI_FILE_INFO) + (FileName ?
2084 StrSize (FileName) :
2085 sizeof (CHAR16));
2086 if (*BufferSize < FileInfoLength) {
2087 //
2088 // The given Buffer has no size enough for EFI_FILE_INFO structure.
2089 //
2090 *BufferSize = FileInfoLength;
2091 return EFI_BUFFER_TOO_SMALL;
2092 }
2093
2094 //
2095 // Buffer now contains room enough to store EFI_FILE_INFO structure.
2096 // Now, fill it in with all necessary information about the file.
2097 //
2098 FileInfo = (EFI_FILE_INFO *)Buffer;
2099 FileInfo->Size = FileInfoLength;
2100 FileInfo->Attribute &= ~EFI_FILE_VALID_ATTR;
2101 FileInfo->Attribute |= EFI_FILE_READ_ONLY;
2102
2103 if (IS_FID_DIRECTORY_FILE (File->FileIdentifierDesc)) {
2104 FileInfo->Attribute |= EFI_FILE_DIRECTORY;
2105 } else if (IS_FID_NORMAL_FILE (File->FileIdentifierDesc)) {
2106 FileInfo->Attribute |= EFI_FILE_ARCHIVE;
2107 }
2108
2109 if (IS_FID_HIDDEN_FILE (File->FileIdentifierDesc)) {
2110 FileInfo->Attribute |= EFI_FILE_HIDDEN;
2111 }
2112
2113 if (IS_FE (File->FileEntry)) {
2114 FileEntry = (UDF_FILE_ENTRY *)File->FileEntry;
2115
2116 //
2117 // Check if FE has the system attribute set.
2118 //
2119 if (FileEntry->IcbTag.Flags & (1 << 10)) {
2120 FileInfo->Attribute |= EFI_FILE_SYSTEM;
2121 }
2122
2123 FileInfo->FileSize = FileSize;
2124 FileInfo->PhysicalSize = FileSize;
2125
2126 FileInfo->CreateTime.Year = FileEntry->AccessTime.Year;
2127 FileInfo->CreateTime.Month = FileEntry->AccessTime.Month;
2128 FileInfo->CreateTime.Day = FileEntry->AccessTime.Day;
2129 FileInfo->CreateTime.Hour = FileEntry->AccessTime.Hour;
2130 FileInfo->CreateTime.Minute = FileEntry->AccessTime.Second;
2131 FileInfo->CreateTime.Second = FileEntry->AccessTime.Second;
2132 FileInfo->CreateTime.Nanosecond =
2133 FileEntry->AccessTime.HundredsOfMicroseconds;
2134
2135 FileInfo->LastAccessTime.Year =
2136 FileEntry->AccessTime.Year;
2137 FileInfo->LastAccessTime.Month =
2138 FileEntry->AccessTime.Month;
2139 FileInfo->LastAccessTime.Day =
2140 FileEntry->AccessTime.Day;
2141 FileInfo->LastAccessTime.Hour =
2142 FileEntry->AccessTime.Hour;
2143 FileInfo->LastAccessTime.Minute =
2144 FileEntry->AccessTime.Minute;
2145 FileInfo->LastAccessTime.Second =
2146 FileEntry->AccessTime.Second;
2147 FileInfo->LastAccessTime.Nanosecond =
2148 FileEntry->AccessTime.HundredsOfMicroseconds;
2149 } else if (IS_EFE (File->FileEntry)) {
2150 ExtendedFileEntry = (UDF_EXTENDED_FILE_ENTRY *)File->FileEntry;
2151
2152 //
2153 // Check if EFE has the system attribute set.
2154 //
2155 if (ExtendedFileEntry->IcbTag.Flags & (1 << 10)) {
2156 FileInfo->Attribute |= EFI_FILE_SYSTEM;
2157 }
2158
2159 FileInfo->FileSize = FileSize;
2160 FileInfo->PhysicalSize = FileSize;
2161
2162 FileInfo->CreateTime.Year = ExtendedFileEntry->CreationTime.Year;
2163 FileInfo->CreateTime.Month = ExtendedFileEntry->CreationTime.Month;
2164 FileInfo->CreateTime.Day = ExtendedFileEntry->CreationTime.Day;
2165 FileInfo->CreateTime.Hour = ExtendedFileEntry->CreationTime.Hour;
2166 FileInfo->CreateTime.Minute = ExtendedFileEntry->CreationTime.Second;
2167 FileInfo->CreateTime.Second = ExtendedFileEntry->CreationTime.Second;
2168 FileInfo->CreateTime.Nanosecond =
2169 ExtendedFileEntry->AccessTime.HundredsOfMicroseconds;
2170
2171 FileInfo->LastAccessTime.Year =
2172 ExtendedFileEntry->AccessTime.Year;
2173 FileInfo->LastAccessTime.Month =
2174 ExtendedFileEntry->AccessTime.Month;
2175 FileInfo->LastAccessTime.Day =
2176 ExtendedFileEntry->AccessTime.Day;
2177 FileInfo->LastAccessTime.Hour =
2178 ExtendedFileEntry->AccessTime.Hour;
2179 FileInfo->LastAccessTime.Minute =
2180 ExtendedFileEntry->AccessTime.Minute;
2181 FileInfo->LastAccessTime.Second =
2182 ExtendedFileEntry->AccessTime.Second;
2183 FileInfo->LastAccessTime.Nanosecond =
2184 ExtendedFileEntry->AccessTime.HundredsOfMicroseconds;
2185 }
2186
2187 FileInfo->CreateTime.TimeZone = EFI_UNSPECIFIED_TIMEZONE;
2188 FileInfo->CreateTime.Daylight = EFI_TIME_ADJUST_DAYLIGHT;
2189 FileInfo->LastAccessTime.TimeZone = EFI_UNSPECIFIED_TIMEZONE;
2190 FileInfo->LastAccessTime.Daylight = EFI_TIME_ADJUST_DAYLIGHT;
2191
2192 CopyMem ((VOID *)&FileInfo->ModificationTime,
2193 (VOID *)&FileInfo->LastAccessTime,
2194 sizeof (EFI_TIME));
2195
2196 if (FileName != NULL) {
2197 StrCpyS (FileInfo->FileName, StrLen (FileName) + 1, FileName);
2198 } else {
2199 FileInfo->FileName[0] = '\0';
2200 }
2201
2202 *BufferSize = FileInfoLength;
2203
2204 return EFI_SUCCESS;
2205 }
2206
2207 /**
2208 Get volume and free space size information of an UDF volume.
2209
2210 @param[in] BlockIo BlockIo interface.
2211 @param[in] DiskIo DiskIo interface.
2212 @param[in] Volume UDF volume information structure.
2213 @param[out] VolumeSize Volume size.
2214 @param[out] FreeSpaceSize Free space size.
2215
2216 @retval EFI_SUCCESS Volume and free space size calculated.
2217 @retval EFI_NO_MEDIA The device has no media.
2218 @retval EFI_DEVICE_ERROR The device reported an error.
2219 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
2220 @retval EFI_OUT_OF_RESOURCES The volume and free space size were not
2221 calculated due to lack of resources.
2222
2223 **/
2224 EFI_STATUS
2225 GetVolumeSize (
2226 IN EFI_BLOCK_IO_PROTOCOL *BlockIo,
2227 IN EFI_DISK_IO_PROTOCOL *DiskIo,
2228 IN UDF_VOLUME_INFO *Volume,
2229 OUT UINT64 *VolumeSize,
2230 OUT UINT64 *FreeSpaceSize
2231 )
2232 {
2233 UDF_EXTENT_AD ExtentAd;
2234 UINT32 LogicalBlockSize;
2235 UINT64 Lsn;
2236 EFI_STATUS Status;
2237 UDF_LOGICAL_VOLUME_INTEGRITY *LogicalVolInt;
2238 UINTN Index;
2239 UINTN Length;
2240 UINT32 LsnsNo;
2241
2242 *VolumeSize = 0;
2243 *FreeSpaceSize = 0;
2244
2245 for (Index = 0; Index < Volume->LogicalVolDescsNo; Index++) {
2246 CopyMem ((VOID *)&ExtentAd,
2247 (VOID *)&Volume->LogicalVolDescs[Index]->IntegritySequenceExtent,
2248 sizeof (UDF_EXTENT_AD));
2249 if (ExtentAd.ExtentLength == 0) {
2250 continue;
2251 }
2252
2253 LogicalBlockSize = LV_BLOCK_SIZE (Volume, Index);
2254
2255 Read_Next_Sequence:
2256 LogicalVolInt = (UDF_LOGICAL_VOLUME_INTEGRITY *)
2257 AllocatePool (ExtentAd.ExtentLength);
2258 if (LogicalVolInt == NULL) {
2259 return EFI_OUT_OF_RESOURCES;
2260 }
2261
2262 Lsn = (UINT64)ExtentAd.ExtentLocation;
2263
2264 Status = DiskIo->ReadDisk (
2265 DiskIo,
2266 BlockIo->Media->MediaId,
2267 MultU64x32 (Lsn, LogicalBlockSize),
2268 ExtentAd.ExtentLength,
2269 (VOID *)LogicalVolInt
2270 );
2271 if (EFI_ERROR (Status)) {
2272 FreePool ((VOID *)LogicalVolInt);
2273 return Status;
2274 }
2275
2276 if (!IS_LVID (LogicalVolInt)) {
2277 FreePool ((VOID *)LogicalVolInt);
2278 return EFI_VOLUME_CORRUPTED;
2279 }
2280
2281 Length = LogicalVolInt->NumberOfPartitions;
2282 for (Index = 0; Index < Length; Index += sizeof (UINT32)) {
2283 LsnsNo = *(UINT32 *)((UINT8 *)LogicalVolInt->Data + Index);
2284 if (LsnsNo == 0xFFFFFFFFUL) {
2285 //
2286 // Size not specified.
2287 //
2288 continue;
2289 }
2290
2291 *FreeSpaceSize += MultU64x32 ((UINT64)LsnsNo, LogicalBlockSize);
2292 }
2293
2294 Length = (LogicalVolInt->NumberOfPartitions * sizeof (UINT32)) << 1;
2295 for (; Index < Length; Index += sizeof (UINT32)) {
2296 LsnsNo = *(UINT32 *)((UINT8 *)LogicalVolInt->Data + Index);
2297 if (LsnsNo == 0xFFFFFFFFUL) {
2298 //
2299 // Size not specified.
2300 //
2301 continue;
2302 }
2303
2304 *VolumeSize += MultU64x32 ((UINT64)LsnsNo, LogicalBlockSize);
2305 }
2306
2307 CopyMem ((VOID *)&ExtentAd,(VOID *)&LogicalVolInt->NextIntegrityExtent,
2308 sizeof (UDF_EXTENT_AD));
2309 if (ExtentAd.ExtentLength > 0) {
2310 FreePool ((VOID *)LogicalVolInt);
2311 goto Read_Next_Sequence;
2312 }
2313
2314 FreePool ((VOID *)LogicalVolInt);
2315 }
2316
2317 return EFI_SUCCESS;
2318 }
2319
2320 /**
2321 Seek a file and read its data into memory on an UDF volume.
2322
2323 @param[in] BlockIo BlockIo interface.
2324 @param[in] DiskIo DiskIo interface.
2325 @param[in] Volume UDF volume information structure.
2326 @param[in] File File information structure.
2327 @param[in] FileSize Size of the file.
2328 @param[in out] FilePosition File position.
2329 @param[in out] Buffer File data.
2330 @param[in out] BufferSize Read size.
2331
2332 @retval EFI_SUCCESS File seeked and read.
2333 @retval EFI_UNSUPPORTED Extended Allocation Descriptors not supported.
2334 @retval EFI_NO_MEDIA The device has no media.
2335 @retval EFI_DEVICE_ERROR The device reported an error.
2336 @retval EFI_VOLUME_CORRUPTED The file system structures are corrupted.
2337 @retval EFI_OUT_OF_RESOURCES The file's recorded data was not read due to lack
2338 of resources.
2339
2340 **/
2341 EFI_STATUS
2342 ReadFileData (
2343 IN EFI_BLOCK_IO_PROTOCOL *BlockIo,
2344 IN EFI_DISK_IO_PROTOCOL *DiskIo,
2345 IN UDF_VOLUME_INFO *Volume,
2346 IN UDF_FILE_INFO *File,
2347 IN UINT64 FileSize,
2348 IN OUT UINT64 *FilePosition,
2349 IN OUT VOID *Buffer,
2350 IN OUT UINT64 *BufferSize
2351 )
2352 {
2353 EFI_STATUS Status;
2354 UDF_READ_FILE_INFO ReadFileInfo;
2355
2356 ReadFileInfo.Flags = READ_FILE_SEEK_AND_READ;
2357 ReadFileInfo.FilePosition = *FilePosition;
2358 ReadFileInfo.FileData = Buffer;
2359 ReadFileInfo.FileDataSize = *BufferSize;
2360 ReadFileInfo.FileSize = FileSize;
2361
2362 Status = ReadFile (
2363 BlockIo,
2364 DiskIo,
2365 Volume,
2366 &File->FileIdentifierDesc->Icb,
2367 File->FileEntry,
2368 &ReadFileInfo
2369 );
2370 if (EFI_ERROR (Status)) {
2371 return Status;
2372 }
2373
2374 *BufferSize = ReadFileInfo.FileDataSize;
2375 *FilePosition = ReadFileInfo.FilePosition;
2376
2377 return EFI_SUCCESS;
2378 }
2379
2380 /**
2381 Check if ControllerHandle supports an UDF file system.
2382
2383 @param[in] This Protocol instance pointer.
2384 @param[in] ControllerHandle Handle of device to test.
2385
2386 @retval EFI_SUCCESS UDF file system found.
2387 @retval EFI_UNSUPPORTED UDF file system not found.
2388
2389 **/
2390 EFI_STATUS
2391 SupportUdfFileSystem (
2392 IN EFI_DRIVER_BINDING_PROTOCOL *This,
2393 IN EFI_HANDLE ControllerHandle
2394 )
2395 {
2396 EFI_STATUS Status;
2397 EFI_DEVICE_PATH_PROTOCOL *DevicePath;
2398 EFI_DEVICE_PATH_PROTOCOL *DevicePathNode;
2399 EFI_DEVICE_PATH_PROTOCOL *LastDevicePathNode;
2400 EFI_GUID *VendorDefinedGuid;
2401 EFI_GUID UdfDevPathGuid = EFI_UDF_DEVICE_PATH_GUID;
2402
2403 //
2404 // Open Device Path protocol on ControllerHandle
2405 //
2406 Status = gBS->OpenProtocol (
2407 ControllerHandle,
2408 &gEfiDevicePathProtocolGuid,
2409 (VOID **)&DevicePath,
2410 This->DriverBindingHandle,
2411 ControllerHandle,
2412 EFI_OPEN_PROTOCOL_GET_PROTOCOL
2413 );
2414 if (EFI_ERROR (Status)) {
2415 return EFI_UNSUPPORTED;
2416 }
2417
2418 Status = EFI_UNSUPPORTED;
2419
2420 //
2421 // Get last Device Path node
2422 //
2423 LastDevicePathNode = NULL;
2424 DevicePathNode = DevicePath;
2425 while (!IsDevicePathEnd (DevicePathNode)) {
2426 LastDevicePathNode = DevicePathNode;
2427 DevicePathNode = NextDevicePathNode (DevicePathNode);
2428 }
2429 //
2430 // Check if last Device Path node contains a Vendor-Defined Media Device Path
2431 // of an UDF file system.
2432 //
2433 if (LastDevicePathNode != NULL &&
2434 DevicePathType (LastDevicePathNode) == MEDIA_DEVICE_PATH &&
2435 DevicePathSubType (LastDevicePathNode) == MEDIA_VENDOR_DP) {
2436 VendorDefinedGuid = (EFI_GUID *)((UINTN)LastDevicePathNode +
2437 OFFSET_OF (VENDOR_DEVICE_PATH, Guid));
2438 if (CompareGuid (VendorDefinedGuid, &UdfDevPathGuid)) {
2439 Status = EFI_SUCCESS;
2440 }
2441 }
2442
2443 //
2444 // Close Device Path protocol on ControllerHandle
2445 //
2446 gBS->CloseProtocol (
2447 ControllerHandle,
2448 &gEfiDevicePathProtocolGuid,
2449 This->DriverBindingHandle,
2450 ControllerHandle
2451 );
2452
2453 return Status;
2454 }