-/* $Id$ */
+#ifndef _PDCLIB_CONFIG_H
+#define _PDCLIB_CONFIG_H
/* Internal PDCLib configuration <_PDCLIB_config.h>
(Generic Template)
/* Misc */
/* -------------------------------------------------------------------------- */
-/* By default, PDCLib does some rather strict checking of function usage, */
-/* especially in <stdio.h>. Things that are undefined by the standard - for */
-/* example, mixing byte / wide operations or read / write operations without */
-/* resetting the stream beforehand - are caught and handled graciously. This */
-/* adds some complexity, and eats a couple of clock cycles. If you want to */
-/* disable these checks, define _PDCLIB_STRICT to zero. */
-#define _PDCLIB_STRICT 1
-
/* The character (sequence) your platform uses as newline. */
#define _PDCLIB_endl "\n"
/* specific platforms, e.g. by swapping int instead of char. */
#define _PDCLIB_memswp( i, j, size ) char tmp; do { tmp = *i; *i++ = *j; *j++ = tmp; } while ( --size );
-/* Define this to some compiler directive that can be written after the */
-/* parameter list of a function declaration to indicate the function does */
-/* never return. If your compiler does not support such a directive, define */
-/* to nothing. (This is to avoid warnings with the exit functions under GCC.) */
-#define _PDCLIB_NORETURN __attribute__(( noreturn ))
-
/* -------------------------------------------------------------------------- */
/* Integers */
/* -------------------------------------------------------------------------- */
/* first, before going to lengths about it. */
/* -------------------------------------------------------------------------- */
-/* Comment out (or delete) the line below if your 'char' type is unsigned. */
+/* Set to 0 if your 'char' type is unsigned. */
#define _PDCLIB_CHAR_SIGNED 1
/* Width of the integer types short, int, long, and long long, in bytes. */
/* compiler manuals. */
#define _PDCLIB_SHRT_BYTES 2
#define _PDCLIB_INT_BYTES 4
-#define _PDCLIB_LONG_BYTES 4
+#if defined(__LP64__) || defined(_LP64)
+# define _PDCLIB_LONG_BYTES 8
+#else
+# define _PDCLIB_LONG_BYTES 4
+#endif
#define _PDCLIB_LLONG_BYTES 8
/* <stdlib.h> defines the div() function family that allows taking quotient */
/* SHRT, INT, LONG, or LLONG (telling which values to use for the *_MIN and */
/* *_MAX limits); the lowercase define either short, int, long, or long long */
/* (telling the actual type to use). */
+/* The third define is the length modifier used for the type in printf() and */
+/* scanf() functions (used in <inttypes.h>). */
/* If you require a non-standard datatype to define the "usually fastest" */
/* types, PDCLib as-is doesn't support that. Please contact the author with */
/* details on your platform in that case, so support can be added. */
#define _PDCLIB_FAST8 INT
#define _PDCLIB_fast8 int
+#define _PDCLIB_FAST8_CONV
#define _PDCLIB_FAST16 INT
#define _PDCLIB_fast16 int
+#define _PDCLIB_FAST16_CONV
#define _PDCLIB_FAST32 INT
#define _PDCLIB_fast32 int
+#define _PDCLIB_FAST32_CONV
#define _PDCLIB_FAST64 LLONG
#define _PDCLIB_fast64 long long
+#define _PDCLIB_FAST64_CONV ll
/* -------------------------------------------------------------------------- */
/* What follows are a couple of "special" typedefs and their limits. Again, */
/* -------------------------------------------------------------------------- */
/* The result type of substracting two pointers */
-#define _PDCLIB_ptrdiff int
-#define _PDCLIB_PTRDIFF INT
+#define _PDCLIB_ptrdiff long
+#define _PDCLIB_PTRDIFF LONG
+#define _PDCLIB_PTR_CONV
/* An integer type that can be accessed as atomic entity (think asynchronous
interrupts). The type itself is not defined in a freestanding environment,
#define _PDCLIB_SIG_ATOMIC INT
/* Result type of the 'sizeof' operator (must be unsigned) */
-#define _PDCLIB_size unsigned int
-#define _PDCLIB_SIZE UINT
+#define _PDCLIB_size unsigned long
+#define _PDCLIB_SIZE ULONG
/* Large enough an integer to hold all character codes of the largest supported
locale.
*/
-#define _PDCLIB_wchar unsigned short
-#define _PDCLIB_WCHAR USHRT
+#define _PDCLIB_wint signed int
+#define _PDCLIB_wchar unsigned int
+#define _PDCLIB_WCHAR UINT
-#define _PDCLIB_intptr int
-#define _PDCLIB_INTPTR INT
+#define _PDCLIB_intptr long
+#define _PDCLIB_INTPTR LONG
/* Largest supported integer type. Implementation note: see _PDCLIB_atomax(). */
#define _PDCLIB_intmax long long int
-#define _PDCLIB_INTMAX LLINT
+#define _PDCLIB_INTMAX LLONG
+#define _PDCLIB_MAX_CONV ll
/* You are also required to state the literal suffix for the intmax type */
#define _PDCLIB_INTMAX_LITERAL ll
+/* <inttypes.h> defines imaxdiv(), which is equivalent to the div() function */
+/* family (see further above) with intmax_t as basis. */
+
+struct _PDCLIB_imaxdiv_t
+{
+ _PDCLIB_intmax quot;
+ _PDCLIB_intmax rem;
+};
+
+/* <time.h>: time_t
+ * The C standard doesn't define what representation of time is stored in
+ * time_t when returned by time() , but POSIX defines it to be seconds since the
+ * UNIX epoch and most appplications expect that.
+ *
+ * time_t is also used as the tv_sec member of struct timespec, which *is*
+ * defined as a linear count of seconds.
+ *
+ * time_t is defined as a "real type", so may be a floating point type, but with
+ * the presence of the nanosecond accurate struct timespec, and with the lack of
+ * any functions for manipulating more accurate values of time_t, this is
+ * probably not useful.
+ */
+#define _PDCLIB_time unsigned long long
+
+/* <time.h>: clock_t
+ *
+ * A count of "clock ticks", where the length of a clock tick is unspecified by
+ * the standard. The implementation is required to provide a macro,
+ * CLOCKS_PER_SEC, which is the number of "clock ticks" which corresponds to one
+ * second.
+ *
+ * clock_t may be any real type (i.e. integral or floating), and its type on
+ * various systems differs.
+ *
+ * On XSI systems, CLOCKS_PER_SEC must be defined to 1000000
+ */
+#define _PDCLIB_clock double
+#define _PDCLIB_CLOCKS_PER_SEC 1000000
+
+/* <time.h>: TIME_UTC
+ *
+ * The TIME_UTC parameter is passed to the timespec_get function in order to get
+ * the system time in UTC since an implementation defined epoch (not necessarily
+ * the same as that used for time_t). That said, on POSIX the obvious
+ * implementation of timespec_get for TIME_UTC is to wrap
+ * clock_gettime(CLOCK_REALTIME, ...), which is defined as time in UTC since the
+ * same epoch.
+ *
+ * This may be any non-zero integer value.
+ */
+#define _PDCLIB_TIME_UTC 1
+
/* -------------------------------------------------------------------------- */
/* Floating Point */
/* -------------------------------------------------------------------------- */
*/
#define _PDCLIB_DECIMAL_DIG 17
+/* Floating point types
+ *
+ * PDCLib (at present) assumes IEEE 754 floating point formats
+ * The following names are used:
+ * SINGLE: IEEE 754 single precision (32-bit)
+ * DOUBLE: IEEE 754 double precision (64-bit)
+ * EXTENDED: IEEE 754 extended precision (80-bit, as x87)
+ */
+#define _PDCLIB_FLOAT_TYPE SINGLE
+#define _PDCLIB_DOUBLE_TYPE DOUBLE
+#if defined(__i386__) || defined(__amd64__)
+ #define _PDCLIB_LDOUBLE_TYPE EXTENDED
+#else
+ #define _PDCLIB_LDOUBLE_TYPE DOUBLE
+#endif
+
/* -------------------------------------------------------------------------- */
/* Platform-dependent macros defined by the standard headers. */
/* -------------------------------------------------------------------------- */
to an appropriate value. (Too small, and malloc() will call the kernel too
often. Too large, and you will waste memory.)
*/
-#define _PDCLIB_PAGESIZE 4096
+#define _PDCLIB_MALLOC_PAGESIZE 4096
+#define _PDCLIB_MALLOC_ALIGN 16
+#define _PDCLIB_MALLOC_GRANULARITY 64*1024
+#define _PDCLIB_MALLOC_TRIM_THRESHOLD 2*1024*1024
+#define _PDCLIB_MALLOC_MMAP_THRESHOLD 256*1024
+#define _PDCLIB_MALLOC_RELEASE_CHECK_RATE 4095
-/* Set this to the minimum memory node size. Any malloc() for a smaller size
- will be satisfied by a malloc() of this size instead (to avoid excessive
- fragmentation).
-*/
-#define _PDCLIB_MINALLOC 8
+/* TODO: Better document these */
-/* I/O ---------------------------------------------------------------------- */
+/* Locale --------------------------------------------------------------------*/
-/* The type of the file descriptor returned by _PDCLIB_open(). */
-typedef int _PDCLIB_fd_t;
+/* Locale method. See _PDCLIB_locale.h */
+/* #define _PDCLIB_LOCALE_METHOD _PDCLIB_LOCALE_METHOD_TSS */
-/* The value (of type _PDCLIB_fd_t) returned by _PDCLIB_open() if the operation
- failed.
-*/
-#define _PDCLIB_NOHANDLE ( (_PDCLIB_fd_t) -1 )
+/* wchar_t encoding */
+#define _PDCLIB_WCHAR_ENCODING _PDCLIB_WCHAR_ENCODING_UCS4
-/* A type in which to store file offsets. See fgetpos() / fsetpos(). */
-/* FIXME: The 'int' types here are placeholders. When changed, check out
- stdinit.c, too. */
-typedef struct
-{
- int position;
- int mbstate;
-} _PDCLIB_fpos_t;
+/* I/O ---------------------------------------------------------------------- */
/* The default size for file buffers. Must be at least 256. */
#define _PDCLIB_BUFSIZ 1024
/* The minimum number of files the implementation can open simultaneously. Must
be at least 8. Depends largely on how the bookkeeping is done by fopen() /
- freopen() / fclose().
+ freopen() / fclose(). The example implementation limits the number of open
+ files only by available memory.
*/
#define _PDCLIB_FOPEN_MAX 8
/* Length of the longest filename the implementation guarantees to support. */
#define _PDCLIB_FILENAME_MAX 128
-/* Buffer size for tmpnam(). */
-#define _PDCLIB_L_tmpnam 100
+/* Maximum length of filenames generated by tmpnam(). (See tmpfile.c.) */
+#define _PDCLIB_L_tmpnam 46
/* Number of distinct file names that can be generated by tmpnam(). */
#define _PDCLIB_TMP_MAX 50
-/* The number of times fflush() tries to write a file buffer before giving up
- if no characters can be written.
+/* The values of SEEK_SET, SEEK_CUR and SEEK_END, used by fseek().
+ Since at least one platform (POSIX) uses the same symbols for its own "seek"
+ function, we use whatever the host defines (if it does define them).
+*/
+#define _PDCLIB_SEEK_SET 0
+#define _PDCLIB_SEEK_CUR 1
+#define _PDCLIB_SEEK_END 2
+
+/* The number of characters that can be buffered with ungetc(). The standard
+ guarantees only one (1); anything larger would make applications relying on
+ this capability dependent on implementation-defined behaviour (not good).
*/
-#define _PDCLIB_FLUSH_RETRIES 3
-/* This macro is executed after each try to write characters that results in
- no characters being written. You can define this to be empty, wait a short
- period of time, or whatever suits your environment.
+#define _PDCLIB_UNGETCBUFSIZE 1
+
+/* errno -------------------------------------------------------------------- */
+
+/* These are the values that _PDCLIB_errno can be set to by the library.
+
+ By keeping PDCLib's errno in the _PDCLIB_* namespace, the library is capable
+ to "translate" between errno values used by the hosting operating system and
+ those used and passed out by the library.
+
+ Example: In the example platform, the remove() function uses the unlink()
+ system call as backend. Linux sets its errno to EISDIR if you try to unlink()
+ a directory, but POSIX demands EPERM. Within the remove() function, you can
+ catch the 'errno == EISDIR', and set '_PDCLIB_errno = _PDCLIB_EPERM'. Anyone
+ using PDCLib's <errno.h> will "see" EPERM instead of EISDIR (the _PDCLIB_*
+ prefix removed by <errno.h> mechanics).
+
+ If you do not want that kind of translation, you might want to "match" the
+ values used by PDCLib with those used by the host OS, to avoid confusion.
+
+ The C standard only defines three distinct errno values: ERANGE, EDOM, and
+ EILSEQ. The standard leaves it up to "the implementation" whether there are
+ any more beyond those three.
+
+ However, C++11 introduced the whole list of POSIX errno values into the
+ standard, so PDCLib might as well define those as well.
+
+ Sometimes the standard says to set errno to indicate an error, but does not
+ prescribe a value. We will use a value from the following list. If POSIX
+ defines a value, we use that; otherwise, we use as seems suitable.
*/
-#define _PDCLIB_FLUSH_RETRY_PREP
+/* These values were taken from Linux, gcc 4.8. */
+#define _PDCLIB_E2BIG 7
+#define _PDCLIB_EACCES 13
+#define _PDCLIB_EADDRINUSE 98
+#define _PDCLIB_EADDRNOTAVAIL 99
+#define _PDCLIB_EAFNOSUPPORT 97
+#define _PDCLIB_EAGAIN 11
+#define _PDCLIB_EALREADY 114
+#define _PDCLIB_EBADF 9
+#define _PDCLIB_EBADMSG 74
+#define _PDCLIB_EBUSY 16
+#define _PDCLIB_ECANCELED 125
+#define _PDCLIB_ECHILD 10
+#define _PDCLIB_ECONNABORTED 103
+#define _PDCLIB_ECONNREFUSED 111
+#define _PDCLIB_ECONNRESET 104
+#define _PDCLIB_EDEADLK 35
+#define _PDCLIB_EDESTADDRREQ 89
+#define _PDCLIB_EDOM 33
+#define _PDCLIB_EEXIST 17
+#define _PDCLIB_EFAULT 14
+#define _PDCLIB_EFBIG 27
+#define _PDCLIB_EHOSTUNREACH 113
+#define _PDCLIB_EIDRM 43
+#define _PDCLIB_EILSEQ 84
+#define _PDCLIB_EINPROGRESS 115
+#define _PDCLIB_EINTR 4
+#define _PDCLIB_EINVAL 22
+#define _PDCLIB_EIO 5
+#define _PDCLIB_EISCONN 106
+#define _PDCLIB_EISDIR 21
+#define _PDCLIB_ELOOP 40
+#define _PDCLIB_EMFILE 24
+#define _PDCLIB_EMLINK 31
+#define _PDCLIB_EMSGSIZE 90
+#define _PDCLIB_ENAMETOOLONG 36
+#define _PDCLIB_ENETDOWN 100
+#define _PDCLIB_ENETRESET 102
+#define _PDCLIB_ENETUNREACH 101
+#define _PDCLIB_ENFILE 23
+#define _PDCLIB_ENOBUFS 105
+#define _PDCLIB_ENODATA 61
+#define _PDCLIB_ENODEV 19
+#define _PDCLIB_ENOENT 2
+#define _PDCLIB_ENOEXEC 8
+#define _PDCLIB_ENOLCK 37
+#define _PDCLIB_ENOLINK 67
+#define _PDCLIB_ENOMEM 12
+#define _PDCLIB_ENOMSG 42
+#define _PDCLIB_ENOPROTOOPT 92
+#define _PDCLIB_ENOSPC 28
+#define _PDCLIB_ENOSR 63
+#define _PDCLIB_ENOSTR 60
+#define _PDCLIB_ENOSYS 38
+#define _PDCLIB_ENOTCONN 107
+#define _PDCLIB_ENOTDIR 20
+#define _PDCLIB_ENOTEMPTY 39
+#define _PDCLIB_ENOTRECOVERABLE 131
+#define _PDCLIB_ENOTSOCK 88
+#define _PDCLIB_ENOTSUP 95
+#define _PDCLIB_ENOTTY 25
+#define _PDCLIB_ENXIO 6
+#define _PDCLIB_EOPNOTSUPP 95
+#define _PDCLIB_EOVERFLOW 75
+#define _PDCLIB_EOWNERDEAD 130
+#define _PDCLIB_EPERM 1
+#define _PDCLIB_EPIPE 32
+#define _PDCLIB_EPROTO 71
+#define _PDCLIB_EPROTONOSUPPORT 93
+#define _PDCLIB_EPROTOTYPE 91
+#define _PDCLIB_ERANGE 34
+#define _PDCLIB_EROFS 30
+#define _PDCLIB_ESPIPE 29
+#define _PDCLIB_ESRCH 3
+#define _PDCLIB_ETIME 62
+#define _PDCLIB_ETIMEDOUT 110
+#define _PDCLIB_ETXTBSY 26
+#define _PDCLIB_EWOULDBLOCK 11
+#define _PDCLIB_EXDEV 18
+
+/* This is used to set the size of the array in struct lconv (<locale.h>) */
+/* holding the error messages for the strerror() and perror() fuctions. If */
+/* you change this value because you are using additional errno values, you */
+/* *HAVE* to provide appropriate error messages for *ALL* locales. */
+/* Needs to be one higher than the highest errno value above. */
+#define _PDCLIB_ERRNO_MAX 132
+
+#endif
projects / pdclib / blobdiff