-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlkrcmm.h
348 lines (277 loc) · 10.9 KB
/
lkrcmm.h
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
// GCC reftrack plugin based heap management for the Linux kernel
// SPDX-License-Identifier: GPL-2.0-only
/************************************************************
Copyright (C) 2022-2023 Aravind Ceyardass (dev@aravind.cc)
************************************************************/
#ifndef LKRCMM__
#define LKRCMM__
#include <linux/compiler.h>
#include <linux/compiler_attributes.h>
#include <linux/overflow.h>
#include <linux/printk.h>
#include <linux/types.h>
#include <linux/syslog.h>
#include <linux/mm.h>
#include <linux/vmalloc.h>
#include <linux/limits.h>
#include <linux/slab.h>
#include <linux/atomic.h>
#include <linux/reftrack.h>
#ifdef REFTRACK_DEBUG
#define REFTRACK_USE_MARK
#endif
#ifdef REFTRACK_TRACE
#define REFTRACK_TRACE_LOG(...) do{__VA_ARGS__}while(0)
#else
#define REFTRACK_TRACE_LOG(...)
#endif
typedef atomic_t reftrack_count_t;
#define REFCOUNT_SET(v, x) atomic_set(&(v), x)
#define REFCOUNT_INC(v) atomic_inc(&(v))
#define REFCOUNT_DEC(v) atomic_dec(&(v))
#define REFCOUNT_DEC_READ(v) atomic_dec_and_test(&(v))
#define REFCOUNT_READ(v) atomic_read(&(v))
#define REFTRACK_MARKER 0xfacebeef
// structure that is prefixed to allocated memory
struct reftrack_ {
reftrack_count_t rc; // reference count
#ifdef REFTRACK_DEBUG
const char *filename; // filename of file where allocation happened
unsigned lineno; // line number in the corresponding file
#endif
#ifdef REFTRACK_USE_MARK
int mark;
#endif
void (*dtor)(void*); // destructor
};
typedef struct reftrack_ reftrack_t;
#define REFTRACK_HDR(bodyp) ((reftrack_t *)((void *)(bodyp) - sizeof(reftrack_t)))
#define REFTRACK_BODY(hdrp) ((void*)hdrp + sizeof(reftrack_t))
#define REFTRACK_COUNTER(bodyp) (REFTRACK_HDR(bodyp)->rc)
#define REFTRACK_COUNT(bodyp) REFCOUNT_READ(REFTRACK_COUNTER(bodyp))
#define REFTRACK_DTOR(hdrp) (hdrp->dtor)
#ifdef REFTRACK_USE_MARK
#define REFTRACK_SET_MARK(p, v) do{ (p)->mark = v; } while(0)
#define mark_found(bodyp) (REFTRACK_HDR(bodyp)->mark == REFTRACK_MARKER)
#else
#define REFTRACK_SET_MARK(p, v) /* discard */
#define mark_found(p) true
#endif
#ifdef REFTRACK_DEBUG
#define reftrack_debug_init(x) do{ \
reftrack_t *const p = x; \
p->filename = filename; \
p->lineno = lineno; \
}while(0)
#define REFTRACK_DEBUG_ARGS ,__BASE_FILE__,__LINE__
#define REFTRACK_DEBUG_PARAMS_DECL ,const char *const filename,const unsigned lineno
#define REFTRACK_DEBUG_PARAMS ,filename,lineno
#else
#define reftrack_debug_init(x) /* discard */
#define REFTRACK_DEBUG_ARGS
#define REFTRACK_DEBUG_PARAMS_DECL
#define REFTRACK_DEBUG_PARAMS
#endif
static void reftrack_hdr_init(reftrack_t *const rtp){
REFCOUNT_SET(rtp->rc, 0);
REFTRACK_SET_MARK(rtp, REFTRACK_MARKER);
reftrack_debug_init(rtp);
rtp->dtor = NULL;
}
REFTRACK_IGNORE MALLOC_LIKE static void *
rc_alloc_helper_(size_t n, gfp_t flags, void *(*alloc_fn)(size_t, gfp_t) REFTRACK_DEBUG_PARAMS_DECL)
{
size_t total_size;
void *p;
if (unlikely(check_add_overflow(n, sizeof(reftrack_t), &total_size)))
return NULL;
p = alloc_fn(total_size, flags);
if (p) {
reftrack_hdr_init(p);
p = REFTRACK_BODY(p);
}
return p;
}
REFTRACK_IGNORE MALLOC_LIKE static void *
rc_kcalloc_(size_t n, size_t size, gfp_t flags REFTRACK_DEBUG_PARAMS_DECL)
{
size_t total_size;
if (unlikely(check_mul_overflow(n, size, &total_size)))
return NULL;
else
return rc_alloc_helper_(total_size, flags REFTRACK_DEBUG_PARAMS);
}
REFTRACK_IGNORE MALLOC_LIKE static void *
rc_vmalloc_helper_(unsigned long n, void *(*const alloc_fn)(unsigned long)
REFTRACK_DEBUG_PARAMS_DECL)
{
size_t total_size;
void *p;
if (unlikely(check_add_overflow(n, sizeof(reftrack_t), &total_size)))
return NULL;
p = alloc_fn(total_size);
if (p) {
reftrack_hdr_init(p);
p = REFTRACK_BODY(p);
}
return p;
}
REFTRACK_HEAP_FN static void *
rc_krealloc_(const void *p, size_t new_size, gfp_t flags
REFTRACK_DEBUG_PARAMS_DECL)
{
void *rv = NULL;
if (!p) {
rv = rc_alloc_helper_(new_size, flags REFTRACK_DEBUG_PARAMS);
/* we have to increment reference count here due to realloc
* behaving like malloc and we are forced to declare krealloc as a heap function.
*/
if (rv) {
REFCOUNT_INC(REFTRACK_COUNTER(rv));
}
} else if (new_size) {
void *orig_p = REFTRACK_HDR(p);
size_t total_size;
if (unlikely(check_add_overflow(new_size, sizeof(reftrack_t), &total_size))) {
pr_err("reftrack:realloc for |0x%p| has incorrect size:|%lu|\n",
p, new_size);
} else {
rv = krealloc(orig_p, total_size, flags);
if (rv != orig_p) {
int count = REFTRACK_COUNT(REFTRACK_BODY(rv));
if (count > 1)
pr_warn("reftrack:object |0x%p| moved while |%d| active references exist\n",
p, count);
}
}
} else {
/*
* case: new_size is zero
* We don't free the object as in original implementation because the object is
* freed when reference count goes to zero.
*/
int count = REFTRACK_COUNT(p);
if (count > 1)
pr_warn("reftrack:attempt to free object |0x%p| with |%d| active references\n",
count-1);
}
return rv ? REFTRACK_BODY(rv) : rv;
}
REFTRACK_IGNORE static void
rc_free_helper_(void *p, void (*const free_fn)(const void *)
REFTRACK_DEBUG_PARAMS_DECL){
if(p) {
reftrack_t *rtp = REFTRACK_HDR(p);
if (REFCOUNT_READ(rtp->rc) != 0) {
pr_warn(
#ifdef REFTRACK_DEBUG
"reftrack: WARNING object |0x%p| allocated at |%s:%u|, freed at |%s:%u| has |%d| reference(s)\n",
rtp, rtp->filename, rtp->lineno,
filename, lineno, REFCOUNT_READ(rtp->rc)
#else
"reftrack: WARNING object |0x%p| has |%u| reference(s)\n",
rtp, REFCOUNT_READ(rtp->rc)
#endif
);
}
if (free_fn) {
REFTRACK_SET_MARK(rtp, 0);
free_fn(rtp);
}
}
}
#define rc_kmalloc(n, f) rc_alloc_helper_(n, f, kmalloc REFTRACK_DEBUG_ARGS)
#define rc_kcalloc(c, n, f) rc_kcalloc_(c, n, f REFTRACK_DEBUG_ARGS)
#define rc_kzalloc(n, f) rc_alloc_helper_(n, (f|__GFP_ZERO), kmalloc REFTRACK_DEBUG_ARGS)
#define rc_vmalloc(n) rc_vmalloc_helper_(n, vmalloc REFTRACK_DEBUG_ARGS)
#define rc_vzalloc(n) rc_vmalloc_helper_(n, vzalloc REFTRACK_DEBUG_ARGS)
#define rc_kvmalloc(n, f) rc_alloc_helper_(n, f, kvmalloc REFTRACK_DEBUG_ARGS)
#define rc_krealloc(p, n, f) rc_krealloc_(p, n, f REFTRACK_DEBUG_ARGS)
#define rc_kfree(x) rc_free_helper_(x, kfree REFTRACK_DEBUG_ARGS)
#define rc_vfree(x) rc_free_helper_(x, vfree REFTRACK_DEBUG_ARGS)
#define rc_kvfree(x) rc_free_helper_(x, kvfree REFTRACK_DEBUG_ARGS)
#define REFTRACK_PROLOG(S) \
struct S; \
static void S##_addref(const struct S *const); \
static void S##_removeref(const struct S *const); \
REFTRACK_IGNORE static void S##_destroy(struct S *const);
#define DECL_ADDREF(S) \
void S##_addref(const struct S *const p) { \
if (p){ \
if (!mark_found(p)){ \
pr_warn("reftrack: Invalid pointer/use-after-free |0x%p| to |%s|\n", p, #S); \
return; \
} \
REFCOUNT_INC(REFTRACK_COUNTER(p)); \
REFTRACK_TRACE_LOG(pr_info("%s:|0x%p|:+1\n", #S, p)); \
} \
}
#define DECL_REMOVEREF(S, DTOR) \
void S##_removeref(const struct S *const p) { \
if (p) { \
if (!mark_found(p)) { \
pr_warn("reftrack: Invalid pointer/use-after-free |0x%p| to |%s|\n", p, #S); \
return; \
} \
REFTRACK_TRACE_LOG(pr_info("%s:|0x%p|:-1n", #S, p)); \
reftrack_t *const rtp = REFTRACK_HDR(p); \
\
if (REFCOUNT_DEC_READ(rtp->rc)){ \
REFTRACK_TRACE_LOG(pr_info("reftrack:free object:%p: type:%s:\n",p,#S)); \
do{ DTOR((struct S*)p); }while(0); \
rc_kvfree((void*)p); \
} \
} \
}
#define REFTRACK_STRUCT(S) \
REFTRACK_PROLOG(S); \
struct REFTRACK(S) S
#define REFTRACK_EPILOG(S) \
DECL_ADDREF(S) \
DECL_REMOVEREF(S, REFTRACK_NOP)
#define REFTRACK_EPILOG_WITH_DTOR(S) \
DECL_ADDREF(S) \
DECL_REMOVEREF(S, S##_destroy)
/*
* Default implementation of addref & removeref functions.
*/
noinline void reftrack_addref(const void *const p) {
if (p){
if (!mark_found(p)){
pr_warn("reftrack: Invalid pointer/use-after-free |0x%p|\n", p);
return;
}
REFCOUNT_INC(REFTRACK_COUNTER(p));
REFTRACK_TRACE_LOG(pr_info("reftrack:|0x%p|:+1\n", p));
}
}
noinline void reftrack_removeref(const void *const p) {
if (p) {
if (!mark_found(p)){
pr_warn("reftrack: Invalid pointer/use-after-free |0x%p|\n", p);
return;
}
REFTRACK_TRACE_LOG(pr_info("reftrack:|0x%p|:-1\n", p));
reftrack_t *const rtp = REFTRACK_HDR(p);
/* checking for one as the value before decrement to zero is one */
if (REFCOUNT_DEC_READ(rtp->rc)){
REFTRACK_DEBUG_LOG(pr_info("reftrack: releasing object |0x%p|\n", p));
void (*dtor)(void *) = REFTRACK_DTOR(rtp);
if (dtor) dtor((void*)p);
rc_kvfree((void*)p);
}
}
}
#ifdef REFTRACK_REPLACE_ALL
#define kmalloc(n, f) rc_kmalloc(n, f)
#define kcalloc(c, n, f) rc_kcalloc(c, n, f)
#define kzalloc(n, f) rc_kzalloc(n, f)
#define vmalloc(n) rc_vmalloc(n)
#define vzalloc(n) rc_vzalloc(n)
#define kvmalloc(n, f) rc_kvmalloc(n, f)
#define krealloc(p, n, f) rc_krealloc(p, n, f)
#define kfree(x) rc_kfree(x)
#define vfree(x) rc_vfree(x)
#define kvfree(x) rc_kvfree(x)
#endif
#endif // LKRCMM__