#include <tools/ccanlint/ccanlint.h>
#include <tools/tools.h>
#include <ccan/talloc/talloc.h>
+#include <ccan/cast/cast.h>
#include <ccan/str/str.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <ctype.h>
#include <assert.h>
+#include <err.h>
+#include "../compulsory_tests/build.h"
static const char *can_run(struct manifest *m)
{
if (safe_mode)
return "Safe mode enabled";
+ if (list_empty(&m->examples))
+ return "No examples to compile";
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 = talloc_get_size(*deps) / sizeof(*deps);
+ *deps = talloc_realloc(NULL, *deps, struct manifest *, 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 *basename)
{
- char **deps, *obj;
unsigned int i;
- /* Not ourselves. */
- if (streq(m->basename, mod))
- return list;
+ for (i = 0; i < talloc_get_size(deps) / sizeof(*deps); i++)
+ if (strcmp(deps[i]->basename, basename) == 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 *basename)
+{
+ unsigned int i;
+ struct manifest *m;
+ char *errstr;
- obj = talloc_asprintf(list, "%s/ccan/%s.o", ccan_dir, mod);
+ if (have_mod(*deps, basename))
+ return;
- /* Not anyone we've already included. */
- if (strstr(list, obj))
- return list;
+ m = get_manifest(*deps, talloc_asprintf(*deps, "%s/ccan/%s",
+ ccan_dir, basename));
+ errstr = build_submodule(m);
+ 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, false, &m->info_file->compiled);
- 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 char *obj_list(struct manifest *m, struct ccan_file *f)
{
- char *list = talloc_strdup(m, "");
- struct ccan_file *i;
- char **lines;
+ struct manifest **deps = talloc_array(f, struct manifest *, 0);
+ char **lines, *list;
+ unsigned int i;
- /* 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->basename);
/* Other modules implied by includes. */
for (lines = get_ccan_file_lines(f); *lines; lines++) {
unsigned preflen = strspn(*lines, " \t");
if (strstarts(*lines + preflen, "#include <ccan/")) {
- const char *mod;
- unsigned modlen;
+ char *modname;
- mod = *lines + preflen + strlen("#include <ccan/");
- modlen = strcspn(mod, "/");
- mod = talloc_strndup(f, mod, modlen);
- list = add_dep(m, list, mod);
+ modname = talloc_strdup(f, *lines + preflen
+ + strlen("#include <ccan/"));
+ modname[strcspn(modname, "/")] = '\0';
+ if (!have_mod(deps, modname))
+ add_dep(&deps, modname);
}
}
+ list = talloc_strdup(f, "");
+ for (i = 0; i < talloc_get_size(deps) / sizeof(*deps); i++) {
+ if (deps[i]->compiled)
+ list = talloc_asprintf_append(list, " %s",
+ deps[i]->compiled);
+ }
return list;
}
static char *lib_list(const struct manifest *m)
{
unsigned int i, num;
- char **libs = get_libs(m, ".", &num, &m->info_file->compiled);
+ char **libs = get_libs(m, m->dir, &num, &m->info_file->compiled);
char *ret = talloc_strdup(m, "");
for (i = 0; i < num; i++)
return ret;
}
-static char *compile(const void *ctx,
- struct manifest *m,
- struct ccan_file *file,
- bool keep)
+static bool compile(const void *ctx,
+ struct manifest *m,
+ struct ccan_file *file,
+ bool keep, 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) {
+ if (!compile_and_link(ctx, file->fullname, ccan_dir,
+ obj_list(m, file),
+ compiler, cflags,
+ lib_list(m), file->compiled, output)) {
+ /* Don't keep failures. */
+ if (keep)
+ unlink(file->compiled);
talloc_free(file->compiled);
- return errmsg;
+ file->compiled = NULL;
+ return false;
}
- return NULL;
+ return true;
}
-struct score {
- unsigned int score;
- char *errors;
-};
-
-static char *start_main(char *ret)
+static char *start_main(char *ret, const char *why)
{
return talloc_asprintf_append(ret,
- "/* Fake function wrapper inserted */\n"
- "int main(int argc, char *argv[])\n"
- "{\n");
+ "/* The example %s, so fake function wrapper inserted */\n"
+ "int main(int argc, char *argv[])\n"
+ "{\n", why);
}
/* We only handle simple function definitions here. */
static char *add_func(char *others, const char *line)
{
const char *p, *end = strchr(line, '(') - 1;
- while (isblank(*end)) {
+ 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",
- end - p + 1, p);
+ (unsigned)(end - p), p+1);
}
static void strip_leading_whitespace(char **lines)
lines[i] += min_span;
}
-static bool looks_internal(char **lines)
+static bool looks_internal(char **lines, char **why)
{
unsigned int i;
bool last_ended = true; /* Did last line finish a statement? */
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, "//"))
continue;
/* The winners. */
- if (strstarts(line, "if") && len == 2)
+ if (strstarts(line, "if") && len == 2) {
+ *why = cast_const(char *, "starts with if");
return true;
- if (strstarts(line, "for") && len == 3)
+ }
+ if (strstarts(line, "for") && len == 3) {
+ *why = cast_const(char *, "starts with for");
return true;
- if (strstarts(line, "while") && len == 5)
+ }
+ if (strstarts(line, "while") && len == 5) {
+ *why = cast_const(char *, "starts with while");
return true;
- if (strstarts(line, "do") && len == 2)
+ }
+ if (strstarts(line, "do") && len == 2) {
+ *why = cast_const(char *, "starts with do");
return true;
+ }
/* The losers. */
- if (strstarts(line, "#include"))
+ if (strstarts(line, "#include")) {
+ *why = cast_const(char *, "starts with #include");
return false;
+ }
if (last_ended && strchr(line, '(')) {
- if (strstarts(line, "static"))
+ if (strstarts(line, "static")) {
+ *why = cast_const(char *,
+ "starts with static"
+ " and contains (");
return false;
- if (strends(line, ")"))
+ }
+ if (strends(line, ")")) {
+ *why = cast_const(char *,
+ "contains ( and ends with )");
return false;
+ }
}
/* Single identifier then operator == inside function. */
if (last_ended && len
- && ispunct(line[len+strspn(line+len, " ")]))
+ && cispunct(line[len+strspn(line+len, " ")])) {
+ *why = cast_const(char *, "starts with identifier"
+ " then punctuation");
return true;
+ }
last_ended = (strends(line, "}")
|| strends(line, ";")
}
/* No idea... Say yes? */
+ *why = cast_const(char *, "gave no clues");
return true;
}
{
unsigned int i, lines_total, prev_total, count;
char **ret;
+ const char *reasoning;
+ char *why = NULL;
if (!prev)
return NULL;
/* If it looks internal, put prev at start. */
- if (looks_internal(lines)) {
+ if (looks_internal(lines, &why)) {
count = 0;
+ reasoning = "seemed to belong inside a function";
} else {
/* Try inserting in first elided position */
for (count = 0; lines[count]; count++) {
if (strcmp(lines[count], "...") == 0)
break;
}
- if (!lines[count])
+ if (!lines[count]) {
/* Try at start anyway? */
count = 0;
- else
+ reasoning = "didn't seem to belong inside"
+ " a function, so we prepended the previous"
+ " example";
+ } else {
+ reasoning = "didn't seem to belong inside"
+ " a function, so we put the previous example"
+ " at the first ...";
+
count++;
+ }
}
for (i = 0; lines[i]; i++);
for (i = 0; prev[i]; i++);
prev_total = i;
- ret = talloc_array(ctx, char *, lines_total + prev_total + 1);
- memcpy(ret, lines, count * sizeof(ret[0]));
- memcpy(ret + count, prev, prev_total * sizeof(ret[0]));
- memcpy(ret + count + prev_total, lines + count,
+ ret = talloc_array(ctx, char *, 1 +lines_total + prev_total + 1);
+ ret[0] = talloc_asprintf(ret, "/* The example %s, thus %s */\n",
+ 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,
(lines_total - count + 1) * sizeof(ret[0]));
return ret;
}
+/* Only handles very simple comments. */
+static char *strip_comment(const void *ctx, const char *orig_line)
+{
+ char *p, *ret = talloc_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;
+ 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 <assert.h>\n"
- "#include <err.h>\n"
- "#include <errno.h>\n"
- "#include <fcntl.h>\n"
- "#include <limits.h>\n"
- "#include <stdbool.h>\n"
- "#include <stdint.h>\n"
- "#include <stdio.h>\n"
- "#include <stdlib.h>\n"
- "#include <string.h>\n"
- "#include <sys/stat.h>\n"
- "#include <sys/types.h>\n"
- "#include <unistd.h>\n");
- ret = talloc_asprintf_append(ret, "/* Include header from module. */\n"
- "#include <ccan/%s/%s.h>\n",
- m->basename, m->basename);
+ ret = talloc_asprintf(m,
+ "/* Include header from module. */\n"
+ "#include <ccan/%s/%s.h>\n"
+ "/* Prepend a heap of headers. */\n"
+ "#include <assert.h>\n"
+ "#include <err.h>\n"
+ "#include <errno.h>\n"
+ "#include <fcntl.h>\n"
+ "#include <limits.h>\n"
+ "#include <stdbool.h>\n"
+ "#include <stdint.h>\n"
+ "#include <stdio.h>\n"
+ "#include <stdlib.h>\n"
+ "#include <string.h>\n"
+ "#include <sys/stat.h>\n"
+ "#include <sys/types.h>\n"
+ "#include <unistd.h>\n",
+ m->basename, m->basename);
ret = talloc_asprintf_append(ret, "/* Useful dummy functions. */\n"
"extern int somefunc(void);\n"
"extern char somestring[];\n"
"char somestring[] = \"hello world\";\n");
- if (looks_internal(lines)) {
+ if (looks_internal(lines, &why)) {
/* Wrap it all in main(). */
- ret = start_main(ret);
+ ret = start_main(ret, why);
fake_function = true;
in_function = true;
has_main = true;
- }
+ } else
+ ret = talloc_asprintf_append(ret,
+ "/* The example %s, so didn't wrap in main() */\n",
+ 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) {
+ if (strncmp(line, "static", 6) == 0) {
use_funcs = add_func(use_funcs,
- lines[i]);
+ line);
}
}
}
/* ... means elided code. */
- if (strcmp(lines[i], "...") == 0) {
+ if (strcmp(line, "...") == 0) {
if (!in_function && !has_main
- && looks_internal(lines + i + 1)) {
+ && looks_internal(lines + i + 1, &why)) {
/* This implies we start a function here. */
- ret = start_main(ret);
+ ret = start_main(ret, why);
has_main = true;
fake_function = true;
in_function = true;
ret = talloc_asprintf_append(ret, "%s\n", lines[i]);
}
- /* Need a main to link successfully. */
if (!has_main) {
- ret = talloc_asprintf_append(ret, "int main(void)\n{\n");
+ ret = talloc_asprintf_append(ret,
+ "/* Need a main to link successfully. */\n"
+ "int main(void)\n{\n");
fake_function = true;
}
- /* Get rid of unused warnings by printing addresses of static funcs. */
if (use_funcs) {
+ ret = talloc_asprintf_append(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"
}
close(fd);
f->contents = talloc_steal(f, contents);
+ list_add(&m->mangled_examples, &f->list);
return f;
}
-static void *build_examples(struct manifest *m, bool keep,
- unsigned int *timeleft)
+/* 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,
+ bool keep,
+ 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], keep, &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], keep);
+ res[1] = compile(i, m, mangled[1], keep, &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], keep);
+ res[num] = compile(i, m, mangled[num], keep, &err[num]);
+
+ return num+1;
+}
+
+static void build_examples(struct manifest *m, bool keep,
+ unsigned int *timeleft, struct score *score)
{
struct ccan_file *i;
- struct score *score = talloc(m, struct score);
- struct ccan_file *mangle;
char **prev = NULL;
+ bool warnings = false;
- score->score = 0;
- score->errors = NULL;
+ score->total = 0;
+ score->pass = true;
list_for_each(&m->examples, i, list) {
- char *ret;
+ 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++;
- examples_compile.total_score++;
/* Simplify our dumb parsing. */
strip_leading_whitespace(get_ccan_file_lines(i));
- ret = compile(score, m, i, keep);
- if (!ret) {
- prev = get_ccan_file_lines(i);
- score->score++;
- continue;
- }
- /* Try combining with previous (successful) example... */
- if (prev) {
- char **new = combine(i, get_ccan_file_lines(i), prev);
- talloc_free(ret);
+ num = try_compiling(m, i, prev, keep, file, res, err, lines);
- mangle = mangle_example(m, i, new, keep);
- ret = compile(score, m, mangle, keep);
- if (!ret) {
- prev = new;
+ /* 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++;
- continue;
+ goto next;
}
}
- /* Try standalone. */
- talloc_free(ret);
- mangle = mangle_example(m, i, get_ccan_file_lines(i), keep);
- ret = compile(score, m, mangle, keep);
- if (!ret) {
- prev = get_ccan_file_lines(i);
- score->score++;
- continue;
+ /* 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++;
+ 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;
+ }
}
- if (!score->errors)
- score->errors = ret;
- else {
- score->errors = talloc_append_string(score->errors,
- ret);
- talloc_free(ret);
+ score->pass = false;
+ if (!verbose) {
+ if (num == 3)
+ error = "Compiling standalone, adding headers, "
+ "and including previous "
+ "example all failed";
+ else
+ error = "Standalone compile and"
+ " adding headers both failed";
+ } else {
+ if (num == 3) {
+ error = talloc_asprintf(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 = 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(file[0]),
+ err[0],
+ get_ccan_file_contents(file[1]),
+ err[1]);
+ }
}
+ score_file_error(score, i, 0, "%s", error);
/* This didn't work, so not a candidate for combining. */
prev = NULL;
- }
- return score;
-}
-static unsigned int score_examples(struct manifest *m, void *check_result)
-{
- struct score *score = check_result;
- return score->score;
-}
+ next:
+ ;
+ }
-static const char *describe(struct manifest *m, void *check_result)
-{
- struct score *score = check_result;
- if (verbose >= 2 && score->errors)
- return talloc_asprintf(m, "Compile errors building examples:\n"
- "%s", score->errors);
- return NULL;
+ /* 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",
- .score = score_examples,
.check = build_examples,
- .describe = describe,
.can_run = can_run,
+ .needs = "examples_exist module_builds"
};
-REGISTER_TEST(examples_compile, &has_examples, NULL);
+REGISTER_TEST(examples_compile);
projects / ccan / blobdiff