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 FUZZ
43: # define FUZZ 0x4000
44: #endif
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: #ifndef __unix__
229: +FUZZ
230: #endif
231: );
232: /*image = maxaligned(image);*/
233: /* memset(image,0,wholesize); */
234:
235: #ifndef __unix__
236: #warning Non-Unix machine, trying to help relocate with FUZZ
237: if(header.base==0) image += FUZZ/2;
238: else if((UCell)(header.base - (Cell)image + preamblesize) < FUZZ)
239: image = header.base - preamblesize;
240: #endif
241: rewind(imagefile); /* fseek(imagefile,0L,SEEK_SET); */
242: fread(image,1,imagesize,imagefile);
243: fclose(imagefile);
244: imp=image+preamblesize;
245:
246: if(header.base==0) {
247: relocate((Cell *)imp,imp+header.image_size,header.image_size,symbols);
248: ((ImageHeader *)imp)->checksum=check_sum;
249: }
250: else if(header.base!=imp) {
251: fprintf(stderr,"%s: Cannot load nonrelocatable image (compiled for address $%lx) at address $%lx\nThe Gforth installer should look into the INSTALL file\n",
252: progname, (unsigned long)header.base, (unsigned long)imp);
253: exit(1);
254: } else if (header.checksum != check_sum) {
255: fprintf(stderr,"%s: Checksum of image ($%lx) does not match the executable ($%lx)\nThe Gforth installer should look into the INSTALL file\n",
256: progname, (unsigned long)(header.checksum),(unsigned long)check_sum);
257: exit(1);
258: }
259:
260: ((ImageHeader *)imp)->dict_size=dictsize;
261: ((ImageHeader *)imp)->data_stack_size=dsize;
262: ((ImageHeader *)imp)->return_stack_size=rsize;
263: ((ImageHeader *)imp)->fp_stack_size=fsize;
264: ((ImageHeader *)imp)->locals_stack_size=lsize;
265:
266: CACHE_FLUSH(imp, header.image_size);
267:
268: return imp;
269: }
270:
271: int go_forth(Address image, int stack, Cell *entries)
272: {
273: Cell *sp=(Cell*)(image+dictsize+dsize);
274: Address lp=(Address)((void *)sp+lsize);
275: Float *fp=(Float *)((void *)lp+fsize);
276: Cell *rp=(Cell*)((void *)fp+rsize);
277: Xt *ip=(Xt *)(((ImageHeader *)image)->boot_entry);
278: int throw_code;
279:
280: for(;stack>0;stack--)
281: *--sp=entries[stack-1];
282:
283: #if !defined(MSDOS) && !defined(_WIN32) && !defined(__EMX__)
284: get_winsize();
285: #endif
286:
287: install_signal_handlers(); /* right place? */
288:
289: if ((throw_code=setjmp(throw_jmp_buf))) {
290: static Cell signal_data_stack[8];
291: static Cell signal_return_stack[8];
292: static Float signal_fp_stack[1];
293:
294: signal_data_stack[7]=throw_code;
295:
296: return((int)engine(((ImageHeader *)image)->throw_entry,signal_data_stack+7,
297: signal_return_stack+8,signal_fp_stack,0));
298: }
299:
300: return((int)engine(ip,sp,rp,fp,lp));
301: }
302:
303: int convsize(char *s, int elemsize)
304: /* converts s of the format #+u (e.g. 25k) into the number of bytes.
305: the unit u can be one of bekM, where e stands for the element
306: size. default is e */
307: {
308: char *endp;
309: int n,m;
310:
311: m = elemsize;
312: n = strtoul(s,&endp,0);
313: if (endp!=NULL) {
314: if (strcmp(endp,"b")==0)
315: m=1;
316: else if (strcmp(endp,"k")==0)
317: m=1024;
318: else if (strcmp(endp,"M")==0)
319: m=1024*1024;
320: else if (strcmp(endp,"e")!=0 && strcmp(endp,"")!=0) {
321: fprintf(stderr,"%s: cannot grok size specification %s: invalid unit \"%s\"\n", progname, s, endp);
322: exit(1);
323: }
324: }
325: return n*m;
326: }
327:
328: int main(int argc, char **argv, char **env)
329: {
330: char *path, *path1;
331: char *imagename="gforth.fi";
332: FILE *image_file;
333: int c, retvalue;
334:
335: #if defined(i386) && defined(ALIGNMENT_CHECK) && !defined(DIRECT_THREADED)
336: /* turn on alignment checks on the 486.
337: * on the 386 this should have no effect. */
338: __asm__("pushfl; popl %eax; orl $0x40000, %eax; pushl %eax; popfl;");
339: /* this is unusable with Linux' libc.4.6.27, because this library is
340: not alignment-clean; we would have to replace some library
341: functions (e.g., memcpy) to make it work */
342: #endif
343:
344: progname = argv[0];
345: if ((path1=getenv("GFORTHPATH"))==NULL)
346: path1 = DEFAULTPATH;
347:
348: opterr=0;
349: while (1) {
350: int option_index=0;
351: static struct option opts[] = {
352: {"image-file", required_argument, NULL, 'i'},
353: {"dictionary-size", required_argument, NULL, 'm'},
354: {"data-stack-size", required_argument, NULL, 'd'},
355: {"return-stack-size", required_argument, NULL, 'r'},
356: {"fp-stack-size", required_argument, NULL, 'f'},
357: {"locals-stack-size", required_argument, NULL, 'l'},
358: {"path", required_argument, NULL, 'p'},
359: {0,0,0,0}
360: /* no-init-file, no-rc? */
361: };
362:
363: c = getopt_long(argc, argv, "+i:m:d:r:f:l:p:", opts, &option_index);
364:
365: if (c==EOF)
366: break;
367: if (c=='?') {
368: optind--;
369: break;
370: }
371: switch (c) {
372: case 'i': imagename = optarg; break;
373: case 'm': dictsize = convsize(optarg,sizeof(Cell)); break;
374: case 'd': dsize = convsize(optarg,sizeof(Cell)); break;
375: case 'r': rsize = convsize(optarg,sizeof(Cell)); break;
376: case 'f': fsize = convsize(optarg,sizeof(Float)); break;
377: case 'l': lsize = convsize(optarg,sizeof(Cell)); break;
378: case 'p': path1 = optarg; break;
379: }
380: }
381: path=path1;
382:
383: if(strchr(imagename, '/')==NULL)
384: {
385: do {
386: char *pend=strchr(path, PATHSEP);
387: if (pend==NULL)
388: pend=path+strlen(path);
389: if (strlen(path)==0) {
390: fprintf(stderr,"%s: cannot open image file %s in path %s for reading\n",
391: progname, imagename, path);
392: exit(1);
393: }
394: {
395: int dirlen=pend-path;
396: char fullfilename[dirlen+strlen(imagename)+2];
397: memcpy(fullfilename, path, dirlen);
398: if (fullfilename[dirlen-1]!='/')
399: fullfilename[dirlen++]='/';
400: strcpy(fullfilename+dirlen,imagename);
401: image_file=fopen(fullfilename,"rb");
402: }
403: path=pend+(*pend==PATHSEP);
404: } while (image_file==NULL);
405: }
406: else
407: {
408: image_file=fopen(imagename,"rb");
409: }
410:
411: {
412: char path2[strlen(path1)+2];
413: char *p1, *p2;
414: Cell environ[]= {
415: (Cell)argc-(optind-1),
416: (Cell)(argv+(optind-1)),
417: (Cell)strlen(path1),
418: (Cell)path2};
419: argv[optind-1] = progname;
420: /*
421: for (i=0; i<environ[0]; i++)
422: printf("%s\n", ((char **)(environ[1]))[i]);
423: */
424: /* make path OS-independent by replacing path separators with NUL */
425: for (p1=path1, p2=path2; *p1!='\0'; p1++, p2++)
426: if (*p1==PATHSEP)
427: *p2 = '\0';
428: else
429: *p2 = *p1;
430: *p2++='\0';
431: *p2='\0';
432: retvalue=go_forth(loader(image_file, imagename),4,environ);
433: deprep_terminal();
434: exit(retvalue);
435: }
436: }
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to main.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [gforth] / gforth