BaseMemoryLib: Add missing ASSERT()s for some interfaces.

[mirror_edk2.git] / MdePkg / Library / UefiMemoryLib / MemLibGuid.c

/** @file\r
  Implementation of GUID functions.\r
\r
  Copyright (c) 2006, Intel Corporation<BR>\r
  All rights reserved. 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
  Module Name:  MemLibGuid.c\r
\r
  The following BaseMemoryLib instances share the same version of this file:\r
\r
    BaseMemoryLib\r
    BaseMemoryLibMmx\r
    BaseMemoryLibSse2\r
    BaseMemoryLibRepStr\r
    PeiMemoryLib\r
    UefiMemoryLib\r
\r
**/\r
\r
/**\r
  This function copies a source GUID to a destination GUID.\r
\r
  This function copies the contents of the 128-bit GUID specified by SourceGuid\r
  to DestinationGuid, and returns DestinationGuid.\r
\r
  If DestinationGuid is NULL, then ASSERT().\r
  If SourceGuid is NULL, then ASSERT().\r
\r
  @param  DestinationGuid Pointer to the destination GUID.\r
  @param  SourceGuid Pointer to the source GUID.\r
\r
  @return DestinationGuid\r
\r
**/\r
GUID *\r
EFIAPI\r
CopyGuid (\r
  OUT     GUID                      *DestinationGuid,\r
  IN      CONST GUID                *SourceGuid\r
  )\r
{\r
  WriteUnaligned64 (\r
    (UINT64*)DestinationGuid,\r
    ReadUnaligned64 ((CONST UINT64*)SourceGuid)\r
    );\r
  WriteUnaligned64 (\r
    (UINT64*)DestinationGuid + 1,\r
    ReadUnaligned64 ((CONST UINT64*)SourceGuid + 1)\r
    );\r
  return DestinationGuid;\r
}\r
\r
/**\r
  Compares two GUIDs\r
\r
  This function compares Guid1 to Guid2. If the GUIDs are identical then TRUE\r
  is returned. If there are any bit differences in the two GUIDs, then FALSE is\r
  returned.\r
\r
  If Guid1 is NULL, then ASSERT().\r
  If Guid2 is NULL, then ASSERT().\r
\r
  @param  Guid1 guid to compare\r
  @param  Guid2 guid to compare\r
\r
  @retval TRUE  if Guid1 == Guid2\r
  @retval FALSE if Guid1 != Guid2\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
CompareGuid (\r
  IN      CONST GUID                *Guid1,\r
  IN      CONST GUID                *Guid2\r
  )\r
{\r
  return (BOOLEAN)(\r
           ReadUnaligned64 ((CONST UINT64*)Guid1)\r
             == ReadUnaligned64 ((CONST UINT64*)Guid2) &&\r
           ReadUnaligned64 ((CONST UINT64*)Guid1 + 1)\r
             == ReadUnaligned64 ((CONST UINT64*)Guid2 + 1)\r
           );\r
}\r
\r
/**\r
  Scans a target buffer for a GUID, and returns a pointer to the matching GUID\r
  in the target buffer.\r
\r
  This function searches target the buffer specified by Buffer and Length from\r
  the lowest address to the highest address at 128-bit increments for the\r
  128-bit GUID value that matches Guid. If a match is found, then a pointer to\r
  the matching GUID in the target buffer is returned. If no match is found,\r
  then NULL is returned. If Length is 0, then NULL is returned.\r
\r
  If Buffer is NULL, then ASSERT().\r
  If Buffer is not aligned on a 64-bit boundary, then ASSERT().\r
  If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().\r
\r
  @param  Buffer  Pointer to the target buffer to scan.\r
  @param  Length  Number of bytes in Buffer to scan.\r
  @param  Guid    Value to search for in the target buffer.\r
\r
  @return Pointer to the first occurrence.\r
  @retval NULL  if Length == 0 or Guid was not found.\r
**/\r
VOID *\r
EFIAPI\r
ScanGuid (\r
  IN      CONST VOID                *Buffer,\r
  IN      UINTN                     Length,\r
  IN      CONST GUID                *Guid\r
  )\r
{\r
  CONST GUID                        *GuidPtr;\r
\r
  ASSERT (Buffer != NULL);\r
  //\r
  // Make sure Buffer is aligned on a 64-bit boundary.\r
  //\r
  ASSERT (((UINTN) Buffer & 7) == 0);\r
\r
  ASSERT (Length <= (MAX_ADDRESS - (UINTN)Buffer + 1));\r
\r
  GuidPtr = (GUID*)Buffer;\r
  Buffer = GuidPtr + Length / sizeof (*GuidPtr);\r
  while (GuidPtr < (CONST GUID*)Buffer) {\r
    if (CompareGuid (GuidPtr, Guid)) {\r
      return (VOID*)GuidPtr;\r
    }\r
    GuidPtr++;\r
  }\r
  return NULL;\r
}\r