Annotation of gforth/engine/forth.h, revision 1.75
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)
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:
1.65 pazsan 118: /* define this false if you want native division */
1.66 pazsan 119: #ifdef FORCE_CDIV
120: #define FLOORED_DIV 0
121: #else
1.65 pazsan 122: #define FLOORED_DIV ((1%-3)>0)
1.66 pazsan 123: #endif
1.65 pazsan 124:
1.1 anton 125: #ifdef BUGGY_LONG_LONG
1.64 pazsan 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:
1.1 anton 136: typedef struct {
137: Cell hi;
138: UCell lo;
139: } DCell;
140:
141: typedef struct {
142: UCell hi;
143: UCell lo;
144: } UDCell;
145:
1.64 pazsan 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:
1.39 anton 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;})
1.36 anton 156: #define UD2OFF(ud) ({UDCell _ud=(ud); (((off_t)_ud.hi)<<CELL_BITS)+_ud.lo;})
1.39 anton 157: #endif /* !SMALL_OFF_T */
1.1 anton 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;
1.63 pazsan 164: typedef DOUBLE_UCELL_TYPE UDCell;
1.1 anton 165:
1.36 anton 166: #define OFF2UD(o) ((UDCell)(o))
167: #define UD2OFF(ud) ((off_t)(ud))
1.16 anton 168: #define DZERO ((DCell)0)
169:
170: #endif /* ! defined(BUGGY_LONG_LONG) */
171:
1.1 anton 172: typedef union {
173: struct {
1.16 anton 174: #if defined(WORDS_BIGENDIAN)||defined(BUGGY_LONG_LONG)
1.1 anton 175: Cell high;
176: UCell low;
177: #else
178: UCell low;
179: Cell high;
1.20 crook 180: #endif
1.1 anton 181: } cells;
1.16 anton 182: DCell d;
183: UDCell ud;
1.1 anton 184: } Double_Store;
1.64 pazsan 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
1.1 anton 194:
1.16 anton 195: #define FETCH_DCELL_T(d_,lo,hi,t_) ({ \
1.1 anton 196: Double_Store _d; \
197: _d.cells.low = (lo); \
198: _d.cells.high = (hi); \
1.16 anton 199: (d_) = _d.t_; \
1.1 anton 200: })
201:
1.16 anton 202: #define STORE_DCELL_T(d_,lo,hi,t_) ({ \
1.1 anton 203: Double_Store _d; \
1.16 anton 204: _d.t_ = (d_); \
1.1 anton 205: (lo) = _d.cells.low; \
206: (hi) = _d.cells.high; \
207: })
208:
1.28 anton 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);
1.1 anton 211:
1.28 anton 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);
1.1 anton 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) */
1.24 anton 228: # define DOES_CA ((Label)&xts[DODOES])
1.1 anton 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)
1.45 anton 248: #warning no FLUSH_ICACHE, turning off dynamic native code by default
249: #undef NO_DYNAMIC_DEFAULT
250: #define NO_DYNAMIC_DEFAULT 1
1.1 anton 251: #endif
252:
1.67 anton 253: #if defined(GFORTH_DEBUGGING) || defined(INDIRECT_THREADED) || defined(DOUBLY_INDIRECT) || defined(VM_PROFILING)
254: #define STACK_CACHE_DEFAULT 0
1.1 anton 255: #else
1.67 anton 256: #define STACK_CACHE_DEFAULT STACK_CACHE_DEFAULT_FAST
1.1 anton 257: #endif
258:
259: #ifdef USE_FTOS
1.14 anton 260: #define IF_fpTOS(x) x
1.1 anton 261: #else
1.14 anton 262: #define IF_fpTOS(x)
263: #define fpTOS (fp[0])
1.1 anton 264: #endif
265:
1.15 anton 266: #define IF_rpTOS(x)
267: #define rpTOS (rp[0])
268:
1.10 anton 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 */
1.24 anton 283: Label *xt_base; /* base of DOUBLE_INDIRECT xts[], for comp-i.fs */
1.10 anton 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:
1.48 anton 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: };
1.49 anton 310:
311: #define IOR(flag) ((flag)? -512-errno : 0)
1.48 anton 312:
1.73 pazsan 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);
1.48 anton 316:
317: /* engine/prim support routines */
1.71 pazsan 318: Address gforth_alloc(Cell size);
1.35 anton 319: char *cstr(Char *from, UCell size, int clear);
1.11 anton 320: char *tilde_cstr(Char *from, UCell size, int clear);
1.35 anton 321: DCell timeval2us(struct timeval *tvp);
1.48 anton 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);
1.60 pazsan 336: UCell lshift(UCell u1, UCell n);
337: UCell rshift(UCell u1, UCell n);
1.61 anton 338: int gforth_system(Char *c_addr, UCell u);
1.72 pazsan 339: Cell capscompare(Char *c_addr1, UCell u1, Char *c_addr2, UCell u2);
1.1 anton 340:
1.50 anton 341: /* signal handler stuff */
342: void install_signal_handlers(void);
1.75 ! anton 343: void throw(int code);
1.50 anton 344: typedef void Sigfunc(int);
345: Sigfunc *bsd_signal(int signo, Sigfunc *func);
346:
1.1 anton 347: /* dblsub routines */
348: DCell dnegate(DCell d1);
349: UDCell ummul (UCell a, UCell b);
350: DCell mmul (Cell a, Cell b);
351: UDCell umdiv (UDCell u, UCell v);
352: DCell smdiv (DCell num, Cell denom);
353: DCell fmdiv (DCell num, Cell denom);
354:
1.7 pazsan 355: Cell memcasecmp(const Char *s1, const Char *s2, Cell n);
1.1 anton 356:
1.18 anton 357: void vm_print_profile(FILE *file);
358: void vm_count_block(Xt *ip);
1.17 anton 359:
1.22 anton 360: /* dynamic superinstruction stuff */
1.33 anton 361: void compile_prim1(Cell *start);
362: void finish_code(void);
1.34 anton 363: int forget_dyncode(Address code);
364: Label decompile_code(Label prim);
1.17 anton 365:
1.1 anton 366: extern int offset_image;
1.5 anton 367: extern int die_on_signal;
1.74 anton 368: extern int ignore_async_signals;
1.10 anton 369: extern UCell pagesize;
370: extern ImageHeader *gforth_header;
1.19 anton 371: extern Label *vm_prims;
1.24 anton 372: extern Label *xts;
1.25 anton 373: extern Cell npriminfos;
1.2 pazsan 374:
1.31 anton 375: #ifdef HAS_DEBUG
376: extern int debug;
377: #else
378: # define debug 0
379: #endif
380:
1.71 pazsan 381: extern Cell *gforth_SP;
382: extern Float *gforth_FP;
383: extern Address gforth_UP;
1.35 anton 384:
1.53 pazsan 385: #ifdef HAS_FFCALL
1.71 pazsan 386: extern Cell *gforth_RP;
387: extern Address gforth_LP;
388: extern void gforth_callback(Xt* fcall, void * alist);
1.53 pazsan 389: #endif
390:
1.69 pazsan 391: #ifdef HAS_LIBFFI
1.71 pazsan 392: extern Cell *gforth_RP;
393: extern Address gforth_LP;
1.69 pazsan 394: #include <ffi.h>
1.72 pazsan 395: extern void gforth_callback(ffi_cif * cif, void * resp, void ** args, void * ip);
1.69 pazsan 396: #endif
397:
1.9 anton 398: #ifdef GFORTH_DEBUGGING
1.29 anton 399: extern Xt *saved_ip;
1.9 anton 400: extern Cell *rp;
1.35 anton 401: #endif
402:
403: #ifdef NO_IP
404: extern Label next_code;
405: #endif
406:
407: #ifdef HAS_FILE
408: extern char* fileattr[6];
409: extern char* pfileattr[6];
410: extern int ufileattr[6];
1.9 anton 411: #endif
412:
1.27 anton 413: #ifdef PRINT_SUPER_LENGTHS
414: Cell prim_length(Cell prim);
415: void print_super_lengths();
416: #endif
1.9 anton 417:
1.2 pazsan 418: /* declare all the functions that are missing */
419: #ifndef HAVE_ATANH
420: extern double atanh(double r1);
421: extern double asinh(double r1);
422: extern double acosh(double r1);
423: #endif
424: #ifndef HAVE_ECVT
1.4 anton 425: /* extern char* ecvt(double x, int len, int* exp, int* sign);*/
1.2 pazsan 426: #endif
427: #ifndef HAVE_MEMMOVE
1.3 anton 428: /* extern char *memmove(char *dest, const char *src, long n); */
1.2 pazsan 429: #endif
430: #ifndef HAVE_POW10
431: extern double pow10(double x);
432: #endif
433: #ifndef HAVE_STRERROR
434: extern char *strerror(int err);
435: #endif
436: #ifndef HAVE_STRSIGNAL
437: extern char *strsignal(int sig);
438: #endif
439: #ifndef HAVE_STRTOUL
1.3 anton 440: extern unsigned long int strtoul(const char *nptr, char **endptr, int base);
1.2 pazsan 441: #endif
442:
443:
1.37 pazsan 444: #define GROUP(x, n)
1.53 pazsan 445: #define GROUPADD(n)
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>