Annotation of gforth/engine/forth.h, revision 1.42
1.1 anton 1: /* common header file
2:
1.12 anton 3: Copyright (C) 1995,1996,1997,1998,2000 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.23 anton 37: #if defined(GFORTH_DEBUGGING)
38: # undef USE_TOS
39: # undef USE_FTOS
40: # define USE_NO_TOS
41: # define USE_NO_FTOS
42: #endif
43:
1.1 anton 44: #include <limits.h>
45:
46: #if defined(NeXT)
47: # include <libc.h>
48: #endif /* NeXT */
49:
50: /* symbol indexed constants */
51:
52: #define DOCOL 0
53: #define DOCON 1
54: #define DOVAR 2
55: #define DOUSER 3
56: #define DODEFER 4
57: #define DOFIELD 5
58: #define DODOES 6
59: #define DOESJUMP 7
60:
61: /* the size of the DOESJUMP, which resides between DOES> and the does-code */
62: #define DOES_HANDLER_SIZE (2*sizeof(Cell))
63:
1.6 jwilke 64: #include "machine.h"
1.1 anton 65:
66: /* Forth data types */
67: /* Cell and UCell must be the same size as a pointer */
68: #define CELL_BITS (sizeof(Cell) * CHAR_BIT)
69: #define FLAG(b) (-(b))
70: #define FILEIO(error) (FLAG(error) & -37)
71: #define FILEEXIST(error) (FLAG(error) & -38)
72:
73: #define F_TRUE (FLAG(0==0))
74: #define F_FALSE (FLAG(0!=0))
75:
76: #ifdef BUGGY_LONG_LONG
77: typedef struct {
78: Cell hi;
79: UCell lo;
80: } DCell;
81:
82: typedef struct {
83: UCell hi;
84: UCell lo;
85: } UDCell;
86:
1.39 anton 87: #if SMALL_OFF_T
88: #define OFF2UD(o) ({UDCell _ud; _ud.hi=0; _ud.lo=(Cell)(o); _ud;})
89: #define UD2OFF(ud) ((ud).lo)
90: #else /* !SMALL_OFF_T */
91: #define OFF2UD(o) ({UDCell _ud; off_t _o=(o); _ud.hi=_o>>CELL_BITS; _ud.lo=(Cell)_o; _ud;})
1.36 anton 92: #define UD2OFF(ud) ({UDCell _ud=(ud); (((off_t)_ud.hi)<<CELL_BITS)+_ud.lo;})
1.39 anton 93: #endif /* !SMALL_OFF_T */
1.1 anton 94: #define DZERO ((DCell){0,0})
95:
96: #else /* ! defined(BUGGY_LONG_LONG) */
97:
98: /* DCell and UDCell must be twice as large as Cell */
99: typedef DOUBLE_CELL_TYPE DCell;
100: typedef unsigned DOUBLE_CELL_TYPE UDCell;
101:
1.36 anton 102: #define OFF2UD(o) ((UDCell)(o))
103: #define UD2OFF(ud) ((off_t)(ud))
1.16 anton 104: #define DZERO ((DCell)0)
105:
106: #endif /* ! defined(BUGGY_LONG_LONG) */
107:
1.1 anton 108: typedef union {
109: struct {
1.16 anton 110: #if defined(WORDS_BIGENDIAN)||defined(BUGGY_LONG_LONG)
1.1 anton 111: Cell high;
112: UCell low;
113: #else
114: UCell low;
115: Cell high;
1.20 crook 116: #endif
1.1 anton 117: } cells;
1.16 anton 118: DCell d;
119: UDCell ud;
1.1 anton 120: } Double_Store;
121:
1.16 anton 122: #define FETCH_DCELL_T(d_,lo,hi,t_) ({ \
1.1 anton 123: Double_Store _d; \
124: _d.cells.low = (lo); \
125: _d.cells.high = (hi); \
1.16 anton 126: (d_) = _d.t_; \
1.1 anton 127: })
128:
1.16 anton 129: #define STORE_DCELL_T(d_,lo,hi,t_) ({ \
1.1 anton 130: Double_Store _d; \
1.16 anton 131: _d.t_ = (d_); \
1.1 anton 132: (lo) = _d.cells.low; \
133: (hi) = _d.cells.high; \
134: })
135:
1.28 anton 136: #define vm_twoCell2d(lo,hi,d_) FETCH_DCELL_T(d_,lo,hi,d);
137: #define vm_twoCell2ud(lo,hi,d_) FETCH_DCELL_T(d_,lo,hi,ud);
1.1 anton 138:
1.28 anton 139: #define vm_d2twoCell(d_,lo,hi) STORE_DCELL_T(d_,lo,hi,d);
140: #define vm_ud2twoCell(d_,lo,hi) STORE_DCELL_T(d_,lo,hi,ud);
1.1 anton 141:
142: typedef Label *Xt;
143:
144: /* PFA gives the parameter field address corresponding to a cfa */
145: #define PFA(cfa) (((Cell *)cfa)+2)
146: /* PFA1 is a special version for use just after a NEXT1 */
147: #define PFA1(cfa) PFA(cfa)
148: /* CODE_ADDRESS is the address of the code jumped to through the code field */
149: #define CODE_ADDRESS(cfa) (*(Xt)(cfa))
150:
151: /* DOES_CODE is the Forth code does jumps to */
152: #if !defined(DOUBLY_INDIRECT)
153: # define DOES_CA (symbols[DODOES])
154: #else /* defined(DOUBLY_INDIRECT) */
1.24 anton 155: # define DOES_CA ((Label)&xts[DODOES])
1.1 anton 156: #endif /* defined(DOUBLY_INDIRECT) */
157:
158:
159:
160: #define DOES_CODE(cfa) ({Xt _cfa=(Xt)(cfa); \
161: (Xt *)(_cfa[0]==DOES_CA ? _cfa[1] : NULL);})
162: #define DOES_CODE1(cfa) ((Xt *)(cfa[1]))
163: /* MAKE_CF creates an appropriate code field at the cfa;
164: ca is the code address */
165: #define MAKE_CF(cfa,ca) ((*(Label *)(cfa)) = ((Label)ca))
166: /* make a code field for a defining-word-defined word */
167: #define MAKE_DOES_CF(cfa,does_code) ({MAKE_CF(cfa,DOES_CA); \
168: ((Cell *)cfa)[1] = (Cell)(does_code);})
169: /* the does handler resides between DOES> and the following Forth code */
170: /* not needed in indirect threaded code */
171: #if defined(DOUBLY_INDIRECT)
172: #define MAKE_DOES_HANDLER(addr) MAKE_CF(addr, ((Label)&symbols[DOESJUMP]))
173: #else /* !defined(DOUBLY_INDIRECT) */
1.42 ! anton 174: #define MAKE_DOES_HANDLER(addr) ((void)0)
1.1 anton 175: #endif /* !defined(DOUBLY_INDIRECT) */
176:
1.29 anton 177: #ifdef GFORTH_DEBUGGING
1.30 anton 178: #define NAME(string) { saved_ip=ip; asm(""); }
179: /* the asm here is to avoid reordering of following stuff above the
180: assignment; this is an old-style asm (no operands), and therefore
181: is treated like "asm volatile ..."; i.e., it prevents most
182: reorderings across itself. We want the assignment above first,
183: because the stack loads may already cause a stack underflow. */
1.29 anton 184: #elif DEBUG
1.1 anton 185: # define NAME(string) fprintf(stderr,"%08lx: "string"\n",(Cell)ip);
186: #else
187: # define NAME(string)
188: #endif
189:
190: #define CF(const) (-const-2)
191:
192: #define CF_NIL -1
193:
194: #ifndef FLUSH_ICACHE
195: #warning flush-icache probably will not work (see manual)
196: # define FLUSH_ICACHE(addr,size)
197: #endif
198:
199: #ifdef USE_TOS
1.14 anton 200: #define IF_spTOS(x) x
1.1 anton 201: #else
1.14 anton 202: #define IF_spTOS(x)
203: #define spTOS (sp[0])
1.1 anton 204: #endif
205:
206: #ifdef USE_FTOS
1.14 anton 207: #define IF_fpTOS(x) x
1.1 anton 208: #else
1.14 anton 209: #define IF_fpTOS(x)
210: #define fpTOS (fp[0])
1.1 anton 211: #endif
212:
1.15 anton 213: #define IF_rpTOS(x)
214: #define rpTOS (rp[0])
215:
1.10 anton 216: typedef struct {
217: Address base; /* base address of image (0 if relocatable) */
218: UCell checksum; /* checksum of ca's to protect against some
219: incompatible binary/executable combinations
220: (0 if relocatable) */
221: UCell image_size; /* all sizes in bytes */
222: UCell dict_size;
223: UCell data_stack_size;
224: UCell fp_stack_size;
225: UCell return_stack_size;
226: UCell locals_stack_size;
227: Xt *boot_entry; /* initial ip for booting (in BOOT) */
228: Xt *throw_entry; /* ip after signal (in THROW) */
229: Cell unused1; /* possibly tib stack size */
1.24 anton 230: Label *xt_base; /* base of DOUBLE_INDIRECT xts[], for comp-i.fs */
1.10 anton 231: Address data_stack_base; /* this and the following fields are initialized by the loader */
232: Address fp_stack_base;
233: Address return_stack_base;
234: Address locals_stack_base;
235: } ImageHeader;
236: /* the image-header is created in main.fs */
237:
1.1 anton 238: Label *engine(Xt *ip, Cell *sp, Cell *rp, Float *fp, Address lp);
1.42 ! anton 239: Label *engine2(Xt *ip, Cell *sp, Cell *rp, Float *fp, Address lp);
! 240: Label *engine3(Xt *ip, Cell *sp, Cell *rp, Float *fp, Address lp);
1.1 anton 241: Address my_alloc(Cell size);
1.35 anton 242: char *cstr(Char *from, UCell size, int clear);
1.11 anton 243: char *tilde_cstr(Char *from, UCell size, int clear);
1.35 anton 244: DCell timeval2us(struct timeval *tvp);
1.1 anton 245:
246: /* dblsub routines */
247: DCell dnegate(DCell d1);
248: UDCell ummul (UCell a, UCell b);
249: DCell mmul (Cell a, Cell b);
250: UDCell umdiv (UDCell u, UCell v);
251: DCell smdiv (DCell num, Cell denom);
252: DCell fmdiv (DCell num, Cell denom);
253:
1.7 pazsan 254: Cell memcasecmp(const Char *s1, const Char *s2, Cell n);
1.1 anton 255:
1.17 anton 256: /* peephole routines */
257:
258: Xt *primtable(Label symbols[], Cell size);
259: Cell prepare_peephole_table(Xt xts[]);
260: Xt peephole_opt(Xt xt1, Xt xt2, Cell peeptable);
1.18 anton 261: void vm_print_profile(FILE *file);
262: void vm_count_block(Xt *ip);
1.17 anton 263:
1.22 anton 264: /* dynamic superinstruction stuff */
265: Label compile_prim(Label prim);
1.33 anton 266: void compile_prim1(Cell *start);
267: void finish_code(void);
1.34 anton 268: int forget_dyncode(Address code);
269: Label decompile_code(Label prim);
1.17 anton 270:
1.1 anton 271: extern int offset_image;
1.5 anton 272: extern int die_on_signal;
1.10 anton 273: extern UCell pagesize;
274: extern ImageHeader *gforth_header;
1.19 anton 275: extern Label *vm_prims;
1.24 anton 276: extern Label *xts;
1.25 anton 277: extern Cell npriminfos;
1.2 pazsan 278:
1.31 anton 279: #ifdef HAS_DEBUG
280: extern int debug;
281: #else
282: # define debug 0
283: #endif
284:
1.35 anton 285: extern Cell *SP;
286: extern Float *FP;
287: extern Address UP;
288:
1.9 anton 289: #ifdef GFORTH_DEBUGGING
1.29 anton 290: extern Xt *saved_ip;
1.9 anton 291: extern Cell *rp;
1.35 anton 292: #endif
293:
294: #ifdef NO_IP
295: extern Label next_code;
296: #endif
297:
298: #ifdef HAS_FILE
299: extern char* fileattr[6];
300: extern char* pfileattr[6];
301: extern int ufileattr[6];
1.9 anton 302: #endif
303:
1.27 anton 304: #ifdef PRINT_SUPER_LENGTHS
305: Cell prim_length(Cell prim);
306: void print_super_lengths();
307: #endif
1.9 anton 308:
1.2 pazsan 309: /* declare all the functions that are missing */
310: #ifndef HAVE_ATANH
311: extern double atanh(double r1);
312: extern double asinh(double r1);
313: extern double acosh(double r1);
314: #endif
315: #ifndef HAVE_ECVT
1.4 anton 316: /* extern char* ecvt(double x, int len, int* exp, int* sign);*/
1.2 pazsan 317: #endif
318: #ifndef HAVE_MEMMOVE
1.3 anton 319: /* extern char *memmove(char *dest, const char *src, long n); */
1.2 pazsan 320: #endif
321: #ifndef HAVE_POW10
322: extern double pow10(double x);
323: #endif
324: #ifndef HAVE_STRERROR
325: extern char *strerror(int err);
326: #endif
327: #ifndef HAVE_STRSIGNAL
328: extern char *strsignal(int sig);
329: #endif
330: #ifndef HAVE_STRTOUL
1.3 anton 331: extern unsigned long int strtoul(const char *nptr, char **endptr, int base);
1.2 pazsan 332: #endif
333:
334:
1.37 pazsan 335: #define GROUP(x, n)
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>