Annotation of gforth/engine/engine.c, revision 1.108

1.1       anton       1: /* Gforth virtual machine (aka inner interpreter)
                      2: 
1.104     anton       3:   Copyright (C) 1995,1996,1997,1998,2000,2003,2004,2005,2006,2007 Free Software Foundation, Inc.
1.1       anton       4: 
                      5:   This file is part of Gforth.
                      6: 
                      7:   Gforth is free software; you can redistribute it and/or
                      8:   modify it under the terms of the GNU General Public License
1.105     anton       9:   as published by the Free Software Foundation, either version 3
1.1       anton      10:   of the License, or (at your option) any later version.
                     11: 
                     12:   This program is distributed in the hope that it will be useful,
                     13:   but WITHOUT ANY WARRANTY; without even the implied warranty of
                     14:   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     15:   GNU General Public License for more details.
                     16: 
                     17:   You should have received a copy of the GNU General Public License
1.105     anton      18:   along with this program; if not, see http://www.gnu.org/licenses/.
1.1       anton      19: */
                     20: 
1.72      anton      21: #if defined(GFORTH_DEBUGGING) || defined(INDIRECT_THREADED) || defined(DOUBLY_INDIRECT) || defined(VM_PROFILING)
1.68      anton      22: #define USE_NO_TOS
1.72      anton      23: #else
                     24: #define USE_TOS
                     25: #endif
1.68      anton      26: 
1.1       anton      27: #include "config.h"
1.31      pazsan     28: #include "forth.h"
1.1       anton      29: #include <ctype.h>
                     30: #include <stdio.h>
                     31: #include <string.h>
                     32: #include <math.h>
1.4       pazsan     33: #include <assert.h>
                     34: #include <stdlib.h>
                     35: #include <errno.h>
                     36: #include "io.h"
                     37: #include "threaded.h"
                     38: #ifndef STANDALONE
1.1       anton      39: #include <sys/types.h>
                     40: #include <sys/stat.h>
                     41: #include <fcntl.h>
                     42: #include <time.h>
                     43: #include <sys/time.h>
                     44: #include <unistd.h>
                     45: #include <pwd.h>
1.17      pazsan     46: #include <dirent.h>
1.89      pazsan     47: #include <wchar.h>
1.21      anton      48: #include <sys/resource.h>
1.19      anton      49: #ifdef HAVE_FNMATCH_H
1.18      anton      50: #include <fnmatch.h>
1.19      anton      51: #else
                     52: #include "fnmatch.h"
                     53: #endif
1.4       pazsan     54: #else
1.96      pazsan     55: /* #include <systypes.h> */
1.4       pazsan     56: #endif
1.1       anton      57: 
                     58: #if defined(HAVE_LIBDL) || defined(HAVE_DLOPEN) /* what else? */
                     59: #include <dlfcn.h>
                     60: #endif
1.8       pazsan     61: #if defined(_WIN32)
                     62: #include <windows.h>
                     63: #endif
1.1       anton      64: #ifdef hpux
                     65: #include <dl.h>
                     66: #endif
                     67: 
1.63      pazsan     68: #ifdef HAS_FFCALL
                     69: #include <avcall.h>
                     70: #include <callback.h>
                     71: #endif
                     72: 
1.1       anton      73: #ifndef SEEK_SET
                     74: /* should be defined in stdio.h, but some systems don't have it */
                     75: #define SEEK_SET 0
                     76: #endif
                     77: 
1.53      anton      78: #ifndef HAVE_FSEEKO
                     79: #define fseeko fseek
                     80: #endif
                     81: 
                     82: #ifndef HAVE_FTELLO
                     83: #define ftello ftell
                     84: #endif
                     85: 
1.1       anton      86: #define NULLC '\0'
                     87: 
1.14      pazsan     88: #ifdef MEMCMP_AS_SUBROUTINE
                     89: extern int gforth_memcmp(const char * s1, const char * s2, size_t n);
1.15      anton      90: #define memcmp(s1,s2,n) gforth_memcmp(s1,s2,n)
1.14      pazsan     91: #endif
                     92: 
1.1       anton      93: #define NEWLINE        '\n'
1.94      anton      94: 
                     95: /* These two flags control whether divisions are checked by software.
                     96:    The CHECK_DIVISION_SW is for those cases where the event is a
                     97:    division by zero or overflow on the C level, and might be reported
                     98:    by hardware; we might check forr that in autoconf and set the
                     99:    switch appropriately, but currently don't.  The CHECK_DIVISION flag
                    100:    is for the other cases. */
                    101: #ifdef GFORTH_DEBUGGING
                    102: #define CHECK_DIVISION_SW 1
1.91      anton     103: #define CHECK_DIVISION 1
1.94      anton     104: #else
                    105: #define CHECK_DIVISION_SW 0
                    106: #define CHECK_DIVISION 0
                    107: #endif
1.1       anton     108: 
1.26      anton     109: /* conversion on fetch */
                    110: 
1.41      anton     111: #define vm_Cell2f(_cell,_x)            ((_x)=(Bool)(_cell))
                    112: #define vm_Cell2c(_cell,_x)            ((_x)=(Char)(_cell))
                    113: #define vm_Cell2n(_cell,_x)            ((_x)=(Cell)(_cell))
                    114: #define vm_Cell2w(_cell,_x)            ((_x)=(Cell)(_cell))
                    115: #define vm_Cell2u(_cell,_x)            ((_x)=(UCell)(_cell))
                    116: #define vm_Cell2a_(_cell,_x)           ((_x)=(Cell *)(_cell))
                    117: #define vm_Cell2c_(_cell,_x)           ((_x)=(Char *)(_cell))
                    118: #define vm_Cell2f_(_cell,_x)           ((_x)=(Float *)(_cell))
                    119: #define vm_Cell2df_(_cell,_x)          ((_x)=(DFloat *)(_cell))
                    120: #define vm_Cell2sf_(_cell,_x)          ((_x)=(SFloat *)(_cell))
                    121: #define vm_Cell2xt(_cell,_x)           ((_x)=(Xt)(_cell))
                    122: #define vm_Cell2f83name(_cell,_x)      ((_x)=(struct F83Name *)(_cell))
                    123: #define vm_Cell2longname(_cell,_x)     ((_x)=(struct Longname *)(_cell))
                    124: #define vm_Float2r(_float,_x)          (_x=_float)
1.26      anton     125: 
                    126: /* conversion on store */
                    127: 
1.41      anton     128: #define vm_f2Cell(_x,_cell)            ((_cell)=(Cell)(_x))
                    129: #define vm_c2Cell(_x,_cell)            ((_cell)=(Cell)(_x))
                    130: #define vm_n2Cell(_x,_cell)            ((_cell)=(Cell)(_x))
                    131: #define vm_w2Cell(_x,_cell)            ((_cell)=(Cell)(_x))
                    132: #define vm_u2Cell(_x,_cell)            ((_cell)=(Cell)(_x))
                    133: #define vm_a_2Cell(_x,_cell)           ((_cell)=(Cell)(_x))
                    134: #define vm_c_2Cell(_x,_cell)           ((_cell)=(Cell)(_x))
                    135: #define vm_f_2Cell(_x,_cell)           ((_cell)=(Cell)(_x))
                    136: #define vm_df_2Cell(_x,_cell)          ((_cell)=(Cell)(_x))
                    137: #define vm_sf_2Cell(_x,_cell)          ((_cell)=(Cell)(_x))
                    138: #define vm_xt2Cell(_x,_cell)           ((_cell)=(Cell)(_x))
                    139: #define vm_f83name2Cell(_x,_cell)      ((_cell)=(Cell)(_x))
                    140: #define vm_longname2Cell(_x,_cell)     ((_cell)=(Cell)(_x))
                    141: #define vm_r2Float(_x,_float)          (_float=_x)
1.26      anton     142: 
1.41      anton     143: #define vm_Cell2Cell(_x,_y)            (_y=_x)
1.29      anton     144: 
1.46      anton     145: #ifdef NO_IP
                    146: #define IMM_ARG(access,value)          (VARIANT(value))
                    147: #else
                    148: #define IMM_ARG(access,value)          (access)
                    149: #endif
                    150: 
1.1       anton     151: /* if machine.h has not defined explicit registers, define them as implicit */
                    152: #ifndef IPREG
                    153: #define IPREG
                    154: #endif
                    155: #ifndef SPREG
                    156: #define SPREG
                    157: #endif
                    158: #ifndef RPREG
                    159: #define RPREG
                    160: #endif
                    161: #ifndef FPREG
                    162: #define FPREG
                    163: #endif
                    164: #ifndef LPREG
                    165: #define LPREG
                    166: #endif
1.79      pazsan    167: #ifndef CAREG
                    168: #define CAREG
                    169: #endif
1.1       anton     170: #ifndef CFAREG
                    171: #define CFAREG
                    172: #endif
                    173: #ifndef UPREG
                    174: #define UPREG
                    175: #endif
                    176: #ifndef TOSREG
                    177: #define TOSREG
                    178: #endif
1.69      anton     179: #ifndef spbREG
                    180: #define spbREG
                    181: #endif
1.74      anton     182: #ifndef spcREG
                    183: #define spcREG
                    184: #endif
1.80      anton     185: #ifndef spdREG
                    186: #define spdREG
                    187: #endif
                    188: #ifndef speREG
                    189: #define speREG
                    190: #endif
1.81      anton     191: #ifndef spfREG
                    192: #define spfREG
                    193: #endif
                    194: #ifndef spgREG
                    195: #define spgREG
                    196: #endif
                    197: #ifndef sphREG
                    198: #define sphREG
                    199: #endif
1.1       anton     200: #ifndef FTOSREG
                    201: #define FTOSREG
                    202: #endif
                    203: 
                    204: #ifndef CPU_DEP1
                    205: # define CPU_DEP1 0
                    206: #endif
                    207: 
1.62      anton     208: /* instructions containing SUPER_END must be the last instruction of a
1.28      anton     209:    super-instruction (e.g., branches, EXECUTE, and other instructions
                    210:    ending the basic block). Instructions containing SET_IP get this
                    211:    automatically, so you usually don't have to write it.  If you have
                    212:    to write it, write it after IP points to the next instruction.
                    213:    Used for profiling.  Don't write it in a word containing SET_IP, or
                    214:    the following block will be counted twice. */
                    215: #ifdef VM_PROFILING
                    216: #define SUPER_END  vm_count_block(IP)
                    217: #else
                    218: #define SUPER_END
                    219: #endif
1.35      anton     220: #define SUPER_CONTINUE
1.46      anton     221: 
1.98      anton     222: #ifdef ASMCOMMENT
                    223: /* an individualized asm statement so that (hopefully) gcc's optimizer
                    224:    does not do cross-jumping */
                    225: #define asmcomment(string) asm(ASMCOMMENT string)
                    226: #else
                    227: /* we don't know how to do an asm comment, so we just do an empty asm */
                    228: #define asmcomment(string) asm("")
                    229: #endif
                    230: 
1.66      anton     231: #ifdef GFORTH_DEBUGGING
1.70      anton     232: #if DEBUG
1.102     pazsan    233: #define NAME(string) { saved_ip=ip; asmcomment(string); fprintf(stderr,"%08lx depth=%3ld tos=%016lx: "string"\n",(Cell)ip,sp0+3-sp,sp[0]);}
1.70      anton     234: #else /* !DEBUG */
1.66      anton     235: #define NAME(string) { saved_ip=ip; asm(""); }
                    236: /* the asm here is to avoid reordering of following stuff above the
                    237:    assignment; this is an old-style asm (no operands), and therefore
                    238:    is treated like "asm volatile ..."; i.e., it prevents most
                    239:    reorderings across itself.  We want the assignment above first,
                    240:    because the stack loads may already cause a stack underflow. */
1.70      anton     241: #endif /* !DEBUG */
1.66      anton     242: #elif DEBUG
1.72      anton     243: #       define  NAME(string)    {Cell __depth=sp0+3-sp; int i; fprintf(stderr,"%08lx depth=%3ld: "string,(Cell)ip,sp0+3-sp); for (i=__depth-1; i>0; i--) fprintf(stderr, " $%lx",sp[i]); fprintf(stderr, " $%lx\n",spTOS); }
1.66      anton     244: #else
1.98      anton     245: #      define  NAME(string) asmcomment(string);
1.66      anton     246: #endif
                    247: 
1.37      pazsan    248: #ifdef DEBUG
                    249: #define CFA_TO_NAME(__cfa) \
                    250:       Cell len, i; \
                    251:       char * name = __cfa; \
                    252:       for(i=0; i<32; i+=sizeof(Cell)) { \
                    253:         len = ((Cell*)name)[-1]; \
                    254:         if(len < 0) { \
                    255:          len &= 0x1F; \
                    256:           if((len+sizeof(Cell)) > i) break; \
                    257:        } len = 0; \
                    258:        name -= sizeof(Cell); \
                    259:       }
                    260: #endif
1.30      anton     261: 
1.101     pazsan    262: #ifdef STANDALONE
                    263: jmp_buf throw_jmp_buf;
                    264: 
                    265: void throw(int code)
                    266: {
                    267:   longjmp(throw_jmp_buf,code); /* !! or use siglongjmp ? */
                    268: }
                    269: #endif
                    270: 
1.85      pazsan    271: #if defined(HAS_FFCALL) || defined(HAS_LIBFFI)
1.88      pazsan    272: #define SAVE_REGS IF_fpTOS(fp[0]=fpTOS); gforth_SP=sp; gforth_FP=fp; gforth_RP=rp; gforth_LP=lp;
                    273: #define REST_REGS sp=gforth_SP; fp=gforth_FP; rp=gforth_RP; lp=gforth_LP; IF_fpTOS(fpTOS=fp[0]);
1.63      pazsan    274: #endif
                    275: 
1.50      anton     276: #if !defined(ENGINE)
                    277: /* normal engine */
                    278: #define VARIANT(v)     (v)
                    279: #define JUMP(target)   goto I_noop
1.82      anton     280: #define LABEL(name) H_##name: asm(""); I_##name:
1.100     anton     281: #define LABEL3(name) J_##name: asm("");
1.50      anton     282: 
                    283: #elif ENGINE==2
                    284: /* variant with padding between VM instructions for finding out
                    285:    cross-inst jumps (for dynamic code) */
1.90      pazsan    286: #define gforth_engine gforth_engine2
1.50      anton     287: #define VARIANT(v)     (v)
                    288: #define JUMP(target)   goto I_noop
1.78      anton     289: #define LABEL(name) H_##name: SKIP16; I_##name:
1.100     anton     290: /* the SKIP16 after LABEL3 is there, because the ARM gcc may place
                    291:    some constants after the final branch, and may refer to them from
                    292:    the code before label3.  Since we don't copy the constants, we have
                    293:    to make sure that such code is recognized as non-relocatable. */
                    294: #define LABEL3(name) J_##name: SKIP16;
1.50      anton     295: 
                    296: #elif ENGINE==3
                    297: /* variant with different immediate arguments for finding out
                    298:    immediate arguments (for native code) */
1.90      pazsan    299: #define gforth_engine gforth_engine3
1.50      anton     300: #define VARIANT(v)     ((v)^0xffffffff)
                    301: #define JUMP(target)   goto K_lit
1.83      anton     302: #define LABEL(name) H_##name: asm(""); I_##name:
1.100     anton     303: #define LABEL3(name) J_##name: asm("");
1.50      anton     304: #else
                    305: #error illegal ENGINE value
                    306: #endif /* ENGINE */
                    307: 
1.67      anton     308: /* the asm(""); is there to get a stop compiled on Itanium */
                    309: #define LABEL2(name) K_##name: asm("");
1.50      anton     310: 
1.106     anton     311: Label *gforth_engine(Xt *ip0, Cell *sp0, Cell *rp0, Float *fp0, Address lp0 sr_proto)
1.1       anton     312: /* executes code at ip, if ip!=NULL
                    313:    returns array of machine code labels (for use in a loader), if ip==NULL
                    314: */
                    315: {
1.107     anton     316: #if defined(GFORTH_DEBUGGING)
                    317: #if defined(GLOBALS_NONRELOC)
                    318:   register saved_regs *saved_regs_p TOSREG = saved_regs_p0;
                    319: #endif /* defined(GLOBALS_NONRELOC) */
                    320: #else /* !defined(GFORTH_DEBUGGING) */
1.10      anton     321:   register Cell *rp RPREG;
1.107     anton     322: #endif /* !defined(GFORTH_DEBUGGING) */
1.46      anton     323: #ifndef NO_IP
                    324:   register Xt *ip IPREG = ip0;
                    325: #endif
1.1       anton     326:   register Cell *sp SPREG = sp0;
                    327:   register Float *fp FPREG = fp0;
                    328:   register Address lp LPREG = lp0;
                    329:   register Xt cfa CFAREG;
1.79      pazsan    330:   register Label real_ca CAREG;
1.11      anton     331: #ifdef MORE_VARS
                    332:   MORE_VARS
1.63      pazsan    333: #endif
                    334: #ifdef HAS_FFCALL
                    335:   av_alist alist;
1.90      pazsan    336:   extern va_alist gforth_clist;
1.63      pazsan    337:   float frv;
                    338:   int irv;
                    339:   double drv;
                    340:   long long llrv;
                    341:   void * prv;
1.84      pazsan    342: #endif
1.88      pazsan    343:   register Address up UPREG = gforth_UP;
1.107     anton     344: #if !defined(GFORTH_DEBUGGING)
1.80      anton     345:   register Cell MAYBE_UNUSED spTOS TOSREG;
1.74      anton     346:   register Cell MAYBE_UNUSED spb spbREG;
                    347:   register Cell MAYBE_UNUSED spc spcREG;
1.80      anton     348:   register Cell MAYBE_UNUSED spd spdREG;
                    349:   register Cell MAYBE_UNUSED spe speREG;
1.81      anton     350:   register Cell MAYBE_UNUSED spf speREG;
                    351:   register Cell MAYBE_UNUSED spg speREG;
                    352:   register Cell MAYBE_UNUSED sph speREG;
1.24      anton     353:   IF_fpTOS(register Float fpTOS FTOSREG;)
1.107     anton     354: #endif /* !defined(GFORTH_DEBUGGING) */
1.1       anton     355: #if defined(DOUBLY_INDIRECT)
                    356:   static Label *symbols;
                    357:   static void *routines[]= {
1.27      anton     358: #define MAX_SYMBOLS (sizeof(routines)/sizeof(routines[0]))
1.1       anton     359: #else /* !defined(DOUBLY_INDIRECT) */
                    360:   static Label symbols[]= {
1.27      anton     361: #define MAX_SYMBOLS (sizeof(symbols)/sizeof(symbols[0]))
1.1       anton     362: #endif /* !defined(DOUBLY_INDIRECT) */
1.55      anton     363: #define INST_ADDR(name) ((Label)&&I_##name)
1.71      anton     364: #include PRIM_LAB_I
1.34      anton     365: #undef INST_ADDR
                    366:     (Label)0,
1.55      anton     367: #define INST_ADDR(name) ((Label)&&K_##name)
1.71      anton     368: #include PRIM_LAB_I
1.46      anton     369: #undef INST_ADDR
1.55      anton     370: #define INST_ADDR(name) ((Label)&&J_##name)
1.71      anton     371: #include PRIM_LAB_I
1.34      anton     372: #undef INST_ADDR
1.76      anton     373:     (Label)&&after_last,
                    374:     (Label)&&before_goto,
1.78      anton     375:     (Label)&&after_goto,
                    376: /* just mention the H_ labels, so the SKIP16s are not optimized away */
                    377: #define INST_ADDR(name) ((Label)&&H_##name)
                    378: #include PRIM_LAB_I
                    379: #undef INST_ADDR
1.1       anton     380:   };
1.99      pazsan    381: #ifdef STANDALONE
1.97      pazsan    382: #define INST_ADDR(name) ((Label)&&I_##name)
                    383: #include "image.i"
                    384: #undef INST_ADDR
                    385: #endif
1.1       anton     386: #ifdef CPU_DEP2
                    387:   CPU_DEP2
                    388: #endif
                    389: 
1.10      anton     390:   rp = rp0;
1.1       anton     391: #ifdef DEBUG
                    392:   fprintf(stderr,"ip=%x, sp=%x, rp=%x, fp=%x, lp=%x, up=%x\n",
1.46      anton     393:           (unsigned)ip0,(unsigned)sp,(unsigned)rp,
1.1       anton     394:          (unsigned)fp,(unsigned)lp,(unsigned)up);
                    395: #endif
                    396: 
1.46      anton     397:   if (ip0 == NULL) {
1.1       anton     398: #if defined(DOUBLY_INDIRECT)
1.38      anton     399: #define CODE_OFFSET (26*sizeof(Cell))
                    400: #define XT_OFFSET (22*sizeof(Cell))
1.1       anton     401:     int i;
1.3       anton     402:     Cell code_offset = offset_image? CODE_OFFSET : 0;
1.38      anton     403:     Cell xt_offset = offset_image? XT_OFFSET : 0;
1.7       pazsan    404: 
1.3       anton     405:     symbols = (Label *)(malloc(MAX_SYMBOLS*sizeof(Cell)+CODE_OFFSET)+code_offset);
1.38      anton     406:     xts = (Label *)(malloc(MAX_SYMBOLS*sizeof(Cell)+XT_OFFSET)+xt_offset);
1.1       anton     407:     for (i=0; i<DOESJUMP+1; i++)
1.38      anton     408:       xts[i] = symbols[i] = (Label)routines[i];
1.1       anton     409:     for (; routines[i]!=0; i++) {
                    410:       if (i>=MAX_SYMBOLS) {
1.60      anton     411:        fprintf(stderr,"gforth-ditc: more than %ld primitives\n",(long)MAX_SYMBOLS);
1.1       anton     412:        exit(1);
1.20      anton     413:       }
1.38      anton     414:       xts[i] = symbols[i] = &routines[i];
1.1       anton     415:     }
1.20      anton     416: #endif /* defined(DOUBLY_INDIRECT) */
1.99      pazsan    417: #ifdef STANDALONE
                    418:     return image;
                    419: #else
1.20      anton     420:     return symbols;
1.99      pazsan    421: #endif
1.7       pazsan    422:   }
1.1       anton     423: 
1.81      anton     424: #if !(defined(GFORTH_DEBUGGING) || defined(INDIRECT_THREADED) || defined(DOUBLY_INDIRECT) || defined(VM_PROFILING))
1.80      anton     425:   sp += STACK_CACHE_DEFAULT-1;
1.81      anton     426:   /* some of those registers are dead, but its simpler to initialize them all */  spTOS = sp[0];
1.80      anton     427:   spb = sp[-1];
                    428:   spc = sp[-2];
                    429:   spd = sp[-3];
                    430:   spe = sp[-4];
1.81      anton     431:   spf = sp[-5];
                    432:   spg = sp[-6];
                    433:   sph = sp[-7];
1.80      anton     434: #endif
                    435: 
1.24      anton     436:   IF_fpTOS(fpTOS = fp[0]);
1.7       pazsan    437: /*  prep_terminal(); */
1.46      anton     438: #ifdef NO_IP
                    439:   goto *(*(Label *)ip0);
1.79      pazsan    440:   before_goto:
                    441:   goto *real_ca;
                    442:   after_goto:;
1.46      anton     443: #else
1.11      anton     444:   SET_IP(ip);
1.28      anton     445:   SUPER_END; /* count the first block, too */
1.79      pazsan    446:   FIRST_NEXT;
1.46      anton     447: #endif
1.11      anton     448: 
1.1       anton     449: #ifdef CPU_DEP3
                    450:   CPU_DEP3
1.46      anton     451: #endif
1.76      anton     452: 
1.78      anton     453: #include PRIM_I
                    454:   after_last: return (Label *)0;
                    455:   /*needed only to get the length of the last primitive */
                    456: 
                    457:   return (Label *)0;
1.50      anton     458: }

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