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