scripts/basic/docproc.c

   1 /*
   2  *      docproc is a simple preprocessor for the template files
   3  *      used as placeholders for the kernel internal documentation.
   4  *      docproc is used for documentation-frontend and
   5  *      dependency-generator.
   6  *      The two usages have in common that they require
   7  *      some knowledge of the .tmpl syntax, therefore they
   8  *      are kept together.
   9  *
  10  *      documentation-frontend
  11  *              Scans the template file and call kernel-doc for
  12  *              all occurrences of ![EIF]file
  13  *              Beforehand each referenced file is scanned for
  14  *              any symbols that are exported via these macros:
  15  *                      EXPORT_SYMBOL(), EXPORT_SYMBOL_GPL(), &
  16  *                      EXPORT_SYMBOL_GPL_FUTURE()
  17  *              This is used to create proper -function and
  18  *              -nofunction arguments in calls to kernel-doc.
  19  *              Usage: docproc doc file.tmpl
  20  *
  21  *      dependency-generator:
  22  *              Scans the template file and list all files
  23  *              referenced in a format recognized by make.
  24  *              Usage:  docproc depend file.tmpl
  25  *              Writes dependency information to stdout
  26  *              in the following format:
  27  *              file.tmpl src.c src2.c
  28  *              The filenames are obtained from the following constructs:
  29  *              !Efilename
  30  *              !Ifilename
  31  *              !Dfilename
  32  *              !Ffilename
  33  *              !Pfilename
  34  *
  35  */
  36
  37 #define _GNU_SOURCE
  38 #include <stdio.h>
  39 #include <stdlib.h>
  40 #include <string.h>
  41 #include <ctype.h>
  42 #include <unistd.h>
  43 #include <limits.h>
  44 #include <errno.h>
  45 #include <sys/types.h>
  46 #include <sys/wait.h>
  47
  48 /* exitstatus is used to keep track of any failing calls to kernel-doc,
  49  * but execution continues. */
  50 int exitstatus = 0;
  51
  52 typedef void DFL(char *);
  53 DFL *defaultline;
  54
  55 typedef void FILEONLY(char * file);
  56 FILEONLY *internalfunctions;
  57 FILEONLY *externalfunctions;
  58 FILEONLY *symbolsonly;
  59 FILEONLY *findall;
  60
  61 typedef void FILELINE(char * file, char * line);
  62 FILELINE * singlefunctions;
  63 FILELINE * entity_system;
  64 FILELINE * docsection;
  65
  66 #define MAXLINESZ     2048
  67 #define MAXFILES      250
  68 #define KERNELDOCPATH "scripts/"
  69 #define KERNELDOC     "kernel-doc"
  70 #define DOCBOOK       "-docbook"
  71 #define LIST          "-list"
  72 #define FUNCTION      "-function"
  73 #define NOFUNCTION    "-nofunction"
  74 #define NODOCSECTIONS "-no-doc-sections"
  75
  76 static char *srctree, *kernsrctree;
  77
  78 static char **all_list = NULL;
  79 static int all_list_len = 0;
  80
  81 static void consume_symbol(const char *sym)
  82 {
  83         int i;
  84
  85         for (i = 0; i < all_list_len; i++) {
  86                 if (!all_list[i])
  87                         continue;
  88                 if (strcmp(sym, all_list[i]))
  89                         continue;
  90                 all_list[i] = NULL;
  91                 break;
  92         }
  93 }
  94
  95 static void usage (void)
  96 {
  97         fprintf(stderr, "Usage: docproc {doc|depend} file\n");
  98         fprintf(stderr, "Input is read from file.tmpl. Output is sent to stdout\n");
  99         fprintf(stderr, "doc: frontend when generating kernel documentation\n");
 100         fprintf(stderr, "depend: generate list of files referenced within file\n");
 101         fprintf(stderr, "Environment variable SRCTREE: absolute path to sources.\n");
 102         fprintf(stderr, "                     KBUILD_SRC: absolute path to kernel source tree.\n");
 103 }
 104
 105 /*
 106  * Execute kernel-doc with parameters given in svec
 107  */
 108 static void exec_kernel_doc(char **svec)
 109 {
 110         pid_t pid;
 111         int ret;
 112         char real_filename[PATH_MAX + 1];
 113         /* Make sure output generated so far are flushed */
 114         fflush(stdout);
 115         switch (pid=fork()) {
 116                 case -1:
 117                         perror("fork");
 118                         exit(1);
 119                 case  0:
 120                         memset(real_filename, 0, sizeof(real_filename));
 121                         strncat(real_filename, kernsrctree, PATH_MAX);
 122                         strncat(real_filename, "/" KERNELDOCPATH KERNELDOC,
 123                                         PATH_MAX - strlen(real_filename));
 124                         execvp(real_filename, svec);
 125                         fprintf(stderr, "exec ");
 126                         perror(real_filename);
 127                         exit(1);
 128                 default:
 129                         waitpid(pid, &ret ,0);
 130         }
 131         if (WIFEXITED(ret))
 132                 exitstatus |= WEXITSTATUS(ret);
 133         else
 134                 exitstatus = 0xff;
 135 }
 136
 137 /* Types used to create list of all exported symbols in a number of files */
 138 struct symbols
 139 {
 140         char *name;
 141 };
 142
 143 struct symfile
 144 {
 145         char *filename;
 146         struct symbols *symbollist;
 147         int symbolcnt;
 148 };
 149
 150 struct symfile symfilelist[MAXFILES];
 151 int symfilecnt = 0;
 152
 153 static void add_new_symbol(struct symfile *sym, char * symname)
 154 {
 155         sym->symbollist =
 156           realloc(sym->symbollist, (sym->symbolcnt + 1) * sizeof(char *));
 157         sym->symbollist[sym->symbolcnt++].name = strdup(symname);
 158 }
 159
 160 /* Add a filename to the list */
 161 static struct symfile * add_new_file(char * filename)
 162 {
 163         symfilelist[symfilecnt++].filename = strdup(filename);
 164         return &symfilelist[symfilecnt - 1];
 165 }
 166
 167 /* Check if file already are present in the list */
 168 static struct symfile * filename_exist(char * filename)
 169 {
 170         int i;
 171         for (i=0; i < symfilecnt; i++)
 172                 if (strcmp(symfilelist[i].filename, filename) == 0)
 173                         return &symfilelist[i];
 174         return NULL;
 175 }
 176
 177 /*
 178  * List all files referenced within the template file.
 179  * Files are separated by tabs.
 180  */
 181 static void adddep(char * file)            { printf("\t%s", file); }
 182 static void adddep2(char * file, char * line)     { line = line; adddep(file); }
 183 static void noaction(char * line)                  { line = line; }
 184 static void noaction2(char * file, char * line)   { file = file; line = line; }
 185
 186 /* Echo the line without further action */
 187 static void printline(char * line)               { printf("%s", line); }
 188
 189 /*
 190  * Find all symbols in filename that are exported with EXPORT_SYMBOL &
 191  * EXPORT_SYMBOL_GPL (& EXPORT_SYMBOL_GPL_FUTURE implicitly).
 192  * All symbols located are stored in symfilelist.
 193  */
 194 static void find_export_symbols(char * filename)
 195 {
 196         FILE * fp;
 197         struct symfile *sym;
 198         char line[MAXLINESZ];
 199         if (filename_exist(filename) == NULL) {
 200                 char real_filename[PATH_MAX + 1];
 201                 memset(real_filename, 0, sizeof(real_filename));
 202                 strncat(real_filename, srctree, PATH_MAX);
 203                 strncat(real_filename, "/", PATH_MAX - strlen(real_filename));
 204                 strncat(real_filename, filename,
 205                                 PATH_MAX - strlen(real_filename));
 206                 sym = add_new_file(filename);
 207                 fp = fopen(real_filename, "r");
 208                 if (fp == NULL)
 209                 {
 210                         fprintf(stderr, "docproc: ");
 211                         perror(real_filename);
 212                         exit(1);
 213                 }
 214                 while (fgets(line, MAXLINESZ, fp)) {
 215                         char *p;
 216                         char *e;
 217                         if (((p = strstr(line, "EXPORT_SYMBOL_GPL")) != NULL) ||
 218                             ((p = strstr(line, "EXPORT_SYMBOL")) != NULL)) {
 219                                 /* Skip EXPORT_SYMBOL{_GPL} */
 220                                 while (isalnum(*p) || *p == '_')
 221                                         p++;
 222                                 /* Remove parentheses & additional whitespace */
 223                                 while (isspace(*p))
 224                                         p++;
 225                                 if (*p != '(')
 226                                         continue; /* Syntax error? */
 227                                 else
 228                                         p++;
 229                                 while (isspace(*p))
 230                                         p++;
 231                                 e = p;
 232                                 while (isalnum(*e) || *e == '_')
 233                                         e++;
 234                                 *e = '\0';
 235                                 add_new_symbol(sym, p);
 236                         }
 237                 }
 238                 fclose(fp);
 239         }
 240 }
 241
 242 /*
 243  * Document all external or internal functions in a file.
 244  * Call kernel-doc with following parameters:
 245  * kernel-doc -docbook -nofunction function_name1 filename
 246  * Function names are obtained from all the src files
 247  * by find_export_symbols.
 248  * intfunc uses -nofunction
 249  * extfunc uses -function
 250  */
 251 static void docfunctions(char * filename, char * type)
 252 {
 253         int i,j;
 254         int symcnt = 0;
 255         int idx = 0;
 256         char **vec;
 257
 258         for (i=0; i <= symfilecnt; i++)
 259                 symcnt += symfilelist[i].symbolcnt;
 260         vec = malloc((2 + 2 * symcnt + 3) * sizeof(char *));
 261         if (vec == NULL) {
 262                 perror("docproc: ");
 263                 exit(1);
 264         }
 265         vec[idx++] = KERNELDOC;
 266         vec[idx++] = DOCBOOK;
 267         vec[idx++] = NODOCSECTIONS;
 268         for (i=0; i < symfilecnt; i++) {
 269                 struct symfile * sym = &symfilelist[i];
 270                 for (j=0; j < sym->symbolcnt; j++) {
 271                         vec[idx++]     = type;
 272                         consume_symbol(sym->symbollist[j].name);
 273                         vec[idx++] = sym->symbollist[j].name;
 274                 }
 275         }
 276         vec[idx++]     = filename;
 277         vec[idx] = NULL;
 278         printf("<!-- %s -->\n", filename);
 279         exec_kernel_doc(vec);
 280         fflush(stdout);
 281         free(vec);
 282 }
 283 static void intfunc(char * filename) {  docfunctions(filename, NOFUNCTION); }
 284 static void extfunc(char * filename) { docfunctions(filename, FUNCTION);   }
 285
 286 /*
 287  * Document specific function(s) in a file.
 288  * Call kernel-doc with the following parameters:
 289  * kernel-doc -docbook -function function1 [-function function2]
 290  */
 291 static void singfunc(char * filename, char * line)
 292 {
 293         char *vec[200]; /* Enough for specific functions */
 294         int i, idx = 0;
 295         int startofsym = 1;
 296         vec[idx++] = KERNELDOC;
 297         vec[idx++] = DOCBOOK;
 298
 299         /* Split line up in individual parameters preceded by FUNCTION */
 300         for (i=0; line[i]; i++) {
 301                 if (isspace(line[i])) {
 302                         line[i] = '\0';
 303                         startofsym = 1;
 304                         continue;
 305                 }
 306                 if (startofsym) {
 307                         startofsym = 0;
 308                         vec[idx++] = FUNCTION;
 309                         vec[idx++] = &line[i];
 310                 }
 311         }
 312         for (i = 0; i < idx; i++) {
 313                 if (strcmp(vec[i], FUNCTION))
 314                         continue;
 315                 consume_symbol(vec[i + 1]);
 316         }
 317         vec[idx++] = filename;
 318         vec[idx] = NULL;
 319         exec_kernel_doc(vec);
 320 }
 321
 322 /*
 323  * Insert specific documentation section from a file.
 324  * Call kernel-doc with the following parameters:
 325  * kernel-doc -docbook -function "doc section" filename
 326  */
 327 static void docsect(char *filename, char *line)
 328 {
 329         char *vec[6]; /* kerneldoc -docbook -function "section" file NULL */
 330         char *s;
 331
 332         for (s = line; *s; s++)
 333                 if (*s == '\n')
 334                         *s = '\0';
 335
 336         asprintf(&s, "DOC: %s", line);
 337         consume_symbol(s);
 338         free(s);
 339
 340         vec[0] = KERNELDOC;
 341         vec[1] = DOCBOOK;
 342         vec[2] = FUNCTION;
 343         vec[3] = line;
 344         vec[4] = filename;
 345         vec[5] = NULL;
 346         exec_kernel_doc(vec);
 347 }
 348
 349 static void find_all_symbols(char *filename)
 350 {
 351         char *vec[4]; /* kerneldoc -list file NULL */
 352         pid_t pid;
 353         int ret, i, count, start;
 354         char real_filename[PATH_MAX + 1];
 355         int pipefd[2];
 356         char *data, *str;
 357         size_t data_len = 0;
 358
 359         vec[0] = KERNELDOC;
 360         vec[1] = LIST;
 361         vec[2] = filename;
 362         vec[3] = NULL;
 363
 364         if (pipe(pipefd)) {
 365                 perror("pipe");
 366                 exit(1);
 367         }
 368
 369         switch (pid=fork()) {
 370                 case -1:
 371                         perror("fork");
 372                         exit(1);
 373                 case  0:
 374                         close(pipefd[0]);
 375                         dup2(pipefd[1], 1);
 376                         memset(real_filename, 0, sizeof(real_filename));
 377                         strncat(real_filename, kernsrctree, PATH_MAX);
 378                         strncat(real_filename, "/" KERNELDOCPATH KERNELDOC,
 379                                         PATH_MAX - strlen(real_filename));
 380                         execvp(real_filename, vec);
 381                         fprintf(stderr, "exec ");
 382                         perror(real_filename);
 383                         exit(1);
 384                 default:
 385                         close(pipefd[1]);
 386                         data = malloc(4096);
 387                         do {
 388                                 while ((ret = read(pipefd[0],
 389                                                    data + data_len,
 390                                                    4096)) > 0) {
 391                                         data_len += ret;
 392                                         data = realloc(data, data_len + 4096);
 393                                 }
 394                         } while (ret == -EAGAIN);
 395                         if (ret != 0) {
 396                                 perror("read");
 397                                 exit(1);
 398                         }
 399                         waitpid(pid, &ret ,0);
 400         }
 401         if (WIFEXITED(ret))
 402                 exitstatus |= WEXITSTATUS(ret);
 403         else
 404                 exitstatus = 0xff;
 405
 406         count = 0;
 407         /* poor man's strtok, but with counting */
 408         for (i = 0; i < data_len; i++) {
 409                 if (data[i] == '\n') {
 410                         count++;
 411                         data[i] = '\0';
 412                 }
 413         }
 414         start = all_list_len;
 415         all_list_len += count;
 416         all_list = realloc(all_list, sizeof(char *) * all_list_len);
 417         str = data;
 418         for (i = 0; i < data_len && start != all_list_len; i++) {
 419                 if (data[i] == '\0') {
 420                         all_list[start] = str;
 421                         str = data + i + 1;
 422                         start++;
 423                 }
 424         }
 425 }
 426
 427 /*
 428  * Parse file, calling action specific functions for:
 429  * 1) Lines containing !E
 430  * 2) Lines containing !I
 431  * 3) Lines containing !D
 432  * 4) Lines containing !F
 433  * 5) Lines containing !P
 434  * 6) Lines containing !C
 435  * 7) Default lines - lines not matching the above
 436  */
 437 static void parse_file(FILE *infile)
 438 {
 439         char line[MAXLINESZ];
 440         char * s;
 441         while (fgets(line, MAXLINESZ, infile)) {
 442                 if (line[0] == '!') {
 443                         s = line + 2;
 444                         switch (line[1]) {
 445                                 case 'E':
 446                                         while (*s && !isspace(*s)) s++;
 447                                         *s = '\0';
 448                                         externalfunctions(line+2);
 449                                         break;
 450                                 case 'I':
 451                                         while (*s && !isspace(*s)) s++;
 452                                         *s = '\0';
 453                                         internalfunctions(line+2);
 454                                         break;
 455                                 case 'D':
 456                                         while (*s && !isspace(*s)) s++;
 457                                         *s = '\0';
 458                                         symbolsonly(line+2);
 459                                         break;
 460                                 case 'F':
 461                                         /* filename */
 462                                         while (*s && !isspace(*s)) s++;
 463                                         *s++ = '\0';
 464                                         /* function names */
 465                                         while (isspace(*s))
 466                                                 s++;
 467                                         singlefunctions(line +2, s);
 468                                         break;
 469                                 case 'P':
 470                                         /* filename */
 471                                         while (*s && !isspace(*s)) s++;
 472                                         *s++ = '\0';
 473                                         /* DOC: section name */
 474                                         while (isspace(*s))
 475                                                 s++;
 476                                         docsection(line + 2, s);
 477                                         break;
 478                                 case 'C':
 479                                         while (*s && !isspace(*s)) s++;
 480                                         *s = '\0';
 481                                         if (findall)
 482                                                 findall(line+2);
 483                                         break;
 484                                 default:
 485                                         defaultline(line);
 486                         }
 487                 }
 488                 else {
 489                         defaultline(line);
 490                 }
 491         }
 492         fflush(stdout);
 493 }
 494
 495
 496 int main(int argc, char *argv[])
 497 {
 498         FILE * infile;
 499         int i;
 500
 501         srctree = getenv("SRCTREE");
 502         if (!srctree)
 503                 srctree = getcwd(NULL, 0);
 504         kernsrctree = getenv("KBUILD_SRC");
 505         if (!kernsrctree || !*kernsrctree)
 506                 kernsrctree = srctree;
 507         if (argc != 3) {
 508                 usage();
 509                 exit(1);
 510         }
 511         /* Open file, exit on error */
 512         infile = fopen(argv[2], "r");
 513         if (infile == NULL) {
 514                 fprintf(stderr, "docproc: ");
 515                 perror(argv[2]);
 516                 exit(2);
 517         }
 518
 519         if (strcmp("doc", argv[1]) == 0)
 520         {
 521                 /* Need to do this in two passes.
 522                  * First pass is used to collect all symbols exported
 523                  * in the various files;
 524                  * Second pass generate the documentation.
 525                  * This is required because some functions are declared
 526                  * and exported in different files :-((
 527                  */
 528                 /* Collect symbols */
 529                 defaultline       = noaction;
 530                 internalfunctions = find_export_symbols;
 531                 externalfunctions = find_export_symbols;
 532                 symbolsonly       = find_export_symbols;
 533                 singlefunctions   = noaction2;
 534                 docsection        = noaction2;
 535                 findall           = find_all_symbols;
 536                 parse_file(infile);
 537
 538                 /* Rewind to start from beginning of file again */
 539                 fseek(infile, 0, SEEK_SET);
 540                 defaultline       = printline;
 541                 internalfunctions = intfunc;
 542                 externalfunctions = extfunc;
 543                 symbolsonly       = printline;
 544                 singlefunctions   = singfunc;
 545                 docsection        = docsect;
 546                 findall           = NULL;
 547
 548                 parse_file(infile);
 549
 550                 for (i = 0; i < all_list_len; i++) {
 551                         if (!all_list[i])
 552                                 continue;
 553                         fprintf(stderr, "Warning: didn't use docs for %s\n",
 554                                 all_list[i]);
 555                 }
 556         }
 557         else if (strcmp("depend", argv[1]) == 0)
 558         {
 559                 /* Create first part of dependency chain
 560                  * file.tmpl */
 561                 printf("%s\t", argv[2]);
 562                 defaultline       = noaction;
 563                 internalfunctions = adddep;
 564                 externalfunctions = adddep;
 565                 symbolsonly       = adddep;
 566                 singlefunctions   = adddep2;
 567                 docsection        = adddep2;
 568                 findall           = adddep;
 569                 parse_file(infile);
 570                 printf("\n");
 571         }
 572         else
 573         {
 574                 fprintf(stderr, "Unknown option: %s\n", argv[1]);
 575                 exit(1);
 576         }
 577         fclose(infile);
 578         fflush(stdout);
 579         return exitstatus;
 580 }