DynamicTablesPkg/TableHelperLib: Enhance error handling

This patch enhances error handling and reporting in the CM ObjectParser.
Specifically:
1. ObjectIDs used as array indexes are checked for being out of bounds,
   and if so an error message is printed before the assert.
2. An error message is printed for unsupported NameSpaceIDs.
3. Adds support for unimplemented parsers by allowing IDs to list a
   NULL parser, resulting in an unimplemented message being printed.

Signed-off-by: Jeshua Smith <jeshuas@nvidia.com>
Reviewed-by: Pierre Gondois <pierre.gondois@arm.com>
Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>
This commit is contained in:
Jeshua Smith 2023-10-06 16:28:07 +00:00 committed by mergify[bot]
parent 575bd4f55c
commit ec7f734366
1 changed files with 33 additions and 14 deletions

View File

@ -795,6 +795,7 @@ STATIC CONST CM_OBJ_PARSER_ARRAY StdNamespaceObjectParser[] = {
ARRAY_SIZE (StdObjAcpiTableInfoParser) }, ARRAY_SIZE (StdObjAcpiTableInfoParser) },
{ "EStdObjSmbiosTableList", StdObjSmbiosTableInfoParser, { "EStdObjSmbiosTableList", StdObjSmbiosTableInfoParser,
ARRAY_SIZE (StdObjSmbiosTableInfoParser) }, ARRAY_SIZE (StdObjSmbiosTableInfoParser) },
{ "EStdObjMax", NULL, 0}
}; };
/** Print string data. /** Print string data.
@ -1066,6 +1067,12 @@ ParseCmObjDesc (
return; return;
} }
if (ObjId >= ARRAY_SIZE (StdNamespaceObjectParser)) {
DEBUG ((DEBUG_ERROR, "ObjId 0x%x is missing from the StdNamespaceObjectParser array\n", ObjId));
ASSERT (0);
return;
}
ParserArray = &StdNamespaceObjectParser[ObjId]; ParserArray = &StdNamespaceObjectParser[ObjId];
break; break;
case EObjNameSpaceArm: case EObjNameSpaceArm:
@ -1074,10 +1081,17 @@ ParseCmObjDesc (
return; return;
} }
if (ObjId >= ARRAY_SIZE (ArmNamespaceObjectParser)) {
DEBUG ((DEBUG_ERROR, "ObjId 0x%x is missing from the ArmNamespaceObjectParser array\n", ObjId));
ASSERT (0);
return;
}
ParserArray = &ArmNamespaceObjectParser[ObjId]; ParserArray = &ArmNamespaceObjectParser[ObjId];
break; break;
default: default:
// Not supported // Not supported
DEBUG ((DEBUG_ERROR, "NameSpaceId 0x%x, ObjId 0x%x is not supported by the parser\n", NameSpaceId, ObjId));
ASSERT (0); ASSERT (0);
return; return;
} // switch } // switch
@ -1095,6 +1109,10 @@ ParseCmObjDesc (
ObjIndex + 1, ObjIndex + 1,
ObjectCount ObjectCount
)); ));
if (ParserArray->Parser == NULL) {
DEBUG ((DEBUG_ERROR, "Parser not implemented\n"));
RemainingSize = 0;
} else {
PrintCmObjDesc ( PrintCmObjDesc (
(VOID *)((UINTN)CmObjDesc->Data + Offset), (VOID *)((UINTN)CmObjDesc->Data + Offset),
ParserArray->Parser, ParserArray->Parser,
@ -1110,6 +1128,7 @@ ParseCmObjDesc (
} }
Offset = CmObjDesc->Size - RemainingSize; Offset = CmObjDesc->Size - RemainingSize;
}
} // for } // for
ASSERT (RemainingSize == 0); ASSERT (RemainingSize == 0);