git.ozlabs.org Git - ccan/blob - tools/configurator/configurator.c

   1 /* Simple tool to create config.h.
   2  * Would be much easier with ccan modules, but deliberately standalone.
   3  *
   4  * Copyright 2011 Rusty Russell <rusty@rustcorp.com.au>.  MIT license.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a copy
   7  * of this software and associated documentation files (the "Software"), to deal
   8  * in the Software without restriction, including without limitation the rights
   9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10  * copies of the Software, and to permit persons to whom the Software is
  11  * furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22  * THE SOFTWARE.
  23  */
  24 #include <stdio.h>
  25 #include <stdbool.h>
  26 #include <stdlib.h>
  27 #include <unistd.h>
  28 #include <err.h>
  29 #include <sys/types.h>
  30 #include <sys/wait.h>
  31 #include <sys/stat.h>
  32 #include <fcntl.h>
  33 #include <string.h>
  34
  35 #define DEFAULT_COMPILER "cc"
  36 #define DEFAULT_FLAGS "-g3 -ggdb -Wall -Wundef -Wmissing-prototypes -Wmissing-declarations -Wstrict-prototypes -Wold-style-definition"
  37
  38 #define OUTPUT_FILE "configurator.out"
  39 #define INPUT_FILE "configuratortest.c"
  40
  41 static int verbose;
  42
  43 enum test_style {
  44         OUTSIDE_MAIN            = 0x1,
  45         DEFINES_FUNC            = 0x2,
  46         INSIDE_MAIN             = 0x4,
  47         DEFINES_EVERYTHING      = 0x8,
  48         MAY_NOT_COMPILE         = 0x10,
  49         EXECUTE                 = 0x8000
  50 };
  51
  52 struct test {
  53         const char *name;
  54         enum test_style style;
  55         const char *depends;
  56         const char *fragment;
  57         bool done;
  58         bool answer;
  59 };
  60
  61 static struct test tests[] = {
  62         { "HAVE_32BIT_OFF_T", DEFINES_EVERYTHING|EXECUTE, NULL,
  63           "#include <sys/types.h>\n"
  64           "int main(int argc, char *argv[]) {\n"
  65           "     return sizeof(off_t) == 4 ? 0 : 1;\n"
  66           "}\n" },
  67         { "HAVE_ALIGNOF", INSIDE_MAIN, NULL,
  68           "return __alignof__(double) > 0 ? 0 : 1;" },
  69         { "HAVE_ASPRINTF", DEFINES_FUNC, NULL,
  70           "#define _GNU_SOURCE\n"
  71           "#include <stdio.h>\n"
  72           "static char *func(int x) {"
  73           "     char *p;\n"
  74           "     if (asprintf(&p, \"%u\", x) == -1) p = NULL;"
  75           "     return p;\n"
  76           "}" },
  77         { "HAVE_ATTRIBUTE_COLD", DEFINES_FUNC, NULL,
  78           "static int __attribute__((cold)) func(int x) { return x; }" },
  79         { "HAVE_ATTRIBUTE_CONST", DEFINES_FUNC, NULL,
  80           "static int __attribute__((const)) func(int x) { return x; }" },
  81         { "HAVE_ATTRIBUTE_MAY_ALIAS", OUTSIDE_MAIN, NULL,
  82           "typedef short __attribute__((__may_alias__)) short_a;" },
  83         { "HAVE_ATTRIBUTE_NORETURN", DEFINES_FUNC, NULL,
  84           "#include <stdlib.h>\n"
  85           "static void __attribute__((noreturn)) func(int x) { exit(x); }" },
  86         { "HAVE_ATTRIBUTE_PRINTF", DEFINES_FUNC, NULL,
  87           "static void __attribute__((format(__printf__, 1, 2))) func(const char *fmt, ...) { }" },
  88         { "HAVE_ATTRIBUTE_UNUSED", OUTSIDE_MAIN, NULL,
  89           "static int __attribute__((unused)) func(int x) { return x; }" },
  90         { "HAVE_ATTRIBUTE_USED", OUTSIDE_MAIN, NULL,
  91           "static int __attribute__((used)) func(int x) { return x; }" },
  92         { "HAVE_BACKTRACE", DEFINES_FUNC, NULL,
  93           "#include <execinfo.h>\n"
  94           "static int func(int x) {"
  95           "     void *bt[10];\n"
  96           "     return backtrace(bt, 10) < x;\n"
  97           "}" },
  98         { "HAVE_BIG_ENDIAN", INSIDE_MAIN|EXECUTE, NULL,
  99           "union { int i; char c[sizeof(int)]; } u;\n"
 100           "u.i = 0x01020304;\n"
 101           "return u.c[0] == 0x01 && u.c[1] == 0x02 && u.c[2] == 0x03 && u.c[3] == 0x04 ? 0 : 1;" },
 102         { "HAVE_BSWAP_64", DEFINES_FUNC, "HAVE_BYTESWAP_H",
 103           "#include <byteswap.h>\n"
 104           "static int func(int x) { return bswap_64(x); }" },
 105         { "HAVE_BUILTIN_CHOOSE_EXPR", INSIDE_MAIN, NULL,
 106           "return __builtin_choose_expr(1, 0, \"garbage\");" },
 107         { "HAVE_BUILTIN_CLZ", INSIDE_MAIN, NULL,
 108           "return __builtin_clz(1) == (sizeof(int)*8 - 1) ? 0 : 1;" },
 109         { "HAVE_BUILTIN_CLZL", INSIDE_MAIN, NULL,
 110           "return __builtin_clzl(1) == (sizeof(long)*8 - 1) ? 0 : 1;" },
 111         { "HAVE_BUILTIN_CLZLL", INSIDE_MAIN, NULL,
 112           "return __builtin_clzll(1) == (sizeof(long long)*8 - 1) ? 0 : 1;" },
 113         { "HAVE_BUILTIN_CONSTANT_P", INSIDE_MAIN, NULL,
 114           "return __builtin_constant_p(1) ? 0 : 1;" },
 115         { "HAVE_BUILTIN_EXPECT", INSIDE_MAIN, NULL,
 116           "return __builtin_expect(argc == 1, 1) ? 0 : 1;" },
 117         { "HAVE_BUILTIN_FFSL", INSIDE_MAIN, NULL,
 118           "return __builtin_ffsl(0L) == 0 ? 0 : 1;" },
 119         { "HAVE_BUILTIN_FFSLL", INSIDE_MAIN, NULL,
 120           "return __builtin_ffsll(0LL) == 0 ? 0 : 1;" },
 121         { "HAVE_BUILTIN_POPCOUNTL", INSIDE_MAIN, NULL,
 122           "return __builtin_popcountl(255L) == 8 ? 0 : 1;" },
 123         { "HAVE_BUILTIN_TYPES_COMPATIBLE_P", INSIDE_MAIN, NULL,
 124           "return __builtin_types_compatible_p(char *, int) ? 1 : 0;" },
 125         { "HAVE_BYTESWAP_H", OUTSIDE_MAIN, NULL,
 126           "#include <byteswap.h>\n" },
 127         { "HAVE_COMPOUND_LITERALS", INSIDE_MAIN, NULL,
 128           "int *foo = (int[]) { 1, 2, 3, 4 };\n"
 129           "return foo[0] ? 0 : 1;" },
 130         { "HAVE_ERR_H", DEFINES_FUNC, NULL,
 131           "#include <err.h>\n"
 132           "static void func(int arg) {\n"
 133           "     if (arg == 0)\n"
 134           "             err(1, \"err %u\", arg);\n"
 135           "     if (arg == 1)\n"
 136           "             errx(1, \"err %u\", arg);\n"
 137           "     if (arg == 3)\n"
 138           "             warn(\"warn %u\", arg);\n"
 139           "     if (arg == 4)\n"
 140           "             warnx(\"warn %u\", arg);\n"
 141           "}\n" },
 142         { "HAVE_FILE_OFFSET_BITS", DEFINES_EVERYTHING|EXECUTE,
 143           "HAVE_32BIT_OFF_T",
 144           "#define _FILE_OFFSET_BITS 64\n"
 145           "#include <sys/types.h>\n"
 146           "int main(int argc, char *argv[]) {\n"
 147           "     return sizeof(off_t) == 8 ? 0 : 1;\n"
 148           "}\n" },
 149         { "HAVE_FOR_LOOP_DECLARATION", INSIDE_MAIN, NULL,
 150           "for (int i = 0; i < argc; i++) { return 0; };\n"
 151           "return 1;" },
 152         { "HAVE_FLEXIBLE_ARRAY_MEMBER", OUTSIDE_MAIN, NULL,
 153           "struct foo { unsigned int x; int arr[]; };" },
 154         { "HAVE_GETPAGESIZE", DEFINES_FUNC, NULL,
 155           "#include <unistd.h>\n"
 156           "static int func(void) { return getpagesize(); }" },
 157         { "HAVE_ISBLANK", DEFINES_FUNC, NULL,
 158           "#define _GNU_SOURCE\n"
 159           "#include <ctype.h>\n"
 160           "static int func(void) { return isblank(' '); }" },
 161         { "HAVE_LITTLE_ENDIAN", INSIDE_MAIN|EXECUTE, NULL,
 162           "union { int i; char c[sizeof(int)]; } u;\n"
 163           "u.i = 0x01020304;\n"
 164           "return u.c[0] == 0x04 && u.c[1] == 0x03 && u.c[2] == 0x02 && u.c[3] == 0x01 ? 0 : 1;" },
 165         { "HAVE_MEMMEM", DEFINES_FUNC, NULL,
 166           "#define _GNU_SOURCE\n"
 167           "#include <string.h>\n"
 168           "static void *func(void *h, size_t hl, void *n, size_t nl) {\n"
 169           "return memmem(h, hl, n, nl);"
 170           "}\n", },
 171         { "HAVE_MMAP", DEFINES_FUNC, NULL,
 172           "#include <sys/mman.h>\n"
 173           "static void *func(int fd) {\n"
 174           "     return mmap(0, 65536, PROT_READ, MAP_SHARED, fd, 0);\n"
 175           "}" },
 176         { "HAVE_PROC_SELF_MAPS", DEFINES_EVERYTHING|EXECUTE, NULL,
 177           "#include <sys/types.h>\n"
 178           "#include <sys/stat.h>\n"
 179           "#include <fcntl.h>\n"
 180           "int main(void) {\n"
 181           "     return open(\"/proc/self/maps\", O_RDONLY) != -1 ? 0 : 1;\n"
 182           "}\n" },
 183         { "HAVE_QSORT_R_PRIVATE_LAST",
 184           DEFINES_EVERYTHING|EXECUTE|MAY_NOT_COMPILE, NULL,
 185           "#define _GNU_SOURCE 1\n"
 186           "#include <stdlib.h>\n"
 187           "static int cmp(const void *lp, const void *rp, void *priv) {\n"
 188           " *(unsigned int *)priv = 1;\n"
 189           " return *(const int *)lp - *(const int *)rp; }\n"
 190           "int main(void) {\n"
 191           " int array[] = { 9, 2, 5 };\n"
 192           " unsigned int called = 0;\n"
 193           " qsort_r(array, 3, sizeof(int), cmp, &called);\n"
 194           " return called && array[0] == 2 && array[1] == 5 && array[2] == 9 ? 0 : 1;\n"
 195           "}\n" },
 196         { "HAVE_SECTION_START_STOP",
 197           DEFINES_FUNC, NULL,
 198           "static void *__attribute__((__section__(\"mysec\"))) p = &p;\n"
 199           "static int func(void) {\n"
 200           "     extern void *__start_mysec[], *__stop_mysec[];\n"
 201           "     return __stop_mysec - __start_mysec;\n"
 202           "}\n" },
 203         { "HAVE_STACK_GROWS_UPWARDS", DEFINES_EVERYTHING|EXECUTE, NULL,
 204           "static long nest(const void *base, unsigned int i)\n"
 205           "{\n"
 206           "     if (i == 0)\n"
 207           "             return (const char *)&i - (const char *)base;\n"
 208           "     return nest(base, i-1);\n"
 209           "}\n"
 210           "int main(int argc, char *argv[]) {\n"
 211           "     return (nest(&argc, argc) > 0) ? 0 : 1\n;"
 212           "}\n" },
 213         { "HAVE_STATEMENT_EXPR", INSIDE_MAIN, NULL,
 214           "return ({ int x = argc; x == argc ? 0 : 1; });" },
 215         { "HAVE_SYS_FILIO_H", OUTSIDE_MAIN, NULL, /* Solaris needs this for FIONREAD */
 216           "#include <sys/filio.h>\n" },
 217         { "HAVE_TYPEOF", INSIDE_MAIN, NULL,
 218           "__typeof__(argc) i; i = argc; return i == argc ? 0 : 1;" },
 219         { "HAVE_UTIME", DEFINES_FUNC, NULL,
 220           "#include <sys/types.h>\n"
 221           "#include <utime.h>\n"
 222           "static int func(const char *filename) {\n"
 223           "     struct utimbuf times = { 0 };\n"
 224           "     return utime(filename, &times);\n"
 225           "}" },
 226         { "HAVE_WARN_UNUSED_RESULT", DEFINES_FUNC, NULL,
 227           "#include <sys/types.h>\n"
 228           "#include <utime.h>\n"
 229           "static __attribute__((warn_unused_result)) int func(int i) {\n"
 230           "     return i + 1;\n"
 231           "}" },
 232 };
 233
 234 static char *grab_fd(int fd)
 235 {
 236         int ret;
 237         size_t max, size = 0;
 238         char *buffer;
 239
 240         max = 16384;
 241         buffer = malloc(max+1);
 242         while ((ret = read(fd, buffer + size, max - size)) > 0) {
 243                 size += ret;
 244                 if (size == max)
 245                         buffer = realloc(buffer, max *= 2);
 246         }
 247         if (ret < 0)
 248                 err(1, "reading from command");
 249         buffer[size] = '\0';
 250         return buffer;
 251 }
 252
 253 static char *run(const char *cmd, int *exitstatus)
 254 {
 255         pid_t pid;
 256         int p[2];
 257         char *ret;
 258         int status;
 259
 260         if (pipe(p) != 0)
 261                 err(1, "creating pipe");
 262
 263         pid = fork();
 264         if (pid == -1)
 265                 err(1, "forking");
 266
 267         if (pid == 0) {
 268                 if (dup2(p[1], STDOUT_FILENO) != STDOUT_FILENO
 269                     || dup2(p[1], STDERR_FILENO) != STDERR_FILENO
 270                     || close(p[0]) != 0
 271                     || close(STDIN_FILENO) != 0
 272                     || open("/dev/null", O_RDONLY) != STDIN_FILENO)
 273                         exit(128);
 274
 275                 status = system(cmd);
 276                 if (WIFEXITED(status))
 277                         exit(WEXITSTATUS(status));
 278                 /* Here's a hint... */
 279                 exit(128 + WTERMSIG(status));
 280         }
 281
 282         close(p[1]);
 283         ret = grab_fd(p[0]);
 284         /* This shouldn't fail... */
 285         if (waitpid(pid, &status, 0) != pid)
 286                 err(1, "Failed to wait for child");
 287         close(p[0]);
 288         if (WIFEXITED(status))
 289                 *exitstatus = WEXITSTATUS(status);
 290         else
 291                 *exitstatus = -WTERMSIG(status);
 292         return ret;
 293 }
 294
 295 static char *connect_args(const char *argv[], const char *extra)
 296 {
 297         unsigned int i, len = strlen(extra) + 1;
 298         char *ret;
 299
 300         for (i = 1; argv[i]; i++)
 301                 len += 1 + strlen(argv[i]);
 302
 303         ret = malloc(len);
 304         len = 0;
 305         for (i = 1; argv[i]; i++) {
 306                 strcpy(ret + len, argv[i]);
 307                 len += strlen(argv[i]);
 308                 ret[len++] = ' ';
 309         }
 310         strcpy(ret + len, extra);
 311         return ret;
 312 }
 313
 314 static struct test *find_test(const char *name)
 315 {
 316         unsigned int i;
 317
 318         for (i = 0; i < sizeof(tests)/sizeof(tests[0]); i++) {
 319                 if (strcmp(tests[i].name, name) == 0)
 320                         return &tests[i];
 321         }
 322         abort();
 323 }
 324
 325 #define PRE_BOILERPLATE "/* Test program generated by configurator. */\n"
 326 #define MAIN_START_BOILERPLATE "int main(int argc, char *argv[]) {\n"
 327 #define USE_FUNC_BOILERPLATE "(void)func;\n"
 328 #define MAIN_BODY_BOILERPLATE "return 0;\n"
 329 #define MAIN_END_BOILERPLATE "}\n"
 330
 331 static bool run_test(const char *cmd, struct test *test)
 332 {
 333         char *output;
 334         FILE *outf;
 335         int status;
 336
 337         if (test->done)
 338                 return test->answer;
 339
 340         if (test->depends && !run_test(cmd, find_test(test->depends))) {
 341                 test->answer = false;
 342                 test->done = true;
 343                 return test->answer;
 344         }
 345
 346         outf = fopen(INPUT_FILE, "w");
 347         if (!outf)
 348                 err(1, "creating %s", INPUT_FILE);
 349
 350         fprintf(outf, "%s", PRE_BOILERPLATE);
 351         switch (test->style & ~(EXECUTE|MAY_NOT_COMPILE)) {
 352         case INSIDE_MAIN:
 353                 fprintf(outf, "%s", MAIN_START_BOILERPLATE);
 354                 fprintf(outf, "%s", test->fragment);
 355                 fprintf(outf, "%s", MAIN_END_BOILERPLATE);
 356                 break;
 357         case OUTSIDE_MAIN:
 358                 fprintf(outf, "%s", test->fragment);
 359                 fprintf(outf, "%s", MAIN_START_BOILERPLATE);
 360                 fprintf(outf, "%s", MAIN_BODY_BOILERPLATE);
 361                 fprintf(outf, "%s", MAIN_END_BOILERPLATE);
 362                 break;
 363         case DEFINES_FUNC:
 364                 fprintf(outf, "%s", test->fragment);
 365                 fprintf(outf, "%s", MAIN_START_BOILERPLATE);
 366                 fprintf(outf, "%s", USE_FUNC_BOILERPLATE);
 367                 fprintf(outf, "%s", MAIN_BODY_BOILERPLATE);
 368                 fprintf(outf, "%s", MAIN_END_BOILERPLATE);
 369                 break;
 370         case DEFINES_EVERYTHING:
 371                 fprintf(outf, "%s", test->fragment);
 372                 break;
 373         default:
 374                 abort();
 375
 376         }
 377         fclose(outf);
 378
 379         if (verbose > 1)
 380                 if (system("cat " INPUT_FILE) == -1);
 381
 382         output = run(cmd, &status);
 383         if (status != 0 || strstr(output, "warning")) {
 384                 if (verbose)
 385                         printf("Compile %s for %s, status %i: %s\n",
 386                                status ? "fail" : "warning",
 387                                test->name, status, output);
 388                 if ((test->style & EXECUTE) && !(test->style & MAY_NOT_COMPILE))
 389                         errx(1, "Test for %s did not compile:\n%s",
 390                              test->name, output);
 391                 test->answer = false;
 392                 free(output);
 393         } else {
 394                 /* Compile succeeded. */
 395                 free(output);
 396                 /* We run INSIDE_MAIN tests for sanity checking. */
 397                 if ((test->style & EXECUTE) || (test->style & INSIDE_MAIN)) {
 398                         output = run("./" OUTPUT_FILE, &status);
 399                         if (!(test->style & EXECUTE) && status != 0)
 400                                 errx(1, "Test for %s failed with %i:\n%s",
 401                                      test->name, status, output);
 402                         if (verbose && status)
 403                                 printf("%s exited %i\n", test->name, status);
 404                         free(output);
 405                 }
 406                 test->answer = (status == 0);
 407         }
 408         test->done = true;
 409         return test->answer;
 410 }
 411
 412 int main(int argc, const char *argv[])
 413 {
 414         char *cmd;
 415         unsigned int i;
 416         const char *default_args[]
 417                 = { "", DEFAULT_COMPILER, DEFAULT_FLAGS, NULL };
 418
 419         if (argc > 1) {
 420                 if (strcmp(argv[1], "--help") == 0) {
 421                         printf("Usage: configurator [-v] [<compiler> <flags>...]\n"
 422                                "  <compiler> <flags> will have \"-o <outfile> <infile.c>\" appended\n"
 423                                "Default: %s %s\n",
 424                                DEFAULT_COMPILER, DEFAULT_FLAGS);
 425                         exit(0);
 426                 }
 427                 if (strcmp(argv[1], "-v") == 0) {
 428                         argc--;
 429                         argv++;
 430                         verbose = 1;
 431                 } else if (strcmp(argv[1], "-vv") == 0) {
 432                         argc--;
 433                         argv++;
 434                         verbose = 2;
 435                 }
 436         }
 437
 438         if (argc == 1)
 439                 argv = default_args;
 440
 441         cmd = connect_args(argv, "-o " OUTPUT_FILE " " INPUT_FILE);
 442         for (i = 0; i < sizeof(tests)/sizeof(tests[0]); i++)
 443                 run_test(cmd, &tests[i]);
 444
 445         unlink(OUTPUT_FILE);
 446         unlink(INPUT_FILE);
 447
 448         cmd[strlen(cmd) - strlen(" -o " OUTPUT_FILE " " INPUT_FILE)] = '\0';
 449         printf("/* Generated by CCAN configurator */\n"
 450                "#ifndef CCAN_CONFIG_H\n"
 451                "#define CCAN_CONFIG_H\n");
 452         printf("#ifndef _GNU_SOURCE\n");
 453         printf("#define _GNU_SOURCE /* Always use GNU extensions. */\n");
 454         printf("#endif\n");
 455         printf("#define CCAN_COMPILER \"%s\"\n", argv[1]);
 456         printf("#define CCAN_CFLAGS \"%s\"\n\n", cmd + strlen(argv[1]) + 1);
 457         /* This one implies "#include <ccan/..." works, eg. for tdb2.h */
 458         printf("#define HAVE_CCAN 1\n");
 459         for (i = 0; i < sizeof(tests)/sizeof(tests[0]); i++)
 460                 printf("#define %s %u\n", tests[i].name, tests[i].answer);
 461         printf("#endif /* CCAN_CONFIG_H */\n");
 462         return 0;
 463 }