X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.c;h=b35f11a7b8947d3cd79a9a9b7c925e6cc3b8dd71;hp=78518721ef30726c7baf29bf80bd2e6625c472b1;hb=60824f8a0f758dc7808eb31cc83434ea78f44ed1;hpb=a1d06d55999cc5004f4a3c2c8c17638972c6fe50 diff --git a/tools/ccanlint/ccanlint.c b/tools/ccanlint/ccanlint.c index 78518721..b35f11a7 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, 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 @@ -19,8 +20,6 @@ #include "ccanlint.h" #include "../tools.h" #include -#include -#include #include #include #include @@ -30,30 +29,27 @@ #include #include #include +#include +#include +#include +#include +#include -unsigned int verbose = 0; -static LIST_HEAD(compulsory_tests); -static LIST_HEAD(normal_tests); -static LIST_HEAD(finished_tests); +/* Defines struct tlist_ccanlint. */ +TLIST_TYPE(ccanlint, struct ccanlint); + +int verbose = 0; +static struct tlist_ccanlint tests = TLIST_INIT(tests); bool safe_mode = 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] [-n] [-v] [-t ] [-d ] [-x ]* [-k ]*\n" - " -v: verbose mode (can specify more than once)\n" - " -s: simply give one line summary\n" - " -d: use this directory instead of the current one\n" - " -n: do not compile anything\n" - " -l: list tests ccanlint performs\n" - " -k: keep results of this test (can be used multiple times)\n" - " -x: exclude tests (can be used multiple times)\n" - " -t: ignore (terminate) tests that are slower than this\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) @@ -72,7 +68,7 @@ static void indent_print(const char *string) bool ask(const char *question) { - char reply[2]; + char reply[80]; printf("%s ", question); fflush(stdout); @@ -89,12 +85,12 @@ static const char *should_skip(struct manifest *m, struct ccanlint *i) 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->skip) - return "dependency was skipped"; - if (i->can_run) return i->can_run(m); return NULL; @@ -102,350 +98,663 @@ static const char *should_skip(struct manifest *m, struct ccanlint *i) static bool run_test(struct ccanlint *i, bool quiet, - unsigned int *score, - unsigned int *total_score, - struct manifest *m) + unsigned int *running_score, + unsigned int *running_total, + struct manifest *m, + const char *prefix) { - void *result; - unsigned int this_score, timeleft; + unsigned int timeleft; const struct dependent *d; const char *skip; - bool bad, good; + struct score *score; //one less test to run through list_for_each(&i->dependencies, d, node) d->dependent->num_depends--; + 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) - printf(" %s: skipped (%s)\n", i->name, 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. */ + /* If we're skipping this because a prereq failed, we fail: + * count it as a score of 1. */ if (i->skip_fail) - *total_score += i->total_score; + (*running_total)++; list_del(&i->list); - list_add_tail(&finished_tests, &i->list); list_for_each(&i->dependencies, d, node) { - d->dependent->skip = true; + if (d->dependent->skip) + continue; + d->dependent->skip = "dependency was skipped"; d->dependent->skip_fail = i->skip_fail; } - return true; + return i->skip_fail ? false : true; } timeleft = timeout ? timeout : default_timeout_ms; - result = i->check(m, i->keep_results, &timeleft); + i->check(m, i->keep_results, &timeleft, score); if (timeout && timeleft == 0) { skip = "timeout"; goto skip; } - if (!result) - this_score = i->total_score ? i->total_score : 1; - else if (i->score) - this_score = i->score(m, result); - else - this_score = 0; - - bad = (this_score == 0); - good = (this_score >= i->total_score); - - if (verbose || (bad && !quiet)) { - printf(" %s: %s", i->name, - bad ? "FAIL" : good ? "PASS" : "PARTIAL"); - if (i->total_score) - printf(" (+%u/%u)", - this_score, i->total_score); + 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 && result) { - const char *desc; - if (i->describe && (desc = i->describe(m, result)) != NULL) - printf(" %s\n", desc); - if (i->handle) - i->handle(m, result); + 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); - if (i->total_score) { - *score += this_score; - *total_score += i->total_score; - } + *running_score += score->score; + *running_total += score->total; list_del(&i->list); - list_add_tail(&finished_tests, &i->list); - if (bad) { + if (!score->pass) { /* Skip any tests which depend on this one. */ list_for_each(&i->dependencies, d, node) { - d->dependent->skip = true; + if (d->dependent->skip) + continue; + d->dependent->skip = "dependency failed"; d->dependent->skip_fail = true; } } - return good; + return score->pass; } -static void register_test(struct list_head *h, struct ccanlint *test, ...) +static void register_test(struct ccanlint *test) { - va_list ap; - struct ccanlint *depends; - struct dependent *dchild; - - list_add(h, &test->list); - - va_start(ap, test); - /* Careful: we might have been initialized by a dependent. */ - if (test->dependencies.n.next == NULL) - list_head_init(&test->dependencies); - - //dependent(s) args (if any), last one is NULL - while ((depends = va_arg(ap, struct ccanlint *)) != NULL) { - dchild = malloc(sizeof(*dchild)); - dchild->dependent = test; - /* The thing we depend on might not be initialized yet! */ - if (depends->dependencies.n.next == NULL) - list_head_init(&depends->dependencies); - list_add_tail(&depends->dependencies, &dchild->node); - test->num_depends++; - } - va_end(ap); + tlist_add(&tests, test, list); + test->options = talloc_array(NULL, char *, 1); + test->options[0] = NULL; + test->skip = NULL; + test->skip_fail = false; } /** * 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; - if (list_empty(test)) + if (tlist_empty(&tests)) return NULL; - list_for_each(test, i, list) { + 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; + + tlist_for_each(&tests, i, list) + if (streq(i->key, key)) + return i; + + return NULL; +} + +bool is_excluded(const char *name) +{ + return btree_lookup(cmdline_exclude, name) != NULL + || btree_lookup(info_exclude, name) != NULL + || find_test(name)->skip != NULL; +} + +#undef REGISTER_TEST +#define REGISTER_TEST(name, ...) extern struct ccanlint name +#include "generated-testlist" + static void init_tests(void) { - const struct ccanlint *i; + struct ccanlint *c; struct btree *keys, *names; + tlist_init(&tests); + #undef REGISTER_TEST -#define REGISTER_TEST(name, ...) register_test(&normal_tests, &name, __VA_ARGS__) -#include "generated-normal-tests" -#undef REGISTER_TEST -#define REGISTER_TEST(name, ...) register_test(&compulsory_tests, &name, __VA_ARGS__) -#include "generated-compulsory-tests" +#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; + } + + /* 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); + } /* Self-consistency check: make sure no two tests have the same key or name. */ keys = btree_new(btree_strcmp); names = btree_new(btree_strcmp); - list_for_each(&compulsory_tests, i, list) { - if (!btree_insert(keys, i->key)) - errx(1, "BUG: Duplicate test key '%s'", i->key); - if (!btree_insert(keys, i->name)) - errx(1, "BUG: Duplicate test name '%s'", i->name); - } - list_for_each(&normal_tests, i, list) { - if (!btree_insert(keys, i->key)) - errx(1, "BUG: Duplicate test key '%s'", i->key); - if (!btree_insert(keys, i->name)) - errx(1, "BUG: Duplicate test name '%s'", i->name); + 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); } + btree_delete(keys); btree_delete(names); - - if (!verbose) - return; +} - printf("\nCompulsory Tests\n"); - list_for_each(&compulsory_tests, i, list) { - printf("%s depends on %u others\n", i->name, i->num_depends); - if (!list_empty(&i->dependencies)) { - const struct dependent *d; - printf("These depend on us:\n"); - list_for_each(&i->dependencies, d, node) - printf("\t%s\n", d->dependent->name); - } - } +static void print_test_depends(void) +{ + struct ccanlint *c; + printf("Tests:\n"); - printf("\nNormal Tests\n"); - list_for_each(&normal_tests, i, list) { - printf("%s depends on %u others\n", i->name, i->num_depends); - if (!list_empty(&i->dependencies)) { + tlist_for_each(&tests, c, list) { + if (!list_empty(&c->dependencies)) { const struct dependent *d; - printf("These depend on us:\n"); - list_for_each(&i->dependencies, d, node) - printf("\t%s\n", d->dependent->name); + printf("These depend on %s:\n", c->key); + list_for_each(&c->dependencies, d, node) + printf("\t%s\n", d->dependent->key); } } } -static struct ccanlint *find_test(const char *key) +static int show_tmpdir(const char *dir) { - struct ccanlint *i; + printf("You can find ccanlint working files in '%s'\n", dir); + return 0; +} - list_for_each(&compulsory_tests, i, list) - if (streq(i->key, key)) - return i; +static char *keep_test(const char *testname, void *unused) +{ + struct ccanlint *i; - list_for_each(&normal_tests, i, list) - if (streq(i->key, key)) - return 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; + } + /* Don't automatically destroy temporary dir. */ + talloc_set_destructor(temp_dir(NULL), show_tmpdir); return NULL; } -static void keep_test(const char *testname) +static char *skip_test(const char *testname, void *unused) { - struct ccanlint *i = find_test(testname); - if (!i) - errx(1, "No test %s to --keep", testname); - i->keep_results = true; + btree_insert(cmdline_exclude, testname); + return NULL; } -static void print_tests(struct list_head *tests, const char *type) +static char *list_tests(void *arg) { struct ccanlint *i; - printf("%s tests:\n", type); + init_tests(); + + printf("Tests:\n"); /* This makes them print in topological order. */ - while ((i = get_next_test(tests)) != NULL) { + 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--; } + exit(0); +} + +static void test_dgraph_vertices(const char *style) +{ + const struct ccanlint *i; + + 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 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); } -static void list_tests(void) +static char *test_dependency_graph(void *arg) { - print_tests(&compulsory_tests, "Compulsory"); - print_tests(&normal_tests, "Normal"); + init_tests(); + puts("digraph G {"); + + test_dgraph_vertices(""); + test_dgraph_edges(); + + puts("}"); + exit(0); } -static char *strip(const void *ctx, const char *line) +/* Remove empty lines. */ +static char **collapse(char **lines, unsigned int *nump) { - line += strcspn(line, IDENT_CHARS "-"); - return talloc_strndup(ctx, line, strspn(line, IDENT_CHARS "-")); + 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_info_fails(struct ccan_file *info) + +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 *)); +} + +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, "fails")) + if (!streq(d->type, "ccanlint")) continue; - for (i = 0; i < d->num_lines; i++) - btree_insert(info_exclude, strip(info, d->lines[i])); - break; + 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 (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); + } + } } } -int main(int argc, char *argv[]) +/* If options are of form "filename: