]> git.ozlabs.org Git - ccan/blobdiff - tools/ccanlint/ccanlint.c
ccanlint: don't crash if given bad directory name.
[ccan] / tools / ccanlint / ccanlint.c
index 931ed41a44429c91affa837c789cd7294e8287cb..7747a4976e7cd1ea748191ff5246480806cb027b 100644 (file)
@@ -19,6 +19,7 @@
  */
 #include "ccanlint.h"
 #include "../tools.h"
+#include "../read_config_header.h"
 #include <unistd.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <err.h>
 #include <ctype.h>
 #include <ccan/str/str.h>
-#include <ccan/str_talloc/str_talloc.h>
-#include <ccan/talloc/talloc.h>
+#include <ccan/take/take.h>
 #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>
+#include <ccan/tal/path/path.h>
 #include <ccan/strmap/strmap.h>
 
 struct ccanlint_map {
@@ -46,10 +46,6 @@ bool keep_results = false;
 static bool targeting = false;
 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;
 
 const char *ccan_dir;
@@ -93,10 +89,11 @@ static const char *dep_failed(struct manifest *m)
        return "dependency couldn't run";
 }
 
-static bool cannot_run(struct dgraph_node *node, void *unused)
+static bool cannot_run(struct dgraph_node *node, void *all)
 {
        struct ccanlint *c = container_of(node, struct ccanlint, node);
        c->can_run = dep_failed;
+
        return true;
 }
 
@@ -117,7 +114,7 @@ static bool run_test(struct dgraph_node *n, struct run_info *run)
        if (i->done)
                return true;
 
-       score = talloc(run->m, struct score);
+       score = tal(run->m, struct score);
        list_head_init(&score->per_file_errors);
        score->error = NULL;
        score->pass = false;
@@ -213,7 +210,7 @@ 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 = tal_arr(NULL, char *, 1);
        test->options[0] = NULL;
        dgraph_init_node(&test->node);
 }
@@ -257,7 +254,7 @@ bool is_excluded(const char *name)
 
 static bool init_deps(const char *member, struct ccanlint *c, void *unused)
 {
-       char **deps = strsplit(NULL, c->needs, " ");
+       char **deps = tal_strsplit(NULL, c->needs, " ", STR_EMPTY_OK);
        unsigned int i;
 
        for (i = 0; deps[i]; i++) {
@@ -269,7 +266,7 @@ static bool init_deps(const char *member, struct ccanlint *c, void *unused)
                             deps[i], c->key);
                dgraph_add_edge(&dep->node, &c->node);
        }
-       talloc_free(deps);
+       tal_free(deps);
        return true;
 }
 
@@ -339,10 +336,9 @@ static void print_test_depends(void)
 }
 
 
-static int show_tmpdir(const char *dir)
+static void show_tmpdir(const char *dir)
 {
        printf("You can find ccanlint working files in '%s'\n", dir);
-       return 0;
 }
 
 static char *keep_tests(void *unused)
@@ -350,7 +346,8 @@ static char *keep_tests(void *unused)
        keep_results = true;
 
        /* Don't automatically destroy temporary dir. */
-       talloc_set_destructor(temp_dir(NULL), show_tmpdir);
+       keep_temp_dir();
+       tal_add_destructor(temp_dir(), show_tmpdir);
        return NULL;
 }
 
@@ -366,8 +363,7 @@ static char *exclude_test(const char *testname, void *unused)
 {
        struct ccanlint *i = find_test(testname);
        if (!i)
-               return talloc_asprintf(NULL, "No test %s to --exclude",
-                                      testname);
+               return tal_fmt(NULL, "No test %s to --exclude", testname);
 
        /* Remove this, and everything which depends on it. */
        dgraph_traverse_from(&i->node, remove_test, "excluded on command line");
@@ -441,21 +437,6 @@ static char *test_dependency_graph(void *arg)
        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)
 {
@@ -465,11 +446,9 @@ static void add_options(struct ccanlint *test, char **options,
                num = 0;
        else
                /* -1, because last one is NULL. */
-               num = talloc_array_length(test->options) - 1;
+               num = tal_count(test->options) - 1;
 
-       test->options = talloc_realloc(NULL, test->options,
-                                      char *,
-                                      num + num_options + 1);
+       tal_resize(&test->options, num + num_options + 1);
        memcpy(&test->options[num], options, (num_options + 1)*sizeof(char *));
 }
 
@@ -484,10 +463,9 @@ void add_info_options(struct ccan_file *info)
                        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)
+                       char **words = tal_strsplit(d, d->lines[i], " \t",
+                                                   STR_NO_EMPTY);
+                       if (!words[0])
                                continue;
 
                        if (strncmp(words[0], "//", 2) == 0)
@@ -516,7 +494,7 @@ void add_info_options(struct ccan_file *info)
                                if (!test->takes_options)
                                        warnx("%s: %s doesn't take options",
                                              info->fullname, words[0]);
-                               add_options(test, words+1, num_words-1);
+                               add_options(test, words+1, tal_count(words)-1);
                        }
                }
        }
@@ -532,7 +510,7 @@ char **per_file_options(const struct ccanlint *test, struct ccan_file *f)
        if (!test->options[0])
                return test->options;
 
-       ret = talloc_array(f, char *, talloc_array_length(test->options));
+       ret = tal_arr(f, char *, tal_count(test->options));
        for (i = 0; test->options[i]; i++) {
                char *optname;
 
@@ -546,7 +524,7 @@ char **per_file_options(const struct ccanlint *test, struct ccan_file *f)
 
                /* FAIL overrides anything else. */
                if (streq(optname, "FAIL")) {
-                       ret = talloc_array(f, char *, 2);
+                       ret = tal_arr(f, char *, 2);
                        ret[0] = (char *)"FAIL";
                        ret[1] = NULL;
                        return ret;
@@ -555,102 +533,9 @@ char **per_file_options(const struct ccanlint *test, struct ccan_file *f)
        }
        ret[j] = NULL;
 
-       /* Shrink it to size so talloc_array_length() works as expected. */
-       return talloc_realloc(NULL, ret, char *, j + 1);
-}
-
-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;
+       /* Shrink it to size so tal_array_length() works as expected. */
+       tal_resize(&ret, j + 1);
+       return ret;
 }
 
 static char *opt_set_const_charp(const char *arg, const char **p)
@@ -662,7 +547,7 @@ static char *opt_set_target(const char *arg, struct dgraph_node *all)
 {
        struct ccanlint *t = find_test(arg);
        if (!t)
-               return talloc_asprintf(NULL, "unknown --target %s", arg);
+               return tal_fmt(NULL, "unknown --target %s", arg);
 
        targeting = true;
        dgraph_add_edge(&t->node, all);
@@ -697,17 +582,32 @@ static bool add_to_all(const char *member, struct ccanlint *c,
        return true;
 }
 
+static bool test_module(struct dgraph_node *all,
+                       const char *dir, const char *prefix, bool summary)
+{
+       struct manifest *m = get_manifest(autofree(), dir);
+       char *testlink = path_join(NULL, temp_dir(), "test");
+
+       /* Create a symlink from temp dir back to src dir's
+        * test directory. */
+       unlink(testlink);
+       if (symlink(path_join(m, dir, "test"), testlink) != 0)
+               err(1, "Creating test symlink in %s", temp_dir());
+
+       return run_tests(all, summary, m, prefix);
+}
+
 int main(int argc, char *argv[])
 {
        bool summary = false, pass = true;
        unsigned int i;
-       struct manifest *m;
        const char *prefix = "";
-       char *dir = talloc_getcwd(NULL), *base_dir = dir, *testlink;
-       struct dgraph_node all;
+       char *cwd = path_cwd(NULL), *dir;
+       struct ccanlint top;  /* cannot_run may try to set ->can_run */
+       const char *override_compiler = NULL, *override_cflags = NULL;
        
        /* Empty graph node to which we attach everything else. */
-       dgraph_init_node(&all);
+       dgraph_init_node(&top.node);
 
        opt_register_early_noarg("--verbose|-v", opt_inc_intval, &verbose,
                                 "verbose mode (up to -vvvv)");
@@ -726,12 +626,13 @@ int main(int argc, char *argv[])
        opt_register_arg("--timeout <milleseconds>", opt_set_uintval,
                         NULL, &timeout,
                         "ignore (terminate) tests that are slower than this");
-       opt_register_arg("-t|--target <testname>", opt_set_target, NULL, &all,
+       opt_register_arg("-t|--target <testname>", opt_set_target, NULL,
+                        &top.node,
                         "only run one test (and its prerequisites)");
        opt_register_arg("--compiler <compiler>", opt_set_const_charp,
-                        NULL, &compiler, "set the compiler");
+                        NULL, &override_compiler, "set the compiler");
        opt_register_arg("--cflags <flags>", opt_set_const_charp,
-                        NULL, &cflags, "set the compiler flags");
+                        NULL, &override_cflags, "set the compiler flags");
        opt_register_noarg("-?|-h|--help", opt_usage_and_exit,
                           "\nA program for checking and guiding development"
                           " of CCAN modules.",
@@ -741,8 +642,8 @@ int main(int argc, char *argv[])
        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));
+       if (chdir(temp_dir()) != 0)
+               err(1, "Error changing to %s temporary dir", temp_dir());
 
        init_tests();
 
@@ -756,55 +657,41 @@ int main(int argc, char *argv[])
        opt_parse(&argc, argv, opt_log_stderr_exit);
 
        if (!targeting)
-               strmap_iterate(&tests, add_to_all, &all);
-
-       /* This links back to the module's test dir. */
-       testlink = talloc_asprintf(NULL, "%s/test", temp_dir(NULL));
-
-       /* Defaults to pwd. */
-       if (argc == 1) {
-               i = 1;
-               goto got_dir;
-       }
+               strmap_iterate(&tests, add_to_all, &top.node);
 
-       for (i = 1; i < argc; i++) {
-               unsigned int score, total_score;
-
-               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:
-               /* We assume there's a ccan/ in there somewhere... */
-               if (i == 1) {
-                       ccan_dir = find_ccan_dir(dir);
-                       if (!ccan_dir)
-                               errx(1, "Cannot find ccan/ base directory in %s",
-                                    dir);
-                       read_config_header();
+       if (argc == 1)
+               dir = cwd;
+       else
+               dir = path_join(NULL, cwd, argv[1]);
+
+       ccan_dir = find_ccan_dir(dir);
+       if (!ccan_dir)
+               errx(1, "Cannot find ccan/ base directory in %s", dir);
+       config_header = read_config_header(ccan_dir, verbose > 1);
+
+       /* We do this after read_config_header has set compiler & cflags */
+       if (override_cflags)
+               cflags = override_cflags;
+       if (override_compiler)
+               compiler = override_compiler;
+
+       if (argc == 1)
+               pass = test_module(&top.node, cwd, "", summary);
+       else {
+               for (i = 1; i < argc; i++) {
+                       dir = path_canon(NULL,
+                                        take(path_join(NULL, cwd, argv[i])));
+                       if (!dir)
+                               err(1, "Cannot get canonical name of '%s'",
+                                   argv[i]);
+
+                       prefix = path_join(NULL, ccan_dir, "ccan");
+                       prefix = path_rel(NULL, take(prefix), dir);
+                       prefix = tal_strcat(NULL, take(prefix), ": ");
+
+                       pass &= test_module(&top.node, dir, prefix, summary);
+                       reset_tests(&top.node);
                }
-
-               if (dir != base_dir)
-                       prefix = talloc_append_string(talloc_basename(NULL,dir),
-                                                     ": ");
-
-               m = get_manifest(talloc_autofree_context(), dir);
-
-               /* 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;
-               if (!run_tests(&all, summary, m, prefix))
-                       pass = false;
-
-               reset_tests(&all);
        }
        return pass ? 0 : 1;
 }