fixdep.c 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404
  1. /*
  2. * "Optimize" a list of dependencies as spit out by gcc -MD
  3. * for the kernel build
  4. * ===========================================================================
  5. *
  6. * Author Kai Germaschewski
  7. * Copyright 2002 by Kai Germaschewski <[email protected]>
  8. *
  9. * This software may be used and distributed according to the terms
  10. * of the GNU General Public License, incorporated herein by reference.
  11. *
  12. *
  13. * Introduction:
  14. *
  15. * gcc produces a very nice and correct list of dependencies which
  16. * tells make when to remake a file.
  17. *
  18. * To use this list as-is however has the drawback that virtually
  19. * every file in the kernel includes autoconf.h.
  20. *
  21. * If the user re-runs make *config, autoconf.h will be
  22. * regenerated. make notices that and will rebuild every file which
  23. * includes autoconf.h, i.e. basically all files. This is extremely
  24. * annoying if the user just changed CONFIG_HIS_DRIVER from n to m.
  25. *
  26. * So we play the same trick that "mkdep" played before. We replace
  27. * the dependency on autoconf.h by a dependency on every config
  28. * option which is mentioned in any of the listed prerequisites.
  29. *
  30. * kconfig populates a tree in include/config/ with an empty file
  31. * for each config symbol and when the configuration is updated
  32. * the files representing changed config options are touched
  33. * which then let make pick up the changes and the files that use
  34. * the config symbols are rebuilt.
  35. *
  36. * So if the user changes his CONFIG_HIS_DRIVER option, only the objects
  37. * which depend on "include/config/his/driver.h" will be rebuilt,
  38. * so most likely only his driver ;-)
  39. *
  40. * The idea above dates, by the way, back to Michael E Chastain, AFAIK.
  41. *
  42. * So to get dependencies right, there are two issues:
  43. * o if any of the files the compiler read changed, we need to rebuild
  44. * o if the command line given to the compile the file changed, we
  45. * better rebuild as well.
  46. *
  47. * The former is handled by using the -MD output, the later by saving
  48. * the command line used to compile the old object and comparing it
  49. * to the one we would now use.
  50. *
  51. * Again, also this idea is pretty old and has been discussed on
  52. * kbuild-devel a long time ago. I don't have a sensibly working
  53. * internet connection right now, so I rather don't mention names
  54. * without double checking.
  55. *
  56. * This code here has been based partially based on mkdep.c, which
  57. * says the following about its history:
  58. *
  59. * Copyright abandoned, Michael Chastain, <mailto:[email protected]>.
  60. * This is a C version of syncdep.pl by Werner Almesberger.
  61. *
  62. *
  63. * It is invoked as
  64. *
  65. * fixdep <depfile> <target> <cmdline>
  66. *
  67. * and will read the dependency file <depfile>
  68. *
  69. * The transformed dependency snipped is written to stdout.
  70. *
  71. * It first generates a line
  72. *
  73. * cmd_<target> = <cmdline>
  74. *
  75. * and then basically copies the .<target>.d file to stdout, in the
  76. * process filtering out the dependency on autoconf.h and adding
  77. * dependencies on include/config/my/option.h for every
  78. * CONFIG_MY_OPTION encountered in any of the prerequisites.
  79. *
  80. * We don't even try to really parse the header files, but
  81. * merely grep, i.e. if CONFIG_FOO is mentioned in a comment, it will
  82. * be picked up as well. It's not a problem with respect to
  83. * correctness, since that can only give too many dependencies, thus
  84. * we cannot miss a rebuild. Since people tend to not mention totally
  85. * unrelated CONFIG_ options all over the place, it's not an
  86. * efficiency problem either.
  87. *
  88. * (Note: it'd be easy to port over the complete mkdep state machine,
  89. * but I don't think the added complexity is worth it)
  90. */
  91. #include <sys/types.h>
  92. #include <sys/stat.h>
  93. #include <unistd.h>
  94. #include <fcntl.h>
  95. #include <string.h>
  96. #include <stdarg.h>
  97. #include <stdlib.h>
  98. #include <stdio.h>
  99. #include <ctype.h>
  100. static void usage(void)
  101. {
  102. fprintf(stderr, "Usage: fixdep <depfile> <target> <cmdline>\n");
  103. exit(1);
  104. }
  105. /*
  106. * In the intended usage of this program, the stdout is redirected to .*.cmd
  107. * files. The return value of printf() and putchar() must be checked to catch
  108. * any error, e.g. "No space left on device".
  109. */
  110. static void xprintf(const char *format, ...)
  111. {
  112. va_list ap;
  113. int ret;
  114. va_start(ap, format);
  115. ret = vprintf(format, ap);
  116. if (ret < 0) {
  117. perror("fixdep");
  118. exit(1);
  119. }
  120. va_end(ap);
  121. }
  122. static void xputchar(int c)
  123. {
  124. int ret;
  125. ret = putchar(c);
  126. if (ret == EOF) {
  127. perror("fixdep");
  128. exit(1);
  129. }
  130. }
  131. /*
  132. * Print out a dependency path from a symbol name
  133. */
  134. static void print_dep(const char *m, int slen, const char *dir)
  135. {
  136. int c, prev_c = '/', i;
  137. xprintf(" $(wildcard %s/", dir);
  138. for (i = 0; i < slen; i++) {
  139. c = m[i];
  140. if (c == '_')
  141. c = '/';
  142. else
  143. c = tolower(c);
  144. if (c != '/' || prev_c != '/')
  145. xputchar(c);
  146. prev_c = c;
  147. }
  148. xprintf(".h) \\\n");
  149. }
  150. struct item {
  151. struct item *next;
  152. unsigned int len;
  153. unsigned int hash;
  154. char name[];
  155. };
  156. #define HASHSZ 256
  157. static struct item *hashtab[HASHSZ];
  158. static unsigned int strhash(const char *str, unsigned int sz)
  159. {
  160. /* fnv32 hash */
  161. unsigned int i, hash = 2166136261U;
  162. for (i = 0; i < sz; i++)
  163. hash = (hash ^ str[i]) * 0x01000193;
  164. return hash;
  165. }
  166. /*
  167. * Lookup a value in the configuration string.
  168. */
  169. static int is_defined_config(const char *name, int len, unsigned int hash)
  170. {
  171. struct item *aux;
  172. for (aux = hashtab[hash % HASHSZ]; aux; aux = aux->next) {
  173. if (aux->hash == hash && aux->len == len &&
  174. memcmp(aux->name, name, len) == 0)
  175. return 1;
  176. }
  177. return 0;
  178. }
  179. /*
  180. * Add a new value to the configuration string.
  181. */
  182. static void define_config(const char *name, int len, unsigned int hash)
  183. {
  184. struct item *aux = malloc(sizeof(*aux) + len);
  185. if (!aux) {
  186. perror("fixdep:malloc");
  187. exit(1);
  188. }
  189. memcpy(aux->name, name, len);
  190. aux->len = len;
  191. aux->hash = hash;
  192. aux->next = hashtab[hash % HASHSZ];
  193. hashtab[hash % HASHSZ] = aux;
  194. }
  195. /*
  196. * Record the use of a CONFIG_* word.
  197. */
  198. static void use_config(const char *m, int slen)
  199. {
  200. unsigned int hash = strhash(m, slen);
  201. if (is_defined_config(m, slen, hash))
  202. return;
  203. define_config(m, slen, hash);
  204. print_dep(m, slen, "include/config");
  205. }
  206. /* test if s ends in sub */
  207. static int str_ends_with(const char *s, int slen, const char *sub)
  208. {
  209. int sublen = strlen(sub);
  210. if (sublen > slen)
  211. return 0;
  212. return !memcmp(s + slen - sublen, sub, sublen);
  213. }
  214. static void parse_config_file(const char *p)
  215. {
  216. const char *q, *r;
  217. const char *start = p;
  218. while ((p = strstr(p, "CONFIG_"))) {
  219. if (p > start && (isalnum(p[-1]) || p[-1] == '_')) {
  220. p += 7;
  221. continue;
  222. }
  223. p += 7;
  224. q = p;
  225. while (isalnum(*q) || *q == '_')
  226. q++;
  227. if (str_ends_with(p, q - p, "_MODULE"))
  228. r = q - 7;
  229. else
  230. r = q;
  231. if (r > p)
  232. use_config(p, r - p);
  233. p = q;
  234. }
  235. }
  236. static void *read_file(const char *filename)
  237. {
  238. struct stat st;
  239. int fd;
  240. char *buf;
  241. fd = open(filename, O_RDONLY);
  242. if (fd < 0) {
  243. fprintf(stderr, "fixdep: error opening file: ");
  244. perror(filename);
  245. exit(2);
  246. }
  247. if (fstat(fd, &st) < 0) {
  248. fprintf(stderr, "fixdep: error fstat'ing file: ");
  249. perror(filename);
  250. exit(2);
  251. }
  252. buf = malloc(st.st_size + 1);
  253. if (!buf) {
  254. perror("fixdep: malloc");
  255. exit(2);
  256. }
  257. if (read(fd, buf, st.st_size) != st.st_size) {
  258. perror("fixdep: read");
  259. exit(2);
  260. }
  261. buf[st.st_size] = '\0';
  262. close(fd);
  263. return buf;
  264. }
  265. /* Ignore certain dependencies */
  266. static int is_ignored_file(const char *s, int len)
  267. {
  268. return str_ends_with(s, len, "include/generated/autoconf.h") ||
  269. str_ends_with(s, len, "include/generated/autoksyms.h");
  270. }
  271. /*
  272. * Important: The below generated source_foo.o and deps_foo.o variable
  273. * assignments are parsed not only by make, but also by the rather simple
  274. * parser in scripts/mod/sumversion.c.
  275. */
  276. static void parse_dep_file(char *m, const char *target)
  277. {
  278. char *p;
  279. int is_last, is_target;
  280. int saw_any_target = 0;
  281. int is_first_dep = 0;
  282. void *buf;
  283. while (1) {
  284. /* Skip any "white space" */
  285. while (*m == ' ' || *m == '\\' || *m == '\n')
  286. m++;
  287. if (!*m)
  288. break;
  289. /* Find next "white space" */
  290. p = m;
  291. while (*p && *p != ' ' && *p != '\\' && *p != '\n')
  292. p++;
  293. is_last = (*p == '\0');
  294. /* Is the token we found a target name? */
  295. is_target = (*(p-1) == ':');
  296. /* Don't write any target names into the dependency file */
  297. if (is_target) {
  298. /* The /next/ file is the first dependency */
  299. is_first_dep = 1;
  300. } else if (!is_ignored_file(m, p - m)) {
  301. *p = '\0';
  302. /*
  303. * Do not list the source file as dependency, so that
  304. * kbuild is not confused if a .c file is rewritten
  305. * into .S or vice versa. Storing it in source_* is
  306. * needed for modpost to compute srcversions.
  307. */
  308. if (is_first_dep) {
  309. /*
  310. * If processing the concatenation of multiple
  311. * dependency files, only process the first
  312. * target name, which will be the original
  313. * source name, and ignore any other target
  314. * names, which will be intermediate temporary
  315. * files.
  316. */
  317. if (!saw_any_target) {
  318. saw_any_target = 1;
  319. xprintf("source_%s := %s\n\n",
  320. target, m);
  321. xprintf("deps_%s := \\\n", target);
  322. }
  323. is_first_dep = 0;
  324. } else {
  325. xprintf(" %s \\\n", m);
  326. }
  327. buf = read_file(m);
  328. parse_config_file(buf);
  329. free(buf);
  330. }
  331. if (is_last)
  332. break;
  333. /*
  334. * Start searching for next token immediately after the first
  335. * "whitespace" character that follows this token.
  336. */
  337. m = p + 1;
  338. }
  339. if (!saw_any_target) {
  340. fprintf(stderr, "fixdep: parse error; no targets found\n");
  341. exit(1);
  342. }
  343. xprintf("\n%s: $(deps_%s)\n\n", target, target);
  344. xprintf("$(deps_%s):\n", target);
  345. }
  346. int main(int argc, char *argv[])
  347. {
  348. const char *depfile, *target, *cmdline;
  349. void *buf;
  350. if (argc != 4)
  351. usage();
  352. depfile = argv[1];
  353. target = argv[2];
  354. cmdline = argv[3];
  355. xprintf("cmd_%s := %s\n\n", target, cmdline);
  356. buf = read_file(depfile);
  357. parse_dep_file(buf, target);
  358. free(buf);
  359. return 0;
  360. }