2 * Copyright (c) 1994 University of Maryland
5 * Permission to use, copy, modify, distribute, and sell this software and its
6 * documentation for any purpose is hereby granted without fee, provided that
7 * the above copyright notice appear in all copies and that both that
8 * copyright notice and this permission notice appear in supporting
9 * documentation, and that the name of U.M. not be used in advertising or
10 * publicity pertaining to distribution of the software without specific,
11 * written prior permission. U.M. makes no representations about the
12 * suitability of this software for any purpose. It is provided "as is"
13 * without express or implied warranty.
15 * U.M. DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL U.M.
17 * BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
18 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
19 * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
20 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
22 * Author: James da Silva, Systems Design and Analysis Group
23 * Computer Science Department
24 * University of Maryland at College Park
29 * ========================================================================
32 * Generates a Makefile and main C file for a crunched executable,
33 * from specs given in a .conf file.
42 #include <sys/types.h>
44 #include <sys/param.h>
46 #define CRUNCH_VERSION "0.2"
48 #define MAXLINELEN 16384
49 #define MAXFIELDS 2048
52 /* internal representation of conf file: */
54 /* simple lists of strings suffice for most parms */
56 typedef struct strlst {
61 /* progs have structure, each field can be set with "special" or calculated */
64 struct prog *next; /* link field */
65 char *name; /* program name */
66 char *ident; /* C identifier for the program name */
69 char *objvar; /* Makefile variable to replace OBJS */
70 strlst_t *objs, *objpaths;
79 strlst_t *srcdirs = NULL;
80 strlst_t *libs = NULL;
83 char line[MAXLINELEN];
85 char confname[MAXPATHLEN], infilename[MAXPATHLEN];
86 char outmkname[MAXPATHLEN], outcfname[MAXPATHLEN], execfname[MAXPATHLEN];
87 char tempfname[MAXPATHLEN], cachename[MAXPATHLEN], curfilename[MAXPATHLEN];
88 char outhdrname[MAXPATHLEN] ; /* user-supplied header for *.mk */
92 int verbose, readcache; /* options */
97 /* general library routines */
99 void status(char *str);
100 void out_of_memory(void);
101 void add_string(strlst_t **listp, char *str);
102 int is_dir(char *pathname);
103 int is_nonempty_file(char *pathname);
105 /* helper routines for main() */
108 void parse_conf_file(void);
109 void gen_outputs(void);
112 int main(int argc, char **argv)
119 *outmkname = *outcfname = *execfname = '\0';
121 while((optc = getopt(argc, argv, "lh:m:c:e:fq")) != -1) {
123 case 'f': readcache = 0; break;
124 case 'q': verbose = 0; break;
126 case 'm': strcpy(outmkname, optarg); break;
127 case 'h': strcpy(outhdrname, optarg); break;
128 case 'c': strcpy(outcfname, optarg); break;
129 case 'e': strcpy(execfname, optarg); break;
130 case 'l': list_mode++; verbose = 0; break;
140 if(argc != 1) usage();
146 strcpy(infilename, argv[0]);
148 /* confname = `basename infilename .conf` */
150 if((p=strrchr(infilename, '/')) != NULL) strcpy(confname, p+1);
151 else strcpy(confname, infilename);
152 if((p=strrchr(confname, '.')) != NULL && !strcmp(p, ".conf")) *p = '\0';
154 if(!*outmkname) sprintf(outmkname, "%s.mk", confname);
155 if(!*outcfname) sprintf(outcfname, "%s.c", confname);
156 if(!*execfname) sprintf(execfname, "%s", confname);
158 sprintf(cachename, "%s.cache", confname);
159 sprintf(tempfname, ".tmp_%sXXXXXX", confname);
160 if(mktemp(tempfname) == NULL) {
177 fprintf(stderr, "%s\n%s\n",
178 "usage: crunchgen [-fq] [-m <makefile>] [-c <c file>]",
179 " [-e <exec file>] <conffile>");
185 * ========================================================================
186 * parse_conf_file subsystem
190 /* helper routines for parse_conf_file */
192 void parse_one_file(char *filename);
193 void parse_line(char *line, int *fc, char **fv, int nf);
194 void add_srcdirs(int argc, char **argv);
195 void add_progs(int argc, char **argv);
196 void add_link(int argc, char **argv);
197 void add_libs(int argc, char **argv);
198 void add_special(int argc, char **argv);
200 prog_t *find_prog(char *str);
201 void add_prog(char *progname);
204 void parse_conf_file(void)
206 if(!is_nonempty_file(infilename))
207 errx(1, "fatal: input file \"%s\" not found", infilename);
208 parse_one_file(infilename);
209 if(readcache && is_nonempty_file(cachename)) {
211 parse_one_file(cachename);
216 void parse_one_file(char *filename)
218 char *fieldv[MAXFIELDS];
220 void (*f)(int c, char **v);
223 sprintf(line, "reading %s", filename);
225 strcpy(curfilename, filename);
227 if((cf = fopen(curfilename, "r")) == NULL) {
228 warn("%s", curfilename);
234 while(fgets(line, MAXLINELEN, cf) != NULL) {
236 parse_line(line, &fieldc, fieldv, MAXFIELDS);
237 if(fieldc < 1) continue;
238 if(!strcmp(fieldv[0], "srcdirs")) f = add_srcdirs;
239 else if(!strcmp(fieldv[0], "progs")) f = add_progs;
240 else if(!strcmp(fieldv[0], "ln")) f = add_link;
241 else if(!strcmp(fieldv[0], "libs")) f = add_libs;
242 else if(!strcmp(fieldv[0], "special")) f = add_special;
244 warnx("%s:%d: skipping unknown command `%s'",
245 curfilename, linenum, fieldv[0]);
250 warnx("%s:%d: %s command needs at least 1 argument, skipping",
251 curfilename, linenum, fieldv[0]);
259 warn("%s", curfilename);
266 void parse_line(char *line, int *fc, char **fv, int nf)
273 while(isspace(*p)) p++;
274 if(*p == '\0' || *p == '#') break;
276 if(*fc < nf) fv[(*fc)++] = p;
277 while(*p && !isspace(*p) && *p != '#') p++;
278 if(*p == '\0' || *p == '#') break;
281 if(*p) *p = '\0'; /* needed for '#' case */
285 void add_srcdirs(int argc, char **argv)
289 for(i=1;i<argc;i++) {
291 add_string(&srcdirs, argv[i]);
293 warnx("%s:%d: `%s' is not a directory, skipping it",
294 curfilename, linenum, argv[i]);
301 void add_progs(int argc, char **argv)
310 void add_prog(char *progname)
314 /* add to end, but be smart about dups */
316 for(p1 = NULL, p2 = progs; p2 != NULL; p1 = p2, p2 = p2->next)
317 if(!strcmp(p2->name, progname)) return;
319 p2 = malloc(sizeof(prog_t));
321 memset(p2, 0, sizeof(prog_t));
322 p2->name = strdup(progname);
328 if(p1 == NULL) progs = p2;
331 p2->ident = p2->srcdir = p2->objdir = NULL;
332 p2->links = p2->objs = p2->keeplist = NULL;
335 printf("%s\n",progname);
339 void add_link(int argc, char **argv)
342 prog_t *p = find_prog(argv[1]);
345 warnx("%s:%d: no prog %s previously declared, skipping link",
346 curfilename, linenum, argv[1]);
350 for(i=2;i<argc;i++) {
352 printf("%s\n",argv[i]);
353 add_string(&p->links, argv[i]);
358 void add_libs(int argc, char **argv)
363 add_string(&libs, argv[i]);
367 void add_special(int argc, char **argv)
370 prog_t *p = find_prog(argv[1]);
373 if(reading_cache) return;
374 warnx("%s:%d: no prog %s previously declared, skipping special",
375 curfilename, linenum, argv[1]);
380 if(!strcmp(argv[2], "ident")) {
381 if(argc != 4) goto argcount;
382 if((p->ident = strdup(argv[3])) == NULL)
385 else if(!strcmp(argv[2], "srcdir")) {
386 if(argc != 4) goto argcount;
387 if((p->srcdir = strdup(argv[3])) == NULL)
390 else if(!strcmp(argv[2], "objdir")) {
391 if(argc != 4) goto argcount;
392 if((p->objdir = strdup(argv[3])) == NULL)
395 else if(!strcmp(argv[2], "objs")) {
398 add_string(&p->objs, argv[i]);
400 else if(!strcmp(argv[2], "objpaths")) {
403 add_string(&p->objpaths, argv[i]);
405 else if(!strcmp(argv[2], "keep")) {
408 add_string(&p->keeplist, argv[i]);
410 else if(!strcmp(argv[2], "objvar")) {
413 if((p->objvar = strdup(argv[3])) == NULL)
417 warnx("%s:%d: bad parameter name `%s', skipping line",
418 curfilename, linenum, argv[2]);
425 warnx("%s:%d: too %s arguments, expected \"special %s %s <string>\"",
426 curfilename, linenum, argc < 4? "few" : "many", argv[1], argv[2]);
431 prog_t *find_prog(char *str)
435 for(p = progs; p != NULL; p = p->next)
436 if(!strcmp(p->name, str)) return p;
443 * ========================================================================
444 * gen_outputs subsystem
448 /* helper subroutines */
450 void remove_error_progs(void);
451 void fillin_program(prog_t *p);
452 void gen_specials_cache(void);
453 void gen_output_makefile(void);
454 void gen_output_cfile(void);
456 void fillin_program_objs(prog_t *p, char *path);
457 void top_makefile_rules(FILE *outmk);
458 void prog_makefile_rules(FILE *outmk, prog_t *p);
459 void output_strlst(FILE *outf, strlst_t *lst);
460 char *genident(char *str);
461 char *dir_search(char *progname);
464 void gen_outputs(void)
468 for(p = progs; p != NULL; p = p->next)
471 remove_error_progs();
472 gen_specials_cache();
474 gen_output_makefile();
477 "Run \"make -f %s objs exe\" to build crunched binary.\n",
482 * run the makefile for the program to find which objects are necessary
484 void fillin_program(prog_t *p)
486 char path[MAXPATHLEN];
490 sprintf(line, "filling in parms for %s", p->name);
494 p->ident = genident(p->name);
496 srcparent = dir_search(p->name);
498 sprintf(path, "%s/%s", srcparent, p->name);
500 p->srcdir = strdup(path);
502 if(!p->objdir && p->srcdir) {
505 sprintf(path, "cd %s && echo -n /usr/obj`/bin/pwd`", p->srcdir);
506 p->objdir = p->srcdir;
509 fgets(path,sizeof path, f);
512 p->objdir = strdup(path);
517 * XXX look for a Makefile.{name} in local directory first.
518 * This lets us override the original Makefile.
520 sprintf(path, "Makefile.%s", p->name);
521 if (is_nonempty_file(path)) {
522 sprintf(line, "Using %s for %s", path, p->name);
525 if(p->srcdir) sprintf(path, "%s/Makefile", p->srcdir);
526 if(!p->objs && p->srcdir && is_nonempty_file(path))
527 fillin_program_objs(p, path);
529 if(!p->objpaths && p->objdir && p->objs)
530 for(s = p->objs; s != NULL; s = s->next) {
531 sprintf(line, "%s/%s", p->objdir, s->str);
532 add_string(&p->objpaths, line);
535 if(!p->srcdir && verbose)
536 warnx("%s: %s: warning: could not find source directory",
537 infilename, p->name);
538 if(!p->objs && verbose)
539 warnx("%s: %s: warning: could not find any .o files",
540 infilename, p->name);
543 warnx("%s: %s: error: no objpaths specified or calculated",
544 infilename, p->name);
545 p->goterror = goterror = 1;
549 void fillin_program_objs(prog_t *p, char *path)
556 /* discover the objs from the srcdir Makefile */
558 if((f = fopen(tempfname, "w")) == NULL) {
559 warn("%s", tempfname);
567 * XXX include outhdrname (e.g. to contain Make variables)
569 if (outhdrname[0] != '\0')
570 fprintf(f, ".include \"%s\"\n", outhdrname);
571 fprintf(f, ".include \"%s\"\n", path);
572 fprintf(f, ".if defined(PROG) && !defined(%s)\n", objvar);
573 fprintf(f, "%s=${PROG}.o\n", objvar);
574 fprintf(f, ".endif\n");
575 fprintf(f, "crunchgen_objs:\n\t@echo 'OBJS= '${%s}\n", objvar);
578 sprintf(line, "make -f %s crunchgen_objs 2>&1", tempfname);
579 if((f = popen(line, "r")) == NULL) {
580 warn("submake pipe");
585 while(fgets(line, MAXLINELEN, f)) {
586 if(strncmp(line, "OBJS= ", 6)) {
587 warnx("make error: %s", line);
592 while(isspace(*cp)) cp++;
595 while(*cp && !isspace(*cp)) cp++;
596 if(*cp) *cp++ = '\0';
597 add_string(&p->objs, obj);
598 while(isspace(*cp)) cp++;
601 if((rc=pclose(f)) != 0) {
602 warnx("make error: make returned %d", rc);
608 void remove_error_progs(void)
612 p1 = NULL; p2 = progs;
615 p1 = p2, p2 = p2->next;
617 /* delete it from linked list */
618 warnx("%s: %s: ignoring program because of errors",
619 infilename, p2->name);
620 if(p1) p1->next = p2->next;
621 else progs = p2->next;
627 void gen_specials_cache(void)
632 sprintf(line, "generating %s", cachename);
635 if((cachef = fopen(cachename, "w")) == NULL) {
636 warn("%s", cachename);
641 fprintf(cachef, "# %s - parm cache generated from %s by crunchgen %s\n\n",
642 cachename, infilename, CRUNCH_VERSION);
644 for(p = progs; p != NULL; p = p->next) {
645 fprintf(cachef, "\n");
647 fprintf(cachef, "special %s srcdir %s\n", p->name, p->srcdir);
649 fprintf(cachef, "special %s objdir %s\n", p->name, p->objdir);
651 fprintf(cachef, "special %s objs", p->name);
652 output_strlst(cachef, p->objs);
654 fprintf(cachef, "special %s objpaths", p->name);
655 output_strlst(cachef, p->objpaths);
661 void gen_output_makefile(void)
666 sprintf(line, "generating %s", outmkname);
669 if((outmk = fopen(outmkname, "w")) == NULL) {
670 warn("%s", outmkname);
675 fprintf(outmk, "# %s - generated from %s by crunchgen %s\n\n",
676 outmkname, infilename, CRUNCH_VERSION);
677 if (outhdrname[0] != '\0')
678 fprintf(outmk, ".include \"%s\"\n", outhdrname);
680 top_makefile_rules(outmk);
682 for(p = progs; p != NULL; p = p->next)
683 prog_makefile_rules(outmk, p);
685 fprintf(outmk, "\n# ========\n");
690 void gen_output_cfile(void)
692 extern char *crunched_skel[];
698 sprintf(line, "generating %s", outcfname);
701 if((outcf = fopen(outcfname, "w")) == NULL) {
702 warn("%s", outcfname);
708 "/* %s - generated from %s by crunchgen %s */\n",
709 outcfname, infilename, CRUNCH_VERSION);
711 fprintf(outcf, "#define EXECNAME \"%s\"\n", execfname);
712 for(cp = crunched_skel; *cp != NULL; cp++)
713 fprintf(outcf, "%s\n", *cp);
715 for(p = progs; p != NULL; p = p->next)
716 fprintf(outcf, "extern int _crunched_%s_stub();\n", p->ident);
718 fprintf(outcf, "\nstruct stub entry_points[] = {\n");
719 for(p = progs; p != NULL; p = p->next) {
720 fprintf(outcf, "\t{ \"%s\", _crunched_%s_stub },\n",
722 for(s = p->links; s != NULL; s = s->next)
723 fprintf(outcf, "\t{ \"%s\", _crunched_%s_stub },\n",
727 fprintf(outcf, "\t{ EXECNAME, crunched_main },\n");
728 fprintf(outcf, "\t{ NULL, NULL }\n};\n");
733 char *genident(char *str)
738 * generates a Makefile/C identifier from a program name, mapping '-' to
739 * '_' and ignoring all other non-identifier characters. This leads to
740 * programs named "foo.bar" and "foobar" to map to the same identifier.
743 if((n = strdup(str)) == NULL)
745 for(d = s = n; *s != '\0'; s++) {
746 if(*s == '-') *d++ = '_';
747 else if(*s == '_' || isalnum(*s)) *d++ = *s;
754 char *dir_search(char *progname)
756 char path[MAXPATHLEN];
759 for(dir=srcdirs; dir != NULL; dir=dir->next) {
760 sprintf(path, "%s/%s", dir->str, progname);
761 if(is_dir(path)) return dir->str;
767 void top_makefile_rules(FILE *outmk)
771 fprintf(outmk, "LIBS=");
772 output_strlst(outmk, libs);
774 fprintf(outmk, "CRUNCHED_OBJS=");
775 for(p = progs; p != NULL; p = p->next)
776 fprintf(outmk, " %s.lo", p->name);
777 fprintf(outmk, "\n");
779 fprintf(outmk, "SUBMAKE_TARGETS=");
780 for(p = progs; p != NULL; p = p->next)
781 fprintf(outmk, " %s_make", p->ident);
782 fprintf(outmk, "\nSUBCLEAN_TARGETS=");
783 for(p = progs; p != NULL; p = p->next)
784 fprintf(outmk, " %s_clean", p->ident);
785 fprintf(outmk, "\n\n");
787 fprintf(outmk, "%s: %s.o $(CRUNCHED_OBJS)\n",
788 execfname, execfname);
789 fprintf(outmk, "\t$(CC) -static -o %s %s.o $(CRUNCHED_OBJS) $(LIBS)\n",
790 execfname, execfname);
791 fprintf(outmk, "\tstrip %s\n", execfname);
792 fprintf(outmk, "all: objs exe\nobjs: $(SUBMAKE_TARGETS)\n");
793 fprintf(outmk, "exe: %s\n", execfname);
794 fprintf(outmk, "realclean: clean subclean\n");
795 fprintf(outmk, "clean:\n\trm -f %s *.lo *.o *_stub.c\n",
797 fprintf(outmk, "subclean: $(SUBCLEAN_TARGETS)\n");
801 void prog_makefile_rules(FILE *outmk, prog_t *p)
805 fprintf(outmk, "\n# -------- %s\n\n", p->name);
807 if(p->srcdir && p->objs) {
808 fprintf(outmk, "%s_SRCDIR=%s\n", p->ident, p->srcdir);
809 fprintf(outmk, "%s_OBJS=", p->ident);
810 output_strlst(outmk, p->objs);
811 fprintf(outmk, "%s_make:\n", p->ident);
812 fprintf(outmk, "\t(cd $(%s_SRCDIR) && make depend && make $(%s_OBJS))\n",
814 fprintf(outmk, "%s_clean:\n", p->ident);
815 fprintf(outmk, "\t(cd $(%s_SRCDIR) && make clean)\n\n", p->ident);
818 fprintf(outmk, "%s_make:\n\t@echo \"** cannot make objs for %s\"\n\n",
821 fprintf(outmk, "%s_OBJPATHS=", p->ident);
822 output_strlst(outmk, p->objpaths);
824 fprintf(outmk, "%s_stub.c:\n", p->name);
825 fprintf(outmk, "\techo \""
826 "int _crunched_%s_stub(int argc, char **argv, char **envp)"
827 "{return main(argc,argv,envp);}\" >%s_stub.c\n",
829 fprintf(outmk, "%s.lo: %s_stub.o $(%s_OBJPATHS)\n",
830 p->name, p->name, p->ident);
831 fprintf(outmk, "\tld -dc -r -o %s.lo %s_stub.o $(%s_OBJPATHS)\n",
832 p->name, p->name, p->ident);
833 fprintf(outmk, "\tcrunchide -k _crunched_%s_stub ", p->ident);
834 for(lst = p->keeplist; lst != NULL; lst = lst->next)
835 fprintf(outmk, "-k _%s ", lst->str);
836 fprintf(outmk, "%s.lo\n", p->name);
839 void output_strlst(FILE *outf, strlst_t *lst)
841 for(; lst != NULL; lst = lst->next)
842 fprintf(outf, " %s", lst->str);
848 * ========================================================================
849 * general library routines
853 void status(char *str)
855 static int lastlen = 0;
861 spaces = lastlen - len;
862 if(spaces < 1) spaces = 1;
864 fprintf(stderr, " [%s]%*.*s\r", str, spaces, spaces, " ");
870 void out_of_memory(void)
872 errx(1, "%s: %d: out of memory, stopping", infilename, linenum);
876 void add_string(strlst_t **listp, char *str)
880 /* add to end, but be smart about dups */
882 for(p1 = NULL, p2 = *listp; p2 != NULL; p1 = p2, p2 = p2->next)
883 if(!strcmp(p2->str, str)) return;
885 p2 = malloc(sizeof(strlst_t));
887 memset(p2, 0, sizeof(strlst_t));
888 p2->str = strdup(str);
894 if(p1 == NULL) *listp = p2;
899 int is_dir(char *pathname)
903 if(stat(pathname, &buf) == -1)
905 return S_ISDIR(buf.st_mode);
908 int is_nonempty_file(char *pathname)
912 if(stat(pathname, &buf) == -1)
915 return S_ISREG(buf.st_mode) && buf.st_size > 0;