]>
git.proxmox.com Git - mirror_edk2.git/blob - MdePkg/Include/Library/BaseMemoryLib.h
2 Memory-only library functions with no library constructor/destructor
4 Copyright (c) 2006, Intel Corporation
5 All rights reserved. This program and the accompanying materials
6 are licensed and made available under the terms and conditions of the BSD License
7 which accompanies this distribution. The full text of the license may be found at
8 http://opensource.org/licenses/bsd-license.php
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15 #ifndef __BASE_MEMORY_LIB__
16 #define __BASE_MEMORY_LIB__
19 Copies a source buffer to a destination buffer, and returns the destination buffer.
21 This function copies Length bytes from SourceBuffer to DestinationBuffer, and returns
22 DestinationBuffer. The implementation must be reentrant, and it must handle the case
23 where SourceBuffer overlaps DestinationBuffer.
24 If Length is greater than (MAX_ADDRESS - DestinationBuffer + 1), then ASSERT().
25 If Length is greater than (MAX_ADDRESS - SourceBuffer + 1), then ASSERT().
27 @param DestinationBuffer Pointer to the destination buffer of the memory copy.
28 @param SourceBuffer Pointer to the source buffer of the memory copy.
29 @param Length Number of bytes to copy from SourceBuffer to DestinationBuffer.
31 @return DestinationBuffer.
37 OUT VOID
*DestinationBuffer
,
38 IN CONST VOID
*SourceBuffer
,
43 Fills a target buffer with a byte value, and returns the target buffer.
45 This function fills Length bytes of Buffer with Value, and returns Buffer.
46 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
48 @param Buffer Memory to set.
49 @param Length Number of bytes to set.
50 @param Value Value of the set operation.
64 Fills a target buffer with a 16-bit value, and returns the target buffer.
66 This function fills Length bytes of Buffer with the 16-bit value specified by
67 Value, and returns Buffer. Value is repeated every 16-bits in for Length
70 If Length > 0 and Buffer is NULL, then ASSERT().
71 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
72 If Buffer is not aligned on a 16-bit boundary, then ASSERT().
73 If Length is not aligned on a 16-bit boundary, then ASSERT().
75 @param Buffer Pointer to the target buffer to fill.
76 @param Length Number of bytes in Buffer to fill.
77 @param Value Value with which to fill Length bytes of Buffer.
91 Fills a target buffer with a 32-bit value, and returns the target buffer.
93 This function fills Length bytes of Buffer with the 32-bit value specified by
94 Value, and returns Buffer. Value is repeated every 32-bits in for Length
97 If Length > 0 and Buffer is NULL, then ASSERT().
98 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
99 If Buffer is not aligned on a 32-bit boundary, then ASSERT().
100 If Length is not aligned on a 32-bit boundary, then ASSERT().
102 @param Buffer Pointer to the target buffer to fill.
103 @param Length Number of bytes in Buffer to fill.
104 @param Value Value with which to fill Length bytes of Buffer.
118 Fills a target buffer with a 64-bit value, and returns the target buffer.
120 This function fills Length bytes of Buffer with the 64-bit value specified by
121 Value, and returns Buffer. Value is repeated every 64-bits in for Length
124 If Length > 0 and Buffer is NULL, then ASSERT().
125 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
126 If Buffer is not aligned on a 64-bit boundary, then ASSERT().
127 If Length is not aligned on a 64-bit boundary, then ASSERT().
129 @param Buffer Pointer to the target buffer to fill.
130 @param Length Number of bytes in Buffer to fill.
131 @param Value Value with which to fill Length bytes of Buffer.
145 Fills a target buffer with zeros, and returns the target buffer.
147 This function fills Length bytes of Buffer with zeros, and returns Buffer.
148 If Length > 0 and Buffer is NULL, then ASSERT().
149 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
151 @param Buffer Pointer to the target buffer to fill with zeros.
152 @param Length Number of bytes in Buffer to fill with zeros.
165 Compares the contents of two buffers.
167 This function compares Length bytes of SourceBuffer to Length bytes of DestinationBuffer.
168 If all Length bytes of the two buffers are identical, then 0 is returned. Otherwise, the
169 value returned is the first mismatched byte in SourceBuffer subtracted from the first
170 mismatched byte in DestinationBuffer.
171 If Length > 0 and DestinationBuffer is NULL, then ASSERT().
172 If Length > 0 and SourceBuffer is NULL, then ASSERT().
173 If Length is greater than (MAX_ADDRESS - DestinationBuffer + 1), then ASSERT().
174 If Length is greater than (MAX_ADDRESS - SourceBuffer + 1), then ASSERT().
176 @param DestinationBuffer Pointer to the destination buffer to compare.
177 @param SourceBuffer Pointer to the source buffer to compare.
178 @param Length Number of bytes to compare.
180 @return 0 All Length bytes of the two buffers are identical.
181 @retval Non-zero The first mismatched byte in SourceBuffer subtracted from the first
182 mismatched byte in DestinationBuffer.
188 IN CONST VOID
*DestinationBuffer
,
189 IN CONST VOID
*SourceBuffer
,
194 Scans a target buffer for an 8-bit value, and returns a pointer to the matching 8-bit value
195 in the target buffer.
197 This function searches target the buffer specified by Buffer and Length from the lowest
198 address to the highest address for an 8-bit value that matches Value. If a match is found,
199 then a pointer to the matching byte in the target buffer is returned. If no match is found,
200 then NULL is returned. If Length is 0, then NULL is returned.
201 If Length > 0 and Buffer is NULL, then ASSERT().
202 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
204 @param Buffer Pointer to the target buffer to scan.
205 @param Length Number of bytes in Buffer to scan.
206 @param Value Value to search for in the target buffer.
208 @return A pointer to the matching byte in the target buffer or NULL otherwise.
214 IN CONST VOID
*Buffer
,
220 Scans a target buffer for a 16-bit value, and returns a pointer to the matching 16-bit value
221 in the target buffer.
223 This function searches target the buffer specified by Buffer and Length from the lowest
224 address to the highest address for a 16-bit value that matches Value. If a match is found,
225 then a pointer to the matching byte in the target buffer is returned. If no match is found,
226 then NULL is returned. If Length is 0, then NULL is returned.
227 If Length > 0 and Buffer is NULL, then ASSERT().
228 If Buffer is not aligned on a 16-bit boundary, then ASSERT().
229 If Length is not aligned on a 16-bit boundary, then ASSERT().
230 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
232 @param Buffer Pointer to the target buffer to scan.
233 @param Length Number of bytes in Buffer to scan.
234 @param Value Value to search for in the target buffer.
236 @return A pointer to the matching byte in the target buffer or NULL otherwise.
242 IN CONST VOID
*Buffer
,
248 Scans a target buffer for a 32-bit value, and returns a pointer to the matching 32-bit value
249 in the target buffer.
251 This function searches target the buffer specified by Buffer and Length from the lowest
252 address to the highest address for a 32-bit value that matches Value. If a match is found,
253 then a pointer to the matching byte in the target buffer is returned. If no match is found,
254 then NULL is returned. If Length is 0, then NULL is returned.
255 If Length > 0 and Buffer is NULL, then ASSERT().
256 If Buffer is not aligned on a 32-bit boundary, then ASSERT().
257 If Length is not aligned on a 32-bit boundary, then ASSERT().
258 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
260 @param Buffer Pointer to the target buffer to scan.
261 @param Length Number of bytes in Buffer to scan.
262 @param Value Value to search for in the target buffer.
264 @return A pointer to the matching byte in the target buffer or NULL otherwise.
270 IN CONST VOID
*Buffer
,
276 Scans a target buffer for a 64-bit value, and returns a pointer to the matching 64-bit value
277 in the target buffer.
279 This function searches target the buffer specified by Buffer and Length from the lowest
280 address to the highest address for a 64-bit value that matches Value. If a match is found,
281 then a pointer to the matching byte in the target buffer is returned. If no match is found,
282 then NULL is returned. If Length is 0, then NULL is returned.
283 If Length > 0 and Buffer is NULL, then ASSERT().
284 If Buffer is not aligned on a 64-bit boundary, then ASSERT().
285 If Length is not aligned on a 64-bit boundary, then ASSERT().
286 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
288 @param Buffer Pointer to the target buffer to scan.
289 @param Length Number of bytes in Buffer to scan.
290 @param Value Value to search for in the target buffer.
292 @return A pointer to the matching byte in the target buffer or NULL otherwise.
298 IN CONST VOID
*Buffer
,
304 Copies a source GUID to a destination GUID.
306 This function copies the contents of the 128-bit GUID specified by SourceGuid to
307 DestinationGuid, and returns DestinationGuid.
308 If DestinationGuid is NULL, then ASSERT().
309 If SourceGuid is NULL, then ASSERT().
311 @param DestinationGuid Pointer to the destination GUID.
312 @param SourceGuid Pointer to the source GUID.
314 @return DestinationGuid.
320 OUT GUID
*DestinationGuid
,
321 IN CONST GUID
*SourceGuid
327 This function compares Guid1 to Guid2. If the GUIDs are identical then TRUE is returned.
328 If there are any bit differences in the two GUIDs, then FALSE is returned.
329 If Guid1 is NULL, then ASSERT().
330 If Guid2 is NULL, then ASSERT().
332 @param Guid1 A pointer to a 128 bit GUID.
333 @param Guid2 A pointer to a 128 bit GUID.
335 @retval TRUE Guid1 and Guid2 are identical.
336 @retval FALSE Guid1 and Guid2 are not identical.
342 IN CONST GUID
*Guid1
,
347 Scans a target buffer for a GUID, and returns a pointer to the matching GUID
348 in the target buffer.
350 This function searches target the buffer specified by Buffer and Length from
351 the lowest address to the highest address at 128-bit increments for the 128-bit
352 GUID value that matches Guid. If a match is found, then a pointer to the matching
353 GUID in the target buffer is returned. If no match is found, then NULL is returned.
354 If Length is 0, then NULL is returned.
355 If Length > 0 and Buffer is NULL, then ASSERT().
356 If Buffer is not aligned on a 32-bit boundary, then ASSERT().
357 If Length is not aligned on a 128-bit boundary, then ASSERT().
358 If Length is greater than (MAX_ADDRESS - Buffer + 1), then ASSERT().
360 @param Buffer Pointer to the target buffer to scan.
361 @param Length Number of bytes in Buffer to scan.
362 @param Guid Value to search for in the target buffer.
364 @return A pointer to the matching Guid in the target buffer or NULL otherwise.
370 IN CONST VOID
*Buffer
,