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

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"
1.82      anton      24: #include "forth.h"
1.1       anton      25: #include <errno.h>
                     26: #include <ctype.h>
                     27: #include <stdio.h>
1.2       pazsan     28: #include <unistd.h>
1.1       anton      29: #include <string.h>
                     30: #include <math.h>
                     31: #include <sys/types.h>
1.32      pazsan     32: #ifndef STANDALONE
1.1       anton      33: #include <sys/stat.h>
1.32      pazsan     34: #endif
1.1       anton      35: #include <fcntl.h>
                     36: #include <assert.h>
                     37: #include <stdlib.h>
1.11      pazsan     38: #ifndef STANDALONE
1.1       anton      39: #if HAVE_SYS_MMAN_H
                     40: #include <sys/mman.h>
                     41: #endif
1.11      pazsan     42: #endif
1.1       anton      43: #include "io.h"
                     44: #include "getopt.h"
1.11      pazsan     45: #ifdef STANDALONE
                     46: #include <systypes.h>
                     47: #endif
1.1       anton      48: 
1.79      anton      49: /* global variables for engine.c 
                     50:    We put them here because engine.c is compiled several times in
                     51:    different ways for the same engine. */
                     52: Cell *SP;
                     53: Float *FP;
                     54: Address UP=NULL;
                     55: 
                     56: #ifdef GFORTH_DEBUGGING
                     57: /* define some VM registers as global variables, so they survive exceptions;
                     58:    global register variables are not up to the task (according to the 
                     59:    GNU C manual) */
                     60: Xt *saved_ip;
                     61: Cell *rp;
                     62: #endif
                     63: 
                     64: #ifdef NO_IP
                     65: Label next_code;
                     66: #endif
                     67: 
                     68: #ifdef HAS_FILE
                     69: char* fileattr[6]={"rb","rb","r+b","r+b","wb","wb"};
                     70: char* pfileattr[6]={"r","r","r+","r+","w","w"};
                     71: 
                     72: #ifndef O_BINARY
                     73: #define O_BINARY 0
                     74: #endif
                     75: #ifndef O_TEXT
                     76: #define O_TEXT 0
                     77: #endif
                     78: 
                     79: int ufileattr[6]= {
                     80:   O_RDONLY|O_BINARY, O_RDONLY|O_BINARY,
                     81:   O_RDWR  |O_BINARY, O_RDWR  |O_BINARY,
                     82:   O_WRONLY|O_BINARY, O_WRONLY|O_BINARY };
                     83: #endif
                     84: /* end global vars for engine.c */
                     85: 
1.1       anton      86: #define PRIM_VERSION 1
                     87: /* increment this whenever the primitives change in an incompatible way */
                     88: 
1.14      pazsan     89: #ifndef DEFAULTPATH
1.39      anton      90: #  define DEFAULTPATH "."
1.14      pazsan     91: #endif
                     92: 
1.1       anton      93: #ifdef MSDOS
                     94: jmp_buf throw_jmp_buf;
                     95: #endif
                     96: 
1.56      anton      97: #if defined(DOUBLY_INDIRECT)
                     98: #  define CFA(n)       ({Cell _n = (n); ((Cell)(((_n & 0x4000) ? symbols : xts)+(_n&~0x4000UL)));})
1.1       anton      99: #else
1.56      anton     100: #  define CFA(n)       ((Cell)(symbols+((n)&~0x4000UL)))
1.1       anton     101: #endif
                    102: 
                    103: #define maxaligned(n)  (typeof(n))((((Cell)n)+sizeof(Float)-1)&-sizeof(Float))
                    104: 
                    105: static UCell dictsize=0;
                    106: static UCell dsize=0;
                    107: static UCell rsize=0;
                    108: static UCell fsize=0;
                    109: static UCell lsize=0;
                    110: int offset_image=0;
1.4       anton     111: int die_on_signal=0;
1.13      pazsan    112: #ifndef INCLUDE_IMAGE
1.1       anton     113: static int clear_dictionary=0;
1.24      anton     114: UCell pagesize=1;
1.22      pazsan    115: char *progname;
                    116: #else
                    117: char *progname = "gforth";
                    118: int optind = 1;
1.13      pazsan    119: #endif
1.31      pazsan    120: 
1.75      anton     121: #define CODE_BLOCK_SIZE (64*1024)
1.48      anton     122: Address code_area=0;
1.73      anton     123: Cell code_area_size = CODE_BLOCK_SIZE;
1.75      anton     124: Address code_here=NULL+CODE_BLOCK_SIZE; /* does for code-area what HERE
                    125:                                           does for the dictionary */
1.65      anton     126: Address start_flush=0; /* start of unflushed code */
1.74      anton     127: Cell last_jump=0; /* if the last prim was compiled without jump, this
                    128:                      is it's number, otherwise this contains 0 */
1.48      anton     129: 
1.60      anton     130: static int no_super=0;   /* true if compile_prim should not fuse prims */
1.81      anton     131: static int no_dynamic=NO_DYNAMIC_DEFAULT; /* if true, no code is generated
                    132:                                             dynamically */
1.60      anton     133: 
1.30      pazsan    134: #ifdef HAS_DEBUG
1.68      anton     135: int debug=0;
1.31      pazsan    136: #else
                    137: # define perror(x...)
                    138: # define fprintf(x...)
1.30      pazsan    139: #endif
1.31      pazsan    140: 
1.24      anton     141: ImageHeader *gforth_header;
1.43      anton     142: Label *vm_prims;
1.53      anton     143: #ifdef DOUBLY_INDIRECT
                    144: Label *xts; /* same content as vm_prims, but should only be used for xts */
                    145: #endif
1.1       anton     146: 
1.30      pazsan    147: #ifdef MEMCMP_AS_SUBROUTINE
                    148: int gforth_memcmp(const char * s1, const char * s2, size_t n)
                    149: {
                    150:   return memcmp(s1, s2, n);
                    151: }
                    152: #endif
                    153: 
1.1       anton     154: /* image file format:
1.15      pazsan    155:  *  "#! binary-path -i\n" (e.g., "#! /usr/local/bin/gforth-0.4.0 -i\n")
1.1       anton     156:  *   padding to a multiple of 8
1.84      anton     157:  *   magic: "Gforth3x" means format 0.6,
1.15      pazsan    158:  *              where x is a byte with
                    159:  *              bit 7:   reserved = 0
                    160:  *              bit 6:5: address unit size 2^n octets
                    161:  *              bit 4:3: character size 2^n octets
                    162:  *              bit 2:1: cell size 2^n octets
                    163:  *              bit 0:   endian, big=0, little=1.
                    164:  *  The magic are always 8 octets, no matter what the native AU/character size is
1.1       anton     165:  *  padding to max alignment (no padding necessary on current machines)
1.24      anton     166:  *  ImageHeader structure (see forth.h)
1.1       anton     167:  *  data (size in ImageHeader.image_size)
                    168:  *  tags ((if relocatable, 1 bit/data cell)
                    169:  *
                    170:  * tag==1 means that the corresponding word is an address;
                    171:  * If the word is >=0, the address is within the image;
                    172:  * addresses within the image are given relative to the start of the image.
                    173:  * If the word =-1 (CF_NIL), the address is NIL,
                    174:  * If the word is <CF_NIL and >CF(DODOES), it's a CFA (:, Create, ...)
                    175:  * If the word =CF(DODOES), it's a DOES> CFA
                    176:  * If the word =CF(DOESJUMP), it's a DOES JUMP (2 Cells after DOES>,
                    177:  *                                     possibly containing a jump to dodoes)
1.51      anton     178:  * If the word is <CF(DOESJUMP) and bit 14 is set, it's the xt of a primitive
                    179:  * If the word is <CF(DOESJUMP) and bit 14 is clear, 
                    180:  *                                        it's the threaded code of a primitive
1.85      pazsan    181:  * bits 13..9 of a primitive token state which group the primitive belongs to,
                    182:  * bits 8..0 of a primitive token index into the group
1.1       anton     183:  */
                    184: 
1.85      pazsan    185: static Cell groups[32] = {
                    186:   0,
                    187: #define GROUP(x, n) DOESJUMP+1+n,
1.86      anton     188: #include "prim_grp.i"
1.85      pazsan    189: #define GROUP(x, n)
                    190: };
                    191: 
1.46      jwilke    192: void relocate(Cell *image, const char *bitstring, 
                    193:               int size, int base, Label symbols[])
1.1       anton     194: {
1.16      pazsan    195:   int i=0, j, k, steps=(size/sizeof(Cell))/RELINFOBITS;
1.11      pazsan    196:   Cell token;
1.1       anton     197:   char bits;
1.37      anton     198:   Cell max_symbols;
1.46      jwilke    199:   /* 
1.85      pazsan    200:    * A virtual start address that's the real start address minus 
1.46      jwilke    201:    * the one in the image 
                    202:    */
1.45      jwilke    203:   Cell *start = (Cell * ) (((void *) image) - ((void *) base));
1.1       anton     204: 
1.85      pazsan    205:   /* group index into table */
1.46      jwilke    206:   
                    207: /* printf("relocating to %x[%x] start=%x base=%x\n", image, size, start, base); */
1.37      anton     208:   
                    209:   for (max_symbols=DOESJUMP+1; symbols[max_symbols]!=0; max_symbols++)
                    210:     ;
1.47      anton     211:   max_symbols--;
1.35      pazsan    212:   size/=sizeof(Cell);
                    213: 
1.31      pazsan    214:   for(k=0; k<=steps; k++) {
1.13      pazsan    215:     for(j=0, bits=bitstring[k]; j<RELINFOBITS; j++, i++, bits<<=1) {
1.1       anton     216:       /*      fprintf(stderr,"relocate: image[%d]\n", i);*/
1.35      pazsan    217:       if((i < size) && (bits & (1U << (RELINFOBITS-1)))) {
                    218:        /* fprintf(stderr,"relocate: image[%d]=%d of %d\n", i, image[i], size/sizeof(Cell)); */
1.45      jwilke    219:         token=image[i];
1.85      pazsan    220:        if(token<0) {
                    221:          int group = (-token & 0x3E00) >> 9;
                    222:          if(group == 0) {
                    223:            switch(token|0x4000) {
1.1       anton     224:            case CF_NIL      : image[i]=0; break;
                    225: #if !defined(DOUBLY_INDIRECT)
                    226:            case CF(DOCOL)   :
                    227:            case CF(DOVAR)   :
                    228:            case CF(DOCON)   :
                    229:            case CF(DOUSER)  : 
                    230:            case CF(DODEFER) : 
1.11      pazsan    231:            case CF(DOFIELD) : MAKE_CF(image+i,symbols[CF(token)]); break;
1.1       anton     232:            case CF(DOESJUMP): MAKE_DOES_HANDLER(image+i); break;
                    233: #endif /* !defined(DOUBLY_INDIRECT) */
                    234:            case CF(DODOES)  :
1.45      jwilke    235:              MAKE_DOES_CF(image+i,(Xt *)(image[i+1]+((Cell)start)));
1.1       anton     236:              break;
1.85      pazsan    237:            default          : /* backward compatibility */
1.56      anton     238: /*           printf("Code field generation image[%x]:=CFA(%x)\n",
1.1       anton     239:                     i, CF(image[i])); */
1.55      anton     240:              if (CF((token | 0x4000))<max_symbols) {
1.56      anton     241:                image[i]=(Cell)CFA(CF(token));
                    242: #ifdef DIRECT_THREADED
                    243:                if ((token & 0x4000) == 0) /* threade code, no CFA */
1.70      anton     244:                  compile_prim1(&image[i]);
1.56      anton     245: #endif
1.55      anton     246:              } else
1.83      anton     247:                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],PACKAGE_VERSION);
1.1       anton     248:            }
1.85      pazsan    249:          } else {
                    250:            int tok = -token & 0x1FF;
                    251:            if (tok < (groups[group+1]-groups[group])) {
                    252: #if defined(DOUBLY_INDIRECT)
                    253:              image[i]=(Cell)CFA(((groups[group]+tok) | (CF(token) & 0x4000)));
                    254: #else
                    255:              image[i]=(Cell)CFA((groups[group]+tok));
                    256: #endif
                    257: #ifdef DIRECT_THREADED
                    258:              if ((token & 0x4000) == 0) /* threade code, no CFA */
                    259:                compile_prim1(&image[i]);
                    260: #endif
                    261:            } else
                    262:              fprintf(stderr,"Primitive %x, %d of group %d used in this image at $%lx is not implemented by this\n engine (%s); executing this code will crash.\n", -token, tok, group, (long)&image[i],PACKAGE_VERSION);
                    263:          }
                    264:        } else {
1.45      jwilke    265:           // if base is > 0: 0 is a null reference so don't adjust
                    266:           if (token>=base) {
                    267:             image[i]+=(Cell)start;
                    268:           }
1.46      jwilke    269:         }
1.1       anton     270:       }
                    271:     }
1.31      pazsan    272:   }
1.70      anton     273:   finish_code();
1.26      jwilke    274:   ((ImageHeader*)(image))->base = (Address) image;
1.1       anton     275: }
                    276: 
                    277: UCell checksum(Label symbols[])
                    278: {
                    279:   UCell r=PRIM_VERSION;
                    280:   Cell i;
                    281: 
                    282:   for (i=DOCOL; i<=DOESJUMP; i++) {
                    283:     r ^= (UCell)(symbols[i]);
                    284:     r = (r << 5) | (r >> (8*sizeof(Cell)-5));
                    285:   }
                    286: #ifdef DIRECT_THREADED
                    287:   /* we have to consider all the primitives */
                    288:   for (; symbols[i]!=(Label)0; i++) {
                    289:     r ^= (UCell)(symbols[i]);
                    290:     r = (r << 5) | (r >> (8*sizeof(Cell)-5));
                    291:   }
                    292: #else
                    293:   /* in indirect threaded code all primitives are accessed through the
                    294:      symbols table, so we just have to put the base address of symbols
                    295:      in the checksum */
                    296:   r ^= (UCell)symbols;
                    297: #endif
                    298:   return r;
                    299: }
                    300: 
1.3       anton     301: Address verbose_malloc(Cell size)
                    302: {
                    303:   Address r;
                    304:   /* leave a little room (64B) for stack underflows */
                    305:   if ((r = malloc(size+64))==NULL) {
                    306:     perror(progname);
                    307:     exit(1);
                    308:   }
                    309:   r = (Address)((((Cell)r)+(sizeof(Float)-1))&(-sizeof(Float)));
                    310:   if (debug)
                    311:     fprintf(stderr, "malloc succeeds, address=$%lx\n", (long)r);
                    312:   return r;
                    313: }
                    314: 
1.33      anton     315: static Address next_address=0;
                    316: void after_alloc(Address r, Cell size)
                    317: {
                    318:   if (r != (Address)-1) {
                    319:     if (debug)
                    320:       fprintf(stderr, "success, address=$%lx\n", (long) r);
                    321:     if (pagesize != 1)
                    322:       next_address = (Address)(((((Cell)r)+size-1)&-pagesize)+2*pagesize); /* leave one page unmapped */
                    323:   } else {
                    324:     if (debug)
                    325:       fprintf(stderr, "failed: %s\n", strerror(errno));
                    326:   }
                    327: }
                    328: 
1.34      anton     329: #ifndef MAP_FAILED
                    330: #define MAP_FAILED ((Address) -1)
                    331: #endif
                    332: #ifndef MAP_FILE
                    333: # define MAP_FILE 0
                    334: #endif
                    335: #ifndef MAP_PRIVATE
                    336: # define MAP_PRIVATE 0
                    337: #endif
                    338: 
                    339: #if defined(HAVE_MMAP)
                    340: static Address alloc_mmap(Cell size)
1.1       anton     341: {
                    342:   Address r;
                    343: 
                    344: #if defined(MAP_ANON)
                    345:   if (debug)
                    346:     fprintf(stderr,"try mmap($%lx, $%lx, ..., MAP_ANON, ...); ", (long)next_address, (long)size);
1.34      anton     347:   r = mmap(next_address, size, PROT_EXEC|PROT_READ|PROT_WRITE, MAP_ANON|MAP_PRIVATE, -1, 0);
1.1       anton     348: #else /* !defined(MAP_ANON) */
1.17      anton     349:   /* Ultrix (at least) does not define MAP_FILE and MAP_PRIVATE (both are
                    350:      apparently defaults) */
1.1       anton     351:   static int dev_zero=-1;
                    352: 
                    353:   if (dev_zero == -1)
                    354:     dev_zero = open("/dev/zero", O_RDONLY);
                    355:   if (dev_zero == -1) {
1.34      anton     356:     r = MAP_FAILED;
1.1       anton     357:     if (debug)
                    358:       fprintf(stderr, "open(\"/dev/zero\"...) failed (%s), no mmap; ", 
                    359:              strerror(errno));
                    360:   } else {
                    361:     if (debug)
                    362:       fprintf(stderr,"try mmap($%lx, $%lx, ..., MAP_FILE, dev_zero, ...); ", (long)next_address, (long)size);
                    363:     r=mmap(next_address, size, PROT_EXEC|PROT_READ|PROT_WRITE, MAP_FILE|MAP_PRIVATE, dev_zero, 0);
                    364:   }
                    365: #endif /* !defined(MAP_ANON) */
1.34      anton     366:   after_alloc(r, size);
                    367:   return r;  
                    368: }
                    369: #endif
                    370: 
                    371: Address my_alloc(Cell size)
                    372: {
                    373: #if HAVE_MMAP
                    374:   Address r;
                    375: 
                    376:   r=alloc_mmap(size);
                    377:   if (r!=MAP_FAILED)
1.1       anton     378:     return r;
                    379: #endif /* HAVE_MMAP */
1.3       anton     380:   /* use malloc as fallback */
                    381:   return verbose_malloc(size);
1.1       anton     382: }
                    383: 
1.34      anton     384: Address dict_alloc_read(FILE *file, Cell imagesize, Cell dictsize, Cell offset)
1.33      anton     385: {
1.34      anton     386:   Address image = MAP_FAILED;
1.33      anton     387: 
1.56      anton     388: #if defined(HAVE_MMAP)
1.33      anton     389:   if (offset==0) {
1.34      anton     390:     image=alloc_mmap(dictsize);
1.33      anton     391:     if (debug)
1.34      anton     392:       fprintf(stderr,"try mmap($%lx, $%lx, ..., MAP_FIXED|MAP_FILE, imagefile, 0); ", (long)image, (long)imagesize);
                    393:     image = mmap(image, imagesize, PROT_EXEC|PROT_READ|PROT_WRITE, MAP_FIXED|MAP_FILE|MAP_PRIVATE, fileno(file), 0);
                    394:     after_alloc(image,dictsize);
1.33      anton     395:   }
1.56      anton     396: #endif /* defined(HAVE_MMAP) */
1.34      anton     397:   if (image == MAP_FAILED) {
1.56      anton     398:     image = my_alloc(dictsize+offset)+offset;
1.33      anton     399:     rewind(file);  /* fseek(imagefile,0L,SEEK_SET); */
1.34      anton     400:     fread(image, 1, imagesize, file);
1.33      anton     401:   }
                    402:   return image;
                    403: }
                    404: 
1.10      pazsan    405: void set_stack_sizes(ImageHeader * header)
                    406: {
                    407:   if (dictsize==0)
                    408:     dictsize = header->dict_size;
                    409:   if (dsize==0)
                    410:     dsize = header->data_stack_size;
                    411:   if (rsize==0)
                    412:     rsize = header->return_stack_size;
                    413:   if (fsize==0)
                    414:     fsize = header->fp_stack_size;
                    415:   if (lsize==0)
                    416:     lsize = header->locals_stack_size;
                    417:   dictsize=maxaligned(dictsize);
                    418:   dsize=maxaligned(dsize);
                    419:   rsize=maxaligned(rsize);
                    420:   lsize=maxaligned(lsize);
                    421:   fsize=maxaligned(fsize);
                    422: }
                    423: 
                    424: void alloc_stacks(ImageHeader * header)
                    425: {
                    426:   header->dict_size=dictsize;
                    427:   header->data_stack_size=dsize;
                    428:   header->fp_stack_size=fsize;
                    429:   header->return_stack_size=rsize;
                    430:   header->locals_stack_size=lsize;
                    431: 
                    432:   header->data_stack_base=my_alloc(dsize);
                    433:   header->fp_stack_base=my_alloc(fsize);
                    434:   header->return_stack_base=my_alloc(rsize);
                    435:   header->locals_stack_base=my_alloc(lsize);
                    436: }
                    437: 
1.44      pazsan    438: #warning You can ignore the warnings about clobbered variables in go_forth
1.11      pazsan    439: int go_forth(Address image, int stack, Cell *entries)
                    440: {
1.38      anton     441:   volatile ImageHeader *image_header = (ImageHeader *)image;
1.18      anton     442:   Cell *sp0=(Cell*)(image_header->data_stack_base + dsize);
1.44      pazsan    443:   Cell *rp0=(Cell *)(image_header->return_stack_base + rsize);
1.18      anton     444:   Float *fp0=(Float *)(image_header->fp_stack_base + fsize);
1.44      pazsan    445: #ifdef GFORTH_DEBUGGING
1.38      anton     446:   volatile Cell *orig_rp0=rp0;
1.44      pazsan    447: #endif
1.18      anton     448:   Address lp0=image_header->locals_stack_base + lsize;
                    449:   Xt *ip0=(Xt *)(image_header->boot_entry);
1.13      pazsan    450: #ifdef SYSSIGNALS
1.11      pazsan    451:   int throw_code;
1.13      pazsan    452: #endif
1.11      pazsan    453: 
                    454:   /* ensure that the cached elements (if any) are accessible */
1.41      anton     455:   IF_spTOS(sp0--);
                    456:   IF_fpTOS(fp0--);
1.11      pazsan    457:   
                    458:   for(;stack>0;stack--)
1.18      anton     459:     *--sp0=entries[stack-1];
1.11      pazsan    460: 
1.30      pazsan    461: #ifdef SYSSIGNALS
1.11      pazsan    462:   get_winsize();
                    463:    
                    464:   install_signal_handlers(); /* right place? */
                    465:   
                    466:   if ((throw_code=setjmp(throw_jmp_buf))) {
                    467:     static Cell signal_data_stack[8];
                    468:     static Cell signal_return_stack[8];
                    469:     static Float signal_fp_stack[1];
1.13      pazsan    470: 
1.11      pazsan    471:     signal_data_stack[7]=throw_code;
1.18      anton     472: 
                    473: #ifdef GFORTH_DEBUGGING
1.38      anton     474:     /* fprintf(stderr,"\nrp=%ld\n",(long)rp); */
                    475:     if (rp <= orig_rp0 && rp > (Cell *)(image_header->return_stack_base+5)) {
1.18      anton     476:       /* no rstack overflow or underflow */
                    477:       rp0 = rp;
1.63      anton     478:       *--rp0 = (Cell)saved_ip;
1.18      anton     479:     }
                    480:     else /* I love non-syntactic ifdefs :-) */
                    481: #endif
                    482:     rp0 = signal_return_stack+8;
1.25      anton     483:     /* fprintf(stderr, "rp=$%x\n",rp0);*/
1.11      pazsan    484:     
1.33      anton     485:     return((int)(Cell)engine(image_header->throw_entry, signal_data_stack+7,
1.18      anton     486:                       rp0, signal_fp_stack, 0));
1.11      pazsan    487:   }
1.13      pazsan    488: #endif
1.11      pazsan    489: 
1.33      anton     490:   return((int)(Cell)engine(ip0,sp0,rp0,fp0,lp0));
1.11      pazsan    491: }
                    492: 
1.30      pazsan    493: #ifndef INCLUDE_IMAGE
1.21      anton     494: void print_sizes(Cell sizebyte)
                    495:      /* print size information */
                    496: {
                    497:   static char* endianstring[]= { "   big","little" };
                    498:   
                    499:   fprintf(stderr,"%s endian, cell=%d bytes, char=%d bytes, au=%d bytes\n",
                    500:          endianstring[sizebyte & 1],
                    501:          1 << ((sizebyte >> 1) & 3),
                    502:          1 << ((sizebyte >> 3) & 3),
                    503:          1 << ((sizebyte >> 5) & 3));
                    504: }
                    505: 
1.70      anton     506: #define MAX_IMMARGS 2
                    507: 
1.69      anton     508: #ifndef NO_DYNAMIC
1.47      anton     509: typedef struct {
                    510:   Label start;
1.74      anton     511:   Cell length; /* only includes the jump iff superend is true*/
                    512:   Cell restlength; /* length of the rest (i.e., the jump or (on superend) 0) */
1.70      anton     513:   char superend; /* true if primitive ends superinstruction, i.e.,
1.47      anton     514:                      unconditional branch, execute, etc. */
1.70      anton     515:   Cell nimmargs;
                    516:   struct immarg {
                    517:     Cell offset; /* offset of immarg within prim */
                    518:     char rel;    /* true if immarg is relative */
                    519:   } immargs[MAX_IMMARGS];
1.47      anton     520: } PrimInfo;
                    521: 
                    522: PrimInfo *priminfos;
1.76      anton     523: PrimInfo **decomp_prims;
                    524: 
                    525: int compare_priminfo_length(PrimInfo **a, PrimInfo **b)
                    526: {
1.77      anton     527:   Cell diff = (*a)->length - (*b)->length;
                    528:   if (diff)
                    529:     return diff;
                    530:   else /* break ties by start address; thus the decompiler produces
                    531:           the earliest primitive with the same code (e.g. noop instead
                    532:           of (char) and @ instead of >code-address */
                    533:     return (*b)->start - (*a)->start;
1.76      anton     534: }
                    535: 
1.69      anton     536: #endif /* defined(NO_DYNAMIC) */
1.48      anton     537: Cell npriminfos=0;
1.47      anton     538: 
1.76      anton     539: 
1.47      anton     540: void check_prims(Label symbols1[])
                    541: {
                    542:   int i;
1.70      anton     543:   Label *symbols2, *symbols3, *ends1;
1.49      anton     544:   static char superend[]={
1.48      anton     545: #include "prim_superend.i"
                    546:   };
1.47      anton     547: 
1.66      anton     548:   if (debug)
                    549: #ifdef __VERSION__
                    550:     fprintf(stderr, "Compiled with gcc-" __VERSION__ "\n");
                    551: #else
                    552: #define xstr(s) str(s)
                    553: #define str(s) #s
                    554:   fprintf(stderr, "Compiled with gcc-" xstr(__GNUC__) "." xstr(__GNUC_MINOR__) "\n"); 
                    555: #endif
1.47      anton     556:   for (i=DOESJUMP+1; symbols1[i+1]!=0; i++)
                    557:     ;
1.55      anton     558:   npriminfos = i;
1.70      anton     559:   
                    560: #ifndef NO_DYNAMIC
1.66      anton     561:   if (no_dynamic)
                    562:     return;
1.55      anton     563:   symbols2=engine2(0,0,0,0,0);
1.70      anton     564: #if NO_IP
                    565:   symbols3=engine3(0,0,0,0,0);
                    566: #else
                    567:   symbols3=symbols1;
                    568: #endif
                    569:   ends1 = symbols1+i+1-DOESJUMP;
1.47      anton     570:   priminfos = calloc(i,sizeof(PrimInfo));
                    571:   for (i=DOESJUMP+1; symbols1[i+1]!=0; i++) {
1.70      anton     572:     int prim_len = ends1[i]-symbols1[i];
1.47      anton     573:     PrimInfo *pi=&priminfos[i];
1.70      anton     574:     int j=0;
                    575:     char *s1 = (char *)symbols1[i];
                    576:     char *s2 = (char *)symbols2[i];
                    577:     char *s3 = (char *)symbols3[i];
                    578: 
                    579:     pi->start = s1;
                    580:     pi->superend = superend[i-DOESJUMP-1]|no_super;
                    581:     if (pi->superend)
                    582:       pi->length = symbols1[i+1]-symbols1[i];
                    583:     else
                    584:       pi->length = prim_len;
1.74      anton     585:     pi->restlength = symbols1[i+1] - symbols1[i] - pi->length;
1.70      anton     586:     pi->nimmargs = 0;
                    587:     if (debug)
1.74      anton     588:       fprintf(stderr, "Prim %3d @ %p %p %p, length=%3d restlength=%2d superend=%1d",
                    589:              i, s1, s2, s3, pi->length, pi->restlength, pi->superend);
1.70      anton     590:     assert(prim_len>=0);
1.74      anton     591:     while (j<(pi->length+pi->restlength)) {
1.70      anton     592:       if (s1[j]==s3[j]) {
                    593:        if (s1[j] != s2[j]) {
                    594:          pi->start = NULL; /* not relocatable */
                    595:          if (debug)
                    596:            fprintf(stderr,"\n   non_reloc: engine1!=engine2 offset %3d",j);
1.74      anton     597:          /* assert(j<prim_len); */
1.70      anton     598:          break;
                    599:        }
                    600:        j++;
                    601:       } else {
                    602:        struct immarg *ia=&pi->immargs[pi->nimmargs];
                    603: 
                    604:        pi->nimmargs++;
                    605:        ia->offset=j;
                    606:        if ((~*(Cell *)&(s1[j]))==*(Cell *)&(s3[j])) {
                    607:          ia->rel=0;
                    608:          if (debug)
                    609:            fprintf(stderr,"\n   absolute immarg: offset %3d",j);
                    610:        } else if ((&(s1[j]))+(*(Cell *)&(s1[j]))+4 ==
                    611:                   symbols1[DOESJUMP+1]) {
                    612:          ia->rel=1;
                    613:          if (debug)
                    614:            fprintf(stderr,"\n   relative immarg: offset %3d",j);
                    615:        } else {
                    616:          pi->start = NULL; /* not relocatable */
                    617:          if (debug)
                    618:            fprintf(stderr,"\n   non_reloc: engine1!=engine3 offset %3d",j);
1.74      anton     619:          /* assert(j<prim_len);*/
1.70      anton     620:          break;
                    621:        }
                    622:        j+=4;
1.47      anton     623:       }
                    624:     }
1.70      anton     625:     if (debug)
                    626:       fprintf(stderr,"\n");
                    627:   }
1.76      anton     628:   decomp_prims = calloc(i,sizeof(PrimInfo *));
                    629:   for (i=DOESJUMP+1; i<npriminfos; i++)
                    630:     decomp_prims[i] = &(priminfos[i]);
                    631:   qsort(decomp_prims+DOESJUMP+1, npriminfos-DOESJUMP-1, sizeof(PrimInfo *),
                    632:        compare_priminfo_length);
1.70      anton     633: #endif
                    634: }
                    635: 
1.74      anton     636: #ifndef NO_DYNAMIC
                    637: void flush_to_here(void)
                    638: {
                    639:   FLUSH_ICACHE(start_flush, code_here-start_flush);
                    640:   start_flush=code_here;
                    641: }
                    642: 
                    643: void append_jump(void)
                    644: {
                    645:   if (last_jump) {
                    646:     PrimInfo *pi = &priminfos[last_jump];
                    647:     
                    648:     memcpy(code_here, pi->start+pi->length, pi->restlength);
                    649:     code_here += pi->restlength;
                    650:     last_jump=0;
                    651:     flush_to_here();
                    652:   }
                    653: }
                    654: 
1.75      anton     655: /* Gforth remembers all code blocks in this list.  On forgetting (by
                    656: executing a marker) the code blocks are not freed (because Gforth does
                    657: not remember how they were allocated; hmm, remembering that might be
                    658: easier and cleaner).  Instead, code_here etc. are reset to the old
                    659: value, and the "forgotten" code blocks are reused when they are
                    660: needed. */
                    661: 
                    662: struct code_block_list {
                    663:   struct code_block_list *next;
                    664:   Address block;
                    665:   Cell size;
                    666: } *code_block_list=NULL, **next_code_blockp=&code_block_list;
                    667: 
1.74      anton     668: Address append_prim(Cell p)
                    669: {
                    670:   PrimInfo *pi = &priminfos[p];
                    671:   Address old_code_here = code_here;
                    672: 
                    673:   if (code_area+code_area_size < code_here+pi->length+pi->restlength) {
1.75      anton     674:     struct code_block_list *p;
1.74      anton     675:     append_jump();
1.75      anton     676:     if (*next_code_blockp == NULL) {
                    677:       code_here = start_flush = code_area = my_alloc(code_area_size);
                    678:       p = (struct code_block_list *)malloc(sizeof(struct code_block_list));
                    679:       *next_code_blockp = p;
                    680:       p->next = NULL;
                    681:       p->block = code_here;
                    682:       p->size = code_area_size;
                    683:     } else {
                    684:       p = *next_code_blockp;
                    685:       code_here = start_flush = code_area = p->block;
                    686:     }
1.74      anton     687:     old_code_here = code_here;
1.75      anton     688:     next_code_blockp = &(p->next);
1.74      anton     689:   }
                    690:   memcpy(code_here, pi->start, pi->length);
                    691:   code_here += pi->length;
                    692:   if (pi->superend)
                    693:     flush_to_here();
                    694:   return old_code_here;
                    695: }
                    696: #endif
1.75      anton     697: 
                    698: int forget_dyncode(Address code)
                    699: {
                    700: #ifdef NO_DYNAMIC
                    701:   return -1;
                    702: #else
                    703:   struct code_block_list *p, **pp;
                    704: 
                    705:   for (pp=&code_block_list, p=*pp; p!=NULL; pp=&(p->next), p=*pp) {
                    706:     if (code >= p->block && code < p->block+p->size) {
                    707:       next_code_blockp = &(p->next);
                    708:       code_here = start_flush = code;
                    709:       code_area = p->block;
                    710:       last_jump = 0;
                    711:       return -1;
                    712:     }
                    713:   }
1.78      anton     714:   return -no_dynamic;
1.75      anton     715: #endif /* !defined(NO_DYNAMIC) */
                    716: }
                    717: 
1.76      anton     718: Label decompile_code(Label code)
1.75      anton     719: {
1.88    ! pazsan    720: #ifdef DIRECT_THREADED
        !           721:   if((code >= (Cell)vm_prims) && (code < (Cell)(vm_prims+npriminfos)))
        !           722:     return *(Label *)code;
        !           723: #endif
1.76      anton     724: #ifdef NO_DYNAMIC
                    725:   return code;
                    726: #else /* !defined(NO_DYNAMIC) */
                    727:   Cell i;
1.77      anton     728:   struct code_block_list *p;
1.76      anton     729: 
1.77      anton     730:   /* first, check if we are in code at all */
                    731:   for (p = code_block_list;; p = p->next) {
                    732:     if (p == NULL)
                    733:       return code;
                    734:     if (code >= p->block && code < p->block+p->size)
                    735:       break;
                    736:   }
1.76      anton     737:   /* reverse order because NOOP might match other prims */
                    738:   for (i=npriminfos-1; i>DOESJUMP; i--) {
                    739:     PrimInfo *pi=decomp_prims[i];
                    740:     if (pi->start==code || (pi->start && memcmp(code,pi->start,pi->length)==0))
                    741:       return pi->start;
                    742:   }
                    743:   return code;
                    744: #endif /* !defined(NO_DYNAMIC) */
1.75      anton     745: }
1.74      anton     746: 
1.70      anton     747: #ifdef NO_IP
                    748: int nbranchinfos=0;
                    749: 
                    750: struct branchinfo {
                    751:   Label *targetptr; /* *(bi->targetptr) is the target */
                    752:   Cell *addressptr; /* store the target here */
                    753: } branchinfos[100000];
                    754: 
                    755: int ndoesexecinfos=0;
                    756: struct doesexecinfo {
                    757:   int branchinfo; /* fix the targetptr of branchinfos[...->branchinfo] */
                    758:   Cell *xt; /* cfa of word whose does-code needs calling */
                    759: } doesexecinfos[10000];
                    760: 
1.73      anton     761: /* definitions of N_execute etc. */
                    762: #include "prim_num.i"
1.70      anton     763: 
                    764: void set_rel_target(Cell *source, Label target)
                    765: {
                    766:   *source = ((Cell)target)-(((Cell)source)+4);
                    767: }
                    768: 
                    769: void register_branchinfo(Label source, Cell targetptr)
                    770: {
                    771:   struct branchinfo *bi = &(branchinfos[nbranchinfos]);
                    772:   bi->targetptr = (Label *)targetptr;
                    773:   bi->addressptr = (Cell *)source;
                    774:   nbranchinfos++;
                    775: }
                    776: 
                    777: Cell *compile_prim1arg(Cell p)
                    778: {
                    779:   int l = priminfos[p].length;
                    780:   Address old_code_here=code_here;
                    781: 
1.74      anton     782:   assert(vm_prims[p]==priminfos[p].start);
                    783:   append_prim(p);
1.70      anton     784:   return (Cell*)(old_code_here+priminfos[p].immargs[0].offset);
                    785: }
                    786: 
                    787: Cell *compile_call2(Cell targetptr)
                    788: {
                    789:   Cell *next_code_target;
1.73      anton     790:   PrimInfo *pi = &priminfos[N_call2];
1.74      anton     791:   Address old_code_here = append_prim(N_call2);
1.70      anton     792: 
1.74      anton     793:   next_code_target = (Cell *)(old_code_here + pi->immargs[0].offset);
                    794:   register_branchinfo(old_code_here + pi->immargs[1].offset, targetptr);
1.70      anton     795:   return next_code_target;
                    796: }
                    797: #endif
                    798: 
                    799: void finish_code(void)
                    800: {
                    801: #ifdef NO_IP
                    802:   Cell i;
                    803: 
                    804:   compile_prim1(NULL);
                    805:   for (i=0; i<ndoesexecinfos; i++) {
                    806:     struct doesexecinfo *dei = &doesexecinfos[i];
                    807:     branchinfos[dei->branchinfo].targetptr = DOES_CODE1((dei->xt));
                    808:   }
                    809:   ndoesexecinfos = 0;
                    810:   for (i=0; i<nbranchinfos; i++) {
                    811:     struct branchinfo *bi=&branchinfos[i];
                    812:     set_rel_target(bi->addressptr, *(bi->targetptr));
                    813:   }
                    814:   nbranchinfos = 0;
                    815:   FLUSH_ICACHE(start_flush, code_here-start_flush);
                    816:   start_flush=code_here;
1.48      anton     817: #endif
                    818: }
                    819: 
1.70      anton     820: void compile_prim1(Cell *start)
1.48      anton     821: {
1.61      anton     822: #if defined(DOUBLY_INDIRECT)
1.70      anton     823:   Label prim=(Label)*start;
1.54      anton     824:   if (prim<((Label)(xts+DOESJUMP)) || prim>((Label)(xts+npriminfos))) {
                    825:     fprintf(stderr,"compile_prim encountered xt %p\n", prim);
1.70      anton     826:     *start=(Cell)prim;
                    827:     return;
                    828:   } else {
                    829:     *start = prim-((Label)xts)+((Label)vm_prims);
                    830:     return;
                    831:   }
                    832: #elif defined(NO_IP)
                    833:   static Cell *last_start=NULL;
                    834:   static Xt last_prim=NULL;
                    835:   /* delay work by one call in order to get relocated immargs */
                    836: 
                    837:   if (last_start) {
                    838:     unsigned i = last_prim-vm_prims;
                    839:     PrimInfo *pi=&priminfos[i];
                    840:     Cell *next_code_target=NULL;
                    841: 
                    842:     assert(i<npriminfos);
1.73      anton     843:     if (i==N_execute||i==N_perform||i==N_lit_perform) {
                    844:       next_code_target = compile_prim1arg(N_set_next_code);
1.70      anton     845:     }
1.73      anton     846:     if (i==N_call) {
1.70      anton     847:       next_code_target = compile_call2(last_start[1]);
1.73      anton     848:     } else if (i==N_does_exec) {
1.70      anton     849:       struct doesexecinfo *dei = &doesexecinfos[ndoesexecinfos++];
1.73      anton     850:       *compile_prim1arg(N_lit) = (Cell)PFA(last_start[1]);
1.70      anton     851:       /* we cannot determine the callee now (last_start[1] may be a
                    852:          forward reference), so just register an arbitrary target, and
                    853:          register in dei that we need to fix this before resolving
                    854:          branches */
                    855:       dei->branchinfo = nbranchinfos;
                    856:       dei->xt = (Cell *)(last_start[1]);
                    857:       next_code_target = compile_call2(NULL);
                    858:     } else if (pi->start == NULL) { /* non-reloc */
1.73      anton     859:       next_code_target = compile_prim1arg(N_set_next_code);
                    860:       set_rel_target(compile_prim1arg(N_abranch),*(Xt)last_prim);
1.70      anton     861:     } else {
                    862:       unsigned j;
1.74      anton     863:       Address old_code_here = append_prim(i);
1.70      anton     864: 
                    865:       for (j=0; j<pi->nimmargs; j++) {
                    866:        struct immarg *ia = &(pi->immargs[j]);
                    867:        Cell argval = last_start[pi->nimmargs - j]; /* !! specific to prims */
                    868:        if (ia->rel) { /* !! assumption: relative refs are branches */
1.74      anton     869:          register_branchinfo(old_code_here + ia->offset, argval);
1.70      anton     870:        } else /* plain argument */
1.74      anton     871:          *(Cell *)(old_code_here + ia->offset) = argval;
1.70      anton     872:       }
                    873:     }
                    874:     if (next_code_target!=NULL)
                    875:       *next_code_target = (Cell)code_here;
                    876:   }
                    877:   if (start) {
                    878:     last_prim = (Xt)*start;
                    879:     *start = (Cell)code_here;
                    880:   }
                    881:   last_start = start;
                    882:   return;
                    883: #elif !defined(NO_DYNAMIC)
                    884:   Label prim=(Label)*start;
1.58      anton     885:   unsigned i;
1.74      anton     886:   Address old_code_here;
1.48      anton     887: 
1.58      anton     888:   i = ((Xt)prim)-vm_prims;
1.56      anton     889:   prim = *(Xt)prim;
1.70      anton     890:   if (no_dynamic) {
                    891:     *start = (Cell)prim;
                    892:     return;
                    893:   }
1.58      anton     894:   if (i>=npriminfos || priminfos[i].start == 0) { /* not a relocatable prim */
1.74      anton     895:     append_jump();
1.70      anton     896:     *start = (Cell)prim;
                    897:     return;
1.47      anton     898:   }
1.58      anton     899:   assert(priminfos[i].start = prim); 
1.50      anton     900: #ifdef ALIGN_CODE
1.87      anton     901:   /*  ALIGN_CODE;*/
1.50      anton     902: #endif
1.74      anton     903:   assert(prim==priminfos[i].start);
                    904:   old_code_here = append_prim(i);
                    905:   last_jump = (priminfos[i].superend) ? 0 : i;
1.70      anton     906:   *start = (Cell)old_code_here;
                    907:   return;
1.61      anton     908: #else /* !defined(DOUBLY_INDIRECT), no code replication */
1.70      anton     909:   Label prim=(Label)*start;
1.61      anton     910: #if !defined(INDIRECT_THREADED)
1.56      anton     911:   prim = *(Xt)prim;
1.61      anton     912: #endif
1.70      anton     913:   *start = (Cell)prim;
                    914:   return;
1.54      anton     915: #endif /* !defined(DOUBLY_INDIRECT) */
1.70      anton     916: }
                    917: 
                    918: Label compile_prim(Label prim)
                    919: {
                    920:   Cell x=(Cell)prim;
1.80      anton     921:   assert(0);
1.70      anton     922:   compile_prim1(&x);
                    923:   return (Label)x;
1.47      anton     924: }
                    925: 
1.69      anton     926: #if defined(PRINT_SUPER_LENGTHS) && !defined(NO_DYNAMIC)
1.59      anton     927: Cell prim_length(Cell prim)
                    928: {
                    929:   return priminfos[prim+DOESJUMP+1].length;
                    930: }
                    931: #endif
                    932: 
1.1       anton     933: Address loader(FILE *imagefile, char* filename)
                    934: /* returns the address of the image proper (after the preamble) */
                    935: {
                    936:   ImageHeader header;
                    937:   Address image;
                    938:   Address imp; /* image+preamble */
1.17      anton     939:   Char magic[8];
                    940:   char magic7; /* size byte of magic number */
1.1       anton     941:   Cell preamblesize=0;
1.6       pazsan    942:   Cell data_offset = offset_image ? 56*sizeof(Cell) : 0;
1.1       anton     943:   UCell check_sum;
1.15      pazsan    944:   Cell ausize = ((RELINFOBITS ==  8) ? 0 :
                    945:                 (RELINFOBITS == 16) ? 1 :
                    946:                 (RELINFOBITS == 32) ? 2 : 3);
                    947:   Cell charsize = ((sizeof(Char) == 1) ? 0 :
                    948:                   (sizeof(Char) == 2) ? 1 :
                    949:                   (sizeof(Char) == 4) ? 2 : 3) + ausize;
                    950:   Cell cellsize = ((sizeof(Cell) == 1) ? 0 :
                    951:                   (sizeof(Cell) == 2) ? 1 :
                    952:                   (sizeof(Cell) == 4) ? 2 : 3) + ausize;
1.21      anton     953:   Cell sizebyte = (ausize << 5) + (charsize << 3) + (cellsize << 1) +
                    954: #ifdef WORDS_BIGENDIAN
                    955:        0
                    956: #else
                    957:        1
                    958: #endif
                    959:     ;
1.1       anton     960: 
1.43      anton     961:   vm_prims = engine(0,0,0,0,0);
1.47      anton     962:   check_prims(vm_prims);
1.1       anton     963: #ifndef DOUBLY_INDIRECT
1.59      anton     964: #ifdef PRINT_SUPER_LENGTHS
                    965:   print_super_lengths();
                    966: #endif
1.43      anton     967:   check_sum = checksum(vm_prims);
1.1       anton     968: #else /* defined(DOUBLY_INDIRECT) */
1.43      anton     969:   check_sum = (UCell)vm_prims;
1.1       anton     970: #endif /* defined(DOUBLY_INDIRECT) */
1.10      pazsan    971:   
                    972:   do {
                    973:     if(fread(magic,sizeof(Char),8,imagefile) < 8) {
1.84      anton     974:       fprintf(stderr,"%s: image %s doesn't seem to be a Gforth (>=0.6) image.\n",
1.10      pazsan    975:              progname, filename);
                    976:       exit(1);
1.1       anton     977:     }
1.10      pazsan    978:     preamblesize+=8;
1.84      anton     979:   } while(memcmp(magic,"Gforth3",7));
1.17      anton     980:   magic7 = magic[7];
1.1       anton     981:   if (debug) {
1.17      anton     982:     magic[7]='\0';
1.21      anton     983:     fprintf(stderr,"Magic found: %s ", magic);
                    984:     print_sizes(magic7);
1.1       anton     985:   }
                    986: 
1.21      anton     987:   if (magic7 != sizebyte)
                    988:     {
                    989:       fprintf(stderr,"This image is:         ");
                    990:       print_sizes(magic7);
                    991:       fprintf(stderr,"whereas the machine is ");
                    992:       print_sizes(sizebyte);
1.1       anton     993:       exit(-2);
                    994:     };
                    995: 
                    996:   fread((void *)&header,sizeof(ImageHeader),1,imagefile);
1.10      pazsan    997: 
                    998:   set_stack_sizes(&header);
1.1       anton     999:   
                   1000: #if HAVE_GETPAGESIZE
                   1001:   pagesize=getpagesize(); /* Linux/GNU libc offers this */
                   1002: #elif HAVE_SYSCONF && defined(_SC_PAGESIZE)
                   1003:   pagesize=sysconf(_SC_PAGESIZE); /* POSIX.4 */
                   1004: #elif PAGESIZE
                   1005:   pagesize=PAGESIZE; /* in limits.h according to Gallmeister's POSIX.4 book */
                   1006: #endif
                   1007:   if (debug)
1.5       jwilke   1008:     fprintf(stderr,"pagesize=%ld\n",(unsigned long) pagesize);
1.1       anton    1009: 
1.34      anton    1010:   image = dict_alloc_read(imagefile, preamblesize+header.image_size,
                   1011:                          preamblesize+dictsize, data_offset);
1.33      anton    1012:   imp=image+preamblesize;
1.57      anton    1013:   alloc_stacks((ImageHeader *)imp);
1.1       anton    1014:   if (clear_dictionary)
1.33      anton    1015:     memset(imp+header.image_size, 0, dictsize-header.image_size);
1.46      jwilke   1016:   if(header.base==0 || header.base  == 0x100) {
1.1       anton    1017:     Cell reloc_size=((header.image_size-1)/sizeof(Cell))/8+1;
                   1018:     char reloc_bits[reloc_size];
1.33      anton    1019:     fseek(imagefile, preamblesize+header.image_size, SEEK_SET);
1.10      pazsan   1020:     fread(reloc_bits, 1, reloc_size, imagefile);
1.45      jwilke   1021:     relocate((Cell *)imp, reloc_bits, header.image_size, header.base, vm_prims);
1.1       anton    1022: #if 0
                   1023:     { /* let's see what the relocator did */
                   1024:       FILE *snapshot=fopen("snapshot.fi","wb");
                   1025:       fwrite(image,1,imagesize,snapshot);
                   1026:       fclose(snapshot);
                   1027:     }
                   1028: #endif
1.46      jwilke   1029:   }
                   1030:   else if(header.base!=imp) {
                   1031:     fprintf(stderr,"%s: Cannot load nonrelocatable image (compiled for address $%lx) at address $%lx\n",
                   1032:            progname, (unsigned long)header.base, (unsigned long)imp);
                   1033:     exit(1);
1.1       anton    1034:   }
                   1035:   if (header.checksum==0)
                   1036:     ((ImageHeader *)imp)->checksum=check_sum;
                   1037:   else if (header.checksum != check_sum) {
                   1038:     fprintf(stderr,"%s: Checksum of image ($%lx) does not match the executable ($%lx)\n",
                   1039:            progname, (unsigned long)(header.checksum),(unsigned long)check_sum);
                   1040:     exit(1);
                   1041:   }
1.53      anton    1042: #ifdef DOUBLY_INDIRECT
                   1043:   ((ImageHeader *)imp)->xt_base = xts;
                   1044: #endif
1.1       anton    1045:   fclose(imagefile);
                   1046: 
1.56      anton    1047:   /* unnecessary, except maybe for CODE words */
                   1048:   /* FLUSH_ICACHE(imp, header.image_size);*/
1.1       anton    1049: 
                   1050:   return imp;
                   1051: }
                   1052: 
1.72      anton    1053: /* pointer to last '/' or '\' in file, 0 if there is none. */
                   1054: char *onlypath(char *filename)
1.10      pazsan   1055: {
1.72      anton    1056:   return strrchr(filename, DIRSEP);
1.1       anton    1057: }
                   1058: 
                   1059: FILE *openimage(char *fullfilename)
1.10      pazsan   1060: {
                   1061:   FILE *image_file;
1.28      anton    1062:   char * expfilename = tilde_cstr(fullfilename, strlen(fullfilename), 1);
1.10      pazsan   1063: 
1.28      anton    1064:   image_file=fopen(expfilename,"rb");
1.1       anton    1065:   if (image_file!=NULL && debug)
1.28      anton    1066:     fprintf(stderr, "Opened image file: %s\n", expfilename);
1.10      pazsan   1067:   return image_file;
1.1       anton    1068: }
                   1069: 
1.28      anton    1070: /* try to open image file concat(path[0:len],imagename) */
1.1       anton    1071: FILE *checkimage(char *path, int len, char *imagename)
1.10      pazsan   1072: {
                   1073:   int dirlen=len;
1.1       anton    1074:   char fullfilename[dirlen+strlen(imagename)+2];
1.10      pazsan   1075: 
1.1       anton    1076:   memcpy(fullfilename, path, dirlen);
1.71      pazsan   1077:   if (fullfilename[dirlen-1]!=DIRSEP)
                   1078:     fullfilename[dirlen++]=DIRSEP;
1.1       anton    1079:   strcpy(fullfilename+dirlen,imagename);
1.10      pazsan   1080:   return openimage(fullfilename);
1.1       anton    1081: }
                   1082: 
1.10      pazsan   1083: FILE * open_image_file(char * imagename, char * path)
1.1       anton    1084: {
1.10      pazsan   1085:   FILE * image_file=NULL;
1.28      anton    1086:   char *origpath=path;
1.10      pazsan   1087:   
1.71      pazsan   1088:   if(strchr(imagename, DIRSEP)==NULL) {
1.10      pazsan   1089:     /* first check the directory where the exe file is in !! 01may97jaw */
                   1090:     if (onlypath(progname))
1.72      anton    1091:       image_file=checkimage(progname, onlypath(progname)-progname, imagename);
1.10      pazsan   1092:     if (!image_file)
                   1093:       do {
                   1094:        char *pend=strchr(path, PATHSEP);
                   1095:        if (pend==NULL)
                   1096:          pend=path+strlen(path);
                   1097:        if (strlen(path)==0) break;
                   1098:        image_file=checkimage(path, pend-path, imagename);
                   1099:        path=pend+(*pend==PATHSEP);
                   1100:       } while (image_file==NULL);
                   1101:   } else {
                   1102:     image_file=openimage(imagename);
                   1103:   }
1.1       anton    1104: 
1.10      pazsan   1105:   if (!image_file) {
                   1106:     fprintf(stderr,"%s: cannot open image file %s in path %s for reading\n",
1.28      anton    1107:            progname, imagename, origpath);
1.10      pazsan   1108:     exit(1);
1.7       anton    1109:   }
                   1110: 
1.10      pazsan   1111:   return image_file;
                   1112: }
1.11      pazsan   1113: #endif
                   1114: 
                   1115: #ifdef HAS_OS
                   1116: UCell convsize(char *s, UCell elemsize)
                   1117: /* converts s of the format [0-9]+[bekMGT]? (e.g. 25k) into the number
                   1118:    of bytes.  the letter at the end indicates the unit, where e stands
                   1119:    for the element size. default is e */
                   1120: {
                   1121:   char *endp;
                   1122:   UCell n,m;
                   1123: 
                   1124:   m = elemsize;
                   1125:   n = strtoul(s,&endp,0);
                   1126:   if (endp!=NULL) {
                   1127:     if (strcmp(endp,"b")==0)
                   1128:       m=1;
                   1129:     else if (strcmp(endp,"k")==0)
                   1130:       m=1024;
                   1131:     else if (strcmp(endp,"M")==0)
                   1132:       m=1024*1024;
                   1133:     else if (strcmp(endp,"G")==0)
                   1134:       m=1024*1024*1024;
                   1135:     else if (strcmp(endp,"T")==0) {
                   1136: #if (SIZEOF_CHAR_P > 4)
1.24      anton    1137:       m=1024L*1024*1024*1024;
1.11      pazsan   1138: #else
                   1139:       fprintf(stderr,"%s: size specification \"%s\" too large for this machine\n", progname, endp);
                   1140:       exit(1);
                   1141: #endif
                   1142:     } else if (strcmp(endp,"e")!=0 && strcmp(endp,"")!=0) {
                   1143:       fprintf(stderr,"%s: cannot grok size specification %s: invalid unit \"%s\"\n", progname, s, endp);
                   1144:       exit(1);
                   1145:     }
                   1146:   }
                   1147:   return n*m;
                   1148: }
1.10      pazsan   1149: 
                   1150: void gforth_args(int argc, char ** argv, char ** path, char ** imagename)
                   1151: {
                   1152:   int c;
                   1153: 
1.1       anton    1154:   opterr=0;
                   1155:   while (1) {
                   1156:     int option_index=0;
                   1157:     static struct option opts[] = {
1.29      anton    1158:       {"appl-image", required_argument, NULL, 'a'},
1.1       anton    1159:       {"image-file", required_argument, NULL, 'i'},
                   1160:       {"dictionary-size", required_argument, NULL, 'm'},
                   1161:       {"data-stack-size", required_argument, NULL, 'd'},
                   1162:       {"return-stack-size", required_argument, NULL, 'r'},
                   1163:       {"fp-stack-size", required_argument, NULL, 'f'},
                   1164:       {"locals-stack-size", required_argument, NULL, 'l'},
                   1165:       {"path", required_argument, NULL, 'p'},
                   1166:       {"version", no_argument, NULL, 'v'},
                   1167:       {"help", no_argument, NULL, 'h'},
                   1168:       /* put something != 0 into offset_image */
                   1169:       {"offset-image", no_argument, &offset_image, 1},
                   1170:       {"no-offset-im", no_argument, &offset_image, 0},
                   1171:       {"clear-dictionary", no_argument, &clear_dictionary, 1},
1.4       anton    1172:       {"die-on-signal", no_argument, &die_on_signal, 1},
1.1       anton    1173:       {"debug", no_argument, &debug, 1},
1.60      anton    1174:       {"no-super", no_argument, &no_super, 1},
                   1175:       {"no-dynamic", no_argument, &no_dynamic, 1},
1.66      anton    1176:       {"dynamic", no_argument, &no_dynamic, 0},
1.1       anton    1177:       {0,0,0,0}
                   1178:       /* no-init-file, no-rc? */
                   1179:     };
                   1180:     
1.36      pazsan   1181:     c = getopt_long(argc, argv, "+i:m:d:r:f:l:p:vhoncsx", opts, &option_index);
1.1       anton    1182:     
                   1183:     switch (c) {
1.29      anton    1184:     case EOF: return;
                   1185:     case '?': optind--; return;
                   1186:     case 'a': *imagename = optarg; return;
1.10      pazsan   1187:     case 'i': *imagename = optarg; break;
1.1       anton    1188:     case 'm': dictsize = convsize(optarg,sizeof(Cell)); break;
                   1189:     case 'd': dsize = convsize(optarg,sizeof(Cell)); break;
                   1190:     case 'r': rsize = convsize(optarg,sizeof(Cell)); break;
                   1191:     case 'f': fsize = convsize(optarg,sizeof(Float)); break;
                   1192:     case 'l': lsize = convsize(optarg,sizeof(Cell)); break;
1.10      pazsan   1193:     case 'p': *path = optarg; break;
1.36      pazsan   1194:     case 'o': offset_image = 1; break;
                   1195:     case 'n': offset_image = 0; break;
                   1196:     case 'c': clear_dictionary = 1; break;
                   1197:     case 's': die_on_signal = 1; break;
                   1198:     case 'x': debug = 1; break;
1.83      anton    1199:     case 'v': fputs(PACKAGE_STRING"\n", stderr); exit(0);
1.1       anton    1200:     case 'h': 
1.29      anton    1201:       fprintf(stderr, "Usage: %s [engine options] ['--'] [image arguments]\n\
1.1       anton    1202: Engine Options:\n\
1.29      anton    1203:   --appl-image FILE                equivalent to '--image-file=FILE --'\n\
1.10      pazsan   1204:   --clear-dictionary               Initialize the dictionary with 0 bytes\n\
                   1205:   -d SIZE, --data-stack-size=SIZE   Specify data stack size\n\
                   1206:   --debug                          Print debugging information during startup\n\
                   1207:   --die-on-signal                  exit instead of CATCHing some signals\n\
1.66      anton    1208:   --dynamic                        use dynamic native code\n\
1.10      pazsan   1209:   -f SIZE, --fp-stack-size=SIZE            Specify floating point stack size\n\
                   1210:   -h, --help                       Print this message and exit\n\
                   1211:   -i FILE, --image-file=FILE       Use image FILE instead of `gforth.fi'\n\
                   1212:   -l SIZE, --locals-stack-size=SIZE Specify locals stack size\n\
                   1213:   -m SIZE, --dictionary-size=SIZE   Specify Forth dictionary size\n\
1.60      anton    1214:   --no-dynamic                     Use only statically compiled primitives\n\
1.10      pazsan   1215:   --no-offset-im                   Load image at normal position\n\
1.60      anton    1216:   --no-super                        No dynamically formed superinstructions\n\
1.10      pazsan   1217:   --offset-image                   Load image at a different position\n\
                   1218:   -p PATH, --path=PATH             Search path for finding image and sources\n\
                   1219:   -r SIZE, --return-stack-size=SIZE Specify return stack size\n\
1.66      anton    1220:   -v, --version                            Print engine version and exit\n\
1.1       anton    1221: SIZE arguments consist of an integer followed by a unit. The unit can be\n\
1.10      pazsan   1222:   `b' (byte), `e' (element; default), `k' (KB), `M' (MB), `G' (GB) or `T' (TB).\n",
                   1223:              argv[0]);
                   1224:       optind--;
                   1225:       return;
1.1       anton    1226:     }
                   1227:   }
1.10      pazsan   1228: }
1.11      pazsan   1229: #endif
1.10      pazsan   1230: 
                   1231: #ifdef INCLUDE_IMAGE
                   1232: extern Cell image[];
                   1233: extern const char reloc_bits[];
                   1234: #endif
1.67      pazsan   1235: 
1.10      pazsan   1236: int main(int argc, char **argv, char **env)
                   1237: {
1.30      pazsan   1238: #ifdef HAS_OS
1.10      pazsan   1239:   char *path = getenv("GFORTHPATH") ? : DEFAULTPATH;
1.30      pazsan   1240: #else
                   1241:   char *path = DEFAULTPATH;
                   1242: #endif
1.13      pazsan   1243: #ifndef INCLUDE_IMAGE
1.10      pazsan   1244:   char *imagename="gforth.fi";
                   1245:   FILE *image_file;
                   1246:   Address image;
                   1247: #endif
                   1248:   int retvalue;
                   1249:          
1.56      anton    1250: #if defined(i386) && defined(ALIGNMENT_CHECK)
1.10      pazsan   1251:   /* turn on alignment checks on the 486.
                   1252:    * on the 386 this should have no effect. */
                   1253:   __asm__("pushfl; popl %eax; orl $0x40000, %eax; pushl %eax; popfl;");
                   1254:   /* this is unusable with Linux' libc.4.6.27, because this library is
                   1255:      not alignment-clean; we would have to replace some library
                   1256:      functions (e.g., memcpy) to make it work. Also GCC doesn't try to keep
                   1257:      the stack FP-aligned. */
                   1258: #endif
                   1259: 
                   1260:   /* buffering of the user output device */
1.11      pazsan   1261: #ifdef _IONBF
1.10      pazsan   1262:   if (isatty(fileno(stdout))) {
                   1263:     fflush(stdout);
                   1264:     setvbuf(stdout,NULL,_IONBF,0);
1.1       anton    1265:   }
1.11      pazsan   1266: #endif
1.1       anton    1267: 
1.10      pazsan   1268:   progname = argv[0];
                   1269: 
1.11      pazsan   1270: #ifdef HAS_OS
1.10      pazsan   1271:   gforth_args(argc, argv, &path, &imagename);
1.11      pazsan   1272: #endif
1.10      pazsan   1273: 
                   1274: #ifdef INCLUDE_IMAGE
                   1275:   set_stack_sizes((ImageHeader *)image);
1.22      pazsan   1276:   if(((ImageHeader *)image)->base != image)
                   1277:     relocate(image, reloc_bits, ((ImageHeader *)image)->image_size,
                   1278:             (Label*)engine(0, 0, 0, 0, 0));
1.10      pazsan   1279:   alloc_stacks((ImageHeader *)image);
                   1280: #else
                   1281:   image_file = open_image_file(imagename, path);
                   1282:   image = loader(image_file, imagename);
                   1283: #endif
1.24      anton    1284:   gforth_header=(ImageHeader *)image; /* used in SIGSEGV handler */
1.1       anton    1285: 
                   1286:   {
1.10      pazsan   1287:     char path2[strlen(path)+1];
1.1       anton    1288:     char *p1, *p2;
                   1289:     Cell environ[]= {
                   1290:       (Cell)argc-(optind-1),
                   1291:       (Cell)(argv+(optind-1)),
1.10      pazsan   1292:       (Cell)strlen(path),
1.1       anton    1293:       (Cell)path2};
                   1294:     argv[optind-1] = progname;
                   1295:     /*
                   1296:        for (i=0; i<environ[0]; i++)
                   1297:        printf("%s\n", ((char **)(environ[1]))[i]);
                   1298:        */
                   1299:     /* make path OS-independent by replacing path separators with NUL */
1.10      pazsan   1300:     for (p1=path, p2=path2; *p1!='\0'; p1++, p2++)
1.1       anton    1301:       if (*p1==PATHSEP)
                   1302:        *p2 = '\0';
                   1303:       else
                   1304:        *p2 = *p1;
                   1305:     *p2='\0';
1.10      pazsan   1306:     retvalue = go_forth(image, 4, environ);
1.42      anton    1307: #ifdef VM_PROFILING
                   1308:     vm_print_profile(stderr);
                   1309: #endif
1.1       anton    1310:     deprep_terminal();
                   1311:   }
1.13      pazsan   1312:   return retvalue;
1.1       anton    1313: }

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