| 1 |
/* SPDX-License-Identifier: LGPL-2.1-or-later */ |
| 2 |
#pragma once |
| 3 |
|
| 4 |
#include <stdlib.h> |
| 5 |
|
| 6 |
#include "basic-forward.h" |
| 7 |
#include "memory-util.h" /* IWYU pragma: keep */ |
| 8 |
|
| 9 |
#if HAS_FEATURE_MEMORY_SANITIZER |
| 10 |
# include <sanitizer/msan_interface.h> |
| 11 |
#endif |
| 12 |
|
| 13 |
/* If for some reason more than 4M are allocated on the stack, let's abort immediately. It's better than |
| 14 |
* proceeding and smashing the stack limits. Note that by default RLIMIT_STACK is 8M on Linux. */ |
| 15 |
#define ALLOCA_MAX (4U*1024U*1024U) |
| 16 |
|
| 17 |
#define new(t, n) ((t*) malloc_multiply(n, sizeof(t))) |
| 18 |
|
| 19 |
#define new0(t, n) ((t*) calloc((n) ?: 1, sizeof(t))) |
| 20 |
|
| 21 |
#define alloca_safe(n) \ |
| 22 |
({ \ |
| 23 |
size_t _nn_ = (n); \ |
| 24 |
assert_se(_nn_ <= ALLOCA_MAX); \ |
| 25 |
alloca(_nn_ == 0 ? 1 : _nn_); \ |
| 26 |
}) \ |
| 27 |
|
| 28 |
#define newa(t, n) \ |
| 29 |
({ \ |
| 30 |
size_t _n_ = (n); \ |
| 31 |
assert_se(MUL_ASSIGN_SAFE(&_n_, sizeof(t))); \ |
| 32 |
(t*) alloca_safe(_n_); \ |
| 33 |
}) |
| 34 |
|
| 35 |
#define newa0(t, n) \ |
| 36 |
({ \ |
| 37 |
size_t _n_ = (n); \ |
| 38 |
assert_se(MUL_ASSIGN_SAFE(&_n_, sizeof(t))); \ |
| 39 |
(t*) alloca0(_n_); \ |
| 40 |
}) |
| 41 |
|
| 42 |
#define newdup(t, p, n) ((t*) memdup_multiply(p, n, sizeof(t))) |
| 43 |
|
| 44 |
#define newdup_suffix0(t, p, n) ((t*) memdup_suffix0_multiply(p, n, sizeof(t))) |
| 45 |
|
| 46 |
#define malloc0(n) (calloc(1, (n) ?: 1)) |
| 47 |
|
| 48 |
#define free_and_replace(a, b) \ |
| 49 |
free_and_replace_full(a, b, free) |
| 50 |
|
| 51 |
void* memdup(const void *p, size_t l) _alloc_(2); |
| 52 |
void* memdup_suffix0(const void *p, size_t l); /* We can't use _alloc_() here, since we return a buffer one byte larger than the specified size */ |
| 53 |
|
| 54 |
#define memdupa(p, l) \ |
| 55 |
({ \ |
| 56 |
void *_q_; \ |
| 57 |
size_t _l_ = l; \ |
| 58 |
_q_ = alloca_safe(_l_); \ |
| 59 |
memcpy_safe(_q_, p, _l_); \ |
| 60 |
}) |
| 61 |
|
| 62 |
#define memdupa_suffix0(p, l) \ |
| 63 |
({ \ |
| 64 |
void *_q_; \ |
| 65 |
size_t _l_ = l; \ |
| 66 |
_q_ = alloca_safe(_l_ + 1); \ |
| 67 |
((uint8_t*) _q_)[_l_] = 0; \ |
| 68 |
memcpy_safe(_q_, p, _l_); \ |
| 69 |
}) |
| 70 |
|
| 71 |
static inline void unsetp(void *p) { |
| 72 |
/* A trivial "destructor" that can be used in cases where we want to |
| 73 |
* unset a pointer from a _cleanup_ function. */ |
| 74 |
|
| 75 |
*(void**)p = NULL; |
| 76 |
} |
| 77 |
|
| 78 |
static inline void freep(void *p) { |
| 79 |
*(void**)p = mfree(*(void**) p); |
| 80 |
} |
| 81 |
|
| 82 |
#define _cleanup_free_ _cleanup_(freep) |
| 83 |
|
| 84 |
static inline bool size_multiply_overflow(size_t size, size_t need) { |
| 85 |
return _unlikely_(need != 0 && size > (SIZE_MAX / need)); |
| 86 |
} |
| 87 |
|
| 88 |
_malloc_ _alloc_(1, 2) static inline void *malloc_multiply(size_t need, size_t size) { |
| 89 |
if (size_multiply_overflow(size, need)) |
| 90 |
return NULL; |
| 91 |
|
| 92 |
return malloc(size * need ?: 1); |
| 93 |
} |
| 94 |
|
| 95 |
_alloc_(2, 3) static inline void *memdup_multiply(const void *p, size_t need, size_t size) { |
| 96 |
if (size_multiply_overflow(size, need)) |
| 97 |
return NULL; |
| 98 |
|
| 99 |
return memdup(p, size * need); |
| 100 |
} |
| 101 |
|
| 102 |
/* Note that we can't decorate this function with _alloc_() since the returned memory area is one byte larger |
| 103 |
* than the product of its parameters. */ |
| 104 |
static inline void *memdup_suffix0_multiply(const void *p, size_t need, size_t size) { |
| 105 |
if (size_multiply_overflow(size, need)) |
| 106 |
return NULL; |
| 107 |
|
| 108 |
return memdup_suffix0(p, size * need); |
| 109 |
} |
| 110 |
|
| 111 |
size_t malloc_sizeof_safe(void **xp); |
| 112 |
|
| 113 |
/* This returns the number of usable bytes in a malloc()ed region as per malloc_usable_size(), which may |
| 114 |
* return a value larger than the size that was actually allocated. Access to that additional memory is |
| 115 |
* discouraged because it violates the C standard; a compiler cannot see that this as valid. To help the |
| 116 |
* compiler out, the MALLOC_SIZEOF_SAFE macro 'allocates' the usable size using a dummy allocator function |
| 117 |
* expand_to_usable. There is a possibility of malloc_usable_size() returning different values during the |
| 118 |
* lifetime of an object, which may cause problems, but the glibc allocator does not do that at the moment. */ |
| 119 |
#define MALLOC_SIZEOF_SAFE(x) \ |
| 120 |
malloc_sizeof_safe((void**) &__builtin_choose_expr(__builtin_constant_p(x), (void*) { NULL }, (x))) |
| 121 |
|
| 122 |
/* Inspired by ELEMENTSOF() but operates on malloc()'ed memory areas: typesafely returns the number of items |
| 123 |
* that fit into the specified memory block */ |
| 124 |
#define MALLOC_ELEMENTSOF(x) \ |
| 125 |
(__builtin_choose_expr( \ |
| 126 |
__builtin_types_compatible_p(typeof(x), typeof(&*(x))), \ |
| 127 |
MALLOC_SIZEOF_SAFE(x)/sizeof((x)[0]), \ |
| 128 |
VOID_0)) |
| 129 |
|
| 130 |
/* Dummy allocator to tell the compiler that the new size of p is newsize. The implementation returns the |
| 131 |
* pointer as is; the only reason for its existence is as a conduit for the _alloc_ attribute. This must not |
| 132 |
* be inlined (hence a non-static function with _noinline_ because LTO otherwise tries to inline it) because |
| 133 |
* gcc then loses the attributes on the function. |
| 134 |
* See: https://gcc.gnu.org/bugzilla/show_bug.cgi?id=96503 */ |
| 135 |
void *expand_to_usable(void *p, size_t newsize) _alloc_(2) _returns_nonnull_ _noinline_; |
| 136 |
|
| 137 |
void* realloc0(void *p, size_t new_size) _alloc_(2); |
| 138 |
|
| 139 |
static inline size_t GREEDY_ALLOC_ROUND_UP(size_t l) { |
| 140 |
size_t m; |
| 141 |
|
| 142 |
/* Round up allocation sizes a bit to some reasonable, likely larger value. This is supposed to be |
| 143 |
* used for cases which are likely called in an allocation loop of some form, i.e. that repetitively |
| 144 |
* grow stuff, for example strv_extend() and suchlike. |
| 145 |
* |
| 146 |
* Note the difference to GREEDY_REALLOC() here, as this helper operates on a single size value only, |
| 147 |
* and rounds up to next multiple of 2, needing no further counter. |
| 148 |
* |
| 149 |
* Note the benefits of direct ALIGN_POWER2() usage: type-safety for size_t, sane handling for very |
| 150 |
* small (i.e. <= 2) and safe handling for very large (i.e. > SSIZE_MAX) values. */ |
| 151 |
|
| 152 |
if (l <= 2) |
| 153 |
return 2; /* Never allocate less than 2 of something. */ |
| 154 |
|
| 155 |
m = ALIGN_POWER2(l); |
| 156 |
if (m == 0) /* overflow? */ |
| 157 |
return l; |
| 158 |
|
| 159 |
return m; |
| 160 |
} |
| 161 |
|
| 162 |
void* greedy_realloc(void **p, size_t need, size_t size); |
| 163 |
void* greedy_realloc0(void **p, size_t need, size_t size); |
| 164 |
void* greedy_realloc_append(void **p, size_t *n_p, const void *from, size_t n_from, size_t size); |
| 165 |
|
| 166 |
#define GREEDY_REALLOC(array, need) \ |
| 167 |
greedy_realloc((void**) &(array), (need), sizeof((array)[0])) |
| 168 |
|
| 169 |
#define GREEDY_REALLOC0(array, need) \ |
| 170 |
greedy_realloc0((void**) &(array), (need), sizeof((array)[0])) |
| 171 |
|
| 172 |
#define GREEDY_REALLOC_APPEND(array, n_array, from, n_from) \ |
| 173 |
({ \ |
| 174 |
const typeof(*(array)) *_from_ = (from); \ |
| 175 |
greedy_realloc_append((void**) &(array), &(n_array), _from_, (n_from), sizeof((array)[0])); \ |
| 176 |
}) |
| 177 |
|
| 178 |
#define alloca0(n) \ |
| 179 |
({ \ |
| 180 |
char *_new_; \ |
| 181 |
size_t _len_ = n; \ |
| 182 |
_new_ = alloca_safe(_len_); \ |
| 183 |
memset(_new_, 0, _len_); \ |
| 184 |
}) |
| 185 |
|
| 186 |
/* It's not clear what alignment glibc/gcc alloca() guarantee, hence provide a guaranteed safe version */ |
| 187 |
#define alloca_align(size, align) \ |
| 188 |
({ \ |
| 189 |
void *_ptr_; \ |
| 190 |
size_t _mask_ = (align) - 1; \ |
| 191 |
size_t _size_ = size; \ |
| 192 |
_ptr_ = alloca_safe(_size_ + _mask_); \ |
| 193 |
(void*)(((uintptr_t)_ptr_ + _mask_) & ~_mask_); \ |
| 194 |
}) |
| 195 |
|
| 196 |
#define alloca0_align(size, align) \ |
| 197 |
({ \ |
| 198 |
void *_new_; \ |
| 199 |
size_t _xsize_ = (size); \ |
| 200 |
_new_ = alloca_align(_xsize_, (align)); \ |
| 201 |
memset(_new_, 0, _xsize_); \ |
| 202 |
}) |
| 203 |
|
| 204 |
#if HAS_FEATURE_MEMORY_SANITIZER |
| 205 |
# define msan_unpoison(r, s) __msan_unpoison(r, s) |
| 206 |
#else |
| 207 |
# define msan_unpoison(r, s) |
| 208 |
#endif |
| 209 |
|
| 210 |
/* Free every element of the array. */ |
| 211 |
void free_many(void **p, size_t n); |
| 212 |
|
| 213 |
/* Typesafe wrapper for char** rather than void**. Unfortunately C won't implicitly cast this. */ |
| 214 |
static inline void free_many_charp(char **c, size_t n) { |
| 215 |
free_many((void**) c, n); |
| 216 |
} |