1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
|
#ifndef __WILC_MEMORY_H__
#define __WILC_MEMORY_H__
/*!
* @file wilc_memory.h
* @brief Memory OS wrapper functionality
* @author syounan
* @sa wilc_oswrapper.h top level OS wrapper file
* @date 16 Aug 2010
* @version 1.0
*/
#include <linux/types.h>
#include <linux/slab.h>
/*!
* @struct tstrWILC_MemoryAttrs
* @brief Memory API options
* @author syounan
* @date 16 Aug 2010
* @version 1.0
*/
typedef struct {
} tstrWILC_MemoryAttrs;
/*!
* @brief Allocates a given size of bytes
* @param[in] u32Size size of memory in bytes to be allocated
* @param[in] strAttrs Optional attributes, NULL for default
* if not NULL, pAllocationPool should point to the pool to use for
* this allocation. if NULL memory will be allocated directly from
* the system
* @param[in] pcFileName file name of the calling code for debugging
* @param[in] u32LineNo line number of the calling code for debugging
* @return The new allocated block, NULL if allocation fails
* @note It is recommended to use of of the wrapper macros instead of
* calling this function directly
* @sa sttrWILC_MemoryAttrs
* @sa WILC_MALLOC
* @sa WILC_MALLOC_EX
* @sa WILC_NEW
* @sa WILC_NEW_EX
* @author syounan
* @date 16 Aug 2010
* @version 1.0
*/
void *WILC_MemoryAlloc(u32 u32Size, tstrWILC_MemoryAttrs *strAttrs,
char *pcFileName, u32 u32LineNo);
/*!
* @brief Allocates a given size of bytes and zero filling it
* @param[in] u32Size size of memory in bytes to be allocated
* @param[in] strAttrs Optional attributes, NULL for default
* if not NULL, pAllocationPool should point to the pool to use for
* this allocation. if NULL memory will be allocated directly from
* the system
* @param[in] pcFileName file name of the calling code for debugging
* @param[in] u32LineNo line number of the calling code for debugging
* @return The new allocated block, NULL if allocation fails
* @note It is recommended to use of of the wrapper macros instead of
* calling this function directly
* @sa sttrWILC_MemoryAttrs
* @sa WILC_CALLOC
* @sa WILC_CALLOC_EX
* @sa WILC_NEW_0
* @sa WILC_NEW_0_EX
* @author syounan
* @date 16 Aug 2010
* @version 1.0
*/
void *WILC_MemoryCalloc(u32 u32Size, tstrWILC_MemoryAttrs *strAttrs,
char *pcFileName, u32 u32LineNo);
/*!
* @brief Reallocates a given block to a new size
* @param[in] pvOldBlock the old memory block, if NULL then this function
* behaves as a new allocation function
* @param[in] u32NewSize size of the new memory block in bytes, if zero then
* this function behaves as a free function
* @param[in] strAttrs Optional attributes, NULL for default
* if pAllocationPool!=NULL and pvOldBlock==NULL, pAllocationPool
* should point to the pool to use for this allocation.
* if pAllocationPool==NULL and pvOldBlock==NULL memory will be
* allocated directly from the system
* if and pvOldBlock!=NULL, pAllocationPool will not be inspected
* and reallocation is done from the same pool as the original block
* @param[in] pcFileName file name of the calling code for debugging
* @param[in] u32LineNo line number of the calling code for debugging
* @return The new allocated block, possibly same as pvOldBlock
* @note It is recommended to use of of the wrapper macros instead of
* calling this function directly
* @sa sttrWILC_MemoryAttrs
* @sa WILC_REALLOC
* @sa WILC_REALLOC_EX
* @author syounan
* @date 16 Aug 2010
* @version 1.0
*/
void *WILC_MemoryRealloc(void *pvOldBlock, u32 u32NewSize,
tstrWILC_MemoryAttrs *strAttrs, char *pcFileName, u32 u32LineNo);
/*!
* @brief Frees given block
* @param[in] pvBlock the memory block to be freed
* @param[in] strAttrs Optional attributes, NULL for default
* @param[in] pcFileName file name of the calling code for debugging
* @param[in] u32LineNo line number of the calling code for debugging
* @note It is recommended to use of of the wrapper macros instead of
* calling this function directly
* @sa sttrWILC_MemoryAttrs
* @sa WILC_FREE
* @sa WILC_FREE_EX
* @sa WILC_FREE_SET_NULL
* @sa WILC_FREE_IF_TRUE
* @author syounan
* @date 16 Aug 2010
* @version 1.0
*/
void WILC_MemoryFree(const void *pvBlock, tstrWILC_MemoryAttrs *strAttrs,
char *pcFileName, u32 u32LineNo);
/*!
* @brief standrad malloc wrapper with custom attributes
*/
#define WILC_MALLOC_EX(__size__, __attrs__) \
(WILC_MemoryAlloc( \
(__size__), __attrs__, NULL, 0))
/*!
* @brief standrad calloc wrapper with custom attributes
*/
#define WILC_CALLOC_EX(__size__, __attrs__) \
(WILC_MemoryCalloc( \
(__size__), __attrs__, NULL, 0))
/*!
* @brief standrad realloc wrapper with custom attributes
*/
#define WILC_REALLOC_EX(__ptr__, __new_size__, __attrs__) \
(WILC_MemoryRealloc( \
(__ptr__), (__new_size__), __attrs__, NULL, 0))
/*!
* @brief standrad free wrapper with custom attributes
*/
#define WILC_FREE_EX(__ptr__, __attrs__) \
(WILC_MemoryFree( \
(__ptr__), __attrs__, NULL, 0))
/*!
* @brief Allocates a block (with custom attributes) of given type and number of
* elements
*/
#define WILC_NEW_EX(__struct_type__, __n_structs__, __attrs__) \
((__struct_type__ *)WILC_MALLOC_EX( \
sizeof(__struct_type__) * (u32)(__n_structs__), __attrs__))
/*!
* @brief Allocates a block (with custom attributes) of given type and number of
* elements and Zero-fills it
*/
#define WILC_NEW_0_EX(__struct_type__, __n_structs__, __attrs__) \
((__struct_type__ *)WILC_CALLOC_EX( \
sizeof(__struct_type__) * (u32)(__n_structs__), __attrs__))
/*!
* @brief Frees a block (with custom attributes), also setting the original pointer
* to NULL
*/
#define WILC_FREE_SET_NULL_EX(__ptr__, __attrs__) do { \
if (__ptr__ != NULL) { \
WILC_FREE_EX(__ptr__, __attrs__); \
__ptr__ = NULL; \
} \
} while (0)
/*!
* @brief Frees a block (with custom attributes) if the pointer expression evaluates
* to true
*/
#define WILC_FREE_IF_TRUE_EX(__ptr__, __attrs__) do { \
if (__ptr__ != NULL) { \
WILC_FREE_EX(__ptr__, __attrs__); \
} \
} while (0)
/*!
* @brief standrad malloc wrapper with default attributes
*/
#define WILC_MALLOC(__size__) \
WILC_MALLOC_EX(__size__, NULL)
/*!
* @brief standrad calloc wrapper with default attributes
*/
#define WILC_CALLOC(__size__) \
WILC_CALLOC_EX(__size__, NULL)
/*!
* @brief standrad realloc wrapper with default attributes
*/
#define WILC_REALLOC(__ptr__, __new_size__) \
WILC_REALLOC_EX(__ptr__, __new_size__, NULL)
/*!
* @brief standrad free wrapper with default attributes
*/
#define WILC_FREE(__ptr__) \
WILC_FREE_EX(__ptr__, NULL)
/*!
* @brief Allocates a block (with default attributes) of given type and number of
* elements
*/
#define WILC_NEW(__struct_type__, __n_structs__) \
WILC_NEW_EX(__struct_type__, __n_structs__, NULL)
/*!
* @brief Allocates a block (with default attributes) of given type and number of
* elements and Zero-fills it
*/
#define WILC_NEW_0(__struct_type__, __n_structs__) \
WILC_NEW_O_EX(__struct_type__, __n_structs__, NULL)
/*!
* @brief Frees a block (with default attributes), also setting the original pointer
* to NULL
*/
#define WILC_FREE_SET_NULL(__ptr__) \
WILC_FREE_SET_NULL_EX(__ptr__, NULL)
/*!
* @brief Frees a block (with default attributes) if the pointer expression evaluates
* to true
*/
#define WILC_FREE_IF_TRUE(__ptr__) \
WILC_FREE_IF_TRUE_EX(__ptr__, NULL)
#endif
|
