]> pd.if.org Git - pdclib.old/blob - platform/example/internals/_PDCLIB_config.h
roff typo fix (-St -> .St)
[pdclib.old] / 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 /* 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_wint  signed int
147 #define _PDCLIB_wchar unsigned int
148 #define _PDCLIB_WCHAR UINT
149
150 #define _PDCLIB_intptr int
151 #define _PDCLIB_INTPTR INT
152
153 /* Largest supported integer type. Implementation note: see _PDCLIB_atomax(). */
154 #define _PDCLIB_intmax long long int
155 #define _PDCLIB_INTMAX LLONG
156 #define _PDCLIB_MAX_CONV ll
157 /* You are also required to state the literal suffix for the intmax type      */
158 #define _PDCLIB_INTMAX_LITERAL ll
159
160 /* <inttypes.h> defines imaxdiv(), which is equivalent to the div() function  */
161 /* family (see further above) with intmax_t as basis.                         */
162
163 struct _PDCLIB_imaxdiv_t
164 {
165     _PDCLIB_intmax quot;
166     _PDCLIB_intmax rem;
167 };
168
169 /* <time.h>: time_t 
170  * The C standard doesn't define what representation of time is stored in 
171  * time_t when returned by time() , but POSIX defines it to be seconds since the
172  * UNIX epoch and most appplications expect that. 
173  *
174  * time_t is also used as the tv_sec member of struct timespec, which *is* 
175  * defined as a linear count of seconds.
176  *
177  * time_t is defined as a "real type", so may be a floating point type, but with
178  * the presence of the nanosecond accurate struct timespec, and with the lack of
179  * any functions for manipulating more accurate values of time_t, this is 
180  * probably not useful.
181  */
182 #define _PDCLIB_time  unsigned long long
183
184 /* <time.h>: clock_t
185  *
186  * A count of "clock ticks", where the length of a clock tick is unspecified by
187  * the standard. The implementation is required to provide a macro, 
188  * CLOCKS_PER_SEC, which is the number of "clock ticks" which corresponds to one
189  * second.
190  *
191  * clock_t may be any real type (i.e. integral or floating), and its type on
192  * various systems differs. 
193  *
194  * On XSI systems, CLOCKS_PER_SEC must be defined to 1000000
195  */
196 #define _PDCLIB_clock double
197 #define _PDCLIB_CLOCKS_PER_SEC 1000000
198
199 /* <time.h>: TIME_UTC
200  *
201  * The TIME_UTC parameter is passed to the timespec_get function in order to get
202  * the system time in UTC since an implementation defined epoch (not necessarily
203  * the same as that used for time_t). That said, on POSIX the obvious 
204  * implementation of timespec_get for TIME_UTC is to wrap 
205  * clock_gettime(CLOCK_REALTIME, ...), which is defined as time in UTC since the
206  * same epoch.
207  *
208  * This may be any non-zero integer value.
209  */
210 #define _PDCLIB_TIME_UTC 1
211
212 /* -------------------------------------------------------------------------- */
213 /* Floating Point                                                             */
214 /* -------------------------------------------------------------------------- */
215
216 /* Whether the implementation rounds toward zero (0), to nearest (1), toward
217    positive infinity (2), or toward negative infinity (3). (-1) signifies
218    indeterminable rounding, any other value implementation-specific rounding.
219 */
220 #define _PDCLIB_FLT_ROUNDS -1
221
222 /* Whether the implementation uses exact-width precision (0), promotes float
223    to double (1), or promotes float and double to long double (2). (-1)
224    signifies indeterminable behaviour, any other value implementation-specific
225    behaviour.
226 */
227 #define _PDCLIB_FLT_EVAL_METHOD -1
228
229 /* "Number of the decimal digits (n), such that any floating-point number in the
230    widest supported floating type with p(max) radix (b) digits can be rounded to
231    a floating-point number with (n) decimal digits and back again without change
232    to the value p(max) log(10)b if (b) is a power of 10, [1 + p(max) log(10)b]
233    otherwise."
234    64bit IEC 60559 double format (53bit mantissa) is DECIMAL_DIG 17.
235    80bit IEC 60559 double-extended format (64bit mantissa) is DECIMAL_DIG 21.
236 */
237 #define _PDCLIB_DECIMAL_DIG 17
238
239 /* -------------------------------------------------------------------------- */
240 /* Platform-dependent macros defined by the standard headers.                 */
241 /* -------------------------------------------------------------------------- */
242
243 /* The offsetof macro
244    Contract: Expand to an integer constant expression of type size_t, which
245    represents the offset in bytes to the structure member from the beginning
246    of the structure. If the specified member is a bitfield, behaviour is
247    undefined.
248    There is no standard-compliant way to do this.
249    This implementation casts an integer zero to 'pointer to type', and then
250    takes the address of member. This is undefined behaviour but should work on
251    most compilers.
252 */
253 #define _PDCLIB_offsetof( type, member ) ( (size_t) &( ( (type *) 0 )->member ) )
254
255 /* Variable Length Parameter List Handling (<stdarg.h>)
256    The macros defined by <stdarg.h> are highly dependent on the calling
257    conventions used, and you probably have to replace them with builtins of
258    your compiler. The following generic implementation works only for pure
259    stack-based architectures, and only if arguments are aligned to pointer
260    type. Credits to Michael Moody, who contributed this to the Public Domain.
261 */
262
263 /* Internal helper macro. va_round is not part of <stdarg.h>. */
264 #define _PDCLIB_va_round( type ) ( (sizeof(type) + sizeof(void *) - 1) & ~(sizeof(void *) - 1) )
265
266 typedef char * _PDCLIB_va_list;
267 #define _PDCLIB_va_arg( ap, type ) ( (ap) += (_PDCLIB_va_round(type)), ( *(type*) ( (ap) - (_PDCLIB_va_round(type)) ) ) )
268 #define _PDCLIB_va_copy( dest, src ) ( (dest) = (src), (void)0 )
269 #define _PDCLIB_va_end( ap ) ( (ap) = (void *)0, (void)0 )
270 #define _PDCLIB_va_start( ap, parmN ) ( (ap) = (char *) &parmN + ( _PDCLIB_va_round(parmN) ), (void)0 )
271
272 /* -------------------------------------------------------------------------- */
273 /* OS "glue", part 1                                                          */
274 /* These are values and data type definitions that you would have to adapt to */
275 /* the capabilities and requirements of your OS.                              */
276 /* The actual *functions* of the OS interface are declared in _PDCLIB_glue.h. */
277 /* -------------------------------------------------------------------------- */
278
279 /* Memory management -------------------------------------------------------- */
280
281 /* Set this to the page size of your OS. If your OS does not support paging, set
282    to an appropriate value. (Too small, and malloc() will call the kernel too
283    often. Too large, and you will waste memory.)
284 */
285 #define _PDCLIB_MALLOC_PAGESIZE 4096
286 #define _PDCLIB_MALLOC_ALIGN 16
287 #define _PDCLIB_MALLOC_GRANULARITY 64*1024
288 #define _PDCLIB_MALLOC_TRIM_THRESHOLD 2*1024*1024
289 #define _PDCLIB_MALLOC_MMAP_THRESHOLD 256*1024
290 #define _PDCLIB_MALLOC_RELEASE_CHECK_RATE 4095
291
292 /* TODO: Better document these */
293
294 /* I/O ---------------------------------------------------------------------- */
295
296 /* The type of the file descriptor returned by _PDCLIB_open(). */
297 typedef int _PDCLIB_fd_t;
298
299 /* The value (of type _PDCLIB_fd_t) returned by _PDCLIB_open() if the operation
300    failed.
301 */
302 #define _PDCLIB_NOHANDLE ( (_PDCLIB_fd_t) -1 )
303
304 /* The default size for file buffers. Must be at least 256. */
305 #define _PDCLIB_BUFSIZ 1024
306
307 /* The minimum number of files the implementation can open simultaneously. Must
308    be at least 8. Depends largely on how the bookkeeping is done by fopen() /
309    freopen() / fclose(). The example implementation limits the number of open
310    files only by available memory.
311 */
312 #define _PDCLIB_FOPEN_MAX 8
313
314 /* Length of the longest filename the implementation guarantees to support. */
315 #define _PDCLIB_FILENAME_MAX 128
316
317 /* Maximum length of filenames generated by tmpnam(). (See tmpfile.c.) */
318 #define _PDCLIB_L_tmpnam 46
319
320 /* Number of distinct file names that can be generated by tmpnam(). */
321 #define _PDCLIB_TMP_MAX 50
322
323 /* The values of SEEK_SET, SEEK_CUR and SEEK_END, used by fseek().
324    Since at least one platform (POSIX) uses the same symbols for its own "seek"
325    function, we use whatever the host defines (if it does define them).
326 */
327 #define _PDCLIB_SEEK_SET 0
328 #define _PDCLIB_SEEK_CUR 1
329 #define _PDCLIB_SEEK_END 2
330
331 /* The number of characters that can be buffered with ungetc(). The standard
332    guarantees only one (1); anything larger would make applications relying on
333    this capability dependent on implementation-defined behaviour (not good).
334 */
335 #define _PDCLIB_UNGETCBUFSIZE 1
336
337 /* errno -------------------------------------------------------------------- */
338
339 /* These are the values that _PDCLIB_errno can be set to by the library.
340
341    By keeping PDCLib's errno in the _PDCLIB_* namespace, the library is capable
342    to "translate" between errno values used by the hosting operating system and
343    those used and passed out by the library.
344
345    Example: In the example platform, the remove() function uses the unlink()
346    system call as backend. Linux sets its errno to EISDIR if you try to unlink()
347    a directory, but POSIX demands EPERM. Within the remove() function, you can
348    catch the 'errno == EISDIR', and set '_PDCLIB_errno = _PDCLIB_EPERM'. Anyone
349    using PDCLib's <errno.h> will "see" EPERM instead of EISDIR (the _PDCLIB_*
350    prefix removed by <errno.h> mechanics).
351
352    If you do not want that kind of translation, you might want to "match" the
353    values used by PDCLib with those used by the host OS, as to avoid confusion.
354
355    The C standard only defines three distinct errno values: ERANGE, EDOM, and
356    EILSEQ. The standard leaves it up to "the implementation" whether there are
357    any more beyond those three. There is some controversy as to whether errno is
358    such a good idea at all, so you might want to come up with a different error
359    reporting facility for your platform. 
360
361    Things used to say "Since errno values beyond the three defined by the 
362    standard are not portable anyway (unless you look at POSIX), having your own
363    error reporting facility would not hurt anybody either." at this point. 
364    However, then somebody birthed C++11 into the world, which copied POSIX's 
365    errno values into C++. Yes, even EINTR. Therefore, this library defines 
366    them. That said, thats nothing stopping you from using your own error 
367    reporting facility for things outside the C library.
368
369    Sometimes the standard says to set errno to indicate an error, but does not 
370    prescribe a value. We will use a value from the following list. If POSIX 
371    defines a value, we use that; otherwise, we use as seems suitable.
372
373    If porting to a system which uses an errno-like reporting system (e.g. a 
374    UNIX), you'll probably want to define them to match what the OS uses
375 */
376 /* C errno values */
377 #define _PDCLIB_ERANGE 1
378 #define _PDCLIB_EDOM   2
379 #define _PDCLIB_EILSEQ 3
380
381 /* C++11/POSIX errno values */
382 #define _PDCLIB_E2BIG 4
383 #define _PDCLIB_ECONNRESET 5
384 #define _PDCLIB_EISCONN 6
385 #define _PDCLIB_ENOENT 7
386 #define _PDCLIB_ENOTRECOVERABLE 8
387 #define _PDCLIB_EROFS 9
388 #define _PDCLIB_EACCES 10
389 #define _PDCLIB_EDEADLK 11
390 #define _PDCLIB_EISDIR 12
391 #define _PDCLIB_ENOEXEC 13
392 #define _PDCLIB_ENOTSOCK 14
393 #define _PDCLIB_ESPIPE 15
394 #define _PDCLIB_EADDRINUSE 16
395 #define _PDCLIB_EDESTADDRREQ 17
396 #define _PDCLIB_ELOOP 18
397 #define _PDCLIB_ENOLCK 19
398 #define _PDCLIB_ENOTSUPP 20
399 #define _PDCLIB_ESRCH 21
400 #define _PDCLIB_EADDRNOTAVAIL 22
401 #define _PDCLIB_EMFILE 23
402 #define _PDCLIB_ENOLINK 24
403 #define _PDCLIB_ENOTTY 25
404 #define _PDCLIB_ETIME 26
405 #define _PDCLIB_EAFNOSUPPORT 27
406 #define _PDCLIB_EEXIST 28
407 #define _PDCLIB_EMLINK 29
408 #define _PDCLIB_ENOMEM 30
409 #define _PDCLIB_ENXIO 31
410 #define _PDCLIB_ETIMEDOUT 32
411 #define _PDCLIB_EAGAIN 33
412 #define _PDCLIB_EFAULT 34
413 #define _PDCLIB_EMSGSIZE 35
414 #define _PDCLIB_ENOMSG 36
415 #define _PDCLIB_EOPNOTSUPP 37
416 #define _PDCLIB_ETXTBSY 38
417 #define _PDCLIB_EALREADY 39
418 #define _PDCLIB_EFBIG 40
419 #define _PDCLIB_ENAMETOOLONG 41
420 #define _PDCLIB_ENOPROTOOPT 42
421 #define _PDCLIB_EOVERFLOW 43
422 #define _PDCLIB_EWOULDBLOCK _PDCLIB_EAGAIN
423 #define _PDCLIB_EBADF 44
424 #define _PDCLIB_EHOSTUNREACH 45
425 #define _PDCLIB_ENETDOWN 46
426 #define _PDCLIB_ENOSPC 47
427 #define _PDCLIB_EOWNERDEAD 48
428 #define _PDCLIB_EXDEV 49
429 #define _PDCLIB_EBADMSG 50
430 #define _PDCLIB_EIDRM 51
431 #define _PDCLIB_ENETRESET 52
432 #define _PDCLIB_ENOSR 53
433 #define _PDCLIB_EPERM 54
434 #define _PDCLIB_EBUSY 55
435 #define _PDCLIB_ENETUNREACH 56
436 #define _PDCLIB_ENOSTR 57
437 #define _PDCLIB_EPIPE 58
438 #define _PDCLIB_ECANCELED 59
439 #define _PDCLIB_EINPROGRESS 60
440 #define _PDCLIB_ENFILE 61
441 #define _PDCLIB_ENOSYS 62
442 #define _PDCLIB_EPROTO 63
443 #define _PDCLIB_ECHILD 64
444 #define _PDCLIB_EINTR 65
445 #define _PDCLIB_ENOBUFS 66
446 #define _PDCLIB_ENOTCONN 67
447 #define _PDCLIB_EPROTONOSUPPORT 68
448 #define _PDCLIB_ECONNABORTED 69
449 #define _PDCLIB_EINVAL 70
450 #define _PDCLIB_ENODATA 71
451 #define _PDCLIB_ENOTDIR 72
452 #define _PDCLIB_EPROTOTYPE 73
453
454 #endif