1 #include <tools/ccanlint/ccanlint.h>
2 #include <tools/tools.h>
3 #include <ccan/talloc/talloc.h>
4 #include <ccan/str/str.h>
14 static const char *can_run(struct manifest *m)
17 return "Safe mode enabled";
21 /* FIXME: We should build if it doesn't exist... */
22 static bool expect_obj_file(const char *dir)
24 struct manifest *dep_man;
27 dep_man = get_manifest(dir, dir);
29 /* If it has C files, we expect an object file built from them. */
30 has_c_files = !list_empty(&dep_man->c_files);
35 static char *add_dep(const struct manifest *m, char *list, const char *mod)
41 if (streq(m->basename, mod))
44 /* Not if there's no object file for that module */
45 if (!expect_obj_file(talloc_asprintf(list, "%s/ccan/%s", ccan_dir,mod)))
48 obj = talloc_asprintf(list, "%s/ccan/%s.o", ccan_dir, mod);
50 /* Not anyone we've already included. */
51 if (strstr(list, obj))
54 list = talloc_asprintf_append(list, " %s", obj);
56 /* Get that modules depends as well... */
58 deps = get_deps(m, talloc_asprintf(list, "%s/ccan/%s", ccan_dir, mod),
61 for (i = 0; deps[i]; i++) {
62 if (strstarts(deps[i], "ccan/"))
63 list = add_dep(m, list, deps[i] + strlen("ccan/"));
68 static char *obj_list(const struct manifest *m, struct ccan_file *f)
70 char *list = talloc_strdup(m, "");
74 /* Object files for this module. */
75 list_for_each(&m->c_files, i, list)
76 list = talloc_asprintf_append(list, " %s", i->compiled);
78 /* Other ccan modules we depend on. */
79 list_for_each(&m->dep_dirs, i, list) {
81 list = talloc_asprintf_append(list, " %s", i->compiled);
84 /* Other modules implied by includes. */
85 for (lines = get_ccan_file_lines(f); *lines; lines++) {
86 unsigned preflen = strspn(*lines, " \t");
87 if (strstarts(*lines + preflen, "#include <ccan/")) {
91 mod = *lines + preflen + strlen("#include <ccan/");
92 modlen = strcspn(mod, "/");
93 mod = talloc_strndup(f, mod, modlen);
94 list = add_dep(m, list, mod);
101 static char *lib_list(const struct manifest *m)
104 char **libs = get_libs(m, ".", &num, &m->info_file->compiled);
105 char *ret = talloc_strdup(m, "");
107 for (i = 0; i < num; i++)
108 ret = talloc_asprintf_append(ret, "-l%s ", libs[i]);
112 static char *compile(const void *ctx,
114 struct ccan_file *file,
119 file->compiled = maybe_temp_file(ctx, "", keep, file->fullname);
120 errmsg = compile_and_link(ctx, file->fullname, ccan_dir,
122 "", lib_list(m), file->compiled);
124 talloc_free(file->compiled);
135 static char *start_main(char *ret, const char *why)
137 return talloc_asprintf_append(ret,
138 "/* The example %s, so fake function wrapper inserted */\n"
139 "int main(int argc, char *argv[])\n"
143 /* We only handle simple function definitions here. */
144 static char *add_func(char *others, const char *line)
146 const char *p, *end = strchr(line, '(') - 1;
147 while (isblank(*end)) {
153 for (p = end; isalnum(*p) || *p == '_'; p--) {
158 return talloc_asprintf_append(others, "printf(\"%%p\", %.*s);\n",
159 (unsigned)(end - p + 1), p);
162 static void strip_leading_whitespace(char **lines)
164 unsigned int i, min_span = -1U;
166 for (i = 0; lines[i]; i++) {
167 unsigned int span = strspn(lines[i], " \t");
168 /* All whitespace? Ignore */
175 for (i = 0; lines[i]; i++)
176 if (strlen(lines[i]) >= min_span)
177 lines[i] += min_span;
180 static bool looks_internal(char **lines, char **why)
183 bool last_ended = true; /* Did last line finish a statement? */
185 for (i = 0; lines[i]; i++) {
186 /* Skip leading whitespace. */
187 const char *line = lines[i] + strspn(lines[i], " \t");
188 unsigned len = strspn(line, IDENT_CHARS);
190 if (!line[0] || isblank(line[0]) || strstarts(line, "//"))
194 if (strstarts(line, "if") && len == 2) {
195 *why = "starts with if";
198 if (strstarts(line, "for") && len == 3) {
199 *why = "starts with for";
202 if (strstarts(line, "while") && len == 5) {
203 *why = "starts with while";
206 if (strstarts(line, "do") && len == 2) {
207 *why = "starts with do";
212 if (strstarts(line, "#include")) {
213 *why = "starts with #include";
217 if (last_ended && strchr(line, '(')) {
218 if (strstarts(line, "static")) {
219 *why = "starts with static and contains (";
222 if (strends(line, ")")) {
223 *why = "contains ( and ends with )";
228 /* Single identifier then operator == inside function. */
229 if (last_ended && len
230 && ispunct(line[len+strspn(line+len, " ")])) {
231 *why = "starts with identifier then punctuation";
235 last_ended = (strends(line, "}")
236 || strends(line, ";")
237 || streq(line, "..."));
240 /* No idea... Say yes? */
241 *why = "gave no clues";
245 /* Examples will often build on prior ones. Try combining them. */
246 static char **combine(const void *ctx, char **lines, char **prev)
248 unsigned int i, lines_total, prev_total, count;
250 const char *reasoning;
256 /* If it looks internal, put prev at start. */
257 if (looks_internal(lines, &why)) {
259 reasoning = "seemed to belong inside a function";
261 /* Try inserting in first elided position */
262 for (count = 0; lines[count]; count++) {
263 if (strcmp(lines[count], "...") == 0)
267 /* Try at start anyway? */
269 reasoning = "didn't seem to belong inside"
270 " a function, so we prepended the previous"
273 reasoning = "didn't seem to belong inside"
274 " a function, so we put the previous example"
281 for (i = 0; lines[i]; i++);
284 for (i = 0; prev[i]; i++);
287 ret = talloc_array(ctx, char *, 1 +lines_total + prev_total + 1);
288 ret[0] = talloc_asprintf(ret, "/* The example %s, thus %s */\n",
290 memcpy(ret+1, lines, count * sizeof(ret[0]));
291 memcpy(ret+1 + count, prev, prev_total * sizeof(ret[0]));
292 memcpy(ret+1 + count + prev_total, lines + count,
293 (lines_total - count + 1) * sizeof(ret[0]));
297 static char *mangle(struct manifest *m, char **lines)
299 char *ret, *use_funcs = NULL, *why;
300 bool in_function = false, fake_function = false, has_main = false;
303 ret = talloc_strdup(m, "/* Prepend a heap of headers. */\n"
304 "#include <assert.h>\n"
306 "#include <errno.h>\n"
307 "#include <fcntl.h>\n"
308 "#include <limits.h>\n"
309 "#include <stdbool.h>\n"
310 "#include <stdint.h>\n"
311 "#include <stdio.h>\n"
312 "#include <stdlib.h>\n"
313 "#include <string.h>\n"
314 "#include <sys/stat.h>\n"
315 "#include <sys/types.h>\n"
316 "#include <unistd.h>\n");
317 ret = talloc_asprintf_append(ret, "/* Include header from module. */\n"
318 "#include <ccan/%s/%s.h>\n",
319 m->basename, m->basename);
321 ret = talloc_asprintf_append(ret, "/* Useful dummy functions. */\n"
322 "extern int somefunc(void);\n"
323 "int somefunc(void) { return 0; }\n"
324 "extern char somestring[];\n"
325 "char somestring[] = \"hello world\";\n");
327 if (looks_internal(lines, &why)) {
328 /* Wrap it all in main(). */
329 ret = start_main(ret, why);
330 fake_function = true;
334 ret = talloc_asprintf_append(ret,
335 "/* The example %s, so didn't wrap in main() */\n",
338 /* Primitive, very primitive. */
339 for (i = 0; lines[i]; i++) {
340 /* } at start of line ends a function. */
342 if (lines[i][0] == '}')
345 /* Character at start of line, with ( and no ;
346 * == function start. Ignore comments. */
347 if (!isblank(lines[i][0])
348 && strchr(lines[i], '(')
349 && !strchr(lines[i], ';')
350 && !strstr(lines[i], "//")) {
352 if (strncmp(lines[i], "int main", 8) == 0)
354 if (strncmp(lines[i], "static", 6) == 0) {
355 use_funcs = add_func(use_funcs,
360 /* ... means elided code. */
361 if (strcmp(lines[i], "...") == 0) {
362 if (!in_function && !has_main
363 && looks_internal(lines + i + 1, &why)) {
364 /* This implies we start a function here. */
365 ret = start_main(ret, why);
367 fake_function = true;
370 ret = talloc_asprintf_append(ret,
371 "/* ... removed */\n");
374 ret = talloc_asprintf_append(ret, "%s\n", lines[i]);
378 ret = talloc_asprintf_append(ret,
379 "/* Need a main to link successfully. */\n"
380 "int main(void)\n{\n");
381 fake_function = true;
385 ret = talloc_asprintf_append(ret,
386 "/* Get rid of unused warnings"
387 " by printing addresses of"
388 " static funcs. */");
389 if (!fake_function) {
390 ret = talloc_asprintf_append(ret,
391 "int use_funcs(void);\n"
392 "int use_funcs(void) {\n");
393 fake_function = true;
395 ret = talloc_asprintf_append(ret, " %s\n", use_funcs);
399 ret = talloc_asprintf_append(ret, "return 0;\n"
404 static struct ccan_file *mangle_example(struct manifest *m,
405 struct ccan_file *example,
409 char *name, *contents;
413 name = maybe_temp_file(example, ".c", keep,
414 talloc_asprintf(m, "%s/mangled-%s",
415 m->dir, example->name));
416 f = new_ccan_file(example,
417 talloc_dirname(example, name),
418 talloc_basename(example, name));
419 talloc_steal(f, name);
421 fd = open(f->fullname, O_WRONLY | O_CREAT | O_EXCL, 0600);
425 contents = mangle(m, lines);
426 if (write(fd, contents, strlen(contents)) != strlen(contents)) {
431 f->contents = talloc_steal(f, contents);
435 static void *build_examples(struct manifest *m, bool keep,
436 unsigned int *timeleft)
439 struct score *score = talloc(m, struct score);
443 score->errors = talloc_strdup(score, "");
445 examples_compile.total_score = 0;
446 list_for_each(&m->examples, i, list) {
447 char *ret, *ret1 = NULL, *ret2;
448 struct ccan_file *mangle1 = NULL, *mangle2;
450 examples_compile.total_score++;
451 /* Simplify our dumb parsing. */
452 strip_leading_whitespace(get_ccan_file_lines(i));
453 ret = compile(score, m, i, keep);
455 prev = get_ccan_file_lines(i);
460 /* Try combining with previous (successful) example... */
462 char **new = combine(i, get_ccan_file_lines(i), prev);
464 mangle1 = mangle_example(m, i, new, keep);
465 ret1 = compile(score, m, mangle1, keep);
473 /* Try standalone. */
474 mangle2 = mangle_example(m, i, get_ccan_file_lines(i), keep);
475 ret2 = compile(score, m, mangle2, keep);
477 prev = get_ccan_file_lines(i);
482 score->errors = talloc_asprintf_append(score->errors,
483 "%s: tried standalone example:\n"
487 get_ccan_file_contents(i),
490 score->errors = talloc_asprintf_append(score->errors,
491 "%s: tried combining with"
492 " previous example:\n"
496 get_ccan_file_contents(mangle1),
499 score->errors = talloc_asprintf_append(score->errors,
500 "%s: tried adding headers, wrappers:\n"
504 get_ccan_file_contents(mangle2),
506 /* This didn't work, so not a candidate for combining. */
510 if (strcmp(score->errors, "") == 0) {
517 static unsigned int score_examples(struct manifest *m, void *check_result)
519 struct score *score = check_result;
523 static const char *describe(struct manifest *m, void *check_result)
525 struct score *score = check_result;
526 if (verbose >= 2 && score->errors)
527 return talloc_asprintf(m, "Compile errors building examples:\n"
528 "%s", score->errors);
532 struct ccanlint examples_compile = {
533 .key = "examples-compile",
534 .name = "Module examples compile",
535 .score = score_examples,
536 .total_score = 3, /* This gets changed to # examples, if they exist */
537 .check = build_examples,
538 .describe = describe,
542 REGISTER_TEST(examples_compile, &has_examples, NULL);