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