1 #ifndef _PDCLIB_CONFIG_H
2 #define _PDCLIB_CONFIG_H
4 /* Internal PDCLib configuration <_PDCLIB_config.h>
7 This file is part of the Public Domain C Library (PDCLib).
8 Permission is granted to use, modify, and / or redistribute at will.
11 /* -------------------------------------------------------------------------- */
13 /* -------------------------------------------------------------------------- */
15 /* The character (sequence) your platform uses as newline. */
16 #define _PDCLIB_endl "\n"
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
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 );
30 /* -------------------------------------------------------------------------- */
32 /* -------------------------------------------------------------------------- */
33 /* Assuming 8-bit char, two's-complement architecture here. 'short' being */
34 /* 16 bit, 'int' being either 16, 32 or 64 bit, 'long' being either 32 or 64 */
35 /* bit (but 64 bit only if 'int' is 32 bit), and 'long long' being 64 bit if */
36 /* 'long' is not, 64 or 128 bit otherwise. */
37 /* Author is quite willing to support other systems but would like to hear of */
38 /* interest in such support and details on the to-be-supported architecture */
39 /* first, before going to lengths about it. */
40 /* -------------------------------------------------------------------------- */
42 /* Comment out (or delete) the line below if your 'char' type is unsigned. */
43 #define _PDCLIB_CHAR_SIGNED 1
45 /* Width of the integer types short, int, long, and long long, in bytes. */
46 /* SHRT == 2, INT >= SHRT, LONG >= INT >= 4, LLONG >= LONG - check your */
47 /* compiler manuals. */
48 #define _PDCLIB_SHRT_BYTES 2
49 #define _PDCLIB_INT_BYTES 4
50 #if defined(_LP64) || defined(__ILP64__)
51 #define _PDCLIB_LONG_BYTES 8
53 #define _PDCLIB_LONG_BYTES 4
55 #define _PDCLIB_LLONG_BYTES 8
57 // Match Darwin headers
58 #define _PDCLIB_INT64_IS_LLONG
60 /* <stdlib.h> defines the div() function family that allows taking quotient */
61 /* and remainder of an integer division in one operation. Many platforms */
62 /* support this in hardware / opcode, and the standard permits ordering of */
63 /* the return structure in any way to fit the hardware. That is why those */
64 /* structs can be configured here. */
78 struct _PDCLIB_lldiv_t
84 /* -------------------------------------------------------------------------- */
85 /* <stdint.h> defines a set of integer types that are of a minimum width, and */
86 /* "usually fastest" on the system. (If, for example, accessing a single char */
87 /* requires the CPU to access a complete int and then mask out the char, the */
88 /* "usually fastest" type of at least 8 bits would be int, not char.) */
89 /* If you do not have information on the relative performance of the types, */
90 /* the standard allows you to define any type that meets minimum width and */
91 /* signedness requirements. */
92 /* The defines below are just configuration for the real typedefs and limit */
93 /* definitions done in <_PDCLIB_int.h>. The uppercase define shall be either */
94 /* SHRT, INT, LONG, or LLONG (telling which values to use for the *_MIN and */
95 /* *_MAX limits); the lowercase define either short, int, long, or long long */
96 /* (telling the actual type to use). */
97 /* The third define is the length modifier used for the type in printf() and */
98 /* scanf() functions (used in <inttypes.h>). */
99 /* If you require a non-standard datatype to define the "usually fastest" */
100 /* types, PDCLib as-is doesn't support that. Please contact the author with */
101 /* details on your platform in that case, so support can be added. */
102 /* -------------------------------------------------------------------------- */
104 #define _PDCLIB_FAST8 INT
105 #define _PDCLIB_fast8 int
106 #define _PDCLIB_FAST8_CONV
108 #define _PDCLIB_FAST16 INT
109 #define _PDCLIB_fast16 int
110 #define _PDCLIB_FAST16_CONV
112 #define _PDCLIB_FAST32 INT
113 #define _PDCLIB_fast32 int
114 #define _PDCLIB_FAST32_CONV
117 #define _PDCLIB_FAST64 LONG
118 #define _PDCLIB_fast64 long
119 #define _PDCLIB_FAST64_CONV l
121 #define _PDCLIB_FAST64 LLONG
122 #define _PDCLIB_fast64 long long
123 #define _PDCLIB_FAST64_CONV ll
126 /* -------------------------------------------------------------------------- */
127 /* What follows are a couple of "special" typedefs and their limits. Again, */
128 /* the actual definition of the limits is done in <_PDCLIB_int.h>, and the */
129 /* defines here are merely "configuration". See above for details. */
130 /* -------------------------------------------------------------------------- */
132 /* The result type of substracting two pointers */
133 #define _PDCLIB_ptrdiff long
134 #define _PDCLIB_PTRDIFF LONG
135 #define _PDCLIB_PTR_CONV l
137 /* An integer type that can be accessed as atomic entity (think asynchronous
138 interrupts). The type itself is not defined in a freestanding environment,
139 but its limits are. (Don't ask.)
141 #define _PDCLIB_sig_atomic int
142 #define _PDCLIB_SIG_ATOMIC INT
144 /* Result type of the 'sizeof' operator (must be unsigned) */
145 #define _PDCLIB_size unsigned long
146 #define _PDCLIB_SIZE ULONG
148 /* Large enough an integer to hold all character codes of the largest supported
151 #define _PDCLIB_wint int
152 #define _PDCLIB_wchar int
153 #define _PDCLIB_WCHAR INT
155 #define _PDCLIB_intptr long
156 #define _PDCLIB_INTPTR LONG
158 /* Largest supported integer type. Implementation note: see _PDCLIB_atomax(). */
159 #define _PDCLIB_intmax long long int
160 #define _PDCLIB_INTMAX LLONG
161 #define _PDCLIB_MAX_CONV ll
162 /* You are also required to state the literal suffix for the intmax type */
163 #define _PDCLIB_INTMAX_LITERAL ll
165 /* <inttypes.h> defines imaxdiv(), which is equivalent to the div() function */
166 /* family (see further above) with intmax_t as basis. */
168 struct _PDCLIB_imaxdiv_t
175 * The C standard doesn't define what representation of time is stored in
176 * time_t when returned by time() , but POSIX defines it to be seconds since the
177 * UNIX epoch and most appplications expect that.
179 * time_t is also used as the tv_sec member of struct timespec, which *is*
180 * defined as a linear count of seconds.
182 * time_t is defined as a "real type", so may be a floating point type, but with
183 * the presence of the nanosecond accurate struct timespec, and with the lack of
184 * any functions for manipulating more accurate values of time_t, this is
185 * probably not useful.
187 #define _PDCLIB_time long
191 * A count of "clock ticks", where the length of a clock tick is unspecified by
192 * the standard. The implementation is required to provide a macro,
193 * CLOCKS_PER_SEC, which is the number of "clock ticks" which corresponds to one
196 * clock_t may be any real type (i.e. integral or floating), and its type on
197 * various systems differs.
199 * On XSI systems, CLOCKS_PER_SEC must be defined to 1000000
201 #define _PDCLIB_clock long
202 #define _PDCLIB_CLOCKS_PER_SEC 1000000
204 /* <time.h>: TIME_UTC
206 * The TIME_UTC parameter is passed to the timespec_get function in order to get
207 * the system time in UTC since an implementation defined epoch (not necessarily
208 * the same as that used for time_t). That said, on POSIX the obvious
209 * implementation of timespec_get for TIME_UTC is to wrap
210 * clock_gettime(CLOCK_REALTIME, ...), which is defined as time in UTC since the
213 * This may be any non-zero integer value.
215 #define _PDCLIB_TIME_UTC 1
217 /* -------------------------------------------------------------------------- */
219 /* -------------------------------------------------------------------------- */
221 /* Whether the implementation rounds toward zero (0), to nearest (1), toward
222 positive infinity (2), or toward negative infinity (3). (-1) signifies
223 indeterminable rounding, any other value implementation-specific rounding.
225 #define _PDCLIB_FLT_ROUNDS -1
227 /* Whether the implementation uses exact-width precision (0), promotes float
228 to double (1), or promotes float and double to long double (2). (-1)
229 signifies indeterminable behaviour, any other value implementation-specific
232 #define _PDCLIB_FLT_EVAL_METHOD -1
234 /* "Number of the decimal digits (n), such that any floating-point number in the
235 widest supported floating type with p(max) radix (b) digits can be rounded to
236 a floating-point number with (n) decimal digits and back again without change
237 to the value p(max) log(10)b if (b) is a power of 10, [1 + p(max) log(10)b]
239 64bit IEC 60559 double format (53bit mantissa) is DECIMAL_DIG 17.
240 80bit IEC 60559 double-extended format (64bit mantissa) is DECIMAL_DIG 21.
242 #define _PDCLIB_DECIMAL_DIG 17
244 /* Floating point types
246 * PDCLib (at present) assumes IEEE 754 floating point formats
247 * The following names are used:
248 * SINGLE: IEEE 754 single precision (32-bit)
249 * DOUBLE: IEEE 754 double precision (64-bit)
250 * EXTENDED: IEEE 754 extended precision (80-bit, as x87)
252 #define _PDCLIB_FLOAT_TYPE SINGLE
253 #define _PDCLIB_DOUBLE_TYPE DOUBLE
254 #define _PDCLIB_LDOUBLE_TYPE EXTENDED
256 /* -------------------------------------------------------------------------- */
257 /* Platform-dependent macros defined by the standard headers. */
258 /* -------------------------------------------------------------------------- */
260 /* The offsetof macro
261 Contract: Expand to an integer constant expression of type size_t, which
262 represents the offset in bytes to the structure member from the beginning
263 of the structure. If the specified member is a bitfield, behaviour is
265 There is no standard-compliant way to do this.
266 This implementation casts an integer zero to 'pointer to type', and then
267 takes the address of member. This is undefined behaviour but should work on
271 #define _PDCLIB_offsetof( type, member ) __builtin_offsetof( type, member )
273 #define _PDCLIB_offsetof( type, member ) ( (size_t) &( ( (type *) 0 )->member ) )
276 /* Variable Length Parameter List Handling (<stdarg.h>)
277 The macros defined by <stdarg.h> are highly dependent on the calling
278 conventions used, and you probably have to replace them with builtins of
283 typedef __builtin_va_list _PDCLIB_va_list;
284 #define _PDCLIB_va_arg( ap, type ) (__builtin_va_arg( (ap), type ))
285 #define _PDCLIB_va_copy( dest, src ) (__builtin_va_copy( (dest), (src) ))
286 #define _PDCLIB_va_end( ap ) (__builtin_va_end( ap ) )
287 #define _PDCLIB_va_start( ap, parmN ) (__builtin_va_start( (ap), (parmN) ))
288 #elif (defined(__i386__) || defined(__i386) || defined(_M_IX86)) && !(defined(__amd64__) || defined(__x86_64__) || defined(_M_AMD64))
289 /* Internal helper macro. va_round is not part of <stdarg.h>. */
290 #define _PDCLIB_va_round( type ) ( (sizeof(type) + sizeof(void *) - 1) & ~(sizeof(void *) - 1) )
292 typedef char * _PDCLIB_va_list;
293 #define _PDCLIB_va_arg( ap, type ) ( (ap) += (_PDCLIB_va_round(type)), ( *(type*) ( (ap) - (_PDCLIB_va_round(type)) ) ) )
294 #define _PDCLIB_va_copy( dest, src ) ( (dest) = (src), (void)0 )
295 #define _PDCLIB_va_end( ap ) ( (ap) = (void *)0, (void)0 )
296 #define _PDCLIB_va_start( ap, parmN ) ( (ap) = (char *) &parmN + ( _PDCLIB_va_round(parmN) ), (void)0 )
298 #error Compiler/Architecture support please
301 /* -------------------------------------------------------------------------- */
302 /* OS "glue", part 1 */
303 /* These are values and data type definitions that you would have to adapt to */
304 /* the capabilities and requirements of your OS. */
305 /* The actual *functions* of the OS interface are declared in _PDCLIB_glue.h. */
306 /* -------------------------------------------------------------------------- */
308 /* Memory management -------------------------------------------------------- */
310 /* Set this to the page size of your OS. If your OS does not support paging, set
311 to an appropriate value. (Too small, and malloc() will call the kernel too
312 often. Too large, and you will waste memory.)
314 #define _PDCLIB_MALLOC_PAGESIZE 4096
315 #define _PDCLIB_MALLOC_ALIGN 16
316 #define _PDCLIB_MALLOC_GRANULARITY 64*1024
317 #define _PDCLIB_MALLOC_TRIM_THRESHOLD 2*1024*1024
318 #define _PDCLIB_MALLOC_MMAP_THRESHOLD 256*1024
319 #define _PDCLIB_MALLOC_RELEASE_CHECK_RATE 4095
321 /* TODO: Better document these */
323 /* Locale --------------------------------------------------------------------*/
325 /* Locale method. See _PDCLIB_locale.h */
326 #define _PDCLIB_LOCALE_METHOD _PDCLIB_LOCALE_METHOD_TSS
328 /* wchar_t encoding */
329 #define _PDCLIB_WCHAR_ENCODING _PDCLIB_WCHAR_ENCODING_UCS4
331 /* I/O ---------------------------------------------------------------------- */
333 /* The default size for file buffers. Must be at least 256. */
334 #define _PDCLIB_BUFSIZ 1024
336 /* The minimum number of files the implementation can open simultaneously. Must
337 be at least 8. Depends largely on how the bookkeeping is done by fopen() /
338 freopen() / fclose(). The example implementation limits the number of open
339 files only by available memory.
341 #define _PDCLIB_FOPEN_MAX 8
343 /* Length of the longest filename the implementation guarantees to support. */
344 #define _PDCLIB_FILENAME_MAX 128
346 /* Maximum length of filenames generated by tmpnam(). (See tmpfile.c.) */
347 #define _PDCLIB_L_tmpnam 128
349 /* Number of distinct file names that can be generated by tmpnam(). */
350 #define _PDCLIB_TMP_MAX 50
352 /* The values of SEEK_SET, SEEK_CUR and SEEK_END, used by fseek().
353 Since at least one platform (POSIX) uses the same symbols for its own "seek"
354 function, we use whatever the host defines (if it does define them).
356 #define _PDCLIB_SEEK_SET 0
357 #define _PDCLIB_SEEK_CUR 1
358 #define _PDCLIB_SEEK_END 2
360 /* The number of characters that can be buffered with ungetc(). The standard
361 guarantees only one (1); anything larger would make applications relying on
362 this capability dependent on implementation-defined behaviour (not good).
364 #define _PDCLIB_UNGETCBUFSIZE 1
366 /* errno -------------------------------------------------------------------- */
368 /* These are the values that _PDCLIB_errno can be set to by the library.
370 By keeping PDCLib's errno in the _PDCLIB_* namespace, the library is capable
371 to "translate" between errno values used by the hosting operating system and
372 those used and passed out by the library.
374 Example: In the example platform, the remove() function uses the unlink()
375 system call as backend. Linux sets its errno to EISDIR if you try to unlink()
376 a directory, but POSIX demands EPERM. Within the remove() function, you can
377 catch the 'errno == EISDIR', and set '_PDCLIB_errno = _PDCLIB_EPERM'. Anyone
378 using PDCLib's <errno.h> will "see" EPERM instead of EISDIR (the _PDCLIB_*
379 prefix removed by <errno.h> mechanics).
381 If you do not want that kind of translation, you might want to "match" the
382 values used by PDCLib with those used by the host OS, to avoid confusion.
384 The C standard only defines three distinct errno values: ERANGE, EDOM, and
385 EILSEQ. The standard leaves it up to "the implementation" whether there are
386 any more beyond those three.
388 However, C++11 introduced the whole list of POSIX errno values into the
389 standard, so PDCLib might as well define those as well.
391 Sometimes the standard says to set errno to indicate an error, but does not
392 prescribe a value. We will use a value from the following list. If POSIX
393 defines a value, we use that; otherwise, we use as seems suitable.
396 /* These values were taken from Linux, gcc 4.8. */
397 #define _PDCLIB_E2BIG 7
398 #define _PDCLIB_EACCES 13
399 #define _PDCLIB_EADDRINUSE 98
400 #define _PDCLIB_EADDRNOTAVAIL 99
401 #define _PDCLIB_EAFNOSUPPORT 97
402 #define _PDCLIB_EAGAIN 11
403 #define _PDCLIB_EALREADY 114
404 #define _PDCLIB_EBADF 9
405 #define _PDCLIB_EBADMSG 74
406 #define _PDCLIB_EBUSY 16
407 #define _PDCLIB_ECANCELED 125
408 #define _PDCLIB_ECHILD 10
409 #define _PDCLIB_ECONNABORTED 103
410 #define _PDCLIB_ECONNREFUSED 111
411 #define _PDCLIB_ECONNRESET 104
412 #define _PDCLIB_EDEADLK 35
413 #define _PDCLIB_EDESTADDRREQ 89
414 #define _PDCLIB_EDOM 33
415 #define _PDCLIB_EEXIST 17
416 #define _PDCLIB_EFAULT 14
417 #define _PDCLIB_EFBIG 27
418 #define _PDCLIB_EHOSTUNREACH 113
419 #define _PDCLIB_EIDRM 43
420 #define _PDCLIB_EILSEQ 84
421 #define _PDCLIB_EINPROGRESS 115
422 #define _PDCLIB_EINTR 4
423 #define _PDCLIB_EINVAL 22
424 #define _PDCLIB_EIO 5
425 #define _PDCLIB_EISCONN 106
426 #define _PDCLIB_EISDIR 21
427 #define _PDCLIB_ELOOP 40
428 #define _PDCLIB_EMFILE 24
429 #define _PDCLIB_EMLINK 31
430 #define _PDCLIB_EMSGSIZE 90
431 #define _PDCLIB_ENAMETOOLONG 36
432 #define _PDCLIB_ENETDOWN 100
433 #define _PDCLIB_ENETRESET 102
434 #define _PDCLIB_ENETUNREACH 101
435 #define _PDCLIB_ENFILE 23
436 #define _PDCLIB_ENOBUFS 105
437 #define _PDCLIB_ENODATA 61
438 #define _PDCLIB_ENODEV 19
439 #define _PDCLIB_ENOENT 2
440 #define _PDCLIB_ENOEXEC 8
441 #define _PDCLIB_ENOLCK 37
442 #define _PDCLIB_ENOLINK 67
443 #define _PDCLIB_ENOMEM 12
444 #define _PDCLIB_ENOMSG 42
445 #define _PDCLIB_ENOPROTOOPT 92
446 #define _PDCLIB_ENOSPC 28
447 #define _PDCLIB_ENOSR 63
448 #define _PDCLIB_ENOSTR 60
449 #define _PDCLIB_ENOSYS 38
450 #define _PDCLIB_ENOTCONN 107
451 #define _PDCLIB_ENOTDIR 20
452 #define _PDCLIB_ENOTEMPTY 39
453 #define _PDCLIB_ENOTRECOVERABLE 131
454 #define _PDCLIB_ENOTSOCK 88
455 #define _PDCLIB_ENOTSUP 95
456 #define _PDCLIB_ENOTTY 25
457 #define _PDCLIB_ENXIO 6
458 #define _PDCLIB_EOPNOTSUPP 95
459 #define _PDCLIB_EOVERFLOW 75
460 #define _PDCLIB_EOWNERDEAD 130
461 #define _PDCLIB_EPERM 1
462 #define _PDCLIB_EPIPE 32
463 #define _PDCLIB_EPROTO 71
464 #define _PDCLIB_EPROTONOSUPPORT 93
465 #define _PDCLIB_EPROTOTYPE 91
466 #define _PDCLIB_ERANGE 34
467 #define _PDCLIB_EROFS 30
468 #define _PDCLIB_ESPIPE 29
469 #define _PDCLIB_ESRCH 3
470 #define _PDCLIB_ETIME 62
471 #define _PDCLIB_ETIMEDOUT 110
472 #define _PDCLIB_ETXTBSY 26
473 #define _PDCLIB_EWOULDBLOCK 11
474 #define _PDCLIB_EXDEV 18
476 /* This is used to set the size of the array in struct lconv (<locale.h>) */
477 /* holding the error messages for the strerror() and perror() fuctions. If */
478 /* you change this value because you are using additional errno values, you */
479 /* *HAVE* to provide appropriate error messages for *ALL* locales. */
480 /* Needs to be one higher than the highest errno value above. */
481 #define _PDCLIB_ERRNO_MAX 132