]> git.ozlabs.org Git - ccan/blobdiff - tools/configurator/configurator.c
configurator: fix crash when more than one extra test provided
[ccan] / tools / configurator / configurator.c
index 43fbf1f6b94067d565377fc05c206f087fce78c2..f15f34483c36352549af73a9facea230ced71bfe 100644 (file)
  */
 #define _POSIX_C_SOURCE 200809L                /* For pclose, popen, strdup */
 
+#define EXIT_BAD_USAGE           1
+#define EXIT_TROUBLE_RUNNING     2
+#define EXIT_BAD_TEST            3
+#define EXIT_BAD_INPUT           4
+
 #include <errno.h>
 #include <stdio.h>
 #include <stdarg.h>
@@ -100,7 +105,10 @@ struct test {
        bool answer;
 };
 
-static struct test tests[] = {
+/* Terminated by a NULL name */
+static struct test *tests;
+
+static const struct test base_tests[] = {
        { "HAVE_32BIT_OFF_T", "off_t is 32 bits",
          "DEFINES_EVERYTHING|EXECUTE|MAY_NOT_COMPILE", NULL, NULL,
          "#include <sys/types.h>\n"
@@ -128,6 +136,15 @@ static struct test tests[] = {
        { "HAVE_ATTRIBUTE_CONST", "__attribute__((const)) support",
          "DEFINES_FUNC", NULL, NULL,
          "static int __attribute__((const)) func(int x) { return x; }" },
+       { "HAVE_ATTRIBUTE_DEPRECATED", "__attribute__((deprecated)) support",
+         "DEFINES_FUNC", NULL, NULL,
+         "static int __attribute__((deprecated)) func(int x) { return x; }" },
+       { "HAVE_ATTRIBUTE_NONNULL", "__attribute__((nonnull)) support",
+         "DEFINES_FUNC", NULL, NULL,
+         "static char *__attribute__((nonnull)) func(char *p) { return p; }" },
+       { "HAVE_ATTRIBUTE_SENTINEL", "__attribute__((sentinel)) support",
+         "DEFINES_FUNC", NULL, NULL,
+         "static int __attribute__((sentinel)) func(int i, ...) { return i; }" },
        { "HAVE_ATTRIBUTE_PURE", "__attribute__((pure)) support",
          "DEFINES_FUNC", NULL, NULL,
          "static int __attribute__((pure)) func(int x) { return x; }" },
@@ -541,7 +558,7 @@ static char *grab_stream(FILE *file)
        }
        size += ret;
        if (ferror(file))
-               c12r_err(1, "reading from command");
+               c12r_err(EXIT_TROUBLE_RUNNING, "reading from command");
        buffer[size] = '\0';
        return buffer;
 }
@@ -561,7 +578,7 @@ static char *run(const char *cmd, int *exitstatus)
 
        cmdout = popen(cmdredir, "r");
        if (!cmdout)
-               c12r_err(1, "popen \"%s\"", cmdredir);
+               c12r_err(EXIT_TROUBLE_RUNNING, "popen \"%s\"", cmdredir);
 
        free(cmdredir);
 
@@ -598,10 +615,11 @@ static struct test *find_test(const char *name)
 {
        unsigned int i;
 
-       for (i = 0; i < sizeof(tests)/sizeof(tests[0]); i++) {
+       for (i = 0; tests[i].name; i++) {
                if (strcmp(tests[i].name, name) == 0)
                        return &tests[i];
        }
+       c12r_errx(EXIT_BAD_TEST, "Unknown test %s", name);
        abort();
 }
 
@@ -657,7 +675,7 @@ static bool run_test(const char *cmd, struct test *test)
 
        outf = fopen(INPUT_FILE, verbose > 1 ? "w+" : "w");
        if (!outf)
-               c12r_err(1, "creating %s", INPUT_FILE);
+               c12r_err(EXIT_TROUBLE_RUNNING, "creating %s", INPUT_FILE);
 
        fprintf(outf, "%s", PRE_BOILERPLATE);
 
@@ -679,7 +697,7 @@ static bool run_test(const char *cmd, struct test *test)
        } else if (strstr(test->style, "DEFINES_EVERYTHING")) {
                fprintf(outf, "%s", test->fragment);
        } else
-               c12r_errx(2, "Unknown style for test %s: %s",
+               c12r_errx(EXIT_BAD_TEST, "Unknown style for test %s: %s",
                          test->name, test->style);
 
        if (verbose > 1) {
@@ -721,7 +739,8 @@ static bool run_test(const char *cmd, struct test *test)
                               test->name, status, output);
                if (strstr(test->style, "EXECUTE")
                    && !strstr(test->style, "MAY_NOT_COMPILE"))
-                       c12r_errx(1, "Test for %s did not compile:\n%s",
+                       c12r_errx(EXIT_BAD_TEST,
+                                 "Test for %s did not compile:\n%s",
                                  test->name, output);
                test->answer = false;
                free(output);
@@ -733,7 +752,8 @@ static bool run_test(const char *cmd, struct test *test)
                    || strstr(test->style, "INSIDE_MAIN")) {
                        output = run("." DIR_SEP OUTPUT_FILE, &status);
                        if (!strstr(test->style, "EXECUTE") && status != 0)
-                               c12r_errx(1, "Test for %s failed with %i:\n%s",
+                               c12r_errx(EXIT_BAD_TEST,
+                                         "Test for %s failed with %i:\n%s",
                                          test->name, status, output);
                        if (verbose && status)
                                printf("%s exited %i\n", test->name, status);
@@ -752,6 +772,127 @@ static bool run_test(const char *cmd, struct test *test)
        return test->answer;
 }
 
+static char *any_field(char **fieldname)
+{
+       char buf[1000];
+       for (;;) {
+               char *p, *eq;
+
+               if (!fgets(buf, sizeof(buf), stdin))
+                       return NULL;
+
+               p = buf;
+               /* Ignore whitespace, lines starting with # */
+               while (*p == ' ' || *p == '\t')
+                       p++;
+               if (*p == '#' || *p == '\n')
+                       continue;
+
+               eq = strchr(p, '=');
+               if (!eq)
+                       c12r_errx(EXIT_BAD_INPUT, "no = in line: %s", p);
+               *eq = '\0';
+               *fieldname = strdup(p);
+               p = eq + 1;
+               if (strlen(p) && p[strlen(p)-1] == '\n')
+                       p[strlen(p)-1] = '\0';
+               return strdup(p);
+       }
+}
+
+static char *read_field(const char *name, bool compulsory)
+{
+       char *fieldname, *value;
+
+       value = any_field(&fieldname);
+       if (!value) {
+               if (!compulsory)
+                       return NULL;
+               c12r_errx(EXIT_BAD_INPUT, "Could not read field %s", name);
+       }
+       if (strcmp(fieldname, name) != 0)
+               c12r_errx(EXIT_BAD_INPUT,
+                         "Expected field %s not %s", name, fieldname);
+       return value;
+}
+
+/* Test descriptions from stdin:
+ * Lines starting with # or whitespace-only are ignored.
+ *
+ * First three non-ignored lines must be:
+ *  var=<varname>
+ *  desc=<description-for-autotools-style>
+ *  style=OUTSIDE_MAIN DEFINES_FUNC INSIDE_MAIN DEFINES_EVERYTHING EXECUTE MAY_NOT_COMPILE
+ *
+ * Followed by optional lines:
+ *  depends=<space-separated-testnames, ! to invert>
+ *  link=<extra args for link line>
+ *  flags=<extra args for compile line>
+ *  overrides=<testname-to-force>
+ *
+ * Finally a code line, either:
+ *  code=<oneline> OR
+ *  code=
+ *  <lines of code>
+ *  <end-comment>
+ *
+ * And <end-comment> looks like this next comment: */
+/*END*/
+static bool read_test(struct test *test)
+{
+       char *field, *value;
+       char buf[1000];
+
+       memset(test, 0, sizeof(*test));
+       test->name = read_field("var", false);
+       if (!test->name)
+               return false;
+       test->desc = read_field("desc", true);
+       test->style = read_field("style", true);
+       /* Read any optional fields. */
+       while ((value = any_field(&field)) != NULL) {
+               if (strcmp(field, "depends") == 0)
+                       test->depends = value;
+               else if (strcmp(field, "link") == 0)
+                       test->link = value;
+               else if (strcmp(field, "flags") == 0)
+                       test->flags = value;
+               else if (strcmp(field, "overrides") == 0)
+                       test->overrides = value;
+               else if (strcmp(field, "code") == 0)
+                       break;
+               else
+                       c12r_errx(EXIT_BAD_INPUT, "Unknown field %s in %s",
+                                 field, test->name);
+       }
+       if (!value)
+               c12r_errx(EXIT_BAD_INPUT, "Missing code in %s", test->name);
+
+       if (strlen(value) == 0) {
+               /* Multiline program, read to END comment */
+               while (fgets(buf, sizeof(buf), stdin) != 0) {
+                       size_t n;
+                       if (strncmp(buf, "/*END*/", 7) == 0)
+                               break;
+                       n = strlen(value);
+                       value = realloc(value, n + strlen(buf) + 1);
+                       strcpy(value + n, buf);
+                       n += strlen(buf);
+               }
+       }
+       test->fragment = value;
+       return true;
+}
+
+static void read_tests(size_t num_tests)
+{
+       while (read_test(tests + num_tests)) {
+               num_tests++;
+               tests = realloc(tests, (num_tests + 1) * sizeof(tests[0]));
+               tests[num_tests].name = NULL;
+       }
+}
+
 int main(int argc, const char *argv[])
 {
        char *cmd;
@@ -763,6 +904,7 @@ int main(int argc, const char *argv[])
        const char *orig_cc;
        const char *varfile = NULL;
        const char *headerfile = NULL;
+       bool extra_tests = false;
        FILE *outf;
 
        if (argc > 0)
@@ -770,7 +912,7 @@ int main(int argc, const char *argv[])
 
        while (argc > 1) {
                if (strcmp(argv[1], "--help") == 0) {
-                       printf("Usage: configurator [-v] [--var-file=<filename>] [-O<outflag>] [--configurator-cc=<compiler-for-tests>] [--autotools-style] [<compiler> <flags>...]\n"
+                       printf("Usage: configurator [-v] [--var-file=<filename>] [-O<outflag>] [--configurator-cc=<compiler-for-tests>] [--autotools-style] [--extra-tests] [<compiler> <flags>...]\n"
                               "  <compiler> <flags> will have \"<outflag> <outfile> <infile.c>\" appended\n"
                               "Default: %s %s %s\n",
                               DEFAULT_COMPILER, DEFAULT_FLAGS,
@@ -785,7 +927,7 @@ int main(int argc, const char *argv[])
                                fprintf(stderr,
                                        "%s: option requires an argument -- O\n",
                                        argv[0]);
-                               exit(1);
+                               exit(EXIT_BAD_USAGE);
                        }
                } else if (strcmp(argv[1], "-v") == 0) {
                        argc--;
@@ -811,10 +953,14 @@ int main(int argc, const char *argv[])
                        headerfile = argv[1] + 14;
                        argc--;
                        argv++;
+               } else if (strcmp(argv[1], "--extra-tests") == 0) {
+                       extra_tests = true;
+                       argc--;
+                       argv++;
                } else if (strcmp(argv[1], "--") == 0) {
                        break;
                } else if (argv[1][0] == '-') {
-                       c12r_errx(2, "Unknown option %s", argv[1]);
+                       c12r_errx(EXIT_BAD_USAGE, "Unknown option %s", argv[1]);
                } else {
                        break;
                }
@@ -823,6 +969,14 @@ int main(int argc, const char *argv[])
        if (argc == 1)
                argv = default_args;
 
+       /* Copy with NULL entry at end */
+       tests = calloc(sizeof(base_tests)/sizeof(base_tests[0]) + 1,
+                      sizeof(base_tests[0]));
+       memcpy(tests, base_tests, sizeof(base_tests));
+
+       if (extra_tests)
+               read_tests(sizeof(base_tests)/sizeof(base_tests[0]));
+
        orig_cc = argv[1];
        if (configurator_cc)
                argv[1] = configurator_cc;
@@ -833,7 +987,7 @@ int main(int argc, const char *argv[])
                sleep(1);
                end_test(1);
        }
-       for (i = 0; i < sizeof(tests)/sizeof(tests[0]); i++)
+       for (i = 0; tests[i].name; i++)
                run_test(cmd, &tests[i]);
        free(cmd);
 
@@ -849,13 +1003,15 @@ int main(int argc, const char *argv[])
                        start_test("Writing variables to ", varfile);
                        vars = fopen(varfile, "a");
                        if (!vars)
-                               c12r_err(2, "Could not open %s", varfile);
+                               c12r_err(EXIT_TROUBLE_RUNNING,
+                                        "Could not open %s", varfile);
                }
-               for (i = 0; i < sizeof(tests)/sizeof(tests[0]); i++)
+               for (i = 0; tests[i].name; i++)
                        fprintf(vars, "%s=%u\n", tests[i].name, tests[i].answer);
                if (vars != stdout) {
                        if (fclose(vars) != 0)
-                               c12r_err(2, "Closing %s", varfile);
+                               c12r_err(EXIT_TROUBLE_RUNNING,
+                                        "Closing %s", varfile);
                        end_test(1);
                }
        }
@@ -864,7 +1020,8 @@ int main(int argc, const char *argv[])
                start_test("Writing header to ", headerfile);
                outf = fopen(headerfile, "w");
                if (!outf)
-                       c12r_err(2, "Could not open %s", headerfile);
+                       c12r_err(EXIT_TROUBLE_RUNNING,
+                                "Could not open %s", headerfile);
        } else
                outf = stdout;
 
@@ -881,13 +1038,13 @@ int main(int argc, const char *argv[])
        fprintf(outf, "#define CCAN_OUTPUT_EXE_CFLAG \"%s\"\n\n", outflag);
        /* This one implies "#include <ccan/..." works, eg. for tdb2.h */
        fprintf(outf, "#define HAVE_CCAN 1\n");
-       for (i = 0; i < sizeof(tests)/sizeof(tests[0]); i++)
+       for (i = 0; tests[i].name; i++)
                fprintf(outf, "#define %s %u\n", tests[i].name, tests[i].answer);
        fprintf(outf, "#endif /* CCAN_CONFIG_H */\n");
 
        if (headerfile) {
                if (fclose(outf) != 0)
-                       c12r_err(2, "Closing %s", headerfile);
+                       c12r_err(EXIT_TROUBLE_RUNNING, "Closing %s", headerfile);
                end_test(1);
        }