Refactor state dump system
[lttng-ust.git] / liblttng-ust-libc-wrapper / lttng-ust-malloc.c
CommitLineData
b27f8e75
MD
1/*
2 * Copyright (C) 2009 Pierre-Marc Fournier
1622ba22 3 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
c39c72ee
PMF
4 *
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
9 *
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
14 *
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18 */
19
e541a28d 20#define _GNU_SOURCE
f02baefb 21#include <lttng/ust-dlfcn.h>
e541a28d
PMF
22#include <sys/types.h>
23#include <stdio.h>
2594a5b4 24#include <assert.h>
4c3536e0
MD
25#include <urcu/system.h>
26#include <urcu/uatomic.h>
2594a5b4 27#include <urcu/compiler.h>
8c06ba6f 28#include <urcu/tls-compat.h>
20ef5166 29#include <urcu/arch.h>
2594a5b4 30#include <lttng/align.h>
1622ba22
MD
31
32#define TRACEPOINT_DEFINE
33#define TRACEPOINT_CREATE_PROBES
34#include "ust_libc.h"
fbd8191b 35
f95b2888
SS
36#define STATIC_CALLOC_LEN 4096
37static char static_calloc_buf[STATIC_CALLOC_LEN];
4c3536e0 38static unsigned long static_calloc_buf_offset;
f95b2888 39
2594a5b4
MD
40struct alloc_functions {
41 void *(*calloc)(size_t nmemb, size_t size);
42 void *(*malloc)(size_t size);
43 void (*free)(void *ptr);
44 void *(*realloc)(void *ptr, size_t size);
45 void *(*memalign)(size_t alignment, size_t size);
46 int (*posix_memalign)(void **memptr, size_t alignment, size_t size);
47};
48
49static
50struct alloc_functions cur_alloc;
51
8c06ba6f
MD
52/*
53 * Make sure our own use of the LTS compat layer will not cause infinite
54 * recursion by calling calloc.
55 */
56
57static
58void *static_calloc(size_t nmemb, size_t size);
59
20ef5166
MD
60/*
61 * pthread mutex replacement for URCU tls compat layer.
62 */
63static int ust_malloc_lock;
64
65static __attribute__((unused))
66void ust_malloc_spin_lock(pthread_mutex_t *lock)
67{
68 /*
69 * The memory barrier within cmpxchg takes care of ordering
70 * memory accesses with respect to the start of the critical
71 * section.
72 */
73 while (uatomic_cmpxchg(&ust_malloc_lock, 0, 1) != 0)
74 caa_cpu_relax();
75}
76
77static __attribute__((unused))
78void ust_malloc_spin_unlock(pthread_mutex_t *lock)
79{
80 /*
81 * Ensure memory accesses within the critical section do not
82 * leak outside.
83 */
84 cmm_smp_mb();
85 uatomic_set(&ust_malloc_lock, 0);
86}
87
8c06ba6f 88#define calloc static_calloc
20ef5166
MD
89#define pthread_mutex_lock ust_malloc_spin_lock
90#define pthread_mutex_unlock ust_malloc_spin_unlock
8c06ba6f 91static DEFINE_URCU_TLS(int, malloc_nesting);
20ef5166
MD
92#undef ust_malloc_spin_unlock
93#undef ust_malloc_spin_lock
8c06ba6f
MD
94#undef calloc
95
2594a5b4
MD
96/*
97 * Static allocator to use when initially executing dlsym(). It keeps a
98 * size_t value of each object size prior to the object.
99 */
100static
101void *static_calloc_aligned(size_t nmemb, size_t size, size_t alignment)
f95b2888 102{
2594a5b4
MD
103 size_t prev_offset, new_offset, res_offset, aligned_offset;
104
105 if (nmemb * size == 0) {
106 return NULL;
107 }
f95b2888 108
4c3536e0
MD
109 /*
110 * Protect static_calloc_buf_offset from concurrent updates
111 * using a cmpxchg loop rather than a mutex to remove a
112 * dependency on pthread. This will minimize the risk of bad
113 * interaction between mutex and malloc instrumentation.
114 */
115 res_offset = CMM_LOAD_SHARED(static_calloc_buf_offset);
116 do {
117 prev_offset = res_offset;
2594a5b4
MD
118 aligned_offset = ALIGN(prev_offset + sizeof(size_t), alignment);
119 new_offset = aligned_offset + nmemb * size;
120 if (new_offset > sizeof(static_calloc_buf)) {
121 abort();
4c3536e0 122 }
4c3536e0
MD
123 } while ((res_offset = uatomic_cmpxchg(&static_calloc_buf_offset,
124 prev_offset, new_offset)) != prev_offset);
2594a5b4
MD
125 *(size_t *) &static_calloc_buf[aligned_offset - sizeof(size_t)] = size;
126 return &static_calloc_buf[aligned_offset];
127}
128
129static
130void *static_calloc(size_t nmemb, size_t size)
131{
132 void *retval;
133
134 retval = static_calloc_aligned(nmemb, size, 1);
2594a5b4
MD
135 return retval;
136}
137
138static
139void *static_malloc(size_t size)
140{
141 void *retval;
142
143 retval = static_calloc_aligned(1, size, 1);
2594a5b4
MD
144 return retval;
145}
146
147static
148void static_free(void *ptr)
149{
150 /* no-op. */
2594a5b4
MD
151}
152
153static
154void *static_realloc(void *ptr, size_t size)
155{
156 size_t *old_size = NULL;
157 void *retval;
158
159 if (size == 0) {
160 retval = NULL;
161 goto end;
162 }
163
164 if (ptr) {
165 old_size = (size_t *) ptr - 1;
166 if (size <= *old_size) {
167 /* We can re-use the old entry. */
168 *old_size = size;
169 retval = ptr;
170 goto end;
171 }
172 }
173 /* We need to expand. Don't free previous memory location. */
174 retval = static_calloc_aligned(1, size, 1);
175 assert(retval);
176 if (ptr)
177 memcpy(retval, ptr, *old_size);
178end:
2594a5b4
MD
179 return retval;
180}
181
182static
183void *static_memalign(size_t alignment, size_t size)
184{
185 void *retval;
186
187 retval = static_calloc_aligned(1, size, alignment);
2594a5b4
MD
188 return retval;
189}
190
191static
192int static_posix_memalign(void **memptr, size_t alignment, size_t size)
193{
2594a5b4
MD
194 void *ptr;
195
196 /* Check for power of 2, larger than void *. */
197 if (alignment & (alignment - 1)
198 || alignment < sizeof(void *)
199 || alignment == 0) {
2594a5b4
MD
200 goto end;
201 }
202 ptr = static_calloc_aligned(1, size, alignment);
203 *memptr = ptr;
2594a5b4 204end:
2594a5b4
MD
205 return 0;
206}
207
208static
209void setup_static_allocator(void)
210{
211 assert(cur_alloc.calloc == NULL);
212 cur_alloc.calloc = static_calloc;
213 assert(cur_alloc.malloc == NULL);
214 cur_alloc.malloc = static_malloc;
215 assert(cur_alloc.free == NULL);
216 cur_alloc.free = static_free;
217 assert(cur_alloc.realloc == NULL);
218 cur_alloc.realloc = static_realloc;
219 assert(cur_alloc.memalign == NULL);
220 cur_alloc.memalign = static_memalign;
221 assert(cur_alloc.posix_memalign == NULL);
222 cur_alloc.posix_memalign = static_posix_memalign;
223}
224
225static
226void lookup_all_symbols(void)
227{
228 struct alloc_functions af;
229
230 /*
231 * Temporarily redirect allocation functions to
232 * static_calloc_aligned, and free function to static_free
233 * (no-op), until the dlsym lookup has completed.
234 */
235 setup_static_allocator();
236
237 /* Perform the actual lookups */
238 af.calloc = dlsym(RTLD_NEXT, "calloc");
239 af.malloc = dlsym(RTLD_NEXT, "malloc");
240 af.free = dlsym(RTLD_NEXT, "free");
241 af.realloc = dlsym(RTLD_NEXT, "realloc");
242 af.memalign = dlsym(RTLD_NEXT, "memalign");
243 af.posix_memalign = dlsym(RTLD_NEXT, "posix_memalign");
244
245 /* Populate the new allocator functions */
246 memcpy(&cur_alloc, &af, sizeof(cur_alloc));
f95b2888
SS
247}
248
e541a28d
PMF
249void *malloc(size_t size)
250{
1c184644
PMF
251 void *retval;
252
8c06ba6f 253 URCU_TLS(malloc_nesting)++;
2594a5b4
MD
254 if (cur_alloc.malloc == NULL) {
255 lookup_all_symbols();
256 if (cur_alloc.malloc == NULL) {
e541a28d 257 fprintf(stderr, "mallocwrap: unable to find malloc\n");
2594a5b4 258 abort();
e541a28d
PMF
259 }
260 }
2594a5b4 261 retval = cur_alloc.malloc(size);
8c06ba6f 262 if (URCU_TLS(malloc_nesting) == 1) {
887bba30 263 tracepoint(ust_libc, malloc, size, retval, __builtin_return_address(0));
8c06ba6f
MD
264 }
265 URCU_TLS(malloc_nesting)--;
1c184644
PMF
266 return retval;
267}
268
269void free(void *ptr)
270{
8c06ba6f 271 URCU_TLS(malloc_nesting)++;
2594a5b4
MD
272 /*
273 * Check whether the memory was allocated with
274 * static_calloc_align, in which case there is nothing to free.
f95b2888 275 */
2594a5b4
MD
276 if (caa_unlikely((char *)ptr >= static_calloc_buf &&
277 (char *)ptr < static_calloc_buf + STATIC_CALLOC_LEN)) {
8c06ba6f
MD
278 goto end;
279 }
280
281 if (URCU_TLS(malloc_nesting) == 1) {
887bba30 282 tracepoint(ust_libc, free, ptr, __builtin_return_address(0));
f95b2888 283 }
1c184644 284
2594a5b4
MD
285 if (cur_alloc.free == NULL) {
286 lookup_all_symbols();
287 if (cur_alloc.free == NULL) {
1c184644 288 fprintf(stderr, "mallocwrap: unable to find free\n");
2594a5b4 289 abort();
1c184644
PMF
290 }
291 }
2594a5b4 292 cur_alloc.free(ptr);
8c06ba6f
MD
293end:
294 URCU_TLS(malloc_nesting)--;
e541a28d 295}
f95b2888
SS
296
297void *calloc(size_t nmemb, size_t size)
298{
f95b2888
SS
299 void *retval;
300
8c06ba6f 301 URCU_TLS(malloc_nesting)++;
2594a5b4
MD
302 if (cur_alloc.calloc == NULL) {
303 lookup_all_symbols();
304 if (cur_alloc.calloc == NULL) {
f95b2888 305 fprintf(stderr, "callocwrap: unable to find calloc\n");
2594a5b4 306 abort();
f95b2888
SS
307 }
308 }
2594a5b4 309 retval = cur_alloc.calloc(nmemb, size);
8c06ba6f 310 if (URCU_TLS(malloc_nesting) == 1) {
887bba30 311 tracepoint(ust_libc, calloc, nmemb, size, retval, __builtin_return_address(0));
8c06ba6f
MD
312 }
313 URCU_TLS(malloc_nesting)--;
f95b2888
SS
314 return retval;
315}
316
317void *realloc(void *ptr, size_t size)
318{
f95b2888
SS
319 void *retval;
320
8c06ba6f
MD
321 URCU_TLS(malloc_nesting)++;
322 /*
323 * Check whether the memory was allocated with
2594a5b4
MD
324 * static_calloc_align, in which case there is nothing
325 * to free, and we need to copy the old data.
326 */
327 if (caa_unlikely((char *)ptr >= static_calloc_buf &&
328 (char *)ptr < static_calloc_buf + STATIC_CALLOC_LEN)) {
329 size_t *old_size;
330
331 old_size = (size_t *) ptr - 1;
332 if (cur_alloc.calloc == NULL) {
333 lookup_all_symbols();
334 if (cur_alloc.calloc == NULL) {
335 fprintf(stderr, "reallocwrap: unable to find calloc\n");
336 abort();
337 }
338 }
339 retval = cur_alloc.calloc(1, size);
340 if (retval) {
341 memcpy(retval, ptr, *old_size);
342 }
8c06ba6f
MD
343 /*
344 * Mimick that a NULL pointer has been received, so
345 * memory allocation analysis based on the trace don't
346 * get confused by the address from the static
347 * allocator.
348 */
349 ptr = NULL;
2594a5b4
MD
350 goto end;
351 }
352
353 if (cur_alloc.realloc == NULL) {
354 lookup_all_symbols();
355 if (cur_alloc.realloc == NULL) {
f95b2888 356 fprintf(stderr, "reallocwrap: unable to find realloc\n");
2594a5b4 357 abort();
f95b2888
SS
358 }
359 }
2594a5b4
MD
360 retval = cur_alloc.realloc(ptr, size);
361end:
8c06ba6f 362 if (URCU_TLS(malloc_nesting) == 1) {
887bba30 363 tracepoint(ust_libc, realloc, ptr, size, retval, __builtin_return_address(0));
8c06ba6f
MD
364 }
365 URCU_TLS(malloc_nesting)--;
f95b2888
SS
366 return retval;
367}
9d34b226
SS
368
369void *memalign(size_t alignment, size_t size)
370{
9d34b226
SS
371 void *retval;
372
8c06ba6f 373 URCU_TLS(malloc_nesting)++;
2594a5b4
MD
374 if (cur_alloc.memalign == NULL) {
375 lookup_all_symbols();
376 if (cur_alloc.memalign == NULL) {
9d34b226 377 fprintf(stderr, "memalignwrap: unable to find memalign\n");
2594a5b4 378 abort();
9d34b226
SS
379 }
380 }
2594a5b4 381 retval = cur_alloc.memalign(alignment, size);
8c06ba6f 382 if (URCU_TLS(malloc_nesting) == 1) {
887bba30 383 tracepoint(ust_libc, memalign, alignment, size, retval, __builtin_return_address(0));
8c06ba6f
MD
384 }
385 URCU_TLS(malloc_nesting)--;
9d34b226
SS
386 return retval;
387}
388
389int posix_memalign(void **memptr, size_t alignment, size_t size)
390{
9d34b226
SS
391 int retval;
392
8c06ba6f 393 URCU_TLS(malloc_nesting)++;
2594a5b4
MD
394 if (cur_alloc.posix_memalign == NULL) {
395 lookup_all_symbols();
396 if (cur_alloc.posix_memalign == NULL) {
9d34b226 397 fprintf(stderr, "posix_memalignwrap: unable to find posix_memalign\n");
2594a5b4 398 abort();
9d34b226
SS
399 }
400 }
2594a5b4 401 retval = cur_alloc.posix_memalign(memptr, alignment, size);
8c06ba6f
MD
402 if (URCU_TLS(malloc_nesting) == 1) {
403 tracepoint(ust_libc, posix_memalign, *memptr, alignment, size,
887bba30 404 retval, __builtin_return_address(0));
8c06ba6f
MD
405 }
406 URCU_TLS(malloc_nesting)--;
9d34b226
SS
407 return retval;
408}
2594a5b4
MD
409
410__attribute__((constructor))
411void lttng_ust_malloc_wrapper_init(void)
412{
413 /* Initialization already done */
414 if (cur_alloc.calloc) {
415 return;
416 }
417 /*
418 * Ensure the allocator is in place before the process becomes
419 * multithreaded.
420 */
421 lookup_all_symbols();
422}
This page took 0.047731 seconds and 4 git commands to generate.