X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.c;h=1c060ba7db6bf61147a8716e47dafe63c130d509;hp=001ee689df834b2e1cdc48b839d9d84a8f71d482;hb=4786b6edb824262957bfd5e7cff74c1e3983a9c9;hpb=650c775ff00cccd03fc84e7789a03c51d9839004 diff --git a/tools/ccanlint/ccanlint.c b/tools/ccanlint/ccanlint.c index 001ee689..1c060ba7 100644 --- a/tools/ccanlint/ccanlint.c +++ b/tools/ccanlint/ccanlint.c @@ -1,6 +1,7 @@ /* * ccanlint: assorted checks and advice for a ccan package - * Copyright (C) 2008 Rusty Russell + * Copyright (C) 2008 Rusty Russell, Idris Soule + * Copyright (C) 2010 Rusty Russell, Idris Soule * * This program is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License as published by the Free @@ -17,32 +18,38 @@ * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ #include "ccanlint.h" +#include "../tools.h" #include -#include #include #include #include #include #include +#include +#include +#include +#include +#include +#include +#include +#include -static unsigned int verbose = 0; -static LIST_HEAD(tests); +int verbose = 0; +static LIST_HEAD(compulsory_tests); +static LIST_HEAD(normal_tests); +static LIST_HEAD(finished_tests); +bool safe_mode = false; +static struct btree *cmdline_exclude; +static struct btree *info_exclude; +static unsigned int timeout; -static void init_tests(void) -{ -#include "generated-init-tests" -} +/* These are overridden at runtime if we can find config.h */ +const char *compiler = NULL; +const char *cflags = NULL; -static void usage(const char *name) -{ - fprintf(stderr, "Usage: %s [-s] [-v] [-d ]\n" - " -v: verbose mode\n" - " -s: simply give one line per FAIL and total score\n" - " -d: use this directory instead of the current one\n", - name); - exit(1); -} +const char *config_header; +#if 0 static void indent_print(const char *string) { while (*string) { @@ -55,10 +62,11 @@ static void indent_print(const char *string) string += line; } } +#endif bool ask(const char *question) { - char reply[2]; + char reply[80]; printf("%s ", question); fflush(stdout); @@ -67,99 +75,672 @@ bool ask(const char *question) && toupper(reply[0]) == 'Y'; } -static bool run_test(const struct ccanlint *i, - bool summary, - unsigned int *score, - unsigned int *total_score, +static const char *should_skip(struct manifest *m, struct ccanlint *i) +{ + 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; + + if (i->skip_fail) + return "dependency failed"; + + if (i->can_run) + return i->can_run(m); + return NULL; +} + +static bool run_test(struct ccanlint *i, + bool quiet, + unsigned int *running_score, + unsigned int *running_total, struct manifest *m) { - void *result; - unsigned int this_score; + unsigned int timeleft; + const struct dependent *d; + const char *skip; + struct score *score; - if (i->total_score) - *total_score += i->total_score; + //one less test to run through + list_for_each(&i->dependencies, d, node) + d->dependent->num_depends--; - result = i->check(m); - if (!result) { - if (verbose) - printf(" %s: OK\n", i->name); - if (i->total_score) - *score += i->total_score; - return true; + score = talloc(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; + } + return i->skip_fail ? false : true; + } + + timeleft = timeout ? timeout : default_timeout_ms; + i->check(m, i->keep_results, &timeleft, score); + if (timeout && timeleft == 0) { + skip = "timeout"; + goto skip; + } + + assert(score->score <= score->total); + if ((!score->pass && !quiet) + || (score->score < score->total && verbose) + || verbose > 1) { + printf("%s (%s): %s", 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 (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 (!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; + } + } + return score->pass; +} + +static void register_test(struct list_head *h, struct ccanlint *test) +{ + list_add(h, &test->list); + test->options = talloc_array(NULL, char *, 1); + test->options[0] = NULL; +} + +/** + * get_next_test - retrieves the next test to be processed + **/ +static inline struct ccanlint *get_next_test(struct list_head *test) +{ + struct ccanlint *i; + + if (list_empty(test)) + 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; + + list_for_each(&compulsory_tests, i, list) + if (streq(i->key, key)) + return i; + + list_for_each(&normal_tests, i, list) + if (streq(i->key, key)) + return i; + + return NULL; +} + +#undef REGISTER_TEST +#define REGISTER_TEST(name, ...) extern struct ccanlint name +#include "generated-normal-tests" +#include "generated-compulsory-tests" - if (i->score) - this_score = i->score(m, result); +static void init_tests(void) +{ + struct ccanlint *c; + struct btree *keys, *names; + struct list_head *list; + +#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" + + /* Initialize dependency lists. */ + foreach_ptr(list, &compulsory_tests, &normal_tests) { + list_for_each(list, c, list) { + list_head_init(&c->dependencies); + } + } + + /* 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); + } + } + + /* 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); + } + } + btree_delete(keys); + btree_delete(names); +} + +static void print_test_depends(void) +{ + struct list_head *list; + + 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); + } + } + } +} + +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) +{ + 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; + } + + /* 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) +{ + btree_insert(cmdline_exclude, testname); + return NULL; +} + +static void print_tests(struct list_head *tests, const char *type) +{ + struct ccanlint *i; + + printf("%s tests:\n", type); + /* This makes them print in topological order. */ + while ((i = get_next_test(tests)) != 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--; + } +} + +static char *list_tests(void *arg) +{ + print_tests(&compulsory_tests, "Compulsory"); + print_tests(&normal_tests, "Normal"); + exit(0); +} + +static void test_dgraph_vertices(struct list_head *tests, const char *style) +{ + const struct ccanlint *i; + + 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 void test_dgraph_edges(struct list_head *tests) +{ + 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); +} + +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); + + puts("}"); + + 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) +{ + unsigned int num; + + if (!test->options) + num = 0; else - this_score = 0; + /* -1, because last one is NULL. */ + num = talloc_array_length(test->options) - 1; + + test->options = talloc_realloc(NULL, test->options, + char *, + num + num_options + 1); + memcpy(&test->options[num], options, (num_options + 1)*sizeof(char *)); +} + +static void add_info_options(struct ccan_file *info, bool mark_fails) +{ + struct doc_section *d; + unsigned int i; + struct ccanlint *test; + + list_for_each(get_ccan_file_docs(info), d, list) { + if (!streq(d->type, "ccanlint")) + 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; - *score += this_score; - if (summary) { - printf("%s FAILED (%u/%u)\n", - i->name, this_score, i->total_score); + test = find_test(words[0]); + if (!test) { + warnx("%s: unknown ccanlint test '%s'", + info->fullname, words[0]); + continue; + } - if (verbose) - indent_print(i->describe(m, result)); - return false; + if (!words[1]) { + warnx("%s: no argument to test '%s'", + info->fullname, words[0]); + continue; + } + + /* Known failure? */ + if (strcasecmp(words[1], "FAIL") == 0) { + if (mark_fails) + btree_insert(info_exclude, words[0]); + } else { + if (!test->takes_options) + warnx("%s: %s doesn't take options", + info->fullname, words[0]); + add_options(test, words+1, num_words-1); + } + } + } +} + +/* If options are of form "filename: