.../RedfishPlatformConfigDxe.c | 123 +++++++++++++++++- 1 file changed, 122 insertions(+), 1 deletion(-)
Add debug prints to show HII option name when assert happens.
This helps developer to debug assert issue easily while Redfish
failed to convert HII value to Redfish value.
Signed-off-by: Nickle Wang <nicklew@nvidia.com>
Cc: Abner Chang <abner.chang@amd.com>
Cc: Igor Kulchytskyy <igork@ami.com>
Cc: Nick Ramirez <nramirez@nvidia.com>
---
.../RedfishPlatformConfigDxe.c | 123 +++++++++++++++++-
1 file changed, 122 insertions(+), 1 deletion(-)
diff --git a/RedfishPkg/RedfishPlatformConfigDxe/RedfishPlatformConfigDxe.c b/RedfishPkg/RedfishPlatformConfigDxe/RedfishPlatformConfigDxe.c
index 30d2ef351eca..cbc65ba59408 100644
--- a/RedfishPkg/RedfishPlatformConfigDxe/RedfishPlatformConfigDxe.c
+++ b/RedfishPkg/RedfishPlatformConfigDxe/RedfishPlatformConfigDxe.c
@@ -203,6 +203,106 @@ FindFormLinkToThis (
return NULL;
}
+/**
+ Debug dump HII statement value.
+
+ @param[in] ErrorLevel DEBUG macro error level
+ @param[in] Value HII statement value to dump
+ @param[in] Message Debug message
+
+ @retval EFI_SUCCESS Dump HII statement value successfully
+ @retval Others Errors occur
+
+**/
+EFI_STATUS
+DumpHiiStatementValue (
+ IN UINTN ErrorLevel,
+ IN HII_STATEMENT_VALUE *Value,
+ IN CHAR8 *Message OPTIONAL
+ )
+{
+ UINT64 Data;
+
+ if (Value == NULL) {
+ return EFI_INVALID_PARAMETER;
+ }
+
+ switch (Value->Type) {
+ case EFI_IFR_TYPE_NUM_SIZE_8:
+ Data = Value->Value.u8;
+ break;
+ case EFI_IFR_TYPE_NUM_SIZE_16:
+ Data = Value->Value.u16;
+ break;
+ case EFI_IFR_TYPE_NUM_SIZE_32:
+ Data = Value->Value.u32;
+ break;
+ case EFI_IFR_TYPE_NUM_SIZE_64:
+ Data = Value->Value.u64;
+ break;
+ case EFI_IFR_TYPE_BOOLEAN:
+ Data = (Value->Value.b ? 1 : 0);
+ break;
+ default:
+ DEBUG ((ErrorLevel, "%a: unsupported type: 0x%x\n", __func__, Value->Type));
+ return EFI_UNSUPPORTED;
+ }
+
+ if (IS_EMPTY_STRING (Message)) {
+ DEBUG ((ErrorLevel, "0x%lx\n", Data));
+ } else {
+ DEBUG ((ErrorLevel, "%a: 0x%lx\n", Message, Data));
+ }
+
+ return EFI_SUCCESS;
+}
+
+/**
+ Debug dump HII statement prompt string.
+
+ @param[in] ErrorLevel DEBUG macro error level
+ @param[in] HiiHandle HII handle instance
+ @param[in] HiiStatement HII statement
+ @param[in] Message Debug message
+
+ @retval EFI_SUCCESS Dump HII statement string successfully
+ @retval Others Errors occur
+
+**/
+EFI_STATUS
+DumpHiiStatementPrompt (
+ IN UINTN ErrorLevel,
+ IN EFI_HII_HANDLE HiiHandle,
+ IN HII_STATEMENT *HiiStatement,
+ IN CHAR8 *Message OPTIONAL
+ )
+{
+ EFI_STRING String;
+
+ if ((HiiHandle == NULL) || (HiiStatement == NULL)) {
+ return EFI_INVALID_PARAMETER;
+ }
+
+ if (HiiStatement->Prompt == 0) {
+ return EFI_NOT_FOUND;
+ }
+
+ String = HiiGetString (HiiHandle, HiiStatement->Prompt, NULL);
+ if (String == NULL) {
+ return EFI_NOT_FOUND;
+ }
+
+ if (IS_EMPTY_STRING (Message)) {
+ DEBUG ((ErrorLevel, "%s\n", String));
+ } else {
+ DEBUG ((ErrorLevel, "%a: %s\n", Message, String));
+ }
+
+ FreePool (String);
+
+ return EFI_SUCCESS;
+}
+
/**
Build the menu path to given statement instance. It is caller's
responsibility to free returned string buffer.
@@ -890,6 +990,7 @@ HiiValueToRedfishNumeric (
break;
default:
RedfishValue->Type = RedfishValueTypeUnknown;
+ DEBUG ((DEBUG_ERROR, "%a: Unsupported value type: 0x%x\n", __func__, Value->Type));
break;
}
@@ -1187,6 +1288,11 @@ HiiValueToRedfishValue (
case EFI_IFR_ONE_OF_OP:
StringId = HiiValueToOneOfOptionStringId (HiiStatement, Value);
if (StringId == 0) {
+ //
+ // Print prompt string of HII statement for ease of debugging
+ //
+ DumpHiiStatementPrompt (DEBUG_ERROR, HiiHandle, HiiStatement, "Can not find string ID");
+ DumpHiiStatementValue (DEBUG_ERROR, Value, "Current value");
ASSERT (FALSE);
Status = EFI_DEVICE_ERROR;
break;
@@ -1254,6 +1360,10 @@ HiiValueToRedfishValue (
case EFI_IFR_ORDERED_LIST_OP:
StringIdArray = HiiValueToOrderedListOptionStringId (HiiStatement, &Count);
if (StringIdArray == NULL) {
+ //
+ // Print prompt string of HII statement for ease of debugging
+ //
+ DumpHiiStatementPrompt (DEBUG_ERROR, HiiHandle, HiiStatement, "Can not get string ID array");
ASSERT (FALSE);
Status = EFI_DEVICE_ERROR;
break;
@@ -1261,13 +1371,24 @@ HiiValueToRedfishValue (
RedfishValue->Value.StringArray = AllocatePool (sizeof (CHAR8 *) * Count);
if (RedfishValue->Value.StringArray == NULL) {
+ //
+ // Print prompt string of HII statement for ease of debugging
+ //
+ DumpHiiStatementPrompt (DEBUG_ERROR, HiiHandle, HiiStatement, "Can not allocate memory");
ASSERT (FALSE);
Status = EFI_OUT_OF_RESOURCES;
break;
}
for (Index = 0; Index < Count; Index++) {
- ASSERT (StringIdArray[Index] != 0);
+ if (StringIdArray[Index] == 0) {
+ //
+ // Print prompt string of HII statement for ease of debugging
+ //
+ DumpHiiStatementPrompt (DEBUG_ERROR, HiiHandle, HiiStatement, "String ID in array is 0");
+ ASSERT (FALSE);
+ }
+
RedfishValue->Value.StringArray[Index] = HiiGetRedfishAsciiString (HiiHandle, FullSchema, StringIdArray[Index]);
ASSERT (RedfishValue->Value.StringArray[Index] != NULL);
}
--
2.17.1
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#109927): https://edk2.groups.io/g/devel/message/109927
Mute This Topic: https://groups.io/mt/102136156/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-[AMD Official Use Only - General]
The change looks good.
Reviewed-by: Abner Chang <abner.chang@amd.com>
> -----Original Message-----
> From: Nickle Wang <nicklew@nvidia.com>
> Sent: Monday, October 23, 2023 10:18 PM
> To: devel@edk2.groups.io
> Cc: Chang, Abner <Abner.Chang@amd.com>; Igor Kulchytskyy
> <igork@ami.com>; Nick Ramirez <nramirez@nvidia.com>
> Subject: [PATCH] RedfishPkg/RedfishPlatformConfigDxe: add debug message.
>
> Caution: This message originated from an External Source. Use proper caution
> when opening attachments, clicking links, or responding.
>
>
> Add debug prints to show HII option name when assert happens.
> This helps developer to debug assert issue easily while Redfish
> failed to convert HII value to Redfish value.
>
> Signed-off-by: Nickle Wang <nicklew@nvidia.com>
> Cc: Abner Chang <abner.chang@amd.com>
> Cc: Igor Kulchytskyy <igork@ami.com>
> Cc: Nick Ramirez <nramirez@nvidia.com>
> ---
> .../RedfishPlatformConfigDxe.c | 123 +++++++++++++++++-
> 1 file changed, 122 insertions(+), 1 deletion(-)
>
> diff --git a/RedfishPkg/RedfishPlatformConfigDxe/RedfishPlatformConfigDxe.c
> b/RedfishPkg/RedfishPlatformConfigDxe/RedfishPlatformConfigDxe.c
> index 30d2ef351eca..cbc65ba59408 100644
> --- a/RedfishPkg/RedfishPlatformConfigDxe/RedfishPlatformConfigDxe.c
> +++ b/RedfishPkg/RedfishPlatformConfigDxe/RedfishPlatformConfigDxe.c
> @@ -203,6 +203,106 @@ FindFormLinkToThis (
> return NULL;
> }
>
> +/**
> + Debug dump HII statement value.
> +
> + @param[in] ErrorLevel DEBUG macro error level
> + @param[in] Value HII statement value to dump
> + @param[in] Message Debug message
> +
> + @retval EFI_SUCCESS Dump HII statement value successfully
> + @retval Others Errors occur
> +
> +**/
> +EFI_STATUS
> +DumpHiiStatementValue (
> + IN UINTN ErrorLevel,
> + IN HII_STATEMENT_VALUE *Value,
> + IN CHAR8 *Message OPTIONAL
> + )
> +{
> + UINT64 Data;
> +
> + if (Value == NULL) {
> + return EFI_INVALID_PARAMETER;
> + }
> +
> + switch (Value->Type) {
> + case EFI_IFR_TYPE_NUM_SIZE_8:
> + Data = Value->Value.u8;
> + break;
> + case EFI_IFR_TYPE_NUM_SIZE_16:
> + Data = Value->Value.u16;
> + break;
> + case EFI_IFR_TYPE_NUM_SIZE_32:
> + Data = Value->Value.u32;
> + break;
> + case EFI_IFR_TYPE_NUM_SIZE_64:
> + Data = Value->Value.u64;
> + break;
> + case EFI_IFR_TYPE_BOOLEAN:
> + Data = (Value->Value.b ? 1 : 0);
> + break;
> + default:
> + DEBUG ((ErrorLevel, "%a: unsupported type: 0x%x\n", __func__, Value-
> >Type));
> + return EFI_UNSUPPORTED;
> + }
> +
> + if (IS_EMPTY_STRING (Message)) {
> + DEBUG ((ErrorLevel, "0x%lx\n", Data));
> + } else {
> + DEBUG ((ErrorLevel, "%a: 0x%lx\n", Message, Data));
> + }
> +
> + return EFI_SUCCESS;
> +}
> +
> +/**
> + Debug dump HII statement prompt string.
> +
> + @param[in] ErrorLevel DEBUG macro error level
> + @param[in] HiiHandle HII handle instance
> + @param[in] HiiStatement HII statement
> + @param[in] Message Debug message
> +
> + @retval EFI_SUCCESS Dump HII statement string successfully
> + @retval Others Errors occur
> +
> +**/
> +EFI_STATUS
> +DumpHiiStatementPrompt (
> + IN UINTN ErrorLevel,
> + IN EFI_HII_HANDLE HiiHandle,
> + IN HII_STATEMENT *HiiStatement,
> + IN CHAR8 *Message OPTIONAL
> + )
> +{
> + EFI_STRING String;
> +
> + if ((HiiHandle == NULL) || (HiiStatement == NULL)) {
> + return EFI_INVALID_PARAMETER;
> + }
> +
> + if (HiiStatement->Prompt == 0) {
> + return EFI_NOT_FOUND;
> + }
> +
> + String = HiiGetString (HiiHandle, HiiStatement->Prompt, NULL);
> + if (String == NULL) {
> + return EFI_NOT_FOUND;
> + }
> +
> + if (IS_EMPTY_STRING (Message)) {
> + DEBUG ((ErrorLevel, "%s\n", String));
> + } else {
> + DEBUG ((ErrorLevel, "%a: %s\n", Message, String));
> + }
> +
> + FreePool (String);
> +
> + return EFI_SUCCESS;
> +}
> +
> /**
> Build the menu path to given statement instance. It is caller's
> responsibility to free returned string buffer.
> @@ -890,6 +990,7 @@ HiiValueToRedfishNumeric (
> break;
> default:
> RedfishValue->Type = RedfishValueTypeUnknown;
> + DEBUG ((DEBUG_ERROR, "%a: Unsupported value type: 0x%x\n",
> __func__, Value->Type));
> break;
> }
>
> @@ -1187,6 +1288,11 @@ HiiValueToRedfishValue (
> case EFI_IFR_ONE_OF_OP:
> StringId = HiiValueToOneOfOptionStringId (HiiStatement, Value);
> if (StringId == 0) {
> + //
> + // Print prompt string of HII statement for ease of debugging
> + //
> + DumpHiiStatementPrompt (DEBUG_ERROR, HiiHandle, HiiStatement,
> "Can not find string ID");
> + DumpHiiStatementValue (DEBUG_ERROR, Value, "Current value");
> ASSERT (FALSE);
> Status = EFI_DEVICE_ERROR;
> break;
> @@ -1254,6 +1360,10 @@ HiiValueToRedfishValue (
> case EFI_IFR_ORDERED_LIST_OP:
> StringIdArray = HiiValueToOrderedListOptionStringId (HiiStatement,
> &Count);
> if (StringIdArray == NULL) {
> + //
> + // Print prompt string of HII statement for ease of debugging
> + //
> + DumpHiiStatementPrompt (DEBUG_ERROR, HiiHandle, HiiStatement,
> "Can not get string ID array");
> ASSERT (FALSE);
> Status = EFI_DEVICE_ERROR;
> break;
> @@ -1261,13 +1371,24 @@ HiiValueToRedfishValue (
>
> RedfishValue->Value.StringArray = AllocatePool (sizeof (CHAR8 *) * Count);
> if (RedfishValue->Value.StringArray == NULL) {
> + //
> + // Print prompt string of HII statement for ease of debugging
> + //
> + DumpHiiStatementPrompt (DEBUG_ERROR, HiiHandle, HiiStatement,
> "Can not allocate memory");
> ASSERT (FALSE);
> Status = EFI_OUT_OF_RESOURCES;
> break;
> }
>
> for (Index = 0; Index < Count; Index++) {
> - ASSERT (StringIdArray[Index] != 0);
> + if (StringIdArray[Index] == 0) {
> + //
> + // Print prompt string of HII statement for ease of debugging
> + //
> + DumpHiiStatementPrompt (DEBUG_ERROR, HiiHandle, HiiStatement,
> "String ID in array is 0");
> + ASSERT (FALSE);
> + }
> +
> RedfishValue->Value.StringArray[Index] = HiiGetRedfishAsciiString
> (HiiHandle, FullSchema, StringIdArray[Index]);
> ASSERT (RedfishValue->Value.StringArray[Index] != NULL);
> }
> --
> 2.17.1
-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#109976): https://edk2.groups.io/g/devel/message/109976
Mute This Topic: https://groups.io/mt/102136156/1787277
Group Owner: devel+owner@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [importer@patchew.org]
-=-=-=-=-=-=-=-=-=-=-=-
© 2016 - 2026 Red Hat, Inc.