ShellPkg: acpiview: SLIT: Validate System Locality count

[mirror_edk2.git] / ShellPkg / Library / UefiShellAcpiViewCommandLib / Parsers / Slit / SlitParser.c

/** @file\r
  SLIT table parser\r
\r
  Copyright (c) 2016 - 2019, ARM Limited. All rights reserved.\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
  @par Reference(s):\r
    - ACPI 6.2 Specification - Errata A, September 2017\r
**/\r
\r
#include <IndustryStandard/Acpi.h>\r
#include <Library/PrintLib.h>\r
#include <Library/UefiLib.h>\r
#include "AcpiParser.h"\r
#include "AcpiTableParser.h"\r
\r
// Local Variables\r
STATIC CONST UINT64* SlitSystemLocalityCount;\r
STATIC ACPI_DESCRIPTION_HEADER_INFO AcpiHdrInfo;\r
\r
/**\r
  An ACPI_PARSER array describing the ACPI SLIT table.\r
**/\r
STATIC CONST ACPI_PARSER SlitParser[] = {\r
  PARSE_ACPI_HEADER (&AcpiHdrInfo),\r
  {L"Number of System Localities", 8, 36, L"0x%lx", NULL,\r
   (VOID**)&SlitSystemLocalityCount, NULL, NULL}\r
};\r
\r
/**\r
  Macro to get the value of a System Locality\r
**/\r
#define SLIT_ELEMENT(Ptr, i, j) *(Ptr + (i * LocalityCount) + j)\r
\r
/**\r
  This function parses the ACPI SLIT table.\r
  When trace is enabled this function parses the SLIT table and\r
  traces the ACPI table fields.\r
\r
  This function also validates System Localities for the following:\r
    - Diagonal elements have a normalized value of 10\r
    - Relative distance from System Locality at i*N+j is same as\r
      j*N+i\r
\r
  @param [in] Trace              If TRUE, trace the ACPI fields.\r
  @param [in] Ptr                Pointer to the start of the buffer.\r
  @param [in] AcpiTableLength    Length of the ACPI table.\r
  @param [in] AcpiTableRevision  Revision of the ACPI table.\r
**/\r
VOID\r
EFIAPI\r
ParseAcpiSlit (\r
  IN BOOLEAN Trace,\r
  IN UINT8*  Ptr,\r
  IN UINT32  AcpiTableLength,\r
  IN UINT8   AcpiTableRevision\r
  )\r
{\r
  UINT32 Offset;\r
  UINT32 Count;\r
  UINT32 Index;\r
  UINT32 LocalityCount;\r
  UINT8* LocalityPtr;\r
  CHAR16 Buffer[80];  // Used for AsciiName param of ParseAcpi\r
\r
  if (!Trace) {\r
    return;\r
  }\r
\r
  Offset = ParseAcpi (\r
             TRUE,\r
             0,\r
             "SLIT",\r
             Ptr,\r
             AcpiTableLength,\r
             PARSER_PARAMS (SlitParser)\r
             );\r
\r
  // Check if the values used to control the parsing logic have been\r
  // successfully read.\r
  if (SlitSystemLocalityCount == NULL) {\r
    IncrementErrorCount ();\r
    Print (\r
      L"ERROR: Insufficient table length. AcpiTableLength = %d.\n",\r
      AcpiTableLength\r
      );\r
    return;\r
  }\r
\r
  /*\r
    Despite the 'Number of System Localities' being a 64-bit field in SLIT,\r
    the maximum number of localities that can be represented in SLIT is limited\r
    by the 'Length' field of the ACPI table.\r
\r
    Since the ACPI table length field is 32-bit wide. The maximum number of\r
    localities that can be represented in SLIT can be calculated as:\r
\r
    MaxLocality = sqrt (MAX_UINT32 - sizeof (EFI_ACPI_6_3_SYSTEM_LOCALITY_DISTANCE_INFORMATION_TABLE_HEADER))\r
                = 65535\r
                = MAX_UINT16\r
  */\r
  if (*SlitSystemLocalityCount > MAX_UINT16) {\r
    IncrementErrorCount ();\r
    Print (\r
      L"ERROR: The Number of System Localities provided can't be represented " \\r
        L"in the SLIT table. SlitSystemLocalityCount = %ld. " \\r
        L"MaxLocalityCountAllowed = %d.\n",\r
      *SlitSystemLocalityCount,\r
      MAX_UINT16\r
      );\r
    return;\r
  }\r
\r
  LocalityCount = (UINT32)*SlitSystemLocalityCount;\r
\r
  // Make sure system localities fit in the table buffer provided\r
  if (Offset + (LocalityCount * LocalityCount) > AcpiTableLength) {\r
    IncrementErrorCount ();\r
    Print (\r
      L"ERROR: Invalid Number of System Localities. " \\r
        L"SlitSystemLocalityCount = %ld. AcpiTableLength = %d.\n",\r
      *SlitSystemLocalityCount,\r
      AcpiTableLength\r
      );\r
    return;\r
  }\r
\r
  LocalityPtr = Ptr + Offset;\r
\r
  // We only print the Localities if the count is less than 16\r
  // If the locality count is more than 16 then refer to the\r
  // raw data dump.\r
  if (LocalityCount < 16) {\r
    UnicodeSPrint (\r
      Buffer,\r
      sizeof (Buffer),\r
      L"Entry[0x%lx][0x%lx]",\r
      LocalityCount,\r
      LocalityCount\r
      );\r
    PrintFieldName (0, Buffer);\r
    Print (L"\n");\r
    Print (L"       ");\r
    for (Index = 0; Index < LocalityCount; Index++) {\r
      Print (L" (%3d) ", Index);\r
    }\r
    Print (L"\n");\r
    for (Count = 0; Count< LocalityCount; Count++) {\r
      Print (L" (%3d) ", Count);\r
      for (Index = 0; Index < LocalityCount; Index++) {\r
        Print (L"  %3d  ", SLIT_ELEMENT (LocalityPtr, Count, Index));\r
      }\r
      Print (L"\n");\r
    }\r
  }\r
\r
  // Validate\r
  for (Count = 0; Count < LocalityCount; Count++) {\r
    for (Index = 0; Index < LocalityCount; Index++) {\r
      // Element[x][x] must be equal to 10\r
      if ((Count == Index) && (SLIT_ELEMENT (LocalityPtr, Count,Index) != 10)) {\r
        IncrementErrorCount ();\r
        Print (\r
          L"ERROR: Diagonal Element[0x%lx][0x%lx] (%3d)."\r
            L" Normalized Value is not 10\n",\r
          Count,\r
          Index,\r
          SLIT_ELEMENT (LocalityPtr, Count, Index)\r
          );\r
      }\r
      // Element[i][j] must be equal to Element[j][i]\r
      if (SLIT_ELEMENT (LocalityPtr, Count, Index) !=\r
          SLIT_ELEMENT (LocalityPtr, Index, Count)) {\r
        IncrementErrorCount ();\r
        Print (\r
          L"ERROR: Relative distances for Element[0x%lx][0x%lx] (%3d) and \n"\r
           L"Element[0x%lx][0x%lx] (%3d) do not match.\n",\r
          Count,\r
          Index,\r
          SLIT_ELEMENT (LocalityPtr, Count, Index),\r
          Index,\r
          Count,\r
          SLIT_ELEMENT (LocalityPtr, Index, Count)\r
          );\r
      }\r
    }\r
  }\r
}\r