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*/
50
51/* $FreeBSD: releng/10.3/sys/boot/ficl/sparc64/sysdep.h 96962 2002-05-19 23:20:56Z jake $ */
52
53#if !defined (__SYSDEP_H__)
54#define __SYSDEP_H__
55
56#include <sys/types.h>
57
58#include <stddef.h> /* size_t, NULL */
59#include <setjmp.h>
60#include <assert.h>
61
62#if !defined IGNORE		/* Macro to silence unused param warnings */
63#define IGNORE(x) &x
64#endif
65
66/*
67** TRUE and FALSE for C boolean operations, and
68** portable 32 bit types for CELLs
69**
70*/
71#if !defined TRUE
72#define TRUE 1
73#endif
74#if !defined FALSE
75#define FALSE 0
76#endif
77
78
79/*
80** System dependent data type declarations...
81*/
82#if !defined INT32
83#define INT32 int
84#endif
85
86#if !defined UNS32
87#define UNS32 unsigned int
88#endif
89
90#if !defined UNS16
91#define UNS16 unsigned short
92#endif
93
94#if !defined UNS8
95#define UNS8 unsigned char
96#endif
97
98#if !defined NULL
99#define NULL ((void *)0)
100#endif
101
102/*
103** FICL_UNS and FICL_INT must have the same size as a void* on
104** the target system. A CELL is a union of void*, FICL_UNS, and
105** FICL_INT.
106** (11/2000: same for FICL_FLOAT)
107*/
108#if !defined FICL_INT
109#define FICL_INT long
110#endif
111
112#if !defined FICL_UNS
113#define FICL_UNS unsigned long
114#endif
115
116#if !defined FICL_FLOAT
117#define FICL_FLOAT float
118#endif
119
120/*
121** Ficl presently supports values of 32 and 64 for BITS_PER_CELL
122*/
123#if !defined BITS_PER_CELL
124#define BITS_PER_CELL 64
125#endif
126
127#if ((BITS_PER_CELL != 32) && (BITS_PER_CELL != 64))
128    Error!
129#endif
130
131typedef struct
132{
133    FICL_UNS hi;
134    FICL_UNS lo;
135} DPUNS;
136
137typedef struct
138{
139    FICL_UNS quot;
140    FICL_UNS rem;
141} UNSQR;
142
143typedef struct
144{
145    FICL_INT hi;
146    FICL_INT lo;
147} DPINT;
148
149typedef struct
150{
151    FICL_INT quot;
152    FICL_INT rem;
153} INTQR;
154
155
156/*
157** B U I L D   C O N T R O L S
158*/
159
160#if !defined (FICL_MINIMAL)
161#define FICL_MINIMAL 0
162#endif
163#if (FICL_MINIMAL)
164#define FICL_WANT_SOFTWORDS  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          0
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_FLOAT
186** Includes a floating point stack for the VM, and words to do float operations.
187** Contributed by Guy Carver
188*/
189#if !defined (FICL_WANT_FLOAT)
190#define FICL_WANT_FLOAT 0
191#endif
192
193/*
194** FICL_WANT_DEBUGGER
195** Inludes a simple source level debugger
196*/
197#if !defined (FICL_WANT_DEBUGGER)
198#define FICL_WANT_DEBUGGER 1
199#endif
200
201/*
202** User variables: per-instance variables bound to the VM.
203** Kinda like thread-local storage. Could be implemented in a
204** VM private dictionary, but I've chosen the lower overhead
205** approach of an array of CELLs instead.
206*/
207#if !defined FICL_WANT_USER
208#define FICL_WANT_USER 1
209#endif
210
211#if !defined FICL_USER_CELLS
212#define FICL_USER_CELLS 16
213#endif
214
215/*
216** FICL_WANT_LOCALS controls the creation of the LOCALS wordset and
217** a private dictionary for local variable compilation.
218*/
219#if !defined FICL_WANT_LOCALS
220#define FICL_WANT_LOCALS 1
221#endif
222
223/* Max number of local variables per definition */
224#if !defined FICL_MAX_LOCALS
225#define FICL_MAX_LOCALS 16
226#endif
227
228/*
229** FICL_WANT_OOP
230** Inludes object oriented programming support (in softwords)
231** OOP support requires locals and user variables!
232*/
233#if !(FICL_WANT_LOCALS) || !(FICL_WANT_USER)
234#if !defined (FICL_WANT_OOP)
235#define FICL_WANT_OOP 0
236#endif
237#endif
238
239#if !defined (FICL_WANT_OOP)
240#define FICL_WANT_OOP 1
241#endif
242
243/*
244** FICL_WANT_SOFTWORDS
245** Controls inclusion of all softwords in softcore.c
246*/
247#if !defined (FICL_WANT_SOFTWORDS)
248#define FICL_WANT_SOFTWORDS 1
249#endif
250
251/*
252** FICL_MULTITHREAD enables dictionary mutual exclusion
253** wia the ficlLockDictionary system dependent function.
254** Note: this implementation is experimental and poorly
255** tested. Further, it's unnecessary unless you really
256** intend to have multiple SESSIONS (poor choice of name
257** on my part) - that is, threads that modify the dictionary
258** at the same time.
259*/
260#if !defined FICL_MULTITHREAD
261#define FICL_MULTITHREAD 0
262#endif
263
264/*
265** PORTABLE_LONGMULDIV causes ficlLongMul and ficlLongDiv to be
266** defined in C in sysdep.c. Use this if you cannot easily
267** generate an inline asm definition
268*/
269#if !defined (PORTABLE_LONGMULDIV)
270#define PORTABLE_LONGMULDIV 0
271#endif
272
273/*
274** INLINE_INNER_LOOP causes the inner interpreter to be inline code
275** instead of a function call. This is mainly because MS VC++ 5
276** chokes with an internal compiler error on the function version.
277** in release mode. Sheesh.
278*/
279#if !defined INLINE_INNER_LOOP
280#if defined _DEBUG
281#define INLINE_INNER_LOOP 0
282#else
283#define INLINE_INNER_LOOP 1
284#endif
285#endif
286
287/*
288** FICL_ROBUST enables bounds checking of stacks and the dictionary.
289** This will detect stack over and underflows and dictionary overflows.
290** Any exceptional condition will result in an assertion failure.
291** (As generated by the ANSI assert macro)
292** FICL_ROBUST == 1 --> stack checking in the outer interpreter
293** FICL_ROBUST == 2 also enables checking in many primitives
294*/
295
296#if !defined FICL_ROBUST
297#define FICL_ROBUST 2
298#endif
299
300/*
301** FICL_DEFAULT_STACK Specifies the default size (in CELLs) of
302** a new virtual machine's stacks, unless overridden at
303** create time.
304*/
305#if !defined FICL_DEFAULT_STACK
306#define FICL_DEFAULT_STACK 128
307#endif
308
309/*
310** FICL_DEFAULT_DICT specifies the number of CELLs to allocate
311** for the system dictionary by default. The value
312** can be overridden at startup time as well.
313** FICL_DEFAULT_ENV specifies the number of cells to allot
314** for the environment-query dictionary.
315*/
316#if !defined FICL_DEFAULT_DICT
317#define FICL_DEFAULT_DICT 12288
318#endif
319
320#if !defined FICL_DEFAULT_ENV
321#define FICL_DEFAULT_ENV 260
322#endif
323
324/*
325** FICL_DEFAULT_VOCS specifies the maximum number of wordlists in
326** the dictionary search order. See Forth DPANS sec 16.3.3
327** (file://dpans16.htm#16.3.3)
328*/
329#if !defined FICL_DEFAULT_VOCS
330#define FICL_DEFAULT_VOCS 16
331#endif
332
333/*
334** FICL_MAX_PARSE_STEPS controls the size of an array in the FICL_SYSTEM structure
335** that stores pointers to parser extension functions. I would never expect to have
336** more than 8 of these, so that's the default limit. Too many of these functions
337** will probably exact a nasty performance penalty.
338*/
339#if !defined FICL_MAX_PARSE_STEPS
340#define FICL_MAX_PARSE_STEPS 8
341#endif
342
343/*
344** FICL_EXTENDED_PREFIX enables a bunch of extra prefixes in prefix.c and prefix.fr (if
345** included as part of softcore.c)
346*/
347#if !defined FICL_EXTENDED_PREFIX
348#define FICL_EXTENDED_PREFIX 0
349#endif
350
351/*
352** FICL_ALIGN is the power of two to which the dictionary
353** pointer address must be aligned. This value is usually
354** either 1 or 2, depending on the memory architecture
355** of the target system; 2 is safe on any 16 or 32 bit
356** machine. 3 would be appropriate for a 64 bit machine.
357*/
358#if !defined FICL_ALIGN
359#define FICL_ALIGN 3
360#define FICL_ALIGN_ADD ((1 << FICL_ALIGN) - 1)
361#endif
362
363/*
364** System dependent routines --
365** edit the implementations in sysdep.c to be compatible
366** with your runtime environment...
367** ficlTextOut sends a NULL terminated string to the
368**   default output device - used for system error messages
369** ficlMalloc and ficlFree have the same semantics as malloc and free
370**   in standard C
371** ficlLongMul multiplies two UNS32s and returns a 64 bit unsigned
372**   product
373** ficlLongDiv divides an UNS64 by an UNS32 and returns UNS32 quotient
374**   and remainder
375*/
376struct vm;
377void  ficlTextOut(struct vm *pVM, char *msg, int fNewline);
378void *ficlMalloc (size_t size);
379void  ficlFree   (void *p);
380void *ficlRealloc(void *p, size_t size);
381/*
382** Stub function for dictionary access control - does nothing
383** by default, user can redefine to guarantee exclusive dict
384** access to a single thread for updates. All dict update code
385** must be bracketed as follows:
386** ficlLockDictionary(TRUE);
387** <code that updates dictionary>
388** ficlLockDictionary(FALSE);
389**
390** Returns zero if successful, nonzero if unable to acquire lock
391** before timeout (optional - could also block forever)
392**
393** NOTE: this function must be implemented with lock counting
394** semantics: nested calls must behave properly.
395*/
396#if FICL_MULTITHREAD
397int ficlLockDictionary(short fLock);
398#else
399#define ficlLockDictionary(x) 0 /* ignore */
400#endif
401
402/*
403** 64 bit integer math support routines: multiply two UNS32s
404** to get a 64 bit product, & divide the product by an UNS32
405** to get an UNS32 quotient and remainder. Much easier in asm
406** on a 32 bit CPU than in C, which usually doesn't support
407** the double length result (but it should).
408*/
409DPUNS ficlLongMul(FICL_UNS x, FICL_UNS y);
410UNSQR ficlLongDiv(DPUNS    q, FICL_UNS y);
411
412#endif /*__SYSDEP_H__*/
413