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.
36 #include <ecoli_init.h>
37 #include <ecoli_log.h>
38 #include <ecoli_test.h>
39 #include <ecoli_malloc.h>
41 EC_LOG_TYPE_REGISTER(main);
43 #define COUNT_OF(x) ((sizeof(x)/sizeof(0[x])) / \
44 ((size_t)(!(sizeof(x) % sizeof(0[x])))))
46 static int log_level = EC_LOG_INFO;
47 static int alloc_fail_proba = 0;
49 static size_t alloc_success = 0;
51 static const char ec_short_options[] =
54 "r:" /* random-alloc-fail */
58 #define EC_OPT_HELP "help"
59 #define EC_OPT_LOG_LEVEL "log-level"
60 #define EC_OPT_RANDOM_ALLOC_FAIL "random-alloc-fail"
61 #define EC_OPT_SEED "seed"
63 static const struct option ec_long_options[] = {
64 {EC_OPT_HELP, 1, NULL, 'h'},
65 {EC_OPT_LOG_LEVEL, 1, NULL, 'l'},
66 {EC_OPT_RANDOM_ALLOC_FAIL, 1, NULL, 'r'},
67 {EC_OPT_SEED, 1, NULL, 's'},
71 static void usage(const char *prgname)
73 printf("%s [options] [test1 test2 test3...]\n"
78 " --"EC_OPT_LOG_LEVEL"=<level>\n"
79 " Set log level (0 = no log, 7 = verbose).\n"
81 " --"EC_OPT_RANDOM_ALLOC_FAIL"=<probability>\n"
82 " Cause malloc to fail randomly. This helps to debug\n"
83 " leaks or crashes in error cases. The probability is\n"
84 " between 0 and 100.\n"
87 " Seeds the random number generator. Default is 0.\n"
92 parse_int(const char *s, int min, int max, int *ret, unsigned int base)
97 n = strtoll(s, &end, base);
98 if ((s[0] == '\0') || (end == NULL) || (*end != '\0'))
109 static int parse_args(int argc, char **argv)
113 while ((opt = getopt_long(argc, argv, ec_short_options,
114 ec_long_options, NULL)) != EOF) {
121 case 'l': /* log-level */
122 if (parse_int(optarg, EC_LOG_EMERG,
123 EC_LOG_DEBUG, &log_level, 10) < 0) {
124 printf("Invalid log value\n");
130 case 'r': /* random-alloc-fail */
131 if (parse_int(optarg, 0, 100, &alloc_fail_proba,
133 printf("Invalid probability value\n");
140 if (parse_int(optarg, 0, INT_MAX, &seed, 10) < 0) {
141 printf("Invalid seed value\n");
159 TAILQ_HEAD(debug_alloc_hdr_list, debug_alloc_hdr);
160 static struct debug_alloc_hdr_list debug_alloc_hdr_list =
161 TAILQ_HEAD_INITIALIZER(debug_alloc_hdr_list);
164 struct debug_alloc_hdr {
165 TAILQ_ENTRY(debug_alloc_hdr) next;
169 void *stack[STACK_SZ];
174 struct debug_alloc_ftr {
176 } __attribute__((packed));
178 static void *debug_malloc(size_t size, const char *file, unsigned int line)
180 struct debug_alloc_hdr *hdr;
181 struct debug_alloc_ftr *ftr;
182 size_t new_size = size + sizeof(*hdr) + sizeof(*ftr);
186 if (alloc_fail_proba != 0 && (random() % 100) < alloc_fail_proba)
189 hdr = malloc(new_size);
197 hdr->stacklen = backtrace(hdr->stack, COUNT_OF(hdr->stack));
198 hdr->cookie = 0x12345678;
199 TAILQ_INSERT_TAIL(&debug_alloc_hdr_list, hdr, next);
201 ftr = (struct debug_alloc_ftr *)(
202 (char *)hdr + size + sizeof(*hdr));
203 ftr->cookie = 0x87654321;
206 EC_LOG(EC_LOG_DEBUG, "%s:%d: info: malloc(%zd) -> %p\n",
207 file, line, size, ret);
214 static void debug_free(void *ptr, const char *file, unsigned int line)
216 struct debug_alloc_hdr *hdr, *h;
217 struct debug_alloc_ftr *ftr;
222 EC_LOG(EC_LOG_DEBUG, "%s:%d: info: free(%p)\n", file, line, ptr);
227 hdr = (ptr - sizeof(*hdr));
228 if (hdr->cookie != 0x12345678) {
229 EC_LOG(EC_LOG_ERR, "%s:%d: error: free(%p): bad start cookie\n",
234 ftr = (ptr + hdr->size);
235 if (ftr->cookie != 0x87654321) {
236 EC_LOG(EC_LOG_ERR, "%s:%d: error: free(%p): bad end cookie\n",
241 TAILQ_FOREACH(h, &debug_alloc_hdr_list, next) {
247 EC_LOG(EC_LOG_ERR, "%s:%d: error: free(%p): bad ptr\n",
252 TAILQ_REMOVE(&debug_alloc_hdr_list, hdr, next);
256 static void *debug_realloc(void *ptr, size_t size, const char *file,
259 struct debug_alloc_hdr *hdr, *h;
260 struct debug_alloc_ftr *ftr;
261 size_t new_size = size + sizeof(*hdr) + sizeof(unsigned int);
265 hdr = (ptr - sizeof(*hdr));
266 if (hdr->cookie != 0x12345678) {
268 "%s:%d: error: realloc(%p): bad start cookie\n",
273 ftr = (ptr + hdr->size);
274 if (ftr->cookie != 0x87654321) {
276 "%s:%d: error: realloc(%p): bad end cookie\n",
281 TAILQ_FOREACH(h, &debug_alloc_hdr_list, next) {
287 EC_LOG(EC_LOG_ERR, "%s:%d: error: realloc(%p): bad ptr\n",
292 TAILQ_REMOVE(&debug_alloc_hdr_list, h, next);
293 hdr = realloc(hdr, new_size);
295 TAILQ_INSERT_TAIL(&debug_alloc_hdr_list, h, next);
301 hdr = realloc(NULL, new_size);
312 hdr->stacklen = backtrace(hdr->stack, COUNT_OF(hdr->stack));
313 hdr->cookie = 0x12345678;
314 TAILQ_INSERT_TAIL(&debug_alloc_hdr_list, hdr, next);
315 ftr = (struct debug_alloc_ftr *)(
316 (char *)hdr + size + sizeof(*hdr));
317 ftr->cookie = 0x87654321;
320 EC_LOG(EC_LOG_DEBUG, "%s:%d: info: realloc(%p, %zd) -> %p\n",
321 file, line, ptr, size, ret);
328 static int debug_alloc_dump_leaks(void)
330 struct debug_alloc_hdr *hdr;
334 EC_LOG(EC_LOG_INFO, "%zd successful allocations\n", alloc_success);
336 if (TAILQ_EMPTY(&debug_alloc_hdr_list))
339 TAILQ_FOREACH(hdr, &debug_alloc_hdr_list, next) {
341 "%s:%d: error: memory leak size=%zd ptr=%p\n",
342 hdr->file, hdr->line, hdr->size, hdr + 1);
343 buffer = backtrace_symbols(hdr->stack, hdr->stacklen);
344 if (buffer == NULL) {
345 for (i = 0; i < hdr->stacklen; i++)
346 EC_LOG(EC_LOG_ERR, " %p\n", hdr->stack[i]);
348 for (i = 0; i < hdr->stacklen; i++)
349 EC_LOG(EC_LOG_ERR, " %s\n",
350 buffer ? buffer[i] : "unknown");
356 " missing static syms, use: addr2line -f -e <prog> <addr>\n");
361 static int debug_log(int type, unsigned int level, void *opaque,
367 if (level > (unsigned int)log_level)
370 if (printf("%s", str) < 0)
376 int main(int argc, char **argv)
378 int i, ret = 0, leaks;
380 ret = parse_args(argc, argv);
389 /* register a new malloc to track memleaks */
390 TAILQ_INIT(&debug_alloc_hdr_list);
391 if (ec_malloc_register(debug_malloc, debug_free, debug_realloc) < 0) {
392 EC_LOG(EC_LOG_ERR, "cannot register new malloc\n");
397 fprintf(stderr, "cannot init ecoli: %s\n", strerror(errno));
400 ec_log_fct_register(debug_log, NULL);
406 for (i = 1; i < argc; i++)
407 ret |= ec_test_one(argv[i]);
410 leaks = debug_alloc_dump_leaks();
412 if (alloc_fail_proba == 0 && ret != 0) {
413 printf("tests failed\n");
415 } else if (alloc_fail_proba != 0 && leaks != 0) {
416 printf("tests failed (memory leak)\n");
420 printf("\ntests ok\n");