git.ozlabs.org Git - ccan/blob - tools/ccanlint/tests/tests_pass_valgrind.c

   1 #include <tools/ccanlint/ccanlint.h>
   2 #include <tools/tools.h>
   3 #include <ccan/talloc/talloc.h>
   4 #include <ccan/str/str.h>
   5 #include <ccan/foreach/foreach.h>
   6 #include <ccan/grab_file/grab_file.h>
   7 #include <ccan/str_talloc/str_talloc.h>
   8 #include "tests_pass.h"
   9 #include <sys/types.h>
  10 #include <sys/stat.h>
  11 #include <fcntl.h>
  12 #include <unistd.h>
  13 #include <limits.h>
  14 #include <errno.h>
  15 #include <stdlib.h>
  16 #include <stdio.h>
  17 #include <err.h>
  18 #include <string.h>
  19 #include <ctype.h>
  20
  21 /* Note: we already test safe_mode in run_tests.c */
  22 static const char *can_run_vg(struct manifest *m)
  23 {
  24         if (!do_valgrind)
  25                 return talloc_asprintf(m, "No valgrind support");
  26         return NULL;
  27 }
  28
  29 static void do_leakcheck_vg(struct manifest *m,
  30                             unsigned int *timeleft,
  31                             struct score *score);
  32
  33 static struct ccanlint tests_pass_valgrind_noleaks = {
  34         .key = "tests_pass_valgrind_noleaks",
  35         .name = "Module's run and api tests have no memory leaks",
  36         .check = do_leakcheck_vg,
  37         .takes_options = true,
  38         .needs = "tests_pass_valgrind"
  39 };
  40 REGISTER_TEST(tests_pass_valgrind_noleaks);
  41
  42
  43 /* Example output:
  44 ==2749== Conditional jump or move depends on uninitialised value(s)
  45 ==2749==    at 0x4026C60: strnlen (mc_replace_strmem.c:263)
  46 ==2749==    by 0x40850E3: vfprintf (vfprintf.c:1614)
  47 ==2749==    by 0x408EACF: printf (printf.c:35)
  48 ==2749==    by 0x8048465: main (in /tmp/foo)
  49 ==2749==
  50 ==2749== 1 bytes in 1 blocks are definitely lost in loss record 1 of 1
  51 ==2749==    at 0x4025BD3: malloc (vg_replace_malloc.c:236)
  52 ==2749==    by 0x8048444: main (in /tmp/foo)
  53 ==2749==
  54 */
  55
  56 static bool blank_line(const char *line)
  57 {
  58         return line[strspn(line, "=0123456789 ")] == '\0';
  59 }
  60
  61 /* Removes matching lines from lines array, returns them.  FIXME: Hacky. */
  62 static char **extract_matching(const char *prefix, char *lines[])
  63 {
  64         unsigned int i, num_ret = 0;
  65         char **ret = talloc_array(lines, char *, talloc_array_length(lines));
  66
  67         for (i = 0; i < talloc_array_length(lines) - 1; i++) {
  68                 if (strstarts(lines[i], prefix)) {
  69                         ret[num_ret++] = talloc_steal(ret, lines[i]);
  70                         lines[i] = (char *)"";
  71                 }
  72         }
  73         ret[num_ret++] = NULL;
  74
  75         /* Make sure length is correct! */
  76         return talloc_realloc(NULL, ret, char *, num_ret);
  77 }
  78
  79 static char *get_leaks(char *lines[], char **errs)
  80 {
  81         char *leaks = talloc_strdup(lines, "");
  82         unsigned int i;
  83
  84         for (i = 0; i < talloc_array_length(lines) - 1; i++) {
  85                 if (strstr(lines[i], " lost ")) {
  86                         /* A leak... */
  87                         if (strstr(lines[i], " definitely lost ")) {
  88                                 /* Definite leak, report. */
  89                                 while (lines[i] && !blank_line(lines[i])) {
  90                                         leaks = talloc_append_string(leaks,
  91                                                                      lines[i]);
  92                                         leaks = talloc_append_string(leaks,
  93                                                                      "\n");
  94                                         i++;
  95                                 }
  96                         } else
  97                                 /* Not definite, ignore. */
  98                                 while (lines[i] && !blank_line(lines[i]))
  99                                         i++;
 100                 } else {
 101                         /* A real error. */
 102                         while (lines[i] && !blank_line(lines[i])) {
 103                                 *errs = talloc_append_string(*errs, lines[i]);
 104                                 *errs = talloc_append_string(*errs, "\n");
 105                                 i++;
 106                         }
 107                 }
 108         }
 109         return leaks;
 110 }
 111
 112 /* Returns leaks, and sets errs[] */
 113 static char *analyze_output(const char *output, char **errs)
 114 {
 115         char *leaks = talloc_strdup(output, "");
 116         unsigned int i;
 117         char **lines = strsplit(output, output, "\n");
 118
 119         *errs = talloc_strdup(output, "");
 120         for (i = 0; i < talloc_array_length(lines) - 1; i++) {
 121                 unsigned int preflen = strspn(lines[i], "=0123456789");
 122                 char *prefix, **sublines;
 123
 124                 /* Ignore erased lines, or weird stuff. */
 125                 if (preflen == 0)
 126                         continue;
 127
 128                 prefix = talloc_strndup(output, lines[i], preflen);
 129                 sublines = extract_matching(prefix, lines);
 130
 131                 leaks = talloc_append_string(leaks, get_leaks(sublines, errs));
 132         }
 133
 134         if (!leaks[0]) {
 135                 talloc_free(leaks);
 136                 leaks = NULL;
 137         }
 138         if (!(*errs)[0]) {
 139                 talloc_free(*errs);
 140                 *errs = NULL;
 141         }
 142         return leaks;
 143 }
 144
 145 static const char *concat(struct score *score, char *bits[])
 146 {
 147         unsigned int i;
 148         char *ret = talloc_strdup(score, "");
 149
 150         for (i = 0; bits[i]; i++) {
 151                 if (i)
 152                         ret = talloc_append_string(ret, " ");
 153                 ret = talloc_append_string(ret, bits[i]);
 154         }
 155         return ret;
 156 }
 157
 158 /* FIXME: Run examples, too! */
 159 static void do_run_tests_vg(struct manifest *m,
 160                             unsigned int *timeleft,
 161                             struct score *score)
 162 {
 163         struct ccan_file *i;
 164         struct list_head *list;
 165
 166         /* This is slow, so we run once but grab leak info. */
 167         score->total = 0;
 168         score->pass = true;
 169         foreach_ptr(list, &m->run_tests, &m->api_tests) {
 170                 list_for_each(list, i, list) {
 171                         char *err, *output;
 172                         const char *options;
 173
 174                         score->total++;
 175                         options = concat(score,
 176                                          per_file_options(&tests_pass_valgrind,
 177                                                           i));
 178                         if (streq(options, "FAIL")) {
 179                                 i->leak_info = NULL;
 180                                 continue;
 181                         }
 182
 183                         output = grab_file(i, i->valgrind_log, NULL);
 184                         /* No valgrind errors? */
 185                         if (!output || output[0] == '\0') {
 186                                 err = NULL;
 187                                 i->leak_info = NULL;
 188                         } else {
 189                                 i->leak_info = analyze_output(output, &err);
 190                         }
 191                         if (err) {
 192                                 score_file_error(score, i, 0, "%s", err);
 193                                 score->pass = false;
 194                         } else
 195                                 score->score++;
 196                 }
 197         }
 198 }
 199
 200 static void do_leakcheck_vg(struct manifest *m,
 201                             unsigned int *timeleft,
 202                             struct score *score)
 203 {
 204         struct ccan_file *i;
 205         struct list_head *list;
 206         char **options;
 207         bool leaks = false;
 208
 209         foreach_ptr(list, &m->run_tests, &m->api_tests) {
 210                 list_for_each(list, i, list) {
 211                         options = per_file_options(&tests_pass_valgrind_noleaks,
 212                                                    i);
 213                         if (options[0]) {
 214                                 if (streq(options[0], "FAIL")) {
 215                                         leaks = true;
 216                                         continue;
 217                                 }
 218                                 errx(1, "Unknown leakcheck options '%s'",
 219                                      options[0]);
 220                         }
 221
 222                         if (i->leak_info) {
 223                                 score_file_error(score, i, 0, "%s",
 224                                                  i->leak_info);
 225                                 leaks = true;
 226                         }
 227                 }
 228         }
 229
 230         /* FIXME: We don't fail for this, since many tests leak. */
 231         score->pass = true;
 232         if (!leaks) {
 233                 score->score = 1;
 234         }
 235 }
 236
 237 /* Gcc's warn_unused_result is fascist bullshit. */
 238 #define doesnt_matter()
 239
 240 static void run_under_debugger_vg(struct manifest *m, struct score *score)
 241 {
 242         struct file_error *first;
 243         char *command;
 244
 245         /* Don't ask anything if they suppressed tests. */
 246         if (score->pass)
 247                 return;
 248
 249         if (!ask("Should I run the first failing test under the debugger?"))
 250                 return;
 251
 252         first = list_top(&score->per_file_errors, struct file_error, list);
 253         command = talloc_asprintf(m, "valgrind --leak-check=full --db-attach=yes%s %s",
 254                                   concat(score,
 255                                          per_file_options(&tests_pass_valgrind,
 256                                                           first->file)),
 257                                   first->file->compiled[COMPILE_NORMAL]);
 258         if (system(command))
 259                 doesnt_matter();
 260 }
 261
 262 struct ccanlint tests_pass_valgrind = {
 263         .key = "tests_pass_valgrind",
 264         .name = "Module's run and api tests succeed under valgrind",
 265         .can_run = can_run_vg,
 266         .check = do_run_tests_vg,
 267         .handle = run_under_debugger_vg,
 268         .takes_options = true,
 269         .needs = "tests_pass"
 270 };
 271 REGISTER_TEST(tests_pass_valgrind);