X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=tools%2Fccanlint%2Ftests%2Fexamples_compile.c;h=745860668beddc8e158d3d5226dc3a4d0b4b849b;hp=a3a3d1d595c88a5e8cfb7384c99b087aa416df64;hb=9e207bca5bf5e0a1e3653a91649414fab793c801;hpb=02c515a11a176ffe7e38738108e51aa81c23ba65 diff --git a/tools/ccanlint/tests/examples_compile.c b/tools/ccanlint/tests/examples_compile.c index a3a3d1d5..74586066 100644 --- a/tools/ccanlint/tests/examples_compile.c +++ b/tools/ccanlint/tests/examples_compile.c @@ -1,6 +1,10 @@ #include #include -#include +#include +#include +#include +#include +#include #include #include #include @@ -10,6 +14,8 @@ #include #include #include +#include +#include "build.h" static const char *can_run(struct manifest *m) { @@ -20,141 +26,172 @@ static const char *can_run(struct manifest *m) return NULL; } -/* FIXME: We should build if it doesn't exist... */ -static bool expect_obj_file(const char *dir) +static void add_mod(struct manifest ***deps, struct manifest *m) { - struct manifest *dep_man; - bool has_c_files; - - dep_man = get_manifest(dir, dir); - - /* If it has C files, we expect an object file built from them. */ - has_c_files = !list_empty(&dep_man->c_files); - talloc_free(dep_man); - return has_c_files; + unsigned int num = tal_count(*deps); + tal_resize(deps, num + 1); + (*deps)[num] = m; } -static char *add_dep(const struct manifest *m, char *list, const char *mod) +static bool have_mod(struct manifest *deps[], const char *modname) { - char **deps, *obj; unsigned int i; - /* Not ourselves. */ - if (streq(m->basename, mod)) - return list; + for (i = 0; i < tal_count(deps); i++) + if (strcmp(deps[i]->modname, modname) == 0) + return true; + return false; +} - /* Not if there's no object file for that module */ - if (!expect_obj_file(talloc_asprintf(list, "%s/ccan/%s", ccan_dir,mod))) - return list; +static void add_dep(struct manifest ***deps, const char *modname) +{ + unsigned int i; + struct manifest *m; + char *errstr; - obj = talloc_asprintf(list, "%s/ccan/%s.o", ccan_dir, mod); + if (have_mod(*deps, modname)) + return; - /* Not anyone we've already included. */ - if (strstr(list, obj)) - return list; + m = get_manifest(*deps, + tal_fmt(*deps, "%s/ccan/%s", ccan_dir, modname)); + errstr = build_submodule(m, cflags, COMPILE_NORMAL); + if (errstr) + errx(1, "%s", errstr); - list = talloc_asprintf_append(list, " %s", obj); + add_mod(deps, m); /* Get that modules depends as well... */ assert(!safe_mode); - deps = get_deps(m, talloc_asprintf(list, "%s/ccan/%s", ccan_dir, mod), - false, NULL); + if (m->info_file) { + char **infodeps; + + infodeps = get_deps(m, m->dir, "depends", false, + get_or_compile_info); - for (i = 0; deps[i]; i++) { - if (strstarts(deps[i], "ccan/")) - list = add_dep(m, list, deps[i] + strlen("ccan/")); + for (i = 0; infodeps[i]; i++) { + if (strstarts(infodeps[i], "ccan/")) + add_dep(deps, infodeps[i] + strlen("ccan/")); + } } - return list; } -static char *obj_list(const struct manifest *m, struct ccan_file *f) +static struct manifest **get_example_deps(struct manifest *m, + struct ccan_file *f) { - char *list = talloc_strdup(m, ""); - struct ccan_file *i; char **lines; + struct manifest **deps = tal_arr(f, struct manifest *, 0); - /* Object files for this module. */ - list_for_each(&m->c_files, i, list) - list = talloc_asprintf_append(list, " %s", i->compiled); - - /* Other ccan modules we depend on. */ - list_for_each(&m->dep_dirs, i, list) { - if (i->compiled) - list = talloc_asprintf_append(list, " %s", i->compiled); - } + /* This one for a start. */ + add_dep(&deps, m->modname); /* Other modules implied by includes. */ for (lines = get_ccan_file_lines(f); *lines; lines++) { - unsigned preflen = strspn(*lines, " \t"); - if (strstarts(*lines + preflen, "#include compiled[COMPILE_NORMAL]) + tal_append_fmt(&list, " %s", + deps[i]->compiled[COMPILE_NORMAL]); + } return list; } -static char *lib_list(const struct manifest *m) +static char *example_lib_list(const void *ctx, struct manifest **deps) { - unsigned int i, num; - char **libs = get_libs(m, ".", &num, &m->info_file->compiled); - char *ret = talloc_strdup(m, ""); + char *list = tal_strdup(ctx, ""); + char **libs; + unsigned int i, j; + + /* FIXME: This doesn't uniquify. */ + for (i = 0; i < tal_count(deps); i++) { + libs = get_libs(ctx, deps[i]->dir, NULL, get_or_compile_info); + for (j = 0; libs[j]; j++) + tal_append_fmt(&list, "-l%s ", libs[j]); + } + return list; +} - for (i = 0; i < num; i++) - ret = talloc_asprintf_append(ret, "-l%s ", libs[i]); +static char *cflags_list(const struct manifest *m) +{ + unsigned int i; + char *ret = tal_strdup(m, cflags); + + char **flags = get_cflags(m, m->dir, get_or_compile_info); + for (i = 0; flags[i]; i++) + tal_append_fmt(&ret, " %s", flags[i]); return ret; } -static char *compile(const void *ctx, - struct manifest *m, - struct ccan_file *file, - bool keep) +/* FIXME: Test with reduced features! */ +static bool compile(const void *ctx, + struct manifest *m, + struct ccan_file *file, + char **output) { - char *errmsg; - - file->compiled = maybe_temp_file(ctx, "", keep, file->fullname); - errmsg = compile_and_link(ctx, file->fullname, ccan_dir, - obj_list(m, file), - "", lib_list(m), file->compiled); - if (errmsg) { - talloc_free(file->compiled); - file->compiled = NULL; - return errmsg; + struct manifest **deps = get_example_deps(m, file); + const char *flags = cflags_list(m); + + file->compiled[COMPILE_NORMAL] = temp_file(ctx, "", file->fullname); + if (!compile_and_link(ctx, file->fullname, ccan_dir, + example_obj_list(file, deps), + compiler, flags, + example_lib_list(file, deps), + file->compiled[COMPILE_NORMAL], + output)) { + /* Don't keep failures, even with --keep */ + unlink(file->compiled[COMPILE_NORMAL]); + file->compiled[COMPILE_NORMAL] = NULL; + return false; } - return NULL; + return true; } -static char *start_main(char *ret, const char *why) +static void start_main(char **ret, const char *why) { - return talloc_asprintf_append(ret, + tal_append_fmt(ret, "/* The example %s, so fake function wrapper inserted */\n" "int main(int argc, char *argv[])\n" - "{\n", why); + "{\n", why); } /* We only handle simple function definitions here. */ -static char *add_func(char *others, const char *line) +static char *add_func(const tal_t *ctx, char *others, const char *line) { const char *p, *end = strchr(line, '(') - 1; - while (isblank(*end)) { + char *use; + + while (cisspace(*end)) { end--; if (end == line) return others; } - for (p = end; isalnum(*p) || *p == '_'; p--) { + for (p = end; cisalnum(*p) || *p == '_'; p--) { if (p == line) return others; } - return talloc_asprintf_append(others, "printf(\"%%p\", %.*s);\n", - (unsigned)(end - p + 1), p); + use = tal_fmt(ctx, "printf(\"%%p\", %.*s);\n", + (unsigned)(end - p), p+1); + if (others) + use = tal_strcat(ctx, take(others), take(use)); + + return use; } static void strip_leading_whitespace(char **lines) @@ -185,58 +222,72 @@ static bool looks_internal(char **lines, char **why) const char *line = lines[i] + strspn(lines[i], " \t"); unsigned len = strspn(line, IDENT_CHARS); - if (!line[0] || isblank(line[0]) || strstarts(line, "//")) + if (!line[0] || cisspace(line[0]) || strstarts(line, "//") + || strstarts(line, "#line")) continue; + assert(line[strlen(line)-1] != '\n'); + /* The winners. */ if (strstarts(line, "if") && len == 2) { - *why = "starts with if"; + *why = cast_const(char *, "starts with if"); return true; } if (strstarts(line, "for") && len == 3) { - *why = "starts with for"; + *why = cast_const(char *, "starts with for"); return true; } if (strstarts(line, "while") && len == 5) { - *why = "starts with while"; + *why = cast_const(char *, "starts with while"); return true; } if (strstarts(line, "do") && len == 2) { - *why = "starts with do"; + *why = cast_const(char *, "starts with do"); return true; } /* The losers. */ if (strstarts(line, "#include")) { - *why = "starts with #include"; + *why = cast_const(char *, "starts with #include"); return false; } if (last_ended && strchr(line, '(')) { if (strstarts(line, "static")) { - *why = "starts with static and contains ("; + *why = cast_const(char *, + "starts with static" + " and contains ("); return false; } if (strends(line, ")")) { - *why = "contains ( and ends with )"; + *why = cast_const(char *, + "contains ( and ends with )"); return false; } } + /* Previously prepended. */ + if (strstr(line, "didn't seem to belong inside a function")) { + *why = cast_const(char *, "Comment said so"); + return false; + } + /* Single identifier then operator == inside function. */ if (last_ended && len - && ispunct(line[len+strspn(line+len, " ")])) { - *why = "starts with identifier then punctuation"; + && cispunct(line[len+strspn(line+len, " ")])) { + *why = cast_const(char *, "starts with identifier" + " then punctuation"); return true; } last_ended = (strends(line, "}") || strends(line, ";") + || strends(line, "*/") || streq(line, "...")); } /* No idea... Say yes? */ - *why = "gave no clues"; + *why = cast_const(char *, "gave no clues"); return true; } @@ -282,9 +333,9 @@ static char **combine(const void *ctx, char **lines, char **prev) for (i = 0; prev[i]; i++); prev_total = i; - ret = talloc_array(ctx, char *, 1 +lines_total + prev_total + 1); - ret[0] = talloc_asprintf(ret, "/* The example %s, thus %s */\n", - why, reasoning); + ret = tal_arr(ctx, char *, 1 + lines_total + prev_total + 1); + ret[0] = tal_fmt(ret, "/* The example %s, thus %s */", + why, reasoning); memcpy(ret+1, lines, count * sizeof(ret[0])); memcpy(ret+1 + count, prev, prev_total * sizeof(ret[0])); memcpy(ret+1 + count + prev_total, lines + count, @@ -292,31 +343,45 @@ static char **combine(const void *ctx, char **lines, char **prev) return ret; } +/* Only handles very simple comments. */ +static char *strip_comment(const void *ctx, const char *orig_line) +{ + char *p, *ret = tal_strdup(ctx, orig_line); + + p = strstr(ret, "/*"); + if (!p) + p = strstr(ret, "//"); + if (p) + *p = '\0'; + return ret; +} + static char *mangle(struct manifest *m, char **lines) { char *ret, *use_funcs = NULL, *why; bool in_function = false, fake_function = false, has_main = false; unsigned int i; - ret = talloc_strdup(m, "/* Prepend a heap of headers. */\n" - "#include \n" - "#include \n" - "#include \n" - "#include \n" - "#include \n" - "#include \n" - "#include \n" - "#include \n" - "#include \n" - "#include \n" - "#include \n" - "#include \n" - "#include \n"); - ret = talloc_asprintf_append(ret, "/* Include header from module. */\n" - "#include \n", - m->basename, m->basename); - - ret = talloc_asprintf_append(ret, "/* Useful dummy functions. */\n" + ret = tal_fmt(m, + "/* Include header from module. */\n" + "#include \n" + "/* Prepend a heap of headers. */\n" + "#include \n" + "#include \n" + "#include \n" + "#include \n" + "#include \n" + "#include \n" + "#include \n" + "#include \n" + "#include \n" + "#include \n" + "#include \n" + "#include \n" + "#include \n", + m->modname, m->basename); + + ret = tal_strcat(m, take(ret), "/* Useful dummy functions. */\n" "extern int somefunc(void);\n" "int somefunc(void) { return 0; }\n" "extern char somestring[];\n" @@ -324,97 +389,96 @@ static char *mangle(struct manifest *m, char **lines) if (looks_internal(lines, &why)) { /* Wrap it all in main(). */ - ret = start_main(ret, why); + start_main(&ret, why); fake_function = true; in_function = true; has_main = true; } else - ret = talloc_asprintf_append(ret, + tal_append_fmt(&ret, "/* The example %s, so didn't wrap in main() */\n", - why); + why); /* Primitive, very primitive. */ for (i = 0; lines[i]; i++) { + char *line = strip_comment(ret, lines[i]); + /* } at start of line ends a function. */ if (in_function) { - if (lines[i][0] == '}') + if (line[0] == '}') in_function = false; } else { /* Character at start of line, with ( and no ; * == function start. Ignore comments. */ - if (!isblank(lines[i][0]) - && strchr(lines[i], '(') - && !strchr(lines[i], ';') - && !strstr(lines[i], "//")) { + if (!cisspace(line[0]) + && strchr(line, '(') + && !strchr(line, ';') + && !strstr(line, "//")) { in_function = true; - if (strncmp(lines[i], "int main", 8) == 0) + if (strncmp(line, "int main", 8) == 0) has_main = true; - if (strncmp(lines[i], "static", 6) == 0) { - use_funcs = add_func(use_funcs, - lines[i]); + if (strncmp(line, "static", 6) == 0) { + use_funcs = add_func(m, use_funcs, + line); } } } /* ... means elided code. */ - if (strcmp(lines[i], "...") == 0) { + if (strcmp(line, "...") == 0) { if (!in_function && !has_main && looks_internal(lines + i + 1, &why)) { /* This implies we start a function here. */ - ret = start_main(ret, why); + start_main(&ret, why); has_main = true; fake_function = true; in_function = true; } - ret = talloc_asprintf_append(ret, - "/* ... removed */\n"); + ret = tal_strcat(m, take(ret), "/* ... removed */\n"); continue; } - ret = talloc_asprintf_append(ret, "%s\n", lines[i]); + ret = tal_strcat(m, take(ret), lines[i]); + ret = tal_strcat(m, take(ret), "\n"); } if (!has_main) { - ret = talloc_asprintf_append(ret, + ret = tal_strcat(m, take(ret), "/* Need a main to link successfully. */\n" "int main(void)\n{\n"); fake_function = true; } if (use_funcs) { - ret = talloc_asprintf_append(ret, - "/* Get rid of unused warnings" - " by printing addresses of" - " static funcs. */"); + ret = tal_strcat(m, take(ret), + "/* Get rid of unused warnings" + " by printing addresses of" + " static funcs. */\n"); if (!fake_function) { - ret = talloc_asprintf_append(ret, - "int use_funcs(void);\n" - "int use_funcs(void) {\n"); + ret = tal_strcat(m, take(ret), + "int use_funcs(void);\n" + "int use_funcs(void) {\n"); fake_function = true; } - ret = talloc_asprintf_append(ret, " %s\n", use_funcs); + tal_append_fmt(&ret, " %s\n", use_funcs); } if (fake_function) - ret = talloc_asprintf_append(ret, "return 0;\n" - "}\n"); + ret = tal_strcat(m, take(ret), "return 0;\n}\n"); return ret; } static struct ccan_file *mangle_example(struct manifest *m, struct ccan_file *example, - char **lines, - bool keep) + char **lines) { char *name, *contents; int fd; struct ccan_file *f; - name = maybe_temp_file(example, ".c", keep, - talloc_asprintf(m, "%s/mangled-%s", - m->dir, example->name)); + name = temp_file(example, ".c", + take(tal_fmt(NULL, "mangled-%s", example->name))); f = new_ccan_file(example, - talloc_dirname(example, name), - talloc_basename(example, name)); - talloc_steal(f, name); + take(path_dirname(example, name)), + take(path_basename(example, name))); + tal_steal(f, name); fd = open(f->fullname, O_WRONLY | O_CREAT | O_EXCL, 0600); if (fd < 0) @@ -426,99 +490,183 @@ static struct ccan_file *mangle_example(struct manifest *m, return NULL; } close(fd); - f->contents = talloc_steal(f, contents); + f->contents = tal_steal(f, contents); list_add(&m->mangled_examples, &f->list); return f; } -static void build_examples(struct manifest *m, bool keep, +/* If an example has expected output, it's complete and should not be + * included in future examples. */ +static bool has_expected_output(char **lines) +{ + unsigned int i; + + for (i = 0; lines[i]; i++) { + char *p = lines[i] + strspn(lines[i], " \t"); + if (!strstarts(p, "//")) + continue; + p += strspn(p, "/ "); + if (strncasecmp(p, "given", strlen("given")) == 0) + return true; + } + return false; +} + +static unsigned int try_compiling(struct manifest *m, + struct ccan_file *i, + char **prev, + struct ccan_file *mangled[3], + bool res[3], + char *err[3], + char **lines[3]) +{ + unsigned int num; + + /* Try standalone. */ + mangled[0] = i; + res[0] = compile(i, m, mangled[0], &err[0]); + lines[0] = get_ccan_file_lines(i); + if (res[0] && streq(err[0], "")) + return 1; + + if (prev) { + lines[1] = combine(i, get_ccan_file_lines(i), prev); + + mangled[1] = mangle_example(m, i, lines[1]); + res[1] = compile(i, m, mangled[1], &err[1]); + if (res[1] && streq(err[1], "")) { + return 2; + } + num = 2; + } else + num = 1; + + /* Try standalone. */ + lines[num] = get_ccan_file_lines(i); + mangled[num] = mangle_example(m, i, lines[num]); + res[num] = compile(i, m, mangled[num], &err[num]); + + return num+1; +} + +static void build_examples(struct manifest *m, unsigned int *timeleft, struct score *score) { struct ccan_file *i; char **prev = NULL; + bool warnings = false; score->total = 0; score->pass = true; list_for_each(&m->examples, i, list) { - char *ret, *ret1, *ret2 = NULL; - struct ccan_file *mangle1, *mangle2 = NULL; - char *err; + char *err[3]; + struct ccan_file *file[3] = { NULL, NULL, NULL }; + bool res[3]; + unsigned num, j; + char **lines[3]; + const char *error; score->total++; + /* Simplify our dumb parsing. */ strip_leading_whitespace(get_ccan_file_lines(i)); - ret = compile(i, m, i, keep); - if (!ret) { - prev = get_ccan_file_lines(i); - score->score++; - continue; - } - /* Try standalone. */ - mangle1 = mangle_example(m, i, get_ccan_file_lines(i), keep); - ret1 = compile(i, m, mangle1, keep); - if (!ret1) { - prev = get_ccan_file_lines(i); - score->score++; - continue; - } + num = try_compiling(m, i, prev, file, res, err, lines); - /* Try combining with previous (successful) example... */ - if (prev) { - char **new = combine(i, get_ccan_file_lines(i), prev); + /* First look for a compile without any warnings. */ + for (j = 0; j < num; j++) { + if (res[j] && streq(err[j], "")) { + if (!has_expected_output(lines[j])) + prev = lines[j]; + score->score++; + goto next; + } + } - mangle2 = mangle_example(m, i, new, keep); - ret2 = compile(i, m, mangle2, keep); - if (!ret2) { - prev = new; + /* Now accept anything which succeeded. */ + for (j = 0; j < num; j++) { + if (res[j]) { + if (!has_expected_output(lines[j])) + prev = lines[j]; score->score++; - continue; + warnings = true; + score_file_error(score, file[j], 0, + "Compiling extracted example" + " gave warnings:\n" + "Example:\n" + "%s\n" + "Compiler:\n" + "%s", + get_ccan_file_contents(file[j]), + err[j]); + goto next; } } score->pass = false; - score->error = "Compiling extracted examples failed"; if (!verbose) { - if (mangle2) - err = "Standalone, adding headers, " + if (num == 3) + error = "Compiling standalone, adding headers, " "and including previous " "example all failed"; else - err = "Standalone compile and" + error = "Standalone compile and" " adding headers both failed"; } else { - err = talloc_asprintf(score, - "Standalone example:\n" - "%s\n" - "Errors: %s\n\n" - "Adding headers, wrappers:\n" - "%s\n" - "Errors: %s\n\n", - get_ccan_file_contents(i), - ret, - get_ccan_file_contents(mangle1), - ret1); - - if (mangle2) - err = talloc_asprintf_append(err, - "Combining with previous example:\n" - "%s\n" - "Errors: %s\n\n", - get_ccan_file_contents(mangle2), - ret2); + if (num == 3) { + error = tal_fmt(score, + "Standalone example:\n" + "%s\n" + "Errors: %s\n\n" + "Combining with previous example:\n" + "%s\n" + "Errors: %s\n\n" + "Adding headers, wrappers:\n" + "%s\n" + "Errors: %s\n\n", + get_ccan_file_contents(file[0]), + err[0], + get_ccan_file_contents(file[1]), + err[1], + get_ccan_file_contents(file[2]), + err[2]); + } else { + error = tal_fmt(score, + "Standalone example:\n" + "%s\n" + "Errors: %s\n\n" + "Adding headers, wrappers:\n" + "%s\n" + "Errors: %s\n\n", + get_ccan_file_contents(file[0]), + err[0], + get_ccan_file_contents(file[1]), + err[1]); + } } - score_file_error(score, i, 0, err); + score_file_error(score, i, 0, "%s", error); /* This didn't work, so not a candidate for combining. */ prev = NULL; + + next: + ; + } + + /* An extra point if they all compiled without warnings. */ + if (!list_empty(&m->examples)) { + score->total++; + if (!warnings) + score->score++; } } struct ccanlint examples_compile = { - .key = "examples-compile", + .key = "examples_compile", .name = "Module examples compile", .check = build_examples, .can_run = can_run, + .needs = "examples_exist module_builds" }; -REGISTER_TEST(examples_compile, &has_examples, NULL); +REGISTER_TEST(examples_compile);