initial commit
[freebsd-arm:freebsd-arm.git] / boot / ficl / mips / sysdep.h
1 /*******************************************************************
2                     s y s d e p . h
3 ** Forth Inspired Command Language
4 ** Author: John Sadler (john_sadler@alum.mit.edu)
5 ** Created: 16 Oct 1997
6 ** Ficl system dependent types and prototypes...
7 **
8 ** Note: Ficl also depends on the use of "assert" when
9 ** FICL_ROBUST is enabled. This may require some consideration
10 ** in firmware systems since assert often
11 ** assumes stderr/stdout.  
12 ** $Id: sysdep.h,v 1.6 2001-04-26 21:41:55-07 jsadler Exp jsadler $
13 *******************************************************************/
14 /*
15 ** Copyright (c) 1997-2001 John Sadler (john_sadler@alum.mit.edu)
16 ** All rights reserved.
17 **
18 ** Get the latest Ficl release at http://ficl.sourceforge.net
19 **
20 ** L I C E N S E  and  D I S C L A I M E R
21 ** 
22 ** Redistribution and use in source and binary forms, with or without
23 ** modification, are permitted provided that the following conditions
24 ** are met:
25 ** 1. Redistributions of source code must retain the above copyright
26 **    notice, this list of conditions and the following disclaimer.
27 ** 2. Redistributions in binary form must reproduce the above copyright
28 **    notice, this list of conditions and the following disclaimer in the
29 **    documentation and/or other materials provided with the distribution.
30 **
31 ** THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
32 ** ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
33 ** IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
34 ** ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
35 ** FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 ** DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 ** OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 ** HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
39 ** LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
40 ** OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
41 ** SUCH DAMAGE.
42 **
43 ** I am interested in hearing from anyone who uses ficl. If you have
44 ** a problem, a success story, a defect, an enhancement request, or
45 ** if you would like to contribute to the ficl release, please send
46 ** contact me by email at the address above.
47 **
48 ** $Id: sysdep.h,v 1.6 2001-04-26 21:41:55-07 jsadler Exp jsadler $
49 ** $FreeBSD$
50 */
51
52 #if !defined (__SYSDEP_H__)
53 #define __SYSDEP_H__ 
54
55 #include <sys/types.h>
56
57 #include <stddef.h> /* size_t, NULL */
58 #include <setjmp.h>
59 #include <assert.h>
60
61 #if !defined IGNORE             /* Macro to silence unused param warnings */
62 #define IGNORE(x) &x
63 #endif
64
65 /*
66 ** TRUE and FALSE for C boolean operations, and
67 ** portable 32 bit types for CELLs
68 ** 
69 */
70 #if !defined TRUE
71 #define TRUE 1
72 #endif
73 #if !defined FALSE
74 #define FALSE 0
75 #endif
76
77
78 /*
79 ** System dependent data type declarations...
80 */
81 #if !defined INT32
82 #define INT32 int
83 #endif
84
85 #if !defined UNS32
86 #define UNS32 unsigned int
87 #endif
88
89 #if !defined UNS16
90 #define UNS16 unsigned short
91 #endif
92
93 #if !defined UNS8
94 #define UNS8 unsigned char
95 #endif
96
97 #if !defined NULL
98 #define NULL ((void *)0)
99 #endif
100
101 /*
102 ** FICL_UNS and FICL_INT must have the same size as a void* on
103 ** the target system. A CELL is a union of void*, FICL_UNS, and
104 ** FICL_INT. 
105 ** (11/2000: same for FICL_FLOAT)
106 */
107 #if !defined FICL_INT
108 #define FICL_INT INT32
109 #endif
110
111 #if !defined FICL_UNS
112 #define FICL_UNS UNS32
113 #endif
114
115 #if !defined FICL_FLOAT
116 #define FICL_FLOAT float
117 #endif
118
119 /*
120 ** Ficl presently supports values of 32 and 64 for BITS_PER_CELL
121 */
122 #if !defined BITS_PER_CELL
123 #define BITS_PER_CELL 32
124 #endif
125
126 #if ((BITS_PER_CELL != 32) && (BITS_PER_CELL != 64))
127     Error!
128 #endif
129
130 typedef struct
131 {
132     FICL_UNS hi;
133     FICL_UNS lo;
134 } DPUNS;
135
136 typedef struct
137 {
138     FICL_UNS quot;
139     FICL_UNS rem;
140 } UNSQR;
141
142 typedef struct
143 {
144     FICL_INT hi;
145     FICL_INT lo;
146 } DPINT;
147
148 typedef struct
149 {
150     FICL_INT quot;
151     FICL_INT rem;
152 } INTQR;
153
154
155 /*
156 ** B U I L D   C O N T R O L S
157 */
158
159 #if !defined (FICL_MINIMAL)
160 #define FICL_MINIMAL 0
161 #endif
162 #if (FICL_MINIMAL)
163 #define FICL_WANT_SOFTWORDS  0
164 #define FICL_WANT_FILE       0
165 #define FICL_WANT_FLOAT      0
166 #define FICL_WANT_USER       0
167 #define FICL_WANT_LOCALS     0
168 #define FICL_WANT_DEBUGGER   0
169 #define FICL_WANT_OOP        0
170 #define FICL_PLATFORM_EXTEND 0
171 #define FICL_MULTITHREAD     0
172 #define FICL_ROBUST         1 
173 #define FICL_EXTENDED_PREFIX 0
174 #endif
175
176 /*
177 ** FICL_PLATFORM_EXTEND
178 ** Includes words defined in ficlCompilePlatform
179 */
180 #if !defined (FICL_PLATFORM_EXTEND)
181 #define FICL_PLATFORM_EXTEND 1
182 #endif
183
184 /*
185 ** FICL_WANT_FILE
186 ** Includes the FILE and FILE-EXT wordset and associated code. Turn this off if you do not
187 ** have a filesystem!
188 ** Contributed by Larry Hastings
189 */
190 #if !defined (FICL_WANT_FILE)
191 #define FICL_WANT_FILE 0
192 #endif
193
194 /*
195 ** FICL_WANT_FLOAT
196 ** Includes a floating point stack for the VM, and words to do float operations.
197 ** Contributed by Guy Carver
198 */
199 #if !defined (FICL_WANT_FLOAT)
200 #define FICL_WANT_FLOAT 0
201 #endif
202
203 /*
204 ** FICL_WANT_DEBUGGER
205 ** Inludes a simple source level debugger
206 */
207 #if !defined (FICL_WANT_DEBUGGER)
208 #define FICL_WANT_DEBUGGER 1
209 #endif
210
211 /*
212 ** User variables: per-instance variables bound to the VM.
213 ** Kinda like thread-local storage. Could be implemented in a 
214 ** VM private dictionary, but I've chosen the lower overhead
215 ** approach of an array of CELLs instead.
216 */
217 #if !defined FICL_WANT_USER
218 #define FICL_WANT_USER 1
219 #endif
220
221 #if !defined FICL_USER_CELLS
222 #define FICL_USER_CELLS 16
223 #endif
224
225 /* 
226 ** FICL_WANT_LOCALS controls the creation of the LOCALS wordset and
227 ** a private dictionary for local variable compilation.
228 */
229 #if !defined FICL_WANT_LOCALS
230 #define FICL_WANT_LOCALS 1
231 #endif
232
233 /* Max number of local variables per definition */
234 #if !defined FICL_MAX_LOCALS
235 #define FICL_MAX_LOCALS 16
236 #endif
237
238 /*
239 ** FICL_WANT_OOP
240 ** Inludes object oriented programming support (in softwords)
241 ** OOP support requires locals and user variables!
242 */
243 #if !(FICL_WANT_LOCALS) || !(FICL_WANT_USER)
244 #if !defined (FICL_WANT_OOP)
245 #define FICL_WANT_OOP 0
246 #endif
247 #endif
248
249 #if !defined (FICL_WANT_OOP)
250 #define FICL_WANT_OOP 1
251 #endif
252
253 /*
254 ** FICL_WANT_SOFTWORDS
255 ** Controls inclusion of all softwords in softcore.c
256 */
257 #if !defined (FICL_WANT_SOFTWORDS)
258 #define FICL_WANT_SOFTWORDS 1
259 #endif
260
261 /*
262 ** FICL_MULTITHREAD enables dictionary mutual exclusion
263 ** wia the ficlLockDictionary system dependent function.
264 ** Note: this implementation is experimental and poorly
265 ** tested. Further, it's unnecessary unless you really
266 ** intend to have multiple SESSIONS (poor choice of name
267 ** on my part) - that is, threads that modify the dictionary
268 ** at the same time.
269 */
270 #if !defined FICL_MULTITHREAD
271 #define FICL_MULTITHREAD 0
272 #endif
273
274 /*
275 ** PORTABLE_LONGMULDIV causes ficlLongMul and ficlLongDiv to be
276 ** defined in C in sysdep.c. Use this if you cannot easily 
277 ** generate an inline asm definition
278 */ 
279 #if !defined (PORTABLE_LONGMULDIV)
280 #define PORTABLE_LONGMULDIV 0
281 #endif
282
283 /*
284 ** INLINE_INNER_LOOP causes the inner interpreter to be inline code
285 ** instead of a function call. This is mainly because MS VC++ 5
286 ** chokes with an internal compiler error on the function version.
287 ** in release mode. Sheesh.
288 */
289 #if !defined INLINE_INNER_LOOP
290 #if defined _DEBUG
291 #define INLINE_INNER_LOOP 0
292 #else
293 #define INLINE_INNER_LOOP 1
294 #endif
295 #endif
296
297 /*
298 ** FICL_ROBUST enables bounds checking of stacks and the dictionary.
299 ** This will detect stack over and underflows and dictionary overflows.
300 ** Any exceptional condition will result in an assertion failure.
301 ** (As generated by the ANSI assert macro)
302 ** FICL_ROBUST == 1 --> stack checking in the outer interpreter
303 ** FICL_ROBUST == 2 also enables checking in many primitives
304 */
305
306 #if !defined FICL_ROBUST
307 #define FICL_ROBUST 2
308 #endif
309
310 /*
311 ** FICL_DEFAULT_STACK Specifies the default size (in CELLs) of
312 ** a new virtual machine's stacks, unless overridden at 
313 ** create time.
314 */
315 #if !defined FICL_DEFAULT_STACK
316 #define FICL_DEFAULT_STACK 128
317 #endif
318
319 /*
320 ** FICL_DEFAULT_DICT specifies the number of CELLs to allocate
321 ** for the system dictionary by default. The value
322 ** can be overridden at startup time as well.
323 ** FICL_DEFAULT_ENV specifies the number of cells to allot
324 ** for the environment-query dictionary.
325 */
326 #if !defined FICL_DEFAULT_DICT
327 #define FICL_DEFAULT_DICT 12288
328 #endif
329
330 #if !defined FICL_DEFAULT_ENV
331 #define FICL_DEFAULT_ENV 260
332 #endif
333
334 /*
335 ** FICL_DEFAULT_VOCS specifies the maximum number of wordlists in 
336 ** the dictionary search order. See Forth DPANS sec 16.3.3
337 ** (file://dpans16.htm#16.3.3)
338 */
339 #if !defined FICL_DEFAULT_VOCS
340 #define FICL_DEFAULT_VOCS 16
341 #endif
342
343 /*
344 ** FICL_MAX_PARSE_STEPS controls the size of an array in the FICL_SYSTEM structure
345 ** that stores pointers to parser extension functions. I would never expect to have
346 ** more than 8 of these, so that's the default limit. Too many of these functions
347 ** will probably exact a nasty performance penalty.
348 */
349 #if !defined FICL_MAX_PARSE_STEPS
350 #define FICL_MAX_PARSE_STEPS 8
351 #endif
352
353 /*
354 ** FICL_EXTENDED_PREFIX enables a bunch of extra prefixes in prefix.c and prefix.fr (if
355 ** included as part of softcore.c)
356 */
357 #if !defined FICL_EXTENDED_PREFIX
358 #define FICL_EXTENDED_PREFIX 0
359 #endif
360
361 /*
362 ** FICL_ALIGN is the power of two to which the dictionary
363 ** pointer address must be aligned. This value is usually
364 ** either 1 or 2, depending on the memory architecture
365 ** of the target system; 2 is safe on any 16 or 32 bit
366 ** machine. 3 would be appropriate for a 64 bit machine.
367 */
368 #if !defined FICL_ALIGN
369 #define FICL_ALIGN 2
370 #define FICL_ALIGN_ADD ((1 << FICL_ALIGN) - 1)
371 #endif
372
373 /*
374 ** System dependent routines --
375 ** edit the implementations in sysdep.c to be compatible
376 ** with your runtime environment...
377 ** ficlTextOut sends a NULL terminated string to the 
378 **   default output device - used for system error messages
379 ** ficlMalloc and ficlFree have the same semantics as malloc and free
380 **   in standard C
381 ** ficlLongMul multiplies two UNS32s and returns a 64 bit unsigned 
382 **   product
383 ** ficlLongDiv divides an UNS64 by an UNS32 and returns UNS32 quotient
384 **   and remainder
385 */
386 struct vm;
387 void  ficlTextOut(struct vm *pVM, char *msg, int fNewline);
388 void *ficlMalloc (size_t size);
389 void  ficlFree   (void *p);
390 void *ficlRealloc(void *p, size_t size);
391 /*
392 ** Stub function for dictionary access control - does nothing
393 ** by default, user can redefine to guarantee exclusive dict
394 ** access to a single thread for updates. All dict update code
395 ** must be bracketed as follows:
396 ** ficlLockDictionary(TRUE);
397 ** <code that updates dictionary>
398 ** ficlLockDictionary(FALSE);
399 **
400 ** Returns zero if successful, nonzero if unable to acquire lock
401 ** before timeout (optional - could also block forever)
402 **
403 ** NOTE: this function must be implemented with lock counting
404 ** semantics: nested calls must behave properly.
405 */
406 #if FICL_MULTITHREAD
407 int ficlLockDictionary(short fLock);
408 #else
409 #define ficlLockDictionary(x) 0 /* ignore */
410 #endif
411
412 /*
413 ** 64 bit integer math support routines: multiply two UNS32s
414 ** to get a 64 bit product, & divide the product by an UNS32
415 ** to get an UNS32 quotient and remainder. Much easier in asm
416 ** on a 32 bit CPU than in C, which usually doesn't support 
417 ** the double length result (but it should).
418 */
419 DPUNS ficlLongMul(FICL_UNS x, FICL_UNS y);
420 UNSQR ficlLongDiv(DPUNS    q, FICL_UNS y);
421
422 /*
423 ** FICL_HAVE_FTRUNCATE indicates whether the current OS supports
424 ** the ftruncate() function (available on most UNIXes).  This
425 ** function is necessary to provide the complete File-Access wordset.
426 */
427 #if !defined (FICL_HAVE_FTRUNCATE)
428 #define FICL_HAVE_FTRUNCATE 0
429 #endif
430
431
432 #endif /*__SYSDEP_H__*/