src/mkinit.c

   1 /*-
   2  * Copyright (c) 1991, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  * Copyright (c) 1997-2005
   5  *      Herbert Xu <herbert@gondor.apana.org.au>.  All rights reserved.
   6  *
   7  * This code is derived from software contributed to Berkeley by
   8  * Kenneth Almquist.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  */
  34
  35 /*
  36  * This program scans all the source files for code to handle various
  37  * special events and combines this code into one file.  This (allegedly)
  38  * improves the structure of the program since there is no need for
  39  * anyone outside of a module to know that that module performs special
  40  * operations on particular events.
  41  *
  42  * Usage:  mkinit sourcefile...
  43  */
  44
  45
  46 #include <sys/types.h>
  47 #include <stdio.h>
  48 #include <stdlib.h>
  49 #include <string.h>
  50 #include <fcntl.h>
  51 #include <unistd.h>
  52
  53
  54 /*
  55  * OUTFILE is the name of the output file.  Output is initially written
  56  * to the file OUTTEMP, which is then moved to OUTFILE.
  57  */
  58
  59 #define OUTFILE "init.c"
  60 #define OUTTEMP "init.c.new"
  61
  62
  63 /*
  64  * A text structure is basicly just a string that grows as more characters
  65  * are added onto the end of it.  It is implemented as a linked list of
  66  * blocks of characters.  The routines addstr and addchar append a string
  67  * or a single character, respectively, to a text structure.  Writetext
  68  * writes the contents of a text structure to a file.
  69  */
  70
  71 #define BLOCKSIZE 512
  72
  73 struct text {
  74         char *nextc;
  75         int nleft;
  76         struct block *start;
  77         struct block *last;
  78 };
  79
  80 struct block {
  81         struct block *next;
  82         char text[BLOCKSIZE];
  83 };
  84
  85
  86 /*
  87  * There is one event structure for each event that mkinit handles.
  88  */
  89
  90 struct event {
  91         char *name;             /* name of event (e.g. INIT) */
  92         char *routine;          /* name of routine called on event */
  93         char *comment;          /* comment describing routine */
  94         char *args;             /* arguments to routine */
  95         struct text code;       /* code for handling event */
  96 };
  97
  98
  99 char writer[] = "\
 100 /*\n\
 101  * This file was generated by the mkinit program.\n\
 102  */\n\
 103 \n";
 104
 105 char init[] = "\
 106 /*\n\
 107  * Initialization code.\n\
 108  */\n";
 109
 110 char exitreset[] = "\
 111 /*\n\
 112  * This routine is called when an error or an interrupt occurs in an\n\
 113  * interactive shell and control is returned to the main command loop\n\
 114  * but prior to exitshell. \n\
 115  */\n";
 116
 117 char forkreset[] = "\
 118 /*\n\
 119  * This routine is called when we enter a subshell.\n\
 120  */\n";
 121
 122 char postexitreset[] = "\
 123 /*\n\
 124  * This routine is called in exitshell.\n\
 125  */\n";
 126
 127 char reset[] = "\
 128 /*\n\
 129  * This routine is called when an error or an interrupt occurs in an\n\
 130  * interactive shell and control is returned to the main command loop.\n\
 131  */\n";
 132
 133
 134 struct event event[] = {
 135         {"INIT", "init", init},
 136         {"EXITRESET", "exitreset", exitreset},
 137         {"FORKRESET", "forkreset", forkreset, "union node *n"},
 138         {"POSTEXITRESET", "postexitreset", postexitreset},
 139         {"RESET", "reset", reset},
 140         {NULL, NULL}
 141 };
 142
 143
 144 char *curfile;                          /* current file */
 145 int linno;                              /* current line */
 146 char *header_files[200];                /* list of header files */
 147 struct text defines;                    /* #define statements */
 148 struct text decls;                      /* declarations */
 149 int amiddecls;                          /* for formatting */
 150
 151
 152 void readfile(char *);
 153 int match(char *, char *);
 154 int gooddefine(char *);
 155 void doevent(struct event *, FILE *, char *);
 156 void doinclude(char *);
 157 void dodecl(char *, FILE *);
 158 void output(void);
 159 void addstr(char *, struct text *);
 160 void addchar(int, struct text *);
 161 void writetext(struct text *, FILE *);
 162 FILE *ckfopen(char *, char *);
 163 void *ckmalloc(int);
 164 char *savestr(char *);
 165 static void error(char *);
 166 int main(int, char **);
 167
 168 #define equal(s1, s2)   (strcmp(s1, s2) == 0)
 169
 170 int
 171 main(int argc, char **argv)
 172 {
 173         char **ap;
 174
 175         header_files[0] = "\"shell.h\"";
 176         header_files[1] = "\"mystring.h\"";
 177         header_files[2] = "\"init.h\"";
 178         for (ap = argv + 1 ; *ap ; ap++)
 179                 readfile(*ap);
 180         output();
 181         rename(OUTTEMP, OUTFILE);
 182         exit(0);
 183         /* NOTREACHED */
 184 }
 185
 186
 187 /*
 188  * Parse an input file.
 189  */
 190
 191 void
 192 readfile(char *fname)
 193 {
 194         FILE *fp;
 195         char line[1024];
 196         struct event *ep;
 197
 198         fp = ckfopen(fname, "r");
 199         curfile = fname;
 200         linno = 0;
 201         amiddecls = 0;
 202         while (fgets(line, sizeof line, fp) != NULL) {
 203                 linno++;
 204                 for (ep = event ; ep->name ; ep++) {
 205                         if (line[0] == ep->name[0] && match(ep->name, line)) {
 206                                 doevent(ep, fp, fname);
 207                                 break;
 208                         }
 209                 }
 210                 if (line[0] == 'I' && match("INCLUDE", line))
 211                         doinclude(line);
 212                 if (line[0] == 'M' && match("MKINIT", line))
 213                         dodecl(line, fp);
 214                 if (line[0] == '#' && gooddefine(line)) {
 215                         char *cp;
 216                         char line2[1024];
 217                         static const char undef[] = "#undef ";
 218
 219                         strcpy(line2, line);
 220                         memcpy(line2, undef, sizeof(undef) - 1);
 221                         cp = line2 + sizeof(undef) - 1;
 222                         while(*cp && (*cp == ' ' || *cp == '\t'))
 223                                 cp++;
 224                         while(*cp && *cp != ' ' && *cp != '\t' && *cp != '\n')
 225                                 cp++;
 226                         *cp++ = '\n'; *cp = '\0';
 227                         addstr(line2, &defines);
 228                         addstr(line, &defines);
 229                 }
 230         }
 231         fclose(fp);
 232 }
 233
 234
 235 int
 236 match(char *name, char *line)
 237 {
 238         char *p, *q;
 239
 240         p = name, q = line;
 241         while (*p) {
 242                 if (*p++ != *q++)
 243                         return 0;
 244         }
 245         if (*q != '{' && *q != ' ' && *q != '\t' && *q != '\n')
 246                 return 0;
 247         return 1;
 248 }
 249
 250
 251 int
 252 gooddefine(char *line)
 253 {
 254         char *p;
 255
 256         if (! match("#define", line))
 257                 return 0;                       /* not a define */
 258         p = line + 7;
 259         while (*p == ' ' || *p == '\t')
 260                 p++;
 261         while (*p != ' ' && *p != '\t') {
 262                 if (*p == '(')
 263                         return 0;               /* macro definition */
 264                 p++;
 265         }
 266         while (*p != '\n' && *p != '\0')
 267                 p++;
 268         if (p[-1] == '\\')
 269                 return 0;                       /* multi-line definition */
 270         return 1;
 271 }
 272
 273
 274 void
 275 doevent(struct event *ep, FILE *fp, char *fname)
 276 {
 277         char line[1024];
 278         int indent;
 279         char *p;
 280
 281         sprintf(line, "\n      /* from %s: */\n", fname);
 282         addstr(line, &ep->code);
 283         addstr("      {\n", &ep->code);
 284         for (;;) {
 285                 linno++;
 286                 if (fgets(line, sizeof line, fp) == NULL)
 287                         error("Unexpected EOF");
 288                 if (equal(line, "}\n"))
 289                         break;
 290                 indent = 6;
 291                 for (p = line ; *p == '\t' ; p++)
 292                         indent += 8;
 293                 for ( ; *p == ' ' ; p++)
 294                         indent++;
 295                 if (*p == '\n' || *p == '#')
 296                         indent = 0;
 297                 while (indent >= 8) {
 298                         addchar('\t', &ep->code);
 299                         indent -= 8;
 300                 }
 301                 while (indent > 0) {
 302                         addchar(' ', &ep->code);
 303                         indent--;
 304                 }
 305                 addstr(p, &ep->code);
 306         }
 307         addstr("      }\n", &ep->code);
 308 }
 309
 310
 311 void
 312 doinclude(char *line)
 313 {
 314         char *p;
 315         char *name;
 316         char **pp;
 317
 318         for (p = line ; *p != '"' && *p != '<' && *p != '\0' ; p++);
 319         if (*p == '\0')
 320                 error("Expecting '\"' or '<'");
 321         name = p;
 322         while (*p != ' ' && *p != '\t' && *p != '\n')
 323                 p++;
 324         if (p[-1] != '"' && p[-1] != '>')
 325                 error("Missing terminator");
 326         *p = '\0';
 327
 328         /* name now contains the name of the include file */
 329         for (pp = header_files ; *pp && ! equal(*pp, name) ; pp++);
 330         if (*pp == NULL)
 331                 *pp = savestr(name);
 332 }
 333
 334
 335 void
 336 dodecl(char *line1, FILE *fp)
 337 {
 338         char line[1024];
 339         char *p, *q;
 340
 341         if (strcmp(line1, "MKINIT\n") == 0) { /* start of struct/union decl */
 342                 addchar('\n', &decls);
 343                 do {
 344                         linno++;
 345                         if (fgets(line, sizeof line, fp) == NULL)
 346                                 error("Unterminated structure declaration");
 347                         addstr(line, &decls);
 348                 } while (line[0] != '}');
 349                 amiddecls = 0;
 350         } else {
 351                 if (! amiddecls)
 352                         addchar('\n', &decls);
 353                 q = NULL;
 354                 for (p = line1 + 6 ; *p && strchr("=/\n", *p) == NULL; p++)
 355                         continue;
 356                 if (*p == '=') {                /* eliminate initialization */
 357                         for (q = p ; *q && *q != ';' ; q++);
 358                         if (*q == '\0')
 359                                 q = NULL;
 360                         else {
 361                                 while (p[-1] == ' ')
 362                                         p--;
 363                                 *p = '\0';
 364                         }
 365                 }
 366                 addstr("extern", &decls);
 367                 addstr(line1 + 6, &decls);
 368                 if (q != NULL)
 369                         addstr(q, &decls);
 370                 amiddecls = 1;
 371         }
 372 }
 373
 374
 375
 376 /*
 377  * Write the output to the file OUTTEMP.
 378  */
 379
 380 void
 381 output(void)
 382 {
 383         FILE *fp;
 384         char **pp;
 385         struct event *ep;
 386
 387         fp = ckfopen(OUTTEMP, "w");
 388         fputs(writer, fp);
 389         for (pp = header_files ; *pp ; pp++)
 390                 fprintf(fp, "#include %s\n", *pp);
 391         fputs("\n\n\n", fp);
 392         writetext(&defines, fp);
 393         fputs("\n\n", fp);
 394         writetext(&decls, fp);
 395         for (ep = event ; ep->name ; ep++) {
 396                 fputs("\n\n\n", fp);
 397                 fputs(ep->comment, fp);
 398                 fprintf(fp, "\nvoid\n%s(%s) {\n", ep->routine, ep->args ?: "");
 399                 writetext(&ep->code, fp);
 400                 fprintf(fp, "}\n");
 401         }
 402         fclose(fp);
 403 }
 404
 405
 406 /*
 407  * A text structure is simply a block of text that is kept in memory.
 408  * Addstr appends a string to the text struct, and addchar appends a single
 409  * character.
 410  */
 411
 412 void
 413 addstr(char *s, struct text *text)
 414 {
 415         while (*s) {
 416                 if (--text->nleft < 0)
 417                         addchar(*s++, text);
 418                 else
 419                         *text->nextc++ = *s++;
 420         }
 421 }
 422
 423
 424 void
 425 addchar(int c, struct text *text)
 426 {
 427         struct block *bp;
 428
 429         if (--text->nleft < 0) {
 430                 bp = ckmalloc(sizeof *bp);
 431                 if (text->start == NULL)
 432                         text->start = bp;
 433                 else
 434                         text->last->next = bp;
 435                 text->last = bp;
 436                 text->nextc = bp->text;
 437                 text->nleft = BLOCKSIZE - 1;
 438         }
 439         *text->nextc++ = c;
 440 }
 441
 442 /*
 443  * Write the contents of a text structure to a file.
 444  */
 445 void
 446 writetext(struct text *text, FILE *fp)
 447 {
 448         struct block *bp;
 449
 450         if (text->start != NULL) {
 451                 for (bp = text->start ; bp != text->last ; bp = bp->next) {
 452                         if ((fwrite(bp->text, sizeof (char), BLOCKSIZE, fp)) != BLOCKSIZE)
 453                                 error("Can't write data\n");
 454                 }
 455                 if ((fwrite(bp->text, sizeof (char), BLOCKSIZE - text->nleft, fp)) != (BLOCKSIZE - text->nleft))
 456                         error("Can't write data\n");
 457         }
 458 }
 459
 460 FILE *
 461 ckfopen(char *file, char *mode)
 462 {
 463         FILE *fp;
 464
 465         if ((fp = fopen(file, mode)) == NULL) {
 466                 fprintf(stderr, "Can't open %s\n", file);
 467                 exit(2);
 468         }
 469         return fp;
 470 }
 471
 472 void *
 473 ckmalloc(int nbytes)
 474 {
 475         char *p;
 476
 477         if ((p = malloc(nbytes)) == NULL)
 478                 error("Out of space");
 479         return p;
 480 }
 481
 482 char *
 483 savestr(char *s)
 484 {
 485         char *p;
 486
 487         p = ckmalloc(strlen(s) + 1);
 488         strcpy(p, s);
 489         return p;
 490 }
 491
 492 static void
 493 error(char *msg)
 494 {
 495         if (curfile != NULL)
 496                 fprintf(stderr, "%s:%d: ", curfile, linno);
 497         fprintf(stderr, "%s\n", msg);
 498         exit(2);
 499         /* NOTREACHED */
 500 }