1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
|
/** @file
File IO routines inspired by Streams with an EFI flavor
Copyright (c) 2007, Intel Corporation<BR>
Portions copyright (c) 2008-2009, Apple Inc. All rights reserved.
All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License
which accompanies this distribution. The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Basic support for opening files on different device types. The device string
is in the form of DevType:Path. Current DevType is required as there is no
current mounted device concept of current working directory concept implement
by this library.
Device names are case insensative and only check the leading characters for
unique matches. Thus the following are all the same:
LoadFile0:
l0:
L0:
Lo0:
Supported Device Names:
A0x1234:0x12 - A memory buffer starting at address 0x1234 for 0x12 bytes
l1: - EFI LoadFile device one.
B0: - EFI BlockIo zero.
fs3: - EFI Simple File System device 3
Fv2: - EFI Firmware VOlume device 2
10.0.1.102: - TFTP service IP followed by the file name
**/
#include <PiDxe.h>
#include <Protocol/BlockIo.h>
#include <Protocol/DiskIo.h>
#include <Protocol/SimpleFileSystem.h>
#include <Protocol/FirmwareVolume2.h>
#include <Protocol/LoadFile.h>
#include <Protocol/FirmwareVolumeBlock.h>
#include <Guid/FileInfo.h>
#include <Library/BaseLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/DevicePathLib.h>
#include <Library/PrintLib.h>
#include <Library/BaseMemoryLib.h>
#include <Library/UefiLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiRuntimeServicesTableLib.h>
#include <Library/DebugLib.h>
#include <Library/EfiFileLib.h>
#include <Library/PcdLib.h>
#include <Library/EblNetworkLib.h>
CHAR8 *gCwd = NULL;
#define EFI_OPEN_FILE_GUARD_HEADER 0x4B4D4641
#define EFI_OPEN_FILE_GUARD_FOOTER 0x444D5A56
// Need to defend against this overflowing
#define MAX_CMD_LINE 0x200
typedef struct {
UINT32 Header;
EFI_OPEN_FILE File;
UINT32 Footer;
} EFI_OPEN_FILE_GUARD;
// globals to store current open device info
EFI_HANDLE *mBlkIo = NULL;
UINTN mBlkIoCount = 0;
EFI_HANDLE *mFs = NULL;
UINTN mFsCount = 0;
// mFsInfo[] array entries must match mFs[] handles
EFI_FILE_SYSTEM_INFO **mFsInfo = NULL;
EFI_HANDLE *mFv = NULL;
UINTN mFvCount = 0;
EFI_HANDLE *mLoadFile = NULL;
UINTN mLoadFileCount = 0;
/**
Internal worker function to validate a File handle.
@param File Open File Handle
@return TRUE File is valid
@return FALSE File is not valid
**/
BOOLEAN
FileHandleValid (
IN EFI_OPEN_FILE *File
)
{
EFI_OPEN_FILE_GUARD *GuardFile;
// Look right before and after file structure for the correct signatures
GuardFile = BASE_CR (File, EFI_OPEN_FILE_GUARD, File);
if ((GuardFile->Header != EFI_OPEN_FILE_GUARD_HEADER) ||
(GuardFile->Footer != EFI_OPEN_FILE_GUARD_FOOTER) ) {
return FALSE;
}
return TRUE;
}
/**
Internal worker function. If Buffer is not NULL free it.
@param Buffer Buffer to FreePool()
**/
VOID
EblFreePool (
IN VOID *Buffer
)
{
if (Buffer != NULL) {
FreePool (Buffer);
}
}
/**
Update Device List Global Variables
**/
VOID
EblUpdateDeviceLists (
VOID
)
{
EFI_STATUS Status;
UINTN Size;
EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *Fs;
EFI_FILE_HANDLE Root;
UINTN Index;
if (mBlkIo != NULL) {
FreePool (mBlkIo);
}
gBS->LocateHandleBuffer (ByProtocol, &gEfiBlockIoProtocolGuid, NULL, &mBlkIoCount, &mBlkIo);
if (mFv != NULL) {
FreePool (mFv);
}
gBS->LocateHandleBuffer (ByProtocol, &gEfiFirmwareVolume2ProtocolGuid, NULL, &mFvCount, &mFv);
if (mLoadFile != NULL) {
FreePool (mLoadFile);
}
gBS->LocateHandleBuffer (ByProtocol, &gEfiLoadFileProtocolGuid, NULL, &mLoadFileCount, &mLoadFile);
if (mFs != NULL) {
FreePool (mFs);
}
if (&mFsInfo[0] != NULL) {
// Need to Free the mFsInfo prior to reclaculating mFsCount so don't move this code
for (Index = 0; Index < mFsCount; Index++) {
if (mFsInfo[Index] != NULL) {
FreePool (mFsInfo[Index]);
}
}
FreePool (mFsInfo);
}
gBS->LocateHandleBuffer (ByProtocol, &gEfiSimpleFileSystemProtocolGuid, NULL, &mFsCount, &mFs);
mFsInfo = AllocateZeroPool (mFsCount * sizeof (EFI_FILE_SYSTEM_INFO *));
if (mFsInfo == NULL) {
// If we can't do this then we can't support file system entries
mFsCount = 0;
} else {
// Loop through all the file system structures and cache the file system info data
for (Index =0; Index < mFsCount; Index++) {
Status = gBS->HandleProtocol (mFs[Index], &gEfiSimpleFileSystemProtocolGuid, (VOID **)&Fs);
if (!EFI_ERROR (Status)) {
Status = Fs->OpenVolume (Fs, &Root);
if (!EFI_ERROR (Status)) {
// Get information about the volume
Size = 0;
Status = Root->GetInfo (Root, &gEfiFileSystemInfoGuid, &Size, mFsInfo[Index]);
if (Status == EFI_BUFFER_TOO_SMALL) {
mFsInfo[Index] = AllocatePool (Size);
Status = Root->GetInfo (Root, &gEfiFileSystemInfoGuid, &Size, mFsInfo[Index]);
}
Root->Close (Root);
}
}
}
}
}
/**
PathName is in the form <device name>:<path> for example fs1:\ or ROOT:\.
Return TRUE if the <devce name> prefix of PathName matches a file system
Volume Name. MatchIndex is the array index in mFsInfo[] of the match,
and it can be used with mFs[] to find the handle that needs to be opened
@param PathName PathName to check
@param FileStart Index of the first character of the <path>
@param MatchIndex Index in mFsInfo[] that matches
@return TRUE PathName matches a Volume Label and MatchIndex is valid
@return FALSE PathName does not match a Volume Label MatchIndex undefined
**/
BOOLEAN
EblMatchVolumeName (
IN CHAR8 *PathName,
IN UINTN FileStart,
OUT UINTN *MatchIndex
)
{
UINTN Index;
UINTN Compare;
UINTN VolStrLen;
BOOLEAN Match;
for (Index =0; Index < mFsCount; Index++) {
if (mFsInfo[Index] == NULL) {
// FsInfo is not valid so skip it
continue;
}
VolStrLen = StrLen (mFsInfo[Index]->VolumeLabel);
for (Compare = 0, Match = TRUE; Compare < (FileStart - 1); Compare++) {
if (Compare > VolStrLen) {
Match = FALSE;
break;
}
if (PathName[Compare] != (CHAR8)mFsInfo[Index]->VolumeLabel[Compare]) {
// If the VolumeLabel has a space allow a _ to match with it in addition to ' '
if (!((PathName[Compare] == '_') && (mFsInfo[Index]->VolumeLabel[Compare] == L' '))) {
Match = FALSE;
break;
}
}
}
if (Match) {
*MatchIndex = Index;
return TRUE;
}
}
return FALSE;
}
/**
Return the number of devices of the current type active in the system
@param Type Device type to check
@return 0 Invalid type
**/
UINTN
EfiGetDeviceCounts (
IN EFI_OPEN_FILE_TYPE DeviceType
)
{
switch (DeviceType) {
case EfiOpenLoadFile:
return mLoadFileCount;
case EfiOpenFirmwareVolume:
return mFvCount;
case EfiOpenFileSystem:
return mFsCount;
case EfiOpenBlockIo:
return mBlkIoCount;
default:
return 0;
}
}
EFI_STATUS
ConvertIpStringToEfiIp (
IN CHAR8 *PathName,
OUT EFI_IP_ADDRESS *ServerIp
)
{
CHAR8 *Str;
Str = PathName;
ServerIp->v4.Addr[0] = (UINT8)AsciiStrDecimalToUintn (Str);
Str = AsciiStrStr (Str, ".");
if (Str == NULL) {
return EFI_DEVICE_ERROR;
}
ServerIp->v4.Addr[1] = (UINT8)AsciiStrDecimalToUintn (++Str);
Str = AsciiStrStr (Str, ".");
if (Str == NULL) {
return EFI_DEVICE_ERROR;
}
ServerIp->v4.Addr[2] = (UINT8)AsciiStrDecimalToUintn (++Str);
Str = AsciiStrStr (Str, ".");
if (Str == NULL) {
return EFI_DEVICE_ERROR;
}
ServerIp->v4.Addr[3] = (UINT8)AsciiStrDecimalToUintn (++Str);
return EFI_SUCCESS;
}
/**
Internal work function to extract a device number from a string skipping
text. Easy way to extract numbers from strings like blk7:.
@param Str String to extract device number form
@return -1 Device string is not valid
@return Device #
**/
UINTN
EblConvertDevStringToNumber (
IN CHAR8 *Str
)
{
UINTN Max;
UINTN Index;
// Find the first digit
Max = AsciiStrLen (Str);
for (Index = 0; !((*Str >= '0') && (*Str <= '9')) && (Index < Max); Index++) {
Str++;
}
if (Index == Max) {
return (UINTN)-1;
}
return AsciiStrDecimalToUintn (Str);
}
/**
Internal work function to fill in EFI_OPEN_FILE information for the Fs and BlkIo
@param File Open file handle
@param FileName Name of file after device stripped off
**/
EFI_STATUS
EblFileDevicePath (
IN OUT EFI_OPEN_FILE *File,
IN CHAR8 *FileName,
IN CONST UINT64 OpenMode
)
{
EFI_STATUS Status;
UINTN Size;
FILEPATH_DEVICE_PATH *FilePath;
EFI_DEVICE_PATH_PROTOCOL *FileDevicePath;
CHAR16 UnicodeFileName[MAX_PATHNAME];
EFI_BLOCK_IO_PROTOCOL *BlkIo;
EFI_SIMPLE_FILE_SYSTEM_PROTOCOL *Fs;
EFI_FILE_HANDLE Root;
if ( *FileName != 0 ) {
AsciiStrToUnicodeStr (FileName, UnicodeFileName);
} else {
AsciiStrToUnicodeStr ("\\", UnicodeFileName);
}
Size = StrSize (UnicodeFileName);
FileDevicePath = AllocatePool (Size + SIZE_OF_FILEPATH_DEVICE_PATH + sizeof (EFI_DEVICE_PATH_PROTOCOL));
if (FileDevicePath != NULL) {
FilePath = (FILEPATH_DEVICE_PATH *) FileDevicePath;
FilePath->Header.Type = MEDIA_DEVICE_PATH;
FilePath->Header.SubType = MEDIA_FILEPATH_DP;
CopyMem (&FilePath->PathName, UnicodeFileName, Size);
SetDevicePathNodeLength (&FilePath->Header, Size + SIZE_OF_FILEPATH_DEVICE_PATH);
SetDevicePathEndNode (NextDevicePathNode (&FilePath->Header));
if (File->EfiHandle != NULL) {
File->DevicePath = DevicePathFromHandle (File->EfiHandle);
}
File->DevicePath = AppendDevicePath (File->DevicePath, FileDevicePath);
FreePool (FileDevicePath);
}
Status = gBS->HandleProtocol (File->EfiHandle, &gEfiBlockIoProtocolGuid, (VOID **)&BlkIo);
if (!EFI_ERROR (Status)) {
CopyMem (&File->FsBlockIoMedia, BlkIo->Media, sizeof (EFI_BLOCK_IO_MEDIA));
// If we are not opening the device this will get over written with file info
File->MaxPosition = MultU64x32 (BlkIo->Media->LastBlock + 1, BlkIo->Media->BlockSize);
}
if (File->Type == EfiOpenFileSystem) {
Status = gBS->HandleProtocol (File->EfiHandle, &gEfiSimpleFileSystemProtocolGuid, (VOID **)&Fs);
if (!EFI_ERROR (Status)) {
Status = Fs->OpenVolume (Fs, &Root);
if (!EFI_ERROR (Status)) {
// Get information about the volume
Size = 0;
Status = Root->GetInfo (Root, &gEfiFileSystemInfoGuid, &Size, File->FsInfo);
if (Status == EFI_BUFFER_TOO_SMALL) {
File->FsInfo = AllocatePool (Size);
Status = Root->GetInfo (Root, &gEfiFileSystemInfoGuid, &Size, File->FsInfo);
}
// Get information about the file
Status = Root->Open (Root, &File->FsFileHandle, UnicodeFileName, OpenMode, 0);
if (!EFI_ERROR (Status)) {
Size = 0;
Status = File->FsFileHandle->GetInfo (File->FsFileHandle, &gEfiFileInfoGuid, &Size, NULL);
if (Status == EFI_BUFFER_TOO_SMALL) {
File->FsFileInfo = AllocatePool (Size);
Status = File->FsFileHandle->GetInfo (File->FsFileHandle, &gEfiFileInfoGuid, &Size, File->FsFileInfo);
if (!EFI_ERROR (Status)) {
File->Size = (UINTN)File->FsFileInfo->FileSize;
File->MaxPosition = (UINT64)File->Size;
}
}
}
Root->Close (Root);
}
}
} else if (File->Type == EfiOpenBlockIo) {
File->Size = (UINTN)File->MaxPosition;
}
return Status;
}
#define ToUpper(a) ((((a) >= 'a') && ((a) <= 'z')) ? ((a) - 'a' + 'A') : (a))
EFI_STATUS
CompareGuidToString (
IN EFI_GUID *Guid,
IN CHAR8 *String
)
{
CHAR8 AsciiGuid[64];
CHAR8 *StringPtr;
CHAR8 *GuidPtr;
AsciiSPrint (AsciiGuid, sizeof(AsciiGuid), "%g", Guid);
StringPtr = String;
GuidPtr = AsciiGuid;
while ((*StringPtr != '\0') && (*GuidPtr != '\0')) {
// Skip dashes
if (*StringPtr == '-') {
StringPtr++;
continue;
}
if (*GuidPtr == '-') {
GuidPtr++;
continue;
}
if (ToUpper(*StringPtr) != ToUpper(*GuidPtr)) {
return EFI_NOT_FOUND;
}
StringPtr++;
GuidPtr++;
}
return EFI_SUCCESS;
}
/**
Internal work function to fill in EFI_OPEN_FILE information for the FV
@param File Open file handle
@param FileName Name of file after device stripped off
**/
EFI_STATUS
EblFvFileDevicePath (
IN OUT EFI_OPEN_FILE *File,
IN CHAR8 *FileName,
IN CONST UINT64 OpenMode
)
{
EFI_STATUS Status;
EFI_STATUS GetNextFileStatus;
MEDIA_FW_VOL_FILEPATH_DEVICE_PATH DevicePathNode;
EFI_DEVICE_PATH_PROTOCOL *DevicePath;
UINTN Key;
UINT32 AuthenticationStatus;
CHAR8 AsciiSection[MAX_PATHNAME];
VOID *Section;
UINTN SectionSize;
EFI_FIRMWARE_VOLUME_BLOCK_PROTOCOL *Fvb;
EFI_LBA Lba;
UINTN BlockSize;
UINTN NumberOfBlocks;
Status = gBS->HandleProtocol (File->EfiHandle, &gEfiFirmwareVolume2ProtocolGuid, (VOID **)&File->Fv);
if (EFI_ERROR (Status)) {
return Status;
}
DevicePath = DevicePathFromHandle (File->EfiHandle);
if (*FileName == '\0') {
File->DevicePath = DuplicateDevicePath (DevicePath);
} else {
Key = 0;
do {
File->FvType = EFI_FV_FILETYPE_ALL;
GetNextFileStatus = File->Fv->GetNextFile (
File->Fv,
&Key,
&File->FvType,
&File->FvNameGuid,
&File->FvAttributes,
&File->Size
);
if (!EFI_ERROR (GetNextFileStatus)) {
Section = NULL;
// Compare GUID first
Status = CompareGuidToString (&File->FvNameGuid, FileName);
if (!EFI_ERROR(Status)) {
break;
}
Status = File->Fv->ReadSection (
File->Fv,
&File->FvNameGuid,
EFI_SECTION_USER_INTERFACE,
0,
&Section,
&SectionSize,
&AuthenticationStatus
);
if (!EFI_ERROR (Status)) {
UnicodeStrToAsciiStr (Section, AsciiSection);
if (AsciiStriCmp (FileName, AsciiSection) == 0) {
FreePool (Section);
break;
}
FreePool (Section);
}
}
} while (!EFI_ERROR (GetNextFileStatus));
if (EFI_ERROR (GetNextFileStatus)) {
return GetNextFileStatus;
}
File->MaxPosition = File->Size;
EfiInitializeFwVolDevicepathNode (&DevicePathNode, &File->FvNameGuid);
File->DevicePath = AppendDevicePathNode (DevicePath, (EFI_DEVICE_PATH_PROTOCOL *)&DevicePathNode);
}
// Get FVB Info about the handle
Status = gBS->HandleProtocol (File->EfiHandle, &gEfiFirmwareVolumeBlockProtocolGuid, (VOID **)&Fvb);
if (!EFI_ERROR (Status)) {
Status = Fvb->GetPhysicalAddress (Fvb, &File->FvStart);
if (!EFI_ERROR (Status)) {
for (Lba = 0, File->FvSize = 0; ; File->FvSize += (BlockSize * NumberOfBlocks), Lba += NumberOfBlocks) {
Status = Fvb->GetBlockSize (Fvb, Lba, &BlockSize, &NumberOfBlocks);
if (EFI_ERROR (Status)) {
break;
}
}
}
}
// FVB not required if FV was soft loaded...
return EFI_SUCCESS;
}
/**
Open a device named by PathName. The PathName includes a device name and
path seperated by a :. See file header for more details on the PathName
syntax. There is no checking to prevent a file from being opened more than
one type.
SectionType is only used to open an FV. Each file in an FV contains multiple
secitons and only the SectionType section is opened.
For any file that is opened with EfiOpen() must be closed with EfiClose().
@param PathName Path to parse to open
@param OpenMode Same as EFI_FILE.Open()
@param SectionType Section in FV to open.
@return NULL Open failed
@return Valid EFI_OPEN_FILE handle
**/
EFI_OPEN_FILE *
EfiOpen (
IN CHAR8 *PathName,
IN CONST UINT64 OpenMode,
IN CONST EFI_SECTION_TYPE SectionType
)
{
EFI_STATUS Status;
EFI_OPEN_FILE *File;
EFI_OPEN_FILE FileData;
UINTN StrLen;
UINTN FileStart;
UINTN DevNumber = 0;
EFI_OPEN_FILE_GUARD *GuardFile;
BOOLEAN VolumeNameMatch;
EFI_DEVICE_PATH_PROTOCOL *DevicePath;
UINTN Size;
EFI_IP_ADDRESS Ip;
CHAR8 *CwdPlusPathName;
EblUpdateDeviceLists ();
File = &FileData;
ZeroMem (File, sizeof (EFI_OPEN_FILE));
File->FvSectionType = SectionType;
StrLen = AsciiStrSize (PathName);
if (StrLen <= 1) {
// Smallest valid path is 1 char and a null
return NULL;
}
for (FileStart = 0; FileStart < StrLen; FileStart++) {
if (PathName[FileStart] == ':') {
FileStart++;
break;
}
}
if (FileStart == StrLen) {
if (gCwd == NULL) {
// No CWD
return NULL;
}
// We could add a current working diretory concept
CwdPlusPathName = AllocatePool (AsciiStrSize (gCwd) + AsciiStrSize (PathName));
if (CwdPlusPathName == NULL) {
return NULL;
}
if ((PathName[0] == '/') || (PathName[0] == '\\')) {
// PathName starts in / so this means we go to the root of the device in the CWD.
CwdPlusPathName[0] = '\0';
for (FileStart = 0; gCwd[FileStart] != '\0'; FileStart++) {
CwdPlusPathName[FileStart] = gCwd[FileStart];
if (gCwd[FileStart] == ':') {
FileStart++;
CwdPlusPathName[FileStart] = '\0';
break;
}
}
} else {
AsciiStrCpy (CwdPlusPathName, gCwd);
StrLen = AsciiStrLen (gCwd);
if ((*PathName != '/') && (*PathName != '\\') && (gCwd[StrLen-1] != '/') && (gCwd[StrLen-1] != '\\')) {
AsciiStrCat (CwdPlusPathName, "/");
}
}
AsciiStrCat (CwdPlusPathName, PathName);
if (AsciiStrStr (CwdPlusPathName, ":") == NULL) {
// Extra error check to make sure we don't recusre and blow stack
return NULL;
}
File = EfiOpen (CwdPlusPathName, OpenMode, SectionType);
FreePool (CwdPlusPathName);
return File;
}
//
// Matching volume name has precedence over handle based names
//
VolumeNameMatch = EblMatchVolumeName (PathName, FileStart, &DevNumber);
if (!VolumeNameMatch) {
DevNumber = EblConvertDevStringToNumber ((CHAR8 *)PathName);
}
File->DeviceName = AllocatePool (StrLen);
AsciiStrCpy (File->DeviceName, PathName);
File->DeviceName[FileStart - 1] = '\0';
File->FileName = &File->DeviceName[FileStart];
if (File->FileName[0] == '\0') {
// if it is just a file name use / as root
File->FileName = "/";
}
//
// Use best match algorithm on the dev names so we only need to look at the
// first few charters to match the full device name. Short name forms are
// legal from the caller.
//
Status = EFI_SUCCESS;
if (*PathName == 'f' || *PathName == 'F' || VolumeNameMatch) {
if (PathName[1] == 's' || PathName[1] == 'S' || VolumeNameMatch) {
if (DevNumber >= mFsCount) {
goto ErrorExit;
}
File->Type = EfiOpenFileSystem;
File->EfiHandle = mFs[DevNumber];
Status = EblFileDevicePath (File, &PathName[FileStart], OpenMode);
} else if (PathName[1] == 'v' || PathName[1] == 'V') {
if (DevNumber >= mFvCount) {
goto ErrorExit;
}
File->Type = EfiOpenFirmwareVolume;
File->EfiHandle = mFv[DevNumber];
if ((PathName[FileStart] == '/') || (PathName[FileStart] == '\\')) {
// Skip leading / as its not really needed for the FV since no directories are supported
FileStart++;
}
Status = EblFvFileDevicePath (File, &PathName[FileStart], OpenMode);
}
} else if ((*PathName == 'A') || (*PathName == 'a')) {
// Handle a:0x10000000:0x1234 address form a:ADDRESS:SIZE
File->Type = EfiOpenMemoryBuffer;
// 1st colon is at PathName[FileStart - 1]
File->Buffer = (VOID *)AsciiStrHexToUintn (&PathName[FileStart]);
// Find 2nd colon
while ((PathName[FileStart] != ':') && (PathName[FileStart] != '\0')) {
FileStart++;
}
// If we ran out of string, there's no extra data
if (PathName[FileStart] == '\0') {
File->Size = 0;
} else {
File->Size = AsciiStrHexToUintn (&PathName[FileStart + 1]);
}
// if there's no number after the second colon, default
// the end of memory
if (File->Size == 0) {
File->Size = (UINTN)(0 - (UINTN)File->Buffer);
}
File->MaxPosition = File->Size;
File->BaseOffset = (UINTN)File->Buffer;
} else if (*PathName== 'l' || *PathName == 'L') {
if (DevNumber >= mLoadFileCount) {
goto ErrorExit;
}
File->Type = EfiOpenLoadFile;
File->EfiHandle = mLoadFile[DevNumber];
Status = gBS->HandleProtocol (File->EfiHandle, &gEfiLoadFileProtocolGuid, (VOID **)&File->LoadFile);
if (EFI_ERROR (Status)) {
goto ErrorExit;
}
Status = gBS->HandleProtocol (File->EfiHandle, &gEfiDevicePathProtocolGuid, (VOID **)&DevicePath);
if (EFI_ERROR (Status)) {
goto ErrorExit;
}
File->DevicePath = DuplicateDevicePath (DevicePath);
} else if (*PathName == 'b' || *PathName == 'B') {
// Handle b#:0x10000000:0x1234 address form b#:ADDRESS:SIZE
if (DevNumber >= mBlkIoCount) {
goto ErrorExit;
}
File->Type = EfiOpenBlockIo;
File->EfiHandle = mBlkIo[DevNumber];
EblFileDevicePath (File, "", OpenMode);
// 1st colon is at PathName[FileStart - 1]
File->DiskOffset = AsciiStrHexToUintn (&PathName[FileStart]);
// Find 2nd colon
while ((PathName[FileStart] != ':') && (PathName[FileStart] != '\0')) {
FileStart++;
}
// If we ran out of string, there's no extra data
if (PathName[FileStart] == '\0') {
Size = 0;
} else {
Size = AsciiStrHexToUintn (&PathName[FileStart + 1]);
}
// if a zero size is passed in (or the size is left out entirely),
// go to the end of the device.
if (Size == 0) {
File->Size = File->Size - File->DiskOffset;
} else {
File->Size = Size;
}
File->MaxPosition = File->Size;
File->BaseOffset = File->DiskOffset;
} else if ((*PathName) >= '0' && (*PathName <= '9')) {
// Get current IP address
Status = EblGetCurrentIpAddress (&Ip);
if (EFI_ERROR(Status)) {
AsciiPrint("Device IP Address is not configured.\n");
goto ErrorExit;
}
// Parse X.X.X.X:Filename, only support IPv4 TFTP for now...
File->Type = EfiOpenTftp;
File->IsDirty = FALSE;
File->IsBufferValid = FALSE;
Status = ConvertIpStringToEfiIp (PathName, &File->ServerIp);
}
if (EFI_ERROR (Status)) {
goto ErrorExit;
}
GuardFile = (EFI_OPEN_FILE_GUARD *)AllocateZeroPool (sizeof (EFI_OPEN_FILE_GUARD));
if (GuardFile == NULL) {
goto ErrorExit;
}
GuardFile->Header = EFI_OPEN_FILE_GUARD_HEADER;
CopyMem (&(GuardFile->File), &FileData, sizeof (EFI_OPEN_FILE));
GuardFile->Footer = EFI_OPEN_FILE_GUARD_FOOTER;
return &(GuardFile->File);
ErrorExit:
FreePool (File->DeviceName);
return NULL;
}
#define FILE_COPY_CHUNK 0x01000000
EFI_STATUS
EfiCopyFile (
IN CHAR8 *DestinationFile,
IN CHAR8 *SourceFile
)
{
EFI_OPEN_FILE *Source = NULL;
EFI_OPEN_FILE *Destination = NULL;
EFI_STATUS Status = EFI_SUCCESS;
VOID *Buffer = NULL;
UINTN Size;
UINTN Offset;
UINTN Chunk = FILE_COPY_CHUNK;
Source = EfiOpen(SourceFile, EFI_FILE_MODE_READ, 0);
if (Source == NULL) {
AsciiPrint("Source file open error.\n");
Status = EFI_NOT_FOUND;
goto Exit;
}
Destination = EfiOpen(DestinationFile, EFI_FILE_MODE_WRITE | EFI_FILE_MODE_CREATE, 0);
if (Destination == NULL) {
AsciiPrint("Destination file open error.\n");
Status = EFI_NOT_FOUND;
goto Exit;
}
Buffer = AllocatePool(FILE_COPY_CHUNK);
if (Buffer == NULL) {
Status = EFI_OUT_OF_RESOURCES;
goto Exit;
}
Size = EfiTell(Source, NULL);
for (Offset = 0; Offset + FILE_COPY_CHUNK <= Size; Offset += Chunk) {
Chunk = FILE_COPY_CHUNK;
Status = EfiRead(Source, Buffer, &Chunk);
if (EFI_ERROR(Status)) {
AsciiPrint("Read file error\n");
goto Exit;
}
Status = EfiWrite(Destination, Buffer, &Chunk);
if (EFI_ERROR(Status)) {
AsciiPrint("Write file error\n");
goto Exit;
}
}
// Any left over?
if (Offset < Size) {
Chunk = Size - Offset;
Status = EfiRead(Source, Buffer, &Chunk);
if (EFI_ERROR(Status)) {
AsciiPrint("Read file error\n");
goto Exit;
}
Status = EfiWrite(Destination, Buffer, &Chunk);
if (EFI_ERROR(Status)) {
AsciiPrint("Write file error\n");
goto Exit;
}
}
Exit:
if (Source != NULL) {
Status = EfiClose(Source);
if (EFI_ERROR(Status)) {
AsciiPrint("Source close error");
}
}
if (Destination != NULL) {
Status = EfiClose(Destination);
if (EFI_ERROR(Status)) {
AsciiPrint("Destination close error");
}
}
if (Buffer != NULL) {
FreePool(Buffer);
}
return Status;
}
/**
Use DeviceType and Index to form a valid PathName and try and open it.
@param DeviceType Device type to open
@param Index Device Index to use. Zero relative.
@return NULL Open failed
@return Valid EFI_OPEN_FILE handle
**/
EFI_OPEN_FILE *
EfiDeviceOpenByType (
IN EFI_OPEN_FILE_TYPE DeviceType,
IN UINTN Index
)
{
CHAR8 *DevStr;
CHAR8 Path[MAX_CMD_LINE];
switch (DeviceType) {
case EfiOpenLoadFile:
DevStr = "loadfile%d:";
break;
case EfiOpenFirmwareVolume:
DevStr = "fv%d:";
break;
case EfiOpenFileSystem:
DevStr = "fs%d:";
break;
case EfiOpenBlockIo:
DevStr = "blk%d:";
break;
case EfiOpenMemoryBuffer:
DevStr = "a%d:";
break;
default:
return NULL;
}
AsciiSPrint (Path, MAX_PATHNAME, DevStr, Index);
return EfiOpen (Path, EFI_FILE_MODE_READ, 0);
}
/**
Close a file handle opened by EfiOpen() and free all resources allocated by
EfiOpen().
@param Stream Open File Handle
@return EFI_INVALID_PARAMETER Stream is not an Open File
@return EFI_SUCCESS Steam closed
**/
EFI_STATUS
EfiClose (
IN EFI_OPEN_FILE *File
)
{
EFI_STATUS Status;
UINT64 TftpBufferSize;
if (!FileHandleValid (File)) {
return EFI_INVALID_PARAMETER;
}
//Write the buffer contents to TFTP file.
if ((File->Type == EfiOpenTftp) && (File->IsDirty)) {
TftpBufferSize = File->Size;
Status = EblMtftp (
EFI_PXE_BASE_CODE_TFTP_WRITE_FILE,
File->Buffer,
TRUE,
&TftpBufferSize,
NULL,
&File->ServerIp,
(UINT8 *)File->FileName,
NULL,
FALSE
);
if (EFI_ERROR(Status)) {
AsciiPrint("TFTP error during APPLE_NSP_TFTP_WRITE_FILE: %r\n", Status);
return Status;
}
}
if ((File->Type == EfiOpenLoadFile) ||
((File->Type == EfiOpenTftp) && (File->IsBufferValid == TRUE))) {
EblFreePool(File->Buffer);
}
EblFreePool (File->DevicePath);
EblFreePool (File->DeviceName);
EblFreePool (File->FsFileInfo);
EblFreePool (File->FsInfo);
if (File->FsFileHandle != NULL) {
File->FsFileHandle->Close (File->FsFileHandle);
}
// Need to free File and it's Guard structures
EblFreePool (BASE_CR (File, EFI_OPEN_FILE_GUARD, File));
return EFI_SUCCESS;
}
/**
Return the size of the file represented by Stream. Also return the current
Seek position. Opening a file will enable a valid file size to be returned.
LoadFile is an exception as a load file size is set to zero.
@param Stream Open File Handle
@return 0 Stream is not an Open File or a valid LoadFile handle
**/
UINTN
EfiTell (
IN EFI_OPEN_FILE *File,
OUT EFI_LBA *CurrentPosition OPTIONAL
)
{
EFI_STATUS Status;
UINT64 BufferSize = 0;
if (!FileHandleValid (File)) {
return 0;
}
if (CurrentPosition != NULL) {
*CurrentPosition = File->CurrentPosition;
}
if (File->Type == EfiOpenLoadFile) {
// Figure out the File->Size
File->Buffer = NULL;
File->Size = 0;
Status = File->LoadFile->LoadFile (File->LoadFile, File->DevicePath, FALSE, &File->Size, File->Buffer);
if (Status != EFI_BUFFER_TOO_SMALL) {
return 0;
}
File->MaxPosition = (UINT64)File->Size;
} else if (File->Type == EfiOpenTftp) {
Status = EblMtftp (
EFI_PXE_BASE_CODE_TFTP_GET_FILE_SIZE,
NULL,
FALSE,
&BufferSize,
NULL,
&File->ServerIp,
(UINT8 *)File->FileName,
NULL,
TRUE
);
if (EFI_ERROR(Status)) {
AsciiPrint("TFTP error during APPLE_NSP_TFTP_GET_FILE_SIZE: %r\n", Status);
return 0;
}
File->Size = (UINTN)BufferSize;
File->MaxPosition = File->Size;
}
return File->Size;
}
/**
Seek to the Offset locaiton in the file. LoadFile and FV device types do
not support EfiSeek(). It is not possible to grow the file size using
EfiSeek().
SeekType defines how use Offset to calculate the new file position:
EfiSeekStart : Position = Offset
EfiSeekCurrent: Position is Offset bytes from the current position
EfiSeekEnd : Only supported if Offset is zero to seek to end of file.
@param Stream Open File Handle
@param Offset Offset to seek too.
@param SeekType Type of seek to perform
@return EFI_INVALID_PARAMETER Stream is not an Open File
@return EFI_UNSUPPORTED LoadFile and FV doe not support Seek
@return EFI_NOT_FOUND Seek past the end of the file.
@return EFI_SUCCESS Steam closed
**/
EFI_STATUS
EfiSeek (
IN EFI_OPEN_FILE *File,
IN EFI_LBA Offset,
IN EFI_SEEK_TYPE SeekType
)
{
EFI_STATUS Status;
UINT64 CurrentPosition;
if (!FileHandleValid (File)) {
return EFI_INVALID_PARAMETER;
}
if (File->Type == EfiOpenLoadFile || File->Type == EfiOpenFirmwareVolume) {
// LoadFile and FV do not support Seek
return EFI_UNSUPPORTED;
}
CurrentPosition = File->CurrentPosition;
switch (SeekType) {
case EfiSeekStart:
if (Offset > File->MaxPosition) {
return EFI_NOT_FOUND;
}
CurrentPosition = Offset;
break;
case EfiSeekCurrent:
if ((File->CurrentPosition + Offset) > File->MaxPosition) {
return EFI_NOT_FOUND;
}
CurrentPosition += Offset;
break;
case EfiSeekEnd:
if (Offset != 0) {
// We don't support growing file size via seeking past end of file
return EFI_UNSUPPORTED;
}
CurrentPosition = File->MaxPosition;
break;
default:
return EFI_NOT_FOUND;
}
Status = EFI_SUCCESS;
if (File->FsFileHandle != NULL) {
Status = File->FsFileHandle->SetPosition (File->FsFileHandle, CurrentPosition);
}
if (!EFI_ERROR (Status)) {
File->CurrentPosition = CurrentPosition;
}
return Status;
}
EFI_STATUS
CacheTftpFile (
IN OUT EFI_OPEN_FILE *File
)
{
EFI_STATUS Status;
UINT64 TftpBufferSize;
if (File->IsBufferValid) {
return EFI_SUCCESS;
}
// Make sure the file size is set.
EfiTell (File, NULL);
//Allocate a buffer to hold the whole file.
File->Buffer = AllocatePool(File->Size);
if (File->Buffer == NULL) {
return EFI_OUT_OF_RESOURCES;
}
TftpBufferSize = File->Size;
Status = EblMtftp (
EFI_PXE_BASE_CODE_TFTP_READ_FILE,
File->Buffer,
FALSE,
&TftpBufferSize,
NULL,
&File->ServerIp,
(UINT8 *)File->FileName,
NULL,
FALSE);
if (EFI_ERROR(Status)) {
AsciiPrint("TFTP error during APPLE_NSP_TFTP_READ_FILE: %r\n", Status);
FreePool(File->Buffer);
return Status;
}
// Set the buffer valid flag.
File->IsBufferValid = TRUE;
return Status;
}
/**
Read BufferSize bytes from the current locaiton in the file. For load file,
FV, and TFTP case you must read the entire file.
@param Stream Open File Handle
@param Buffer Caller allocated buffer.
@param BufferSize Size of buffer in bytes.
@return EFI_SUCCESS Stream is not an Open File
@return EFI_END_OF_FILE Tried to read past the end of the file
@return EFI_INVALID_PARAMETER Stream is not an open file handle
@return EFI_BUFFER_TOO_SMALL Buffer is not big enough to do the read
@return "other" Error returned from device read
**/
EFI_STATUS
EfiRead (
IN EFI_OPEN_FILE *File,
OUT VOID *Buffer,
OUT UINTN *BufferSize
)
{
EFI_STATUS Status;
UINT32 AuthenticationStatus;
EFI_DISK_IO_PROTOCOL *DiskIo;
if (!FileHandleValid (File)) {
return EFI_INVALID_PARAMETER;
}
// Don't read past the end of the file.
if ((File->CurrentPosition + *BufferSize) > File->MaxPosition) {
return EFI_END_OF_FILE;
}
switch (File->Type) {
case EfiOpenMemoryBuffer:
CopyMem (Buffer, File->Buffer + File->CurrentPosition, *BufferSize);
File->CurrentPosition += *BufferSize;
Status = EFI_SUCCESS;
break;
case EfiOpenLoadFile:
// Figure out the File->Size
EfiTell (File, NULL);
Status = File->LoadFile->LoadFile (File->LoadFile, File->DevicePath, FALSE, BufferSize, Buffer);
break;
case EfiOpenFirmwareVolume:
if (File->FvSectionType == EFI_SECTION_ALL) {
Status = File->Fv->ReadFile (
File->Fv,
&File->FvNameGuid,
&Buffer,
BufferSize,
&File->FvType,
&File->FvAttributes,
&AuthenticationStatus
);
} else {
Status = File->Fv->ReadSection (
File->Fv,
&File->FvNameGuid,
File->FvSectionType,
0,
&Buffer,
BufferSize,
&AuthenticationStatus
);
}
break;
case EfiOpenFileSystem:
Status = File->FsFileHandle->Read (File->FsFileHandle, BufferSize, Buffer);
File->CurrentPosition += *BufferSize;
break;
case EfiOpenBlockIo:
Status = gBS->HandleProtocol(File->EfiHandle, &gEfiDiskIoProtocolGuid, (VOID **)&DiskIo);
if (!EFI_ERROR(Status)) {
Status = DiskIo->ReadDisk(DiskIo, File->FsBlockIoMedia.MediaId, File->DiskOffset + File->CurrentPosition, *BufferSize, Buffer);
}
File->CurrentPosition += *BufferSize;
break;
case EfiOpenTftp:
// Cache the file if it hasn't been cached yet.
if (File->IsBufferValid == FALSE) {
Status = CacheTftpFile (File);
if (EFI_ERROR (Status)) {
return Status;
}
}
// Copy out the requested data
CopyMem (Buffer, File->Buffer + File->CurrentPosition, *BufferSize);
File->CurrentPosition += *BufferSize;
Status = EFI_SUCCESS;
break;
default:
return EFI_INVALID_PARAMETER;
};
return Status;
}
/**
Read the entire file into a buffer. This routine allocates the buffer and
returns it to the user full of the read data.
This is very useful for load flie where it's hard to know how big the buffer
must be.
@param Stream Open File Handle
@param Buffer Pointer to buffer to return.
@param BufferSize Pointer to Size of buffer return..
@return EFI_SUCCESS Stream is not an Open File
@return EFI_END_OF_FILE Tried to read past the end of the file
@return EFI_INVALID_PARAMETER Stream is not an open file handle
@return EFI_BUFFER_TOO_SMALL Buffer is not big enough to do the read
@return "other" Error returned from device read
**/
EFI_STATUS
EfiReadAllocatePool (
IN EFI_OPEN_FILE *File,
OUT VOID **Buffer,
OUT UINTN *BufferSize
)
{
if (!FileHandleValid (File)) {
return EFI_INVALID_PARAMETER;
}
// Loadfile defers file size determination on Open so use tell to find it
EfiTell (File, NULL);
*BufferSize = File->Size;
*Buffer = AllocatePool (*BufferSize);
if (*Buffer == NULL) {
return EFI_NOT_FOUND;
}
return EfiRead (File, *Buffer, BufferSize);
}
/**
Write data back to the file. For TFTP case you must write the entire file.
@param Stream Open File Handle
@param Buffer Pointer to buffer to return.
@param BufferSize Pointer to Size of buffer return..
@return EFI_SUCCESS Stream is not an Open File
@return EFI_END_OF_FILE Tried to read past the end of the file
@return EFI_INVALID_PARAMETER Stream is not an open file handle
@return EFI_BUFFER_TOO_SMALL Buffer is not big enough to do the read
@return "other" Error returned from device write
**/
EFI_STATUS
EfiWrite (
IN EFI_OPEN_FILE *File,
OUT VOID *Buffer,
OUT UINTN *BufferSize
)
{
EFI_STATUS Status;
EFI_FV_WRITE_FILE_DATA FileData;
EFI_DISK_IO_PROTOCOL *DiskIo;
if (!FileHandleValid (File)) {
return EFI_INVALID_PARAMETER;
}
switch (File->Type) {
case EfiOpenMemoryBuffer:
if ((File->CurrentPosition + *BufferSize) > File->MaxPosition) {
return EFI_END_OF_FILE;
}
CopyMem (File->Buffer + File->CurrentPosition, Buffer, *BufferSize);
File->CurrentPosition += *BufferSize;
Status = EFI_SUCCESS;
case EfiOpenLoadFile:
// LoadFile device is read only be definition
Status = EFI_UNSUPPORTED;
case EfiOpenFirmwareVolume:
if (File->FvSectionType != EFI_SECTION_ALL) {
// Writes not support to a specific section. You have to update entire file
return EFI_UNSUPPORTED;
}
FileData.NameGuid = &(File->FvNameGuid);
FileData.Type = File->FvType;
FileData.FileAttributes = File->FvAttributes;
FileData.Buffer = Buffer;
FileData.BufferSize = (UINT32)*BufferSize;
Status = File->Fv->WriteFile (File->Fv, 1, EFI_FV_UNRELIABLE_WRITE, &FileData);
break;
case EfiOpenFileSystem:
Status = File->FsFileHandle->Write (File->FsFileHandle, BufferSize, Buffer);
File->CurrentPosition += *BufferSize;
break;
case EfiOpenBlockIo:
if ((File->CurrentPosition + *BufferSize) > File->MaxPosition) {
return EFI_END_OF_FILE;
}
Status = gBS->HandleProtocol (File->EfiHandle, &gEfiDiskIoProtocolGuid, (VOID **)&DiskIo);
if (!EFI_ERROR(Status)) {
Status = DiskIo->WriteDisk (DiskIo, File->FsBlockIoMedia.MediaId, File->DiskOffset + File->CurrentPosition, *BufferSize, Buffer);
}
File->CurrentPosition += *BufferSize;
break;
case EfiOpenTftp:
// Cache the file if it hasn't been cached yet.
if (File->IsBufferValid == FALSE) {
Status = CacheTftpFile(File);
if (EFI_ERROR(Status)) {
return Status;
}
}
// Don't overwrite the buffer
if ((File->CurrentPosition + *BufferSize) > File->MaxPosition) {
UINT8 *TempBuffer;
TempBuffer = File->Buffer;
File->Buffer = AllocatePool ((UINTN)(File->CurrentPosition + *BufferSize));
if (File->Buffer == NULL) {
return EFI_OUT_OF_RESOURCES;
}
CopyMem (File->Buffer, TempBuffer, File->Size);
FreePool (TempBuffer);
File->Size = (UINTN)(File->CurrentPosition + *BufferSize);
File->MaxPosition = (UINT64)File->Size;
}
// Copy in the requested data
CopyMem (File->Buffer + File->CurrentPosition, Buffer, *BufferSize);
File->CurrentPosition += *BufferSize;
// Mark the file dirty
File->IsDirty = TRUE;
Status = EFI_SUCCESS;
break;
default:
Status = EFI_INVALID_PARAMETER;
};
return Status;
}
/**
Given Cwd expand Path to remove .. and replace them with real
directory names.
@param Cwd Current Working Directory
@param Path Path to expand
@return NULL Cwd or Path are not valid
@return 'other' Path with .. expanded
**/
CHAR8 *
ExpandPath (
IN CHAR8 *Cwd,
IN CHAR8 *Path
)
{
CHAR8 *NewPath;
CHAR8 *Work, *Start, *End;
UINTN StrLen;
UINTN i;
if (Cwd == NULL || Path == NULL) {
return NULL;
}
StrLen = AsciiStrSize (Cwd);
if (StrLen <= 2) {
// Smallest valid path is 1 char and a null
return NULL;
}
StrLen = AsciiStrSize (Path);
NewPath = AllocatePool (AsciiStrSize (Cwd) + StrLen + 1);
if (NewPath == NULL) {
return NULL;
}
AsciiStrCpy (NewPath, Cwd);
End = Path + StrLen;
for (Start = Path ;;) {
Work = AsciiStrStr (Start, "..") ;
if (Work == NULL) {
// Remaining part of Path contains no more ..
break;
}
// append path prior to ..
AsciiStrnCat (NewPath, Start, Work - Start);
StrLen = AsciiStrLen (NewPath);
for (i = StrLen; i >= 0; i--) {
if (NewPath[i] == ':') {
// too many ..
return NULL;
}
if (NewPath[i] == '/' || NewPath[i] == '\\') {
if ((i > 0) && (NewPath[i-1] == ':')) {
// leave the / before a :
NewPath[i+1] = '\0';
} else {
// replace / will Null to remove trailing file/dir reference
NewPath[i] = '\0';
}
break;
}
}
Start = Work + 3;
}
// Handle the path that remains after the ..
AsciiStrnCat (NewPath, Start, End - Start);
return NewPath;
}
/**
Set the Curent Working Directory (CWD). If a call is made to EfiOpen () and
the path does not contain a device name, The CWD is prepended to the path.
@param Cwd Current Working Directory to set
@return EFI_SUCCESS CWD is set
@return EFI_INVALID_PARAMETER Cwd is not a valid device:path
**/
EFI_STATUS
EfiSetCwd (
IN CHAR8 *Cwd
)
{
EFI_OPEN_FILE *File;
UINTN Len;
CHAR8 *Path;
if (Cwd == NULL) {
return EFI_INVALID_PARAMETER;
}
if (AsciiStrCmp (Cwd, ".") == 0) {
// cd . is a no-op
return EFI_SUCCESS;
}
Path = Cwd;
if (AsciiStrStr (Cwd, "..") != NULL) {
if (gCwd == NULL) {
// no parent
return EFI_SUCCESS;
}
Len = AsciiStrLen (gCwd);
if ((gCwd[Len-2] == ':') && ((gCwd[Len-1] == '/') || (gCwd[Len-1] == '\\'))) {
// parent is device so nothing to do
return EFI_SUCCESS;
}
// Expand .. in Cwd, given we know current working directory
Path = ExpandPath (gCwd, Cwd);
if (Path == NULL) {
return EFI_NOT_FOUND;
}
}
File = EfiOpen (Path, EFI_FILE_MODE_READ, 0);
if (File == NULL) {
return EFI_INVALID_PARAMETER;
}
if (gCwd != NULL) {
FreePool (gCwd);
}
// Use the info returned from EfiOpen as it can add in CWD if needed. So Cwd could be
// relative to the current gCwd or not.
gCwd = AllocatePool (AsciiStrSize (File->DeviceName) + AsciiStrSize (File->FileName) + 1);
if (gCwd == NULL) {
return EFI_INVALID_PARAMETER;
}
AsciiStrCpy (gCwd, File->DeviceName);
if (File->FileName == NULL) {
AsciiStrCat (gCwd, ":\\");
} else {
AsciiStrCat (gCwd, ":");
AsciiStrCat (gCwd, File->FileName);
}
EfiClose (File);
if (Path != Cwd) {
FreePool (Path);
}
return EFI_SUCCESS;
}
/**
Set the Curent Working Directory (CWD). If a call is made to EfiOpen () and
the path does not contain a device name, The CWD is prepended to the path.
The CWD buffer is only valid until a new call is made to EfiSetCwd(). After
a call to EfiSetCwd() it is not legal to use the pointer returned by
this funciton.
@param Cwd Current Working Directory
@return "" No CWD set
@return 'other' Returns buffer that contains CWD.
**/
CHAR8 *
EfiGetCwd (
VOID
)
{
if (gCwd == NULL) {
return "";
}
return gCwd;
}
|