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