OLD | NEW |
---|---|
(Empty) | |
1 /* Copyright (c) 2010 The Chromium OS Authors. All rights reserved. | |
2 * Use of this source code is governed by a BSD-style license that can be | |
3 * found in the LICENSE file. | |
4 */ | |
5 | |
6 /* Helper functions/wrappers for memory allocations, manipulation and | |
7 * comparison. | |
8 */ | |
9 | |
10 #ifndef VBOOT_FIRMWARE_LIB_UTILITY_H_ | |
11 #define VBOOT_FIRMWARE_LIB_UTILITY_H_ | |
12 | |
13 #include <stdint.h> | |
14 #include <string.h> | |
15 | |
16 #include "utility.h" | |
17 | |
18 /* Track remaining data to be read in a buffer. */ | |
19 typedef struct MemcpyState { | |
20 void* remaining_buf; | |
21 uint64_t remaining_len; /* Remaining length of the buffer. */ | |
22 uint8_t overrun; /* Flag set to 1 when an overrun occurs. */ | |
23 } MemcpyState; | |
24 | |
25 /* Copy [len] bytes into [dst] only if there's enough data to read according | |
26 * to [state]. | |
27 * On success, return [dst] and update [state]. | |
28 * On failure, return NULL, set remaining len in state to -1. | |
29 * | |
30 * Useful for iterating through a binary blob to populate a struct. After the | |
31 * first failure (buffer overrun), successive calls will always fail. | |
32 */ | |
33 void* StatefulMemcpy(MemcpyState* state, void* dst, uint64_t len); | |
34 | |
35 /* Like StatefulMemcpy() but copies in the opposite direction, populating | |
36 * data from [src] into the buffer encapsulated in state [state]. | |
37 * On success, return [src] and update [state]. | |
38 * On failure, return NULL, set remaining_len in state to -1. | |
39 * | |
40 * Useful for iterating through a structure to populate a binary blob. After the | |
41 * first failure (buffer overrun), successive calls will always fail. | |
42 */ | |
43 const void* StatefulMemcpy_r(MemcpyState* state, const void* src, uint64_t len); | |
44 | |
45 /* Like StatefulMemcpy_r() but fills a portion of the encapsulated buffer with | |
46 * a constant value. | |
47 * On success, return a meaningless but non-NULL pointer and updates [state]. | |
48 * On failure, return NULL, set remaining_len in state to -1. | |
49 * | |
50 * After the first failure (buffer overrun), successive calls will always fail. | |
51 */ | |
52 const void* StatefulMemset_r(MemcpyState* state, const uint8_t val, | |
53 uint64_t len); | |
54 | |
gauravsh
2010/05/27 19:07:50
extra vertical space
| |
55 | |
56 #endif /* VBOOT_FIRMWARE_LIB_UTILITY_H_ */ | |
OLD | NEW |