X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.c;h=d31ef94058f6d63b0030f5e85c6e971edbc60189;hp=1c060ba7db6bf61147a8716e47dafe63c130d509;hb=af5b1a18948345c5f9f9abf4eda3ab9fe0aa9a9f;hpb=05b39faed2c73b317f6a7f6f59ec0e8c69e5d5bf diff --git a/tools/ccanlint/ccanlint.c b/tools/ccanlint/ccanlint.c index 1c060ba7..d31ef940 100644 --- a/tools/ccanlint/ccanlint.c +++ b/tools/ccanlint/ccanlint.c @@ -25,7 +25,6 @@ #include #include #include -#include #include #include #include @@ -33,14 +32,18 @@ #include #include #include +#include +#include + +struct ccanlint_map { + STRMAP_MEMBERS(struct ccanlint *); +}; int verbose = 0; -static LIST_HEAD(compulsory_tests); -static LIST_HEAD(normal_tests); -static LIST_HEAD(finished_tests); +static struct ccanlint_map tests; bool safe_mode = false; -static struct btree *cmdline_exclude; -static struct btree *info_exclude; +bool keep_results = false; +static bool targeting = false; static unsigned int timeout; /* These are overridden at runtime if we can find config.h */ @@ -75,328 +78,362 @@ bool ask(const char *question) && toupper(reply[0]) == 'Y'; } -static const char *should_skip(struct manifest *m, struct ccanlint *i) +/* Skip, but don't remove. */ +static bool skip_test(struct dgraph_node *node, const char *why) { - if (btree_lookup(cmdline_exclude, i->key)) - return "excluded on command line"; - - if (btree_lookup(info_exclude, i->key)) - return "excluded in _info file"; - - if (i->skip) - return i->skip; + struct ccanlint *c = container_of(node, struct ccanlint, node); + c->skip = why; + return true; +} - if (i->skip_fail) - return "dependency failed"; +static const char *dep_failed(struct manifest *m) +{ + return "dependency couldn't run"; +} - if (i->can_run) - return i->can_run(m); - return NULL; +static bool cannot_run(struct dgraph_node *node, void *unused) +{ + struct ccanlint *c = container_of(node, struct ccanlint, node); + c->can_run = dep_failed; + return true; } -static bool run_test(struct ccanlint *i, - bool quiet, - unsigned int *running_score, - unsigned int *running_total, - struct manifest *m) +struct run_info { + bool quiet; + unsigned int score, total; + struct manifest *m; + const char *prefix; + bool pass; +}; + +static bool run_test(struct dgraph_node *n, struct run_info *run) { + struct ccanlint *i = container_of(n, struct ccanlint, node); unsigned int timeleft; - const struct dependent *d; - const char *skip; struct score *score; - //one less test to run through - list_for_each(&i->dependencies, d, node) - d->dependent->num_depends--; + if (i->done) + return true; - score = talloc(m, struct score); + score = talloc(run->m, struct score); list_head_init(&score->per_file_errors); score->error = NULL; score->pass = false; score->score = 0; score->total = 1; - skip = should_skip(m, i); - - if (skip) { - skip: - if (verbose && !streq(skip, "not relevant to target")) - printf("%s: skipped (%s)\n", i->name, skip); - - /* If we're skipping this because a prereq failed, we fail: - * count it as a score of 1. */ - if (i->skip_fail) - (*running_total)++; - - list_del(&i->list); - list_add_tail(&finished_tests, &i->list); - list_for_each(&i->dependencies, d, node) { - if (d->dependent->skip) - continue; - d->dependent->skip = "dependency was skipped"; - d->dependent->skip_fail = i->skip_fail; + /* We can see skipped things in two cases: + * (1) _info excluded them (presumably because they fail). + * (2) A prerequisite failed. + */ + if (i->skip) { + if (verbose) + printf("%s%s: skipped (%s)\n", + run->prefix, i->name, i->skip); + /* Pass us up to the test which failed, not us. */ + score->pass = true; + goto out; + } + + if (i->can_run) { + i->skip = i->can_run(run->m); + if (i->skip) { + /* Test doesn't apply, or can't run? That's OK. */ + if (verbose > 1) + printf("%s%s: skipped (%s)\n", + run->prefix, i->name, i->skip); + /* Mark our dependencies to skip. */ + dgraph_traverse_from(&i->node, cannot_run, NULL); + score->pass = true; + score->total = 0; + goto out; } - return i->skip_fail ? false : true; } timeleft = timeout ? timeout : default_timeout_ms; - i->check(m, i->keep_results, &timeleft, score); + i->check(run->m, &timeleft, score); if (timeout && timeleft == 0) { - skip = "timeout"; - goto skip; + i->skip = "timeout"; + if (verbose) + printf("%s%s: skipped (%s)\n", + run->prefix, i->name, i->skip); + /* Mark our dependencies to skip. */ + dgraph_traverse_from(&i->node, skip_test, + "dependency timed out"); + score->pass = true; + score->total = 0; + goto out; } assert(score->score <= score->total); - if ((!score->pass && !quiet) + if ((!score->pass && !run->quiet) || (score->score < score->total && verbose) || verbose > 1) { - printf("%s (%s): %s", i->name, i->key, score->pass ? "PASS" : "FAIL"); + printf("%s%s (%s): %s", + run->prefix, i->name, i->key, + score->pass ? "PASS" : "FAIL"); if (score->total > 1) printf(" (+%u/%u)", score->score, score->total); printf("\n"); } - if ((!quiet && !score->pass) || verbose) { + if ((!run->quiet && !score->pass) || verbose) { if (score->error) { printf("%s%s", score->error, strends(score->error, "\n") ? "" : "\n"); } } - if (!quiet && score->score < score->total && i->handle) - i->handle(m, score); - - *running_score += score->score; - *running_total += score->total; - - list_del(&i->list); - list_add_tail(&finished_tests, &i->list); + if (!run->quiet && score->score < score->total && i->handle) + i->handle(run->m, score); if (!score->pass) { /* Skip any tests which depend on this one. */ - list_for_each(&i->dependencies, d, node) { - if (d->dependent->skip) - continue; - d->dependent->skip = "dependency failed"; - d->dependent->skip_fail = true; - } + dgraph_traverse_from(&i->node, skip_test, "dependency failed"); + } + +out: + run->score += score->score; + run->total += score->total; + + /* FIXME: Free score. */ + run->pass &= score->pass; + i->done = true; + + if (!score->pass && i->compulsory) { + warnx("%s%s failed", run->prefix, i->name); + run->score = 0; + return false; } - return score->pass; + return true; } -static void register_test(struct list_head *h, struct ccanlint *test) +static void register_test(struct ccanlint *test) { - list_add(h, &test->list); + if (!strmap_add(&tests, test->key, test)) + err(1, "Adding test %s", test->key); test->options = talloc_array(NULL, char *, 1); test->options[0] = NULL; + dgraph_init_node(&test->node); +} + +static bool get_test(const char *member, struct ccanlint *i, + struct ccanlint **ret) +{ + if (tlist_empty(&i->node.edge[DGRAPH_TO])) { + *ret = i; + return false; + } + return true; } /** * get_next_test - retrieves the next test to be processed **/ -static inline struct ccanlint *get_next_test(struct list_head *test) +static inline struct ccanlint *get_next_test(void) { - struct ccanlint *i; + struct ccanlint *i = NULL; - if (list_empty(test)) + strmap_iterate(&tests, get_test, &i); + if (i) + return i; + + if (strmap_empty(&tests)) return NULL; - list_for_each(test, i, list) { - if (i->num_depends == 0) - return i; - } errx(1, "Can't make process; test dependency cycle"); } static struct ccanlint *find_test(const char *key) { - struct ccanlint *i; + return strmap_get(&tests, key); +} + +bool is_excluded(const char *name) +{ + return find_test(name)->skip != NULL; +} - list_for_each(&compulsory_tests, i, list) - if (streq(i->key, key)) - return i; +static bool init_deps(const char *member, struct ccanlint *c, void *unused) +{ + char **deps = strsplit(NULL, c->needs, " "); + unsigned int i; - list_for_each(&normal_tests, i, list) - if (streq(i->key, key)) - return i; + for (i = 0; deps[i]; i++) { + struct ccanlint *dep; - return NULL; + dep = find_test(deps[i]); + if (!dep) + errx(1, "BUG: unknown dep '%s' for %s", + deps[i], c->key); + dgraph_add_edge(&dep->node, &c->node); + } + talloc_free(deps); + return true; +} + +static bool check_names(const char *member, struct ccanlint *c, + struct ccanlint_map *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-normal-tests" -#include "generated-compulsory-tests" +#include "generated-testlist" static void init_tests(void) { - struct ccanlint *c; - struct btree *keys, *names; - struct list_head *list; + struct ccanlint_map names; + + strmap_init(&tests); #undef REGISTER_TEST -#define REGISTER_TEST(name) register_test(&normal_tests, &name) -#include "generated-normal-tests" -#undef REGISTER_TEST -#define REGISTER_TEST(name) register_test(&compulsory_tests, &name) -#include "generated-compulsory-tests" +#define REGISTER_TEST(name) register_test(&name) +#include "generated-testlist" - /* Initialize dependency lists. */ - foreach_ptr(list, &compulsory_tests, &normal_tests) { - list_for_each(list, c, list) { - list_head_init(&c->dependencies); - } - } + strmap_iterate(&tests, init_deps, NULL); - /* Resolve dependencies. */ - foreach_ptr(list, &compulsory_tests, &normal_tests) { - list_for_each(list, c, list) { - char **deps = strsplit(NULL, c->needs, " "); - unsigned int i; - - for (i = 0; deps[i]; i++) { - struct ccanlint *dep; - struct dependent *dchild; - - dep = find_test(deps[i]); - if (!dep) - errx(1, "BUG: unknown dep '%s' for %s", - deps[i], c->key); - dchild = talloc(NULL, struct dependent); - dchild->dependent = c; - list_add_tail(&dep->dependencies, - &dchild->node); - c->num_depends++; - } - talloc_free(deps); - } - } + /* Check for duplicate names. */ + strmap_init(&names); + strmap_iterate(&tests, check_names, &names); + strmap_clear(&names); +} + +static bool reset_test(struct dgraph_node *node, void *unused) +{ + struct ccanlint *c = container_of(node, struct ccanlint, node); + c->skip = NULL; + c->done = false; + return true; +} - /* Self-consistency check: make sure no two tests - have the same key or name. */ - keys = btree_new(btree_strcmp); - names = btree_new(btree_strcmp); - foreach_ptr(list, &compulsory_tests, &normal_tests) { - list_for_each(list, c, list) { - if (!btree_insert(keys, c->key)) - errx(1, "BUG: Duplicate test key '%s'", - c->key); - if (!btree_insert(names, c->name)) - errx(1, "BUG: Duplicate test name '%s'", - c->name); +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) +{ + if (!tlist_empty(&c->node.edge[DGRAPH_FROM])) { + struct dgraph_edge *e; + + printf("These depend on %s:\n", c->key); + dgraph_for_each_edge(&c->node, e, DGRAPH_FROM) { + struct ccanlint *to = container_of(e->n[DGRAPH_TO], + struct ccanlint, + node); + printf("\t%s\n", to->key); } } - btree_delete(keys); - btree_delete(names); + return true; } static void print_test_depends(void) { - struct list_head *list; + printf("Tests:\n"); - foreach_ptr(list, &compulsory_tests, &normal_tests) { - struct ccanlint *c; - printf("\%s Tests\n", - list == &compulsory_tests ? "Compulsory" : "Normal"); - - list_for_each(list, c, list) { - if (!list_empty(&c->dependencies)) { - const struct dependent *d; - printf("These depend on %s:\n", c->key); - list_for_each(&c->dependencies, d, node) - printf("\t%s\n", d->dependent->key); - } - } - } + strmap_iterate(&tests, print_deps, NULL); } + static int show_tmpdir(const char *dir) { printf("You can find ccanlint working files in '%s'\n", dir); return 0; } -static char *keep_test(const char *testname, void *unused) +static char *keep_tests(void *unused) { - struct ccanlint *i; - - if (streq(testname, "all")) { - struct list_head *list; - foreach_ptr(list, &compulsory_tests, &normal_tests) { - list_for_each(list, i, list) - i->keep_results = true; - } - } else { - i = find_test(testname); - if (!i) - errx(1, "No test %s to --keep", testname); - i->keep_results = true; - } + keep_results = true; /* Don't automatically destroy temporary dir. */ talloc_set_destructor(temp_dir(NULL), show_tmpdir); return NULL; } -static char *skip_test(const char *testname, void *unused) +static bool remove_test(struct dgraph_node *node, const char *why) { - btree_insert(cmdline_exclude, testname); + struct ccanlint *c = container_of(node, struct ccanlint, node); + c->skip = why; + dgraph_clear_node(node); + return true; +} + +static char *exclude_test(const char *testname, void *unused) +{ + struct ccanlint *i = find_test(testname); + if (!i) + return talloc_asprintf(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"); + remove_test(&i->node, "excluded on command line"); return NULL; } -static void print_tests(struct list_head *tests, const char *type) +static void skip_test_and_deps(struct ccanlint *c, const char *why) +{ + /* Skip this, and everything which depends on us. */ + dgraph_traverse_from(&c->node, skip_test, why); + skip_test(&c->node, why); +} + +static char *list_tests(void *arg) { struct ccanlint *i; - printf("%s tests:\n", type); + printf("Tests:\n"); /* This makes them print in topological order. */ - while ((i = get_next_test(tests)) != NULL) { - const struct dependent *d; + while ((i = get_next_test()) != NULL) { printf(" %-25s %s\n", i->key, i->name); - list_del(&i->list); - list_for_each(&i->dependencies, d, node) - d->dependent->num_depends--; + dgraph_clear_node(&i->node); + strmap_del(&tests, i->key, NULL); } + exit(0); } -static char *list_tests(void *arg) +static bool draw_test(const char *member, struct ccanlint *c, const char *style) { - print_tests(&compulsory_tests, "Compulsory"); - print_tests(&normal_tests, "Normal"); - exit(0); + /* + * todo: escape labels in case ccanlint test keys have + * characters interpreted as GraphViz syntax. + */ + printf("\t\"%p\" [label=\"%s\"%s]\n", c, c->key, style); + return true; } -static void test_dgraph_vertices(struct list_head *tests, const char *style) +static void test_dgraph_vertices(const char *style) { - const struct ccanlint *i; + strmap_iterate(&tests, draw_test, style); +} - list_for_each(tests, i, list) { - /* - * todo: escape labels in case ccanlint test keys have - * characters interpreted as GraphViz syntax. - */ - printf("\t\"%p\" [label=\"%s\"%s]\n", i, i->key, style); +static bool draw_edges(const char *member, struct ccanlint *c, void *unused) +{ + struct dgraph_edge *e; + + dgraph_for_each_edge(&c->node, e, DGRAPH_FROM) { + struct ccanlint *to = container_of(e->n[DGRAPH_TO], + struct ccanlint, + node); + printf("\t\"%p\" -> \"%p\"\n", c->name, to->name); } + return true; } -static void test_dgraph_edges(struct list_head *tests) +static void test_dgraph_edges(void) { - const struct ccanlint *i; - const struct dependent *d; - - list_for_each(tests, i, list) - list_for_each(&i->dependencies, d, node) - printf("\t\"%p\" -> \"%p\"\n", d->dependent, i); + strmap_iterate(&tests, draw_edges, NULL); } static char *test_dependency_graph(void *arg) { puts("digraph G {"); - test_dgraph_vertices(&compulsory_tests, ", style=filled, fillcolor=yellow"); - test_dgraph_vertices(&normal_tests, ""); - - test_dgraph_edges(&compulsory_tests); - test_dgraph_edges(&normal_tests); + test_dgraph_vertices(""); + test_dgraph_edges(); puts("}"); @@ -435,7 +472,7 @@ static void add_options(struct ccanlint *test, char **options, memcpy(&test->options[num], options, (num_options + 1)*sizeof(char *)); } -static void add_info_options(struct ccan_file *info, bool mark_fails) +void add_info_options(struct ccan_file *info) { struct doc_section *d; unsigned int i; @@ -470,8 +507,10 @@ static void add_info_options(struct ccan_file *info, bool mark_fails) /* Known failure? */ if (strcasecmp(words[1], "FAIL") == 0) { - if (mark_fails) - btree_insert(info_exclude, words[0]); + if (!targeting) + skip_test_and_deps(test, + "excluded in _info" + " file"); } else { if (!test->takes_options) warnx("%s: %s doesn't take options", @@ -519,32 +558,6 @@ char **per_file_options(const struct ccanlint *test, struct ccan_file *f) return talloc_realloc(NULL, ret, char *, j + 1); } -static bool depends_on(struct ccanlint *i, struct ccanlint *target) -{ - const struct dependent *d; - - if (i == target) - return true; - - list_for_each(&i->dependencies, d, node) { - if (depends_on(d->dependent, target)) - return true; - } - return false; -} - -/* O(N^2), who cares? */ -static void skip_unrelated_tests(struct ccanlint *target) -{ - struct ccanlint *i; - struct list_head *list; - - foreach_ptr(list, &compulsory_tests, &normal_tests) - list_for_each(list, i, list) - if (!depends_on(i, target)) - i->skip = "not relevant to target"; -} - static char *demangle_string(char *string) { unsigned int i; @@ -644,42 +657,73 @@ static char *opt_set_const_charp(const char *arg, const char **p) return opt_set_charp(arg, cast_const2(char **, p)); } +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); + + targeting = true; + dgraph_add_edge(&t->node, all); + return NULL; +} + +static bool run_tests(struct dgraph_node *all, + bool summary, + struct manifest *m, + const char *prefix) +{ + struct run_info run; + + run.quiet = summary; + run.m = m; + run.prefix = prefix; + run.score = run.total = 0; + run.pass = true; + + dgraph_traverse_to(all, run_test, &run); + + printf("%sTotal score: %u/%u\n", prefix, run.score, run.total); + return run.pass; +} + +static bool add_to_all(const char *member, struct ccanlint *c, + struct dgraph_node *all) +{ + dgraph_add_edge(&c->node, all); + return true; +} + int main(int argc, char *argv[]) { bool summary = false, pass = true; - unsigned int score = 0, total_score = 0; + unsigned int i; struct manifest *m; - struct ccanlint *i; const char *prefix = ""; - char *dir = talloc_getcwd(NULL), *base_dir = dir, *target = NULL; + char *dir = talloc_getcwd(NULL), *base_dir = dir, *testlink; + struct dgraph_node all; - init_tests(); + /* Empty graph node to which we attach everything else. */ + dgraph_init_node(&all); - cmdline_exclude = btree_new(btree_strcmp); - info_exclude = btree_new(btree_strcmp); - - opt_register_arg("--dir|-d", opt_set_charp, opt_show_charp, &dir, - "use this directory"); + opt_register_early_noarg("--verbose|-v", opt_inc_intval, &verbose, + "verbose mode (up to -vvvv)"); opt_register_noarg("-n|--safe-mode", opt_set_bool, &safe_mode, "do not compile anything"); opt_register_noarg("-l|--list-tests", list_tests, NULL, "list tests ccanlint performs (and exit)"); opt_register_noarg("--test-dep-graph", test_dependency_graph, NULL, "print dependency graph of tests in Graphviz .dot format"); - opt_register_arg("-k|--keep ", keep_test, NULL, NULL, - "keep results of " - " (can be used multiple times, or 'all')"); + 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"); - opt_register_noarg("--verbose|-v", opt_inc_intval, &verbose, - "verbose mode (up to -vvvv)"); - opt_register_arg("-x|--exclude ", skip_test, NULL, NULL, + opt_register_arg("-x|--exclude ", exclude_test, NULL, NULL, "exclude (can be used multiple times)"); - opt_register_arg("-t|--timeout ", opt_set_uintval, + opt_register_arg("--timeout ", opt_set_uintval, NULL, &timeout, "ignore (terminate) tests that are slower than this"); - opt_register_arg("--target ", opt_set_charp, - NULL, &target, + opt_register_arg("-t|--target ", opt_set_target, NULL, &all, "only run one test (and its prerequisites)"); opt_register_arg("--compiler ", opt_set_const_charp, NULL, &compiler, "set the compiler"); @@ -690,18 +734,15 @@ int main(int argc, char *argv[]) " of CCAN modules.", "This usage message"); + /* Do verbose before anything else... */ + 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)); - opt_parse(&argc, argv, opt_log_stderr_exit); + init_tests(); - if (dir[0] != '/') - dir = talloc_asprintf_append(NULL, "%s/%s", base_dir, dir); - while (strends(dir, "/")) - dir[strlen(dir)-1] = '\0'; - if (dir != base_dir) - prefix = talloc_append_string(talloc_basename(NULL, dir), ": "); if (verbose >= 3) { compile_verbose = true; print_test_depends(); @@ -709,38 +750,53 @@ int main(int argc, char *argv[]) if (verbose >= 4) tools_verbose = true; - m = get_manifest(talloc_autofree_context(), dir); - read_config_header(); + opt_parse(&argc, argv, opt_log_stderr_exit); - /* Create a symlink from temp dir back to src dir's test directory. */ - if (symlink(talloc_asprintf(m, "%s/test", dir), - talloc_asprintf(m, "%s/test", temp_dir(NULL))) != 0) - err(1, "Creating test symlink in %s", temp_dir(NULL)); + if (!targeting) + strmap_iterate(&tests, add_to_all, &all); - if (target) { - struct ccanlint *test; + /* This links back to the module's test dir. */ + testlink = talloc_asprintf(NULL, "%s/test", temp_dir(NULL)); - test = find_test(target); - if (!test) - errx(1, "Unknown test to run '%s'", target); - skip_unrelated_tests(test); + /* Defaults to pwd. */ + if (argc == 1) { + i = 1; + goto got_dir; } - /* If you don't pass the compulsory tests, you get a score of 0. */ - while ((i = get_next_test(&compulsory_tests)) != NULL) { - if (!run_test(i, summary, &score, &total_score, m)) { - printf("%sTotal score: 0/%u\n", prefix, total_score); - errx(1, "%s%s failed", prefix, i->name); - } - } + for (i = 1; i < argc; i++) { + unsigned int score, total_score; + + dir = argv[i]; + + 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), + ": "); - /* --target overrides known FAIL from _info */ - if (m->info_file) - add_info_options(m->info_file, !target); + m = get_manifest(talloc_autofree_context(), dir); - while ((i = get_next_test(&normal_tests)) != NULL) - pass &= run_test(i, summary, &score, &total_score, m); + /* FIXME: This has to come after we've got manifest. */ + if (i == 1) + read_config_header(); - printf("%sTotal score: %u/%u\n", prefix, score, total_score); + /* 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); + } return pass ? 0 : 1; }