X-Git-Url: https://pd.if.org/git/?p=pdclib;a=blobdiff_plain;f=platform%2Fexample%2Finternals%2F_PDCLIB_config.h;h=0f0c21c7e5fc5ea02dacbb43a3a74ebc5a6c7cb0;hp=41fe02cb3f62711e2ee40b482ef3adc66f3137f7;hb=01c88bc38e78e9b2c47917b85b9b497187946e3c;hpb=3f6094115e79a45413f08361b68b71eb08da306e diff --git a/platform/example/internals/_PDCLIB_config.h b/platform/example/internals/_PDCLIB_config.h index 41fe02c..0f0c21c 100644 --- a/platform/example/internals/_PDCLIB_config.h +++ b/platform/example/internals/_PDCLIB_config.h @@ -1,7 +1,5 @@ /* $Id$ */ -/* Release $Name$ */ - /* Internal PDCLib configuration <_PDCLIB_config.h> (Generic Template) @@ -28,6 +26,12 @@ /* 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 */ /* -------------------------------------------------------------------------- */ @@ -88,6 +92,8 @@ struct _PDCLIB_lldiv_t /* 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 ). */ /* 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. */ @@ -95,15 +101,19 @@ struct _PDCLIB_lldiv_t #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, */ @@ -114,11 +124,13 @@ struct _PDCLIB_lldiv_t /* The result type of substracting two pointers */ #define _PDCLIB_ptrdiff int #define _PDCLIB_PTRDIFF INT +#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, but its limits are. (Don't ask.) */ +#define _PDCLIB_sig_atomic int #define _PDCLIB_SIG_ATOMIC INT /* Result type of the 'sizeof' operator (must be unsigned) */ @@ -136,10 +148,20 @@ struct _PDCLIB_lldiv_t /* 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 +/* 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; +}; + /* -------------------------------------------------------------------------- */ /* Floating Point */ /* -------------------------------------------------------------------------- */ @@ -201,31 +223,101 @@ typedef char * _PDCLIB_va_list; #define _PDCLIB_va_start( ap, parmN ) ( (ap) = (char *) &parmN + ( _PDCLIB_va_round(parmN) ), (void)0 ) /* -------------------------------------------------------------------------- */ -/* OS "glue" */ -/* This is where PDCLib interfaces with the operating system. The examples */ -/* below are POSIX calls; provide your OS' equivalents. */ +/* OS "glue", part 1 */ +/* These are values and data type definitions that you would have to adapt to */ +/* the capabilities and requirements of your OS. */ +/* The actual *functions* of the OS interface are declared in _PDCLIB_glue.h. */ /* -------------------------------------------------------------------------- */ -/* A system call that terminates the calling process */ -void _exit( int status ) __attribute__(( noreturn )); -#define _PDCLIB_Exit( x ) _exit( x ) - -/* Memory management */ +/* Memory management -------------------------------------------------------- */ /* Set this to the page size of your OS. If your OS does not support paging, set to an appropriate value. (Too small, and malloc() will call the kernel too - often. Too large, and you will waste memory. + often. Too large, and you will waste memory.) */ #define _PDCLIB_PAGESIZE 4096 -/* Set this to the minimum memory node size. Any malloc() for a smaller siz - will be satisfied by a malloc() of this size instead. +/* 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 -/* Request another x pages (of size _PDCLIB_PAGESIZE) of memory from the kernel, - or release them back to the kernel if n is negative. - Return a (void *) pointing to the former end-of-heap if successful, NULL - otherwise. +/* I/O ---------------------------------------------------------------------- */ + +/* The type of the file descriptor returned by _PDCLIB_open(). */ +typedef int _PDCLIB_fd_t; + +/* The value (of type _PDCLIB_fd_t) returned by _PDCLIB_open() if the operation + failed. */ -void * _PDCLIB_allocpages( int n ); +#define _PDCLIB_NOHANDLE ( (_PDCLIB_fd_t) -1 ) + +/* 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(). 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 + +/* 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 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_UNGETCBUFSIZE 1 + +/* Signals ------------------------------------------------------------------ */ + +/* A word on signals, to the people using PDCLib in their OS projects. + + The way they are defined by the C standard severely limits their usefulness, + to the point where a library implementation need not interface with the OS' + signals at all (which is what the PDCLib example implementation does). + (Other issues include, for example, that signal handlers are not re-entrant.) + + Thus, it is strongly discouraged to try bolting on a signal handling infra- + structure onto . Since C's signal handling is so limited to begin + with, and code using it is pretty much non-portable anyway, it would be + smarter to keep in the barely functional state it is in, and + instead create a better, OS-specific API. + + That being said, the below signals require to be defined to a positive int + value. I took what my Linux box defined them to; if you have to change them, + and what value to change them *to*, depends heavily on your environment and + what you are expecting to accomplish (see above). +*/ +#define _PDCLIB_SIGABRT 6 +#define _PDCLIB_SIGFPE 8 +#define _PDCLIB_SIGILL 4 +#define _PDCLIB_SIGINT 2 +#define _PDCLIB_SIGSEGV 11 +#define _PDCLIB_SIGTERM 15 + +/* The following should be defined to pointer values that could NEVER point to + a valid function. (They are used as special arguments to signal().) Again, I + took the values of my Linux box, which should be as good as any other value. +*/ +#define _PDCLIB_SIG_DFL (void (*)( int ))0 +#define _PDCLIB_SIG_ERR (void (*)( int ))-1 +#define _PDCLIB_SIG_IGN (void (*)( int ))1 +