fixdep.c 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403
  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 <kai.germaschewski@gmx.de>
  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:mec@shout.net>.
  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. * It will also filter out all the dependencies on *.ver. We need
  81. * to make sure that the generated version checksum are globally up
  82. * to date before even starting the recursive build, so it's too late
  83. * at this point anyway.
  84. *
  85. * We don't even try to really parse the header files, but
  86. * merely grep, i.e. if CONFIG_FOO is mentioned in a comment, it will
  87. * be picked up as well. It's not a problem with respect to
  88. * correctness, since that can only give too many dependencies, thus
  89. * we cannot miss a rebuild. Since people tend to not mention totally
  90. * unrelated CONFIG_ options all over the place, it's not an
  91. * efficiency problem either.
  92. *
  93. * (Note: it'd be easy to port over the complete mkdep state machine,
  94. * but I don't think the added complexity is worth it)
  95. */
  96. #include <sys/types.h>
  97. #include <sys/stat.h>
  98. #include <unistd.h>
  99. #include <fcntl.h>
  100. #include <string.h>
  101. #include <stdlib.h>
  102. #include <stdio.h>
  103. #include <ctype.h>
  104. static void usage(void)
  105. {
  106. fprintf(stderr, "Usage: fixdep [-e] <depfile> <target> <cmdline>\n");
  107. fprintf(stderr, " -e insert extra dependencies given on stdin\n");
  108. exit(1);
  109. }
  110. /*
  111. * Print out a dependency path from a symbol name
  112. */
  113. static void print_config(const char *m, int slen)
  114. {
  115. int c, prev_c = '/', i;
  116. printf(" $(wildcard include/config/");
  117. for (i = 0; i < slen; i++) {
  118. c = m[i];
  119. if (c == '_')
  120. c = '/';
  121. else
  122. c = tolower(c);
  123. if (c != '/' || prev_c != '/')
  124. putchar(c);
  125. prev_c = c;
  126. }
  127. printf(".h) \\\n");
  128. }
  129. static void do_extra_deps(void)
  130. {
  131. char buf[80];
  132. while (fgets(buf, sizeof(buf), stdin)) {
  133. int len = strlen(buf);
  134. if (len < 2 || buf[len - 1] != '\n') {
  135. fprintf(stderr, "fixdep: bad data on stdin\n");
  136. exit(1);
  137. }
  138. print_config(buf, len - 1);
  139. }
  140. }
  141. struct item {
  142. struct item *next;
  143. unsigned int len;
  144. unsigned int hash;
  145. char name[0];
  146. };
  147. #define HASHSZ 256
  148. static struct item *hashtab[HASHSZ];
  149. static unsigned int strhash(const char *str, unsigned int sz)
  150. {
  151. /* fnv32 hash */
  152. unsigned int i, hash = 2166136261U;
  153. for (i = 0; i < sz; i++)
  154. hash = (hash ^ str[i]) * 0x01000193;
  155. return hash;
  156. }
  157. /*
  158. * Lookup a value in the configuration string.
  159. */
  160. static int is_defined_config(const char *name, int len, unsigned int hash)
  161. {
  162. struct item *aux;
  163. for (aux = hashtab[hash % HASHSZ]; aux; aux = aux->next) {
  164. if (aux->hash == hash && aux->len == len &&
  165. memcmp(aux->name, name, len) == 0)
  166. return 1;
  167. }
  168. return 0;
  169. }
  170. /*
  171. * Add a new value to the configuration string.
  172. */
  173. static void define_config(const char *name, int len, unsigned int hash)
  174. {
  175. struct item *aux = malloc(sizeof(*aux) + len);
  176. if (!aux) {
  177. perror("fixdep:malloc");
  178. exit(1);
  179. }
  180. memcpy(aux->name, name, len);
  181. aux->len = len;
  182. aux->hash = hash;
  183. aux->next = hashtab[hash % HASHSZ];
  184. hashtab[hash % HASHSZ] = aux;
  185. }
  186. /*
  187. * Record the use of a CONFIG_* word.
  188. */
  189. static void use_config(const char *m, int slen)
  190. {
  191. unsigned int hash = strhash(m, slen);
  192. if (is_defined_config(m, slen, hash))
  193. return;
  194. define_config(m, slen, hash);
  195. print_config(m, slen);
  196. }
  197. /* test if s ends in sub */
  198. static int str_ends_with(const char *s, int slen, const char *sub)
  199. {
  200. int sublen = strlen(sub);
  201. if (sublen > slen)
  202. return 0;
  203. return !memcmp(s + slen - sublen, sub, sublen);
  204. }
  205. static void parse_config_file(const char *p)
  206. {
  207. const char *q, *r;
  208. const char *start = p;
  209. while ((p = strstr(p, "CONFIG_"))) {
  210. if (p > start && (isalnum(p[-1]) || p[-1] == '_')) {
  211. p += 7;
  212. continue;
  213. }
  214. p += 7;
  215. q = p;
  216. while (*q && (isalnum(*q) || *q == '_'))
  217. q++;
  218. if (str_ends_with(p, q - p, "_MODULE"))
  219. r = q - 7;
  220. else
  221. r = q;
  222. if (r > p)
  223. use_config(p, r - p);
  224. p = q;
  225. }
  226. }
  227. static void *read_file(const char *filename)
  228. {
  229. struct stat st;
  230. int fd;
  231. char *buf;
  232. fd = open(filename, O_RDONLY);
  233. if (fd < 0) {
  234. fprintf(stderr, "fixdep: error opening file: ");
  235. perror(filename);
  236. exit(2);
  237. }
  238. if (fstat(fd, &st) < 0) {
  239. fprintf(stderr, "fixdep: error fstat'ing file: ");
  240. perror(filename);
  241. exit(2);
  242. }
  243. buf = malloc(st.st_size + 1);
  244. if (!buf) {
  245. perror("fixdep: malloc");
  246. exit(2);
  247. }
  248. if (read(fd, buf, st.st_size) != st.st_size) {
  249. perror("fixdep: read");
  250. exit(2);
  251. }
  252. buf[st.st_size] = '\0';
  253. close(fd);
  254. return buf;
  255. }
  256. /* Ignore certain dependencies */
  257. static int is_ignored_file(const char *s, int len)
  258. {
  259. return str_ends_with(s, len, "include/generated/autoconf.h") ||
  260. str_ends_with(s, len, "include/generated/autoksyms.h") ||
  261. str_ends_with(s, len, ".ver");
  262. }
  263. /*
  264. * Important: The below generated source_foo.o and deps_foo.o variable
  265. * assignments are parsed not only by make, but also by the rather simple
  266. * parser in scripts/mod/sumversion.c.
  267. */
  268. static void parse_dep_file(char *m, const char *target, int insert_extra_deps)
  269. {
  270. char *p;
  271. int is_last, is_target;
  272. int saw_any_target = 0;
  273. int is_first_dep = 0;
  274. void *buf;
  275. while (1) {
  276. /* Skip any "white space" */
  277. while (*m == ' ' || *m == '\\' || *m == '\n')
  278. m++;
  279. if (!*m)
  280. break;
  281. /* Find next "white space" */
  282. p = m;
  283. while (*p && *p != ' ' && *p != '\\' && *p != '\n')
  284. p++;
  285. is_last = (*p == '\0');
  286. /* Is the token we found a target name? */
  287. is_target = (*(p-1) == ':');
  288. /* Don't write any target names into the dependency file */
  289. if (is_target) {
  290. /* The /next/ file is the first dependency */
  291. is_first_dep = 1;
  292. } else if (!is_ignored_file(m, p - m)) {
  293. *p = '\0';
  294. /*
  295. * Do not list the source file as dependency, so that
  296. * kbuild is not confused if a .c file is rewritten
  297. * into .S or vice versa. Storing it in source_* is
  298. * needed for modpost to compute srcversions.
  299. */
  300. if (is_first_dep) {
  301. /*
  302. * If processing the concatenation of multiple
  303. * dependency files, only process the first
  304. * target name, which will be the original
  305. * source name, and ignore any other target
  306. * names, which will be intermediate temporary
  307. * files.
  308. */
  309. if (!saw_any_target) {
  310. saw_any_target = 1;
  311. printf("source_%s := %s\n\n",
  312. target, m);
  313. printf("deps_%s := \\\n", target);
  314. }
  315. is_first_dep = 0;
  316. } else {
  317. printf(" %s \\\n", m);
  318. }
  319. buf = read_file(m);
  320. parse_config_file(buf);
  321. free(buf);
  322. }
  323. if (is_last)
  324. break;
  325. /*
  326. * Start searching for next token immediately after the first
  327. * "whitespace" character that follows this token.
  328. */
  329. m = p + 1;
  330. }
  331. if (!saw_any_target) {
  332. fprintf(stderr, "fixdep: parse error; no targets found\n");
  333. exit(1);
  334. }
  335. if (insert_extra_deps)
  336. do_extra_deps();
  337. printf("\n%s: $(deps_%s)\n\n", target, target);
  338. printf("$(deps_%s):\n", target);
  339. }
  340. int main(int argc, char *argv[])
  341. {
  342. const char *depfile, *target, *cmdline;
  343. int insert_extra_deps = 0;
  344. void *buf;
  345. if (argc == 5 && !strcmp(argv[1], "-e")) {
  346. insert_extra_deps = 1;
  347. argv++;
  348. } else if (argc != 4)
  349. usage();
  350. depfile = argv[1];
  351. target = argv[2];
  352. cmdline = argv[3];
  353. printf("cmd_%s := %s\n\n", target, cmdline);
  354. buf = read_file(depfile);
  355. parse_dep_file(buf, target, insert_extra_deps);
  356. free(buf);
  357. return 0;
  358. }