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);
125 file->compiled = NULL;
136 static char *start_main(char *ret, const char *why)
138 return talloc_asprintf_append(ret,
139 "/* The example %s, so fake function wrapper inserted */\n"
140 "int main(int argc, char *argv[])\n"
144 /* We only handle simple function definitions here. */
145 static char *add_func(char *others, const char *line)
147 const char *p, *end = strchr(line, '(') - 1;
148 while (isblank(*end)) {
154 for (p = end; isalnum(*p) || *p == '_'; p--) {
159 return talloc_asprintf_append(others, "printf(\"%%p\", %.*s);\n",
160 (unsigned)(end - p + 1), p);
163 static void strip_leading_whitespace(char **lines)
165 unsigned int i, min_span = -1U;
167 for (i = 0; lines[i]; i++) {
168 unsigned int span = strspn(lines[i], " \t");
169 /* All whitespace? Ignore */
176 for (i = 0; lines[i]; i++)
177 if (strlen(lines[i]) >= min_span)
178 lines[i] += min_span;
181 static bool looks_internal(char **lines, char **why)
184 bool last_ended = true; /* Did last line finish a statement? */
186 for (i = 0; lines[i]; i++) {
187 /* Skip leading whitespace. */
188 const char *line = lines[i] + strspn(lines[i], " \t");
189 unsigned len = strspn(line, IDENT_CHARS);
191 if (!line[0] || isblank(line[0]) || strstarts(line, "//"))
195 if (strstarts(line, "if") && len == 2) {
196 *why = "starts with if";
199 if (strstarts(line, "for") && len == 3) {
200 *why = "starts with for";
203 if (strstarts(line, "while") && len == 5) {
204 *why = "starts with while";
207 if (strstarts(line, "do") && len == 2) {
208 *why = "starts with do";
213 if (strstarts(line, "#include")) {
214 *why = "starts with #include";
218 if (last_ended && strchr(line, '(')) {
219 if (strstarts(line, "static")) {
220 *why = "starts with static and contains (";
223 if (strends(line, ")")) {
224 *why = "contains ( and ends with )";
229 /* Single identifier then operator == inside function. */
230 if (last_ended && len
231 && ispunct(line[len+strspn(line+len, " ")])) {
232 *why = "starts with identifier then punctuation";
236 last_ended = (strends(line, "}")
237 || strends(line, ";")
238 || streq(line, "..."));
241 /* No idea... Say yes? */
242 *why = "gave no clues";
246 /* Examples will often build on prior ones. Try combining them. */
247 static char **combine(const void *ctx, char **lines, char **prev)
249 unsigned int i, lines_total, prev_total, count;
251 const char *reasoning;
257 /* If it looks internal, put prev at start. */
258 if (looks_internal(lines, &why)) {
260 reasoning = "seemed to belong inside a function";
262 /* Try inserting in first elided position */
263 for (count = 0; lines[count]; count++) {
264 if (strcmp(lines[count], "...") == 0)
268 /* Try at start anyway? */
270 reasoning = "didn't seem to belong inside"
271 " a function, so we prepended the previous"
274 reasoning = "didn't seem to belong inside"
275 " a function, so we put the previous example"
282 for (i = 0; lines[i]; i++);
285 for (i = 0; prev[i]; i++);
288 ret = talloc_array(ctx, char *, 1 +lines_total + prev_total + 1);
289 ret[0] = talloc_asprintf(ret, "/* The example %s, thus %s */\n",
291 memcpy(ret+1, lines, count * sizeof(ret[0]));
292 memcpy(ret+1 + count, prev, prev_total * sizeof(ret[0]));
293 memcpy(ret+1 + count + prev_total, lines + count,
294 (lines_total - count + 1) * sizeof(ret[0]));
298 static char *mangle(struct manifest *m, char **lines)
300 char *ret, *use_funcs = NULL, *why;
301 bool in_function = false, fake_function = false, has_main = false;
304 ret = talloc_strdup(m, "/* Prepend a heap of headers. */\n"
305 "#include <assert.h>\n"
307 "#include <errno.h>\n"
308 "#include <fcntl.h>\n"
309 "#include <limits.h>\n"
310 "#include <stdbool.h>\n"
311 "#include <stdint.h>\n"
312 "#include <stdio.h>\n"
313 "#include <stdlib.h>\n"
314 "#include <string.h>\n"
315 "#include <sys/stat.h>\n"
316 "#include <sys/types.h>\n"
317 "#include <unistd.h>\n");
318 ret = talloc_asprintf_append(ret, "/* Include header from module. */\n"
319 "#include <ccan/%s/%s.h>\n",
320 m->basename, m->basename);
322 ret = talloc_asprintf_append(ret, "/* Useful dummy functions. */\n"
323 "extern int somefunc(void);\n"
324 "int somefunc(void) { return 0; }\n"
325 "extern char somestring[];\n"
326 "char somestring[] = \"hello world\";\n");
328 if (looks_internal(lines, &why)) {
329 /* Wrap it all in main(). */
330 ret = start_main(ret, why);
331 fake_function = true;
335 ret = talloc_asprintf_append(ret,
336 "/* The example %s, so didn't wrap in main() */\n",
339 /* Primitive, very primitive. */
340 for (i = 0; lines[i]; i++) {
341 /* } at start of line ends a function. */
343 if (lines[i][0] == '}')
346 /* Character at start of line, with ( and no ;
347 * == function start. Ignore comments. */
348 if (!isblank(lines[i][0])
349 && strchr(lines[i], '(')
350 && !strchr(lines[i], ';')
351 && !strstr(lines[i], "//")) {
353 if (strncmp(lines[i], "int main", 8) == 0)
355 if (strncmp(lines[i], "static", 6) == 0) {
356 use_funcs = add_func(use_funcs,
361 /* ... means elided code. */
362 if (strcmp(lines[i], "...") == 0) {
363 if (!in_function && !has_main
364 && looks_internal(lines + i + 1, &why)) {
365 /* This implies we start a function here. */
366 ret = start_main(ret, why);
368 fake_function = true;
371 ret = talloc_asprintf_append(ret,
372 "/* ... removed */\n");
375 ret = talloc_asprintf_append(ret, "%s\n", lines[i]);
379 ret = talloc_asprintf_append(ret,
380 "/* Need a main to link successfully. */\n"
381 "int main(void)\n{\n");
382 fake_function = true;
386 ret = talloc_asprintf_append(ret,
387 "/* Get rid of unused warnings"
388 " by printing addresses of"
389 " static funcs. */");
390 if (!fake_function) {
391 ret = talloc_asprintf_append(ret,
392 "int use_funcs(void);\n"
393 "int use_funcs(void) {\n");
394 fake_function = true;
396 ret = talloc_asprintf_append(ret, " %s\n", use_funcs);
400 ret = talloc_asprintf_append(ret, "return 0;\n"
405 static struct ccan_file *mangle_example(struct manifest *m,
406 struct ccan_file *example,
410 char *name, *contents;
414 name = maybe_temp_file(example, ".c", keep,
415 talloc_asprintf(m, "%s/mangled-%s",
416 m->dir, example->name));
417 f = new_ccan_file(example,
418 talloc_dirname(example, name),
419 talloc_basename(example, name));
420 talloc_steal(f, name);
422 fd = open(f->fullname, O_WRONLY | O_CREAT | O_EXCL, 0600);
426 contents = mangle(m, lines);
427 if (write(fd, contents, strlen(contents)) != strlen(contents)) {
432 f->contents = talloc_steal(f, contents);
433 list_add(&m->mangled_examples, &f->list);
437 static void *build_examples(struct manifest *m, bool keep,
438 unsigned int *timeleft)
441 struct score *score = talloc(m, struct score);
445 score->errors = talloc_strdup(score, "");
447 examples_compile.total_score = 0;
448 list_for_each(&m->examples, i, list) {
449 char *ret, *ret1 = NULL, *ret2;
450 struct ccan_file *mangle1 = NULL, *mangle2;
452 examples_compile.total_score++;
453 /* Simplify our dumb parsing. */
454 strip_leading_whitespace(get_ccan_file_lines(i));
455 ret = compile(i, m, i, keep);
457 prev = get_ccan_file_lines(i);
462 /* Try standalone. */
463 mangle1 = mangle_example(m, i, get_ccan_file_lines(i), keep);
464 ret1 = compile(i, m, mangle1, keep);
466 prev = get_ccan_file_lines(i);
471 /* Try combining with previous (successful) example... */
473 char **new = combine(i, get_ccan_file_lines(i), prev);
475 mangle2 = mangle_example(m, i, new, keep);
476 ret2 = compile(i, m, mangle1, keep);
484 score->errors = talloc_asprintf_append(score->errors,
485 "%s: tried standalone example:\n"
489 get_ccan_file_contents(i),
491 score->errors = talloc_asprintf_append(score->errors,
492 "%s: tried adding headers, wrappers:\n"
496 get_ccan_file_contents(mangle1),
500 score->errors = talloc_asprintf_append(score->errors,
502 "%s: tried combining with"
503 " previous example:\n"
506 get_ccan_file_contents(mangle2),
509 /* This didn't work, so not a candidate for combining. */
513 if (strcmp(score->errors, "") == 0) {
520 static unsigned int score_examples(struct manifest *m, void *check_result)
522 struct score *score = check_result;
526 static const char *describe(struct manifest *m, void *check_result)
528 struct score *score = check_result;
529 if (verbose >= 2 && score->errors)
530 return talloc_asprintf(m, "Compile errors building examples:\n"
531 "%s", score->errors);
535 struct ccanlint examples_compile = {
536 .key = "examples-compile",
537 .name = "Module examples compile",
538 .score = score_examples,
539 .total_score = 3, /* This gets changed to # examples, if they exist */
540 .check = build_examples,
541 .describe = describe,
545 REGISTER_TEST(examples_compile, &has_examples, NULL);