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