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:
38: #ifdef MSDOS
39: jmp_buf throw_jmp_buf;
40: #endif
41:
42: #ifndef DEFAULTPATH
43: # define DEFAULTPATH "/usr/local/lib/gforth:."
44: #endif
45:
46: #ifdef DIRECT_THREADED
47: # define CA(n) (symbols[(n)])
48: #else
49: # define CA(n) ((Cell)(symbols+(n)))
50: #endif
51:
52: #define maxaligned(n) (typeof(n))((((Cell)n)+sizeof(Float)-1)&-sizeof(Float))
53:
54: static Cell dictsize=0;
55: static Cell dsize=0;
56: static Cell rsize=0;
57: static Cell fsize=0;
58: static Cell lsize=0;
59: char *progname;
60:
61: /* image file format:
62: * "#! binary-path -i\n" (e.g., "#! /usr/local/bin/gforth-0.2.0 -i\n")
63: * padding to a multiple of 8
64: * magic: "Gforth1x" means format 0.2,
65: * where x is even for big endian and odd for little endian
66: * and x & ~1 is the size of the cell in bytes.
67: * padding to max alignment (no padding necessary on current machines)
68: * ImageHeader structure (see below)
69: * data (size in ImageHeader.image_size)
70: * tags ((if relocatable, 1 bit/data cell)
71: *
72: * tag==1 means that the corresponding word is an address;
73: * If the word is >=0, the address is within the image;
74: * addresses within the image are given relative to the start of the image.
75: * If the word =-1 (CF_NIL), the address is NIL,
76: * If the word is <CF_NIL and >CF(DODOES), it's a CFA (:, Create, ...)
77: * If the word =CF(DODOES), it's a DOES> CFA
78: * If the word =CF(DOESJUMP), it's a DOES JUMP (2 Cells after DOES>,
79: * possibly containing a jump to dodoes)
80: * If the word is <CF(DOESJUMP), it's a primitive
81: */
82:
83: typedef struct {
84: Address base; /* base address of image (0 if relocatable) */
85: UCell checksum; /* checksum of ca's to protect against some
86: incompatible binary/executable combinations
87: (0 if relocatable) */
88: UCell image_size; /* all sizes in bytes */
89: UCell dict_size;
90: UCell data_stack_size;
91: UCell fp_stack_size;
92: UCell return_stack_size;
93: UCell locals_stack_size;
94: Xt *boot_entry; /* initial ip for booting (in BOOT) */
95: Xt *throw_entry; /* ip after signal (in THROW) */
96: } ImageHeader;
97: /* the image-header is created in main.fs */
98:
99: void relocate(Cell *image, char *bitstring, int size, Label symbols[])
100: {
101: int i=0, j, k, steps=(size/sizeof(Cell))/8;
102: char bits;
103: /* static char bits[8]={0x80,0x40,0x20,0x10,0x08,0x04,0x02,0x01};*/
104:
105: for(k=0; k<=steps; k++)
106: for(j=0, bits=bitstring[k]; j<8; j++, i++, bits<<=1)
107: if(bits & 0x80)
108: if(image[i]<0)
109: switch(image[i])
110: {
111: case CF_NIL : image[i]=0; break;
112: case CF(DOCOL) :
113: case CF(DOVAR) :
114: case CF(DOCON) :
115: case CF(DOUSER) :
116: case CF(DODEFER) :
117: case CF(DOFIELD) : MAKE_CF(image+i,symbols[CF(image[i])]); break;
118: case CF(DODOES) : MAKE_DOES_CF(image+i,image[i+1]+((Cell)image));
119: break;
120: case CF(DOESJUMP): MAKE_DOES_HANDLER(image+i); break;
121: default : image[i]=(Cell)CA(CF(image[i]));
122: }
123: else
124: image[i]+=(Cell)image;
125: }
126:
127: UCell checksum(Label symbols[])
128: {
129: UCell r=0;
130: Cell i;
131:
132: for (i=DOCOL; i<=DOESJUMP; i++) {
133: r ^= (UCell)(symbols[i]);
134: r = (r << 5) | (r >> (8*sizeof(Cell)-5));
135: }
136: #ifdef DIRECT_THREADED
137: /* we have to consider all the primitives */
138: for (; symbols[i]!=(Label)0; i++) {
139: r ^= (UCell)(symbols[i]);
140: r = (r << 5) | (r >> (8*sizeof(Cell)-5));
141: }
142: #else
143: /* in indirect threaded code all primitives are accessed through the
144: symbols table, so we just have to put the base address of symbols
145: in the checksum */
146: r ^= (UCell)symbols;
147: #endif
148: return r;
149: }
150:
151: Address loader(FILE *imagefile)
152: /* returns the address of the image proper (after the preamble) */
153: {
154: ImageHeader header;
155: Address image;
156: Address imp; /* image+preamble */
157: Char magic[8];
158: Cell wholesize;
159: Cell imagesize; /* everything needed by the image */
160: Cell preamblesize=0;
161: Label *symbols=engine(0,0,0,0,0);
162: UCell check_sum=checksum(symbols);
163:
164: static char* endianstring[]= { "big","little" };
165:
166: do
167: {
168: if(fread(magic,sizeof(Char),8,imagefile) < 8) {
169: fprintf(stderr,"%s: image doesn't seem to be a Gforth (>=0.2) image.\n",progname);
170: exit(1);
171: }
172: preamblesize+=8;
173: #ifdef DEBUG
174: fprintf(stderr,"Magic found: %-8s\n",magic);
175: #endif
176: }
177: while(memcmp(magic,"Gforth1",7));
178:
179: if(magic[7] != sizeof(Cell) +
180: #ifdef WORDS_BIGENDIAN
181: '0'
182: #else
183: '1'
184: #endif
185: )
186: { fprintf(stderr,"This image is %d bit %s-endian, whereas the machine is %d bit %s-endian.\n",
187: ((magic[7]-'0')&~1)*8, endianstring[magic[7]&1],
188: sizeof(Cell)*8, endianstring[
189: #ifdef WORDS_BIGENDIAN
190: 0
191: #else
192: 1
193: #endif
194: ]);
195: exit(-2);
196: };
197:
198: fread((void *)&header,sizeof(ImageHeader),1,imagefile);
199: if (dictsize==0)
200: dictsize = header.dict_size;
201: if (dsize==0)
202: dsize=header.data_stack_size;
203: if (rsize==0)
204: rsize=header.return_stack_size;
205: if (fsize==0)
206: fsize=header.fp_stack_size;
207: if (lsize==0)
208: lsize=header.locals_stack_size;
209: dictsize=maxaligned(dictsize);
210: dsize=maxaligned(dsize);
211: rsize=maxaligned(rsize);
212: lsize=maxaligned(lsize);
213: fsize=maxaligned(fsize);
214:
215: wholesize = preamblesize+dictsize+dsize+rsize+fsize+lsize;
216: imagesize = preamblesize+header.image_size+((header.image_size-1)/sizeof(Cell))/8+1;
217: image=malloc((wholesize>imagesize?wholesize:imagesize)/*+sizeof(Float)*/);
218: /*image = maxaligned(image);*/
219: memset(image,0,wholesize); /* why? - anton */
220: rewind(imagefile); /* fseek(imagefile,0L,SEEK_SET); */
221: fread(image,1,imagesize,imagefile);
222: fclose(imagefile);
223: imp=image+preamblesize;
224:
225: if(header.base==0) {
226: relocate((Cell *)imp,imp+header.image_size,header.image_size,symbols);
227: ((ImageHeader *)imp)->checksum=check_sum;
228: }
229: else if(header.base!=imp) {
230: fprintf(stderr,"%s: Cannot load nonrelocatable image (compiled for address $%lx) at address $%lx\nThe Gforth installer should look into the INSTALL file\n",
231: progname, (unsigned long)header.base, (unsigned long)imp);
232: exit(1);
233: } else if (header.checksum != check_sum) {
234: fprintf(stderr,"%s: Checksum of image ($%lx) does not match the executable ($%lx)\nThe Gforth installer should look into the INSTALL file\n",
235: progname, (unsigned long)(header.checksum),(unsigned long)check_sum);
236: exit(1);
237: }
238:
239: ((ImageHeader *)imp)->dict_size=dictsize;
240: ((ImageHeader *)imp)->data_stack_size=dsize;
241: ((ImageHeader *)imp)->return_stack_size=rsize;
242: ((ImageHeader *)imp)->fp_stack_size=fsize;
243: ((ImageHeader *)imp)->locals_stack_size=lsize;
244:
245: CACHE_FLUSH(imp, header.imagesize);
246:
247: return imp;
248: }
249:
250: int go_forth(Address image, int stack, Cell *entries)
251: {
252: Cell *sp=(Cell*)(image+dictsize+dsize);
253: Address lp=(Address)((void *)sp+lsize);
254: Float *fp=(Float *)((void *)lp+fsize);
255: Cell *rp=(Cell*)((void *)fp+rsize);
256: Xt *ip=(Xt *)(((ImageHeader *)image)->boot_entry);
257: int throw_code;
258:
259: for(;stack>0;stack--)
260: *--sp=entries[stack-1];
261:
262: get_winsize();
263: install_signal_handlers(); /* right place? */
264:
265: if ((throw_code=setjmp(throw_jmp_buf))) {
266: static Cell signal_data_stack[8];
267: static Cell signal_return_stack[8];
268: static Float signal_fp_stack[1];
269:
270: signal_data_stack[7]=throw_code;
271:
272: return((int)engine(((ImageHeader *)image)->throw_entry,signal_data_stack+7,
273: signal_return_stack+8,signal_fp_stack,0));
274: }
275:
276: return((int)engine(ip,sp,rp,fp,lp));
277: }
278:
279: int convsize(char *s, int elemsize)
280: /* converts s of the format #+u (e.g. 25k) into the number of bytes.
281: the unit u can be one of bekM, where e stands for the element
282: size. default is e */
283: {
284: char *endp;
285: int n,m;
286:
287: m = elemsize;
288: n = strtoul(s,&endp,0);
289: if (endp!=NULL) {
290: if (strcmp(endp,"b")==0)
291: m=1;
292: else if (strcmp(endp,"k")==0)
293: m=1024;
294: else if (strcmp(endp,"M")==0)
295: m=1024*1024;
296: else if (strcmp(endp,"e")!=0 && strcmp(endp,"")!=0) {
297: fprintf(stderr,"%s: cannot grok size specification %s: invalid unit \"%s\"\n", progname, s, endp);
298: exit(1);
299: }
300: }
301: return n*m;
302: }
303:
304: int main(int argc, char **argv, char **env)
305: {
306: char *path, *path1;
307: char *imagename="gforth.fi";
308: FILE *image_file;
309: int c, retvalue;
310:
311: #if defined(i386) && defined(ALIGNMENT_CHECK) && !defined(DIRECT_THREADED)
312: /* turn on alignment checks on the 486.
313: * on the 386 this should have no effect. */
314: __asm__("pushfl; popl %eax; orl $0x40000, %eax; pushl %eax; popfl;");
315: /* this is unusable with Linux' libc.4.6.27, because this library is
316: not alignment-clean; we would have to replace some library
317: functions (e.g., memcpy) to make it work */
318: #endif
319:
320: progname = argv[0];
321: if ((path=getenv("GFORTHPATH"))==NULL)
322: path = strcpy(malloc(strlen(DEFAULTPATH)+1),DEFAULTPATH);
323: opterr=0;
324: while (1) {
325: int option_index=0;
326: static struct option opts[] = {
327: {"image-file", required_argument, NULL, 'i'},
328: {"dictionary-size", required_argument, NULL, 'm'},
329: {"data-stack-size", required_argument, NULL, 'd'},
330: {"return-stack-size", required_argument, NULL, 'r'},
331: {"fp-stack-size", required_argument, NULL, 'f'},
332: {"locals-stack-size", required_argument, NULL, 'l'},
333: {"path", required_argument, NULL, 'p'},
334: {0,0,0,0}
335: /* no-init-file, no-rc? */
336: };
337:
338: c = getopt_long(argc, argv, "+i:m:d:r:f:l:p:", opts, &option_index);
339:
340: if (c==EOF)
341: break;
342: if (c=='?') {
343: optind--;
344: break;
345: }
346: switch (c) {
347: case 'i': imagename = optarg; break;
348: case 'm': dictsize = convsize(optarg,sizeof(Cell)); break;
349: case 'd': dsize = convsize(optarg,sizeof(Cell)); break;
350: case 'r': rsize = convsize(optarg,sizeof(Cell)); break;
351: case 'f': fsize = convsize(optarg,sizeof(Float)); break;
352: case 'l': lsize = convsize(optarg,sizeof(Cell)); break;
353: case 'p': path = optarg; break;
354: }
355: }
356: path1=path;
357:
358: if(strchr(imagename, '/')==NULL)
359: {
360: do {
361: char *pend=strchr(path, ':');
362: if (pend==NULL)
363: pend=path+strlen(path);
364: if (strlen(path)==0) {
365: fprintf(stderr,"%s: cannot open image file %s in path %s for reading\n",
366: progname, imagename, path1);
367: exit(1);
368: }
369: {
370: int dirlen=pend-path;
371: char fullfilename[dirlen+strlen(imagename)+2];
372: memcpy(fullfilename, path, dirlen);
373: if (fullfilename[dirlen-1]!='/')
374: fullfilename[dirlen++]='/';
375: strcpy(fullfilename+dirlen,imagename);
376: image_file=fopen(fullfilename,"rb");
377: }
378: path=pend+(*pend==':');
379: } while (image_file==NULL);
380: }
381: else
382: {
383: image_file=fopen(imagename,"rb");
384: if(image_file==NULL) {
385: fprintf(stderr,"%s: %s: %s\n", progname, imagename, strerror(errno));
386: exit(1);
387: }
388: }
389:
390: {
391: Cell environ[]= {
392: (Cell)argc-(optind-1),
393: (Cell)(argv+(optind-1)),
394: (Cell)path1};
395: argv[optind-1] = progname;
396: /*
397: for (i=0; i<environ[0]; i++)
398: printf("%s\n", ((char **)(environ[1]))[i]);
399: */
400: retvalue=go_forth(loader(image_file),3,environ);
401: deprep_terminal();
402: exit(retvalue);
403: }
404: }
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>