#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 "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, 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, 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 char *example_obj_list(struct manifest *m, struct ccan_file *f)
{
- char *list = talloc_strdup(m, "");
- struct ccan_file *i;
- char **lines;
-
- /* Object files for this module. */
- list_for_each(&m->c_files, i, list)
- list = talloc_asprintf_append(list, " %s", i->compiled);
+ struct manifest **deps = talloc_array(f, struct manifest *, 0);
+ char **lines, *list;
+ unsigned int i;
- /* 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[COMPILE_NORMAL])
+ list = talloc_asprintf_append(list, " %s",
+ deps[i]->compiled
+ [COMPILE_NORMAL]);
+ }
return list;
}
+/* FIXME: Test with reduced features! */
static char *lib_list(const struct manifest *m)
{
- unsigned int i, num;
- char **libs = get_libs(m, ".", &num, &m->info_file->compiled);
+ unsigned int i;
+ char **libs;
char *ret = talloc_strdup(m, "");
- for (i = 0; i < num; i++)
+ libs = get_libs(m, m->dir, true, get_or_compile_info);
+ for (i = 0; libs[i]; i++)
ret = talloc_asprintf_append(ret, "-l%s ", libs[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,
+ 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);
- return errmsg;
+ file->compiled[COMPILE_NORMAL] = temp_file(ctx, "", file->fullname);
+ if (!compile_and_link(ctx, file->fullname, ccan_dir,
+ example_obj_list(m, file),
+ compiler, cflags,
+ lib_list(m), 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;
}
-struct score {
- unsigned int score;
- char *errors;
-};
-
static char *start_main(char *ret, const char *why)
{
return talloc_asprintf_append(ret,
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",
- (unsigned)(end - p + 1), p);
+ (unsigned)(end - p), p+1);
}
static void strip_leading_whitespace(char **lines)
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;
+ 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;
}
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",
+ ret[0] = talloc_asprintf(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]));
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, *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"
/* 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, &why)) {
/* This implies we start a function here. */
ret = talloc_asprintf_append(ret,
"/* Get rid of unused warnings"
" by printing addresses of"
- " static funcs. */");
+ " static funcs. */\n");
if (!fake_function) {
ret = talloc_asprintf_append(ret,
"int use_funcs(void);\n"
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",
+ talloc_asprintf(m, "%s/mangled-%s",
+ m->dir, example->name));
f = new_ccan_file(example,
talloc_dirname(example, name),
talloc_basename(example, name));
}
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,
+ 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;
- struct score *score = talloc(m, struct score);
char **prev = NULL;
+ bool warnings = false;
- score->score = 0;
- score->errors = talloc_strdup(score, "");
+ score->total = 0;
+ score->pass = true;
- examples_compile.total_score = 0;
list_for_each(&m->examples, i, list) {
- char *ret, *ret1 = NULL, *ret2;
- struct ccan_file *mangle1 = NULL, *mangle2;
+ 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);
+ num = try_compiling(m, i, prev, file, res, err, lines);
- mangle1 = mangle_example(m, i, new, keep);
- ret1 = compile(score, m, mangle1, keep);
- if (!ret1) {
- 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. */
- mangle2 = mangle_example(m, i, get_ccan_file_lines(i), keep);
- ret2 = compile(score, m, mangle2, keep);
- if (!ret2) {
- 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;
+ }
}
- score->errors = talloc_asprintf_append(score->errors,
- "%s: tried standalone example:\n"
- "%s\n"
- "Errors: %s\n\n",
- i->name,
- get_ccan_file_contents(i),
- ret);
- if (mangle1) {
- score->errors = talloc_asprintf_append(score->errors,
- "%s: tried combining with"
- " previous example:\n"
- "%s\n"
- "Errors: %s\n\n",
- i->name,
- get_ccan_file_contents(mangle1),
- ret1);
+ 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->errors = talloc_asprintf_append(score->errors,
- "%s: tried adding headers, wrappers:\n"
- "%s\n"
- "Errors: %s\n\n",
- i->name,
- get_ccan_file_contents(mangle2),
- ret2);
+ score_file_error(score, i, 0, "%s", error);
/* This didn't work, so not a candidate for combining. */
prev = NULL;
- }
- if (strcmp(score->errors, "") == 0) {
- talloc_free(score);
- return NULL;
+ next:
+ ;
}
- return score;
-}
-
-static unsigned int score_examples(struct manifest *m, void *check_result)
-{
- struct score *score = check_result;
- return score->score;
-}
-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,
- .total_score = 3, /* This gets changed to # examples, if they exist */
.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