Annotation of gforth/engine/main.c, revision 1.54

1.1       anton       1: /* command line interpretation, image loading etc. for Gforth
                      2: 
                      3: 
1.39      anton       4:   Copyright (C) 1995,1996,1997,1998,2000 Free Software Foundation, Inc.
1.1       anton       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
1.40      anton      20:   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
1.1       anton      21: */
                     22: 
                     23: #include "config.h"
                     24: #include <errno.h>
                     25: #include <ctype.h>
                     26: #include <stdio.h>
1.2       pazsan     27: #include <unistd.h>
1.1       anton      28: #include <string.h>
                     29: #include <math.h>
                     30: #include <sys/types.h>
1.32      pazsan     31: #ifndef STANDALONE
1.1       anton      32: #include <sys/stat.h>
1.32      pazsan     33: #endif
1.1       anton      34: #include <fcntl.h>
                     35: #include <assert.h>
                     36: #include <stdlib.h>
1.11      pazsan     37: #ifndef STANDALONE
1.1       anton      38: #if HAVE_SYS_MMAN_H
                     39: #include <sys/mman.h>
                     40: #endif
1.11      pazsan     41: #endif
1.1       anton      42: #include "forth.h"
                     43: #include "io.h"
                     44: #include "getopt.h"
1.11      pazsan     45: #ifdef STANDALONE
                     46: #include <systypes.h>
                     47: #endif
1.1       anton      48: 
                     49: #define PRIM_VERSION 1
                     50: /* increment this whenever the primitives change in an incompatible way */
                     51: 
1.14      pazsan     52: #ifndef DEFAULTPATH
1.39      anton      53: #  define DEFAULTPATH "."
1.14      pazsan     54: #endif
                     55: 
1.1       anton      56: #ifdef MSDOS
                     57: jmp_buf throw_jmp_buf;
                     58: #endif
                     59: 
1.53      anton      60: #if defined(DIRECT_THREADED)
                     61: /*#  define CA(n) (symbols[(n)])*/
                     62: #  define CA(n)        (symbols[(n)&~0x4000UL])
                     63: #elif defined(DOUBLY_INDIRECT)
                     64: /* #  define CA(n)     ((Cell)(symbols+((n)&~0x4000UL))) */
                     65: #  define CA(n)        ({Cell _n = (n); ((Cell)(((_n & 0x4000) ? symbols : xts)+(_n&~0x4000UL)));})
1.1       anton      66: #else
1.53      anton      67: #  define CA(n)        ((Cell)(symbols+((n)&~0x4000UL)))
1.1       anton      68: #endif
                     69: 
                     70: #define maxaligned(n)  (typeof(n))((((Cell)n)+sizeof(Float)-1)&-sizeof(Float))
                     71: 
                     72: static UCell dictsize=0;
                     73: static UCell dsize=0;
                     74: static UCell rsize=0;
                     75: static UCell fsize=0;
                     76: static UCell lsize=0;
                     77: int offset_image=0;
1.4       anton      78: int die_on_signal=0;
1.13      pazsan     79: #ifndef INCLUDE_IMAGE
1.1       anton      80: static int clear_dictionary=0;
1.24      anton      81: UCell pagesize=1;
1.22      pazsan     82: char *progname;
                     83: #else
                     84: char *progname = "gforth";
                     85: int optind = 1;
1.13      pazsan     86: #endif
1.31      pazsan     87: 
1.48      anton      88: Address code_area=0;
                     89: Address code_here=0; /* does for code-area what HERE does for the dictionary */
                     90: 
1.30      pazsan     91: #ifdef HAS_DEBUG
1.1       anton      92: static int debug=0;
1.31      pazsan     93: #else
                     94: # define debug 0
                     95: # define perror(x...)
                     96: # define fprintf(x...)
1.30      pazsan     97: #endif
1.31      pazsan     98: 
1.24      anton      99: ImageHeader *gforth_header;
1.43      anton     100: Label *vm_prims;
1.53      anton     101: #ifdef DOUBLY_INDIRECT
                    102: Label *xts; /* same content as vm_prims, but should only be used for xts */
                    103: #endif
1.1       anton     104: 
1.30      pazsan    105: #ifdef MEMCMP_AS_SUBROUTINE
                    106: int gforth_memcmp(const char * s1, const char * s2, size_t n)
                    107: {
                    108:   return memcmp(s1, s2, n);
                    109: }
                    110: #endif
                    111: 
1.1       anton     112: /* image file format:
1.15      pazsan    113:  *  "#! binary-path -i\n" (e.g., "#! /usr/local/bin/gforth-0.4.0 -i\n")
1.1       anton     114:  *   padding to a multiple of 8
1.15      pazsan    115:  *   magic: "Gforth2x" means format 0.4,
                    116:  *              where x is a byte with
                    117:  *              bit 7:   reserved = 0
                    118:  *              bit 6:5: address unit size 2^n octets
                    119:  *              bit 4:3: character size 2^n octets
                    120:  *              bit 2:1: cell size 2^n octets
                    121:  *              bit 0:   endian, big=0, little=1.
                    122:  *  The magic are always 8 octets, no matter what the native AU/character size is
1.1       anton     123:  *  padding to max alignment (no padding necessary on current machines)
1.24      anton     124:  *  ImageHeader structure (see forth.h)
1.1       anton     125:  *  data (size in ImageHeader.image_size)
                    126:  *  tags ((if relocatable, 1 bit/data cell)
                    127:  *
                    128:  * tag==1 means that the corresponding word is an address;
                    129:  * If the word is >=0, the address is within the image;
                    130:  * addresses within the image are given relative to the start of the image.
                    131:  * If the word =-1 (CF_NIL), the address is NIL,
                    132:  * If the word is <CF_NIL and >CF(DODOES), it's a CFA (:, Create, ...)
                    133:  * If the word =CF(DODOES), it's a DOES> CFA
                    134:  * If the word =CF(DOESJUMP), it's a DOES JUMP (2 Cells after DOES>,
                    135:  *                                     possibly containing a jump to dodoes)
1.51      anton     136:  * If the word is <CF(DOESJUMP) and bit 14 is set, it's the xt of a primitive
                    137:  * If the word is <CF(DOESJUMP) and bit 14 is clear, 
                    138:  *                                        it's the threaded code of a primitive
1.1       anton     139:  */
                    140: 
1.46      jwilke    141: void relocate(Cell *image, const char *bitstring, 
                    142:               int size, int base, Label symbols[])
1.1       anton     143: {
1.16      pazsan    144:   int i=0, j, k, steps=(size/sizeof(Cell))/RELINFOBITS;
1.11      pazsan    145:   Cell token;
1.1       anton     146:   char bits;
1.37      anton     147:   Cell max_symbols;
1.46      jwilke    148:   /* 
                    149:    * A virtial start address that's the real start address minus 
                    150:    * the one in the image 
                    151:    */
1.45      jwilke    152:   Cell *start = (Cell * ) (((void *) image) - ((void *) base));
1.1       anton     153: 
1.46      jwilke    154:   
                    155: /* printf("relocating to %x[%x] start=%x base=%x\n", image, size, start, base); */
1.37      anton     156:   
                    157:   for (max_symbols=DOESJUMP+1; symbols[max_symbols]!=0; max_symbols++)
                    158:     ;
1.47      anton     159:   max_symbols--;
1.35      pazsan    160:   size/=sizeof(Cell);
                    161: 
1.31      pazsan    162:   for(k=0; k<=steps; k++) {
1.13      pazsan    163:     for(j=0, bits=bitstring[k]; j<RELINFOBITS; j++, i++, bits<<=1) {
1.1       anton     164:       /*      fprintf(stderr,"relocate: image[%d]\n", i);*/
1.35      pazsan    165:       if((i < size) && (bits & (1U << (RELINFOBITS-1)))) {
                    166:        /* fprintf(stderr,"relocate: image[%d]=%d of %d\n", i, image[i], size/sizeof(Cell)); */
1.45      jwilke    167:         token=image[i];
                    168:        if(token<0)
1.11      pazsan    169:          switch(token)
1.1       anton     170:            {
                    171:            case CF_NIL      : image[i]=0; break;
                    172: #if !defined(DOUBLY_INDIRECT)
                    173:            case CF(DOCOL)   :
                    174:            case CF(DOVAR)   :
                    175:            case CF(DOCON)   :
                    176:            case CF(DOUSER)  : 
                    177:            case CF(DODEFER) : 
1.11      pazsan    178:            case CF(DOFIELD) : MAKE_CF(image+i,symbols[CF(token)]); break;
1.1       anton     179:            case CF(DOESJUMP): MAKE_DOES_HANDLER(image+i); break;
                    180: #endif /* !defined(DOUBLY_INDIRECT) */
                    181:            case CF(DODOES)  :
1.45      jwilke    182:              MAKE_DOES_CF(image+i,(Xt *)(image[i+1]+((Cell)start)));
1.1       anton     183:              break;
                    184:            default          :
                    185: /*           printf("Code field generation image[%x]:=CA(%x)\n",
                    186:                     i, CF(image[i])); */
1.52      pazsan    187: #if !defined(DOUBLY_INDIRECT)
                    188:              if (((token | 0x4000) >= CF(DODOES)) && (token < -0x4000))
1.53      anton     189:                fprintf(stderr,"Doer %d used in this image at $%lx is marked as Xt;\n executing this code will crash.\n",CF((token | 0x4000)),(long)&image[i],VERSION);
1.52      pazsan    190: #endif
1.53      anton     191:              if (CF((token | 0x4000))<max_symbols)
1.37      anton     192:                image[i]=(Cell)CA(CF(token));
                    193:              else
                    194:                fprintf(stderr,"Primitive %d used in this image at $%lx is not implemented by this\n engine (%s); executing this code will crash.\n",CF(token),(long)&image[i],VERSION);
1.1       anton     195:            }
1.46      jwilke    196:        else {
1.45      jwilke    197:           // if base is > 0: 0 is a null reference so don't adjust
                    198:           if (token>=base) {
                    199:             image[i]+=(Cell)start;
                    200:           }
1.46      jwilke    201:         }
1.1       anton     202:       }
                    203:     }
1.31      pazsan    204:   }
1.26      jwilke    205:   ((ImageHeader*)(image))->base = (Address) image;
1.1       anton     206: }
                    207: 
                    208: UCell checksum(Label symbols[])
                    209: {
                    210:   UCell r=PRIM_VERSION;
                    211:   Cell i;
                    212: 
                    213:   for (i=DOCOL; i<=DOESJUMP; i++) {
                    214:     r ^= (UCell)(symbols[i]);
                    215:     r = (r << 5) | (r >> (8*sizeof(Cell)-5));
                    216:   }
                    217: #ifdef DIRECT_THREADED
                    218:   /* we have to consider all the primitives */
                    219:   for (; symbols[i]!=(Label)0; i++) {
                    220:     r ^= (UCell)(symbols[i]);
                    221:     r = (r << 5) | (r >> (8*sizeof(Cell)-5));
                    222:   }
                    223: #else
                    224:   /* in indirect threaded code all primitives are accessed through the
                    225:      symbols table, so we just have to put the base address of symbols
                    226:      in the checksum */
                    227:   r ^= (UCell)symbols;
                    228: #endif
                    229:   return r;
                    230: }
                    231: 
1.3       anton     232: Address verbose_malloc(Cell size)
                    233: {
                    234:   Address r;
                    235:   /* leave a little room (64B) for stack underflows */
                    236:   if ((r = malloc(size+64))==NULL) {
                    237:     perror(progname);
                    238:     exit(1);
                    239:   }
                    240:   r = (Address)((((Cell)r)+(sizeof(Float)-1))&(-sizeof(Float)));
                    241:   if (debug)
                    242:     fprintf(stderr, "malloc succeeds, address=$%lx\n", (long)r);
                    243:   return r;
                    244: }
                    245: 
1.33      anton     246: static Address next_address=0;
                    247: void after_alloc(Address r, Cell size)
                    248: {
                    249:   if (r != (Address)-1) {
                    250:     if (debug)
                    251:       fprintf(stderr, "success, address=$%lx\n", (long) r);
                    252:     if (pagesize != 1)
                    253:       next_address = (Address)(((((Cell)r)+size-1)&-pagesize)+2*pagesize); /* leave one page unmapped */
                    254:   } else {
                    255:     if (debug)
                    256:       fprintf(stderr, "failed: %s\n", strerror(errno));
                    257:   }
                    258: }
                    259: 
1.34      anton     260: #ifndef MAP_FAILED
                    261: #define MAP_FAILED ((Address) -1)
                    262: #endif
                    263: #ifndef MAP_FILE
                    264: # define MAP_FILE 0
                    265: #endif
                    266: #ifndef MAP_PRIVATE
                    267: # define MAP_PRIVATE 0
                    268: #endif
                    269: 
                    270: #if defined(HAVE_MMAP)
                    271: static Address alloc_mmap(Cell size)
1.1       anton     272: {
                    273:   Address r;
                    274: 
                    275: #if defined(MAP_ANON)
                    276:   if (debug)
                    277:     fprintf(stderr,"try mmap($%lx, $%lx, ..., MAP_ANON, ...); ", (long)next_address, (long)size);
1.34      anton     278:   r = mmap(next_address, size, PROT_EXEC|PROT_READ|PROT_WRITE, MAP_ANON|MAP_PRIVATE, -1, 0);
1.1       anton     279: #else /* !defined(MAP_ANON) */
1.17      anton     280:   /* Ultrix (at least) does not define MAP_FILE and MAP_PRIVATE (both are
                    281:      apparently defaults) */
1.1       anton     282:   static int dev_zero=-1;
                    283: 
                    284:   if (dev_zero == -1)
                    285:     dev_zero = open("/dev/zero", O_RDONLY);
                    286:   if (dev_zero == -1) {
1.34      anton     287:     r = MAP_FAILED;
1.1       anton     288:     if (debug)
                    289:       fprintf(stderr, "open(\"/dev/zero\"...) failed (%s), no mmap; ", 
                    290:              strerror(errno));
                    291:   } else {
                    292:     if (debug)
                    293:       fprintf(stderr,"try mmap($%lx, $%lx, ..., MAP_FILE, dev_zero, ...); ", (long)next_address, (long)size);
                    294:     r=mmap(next_address, size, PROT_EXEC|PROT_READ|PROT_WRITE, MAP_FILE|MAP_PRIVATE, dev_zero, 0);
                    295:   }
                    296: #endif /* !defined(MAP_ANON) */
1.34      anton     297:   after_alloc(r, size);
                    298:   return r;  
                    299: }
                    300: #endif
                    301: 
                    302: Address my_alloc(Cell size)
                    303: {
                    304: #if HAVE_MMAP
                    305:   Address r;
                    306: 
                    307:   r=alloc_mmap(size);
                    308:   if (r!=MAP_FAILED)
1.1       anton     309:     return r;
                    310: #endif /* HAVE_MMAP */
1.3       anton     311:   /* use malloc as fallback */
                    312:   return verbose_malloc(size);
1.1       anton     313: }
                    314: 
1.3       anton     315: #if (defined(mips) && !defined(INDIRECT_THREADED))
                    316: /* the 256MB jump restriction on the MIPS architecture makes the
                    317:    combination of direct threading and mmap unsafe. */
1.33      anton     318: #define mips_dict_alloc 1
1.3       anton     319: #define dict_alloc(size) verbose_malloc(size)
                    320: #else
                    321: #define dict_alloc(size) my_alloc(size)
                    322: #endif
                    323: 
1.34      anton     324: Address dict_alloc_read(FILE *file, Cell imagesize, Cell dictsize, Cell offset)
1.33      anton     325: {
1.34      anton     326:   Address image = MAP_FAILED;
1.33      anton     327: 
1.34      anton     328: #if defined(HAVE_MMAP) && !defined(mips_dict_alloc)
1.33      anton     329:   if (offset==0) {
1.34      anton     330:     image=alloc_mmap(dictsize);
1.33      anton     331:     if (debug)
1.34      anton     332:       fprintf(stderr,"try mmap($%lx, $%lx, ..., MAP_FIXED|MAP_FILE, imagefile, 0); ", (long)image, (long)imagesize);
                    333:     image = mmap(image, imagesize, PROT_EXEC|PROT_READ|PROT_WRITE, MAP_FIXED|MAP_FILE|MAP_PRIVATE, fileno(file), 0);
                    334:     after_alloc(image,dictsize);
1.33      anton     335:   }
1.34      anton     336: #endif /* defined(MAP_ANON) && !defined(mips_dict_alloc) */
                    337:   if (image == MAP_FAILED) {
                    338:     image = dict_alloc(dictsize+offset)+offset;
1.33      anton     339:     rewind(file);  /* fseek(imagefile,0L,SEEK_SET); */
1.34      anton     340:     fread(image, 1, imagesize, file);
1.33      anton     341:   }
                    342:   return image;
                    343: }
                    344: 
1.10      pazsan    345: void set_stack_sizes(ImageHeader * header)
                    346: {
                    347:   if (dictsize==0)
                    348:     dictsize = header->dict_size;
                    349:   if (dsize==0)
                    350:     dsize = header->data_stack_size;
                    351:   if (rsize==0)
                    352:     rsize = header->return_stack_size;
                    353:   if (fsize==0)
                    354:     fsize = header->fp_stack_size;
                    355:   if (lsize==0)
                    356:     lsize = header->locals_stack_size;
                    357:   dictsize=maxaligned(dictsize);
                    358:   dsize=maxaligned(dsize);
                    359:   rsize=maxaligned(rsize);
                    360:   lsize=maxaligned(lsize);
                    361:   fsize=maxaligned(fsize);
                    362: }
                    363: 
                    364: void alloc_stacks(ImageHeader * header)
                    365: {
                    366:   header->dict_size=dictsize;
                    367:   header->data_stack_size=dsize;
                    368:   header->fp_stack_size=fsize;
                    369:   header->return_stack_size=rsize;
                    370:   header->locals_stack_size=lsize;
                    371: 
                    372:   header->data_stack_base=my_alloc(dsize);
                    373:   header->fp_stack_base=my_alloc(fsize);
                    374:   header->return_stack_base=my_alloc(rsize);
                    375:   header->locals_stack_base=my_alloc(lsize);
1.48      anton     376:   code_here = code_area = my_alloc(dictsize);
1.10      pazsan    377: }
                    378: 
1.44      pazsan    379: #warning You can ignore the warnings about clobbered variables in go_forth
1.11      pazsan    380: int go_forth(Address image, int stack, Cell *entries)
                    381: {
1.38      anton     382:   volatile ImageHeader *image_header = (ImageHeader *)image;
1.18      anton     383:   Cell *sp0=(Cell*)(image_header->data_stack_base + dsize);
1.44      pazsan    384:   Cell *rp0=(Cell *)(image_header->return_stack_base + rsize);
1.18      anton     385:   Float *fp0=(Float *)(image_header->fp_stack_base + fsize);
1.44      pazsan    386: #ifdef GFORTH_DEBUGGING
1.38      anton     387:   volatile Cell *orig_rp0=rp0;
1.44      pazsan    388: #endif
1.18      anton     389:   Address lp0=image_header->locals_stack_base + lsize;
                    390:   Xt *ip0=(Xt *)(image_header->boot_entry);
1.13      pazsan    391: #ifdef SYSSIGNALS
1.11      pazsan    392:   int throw_code;
1.13      pazsan    393: #endif
1.11      pazsan    394: 
                    395:   /* ensure that the cached elements (if any) are accessible */
1.41      anton     396:   IF_spTOS(sp0--);
                    397:   IF_fpTOS(fp0--);
1.11      pazsan    398:   
                    399:   for(;stack>0;stack--)
1.18      anton     400:     *--sp0=entries[stack-1];
1.11      pazsan    401: 
1.30      pazsan    402: #ifdef SYSSIGNALS
1.11      pazsan    403:   get_winsize();
                    404:    
                    405:   install_signal_handlers(); /* right place? */
                    406:   
                    407:   if ((throw_code=setjmp(throw_jmp_buf))) {
                    408:     static Cell signal_data_stack[8];
                    409:     static Cell signal_return_stack[8];
                    410:     static Float signal_fp_stack[1];
1.13      pazsan    411: 
1.11      pazsan    412:     signal_data_stack[7]=throw_code;
1.18      anton     413: 
                    414: #ifdef GFORTH_DEBUGGING
1.38      anton     415:     /* fprintf(stderr,"\nrp=%ld\n",(long)rp); */
                    416:     if (rp <= orig_rp0 && rp > (Cell *)(image_header->return_stack_base+5)) {
1.18      anton     417:       /* no rstack overflow or underflow */
                    418:       rp0 = rp;
1.27      anton     419:       *--rp0 = (Cell)ip;
1.18      anton     420:     }
                    421:     else /* I love non-syntactic ifdefs :-) */
                    422: #endif
                    423:     rp0 = signal_return_stack+8;
1.25      anton     424:     /* fprintf(stderr, "rp=$%x\n",rp0);*/
1.11      pazsan    425:     
1.33      anton     426:     return((int)(Cell)engine(image_header->throw_entry, signal_data_stack+7,
1.18      anton     427:                       rp0, signal_fp_stack, 0));
1.11      pazsan    428:   }
1.13      pazsan    429: #endif
1.11      pazsan    430: 
1.33      anton     431:   return((int)(Cell)engine(ip0,sp0,rp0,fp0,lp0));
1.11      pazsan    432: }
                    433: 
1.21      anton     434: 
1.30      pazsan    435: #ifndef INCLUDE_IMAGE
1.21      anton     436: void print_sizes(Cell sizebyte)
                    437:      /* print size information */
                    438: {
                    439:   static char* endianstring[]= { "   big","little" };
                    440:   
                    441:   fprintf(stderr,"%s endian, cell=%d bytes, char=%d bytes, au=%d bytes\n",
                    442:          endianstring[sizebyte & 1],
                    443:          1 << ((sizebyte >> 1) & 3),
                    444:          1 << ((sizebyte >> 3) & 3),
                    445:          1 << ((sizebyte >> 5) & 3));
                    446: }
                    447: 
1.47      anton     448: typedef struct {
                    449:   Label start;
                    450:   Cell length; /* excluding the jump */
                    451:   char super_end; /* true if primitive ends superinstruction, i.e.,
                    452:                      unconditional branch, execute, etc. */
                    453: } PrimInfo;
                    454: 
                    455: PrimInfo *priminfos;
1.48      anton     456: Cell npriminfos=0;
1.47      anton     457: 
                    458: void check_prims(Label symbols1[])
                    459: {
1.50      anton     460: #if defined(IS_NEXT_JUMP) && !defined(DOUBLY_INDIRECT)
1.47      anton     461:   int i;
                    462:   Label *symbols2=engine2(0,0,0,0,0);
1.49      anton     463:   static char superend[]={
1.48      anton     464: #include "prim_superend.i"
                    465:   };
1.47      anton     466: 
                    467:   for (i=DOESJUMP+1; symbols1[i+1]!=0; i++)
                    468:     ;
                    469:   priminfos = calloc(i,sizeof(PrimInfo));
1.48      anton     470:   npriminfos = i;
1.47      anton     471:   for (i=DOESJUMP+1; symbols1[i+1]!=0; i++) {
                    472:     int prim_len=symbols1[i+1]-symbols1[i];
                    473:     PrimInfo *pi=&priminfos[i];
                    474:     int j;
1.48      anton     475:     pi->super_end = superend[i-DOESJUMP-1];
1.50      anton     476:     for (j=prim_len-IND_JUMP_LENGTH; ; j--) {
                    477:       if (IS_NEXT_JUMP(symbols1[i]+j)) {
1.47      anton     478:        prim_len = j;
1.48      anton     479:        if (pi->super_end)
1.50      anton     480:          prim_len += IND_JUMP_LENGTH; /* include the jump */
1.47      anton     481:        break;
                    482:       }
                    483:       if (j==0) { /* NEXT jump not found, e.g., execute */
1.48      anton     484:        if (!pi->super_end && debug)
                    485:          fprintf(stderr, "NEXT jump not found for primitive %d, making it super_end\n", i);
                    486:         pi->super_end = 1;
1.47      anton     487:        break;
                    488:       }
                    489:     }
                    490:     /* fprintf(stderr,"checking primitive %d: memcmp(%p, %p, %d)\n",
                    491:        i, symbols1[i], symbols2[i], prim_len);*/
                    492:     if (memcmp(symbols1[i],symbols2[i],prim_len)!=0) {
                    493:       if (debug)
                    494:        fprintf(stderr,"Primitive %d not relocatable: memcmp(%p, %p, %d)\n",
                    495:                i, symbols1[i], symbols2[i], prim_len);
                    496:     } else {
                    497:       pi->start = symbols1[i];
                    498:       pi->length = prim_len;
                    499:       if (debug)
                    500:        fprintf(stderr,"Primitive %d relocatable: start %p, length %ld, super_end %d\n",
                    501:                i, pi->start, pi->length, pi->super_end);
                    502:     }      
1.48      anton     503:   }  
                    504: #endif
                    505: }
                    506: 
                    507: Label compile_prim(Label prim)
                    508: {
1.54    ! anton     509: #ifdef DOUBLY_INDIRECT
        !           510:   if (prim<((Label)(xts+DOESJUMP)) || prim>((Label)(xts+npriminfos))) {
        !           511:     fprintf(stderr,"compile_prim encountered xt %p\n", prim);
        !           512:     return prim;
        !           513:   } else
        !           514:     return prim-((Label)xts)+((Label)vm_prims);
        !           515: #else /* !defined(DOUBLY_INDIRECT) */
1.50      anton     516: #ifdef IND_JUMP_LENGTH
1.48      anton     517:   int i;
                    518:   Address old_code_here=code_here;
                    519:   static Address last_jump=0;
                    520: 
                    521:   for (i=0; ; i++) {
                    522:     if (i>=npriminfos) { /* not a relocatable prim */
                    523:       if (last_jump) { /* make sure the last sequence is complete */
1.50      anton     524:        memcpy(code_here, last_jump, IND_JUMP_LENGTH);
                    525:        code_here += IND_JUMP_LENGTH;
1.48      anton     526:        last_jump = 0;
                    527:       }
                    528:       return prim;
                    529:     }
                    530:     if (priminfos[i].start==prim)
                    531:       break;
1.47      anton     532:   }
1.50      anton     533: #ifdef ALIGN_CODE
                    534:   ALIGN_CODE;
                    535: #endif
1.48      anton     536:   memcpy(code_here, (Address)prim, priminfos[i].length);
                    537:   code_here += priminfos[i].length;
                    538:   last_jump = (priminfos[i].super_end) ? 0 : (prim+priminfos[i].length);
                    539:   return (Label)old_code_here;
1.50      anton     540: #else
                    541:   return prim;
                    542: #endif
1.54    ! anton     543: #endif /* !defined(DOUBLY_INDIRECT) */
1.47      anton     544: }
                    545: 
1.1       anton     546: Address loader(FILE *imagefile, char* filename)
                    547: /* returns the address of the image proper (after the preamble) */
                    548: {
                    549:   ImageHeader header;
                    550:   Address image;
                    551:   Address imp; /* image+preamble */
1.17      anton     552:   Char magic[8];
                    553:   char magic7; /* size byte of magic number */
1.1       anton     554:   Cell preamblesize=0;
1.6       pazsan    555:   Cell data_offset = offset_image ? 56*sizeof(Cell) : 0;
1.1       anton     556:   UCell check_sum;
1.15      pazsan    557:   Cell ausize = ((RELINFOBITS ==  8) ? 0 :
                    558:                 (RELINFOBITS == 16) ? 1 :
                    559:                 (RELINFOBITS == 32) ? 2 : 3);
                    560:   Cell charsize = ((sizeof(Char) == 1) ? 0 :
                    561:                   (sizeof(Char) == 2) ? 1 :
                    562:                   (sizeof(Char) == 4) ? 2 : 3) + ausize;
                    563:   Cell cellsize = ((sizeof(Cell) == 1) ? 0 :
                    564:                   (sizeof(Cell) == 2) ? 1 :
                    565:                   (sizeof(Cell) == 4) ? 2 : 3) + ausize;
1.21      anton     566:   Cell sizebyte = (ausize << 5) + (charsize << 3) + (cellsize << 1) +
                    567: #ifdef WORDS_BIGENDIAN
                    568:        0
                    569: #else
                    570:        1
                    571: #endif
                    572:     ;
1.1       anton     573: 
1.43      anton     574:   vm_prims = engine(0,0,0,0,0);
1.47      anton     575:   check_prims(vm_prims);
1.1       anton     576: #ifndef DOUBLY_INDIRECT
1.43      anton     577:   check_sum = checksum(vm_prims);
1.1       anton     578: #else /* defined(DOUBLY_INDIRECT) */
1.43      anton     579:   check_sum = (UCell)vm_prims;
1.1       anton     580: #endif /* defined(DOUBLY_INDIRECT) */
1.10      pazsan    581:   
                    582:   do {
                    583:     if(fread(magic,sizeof(Char),8,imagefile) < 8) {
1.15      pazsan    584:       fprintf(stderr,"%s: image %s doesn't seem to be a Gforth (>=0.4) image.\n",
1.10      pazsan    585:              progname, filename);
                    586:       exit(1);
1.1       anton     587:     }
1.10      pazsan    588:     preamblesize+=8;
1.15      pazsan    589:   } while(memcmp(magic,"Gforth2",7));
1.17      anton     590:   magic7 = magic[7];
1.1       anton     591:   if (debug) {
1.17      anton     592:     magic[7]='\0';
1.21      anton     593:     fprintf(stderr,"Magic found: %s ", magic);
                    594:     print_sizes(magic7);
1.1       anton     595:   }
                    596: 
1.21      anton     597:   if (magic7 != sizebyte)
                    598:     {
                    599:       fprintf(stderr,"This image is:         ");
                    600:       print_sizes(magic7);
                    601:       fprintf(stderr,"whereas the machine is ");
                    602:       print_sizes(sizebyte);
1.1       anton     603:       exit(-2);
                    604:     };
                    605: 
                    606:   fread((void *)&header,sizeof(ImageHeader),1,imagefile);
1.10      pazsan    607: 
                    608:   set_stack_sizes(&header);
1.1       anton     609:   
                    610: #if HAVE_GETPAGESIZE
                    611:   pagesize=getpagesize(); /* Linux/GNU libc offers this */
                    612: #elif HAVE_SYSCONF && defined(_SC_PAGESIZE)
                    613:   pagesize=sysconf(_SC_PAGESIZE); /* POSIX.4 */
                    614: #elif PAGESIZE
                    615:   pagesize=PAGESIZE; /* in limits.h according to Gallmeister's POSIX.4 book */
                    616: #endif
                    617:   if (debug)
1.5       jwilke    618:     fprintf(stderr,"pagesize=%ld\n",(unsigned long) pagesize);
1.1       anton     619: 
1.34      anton     620:   image = dict_alloc_read(imagefile, preamblesize+header.image_size,
                    621:                          preamblesize+dictsize, data_offset);
1.33      anton     622:   imp=image+preamblesize;
1.1       anton     623:   if (clear_dictionary)
1.33      anton     624:     memset(imp+header.image_size, 0, dictsize-header.image_size);
1.46      jwilke    625:   if(header.base==0 || header.base  == 0x100) {
1.1       anton     626:     Cell reloc_size=((header.image_size-1)/sizeof(Cell))/8+1;
                    627:     char reloc_bits[reloc_size];
1.33      anton     628:     fseek(imagefile, preamblesize+header.image_size, SEEK_SET);
1.10      pazsan    629:     fread(reloc_bits, 1, reloc_size, imagefile);
1.45      jwilke    630:     relocate((Cell *)imp, reloc_bits, header.image_size, header.base, vm_prims);
1.1       anton     631: #if 0
                    632:     { /* let's see what the relocator did */
                    633:       FILE *snapshot=fopen("snapshot.fi","wb");
                    634:       fwrite(image,1,imagesize,snapshot);
                    635:       fclose(snapshot);
                    636:     }
                    637: #endif
1.46      jwilke    638:   }
                    639:   else if(header.base!=imp) {
                    640:     fprintf(stderr,"%s: Cannot load nonrelocatable image (compiled for address $%lx) at address $%lx\n",
                    641:            progname, (unsigned long)header.base, (unsigned long)imp);
                    642:     exit(1);
1.1       anton     643:   }
                    644:   if (header.checksum==0)
                    645:     ((ImageHeader *)imp)->checksum=check_sum;
                    646:   else if (header.checksum != check_sum) {
                    647:     fprintf(stderr,"%s: Checksum of image ($%lx) does not match the executable ($%lx)\n",
                    648:            progname, (unsigned long)(header.checksum),(unsigned long)check_sum);
                    649:     exit(1);
                    650:   }
1.53      anton     651: #ifdef DOUBLY_INDIRECT
                    652:   ((ImageHeader *)imp)->xt_base = xts;
                    653: #endif
1.1       anton     654:   fclose(imagefile);
                    655: 
1.10      pazsan    656:   alloc_stacks((ImageHeader *)imp);
1.1       anton     657: 
                    658:   CACHE_FLUSH(imp, header.image_size);
                    659: 
                    660:   return imp;
                    661: }
                    662: 
1.28      anton     663: /* index of last '/' or '\' in file, 0 if there is none. !! Hmm, could
                    664:    be implemented with strrchr and the separator should be
                    665:    OS-dependent */
1.1       anton     666: int onlypath(char *file)
1.10      pazsan    667: {
                    668:   int i;
1.1       anton     669:   i=strlen(file);
1.10      pazsan    670:   while (i) {
                    671:     if (file[i]=='\\' || file[i]=='/') break;
                    672:     i--;
                    673:   }
                    674:   return i;
1.1       anton     675: }
                    676: 
                    677: FILE *openimage(char *fullfilename)
1.10      pazsan    678: {
                    679:   FILE *image_file;
1.28      anton     680:   char * expfilename = tilde_cstr(fullfilename, strlen(fullfilename), 1);
1.10      pazsan    681: 
1.28      anton     682:   image_file=fopen(expfilename,"rb");
1.1       anton     683:   if (image_file!=NULL && debug)
1.28      anton     684:     fprintf(stderr, "Opened image file: %s\n", expfilename);
1.10      pazsan    685:   return image_file;
1.1       anton     686: }
                    687: 
1.28      anton     688: /* try to open image file concat(path[0:len],imagename) */
1.1       anton     689: FILE *checkimage(char *path, int len, char *imagename)
1.10      pazsan    690: {
                    691:   int dirlen=len;
1.1       anton     692:   char fullfilename[dirlen+strlen(imagename)+2];
1.10      pazsan    693: 
1.1       anton     694:   memcpy(fullfilename, path, dirlen);
                    695:   if (fullfilename[dirlen-1]!='/')
                    696:     fullfilename[dirlen++]='/';
                    697:   strcpy(fullfilename+dirlen,imagename);
1.10      pazsan    698:   return openimage(fullfilename);
1.1       anton     699: }
                    700: 
1.10      pazsan    701: FILE * open_image_file(char * imagename, char * path)
1.1       anton     702: {
1.10      pazsan    703:   FILE * image_file=NULL;
1.28      anton     704:   char *origpath=path;
1.10      pazsan    705:   
                    706:   if(strchr(imagename, '/')==NULL) {
                    707:     /* first check the directory where the exe file is in !! 01may97jaw */
                    708:     if (onlypath(progname))
                    709:       image_file=checkimage(progname, onlypath(progname), imagename);
                    710:     if (!image_file)
                    711:       do {
                    712:        char *pend=strchr(path, PATHSEP);
                    713:        if (pend==NULL)
                    714:          pend=path+strlen(path);
                    715:        if (strlen(path)==0) break;
                    716:        image_file=checkimage(path, pend-path, imagename);
                    717:        path=pend+(*pend==PATHSEP);
                    718:       } while (image_file==NULL);
                    719:   } else {
                    720:     image_file=openimage(imagename);
                    721:   }
1.1       anton     722: 
1.10      pazsan    723:   if (!image_file) {
                    724:     fprintf(stderr,"%s: cannot open image file %s in path %s for reading\n",
1.28      anton     725:            progname, imagename, origpath);
1.10      pazsan    726:     exit(1);
1.7       anton     727:   }
                    728: 
1.10      pazsan    729:   return image_file;
                    730: }
1.11      pazsan    731: #endif
                    732: 
                    733: #ifdef HAS_OS
                    734: UCell convsize(char *s, UCell elemsize)
                    735: /* converts s of the format [0-9]+[bekMGT]? (e.g. 25k) into the number
                    736:    of bytes.  the letter at the end indicates the unit, where e stands
                    737:    for the element size. default is e */
                    738: {
                    739:   char *endp;
                    740:   UCell n,m;
                    741: 
                    742:   m = elemsize;
                    743:   n = strtoul(s,&endp,0);
                    744:   if (endp!=NULL) {
                    745:     if (strcmp(endp,"b")==0)
                    746:       m=1;
                    747:     else if (strcmp(endp,"k")==0)
                    748:       m=1024;
                    749:     else if (strcmp(endp,"M")==0)
                    750:       m=1024*1024;
                    751:     else if (strcmp(endp,"G")==0)
                    752:       m=1024*1024*1024;
                    753:     else if (strcmp(endp,"T")==0) {
                    754: #if (SIZEOF_CHAR_P > 4)
1.24      anton     755:       m=1024L*1024*1024*1024;
1.11      pazsan    756: #else
                    757:       fprintf(stderr,"%s: size specification \"%s\" too large for this machine\n", progname, endp);
                    758:       exit(1);
                    759: #endif
                    760:     } else if (strcmp(endp,"e")!=0 && strcmp(endp,"")!=0) {
                    761:       fprintf(stderr,"%s: cannot grok size specification %s: invalid unit \"%s\"\n", progname, s, endp);
                    762:       exit(1);
                    763:     }
                    764:   }
                    765:   return n*m;
                    766: }
1.10      pazsan    767: 
                    768: void gforth_args(int argc, char ** argv, char ** path, char ** imagename)
                    769: {
                    770:   int c;
                    771: 
1.1       anton     772:   opterr=0;
                    773:   while (1) {
                    774:     int option_index=0;
                    775:     static struct option opts[] = {
1.29      anton     776:       {"appl-image", required_argument, NULL, 'a'},
1.1       anton     777:       {"image-file", required_argument, NULL, 'i'},
                    778:       {"dictionary-size", required_argument, NULL, 'm'},
                    779:       {"data-stack-size", required_argument, NULL, 'd'},
                    780:       {"return-stack-size", required_argument, NULL, 'r'},
                    781:       {"fp-stack-size", required_argument, NULL, 'f'},
                    782:       {"locals-stack-size", required_argument, NULL, 'l'},
                    783:       {"path", required_argument, NULL, 'p'},
                    784:       {"version", no_argument, NULL, 'v'},
                    785:       {"help", no_argument, NULL, 'h'},
                    786:       /* put something != 0 into offset_image */
                    787:       {"offset-image", no_argument, &offset_image, 1},
                    788:       {"no-offset-im", no_argument, &offset_image, 0},
                    789:       {"clear-dictionary", no_argument, &clear_dictionary, 1},
1.4       anton     790:       {"die-on-signal", no_argument, &die_on_signal, 1},
1.1       anton     791:       {"debug", no_argument, &debug, 1},
                    792:       {0,0,0,0}
                    793:       /* no-init-file, no-rc? */
                    794:     };
                    795:     
1.36      pazsan    796:     c = getopt_long(argc, argv, "+i:m:d:r:f:l:p:vhoncsx", opts, &option_index);
1.1       anton     797:     
                    798:     switch (c) {
1.29      anton     799:     case EOF: return;
                    800:     case '?': optind--; return;
                    801:     case 'a': *imagename = optarg; return;
1.10      pazsan    802:     case 'i': *imagename = optarg; break;
1.1       anton     803:     case 'm': dictsize = convsize(optarg,sizeof(Cell)); break;
                    804:     case 'd': dsize = convsize(optarg,sizeof(Cell)); break;
                    805:     case 'r': rsize = convsize(optarg,sizeof(Cell)); break;
                    806:     case 'f': fsize = convsize(optarg,sizeof(Float)); break;
                    807:     case 'l': lsize = convsize(optarg,sizeof(Cell)); break;
1.10      pazsan    808:     case 'p': *path = optarg; break;
1.36      pazsan    809:     case 'o': offset_image = 1; break;
                    810:     case 'n': offset_image = 0; break;
                    811:     case 'c': clear_dictionary = 1; break;
                    812:     case 's': die_on_signal = 1; break;
                    813:     case 'x': debug = 1; break;
1.8       anton     814:     case 'v': fprintf(stderr, "gforth %s\n", VERSION); exit(0);
1.1       anton     815:     case 'h': 
1.29      anton     816:       fprintf(stderr, "Usage: %s [engine options] ['--'] [image arguments]\n\
1.1       anton     817: Engine Options:\n\
1.29      anton     818:   --appl-image FILE                equivalent to '--image-file=FILE --'\n\
1.10      pazsan    819:   --clear-dictionary               Initialize the dictionary with 0 bytes\n\
                    820:   -d SIZE, --data-stack-size=SIZE   Specify data stack size\n\
                    821:   --debug                          Print debugging information during startup\n\
                    822:   --die-on-signal                  exit instead of CATCHing some signals\n\
                    823:   -f SIZE, --fp-stack-size=SIZE            Specify floating point stack size\n\
                    824:   -h, --help                       Print this message and exit\n\
                    825:   -i FILE, --image-file=FILE       Use image FILE instead of `gforth.fi'\n\
                    826:   -l SIZE, --locals-stack-size=SIZE Specify locals stack size\n\
                    827:   -m SIZE, --dictionary-size=SIZE   Specify Forth dictionary size\n\
                    828:   --no-offset-im                   Load image at normal position\n\
                    829:   --offset-image                   Load image at a different position\n\
                    830:   -p PATH, --path=PATH             Search path for finding image and sources\n\
                    831:   -r SIZE, --return-stack-size=SIZE Specify return stack size\n\
                    832:   -v, --version                            Print version and exit\n\
1.1       anton     833: SIZE arguments consist of an integer followed by a unit. The unit can be\n\
1.10      pazsan    834:   `b' (byte), `e' (element; default), `k' (KB), `M' (MB), `G' (GB) or `T' (TB).\n",
                    835:              argv[0]);
                    836:       optind--;
                    837:       return;
1.1       anton     838:     }
                    839:   }
1.10      pazsan    840: }
1.11      pazsan    841: #endif
1.10      pazsan    842: 
                    843: #ifdef INCLUDE_IMAGE
                    844: extern Cell image[];
                    845: extern const char reloc_bits[];
                    846: #endif
                    847: 
                    848: int main(int argc, char **argv, char **env)
                    849: {
1.30      pazsan    850: #ifdef HAS_OS
1.10      pazsan    851:   char *path = getenv("GFORTHPATH") ? : DEFAULTPATH;
1.30      pazsan    852: #else
                    853:   char *path = DEFAULTPATH;
                    854: #endif
1.13      pazsan    855: #ifndef INCLUDE_IMAGE
1.10      pazsan    856:   char *imagename="gforth.fi";
                    857:   FILE *image_file;
                    858:   Address image;
                    859: #endif
                    860:   int retvalue;
                    861:          
                    862: #if defined(i386) && defined(ALIGNMENT_CHECK) && !defined(DIRECT_THREADED)
                    863:   /* turn on alignment checks on the 486.
                    864:    * on the 386 this should have no effect. */
                    865:   __asm__("pushfl; popl %eax; orl $0x40000, %eax; pushl %eax; popfl;");
                    866:   /* this is unusable with Linux' libc.4.6.27, because this library is
                    867:      not alignment-clean; we would have to replace some library
                    868:      functions (e.g., memcpy) to make it work. Also GCC doesn't try to keep
                    869:      the stack FP-aligned. */
                    870: #endif
                    871: 
                    872:   /* buffering of the user output device */
1.11      pazsan    873: #ifdef _IONBF
1.10      pazsan    874:   if (isatty(fileno(stdout))) {
                    875:     fflush(stdout);
                    876:     setvbuf(stdout,NULL,_IONBF,0);
1.1       anton     877:   }
1.11      pazsan    878: #endif
1.1       anton     879: 
1.10      pazsan    880:   progname = argv[0];
                    881: 
1.11      pazsan    882: #ifdef HAS_OS
1.10      pazsan    883:   gforth_args(argc, argv, &path, &imagename);
1.11      pazsan    884: #endif
1.10      pazsan    885: 
                    886: #ifdef INCLUDE_IMAGE
                    887:   set_stack_sizes((ImageHeader *)image);
1.22      pazsan    888:   if(((ImageHeader *)image)->base != image)
                    889:     relocate(image, reloc_bits, ((ImageHeader *)image)->image_size,
                    890:             (Label*)engine(0, 0, 0, 0, 0));
1.10      pazsan    891:   alloc_stacks((ImageHeader *)image);
                    892: #else
                    893:   image_file = open_image_file(imagename, path);
                    894:   image = loader(image_file, imagename);
                    895: #endif
1.24      anton     896:   gforth_header=(ImageHeader *)image; /* used in SIGSEGV handler */
1.1       anton     897: 
                    898:   {
1.10      pazsan    899:     char path2[strlen(path)+1];
1.1       anton     900:     char *p1, *p2;
                    901:     Cell environ[]= {
                    902:       (Cell)argc-(optind-1),
                    903:       (Cell)(argv+(optind-1)),
1.10      pazsan    904:       (Cell)strlen(path),
1.1       anton     905:       (Cell)path2};
                    906:     argv[optind-1] = progname;
                    907:     /*
                    908:        for (i=0; i<environ[0]; i++)
                    909:        printf("%s\n", ((char **)(environ[1]))[i]);
                    910:        */
                    911:     /* make path OS-independent by replacing path separators with NUL */
1.10      pazsan    912:     for (p1=path, p2=path2; *p1!='\0'; p1++, p2++)
1.1       anton     913:       if (*p1==PATHSEP)
                    914:        *p2 = '\0';
                    915:       else
                    916:        *p2 = *p1;
                    917:     *p2='\0';
1.10      pazsan    918:     retvalue = go_forth(image, 4, environ);
1.42      anton     919: #ifdef VM_PROFILING
                    920:     vm_print_profile(stderr);
                    921: #endif
1.1       anton     922:     deprep_terminal();
                    923:   }
1.13      pazsan    924:   return retvalue;
1.1       anton     925: }

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>