File:  [gforth] / gforth / engine / engine.c
Revision 1.33: download - view: text, annotated - select for diffs
Sun Dec 9 19:12:46 2001 UTC (22 years, 4 months ago) by anton
Branches: MAIN
CVS tags: HEAD
use LABEL(name) instead of CASE I_name at the start of a primitive
fixed read-line tutorial documentation bug

    1: /* Gforth virtual machine (aka inner interpreter)
    2: 
    3:   Copyright (C) 1995,1996,1997,1998,2000 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 2
   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, write to the Free Software
   19:   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
   20: */
   21: 
   22: #include "config.h"
   23: #include "forth.h"
   24: #include <ctype.h>
   25: #include <stdio.h>
   26: #include <string.h>
   27: #include <math.h>
   28: #include <assert.h>
   29: #include <stdlib.h>
   30: #include <errno.h>
   31: #include "io.h"
   32: #include "threaded.h"
   33: #ifndef STANDALONE
   34: #include <sys/types.h>
   35: #include <sys/stat.h>
   36: #include <fcntl.h>
   37: #include <time.h>
   38: #include <sys/time.h>
   39: #include <unistd.h>
   40: #include <pwd.h>
   41: #include <dirent.h>
   42: #include <sys/resource.h>
   43: #ifdef HAVE_FNMATCH_H
   44: #include <fnmatch.h>
   45: #else
   46: #include "fnmatch.h"
   47: #endif
   48: #else
   49: #include "systypes.h"
   50: #endif
   51: 
   52: #if defined(HAVE_LIBDL) || defined(HAVE_DLOPEN) /* what else? */
   53: #include <dlfcn.h>
   54: #endif
   55: #if defined(_WIN32)
   56: #include <windows.h>
   57: #endif
   58: #ifdef hpux
   59: #include <dl.h>
   60: #endif
   61: 
   62: #ifndef SEEK_SET
   63: /* should be defined in stdio.h, but some systems don't have it */
   64: #define SEEK_SET 0
   65: #endif
   66: 
   67: #define IOR(flag)	((flag)? -512-errno : 0)
   68: 
   69: struct F83Name {
   70:   struct F83Name *next;  /* the link field for old hands */
   71:   char		countetc;
   72:   char		name[0];
   73: };
   74: 
   75: #define F83NAME_COUNT(np)	((np)->countetc & 0x1f)
   76: 
   77: struct Longname {
   78:   struct Longname *next;  /* the link field for old hands */
   79:   Cell		countetc;
   80:   char		name[0];
   81: };
   82: 
   83: #define LONGNAME_COUNT(np)	((np)->countetc & (((~((UCell)0))<<3)>>3))
   84: 
   85: Cell *SP;
   86: Float *FP;
   87: Address UP=NULL;
   88: 
   89: #if 0
   90: /* not used currently */
   91: int emitcounter;
   92: #endif
   93: #define NULLC '\0'
   94: 
   95: #ifdef MEMCMP_AS_SUBROUTINE
   96: extern int gforth_memcmp(const char * s1, const char * s2, size_t n);
   97: #define memcmp(s1,s2,n) gforth_memcmp(s1,s2,n)
   98: #endif
   99: 
  100: #ifdef HAS_FILE
  101: char *cstr(Char *from, UCell size, int clear)
  102: /* return a C-string corresponding to the Forth string ( FROM SIZE ).
  103:    the C-string lives until the next call of cstr with CLEAR being true */
  104: {
  105:   static struct cstr_buffer {
  106:     char *buffer;
  107:     size_t size;
  108:   } *buffers=NULL;
  109:   static int nbuffers=0;
  110:   static int used=0;
  111:   struct cstr_buffer *b;
  112: 
  113:   if (buffers==NULL)
  114:     buffers=malloc(0);
  115:   if (clear)
  116:     used=0;
  117:   if (used>=nbuffers) {
  118:     buffers=realloc(buffers,sizeof(struct cstr_buffer)*(used+1));
  119:     buffers[used]=(struct cstr_buffer){malloc(0),0};
  120:     nbuffers=used+1;
  121:   }
  122:   b=&buffers[used];
  123:   if (size+1 > b->size) {
  124:     b->buffer = realloc(b->buffer,size+1);
  125:     b->size = size+1;
  126:   }
  127:   memcpy(b->buffer,from,size);
  128:   b->buffer[size]='\0';
  129:   used++;
  130:   return b->buffer;
  131: }
  132: 
  133: char *tilde_cstr(Char *from, UCell size, int clear)
  134: /* like cstr(), but perform tilde expansion on the string */
  135: {
  136:   char *s1,*s2;
  137:   int s1_len, s2_len;
  138:   struct passwd *getpwnam (), *user_entry;
  139: 
  140:   if (size<1 || from[0]!='~')
  141:     return cstr(from, size, clear);
  142:   if (size<2 || from[1]=='/') {
  143:     s1 = (char *)getenv ("HOME");
  144:     if(s1 == NULL)
  145:       s1 = "";
  146:     s2 = from+1;
  147:     s2_len = size-1;
  148:   } else {
  149:     UCell i;
  150:     for (i=1; i<size && from[i]!='/'; i++)
  151:       ;
  152:     if (i==2 && from[1]=='+') /* deal with "~+", i.e., the wd */
  153:       return cstr(from+3, size<3?0:size-3,clear);
  154:     {
  155:       char user[i];
  156:       memcpy(user,from+1,i-1);
  157:       user[i-1]='\0';
  158:       user_entry=getpwnam(user);
  159:     }
  160:     if (user_entry==NULL)
  161:       return cstr(from, size, clear);
  162:     s1 = user_entry->pw_dir;
  163:     s2 = from+i;
  164:     s2_len = size-i;
  165:   }
  166:   s1_len = strlen(s1);
  167:   if (s1_len>1 && s1[s1_len-1]=='/')
  168:     s1_len--;
  169:   {
  170:     char path[s1_len+s2_len];
  171:     memcpy(path,s1,s1_len);
  172:     memcpy(path+s1_len,s2,s2_len);
  173:     return cstr(path,s1_len+s2_len,clear);
  174:   }
  175: }
  176: #endif
  177: 
  178: DCell timeval2us(struct timeval *tvp)
  179: {
  180: #ifndef BUGGY_LONG_LONG
  181:   return (tvp->tv_sec*(DCell)1000000)+tvp->tv_usec;
  182: #else
  183:   DCell d2;
  184:   DCell d1=mmul(tvp->tv_sec,1000000);
  185:   d2.lo = d1.lo+tvp->tv_usec;
  186:   d2.hi = d1.hi + (d2.lo<d1.lo);
  187:   return d2;
  188: #endif
  189: }
  190: 
  191: #define NEWLINE	'\n'
  192: 
  193: #ifndef HAVE_RINT
  194: #define rint(x)	floor((x)+0.5)
  195: #endif
  196: 
  197: #ifdef HAS_FILE
  198: static char* fileattr[6]={"rb","rb","r+b","r+b","wb","wb"};
  199: static char* pfileattr[6]={"r","r","r+","r+","w","w"};
  200: 
  201: #ifndef O_BINARY
  202: #define O_BINARY 0
  203: #endif
  204: #ifndef O_TEXT
  205: #define O_TEXT 0
  206: #endif
  207: 
  208: static int ufileattr[6]= {
  209:   O_RDONLY|O_BINARY, O_RDONLY|O_BINARY,
  210:   O_RDWR  |O_BINARY, O_RDWR  |O_BINARY,
  211:   O_WRONLY|O_BINARY, O_WRONLY|O_BINARY };
  212: #endif
  213: 
  214: /* conversion on fetch */
  215: 
  216: #define vm_Cell2f(x)		((Bool)(x))
  217: #define vm_Cell2c(x)		((Char)(x))
  218: #define vm_Cell2n(x)		((Cell)x)
  219: #define vm_Cell2w(x)		((Cell)x)
  220: #define vm_Cell2u(x)		((UCell)(x))
  221: #define vm_Cell2a_(x)		((Cell *)(x))
  222: #define vm_Cell2c_(x)		((Char *)(x))
  223: #define vm_Cell2f_(x)		((Float *)(x))
  224: #define vm_Cell2df_(x)		((DFloat *)(x))
  225: #define vm_Cell2sf_(x)		((SFloat *)(x))
  226: #define vm_Cell2xt(x)		((Xt)(x))
  227: #define vm_Cell2f83name(x)	((struct F83Name *)(x))
  228: #define vm_Cell2longname(x)	((struct Longname *)(x))
  229: #define vm_Float2r(x)	(x)
  230: 
  231: /* conversion on store */
  232: 
  233: #define vm_f2Cell(x)		((Cell)(x))
  234: #define vm_c2Cell(x)		((Cell)(x))
  235: #define vm_n2Cell(x)		((Cell)(x))
  236: #define vm_w2Cell(x)		((Cell)(x))
  237: #define vm_u2Cell(x)		((Cell)(x))
  238: #define vm_a_2Cell(x)		((Cell)(x))
  239: #define vm_c_2Cell(x)		((Cell)(x))
  240: #define vm_f_2Cell(x)		((Cell)(x))
  241: #define vm_df_2Cell(x)		((Cell)(x))
  242: #define vm_sf_2Cell(x)		((Cell)(x))
  243: #define vm_xt2Cell(x)		((Cell)(x))
  244: #define vm_f83name2Cell(x)	((Cell)(x))
  245: #define vm_longname2Cell(x)	((Cell)(x))
  246: #define vm_r2Float(x)	(x)
  247: 
  248: #define vm_Cell2Cell(x)		(x)
  249: 
  250: /* if machine.h has not defined explicit registers, define them as implicit */
  251: #ifndef IPREG
  252: #define IPREG
  253: #endif
  254: #ifndef SPREG
  255: #define SPREG
  256: #endif
  257: #ifndef RPREG
  258: #define RPREG
  259: #endif
  260: #ifndef FPREG
  261: #define FPREG
  262: #endif
  263: #ifndef LPREG
  264: #define LPREG
  265: #endif
  266: #ifndef CFAREG
  267: #define CFAREG
  268: #endif
  269: #ifndef UPREG
  270: #define UPREG
  271: #endif
  272: #ifndef TOSREG
  273: #define TOSREG
  274: #endif
  275: #ifndef FTOSREG
  276: #define FTOSREG
  277: #endif
  278: 
  279: #ifndef CPU_DEP1
  280: # define CPU_DEP1 0
  281: #endif
  282: 
  283: /* declare and compute cfa for certain threading variants */
  284: /* warning: this is nonsyntactical; it will not work in place of a statement */
  285: #ifndef GETCFA
  286: #define DOCFA
  287: #else
  288: #define DOCFA	Xt cfa; GETCFA(cfa)
  289: #endif
  290: 
  291: /* instructions containing these must be the last instruction of a
  292:    super-instruction (e.g., branches, EXECUTE, and other instructions
  293:    ending the basic block). Instructions containing SET_IP get this
  294:    automatically, so you usually don't have to write it.  If you have
  295:    to write it, write it after IP points to the next instruction.
  296:    Used for profiling.  Don't write it in a word containing SET_IP, or
  297:    the following block will be counted twice. */
  298: #ifdef VM_PROFILING
  299: #define SUPER_END  vm_count_block(IP)
  300: #else
  301: #define SUPER_END
  302: #endif
  303: 
  304: #ifdef GFORTH_DEBUGGING
  305: /* define some VM registers as global variables, so they survive exceptions;
  306:    global register variables are not up to the task (according to the 
  307:    GNU C manual) */
  308: Xt *ip;
  309: Cell *rp;
  310: #endif
  311: 
  312: Xt *primtable(Label symbols[], Cell size)
  313: {
  314: #ifdef DIRECT_THREADED
  315:   return symbols;
  316: #else /* !defined(DIRECT_THREADED) */
  317:   Xt *xts = (Xt *)malloc(size*sizeof(Xt));
  318:   Cell i;
  319: 
  320:   for (i=0; i<size; i++)
  321:     xts[i] = &symbols[i];
  322:   return xts;
  323: #endif /* !defined(DIRECT_THREADED) */
  324: }
  325: 
  326: Label *engine(Xt *ip0, Cell *sp0, Cell *rp0, Float *fp0, Address lp0)
  327: /* executes code at ip, if ip!=NULL
  328:    returns array of machine code labels (for use in a loader), if ip==NULL
  329: */
  330: {
  331: #ifndef GFORTH_DEBUGGING
  332:   register Xt *ip IPREG;
  333:   register Cell *rp RPREG;
  334: #endif
  335:   register Cell *sp SPREG = sp0;
  336:   register Float *fp FPREG = fp0;
  337:   register Address lp LPREG = lp0;
  338: #ifdef CFA_NEXT
  339:   register Xt cfa CFAREG;
  340: #endif
  341: #ifdef MORE_VARS
  342:   MORE_VARS
  343: #endif
  344:   register Address up UPREG = UP;
  345:   IF_spTOS(register Cell spTOS TOSREG;)
  346:   IF_fpTOS(register Float fpTOS FTOSREG;)
  347: #if defined(DOUBLY_INDIRECT)
  348:   static Label *symbols;
  349:   static void *routines[]= {
  350: #define MAX_SYMBOLS (sizeof(routines)/sizeof(routines[0]))
  351: #else /* !defined(DOUBLY_INDIRECT) */
  352:   static Label symbols[]= {
  353: #define MAX_SYMBOLS (sizeof(symbols)/sizeof(symbols[0]))
  354: #endif /* !defined(DOUBLY_INDIRECT) */
  355:     (Label)&&docol,
  356:     (Label)&&docon,
  357:     (Label)&&dovar,
  358:     (Label)&&douser,
  359:     (Label)&&dodefer,
  360:     (Label)&&dofield,
  361:     (Label)&&dodoes,
  362:     /* the following entry is normally unused;
  363:        it's there because its index indicates a does-handler */
  364:     CPU_DEP1,
  365: #include "prim_lab.i"
  366:     (Label)0
  367:   };
  368: #ifdef CPU_DEP2
  369:   CPU_DEP2
  370: #endif
  371: 
  372:   ip = ip0;
  373:   rp = rp0;
  374: #ifdef DEBUG
  375:   fprintf(stderr,"ip=%x, sp=%x, rp=%x, fp=%x, lp=%x, up=%x\n",
  376:           (unsigned)ip,(unsigned)sp,(unsigned)rp,
  377: 	  (unsigned)fp,(unsigned)lp,(unsigned)up);
  378: #endif
  379: 
  380:   if (ip == NULL) {
  381: #if defined(DOUBLY_INDIRECT)
  382: #define CODE_OFFSET (22*sizeof(Cell))
  383:     int i;
  384:     Cell code_offset = offset_image? CODE_OFFSET : 0;
  385: 
  386:     symbols = (Label *)(malloc(MAX_SYMBOLS*sizeof(Cell)+CODE_OFFSET)+code_offset);
  387:     for (i=0; i<DOESJUMP+1; i++)
  388:       symbols[i] = (Label)routines[i];
  389:     for (; routines[i]!=0; i++) {
  390:       if (i>=MAX_SYMBOLS) {
  391: 	fprintf(stderr,"gforth-ditc: more than %d primitives\n",MAX_SYMBOLS);
  392: 	exit(1);
  393:       }
  394:       symbols[i] = &routines[i];
  395:     }
  396: #endif /* defined(DOUBLY_INDIRECT) */
  397:     return symbols;
  398:   }
  399: 
  400:   IF_spTOS(spTOS = sp[0]);
  401:   IF_fpTOS(fpTOS = fp[0]);
  402: /*  prep_terminal(); */
  403:   SET_IP(ip);
  404:   SUPER_END; /* count the first block, too */
  405:   NEXT;
  406: 
  407: 
  408: #ifdef CPU_DEP3
  409:   CPU_DEP3
  410: #endif
  411:   
  412:  docol:
  413:   {
  414:     DOCFA;
  415: #ifdef DEBUG
  416:     fprintf(stderr,"%08lx: col: %08lx\n",(Cell)ip,(Cell)PFA1(cfa));
  417: #endif
  418: #ifdef CISC_NEXT
  419:     /* this is the simple version */
  420:     *--rp = (Cell)ip;
  421:     SET_IP((Xt *)PFA1(cfa));
  422:     SUPER_END;
  423:     NEXT;
  424: #else
  425:     /* this one is important, so we help the compiler optimizing */
  426:     {
  427:       DEF_CA
  428:       rp[-1] = (Cell)ip;
  429:       SET_IP((Xt *)PFA1(cfa));
  430:       SUPER_END;
  431:       NEXT_P1;
  432:       rp--;
  433:       NEXT_P2;
  434:     }
  435: #endif
  436:   }
  437: 
  438:  docon:
  439:   {
  440:     DOCFA;
  441: #ifdef DEBUG
  442:     fprintf(stderr,"%08lx: con: %08lx\n",(Cell)ip,*(Cell*)PFA1(cfa));
  443: #endif
  444: #ifdef USE_TOS
  445:     *sp-- = spTOS;
  446:     spTOS = *(Cell *)PFA1(cfa);
  447: #else
  448:     *--sp = *(Cell *)PFA1(cfa);
  449: #endif
  450:   }
  451:   NEXT_P0;
  452:   NEXT;
  453:   
  454:  dovar:
  455:   {
  456:     DOCFA;
  457: #ifdef DEBUG
  458:     fprintf(stderr,"%08lx: var: %08lx\n",(Cell)ip,(Cell)PFA1(cfa));
  459: #endif
  460: #ifdef USE_TOS
  461:     *sp-- = spTOS;
  462:     spTOS = (Cell)PFA1(cfa);
  463: #else
  464:     *--sp = (Cell)PFA1(cfa);
  465: #endif
  466:   }
  467:   NEXT_P0;
  468:   NEXT;
  469:   
  470:  douser:
  471:   {
  472:     DOCFA;
  473: #ifdef DEBUG
  474:     fprintf(stderr,"%08lx: user: %08lx\n",(Cell)ip,(Cell)PFA1(cfa));
  475: #endif
  476: #ifdef USE_TOS
  477:     *sp-- = spTOS;
  478:     spTOS = (Cell)(up+*(Cell*)PFA1(cfa));
  479: #else
  480:     *--sp = (Cell)(up+*(Cell*)PFA1(cfa));
  481: #endif
  482:   }
  483:   NEXT_P0;
  484:   NEXT;
  485:   
  486:  dodefer:
  487:   {
  488:     DOCFA;
  489: #ifdef DEBUG
  490:     fprintf(stderr,"%08lx: defer: %08lx\n",(Cell)ip,*(Cell*)PFA1(cfa));
  491: #endif
  492:     SUPER_END;
  493:     EXEC(*(Xt *)PFA1(cfa));
  494:   }
  495: 
  496:  dofield:
  497:   {
  498:     DOCFA;
  499: #ifdef DEBUG
  500:     fprintf(stderr,"%08lx: field: %08lx\n",(Cell)ip,(Cell)PFA1(cfa));
  501: #endif
  502:     spTOS += *(Cell*)PFA1(cfa);
  503:   }
  504:   NEXT_P0;
  505:   NEXT;
  506: 
  507:  dodoes:
  508:   /* this assumes the following structure:
  509:      defining-word:
  510:      
  511:      ...
  512:      DOES>
  513:      (possible padding)
  514:      possibly handler: jmp dodoes
  515:      (possible branch delay slot(s))
  516:      Forth code after DOES>
  517:      
  518:      defined word:
  519:      
  520:      cfa: address of or jump to handler OR
  521:           address of or jump to dodoes, address of DOES-code
  522:      pfa:
  523:      
  524:      */
  525:   {
  526:     DOCFA;
  527: 
  528:     /*    fprintf(stderr, "Got CFA %08lx at doescode %08lx/%08lx: does: %08lx\n",cfa,(Cell)ip,(Cell)PFA(cfa),(Cell)DOES_CODE1(cfa));*/
  529: #ifdef DEBUG
  530:     fprintf(stderr,"%08lx/%08lx: does: %08lx\n",(Cell)ip,(Cell)PFA(cfa),(Cell)DOES_CODE1(cfa));
  531:     fflush(stderr);
  532: #endif
  533:     *--rp = (Cell)ip;
  534:     /* PFA1 might collide with DOES_CODE1 here, so we use PFA */
  535: #ifdef USE_TOS
  536:     *sp-- = spTOS;
  537:     spTOS = (Cell)PFA(cfa);
  538: #else
  539:     *--sp = (Cell)PFA(cfa);
  540: #endif
  541:     SET_IP(DOES_CODE1(cfa));
  542:     SUPER_END;
  543:     /*    fprintf(stderr,"TOS = %08lx, IP=%08lx\n", spTOS, IP);*/
  544:   }
  545:   NEXT;
  546: 
  547: #define LABEL(name) I_##name
  548: #include "prim.i"
  549: }

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