File:  [gforth] / gforth / engine / forth.h
Revision 1.73: download - view: text, annotated - select for diffs
Sat Mar 11 23:05:09 2006 UTC (18 years, 1 month ago) by pazsan
Branches: MAIN
CVS tags: HEAD
Added gforth_ prefix to some functions

    1: /* common header file
    2: 
    3:   Copyright (C) 1995,1996,1997,1998,2000,2003,2004,2005 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 <stdio.h>
   24: #include <sys/time.h>
   25: #include <unistd.h>
   26: 
   27: #if defined(DOUBLY_INDIRECT)||defined(INDIRECT_THREADED)||defined(VM_PROFILING)
   28: #define NO_DYNAMIC
   29: #endif
   30: 
   31: #if defined(DOUBLY_INDIRECT)
   32: #  undef DIRECT_THREADED
   33: #  undef INDIRECT_THREADED
   34: #  define INDIRECT_THREADED
   35: #endif
   36: 
   37: #if defined(GFORTH_DEBUGGING) || defined(INDIRECT_THREADED) || defined(DOUBLY_INDIRECT) || defined(VM_PROFILING)
   38: #  undef USE_TOS
   39: #  undef USE_FTOS
   40: #  undef USE_NO_TOS
   41: #  undef USE_NO_FTOS
   42: #  define USE_NO_TOS
   43: #  define USE_NO_FTOS
   44: 
   45: #define PRIM_I "prim.i"
   46: #define PRIM_LAB_I "prim_lab.i"
   47: #define PRIM_NAMES_I "prim_names.i"
   48: #define PRIM_SUPEREND_I "prim_superend.i"
   49: #define PRIM_NUM_I "prim_num.i"
   50: #define PRIM_GRP_I "prim_grp.i"
   51: #define COSTS_I "costs.i"
   52: #define SUPER2_I "super2.i"
   53: /* #define PROFILE_I "profile.i" */
   54: 
   55: #else
   56: /* gforth-fast or gforth-native */
   57: #  undef USE_TOS
   58: #  undef USE_FTOS
   59: #  undef USE_NO_TOS
   60: #  undef USE_NO_FTOS
   61: #  define USE_TOS
   62: #  define USE_NO_FTOS
   63: 
   64: #define PRIM_I "prim-fast.i"
   65: #define PRIM_LAB_I "prim_lab-fast.i"
   66: #define PRIM_NAMES_I "prim_names-fast.i"
   67: #define PRIM_SUPEREND_I "prim_superend-fast.i"
   68: #define PRIM_NUM_I "prim_num-fast.i"
   69: #define PRIM_GRP_I "prim_grp-fast.i"
   70: #define COSTS_I "costs-fast.i"
   71: #define SUPER2_I "super2-fast.i"
   72: /* profile.c uses profile.i but does not define VM_PROFILING */
   73: /* #define PROFILE_I "profile-fast.i" */
   74: 
   75: #endif
   76: 
   77: 
   78: 
   79: #include <limits.h>
   80: 
   81: #if defined(NeXT)
   82: #  include <libc.h>
   83: #endif /* NeXT */
   84: 
   85: /* symbol indexed constants */
   86: 
   87: #define DOCOL	0
   88: #define DOCON	1
   89: #define DOVAR	2
   90: #define DOUSER	3
   91: #define DODEFER	4
   92: #define DOFIELD	5
   93: #define DODOES	6
   94: #define DOESJUMP	7
   95: 
   96: /* the size of the DOESJUMP, which resides between DOES> and the does-code */
   97: #define DOES_HANDLER_SIZE	(2*sizeof(Cell))
   98: 
   99: #include "machine.h"
  100: 
  101: /* C interface data types */
  102: 
  103: typedef WYDE_TYPE Wyde;
  104: typedef TETRABYTE_TYPE Tetrabyte;
  105: typedef unsigned WYDE_TYPE UWyde;
  106: typedef unsigned TETRABYTE_TYPE UTetrabyte;
  107: 
  108: /* Forth data types */
  109: /* Cell and UCell must be the same size as a pointer */
  110: #define CELL_BITS	(sizeof(Cell) * CHAR_BIT)
  111: #define FLAG(b) (-(b))
  112: #define FILEIO(error)	(FLAG(error) & -37)
  113: #define FILEEXIST(error)	(FLAG(error) & -38)
  114: 
  115: #define F_TRUE (FLAG(0==0))
  116: #define F_FALSE (FLAG(0!=0))
  117: 
  118: /* define this false if you want native division */
  119: #ifdef FORCE_CDIV
  120: #define FLOORED_DIV 0
  121: #else
  122: #define FLOORED_DIV ((1%-3)>0)
  123: #endif
  124: 
  125: #ifdef BUGGY_LONG_LONG
  126: 
  127: #define BUGGY_LL_CMP    /* compares not possible */
  128: #define BUGGY_LL_MUL    /* multiplication not possible */
  129: #define BUGGY_LL_DIV    /* division not possible */
  130: #define BUGGY_LL_ADD    /* addition not possible */
  131: #define BUGGY_LL_SHIFT  /* shift not possible */
  132: #define BUGGY_LL_D2F    /* to float not possible */
  133: #define BUGGY_LL_F2D    /* from float not possible */
  134: #define BUGGY_LL_SIZE   /* long long "too short", so we use something else */
  135: 
  136: typedef struct {
  137:   Cell hi;
  138:   UCell lo;
  139: } DCell;
  140: 
  141: typedef struct {
  142:   UCell hi;
  143:   UCell lo;
  144: } UDCell;
  145: 
  146: #define DHI(x) (x).hi
  147: #define DLO(x) (x).lo
  148: #define DHI_IS(x,y) (x).hi=(y)
  149: #define DLO_IS(x,y) (x).lo=(y)
  150: 
  151: #if SMALL_OFF_T
  152: #define OFF2UD(o) ({UDCell _ud; _ud.hi=0; _ud.lo=(Cell)(o); _ud;})
  153: #define UD2OFF(ud) ((ud).lo)
  154: #else /* !SMALL_OFF_T */
  155: #define OFF2UD(o) ({UDCell _ud; off_t _o=(o); _ud.hi=_o>>CELL_BITS; _ud.lo=(Cell)_o; _ud;})
  156: #define UD2OFF(ud) ({UDCell _ud=(ud); (((off_t)_ud.hi)<<CELL_BITS)+_ud.lo;})
  157: #endif /* !SMALL_OFF_T */
  158: #define DZERO		((DCell){0,0})
  159: 
  160: #else /* ! defined(BUGGY_LONG_LONG) */
  161: 
  162: /* DCell and UDCell must be twice as large as Cell */
  163: typedef DOUBLE_CELL_TYPE DCell;
  164: typedef DOUBLE_UCELL_TYPE UDCell;
  165: 
  166: #define OFF2UD(o)	((UDCell)(o))
  167: #define UD2OFF(ud)	((off_t)(ud))
  168: #define DZERO		((DCell)0)
  169: 
  170: #endif /* ! defined(BUGGY_LONG_LONG) */
  171: 
  172: typedef union {
  173:   struct {
  174: #if defined(WORDS_BIGENDIAN)||defined(BUGGY_LONG_LONG)
  175:     Cell high;
  176:     UCell low;
  177: #else
  178:     UCell low;
  179:     Cell high;
  180: #endif
  181:   } cells;
  182:   DCell d;
  183:   UDCell ud;
  184: } Double_Store;
  185: 
  186: #ifndef BUGGY_LONG_LONG
  187: #define DHI(x) ({ Double_Store _d; _d.d=(x); _d.cells.high; })
  188: #define DLO(x) ({ Double_Store _d; _d.d=(x); _d.cells.low;  })
  189: 
  190: /* beware with the assignment: x is referenced twice! */
  191: #define DHI_IS(x,y) ({ Double_Store _d; _d.d=(x); _d.cells.high=(y); (x)=_d; })
  192: #define DLO_IS(x,y) ({ Double_Store _d; _d.d=(x); _d.cells.low =(y); (x)=_d; })
  193: #endif
  194: 
  195: #define FETCH_DCELL_T(d_,lo,hi,t_)	({ \
  196: 				     Double_Store _d; \
  197: 				     _d.cells.low = (lo); \
  198: 				     _d.cells.high = (hi); \
  199: 				     (d_) = _d.t_; \
  200: 				 })
  201: 
  202: #define STORE_DCELL_T(d_,lo,hi,t_)	({ \
  203: 				     Double_Store _d; \
  204: 				     _d.t_ = (d_); \
  205: 				     (lo) = _d.cells.low; \
  206: 				     (hi) = _d.cells.high; \
  207: 				 })
  208: 
  209: #define vm_twoCell2d(lo,hi,d_)  FETCH_DCELL_T(d_,lo,hi,d);
  210: #define vm_twoCell2ud(lo,hi,d_) FETCH_DCELL_T(d_,lo,hi,ud);
  211: 
  212: #define vm_d2twoCell(d_,lo,hi)  STORE_DCELL_T(d_,lo,hi,d);
  213: #define vm_ud2twoCell(d_,lo,hi) STORE_DCELL_T(d_,lo,hi,ud);
  214: 
  215: typedef Label *Xt;
  216: 
  217: /* PFA gives the parameter field address corresponding to a cfa */
  218: #define PFA(cfa)	(((Cell *)cfa)+2)
  219: /* PFA1 is a special version for use just after a NEXT1 */
  220: #define PFA1(cfa)	PFA(cfa)
  221: /* CODE_ADDRESS is the address of the code jumped to through the code field */
  222: #define CODE_ADDRESS(cfa)	(*(Xt)(cfa))
  223: 
  224: /* DOES_CODE is the Forth code does jumps to */
  225: #if !defined(DOUBLY_INDIRECT)
  226: #  define DOES_CA (symbols[DODOES])
  227: #else /* defined(DOUBLY_INDIRECT) */
  228: #  define DOES_CA ((Label)&xts[DODOES])
  229: #endif /* defined(DOUBLY_INDIRECT) */
  230: 
  231: 
  232: 
  233: #define DOES_CODE1(cfa)	((Xt *)(cfa[1]))
  234: /* MAKE_CF creates an appropriate code field at the cfa;
  235:    ca is the code address */
  236: #define MAKE_CF(cfa,ca) ((*(Label *)(cfa)) = ((Label)ca))
  237: /* make a code field for a defining-word-defined word */
  238: #define MAKE_DOES_CF(cfa,does_code)  ({MAKE_CF(cfa,DOES_CA);	\
  239: 				       ((Cell *)cfa)[1] = (Cell)(does_code);})
  240: 
  241: #define CF(const)	(-const-2)
  242: 
  243: #define CF_NIL	-1
  244: 
  245: #ifndef FLUSH_ICACHE
  246: #warning flush-icache probably will not work (see manual)
  247: #	define FLUSH_ICACHE(addr,size)
  248: #warning no FLUSH_ICACHE, turning off dynamic native code by default
  249: #undef NO_DYNAMIC_DEFAULT
  250: #define NO_DYNAMIC_DEFAULT 1
  251: #endif
  252: 
  253: #if defined(GFORTH_DEBUGGING) || defined(INDIRECT_THREADED) || defined(DOUBLY_INDIRECT) || defined(VM_PROFILING)
  254: #define STACK_CACHE_DEFAULT 0
  255: #else
  256: #define STACK_CACHE_DEFAULT STACK_CACHE_DEFAULT_FAST
  257: #endif
  258: 
  259: #ifdef USE_FTOS
  260: #define IF_fpTOS(x) x
  261: #else
  262: #define IF_fpTOS(x)
  263: #define fpTOS (fp[0])
  264: #endif
  265: 
  266: #define IF_rpTOS(x)
  267: #define rpTOS (rp[0])
  268: 
  269: typedef struct {
  270:   Address base;		/* base address of image (0 if relocatable) */
  271:   UCell checksum;	/* checksum of ca's to protect against some
  272: 			   incompatible	binary/executable combinations
  273: 			   (0 if relocatable) */
  274:   UCell image_size;	/* all sizes in bytes */
  275:   UCell dict_size;
  276:   UCell data_stack_size;
  277:   UCell fp_stack_size;
  278:   UCell return_stack_size;
  279:   UCell locals_stack_size;
  280:   Xt *boot_entry;	/* initial ip for booting (in BOOT) */
  281:   Xt *throw_entry;	/* ip after signal (in THROW) */
  282:   Cell unused1;		/* possibly tib stack size */
  283:   Label *xt_base;         /* base of DOUBLE_INDIRECT xts[], for comp-i.fs */
  284:   Address data_stack_base; /* this and the following fields are initialized by the loader */
  285:   Address fp_stack_base;
  286:   Address return_stack_base;
  287:   Address locals_stack_base;
  288: } ImageHeader;
  289: /* the image-header is created in main.fs */
  290: 
  291: struct Longname {
  292:   struct Longname *next;  /* the link field for old hands */
  293:   Cell		countetc;
  294:   char		name[0];
  295: };
  296: 
  297: #define LONGNAME_COUNT(np)	((np)->countetc & (((~((UCell)0))<<3)>>3))
  298: 
  299: struct Cellpair {
  300:   Cell n1;
  301:   Cell n2;
  302: };
  303: 
  304: struct Cellquad {
  305:   Cell n1;
  306:   Cell n2;
  307:   Cell n3;
  308:   Cell n4;
  309: };
  310: 
  311: #define IOR(flag)	((flag)? -512-errno : 0)
  312: 
  313: Label *gforth_engine(Xt *ip, Cell *sp, Cell *rp, Float *fp, Address lp);
  314: Label *gforth_engine2(Xt *ip, Cell *sp, Cell *rp, Float *fp, Address lp);
  315: Label *gforth_engine3(Xt *ip, Cell *sp, Cell *rp, Float *fp, Address lp);
  316: 
  317: /* engine/prim support routines */
  318: Address gforth_alloc(Cell size);
  319: char *cstr(Char *from, UCell size, int clear);
  320: char *tilde_cstr(Char *from, UCell size, int clear);
  321: DCell timeval2us(struct timeval *tvp);
  322: void cmove(Char *c_from, Char *c_to, UCell u);
  323: void cmove_up(Char *c_from, Char *c_to, UCell u);
  324: Cell compare(Char *c_addr1, UCell u1, Char *c_addr2, UCell u2);
  325: struct Longname *listlfind(Char *c_addr, UCell u, struct Longname *longname1);
  326: struct Longname *hashlfind(Char *c_addr, UCell u, Cell *a_addr);
  327: struct Longname *tablelfind(Char *c_addr, UCell u, Cell *a_addr);
  328: UCell hashkey1(Char *c_addr, UCell u, UCell ubits);
  329: struct Cellpair parse_white(Char *c_addr1, UCell u1);
  330: Cell rename_file(Char *c_addr1, UCell u1, Char *c_addr2, UCell u2);
  331: struct Cellquad read_line(Char *c_addr, UCell u1, Cell wfileid);
  332: struct Cellpair file_status(Char *c_addr, UCell u);
  333: Cell to_float(Char *c_addr, UCell u, Float *rp);
  334: Float v_star(Float *f_addr1, Cell nstride1, Float *f_addr2, Cell nstride2, UCell ucount);
  335: void faxpy(Float ra, Float *f_x, Cell nstridex, Float *f_y, Cell nstridey, UCell ucount);
  336: UCell lshift(UCell u1, UCell n);
  337: UCell rshift(UCell u1, UCell n);
  338: int gforth_system(Char *c_addr, UCell u);
  339: Cell capscompare(Char *c_addr1, UCell u1, Char *c_addr2, UCell u2);
  340: 
  341: /* signal handler stuff */
  342: void install_signal_handlers(void);
  343: typedef void Sigfunc(int);
  344: Sigfunc *bsd_signal(int signo, Sigfunc *func);
  345: 
  346: /* dblsub routines */
  347: DCell dnegate(DCell d1);
  348: UDCell ummul (UCell a, UCell b);
  349: DCell mmul (Cell a, Cell b);
  350: UDCell umdiv (UDCell u, UCell v);
  351: DCell smdiv (DCell num, Cell denom);
  352: DCell fmdiv (DCell num, Cell denom);
  353: 
  354: Cell memcasecmp(const Char *s1, const Char *s2, Cell n);
  355: 
  356: void vm_print_profile(FILE *file);
  357: void vm_count_block(Xt *ip);
  358: 
  359: /* dynamic superinstruction stuff */
  360: void compile_prim1(Cell *start);
  361: void finish_code(void);
  362: int forget_dyncode(Address code);
  363: Label decompile_code(Label prim);
  364: 
  365: extern int offset_image;
  366: extern int die_on_signal;
  367: extern UCell pagesize;
  368: extern ImageHeader *gforth_header;
  369: extern Label *vm_prims;
  370: extern Label *xts;
  371: extern Cell npriminfos;
  372: 
  373: #ifdef HAS_DEBUG
  374: extern int debug;
  375: #else
  376: # define debug 0
  377: #endif
  378: 
  379: extern Cell *gforth_SP;
  380: extern Float *gforth_FP;
  381: extern Address gforth_UP;
  382: 
  383: #ifdef HAS_FFCALL
  384: extern Cell *gforth_RP;
  385: extern Address gforth_LP;
  386: extern void gforth_callback(Xt* fcall, void * alist);
  387: #endif
  388: 
  389: #ifdef HAS_LIBFFI
  390: extern Cell *gforth_RP;
  391: extern Address gforth_LP;
  392: #include <ffi.h>
  393: extern void gforth_callback(ffi_cif * cif, void * resp, void ** args, void * ip);
  394: #endif
  395: 
  396: #ifdef GFORTH_DEBUGGING
  397: extern Xt *saved_ip;
  398: extern Cell *rp;
  399: #endif
  400: 
  401: #ifdef NO_IP
  402: extern Label next_code;
  403: #endif
  404: 
  405: #ifdef HAS_FILE
  406: extern char* fileattr[6];
  407: extern char* pfileattr[6];
  408: extern int ufileattr[6];
  409: #endif
  410: 
  411: #ifdef PRINT_SUPER_LENGTHS
  412: Cell prim_length(Cell prim);
  413: void print_super_lengths();
  414: #endif
  415: 
  416: /* declare all the functions that are missing */
  417: #ifndef HAVE_ATANH
  418: extern double atanh(double r1);
  419: extern double asinh(double r1);
  420: extern double acosh(double r1);
  421: #endif
  422: #ifndef HAVE_ECVT
  423: /* extern char* ecvt(double x, int len, int* exp, int* sign);*/
  424: #endif
  425: #ifndef HAVE_MEMMOVE
  426: /* extern char *memmove(char *dest, const char *src, long n); */
  427: #endif
  428: #ifndef HAVE_POW10
  429: extern double pow10(double x);
  430: #endif
  431: #ifndef HAVE_STRERROR
  432: extern char *strerror(int err);
  433: #endif
  434: #ifndef HAVE_STRSIGNAL
  435: extern char *strsignal(int sig);
  436: #endif
  437: #ifndef HAVE_STRTOUL
  438: extern unsigned long int strtoul(const char *nptr, char **endptr, int base);
  439: #endif
  440: 
  441: 
  442: #define GROUP(x, n)
  443: #define GROUPADD(n)

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