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