]> git.ozlabs.org Git - ccan/blobdiff - tools/ccanlint/ccanlint.c
configurator: HAVE_PROC_SELF_MAPS
[ccan] / tools / ccanlint / ccanlint.c
index fd7e0c719001af2d0a58f26f04e3fa0d19465989..d31ef94058f6d63b0030f5e85c6e971edbc60189 100644 (file)
@@ -25,7 +25,6 @@
 #include <string.h>
 #include <err.h>
 #include <ctype.h>
-#include <ccan/btree/btree.h>
 #include <ccan/str/str.h>
 #include <ccan/str_talloc/str_talloc.h>
 #include <ccan/talloc/talloc.h>
 #include <ccan/grab_file/grab_file.h>
 #include <ccan/cast/cast.h>
 #include <ccan/tlist/tlist.h>
+#include <ccan/strmap/strmap.h>
 
-/* Defines struct tlist_ccanlint. */
-TLIST_TYPE(ccanlint, struct ccanlint);
+struct ccanlint_map {
+       STRMAP_MEMBERS(struct ccanlint *);
+};
 
 int verbose = 0;
-static struct tlist_ccanlint tests = TLIST_INIT(tests);
+static struct ccanlint_map tests;
 bool safe_mode = false;
+bool keep_results = false;
 static bool targeting = false;
-static struct btree *cmdline_exclude;
-static struct btree *info_exclude;
 static unsigned int timeout;
 
 /* These are overridden at runtime if we can find config.h */
@@ -78,121 +78,152 @@ 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,
-                    const char *prefix)
+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%s: skipped (%s)\n", prefix, 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_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): %s",
-                      prefix, i->name, i->key, score->pass ? "PASS" : "FAIL");
+                      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);
+       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 ccanlint *test)
 {
-       tlist_add(&tests, 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;
-       test->skip = NULL;
-       test->skip_fail = false;
+       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;
 }
 
 /**
@@ -200,34 +231,52 @@ static void register_test(struct ccanlint *test)
  **/
 static inline struct ccanlint *get_next_test(void)
 {
-       struct ccanlint *i;
+       struct ccanlint *i = NULL;
+
+       strmap_iterate(&tests, get_test, &i);
+       if (i)
+               return i;
 
-       if (tlist_empty(&tests))
+       if (strmap_empty(&tests))
                return NULL;
 
-       tlist_for_each(&tests, 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);
+}
 
-       tlist_for_each(&tests, i, list)
-               if (streq(i->key, key))
-                       return i;
+bool is_excluded(const char *name)
+{
+       return find_test(name)->skip != NULL;
+}
 
-       return NULL;
+static bool init_deps(const char *member, struct ccanlint *c, void *unused)
+{
+       char **deps = strsplit(NULL, c->needs, " ");
+       unsigned int i;
+
+       for (i = 0; deps[i]; i++) {
+               struct ccanlint *dep;
+
+               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;
 }
 
-bool is_excluded(const char *name)
+static bool check_names(const char *member, struct ccanlint *c,
+                       struct ccanlint_map *names)
 {
-       return btree_lookup(cmdline_exclude, name) != NULL
-               || btree_lookup(info_exclude, name) != NULL
-               || find_test(name)->skip != NULL;
+       if (!strmap_add(names, c->name, c))
+               err(1, "Duplicate name %s", c->name);
+       return true;
 }
 
 #undef REGISTER_TEST
@@ -236,150 +285,151 @@ bool is_excluded(const char *name)
 
 static void init_tests(void)
 {
-       struct ccanlint *c;
-       struct btree *keys, *names;
+       struct ccanlint_map names;
 
-       tlist_init(&tests);
+       strmap_init(&tests);
 
 #undef REGISTER_TEST
 #define REGISTER_TEST(name) register_test(&name)
 #include "generated-testlist"
 
-       /* Initialize dependency lists. */
-       tlist_for_each(&tests, c, list) {
-               list_head_init(&c->dependencies);
-               c->num_depends = 0;
-       }
+       strmap_iterate(&tests, init_deps, NULL);
 
-       /* Resolve dependencies. */
-       tlist_for_each(&tests, 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);
+}
 
-       /* Self-consistency check: make sure no two tests
-          have the same key or name. */
-       keys = btree_new(btree_strcmp);
-       names = btree_new(btree_strcmp);
-       tlist_for_each(&tests, 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 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;
+}
+
+static void reset_tests(struct dgraph_node *all)
+{
+       dgraph_traverse_to(all, reset_test, NULL);
+}
 
-       btree_delete(keys);
-       btree_delete(names);
+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);
+               }
+       }
+       return true;
 }
 
 static void print_test_depends(void)
 {
-       struct ccanlint *c;
        printf("Tests:\n");
 
-       tlist_for_each(&tests, 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;
-
-       init_tests();
-       if (streq(testname, "all")) {
-               tlist_for_each(&tests, 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)
+{
+       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)
 {
-       btree_insert(cmdline_exclude, testname);
+       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 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;
 
-       init_tests();
-
        printf("Tests:\n");
        /* This makes them print in topological order. */
        while ((i = get_next_test()) != NULL) {
-               const struct dependent *d;
                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 bool draw_test(const char *member, struct ccanlint *c, const char *style)
+{
+       /*
+        * 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(const char *style)
 {
-       const struct ccanlint *i;
+       strmap_iterate(&tests, draw_test, style);
+}
 
-       tlist_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(void)
 {
-       const struct ccanlint *i;
-       const struct dependent *d;
-
-       tlist_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)
 {
-       init_tests();
        puts("digraph G {");
 
        test_dgraph_vertices("");
@@ -458,7 +508,9 @@ void add_info_options(struct ccan_file *info)
                        /* Known failure? */
                        if (strcasecmp(words[1], "FAIL") == 0) {
                                if (!targeting)
-                                       btree_insert(info_exclude, words[0]);
+                                       skip_test_and_deps(test,
+                                                          "excluded in _info"
+                                                          " file");
                        } else {
                                if (!test->takes_options)
                                        warnx("%s: %s doesn't take options",
@@ -506,30 +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;
-
-       tlist_for_each(&tests, i, list)
-               if (!depends_on(i, target))
-                       i->skip = "not relevant to target";
-}
-
 static char *demangle_string(char *string)
 {
        unsigned int i;
@@ -629,18 +657,54 @@ 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 i;
        struct manifest *m;
-       struct ccanlint *t;
        const char *prefix = "";
-       char *dir = talloc_getcwd(NULL), *base_dir = dir, *target = NULL,
-               *testlink;
+       char *dir = talloc_getcwd(NULL), *base_dir = dir, *testlink;
+       struct dgraph_node all;
        
-       cmdline_exclude = btree_new(btree_strcmp);
-       info_exclude = btree_new(btree_strcmp);
+       /* Empty graph node to which we attach everything else. */
+       dgraph_init_node(&all);
 
        opt_register_early_noarg("--verbose|-v", opt_inc_intval, &verbose,
                                 "verbose mode (up to -vvvv)");
@@ -650,18 +714,16 @@ int main(int argc, char *argv[])
                         "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 <testname>", keep_test, NULL, NULL,
-                        "keep results of <testname>"
-                        " (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_arg("-x|--exclude <testname>", skip_test, NULL, NULL,
+       opt_register_arg("-x|--exclude <testname>", exclude_test, NULL, NULL,
                         "exclude <testname> (can be used multiple times)");
-       opt_register_arg("-t|--timeout <milleseconds>", opt_set_uintval,
+       opt_register_arg("--timeout <milleseconds>", opt_set_uintval,
                         NULL, &timeout,
                         "ignore (terminate) tests that are slower than this");
-       opt_register_arg("--target <testname>", opt_set_charp,
-                        NULL, &target,
+       opt_register_arg("-t|--target <testname>", opt_set_target, NULL, &all,
                         "only run one test (and its prerequisites)");
        opt_register_arg("--compiler <compiler>", opt_set_const_charp,
                         NULL, &compiler, "set the compiler");
@@ -679,7 +741,7 @@ int main(int argc, char *argv[])
        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 (verbose >= 3) {
                compile_verbose = true;
@@ -688,6 +750,11 @@ int main(int argc, char *argv[])
        if (verbose >= 4)
                tools_verbose = true;
 
+       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));
 
@@ -713,17 +780,6 @@ int main(int argc, char *argv[])
                        prefix = talloc_append_string(talloc_basename(NULL,dir),
                                                      ": ");
 
-               init_tests();
-
-               if (target) {
-                       struct ccanlint *test;
-
-                       test = find_test(target);
-                       if (!test)
-                               errx(1, "Unknown test to run '%s'", target);
-                       skip_unrelated_tests(test);
-               }
-
                m = get_manifest(talloc_autofree_context(), dir);
 
                /* FIXME: This has to come after we've got manifest. */
@@ -737,21 +793,10 @@ int main(int argc, char *argv[])
                        err(1, "Creating test symlink in %s", temp_dir(NULL));
 
                score = total_score = 0;
-               while ((t = get_next_test()) != NULL) {
-                       if (!run_test(t, summary, &score, &total_score, m,
-                                     prefix)) {
-                               pass = false;
-                               if (t->compulsory) {
-                                       warnx("%s%s failed", prefix, t->name);
-                                       printf("%sTotal score: 0/%u\n",
-                                              prefix, total_score);
-                                       goto next;
-                               }
-                       }
-               }
+               if (!run_tests(&all, summary, m, prefix))
+                       pass = false;
 
-               printf("%sTotal score: %u/%u\n", prefix, score, total_score);
-       next: ;
+               reset_tests(&all);
        }
        return pass ? 0 : 1;
 }