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
|
/** @file
RedfishHttpDxe produces EdkIIRedfishHttpProtocol
for EDK2 Redfish Feature driver to do HTTP operations.
Copyright (c) 2023-2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include "RedfishHttpDxe.h"
#include "RedfishHttpData.h"
#include "RedfishHttpOperation.h"
REDFISH_HTTP_CACHE_PRIVATE *mRedfishHttpCachePrivate = NULL;
/**
Debug output the cache list.
@param[in] Msg Debug message string.
@param[in] ErrorLevel Output error level.
@param[in] CacheList Target list to dump.
@retval EFI_SUCCESS Debug dump finished.
@retval EFI_INVALID_PARAMETER HttpCacheList is NULL.
**/
EFI_STATUS
DebugPrintHttpCacheList (
IN CONST CHAR8 *Msg,
IN UINTN ErrorLevel,
IN REDFISH_HTTP_CACHE_LIST *CacheList
)
{
LIST_ENTRY *List;
REDFISH_HTTP_CACHE_DATA *Data;
UINTN Index;
if (CacheList == NULL) {
return EFI_INVALID_PARAMETER;
}
if (!IS_EMPTY_STRING (Msg)) {
DEBUG ((ErrorLevel, "%a\n", Msg));
}
if (IsListEmpty (&CacheList->Head)) {
DEBUG ((ErrorLevel, "list is empty\n"));
return EFI_NOT_FOUND;
}
DEBUG ((ErrorLevel, "list count: %d capacity: %d\n", CacheList->Count, CacheList->Capacity));
Data = NULL;
Index = 0;
List = GetFirstNode (&CacheList->Head);
while (!IsNull (&CacheList->Head, List)) {
Data = REDFISH_HTTP_CACHE_FROM_LIST (List);
DEBUG ((ErrorLevel, "%d) Uri: %s Hit: %d\n", ++Index, Data->Uri, Data->HitCount));
List = GetNextNode (&CacheList->Head, List);
}
return EFI_SUCCESS;
}
/**
Check HTTP status code to see if we like to retry HTTP request or not.
@param[in] StatusCode HTTP status code.
@retval BOOLEAN Return true when we like to retry request.
Return false when we don't want to retry request.
**/
BOOLEAN
RedfishRetryRequired (
IN EFI_HTTP_STATUS_CODE *StatusCode
)
{
if (StatusCode == NULL) {
return TRUE;
}
if ((*StatusCode == HTTP_STATUS_500_INTERNAL_SERVER_ERROR) ||
(*StatusCode == HTTP_STATUS_UNSUPPORTED_STATUS))
{
return TRUE;
}
return FALSE;
}
/**
This function follows below sections in Redfish specification to
check HTTP status code and see if this is success response or not.
7.5.2 Modification success responses
7.11 POST (action)
@param[in] Method HTTP method of this status code.
@param[in] StatusCode HTTP status code.
@retval BOOLEAN Return true when this is success response.
Return false when this is not success response.
**/
BOOLEAN
RedfishSuccessResponse (
IN EFI_HTTP_METHOD Method,
IN EFI_HTTP_STATUS_CODE *StatusCode
)
{
BOOLEAN SuccessResponse;
if (StatusCode == NULL) {
return TRUE;
}
SuccessResponse = FALSE;
switch (Method) {
case HttpMethodPost:
if ((*StatusCode == HTTP_STATUS_200_OK) ||
(*StatusCode == HTTP_STATUS_201_CREATED) ||
(*StatusCode == HTTP_STATUS_202_ACCEPTED) ||
(*StatusCode == HTTP_STATUS_204_NO_CONTENT))
{
SuccessResponse = TRUE;
}
break;
case HttpMethodPatch:
case HttpMethodPut:
case HttpMethodDelete:
if ((*StatusCode == HTTP_STATUS_200_OK) ||
(*StatusCode == HTTP_STATUS_202_ACCEPTED) ||
(*StatusCode == HTTP_STATUS_204_NO_CONTENT))
{
SuccessResponse = TRUE;
}
break;
default:
//
// Return true for unsupported method to prevent false alarm.
//
SuccessResponse = TRUE;
break;
}
return SuccessResponse;
}
/**
Convert Unicode string to ASCII string. It's call responsibility to release returned buffer.
@param[in] UnicodeStr Unicode string to convert.
@retval CHAR8 * ASCII string returned.
@retval NULL Errors occur.
**/
CHAR8 *
StringUnicodeToAscii (
IN EFI_STRING UnicodeStr
)
{
CHAR8 *AsciiStr;
UINTN AsciiStrSize;
EFI_STATUS Status;
if (IS_EMPTY_STRING (UnicodeStr)) {
return NULL;
}
AsciiStrSize = StrLen (UnicodeStr) + 1;
AsciiStr = AllocateZeroPool (AsciiStrSize);
if (AsciiStr == NULL) {
return NULL;
}
Status = UnicodeStrToAsciiStrS (UnicodeStr, AsciiStr, AsciiStrSize);
if (EFI_ERROR (Status)) {
DEBUG ((DEBUG_ERROR, "UnicodeStrToAsciiStrS failed: %r\n", Status));
FreePool (AsciiStr);
return NULL;
}
return AsciiStr;
}
/**
Return HTTP method in ASCII string. Caller does not need
to free returned string buffer.
@param[in] Method HTTP method.
@retval CHAR8 * Method in string.
**/
CHAR8 *
HttpMethodToString (
IN EFI_HTTP_METHOD Method
)
{
switch (Method) {
case HttpMethodGet:
return HTTP_METHOD_GET;
break;
case HttpMethodPost:
return HTTP_METHOD_POST;
break;
case HttpMethodPatch:
return HTTP_METHOD_PATCH;
break;
case HttpMethodPut:
return HTTP_METHOD_PUT;
break;
case HttpMethodDelete:
return HTTP_METHOD_DELETE;
break;
default:
break;
}
return "Unknown";
}
/**
Report HTTP communication error via report status code.
@param[in] Method HTTP method.
@param[in] Uri The URI which has failure.
@param[in] HttpStatusCode HTTP status code.
**/
VOID
ReportHttpError (
IN EFI_HTTP_METHOD Method,
IN EFI_STRING Uri,
IN EFI_HTTP_STATUS_CODE *HttpStatusCode OPTIONAL
)
{
CHAR8 ErrorMsg[REDFISH_ERROR_MSG_MAX];
if (IS_EMPTY_STRING (Uri)) {
DEBUG ((DEBUG_ERROR, "%a: no URI to report error status\n", __func__));
return;
}
//
// Report failure of URI and HTTP status code.
//
AsciiSPrint (ErrorMsg, sizeof (ErrorMsg), REDFISH_HTTP_ERROR_REPORT, HttpMethodToString (Method), (HttpStatusCode == NULL ? HTTP_STATUS_UNSUPPORTED_STATUS : *HttpStatusCode), Uri);
DEBUG ((DEBUG_ERROR, "%a\n", ErrorMsg));
//
// TODO:
// Below PI status code is approved by PIWG and wait for specification published.
// We will uncomment below report status code after PI status code get published.
// REF: https://bugzilla.tianocore.org/show_bug.cgi?id=4483
//
// REPORT_STATUS_CODE_WITH_EXTENDED_DATA (
// EFI_ERROR_CODE | EFI_ERROR_MAJOR,
// EFI_COMPUTING_UNIT_MANAGEABILITY | EFI_MANAGEABILITY_EC_REDFISH_COMMUNICATION_ERROR,
// ErrorMsg,
// AsciiStrSize (ErrorMsg)
// );
}
/**
This function create Redfish service. It's caller's responsibility to free returned
Redfish service by calling FreeService ().
@param[in] This Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
@param[in] RedfishConfigServiceInfo Redfish config service information.
@retval REDFISH_SERVICE Redfish service is created.
@retval NULL Errors occur.
**/
REDFISH_SERVICE
EFIAPI
RedfishCreateRedfishService (
IN EDKII_REDFISH_HTTP_PROTOCOL *This,
IN REDFISH_CONFIG_SERVICE_INFORMATION *RedfishConfigServiceInfo
)
{
EFI_STATUS Status;
REDFISH_HTTP_CACHE_PRIVATE *Private;
REDFISH_SERVICE_PRIVATE *NewService;
CHAR8 *AsciiLocation;
CHAR8 *Host;
CHAR8 *BasicAuthString;
UINTN BasicAuthStrSize;
CHAR8 *EncodedAuthString;
UINTN EncodedAuthStrSize;
EDKII_REDFISH_AUTH_METHOD AuthMethod;
CHAR8 *Username;
CHAR8 *Password;
UINTN UsernameSize;
UINTN PasswordSize;
EFI_REST_EX_PROTOCOL *RestEx;
if ((This == NULL) || (RedfishConfigServiceInfo == NULL)) {
return NULL;
}
DEBUG ((REDFISH_HTTP_CACHE_DEBUG, "%a: service location: %s\n", __func__, RedfishConfigServiceInfo->RedfishServiceLocation));
Private = REDFISH_HTTP_CACHE_PRIVATE_FROM_THIS (This);
BasicAuthString = NULL;
EncodedAuthString = NULL;
Username = NULL;
Password = NULL;
NewService = NULL;
AsciiLocation = NULL;
Host = NULL;
BasicAuthStrSize = 0;
EncodedAuthStrSize = 0;
UsernameSize = 0;
PasswordSize = 0;
//
// Build host and host name from service location
//
if (!IS_EMPTY_STRING (RedfishConfigServiceInfo->RedfishServiceLocation)) {
AsciiLocation = StringUnicodeToAscii (RedfishConfigServiceInfo->RedfishServiceLocation);
if (AsciiLocation == NULL) {
goto ON_RELEASE;
}
Host = AllocateZeroPool (REDFISH_HOST_NAME_MAX);
if (AsciiLocation == NULL) {
goto ON_RELEASE;
}
if (RedfishConfigServiceInfo->RedfishServiceUseHttps) {
AsciiSPrint (Host, REDFISH_HOST_NAME_MAX, "https://%a", AsciiLocation);
} else {
AsciiSPrint (Host, REDFISH_HOST_NAME_MAX, "http://%a", AsciiLocation);
}
DEBUG ((REDFISH_HTTP_CACHE_DEBUG, "%a: Host: %a\n", __func__, Host));
}
//
// Find Rest Ex protocol
//
if (RedfishConfigServiceInfo->RedfishServiceRestExHandle != NULL) {
Status = gBS->HandleProtocol (
RedfishConfigServiceInfo->RedfishServiceRestExHandle,
&gEfiRestExProtocolGuid,
(VOID **)&RestEx
);
} else {
DEBUG ((DEBUG_ERROR, "%a: Rest Ex protocol is not available\n", __func__));
goto ON_RELEASE;
}
//
// Get credential
//
if (Private->CredentialProtocol == NULL) {
//
// No credential available on this system.
//
DEBUG ((DEBUG_WARN, "%a: no credential protocol available\n", __func__));
} else {
Status = Private->CredentialProtocol->GetAuthInfo (
Private->CredentialProtocol,
&AuthMethod,
&Username,
&Password
);
if (EFI_ERROR (Status) || ((AuthMethod != AuthMethodNone) && (IS_EMPTY_STRING (Username) || IS_EMPTY_STRING (Password)))) {
DEBUG ((DEBUG_ERROR, "%a: cannot get authentication information: %r\n", __func__, Status));
goto ON_RELEASE;
} else if (AuthMethod != AuthMethodNone) {
DEBUG ((REDFISH_HTTP_CACHE_DEBUG, "%a: Auth method: 0x%x username: %a password: %a\n", __func__, AuthMethod, Username, Password));
//
// Perform base64 encoding (RFC 7617)
//
UsernameSize = AsciiStrSize (Username);
PasswordSize = AsciiStrSize (Password);
BasicAuthStrSize = UsernameSize + PasswordSize; // one byte taken from null-terminator for ':'
BasicAuthString = AllocateZeroPool (BasicAuthStrSize);
if (BasicAuthString == NULL) {
goto ON_RELEASE;
}
AsciiSPrint (
BasicAuthString,
BasicAuthStrSize,
"%a:%a",
Username,
Password
);
Status = Base64Encode (
(CONST UINT8 *)BasicAuthString,
BasicAuthStrSize,
EncodedAuthString,
&EncodedAuthStrSize
);
if ((Status == EFI_BUFFER_TOO_SMALL) && (EncodedAuthStrSize > 0)) {
EncodedAuthString = AllocateZeroPool (EncodedAuthStrSize);
if (EncodedAuthString == NULL) {
goto ON_RELEASE;
}
Status = Base64Encode (
(CONST UINT8 *)BasicAuthString,
BasicAuthStrSize,
EncodedAuthString,
&EncodedAuthStrSize
);
if (EFI_ERROR (Status)) {
DEBUG ((DEBUG_ERROR, "%a: Base64Encode failure: %r\n", __func__, Status));
}
DEBUG ((REDFISH_HTTP_CACHE_DEBUG, "%a: Basic authorization: %a\n", __func__, EncodedAuthString));
} else {
DEBUG ((DEBUG_ERROR, "%a: Base64Encode failure: %r\n", __func__, Status));
goto ON_RELEASE;
}
}
}
NewService = CreateRedfishService (Host, AsciiLocation, EncodedAuthString, NULL, RestEx);
if (NewService == NULL) {
DEBUG ((DEBUG_ERROR, "%a: CreateRedfishService\n", __func__));
goto ON_RELEASE;
}
if (Private->CredentialProtocol != NULL) {
Status = Private->CredentialProtocol->RegisterRedfishService (Private->CredentialProtocol, NewService);
if (EFI_ERROR (Status)) {
DEBUG ((DEBUG_ERROR, "%a: Failed to register Redfish service - %r\n", __func__, Status));
}
}
ON_RELEASE:
if (BasicAuthString != NULL) {
ZeroMem (BasicAuthString, BasicAuthStrSize);
FreePool (BasicAuthString);
}
if (EncodedAuthString != NULL) {
ZeroMem (BasicAuthString, EncodedAuthStrSize);
FreePool (EncodedAuthString);
}
if (Username != NULL) {
ZeroMem (Username, UsernameSize);
FreePool (Username);
}
if (Password != NULL) {
ZeroMem (Password, PasswordSize);
FreePool (Password);
}
if (AsciiLocation != NULL) {
FreePool (AsciiLocation);
}
if (Host != NULL) {
FreePool (Host);
}
return NewService;
}
/**
This function free resources in Redfish service. RedfishService is no longer available
after this function returns successfully.
@param[in] This Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
@param[in] RedfishService Pointer to Redfish service to be released.
@retval EFI_SUCCESS Resource is released successfully.
@retval Others Errors occur.
**/
EFI_STATUS
EFIAPI
RedfishFreeRedfishService (
IN EDKII_REDFISH_HTTP_PROTOCOL *This,
IN REDFISH_SERVICE RedfishService
)
{
EFI_STATUS Status;
REDFISH_SERVICE_PRIVATE *Service;
REDFISH_HTTP_CACHE_PRIVATE *Private;
if ((This == NULL) || (RedfishService == NULL)) {
return EFI_INVALID_PARAMETER;
}
Private = REDFISH_HTTP_CACHE_PRIVATE_FROM_THIS (This);
Service = (REDFISH_SERVICE_PRIVATE *)RedfishService;
if (Service->Signature != REDFISH_HTTP_SERVICE_SIGNATURE) {
DEBUG ((DEBUG_ERROR, "%a: signature check failure\n", __func__));
}
if (Private->CredentialProtocol != NULL) {
Status = Private->CredentialProtocol->UnregisterRedfishService (Private->CredentialProtocol, RedfishService);
if (EFI_ERROR (Status)) {
DEBUG ((DEBUG_ERROR, "%a: Failed to unregister Redfish service - %r\n", __func__, Status));
} else {
if (Service->RestEx != NULL) {
Status = Service->RestEx->Configure (Service->RestEx, NULL);
DEBUG ((REDFISH_HTTP_CACHE_DEBUG, "%a: release RestEx instance: %r\n", __func__, Status));
}
}
}
return ReleaseRedfishService (Service);
}
/**
This function returns JSON value in given RedfishPayload. Returned JSON value
is a reference to the JSON value in RedfishPayload. Any modification to returned
JSON value will change JSON value in RedfishPayload.
@param[in] This Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
@param[in] RedfishPayload Pointer to Redfish payload.
@retval EDKII_JSON_VALUE JSON value is returned.
@retval NULL Errors occur.
**/
EDKII_JSON_VALUE
EFIAPI
RedfishJsonInRedfishPayload (
IN EDKII_REDFISH_HTTP_PROTOCOL *This,
IN REDFISH_PAYLOAD RedfishPayload
)
{
REDFISH_PAYLOAD_PRIVATE *Payload;
if ((This == NULL) || (RedfishPayload == NULL)) {
return NULL;
}
Payload = (REDFISH_PAYLOAD_PRIVATE *)RedfishPayload;
if (Payload->Signature != REDFISH_HTTP_PAYLOAD_SIGNATURE) {
DEBUG ((DEBUG_ERROR, "%a: signature check failure\n", __func__));
}
return Payload->JsonValue;
}
/**
Perform HTTP GET to Get redfish resource from given resource URI with
cache mechanism supported. It's caller's responsibility to free Response
by calling FreeResponse ().
@param[in] This Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
@param[in] Service Redfish service instance to perform HTTP GET.
@param[in] Uri Target resource URI.
@param[in] Request Additional request context. This is optional.
@param[out] Response HTTP response from redfish service.
@param[in] UseCache If it is TRUE, this function will search for
cache first. If it is FALSE, this function
will query Redfish URI directly.
@retval EFI_SUCCESS Resource is returned successfully.
@retval Others Errors occur.
**/
EFI_STATUS
EFIAPI
RedfishGetResource (
IN EDKII_REDFISH_HTTP_PROTOCOL *This,
IN REDFISH_SERVICE Service,
IN EFI_STRING Uri,
IN REDFISH_REQUEST *Request OPTIONAL,
OUT REDFISH_RESPONSE *Response,
IN BOOLEAN UseCache
)
{
EFI_STATUS Status;
REDFISH_HTTP_CACHE_DATA *CacheData;
UINTN RetryCount;
REDFISH_HTTP_CACHE_PRIVATE *Private;
if ((This == NULL) || (Service == NULL) || (Response == NULL) || IS_EMPTY_STRING (Uri)) {
return EFI_INVALID_PARAMETER;
}
DEBUG ((REDFISH_HTTP_CACHE_DEBUG, "%a: Get URI: %s cache: %a\n", __func__, Uri, (UseCache ? "true" : "false")));
Private = REDFISH_HTTP_CACHE_PRIVATE_FROM_THIS (This);
CacheData = NULL;
RetryCount = 0;
ZeroMem (Response, sizeof (REDFISH_RESPONSE));
if (Private->CacheDisabled) {
UseCache = FALSE;
DEBUG ((REDFISH_HTTP_CACHE_DEBUG, "%a: cache is disabled by PCD!\n", __func__));
}
//
// Search for cache list.
//
if (UseCache) {
CacheData = FindHttpCacheData (&Private->CacheList.Head, Uri);
if (CacheData != NULL) {
DEBUG ((REDFISH_HTTP_CACHE_DEBUG_REQUEST, "%a: cache hit! %s\n", __func__, Uri));
//
// Copy cached response to caller's buffer.
//
Status = CopyRedfishResponse (CacheData->Response, Response);
CacheData->HitCount += 1;
return Status;
}
}
//
// Get resource from redfish service.
//
do {
RetryCount += 1;
Status = HttpSendReceive (
Service,
Uri,
HttpMethodGet,
Request,
Response
);
DEBUG ((REDFISH_HTTP_CACHE_DEBUG_REQUEST, "%a: HTTP request: %s :%r\n", __func__, Uri, Status));
if (!EFI_ERROR (Status) || (RetryCount >= Private->RetrySetting.MaximumRetryGet)) {
break;
}
//
// Retry when BMC is not ready.
//
if ((Response->StatusCode != NULL)) {
DEBUG_CODE (
DumpRedfishResponse (NULL, DEBUG_ERROR, Response);
);
if (!RedfishRetryRequired (Response->StatusCode)) {
break;
}
//
// Release response for next round of request.
//
This->FreeResponse (This, Response);
}
DEBUG ((DEBUG_WARN, "%a: RedfishGetByUriEx failed, retry (%d/%d)\n", __func__, RetryCount, Private->RetrySetting.MaximumRetryGet));
if (Private->RetrySetting.RetryWait > 0) {
gBS->Stall (Private->RetrySetting.RetryWait);
}
} while (TRUE);
if (EFI_ERROR (Status)) {
DEBUG_CODE (
DumpRedfishResponse (NULL, DEBUG_ERROR, Response);
);
//
// Report status code for Redfish failure
//
ReportHttpError (HttpMethodGet, Uri, Response->StatusCode);
DEBUG ((DEBUG_ERROR, "%a: get %s failed (%d/%d): %r\n", __func__, Uri, RetryCount, Private->RetrySetting.MaximumRetryGet, Status));
goto ON_RELEASE;
}
if (!Private->CacheDisabled) {
//
// Keep response in cache list
//
Status = AddHttpCacheData (&Private->CacheList, Uri, Response);
if (EFI_ERROR (Status)) {
DEBUG ((DEBUG_ERROR, "%a: failed to cache %s: %r\n", __func__, Uri, Status));
goto ON_RELEASE;
}
DEBUG_CODE (
DebugPrintHttpCacheList (__func__, REDFISH_HTTP_CACHE_DEBUG_DUMP, &Private->CacheList);
);
}
ON_RELEASE:
return Status;
}
/**
This function free resources in Request. Request is no longer available
after this function returns successfully.
@param[in] This Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
@param[in] Request HTTP request to be released.
@retval EFI_SUCCESS Resource is released successfully.
@retval Others Errors occur.
**/
EFI_STATUS
EFIAPI
RedfishFreeRequest (
IN EDKII_REDFISH_HTTP_PROTOCOL *This,
IN REDFISH_REQUEST *Request
)
{
if ((This == NULL) || (Request == NULL)) {
return EFI_INVALID_PARAMETER;
}
DEBUG ((REDFISH_HTTP_CACHE_DEBUG, "%a: entry\n", __func__));
return ReleaseRedfishRequest (Request);
}
/**
This function free resources in given Response.
@param[in] This Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
@param[in] Response HTTP response to be released.
@retval EFI_SUCCESS Resource is released successfully.
@retval Others Errors occur.
**/
EFI_STATUS
EFIAPI
RedfishFreeResponse (
IN EDKII_REDFISH_HTTP_PROTOCOL *This,
IN REDFISH_RESPONSE *Response
)
{
if ((This == NULL) || (Response == NULL)) {
return EFI_INVALID_PARAMETER;
}
DEBUG ((REDFISH_HTTP_CACHE_DEBUG, "%a: entry\n", __func__));
return ReleaseRedfishResponse (Response);
}
/**
This function expire the cached response of given URI.
@param[in] This Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
@param[in] Uri Target response of URI.
@retval EFI_SUCCESS Target response is expired successfully.
@retval Others Errors occur.
**/
EFI_STATUS
EFIAPI
RedfishExpireResponse (
IN EDKII_REDFISH_HTTP_PROTOCOL *This,
IN EFI_STRING Uri
)
{
REDFISH_HTTP_CACHE_PRIVATE *Private;
REDFISH_HTTP_CACHE_DATA *CacheData;
if ((This == NULL) || IS_EMPTY_STRING (Uri)) {
return EFI_INVALID_PARAMETER;
}
DEBUG ((REDFISH_HTTP_CACHE_DEBUG, "%a: expire URI: %s\n", __func__, Uri));
Private = REDFISH_HTTP_CACHE_PRIVATE_FROM_THIS (This);
CacheData = FindHttpCacheData (&Private->CacheList.Head, Uri);
if (CacheData == NULL) {
return EFI_NOT_FOUND;
}
return DeleteHttpCacheData (&Private->CacheList, CacheData);
}
/**
Perform HTTP PATCH to send redfish resource to given resource URI.
It's caller's responsibility to free Response by calling FreeResponse ().
@param[in] This Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
@param[in] Service Redfish service instance to perform HTTP PATCH.
@param[in] Uri Target resource URI.
@param[in] Content Data to patch.
@param[in] ContentSize Size of the Content to be send to Redfish service.
This is optional. When ContentSize is 0, ContentSize
is the size of Content.
@param[in] ContentType Type of the Content to be send to Redfish service.
This is optional. When ContentType is NULL, content
type HTTP_CONTENT_TYPE_APP_JSON will be used.
@param[out] Response HTTP response from redfish service.
@retval EFI_SUCCESS Resource is returned successfully.
@retval Others Errors occur.
**/
EFI_STATUS
EFIAPI
RedfishPatchResource (
IN EDKII_REDFISH_HTTP_PROTOCOL *This,
IN REDFISH_SERVICE Service,
IN EFI_STRING Uri,
IN CHAR8 *Content,
IN UINTN ContentSize OPTIONAL,
IN CHAR8 *ContentType OPTIONAL,
OUT REDFISH_RESPONSE *Response
)
{
EFI_STATUS Status;
UINTN RetryCount;
REDFISH_REQUEST Request;
REDFISH_HTTP_CACHE_PRIVATE *Private;
if ((This == NULL) || (Service == NULL) || (Response == NULL) || IS_EMPTY_STRING (Uri) || IS_EMPTY_STRING (Content)) {
return EFI_INVALID_PARAMETER;
}
DEBUG ((REDFISH_HTTP_CACHE_DEBUG, "%a: Patch URI: %s\n", __func__, Uri));
Private = REDFISH_HTTP_CACHE_PRIVATE_FROM_THIS (This);
RetryCount = 0;
ZeroMem (Response, sizeof (REDFISH_RESPONSE));
ZeroMem (&Request, sizeof (REDFISH_REQUEST));
Request.Content = Content;
Request.ContentLength = ContentSize;
Request.ContentType = ContentType;
//
// Patch resource to redfish service.
//
do {
RetryCount += 1;
Status = HttpSendReceive (
Service,
Uri,
HttpMethodPatch,
&Request,
Response
);
DEBUG ((REDFISH_HTTP_CACHE_DEBUG_REQUEST, "%a: HTTP request: %s :%r\n", __func__, Uri, Status));
if (!EFI_ERROR (Status) || (RetryCount >= Private->RetrySetting.MaximumRetryPatch)) {
break;
}
//
// Retry when BMC is not ready.
//
if ((Response->StatusCode != NULL)) {
DEBUG_CODE (
DumpRedfishResponse (NULL, DEBUG_ERROR, Response);
);
if (!RedfishRetryRequired (Response->StatusCode)) {
break;
}
//
// Release response for next round of request.
//
This->FreeResponse (This, Response);
}
DEBUG ((DEBUG_WARN, "%a: RedfishPatchToUriEx failed, retry (%d/%d)\n", __func__, RetryCount, Private->RetrySetting.MaximumRetryPatch));
if (Private->RetrySetting.RetryWait > 0) {
gBS->Stall (Private->RetrySetting.RetryWait);
}
} while (TRUE);
//
// Redfish resource is updated. Automatically expire the cached response
// so application can directly get resource from Redfish service again.
//
DEBUG ((REDFISH_HTTP_CACHE_DEBUG, "%a: Resource is updated, expire URI: %s\n", __func__, Uri));
RedfishExpireResponse (This, Uri);
if (EFI_ERROR (Status) || !RedfishSuccessResponse (HttpMethodPatch, Response->StatusCode)) {
DEBUG_CODE (
DumpRedfishResponse (NULL, DEBUG_ERROR, Response);
);
//
// Report status code for Redfish failure
//
ReportHttpError (HttpMethodPatch, Uri, Response->StatusCode);
DEBUG ((DEBUG_ERROR, "%a: patch %s failed (%d/%d): %r\n", __func__, Uri, RetryCount, Private->RetrySetting.MaximumRetryPatch, Status));
goto ON_RELEASE;
}
ON_RELEASE:
return Status;
}
/**
Perform HTTP PUT to send redfish resource to given resource URI.
It's caller's responsibility to free Response by calling FreeResponse ().
@param[in] This Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
@param[in] Service Redfish service instance to perform HTTP PUT.
@param[in] Uri Target resource URI.
@param[in] Content Data to put.
@param[in] ContentSize Size of the Content to be send to Redfish service.
This is optional. When ContentSize is 0, ContentSize
is the size of Content.
@param[in] ContentType Type of the Content to be send to Redfish service.
This is optional. When ContentType is NULL, content
type HTTP_CONTENT_TYPE_APP_JSON will be used.
@param[out] Response HTTP response from redfish service.
@retval EFI_SUCCESS Resource is returned successfully.
@retval Others Errors occur.
**/
EFI_STATUS
EFIAPI
RedfishPutResource (
IN EDKII_REDFISH_HTTP_PROTOCOL *This,
IN REDFISH_SERVICE Service,
IN EFI_STRING Uri,
IN CHAR8 *Content,
IN UINTN ContentSize OPTIONAL,
IN CHAR8 *ContentType OPTIONAL,
OUT REDFISH_RESPONSE *Response
)
{
EFI_STATUS Status;
UINTN RetryCount;
REDFISH_REQUEST Request;
REDFISH_HTTP_CACHE_PRIVATE *Private;
if ((This == NULL) || (Service == NULL) || (Response == NULL) || IS_EMPTY_STRING (Uri) || IS_EMPTY_STRING (Content)) {
return EFI_INVALID_PARAMETER;
}
DEBUG ((REDFISH_HTTP_CACHE_DEBUG, "%a: Put URI: %s\n", __func__, Uri));
Private = REDFISH_HTTP_CACHE_PRIVATE_FROM_THIS (This);
RetryCount = 0;
ZeroMem (Response, sizeof (REDFISH_RESPONSE));
ZeroMem (&Request, sizeof (REDFISH_REQUEST));
Request.Content = Content;
Request.ContentLength = ContentSize;
Request.ContentType = ContentType;
//
// Patch resource to redfish service.
//
do {
RetryCount += 1;
Status = HttpSendReceive (
Service,
Uri,
HttpMethodPut,
&Request,
Response
);
DEBUG ((REDFISH_HTTP_CACHE_DEBUG_REQUEST, "%a: HTTP request: %s :%r\n", __func__, Uri, Status));
if (!EFI_ERROR (Status) || (RetryCount >= Private->RetrySetting.MaximumRetryPut)) {
break;
}
//
// Retry when BMC is not ready.
//
if ((Response->StatusCode != NULL)) {
DEBUG_CODE (
DumpRedfishResponse (NULL, DEBUG_ERROR, Response);
);
if (!RedfishRetryRequired (Response->StatusCode)) {
break;
}
//
// Release response for next round of request.
//
This->FreeResponse (This, Response);
}
DEBUG ((DEBUG_WARN, "%a: RedfishPutToUri failed, retry (%d/%d)\n", __func__, RetryCount, Private->RetrySetting.MaximumRetryPut));
if (Private->RetrySetting.RetryWait > 0) {
gBS->Stall (Private->RetrySetting.RetryWait);
}
} while (TRUE);
//
// Redfish resource is updated. Automatically expire the cached response
// so application can directly get resource from Redfish service again.
//
DEBUG ((REDFISH_HTTP_CACHE_DEBUG, "%a: Resource is updated, expire URI: %s\n", __func__, Uri));
RedfishExpireResponse (This, Uri);
if (EFI_ERROR (Status) || !RedfishSuccessResponse (HttpMethodPut, Response->StatusCode)) {
DEBUG_CODE (
DumpRedfishResponse (NULL, DEBUG_ERROR, Response);
);
//
// Report status code for Redfish failure
//
ReportHttpError (HttpMethodPut, Uri, Response->StatusCode);
DEBUG ((DEBUG_ERROR, "%a: put %s failed (%d/%d): %r\n", __func__, Uri, RetryCount, Private->RetrySetting.MaximumRetryPut, Status));
goto ON_RELEASE;
}
ON_RELEASE:
return Status;
}
/**
Perform HTTP POST to send redfish resource to given resource URI.
It's caller's responsibility to free Response by calling FreeResponse ().
@param[in] This Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
@param[in] Service Redfish service instance to perform HTTP POST.
@param[in] Uri Target resource URI.
@param[in] Content Data to post.
@param[in] ContentSize Size of the Content to be send to Redfish service.
This is optional. When ContentSize is 0, ContentSize
is the size of Content.
@param[in] ContentType Type of the Content to be send to Redfish service.
This is optional. When ContentType is NULL, content
type HTTP_CONTENT_TYPE_APP_JSON will be used.
@param[out] Response HTTP response from redfish service.
@retval EFI_SUCCESS Resource is returned successfully.
@retval Others Errors occur.
**/
EFI_STATUS
EFIAPI
RedfishPostResource (
IN EDKII_REDFISH_HTTP_PROTOCOL *This,
IN REDFISH_SERVICE Service,
IN EFI_STRING Uri,
IN CHAR8 *Content,
IN UINTN ContentSize OPTIONAL,
IN CHAR8 *ContentType OPTIONAL,
OUT REDFISH_RESPONSE *Response
)
{
EFI_STATUS Status;
UINTN RetryCount;
REDFISH_REQUEST Request;
REDFISH_HTTP_CACHE_PRIVATE *Private;
if ((This == NULL) || (Service == NULL) || (Response == NULL) || IS_EMPTY_STRING (Uri) || IS_EMPTY_STRING (Content)) {
return EFI_INVALID_PARAMETER;
}
DEBUG ((REDFISH_HTTP_CACHE_DEBUG, "%a: Post URI: %s\n", __func__, Uri));
Private = REDFISH_HTTP_CACHE_PRIVATE_FROM_THIS (This);
RetryCount = 0;
ZeroMem (Response, sizeof (REDFISH_RESPONSE));
ZeroMem (&Request, sizeof (REDFISH_REQUEST));
Request.Content = Content;
Request.ContentLength = ContentSize;
Request.ContentType = ContentType;
//
// Patch resource to redfish service.
//
do {
RetryCount += 1;
Status = HttpSendReceive (
Service,
Uri,
HttpMethodPost,
&Request,
Response
);
DEBUG ((REDFISH_HTTP_CACHE_DEBUG_REQUEST, "%a: HTTP request: %s :%r\n", __func__, Uri, Status));
if (!EFI_ERROR (Status) || (RetryCount >= Private->RetrySetting.MaximumRetryPost)) {
break;
}
//
// Retry when BMC is not ready.
//
if ((Response->StatusCode != NULL)) {
DEBUG_CODE (
DumpRedfishResponse (NULL, DEBUG_ERROR, Response);
);
if (!RedfishRetryRequired (Response->StatusCode)) {
break;
}
//
// Release response for next round of request.
//
This->FreeResponse (This, Response);
}
DEBUG ((DEBUG_WARN, "%a: RedfishPostToUri failed, retry (%d/%d)\n", __func__, RetryCount, Private->RetrySetting.MaximumRetryPost));
if (Private->RetrySetting.RetryWait > 0) {
gBS->Stall (Private->RetrySetting.RetryWait);
}
} while (TRUE);
//
// Redfish resource is updated. Automatically expire the cached response
// so application can directly get resource from Redfish service again.
//
DEBUG ((REDFISH_HTTP_CACHE_DEBUG, "%a: Resource is updated, expire URI: %s\n", __func__, Uri));
RedfishExpireResponse (This, Uri);
if (EFI_ERROR (Status) || !RedfishSuccessResponse (HttpMethodPost, Response->StatusCode)) {
DEBUG_CODE (
DumpRedfishResponse (NULL, DEBUG_ERROR, Response);
);
//
// Report status code for Redfish failure
//
ReportHttpError (HttpMethodPost, Uri, Response->StatusCode);
DEBUG ((DEBUG_ERROR, "%a: post %s failed (%d/%d): %r\n", __func__, Uri, RetryCount, Private->RetrySetting.MaximumRetryPost, Status));
goto ON_RELEASE;
}
ON_RELEASE:
return Status;
}
/**
Perform HTTP DELETE to delete redfish resource on given resource URI.
It's caller's responsibility to free Response by calling FreeResponse ().
@param[in] This Pointer to EDKII_REDFISH_HTTP_PROTOCOL instance.
@param[in] Service Redfish service instance to perform HTTP DELETE.
@param[in] Uri Target resource URI.
@param[in] Content JSON represented properties to be deleted. This is
optional.
@param[in] ContentSize Size of the Content to be send to Redfish service.
This is optional. When ContentSize is 0, ContentSize
is the size of Content if Content is not NULL.
@param[in] ContentType Type of the Content to be send to Redfish service.
This is optional. When Content is not NULL and
ContentType is NULL, content type HTTP_CONTENT_TYPE_APP_JSON
will be used.
@param[out] Response HTTP response from redfish service.
@retval EFI_SUCCESS Resource is returned successfully.
@retval Others Errors occur.
**/
EFI_STATUS
EFIAPI
RedfishDeleteResource (
IN EDKII_REDFISH_HTTP_PROTOCOL *This,
IN REDFISH_SERVICE Service,
IN EFI_STRING Uri,
IN CHAR8 *Content OPTIONAL,
IN UINTN ContentSize OPTIONAL,
IN CHAR8 *ContentType OPTIONAL,
OUT REDFISH_RESPONSE *Response
)
{
EFI_STATUS Status;
UINTN RetryCount;
REDFISH_REQUEST Request;
REDFISH_HTTP_CACHE_PRIVATE *Private;
if ((This == NULL) || (Service == NULL) || (Response == NULL) || IS_EMPTY_STRING (Uri)) {
return EFI_INVALID_PARAMETER;
}
DEBUG ((REDFISH_HTTP_CACHE_DEBUG, "%a: Delete URI: %s\n", __func__, Uri));
Private = REDFISH_HTTP_CACHE_PRIVATE_FROM_THIS (This);
RetryCount = 0;
ZeroMem (Response, sizeof (REDFISH_RESPONSE));
ZeroMem (&Request, sizeof (REDFISH_REQUEST));
Request.Content = Content;
Request.ContentLength = ContentSize;
Request.ContentType = ContentType;
//
// Patch resource to redfish service.
//
do {
RetryCount += 1;
Status = HttpSendReceive (
Service,
Uri,
HttpMethodDelete,
&Request,
Response
);
DEBUG ((REDFISH_HTTP_CACHE_DEBUG_REQUEST, "%a: HTTP request: %s :%r\n", __func__, Uri, Status));
if (!EFI_ERROR (Status) || (RetryCount >= Private->RetrySetting.MaximumRetryDelete)) {
break;
}
//
// Retry when BMC is not ready.
//
if ((Response->StatusCode != NULL)) {
DEBUG_CODE (
DumpRedfishResponse (NULL, DEBUG_ERROR, Response);
);
if (!RedfishRetryRequired (Response->StatusCode)) {
break;
}
//
// Release response for next round of request.
//
This->FreeResponse (This, Response);
}
DEBUG ((DEBUG_WARN, "%a: RedfishDeleteByUri failed, retry (%d/%d)\n", __func__, RetryCount, Private->RetrySetting.MaximumRetryDelete));
if (Private->RetrySetting.RetryWait > 0) {
gBS->Stall (Private->RetrySetting.RetryWait);
}
} while (TRUE);
//
// Redfish resource is updated. Automatically expire the cached response
// so application can directly get resource from Redfish service again.
//
DEBUG ((REDFISH_HTTP_CACHE_DEBUG, "%a: Resource is updated, expire URI: %s\n", __func__, Uri));
RedfishExpireResponse (This, Uri);
if (EFI_ERROR (Status) || !RedfishSuccessResponse (HttpMethodDelete, Response->StatusCode)) {
DEBUG_CODE (
DumpRedfishResponse (NULL, DEBUG_ERROR, Response);
);
//
// Report status code for Redfish failure
//
ReportHttpError (HttpMethodDelete, Uri, Response->StatusCode);
DEBUG ((DEBUG_ERROR, "%a: delete %s failed (%d/%d): %r\n", __func__, Uri, RetryCount, Private->RetrySetting.MaximumRetryDelete, Status));
goto ON_RELEASE;
}
ON_RELEASE:
return Status;
}
EDKII_REDFISH_HTTP_PROTOCOL mEdkIIRedfishHttpProtocol = {
EDKII_REDFISH_HTTP_PROTOCOL_REVISION,
RedfishCreateRedfishService,
RedfishFreeRedfishService,
RedfishJsonInRedfishPayload,
RedfishGetResource,
RedfishPatchResource,
RedfishPutResource,
RedfishPostResource,
RedfishDeleteResource,
RedfishFreeRequest,
RedfishFreeResponse,
RedfishExpireResponse
};
/**
Unloads an image.
@param[in] ImageHandle Handle that identifies the image to be unloaded.
@retval EFI_SUCCESS The image has been unloaded.
@retval EFI_INVALID_PARAMETER ImageHandle is not a valid image handle.
**/
EFI_STATUS
EFIAPI
RedfishHttpDriverUnload (
IN EFI_HANDLE ImageHandle
)
{
if (mRedfishHttpCachePrivate == NULL) {
return EFI_SUCCESS;
}
if (!IsListEmpty (&mRedfishHttpCachePrivate->CacheList.Head)) {
ReleaseCacheList (&mRedfishHttpCachePrivate->CacheList);
}
gBS->UninstallMultipleProtocolInterfaces (
ImageHandle,
&gEdkIIRedfishHttpProtocolGuid,
&mRedfishHttpCachePrivate->Protocol,
NULL
);
FreePool (mRedfishHttpCachePrivate);
mRedfishHttpCachePrivate = NULL;
return EFI_SUCCESS;
}
/**
This is a EDKII_REDFISH_CREDENTIAL_PROTOCOL notification event handler.
@param[in] Event Event whose notification function is being invoked.
@param[in] Context Pointer to the notification function's context.
**/
VOID
EFIAPI
CredentialProtocolInstalled (
IN EFI_EVENT Event,
IN VOID *Context
)
{
EFI_STATUS Status;
REDFISH_HTTP_CACHE_PRIVATE *Private;
Private = (REDFISH_HTTP_CACHE_PRIVATE *)Context;
if (Private->Signature != REDFISH_HTTP_DRIVER_SIGNATURE) {
DEBUG ((DEBUG_ERROR, "%a: signature check failure\n", __func__));
return;
}
//
// Locate HII credential protocol.
//
Status = gBS->LocateProtocol (
&gEdkIIRedfishCredential2ProtocolGuid,
NULL,
(VOID **)&Private->CredentialProtocol
);
if (EFI_ERROR (Status)) {
return;
}
gBS->CloseEvent (Event);
}
/**
Main entry for this driver.
@param[in] ImageHandle Image handle this driver.
@param[in] SystemTable Pointer to SystemTable.
@retval EFI_SUCCESS This function always complete successfully.
**/
EFI_STATUS
EFIAPI
RedfishHttpEntryPoint (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
{
EFI_STATUS Status;
VOID *Registration;
if (mRedfishHttpCachePrivate != NULL) {
return EFI_ALREADY_STARTED;
}
mRedfishHttpCachePrivate = AllocateZeroPool (sizeof (REDFISH_HTTP_CACHE_PRIVATE));
if (mRedfishHttpCachePrivate == NULL) {
return EFI_OUT_OF_RESOURCES;
}
//
// Initial cache list and protocol instance.
//
mRedfishHttpCachePrivate->Signature = REDFISH_HTTP_DRIVER_SIGNATURE;
mRedfishHttpCachePrivate->ImageHandle = ImageHandle;
CopyMem (&mRedfishHttpCachePrivate->Protocol, &mEdkIIRedfishHttpProtocol, sizeof (EDKII_REDFISH_HTTP_PROTOCOL));
mRedfishHttpCachePrivate->CacheList.Capacity = REDFISH_HTTP_CACHE_LIST_SIZE;
mRedfishHttpCachePrivate->CacheList.Count = 0x00;
mRedfishHttpCachePrivate->CacheDisabled = PcdGetBool (PcdHttpCacheDisabled);
InitializeListHead (&mRedfishHttpCachePrivate->CacheList.Head);
//
// Get retry settings
//
mRedfishHttpCachePrivate->RetrySetting.MaximumRetryGet = PcdGet16 (PcdHttpGetRetry);
mRedfishHttpCachePrivate->RetrySetting.MaximumRetryPut = PcdGet16 (PcdHttpPutRetry);
mRedfishHttpCachePrivate->RetrySetting.MaximumRetryPatch = PcdGet16 (PcdHttpPatchRetry);
mRedfishHttpCachePrivate->RetrySetting.MaximumRetryPost = PcdGet16 (PcdHttpPostRetry);
mRedfishHttpCachePrivate->RetrySetting.MaximumRetryDelete = PcdGet16 (PcdHttpDeleteRetry);
mRedfishHttpCachePrivate->RetrySetting.RetryWait = PcdGet16 (PcdHttpRetryWaitInSecond) * 1000000U;
//
// Install the gEdkIIRedfishHttpProtocolGuid onto Handle.
//
Status = gBS->InstallMultipleProtocolInterfaces (
&mRedfishHttpCachePrivate->ImageHandle,
&gEdkIIRedfishHttpProtocolGuid,
&mRedfishHttpCachePrivate->Protocol,
NULL
);
if (EFI_ERROR (Status)) {
DEBUG ((DEBUG_ERROR, "%a: cannot install Redfish http protocol: %r\n", __func__, Status));
RedfishHttpDriverUnload (ImageHandle);
return Status;
}
//
// Install protocol notification if credential protocol is installed.
//
mRedfishHttpCachePrivate->NotifyEvent = EfiCreateProtocolNotifyEvent (
&gEdkIIRedfishCredential2ProtocolGuid,
TPL_CALLBACK,
CredentialProtocolInstalled,
mRedfishHttpCachePrivate,
&Registration
);
if (mRedfishHttpCachePrivate->NotifyEvent == NULL) {
DEBUG ((DEBUG_ERROR, "%a: failed to create protocol notification for gEdkIIRedfishCredential2ProtocolGuid\n", __func__));
ASSERT (FALSE);
RedfishHttpDriverUnload (ImageHandle);
return Status;
}
return EFI_SUCCESS;
}
|