a9dc26f5036f91387fc3805e1d2614977ddf7531
[pdclib] / 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    (POSIX platform)
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 /* -------------------------------------------------------------------------- */
31 /* Integers                                                                   */
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 /* -------------------------------------------------------------------------- */
41
42 /* Comment out (or delete) the line below if your 'char' type is unsigned.    */
43 #define _PDCLIB_CHAR_SIGNED 1
44
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
52 #else
53 #define _PDCLIB_LONG_BYTES 4
54 #endif
55 #define _PDCLIB_LLONG_BYTES 8
56
57 // Match Darwin headers
58 #define _PDCLIB_INT64_IS_LLONG
59
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.                                            */
65
66 struct _PDCLIB_div_t
67 {
68     int quot;
69     int rem;
70 };
71
72 struct _PDCLIB_ldiv_t
73 {
74     long int quot;
75     long int rem;
76 };
77
78 struct _PDCLIB_lldiv_t
79 {
80     long long int quot;
81     long long int rem;
82 };
83
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 /* -------------------------------------------------------------------------- */
103
104 #define _PDCLIB_FAST8 INT
105 #define _PDCLIB_fast8 int
106 #define _PDCLIB_FAST8_CONV
107
108 #define _PDCLIB_FAST16 INT
109 #define _PDCLIB_fast16 int
110 #define _PDCLIB_FAST16_CONV
111
112 #define _PDCLIB_FAST32 INT
113 #define _PDCLIB_fast32 int
114 #define _PDCLIB_FAST32_CONV
115
116 #ifdef __LP64__
117 #define _PDCLIB_FAST64 LONG
118 #define _PDCLIB_fast64 long
119 #define _PDCLIB_FAST64_CONV l
120 #else
121 #define _PDCLIB_FAST64 LLONG
122 #define _PDCLIB_fast64 long long
123 #define _PDCLIB_FAST64_CONV ll
124 #endif
125
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 /* -------------------------------------------------------------------------- */
131
132 /* The types used for size_t and ptrdiff_t should not have an integer conversion
133    rank greater than that of signed long int unless the implementation supports
134    objects large enough to make this necessary.
135 */
136
137 /* Result type of substracting two pointers (must be signed) */
138 #define _PDCLIB_ptrdiff long
139 #define _PDCLIB_PTRDIFF LONG
140 #define _PDCLIB_PTR_CONV l
141
142 /* Result type of the 'sizeof' operator (must be unsigned) */
143 #define _PDCLIB_size unsigned long
144 #define _PDCLIB_SIZE ULONG
145
146 /* An integer type that can be accessed as atomic entity (think asynchronous
147    interrupts). The type itself is not defined in a freestanding environment,
148    but its limits are. (Don't ask.)
149 */
150 #define _PDCLIB_sig_atomic int
151 #define _PDCLIB_SIG_ATOMIC INT
152
153 /* Object type whose alignment is as great as supported by implementation
154    in all contexts.
155 */
156 #define _PDCLIB_max_align long double
157
158 /* Integer type whose range of values can represent distinct codes for
159    all members of the largest extended character set specified among the
160    supported locales.
161    Note that the definition of this type must agree with the type used
162    by the compiler for L"" string and L'' character literals.
163 */
164 #if defined(_LP64) || defined(__ILP64__)
165 #define _PDCLIB_wchar int
166 #define _PDCLIB_WCHAR INT
167 #else
168 #define _PDCLIB_wchar long
169 #define _PDCLIB_WCHAR LONG
170 #endif
171
172 /* Each member of the basic character set shall have a code value equal
173    to its value when used as the lone character in an integer character
174    constant. If that is not the case, uncomment the following line.
175 #define __STDC_MB_MIGHT_NEQ_WC__
176 */
177
178 /* Integer type unchanged by default argument promotions that can hold any
179    value corresponding to characters of the extended character set, as well
180    as at least one value that does not correspond to any member of the
181    extended character set (WEOF).
182 */
183 #define _PDCLIB_wint  int
184
185 #define _PDCLIB_intptr long
186 #define _PDCLIB_INTPTR LONG
187
188 /* Largest supported integer type. Implementation note: see _PDCLIB_atomax(). */
189 #define _PDCLIB_intmax long long int
190 #define _PDCLIB_INTMAX LLONG
191 #define _PDCLIB_MAX_CONV ll
192 /* You are also required to state the literal suffix for the intmax type      */
193 #define _PDCLIB_INTMAX_LITERAL ll
194
195 /* <inttypes.h> defines imaxdiv(), which is equivalent to the div() function  */
196 /* family (see further above) with intmax_t as basis.                         */
197
198 struct _PDCLIB_imaxdiv_t
199 {
200     _PDCLIB_intmax quot;
201     _PDCLIB_intmax rem;
202 };
203
204 /* <time.h>: time_t
205  * The C standard doesn't define what representation of time is stored in
206  * time_t when returned by time() , but POSIX defines it to be seconds since the
207  * UNIX epoch and most appplications expect that.
208  *
209  * time_t is also used as the tv_sec member of struct timespec, which *is*
210  * defined as a linear count of seconds.
211  *
212  * time_t is defined as a "real type", so may be a floating point type, but with
213  * the presence of the nanosecond accurate struct timespec, and with the lack of
214  * any functions for manipulating more accurate values of time_t, this is
215  * probably not useful.
216  */
217 #define _PDCLIB_time long
218
219 /* <time.h>: clock_t
220  *
221  * A count of "clock ticks", where the length of a clock tick is unspecified by
222  * the standard. The implementation is required to provide a macro,
223  * CLOCKS_PER_SEC, which is the number of "clock ticks" which corresponds to one
224  * second.
225  *
226  * clock_t may be any real type (i.e. integral or floating), and its type on
227  * various systems differs.
228  *
229  * On XSI systems, CLOCKS_PER_SEC must be defined to 1000000
230  */
231 #define _PDCLIB_clock long
232 #define _PDCLIB_CLOCKS_PER_SEC 1000000
233
234 /* <time.h>: TIME_UTC
235  *
236  * The TIME_UTC parameter is passed to the timespec_get function in order to get
237  * the system time in UTC since an implementation defined epoch (not necessarily
238  * the same as that used for time_t). That said, on POSIX the obvious
239  * implementation of timespec_get for TIME_UTC is to wrap
240  * clock_gettime(CLOCK_REALTIME, ...), which is defined as time in UTC since the
241  * same epoch.
242  *
243  * This may be any non-zero integer value.
244  */
245 #define _PDCLIB_TIME_UTC 1
246
247 /* -------------------------------------------------------------------------- */
248 /* Floating Point                                                             */
249 /* -------------------------------------------------------------------------- */
250
251 /* Whether the implementation rounds toward zero (0), to nearest (1), toward
252    positive infinity (2), or toward negative infinity (3). (-1) signifies
253    indeterminable rounding, any other value implementation-specific rounding.
254 */
255 #define _PDCLIB_FLT_ROUNDS -1
256
257 /* Whether the implementation uses exact-width precision (0), promotes float
258    to double (1), or promotes float and double to long double (2). (-1)
259    signifies indeterminable behaviour, any other value implementation-specific
260    behaviour.
261 */
262 #define _PDCLIB_FLT_EVAL_METHOD -1
263
264 /* "Number of the decimal digits (n), such that any floating-point number in the
265    widest supported floating type with p(max) radix (b) digits can be rounded to
266    a floating-point number with (n) decimal digits and back again without change
267    to the value p(max) log(10)b if (b) is a power of 10, [1 + p(max) log(10)b]
268    otherwise."
269    64bit IEC 60559 double format (53bit mantissa) is DECIMAL_DIG 17.
270    80bit IEC 60559 double-extended format (64bit mantissa) is DECIMAL_DIG 21.
271 */
272 #define _PDCLIB_DECIMAL_DIG 17
273
274 /* Floating point types
275  *
276  * PDCLib (at present) assumes IEEE 754 floating point formats
277  * The following names are used:
278  *    SINGLE:   IEEE 754 single precision (32-bit)
279  *    DOUBLE:   IEEE 754 double precision (64-bit)
280  *    EXTENDED: IEEE 754 extended precision (80-bit, as x87)
281  */
282 #define _PDCLIB_FLOAT_TYPE   SINGLE
283 #define _PDCLIB_DOUBLE_TYPE  DOUBLE
284 #define _PDCLIB_LDOUBLE_TYPE EXTENDED
285
286 /* -------------------------------------------------------------------------- */
287 /* Platform-dependent macros defined by the standard headers.                 */
288 /* -------------------------------------------------------------------------- */
289
290 /* The offsetof macro
291    Contract: Expand to an integer constant expression of type size_t, which
292    represents the offset in bytes to the structure member from the beginning
293    of the structure. If the specified member is a bitfield, behaviour is
294    undefined.
295    There is no standard-compliant way to do this.
296    This implementation casts an integer zero to 'pointer to type', and then
297    takes the address of member. This is undefined behaviour but should work on
298    most compilers.
299 */
300 #ifdef __GNUC__
301 #define _PDCLIB_offsetof( type, member ) __builtin_offsetof( type, member )
302 #else
303 #define _PDCLIB_offsetof( type, member ) ( (size_t) &( ( (type *) 0 )->member ) )
304 #endif
305
306 /* Variable Length Parameter List Handling (<stdarg.h>)
307    The macros defined by <stdarg.h> are highly dependent on the calling
308    conventions used, and you probably have to replace them with builtins of
309    your compiler.
310 */
311
312 #ifdef __GNUC__
313 typedef __builtin_va_list _PDCLIB_va_list;
314 #define _PDCLIB_va_arg( ap, type ) (__builtin_va_arg( (ap), type ))
315 #define _PDCLIB_va_copy( dest, src ) (__builtin_va_copy( (dest), (src) ))
316 #define _PDCLIB_va_end( ap ) (__builtin_va_end( ap ) )
317 #define _PDCLIB_va_start( ap, parmN ) (__builtin_va_start( (ap), (parmN) ))
318 #elif (defined(__i386__) || defined(__i386) || defined(_M_IX86)) && !(defined(__amd64__) || defined(__x86_64__) || defined(_M_AMD64))
319 /* Internal helper macro. va_round is not part of <stdarg.h>. */
320 #define _PDCLIB_va_round( type ) ( (sizeof(type) + sizeof(void *) - 1) & ~(sizeof(void *) - 1) )
321 typedef char * _PDCLIB_va_list;
322 #define _PDCLIB_va_arg( ap, type ) ( (ap) += (_PDCLIB_va_round(type)), ( *(type*) ( (ap) - (_PDCLIB_va_round(type)) ) ) )
323 #define _PDCLIB_va_copy( dest, src ) ( (dest) = (src), (void)0 )
324 #define _PDCLIB_va_end( ap ) ( (ap) = (void *)0, (void)0 )
325 #define _PDCLIB_va_start( ap, parmN ) ( (ap) = (char *) &parmN + ( _PDCLIB_va_round(parmN) ), (void)0 )
326 #else
327 #error Compiler/Architecture support please
328 #endif
329
330 /* -------------------------------------------------------------------------- */
331 /* OS "glue", part 1                                                          */
332 /* These are values and data type definitions that you would have to adapt to */
333 /* the capabilities and requirements of your OS.                              */
334 /* The actual *functions* of the OS interface are declared in _PDCLIB_glue.h. */
335 /* -------------------------------------------------------------------------- */
336
337 /* Memory management -------------------------------------------------------- */
338
339 /* Set this to the page size of your OS. If your OS does not support paging, set
340    to an appropriate value. (Too small, and malloc() will call the kernel too
341    often. Too large, and you will waste memory.)
342 */
343 #define _PDCLIB_MALLOC_PAGESIZE 4096
344 #define _PDCLIB_MALLOC_ALIGN 16
345 #define _PDCLIB_MALLOC_GRANULARITY 64*1024
346 #define _PDCLIB_MALLOC_TRIM_THRESHOLD 2*1024*1024
347 #define _PDCLIB_MALLOC_MMAP_THRESHOLD 256*1024
348 #define _PDCLIB_MALLOC_RELEASE_CHECK_RATE 4095
349
350 /* TODO: Better document these */
351
352 /* Locale --------------------------------------------------------------------*/
353
354 /* Locale method. See _PDCLIB_locale.h. If undefined, POSIX per-thread locales
355    will be disabled.
356 */
357 #define _PDCLIB_LOCALE_METHOD _PDCLIB_LOCALE_METHOD_TSS
358
359 /* wchar_t encoding */
360 #define _PDCLIB_WCHAR_ENCODING _PDCLIB_WCHAR_ENCODING_UCS4
361
362 /* I/O ---------------------------------------------------------------------- */
363
364 /* The default size for file buffers. Must be at least 256. */
365 #define _PDCLIB_BUFSIZ 1024
366
367 /* The minimum number of files the implementation can open simultaneously. Must
368    be at least 8. Depends largely on how the bookkeeping is done by fopen() /
369    freopen() / fclose(). The example implementation limits the number of open
370    files only by available memory.
371 */
372 #define _PDCLIB_FOPEN_MAX 8
373
374 /* Length of the longest filename the implementation guarantees to support. */
375 #define _PDCLIB_FILENAME_MAX 128
376
377 /* Maximum length of filenames generated by tmpnam(). (See tmpfile.c.) */
378 #define _PDCLIB_L_tmpnam 128
379
380 /* Number of distinct file names that can be generated by tmpnam(). */
381 #define _PDCLIB_TMP_MAX 50
382
383 /* The values of SEEK_SET, SEEK_CUR and SEEK_END, used by fseek().
384    Since at least one platform (POSIX) uses the same symbols for its own "seek"
385    function, we use whatever the host defines (if it does define them).
386 */
387 #define _PDCLIB_SEEK_SET 0
388 #define _PDCLIB_SEEK_CUR 1
389 #define _PDCLIB_SEEK_END 2
390
391 /* The number of characters that can be buffered with ungetc(). The standard
392    guarantees only one (1); anything larger would make applications relying on
393    this capability dependent on implementation-defined behaviour (not good).
394 */
395 #define _PDCLIB_UNGETCBUFSIZE 1
396
397 /* errno -------------------------------------------------------------------- */
398
399 /* These are the values that _PDCLIB_errno can be set to by the library.
400
401    By keeping PDCLib's errno in the _PDCLIB_* namespace, the library is capable
402    to "translate" between errno values used by the hosting operating system and
403    those used and passed out by the library.
404
405    Example: In the example platform, the remove() function uses the unlink()
406    system call as backend. Linux sets its errno to EISDIR if you try to unlink()
407    a directory, but POSIX demands EPERM. Within the remove() function, you can
408    catch the 'errno == EISDIR', and set '_PDCLIB_errno = _PDCLIB_EPERM'. Anyone
409    using PDCLib's <errno.h> will "see" EPERM instead of EISDIR (the _PDCLIB_*
410    prefix removed by <errno.h> mechanics).
411
412    If you do not want that kind of translation, you might want to "match" the
413    values used by PDCLib with those used by the host OS, as to avoid confusion.
414
415    The C standard only defines three distinct errno values: ERANGE, EDOM, and
416    EILSEQ. The standard leaves it up to "the implementation" whether there are
417    any more beyond those three.
418
419    However, C++11 introduced the whole list of POSIX errno values into the
420    standard, so PDCLib might as well define those as well.
421
422    Sometimes the standard says to set errno to indicate an error, but does not
423    prescribe a value. We will use a value from the following list. If POSIX
424    defines a value, we use that; otherwise, we use as seems suitable.
425 */
426
427 /* These values were taken from Linux, gcc 4.8. */
428 #define _PDCLIB_E2BIG              7
429 #define _PDCLIB_EACCES            13
430 #define _PDCLIB_EADDRINUSE        98
431 #define _PDCLIB_EADDRNOTAVAIL     99
432 #define _PDCLIB_EAFNOSUPPORT      97
433 #define _PDCLIB_EAGAIN            11
434 #define _PDCLIB_EALREADY         114
435 #define _PDCLIB_EBADF              9
436 #define _PDCLIB_EBADMSG           74
437 #define _PDCLIB_EBUSY             16
438 #define _PDCLIB_ECANCELED        125
439 #define _PDCLIB_ECHILD            10
440 #define _PDCLIB_ECONNABORTED     103
441 #define _PDCLIB_ECONNREFUSED     111
442 #define _PDCLIB_ECONNRESET       104
443 #define _PDCLIB_EDEADLK           35
444 #define _PDCLIB_EDESTADDRREQ      89
445 #define _PDCLIB_EDOM              33
446 #define _PDCLIB_EEXIST            17
447 #define _PDCLIB_EFAULT            14
448 #define _PDCLIB_EFBIG             27
449 #define _PDCLIB_EHOSTUNREACH     113
450 #define _PDCLIB_EIDRM             43
451 #define _PDCLIB_EILSEQ            84
452 #define _PDCLIB_EINPROGRESS      115
453 #define _PDCLIB_EINTR              4
454 #define _PDCLIB_EINVAL            22
455 #define _PDCLIB_EIO                5
456 #define _PDCLIB_EISCONN          106
457 #define _PDCLIB_EISDIR            21
458 #define _PDCLIB_ELOOP             40
459 #define _PDCLIB_EMFILE            24
460 #define _PDCLIB_EMLINK            31
461 #define _PDCLIB_EMSGSIZE          90
462 #define _PDCLIB_ENAMETOOLONG      36
463 #define _PDCLIB_ENETDOWN         100
464 #define _PDCLIB_ENETRESET        102
465 #define _PDCLIB_ENETUNREACH      101
466 #define _PDCLIB_ENFILE            23
467 #define _PDCLIB_ENOBUFS          105
468 #define _PDCLIB_ENODATA           61
469 #define _PDCLIB_ENODEV            19
470 #define _PDCLIB_ENOENT             2
471 #define _PDCLIB_ENOEXEC            8
472 #define _PDCLIB_ENOLCK            37
473 #define _PDCLIB_ENOLINK           67
474 #define _PDCLIB_ENOMEM            12
475 #define _PDCLIB_ENOMSG            42
476 #define _PDCLIB_ENOPROTOOPT       92
477 #define _PDCLIB_ENOSPC            28
478 #define _PDCLIB_ENOSR             63
479 #define _PDCLIB_ENOSTR            60
480 #define _PDCLIB_ENOSYS            38
481 #define _PDCLIB_ENOTCONN         107
482 #define _PDCLIB_ENOTDIR           20
483 #define _PDCLIB_ENOTEMPTY         39
484 #define _PDCLIB_ENOTRECOVERABLE  131
485 #define _PDCLIB_ENOTSOCK          88
486 #define _PDCLIB_ENOTSUP           95
487 #define _PDCLIB_ENOTTY            25
488 #define _PDCLIB_ENXIO              6
489 #define _PDCLIB_EOPNOTSUPP        95
490 #define _PDCLIB_EOVERFLOW         75
491 #define _PDCLIB_EOWNERDEAD       130
492 #define _PDCLIB_EPERM              1
493 #define _PDCLIB_EPIPE             32
494 #define _PDCLIB_EPROTO            71
495 #define _PDCLIB_EPROTONOSUPPORT   93
496 #define _PDCLIB_EPROTOTYPE        91
497 #define _PDCLIB_ERANGE            34
498 #define _PDCLIB_EROFS             30
499 #define _PDCLIB_ESPIPE            29
500 #define _PDCLIB_ESRCH              3
501 #define _PDCLIB_ETIME             62
502 #define _PDCLIB_ETIMEDOUT        110
503 #define _PDCLIB_ETXTBSY           26
504 #define _PDCLIB_EWOULDBLOCK       11
505 #define _PDCLIB_EXDEV             18
506
507 /* This is used to set the size of the array in struct lconv (<locale.h>)     */
508 /* holding the error messages for the strerror() and perror() fuctions. If    */
509 /* you change this value because you are using additional errno values, you   */
510 /* *HAVE* to provide appropriate error messages for *ALL* locales.            */
511 /* Needs to be one higher than the highest errno value above.                 */
512 #define _PDCLIB_ERRNO_MAX 132
513
514 #endif