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
|
/** @file
Redfish debug library to debug Redfish application.
Copyright (c) 2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent
**/
#include <Uefi.h>
#include <Library/BaseLib.h>
#include <Library/DebugLib.h>
#include <Library/MemoryAllocationLib.h>
#include <Library/RedfishDebugLib.h>
#include <Library/UefiLib.h>
#ifndef IS_EMPTY_STRING
#define IS_EMPTY_STRING(a) ((a) == NULL || (a)[0] == '\0')
#endif
#define REDFISH_JSON_STRING_LENGTH 200
#define REDFISH_JSON_OUTPUT_FORMAT (EDKII_JSON_COMPACT | EDKII_JSON_INDENT(2))
/**
This function dump the Json string in given error level.
@param[in] ErrorLevel DEBUG macro error level
@param[in] JsonValue Json value to dump.
@retval EFI_SUCCESS Json string is printed.
@retval Others Errors occur.
**/
EFI_STATUS
DumpJsonValue (
IN UINTN ErrorLevel,
IN EDKII_JSON_VALUE JsonValue
)
{
CHAR8 *String;
CHAR8 *Runner;
CHAR8 Buffer[REDFISH_JSON_STRING_LENGTH + 1];
UINTN StrLen;
UINTN Count;
UINTN Index;
if (JsonValue == NULL) {
return EFI_INVALID_PARAMETER;
}
String = JsonDumpString (JsonValue, REDFISH_JSON_OUTPUT_FORMAT);
if (String == NULL) {
return EFI_UNSUPPORTED;
}
StrLen = AsciiStrLen (String);
if (StrLen == 0) {
return EFI_UNSUPPORTED;
}
Count = StrLen / REDFISH_JSON_STRING_LENGTH;
Runner = String;
for (Index = 0; Index < Count; Index++) {
AsciiStrnCpyS (Buffer, (REDFISH_JSON_STRING_LENGTH + 1), Runner, REDFISH_JSON_STRING_LENGTH);
Buffer[REDFISH_JSON_STRING_LENGTH] = '\0';
DEBUG ((ErrorLevel, "%a", Buffer));
Runner += REDFISH_JSON_STRING_LENGTH;
}
Count = StrLen % REDFISH_JSON_STRING_LENGTH;
if (Count > 0) {
DEBUG ((ErrorLevel, "%a", Runner));
}
DEBUG ((ErrorLevel, "\n"));
FreePool (String);
return EFI_SUCCESS;
}
/**
This function dump the status code, header and body in given
Redfish payload.
@param[in] ErrorLevel DEBUG macro error level
@param[in] Payload Redfish payload to dump
@retval EFI_SUCCESS Redfish payload is printed.
@retval Others Errors occur.
**/
EFI_STATUS
DumpRedfishPayload (
IN UINTN ErrorLevel,
IN REDFISH_PAYLOAD Payload
)
{
EDKII_JSON_VALUE JsonValue;
if (Payload == NULL) {
return EFI_INVALID_PARAMETER;
}
JsonValue = RedfishJsonInPayload (Payload);
if (JsonValue != NULL) {
DEBUG ((ErrorLevel, "Payload:\n"));
DumpJsonValue (ErrorLevel, JsonValue);
}
return EFI_SUCCESS;
}
/**
This function dump the HTTP status code.
@param[in] ErrorLevel DEBUG macro error level
@param[in] HttpStatusCode HTTP status code
@retval EFI_SUCCESS HTTP status code is printed
**/
EFI_STATUS
DumpHttpStatusCode (
IN UINTN ErrorLevel,
IN EFI_HTTP_STATUS_CODE HttpStatusCode
)
{
switch (HttpStatusCode) {
case HTTP_STATUS_100_CONTINUE:
DEBUG ((ErrorLevel, "Status code: 100 CONTINUE\n"));
break;
case HTTP_STATUS_200_OK:
DEBUG ((ErrorLevel, "Status code: 200 OK\n"));
break;
case HTTP_STATUS_201_CREATED:
DEBUG ((ErrorLevel, "Status code: 201 CREATED\n"));
break;
case HTTP_STATUS_202_ACCEPTED:
DEBUG ((ErrorLevel, "Status code: 202 ACCEPTED\n"));
break;
case HTTP_STATUS_304_NOT_MODIFIED:
DEBUG ((ErrorLevel, "Status code: 304 NOT MODIFIED\n"));
break;
case HTTP_STATUS_400_BAD_REQUEST:
DEBUG ((ErrorLevel, "Status code: 400 BAD REQUEST\n"));
break;
case HTTP_STATUS_401_UNAUTHORIZED:
DEBUG ((ErrorLevel, "Status code: 401 UNAUTHORIZED\n"));
break;
case HTTP_STATUS_403_FORBIDDEN:
DEBUG ((ErrorLevel, "Status code: 403 FORBIDDEN\n"));
break;
case HTTP_STATUS_404_NOT_FOUND:
DEBUG ((ErrorLevel, "Status code: 404 NOT FOUND\n"));
break;
case HTTP_STATUS_405_METHOD_NOT_ALLOWED:
DEBUG ((ErrorLevel, "Status code: 405 METHOD NOT ALLOWED\n"));
break;
case HTTP_STATUS_500_INTERNAL_SERVER_ERROR:
DEBUG ((ErrorLevel, "Status code: 500 INTERNAL SERVER ERROR\n"));
break;
default:
DEBUG ((ErrorLevel, "Status code: 0x%x\n", HttpStatusCode));
break;
}
return EFI_SUCCESS;
}
/**
This function dump the status code, header and body in given
Redfish response.
@param[in] Message Message string
@param[in] ErrorLevel DEBUG macro error level
@param[in] Response Redfish response to dump
@retval EFI_SUCCESS Redfish response is printed.
@retval Others Errors occur.
**/
EFI_STATUS
DumpRedfishResponse (
IN CONST CHAR8 *Message,
IN UINTN ErrorLevel,
IN REDFISH_RESPONSE *Response
)
{
UINTN Index;
if (Response == NULL) {
return EFI_INVALID_PARAMETER;
}
if (!IS_EMPTY_STRING (Message)) {
DEBUG ((ErrorLevel, "%a\n", Message));
}
//
// status code
//
if (Response->StatusCode != NULL) {
DumpHttpStatusCode (ErrorLevel, *(Response->StatusCode));
}
//
// header
//
if (Response->HeaderCount > 0) {
DEBUG ((ErrorLevel, "Header: %d\n", Response->HeaderCount));
for (Index = 0; Index < Response->HeaderCount; Index++) {
DEBUG ((ErrorLevel, " %a: %a\n", Response->Headers[Index].FieldName, Response->Headers[Index].FieldValue));
}
}
//
// Body
//
if (Response->Payload != NULL) {
DumpRedfishPayload (ErrorLevel, Response->Payload);
}
return EFI_SUCCESS;
}
|
