1: /* command line interpretation, image loading etc. for Gforth
2:
3:
4: Copyright (C) 1995 Free Software Foundation, Inc.
5:
6: This file is part of Gforth.
7:
8: Gforth is free software; you can redistribute it and/or
9: modify it under the terms of the GNU General Public License
10: as published by the Free Software Foundation; either version 2
11: of the License, or (at your option) any later version.
12:
13: This program is distributed in the hope that it will be useful,
14: but WITHOUT ANY WARRANTY; without even the implied warranty of
15: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16: GNU General Public License for more details.
17:
18: You should have received a copy of the GNU General Public License
19: along with this program; if not, write to the Free Software
20: Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21: */
22:
23: #include "config.h"
24: #include <errno.h>
25: #include <ctype.h>
26: #include <stdio.h>
27: #include <string.h>
28: #include <math.h>
29: #include <sys/types.h>
30: #include <sys/stat.h>
31: #include <fcntl.h>
32: #include <assert.h>
33: #include <stdlib.h>
34: #include "forth.h"
35: #include "io.h"
36: #include "getopt.h"
37: #include "version.h"
38:
39: #ifdef MSDOS
40: jmp_buf throw_jmp_buf;
41: #endif
42:
43: /* Define FUZZ for better image positioning */
44: #define FUZZ 0x4000
45:
46: #ifndef DEFAULTPATH
47: # define DEFAULTPATH "/usr/local/lib/gforth:."
48: #endif
49:
50: #ifdef DIRECT_THREADED
51: # define CA(n) (symbols[(n)])
52: #else
53: # define CA(n) ((Cell)(symbols+(n)))
54: #endif
55:
56: #define maxaligned(n) (typeof(n))((((Cell)n)+sizeof(Float)-1)&-sizeof(Float))
57:
58: static Cell dictsize=0;
59: static Cell dsize=0;
60: static Cell rsize=0;
61: static Cell fsize=0;
62: static Cell lsize=0;
63: char *progname;
64:
65: /* image file format:
66: * "#! binary-path -i\n" (e.g., "#! /usr/local/bin/gforth-0.2.0 -i\n")
67: * padding to a multiple of 8
68: * magic: "Gforth1x" means format 0.2,
69: * where x is even for big endian and odd for little endian
70: * and x & ~1 is the size of the cell in bytes.
71: * padding to max alignment (no padding necessary on current machines)
72: * ImageHeader structure (see below)
73: * data (size in ImageHeader.image_size)
74: * tags ((if relocatable, 1 bit/data cell)
75: *
76: * tag==1 means that the corresponding word is an address;
77: * If the word is >=0, the address is within the image;
78: * addresses within the image are given relative to the start of the image.
79: * If the word =-1 (CF_NIL), the address is NIL,
80: * If the word is <CF_NIL and >CF(DODOES), it's a CFA (:, Create, ...)
81: * If the word =CF(DODOES), it's a DOES> CFA
82: * If the word =CF(DOESJUMP), it's a DOES JUMP (2 Cells after DOES>,
83: * possibly containing a jump to dodoes)
84: * If the word is <CF(DOESJUMP), it's a primitive
85: */
86:
87: typedef struct {
88: Address base; /* base address of image (0 if relocatable) */
89: UCell checksum; /* checksum of ca's to protect against some
90: incompatible binary/executable combinations
91: (0 if relocatable) */
92: UCell image_size; /* all sizes in bytes */
93: UCell dict_size;
94: UCell data_stack_size;
95: UCell fp_stack_size;
96: UCell return_stack_size;
97: UCell locals_stack_size;
98: Xt *boot_entry; /* initial ip for booting (in BOOT) */
99: Xt *throw_entry; /* ip after signal (in THROW) */
100: } ImageHeader;
101: /* the image-header is created in main.fs */
102:
103: void relocate(Cell *image, char *bitstring, int size, Label symbols[])
104: {
105: int i=0, j, k, steps=(size/sizeof(Cell))/8;
106: char bits;
107: /* static char bits[8]={0x80,0x40,0x20,0x10,0x08,0x04,0x02,0x01};*/
108:
109: /* printf("relocating %x[%x]\n", image, size); */
110:
111: for(k=0; k<=steps; k++)
112: for(j=0, bits=bitstring[k]; j<8; j++, i++, bits<<=1)
113: if(bits & 0x80)
114: if(image[i]<0)
115: switch(image[i])
116: {
117: case CF_NIL : image[i]=0; break;
118: case CF(DOCOL) :
119: case CF(DOVAR) :
120: case CF(DOCON) :
121: case CF(DOUSER) :
122: case CF(DODEFER) :
123: case CF(DOFIELD) : MAKE_CF(image+i,symbols[CF(image[i])]); break;
124: case CF(DODOES) : MAKE_DOES_CF(image+i,image[i+1]+((Cell)image));
125: break;
126: case CF(DOESJUMP): MAKE_DOES_HANDLER(image+i); break;
127: default :
128: /* printf("Code field generation image[%x]:=CA(%x)\n",
129: i, CF(image[i]));
130: */ image[i]=(Cell)CA(CF(image[i]));
131: }
132: else
133: image[i]+=(Cell)image;
134: }
135:
136: UCell checksum(Label symbols[])
137: {
138: UCell r=0;
139: Cell i;
140:
141: for (i=DOCOL; i<=DOESJUMP; i++) {
142: r ^= (UCell)(symbols[i]);
143: r = (r << 5) | (r >> (8*sizeof(Cell)-5));
144: }
145: #ifdef DIRECT_THREADED
146: /* we have to consider all the primitives */
147: for (; symbols[i]!=(Label)0; i++) {
148: r ^= (UCell)(symbols[i]);
149: r = (r << 5) | (r >> (8*sizeof(Cell)-5));
150: }
151: #else
152: /* in indirect threaded code all primitives are accessed through the
153: symbols table, so we just have to put the base address of symbols
154: in the checksum */
155: r ^= (UCell)symbols;
156: #endif
157: return r;
158: }
159:
160: Address loader(FILE *imagefile, char* filename)
161: /* returns the address of the image proper (after the preamble) */
162: {
163: ImageHeader header;
164: Address image;
165: Address imp; /* image+preamble */
166: Char magic[8];
167: Cell wholesize;
168: Cell imagesize; /* everything needed by the image */
169: Cell preamblesize=0;
170: Label *symbols=engine(0,0,0,0,0);
171: UCell check_sum=checksum(symbols);
172:
173: static char* endianstring[]= { "big","little" };
174:
175: do
176: {
177: if(fread(magic,sizeof(Char),8,imagefile) < 8) {
178: fprintf(stderr,"%s: image %s doesn't seem to be a Gforth (>=0.2) image.\n",
179: progname, filename);
180: exit(1);
181: }
182: preamblesize+=8;
183: #ifdef DEBUG
184: fprintf(stderr,"Magic found: %-8s\n",magic);
185: #endif
186: }
187: while(memcmp(magic,"Gforth1",7));
188:
189: if(magic[7] != sizeof(Cell) +
190: #ifdef WORDS_BIGENDIAN
191: '0'
192: #else
193: '1'
194: #endif
195: )
196: { fprintf(stderr,"This image is %d bit %s-endian, whereas the machine is %d bit %s-endian.\n",
197: ((magic[7]-'0')&~1)*8, endianstring[magic[7]&1],
198: sizeof(Cell)*8, endianstring[
199: #ifdef WORDS_BIGENDIAN
200: 0
201: #else
202: 1
203: #endif
204: ]);
205: exit(-2);
206: };
207:
208: fread((void *)&header,sizeof(ImageHeader),1,imagefile);
209: if (dictsize==0)
210: dictsize = header.dict_size;
211: if (dsize==0)
212: dsize=header.data_stack_size;
213: if (rsize==0)
214: rsize=header.return_stack_size;
215: if (fsize==0)
216: fsize=header.fp_stack_size;
217: if (lsize==0)
218: lsize=header.locals_stack_size;
219: dictsize=maxaligned(dictsize);
220: dsize=maxaligned(dsize);
221: rsize=maxaligned(rsize);
222: lsize=maxaligned(lsize);
223: fsize=maxaligned(fsize);
224:
225: wholesize = preamblesize+dictsize+dsize+rsize+fsize+lsize;
226: imagesize = preamblesize+header.image_size+((header.image_size-1)/sizeof(Cell))/8+1;
227: image=malloc((wholesize>imagesize?wholesize:imagesize)
228: #ifdef FUZZ
229: +FUZZ
230: #endif
231: );
232: /*image = maxaligned(image);*/
233: /* memset(image,0,wholesize); */
234:
235: #ifdef FUZZ
236: if(header.base==0) image += FUZZ/2;
237: else if((UCell)(header.base - (Cell)image + preamblesize) < FUZZ)
238: image = header.base - preamblesize;
239: #endif
240: rewind(imagefile); /* fseek(imagefile,0L,SEEK_SET); */
241: fread(image,1,imagesize,imagefile);
242: fclose(imagefile);
243: imp=image+preamblesize;
244:
245: if(header.base==0) {
246: relocate((Cell *)imp,imp+header.image_size,header.image_size,symbols);
247: ((ImageHeader *)imp)->checksum=check_sum;
248: }
249: else if(header.base!=imp) {
250: fprintf(stderr,"%s: Cannot load nonrelocatable image (compiled for address $%lx) at address $%lx\nThe Gforth installer should look into the INSTALL file\n",
251: progname, (unsigned long)header.base, (unsigned long)imp);
252: exit(1);
253: } else if (header.checksum != check_sum) {
254: fprintf(stderr,"%s: Checksum of image ($%lx) does not match the executable ($%lx)\nThe Gforth installer should look into the INSTALL file\n",
255: progname, (unsigned long)(header.checksum),(unsigned long)check_sum);
256: exit(1);
257: }
258:
259: ((ImageHeader *)imp)->dict_size=dictsize;
260: ((ImageHeader *)imp)->data_stack_size=dsize;
261: ((ImageHeader *)imp)->return_stack_size=rsize;
262: ((ImageHeader *)imp)->fp_stack_size=fsize;
263: ((ImageHeader *)imp)->locals_stack_size=lsize;
264:
265: CACHE_FLUSH(imp, header.image_size);
266:
267: return imp;
268: }
269:
270: int go_forth(Address image, int stack, Cell *entries)
271: {
272: Cell *sp=(Cell*)(image+dictsize+dsize);
273: Address lp=(Address)((void *)sp+lsize);
274: Float *fp=(Float *)((void *)lp+fsize);
275: Cell *rp=(Cell*)((void *)fp+rsize);
276: Xt *ip=(Xt *)(((ImageHeader *)image)->boot_entry);
277: int throw_code;
278:
279: for(;stack>0;stack--)
280: *--sp=entries[stack-1];
281:
282: #if !defined(MSDOS) && !defined(_WIN32) && !defined(__EMX__)
283: get_winsize();
284: #endif
285:
286: install_signal_handlers(); /* right place? */
287:
288: if ((throw_code=setjmp(throw_jmp_buf))) {
289: static Cell signal_data_stack[8];
290: static Cell signal_return_stack[8];
291: static Float signal_fp_stack[1];
292:
293: signal_data_stack[7]=throw_code;
294:
295: return((int)engine(((ImageHeader *)image)->throw_entry,signal_data_stack+7,
296: signal_return_stack+8,signal_fp_stack,0));
297: }
298:
299: return((int)engine(ip,sp,rp,fp,lp));
300: }
301:
302: int convsize(char *s, int elemsize)
303: /* converts s of the format #+u (e.g. 25k) into the number of bytes.
304: the unit u can be one of bekM, where e stands for the element
305: size. default is e */
306: {
307: char *endp;
308: int n,m;
309:
310: m = elemsize;
311: n = strtoul(s,&endp,0);
312: if (endp!=NULL) {
313: if (strcmp(endp,"b")==0)
314: m=1;
315: else if (strcmp(endp,"k")==0)
316: m=1024;
317: else if (strcmp(endp,"M")==0)
318: m=1024*1024;
319: else if (strcmp(endp,"e")!=0 && strcmp(endp,"")!=0) {
320: fprintf(stderr,"%s: cannot grok size specification %s: invalid unit \"%s\"\n", progname, s, endp);
321: exit(1);
322: }
323: }
324: return n*m;
325: }
326:
327: int main(int argc, char **argv, char **env)
328: {
329: char *path, *path1;
330: char *imagename="gforth.fi";
331: FILE *image_file;
332: int c, retvalue;
333:
334: #if defined(i386) && defined(ALIGNMENT_CHECK) && !defined(DIRECT_THREADED)
335: /* turn on alignment checks on the 486.
336: * on the 386 this should have no effect. */
337: __asm__("pushfl; popl %eax; orl $0x40000, %eax; pushl %eax; popfl;");
338: /* this is unusable with Linux' libc.4.6.27, because this library is
339: not alignment-clean; we would have to replace some library
340: functions (e.g., memcpy) to make it work */
341: #endif
342:
343: progname = argv[0];
344: if ((path1=getenv("GFORTHPATH"))==NULL)
345: path1 = DEFAULTPATH;
346:
347: opterr=0;
348: while (1) {
349: int option_index=0;
350: static struct option opts[] = {
351: {"image-file", required_argument, NULL, 'i'},
352: {"dictionary-size", required_argument, NULL, 'm'},
353: {"data-stack-size", required_argument, NULL, 'd'},
354: {"return-stack-size", required_argument, NULL, 'r'},
355: {"fp-stack-size", required_argument, NULL, 'f'},
356: {"locals-stack-size", required_argument, NULL, 'l'},
357: {"path", required_argument, NULL, 'p'},
358: {"version", no_argument, NULL, 'v'},
359: {"help", no_argument, NULL, 'h'},
360: {0,0,0,0}
361: /* no-init-file, no-rc? */
362: };
363:
364: c = getopt_long(argc, argv, "+i:m:d:r:f:l:p:vh", opts, &option_index);
365:
366: if (c==EOF)
367: break;
368: if (c=='?') {
369: optind--;
370: break;
371: }
372: switch (c) {
373: case 'i': imagename = optarg; break;
374: case 'm': dictsize = convsize(optarg,sizeof(Cell)); break;
375: case 'd': dsize = convsize(optarg,sizeof(Cell)); break;
376: case 'r': rsize = convsize(optarg,sizeof(Cell)); break;
377: case 'f': fsize = convsize(optarg,sizeof(Float)); break;
378: case 'l': lsize = convsize(optarg,sizeof(Cell)); break;
379: case 'p': path1 = optarg; break;
380: case 'v': fprintf(stderr, "gforth %s\n", gforth_version); exit(0);
381: case 'h':
382: fprintf(stderr, "Usage: %s [engine options] [image arguments]\n\
383: Engine Options:\n\
384: -d SIZE, --data-stack-size=SIZE Specify data stack size\n\
385: -f SIZE, --fp-stack-size=SIZE Specify floating point stack size\n\
386: -h, --help Print this message and exit\n\
387: -i FILE, --image-file=FILE Use image FILE instead of `gforth.fi'\n\
388: -l SIZE, --locals-stack-size=SIZE Specify locals stack size\n\
389: -m SIZE, --dictionary-size=SIZE Specify Forth dictionary size\n\
390: -p PATH, --path=PATH Search path for finding image and sources\n\
391: -r SIZE, --return-stack-size=SIZE Specify return stack size\n\
392: -v, --version Print version and exit\n\
393: SIZE arguments consists of an integer followed by a unit. The unit can be\n\
394: `b' (bytes), `e' (elements), `k' (kilobytes), or `M' (Megabytes).\n\
395: \n\
396: Arguments of default image `gforth.fi':\n\
397: FILE load FILE (with `require')\n\
398: -e STRING, --evaluate STRING interpret STRING (with `EVALUATE')\n",
399: argv[0]); exit(0);
400: }
401: }
402: path=path1;
403:
404: if(strchr(imagename, '/')==NULL)
405: {
406: do {
407: char *pend=strchr(path, PATHSEP);
408: if (pend==NULL)
409: pend=path+strlen(path);
410: if (strlen(path)==0) {
411: fprintf(stderr,"%s: cannot open image file %s in path %s for reading\n",
412: progname, imagename, path1);
413: exit(1);
414: }
415: {
416: int dirlen=pend-path;
417: char fullfilename[dirlen+strlen(imagename)+2];
418: memcpy(fullfilename, path, dirlen);
419: if (fullfilename[dirlen-1]!='/')
420: fullfilename[dirlen++]='/';
421: strcpy(fullfilename+dirlen,imagename);
422: image_file=fopen(fullfilename,"rb");
423: }
424: path=pend+(*pend==PATHSEP);
425: } while (image_file==NULL);
426: }
427: else
428: {
429: image_file=fopen(imagename,"rb");
430: }
431:
432: {
433: char path2[strlen(path1)+1];
434: char *p1, *p2;
435: Cell environ[]= {
436: (Cell)argc-(optind-1),
437: (Cell)(argv+(optind-1)),
438: (Cell)strlen(path1),
439: (Cell)path2};
440: argv[optind-1] = progname;
441: /*
442: for (i=0; i<environ[0]; i++)
443: printf("%s\n", ((char **)(environ[1]))[i]);
444: */
445: /* make path OS-independent by replacing path separators with NUL */
446: for (p1=path1, p2=path2; *p1!='\0'; p1++, p2++)
447: if (*p1==PATHSEP)
448: *p2 = '\0';
449: else
450: *p2 = *p1;
451: *p2='\0';
452: retvalue=go_forth(loader(image_file, imagename),4,environ);
453: deprep_terminal();
454: exit(retvalue);
455: }
456: }
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>