2 * Copyright © 2010 Intel Corporation
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
31 /* Android defines SIZE_MAX in limits.h, instead of the standard stdint.h */
36 /* Some versions of MinGW are missing _vscprintf's declaration, although they
37 * still provide the symbol in the import library. */
39 _CRTIMP int _vscprintf(const char *format, va_list argptr);
46 #define va_copy(dest, src) __va_copy((dest), (src))
48 #define va_copy(dest, src) (dest) = (src)
52 #define CANARY 0x5A1106
56 /* A canary value used to determine whether a pointer is ralloc'd. */
59 struct ralloc_header *parent;
61 /* The first child (head of a linked list) */
62 struct ralloc_header *child;
64 /* Linked list of siblings */
65 struct ralloc_header *prev;
66 struct ralloc_header *next;
68 void (*destructor)(void *);
71 typedef struct ralloc_header ralloc_header;
73 static void unlink_block(ralloc_header *info);
74 static void unsafe_free(ralloc_header *info);
76 static ralloc_header *
77 get_header(const void *ptr)
79 ralloc_header *info = (ralloc_header *) (((char *) ptr) -
80 sizeof(ralloc_header));
81 assert(info->canary == CANARY);
85 #define PTR_FROM_HEADER(info) (((char *) info) + sizeof(ralloc_header))
88 add_child(ralloc_header *parent, ralloc_header *info)
91 info->parent = parent;
92 info->next = parent->child;
95 if (info->next != NULL)
96 info->next->prev = info;
101 ralloc_context(const void *ctx)
103 return ralloc_size(ctx, 0);
107 ralloc_size(const void *ctx, size_t size)
109 void *block = calloc(1, size + sizeof(ralloc_header));
111 ralloc_header *info = (ralloc_header *) block;
112 ralloc_header *parent = ctx != NULL ? get_header(ctx) : NULL;
114 add_child(parent, info);
116 info->canary = CANARY;
118 return PTR_FROM_HEADER(info);
122 rzalloc_size(const void *ctx, size_t size)
124 void *ptr = ralloc_size(ctx, size);
125 if (likely(ptr != NULL))
126 memset(ptr, 0, size);
130 /* helper function - assumes ptr != NULL */
132 resize(void *ptr, size_t size)
134 ralloc_header *child, *old, *info;
136 old = get_header(ptr);
137 info = realloc(old, size + sizeof(ralloc_header));
142 /* Update parent and sibling's links to the reallocated node. */
143 if (info != old && info->parent != NULL) {
144 if (info->parent->child == old)
145 info->parent->child = info;
147 if (info->prev != NULL)
148 info->prev->next = info;
150 if (info->next != NULL)
151 info->next->prev = info;
154 /* Update child->parent links for all children */
155 for (child = info->child; child != NULL; child = child->next)
156 child->parent = info;
158 return PTR_FROM_HEADER(info);
162 reralloc_size(const void *ctx, void *ptr, size_t size)
164 if (unlikely(ptr == NULL))
165 return ralloc_size(ctx, size);
167 assert(ralloc_parent(ptr) == ctx);
168 return resize(ptr, size);
172 ralloc_array_size(const void *ctx, size_t size, unsigned count)
174 if (count > SIZE_MAX/size)
177 return ralloc_size(ctx, size * count);
181 rzalloc_array_size(const void *ctx, size_t size, unsigned count)
183 if (count > SIZE_MAX/size)
186 return rzalloc_size(ctx, size * count);
190 reralloc_array_size(const void *ctx, void *ptr, size_t size, unsigned count)
192 if (count > SIZE_MAX/size)
195 return reralloc_size(ctx, ptr, size * count);
199 ralloc_free(void *ptr)
206 info = get_header(ptr);
212 unlink_block(ralloc_header *info)
214 /* Unlink from parent & siblings */
215 if (info->parent != NULL) {
216 if (info->parent->child == info)
217 info->parent->child = info->next;
219 if (info->prev != NULL)
220 info->prev->next = info->next;
222 if (info->next != NULL)
223 info->next->prev = info->prev;
231 unsafe_free(ralloc_header *info)
233 /* Recursively free any children...don't waste time unlinking them. */
235 while (info->child != NULL) {
237 info->child = temp->next;
241 /* Free the block itself. Call the destructor first, if any. */
242 if (info->destructor != NULL)
243 info->destructor(PTR_FROM_HEADER(info));
249 ralloc_steal(const void *new_ctx, void *ptr)
251 ralloc_header *info, *parent;
253 if (unlikely(ptr == NULL))
256 info = get_header(ptr);
257 parent = get_header(new_ctx);
261 add_child(parent, info);
265 ralloc_parent(const void *ptr)
269 if (unlikely(ptr == NULL))
272 info = get_header(ptr);
273 return info->parent ? PTR_FROM_HEADER(info->parent) : NULL;
276 static void *autofree_context = NULL;
281 ralloc_free(autofree_context);
285 ralloc_autofree_context(void)
287 if (unlikely(autofree_context == NULL)) {
288 autofree_context = ralloc_context(NULL);
291 return autofree_context;
295 ralloc_set_destructor(const void *ptr, void(*destructor)(void *))
297 ralloc_header *info = get_header(ptr);
298 info->destructor = destructor;
302 ralloc_strdup(const void *ctx, const char *str)
307 if (unlikely(str == NULL))
311 ptr = ralloc_array(ctx, char, n + 1);
318 ralloc_strndup(const void *ctx, const char *str, size_t max)
323 if (unlikely(str == NULL))
330 ptr = ralloc_array(ctx, char, n + 1);
336 /* helper routine for strcat/strncat - n is the exact amount to copy */
338 cat(char **dest, const char *str, size_t n)
341 size_t existing_length;
342 assert(dest != NULL && *dest != NULL);
344 existing_length = strlen(*dest);
345 both = resize(*dest, existing_length + n + 1);
346 if (unlikely(both == NULL))
349 memcpy(both + existing_length, str, n);
350 both[existing_length + n] = '\0';
358 ralloc_strcat(char **dest, const char *str)
360 return cat(dest, str, strlen(str));
364 ralloc_strncat(char **dest, const char *str, size_t n)
366 /* Clamp n to the string length */
367 size_t str_length = strlen(str);
371 return cat(dest, str, n);
375 ralloc_asprintf(const void *ctx, const char *fmt, ...)
380 ptr = ralloc_vasprintf(ctx, fmt, args);
385 /* Return the length of the string that would be generated by a printf-style
386 * format and argument list, not including the \0 byte.
389 printf_length(const char *fmt, va_list untouched_args)
394 /* Make a copy of the va_list so the original caller can still use it */
396 va_copy(args, untouched_args);
399 /* We need to use _vcsprintf to calculate the size as vsnprintf returns -1
400 * if the number of characters to write is greater than count.
402 size = _vscprintf(fmt, args);
405 size = vsnprintf(&junk, 1, fmt, args);
415 ralloc_vasprintf(const void *ctx, const char *fmt, va_list args)
417 size_t size = printf_length(fmt, args) + 1;
419 char *ptr = ralloc_size(ctx, size);
421 vsnprintf(ptr, size, fmt, args);
427 ralloc_asprintf_append(char **str, const char *fmt, ...)
432 success = ralloc_vasprintf_append(str, fmt, args);
438 ralloc_vasprintf_append(char **str, const char *fmt, va_list args)
440 size_t existing_length;
442 existing_length = *str ? strlen(*str) : 0;
443 return ralloc_vasprintf_rewrite_tail(str, &existing_length, fmt, args);
447 ralloc_asprintf_rewrite_tail(char **str, size_t *start, const char *fmt, ...)
452 success = ralloc_vasprintf_rewrite_tail(str, start, fmt, args);
458 ralloc_vasprintf_rewrite_tail(char **str, size_t *start, const char *fmt,
466 if (unlikely(*str == NULL)) {
467 // Assuming a NULL context is probably bad, but it's expected behavior.
468 *str = ralloc_vasprintf(NULL, fmt, args);
472 new_length = printf_length(fmt, args);
474 ptr = resize(*str, *start + new_length + 1);
475 if (unlikely(ptr == NULL))
478 vsnprintf(ptr + *start, new_length + 1, fmt, args);
480 *start += new_length;