scripts/basic/fixdep.c

   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  * 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
  97 #include <sys/types.h>
  98 #include <sys/stat.h>
  99 #include <unistd.h>
 100 #include <fcntl.h>
 101 #include <string.h>
 102 #include <stdlib.h>
 103 #include <stdio.h>
 104 #include <ctype.h>
 105
 106 int is_spl_build = 0; /* hack for U-Boot */
 107
 108 static void usage(void)
 109 {
 110         fprintf(stderr, "Usage: fixdep [-e] <depfile> <target> <cmdline>\n");
 111         fprintf(stderr, " -e  insert extra dependencies given on stdin\n");
 112         exit(1);
 113 }
 114
 115 /*
 116  * Print out a dependency path from a symbol name
 117  */
 118 static void print_dep(const char *m, int slen, const char *dir)
 119 {
 120         int c, prev_c = '/', i;
 121
 122         printf("    $(wildcard %s/", dir);
 123         for (i = 0; i < slen; i++) {
 124                 c = m[i];
 125                 if (c == '_')
 126                         c = '/';
 127                 else
 128                         c = tolower(c);
 129                 if (c != '/' || prev_c != '/')
 130                         putchar(c);
 131                 prev_c = c;
 132         }
 133         printf(".h) \\\n");
 134 }
 135
 136 static void do_extra_deps(void)
 137 {
 138         char buf[80];
 139
 140         while (fgets(buf, sizeof(buf), stdin)) {
 141                 int len = strlen(buf);
 142
 143                 if (len < 2 || buf[len - 1] != '\n') {
 144                         fprintf(stderr, "fixdep: bad data on stdin\n");
 145                         exit(1);
 146                 }
 147                 print_dep(buf, len - 1, "include/ksym");
 148         }
 149 }
 150
 151 struct item {
 152         struct item     *next;
 153         unsigned int    len;
 154         unsigned int    hash;
 155         char            name[0];
 156 };
 157
 158 #define HASHSZ 256
 159 static struct item *hashtab[HASHSZ];
 160
 161 static unsigned int strhash(const char *str, unsigned int sz)
 162 {
 163         /* fnv32 hash */
 164         unsigned int i, hash = 2166136261U;
 165
 166         for (i = 0; i < sz; i++)
 167                 hash = (hash ^ str[i]) * 0x01000193;
 168         return hash;
 169 }
 170
 171 /*
 172  * Lookup a value in the configuration string.
 173  */
 174 static int is_defined_config(const char *name, int len, unsigned int hash)
 175 {
 176         struct item *aux;
 177
 178         for (aux = hashtab[hash % HASHSZ]; aux; aux = aux->next) {
 179                 if (aux->hash == hash && aux->len == len &&
 180                     memcmp(aux->name, name, len) == 0)
 181                         return 1;
 182         }
 183         return 0;
 184 }
 185
 186 /*
 187  * Add a new value to the configuration string.
 188  */
 189 static void define_config(const char *name, int len, unsigned int hash)
 190 {
 191         struct item *aux = malloc(sizeof(*aux) + len);
 192
 193         if (!aux) {
 194                 perror("fixdep:malloc");
 195                 exit(1);
 196         }
 197         memcpy(aux->name, name, len);
 198         aux->len = len;
 199         aux->hash = hash;
 200         aux->next = hashtab[hash % HASHSZ];
 201         hashtab[hash % HASHSZ] = aux;
 202 }
 203
 204 /*
 205  * Record the use of a CONFIG_* word.
 206  */
 207 static void use_config(const char *m, int slen)
 208 {
 209         unsigned int hash = strhash(m, slen);
 210
 211         if (is_defined_config(m, slen, hash))
 212             return;
 213
 214         define_config(m, slen, hash);
 215         print_dep(m, slen, "include/config");
 216 }
 217
 218 /* test if s ends in sub */
 219 static int str_ends_with(const char *s, int slen, const char *sub)
 220 {
 221         int sublen = strlen(sub);
 222
 223         if (sublen > slen)
 224                 return 0;
 225
 226         return !memcmp(s + slen - sublen, sub, sublen);
 227 }
 228
 229 static void parse_config_file(const char *p)
 230 {
 231         const char *q, *r;
 232         const char *start = p;
 233         char tmp_buf[256] = "SPL_"; /* hack for U-Boot */
 234
 235         while ((p = strstr(p, "CONFIG_"))) {
 236                 if (p > start && (isalnum(p[-1]) || p[-1] == '_')) {
 237                         p += 7;
 238                         continue;
 239                 }
 240                 p += 7;
 241                 q = p;
 242                 while (*q && (isalnum(*q) || *q == '_'))
 243                         q++;
 244                 if (str_ends_with(p, q - p, "_MODULE"))
 245                         r = q - 7;
 246                 else
 247                         r = q;
 248                 /*
 249                  * U-Boot also handles
 250                  *   CONFIG_IS_ENABLED(...)
 251                  *   CONFIG_IS_BUILTIN(...)
 252                  *   CONFIG_IS_MODULE(...)
 253                  *   CONFIG_VAL(...)
 254                  */
 255                 if ((q - p == 10 && !memcmp(p, "IS_ENABLED(", 11)) ||
 256                     (q - p == 10 && !memcmp(p, "IS_BUILTIN(", 11)) ||
 257                     (q - p == 9 && !memcmp(p, "IS_MODULE(", 10)) ||
 258                     (q - p == 3 && !memcmp(p, "VAL(", 4))) {
 259                         p = q + 1;
 260                         while (isalnum(*q) || *q == '_')
 261                                 q++;
 262                         r = q;
 263                         if (r > p && is_spl_build) {
 264                                 memcpy(tmp_buf + 4, p, r - p);
 265                                 r = tmp_buf + 4 + (r - p);
 266                                 p = tmp_buf;
 267                         }
 268                 }
 269                 /* end U-Boot hack */
 270
 271                 if (r > p)
 272                         use_config(p, r - p);
 273                 p = q;
 274         }
 275 }
 276
 277 static void *read_file(const char *filename)
 278 {
 279         struct stat st;
 280         int fd;
 281         char *buf;
 282
 283         fd = open(filename, O_RDONLY);
 284         if (fd < 0) {
 285                 fprintf(stderr, "fixdep: error opening file: ");
 286                 perror(filename);
 287                 exit(2);
 288         }
 289         if (fstat(fd, &st) < 0) {
 290                 fprintf(stderr, "fixdep: error fstat'ing file: ");
 291                 perror(filename);
 292                 exit(2);
 293         }
 294         buf = malloc(st.st_size + 1);
 295         if (!buf) {
 296                 perror("fixdep: malloc");
 297                 exit(2);
 298         }
 299         if (read(fd, buf, st.st_size) != st.st_size) {
 300                 perror("fixdep: read");
 301                 exit(2);
 302         }
 303         buf[st.st_size] = '\0';
 304         close(fd);
 305
 306         return buf;
 307 }
 308
 309 /* Ignore certain dependencies */
 310 static int is_ignored_file(const char *s, int len)
 311 {
 312         return str_ends_with(s, len, "include/generated/autoconf.h") ||
 313                str_ends_with(s, len, "include/generated/autoksyms.h") ||
 314                str_ends_with(s, len, ".ver");
 315 }
 316
 317 /*
 318  * Important: The below generated source_foo.o and deps_foo.o variable
 319  * assignments are parsed not only by make, but also by the rather simple
 320  * parser in scripts/mod/sumversion.c.
 321  */
 322 static void parse_dep_file(char *m, const char *target, int insert_extra_deps)
 323 {
 324         char *p;
 325         int is_last, is_target;
 326         int saw_any_target = 0;
 327         int is_first_dep = 0;
 328         void *buf;
 329
 330         while (1) {
 331                 /* Skip any "white space" */
 332                 while (*m == ' ' || *m == '\\' || *m == '\n')
 333                         m++;
 334
 335                 if (!*m)
 336                         break;
 337
 338                 /* Find next "white space" */
 339                 p = m;
 340                 while (*p && *p != ' ' && *p != '\\' && *p != '\n')
 341                         p++;
 342                 is_last = (*p == '\0');
 343                 /* Is the token we found a target name? */
 344                 is_target = (*(p-1) == ':');
 345                 /* Don't write any target names into the dependency file */
 346                 if (is_target) {
 347                         /* The /next/ file is the first dependency */
 348                         is_first_dep = 1;
 349                 } else if (!is_ignored_file(m, p - m)) {
 350                         *p = '\0';
 351
 352                         /*
 353                          * Do not list the source file as dependency, so that
 354                          * kbuild is not confused if a .c file is rewritten
 355                          * into .S or vice versa. Storing it in source_* is
 356                          * needed for modpost to compute srcversions.
 357                          */
 358                         if (is_first_dep) {
 359                                 /*
 360                                  * If processing the concatenation of multiple
 361                                  * dependency files, only process the first
 362                                  * target name, which will be the original
 363                                  * source name, and ignore any other target
 364                                  * names, which will be intermediate temporary
 365                                  * files.
 366                                  */
 367                                 if (!saw_any_target) {
 368                                         saw_any_target = 1;
 369                                         printf("source_%s := %s\n\n",
 370                                                target, m);
 371                                         printf("deps_%s := \\\n", target);
 372                                 }
 373                                 is_first_dep = 0;
 374                         } else {
 375                                 printf("  %s \\\n", m);
 376                         }
 377
 378                         buf = read_file(m);
 379                         parse_config_file(buf);
 380                         free(buf);
 381                 }
 382
 383                 if (is_last)
 384                         break;
 385
 386                 /*
 387                  * Start searching for next token immediately after the first
 388                  * "whitespace" character that follows this token.
 389                  */
 390                 m = p + 1;
 391         }
 392
 393         if (!saw_any_target) {
 394                 fprintf(stderr, "fixdep: parse error; no targets found\n");
 395                 exit(1);
 396         }
 397
 398         if (insert_extra_deps)
 399                 do_extra_deps();
 400
 401         printf("\n%s: $(deps_%s)\n\n", target, target);
 402         printf("$(deps_%s):\n", target);
 403 }
 404
 405 int main(int argc, char *argv[])
 406 {
 407         const char *depfile, *target, *cmdline;
 408         int insert_extra_deps = 0;
 409         void *buf;
 410
 411         if (argc == 5 && !strcmp(argv[1], "-e")) {
 412                 insert_extra_deps = 1;
 413                 argv++;
 414         } else if (argc != 4)
 415                 usage();
 416
 417         depfile = argv[1];
 418         target = argv[2];
 419         cmdline = argv[3];
 420
 421         /* hack for U-Boot */
 422         if (!strncmp(target, "spl/", 4) || !strncmp(target, "tpl/", 4))
 423                 is_spl_build = 1;
 424
 425         printf("cmd_%s := %s\n\n", target, cmdline);
 426
 427         buf = read_file(depfile);
 428         parse_dep_file(buf, target, insert_extra_deps);
 429         free(buf);
 430
 431         return 0;
 432 }