X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Fccanlint.c;h=4092d104160145fd6e0657187034a48da3ad845c;hp=7515a7c6f7af15eebe184699c3e731a7ce37c555;hb=0ad719f56d355a3e733b58d2accf2e7b270ac37e;hpb=016a19d260cd7f4afeb5b2b2cc28c8bbed1cd170

diff --git a/tools/ccanlint/ccanlint.c b/tools/ccanlint/ccanlint.c
index 7515a7c6..4092d104 100644
--- a/tools/ccanlint/ccanlint.c
+++ b/tools/ccanlint/ccanlint.c
@@ -31,16 +31,23 @@
 #include <ccan/talloc/talloc.h>
 #include <ccan/opt/opt.h>
 #include <ccan/foreach/foreach.h>
+#include <ccan/grab_file/grab_file.h>
+#include <ccan/cast/cast.h>
 
 int verbose = 0;
-static LIST_HEAD(compulsory_tests);
-static LIST_HEAD(normal_tests);
-static LIST_HEAD(finished_tests);
+static struct list_head compulsory_tests;
+static struct list_head normal_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 */
+const char *compiler = NULL;
+const char *cflags = NULL;
+
+const char *config_header;
+
 #if 0
 static void indent_print(const char *string)
 {
@@ -90,7 +97,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;
@@ -113,7 +121,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. */
@@ -121,7 +129,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;
@@ -142,42 +149,26 @@ static bool run_test(struct ccanlint *i,
 	if ((!score->pass && !quiet)
 	    || (score->score < score->total && verbose)
 	    || verbose > 1) {
-		printf("%s: %s", i->name, 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");
 	}
 
 	if ((!quiet && !score->pass) || verbose) {
-		struct file_error *f;
-		unsigned int lines = 1;
-
-		if (score->error)
-			printf("%s%s\n", score->error,
-			       list_empty(&score->per_file_errors) ? "" : ":");
-
-		list_for_each(&score->per_file_errors, f, list) {
-			if (f->line)
-				printf("%s:%u:%s\n",
-				       f->file->fullname, f->line, f->error);
-			else if (f->file)
-				printf("%s:%s\n", f->file->fullname, f->error);
-			else
-				printf("%s\n", f->error);
-			if (verbose < 2 && ++lines > 5) {
-				printf("... more (use -vv to see them all)\n");
-				break;
-			}
+		if (score->error) {
+			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. */
@@ -194,6 +185,10 @@ static bool run_test(struct ccanlint *i,
 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;
+	test->skip = NULL;
+	test->skip_fail = false;
 }
 
 /**
@@ -228,6 +223,13 @@ static struct ccanlint *find_test(const char *key)
 	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"
@@ -239,6 +241,9 @@ static void init_tests(void)
 	struct btree *keys, *names;
 	struct list_head *list;
 
+	list_head_init(&normal_tests);
+	list_head_init(&compulsory_tests);
+
 #undef REGISTER_TEST
 #define REGISTER_TEST(name) register_test(&normal_tests, &name)
 #include "generated-normal-tests"
@@ -250,13 +255,14 @@ static void init_tests(void)
 	foreach_ptr(list, &compulsory_tests, &normal_tests) {
 		list_for_each(list, 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, " ", NULL);
+			char **deps = strsplit(NULL, c->needs, " ");
 			unsigned int i;
 
 			for (i = 0; deps[i]; i++) {
@@ -293,29 +299,53 @@ static void init_tests(void)
 	}
 	btree_delete(keys);
 	btree_delete(names);
+}
 
-	if (!verbose)
-		return;
+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");
 
-		if (!list_empty(&c->dependencies)) {
-			const struct dependent *d;
-			printf("These depend on us:\n");
-			list_for_each(&c->dependencies, d, node)
-				printf("\t%s\n", d->dependent->name);
+		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 = find_test(testname);
-	if (!i)
-		errx(1, "No test %s to --keep", testname);
-	i->keep_results = true;
+	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;
 }
 
@@ -342,6 +372,7 @@ static void print_tests(struct list_head *tests, const char *type)
 
 static char *list_tests(void *arg)
 {
+	init_tests();
 	print_tests(&compulsory_tests, "Compulsory");
 	print_tests(&normal_tests, "Normal");
 	exit(0);
@@ -372,6 +403,7 @@ static void test_dgraph_edges(struct list_head *tests)
 
 static char *test_dependency_graph(void *arg)
 {
+	init_tests();
 	puts("digraph G {");
 
 	test_dgraph_vertices(&compulsory_tests, ", style=filled, fillcolor=yellow");
@@ -393,11 +425,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;
@@ -409,9 +460,10 @@ static void add_info_options(struct ccan_file *info, bool mark_fails)
 			continue;
 
 		for (i = 0; i < d->num_lines; i++) {
-			char **words = collapse(strsplit(d, d->lines[i], " \t",
-							 NULL), NULL);
-			if (!words[0])
+			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)
@@ -438,14 +490,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;
@@ -472,22 +559,118 @@ static void skip_unrelated_tests(struct ccanlint *target)
 				i->skip = "not relevant to target";
 }
 
+static char *demangle_string(char *string)
+{
+	unsigned int i;
+	const char mapfrom[] = "abfnrtv";
+	const char mapto[] = "\a\b\f\n\r\t\v";
+
+	if (!strchr(string, '"'))
+		return NULL;
+	string = strchr(string, '"') + 1;
+	if (!strrchr(string, '"'))
+		return NULL;
+	*strrchr(string, '"') = '\0';
+
+	for (i = 0; i < strlen(string); i++) {
+		if (string[i] == '\\') {
+			char repl;
+			unsigned len = 0;
+			const char *p = strchr(mapfrom, string[i+1]);
+			if (p) {
+				repl = mapto[p - mapfrom];
+				len = 1;
+			} else if (strlen(string+i+1) >= 3) {
+				if (string[i+1] == 'x') {
+					repl = (string[i+2]-'0')*16
+						+ string[i+3]-'0';
+					len = 3;
+				} else if (cisdigit(string[i+1])) {
+					repl = (string[i+2]-'0')*8*8
+						+ (string[i+3]-'0')*8
+						+ (string[i+4]-'0');
+					len = 3;
+				}
+			}
+			if (len == 0) {
+				repl = string[i+1];
+				len = 1;
+			}
+
+			string[i] = repl;
+			memmove(string + i + 1, string + i + len + 1,
+				strlen(string + i + len + 1) + 1);
+		}
+	}
+
+	return string;
+}
+
+
+static void read_config_header(void)
+{
+	char *fname = talloc_asprintf(NULL, "%s/config.h", ccan_dir);
+	char **lines;
+	unsigned int i;
+
+	config_header = grab_file(NULL, fname, NULL);
+	if (!config_header) {
+		talloc_free(fname);
+		return;
+	}
+
+	lines = strsplit(config_header, config_header, "\n");
+	for (i = 0; i < talloc_array_length(lines) - 1; i++) {
+		char *sym;
+		const char **line = (const char **)&lines[i];
+
+		if (!get_token(line, "#"))
+			continue;
+		if (!get_token(line, "define"))
+			continue;
+		sym = get_symbol_token(lines, line);
+		if (streq(sym, "CCAN_COMPILER") && !compiler) {
+			compiler = demangle_string(lines[i]);
+			if (!compiler)
+				errx(1, "%s:%u:could not parse CCAN_COMPILER",
+				     fname, i+1);
+			if (verbose > 1)
+				printf("%s: compiler set to '%s'\n",
+				       fname, compiler);
+		} else if (streq(sym, "CCAN_CFLAGS") && !cflags) {
+			cflags = demangle_string(lines[i]);
+			if (!cflags)
+				errx(1, "%s:%u:could not parse CCAN_CFLAGS",
+				     fname, i+1);
+			if (verbose > 1)
+				printf("%s: compiler flags set to '%s'\n",
+				       fname, cflags);
+		}
+	}
+	if (!compiler)
+		compiler = CCAN_COMPILER;
+	if (!cflags)
+		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_noarg("-n|--safe-mode", opt_set_bool, &safe_mode,
 			 "do not compile anything");
 	opt_register_noarg("-l|--list-tests", list_tests, NULL,
@@ -495,7 +678,8 @@ int main(int argc, char *argv[])
 	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)");
+			 "keep results of <testname>"
+			 " (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,
@@ -508,56 +692,98 @@ 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_const_charp,
+			 NULL, &compiler, "set the compiler");
+	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");
 
+	/* 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);
-	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;
 
-	/* 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));
+	/* This links back to the module's test dir. */
+	testlink = talloc_asprintf(NULL, "%s/test", temp_dir(NULL));
 
-	m = get_manifest(talloc_autofree_context(), dir);
+	/* Defaults to pwd. */
+	if (argc == 1) {
+		i = 1;
+		goto got_dir;
+	}
 
-	/* 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));
+	for (i = 1; i < argc; i++) {
+		unsigned int score, total_score;
+		dir = argv[i];
 
-	if (target) {
-		struct ccanlint *test;
+		if (dir[0] != '/')
+			dir = talloc_asprintf_append(NULL, "%s/%s",
+						     base_dir, dir);
+		while (strends(dir, "/"))
+			dir[strlen(dir)-1] = '\0';
 
-		test = find_test(target);
-		if (!test)
-			errx(1, "Unknown test to run '%s'", target);
-		skip_unrelated_tests(test);
-	}
+	got_dir:
+		if (dir != base_dir)
+			prefix = talloc_append_string(talloc_basename(NULL,dir),
+						      ": ");
 
-	/* 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);
+		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);
 		}
-	}
 
-	/* --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));
+
+		/* If you don't pass the compulsory tests, score is 0. */
+		score = total_score = 0;
+		while ((t = get_next_test(&compulsory_tests)) != NULL) {
+			if (!run_test(t, summary, &score, &total_score, m,
+				      prefix)) {
+				warnx("%s%s failed", prefix, t->name);
+				printf("%sTotal score: 0/%u\n",
+				       prefix, total_score);
+				pass = false;
+				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 (m->info_file)
+			add_info_options(m->info_file, !target);
 
-	printf("%sTotal score: %u/%u\n", prefix, score, total_score);
-	return 0;
+		while ((t = get_next_test(&normal_tests)) != NULL)
+			pass &= run_test(t, summary, &score, &total_score, m,
+					 prefix);
+
+		printf("%sTotal score: %u/%u\n", prefix, score, total_score);
+	next: ;
+	}
+	return pass ? 0 : 1;
 }