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

   1 #ifndef _PDCLIB_CONFIG_H
   2 #define _PDCLIB_CONFIG_H
   3
   4 /* Internal PDCLib configuration <_PDCLIB_config.h>
   5    (Generic Template)
   6
   7    This file is part of the Public Domain C Library (PDCLib).
   8    Permission is granted to use, modify, and / or redistribute at will.
   9 */
  10
  11 /* -------------------------------------------------------------------------- */
  12 /* Misc                                                                       */
  13 /* -------------------------------------------------------------------------- */
  14
  15 /* The character (sequence) your platform uses as newline.                    */
  16 #define _PDCLIB_endl "\n"
  17
  18 /* exit() can signal success to the host environment by the value of zero or  */
  19 /* the constant EXIT_SUCCESS. Failure is signaled by EXIT_FAILURE. Note that  */
  20 /* any other return value is "implementation-defined", i.e. your environment  */
  21 /* is not required to handle it gracefully. Set your definitions here.        */
  22 #define _PDCLIB_SUCCESS 0
  23 #define _PDCLIB_FAILURE -1
  24
  25 /* qsort() in <stdlib.h> requires a function that swaps two memory areas.     */
  26 /* Below is a naive implementation that can be improved significantly for     */
  27 /* specific platforms, e.g. by swapping int instead of char.                  */
  28 #define _PDCLIB_memswp( i, j, size ) char tmp; do { tmp = *i; *i++ = *j; *j++ = tmp; } while ( --size );
  29
  30 /* The maximum value that errno can be set to. This is used to set the size   */
  31 /* of the array in struct lconv (<locale.h>) holding error messages for the   */
  32 /* strerror() and perror() functions. (If you change this value because you   */
  33 /* are using additional errno values, you *HAVE* to provide appropriate error */
  34 /* messages for *ALL* locales.)                                               */
  35 /* Default is 4 (0, ERANGE, EDOM, EILSEQ).                                    */
  36 #define _PDCLIB_ERRNO_MAX 4
  37
  38 /* -------------------------------------------------------------------------- */
  39 /* Integers                                                                   */
  40 /* -------------------------------------------------------------------------- */
  41 /* Assuming 8-bit char, two's-complement architecture here. 'short' being     */
  42 /* 16 bit, 'int' being either 16, 32 or 64 bit, 'long' being either 32 or 64  */
  43 /* bit (but 64 bit only if 'int' is 32 bit), and 'long long' being 64 bit if  */
  44 /* 'long' is not, 64 or 128 bit otherwise.                                    */
  45 /* Author is quite willing to support other systems but would like to hear of */
  46 /* interest in such support and details on the to-be-supported architecture   */
  47 /* first, before going to lengths about it.                                   */
  48 /* -------------------------------------------------------------------------- */
  49
  50 /* Comment out (or delete) the line below if your 'char' type is unsigned.    */
  51 #define _PDCLIB_CHAR_SIGNED 1
  52
  53 /* Width of the integer types short, int, long, and long long, in bytes.      */
  54 /* SHRT == 2, INT >= SHRT, LONG >= INT >= 4, LLONG >= LONG - check your       */
  55 /* compiler manuals.                                                          */
  56 #define _PDCLIB_SHRT_BYTES  2
  57 #define _PDCLIB_INT_BYTES   4
  58 #define _PDCLIB_LONG_BYTES  4
  59 #define _PDCLIB_LLONG_BYTES 8
  60
  61 /* <stdlib.h> defines the div() function family that allows taking quotient   */
  62 /* and remainder of an integer division in one operation. Many platforms      */
  63 /* support this in hardware / opcode, and the standard permits ordering of    */
  64 /* the return structure in any way to fit the hardware. That is why those     */
  65 /* structs can be configured here.                                            */
  66
  67 struct _PDCLIB_div_t
  68 {
  69     int quot;
  70     int rem;
  71 };
  72
  73 struct _PDCLIB_ldiv_t
  74 {
  75     long int quot;
  76     long int rem;
  77 };
  78
  79 struct _PDCLIB_lldiv_t
  80 {
  81     long long int quot;
  82     long long int rem;
  83 };
  84
  85 /* -------------------------------------------------------------------------- */
  86 /* <stdint.h> defines a set of integer types that are of a minimum width, and */
  87 /* "usually fastest" on the system. (If, for example, accessing a single char */
  88 /* requires the CPU to access a complete int and then mask out the char, the  */
  89 /* "usually fastest" type of at least 8 bits would be int, not char.)         */
  90 /* If you do not have information on the relative performance of the types,   */
  91 /* the standard allows you to define any type that meets minimum width and    */
  92 /* signedness requirements.                                                   */
  93 /* The defines below are just configuration for the real typedefs and limit   */
  94 /* definitions done in <_PDCLIB_int.h>. The uppercase define shall be either  */
  95 /* SHRT, INT, LONG, or LLONG (telling which values to use for the *_MIN and   */
  96 /* *_MAX limits); the lowercase define either short, int, long, or long long  */
  97 /* (telling the actual type to use).                                          */
  98 /* The third define is the length modifier used for the type in printf() and  */
  99 /* scanf() functions (used in <inttypes.h>).                                  */
 100 /* If you require a non-standard datatype to define the "usually fastest"     */
 101 /* types, PDCLib as-is doesn't support that. Please contact the author with   */
 102 /* details on your platform in that case, so support can be added.            */
 103 /* -------------------------------------------------------------------------- */
 104
 105 #define _PDCLIB_FAST8 INT
 106 #define _PDCLIB_fast8 int
 107 #define _PDCLIB_FAST8_CONV
 108
 109 #define _PDCLIB_FAST16 INT
 110 #define _PDCLIB_fast16 int
 111 #define _PDCLIB_FAST16_CONV
 112
 113 #define _PDCLIB_FAST32 INT
 114 #define _PDCLIB_fast32 int
 115 #define _PDCLIB_FAST32_CONV
 116
 117 #define _PDCLIB_FAST64 LLONG
 118 #define _PDCLIB_fast64 long long
 119 #define _PDCLIB_FAST64_CONV ll
 120
 121 /* -------------------------------------------------------------------------- */
 122 /* What follows are a couple of "special" typedefs and their limits. Again,   */
 123 /* the actual definition of the limits is done in <_PDCLIB_int.h>, and the    */
 124 /* defines here are merely "configuration". See above for details.            */
 125 /* -------------------------------------------------------------------------- */
 126
 127 /* The result type of substracting two pointers */
 128 #define _PDCLIB_ptrdiff int
 129 #define _PDCLIB_PTRDIFF INT
 130 #define _PDCLIB_PTR_CONV
 131
 132 /* An integer type that can be accessed as atomic entity (think asynchronous
 133    interrupts). The type itself is not defined in a freestanding environment,
 134    but its limits are. (Don't ask.)
 135 */
 136 #define _PDCLIB_sig_atomic int
 137 #define _PDCLIB_SIG_ATOMIC INT
 138
 139 /* Result type of the 'sizeof' operator (must be unsigned) */
 140 #define _PDCLIB_size unsigned int
 141 #define _PDCLIB_SIZE UINT
 142
 143 /* Large enough an integer to hold all character codes of the largest supported
 144    locale.
 145 */
 146 #define _PDCLIB_wchar unsigned short
 147 #define _PDCLIB_WCHAR USHRT
 148
 149 #define _PDCLIB_intptr int
 150 #define _PDCLIB_INTPTR INT
 151
 152 /* Largest supported integer type. Implementation note: see _PDCLIB_atomax(). */
 153 #define _PDCLIB_intmax long long int
 154 #define _PDCLIB_INTMAX LLONG
 155 #define _PDCLIB_MAX_CONV ll
 156 /* You are also required to state the literal suffix for the intmax type      */
 157 #define _PDCLIB_INTMAX_LITERAL ll
 158
 159 /* <inttypes.h> defines imaxdiv(), which is equivalent to the div() function  */
 160 /* family (see further above) with intmax_t as basis.                         */
 161
 162 struct _PDCLIB_imaxdiv_t
 163 {
 164     _PDCLIB_intmax quot;
 165     _PDCLIB_intmax rem;
 166 };
 167
 168 /* <time.h>: time_t
 169  * The C standard doesn't define what representation of time is stored in
 170  * time_t when returned by time() , but POSIX defines it to be seconds since the
 171  * UNIX epoch and most appplications expect that.
 172  *
 173  * time_t is also used as the tv_sec member of struct timespec, which *is*
 174  * defined as a linear count of seconds.
 175  *
 176  * time_t is defined as a "real type", so may be a floating point type, but with
 177  * the presence of the nanosecond accurate struct timespec, and with the lack of
 178  * any functions for manipulating more accurate values of time_t, this is
 179  * probably not useful.
 180  */
 181 #define _PDCLIB_time  unsigned long long
 182
 183 /* <time.h>: clock_t
 184  *
 185  * A count of "clock ticks", where the length of a clock tick is unspecified by
 186  * the standard. The implementation is required to provide a macro,
 187  * CLOCKS_PER_SEC, which is the number of "clock ticks" which corresponds to one
 188  * second.
 189  *
 190  * clock_t may be any real type (i.e. integral or floating), and its type on
 191  * various systems differs.
 192  *
 193  * On XSI systems, CLOCKS_PER_SEC must be defined to 1000000
 194  */
 195 #define _PDCLIB_clock double
 196 #define _PDCLIB_CLOCKS_PER_SEC 1000000
 197
 198 /* -------------------------------------------------------------------------- */
 199 /* Floating Point                                                             */
 200 /* -------------------------------------------------------------------------- */
 201
 202 /* Whether the implementation rounds toward zero (0), to nearest (1), toward
 203    positive infinity (2), or toward negative infinity (3). (-1) signifies
 204    indeterminable rounding, any other value implementation-specific rounding.
 205 */
 206 #define _PDCLIB_FLT_ROUNDS -1
 207
 208 /* Whether the implementation uses exact-width precision (0), promotes float
 209    to double (1), or promotes float and double to long double (2). (-1)
 210    signifies indeterminable behaviour, any other value implementation-specific
 211    behaviour.
 212 */
 213 #define _PDCLIB_FLT_EVAL_METHOD -1
 214
 215 /* "Number of the decimal digits (n), such that any floating-point number in the
 216    widest supported floating type with p(max) radix (b) digits can be rounded to
 217    a floating-point number with (n) decimal digits and back again without change
 218    to the value p(max) log(10)b if (b) is a power of 10, [1 + p(max) log(10)b]
 219    otherwise."
 220    64bit IEC 60559 double format (53bit mantissa) is DECIMAL_DIG 17.
 221    80bit IEC 60559 double-extended format (64bit mantissa) is DECIMAL_DIG 21.
 222 */
 223 #define _PDCLIB_DECIMAL_DIG 17
 224
 225 /* -------------------------------------------------------------------------- */
 226 /* Platform-dependent macros defined by the standard headers.                 */
 227 /* -------------------------------------------------------------------------- */
 228
 229 /* The offsetof macro
 230    Contract: Expand to an integer constant expression of type size_t, which
 231    represents the offset in bytes to the structure member from the beginning
 232    of the structure. If the specified member is a bitfield, behaviour is
 233    undefined.
 234    There is no standard-compliant way to do this.
 235    This implementation casts an integer zero to 'pointer to type', and then
 236    takes the address of member. This is undefined behaviour but should work on
 237    most compilers.
 238 */
 239 #define _PDCLIB_offsetof( type, member ) ( (size_t) &( ( (type *) 0 )->member ) )
 240
 241 /* Variable Length Parameter List Handling (<stdarg.h>)
 242    The macros defined by <stdarg.h> are highly dependent on the calling
 243    conventions used, and you probably have to replace them with builtins of
 244    your compiler. The following generic implementation works only for pure
 245    stack-based architectures, and only if arguments are aligned to pointer
 246    type. Credits to Michael Moody, who contributed this to the Public Domain.
 247 */
 248
 249 /* Internal helper macro. va_round is not part of <stdarg.h>. */
 250 #define _PDCLIB_va_round( type ) ( (sizeof(type) + sizeof(void *) - 1) & ~(sizeof(void *) - 1) )
 251
 252 typedef char * _PDCLIB_va_list;
 253 #define _PDCLIB_va_arg( ap, type ) ( (ap) += (_PDCLIB_va_round(type)), ( *(type*) ( (ap) - (_PDCLIB_va_round(type)) ) ) )
 254 #define _PDCLIB_va_copy( dest, src ) ( (dest) = (src), (void)0 )
 255 #define _PDCLIB_va_end( ap ) ( (ap) = (void *)0, (void)0 )
 256 #define _PDCLIB_va_start( ap, parmN ) ( (ap) = (char *) &parmN + ( _PDCLIB_va_round(parmN) ), (void)0 )
 257
 258 /* -------------------------------------------------------------------------- */
 259 /* OS "glue", part 1                                                          */
 260 /* These are values and data type definitions that you would have to adapt to */
 261 /* the capabilities and requirements of your OS.                              */
 262 /* The actual *functions* of the OS interface are declared in _PDCLIB_glue.h. */
 263 /* -------------------------------------------------------------------------- */
 264
 265 /* Memory management -------------------------------------------------------- */
 266
 267 /* Set this to the page size of your OS. If your OS does not support paging, set
 268    to an appropriate value. (Too small, and malloc() will call the kernel too
 269    often. Too large, and you will waste memory.)
 270 */
 271 #define _PDCLIB_PAGESIZE 4096
 272
 273 /* Set this to the minimum memory node size. Any malloc() for a smaller size
 274    will be satisfied by a malloc() of this size instead (to avoid excessive
 275    fragmentation).
 276 */
 277 #define _PDCLIB_MINALLOC 8
 278
 279 /* I/O ---------------------------------------------------------------------- */
 280
 281 /* The type of the file descriptor returned by _PDCLIB_open(). */
 282 typedef int _PDCLIB_fd_t;
 283
 284 /* The value (of type _PDCLIB_fd_t) returned by _PDCLIB_open() if the operation
 285    failed.
 286 */
 287 #define _PDCLIB_NOHANDLE ( (_PDCLIB_fd_t) -1 )
 288
 289 /* The default size for file buffers. Must be at least 256. */
 290 #define _PDCLIB_BUFSIZ 1024
 291
 292 /* The minimum number of files the implementation can open simultaneously. Must
 293    be at least 8. Depends largely on how the bookkeeping is done by fopen() /
 294    freopen() / fclose(). The example implementation limits the number of open
 295    files only by available memory.
 296 */
 297 #define _PDCLIB_FOPEN_MAX 8
 298
 299 /* Length of the longest filename the implementation guarantees to support. */
 300 #define _PDCLIB_FILENAME_MAX 128
 301
 302 /* Maximum length of filenames generated by tmpnam(). (See tmpfile.c.) */
 303 #define _PDCLIB_L_tmpnam 46
 304
 305 /* Number of distinct file names that can be generated by tmpnam(). */
 306 #define _PDCLIB_TMP_MAX 50
 307
 308 /* The values of SEEK_SET, SEEK_CUR and SEEK_END, used by fseek().
 309    Since at least one platform (POSIX) uses the same symbols for its own "seek"
 310    function, we use whatever the host defines (if it does define them).
 311 */
 312 #define _PDCLIB_SEEK_SET 0
 313 #define _PDCLIB_SEEK_CUR 1
 314 #define _PDCLIB_SEEK_END 2
 315
 316 /* The number of characters that can be buffered with ungetc(). The standard
 317    guarantees only one (1); anything larger would make applications relying on
 318    this capability dependent on implementation-defined behaviour (not good).
 319 */
 320 #define _PDCLIB_UNGETCBUFSIZE 1
 321
 322 /* errno -------------------------------------------------------------------- */
 323
 324 /* These are the values that _PDCLIB_errno can be set to by the library.
 325
 326    By keeping PDCLib's errno in the _PDCLIB_* namespace, the library is capable
 327    to "translate" between errno values used by the hosting operating system and
 328    those used and passed out by the library.
 329
 330    Example: In the example platform, the remove() function uses the unlink()
 331    system call as backend. Linux sets its errno to EISDIR if you try to unlink()
 332    a directory, but POSIX demands EPERM. Within the remove() function, you can
 333    catch the 'errno == EISDIR', and set '_PDCLIB_errno = _PDCLIB_EPERM'. Anyone
 334    using PDCLib's <errno.h> will "see" EPERM instead of EISDIR (the _PDCLIB_*
 335    prefix removed by <errno.h> mechanics).
 336
 337    If you do not want that kind of translation, you might want to "match" the
 338    values used by PDCLib with those used by the host OS, as to avoid confusion.
 339
 340    The C standard only defines three distinct errno values: ERANGE, EDOM, and
 341    EILSEQ. The standard leaves it up to "the implementation" whether there are
 342    any more beyond those three. There is some controversy as to whether errno is
 343    such a good idea at all, so you might want to come up with a different error
 344    reporting facility for your platform.
 345
 346    Things used to say "Since errno values beyond the three defined by the
 347    standard are not portable anyway (unless you look at POSIX), having your own
 348    error reporting facility would not hurt anybody either." at this point.
 349    However, then somebody birthed C++11 into the world, which copied POSIX's
 350    errno values into C++. Yes, even EINTR. Therefore, this library defines
 351    them. That said, thats nothing stopping you from using your own error
 352    reporting facility for things outside the C library.
 353
 354    Sometimes the standard says to set errno to indicate an error, but does not
 355    prescribe a value. We will use a value from the following list. If POSIX
 356    defines a value, we use that; otherwise, we use as seems suitable.
 357
 358    If porting to a system which uses an errno-like reporting system (e.g. a
 359    UNIX), you'll probably want to define them to match what the OS uses
 360 */
 361 /* C errno values */
 362 #define _PDCLIB_ERANGE 1
 363 #define _PDCLIB_EDOM   2
 364 #define _PDCLIB_EILSEQ 3
 365
 366 /* C++11/POSIX errno values */
 367 #define _PDCLIB_E2BIG 4
 368 #define _PDCLIB_ECONNRESET 5
 369 #define _PDCLIB_EISCONN 6
 370 #define _PDCLIB_ENOENT 7
 371 #define _PDCLIB_ENOTRECOVERABLE 8
 372 #define _PDCLIB_EROFS 9
 373 #define _PDCLIB_EACCES 10
 374 #define _PDCLIB_EDEADLK 11
 375 #define _PDCLIB_EISDIR 12
 376 #define _PDCLIB_ENOEXEC 13
 377 #define _PDCLIB_ENOTSOCK 14
 378 #define _PDCLIB_ESPIPE 15
 379 #define _PDCLIB_EADDRINUSE 16
 380 #define _PDCLIB_EDESTADDRREQ 17
 381 #define _PDCLIB_ELOOP 18
 382 #define _PDCLIB_ENOLCK 19
 383 #define _PDCLIB_ENOTSUPP 20
 384 #define _PDCLIB_ESRCH 21
 385 #define _PDCLIB_EADDRNOTAVAIL 22
 386 #define _PDCLIB_EMFILE 23
 387 #define _PDCLIB_ENOLINK 24
 388 #define _PDCLIB_ENOTTY 25
 389 #define _PDCLIB_ETIME 26
 390 #define _PDCLIB_EAFNOSUPPORT 27
 391 #define _PDCLIB_EEXIST 28
 392 #define _PDCLIB_EMLINK 29
 393 #define _PDCLIB_ENOMEM 30
 394 #define _PDCLIB_ENXIO 31
 395 #define _PDCLIB_ETIMEDOUT 32
 396 #define _PDCLIB_EAGAIN 33
 397 #define _PDCLIB_EFAULT 34
 398 #define _PDCLIB_EMSGSIZE 35
 399 #define _PDCLIB_ENOMSG 36
 400 #define _PDCLIB_EOPNOTSUPP 37
 401 #define _PDCLIB_ETXTBSY 38
 402 #define _PDCLIB_EALREADY 39
 403 #define _PDCLIB_EFBIG 40
 404 #define _PDCLIB_ENAMETOOLONG 41
 405 #define _PDCLIB_ENOPROTOOPT 42
 406 #define _PDCLIB_EOVERFLOW 43
 407 #define _PDCLIB_EWOULDBLOCK _PDCLIB_EAGAIN
 408 #define _PDCLIB_EBADF 44
 409 #define _PDCLIB_EHOSTUNREACH 45
 410 #define _PDCLIB_ENETDOWN 46
 411 #define _PDCLIB_ENOSPC 47
 412 #define _PDCLIB_EOWNERDEAD 48
 413 #define _PDCLIB_EXDEV 49
 414 #define _PDCLIB_EBADMSG 50
 415 #define _PDCLIB_EIDRM 51
 416 #define _PDCLIB_ENETRESET 52
 417 #define _PDCLIB_ENOSR 53
 418 #define _PDCLIB_EPERM 54
 419 #define _PDCLIB_EBUSY 55
 420 #define _PDCLIB_ENETUNREACH 56
 421 #define _PDCLIB_ENOSTR 57
 422 #define _PDCLIB_EPIPE 58
 423 #define _PDCLIB_ECANCELED 59
 424 #define _PDCLIB_EINPROGRESS 60
 425 #define _PDCLIB_ENFILE 61
 426 #define _PDCLIB_ENOSYS 62
 427 #define _PDCLIB_EPROTO 63
 428 #define _PDCLIB_ECHILD 64
 429 #define _PDCLIB_EINTR 65
 430 #define _PDCLIB_ENOBUFS 66
 431 #define _PDCLIB_ENOTCONN 67
 432 #define _PDCLIB_EPROTONOSUPPORT 68
 433 #define _PDCLIB_ECONNABORTED 69
 434 #define _PDCLIB_EINVAL 70
 435 #define _PDCLIB_ENODATA 71
 436 #define _PDCLIB_ENOTDIR 72
 437 #define _PDCLIB_EPROTOTYPE 73
 438
 439 #endif