ref: f452824602002d832ea1c31b2c8fc8806d063f3f
dir: /sysdep.h/
/******************************************************************* s y s d e p . h ** Forth Inspired Command Language ** Author: John Sadler (john_sadler@alum.mit.edu) ** Created: 16 Oct 1997 ** Ficl system dependent types and prototypes... ** ** Note: Ficl also depends on the use of "assert" when ** FICL_ROBUST is enabled. This may require some consideration ** in firmware systems since assert often ** assumes stderr/stdout. ** $Id: sysdep.h,v 1.7 2001/05/16 14:56:18 jsadler Exp $ *******************************************************************/ /* ** Copyright (c) 1997-2001 John Sadler (john_sadler@alum.mit.edu) ** All rights reserved. ** ** Get the latest Ficl release at http://ficl.sourceforge.net ** ** I am interested in hearing from anyone who uses ficl. If you have ** a problem, a success story, a defect, an enhancement request, or ** if you would like to contribute to the ficl release, please ** contact me by email at the address above. ** ** L I C E N S E and D I S C L A I M E R ** ** Redistribution and use in source and binary forms, with or without ** modification, are permitted provided that the following conditions ** are met: ** 1. Redistributions of source code must retain the above copyright ** notice, this list of conditions and the following disclaimer. ** 2. Redistributions in binary form must reproduce the above copyright ** notice, this list of conditions and the following disclaimer in the ** documentation and/or other materials provided with the distribution. ** ** THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ** ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE ** IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ** ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE ** FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL ** DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS ** OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) ** HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT ** LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY ** OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF ** SUCH DAMAGE. */ #if !defined (__SYSDEP_H__) #define __SYSDEP_H__ #include <stddef.h> /* size_t, NULL */ #include <setjmp.h> #include <assert.h> #if defined(_WIN32) #define alloca(x) _alloca(x) #define stat _stat #define getcwd _getcwd #define chdir _chdir #elif defined(linux) #endif /* platform */ #if !defined IGNORE /* Macro to silence unused param warnings */ #define IGNORE(x) &x #endif /* ** TRUE and FALSE for C boolean operations, and ** portable 32 bit types for CELLs ** */ #if !defined TRUE #define TRUE 1 #endif #if !defined FALSE #define FALSE 0 #endif /* ** FreeBSD Alpha (64 bit) data types */ #if defined (FREEBSD_ALPHA) #define INT32 int #define UNS32 unsigned int #define FICL_INT long #define FICL_UNS unsigned long #define BITS_PER_CELL 64 #define FICL_ALIGN 3 #endif /* ** System dependent data type declarations... */ #if !defined INT32 #define INT32 long #endif #if !defined UNS32 #define UNS32 unsigned long #endif #if !defined UNS16 #define UNS16 unsigned short #endif #if !defined UNS8 #define UNS8 unsigned char #endif #if !defined NULL #define NULL ((void *)0) #endif /* ** FICL_UNS and FICL_INT must have the same size as a void* on ** the target system. A CELL is a union of void*, FICL_UNS, and ** FICL_INT. ** (11/2000: same for FICL_FLOAT) */ #if !defined FICL_INT #define FICL_INT INT32 #endif #if !defined FICL_UNS #define FICL_UNS UNS32 #endif #if !defined FICL_FLOAT #define FICL_FLOAT float #endif /* ** Ficl presently supports values of 32 and 64 for BITS_PER_CELL */ #if !defined BITS_PER_CELL #define BITS_PER_CELL 32 #endif #if ((BITS_PER_CELL != 32) && (BITS_PER_CELL != 64)) Error! #endif typedef struct { FICL_UNS hi; FICL_UNS lo; } DPUNS; typedef struct { FICL_UNS quot; FICL_UNS rem; } UNSQR; typedef struct { FICL_INT hi; FICL_INT lo; } DPINT; typedef struct { FICL_INT quot; FICL_INT rem; } INTQR; /* ** B U I L D C O N T R O L S */ #if !defined (FICL_MINIMAL) #define FICL_MINIMAL 0 #endif #if (FICL_MINIMAL) #define FICL_WANT_SOFTWORDS 0 #define FICL_WANT_FLOAT 0 #define FICL_WANT_USER 0 #define FICL_WANT_LOCALS 0 #define FICL_WANT_DEBUGGER 0 #define FICL_WANT_OOP 0 #define FICL_PLATFORM_EXTEND 0 #define FICL_MULTITHREAD 0 #define FICL_ROBUST 0 #define FICL_EXTENDED_PREFIX 0 #endif /* ** FICL_PLATFORM_EXTEND ** Includes words defined in ficlCompilePlatform (see win32.c for example) */ #ifdef _WIN32 #if !defined (FICL_PLATFORM_EXTEND) #define FICL_PLATFORM_EXTEND 1 #endif #endif #if !defined (FICL_PLATFORM_EXTEND) #define FICL_PLATFORM_EXTEND 0 #endif /* ** FICL_WANT_FLOAT ** Includes a floating point stack for the VM, and words to do float operations. ** Contributed by Guy Carver */ #if !defined (FICL_WANT_FLOAT) #define FICL_WANT_FLOAT 1 #endif /* ** FICL_WANT_DEBUGGER ** Inludes a simple source level debugger */ #if !defined (FICL_WANT_DEBUGGER) #define FICL_WANT_DEBUGGER 1 #endif /* ** User variables: per-instance variables bound to the VM. ** Kinda like thread-local storage. Could be implemented in a ** VM private dictionary, but I've chosen the lower overhead ** approach of an array of CELLs instead. */ #if !defined FICL_WANT_USER #define FICL_WANT_USER 1 #endif #if !defined FICL_USER_CELLS #define FICL_USER_CELLS 16 #endif /* ** FICL_WANT_LOCALS controls the creation of the LOCALS wordset and ** a private dictionary for local variable compilation. */ #if !defined FICL_WANT_LOCALS #define FICL_WANT_LOCALS 1 #endif /* Max number of local variables per definition */ #if !defined FICL_MAX_LOCALS #define FICL_MAX_LOCALS 16 #endif /* ** FICL_WANT_OOP ** Inludes object oriented programming support (in softwords) ** OOP support requires locals and user variables! */ #if !(FICL_WANT_LOCALS) || !(FICL_WANT_USER) #if !defined (FICL_WANT_OOP) #define FICL_WANT_OOP 0 #endif #endif #if !defined (FICL_WANT_OOP) #define FICL_WANT_OOP 1 #endif /* ** FICL_WANT_SOFTWORDS ** Controls inclusion of all softwords in softcore.c */ #if !defined (FICL_WANT_SOFTWORDS) #define FICL_WANT_SOFTWORDS 1 #endif /* ** FICL_MULTITHREAD enables dictionary mutual exclusion ** wia the ficlLockDictionary system dependent function. ** Note: this implementation is experimental and poorly ** tested. Further, it's unnecessary unless you really ** intend to have multiple SESSIONS (poor choice of name ** on my part) - that is, threads that modify the dictionary ** at the same time. */ #if !defined FICL_MULTITHREAD #define FICL_MULTITHREAD 0 #endif /* ** PORTABLE_LONGMULDIV causes ficlLongMul and ficlLongDiv to be ** defined in C in sysdep.c. Use this if you cannot easily ** generate an inline asm definition */ #if !defined (PORTABLE_LONGMULDIV) #define PORTABLE_LONGMULDIV 0 #endif /* ** INLINE_INNER_LOOP causes the inner interpreter to be inline code ** instead of a function call. This is mainly because MS VC++ 5 ** chokes with an internal compiler error on the function version. ** in release mode. Sheesh. */ #if !defined INLINE_INNER_LOOP #if defined _DEBUG #define INLINE_INNER_LOOP 0 #else #define INLINE_INNER_LOOP 1 #endif #endif /* ** FICL_ROBUST enables bounds checking of stacks and the dictionary. ** This will detect stack over and underflows and dictionary overflows. ** Any exceptional condition will result in an assertion failure. ** (As generated by the ANSI assert macro) ** FICL_ROBUST == 1 --> stack checking in the outer interpreter ** FICL_ROBUST == 2 also enables checking in many primitives */ #if !defined FICL_ROBUST #define FICL_ROBUST 2 #endif /* ** FICL_DEFAULT_STACK Specifies the default size (in CELLs) of ** a new virtual machine's stacks, unless overridden at ** create time. */ #if !defined FICL_DEFAULT_STACK #define FICL_DEFAULT_STACK 128 #endif /* ** FICL_DEFAULT_DICT specifies the number of CELLs to allocate ** for the system dictionary by default. The value ** can be overridden at startup time as well. ** FICL_DEFAULT_ENV specifies the number of cells to allot ** for the environment-query dictionary. */ #if !defined FICL_DEFAULT_DICT #define FICL_DEFAULT_DICT 12288 #endif #if !defined FICL_DEFAULT_ENV #define FICL_DEFAULT_ENV 260 #endif /* ** FICL_DEFAULT_VOCS specifies the maximum number of wordlists in ** the dictionary search order. See Forth DPANS sec 16.3.3 ** (file://dpans16.htm#16.3.3) */ #if !defined FICL_DEFAULT_VOCS #define FICL_DEFAULT_VOCS 16 #endif /* ** FICL_MAX_PARSE_STEPS controls the size of an array in the FICL_SYSTEM structure ** that stores pointers to parser extension functions. I would never expect to have ** more than 8 of these, so that's the default limit. Too many of these functions ** will probably exact a nasty performance penalty. */ #if !defined FICL_MAX_PARSE_STEPS #define FICL_MAX_PARSE_STEPS 8 #endif /* ** FICL_EXTENDED_PREFIX enables a bunch of extra prefixes in prefix.c and prefix.fr (if ** included as part of softcore.c) */ #if !defined FICL_EXTENDED_PREFIX #define FICL_EXTENDED_PREFIX 0 #endif /* ** FICL_ALIGN is the power of two to which the dictionary ** pointer address must be aligned. This value is usually ** either 1 or 2, depending on the memory architecture ** of the target system; 2 is safe on any 16 or 32 bit ** machine. 3 would be appropriate for a 64 bit machine. */ #if !defined FICL_ALIGN #define FICL_ALIGN 2 #define FICL_ALIGN_ADD ((1 << FICL_ALIGN) - 1) #endif /* ** System dependent routines -- ** edit the implementations in sysdep.c to be compatible ** with your runtime environment... ** ficlTextOut sends a NULL terminated string to the ** default output device - used for system error messages ** ficlMalloc and ficlFree have the same semantics as malloc and free ** in standard C ** ficlLongMul multiplies two UNS32s and returns a 64 bit unsigned ** product ** ficlLongDiv divides an UNS64 by an UNS32 and returns UNS32 quotient ** and remainder */ struct vm; void ficlTextOut(struct vm *pVM, char *msg, int fNewline); void *ficlMalloc (size_t size); void ficlFree (void *p); void *ficlRealloc(void *p, size_t size); /* ** Stub function for dictionary access control - does nothing ** by default, user can redefine to guarantee exclusive dict ** access to a single thread for updates. All dict update code ** must be bracketed as follows: ** ficlLockDictionary(TRUE); ** <code that updates dictionary> ** ficlLockDictionary(FALSE); ** ** Returns zero if successful, nonzero if unable to acquire lock ** before timeout (optional - could also block forever) ** ** NOTE: this function must be implemented with lock counting ** semantics: nested calls must behave properly. */ #if FICL_MULTITHREAD int ficlLockDictionary(short fLock); #else #define ficlLockDictionary(x) 0 /* ignore */ #endif /* ** 64 bit integer math support routines: multiply two UNS32s ** to get a 64 bit product, & divide the product by an UNS32 ** to get an UNS32 quotient and remainder. Much easier in asm ** on a 32 bit CPU than in C, which usually doesn't support ** the double length result (but it should). */ DPUNS ficlLongMul(FICL_UNS x, FICL_UNS y); UNSQR ficlLongDiv(DPUNS q, FICL_UNS y); #endif /*__SYSDEP_H__*/