Annotation of gforth/engine/forth.h, revision 1.58
1.1 anton 1: /* common header file
2:
1.51 anton 3: Copyright (C) 1995,1996,1997,1998,2000,2003 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 */
57:
58: #define PRIM_I "prim-fast.i"
59: #define PRIM_LAB_I "prim_lab-fast.i"
60: #define PRIM_NAMES_I "prim_names-fast.i"
61: #define PRIM_SUPEREND_I "prim_superend-fast.i"
62: #define PRIM_NUM_I "prim_num-fast.i"
63: #define PRIM_GRP_I "prim_grp-fast.i"
64: #define COSTS_I "costs-fast.i"
65: #define SUPER2_I "super2-fast.i"
1.58 ! anton 66: /* profile.c uses profile.i but does not define VM_PROFILING */
! 67: /* #define PROFILE_I "profile-fast.i" */
1.57 anton 68:
1.23 anton 69: #endif
1.57 anton 70:
71:
1.23 anton 72:
1.1 anton 73: #include <limits.h>
74:
75: #if defined(NeXT)
76: # include <libc.h>
77: #endif /* NeXT */
78:
79: /* symbol indexed constants */
80:
81: #define DOCOL 0
82: #define DOCON 1
83: #define DOVAR 2
84: #define DOUSER 3
85: #define DODEFER 4
86: #define DOFIELD 5
87: #define DODOES 6
88: #define DOESJUMP 7
89:
90: /* the size of the DOESJUMP, which resides between DOES> and the does-code */
91: #define DOES_HANDLER_SIZE (2*sizeof(Cell))
92:
1.6 jwilke 93: #include "machine.h"
1.1 anton 94:
95: /* Forth data types */
96: /* Cell and UCell must be the same size as a pointer */
97: #define CELL_BITS (sizeof(Cell) * CHAR_BIT)
98: #define FLAG(b) (-(b))
99: #define FILEIO(error) (FLAG(error) & -37)
100: #define FILEEXIST(error) (FLAG(error) & -38)
101:
102: #define F_TRUE (FLAG(0==0))
103: #define F_FALSE (FLAG(0!=0))
104:
105: #ifdef BUGGY_LONG_LONG
106: typedef struct {
107: Cell hi;
108: UCell lo;
109: } DCell;
110:
111: typedef struct {
112: UCell hi;
113: UCell lo;
114: } UDCell;
115:
1.39 anton 116: #if SMALL_OFF_T
117: #define OFF2UD(o) ({UDCell _ud; _ud.hi=0; _ud.lo=(Cell)(o); _ud;})
118: #define UD2OFF(ud) ((ud).lo)
119: #else /* !SMALL_OFF_T */
120: #define OFF2UD(o) ({UDCell _ud; off_t _o=(o); _ud.hi=_o>>CELL_BITS; _ud.lo=(Cell)_o; _ud;})
1.36 anton 121: #define UD2OFF(ud) ({UDCell _ud=(ud); (((off_t)_ud.hi)<<CELL_BITS)+_ud.lo;})
1.39 anton 122: #endif /* !SMALL_OFF_T */
1.1 anton 123: #define DZERO ((DCell){0,0})
124:
125: #else /* ! defined(BUGGY_LONG_LONG) */
126:
127: /* DCell and UDCell must be twice as large as Cell */
128: typedef DOUBLE_CELL_TYPE DCell;
129: typedef unsigned DOUBLE_CELL_TYPE UDCell;
130:
1.36 anton 131: #define OFF2UD(o) ((UDCell)(o))
132: #define UD2OFF(ud) ((off_t)(ud))
1.16 anton 133: #define DZERO ((DCell)0)
134:
135: #endif /* ! defined(BUGGY_LONG_LONG) */
136:
1.1 anton 137: typedef union {
138: struct {
1.16 anton 139: #if defined(WORDS_BIGENDIAN)||defined(BUGGY_LONG_LONG)
1.1 anton 140: Cell high;
141: UCell low;
142: #else
143: UCell low;
144: Cell high;
1.20 crook 145: #endif
1.1 anton 146: } cells;
1.16 anton 147: DCell d;
148: UDCell ud;
1.1 anton 149: } Double_Store;
150:
1.16 anton 151: #define FETCH_DCELL_T(d_,lo,hi,t_) ({ \
1.1 anton 152: Double_Store _d; \
153: _d.cells.low = (lo); \
154: _d.cells.high = (hi); \
1.16 anton 155: (d_) = _d.t_; \
1.1 anton 156: })
157:
1.16 anton 158: #define STORE_DCELL_T(d_,lo,hi,t_) ({ \
1.1 anton 159: Double_Store _d; \
1.16 anton 160: _d.t_ = (d_); \
1.1 anton 161: (lo) = _d.cells.low; \
162: (hi) = _d.cells.high; \
163: })
164:
1.28 anton 165: #define vm_twoCell2d(lo,hi,d_) FETCH_DCELL_T(d_,lo,hi,d);
166: #define vm_twoCell2ud(lo,hi,d_) FETCH_DCELL_T(d_,lo,hi,ud);
1.1 anton 167:
1.28 anton 168: #define vm_d2twoCell(d_,lo,hi) STORE_DCELL_T(d_,lo,hi,d);
169: #define vm_ud2twoCell(d_,lo,hi) STORE_DCELL_T(d_,lo,hi,ud);
1.1 anton 170:
171: typedef Label *Xt;
172:
173: /* PFA gives the parameter field address corresponding to a cfa */
174: #define PFA(cfa) (((Cell *)cfa)+2)
175: /* PFA1 is a special version for use just after a NEXT1 */
176: #define PFA1(cfa) PFA(cfa)
177: /* CODE_ADDRESS is the address of the code jumped to through the code field */
178: #define CODE_ADDRESS(cfa) (*(Xt)(cfa))
179:
180: /* DOES_CODE is the Forth code does jumps to */
181: #if !defined(DOUBLY_INDIRECT)
182: # define DOES_CA (symbols[DODOES])
183: #else /* defined(DOUBLY_INDIRECT) */
1.24 anton 184: # define DOES_CA ((Label)&xts[DODOES])
1.1 anton 185: #endif /* defined(DOUBLY_INDIRECT) */
186:
187:
188:
189: #define DOES_CODE1(cfa) ((Xt *)(cfa[1]))
190: /* MAKE_CF creates an appropriate code field at the cfa;
191: ca is the code address */
192: #define MAKE_CF(cfa,ca) ((*(Label *)(cfa)) = ((Label)ca))
193: /* make a code field for a defining-word-defined word */
194: #define MAKE_DOES_CF(cfa,does_code) ({MAKE_CF(cfa,DOES_CA); \
195: ((Cell *)cfa)[1] = (Cell)(does_code);})
196:
197: #define CF(const) (-const-2)
198:
199: #define CF_NIL -1
200:
201: #ifndef FLUSH_ICACHE
202: #warning flush-icache probably will not work (see manual)
203: # define FLUSH_ICACHE(addr,size)
1.45 anton 204: #warning no FLUSH_ICACHE, turning off dynamic native code by default
205: #undef NO_DYNAMIC_DEFAULT
206: #define NO_DYNAMIC_DEFAULT 1
1.1 anton 207: #endif
208:
209: #ifdef USE_TOS
1.14 anton 210: #define IF_spTOS(x) x
1.1 anton 211: #else
1.14 anton 212: #define IF_spTOS(x)
213: #define spTOS (sp[0])
1.1 anton 214: #endif
215:
216: #ifdef USE_FTOS
1.14 anton 217: #define IF_fpTOS(x) x
1.1 anton 218: #else
1.14 anton 219: #define IF_fpTOS(x)
220: #define fpTOS (fp[0])
1.1 anton 221: #endif
222:
1.15 anton 223: #define IF_rpTOS(x)
224: #define rpTOS (rp[0])
225:
1.10 anton 226: typedef struct {
227: Address base; /* base address of image (0 if relocatable) */
228: UCell checksum; /* checksum of ca's to protect against some
229: incompatible binary/executable combinations
230: (0 if relocatable) */
231: UCell image_size; /* all sizes in bytes */
232: UCell dict_size;
233: UCell data_stack_size;
234: UCell fp_stack_size;
235: UCell return_stack_size;
236: UCell locals_stack_size;
237: Xt *boot_entry; /* initial ip for booting (in BOOT) */
238: Xt *throw_entry; /* ip after signal (in THROW) */
239: Cell unused1; /* possibly tib stack size */
1.24 anton 240: Label *xt_base; /* base of DOUBLE_INDIRECT xts[], for comp-i.fs */
1.10 anton 241: Address data_stack_base; /* this and the following fields are initialized by the loader */
242: Address fp_stack_base;
243: Address return_stack_base;
244: Address locals_stack_base;
245: } ImageHeader;
246: /* the image-header is created in main.fs */
247:
1.48 anton 248: struct Longname {
249: struct Longname *next; /* the link field for old hands */
250: Cell countetc;
251: char name[0];
252: };
253:
254: #define LONGNAME_COUNT(np) ((np)->countetc & (((~((UCell)0))<<3)>>3))
255:
256: struct Cellpair {
257: Cell n1;
258: Cell n2;
259: };
260:
261: struct Cellquad {
262: Cell n1;
263: Cell n2;
264: Cell n3;
265: Cell n4;
266: };
1.49 anton 267:
268: #define IOR(flag) ((flag)? -512-errno : 0)
1.48 anton 269:
1.1 anton 270: Label *engine(Xt *ip, Cell *sp, Cell *rp, Float *fp, Address lp);
1.42 anton 271: Label *engine2(Xt *ip, Cell *sp, Cell *rp, Float *fp, Address lp);
272: Label *engine3(Xt *ip, Cell *sp, Cell *rp, Float *fp, Address lp);
1.48 anton 273:
274: /* engine/prim support routines */
1.1 anton 275: Address my_alloc(Cell size);
1.35 anton 276: char *cstr(Char *from, UCell size, int clear);
1.11 anton 277: char *tilde_cstr(Char *from, UCell size, int clear);
1.35 anton 278: DCell timeval2us(struct timeval *tvp);
1.48 anton 279: void cmove(Char *c_from, Char *c_to, UCell u);
280: void cmove_up(Char *c_from, Char *c_to, UCell u);
281: Cell compare(Char *c_addr1, UCell u1, Char *c_addr2, UCell u2);
282: struct Longname *listlfind(Char *c_addr, UCell u, struct Longname *longname1);
283: struct Longname *hashlfind(Char *c_addr, UCell u, Cell *a_addr);
284: struct Longname *tablelfind(Char *c_addr, UCell u, Cell *a_addr);
285: UCell hashkey1(Char *c_addr, UCell u, UCell ubits);
286: struct Cellpair parse_white(Char *c_addr1, UCell u1);
287: Cell rename_file(Char *c_addr1, UCell u1, Char *c_addr2, UCell u2);
288: struct Cellquad read_line(Char *c_addr, UCell u1, Cell wfileid);
289: struct Cellpair file_status(Char *c_addr, UCell u);
290: Cell to_float(Char *c_addr, UCell u, Float *rp);
291: Float v_star(Float *f_addr1, Cell nstride1, Float *f_addr2, Cell nstride2, UCell ucount);
292: void faxpy(Float ra, Float *f_x, Cell nstridex, Float *f_y, Cell nstridey, UCell ucount);
1.1 anton 293:
1.50 anton 294: /* signal handler stuff */
295: void install_signal_handlers(void);
296: typedef void Sigfunc(int);
297: Sigfunc *bsd_signal(int signo, Sigfunc *func);
298:
1.1 anton 299: /* dblsub routines */
300: DCell dnegate(DCell d1);
301: UDCell ummul (UCell a, UCell b);
302: DCell mmul (Cell a, Cell b);
303: UDCell umdiv (UDCell u, UCell v);
304: DCell smdiv (DCell num, Cell denom);
305: DCell fmdiv (DCell num, Cell denom);
306:
1.7 pazsan 307: Cell memcasecmp(const Char *s1, const Char *s2, Cell n);
1.1 anton 308:
1.18 anton 309: void vm_print_profile(FILE *file);
310: void vm_count_block(Xt *ip);
1.17 anton 311:
1.22 anton 312: /* dynamic superinstruction stuff */
1.33 anton 313: void compile_prim1(Cell *start);
314: void finish_code(void);
1.34 anton 315: int forget_dyncode(Address code);
316: Label decompile_code(Label prim);
1.17 anton 317:
1.1 anton 318: extern int offset_image;
1.5 anton 319: extern int die_on_signal;
1.10 anton 320: extern UCell pagesize;
321: extern ImageHeader *gforth_header;
1.19 anton 322: extern Label *vm_prims;
1.24 anton 323: extern Label *xts;
1.25 anton 324: extern Cell npriminfos;
1.2 pazsan 325:
1.31 anton 326: #ifdef HAS_DEBUG
327: extern int debug;
328: #else
329: # define debug 0
330: #endif
331:
1.35 anton 332: extern Cell *SP;
333: extern Float *FP;
334: extern Address UP;
335:
1.53 pazsan 336: #ifdef HAS_FFCALL
337: extern Cell *RP;
338: extern Address LP;
1.54 pazsan 339: extern void engine_callback(Xt* fcall, void * alist);
1.53 pazsan 340: #endif
341:
1.9 anton 342: #ifdef GFORTH_DEBUGGING
1.29 anton 343: extern Xt *saved_ip;
1.9 anton 344: extern Cell *rp;
1.35 anton 345: #endif
346:
347: #ifdef NO_IP
348: extern Label next_code;
349: #endif
350:
351: #ifdef HAS_FILE
352: extern char* fileattr[6];
353: extern char* pfileattr[6];
354: extern int ufileattr[6];
1.9 anton 355: #endif
356:
1.27 anton 357: #ifdef PRINT_SUPER_LENGTHS
358: Cell prim_length(Cell prim);
359: void print_super_lengths();
360: #endif
1.9 anton 361:
1.2 pazsan 362: /* declare all the functions that are missing */
363: #ifndef HAVE_ATANH
364: extern double atanh(double r1);
365: extern double asinh(double r1);
366: extern double acosh(double r1);
367: #endif
368: #ifndef HAVE_ECVT
1.4 anton 369: /* extern char* ecvt(double x, int len, int* exp, int* sign);*/
1.2 pazsan 370: #endif
371: #ifndef HAVE_MEMMOVE
1.3 anton 372: /* extern char *memmove(char *dest, const char *src, long n); */
1.2 pazsan 373: #endif
374: #ifndef HAVE_POW10
375: extern double pow10(double x);
376: #endif
377: #ifndef HAVE_STRERROR
378: extern char *strerror(int err);
379: #endif
380: #ifndef HAVE_STRSIGNAL
381: extern char *strsignal(int sig);
382: #endif
383: #ifndef HAVE_STRTOUL
1.3 anton 384: extern unsigned long int strtoul(const char *nptr, char **endptr, int base);
1.2 pazsan 385: #endif
386:
387:
1.37 pazsan 388: #define GROUP(x, n)
1.53 pazsan 389: #define GROUPADD(n)
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>