BaseTools: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / BaseTools / Source / C / Common / ParseGuidedSectionTools.c

/** @file\r
Helper functions for parsing GuidedSectionTools.txt\r
\r
Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include <assert.h>\r
#include <string.h>\r
#include <ctype.h>\r
#include <stdlib.h>\r
#include "MemoryFile.h"\r
#include "CommonLib.h"\r
#include "EfiUtilityMsgs.h"\r
#include "ParseInf.h"\r
#include "ParseGuidedSectionTools.h"\r
#include "StringFuncs.h"\r
\r
\r
//\r
// Local types / structures\r
//\r
\r
typedef struct _GUID_SEC_TOOL_ENTRY {\r
  EFI_GUID   Guid;\r
  CHAR8*     Name;\r
  CHAR8*     Path;\r
  struct _GUID_SEC_TOOL_ENTRY *Next;\r
} GUID_SEC_TOOL_ENTRY;\r
\r
//\r
// Function Implementation\r
//\r
\r
EFI_HANDLE\r
ParseGuidedSectionToolsFile (\r
  IN CHAR8    *InputFile\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This function parses the tools_def.txt file.  It returns a\r
  EFI_HANDLE object which can be used for the other library\r
  functions and should be passed to FreeParsedGuidedSectionToolsHandle\r
  to free resources when the tools_def.txt information is no\r
  longer needed.\r
\r
Arguments:\r
\r
  InputFile     Path name of file to read\r
\r
Returns:\r
\r
  NULL if error parsing\r
  A non-NULL EFI_HANDLE otherwise\r
\r
--*/\r
{\r
  EFI_STATUS Status;\r
  EFI_HANDLE MemoryFile;\r
  EFI_HANDLE ParsedGuidedSectionTools;\r
\r
  Status = GetMemoryFile (InputFile, &MemoryFile);\r
  if (EFI_ERROR (Status)) {\r
    return NULL;\r
  }\r
\r
  ParsedGuidedSectionTools = ParseGuidedSectionToolsMemoryFile (MemoryFile);\r
\r
  FreeMemoryFile (MemoryFile);\r
\r
  return ParsedGuidedSectionTools;\r
}\r
\r
\r
EFI_HANDLE\r
ParseGuidedSectionToolsMemoryFile (\r
  IN EFI_HANDLE    InputFile\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This function parses the tools_def.txt file.  It returns a\r
  EFI_HANDLE object which can be used for the other library\r
  functions and should be passed to FreeParsedGuidedSectionToolsHandle\r
  to free resources when the tools_def.txt information is no\r
  longer needed.\r
\r
Arguments:\r
\r
  InputFile     Memory file image.\r
\r
Returns:\r
\r
  NULL if error or EOF\r
  InputBuffer otherwise\r
\r
--*/\r
{\r
  EFI_STATUS  Status;\r
  CHAR8       *NextLine;\r
  STRING_LIST *Tool;\r
  EFI_GUID    Guid;\r
  GUID_SEC_TOOL_ENTRY *FirstGuidTool;\r
  GUID_SEC_TOOL_ENTRY *LastGuidTool;\r
  GUID_SEC_TOOL_ENTRY *NewGuidTool;\r
\r
  FirstGuidTool = NULL;\r
  LastGuidTool  = NULL;\r
\r
  while (TRUE) {\r
    NextLine = ReadMemoryFileLine (InputFile);\r
    if (NextLine == NULL) {\r
      break;\r
    }\r
\r
    Status = StripInfDscStringInPlace (NextLine);\r
    if (EFI_ERROR (Status)) {\r
      free (NextLine);\r
      break;\r
    }\r
\r
    if (NextLine[0] == '\0') {\r
      free (NextLine);\r
      continue;\r
    }\r
\r
    Tool = SplitStringByWhitespace (NextLine);\r
    if ((Tool != NULL) &&\r
        (Tool->Count == 3)\r
       ) {\r
      Status = StringToGuid (Tool->Strings[0], &Guid);\r
      if (!EFI_ERROR (Status)) {\r
        NewGuidTool = malloc (sizeof (GUID_SEC_TOOL_ENTRY));\r
        if (NewGuidTool != NULL) {\r
          memcpy (&(NewGuidTool->Guid), &Guid, sizeof (Guid));\r
          NewGuidTool->Name = CloneString(Tool->Strings[1]);\r
          NewGuidTool->Path = CloneString(Tool->Strings[2]);\r
          NewGuidTool->Next = NULL;\r
\r
          if (FirstGuidTool == NULL) {\r
            FirstGuidTool = NewGuidTool;\r
          } else {\r
            LastGuidTool->Next = NewGuidTool;\r
          }\r
          LastGuidTool = NewGuidTool;\r
        }\r
      }\r
    }\r
\r
    if (Tool != NULL) {\r
      FreeStringList (Tool);\r
    }\r
    free (NextLine);\r
  }\r
\r
  return FirstGuidTool;\r
}\r
\r
\r
CHAR8*\r
LookupGuidedSectionToolPath (\r
  IN EFI_HANDLE ParsedGuidedSectionToolsHandle,\r
  IN EFI_GUID   *SectionGuid\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This function looks up the appropriate tool to use for extracting\r
  a GUID defined FV section.\r
\r
Arguments:\r
\r
  ParsedGuidedSectionToolsHandle    A parsed GUID section tools handle.\r
  SectionGuid                       The GUID for the section.\r
\r
Returns:\r
\r
  NULL     - if no tool is found or there is another error\r
  Non-NULL - The tool to use to access the section contents.  (The caller\r
             must free the memory associated with this string.)\r
\r
--*/\r
{\r
  GUID_SEC_TOOL_ENTRY *GuidTool;\r
\r
  GuidTool = (GUID_SEC_TOOL_ENTRY*)ParsedGuidedSectionToolsHandle;\r
  if (GuidTool == NULL) {\r
    return NULL;\r
  }\r
\r
  for ( ; GuidTool != NULL; GuidTool = GuidTool->Next) {\r
    if (CompareGuid (&(GuidTool->Guid), SectionGuid) == 0) {\r
      return CloneString (GuidTool->Path);\r
    }\r
  }\r
\r
  return NULL;\r
}\r
\r
\r