2 * Copyright (c) 2016, Olivier MATZ <zer0@droids-corp.org>
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of the University of California, Berkeley nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 #include <ecoli_log.h>
36 #include <ecoli_test.h>
37 #include <ecoli_malloc.h>
39 #define COUNT_OF(x) ((sizeof(x)/sizeof(0[x])) / \
40 ((size_t)(!(sizeof(x) % sizeof(0[x])))))
42 static int log_level = EC_LOG_INFO;
43 static int alloc_fail_proba = 0;
46 static const char ec_short_options[] =
49 "r:" /* random-alloc-fail */
53 #define EC_OPT_HELP "help"
54 #define EC_OPT_LOG_LEVEL "log-level"
55 #define EC_OPT_RANDOM_ALLOC_FAIL "random-alloc-fail"
56 #define EC_OPT_SEED "seed"
58 static const struct option ec_long_options[] = {
59 {EC_OPT_HELP, 1, NULL, 'h'},
60 {EC_OPT_LOG_LEVEL, 1, NULL, 'l'},
61 {EC_OPT_RANDOM_ALLOC_FAIL, 1, NULL, 'r'},
62 {EC_OPT_SEED, 1, NULL, 's'},
66 static void usage(const char *prgname)
68 printf("%s [options]\n"
73 " --"EC_OPT_LOG_LEVEL"=<level>\n"
74 " Set log level (0 = no log, 7 = verbose).\n"
76 " --"EC_OPT_RANDOM_ALLOC_FAIL"=<probability>\n"
77 " Cause malloc to fail randomly. This helps to debug\n"
78 " leaks or crashes in error cases. The probability is\n"
79 " between 0 and 100.\n"
82 " Seeds the random number generator. Default is 0.\n"
87 parse_int(const char *s, int min, int max, int *ret, unsigned int base)
92 n = strtoll(s, &end, base);
93 if ((s[0] == '\0') || (end == NULL) || (*end != '\0'))
104 static void parse_args(int argc, char **argv)
108 while ((opt = getopt_long(argc, argv, ec_short_options,
109 ec_long_options, NULL)) != EOF) {
116 case 'l': /* log-level */
117 if (parse_int(optarg, EC_LOG_EMERG,
118 EC_LOG_DEBUG, &log_level, 10) < 0) {
119 printf("Invalid log value\n");
125 case 'r': /* random-alloc-fail */
126 if (parse_int(optarg, 0, 100, &alloc_fail_proba,
128 printf("Invalid probability value\n");
135 if (parse_int(optarg, 0, INT_MAX, &seed, 10) < 0) {
136 printf("Invalid seed value\n");
149 TAILQ_HEAD(debug_alloc_hdr_list, debug_alloc_hdr);
150 static struct debug_alloc_hdr_list debug_alloc_hdr_list =
151 TAILQ_HEAD_INITIALIZER(debug_alloc_hdr_list);
154 struct debug_alloc_hdr {
155 TAILQ_ENTRY(debug_alloc_hdr) next;
159 void *stack[STACK_SZ];
164 struct debug_alloc_ftr {
166 } __attribute__((packed));
168 static void *debug_malloc(size_t size, const char *file, unsigned int line)
170 struct debug_alloc_hdr *hdr;
171 struct debug_alloc_ftr *ftr;
172 size_t new_size = size + sizeof(*hdr) + sizeof(*ftr);
176 if (alloc_fail_proba != 0 && (random() % 100) < alloc_fail_proba)
179 hdr = malloc(new_size);
187 hdr->stacklen = backtrace(hdr->stack, COUNT_OF(hdr->stack));
188 hdr->cookie = 0x12345678;
189 TAILQ_INSERT_TAIL(&debug_alloc_hdr_list, hdr, next);
191 ftr = (struct debug_alloc_ftr *)(
192 (char *)hdr + size + sizeof(*hdr));
193 ftr->cookie = 0x87654321;
196 ec_log(EC_LOG_DEBUG, "%s:%d: info: malloc(%zd) -> %p\n",
197 file, line, size, ret);
202 static void debug_free(void *ptr, const char *file, unsigned int line)
204 struct debug_alloc_hdr *hdr, *h;
205 struct debug_alloc_ftr *ftr;
210 ec_log(EC_LOG_DEBUG, "%s:%d: info: free(%p)\n", file, line, ptr);
215 hdr = (ptr - sizeof(*hdr));
216 if (hdr->cookie != 0x12345678) {
217 ec_log(EC_LOG_ERR, "%s:%d: error: free(%p): bad start cookie\n",
222 ftr = (ptr + hdr->size);
223 if (ftr->cookie != 0x87654321) {
224 ec_log(EC_LOG_ERR, "%s:%d: error: free(%p): bad end cookie\n",
229 TAILQ_FOREACH(h, &debug_alloc_hdr_list, next) {
235 ec_log(EC_LOG_ERR, "%s:%d: error: free(%p): bad ptr\n",
240 TAILQ_REMOVE(&debug_alloc_hdr_list, hdr, next);
244 static void *debug_realloc(void *ptr, size_t size, const char *file,
247 struct debug_alloc_hdr *hdr, *h;
248 struct debug_alloc_ftr *ftr;
249 size_t new_size = size + sizeof(*hdr) + sizeof(unsigned int);
253 hdr = (ptr - sizeof(*hdr));
254 if (hdr->cookie != 0x12345678) {
256 "%s:%d: error: realloc(%p): bad start cookie\n",
261 ftr = (ptr + hdr->size);
262 if (ftr->cookie != 0x87654321) {
264 "%s:%d: error: realloc(%p): bad end cookie\n",
269 TAILQ_FOREACH(h, &debug_alloc_hdr_list, next) {
275 ec_log(EC_LOG_ERR, "%s:%d: error: realloc(%p): bad ptr\n",
280 TAILQ_REMOVE(&debug_alloc_hdr_list, h, next);
281 hdr = realloc(hdr, new_size);
283 TAILQ_INSERT_TAIL(&debug_alloc_hdr_list, h, next);
289 hdr = realloc(NULL, new_size);
300 hdr->stacklen = backtrace(hdr->stack, COUNT_OF(hdr->stack));
301 hdr->cookie = 0x12345678;
302 TAILQ_INSERT_TAIL(&debug_alloc_hdr_list, hdr, next);
303 ftr = (struct debug_alloc_ftr *)(
304 (char *)hdr + size + sizeof(*hdr));
305 ftr->cookie = 0x87654321;
308 ec_log(EC_LOG_DEBUG, "%s:%d: info: realloc(%p, %zd) -> %p\n",
309 file, line, ptr, size, ret);
314 static int debug_alloc_dump_leaks(void)
316 struct debug_alloc_hdr *hdr;
320 if (TAILQ_EMPTY(&debug_alloc_hdr_list))
323 TAILQ_FOREACH(hdr, &debug_alloc_hdr_list, next) {
325 "%s:%d: error: memory leak size=%zd ptr=%p\n",
326 hdr->file, hdr->line, hdr->size, hdr + 1);
327 buffer = backtrace_symbols(hdr->stack, hdr->stacklen);
328 if (buffer == NULL) {
329 for (i = 0; i < hdr->stacklen; i++)
330 ec_log(EC_LOG_ERR, " %p\n", hdr->stack[i]);
332 for (i = 0; i < hdr->stacklen; i++)
333 ec_log(EC_LOG_ERR, " %s\n",
334 buffer ? buffer[i] : "unknown");
340 " missing static syms, use: addr2line -f -e <prog> <addr>\n");
345 static int debug_log(unsigned int level, void *opaque, const char *str)
349 if (level > (unsigned int)log_level)
352 return printf("%s", str);
355 int main(int argc, char **argv)
359 parse_args(argc, argv);
362 ec_log_register(debug_log, NULL);
364 /* register a new malloc to track memleaks */
365 TAILQ_INIT(&debug_alloc_hdr_list);
366 if (ec_malloc_register(debug_malloc, debug_free, debug_realloc) < 0) {
367 ec_log(EC_LOG_ERR, "cannot register new malloc\n");
373 ec_malloc_unregister();
374 leaks = debug_alloc_dump_leaks();
376 if (alloc_fail_proba == 0 && ret != 0) {
377 printf("tests failed\n");
379 } else if (alloc_fail_proba != 0 && leaks != 0) {
380 printf("tests failed (memory leak)\n");
384 printf("\ntests ok\n");