pd.if.org Git - pdclib/blob - platform/example/internals/_PDCLIB_config.h

   1 /* $Id$ */
   2
   3 /* Release $Name$ */
   4
   5 /* Internal PDCLib configuration <_PDCLIB_config.h>
   6    (Generic Template)
   7
   8    This file is part of the Public Domain C Library (PDCLib).
   9    Permission is granted to use, modify, and / or redistribute at will.
  10 */
  11
  12 /* -------------------------------------------------------------------------- */
  13 /* Misc                                                                       */
  14 /* -------------------------------------------------------------------------- */
  15
  16 /* The character (sequence) your platform uses as newline.                    */
  17 #define _PDCLIB_endl "\n"
  18
  19 /* exit() can signal success to the host environment by the value of zero or  */
  20 /* the constant EXIT_SUCCESS. Failure is signaled by EXIT_FAILURE. Note that  */
  21 /* any other return value is "implementation-defined", i.e. your environment  */
  22 /* is not required to handle it gracefully. Set your definitions here.        */
  23 #define _PDCLIB_SUCCESS 0
  24 #define _PDCLIB_FAILURE -1
  25
  26 /* qsort() in <stdlib.h> requires a function that swaps two memory areas.     */
  27 /* Below is a naive implementation that can be improved significantly for     */
  28 /* specific platforms, e.g. by swapping int instead of char.                  */
  29 #define _PDCLIB_memswp( i, j, size ) char tmp; do { tmp = *i; *i++ = *j; *j++ = tmp; } while ( --size );
  30
  31 /* -------------------------------------------------------------------------- */
  32 /* Integers                                                                   */
  33 /* -------------------------------------------------------------------------- */
  34 /* Assuming 8-bit char, two's-complement architecture here. 'short' being     */
  35 /* 16 bit, 'int' being either 16, 32 or 64 bit, 'long' being either 32 or 64  */
  36 /* bit (but 64 bit only if 'int' is 32 bit), and 'long long' being 64 bit if  */
  37 /* 'long' is not, 64 or 128 bit otherwise.                                    */
  38 /* Author is quite willing to support other systems but would like to hear of */
  39 /* interest in such support and details on the to-be-supported architecture   */
  40 /* first, before going to lengths about it.                                   */
  41 /* -------------------------------------------------------------------------- */
  42
  43 /* Comment out (or delete) the line below if your 'char' type is unsigned.    */
  44 #define _PDCLIB_CHAR_SIGNED 1
  45
  46 /* Width of the integer types short, int, long, and long long, in bytes.      */
  47 /* SHRT == 2, INT >= SHRT, LONG >= INT >= 4, LLONG >= LONG - check your       */
  48 /* compiler manuals.                                                          */
  49 #define _PDCLIB_SHRT_BYTES  2
  50 #define _PDCLIB_INT_BYTES   4
  51 #define _PDCLIB_LONG_BYTES  4
  52 #define _PDCLIB_LLONG_BYTES 8
  53
  54 /* <stdlib.h> defines the div() function family that allows taking quotient   */
  55 /* and remainder of an integer division in one operation. Many platforms      */
  56 /* support this in hardware / opcode, and the standard permits ordering of    */
  57 /* the return structure in any way to fit the hardware. That is why those     */
  58 /* structs can be configured here.                                            */
  59
  60 struct _PDCLIB_div_t
  61 {
  62     int quot;
  63     int rem;
  64 };
  65
  66 struct _PDCLIB_ldiv_t
  67 {
  68     long int quot;
  69     long int rem;
  70 };
  71
  72 struct _PDCLIB_lldiv_t
  73 {
  74     long long int quot;
  75     long long int rem;
  76 };
  77
  78 /* -------------------------------------------------------------------------- */
  79 /* <stdint.h> defines a set of integer types that are of a minimum width, and */
  80 /* "usually fastest" on the system. (If, for example, accessing a single char */
  81 /* requires the CPU to access a complete int and then mask out the char, the  */
  82 /* "usually fastest" type of at least 8 bits would be int, not char.)         */
  83 /* If you do not have information on the relative performance of the types,   */
  84 /* the standard allows you to define any type that meets minimum width and    */
  85 /* signedness requirements.                                                   */
  86 /* The defines below are just configuration for the real typedefs and limit   */
  87 /* definitions done in <_PDCLIB_int.h>. The uppercase define shall be either  */
  88 /* SHRT, INT, LONG, or LLONG (telling which values to use for the *_MIN and   */
  89 /* *_MAX limits); the lowercase define either short, int, long, or long long  */
  90 /* (telling the actual type to use).                                          */
  91 /* If you require a non-standard datatype to define the "usually fastest"     */
  92 /* types, PDCLib as-is doesn't support that. Please contact the author with   */
  93 /* details on your platform in that case, so support can be added.            */
  94 /* -------------------------------------------------------------------------- */
  95
  96 #define _PDCLIB_FAST8 INT
  97 #define _PDCLIB_fast8 int
  98
  99 #define _PDCLIB_FAST16 INT
 100 #define _PDCLIB_fast16 int
 101
 102 #define _PDCLIB_FAST32 INT
 103 #define _PDCLIB_fast32 int
 104
 105 #define _PDCLIB_FAST64 LLONG
 106 #define _PDCLIB_fast64 long long
 107
 108 /* -------------------------------------------------------------------------- */
 109 /* What follows are a couple of "special" typedefs and their limits. Again,   */
 110 /* the actual definition of the limits is done in <_PDCLIB_int.h>, and the    */
 111 /* defines here are merely "configuration". See above for details.            */
 112 /* -------------------------------------------------------------------------- */
 113
 114 /* The result type of substracting two pointers */
 115 #define _PDCLIB_ptrdiff int
 116 #define _PDCLIB_PTRDIFF INT
 117
 118 /* An integer type that can be accessed as atomic entity (think asynchronous
 119    interrupts). The type itself is not defined in a freestanding environment,
 120    but its limits are. (Don't ask.)
 121 */
 122 #define _PDCLIB_SIG_ATOMIC INT
 123
 124 /* Result type of the 'sizeof' operator (must be unsigned) */
 125 #define _PDCLIB_size unsigned int
 126 #define _PDCLIB_SIZE UINT
 127
 128 /* Large enough an integer to hold all character codes of the largest supported
 129    locale.
 130 */
 131 #define _PDCLIB_wchar unsigned short
 132 #define _PDCLIB_WCHAR USHRT
 133
 134 #define _PDCLIB_intptr int
 135 #define _PDCLIB_INTPTR INT
 136
 137 /* Largest supported integer type. Implementation note: see _PDCLIB_atomax(). */
 138 #define _PDCLIB_intmax long long int
 139 #define _PDCLIB_INTMAX LLINT
 140 /* You are also required to state the literal suffix for the intmax type      */
 141 #define _PDCLIB_INTMAX_LITERAL ll
 142
 143 /* -------------------------------------------------------------------------- */
 144 /* Floating Point                                                             */
 145 /* -------------------------------------------------------------------------- */
 146
 147 /* Whether the implementation rounds toward zero (0), to nearest (1), toward
 148    positive infinity (2), or toward negative infinity (3). (-1) signifies
 149    indeterminable rounding, any other value implementation-specific rounding.
 150 */
 151 #define _PDCLIB_FLT_ROUNDS -1
 152
 153 /* Whether the implementation uses exact-width precision (0), promotes float
 154    to double (1), or promotes float and double to long double (2). (-1)
 155    signifies indeterminable behaviour, any other value implementation-specific
 156    behaviour.
 157 */
 158 #define _PDCLIB_FLT_EVAL_METHOD -1
 159
 160 /* "Number of the decimal digits (n), such that any floating-point number in the
 161    widest supported floating type with p(max) radix (b) digits can be rounded to
 162    a floating-point number with (n) decimal digits and back again without change
 163    to the value p(max) log(10)b if (b) is a power of 10, [1 + p(max) log(10)b]
 164    otherwise."
 165    64bit IEC 60559 double format (53bit mantissa) is DECIMAL_DIG 17.
 166    80bit IEC 60559 double-extended format (64bit mantissa) is DECIMAL_DIG 21.
 167 */
 168 #define _PDCLIB_DECIMAL_DIG 17
 169
 170 /* -------------------------------------------------------------------------- */
 171 /* Platform-dependent macros defined by the standard headers.                 */
 172 /* -------------------------------------------------------------------------- */
 173
 174 /* The offsetof macro
 175    Contract: Expand to an integer constant expression of type size_t, which
 176    represents the offset in bytes to the structure member from the beginning
 177    of the structure. If the specified member is a bitfield, behaviour is
 178    undefined.
 179    There is no standard-compliant way to do this.
 180    This implementation casts an integer zero to 'pointer to type', and then
 181    takes the address of member. This is undefined behaviour but should work on
 182    most compilers.
 183 */
 184 #define _PDCLIB_offsetof( type, member ) ( (size_t) &( ( (type *) 0 )->member ) )
 185
 186 /* Variable Length Parameter List Handling (<stdarg.h>)
 187    The macros defined by <stdarg.h> are highly dependent on the calling
 188    conventions used, and you probably have to replace them with builtins of
 189    your compiler. The following generic implementation works only for pure
 190    stack-based architectures, and only if arguments are aligned to pointer
 191    type. Credits to Michael Moody, who contributed this to the Public Domain.
 192 */
 193
 194 /* Internal helper macro. va_round is not part of <stdarg.h>. */
 195 #define _PDCLIB_va_round( type ) ( (sizeof(type) + sizeof(void *) - 1) & ~(sizeof(void *) - 1) )
 196
 197 typedef char * _PDCLIB_va_list;
 198 #define _PDCLIB_va_arg( ap, type ) ( (ap) += (_PDCLIB_va_round(type)), ( *(type*) ( (ap) - (_PDCLIB_va_round(type)) ) ) )
 199 #define _PDCLIB_va_copy( dest, src ) ( (dest) = (src), (void)0 )
 200 #define _PDCLIB_va_end( ap ) ( (ap) = (void *)0, (void)0 )
 201 #define _PDCLIB_va_start( ap, parmN ) ( (ap) = (char *) &parmN + ( _PDCLIB_va_round(parmN) ), (void)0 )
 202
 203 /* -------------------------------------------------------------------------- */
 204 /* OS "glue"                                                                  */
 205 /* This is where PDCLib interfaces with the operating system. The examples    */
 206 /* below are POSIX calls; provide your OS' equivalents.                       */
 207 /* -------------------------------------------------------------------------- */
 208
 209 /* A system call that terminates the calling process */
 210 void _exit( int status ) __attribute__(( noreturn ));
 211 #define _PDCLIB_Exit( x ) _exit( x )
 212
 213 /* Memory management */
 214
 215 /* Set this to the page size of your OS. If your OS does not support paging, set
 216    to an appropriate value. (Too small, and malloc() will call the kernel too
 217    often. Too large, and you will waste memory.
 218 */
 219 #define _PDCLIB_PAGESIZE 4096
 220
 221 /* Set this to the minimum memory node size. Any malloc() for a smaller siz
 222    will be satisfied by a malloc() of this size instead.
 223 */
 224 #define _PDCLIB_MINALLOC 8
 225
 226 /* Request another x pages (of size _PDCLIB_PAGESIZE) of memory from the kernel,
 227    or release them back to the kernel if n is negative.
 228    Return a (void *) pointing to the former end-of-heap if successful, NULL
 229    otherwise.
 230 */
 231 void * _PDCLIB_allocpages( int n );