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

/** @file\r
  Architecture Independent Base Memory Library Implementation.\r
\r
  The following BaseMemoryLib instances contain the same copy of this file:\r
    BaseMemoryLib\r
    PeiMemoryLib\r
    UefiMemoryLib\r
\r
  Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "MemLibInternals.h"\r
\r
/**\r
  Fills a target buffer with a 16-bit value, and returns the target buffer.\r
\r
  @param  Buffer  The pointer to the target buffer to fill.\r
  @param  Length  The count of 16-bit value to fill.\r
  @param  Value   The value with which to fill Length bytes of Buffer.\r
\r
  @return Buffer\r
\r
**/\r
VOID *\r
EFIAPI\r
InternalMemSetMem16 (\r
  OUT     VOID                      *Buffer,\r
  IN      UINTN                     Length,\r
  IN      UINT16                    Value\r
  )\r
{\r
  for (; Length != 0; Length--) {\r
    ((UINT16*)Buffer)[Length - 1] = Value;\r
  }\r
  return Buffer;\r
}\r
\r
/**\r
  Fills a target buffer with a 32-bit value, and returns the target buffer.\r
\r
  @param  Buffer  The pointer to the target buffer to fill.\r
  @param  Length  The count of 32-bit value to fill.\r
  @param  Value   The value with which to fill Length bytes of Buffer.\r
\r
  @return Buffer\r
\r
**/\r
VOID *\r
EFIAPI\r
InternalMemSetMem32 (\r
  OUT     VOID                      *Buffer,\r
  IN      UINTN                     Length,\r
  IN      UINT32                    Value\r
  )\r
{\r
  for (; Length != 0; Length--) {\r
    ((UINT32*)Buffer)[Length - 1] = Value;\r
  }\r
  return Buffer;\r
}\r
\r
/**\r
  Fills a target buffer with a 64-bit value, and returns the target buffer.\r
\r
  @param  Buffer  The pointer to the target buffer to fill.\r
  @param  Length  The count of 64-bit value to fill.\r
  @param  Value   The value with which to fill Length bytes of Buffer.\r
\r
  @return Buffer\r
\r
**/\r
VOID *\r
EFIAPI\r
InternalMemSetMem64 (\r
  OUT     VOID                      *Buffer,\r
  IN      UINTN                     Length,\r
  IN      UINT64                    Value\r
  )\r
{\r
  for (; Length != 0; Length--) {\r
    ((UINT64*)Buffer)[Length - 1] = Value;\r
  }\r
  return Buffer;\r
}\r
\r
/**\r
  Set Buffer to 0 for Size bytes.\r
\r
  @param  Buffer Memory to set.\r
  @param  Length The number of bytes to set\r
\r
  @return Buffer\r
\r
**/\r
VOID *\r
EFIAPI\r
InternalMemZeroMem (\r
  OUT     VOID                      *Buffer,\r
  IN      UINTN                     Length\r
  )\r
{\r
  return InternalMemSetMem (Buffer, Length, 0);\r
}\r
\r
/**\r
  Compares two memory buffers of a given length.\r
\r
  @param  DestinationBuffer The first memory buffer\r
  @param  SourceBuffer      The second memory buffer\r
  @param  Length            The length of DestinationBuffer and SourceBuffer memory\r
                            regions to compare. Must be non-zero.\r
\r
  @return 0                 All Length bytes of the two buffers are identical.\r
  @retval Non-zero          The first mismatched byte in SourceBuffer subtracted from the first\r
                            mismatched byte in DestinationBuffer.\r
\r
**/\r
INTN\r
EFIAPI\r
InternalMemCompareMem (\r
  IN      CONST VOID                *DestinationBuffer,\r
  IN      CONST VOID                *SourceBuffer,\r
  IN      UINTN                     Length\r
  )\r
{\r
  while ((--Length != 0) &&\r
         (*(INT8*)DestinationBuffer == *(INT8*)SourceBuffer)) {\r
    DestinationBuffer = (INT8*)DestinationBuffer + 1;\r
    SourceBuffer = (INT8*)SourceBuffer + 1;\r
  }\r
  return (INTN)*(UINT8*)DestinationBuffer - (INTN)*(UINT8*)SourceBuffer;\r
}\r
\r
/**\r
  Scans a target buffer for an 8-bit value, and returns a pointer to the\r
  matching 8-bit value in the target buffer.\r
\r
  @param  Buffer  The pointer to the target buffer to scan.\r
  @param  Length  The count of 8-bit value to scan. Must be non-zero.\r
  @param  Value   The value to search for in the target buffer.\r
\r
  @return The pointer to the first occurrence or NULL if not found.\r
\r
**/\r
CONST VOID *\r
EFIAPI\r
InternalMemScanMem8 (\r
  IN      CONST VOID                *Buffer,\r
  IN      UINTN                     Length,\r
  IN      UINT8                     Value\r
  )\r
{\r
  CONST UINT8                       *Pointer;\r
\r
  Pointer = (CONST UINT8*)Buffer;\r
  do {\r
    if (*(Pointer++) == Value) {\r
      return --Pointer;\r
    }\r
  } while (--Length != 0);\r
  return NULL;\r
}\r
\r
/**\r
  Scans a target buffer for a 16-bit value, and returns a pointer to the\r
  matching 16-bit value in the target buffer.\r
\r
  @param  Buffer  The pointer to the target buffer to scan.\r
  @param  Length  The count of 16-bit value to scan. Must be non-zero.\r
  @param  Value   The value to search for in the target buffer.\r
\r
  @return The pointer to the first occurrence or NULL if not found.\r
\r
**/\r
CONST VOID *\r
EFIAPI\r
InternalMemScanMem16 (\r
  IN      CONST VOID                *Buffer,\r
  IN      UINTN                     Length,\r
  IN      UINT16                    Value\r
  )\r
{\r
  CONST UINT16                      *Pointer;\r
\r
  Pointer = (CONST UINT16*)Buffer;\r
  do {\r
    if (*(Pointer++) == Value) {\r
      return --Pointer;\r
    }\r
  } while (--Length != 0);\r
  return NULL;\r
}\r
\r
/**\r
  Scans a target buffer for a 32-bit value, and returns a pointer to the\r
  matching 32-bit value in the target buffer.\r
\r
  @param  Buffer  The pointer to the target buffer to scan.\r
  @param  Length  The count of 32-bit value to scan. Must be non-zero.\r
  @param  Value   The value to search for in the target buffer.\r
\r
  @return The pointer to the first occurrence or NULL if not found.\r
\r
**/\r
CONST VOID *\r
EFIAPI\r
InternalMemScanMem32 (\r
  IN      CONST VOID                *Buffer,\r
  IN      UINTN                     Length,\r
  IN      UINT32                    Value\r
  )\r
{\r
  CONST UINT32                      *Pointer;\r
\r
  Pointer = (CONST UINT32*)Buffer;\r
  do {\r
    if (*(Pointer++) == Value) {\r
      return --Pointer;\r
    }\r
  } while (--Length != 0);\r
  return NULL;\r
}\r
\r
/**\r
  Scans a target buffer for a 64-bit value, and returns a pointer to the\r
  matching 64-bit value in the target buffer.\r
\r
  @param  Buffer  The pointer to the target buffer to scan.\r
  @param  Length  The count of 64-bit value to scan. Must be non-zero.\r
  @param  Value   The value to search for in the target buffer.\r
\r
  @return The pointer to the first occurrence or NULL if not found.\r
\r
**/\r
CONST VOID *\r
EFIAPI\r
InternalMemScanMem64 (\r
  IN      CONST VOID                *Buffer,\r
  IN      UINTN                     Length,\r
  IN      UINT64                    Value\r
  )\r
{\r
  CONST UINT64                      *Pointer;\r
\r
  Pointer = (CONST UINT64*)Buffer;\r
  do {\r
    if (*(Pointer++) == Value) {\r
      return --Pointer;\r
    }\r
  } while (--Length != 0);\r
  return NULL;\r
}\r
\r
/**\r
  Checks whether the contents of a buffer are all zeros.\r
\r
  @param  Buffer  The pointer to the buffer to be checked.\r
  @param  Length  The size of the buffer (in bytes) to be checked.\r
\r
  @retval TRUE    Contents of the buffer are all zeros.\r
  @retval FALSE   Contents of the buffer are not all zeros.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
InternalMemIsZeroBuffer (\r
  IN CONST VOID  *Buffer,\r
  IN UINTN       Length\r
  )\r
{\r
  CONST UINT8 *BufferData;\r
  UINTN       Index;\r
\r
  BufferData = Buffer;\r
  for (Index = 0; Index < Length; Index++) {\r
    if (BufferData[Index] != 0) {\r
      return FALSE;\r
    }\r
  }\r
  return TRUE;\r
}\r
Commit	Line	Data
dd51a993	1	/** @file\r
	2	Architecture Independent Base Memory Library Implementation.\r
	3	\r
1fef058f	4	The following BaseMemoryLib instances contain the same copy of this file:\r
	5	BaseMemoryLib\r
	6	PeiMemoryLib\r
	7	UefiMemoryLib\r
	8	\r
1944b02b	9	Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
9344f092	10	SPDX-License-Identifier: BSD-2-Clause-Patent\r
dd51a993	11	\r
dd51a993	12	**/\r
	13	\r
	14	#include "MemLibInternals.h"\r
	15	\r
	16	/**\r
	17	Fills a target buffer with a 16-bit value, and returns the target buffer.\r
	18	\r
2fc59a00	19	@param Buffer The pointer to the target buffer to fill.\r
	20	@param Length The count of 16-bit value to fill.\r
	21	@param Value The value with which to fill Length bytes of Buffer.\r
dd51a993	22	\r
	23	@return Buffer\r
	24	\r
	25	**/\r
	26	VOID *\r
	27	EFIAPI\r
	28	InternalMemSetMem16 (\r
	29	OUT VOID *Buffer,\r
	30	IN UINTN Length,\r
	31	IN UINT16 Value\r
	32	)\r
	33	{\r
9088c61e HW	34	for (; Length != 0; Length--) {\r
	35	((UINT16*)Buffer)[Length - 1] = Value;\r
	36	}\r
dd51a993	37	return Buffer;\r
	38	}\r
	39	\r
	40	/**\r
	41	Fills a target buffer with a 32-bit value, and returns the target buffer.\r
	42	\r
2fc59a00	43	@param Buffer The pointer to the target buffer to fill.\r
	44	@param Length The count of 32-bit value to fill.\r
	45	@param Value The value with which to fill Length bytes of Buffer.\r
dd51a993	46	\r
	47	@return Buffer\r
	48	\r
	49	**/\r
	50	VOID *\r
	51	EFIAPI\r
	52	InternalMemSetMem32 (\r
	53	OUT VOID *Buffer,\r
	54	IN UINTN Length,\r
	55	IN UINT32 Value\r
	56	)\r
	57	{\r
9088c61e HW	58	for (; Length != 0; Length--) {\r
	59	((UINT32*)Buffer)[Length - 1] = Value;\r
	60	}\r
dd51a993	61	return Buffer;\r
	62	}\r
	63	\r
	64	/**\r
	65	Fills a target buffer with a 64-bit value, and returns the target buffer.\r
	66	\r
2fc59a00	67	@param Buffer The pointer to the target buffer to fill.\r
	68	@param Length The count of 64-bit value to fill.\r
	69	@param Value The value with which to fill Length bytes of Buffer.\r
dd51a993	70	\r
	71	@return Buffer\r
	72	\r
	73	**/\r
	74	VOID *\r
	75	EFIAPI\r
	76	InternalMemSetMem64 (\r
	77	OUT VOID *Buffer,\r
	78	IN UINTN Length,\r
	79	IN UINT64 Value\r
	80	)\r
	81	{\r
9088c61e HW	82	for (; Length != 0; Length--) {\r
	83	((UINT64*)Buffer)[Length - 1] = Value;\r
	84	}\r
dd51a993	85	return Buffer;\r
	86	}\r
	87	\r
	88	/**\r
	89	Set Buffer to 0 for Size bytes.\r
	90	\r
	91	@param Buffer Memory to set.\r
2fc59a00	92	@param Length The number of bytes to set\r
dd51a993	93	\r
	94	@return Buffer\r
	95	\r
	96	**/\r
	97	VOID *\r
	98	EFIAPI\r
	99	InternalMemZeroMem (\r
	100	OUT VOID *Buffer,\r
	101	IN UINTN Length\r
	102	)\r
	103	{\r
	104	return InternalMemSetMem (Buffer, Length, 0);\r
	105	}\r
	106	\r
	107	/**\r
	108	Compares two memory buffers of a given length.\r
	109	\r
58380e9c	110	@param DestinationBuffer The first memory buffer\r
	111	@param SourceBuffer The second memory buffer\r
	112	@param Length The length of DestinationBuffer and SourceBuffer memory\r
dd51a993	113	regions to compare. Must be non-zero.\r
dd51a993	114	\r
d531bfee	115	@return 0 All Length bytes of the two buffers are identical.\r
	116	@retval Non-zero The first mismatched byte in SourceBuffer subtracted from the first\r
	117	mismatched byte in DestinationBuffer.\r
dd51a993	118	\r
	119	**/\r
	120	INTN\r
	121	EFIAPI\r
	122	InternalMemCompareMem (\r
	123	IN CONST VOID *DestinationBuffer,\r
	124	IN CONST VOID *SourceBuffer,\r
	125	IN UINTN Length\r
	126	)\r
	127	{\r
	128	while ((--Length != 0) &&\r
	129	((INT8)DestinationBuffer == (INT8)SourceBuffer)) {\r
	130	DestinationBuffer = (INT8*)DestinationBuffer + 1;\r
	131	SourceBuffer = (INT8*)SourceBuffer + 1;\r
	132	}\r
	133	return (INTN)(UINT8)DestinationBuffer - (INTN)(UINT8)SourceBuffer;\r
	134	}\r
	135	\r
	136	/**\r
	137	Scans a target buffer for an 8-bit value, and returns a pointer to the\r
	138	matching 8-bit value in the target buffer.\r
	139	\r
2fc59a00	140	@param Buffer The pointer to the target buffer to scan.\r
	141	@param Length The count of 8-bit value to scan. Must be non-zero.\r
	142	@param Value The value to search for in the target buffer.\r
dd51a993	143	\r
2fc59a00	144	@return The pointer to the first occurrence or NULL if not found.\r
dd51a993	145	\r
	146	**/\r
	147	CONST VOID *\r
	148	EFIAPI\r
	149	InternalMemScanMem8 (\r
	150	IN CONST VOID *Buffer,\r
	151	IN UINTN Length,\r
	152	IN UINT8 Value\r
	153	)\r
	154	{\r
	155	CONST UINT8 *Pointer;\r
	156	\r
	157	Pointer = (CONST UINT8*)Buffer;\r
	158	do {\r
	159	if (*(Pointer++) == Value) {\r
00dbccf2	160	return --Pointer;\r
dd51a993	161	}\r
	162	} while (--Length != 0);\r
	163	return NULL;\r
	164	}\r
	165	\r
	166	/**\r
	167	Scans a target buffer for a 16-bit value, and returns a pointer to the\r
	168	matching 16-bit value in the target buffer.\r
	169	\r
2fc59a00	170	@param Buffer The pointer to the target buffer to scan.\r
	171	@param Length The count of 16-bit value to scan. Must be non-zero.\r
	172	@param Value The value to search for in the target buffer.\r
dd51a993	173	\r
2fc59a00	174	@return The pointer to the first occurrence or NULL if not found.\r
dd51a993	175	\r
	176	**/\r
	177	CONST VOID *\r
	178	EFIAPI\r
	179	InternalMemScanMem16 (\r
	180	IN CONST VOID *Buffer,\r
	181	IN UINTN Length,\r
	182	IN UINT16 Value\r
	183	)\r
	184	{\r
	185	CONST UINT16 *Pointer;\r
	186	\r
	187	Pointer = (CONST UINT16*)Buffer;\r
	188	do {\r
	189	if (*(Pointer++) == Value) {\r
00dbccf2	190	return --Pointer;\r
dd51a993	191	}\r
	192	} while (--Length != 0);\r
	193	return NULL;\r
	194	}\r
	195	\r
	196	/**\r
	197	Scans a target buffer for a 32-bit value, and returns a pointer to the\r
	198	matching 32-bit value in the target buffer.\r
	199	\r
2fc59a00	200	@param Buffer The pointer to the target buffer to scan.\r
	201	@param Length The count of 32-bit value to scan. Must be non-zero.\r
	202	@param Value The value to search for in the target buffer.\r
dd51a993	203	\r
2fc59a00	204	@return The pointer to the first occurrence or NULL if not found.\r
dd51a993	205	\r
	206	**/\r
	207	CONST VOID *\r
	208	EFIAPI\r
	209	InternalMemScanMem32 (\r
	210	IN CONST VOID *Buffer,\r
	211	IN UINTN Length,\r
	212	IN UINT32 Value\r
	213	)\r
	214	{\r
	215	CONST UINT32 *Pointer;\r
	216	\r
	217	Pointer = (CONST UINT32*)Buffer;\r
	218	do {\r
	219	if (*(Pointer++) == Value) {\r
00dbccf2	220	return --Pointer;\r
dd51a993	221	}\r
	222	} while (--Length != 0);\r
	223	return NULL;\r
	224	}\r
	225	\r
	226	/**\r
	227	Scans a target buffer for a 64-bit value, and returns a pointer to the\r
	228	matching 64-bit value in the target buffer.\r
	229	\r
2fc59a00	230	@param Buffer The pointer to the target buffer to scan.\r
	231	@param Length The count of 64-bit value to scan. Must be non-zero.\r
	232	@param Value The value to search for in the target buffer.\r
dd51a993	233	\r
2fc59a00	234	@return The pointer to the first occurrence or NULL if not found.\r
dd51a993	235	\r
	236	**/\r
	237	CONST VOID *\r
	238	EFIAPI\r
	239	InternalMemScanMem64 (\r
	240	IN CONST VOID *Buffer,\r
	241	IN UINTN Length,\r
	242	IN UINT64 Value\r
	243	)\r
	244	{\r
	245	CONST UINT64 *Pointer;\r
	246	\r
	247	Pointer = (CONST UINT64*)Buffer;\r
	248	do {\r
	249	if (*(Pointer++) == Value) {\r
00dbccf2	250	return --Pointer;\r
dd51a993	251	}\r
	252	} while (--Length != 0);\r
	253	return NULL;\r
	254	}\r
1944b02b HW	255	\r
	256	/**\r
	257	Checks whether the contents of a buffer are all zeros.\r
	258	\r
	259	@param Buffer The pointer to the buffer to be checked.\r
	260	@param Length The size of the buffer (in bytes) to be checked.\r
	261	\r
	262	@retval TRUE Contents of the buffer are all zeros.\r
	263	@retval FALSE Contents of the buffer are not all zeros.\r
	264	\r
	265	**/\r
	266	BOOLEAN\r
	267	EFIAPI\r
	268	InternalMemIsZeroBuffer (\r
	269	IN CONST VOID *Buffer,\r
	270	IN UINTN Length\r
	271	)\r
	272	{\r
	273	CONST UINT8 *BufferData;\r
	274	UINTN Index;\r
	275	\r
	276	BufferData = Buffer;\r
	277	for (Index = 0; Index < Length; Index++) {\r
	278	if (BufferData[Index] != 0) {\r
	279	return FALSE;\r
	280	}\r
	281	}\r
	282	return TRUE;\r
	283	}\r