1 /* 2 * Copyright © 2010 Intel Corporation 3 * 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: 10 * 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 13 * Software. 14 * 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. 22 */ 23 24 /** 25 * \file ralloc.h 26 * 27 * ralloc: a recursive memory allocator 28 * 29 * The ralloc memory allocator creates a hierarchy of allocated 30 * objects. Every allocation is in reference to some parent, and 31 * every allocated object can in turn be used as the parent of a 32 * subsequent allocation. This allows for extremely convenient 33 * discarding of an entire tree/sub-tree of allocations by calling 34 * ralloc_free on any particular object to free it and all of its 35 * children. 36 * 37 * The conceptual working of ralloc was directly inspired by Andrew 38 * Tridgell's talloc, but ralloc is an independent implementation 39 * released under the MIT license and tuned for Mesa. 40 * 41 * talloc is more sophisticated than ralloc in that it includes reference 42 * counting and useful debugging features. However, it is released under 43 * a non-permissive open source license. 44 */ 45 46 #ifndef RALLOC_H 47 #define RALLOC_H 48 49 #include <stddef.h> 50 #include <stdarg.h> 51 #include <stdbool.h> 52 53 #include "macros.h" 54 55 #ifdef __cplusplus 56 extern "C" { 57 #endif 58 59 /** 60 * \def ralloc(ctx, type) 61 * Allocate a new object chained off of the given context. 62 * 63 * This is equivalent to: 64 * \code 65 * ((type *) ralloc_size(ctx, sizeof(type)) 66 * \endcode 67 */ 68 #define ralloc(ctx, type) ((type *) ralloc_size(ctx, sizeof(type))) 69 70 /** 71 * \def rzalloc(ctx, type) 72 * Allocate a new object out of the given context and initialize it to zero. 73 * 74 * This is equivalent to: 75 * \code 76 * ((type *) rzalloc_size(ctx, sizeof(type)) 77 * \endcode 78 */ 79 #define rzalloc(ctx, type) ((type *) rzalloc_size(ctx, sizeof(type))) 80 81 /** 82 * Allocate a new ralloc context. 83 * 84 * While any ralloc'd pointer can be used as a context, sometimes it is useful 85 * to simply allocate a context with no associated memory. 86 * 87 * It is equivalent to: 88 * \code 89 * ((type *) ralloc_size(ctx, 0) 90 * \endcode 91 */ 92 void *ralloc_context(const void *ctx); 93 94 /** 95 * Allocate memory chained off of the given context. 96 * 97 * This is the core allocation routine which is used by all others. It 98 * simply allocates storage for \p size bytes and returns the pointer, 99 * similar to \c malloc. 100 */ 101 void *ralloc_size(const void *ctx, size_t size) MALLOCLIKE; 102 103 /** 104 * Allocate zero-initialized memory chained off of the given context. 105 * 106 * This is similar to \c calloc with a size of 1. 107 */ 108 void *rzalloc_size(const void *ctx, size_t size) MALLOCLIKE; 109 110 /** 111 * Resize a piece of ralloc-managed memory, preserving data. 112 * 113 * Similar to \c realloc. Unlike C89, passing 0 for \p size does not free the 114 * memory. Instead, it resizes it to a 0-byte ralloc context, just like 115 * calling ralloc_size(ctx, 0). This is different from talloc. 116 * 117 * \param ctx The context to use for new allocation. If \p ptr != NULL, 118 * it must be the same as ralloc_parent(\p ptr). 119 * \param ptr Pointer to the memory to be resized. May be NULL. 120 * \param size The amount of memory to allocate, in bytes. 121 */ 122 void *reralloc_size(const void *ctx, void *ptr, size_t size); 123 124 /** 125 * Resize a ralloc-managed array, preserving data and initializing any newly 126 * allocated data to zero. 127 * 128 * Similar to \c realloc. Unlike C89, passing 0 for \p size does not free the 129 * memory. Instead, it resizes it to a 0-byte ralloc context, just like 130 * calling ralloc_size(ctx, 0). This is different from talloc. 131 * 132 * \param ctx The context to use for new allocation. If \p ptr != NULL, 133 * it must be the same as ralloc_parent(\p ptr). 134 * \param ptr Pointer to the memory to be resized. May be NULL. 135 * \param old_size The amount of memory in the previous allocation, in bytes. 136 * \param new_size The amount of memory to allocate, in bytes. 137 */ 138 void *rerzalloc_size(const void *ctx, void *ptr, 139 size_t old_size, size_t new_size); 140 141 /// \defgroup array Array Allocators @{ 142 143 /** 144 * \def ralloc_array(ctx, type, count) 145 * Allocate an array of objects chained off the given context. 146 * 147 * Similar to \c calloc, but does not initialize the memory to zero. 148 * 149 * More than a convenience function, this also checks for integer overflow when 150 * multiplying \c sizeof(type) and \p count. This is necessary for security. 151 * 152 * This is equivalent to: 153 * \code 154 * ((type *) ralloc_array_size(ctx, sizeof(type), count) 155 * \endcode 156 */ 157 #define ralloc_array(ctx, type, count) \ 158 ((type *) ralloc_array_size(ctx, sizeof(type), count)) 159 160 /** 161 * \def rzalloc_array(ctx, type, count) 162 * Allocate a zero-initialized array chained off the given context. 163 * 164 * Similar to \c calloc. 165 * 166 * More than a convenience function, this also checks for integer overflow when 167 * multiplying \c sizeof(type) and \p count. This is necessary for security. 168 * 169 * This is equivalent to: 170 * \code 171 * ((type *) rzalloc_array_size(ctx, sizeof(type), count) 172 * \endcode 173 */ 174 #define rzalloc_array(ctx, type, count) \ 175 ((type *) rzalloc_array_size(ctx, sizeof(type), count)) 176 177 /** 178 * \def reralloc(ctx, ptr, type, count) 179 * Resize a ralloc-managed array, preserving data. 180 * 181 * Similar to \c realloc. Unlike C89, passing 0 for \p size does not free the 182 * memory. Instead, it resizes it to a 0-byte ralloc context, just like 183 * calling ralloc_size(ctx, 0). This is different from talloc. 184 * 185 * More than a convenience function, this also checks for integer overflow when 186 * multiplying \c sizeof(type) and \p count. This is necessary for security. 187 * 188 * \param ctx The context to use for new allocation. If \p ptr != NULL, 189 * it must be the same as ralloc_parent(\p ptr). 190 * \param ptr Pointer to the array to be resized. May be NULL. 191 * \param type The element type. 192 * \param count The number of elements to allocate. 193 */ 194 #define reralloc(ctx, ptr, type, count) \ 195 ((type *) reralloc_array_size(ctx, ptr, sizeof(type), count)) 196 197 /** 198 * \def rerzalloc(ctx, ptr, type, count) 199 * Resize a ralloc-managed array, preserving data and initializing any newly 200 * allocated data to zero. 201 * 202 * Similar to \c realloc. Unlike C89, passing 0 for \p size does not free the 203 * memory. Instead, it resizes it to a 0-byte ralloc context, just like 204 * calling ralloc_size(ctx, 0). This is different from talloc. 205 * 206 * More than a convenience function, this also checks for integer overflow when 207 * multiplying \c sizeof(type) and \p count. This is necessary for security. 208 * 209 * \param ctx The context to use for new allocation. If \p ptr != NULL, 210 * it must be the same as ralloc_parent(\p ptr). 211 * \param ptr Pointer to the array to be resized. May be NULL. 212 * \param type The element type. 213 * \param old_count The number of elements in the previous allocation. 214 * \param new_count The number of elements to allocate. 215 */ 216 #define rerzalloc(ctx, ptr, type, old_count, new_count) \ 217 ((type *) rerzalloc_array_size(ctx, ptr, sizeof(type), old_count, new_count)) 218 219 /** 220 * Allocate memory for an array chained off the given context. 221 * 222 * Similar to \c calloc, but does not initialize the memory to zero. 223 * 224 * More than a convenience function, this also checks for integer overflow when 225 * multiplying \p size and \p count. This is necessary for security. 226 */ 227 void *ralloc_array_size(const void *ctx, size_t size, unsigned count) MALLOCLIKE; 228 229 /** 230 * Allocate a zero-initialized array chained off the given context. 231 * 232 * Similar to \c calloc. 233 * 234 * More than a convenience function, this also checks for integer overflow when 235 * multiplying \p size and \p count. This is necessary for security. 236 */ 237 void *rzalloc_array_size(const void *ctx, size_t size, unsigned count) MALLOCLIKE; 238 239 /** 240 * Resize a ralloc-managed array, preserving data. 241 * 242 * Similar to \c realloc. Unlike C89, passing 0 for \p size does not free the 243 * memory. Instead, it resizes it to a 0-byte ralloc context, just like 244 * calling ralloc_size(ctx, 0). This is different from talloc. 245 * 246 * More than a convenience function, this also checks for integer overflow when 247 * multiplying \c sizeof(type) and \p count. This is necessary for security. 248 * 249 * \param ctx The context to use for new allocation. If \p ptr != NULL, 250 * it must be the same as ralloc_parent(\p ptr). 251 * \param ptr Pointer to the array to be resized. May be NULL. 252 * \param size The size of an individual element. 253 * \param count The number of elements to allocate. 254 * 255 * \return True unless allocation failed. 256 */ 257 void *reralloc_array_size(const void *ctx, void *ptr, size_t size, 258 unsigned count); 259 260 /** 261 * Resize a ralloc-managed array, preserving data and initializing any newly 262 * allocated data to zero. 263 * 264 * Similar to \c realloc. Unlike C89, passing 0 for \p size does not free the 265 * memory. Instead, it resizes it to a 0-byte ralloc context, just like 266 * calling ralloc_size(ctx, 0). This is different from talloc. 267 * 268 * More than a convenience function, this also checks for integer overflow when 269 * multiplying \c sizeof(type) and \p count. This is necessary for security. 270 * 271 * \param ctx The context to use for new allocation. If \p ptr != NULL, 272 * it must be the same as ralloc_parent(\p ptr). 273 * \param ptr Pointer to the array to be resized. May be NULL. 274 * \param size The size of an individual element. 275 * \param old_count The number of elements in the previous allocation. 276 * \param new_count The number of elements to allocate. 277 * 278 * \return True unless allocation failed. 279 */ 280 void *rerzalloc_array_size(const void *ctx, void *ptr, size_t size, 281 unsigned old_count, unsigned new_count); 282 /// @} 283 284 /** 285 * Free a piece of ralloc-managed memory. 286 * 287 * This will also free the memory of any children allocated this context. 288 */ 289 void ralloc_free(void *ptr); 290 291 /** 292 * "Steal" memory from one context, changing it to another. 293 * 294 * This changes \p ptr's context to \p new_ctx. This is quite useful if 295 * memory is allocated out of a temporary context. 296 */ 297 void ralloc_steal(const void *new_ctx, void *ptr); 298 299 /** 300 * Reparent all children from one context to another. 301 * 302 * This effectively calls ralloc_steal(new_ctx, child) for all children of \p old_ctx. 303 */ 304 void ralloc_adopt(const void *new_ctx, void *old_ctx); 305 306 /** 307 * Return the given pointer's ralloc context. 308 */ 309 void *ralloc_parent(const void *ptr); 310 311 /** 312 * Set a callback to occur just before an object is freed. 313 */ 314 void ralloc_set_destructor(const void *ptr, void(*destructor)(void *)); 315 316 /** 317 * Duplicate memory, allocating the memory from the given context. 318 */ 319 void *ralloc_memdup(const void *ctx, const void *mem, size_t n) MALLOCLIKE; 320 321 /// \defgroup array String Functions @{ 322 /** 323 * Duplicate a string, allocating the memory from the given context. 324 */ 325 char *ralloc_strdup(const void *ctx, const char *str) MALLOCLIKE; 326 327 /** 328 * Duplicate a string, allocating the memory from the given context. 329 * 330 * Like \c strndup, at most \p n characters are copied. If \p str is longer 331 * than \p n characters, \p n are copied, and a termining \c '\0' byte is added. 332 */ 333 char *ralloc_strndup(const void *ctx, const char *str, size_t n) MALLOCLIKE; 334 335 /** 336 * Concatenate two strings, allocating the necessary space. 337 * 338 * This appends \p str to \p *dest, similar to \c strcat, using ralloc_resize 339 * to expand \p *dest to the appropriate size. \p dest will be updated to the 340 * new pointer unless allocation fails. 341 * 342 * The result will always be null-terminated. 343 * 344 * \return True unless allocation failed. 345 */ 346 bool ralloc_strcat(char **dest, const char *str); 347 348 /** 349 * Concatenate two strings, allocating the necessary space. 350 * 351 * This appends at most \p n bytes of \p str to \p *dest, using ralloc_resize 352 * to expand \p *dest to the appropriate size. \p dest will be updated to the 353 * new pointer unless allocation fails. 354 * 355 * The result will always be null-terminated; \p str does not need to be null 356 * terminated if it is longer than \p n. 357 * 358 * \return True unless allocation failed. 359 */ 360 bool ralloc_strncat(char **dest, const char *str, size_t n); 361 362 /** 363 * Concatenate two strings, allocating the necessary space. 364 * 365 * This appends \p n bytes of \p str to \p *dest, using ralloc_resize 366 * to expand \p *dest to the appropriate size. \p dest will be updated to the 367 * new pointer unless allocation fails. 368 * 369 * The result will always be null-terminated. 370 * 371 * This function differs from ralloc_strcat() and ralloc_strncat() in that it 372 * does not do any strlen() calls which can become costly on large strings. 373 * 374 * \return True unless allocation failed. 375 */ 376 bool 377 ralloc_str_append(char **dest, const char *str, 378 size_t existing_length, size_t str_size); 379 380 /** 381 * Print to a string. 382 * 383 * This is analogous to \c sprintf, but allocates enough space (using \p ctx 384 * as the context) for the resulting string. 385 * 386 * \return The newly allocated string. 387 */ 388 char *ralloc_asprintf (const void *ctx, const char *fmt, ...) PRINTFLIKE(2, 3) MALLOCLIKE; 389 390 /** 391 * Print to a string, given a va_list. 392 * 393 * This is analogous to \c vsprintf, but allocates enough space (using \p ctx 394 * as the context) for the resulting string. 395 * 396 * \return The newly allocated string. 397 */ 398 char *ralloc_vasprintf(const void *ctx, const char *fmt, va_list args) MALLOCLIKE; 399 400 /** 401 * Rewrite the tail of an existing string, starting at a given index. 402 * 403 * Overwrites the contents of *str starting at \p start with newly formatted 404 * text, including a new null-terminator. Allocates more memory as necessary. 405 * 406 * This can be used to append formatted text when the length of the existing 407 * string is already known, saving a strlen() call. 408 * 409 * \sa ralloc_asprintf_append 410 * 411 * \param str The string to be updated. 412 * \param start The index to start appending new data at. 413 * \param fmt A printf-style formatting string 414 * 415 * \p str will be updated to the new pointer unless allocation fails. 416 * \p start will be increased by the length of the newly formatted text. 417 * 418 * \return True unless allocation failed. 419 */ 420 bool ralloc_asprintf_rewrite_tail(char **str, size_t *start, 421 const char *fmt, ...) 422 PRINTFLIKE(3, 4); 423 424 /** 425 * Rewrite the tail of an existing string, starting at a given index. 426 * 427 * Overwrites the contents of *str starting at \p start with newly formatted 428 * text, including a new null-terminator. Allocates more memory as necessary. 429 * 430 * This can be used to append formatted text when the length of the existing 431 * string is already known, saving a strlen() call. 432 * 433 * \sa ralloc_vasprintf_append 434 * 435 * \param str The string to be updated. 436 * \param start The index to start appending new data at. 437 * \param fmt A printf-style formatting string 438 * \param args A va_list containing the data to be formatted 439 * 440 * \p str will be updated to the new pointer unless allocation fails. 441 * \p start will be increased by the length of the newly formatted text. 442 * 443 * \return True unless allocation failed. 444 */ 445 bool ralloc_vasprintf_rewrite_tail(char **str, size_t *start, const char *fmt, 446 va_list args); 447 448 /** 449 * Append formatted text to the supplied string. 450 * 451 * This is equivalent to 452 * \code 453 * ralloc_asprintf_rewrite_tail(str, strlen(*str), fmt, ...) 454 * \endcode 455 * 456 * \sa ralloc_asprintf 457 * \sa ralloc_asprintf_rewrite_tail 458 * \sa ralloc_strcat 459 * 460 * \p str will be updated to the new pointer unless allocation fails. 461 * 462 * \return True unless allocation failed. 463 */ 464 bool ralloc_asprintf_append (char **str, const char *fmt, ...) 465 PRINTFLIKE(2, 3); 466 467 /** 468 * Append formatted text to the supplied string, given a va_list. 469 * 470 * This is equivalent to 471 * \code 472 * ralloc_vasprintf_rewrite_tail(str, strlen(*str), fmt, args) 473 * \endcode 474 * 475 * \sa ralloc_vasprintf 476 * \sa ralloc_vasprintf_rewrite_tail 477 * \sa ralloc_strcat 478 * 479 * \p str will be updated to the new pointer unless allocation fails. 480 * 481 * \return True unless allocation failed. 482 */ 483 bool ralloc_vasprintf_append(char **str, const char *fmt, va_list args); 484 /// @} 485 486 typedef struct gc_ctx gc_ctx; 487 488 /** 489 * Allocate a new garbage collection context. The children of the 490 * context are not necessarily ralloc'd pointers and cannot be stolen to a ralloc context. Instead, 491 * The user should use the mark-and-sweep interface below to free any unused children. Under the 492 * hood, this restriction lets us manage allocations ourselves, using a freelist. This means that 493 * GC contexts should be used for scenarios where there are many allocations and frees, most of 494 * which use only a few different sizes. 495 */ 496 gc_ctx *gc_context(const void *parent); 497 498 #define gc_alloc(ctx, type, count) gc_alloc_size(ctx, sizeof(type) * (count), alignof(type)) 499 #define gc_zalloc(ctx, type, count) gc_zalloc_size(ctx, sizeof(type) * (count), alignof(type)) 500 501 #define gc_alloc_zla(ctx, type, type2, count) \ 502 gc_alloc_size(ctx, sizeof(type) + sizeof(type2) * (count), MAX2(alignof(type), alignof(type2))) 503 #define gc_zalloc_zla(ctx, type, type2, count) \ 504 gc_zalloc_size(ctx, sizeof(type) + sizeof(type2) * (count), MAX2(alignof(type), alignof(type2))) 505 506 void *gc_alloc_size(gc_ctx *ctx, size_t size, size_t alignment) MALLOCLIKE; 507 void *gc_zalloc_size(gc_ctx *ctx, size_t size, size_t alignment) MALLOCLIKE; 508 void gc_free(void *ptr); 509 gc_ctx *gc_get_context(void *ptr); 510 511 void gc_sweep_start(gc_ctx *ctx); 512 void gc_mark_live(gc_ctx *ctx, const void *mem); 513 void gc_sweep_end(gc_ctx *ctx); 514 515 /** 516 * Declare C++ new and delete operators which use ralloc. 517 * 518 * Placing this macro in the body of a class makes it possible to do: 519 * 520 * TYPE *var = new(mem_ctx) TYPE(...); 521 * delete var; 522 * 523 * which is more idiomatic in C++ than calling ralloc. 524 */ 525 #define DECLARE_RALLOC_CXX_OPERATORS_TEMPLATE(TYPE, ALLOC_FUNC) \ 526 private: \ 527 static void _ralloc_destructor(void *p) \ 528 { \ 529 reinterpret_cast<TYPE *>(p)->TYPE::~TYPE(); \ 530 } \ 531 public: \ 532 static void* operator new(size_t size, void *mem_ctx) \ 533 { \ 534 void *p = ALLOC_FUNC(mem_ctx, size); \ 535 assert(p != NULL); \ 536 if (!HAS_TRIVIAL_DESTRUCTOR(TYPE)) \ 537 ralloc_set_destructor(p, _ralloc_destructor); \ 538 return p; \ 539 } \ 540 \ 541 static void operator delete(void *p) \ 542 { \ 543 /* The object's destructor is guaranteed to have already been \ 544 * called by the delete operator at this point -- Make sure it's \ 545 * not called again. \ 546 */ \ 547 if (!HAS_TRIVIAL_DESTRUCTOR(TYPE)) \ 548 ralloc_set_destructor(p, NULL); \ 549 ralloc_free(p); \ 550 } 551 552 #define DECLARE_RALLOC_CXX_OPERATORS(type) \ 553 DECLARE_RALLOC_CXX_OPERATORS_TEMPLATE(type, ralloc_size) 554 555 #define DECLARE_RZALLOC_CXX_OPERATORS(type) \ 556 DECLARE_RALLOC_CXX_OPERATORS_TEMPLATE(type, rzalloc_size) 557 558 559 #define DECLARE_LINEAR_ALLOC_CXX_OPERATORS_TEMPLATE(TYPE, ALLOC_FUNC) \ 560 public: \ 561 static void* operator new(size_t size, linear_ctx *ctx) \ 562 { \ 563 void *p = ALLOC_FUNC(ctx, size); \ 564 assert(p != NULL); \ 565 static_assert(HAS_TRIVIAL_DESTRUCTOR(TYPE)); \ 566 return p; \ 567 } 568 569 #define DECLARE_LINEAR_ALLOC_CXX_OPERATORS(type) \ 570 DECLARE_LINEAR_ALLOC_CXX_OPERATORS_TEMPLATE(type, linear_alloc_child) 571 572 #define DECLARE_LINEAR_ZALLOC_CXX_OPERATORS(type) \ 573 DECLARE_LINEAR_ALLOC_CXX_OPERATORS_TEMPLATE(type, linear_zalloc_child) 574 575 typedef struct linear_ctx linear_ctx; 576 577 /** 578 * Do a fast allocation from the linear context, also known as the child node 579 * from the allocator's point of view. It can't be freed directly. You have 580 * to free the linear context or the ralloc parent. 581 * 582 * \param ctx linear context of the allocator 583 * \param size size to allocate (max 32 bits) 584 */ 585 void *linear_alloc_child(linear_ctx *ctx, unsigned size); 586 587 typedef struct { 588 unsigned min_buffer_size; 589 } linear_opts; 590 591 /** 592 * Allocate a linear context that will internally hold linear buffers. 593 * Use it for all child node allocations. 594 * 595 * \param ralloc_ctx ralloc context, must not be NULL 596 */ 597 linear_ctx *linear_context(void *ralloc_ctx); 598 599 linear_ctx *linear_context_with_opts(void *ralloc_ctx, const linear_opts *opts); 600 601 /** 602 * Same as linear_alloc_child, but also clears memory. 603 */ 604 void *linear_zalloc_child(linear_ctx *ctx, unsigned size) MALLOCLIKE; 605 606 /** 607 * Free a linear context. This will free all child nodes too. 608 * Alternatively, freeing the ralloc parent will also free 609 * the linear context. 610 */ 611 void linear_free_context(linear_ctx *ctx); 612 613 /** 614 * Same as ralloc_steal, but steals the entire linear context. 615 */ 616 void ralloc_steal_linear_context(void *new_ralloc_ctx, linear_ctx *ctx); 617 618 /** 619 * Return the ralloc parent of the linear context. 620 */ 621 void *ralloc_parent_of_linear_context(linear_ctx *ctx); 622 623 /** 624 * Do a fast allocation of an array from the linear context and initialize it to zero. 625 * 626 * Similar to \c calloc, but does not initialize the memory to zero. 627 * 628 * More than a convenience function, this also checks for integer overflow when 629 * multiplying \p size and \p count. This is necessary for security. 630 */ 631 void *linear_alloc_child_array(linear_ctx *ctx, size_t size, unsigned count) MALLOCLIKE; 632 633 /** 634 * Do a fast allocation of an array from the linear context. 635 * 636 * Similar to \c calloc. 637 * 638 * More than a convenience function, this also checks for integer overflow when 639 * multiplying \p size and \p count. This is necessary for security. 640 */ 641 void *linear_zalloc_child_array(linear_ctx *ctx, size_t size, unsigned count) MALLOCLIKE; 642 643 /* The functions below have the same semantics as their ralloc counterparts, 644 * except that they always allocate a linear child node. 645 */ 646 char *linear_strdup(linear_ctx *ctx, const char *str) MALLOCLIKE; 647 char *linear_asprintf(linear_ctx *ctx, const char *fmt, ...) PRINTFLIKE(2, 3) MALLOCLIKE; 648 char *linear_vasprintf(linear_ctx *ctx, const char *fmt, va_list args) MALLOCLIKE; 649 bool linear_asprintf_append(linear_ctx *ctx, char **str, const char *fmt, ...) PRINTFLIKE(3, 4); 650 bool linear_vasprintf_append(linear_ctx *ctx, char **str, const char *fmt, 651 va_list args); 652 bool linear_asprintf_rewrite_tail(linear_ctx *ctx, char **str, size_t *start, 653 const char *fmt, ...) PRINTFLIKE(4, 5); 654 bool linear_vasprintf_rewrite_tail(linear_ctx *ctx, char **str, size_t *start, 655 const char *fmt, va_list args); 656 bool linear_strcat(linear_ctx *ctx, char **dest, const char *str); 657 658 /** 659 * \def linear_alloc(ctx, type) 660 * Do a fast allocation from the linear context. 661 * 662 * This is equivalent to: 663 * \code 664 * ((type *) linear_alloc_child(ctx, sizeof(type)) 665 * \endcode 666 */ 667 #define linear_alloc(ctx, type) ((type *) linear_alloc_child(ctx, sizeof(type))) 668 669 /** 670 * \def linear_zalloc(ctx, type) 671 * Do a fast allocation from the linear context and initialize it to zero. 672 * 673 * This is equivalent to: 674 * \code 675 * ((type *) linear_zalloc_child(ctx, sizeof(type)) 676 * \endcode 677 */ 678 #define linear_zalloc(ctx, type) ((type *) linear_zalloc_child(ctx, sizeof(type))) 679 680 /** 681 * \def linear_alloc_array(ctx, type, count) 682 * Do a fast allocation of an array from the linear context. 683 * 684 * Similar to \c calloc, but does not initialize the memory to zero. 685 * 686 * More than a convenience function, this also checks for integer overflow when 687 * multiplying \c sizeof(type) and \p count. This is necessary for security. 688 * 689 * This is equivalent to: 690 * \code 691 * ((type *) linear_alloc_child_array(ctx, sizeof(type), count) 692 * \endcode 693 */ 694 #define linear_alloc_array(ctx, type, count) \ 695 ((type *) linear_alloc_child_array(ctx, sizeof(type), count)) 696 697 /** 698 * \def linear_zalloc_array(ctx, type, count) 699 * Do a fast allocation of an array from the linear context and initialize it to zero 700 * 701 * Similar to \c calloc. 702 * 703 * More than a convenience function, this also checks for integer overflow when 704 * multiplying \c sizeof(type) and \p count. This is necessary for security. 705 * 706 * This is equivalent to: 707 * \code 708 * ((type *) linear_zalloc_child_array(ctx, sizeof(type), count) 709 * \endcode 710 */ 711 #define linear_zalloc_array(ctx, type, count) \ 712 ((type *) linear_zalloc_child_array(ctx, sizeof(type), count)) 713 714 enum { 715 RALLOC_PRINT_INFO_SUMMARY_ONLY = 1 << 0, 716 }; 717 718 void ralloc_print_info(FILE *f, const void *p, unsigned flags); 719 720 #ifdef __cplusplus 721 } /* end of extern "C" */ 722 #endif 723 724 #endif 725