X-Git-Url: http://git.ozlabs.org/?a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.c;h=7a7f5b8be17d3187f51b29d19de71c448471db0d;hb=43ea89157d6cf730d44050548cb60407da60cb0f;hp=001ee689df834b2e1cdc48b839d9d84a8f71d482;hpb=650c775ff00cccd03fc84e7789a03c51d9839004;p=ccan diff --git a/tools/ccanlint/ccanlint.c b/tools/ccanlint/ccanlint.c index 001ee689..7a7f5b8b 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,43 @@ * 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 +#include +#include -static unsigned int verbose = 0; -static LIST_HEAD(tests); +struct ccanlint_map { + STRMAP_MEMBERS(struct ccanlint *); +}; -static void init_tests(void) -{ -#include "generated-init-tests" -} +int verbose = 0; +static struct ccanlint_map tests; +bool safe_mode = false; +static bool targeting = false; +static struct btree *cmdline_exclude; +static struct btree *info_exclude; +static unsigned int timeout; -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); -} +/* These are overridden at runtime if we can find config.h */ +const char *compiler = NULL; +const char *cflags = NULL; + +const char *config_header; +#if 0 static void indent_print(const char *string) { while (*string) { @@ -55,10 +67,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 +80,693 @@ 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, - struct manifest *m) +static const char *should_skip(struct manifest *m, struct ccanlint *i) { - void *result; - unsigned int this_score; + if (btree_lookup(cmdline_exclude, i->key)) + return "excluded on command line"; - if (i->total_score) - *total_score += i->total_score; + if (btree_lookup(info_exclude, i->key)) + return "excluded in _info file"; + + if (i->skip) + return i->skip; - result = i->check(m); - if (!result) { - if (verbose) - printf(" %s: OK\n", i->name); - if (i->total_score) - *score += i->total_score; + if (i->skip_fail) + return "dependency failed"; + + if (i->can_run) + return i->can_run(m); + return NULL; +} + +static bool skip_node(struct dgraph_node *to, const char *failmsg) +{ + struct ccanlint *c = container_of(to, struct ccanlint, node); + if (!c->skip) { + if (failmsg) { + c->skip = failmsg; + c->skip_fail = true; + } else { + c->skip = "dependency was skipped"; + } + } + 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) +{ + unsigned int timeleft; + const char *skip; + struct score *score; + + strmap_del(&tests, i->key, NULL); + + if (!i->should_run) { + dgraph_clear_node(&i->node); return true; } - if (i->score) - this_score = i->score(m, result); - else - this_score = 0; + score = talloc(m, struct score); + list_head_init(&score->per_file_errors); + score->error = NULL; + score->pass = false; + score->score = 0; + score->total = 1; - *score += this_score; - if (summary) { - printf("%s FAILED (%u/%u)\n", - i->name, this_score, i->total_score); + skip = should_skip(m, i); + if (skip) { + skip: if (verbose) - indent_print(i->describe(m, result)); + 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)++; + + dgraph_traverse_from(&i->node, skip_node, + i->skip_fail ? "dependency failed" : NULL); + dgraph_clear_node(&i->node); + 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): %s", + 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 (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; + + if (!score->pass) { + /* Skip any tests which depend on this one. */ + dgraph_traverse_from(&i->node, skip_node, "dependency failed"); + } + dgraph_clear_node(&i->node); + return score->pass; +} + +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[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(void) +{ + struct ccanlint *i = NULL; - printf("%s\n", i->describe(m, result)); + strmap_iterate(&tests, get_test, &i); + if (i) + return i; - if (i->handle) - i->handle(m, result); + if (strmap_empty(&tests)) + return NULL; - return false; + errx(1, "Can't make process; test dependency cycle"); } -int main(int argc, char *argv[]) +static struct ccanlint *find_test(const char *key) { - int c; - bool summary = false; - unsigned int score, total_score; - struct manifest *m; - const struct ccanlint *i; - - /* I'd love to use long options, but that's not standard. */ - /* FIXME: getopt_long ccan package? */ - while ((c = getopt(argc, argv, "sd:v")) != -1) { - switch (c) { - case 'd': - if (chdir(optarg) != 0) - err(1, "Changing into directory '%s'", optarg); - break; - case 's': - summary = true; - break; - case 'v': - verbose++; - break; - default: - usage(argv[0]); + return strmap_get(&tests, key); +} + +bool is_excluded(const char *name) +{ + return btree_lookup(cmdline_exclude, name) != NULL + || btree_lookup(info_exclude, name) != NULL + || find_test(name)->skip != NULL; +} + +static bool reset_deps(const char *member, struct ccanlint *c, void *unused) +{ + char **deps = strsplit(NULL, c->needs, " "); + unsigned int i; + + c->skip = NULL; + c->skip_fail = false; + 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; +} + +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-testlist" + +static void init_tests(void) +{ + struct ccanlint_map names; + + strmap_init(&tests); + +#undef REGISTER_TEST +#define REGISTER_TEST(name) register_test(&name) +#include "generated-testlist" + + strmap_iterate(&tests, reset_deps, NULL); + + /* Check for duplicate names. */ + strmap_init(&names); + strmap_iterate(&tests, check_names, &names); + strmap_clear(&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) +{ + printf("Tests:\n"); + + 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 bool keep_one_test(const char *member, struct ccanlint *c, void *unused) +{ + c->keep_results = true; + return true; +} + +static char *keep_test(const char *testname, void *unused) +{ + if (streq(testname, "all")) { + strmap_iterate(&tests, keep_one_test, NULL); + } else { + struct ccanlint *i = find_test(testname); + if (!i) + errx(1, "No test %s to --keep", testname); + keep_one_test(testname, i, NULL); + } + + /* Don't automatically destroy temporary dir. */ + talloc_set_destructor(temp_dir(NULL), show_tmpdir); + return NULL; +} - if (optind < argc) - usage(argv[0]); +static char *skip_test(const char *testname, void *unused) +{ + btree_insert(cmdline_exclude, testname); + return NULL; +} - m = get_manifest(); +static char *list_tests(void *arg) +{ + struct ccanlint *i; + + printf("Tests:\n"); + /* This makes them print in topological order. */ + while ((i = get_next_test()) != NULL) { + printf(" %-25s %s\n", i->key, i->name); + 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) +{ + strmap_iterate(&tests, draw_test, 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) +{ + strmap_iterate(&tests, draw_edges, NULL); +} + +static char *test_dependency_graph(void *arg) +{ + puts("digraph G {"); + + test_dgraph_vertices(""); + test_dgraph_edges(); + + 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 + /* -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 *)); +} + +void add_info_options(struct ccan_file *info) +{ + 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; + + 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) + 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: