Annotation of gforth/engine/forth.h, revision 1.78
1.1 anton 1: /* common header file
2:
1.70 anton 3: Copyright (C) 1995,1996,1997,1998,2000,2003,2004,2005 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
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
1.13 anton 19: Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
1.1 anton 20: */
21:
22: #include "config.h"
1.18 anton 23: #include <stdio.h>
1.35 anton 24: #include <sys/time.h>
25: #include <unistd.h>
1.1 anton 26:
1.32 anton 27: #if defined(DOUBLY_INDIRECT)||defined(INDIRECT_THREADED)||defined(VM_PROFILING)
28: #define NO_DYNAMIC
29: #endif
30:
1.1 anton 31: #if defined(DOUBLY_INDIRECT)
32: # undef DIRECT_THREADED
33: # undef INDIRECT_THREADED
34: # define INDIRECT_THREADED
35: #endif
36:
1.57 anton 37: #if defined(GFORTH_DEBUGGING) || defined(INDIRECT_THREADED) || defined(DOUBLY_INDIRECT) || defined(VM_PROFILING)
1.23 anton 38: # undef USE_TOS
39: # undef USE_FTOS
1.56 anton 40: # undef USE_NO_TOS
41: # undef USE_NO_FTOS
1.23 anton 42: # define USE_NO_TOS
43: # define USE_NO_FTOS
1.57 anton 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"
1.58 anton 53: /* #define PROFILE_I "profile.i" */
1.57 anton 54:
55: #else
56: /* gforth-fast or gforth-native */
1.59 anton 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
1.57 anton 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"
1.58 anton 72: /* profile.c uses profile.i but does not define VM_PROFILING */
73: /* #define PROFILE_I "profile-fast.i" */
1.57 anton 74:
1.23 anton 75: #endif
1.57 anton 76:
77:
1.23 anton 78:
1.1 anton 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:
1.6 jwilke 99: #include "machine.h"
1.1 anton 100:
1.68 pazsan 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:
1.1 anton 108: /* Forth data types */
109: /* Cell and UCell must be the same size as a pointer */
110: #define CELL_BITS (sizeof(Cell) * CHAR_BIT)
1.77 anton 111: #define CELL_MIN (((Cell)1)<<(sizeof(Cell)*CHAR_BIT-1))
1.78 ! anton 112:
! 113: #define HALFCELL_BITS (CELL_BITS/2)
! 114: #define HALFCELL_MASK ((~(UCell)0)>>HALFCELL_BITS)
! 115: #define UH(x) (((UCell)(x))>>HALFCELL_BITS)
! 116: #define LH(x) ((x)&HALFCELL_MASK)
! 117: #define L2U(x) (((UCell)(x))<<HALFCELL_BITS)
! 118: #define HIGHBIT(x) (((UCell)(x))>>(CELL_BITS-1))
! 119:
1.1 anton 120: #define FLAG(b) (-(b))
121: #define FILEIO(error) (FLAG(error) & -37)
122: #define FILEEXIST(error) (FLAG(error) & -38)
123:
124: #define F_TRUE (FLAG(0==0))
125: #define F_FALSE (FLAG(0!=0))
126:
1.65 pazsan 127: /* define this false if you want native division */
1.66 pazsan 128: #ifdef FORCE_CDIV
129: #define FLOORED_DIV 0
130: #else
1.65 pazsan 131: #define FLOORED_DIV ((1%-3)>0)
1.66 pazsan 132: #endif
1.65 pazsan 133:
1.1 anton 134: #ifdef BUGGY_LONG_LONG
1.64 pazsan 135:
136: #define BUGGY_LL_CMP /* compares not possible */
137: #define BUGGY_LL_MUL /* multiplication not possible */
138: #define BUGGY_LL_DIV /* division not possible */
139: #define BUGGY_LL_ADD /* addition not possible */
140: #define BUGGY_LL_SHIFT /* shift not possible */
141: #define BUGGY_LL_D2F /* to float not possible */
142: #define BUGGY_LL_F2D /* from float not possible */
143: #define BUGGY_LL_SIZE /* long long "too short", so we use something else */
144:
1.1 anton 145: typedef struct {
146: Cell hi;
147: UCell lo;
148: } DCell;
149:
150: typedef struct {
151: UCell hi;
152: UCell lo;
153: } UDCell;
154:
1.64 pazsan 155: #define DHI(x) (x).hi
156: #define DLO(x) (x).lo
157: #define DHI_IS(x,y) (x).hi=(y)
158: #define DLO_IS(x,y) (x).lo=(y)
159:
1.78 ! anton 160: #define UD2D(ud) ({UDCell _ud=(ud); (DCell){_ud.hi,_ud.lo};})
! 161: #define D2UD(d) ({DCell _d=(d); (UDCell){_d.hi,_d.lo};})
! 162:
1.39 anton 163: #if SMALL_OFF_T
164: #define OFF2UD(o) ({UDCell _ud; _ud.hi=0; _ud.lo=(Cell)(o); _ud;})
165: #define UD2OFF(ud) ((ud).lo)
166: #else /* !SMALL_OFF_T */
167: #define OFF2UD(o) ({UDCell _ud; off_t _o=(o); _ud.hi=_o>>CELL_BITS; _ud.lo=(Cell)_o; _ud;})
1.36 anton 168: #define UD2OFF(ud) ({UDCell _ud=(ud); (((off_t)_ud.hi)<<CELL_BITS)+_ud.lo;})
1.39 anton 169: #endif /* !SMALL_OFF_T */
1.1 anton 170: #define DZERO ((DCell){0,0})
171:
172: #else /* ! defined(BUGGY_LONG_LONG) */
173:
174: /* DCell and UDCell must be twice as large as Cell */
175: typedef DOUBLE_CELL_TYPE DCell;
1.63 pazsan 176: typedef DOUBLE_UCELL_TYPE UDCell;
1.1 anton 177:
1.36 anton 178: #define OFF2UD(o) ((UDCell)(o))
179: #define UD2OFF(ud) ((off_t)(ud))
1.16 anton 180: #define DZERO ((DCell)0)
181:
182: #endif /* ! defined(BUGGY_LONG_LONG) */
183:
1.1 anton 184: typedef union {
185: struct {
1.16 anton 186: #if defined(WORDS_BIGENDIAN)||defined(BUGGY_LONG_LONG)
1.1 anton 187: Cell high;
188: UCell low;
189: #else
190: UCell low;
191: Cell high;
1.20 crook 192: #endif
1.1 anton 193: } cells;
1.16 anton 194: DCell d;
195: UDCell ud;
1.1 anton 196: } Double_Store;
1.64 pazsan 197:
198: #ifndef BUGGY_LONG_LONG
199: #define DHI(x) ({ Double_Store _d; _d.d=(x); _d.cells.high; })
200: #define DLO(x) ({ Double_Store _d; _d.d=(x); _d.cells.low; })
201:
202: /* beware with the assignment: x is referenced twice! */
1.78 ! anton 203: #define DHI_IS(x,y) ({ Double_Store _d; _d.d=(x); _d.cells.high=(y); (x)=_d.d; })
! 204: #define DLO_IS(x,y) ({ Double_Store _d; _d.d=(x); _d.cells.low =(y); (x)=_d.d; })
! 205:
! 206: #define UD2D(ud) ((DCell)(ud))
! 207: #define D2UD(d) ((UDCell)(d))
1.64 pazsan 208: #endif
1.1 anton 209:
1.16 anton 210: #define FETCH_DCELL_T(d_,lo,hi,t_) ({ \
1.1 anton 211: Double_Store _d; \
212: _d.cells.low = (lo); \
213: _d.cells.high = (hi); \
1.16 anton 214: (d_) = _d.t_; \
1.1 anton 215: })
216:
1.16 anton 217: #define STORE_DCELL_T(d_,lo,hi,t_) ({ \
1.1 anton 218: Double_Store _d; \
1.16 anton 219: _d.t_ = (d_); \
1.1 anton 220: (lo) = _d.cells.low; \
221: (hi) = _d.cells.high; \
222: })
223:
1.28 anton 224: #define vm_twoCell2d(lo,hi,d_) FETCH_DCELL_T(d_,lo,hi,d);
225: #define vm_twoCell2ud(lo,hi,d_) FETCH_DCELL_T(d_,lo,hi,ud);
1.1 anton 226:
1.28 anton 227: #define vm_d2twoCell(d_,lo,hi) STORE_DCELL_T(d_,lo,hi,d);
228: #define vm_ud2twoCell(d_,lo,hi) STORE_DCELL_T(d_,lo,hi,ud);
1.1 anton 229:
230: typedef Label *Xt;
231:
232: /* PFA gives the parameter field address corresponding to a cfa */
233: #define PFA(cfa) (((Cell *)cfa)+2)
234: /* PFA1 is a special version for use just after a NEXT1 */
235: #define PFA1(cfa) PFA(cfa)
236: /* CODE_ADDRESS is the address of the code jumped to through the code field */
237: #define CODE_ADDRESS(cfa) (*(Xt)(cfa))
238:
239: /* DOES_CODE is the Forth code does jumps to */
240: #if !defined(DOUBLY_INDIRECT)
241: # define DOES_CA (symbols[DODOES])
242: #else /* defined(DOUBLY_INDIRECT) */
1.24 anton 243: # define DOES_CA ((Label)&xts[DODOES])
1.1 anton 244: #endif /* defined(DOUBLY_INDIRECT) */
245:
246:
247:
248: #define DOES_CODE1(cfa) ((Xt *)(cfa[1]))
249: /* MAKE_CF creates an appropriate code field at the cfa;
250: ca is the code address */
251: #define MAKE_CF(cfa,ca) ((*(Label *)(cfa)) = ((Label)ca))
252: /* make a code field for a defining-word-defined word */
253: #define MAKE_DOES_CF(cfa,does_code) ({MAKE_CF(cfa,DOES_CA); \
254: ((Cell *)cfa)[1] = (Cell)(does_code);})
255:
256: #define CF(const) (-const-2)
257:
258: #define CF_NIL -1
259:
260: #ifndef FLUSH_ICACHE
261: #warning flush-icache probably will not work (see manual)
262: # define FLUSH_ICACHE(addr,size)
1.45 anton 263: #warning no FLUSH_ICACHE, turning off dynamic native code by default
264: #undef NO_DYNAMIC_DEFAULT
265: #define NO_DYNAMIC_DEFAULT 1
1.1 anton 266: #endif
267:
1.67 anton 268: #if defined(GFORTH_DEBUGGING) || defined(INDIRECT_THREADED) || defined(DOUBLY_INDIRECT) || defined(VM_PROFILING)
269: #define STACK_CACHE_DEFAULT 0
1.1 anton 270: #else
1.67 anton 271: #define STACK_CACHE_DEFAULT STACK_CACHE_DEFAULT_FAST
1.1 anton 272: #endif
273:
274: #ifdef USE_FTOS
1.14 anton 275: #define IF_fpTOS(x) x
1.1 anton 276: #else
1.14 anton 277: #define IF_fpTOS(x)
278: #define fpTOS (fp[0])
1.1 anton 279: #endif
280:
1.15 anton 281: #define IF_rpTOS(x)
282: #define rpTOS (rp[0])
283:
1.10 anton 284: typedef struct {
285: Address base; /* base address of image (0 if relocatable) */
286: UCell checksum; /* checksum of ca's to protect against some
287: incompatible binary/executable combinations
288: (0 if relocatable) */
289: UCell image_size; /* all sizes in bytes */
290: UCell dict_size;
291: UCell data_stack_size;
292: UCell fp_stack_size;
293: UCell return_stack_size;
294: UCell locals_stack_size;
295: Xt *boot_entry; /* initial ip for booting (in BOOT) */
296: Xt *throw_entry; /* ip after signal (in THROW) */
297: Cell unused1; /* possibly tib stack size */
1.24 anton 298: Label *xt_base; /* base of DOUBLE_INDIRECT xts[], for comp-i.fs */
1.10 anton 299: Address data_stack_base; /* this and the following fields are initialized by the loader */
300: Address fp_stack_base;
301: Address return_stack_base;
302: Address locals_stack_base;
303: } ImageHeader;
304: /* the image-header is created in main.fs */
305:
1.48 anton 306: struct Longname {
307: struct Longname *next; /* the link field for old hands */
308: Cell countetc;
309: char name[0];
310: };
311:
312: #define LONGNAME_COUNT(np) ((np)->countetc & (((~((UCell)0))<<3)>>3))
313:
314: struct Cellpair {
315: Cell n1;
316: Cell n2;
317: };
318:
319: struct Cellquad {
320: Cell n1;
321: Cell n2;
322: Cell n3;
323: Cell n4;
324: };
1.49 anton 325:
326: #define IOR(flag) ((flag)? -512-errno : 0)
1.48 anton 327:
1.73 pazsan 328: Label *gforth_engine(Xt *ip, Cell *sp, Cell *rp, Float *fp, Address lp);
329: Label *gforth_engine2(Xt *ip, Cell *sp, Cell *rp, Float *fp, Address lp);
330: Label *gforth_engine3(Xt *ip, Cell *sp, Cell *rp, Float *fp, Address lp);
1.48 anton 331:
332: /* engine/prim support routines */
1.71 pazsan 333: Address gforth_alloc(Cell size);
1.35 anton 334: char *cstr(Char *from, UCell size, int clear);
1.11 anton 335: char *tilde_cstr(Char *from, UCell size, int clear);
1.35 anton 336: DCell timeval2us(struct timeval *tvp);
1.48 anton 337: void cmove(Char *c_from, Char *c_to, UCell u);
338: void cmove_up(Char *c_from, Char *c_to, UCell u);
339: Cell compare(Char *c_addr1, UCell u1, Char *c_addr2, UCell u2);
340: struct Longname *listlfind(Char *c_addr, UCell u, struct Longname *longname1);
341: struct Longname *hashlfind(Char *c_addr, UCell u, Cell *a_addr);
342: struct Longname *tablelfind(Char *c_addr, UCell u, Cell *a_addr);
343: UCell hashkey1(Char *c_addr, UCell u, UCell ubits);
344: struct Cellpair parse_white(Char *c_addr1, UCell u1);
345: Cell rename_file(Char *c_addr1, UCell u1, Char *c_addr2, UCell u2);
346: struct Cellquad read_line(Char *c_addr, UCell u1, Cell wfileid);
347: struct Cellpair file_status(Char *c_addr, UCell u);
348: Cell to_float(Char *c_addr, UCell u, Float *rp);
349: Float v_star(Float *f_addr1, Cell nstride1, Float *f_addr2, Cell nstride2, UCell ucount);
350: void faxpy(Float ra, Float *f_x, Cell nstridex, Float *f_y, Cell nstridey, UCell ucount);
1.60 pazsan 351: UCell lshift(UCell u1, UCell n);
352: UCell rshift(UCell u1, UCell n);
1.61 anton 353: int gforth_system(Char *c_addr, UCell u);
1.72 pazsan 354: Cell capscompare(Char *c_addr1, UCell u1, Char *c_addr2, UCell u2);
1.1 anton 355:
1.50 anton 356: /* signal handler stuff */
357: void install_signal_handlers(void);
1.75 anton 358: void throw(int code);
1.76 anton 359: /* throw codes */
360: #define BALL_DIVZERO -10
361: #define BALL_RESULTRANGE -11
362:
1.50 anton 363: typedef void Sigfunc(int);
364: Sigfunc *bsd_signal(int signo, Sigfunc *func);
365:
1.1 anton 366: /* dblsub routines */
367: DCell dnegate(DCell d1);
368: UDCell ummul (UCell a, UCell b);
369: DCell mmul (Cell a, Cell b);
370: UDCell umdiv (UDCell u, UCell v);
371: DCell smdiv (DCell num, Cell denom);
372: DCell fmdiv (DCell num, Cell denom);
373:
1.7 pazsan 374: Cell memcasecmp(const Char *s1, const Char *s2, Cell n);
1.1 anton 375:
1.18 anton 376: void vm_print_profile(FILE *file);
377: void vm_count_block(Xt *ip);
1.17 anton 378:
1.22 anton 379: /* dynamic superinstruction stuff */
1.33 anton 380: void compile_prim1(Cell *start);
381: void finish_code(void);
1.34 anton 382: int forget_dyncode(Address code);
383: Label decompile_code(Label prim);
1.17 anton 384:
1.1 anton 385: extern int offset_image;
1.5 anton 386: extern int die_on_signal;
1.74 anton 387: extern int ignore_async_signals;
1.10 anton 388: extern UCell pagesize;
389: extern ImageHeader *gforth_header;
1.19 anton 390: extern Label *vm_prims;
1.24 anton 391: extern Label *xts;
1.25 anton 392: extern Cell npriminfos;
1.2 pazsan 393:
1.31 anton 394: #ifdef HAS_DEBUG
395: extern int debug;
396: #else
397: # define debug 0
398: #endif
399:
1.71 pazsan 400: extern Cell *gforth_SP;
401: extern Float *gforth_FP;
402: extern Address gforth_UP;
1.35 anton 403:
1.53 pazsan 404: #ifdef HAS_FFCALL
1.71 pazsan 405: extern Cell *gforth_RP;
406: extern Address gforth_LP;
407: extern void gforth_callback(Xt* fcall, void * alist);
1.53 pazsan 408: #endif
409:
1.69 pazsan 410: #ifdef HAS_LIBFFI
1.71 pazsan 411: extern Cell *gforth_RP;
412: extern Address gforth_LP;
1.69 pazsan 413: #include <ffi.h>
1.72 pazsan 414: extern void gforth_callback(ffi_cif * cif, void * resp, void ** args, void * ip);
1.69 pazsan 415: #endif
416:
1.9 anton 417: #ifdef GFORTH_DEBUGGING
1.29 anton 418: extern Xt *saved_ip;
1.9 anton 419: extern Cell *rp;
1.35 anton 420: #endif
421:
422: #ifdef NO_IP
423: extern Label next_code;
424: #endif
425:
426: #ifdef HAS_FILE
427: extern char* fileattr[6];
428: extern char* pfileattr[6];
429: extern int ufileattr[6];
1.9 anton 430: #endif
431:
1.27 anton 432: #ifdef PRINT_SUPER_LENGTHS
433: Cell prim_length(Cell prim);
434: void print_super_lengths();
435: #endif
1.9 anton 436:
1.2 pazsan 437: /* declare all the functions that are missing */
438: #ifndef HAVE_ATANH
439: extern double atanh(double r1);
440: extern double asinh(double r1);
441: extern double acosh(double r1);
442: #endif
443: #ifndef HAVE_ECVT
1.4 anton 444: /* extern char* ecvt(double x, int len, int* exp, int* sign);*/
1.2 pazsan 445: #endif
446: #ifndef HAVE_MEMMOVE
1.3 anton 447: /* extern char *memmove(char *dest, const char *src, long n); */
1.2 pazsan 448: #endif
449: #ifndef HAVE_POW10
450: extern double pow10(double x);
451: #endif
452: #ifndef HAVE_STRERROR
453: extern char *strerror(int err);
454: #endif
455: #ifndef HAVE_STRSIGNAL
456: extern char *strsignal(int sig);
457: #endif
458: #ifndef HAVE_STRTOUL
1.3 anton 459: extern unsigned long int strtoul(const char *nptr, char **endptr, int base);
1.2 pazsan 460: #endif
461:
462:
1.37 pazsan 463: #define GROUP(x, n)
1.53 pazsan 464: #define GROUPADD(n)
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>