X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.c;h=d80c11d1594dde2a0db1e23093618d0d5d89c61c;hp=b8dd467a18e78e76891dd2143962084cb1bde8a5;hb=4c6f5a73a0817641571fad7383ec3604487889f8;hpb=27b8937c5ed206e515c7b933f9593d7bc7f350e0

diff --git a/tools/ccanlint/ccanlint.c b/tools/ccanlint/ccanlint.c
index b8dd467a..d80c11d1 100644
--- a/tools/ccanlint/ccanlint.c
+++ b/tools/ccanlint/ccanlint.c
@@ -32,19 +32,22 @@
 #include <ccan/opt/opt.h>
 #include <ccan/foreach/foreach.h>
 #include <ccan/grab_file/grab_file.h>
+#include <ccan/cast/cast.h>
+#include <ccan/tlist/tlist.h>
+
+/* Defines struct tlist_ccanlint. */
+TLIST_TYPE(ccanlint, struct ccanlint);
 
 int verbose = 0;
-static LIST_HEAD(compulsory_tests);
-static LIST_HEAD(normal_tests);
-static LIST_HEAD(finished_tests);
+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;
 
 /* These are overridden at runtime if we can find config.h */
-char *compiler = NULL;
-char *cflags = NULL;
+const char *compiler = NULL;
+const char *cflags = NULL;
 
 const char *config_header;
 
@@ -97,7 +100,8 @@ static bool run_test(struct ccanlint *i,
 		     bool quiet,
 		     unsigned int *running_score,
 		     unsigned int *running_total,
-		     struct manifest *m)
+		     struct manifest *m,
+		     const char *prefix)
 {
 	unsigned int timeleft;
 	const struct dependent *d;
@@ -120,7 +124,7 @@ static bool run_test(struct ccanlint *i,
 	if (skip) {
 	skip:
 		if (verbose && !streq(skip, "not relevant to target"))
-			printf("%s: skipped (%s)\n", i->name, skip);
+			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. */
@@ -128,7 +132,6 @@ static bool run_test(struct ccanlint *i,
 			(*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;
@@ -149,7 +152,8 @@ static bool run_test(struct ccanlint *i,
 	if ((!score->pass && !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",
+		       prefix, i->name, i->key, score->pass ? "PASS" : "FAIL");
 		if (score->total > 1)
 			printf(" (+%u/%u)", score->score, score->total);
 		printf("\n");
@@ -160,15 +164,14 @@ static bool run_test(struct ccanlint *i,
 			printf("%s%s", score->error,
 			       strends(score->error, "\n") ? "" : "\n");
 		}
-		if (!quiet && !score->pass && i->handle)
-			i->handle(m, score);
 	}
+	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. */
@@ -182,22 +185,26 @@ static bool run_test(struct ccanlint *i,
 	return score->pass;
 }
 
-static void register_test(struct list_head *h, struct ccanlint *test)
+static void register_test(struct ccanlint *test)
 {
-	list_add(h, &test->list);
+	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;
 	}
@@ -208,100 +215,95 @@ 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)
+	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-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;
+
+	tlist_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);
-		}
+	tlist_for_each(&tests, c, list) {
+		list_head_init(&c->dependencies);
+		c->num_depends = 0;
 	}
 
 	/* 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);
+	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);
-	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);
-		}
+	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;
-
-	foreach_ptr(list, &compulsory_tests, &normal_tests) {
-		printf("\%s Tests\n",
-		       list == &compulsory_tests ? "Compulsory" : "Normal");
+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 us:\n");
+			printf("These depend on %s:\n", c->key);
 			list_for_each(&c->dependencies, d, node)
-				printf("\t%s\n", d->dependent->name);
+				printf("\t%s\n", d->dependent->key);
 		}
 	}
 }
 
-static int show_tmpdir(char *dir)
+static int show_tmpdir(const char *dir)
 {
 	printf("You can find ccanlint working files in '%s'\n", dir);
 	return 0;
@@ -311,12 +313,10 @@ static char *keep_test(const char *testname, void *unused)
 {
 	struct ccanlint *i;
 
+	init_tests();
 	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;
-		}
+		tlist_for_each(&tests, i, list)
+			i->keep_results = true;
 	} else {
 		i = find_test(testname);
 		if (!i)
@@ -335,33 +335,29 @@ static char *skip_test(const char *testname, void *unused)
 	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--;
 	}
-}
-
-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)
+static void test_dgraph_vertices(const char *style)
 {
 	const struct ccanlint *i;
 
-	list_for_each(tests, i, list) {
+	tlist_for_each(&tests, i, list) {
 		/*
 		 * todo: escape labels in case ccanlint test keys have
 		 *       characters interpreted as GraphViz syntax.
@@ -370,25 +366,23 @@ static void test_dgraph_vertices(struct list_head *tests, const char *style)
 	}
 }
 
-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)
+	tlist_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)
 {
+	init_tests();
 	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("}");
 
@@ -403,11 +397,30 @@ static char **collapse(char **lines, unsigned int *nump)
 		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 *));
+}
+
 static void add_info_options(struct ccan_file *info, bool mark_fails)
 {
 	struct doc_section *d;
@@ -419,9 +432,10 @@ static void add_info_options(struct ccan_file *info, bool mark_fails)
 			continue;
 
 		for (i = 0; i < d->num_lines; i++) {
+			unsigned int num_words;
 			char **words = collapse(strsplit(d, d->lines[i], " \t"),
-						NULL);
-			if (!words[0])
+						&num_words);
+			if (num_words == 0)
 				continue;
 
 			if (strncmp(words[0], "//", 2) == 0)
@@ -448,14 +462,49 @@ static void add_info_options(struct ccan_file *info, bool mark_fails)
 				if (!test->takes_options)
 					warnx("%s: %s doesn't take options",
 					      info->fullname, words[0]);
-				/* Copy line exactly into options. */
-				test->options = strstr(d->lines[i], words[0])
-					+ strlen(words[0]);
+				add_options(test, words+1, num_words-1);
 			}
 		}
 	}
 }
 
+/* If options are of form "filename:<option>" they only apply to that file */
+char **per_file_options(const struct ccanlint *test, struct ccan_file *f)
+{
+	char **ret;
+	unsigned int i, j = 0;
+
+	/* Fast path. */
+	if (!test->options[0])
+		return test->options;
+
+	ret = talloc_array(f, char *, talloc_array_length(test->options));
+	for (i = 0; test->options[i]; i++) {
+		char *optname;
+
+		if (!test->options[i] || !strchr(test->options[i], ':')) {
+			optname = test->options[i];
+		} else if (strstarts(test->options[i], f->name)
+			   && test->options[i][strlen(f->name)] == ':') {
+			optname = test->options[i] + strlen(f->name) + 1;
+		} else
+			continue;
+
+		/* FAIL overrides anything else. */
+		if (streq(optname, "FAIL")) {
+			ret = talloc_array(f, char *, 2);
+			ret[0] = (char *)"FAIL";
+			ret[1] = NULL;
+			return ret;
+		}
+		ret[j++] = optname;
+	}
+	ret[j] = NULL;
+
+	/* Shrink it to size so talloc_array_length() works as expected. */
+	return talloc_realloc(NULL, ret, char *, j + 1);
+}
+
 static bool depends_on(struct ccanlint *i, struct ccanlint *target)
 {
 	const struct dependent *d;
@@ -474,12 +523,10 @@ static bool depends_on(struct ccanlint *i, struct ccanlint *target)
 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";
+	tlist_for_each(&tests, i, list)
+		if (!depends_on(i, target))
+			i->skip = "not relevant to target";
 }
 
 static char *demangle_string(char *string)
@@ -499,7 +546,7 @@ static char *demangle_string(char *string)
 		if (string[i] == '\\') {
 			char repl;
 			unsigned len = 0;
-			char *p = strchr(mapfrom, string[i+1]);
+			const char *p = strchr(mapfrom, string[i+1]);
 			if (p) {
 				repl = mapto[p - mapfrom];
 				len = 1;
@@ -508,7 +555,7 @@ static char *demangle_string(char *string)
 					repl = (string[i+2]-'0')*16
 						+ string[i+3]-'0';
 					len = 3;
-				} else if (isdigit(string[i+1])) {
+				} else if (cisdigit(string[i+1])) {
 					repl = (string[i+2]-'0')*8*8
 						+ (string[i+3]-'0')*8
 						+ (string[i+4]-'0');
@@ -576,22 +623,26 @@ static void read_config_header(void)
 		compiler = CCAN_CFLAGS;
 }
 
+static char *opt_set_const_charp(const char *arg, const char **p)
+{
+	return opt_set_charp(arg, cast_const2(char **, p));
+}
+
 int main(int argc, char *argv[])
 {
-	bool summary = false;
-	unsigned int score = 0, total_score = 0;
+	bool summary = false, pass = true;
+	unsigned int i;
 	struct manifest *m;
-	struct ccanlint *i;
+	struct ccanlint *t;
 	const char *prefix = "";
-	char *dir = talloc_getcwd(NULL), *base_dir = dir, *target = NULL;
+	char *dir = talloc_getcwd(NULL), *base_dir = dir, *target = NULL,
+		*testlink;
 	
-	init_tests();
-
 	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,
@@ -603,8 +654,6 @@ int main(int argc, char *argv[])
 			 " (can be used multiple times, or 'all')");
 	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 <testname>", skip_test, NULL, NULL,
 			 "exclude <testname> (can be used multiple times)");
 	opt_register_arg("-t|--timeout <milleseconds>", opt_set_uintval,
@@ -613,63 +662,102 @@ int main(int argc, char *argv[])
 	opt_register_arg("--target <testname>", opt_set_charp,
 			 NULL, &target,
 			 "only run one test (and its prerequisites)");
-	opt_register_arg("--compiler <compiler>", opt_set_charp,
+	opt_register_arg("--compiler <compiler>", opt_set_const_charp,
 			 NULL, &compiler, "set the compiler");
-	opt_register_arg("--cflags <flags>", opt_set_charp,
+	opt_register_arg("--cflags <flags>", opt_set_const_charp,
 			 NULL, &cflags, "set the compiler flags");
 	opt_register_noarg("-?|-h|--help", opt_usage_and_exit,
 			   "\nA program for checking and guiding development"
 			   " 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);
 
-	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)
+	if (verbose >= 3) {
 		compile_verbose = true;
+		print_test_depends();
+	}
 	if (verbose >= 4)
 		tools_verbose = true;
 
-	m = get_manifest(talloc_autofree_context(), dir);
-	read_config_header();
+	/* This links back to the module's test dir. */
+	testlink = talloc_asprintf(NULL, "%s/test", temp_dir(NULL));
 
-	/* 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));
+	/* Defaults to pwd. */
+	if (argc == 1) {
+		i = 1;
+		goto got_dir;
+	}
 
-	if (target) {
-		struct ccanlint *test;
+	for (i = 1; i < argc; i++) {
+		unsigned int score, total_score;
+		bool added_info_options = false;
 
-		test = find_test(target);
-		if (!test)
-			errx(1, "Unknown test to run '%s'", target);
-		skip_unrelated_tests(test);
-	}
+		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),
+						      ": ");
+
+		init_tests();
+
+		if (target) {
+			struct ccanlint *test;
 
-	/* 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);
+			test = find_test(target);
+			if (!test)
+				errx(1, "Unknown test to run '%s'", target);
+			skip_unrelated_tests(test);
 		}
-	}
 
-	/* --target overrides known FAIL from _info */
-	add_info_options(m->info_file, !target);
+		m = get_manifest(talloc_autofree_context(), dir);
+
+		/* FIXME: This has to come after we've got manifest. */
+		if (i == 1)
+			read_config_header();
+
+		/* 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;
+		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;
+				}
+			}
 
-	while ((i = get_next_test(&normal_tests)) != NULL)
-		run_test(i, summary, &score, &total_score, m);
+			/* --target overrides known FAIL from _info */
+			if (!added_info_options && m->info_file) {
+				add_info_options(m->info_file, !target);
+				added_info_options = true;
+			}
+		}
 
-	printf("%sTotal score: %u/%u\n", prefix, score, total_score);
-	return 0;
+		printf("%sTotal score: %u/%u\n", prefix, score, total_score);
+	next: ;
+	}
+	return pass ? 0 : 1;
 }