Return to engine.c CVS log

Up to [gforth] / gforth / engine

enable dynamic code generation for (debugging) gforth on AMD64 by accessing
  the global variable through a local pointer.  Mixed results up to now, may
  be better with explicit register allocation.

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