Annotation of gforth/engine/forth.h, revision 1.14
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:
1.14 ! anton 22: #define _GNU_SOURCE
! 23:
1.1 anton 24: #include "config.h"
25:
26: #if defined(DOUBLY_INDIRECT)
27: # undef DIRECT_THREADED
28: # undef INDIRECT_THREADED
29: # define INDIRECT_THREADED
30: #endif
31:
32: #include <limits.h>
33:
34: #if defined(NeXT)
35: # include <libc.h>
36: #endif /* NeXT */
37:
38: /* symbol indexed constants */
39:
40: #define DOCOL 0
41: #define DOCON 1
42: #define DOVAR 2
43: #define DOUSER 3
44: #define DODEFER 4
45: #define DOFIELD 5
46: #define DODOES 6
47: #define DOESJUMP 7
48:
49: /* the size of the DOESJUMP, which resides between DOES> and the does-code */
50: #define DOES_HANDLER_SIZE (2*sizeof(Cell))
51:
1.6 jwilke 52: #include "machine.h"
1.1 anton 53:
54: /* Forth data types */
55: /* Cell and UCell must be the same size as a pointer */
56: #define CELL_BITS (sizeof(Cell) * CHAR_BIT)
57: #define FLAG(b) (-(b))
58: #define FILEIO(error) (FLAG(error) & -37)
59: #define FILEEXIST(error) (FLAG(error) & -38)
60:
61: #define F_TRUE (FLAG(0==0))
62: #define F_FALSE (FLAG(0!=0))
63:
64: #ifdef BUGGY_LONG_LONG
65: typedef struct {
66: Cell hi;
67: UCell lo;
68: } DCell;
69:
70: typedef struct {
71: UCell hi;
72: UCell lo;
73: } UDCell;
74:
75: #define FETCH_DCELL(d,lo,hi) ((d)=(typeof(d)){(hi),(lo)})
76: #define STORE_DCELL(d,low,high) ({ \
77: typeof(d) _d = (d); \
78: (low) = _d.lo; \
79: (high)= _d.hi; \
80: })
81:
82: #define LONG2UD(l) ({UDCell _ud; _ud.hi=0; _ud.lo=(Cell)(l); _ud;})
83: #define UD2LONG(ud) ((long)(ud.lo))
84: #define DZERO ((DCell){0,0})
85:
86: #else /* ! defined(BUGGY_LONG_LONG) */
87:
88: /* DCell and UDCell must be twice as large as Cell */
89: typedef DOUBLE_CELL_TYPE DCell;
90: typedef unsigned DOUBLE_CELL_TYPE UDCell;
91:
92: typedef union {
93: struct {
94: #ifdef WORDS_BIGENDIAN
95: Cell high;
96: UCell low;
97: #else
98: UCell low;
99: Cell high;
100: #endif;
101: } cells;
102: DCell dcell;
103: } Double_Store;
104:
105: #define FETCH_DCELL(d,lo,hi) ({ \
106: Double_Store _d; \
107: _d.cells.low = (lo); \
108: _d.cells.high = (hi); \
109: (d) = _d.dcell; \
110: })
111:
112: #define STORE_DCELL(d,lo,hi) ({ \
113: Double_Store _d; \
114: _d.dcell = (d); \
115: (lo) = _d.cells.low; \
116: (hi) = _d.cells.high; \
117: })
118:
119: #define LONG2UD(l) ((UDCell)(l))
120: #define UD2LONG(ud) ((long)(ud))
121: #define DZERO ((DCell)0)
122:
123: #endif /* ! defined(BUGGY_LONG_LONG) */
124:
125: #ifdef DIRECT_THREADED
126: typedef Label Xt;
127: #else
128: typedef Label *Xt;
129: #endif
130:
131: #if !defined(DIRECT_THREADED)
132: /* i.e. indirect threaded our doubly indirect threaded */
133: /* the direct threaded version is machine dependent and resides in machine.h */
134:
135: /* PFA gives the parameter field address corresponding to a cfa */
136: #define PFA(cfa) (((Cell *)cfa)+2)
137: /* PFA1 is a special version for use just after a NEXT1 */
138: #define PFA1(cfa) PFA(cfa)
139: /* CODE_ADDRESS is the address of the code jumped to through the code field */
140: #define CODE_ADDRESS(cfa) (*(Xt)(cfa))
141:
142: /* DOES_CODE is the Forth code does jumps to */
143: #if !defined(DOUBLY_INDIRECT)
144: # define DOES_CA (symbols[DODOES])
145: #else /* defined(DOUBLY_INDIRECT) */
146: # define DOES_CA ((Label)&symbols[DODOES])
147: #endif /* defined(DOUBLY_INDIRECT) */
148:
149:
150:
151: #define DOES_CODE(cfa) ({Xt _cfa=(Xt)(cfa); \
152: (Xt *)(_cfa[0]==DOES_CA ? _cfa[1] : NULL);})
153: #define DOES_CODE1(cfa) ((Xt *)(cfa[1]))
154: /* MAKE_CF creates an appropriate code field at the cfa;
155: ca is the code address */
156: #define MAKE_CF(cfa,ca) ((*(Label *)(cfa)) = ((Label)ca))
157: /* make a code field for a defining-word-defined word */
158: #define MAKE_DOES_CF(cfa,does_code) ({MAKE_CF(cfa,DOES_CA); \
159: ((Cell *)cfa)[1] = (Cell)(does_code);})
160: /* the does handler resides between DOES> and the following Forth code */
161: /* not needed in indirect threaded code */
162: #if defined(DOUBLY_INDIRECT)
163: #define MAKE_DOES_HANDLER(addr) MAKE_CF(addr, ((Label)&symbols[DOESJUMP]))
164: #else /* !defined(DOUBLY_INDIRECT) */
165: #define MAKE_DOES_HANDLER(addr) 0
166: #endif /* !defined(DOUBLY_INDIRECT) */
167: #endif /* !defined(DIRECT_THREADED) */
168:
169: #ifdef DEBUG
170: # define NAME(string) fprintf(stderr,"%08lx: "string"\n",(Cell)ip);
171: #else
172: # define NAME(string)
173: #endif
174:
175: #define CF(const) (-const-2)
176:
177: #define CF_NIL -1
178:
179: #ifndef FLUSH_ICACHE
180: #warning flush-icache probably will not work (see manual)
181: # define FLUSH_ICACHE(addr,size)
182: #endif
183:
184: #if defined(DIRECT_THREADED)
185: #define CACHE_FLUSH(addr,size) FLUSH_ICACHE(addr,size)
186: #else
187: #define CACHE_FLUSH(addr,size)
188: #endif
189:
190: #ifdef USE_TOS
1.14 ! anton 191: #define IF_spTOS(x) x
1.1 anton 192: #else
1.14 ! anton 193: #define IF_spTOS(x)
! 194: #define spTOS (sp[0])
1.1 anton 195: #endif
196:
197: #ifdef USE_FTOS
1.14 ! anton 198: #define IF_fpTOS(x) x
1.1 anton 199: #else
1.14 ! anton 200: #define IF_fpTOS(x)
! 201: #define fpTOS (fp[0])
1.1 anton 202: #endif
203:
1.10 anton 204: typedef struct {
205: Address base; /* base address of image (0 if relocatable) */
206: UCell checksum; /* checksum of ca's to protect against some
207: incompatible binary/executable combinations
208: (0 if relocatable) */
209: UCell image_size; /* all sizes in bytes */
210: UCell dict_size;
211: UCell data_stack_size;
212: UCell fp_stack_size;
213: UCell return_stack_size;
214: UCell locals_stack_size;
215: Xt *boot_entry; /* initial ip for booting (in BOOT) */
216: Xt *throw_entry; /* ip after signal (in THROW) */
217: Cell unused1; /* possibly tib stack size */
218: Cell unused2;
219: Address data_stack_base; /* this and the following fields are initialized by the loader */
220: Address fp_stack_base;
221: Address return_stack_base;
222: Address locals_stack_base;
223: } ImageHeader;
224: /* the image-header is created in main.fs */
225:
1.1 anton 226: Label *engine(Xt *ip, Cell *sp, Cell *rp, Float *fp, Address lp);
227: Address my_alloc(Cell size);
1.11 anton 228: char *tilde_cstr(Char *from, UCell size, int clear);
1.1 anton 229:
230: /* dblsub routines */
231: DCell dnegate(DCell d1);
232: UDCell ummul (UCell a, UCell b);
233: DCell mmul (Cell a, Cell b);
234: UDCell umdiv (UDCell u, UCell v);
235: DCell smdiv (DCell num, Cell denom);
236: DCell fmdiv (DCell num, Cell denom);
237:
1.7 pazsan 238: Cell memcasecmp(const Char *s1, const Char *s2, Cell n);
1.1 anton 239:
240: extern int offset_image;
1.5 anton 241: extern int die_on_signal;
1.10 anton 242: extern UCell pagesize;
243: extern ImageHeader *gforth_header;
1.2 pazsan 244:
1.9 anton 245: #ifdef GFORTH_DEBUGGING
246: extern Xt *ip;
247: extern Cell *rp;
248: #endif
249:
250:
1.2 pazsan 251: /* declare all the functions that are missing */
252: #ifndef HAVE_ATANH
253: extern double atanh(double r1);
254: extern double asinh(double r1);
255: extern double acosh(double r1);
256: #endif
257: #ifndef HAVE_ECVT
1.4 anton 258: /* extern char* ecvt(double x, int len, int* exp, int* sign);*/
1.2 pazsan 259: #endif
260: #ifndef HAVE_MEMMOVE
1.3 anton 261: /* extern char *memmove(char *dest, const char *src, long n); */
1.2 pazsan 262: #endif
263: #ifndef HAVE_POW10
264: extern double pow10(double x);
265: #endif
266: #ifndef HAVE_STRERROR
267: extern char *strerror(int err);
268: #endif
269: #ifndef HAVE_STRSIGNAL
270: extern char *strsignal(int sig);
271: #endif
272: #ifndef HAVE_STRTOUL
1.3 anton 273: extern unsigned long int strtoul(const char *nptr, char **endptr, int base);
1.2 pazsan 274: #endif
275:
276:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>