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
|
/** @file
Redfish HTTP cache library helps Redfish application to get Redfish resource
from BMC with cache mechanism enabled.
Copyright (c) 2023-2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include <Library/BaseLib.h>
#include <Library/DebugLib.h>
#include <Library/RedfishHttpLib.h>
#include <Library/UefiBootServicesTableLib.h>
#include <Library/UefiLib.h>
EDKII_REDFISH_HTTP_PROTOCOL *mRedfishHttpProtocol = NULL;
/**
This function create Redfish service. It's caller's responsibility to free returned
Redfish service by calling FreeService ().
@param[in] RedfishConfigServiceInfo Redfish config service information.
@retval REDFISH_SERVICE Redfish service is created.
@retval NULL Errors occur.
**/
REDFISH_SERVICE
RedfishCreateService (
IN REDFISH_CONFIG_SERVICE_INFORMATION *RedfishConfigServiceInfo
)
{
if (mRedfishHttpProtocol == NULL) {
return NULL;
}
return mRedfishHttpProtocol->CreateService (
mRedfishHttpProtocol,
RedfishConfigServiceInfo
);
}
/**
This function free resources in Redfish service. RedfishService is no longer available
after this function returns successfully.
@param[in] RedfishService Pointer to Redfish service to be released.
@retval EFI_SUCCESS Resource is released successfully.
@retval Others Errors occur.
**/
EFI_STATUS
RedfishCleanupService (
IN REDFISH_SERVICE RedfishService
)
{
if (mRedfishHttpProtocol == NULL) {
return EFI_NOT_READY;
}
return mRedfishHttpProtocol->FreeService (
mRedfishHttpProtocol,
RedfishService
);
}
/**
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] RedfishPayload Pointer to Redfish payload.
@retval EDKII_JSON_VALUE JSON value is returned.
@retval NULL Errors occur.
**/
EDKII_JSON_VALUE
RedfishJsonInPayload (
IN REDFISH_PAYLOAD RedfishPayload
)
{
if (mRedfishHttpProtocol == NULL) {
return NULL;
}
return mRedfishHttpProtocol->JsonInPayload (
mRedfishHttpProtocol,
RedfishPayload
);
}
/**
This function free resources in Request. Request is no longer available
after this function returns successfully.
@param[in] Request HTTP request to be released.
@retval EFI_SUCCESS Resource is released successfully.
@retval Others Errors occur.
**/
EFI_STATUS
RedfishHttpFreeRequest (
IN REDFISH_REQUEST *Request
)
{
if (mRedfishHttpProtocol == NULL) {
return EFI_NOT_READY;
}
return mRedfishHttpProtocol->FreeRequest (
mRedfishHttpProtocol,
Request
);
}
/**
This function free resources in Response. Response is no longer available
after this function returns successfully.
@param[in] Response HTTP response to be released.
@retval EFI_SUCCESS Resource is released successfully.
@retval Others Errors occur.
**/
EFI_STATUS
RedfishHttpFreeResponse (
IN REDFISH_RESPONSE *Response
)
{
if (mRedfishHttpProtocol == NULL) {
return EFI_NOT_READY;
}
return mRedfishHttpProtocol->FreeResponse (
mRedfishHttpProtocol,
Response
);
}
/**
This function expire the cached response of given URI.
@param[in] Uri Target response of URI.
@retval EFI_SUCCESS Target response is expired successfully.
@retval Others Errors occur.
**/
EFI_STATUS
RedfishHttpExpireResponse (
IN EFI_STRING Uri
)
{
if (mRedfishHttpProtocol == NULL) {
return EFI_NOT_READY;
}
return mRedfishHttpProtocol->ExpireResponse (
mRedfishHttpProtocol,
Uri
);
}
/**
Get redfish resource from given resource URI with cache mechanism
supported. It's caller's responsibility to Response by calling
RedfishHttpFreeResponse ().
@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
RedfishHttpGetResource (
IN REDFISH_SERVICE Service,
IN EFI_STRING Uri,
IN REDFISH_REQUEST *Request OPTIONAL,
OUT REDFISH_RESPONSE *Response,
IN BOOLEAN UseCache
)
{
if (mRedfishHttpProtocol == NULL) {
return EFI_NOT_READY;
}
return mRedfishHttpProtocol->GetResource (
mRedfishHttpProtocol,
Service,
Uri,
Request,
Response,
UseCache
);
}
/**
Perform HTTP PATCH to send redfish resource to given resource URI.
It's caller's responsibility to free Response by calling RedfishHttpFreeResponse ().
@param[in] Service Redfish service instance to perform HTTP PATCH.
@param[in] Uri Target resource URI.
@param[in] Content Data to patch.
@param[out] Response HTTP response from redfish service.
@retval EFI_SUCCESS Resource is returned successfully.
@retval Others Errors occur.
**/
EFI_STATUS
RedfishHttpPatchResource (
IN REDFISH_SERVICE Service,
IN EFI_STRING Uri,
IN CHAR8 *Content,
OUT REDFISH_RESPONSE *Response
)
{
if (mRedfishHttpProtocol == NULL) {
return EFI_NOT_READY;
}
return mRedfishHttpProtocol->PatchResource (
mRedfishHttpProtocol,
Service,
Uri,
Content,
0,
NULL,
Response
);
}
/**
Perform HTTP PATCH to send redfish resource to given resource URI.
It's caller's responsibility to free Response by calling RedfishHttpFreeResponse ().
@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.
@param[out] Response HTTP response from redfish service.
@retval EFI_SUCCESS Resource is returned successfully.
@retval Others Errors occur.
**/
EFI_STATUS
RedfishHttpPatchResourceEx (
IN REDFISH_SERVICE Service,
IN EFI_STRING Uri,
IN CHAR8 *Content,
IN UINTN ContentSize OPTIONAL,
IN CHAR8 *ContentType OPTIONAL,
OUT REDFISH_RESPONSE *Response
)
{
if (mRedfishHttpProtocol == NULL) {
return EFI_NOT_READY;
}
return mRedfishHttpProtocol->PatchResource (
mRedfishHttpProtocol,
Service,
Uri,
Content,
ContentSize,
ContentType,
Response
);
}
/**
Perform HTTP PUT to send redfish resource to given resource URI.
It's caller's responsibility to free Response by calling RedfishHttpFreeResponse ().
@param[in] Service Redfish service instance to perform HTTP PUT.
@param[in] Uri Target resource URI.
@param[in] Content Data to put.
@param[out] Response HTTP response from redfish service.
@retval EFI_SUCCESS Resource is returned successfully.
@retval Others Errors occur.
**/
EFI_STATUS
RedfishHttpPutResource (
IN REDFISH_SERVICE Service,
IN EFI_STRING Uri,
IN CHAR8 *Content,
OUT REDFISH_RESPONSE *Response
)
{
if (mRedfishHttpProtocol == NULL) {
return EFI_NOT_READY;
}
return mRedfishHttpProtocol->PutResource (
mRedfishHttpProtocol,
Service,
Uri,
Content,
0,
NULL,
Response
);
}
/**
Perform HTTP PUT to send redfish resource to given resource URI.
It's caller's responsibility to free Response by calling RedfishHttpFreeResponse ().
@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.
@param[out] Response HTTP response from redfish service.
@retval EFI_SUCCESS Resource is returned successfully.
@retval Others Errors occur.
**/
EFI_STATUS
RedfishHttpPutResourceEx (
IN REDFISH_SERVICE Service,
IN EFI_STRING Uri,
IN CHAR8 *Content,
IN UINTN ContentSize OPTIONAL,
IN CHAR8 *ContentType OPTIONAL,
OUT REDFISH_RESPONSE *Response
)
{
if (mRedfishHttpProtocol == NULL) {
return EFI_NOT_READY;
}
return mRedfishHttpProtocol->PutResource (
mRedfishHttpProtocol,
Service,
Uri,
Content,
ContentSize,
ContentType,
Response
);
}
/**
Perform HTTP POST to send redfish resource to given resource URI.
It's caller's responsibility to free Response by calling RedfishHttpFreeResponse ().
@param[in] Service Redfish service instance to perform HTTP POST.
@param[in] Uri Target resource URI.
@param[in] Content Data to post.
@param[out] Response HTTP response from redfish service.
@retval EFI_SUCCESS Resource is returned successfully.
@retval Others Errors occur.
**/
EFI_STATUS
RedfishHttpPostResource (
IN REDFISH_SERVICE Service,
IN EFI_STRING Uri,
IN CHAR8 *Content,
OUT REDFISH_RESPONSE *Response
)
{
if (mRedfishHttpProtocol == NULL) {
return EFI_NOT_READY;
}
return mRedfishHttpProtocol->PostResource (
mRedfishHttpProtocol,
Service,
Uri,
Content,
0,
NULL,
Response
);
}
/**
Perform HTTP POST to send redfish resource to given resource URI.
It's caller's responsibility to free Response by calling RedfishHttpFreeResponse ().
@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.
@param[out] Response HTTP response from redfish service.
@retval EFI_SUCCESS Resource is returned successfully.
@retval Others Errors occur.
**/
EFI_STATUS
RedfishHttpPostResourceEx (
IN REDFISH_SERVICE Service,
IN EFI_STRING Uri,
IN CHAR8 *Content,
IN UINTN ContentSize OPTIONAL,
IN CHAR8 *ContentType OPTIONAL,
OUT REDFISH_RESPONSE *Response
)
{
if (mRedfishHttpProtocol == NULL) {
return EFI_NOT_READY;
}
return mRedfishHttpProtocol->PostResource (
mRedfishHttpProtocol,
Service,
Uri,
Content,
ContentSize,
ContentType,
Response
);
}
/**
Perform HTTP DELETE to delete redfish resource on given resource URI.
It's caller's responsibility to free Response by calling RedfishHttpFreeResponse ().
@param[in] Service Redfish service instance to perform HTTP DELETE.
@param[in] Uri Target resource URI.
@param[out] Response HTTP response from redfish service.
@retval EFI_SUCCESS Resource is returned successfully.
@retval Others Errors occur.
**/
EFI_STATUS
RedfishHttpDeleteResource (
IN REDFISH_SERVICE Service,
IN EFI_STRING Uri,
OUT REDFISH_RESPONSE *Response
)
{
if (mRedfishHttpProtocol == NULL) {
return EFI_NOT_READY;
}
return mRedfishHttpProtocol->DeleteResource (
mRedfishHttpProtocol,
Service,
Uri,
NULL,
0,
NULL,
Response
);
}
/**
Perform HTTP DELETE to delete redfish resource on given resource URI.
It's caller's responsibility to free Response by calling RedfishHttpFreeResponse ().
@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.
@param[out] Response HTTP response from redfish service.
@retval EFI_SUCCESS Resource is returned successfully.
@retval Others Errors occur.
**/
EFI_STATUS
RedfishHttpDeleteResourceEx (
IN REDFISH_SERVICE Service,
IN EFI_STRING Uri,
IN CHAR8 *Content OPTIONAL,
IN UINTN ContentSize OPTIONAL,
IN CHAR8 *ContentType OPTIONAL,
OUT REDFISH_RESPONSE *Response
)
{
if (mRedfishHttpProtocol == NULL) {
return EFI_NOT_READY;
}
return mRedfishHttpProtocol->DeleteResource (
mRedfishHttpProtocol,
Service,
Uri,
Content,
ContentSize,
ContentType,
Response
);
}
/**
Callback function when gEdkIIRedfishHttpProtocolGuid is installed.
@param[in] Event Event whose notification function is being invoked.
@param[in] Context Pointer to the notification function's context.
**/
VOID
EFIAPI
RedfishHttpProtocolIsReady (
IN EFI_EVENT Event,
IN VOID *Context
)
{
EFI_STATUS Status;
if (mRedfishHttpProtocol != NULL) {
gBS->CloseEvent (Event);
return;
}
Status = gBS->LocateProtocol (
&gEdkIIRedfishHttpProtocolGuid,
NULL,
(VOID **)&mRedfishHttpProtocol
);
if (EFI_ERROR (Status)) {
return;
}
gBS->CloseEvent (Event);
}
/**
Initial HTTP library instance.
@param[in] ImageHandle The image handle.
@param[in] SystemTable The system table.
@retval EFI_SUCCESS Initial library successfully.
@retval Other Return error status.
**/
EFI_STATUS
EFIAPI
RedfishHttpConstructor (
IN EFI_HANDLE ImageHandle,
IN EFI_SYSTEM_TABLE *SystemTable
)
{
VOID *Registration;
EfiCreateProtocolNotifyEvent (
&gEdkIIRedfishHttpProtocolGuid,
TPL_CALLBACK,
RedfishHttpProtocolIsReady,
NULL,
&Registration
);
return EFI_SUCCESS;
}
|