License header updated to match correct format.

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

/** @file\r
Common basic Library Functions\r
\r
Copyright (c) 2004 - 2014, Intel Corporation. All rights reserved.<BR>\r
This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
**/\r
\r
#include <stdio.h>\r
#include <string.h>\r
#include <stdlib.h>\r
#include <ctype.h>\r
#ifdef __GNUC__\r
#include <unistd.h>\r
#else\r
#include <direct.h>\r
#endif\r
#include "CommonLib.h"\r
#include "EfiUtilityMsgs.h"\r
\r
VOID\r
PeiZeroMem (\r
  IN VOID   *Buffer,\r
  IN UINTN  Size\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Set Buffer to zero for Size bytes.\r
\r
Arguments:\r
\r
  Buffer  - Memory to set.\r
\r
  Size    - Number of bytes to set\r
\r
Returns:\r
\r
  None\r
\r
--*/\r
{\r
  INT8  *Ptr;\r
\r
  Ptr = Buffer;\r
  while (Size--) {\r
    *(Ptr++) = 0;\r
  }\r
}\r
\r
VOID\r
PeiCopyMem (\r
  IN VOID   *Destination,\r
  IN VOID   *Source,\r
  IN UINTN  Length\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Copy Length bytes from Source to Destination.\r
\r
Arguments:\r
\r
  Destination - Target of copy\r
\r
  Source      - Place to copy from\r
\r
  Length      - Number of bytes to copy\r
\r
Returns:\r
\r
  None\r
\r
--*/\r
{\r
  CHAR8 *Destination8;\r
  CHAR8 *Source8;\r
\r
  Destination8  = Destination;\r
  Source8       = Source;\r
  while (Length--) {\r
    *(Destination8++) = *(Source8++);\r
  }\r
}\r
\r
VOID\r
ZeroMem (\r
  IN VOID   *Buffer,\r
  IN UINTN  Size\r
  )\r
{\r
  PeiZeroMem (Buffer, Size);\r
}\r
\r
VOID\r
CopyMem (\r
  IN VOID   *Destination,\r
  IN VOID   *Source,\r
  IN UINTN  Length\r
  )\r
{\r
  PeiCopyMem (Destination, Source, Length);\r
}\r
\r
INTN\r
CompareGuid (\r
  IN EFI_GUID     *Guid1,\r
  IN EFI_GUID     *Guid2\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Compares to GUIDs\r
\r
Arguments:\r
\r
  Guid1 - guid to compare\r
  Guid2 - guid to compare\r
\r
Returns:\r
  =  0  if Guid1 == Guid2\r
  != 0  if Guid1 != Guid2 \r
\r
--*/\r
{\r
  INT32 *g1;\r
  INT32 *g2;\r
  INT32 r;\r
\r
  //\r
  // Compare 32 bits at a time\r
  //\r
  g1  = (INT32 *) Guid1;\r
  g2  = (INT32 *) Guid2;\r
\r
  r   = g1[0] - g2[0];\r
  r |= g1[1] - g2[1];\r
  r |= g1[2] - g2[2];\r
  r |= g1[3] - g2[3];\r
\r
  return r;\r
}\r
\r
\r
EFI_STATUS\r
GetFileImage (\r
  IN CHAR8    *InputFileName,\r
  OUT CHAR8   **InputFileImage,\r
  OUT UINT32  *BytesRead\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This function opens a file and reads it into a memory buffer.  The function \r
  will allocate the memory buffer and returns the size of the buffer.\r
\r
Arguments:\r
\r
  InputFileName     The name of the file to read.\r
  InputFileImage    A pointer to the memory buffer.\r
  BytesRead         The size of the memory buffer.\r
\r
Returns:\r
\r
  EFI_SUCCESS              The function completed successfully.\r
  EFI_INVALID_PARAMETER    One of the input parameters was invalid.\r
  EFI_ABORTED              An error occurred.\r
  EFI_OUT_OF_RESOURCES     No resource to complete operations.\r
\r
--*/\r
{\r
  FILE    *InputFile;\r
  UINT32  FileSize;\r
\r
  //\r
  // Verify input parameters.\r
  //\r
  if (InputFileName == NULL || strlen (InputFileName) == 0 || InputFileImage == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  //\r
  // Open the file and copy contents into a memory buffer.\r
  //\r
  //\r
  // Open the file\r
  //\r
  InputFile = fopen (LongFilePath (InputFileName), "rb");\r
  if (InputFile == NULL) {\r
    Error (NULL, 0, 0001, "Error opening the input file", InputFileName);\r
    return EFI_ABORTED;\r
  }\r
  //\r
  // Go to the end so that we can determine the file size\r
  //\r
  if (fseek (InputFile, 0, SEEK_END)) {\r
    Error (NULL, 0, 0004, "Error reading the input file", InputFileName);\r
    fclose (InputFile);\r
    return EFI_ABORTED;\r
  }\r
  //\r
  // Get the file size\r
  //\r
  FileSize = ftell (InputFile);\r
  if (FileSize == -1) {\r
    Error (NULL, 0, 0003, "Error parsing the input file", InputFileName);\r
    fclose (InputFile);\r
    return EFI_ABORTED;\r
  }\r
  //\r
  // Allocate a buffer\r
  //\r
  *InputFileImage = malloc (FileSize);\r
  if (*InputFileImage == NULL) {\r
    fclose (InputFile);\r
    return EFI_OUT_OF_RESOURCES;\r
  }\r
  //\r
  // Reset to the beginning of the file\r
  //\r
  if (fseek (InputFile, 0, SEEK_SET)) {\r
    Error (NULL, 0, 0004, "Error reading the input file", InputFileName);\r
    fclose (InputFile);\r
    free (*InputFileImage);\r
    *InputFileImage = NULL;\r
    return EFI_ABORTED;\r
  }\r
  //\r
  // Read all of the file contents.\r
  //\r
  *BytesRead = fread (*InputFileImage, sizeof (UINT8), FileSize, InputFile);\r
  if (*BytesRead != sizeof (UINT8) * FileSize) {\r
    Error (NULL, 0, 0004, "Error reading the input file", InputFileName);\r
    fclose (InputFile);\r
    free (*InputFileImage);\r
    *InputFileImage = NULL;\r
    return EFI_ABORTED;\r
  }\r
  //\r
  // Close the file\r
  //\r
  fclose (InputFile);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
PutFileImage (\r
  IN CHAR8    *OutputFileName,\r
  IN CHAR8    *OutputFileImage,\r
  IN UINT32   BytesToWrite\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This function opens a file and writes OutputFileImage into the file.\r
\r
Arguments:\r
\r
  OutputFileName     The name of the file to write.\r
  OutputFileImage    A pointer to the memory buffer.\r
  BytesToWrite       The size of the memory buffer.\r
\r
Returns:\r
\r
  EFI_SUCCESS              The function completed successfully.\r
  EFI_INVALID_PARAMETER    One of the input parameters was invalid.\r
  EFI_ABORTED              An error occurred.\r
  EFI_OUT_OF_RESOURCES     No resource to complete operations.\r
\r
--*/\r
{\r
  FILE    *OutputFile;\r
  UINT32  BytesWrote;\r
\r
  //\r
  // Verify input parameters.\r
  //\r
  if (OutputFileName == NULL || strlen (OutputFileName) == 0 || OutputFileImage == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
  //\r
  // Open the file and copy contents into a memory buffer.\r
  //\r
  //\r
  // Open the file\r
  //\r
  OutputFile = fopen (LongFilePath (OutputFileName), "wb");\r
  if (OutputFile == NULL) {\r
    Error (NULL, 0, 0001, "Error opening the output file", OutputFileName);\r
    return EFI_ABORTED;\r
  }\r
\r
  //\r
  // Write all of the file contents.\r
  //\r
  BytesWrote = fwrite (OutputFileImage, sizeof (UINT8), BytesToWrite, OutputFile);\r
  if (BytesWrote != sizeof (UINT8) * BytesToWrite) {\r
    Error (NULL, 0, 0002, "Error writing the output file", OutputFileName);\r
    fclose (OutputFile);\r
    return EFI_ABORTED;\r
  }\r
  //\r
  // Close the file\r
  //\r
  fclose (OutputFile);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
UINT8\r
CalculateChecksum8 (\r
  IN UINT8        *Buffer,\r
  IN UINTN        Size\r
  )\r
/*++\r
  \r
Routine Description:\r
\r
  This function calculates the value needed for a valid UINT8 checksum\r
\r
Arguments:\r
\r
  Buffer      Pointer to buffer containing byte data of component.\r
  Size        Size of the buffer\r
\r
Returns:\r
\r
  The 8 bit checksum value needed.\r
\r
--*/\r
{\r
  return (UINT8) (0x100 - CalculateSum8 (Buffer, Size));\r
}\r
\r
UINT8\r
CalculateSum8 (\r
  IN UINT8  *Buffer,\r
  IN UINTN  Size\r
  )\r
/*++\r
  \r
Routine Description::\r
\r
  This function calculates the UINT8 sum for the requested region.\r
\r
Arguments:\r
\r
  Buffer      Pointer to buffer containing byte data of component.\r
  Size        Size of the buffer\r
\r
Returns:\r
\r
  The 8 bit checksum value needed.\r
\r
--*/\r
{\r
  UINTN Index;\r
  UINT8 Sum;\r
\r
  Sum = 0;\r
\r
  //\r
  // Perform the byte sum for buffer\r
  //\r
  for (Index = 0; Index < Size; Index++) {\r
    Sum = (UINT8) (Sum + Buffer[Index]);\r
  }\r
\r
  return Sum;\r
}\r
\r
UINT16\r
CalculateChecksum16 (\r
  IN UINT16       *Buffer,\r
  IN UINTN        Size\r
  )\r
/*++\r
  \r
Routine Description::\r
\r
  This function calculates the value needed for a valid UINT16 checksum\r
\r
Arguments:\r
\r
  Buffer      Pointer to buffer containing byte data of component.\r
  Size        Size of the buffer\r
\r
Returns:\r
\r
  The 16 bit checksum value needed.\r
\r
--*/\r
{\r
  return (UINT16) (0x10000 - CalculateSum16 (Buffer, Size));\r
}\r
\r
UINT16\r
CalculateSum16 (\r
  IN UINT16       *Buffer,\r
  IN UINTN        Size\r
  )\r
/*++\r
  \r
Routine Description:\r
\r
  This function calculates the UINT16 sum for the requested region.\r
\r
Arguments:\r
\r
  Buffer      Pointer to buffer containing byte data of component.\r
  Size        Size of the buffer\r
\r
Returns:\r
\r
  The 16 bit checksum\r
\r
--*/\r
{\r
  UINTN   Index;\r
  UINT16  Sum;\r
\r
  Sum = 0;\r
\r
  //\r
  // Perform the word sum for buffer\r
  //\r
  for (Index = 0; Index < Size; Index++) {\r
    Sum = (UINT16) (Sum + Buffer[Index]);\r
  }\r
\r
  return (UINT16) Sum;\r
}\r
\r
EFI_STATUS\r
PrintGuid (\r
  IN EFI_GUID *Guid\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This function prints a GUID to STDOUT.\r
\r
Arguments:\r
\r
  Guid    Pointer to a GUID to print.\r
\r
Returns:\r
\r
  EFI_SUCCESS             The GUID was printed.\r
  EFI_INVALID_PARAMETER   The input was NULL.\r
\r
--*/\r
{\r
  if (Guid == NULL) {\r
    Error (NULL, 0, 2000, "Invalid parameter", "PrintGuidToBuffer() called with a NULL value");\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  printf (\r
    "%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x\n",\r
    (unsigned) Guid->Data1,\r
    Guid->Data2,\r
    Guid->Data3,\r
    Guid->Data4[0],\r
    Guid->Data4[1],\r
    Guid->Data4[2],\r
    Guid->Data4[3],\r
    Guid->Data4[4],\r
    Guid->Data4[5],\r
    Guid->Data4[6],\r
    Guid->Data4[7]\r
    );\r
  return EFI_SUCCESS;\r
}\r
\r
EFI_STATUS\r
PrintGuidToBuffer (\r
  IN EFI_GUID     *Guid,\r
  IN OUT UINT8    *Buffer,\r
  IN UINT32       BufferLen,\r
  IN BOOLEAN      Uppercase\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  This function prints a GUID to a buffer\r
\r
Arguments:\r
\r
  Guid      - Pointer to a GUID to print.\r
  Buffer    - Pointer to a user-provided buffer to print to\r
  BufferLen - Size of the Buffer\r
  Uppercase - If use upper case.\r
\r
Returns:\r
\r
  EFI_SUCCESS             The GUID was printed.\r
  EFI_INVALID_PARAMETER   The input was NULL.\r
  EFI_BUFFER_TOO_SMALL    The input buffer was not big enough\r
  \r
--*/\r
{\r
  if (Guid == NULL) {\r
    Error (NULL, 0, 2000, "Invalid parameter", "PrintGuidToBuffer() called with a NULL value");\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (BufferLen < PRINTED_GUID_BUFFER_SIZE) {\r
    Error (NULL, 0, 2000, "Invalid parameter", "PrintGuidToBuffer() called with invalid buffer size");\r
    return EFI_BUFFER_TOO_SMALL;\r
  }\r
\r
  if (Uppercase) {\r
    sprintf (\r
      (CHAR8 *)Buffer,\r
      "%08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X",\r
      (unsigned) Guid->Data1,\r
      Guid->Data2,\r
      Guid->Data3,\r
      Guid->Data4[0],\r
      Guid->Data4[1],\r
      Guid->Data4[2],\r
      Guid->Data4[3],\r
      Guid->Data4[4],\r
      Guid->Data4[5],\r
      Guid->Data4[6],\r
      Guid->Data4[7]\r
      );\r
  } else {\r
    sprintf (\r
      (CHAR8 *)Buffer,\r
      "%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x",\r
      (unsigned) Guid->Data1,\r
      Guid->Data2,\r
      Guid->Data3,\r
      Guid->Data4[0],\r
      Guid->Data4[1],\r
      Guid->Data4[2],\r
      Guid->Data4[3],\r
      Guid->Data4[4],\r
      Guid->Data4[5],\r
      Guid->Data4[6],\r
      Guid->Data4[7]\r
      );\r
  }\r
\r
  return EFI_SUCCESS;\r
}\r
\r
#ifdef __GNUC__\r
\r
size_t _filelength(int fd)\r
{\r
  struct stat stat_buf;\r
  fstat(fd, &stat_buf);\r
  return stat_buf.st_size;\r
}\r
\r
#ifndef __CYGWIN__\r
char *strlwr(char *s)\r
{\r
  char *p = s;\r
  for(;*s;s++) {\r
    *s = tolower(*s);\r
  }\r
  return p;\r
}\r
#endif\r
#endif\r
\r
#define WINDOWS_EXTENSION_PATH "\\\\?\\"\r
#define WINDOWS_UNC_EXTENSION_PATH "\\\\?\\UNC"\r
\r
//\r
// Global data to store full file path. It is not required to be free. \r
//\r
CHAR8 mCommonLibFullPath[MAX_LONG_FILE_PATH];\r
\r
CHAR8 *\r
LongFilePath (\r
 IN CHAR8 *FileName\r
 )\r
/*++\r
\r
Routine Description:\r
  Convert FileName to the long file path, which can support larger than 260 length. \r
\r
Arguments:\r
  FileName         - FileName. \r
\r
Returns:\r
  LongFilePath      A pointer to the converted long file path.\r
  \r
--*/\r
{\r
#ifdef __GNUC__\r
  //\r
  // __GNUC__ may not be good way to differentiate unix and windows. Need more investigation here. \r
  // unix has no limitation on file path. Just return FileName. \r
  //\r
  return FileName;\r
#else\r
  CHAR8 *RootPath;\r
  CHAR8 *PathPointer;\r
  CHAR8 *NextPointer;\r
  \r
  PathPointer = (CHAR8 *) FileName;\r
  \r
  if (FileName != NULL) {\r
    //\r
    // Add the extension string first to support long file path. \r
    //\r
    mCommonLibFullPath[0] = 0;\r
    strcpy (mCommonLibFullPath, WINDOWS_EXTENSION_PATH);\r
\r
    if (strlen (FileName) > 1 && FileName[0] == '\\' && FileName[1] == '\\') {\r
      //\r
      // network path like \\server\share to \\?\UNC\server\share\r
      //\r
      strcpy (mCommonLibFullPath, WINDOWS_UNC_EXTENSION_PATH);\r
      FileName ++;\r
    } else if (strlen (FileName) < 3 || FileName[1] != ':' || (FileName[2] != '\\' && FileName[2] != '/')) {\r
      //\r
      // Relative file path. Convert it to absolute path. \r
      //\r
      RootPath = getcwd (NULL, 0);\r
      if (RootPath != NULL) {\r
        strcat (mCommonLibFullPath, RootPath);\r
        if (FileName[0] != '\\' && FileName[0] != '/') {\r
          //\r
          // Attach directory separator\r
          //\r
          strcat (mCommonLibFullPath, "\\");\r
        }\r
        free (RootPath);\r
      }\r
    }\r
\r
    //\r
    // Construct the full file path\r
    //\r
    strcat (mCommonLibFullPath, FileName);\r
    \r
    //\r
    // Convert directory separator '/' to '\\'\r
    //\r
    PathPointer = (CHAR8 *) mCommonLibFullPath;\r
    do {\r
      if (*PathPointer == '/') {\r
        *PathPointer = '\\';\r
      }\r
    } while (*PathPointer ++ != '\0');\r
    \r
    //\r
    // Convert "\\.\\" to "\\", because it doesn't work with WINDOWS_EXTENSION_PATH.\r
    //\r
    while ((PathPointer = strstr (mCommonLibFullPath, "\\.\\")) != NULL) {\r
      *PathPointer = '\0';\r
      strcat (mCommonLibFullPath, PathPointer + 2);\r
    }\r
    \r
    //\r
    // Convert "\\..\\" to last directory, because it doesn't work with WINDOWS_EXTENSION_PATH.\r
    //\r
    while ((PathPointer = strstr (mCommonLibFullPath, "\\..\\")) != NULL) {\r
      NextPointer = PathPointer + 3;\r
      do {\r
        PathPointer --;\r
      } while (PathPointer > mCommonLibFullPath && *PathPointer != ':' && *PathPointer != '\\');\r
\r
      if (*PathPointer == '\\') {\r
        //\r
        // Skip one directory\r
        //\r
        *PathPointer = '\0';\r
        strcat (mCommonLibFullPath, NextPointer);\r
      } else {\r
        //\r
        // No directory is found. Just break.\r
        //\r
        break;\r
      }\r
    }\r
    \r
    PathPointer = mCommonLibFullPath;\r
  }\r
  \r
  return PathPointer;\r
#endif\r
}\r