#include <tools/ccanlint/ccanlint.h>
#include <tools/tools.h>
#include <ccan/talloc/talloc.h>
+#include <ccan/str/str.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <string.h>
#include <unistd.h>
#include <ctype.h>
+#include <assert.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;
}
-static char *obj_list(const struct manifest *m)
+/* FIXME: We should build if it doesn't exist... */
+static bool expect_obj_file(const char *dir)
{
- char *list;
+ 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;
+}
+
+static char *add_dep(const struct manifest *m, char *list, const char *mod)
+{
+ char **deps, *obj;
+ unsigned int i;
+
+ /* Not ourselves. */
+ if (streq(m->basename, mod))
+ return list;
+
+ /* 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;
+
+ obj = talloc_asprintf(list, "%s/ccan/%s.o", ccan_dir, mod);
+
+ /* Not anyone we've already included. */
+ if (strstr(list, obj))
+ return list;
+
+ list = talloc_asprintf_append(list, " %s", obj);
+
+ /* Get that modules depends as well... */
+ assert(!safe_mode);
+ deps = get_deps(m, talloc_asprintf(list, "%s/ccan/%s", ccan_dir, mod),
+ false, NULL);
+
+ for (i = 0; deps[i]; i++) {
+ if (strstarts(deps[i], "ccan/"))
+ list = add_dep(m, list, deps[i] + strlen("ccan/"));
+ }
+ return list;
+}
+
+/* FIXME: Merge this into one place. */
+static char *obj_list(const struct manifest *m, struct ccan_file *f)
+{
+ char *list = talloc_strdup(m, "");
struct ccan_file *i;
+ struct manifest *subm;
+ char **lines;
/* 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);
+ list_for_each(&m->deps, subm, list) {
+ if (subm->compiled)
+ list = talloc_asprintf_append(list, " %s",
+ subm->compiled);
+ }
+
+ /* 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;
+
+ mod = *lines + preflen + strlen("#include <ccan/");
+ modlen = strcspn(mod, "/");
+ mod = talloc_strndup(f, mod, modlen);
+ list = add_dep(m, list, mod);
+ }
}
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), "", lib_list(m), file->compiled);
- if (errmsg) {
+ if (!compile_and_link(ctx, file->fullname, ccan_dir,
+ obj_list(m, file),
+ "", lib_list(m), file->compiled, output)) {
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 (isspace(*end)) {
end--;
if (end == line)
return others;
}
return talloc_asprintf_append(others, "printf(\"%%p\", %.*s);\n",
- end - p + 1, p);
+ (unsigned)(end - p), p+1);
}
-static bool looks_internal(const char *p)
+static void strip_leading_whitespace(char **lines)
{
- return (strncmp(p, "#", 1) != 0
- && strncmp(p, "static", 6) != 0
- && strncmp(p, "struct", 6) != 0
- && strncmp(p, "union", 5) != 0);
+ unsigned int i, min_span = -1U;
+
+ for (i = 0; lines[i]; i++) {
+ unsigned int span = strspn(lines[i], " \t");
+ /* All whitespace? Ignore */
+ if (!lines[i][span])
+ continue;
+ if (span < min_span)
+ min_span = span;
+ }
+
+ for (i = 0; lines[i]; i++)
+ if (strlen(lines[i]) >= min_span)
+ lines[i] += min_span;
}
-static void strip_leading_whitespace(char **lines, unsigned prefix_len)
+static bool looks_internal(char **lines, char **why)
{
unsigned int i;
+ bool last_ended = true; /* Did last line finish a statement? */
- for (i = 0; lines[i]; i++)
- lines[i] += prefix_len;
+ for (i = 0; lines[i]; i++) {
+ /* Skip leading whitespace. */
+ const char *line = lines[i] + strspn(lines[i], " \t");
+ unsigned len = strspn(line, IDENT_CHARS);
+
+ if (!line[0] || isspace(line[0]) || strstarts(line, "//"))
+ continue;
+
+ /* The winners. */
+ if (strstarts(line, "if") && len == 2) {
+ *why = "starts with if";
+ return true;
+ }
+ if (strstarts(line, "for") && len == 3) {
+ *why = "starts with for";
+ return true;
+ }
+ if (strstarts(line, "while") && len == 5) {
+ *why = "starts with while";
+ return true;
+ }
+ if (strstarts(line, "do") && len == 2) {
+ *why = "starts with do";
+ return true;
+ }
+
+ /* The losers. */
+ if (strstarts(line, "#include")) {
+ *why = "starts with #include";
+ return false;
+ }
+
+ if (last_ended && strchr(line, '(')) {
+ if (strstarts(line, "static")) {
+ *why = "starts with static and contains (";
+ return false;
+ }
+ if (strends(line, ")")) {
+ *why = "contains ( and ends with )";
+ return false;
+ }
+ }
+
+ /* Single identifier then operator == inside function. */
+ if (last_ended && len
+ && ispunct(line[len+strspn(line+len, " ")])) {
+ *why = "starts with identifier then punctuation";
+ return true;
+ }
+
+ last_ended = (strends(line, "}")
+ || strends(line, ";")
+ || streq(line, "..."));
+ }
+
+ /* No idea... Say yes? */
+ *why = "gave no clues";
+ return true;
+}
+
+/* Examples will often build on prior ones. Try combining them. */
+static char **combine(const void *ctx, char **lines, char **prev)
+{
+ 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, &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]) {
+ /* Try at start anyway? */
+ count = 0;
+ 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++);
+ lines_total = i;
+
+ 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);
+ 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;
}
-static char *mangle(struct manifest *m, struct ccan_file *example)
+static char *mangle(struct manifest *m, char **lines)
{
- char **lines = get_ccan_file_lines(example);
- 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 <ccan/%s/%s.h>\n",
m->basename, m->basename);
- ret = talloc_asprintf_append(ret, "/* Useful dummmy functions. */\n"
- "int somefunc(void);\n"
- "int somefunc(void) { return 0; }\n");
+ ret = talloc_asprintf_append(ret, "/* Useful dummy functions. */\n"
+ "extern int somefunc(void);\n"
+ "int somefunc(void) { return 0; }\n"
+ "extern char somestring[];\n"
+ "char somestring[] = \"hello world\";\n");
- /* Starts indented? */
- if (lines[0] && isblank(lines[0][0])) {
- unsigned prefix = strspn(lines[0], " \t");
- if (looks_internal(lines[0] + prefix)) {
- /* Wrap it all in main(). */
- ret = start_main(ret);
- fake_function = true;
- in_function = true;
- has_main = true;
- } else
- strip_leading_whitespace(lines, prefix);
- }
+ if (looks_internal(lines, &why)) {
+ /* Wrap it all in main(). */
+ 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++) {
in_function = false;
} else {
/* Character at start of line, with ( and no ;
- * == function start. */
- if (!isblank(lines[i][0])
+ * == function start. Ignore comments. */
+ if (!isspace(lines[i][0])
&& strchr(lines[i], '(')
- && !strchr(lines[i], ';')) {
+ && !strchr(lines[i], ';')
+ && !strstr(lines[i], "//")) {
in_function = true;
if (strncmp(lines[i], "int main", 8) == 0)
has_main = true;
}
}
}
- /* ... means elided code. If followed by spaced line, means
- * next part is supposed to be inside a function. */
+ /* ... means elided code. */
if (strcmp(lines[i], "...") == 0) {
- if (!in_function
- && lines[i+1]
- && isblank(lines[i+1][0])) {
+ if (!in_function && !has_main
+ && 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"
}
static struct ccan_file *mangle_example(struct manifest *m,
- struct ccan_file *example, bool keep)
+ struct ccan_file *example,
+ char **lines,
+ bool keep)
{
char *name, *contents;
int fd;
if (fd < 0)
return NULL;
- contents = mangle(m, example);
+ contents = mangle(m, lines);
if (write(fd, contents, strlen(contents)) != strlen(contents)) {
close(fd);
return NULL;
}
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);
+ 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];
+ char *error;
- examples_compile.total_score++;
- ret = compile(score, m, i, keep);
- if (!ret)
- score->score++;
- else {
- struct ccan_file *mangle = mangle_example(m, i, keep);
+ score->total++;
+
+ /* Simplify our dumb parsing. */
+ strip_leading_whitespace(get_ccan_file_lines(i));
- talloc_free(ret);
- ret = compile(score, m, mangle, keep);
- if (!ret)
+ num = try_compiling(m, i, prev, keep, file, res, err, lines);
+
+ /* 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++;
- else {
- if (!score->errors)
- score->errors = ret;
- else {
- score->errors
- = talloc_append_string(score->errors,
- ret);
- talloc_free(ret);
- }
+ goto next;
}
}
- }
- return score;
-}
-static unsigned int score_examples(struct manifest *m, void *check_result)
-{
- struct score *score = check_result;
- return score->score;
-}
+ /* 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->error = "Compiling extracted example"
+ " gave warnings";
+ score_file_error(score, file[j], 0, err[j]);
+ goto 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;
+ score->pass = false;
+ score->error = "Compiling extracted examples failed";
+ if (!verbose) {
+ if (num == 3)
+ error = "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, 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",
.name = "Module examples compile",
- .score = score_examples,
.check = build_examples,
- .describe = describe,
.can_run = can_run,
};
-REGISTER_TEST(examples_compile, &has_examples, NULL);
+REGISTER_TEST(examples_compile, &has_examples, &build_objs, NULL);
projects / ccan / blobdiff