-
-
Notifications
You must be signed in to change notification settings - Fork 195
/
heaptrack_preload.cpp
434 lines (351 loc) · 9.27 KB
/
heaptrack_preload.cpp
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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
/*
SPDX-FileCopyrightText: 2014-2017 Milian Wolff <mail@milianw.de>
SPDX-License-Identifier: LGPL-2.1-or-later
*/
#include "libheaptrack.h"
#include "util/config.h"
#include <cstdio>
#include <cstdlib>
#include <cstring>
#include <dlfcn.h>
#include <unistd.h>
#include <atomic>
#include <type_traits>
using namespace std;
#if defined(_ISOC11_SOURCE)
#define HAVE_ALIGNED_ALLOC 1
#else
#define HAVE_ALIGNED_ALLOC 0
#endif
// NOTE: adding noexcept to C functions is a hard error in clang++
// (but not even a warning in GCC, even with -Wall)
#if defined(__GNUC__) && !defined(__clang__)
#define LIBC_FUN_ATTRS noexcept
#else
#define LIBC_FUN_ATTRS
#endif
extern "C" {
// Foward declare mimalloc (https://github.com/microsoft/mimalloc) functions so we don't need to include its .h.
void* mi_malloc(size_t size) LIBC_FUN_ATTRS;
void* mi_calloc(size_t count, size_t size) LIBC_FUN_ATTRS;
void* mi_realloc(void* p, size_t newsize) LIBC_FUN_ATTRS;
void mi_free(void* p) LIBC_FUN_ATTRS;
}
namespace {
namespace hooks {
enum class HookType
{
Required,
Optional
};
template <typename Signature, typename Base, HookType Type>
struct hook
{
Signature original = nullptr;
void init() noexcept
{
auto ret = dlsym(RTLD_NEXT, Base::identifier);
if (!ret && Type == HookType::Optional) {
return;
}
if (!ret) {
fprintf(stderr, "Could not find original function %s\n", Base::identifier);
abort();
}
original = reinterpret_cast<Signature>(ret);
}
template <typename... Args>
auto operator()(Args... args) const noexcept -> decltype(original(args...))
{
return original(args...);
}
explicit operator bool() const noexcept
{
return original;
}
};
#define HOOK(name, type) \
struct name##_t : public hook<decltype(&::name), name##_t, type> \
{ \
static constexpr const char* identifier = #name; \
} name
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wignored-attributes"
HOOK(malloc, HookType::Required);
HOOK(free, HookType::Required);
HOOK(calloc, HookType::Required);
#if HAVE_CFREE
HOOK(cfree, HookType::Optional);
#endif
HOOK(realloc, HookType::Required);
HOOK(posix_memalign, HookType::Optional);
#if HAVE_VALLOC
HOOK(valloc, HookType::Optional);
#endif
#if HAVE_ALIGNED_ALLOC
HOOK(aligned_alloc, HookType::Optional);
#endif
HOOK(dlopen, HookType::Required);
HOOK(dlclose, HookType::Required);
// mimalloc functions
HOOK(mi_malloc, HookType::Optional);
HOOK(mi_calloc, HookType::Optional);
HOOK(mi_realloc, HookType::Optional);
HOOK(mi_free, HookType::Optional);
#pragma GCC diagnostic pop
#undef HOOK
/**
* Dummy implementation, since the call to dlsym from findReal triggers a call
* to calloc.
*
* This is only called at startup and will eventually be replaced by the
* "proper" calloc implementation.
*/
struct DummyPool
{
static const constexpr size_t MAX_SIZE = 1024;
char buf[MAX_SIZE] = {0};
size_t offset = 0;
bool isDummyAllocation(void* ptr) noexcept
{
return ptr >= buf && ptr < buf + MAX_SIZE;
}
void* alloc(size_t num, size_t size) noexcept
{
size_t oldOffset = offset;
offset += num * size;
if (offset >= MAX_SIZE) {
fprintf(stderr,
"failed to initialize, dummy calloc buf size exhausted: "
"%zu requested, %zu available\n",
offset, MAX_SIZE);
abort();
}
return buf + oldOffset;
}
};
DummyPool& dummyPool()
{
static DummyPool pool;
return pool;
}
void* dummy_calloc(size_t num, size_t size) noexcept
{
return dummyPool().alloc(num, size);
}
void init()
{
// heaptrack_init itself calls calloc via std::mutex/_libpthread_init on FreeBSD
hooks::calloc.original = &dummy_calloc;
hooks::calloc.init();
heaptrack_init(
getenv("DUMP_HEAPTRACK_OUTPUT"),
[] {
hooks::dlopen.init();
hooks::dlclose.init();
hooks::malloc.init();
hooks::free.init();
hooks::calloc.init();
#if HAVE_CFREE
hooks::cfree.init();
#endif
hooks::realloc.init();
hooks::posix_memalign.init();
#if HAVE_VALLOC
hooks::valloc.init();
#endif
#if HAVE_ALIGNED_ALLOC
hooks::aligned_alloc.init();
#endif
// mimalloc functions
hooks::mi_malloc.init();
hooks::mi_calloc.init();
hooks::mi_realloc.init();
hooks::mi_free.init();
// cleanup environment to prevent tracing of child apps
unsetenv("LD_PRELOAD");
unsetenv("DUMP_HEAPTRACK_OUTPUT");
},
nullptr, nullptr);
}
}
}
extern "C" {
/// TODO: memalign, pvalloc, ...?
void* malloc(size_t size) LIBC_FUN_ATTRS
{
if (!hooks::malloc) {
hooks::init();
}
void* ptr = hooks::malloc(size);
heaptrack_malloc(ptr, size);
return ptr;
}
void free(void* ptr) LIBC_FUN_ATTRS
{
if (!hooks::free) {
hooks::init();
}
if (hooks::dummyPool().isDummyAllocation(ptr)) {
return;
}
// call handler before handing over the real free implementation
// to ensure the ptr is not reused in-between and thus the output
// stays consistent
heaptrack_free(ptr);
hooks::free(ptr);
}
void* realloc(void* ptr, size_t size) LIBC_FUN_ATTRS
{
if (!hooks::realloc) {
hooks::init();
}
void* ret = hooks::realloc(ptr, size);
if (ret) {
heaptrack_realloc(ptr, size, ret);
}
return ret;
}
void* calloc(size_t num, size_t size) LIBC_FUN_ATTRS
{
if (!hooks::calloc) {
hooks::init();
}
void* ret = hooks::calloc(num, size);
if (ret) {
heaptrack_malloc(ret, num * size);
}
return ret;
}
#if HAVE_CFREE
void cfree(void* ptr) LIBC_FUN_ATTRS
{
if (!hooks::cfree) {
hooks::init();
}
// call handler before handing over the real free implementation
// to ensure the ptr is not reused in-between and thus the output
// stays consistent
if (ptr) {
heaptrack_free(ptr);
}
hooks::cfree(ptr);
}
#endif
int posix_memalign(void** memptr, size_t alignment, size_t size) LIBC_FUN_ATTRS
{
if (!hooks::posix_memalign) {
hooks::init();
}
int ret = hooks::posix_memalign(memptr, alignment, size);
if (!ret) {
heaptrack_malloc(*memptr, size);
}
return ret;
}
#if HAVE_ALIGNED_ALLOC
void* aligned_alloc(size_t alignment, size_t size) LIBC_FUN_ATTRS
{
if (!hooks::aligned_alloc) {
hooks::init();
}
void* ret = hooks::aligned_alloc(alignment, size);
if (ret) {
heaptrack_malloc(ret, size);
}
return ret;
}
#endif
#if HAVE_VALLOC
void* valloc(size_t size) LIBC_FUN_ATTRS
{
if (!hooks::valloc) {
hooks::init();
}
void* ret = hooks::valloc(size);
if (ret) {
heaptrack_malloc(ret, size);
}
return ret;
}
#endif
void* dlopen(const char* filename, int flag) LIBC_FUN_ATTRS
{
if (!hooks::dlopen) {
hooks::init();
}
#ifdef RTLD_DEEPBIND
if (filename && flag & RTLD_DEEPBIND) {
heaptrack_warning([](FILE* out) {
fprintf(out,
"Detected dlopen call with RTLD_DEEPBIND which breaks function call interception. "
"Heaptrack will drop this flag. If your application relies on it, try to run `heaptrack "
"--use-inject` instead.");
});
flag &= ~RTLD_DEEPBIND;
}
#endif
void* ret = hooks::dlopen(filename, flag);
if (ret) {
heaptrack_invalidate_module_cache();
}
return ret;
}
int dlclose(void* handle) LIBC_FUN_ATTRS
{
if (!hooks::dlclose) {
hooks::init();
}
int ret = hooks::dlclose(handle);
if (!ret) {
heaptrack_invalidate_module_cache();
}
return ret;
}
// mimalloc functions, implementations just copied from above and names changed
void* mi_malloc(size_t size) LIBC_FUN_ATTRS
{
if (!hooks::mi_malloc) {
hooks::init();
}
void* ptr = hooks::mi_malloc(size);
heaptrack_malloc(ptr, size);
return ptr;
}
void* mi_realloc(void* ptr, size_t size) LIBC_FUN_ATTRS
{
if (!hooks::mi_realloc) {
hooks::init();
}
void* ret = hooks::mi_realloc(ptr, size);
if (ret) {
heaptrack_realloc(ptr, size, ret);
}
return ret;
}
void* mi_calloc(size_t num, size_t size) LIBC_FUN_ATTRS
{
if (!hooks::mi_calloc) {
hooks::init();
}
void* ret = hooks::mi_calloc(num, size);
if (ret) {
heaptrack_malloc(ret, num * size);
}
return ret;
}
void mi_free(void* ptr) LIBC_FUN_ATTRS
{
if (!hooks::mi_free) {
hooks::init();
}
if (hooks::dummyPool().isDummyAllocation(ptr)) {
return;
}
// call handler before handing over the real free implementation
// to ensure the ptr is not reused in-between and thus the output
// stays consistent
heaptrack_free(ptr);
hooks::mi_free(ptr);
}
}