X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.c;h=237e412817d8f99ff44d9e68afeed050365d89b6;hp=d31ef94058f6d63b0030f5e85c6e971edbc60189;hb=d1827b423b5d30c8ecb184a3186d95d9f134f806;hpb=af5b1a18948345c5f9f9abf4eda3ab9fe0aa9a9f diff --git a/tools/ccanlint/ccanlint.c b/tools/ccanlint/ccanlint.c index d31ef940..237e4128 100644 --- a/tools/ccanlint/ccanlint.c +++ b/tools/ccanlint/ccanlint.c @@ -19,6 +19,7 @@ */ #include "ccanlint.h" #include "../tools.h" +#include "../read_config_header.h" #include #include #include @@ -26,32 +27,29 @@ #include #include #include -#include -#include +#include #include #include -#include #include #include +#include #include -struct ccanlint_map { - STRMAP_MEMBERS(struct ccanlint *); -}; +typedef STRMAP(struct ccanlint *) ccanlint_map_t; int verbose = 0; -static struct ccanlint_map tests; +static ccanlint_map_t tests; bool safe_mode = false; bool keep_results = false; +bool non_ccan_deps = false; +bool build_failed = false; static bool targeting = false; static unsigned int timeout; -/* These are overridden at runtime if we can find config.h */ -const char *compiler = NULL; -const char *cflags = NULL; - const char *config_header; +const char *ccan_dir; + #if 0 static void indent_print(const char *string) { @@ -86,20 +84,21 @@ static bool skip_test(struct dgraph_node *node, const char *why) return true; } -static const char *dep_failed(struct manifest *m) +static const char *dep_failed(struct manifest *m UNNEEDED) { return "dependency couldn't run"; } -static bool cannot_run(struct dgraph_node *node, void *unused) +static bool cannot_run(struct dgraph_node *node, void *all UNNEEDED) { struct ccanlint *c = container_of(node, struct ccanlint, node); c->can_run = dep_failed; + return true; } struct run_info { - bool quiet; + bool noninteractive; unsigned int score, total; struct manifest *m; const char *prefix; @@ -115,7 +114,7 @@ static bool run_test(struct dgraph_node *n, struct run_info *run) if (i->done) return true; - score = talloc(run->m, struct score); + score = tal(run->m, struct score); list_head_init(&score->per_file_errors); score->error = NULL; score->pass = false; @@ -166,7 +165,7 @@ static bool run_test(struct dgraph_node *n, struct run_info *run) } assert(score->score <= score->total); - if ((!score->pass && !run->quiet) + if (!score->pass || (score->score < score->total && verbose) || verbose > 1) { printf("%s%s (%s): %s", @@ -177,13 +176,13 @@ static bool run_test(struct dgraph_node *n, struct run_info *run) printf("\n"); } - if ((!run->quiet && !score->pass) || verbose) { + if (!score->pass || verbose) { if (score->error) { printf("%s%s", score->error, strends(score->error, "\n") ? "" : "\n"); } } - if (!run->quiet && score->score < score->total && i->handle) + if (!run->noninteractive && score->score < score->total && i->handle) i->handle(run->m, score); if (!score->pass) { @@ -211,12 +210,12 @@ static void register_test(struct ccanlint *test) { if (!strmap_add(&tests, test->key, test)) err(1, "Adding test %s", test->key); - test->options = talloc_array(NULL, char *, 1); + test->options = tal_arr(NULL, char *, 1); test->options[0] = NULL; dgraph_init_node(&test->node); } -static bool get_test(const char *member, struct ccanlint *i, +static bool get_test(const char *member UNNEEDED, struct ccanlint *i, struct ccanlint **ret) { if (tlist_empty(&i->node.edge[DGRAPH_TO])) { @@ -253,9 +252,10 @@ bool is_excluded(const char *name) return find_test(name)->skip != NULL; } -static bool init_deps(const char *member, struct ccanlint *c, void *unused) +static bool init_deps(const char *member UNNEEDED, + struct ccanlint *c, void *unused UNNEEDED) { - char **deps = strsplit(NULL, c->needs, " "); + char **deps = tal_strsplit(NULL, c->needs, " ", STR_EMPTY_OK); unsigned int i; for (i = 0; deps[i]; i++) { @@ -267,31 +267,30 @@ static bool init_deps(const char *member, struct ccanlint *c, void *unused) deps[i], c->key); dgraph_add_edge(&dep->node, &c->node); } - talloc_free(deps); + tal_free(deps); return true; } -static bool check_names(const char *member, struct ccanlint *c, - struct ccanlint_map *names) +static bool check_names(const char *member UNNEEDED, struct ccanlint *c, + ccanlint_map_t *names) { if (!strmap_add(names, c->name, c)) err(1, "Duplicate name %s", c->name); return true; } -#undef REGISTER_TEST -#define REGISTER_TEST(name, ...) extern struct ccanlint name -#include "generated-testlist" - static void init_tests(void) { - struct ccanlint_map names; + ccanlint_map_t names; + struct ccanlint **table; + size_t i, num; strmap_init(&tests); -#undef REGISTER_TEST -#define REGISTER_TEST(name) register_test(&name) -#include "generated-testlist" + table = autodata_get(ccanlint_tests, &num); + for (i = 0; i < num; i++) + register_test(table[i]); + autodata_free(table); strmap_iterate(&tests, init_deps, NULL); @@ -301,7 +300,7 @@ static void init_tests(void) strmap_clear(&names); } -static bool reset_test(struct dgraph_node *node, void *unused) +static bool reset_test(struct dgraph_node *node, void *unused UNNEEDED) { struct ccanlint *c = container_of(node, struct ccanlint, node); c->skip = NULL; @@ -314,7 +313,8 @@ static void reset_tests(struct dgraph_node *all) dgraph_traverse_to(all, reset_test, NULL); } -static bool print_deps(const char *member, struct ccanlint *c, void *unused) +static bool print_deps(const char *member UNNEEDED, + struct ccanlint *c, void *unused UNNEEDED) { if (!tlist_empty(&c->node.edge[DGRAPH_FROM])) { struct dgraph_edge *e; @@ -338,18 +338,18 @@ static void print_test_depends(void) } -static int show_tmpdir(const char *dir) +static void show_tmpdir(const char *dir) { printf("You can find ccanlint working files in '%s'\n", dir); - return 0; } -static char *keep_tests(void *unused) +static char *keep_tests(void *unused UNNEEDED) { keep_results = true; /* Don't automatically destroy temporary dir. */ - talloc_set_destructor(temp_dir(NULL), show_tmpdir); + keep_temp_dir(); + tal_add_destructor(temp_dir(), show_tmpdir); return NULL; } @@ -361,12 +361,11 @@ static bool remove_test(struct dgraph_node *node, const char *why) return true; } -static char *exclude_test(const char *testname, void *unused) +static char *exclude_test(const char *testname, void *unused UNNEEDED) { struct ccanlint *i = find_test(testname); if (!i) - return talloc_asprintf(NULL, "No test %s to --exclude", - testname); + return tal_fmt(NULL, "No test %s to --exclude", testname); /* Remove this, and everything which depends on it. */ dgraph_traverse_from(&i->node, remove_test, "excluded on command line"); @@ -381,7 +380,7 @@ static void skip_test_and_deps(struct ccanlint *c, const char *why) skip_test(&c->node, why); } -static char *list_tests(void *arg) +static char *list_tests(void *arg UNNEEDED) { struct ccanlint *i; @@ -395,7 +394,8 @@ static char *list_tests(void *arg) exit(0); } -static bool draw_test(const char *member, struct ccanlint *c, const char *style) +static bool draw_test(const char *member UNNEEDED, + struct ccanlint *c, const char *style) { /* * todo: escape labels in case ccanlint test keys have @@ -410,7 +410,8 @@ static void test_dgraph_vertices(const char *style) strmap_iterate(&tests, draw_test, style); } -static bool draw_edges(const char *member, struct ccanlint *c, void *unused) +static bool draw_edges(const char *member UNNEEDED, + struct ccanlint *c, void *unused UNNEEDED) { struct dgraph_edge *e; @@ -428,7 +429,7 @@ static void test_dgraph_edges(void) strmap_iterate(&tests, draw_edges, NULL); } -static char *test_dependency_graph(void *arg) +static char *test_dependency_graph(void *arg UNNEEDED) { puts("digraph G {"); @@ -440,21 +441,6 @@ static char *test_dependency_graph(void *arg) exit(0); } -/* Remove empty lines. */ -static char **collapse(char **lines, unsigned int *nump) -{ - unsigned int i, j; - for (i = j = 0; lines[i]; i++) { - if (lines[i][0]) - lines[j++] = lines[i]; - } - lines[j] = NULL; - if (nump) - *nump = j; - return lines; -} - - static void add_options(struct ccanlint *test, char **options, unsigned int num_options) { @@ -464,59 +450,49 @@ static void add_options(struct ccanlint *test, char **options, num = 0; else /* -1, because last one is NULL. */ - num = talloc_array_length(test->options) - 1; + num = tal_count(test->options) - 1; - test->options = talloc_realloc(NULL, test->options, - char *, - num + num_options + 1); + tal_resize(&test->options, num + num_options + 1); memcpy(&test->options[num], options, (num_options + 1)*sizeof(char *)); } -void add_info_options(struct ccan_file *info) +void add_info_options(struct manifest *m) { - struct doc_section *d; unsigned int i; - struct ccanlint *test; + char **info_options = get_ccanlint(m, m->dir, get_or_compile_info); + + for (i = 0; info_options[i]; i++) { + char **words = tal_strsplit(m, info_options[i], " \t", + STR_NO_EMPTY); + struct ccanlint *test; + + if (!words[0]) + continue; - list_for_each(get_ccan_file_docs(info), d, list) { - if (!streq(d->type, "ccanlint")) + test = find_test(words[0]); + if (!test) { + warnx("%s: unknown ccanlint test '%s'", + m->info_file->fullname, words[0]); continue; + } + + if (!words[1]) { + warnx("%s: no argument to test '%s'", + m->info_file->fullname, words[0]); + continue; + } - for (i = 0; i < d->num_lines; i++) { - unsigned int num_words; - char **words = collapse(strsplit(d, d->lines[i], " \t"), - &num_words); - if (num_words == 0) - continue; - - if (strncmp(words[0], "//", 2) == 0) - continue; - - test = find_test(words[0]); - if (!test) { - warnx("%s: unknown ccanlint test '%s'", - info->fullname, words[0]); - continue; - } - - if (!words[1]) { - warnx("%s: no argument to test '%s'", - info->fullname, words[0]); - continue; - } - - /* Known failure? */ - if (strcasecmp(words[1], "FAIL") == 0) { - if (!targeting) - skip_test_and_deps(test, - "excluded in _info" - " file"); - } else { - if (!test->takes_options) - warnx("%s: %s doesn't take options", - info->fullname, words[0]); - add_options(test, words+1, num_words-1); - } + /* Known failure? */ + if (strcasecmp(words[1], "FAIL") == 0) { + if (!targeting) + skip_test_and_deps(test, + "excluded in _info" + " file"); + } else { + if (!test->takes_options) + warnx("%s: %s doesn't take options", + m->info_file->fullname, words[0]); + add_options(test, words+1, tal_count(words)-1); } } } @@ -531,7 +507,7 @@ char **per_file_options(const struct ccanlint *test, struct ccan_file *f) if (!test->options[0]) return test->options; - ret = talloc_array(f, char *, talloc_array_length(test->options)); + ret = tal_arr(f, char *, tal_count(test->options)); for (i = 0; test->options[i]; i++) { char *optname; @@ -545,7 +521,7 @@ char **per_file_options(const struct ccanlint *test, struct ccan_file *f) /* FAIL overrides anything else. */ if (streq(optname, "FAIL")) { - ret = talloc_array(f, char *, 2); + ret = tal_arr(f, char *, 2); ret[0] = (char *)"FAIL"; ret[1] = NULL; return ret; @@ -554,102 +530,9 @@ char **per_file_options(const struct ccanlint *test, struct ccan_file *f) } ret[j] = NULL; - /* Shrink it to size so talloc_array_length() works as expected. */ - return talloc_realloc(NULL, ret, char *, j + 1); -} - -static char *demangle_string(char *string) -{ - unsigned int i; - const char mapfrom[] = "abfnrtv"; - const char mapto[] = "\a\b\f\n\r\t\v"; - - if (!strchr(string, '"')) - return NULL; - string = strchr(string, '"') + 1; - if (!strrchr(string, '"')) - return NULL; - *strrchr(string, '"') = '\0'; - - for (i = 0; i < strlen(string); i++) { - if (string[i] == '\\') { - char repl; - unsigned len = 0; - const char *p = strchr(mapfrom, string[i+1]); - if (p) { - repl = mapto[p - mapfrom]; - len = 1; - } else if (strlen(string+i+1) >= 3) { - if (string[i+1] == 'x') { - repl = (string[i+2]-'0')*16 - + string[i+3]-'0'; - len = 3; - } else if (cisdigit(string[i+1])) { - repl = (string[i+2]-'0')*8*8 - + (string[i+3]-'0')*8 - + (string[i+4]-'0'); - len = 3; - } - } - if (len == 0) { - repl = string[i+1]; - len = 1; - } - - string[i] = repl; - memmove(string + i + 1, string + i + len + 1, - strlen(string + i + len + 1) + 1); - } - } - - return string; -} - - -static void read_config_header(void) -{ - char *fname = talloc_asprintf(NULL, "%s/config.h", ccan_dir); - char **lines; - unsigned int i; - - config_header = grab_file(NULL, fname, NULL); - if (!config_header) { - talloc_free(fname); - return; - } - - lines = strsplit(config_header, config_header, "\n"); - for (i = 0; i < talloc_array_length(lines) - 1; i++) { - char *sym; - const char **line = (const char **)&lines[i]; - - if (!get_token(line, "#")) - continue; - if (!get_token(line, "define")) - continue; - sym = get_symbol_token(lines, line); - if (streq(sym, "CCAN_COMPILER") && !compiler) { - compiler = demangle_string(lines[i]); - if (!compiler) - errx(1, "%s:%u:could not parse CCAN_COMPILER", - fname, i+1); - if (verbose > 1) - printf("%s: compiler set to '%s'\n", - fname, compiler); - } else if (streq(sym, "CCAN_CFLAGS") && !cflags) { - cflags = demangle_string(lines[i]); - if (!cflags) - errx(1, "%s:%u:could not parse CCAN_CFLAGS", - fname, i+1); - if (verbose > 1) - printf("%s: compiler flags set to '%s'\n", - fname, cflags); - } - } - if (!compiler) - compiler = CCAN_COMPILER; - if (!cflags) - compiler = CCAN_CFLAGS; + /* Shrink it to size so tal_array_length() works as expected. */ + tal_resize(&ret, j + 1); + return ret; } static char *opt_set_const_charp(const char *arg, const char **p) @@ -661,7 +544,7 @@ static char *opt_set_target(const char *arg, struct dgraph_node *all) { struct ccanlint *t = find_test(arg); if (!t) - return talloc_asprintf(NULL, "unknown --target %s", arg); + return tal_fmt(NULL, "unknown --target %s", arg); targeting = true; dgraph_add_edge(&t->node, all); @@ -670,41 +553,73 @@ static char *opt_set_target(const char *arg, struct dgraph_node *all) static bool run_tests(struct dgraph_node *all, bool summary, + bool deps_fail_ignore, struct manifest *m, const char *prefix) { struct run_info run; + const char *comment = ""; - run.quiet = summary; + run.noninteractive = summary; run.m = m; run.prefix = prefix; run.score = run.total = 0; run.pass = true; + non_ccan_deps = build_failed = false; + dgraph_traverse_to(all, run_test, &run); - printf("%sTotal score: %u/%u\n", prefix, run.score, run.total); + /* We can completely fail if we're missing external stuff: ignore */ + if (deps_fail_ignore && non_ccan_deps && build_failed) { + comment = " (missing non-ccan dependencies?)"; + run.pass = true; + } else if (!run.pass) { + comment = " FAIL!"; + } + printf("%sTotal score: %u/%u%s\n", + prefix, run.score, run.total, comment); + return run.pass; } -static bool add_to_all(const char *member, struct ccanlint *c, +static bool add_to_all(const char *member UNNEEDED, struct ccanlint *c, struct dgraph_node *all) { - dgraph_add_edge(&c->node, all); + /* If we're excluded on cmdline, don't add. */ + if (!c->skip) + dgraph_add_edge(&c->node, all); return true; } +static bool test_module(struct dgraph_node *all, + const char *dir, const char *prefix, bool summary, + bool deps_fail_ignore) +{ + struct manifest *m = get_manifest(autofree(), dir); + char *testlink = path_join(NULL, temp_dir(), "test"); + + /* Create a symlink from temp dir back to src dir's + * test directory. */ + unlink(testlink); + if (symlink(path_join(m, dir, "test"), testlink) != 0) + err(1, "Creating test symlink in %s", temp_dir()); + + return run_tests(all, summary, deps_fail_ignore, m, prefix); +} + int main(int argc, char *argv[]) { - bool summary = false, pass = true; - unsigned int i; - struct manifest *m; + bool summary = false, pass = true, deps_fail_ignore = false; + int i; const char *prefix = ""; - char *dir = talloc_getcwd(NULL), *base_dir = dir, *testlink; - struct dgraph_node all; + char *cwd = path_cwd(NULL), *dir; + struct ccanlint top; /* cannot_run may try to set ->can_run */ + const char *override_compiler = NULL, *override_cflags = NULL; + const char *override_gcov = NULL; /* Empty graph node to which we attach everything else. */ - dgraph_init_node(&all); + dgraph_init_node(&top.node); opt_register_early_noarg("--verbose|-v", opt_inc_intval, &verbose, "verbose mode (up to -vvvv)"); @@ -717,18 +632,24 @@ int main(int argc, char *argv[]) opt_register_noarg("-k|--keep", keep_tests, NULL, "do not delete ccanlint working files"); opt_register_noarg("--summary|-s", opt_set_bool, &summary, - "simply give one line summary"); + "give results only, no interactive correction"); opt_register_arg("-x|--exclude ", exclude_test, NULL, NULL, "exclude (can be used multiple times)"); opt_register_arg("--timeout ", opt_set_uintval, NULL, &timeout, "ignore (terminate) tests that are slower than this"); - opt_register_arg("-t|--target ", opt_set_target, NULL, &all, + opt_register_arg("-t|--target ", opt_set_target, NULL, + &top.node, "only run one test (and its prerequisites)"); opt_register_arg("--compiler ", opt_set_const_charp, - NULL, &compiler, "set the compiler"); + NULL, &override_compiler, "set the compiler"); opt_register_arg("--cflags ", opt_set_const_charp, - NULL, &cflags, "set the compiler flags"); + NULL, &override_cflags, "set the compiler flags"); + opt_register_arg("--gcov ", opt_set_const_charp, + NULL, &override_gcov, "set the coverage tool"); + opt_register_noarg("--deps-fail-ignore", opt_set_bool, + &deps_fail_ignore, + "don't fail if external dependencies are missing"); opt_register_noarg("-?|-h|--help", opt_usage_and_exit, "\nA program for checking and guiding development" " of CCAN modules.", @@ -738,8 +659,8 @@ int main(int argc, char *argv[]) opt_early_parse(argc, argv, opt_log_stderr_exit); /* We move into temporary directory, so gcov dumps its files there. */ - if (chdir(temp_dir(talloc_autofree_context())) != 0) - err(1, "Error changing to %s temporary dir", temp_dir(NULL)); + if (chdir(temp_dir()) != 0) + err(1, "Error changing to %s temporary dir", temp_dir()); init_tests(); @@ -753,50 +674,45 @@ int main(int argc, char *argv[]) opt_parse(&argc, argv, opt_log_stderr_exit); if (!targeting) - strmap_iterate(&tests, add_to_all, &all); - - /* This links back to the module's test dir. */ - testlink = talloc_asprintf(NULL, "%s/test", temp_dir(NULL)); - - /* Defaults to pwd. */ - if (argc == 1) { - i = 1; - goto got_dir; - } - - for (i = 1; i < argc; i++) { - unsigned int score, total_score; - - dir = argv[i]; + strmap_iterate(&tests, add_to_all, &top.node); - if (dir[0] != '/') - dir = talloc_asprintf_append(NULL, "%s/%s", - base_dir, dir); - while (strends(dir, "/")) - dir[strlen(dir)-1] = '\0'; - - got_dir: - if (dir != base_dir) - prefix = talloc_append_string(talloc_basename(NULL,dir), - ": "); - - m = get_manifest(talloc_autofree_context(), dir); - - /* FIXME: This has to come after we've got manifest. */ - if (i == 1) - read_config_header(); - - /* Create a symlink from temp dir back to src dir's - * test directory. */ - unlink(testlink); - if (symlink(talloc_asprintf(m, "%s/test", dir), testlink) != 0) - err(1, "Creating test symlink in %s", temp_dir(NULL)); - - score = total_score = 0; - if (!run_tests(&all, summary, m, prefix)) - pass = false; - - reset_tests(&all); + if (argc == 1) + dir = cwd; + else + dir = path_simplify(NULL, take(path_join(NULL, cwd, argv[1]))); + + ccan_dir = find_ccan_dir(dir); + if (!ccan_dir) + errx(1, "Cannot find ccan/ base directory in %s", dir); + config_header = read_config_header(ccan_dir, verbose > 1); + + /* We do this after read_config_header has set compiler & cflags */ + if (override_cflags) + cflags = override_cflags; + if (override_compiler) + compiler = override_compiler; + if (override_gcov) + gcov = override_gcov; + + if (argc == 1) + pass = test_module(&top.node, cwd, "", + summary, deps_fail_ignore); + else { + for (i = 1; i < argc; i++) { + dir = path_canon(NULL, + take(path_join(NULL, cwd, argv[i]))); + if (!dir) + err(1, "Cannot get canonical name of '%s'", + argv[i]); + + prefix = path_join(NULL, ccan_dir, "ccan"); + prefix = path_rel(NULL, take(prefix), dir); + prefix = tal_strcat(NULL, take(prefix), ": "); + + pass &= test_module(&top.node, dir, prefix, summary, + deps_fail_ignore); + reset_tests(&top.node); + } } return pass ? 0 : 1; }