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 /* XXX add a parameter to test only one testcase */
69 printf("%s [options]\n"
74 " --"EC_OPT_LOG_LEVEL"=<level>\n"
75 " Set log level (0 = no log, 7 = verbose).\n"
77 " --"EC_OPT_RANDOM_ALLOC_FAIL"=<probability>\n"
78 " Cause malloc to fail randomly. This helps to debug\n"
79 " leaks or crashes in error cases. The probability is\n"
80 " between 0 and 100.\n"
83 " Seeds the random number generator. Default is 0.\n"
88 parse_int(const char *s, int min, int max, int *ret, unsigned int base)
93 n = strtoll(s, &end, base);
94 if ((s[0] == '\0') || (end == NULL) || (*end != '\0'))
105 static void parse_args(int argc, char **argv)
109 while ((opt = getopt_long(argc, argv, ec_short_options,
110 ec_long_options, NULL)) != EOF) {
117 case 'l': /* log-level */
118 if (parse_int(optarg, EC_LOG_EMERG,
119 EC_LOG_DEBUG, &log_level, 10) < 0) {
120 printf("Invalid log value\n");
126 case 'r': /* random-alloc-fail */
127 if (parse_int(optarg, 0, 100, &alloc_fail_proba,
129 printf("Invalid probability value\n");
136 if (parse_int(optarg, 0, INT_MAX, &seed, 10) < 0) {
137 printf("Invalid seed value\n");
150 TAILQ_HEAD(debug_alloc_hdr_list, debug_alloc_hdr);
151 static struct debug_alloc_hdr_list debug_alloc_hdr_list =
152 TAILQ_HEAD_INITIALIZER(debug_alloc_hdr_list);
155 struct debug_alloc_hdr {
156 TAILQ_ENTRY(debug_alloc_hdr) next;
160 void *stack[STACK_SZ];
165 struct debug_alloc_ftr {
167 } __attribute__((packed));
169 static void *debug_malloc(size_t size, const char *file, unsigned int line)
171 struct debug_alloc_hdr *hdr;
172 struct debug_alloc_ftr *ftr;
173 size_t new_size = size + sizeof(*hdr) + sizeof(*ftr);
177 if (alloc_fail_proba != 0 && (random() % 100) < alloc_fail_proba)
180 hdr = malloc(new_size);
188 hdr->stacklen = backtrace(hdr->stack, COUNT_OF(hdr->stack));
189 hdr->cookie = 0x12345678;
190 TAILQ_INSERT_TAIL(&debug_alloc_hdr_list, hdr, next);
192 ftr = (struct debug_alloc_ftr *)(
193 (char *)hdr + size + sizeof(*hdr));
194 ftr->cookie = 0x87654321;
197 ec_log(EC_LOG_DEBUG, "%s:%d: info: malloc(%zd) -> %p\n",
198 file, line, size, ret);
203 static void debug_free(void *ptr, const char *file, unsigned int line)
205 struct debug_alloc_hdr *hdr, *h;
206 struct debug_alloc_ftr *ftr;
211 ec_log(EC_LOG_DEBUG, "%s:%d: info: free(%p)\n", file, line, ptr);
216 hdr = (ptr - sizeof(*hdr));
217 if (hdr->cookie != 0x12345678) {
218 ec_log(EC_LOG_ERR, "%s:%d: error: free(%p): bad start cookie\n",
223 ftr = (ptr + hdr->size);
224 if (ftr->cookie != 0x87654321) {
225 ec_log(EC_LOG_ERR, "%s:%d: error: free(%p): bad end cookie\n",
230 TAILQ_FOREACH(h, &debug_alloc_hdr_list, next) {
236 ec_log(EC_LOG_ERR, "%s:%d: error: free(%p): bad ptr\n",
241 TAILQ_REMOVE(&debug_alloc_hdr_list, hdr, next);
245 static void *debug_realloc(void *ptr, size_t size, const char *file,
248 struct debug_alloc_hdr *hdr, *h;
249 struct debug_alloc_ftr *ftr;
250 size_t new_size = size + sizeof(*hdr) + sizeof(unsigned int);
254 hdr = (ptr - sizeof(*hdr));
255 if (hdr->cookie != 0x12345678) {
257 "%s:%d: error: realloc(%p): bad start cookie\n",
262 ftr = (ptr + hdr->size);
263 if (ftr->cookie != 0x87654321) {
265 "%s:%d: error: realloc(%p): bad end cookie\n",
270 TAILQ_FOREACH(h, &debug_alloc_hdr_list, next) {
276 ec_log(EC_LOG_ERR, "%s:%d: error: realloc(%p): bad ptr\n",
281 TAILQ_REMOVE(&debug_alloc_hdr_list, h, next);
282 hdr = realloc(hdr, new_size);
284 TAILQ_INSERT_TAIL(&debug_alloc_hdr_list, h, next);
290 hdr = realloc(NULL, new_size);
301 hdr->stacklen = backtrace(hdr->stack, COUNT_OF(hdr->stack));
302 hdr->cookie = 0x12345678;
303 TAILQ_INSERT_TAIL(&debug_alloc_hdr_list, hdr, next);
304 ftr = (struct debug_alloc_ftr *)(
305 (char *)hdr + size + sizeof(*hdr));
306 ftr->cookie = 0x87654321;
309 ec_log(EC_LOG_DEBUG, "%s:%d: info: realloc(%p, %zd) -> %p\n",
310 file, line, ptr, size, ret);
315 static int debug_alloc_dump_leaks(void)
317 struct debug_alloc_hdr *hdr;
321 if (TAILQ_EMPTY(&debug_alloc_hdr_list))
324 TAILQ_FOREACH(hdr, &debug_alloc_hdr_list, next) {
326 "%s:%d: error: memory leak size=%zd ptr=%p\n",
327 hdr->file, hdr->line, hdr->size, hdr + 1);
328 buffer = backtrace_symbols(hdr->stack, hdr->stacklen);
329 if (buffer == NULL) {
330 for (i = 0; i < hdr->stacklen; i++)
331 ec_log(EC_LOG_ERR, " %p\n", hdr->stack[i]);
333 for (i = 0; i < hdr->stacklen; i++)
334 ec_log(EC_LOG_ERR, " %s\n",
335 buffer ? buffer[i] : "unknown");
341 " missing static syms, use: addr2line -f -e <prog> <addr>\n");
346 static int debug_log(unsigned int level, void *opaque, const char *str)
350 if (level > (unsigned int)log_level)
353 return printf("%s", str);
356 int main(int argc, char **argv)
360 parse_args(argc, argv);
363 ec_log_register(debug_log, NULL);
365 /* register a new malloc to track memleaks */
366 TAILQ_INIT(&debug_alloc_hdr_list);
367 if (ec_malloc_register(debug_malloc, debug_free, debug_realloc) < 0) {
368 ec_log(EC_LOG_ERR, "cannot register new malloc\n");
374 ec_malloc_unregister();
375 leaks = debug_alloc_dump_leaks();
377 if (alloc_fail_proba == 0 && ret != 0) {
378 printf("tests failed\n");
380 } else if (alloc_fail_proba != 0 && leaks != 0) {
381 printf("tests failed (memory leak)\n");
385 printf("\ntests ok\n");