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

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