diff options
Diffstat (limited to 'src/platform')
| -rw-r--r-- | src/platform/platform.h | 125 | ||||
| -rw-r--r-- | src/platform/posix/posix_alloc.h | 45 | ||||
| -rw-r--r-- | src/platform/posix/posix_debug.h | 48 | ||||
| -rw-r--r-- | src/platform/posix/posix_impl.h | 41 | ||||
| -rw-r--r-- | src/platform/posix/posix_synch.h | 143 | ||||
| -rw-r--r-- | src/platform/posix/posix_vsnprintf.h | 30 |
6 files changed, 432 insertions, 0 deletions
diff --git a/src/platform/platform.h b/src/platform/platform.h new file mode 100644 index 00000000..05f55be9 --- /dev/null +++ b/src/platform/platform.h @@ -0,0 +1,125 @@ +/* + * Copyright 2016 Garrett D'Amore <garrett@damore.org> + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), + * to deal in the Software without restriction, including without limitation + * the rights to use, copy, modify, merge, publish, distribute, sublicense, + * and/or sell copies of the Software, and to permit persons to whom + * the Software is furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + * IN THE SOFTWARE. + */ + +#ifndef PLATFORM_H +#define PLATFORM_H + +#include <stdlib.h> +#include <stdint.h> +#include <stdarg.h> + +/* + * These are the APIs that a platform must implement to support nng. + */ + +/* + * nni_abort crashes the system; it should do whatever is appropriate + * for abnormal programs on the platform, such as calling abort(). + */ +void nni_abort(void); + +/* + * nni_vnsprintf is exactly like its POSIX counterpart. + * Some platforms (Windows!) need a special version of this. + */ +void nni_vsnprintf(char *, size_t, const char *, va_list); + +/* + * nni_debug_output is used to emit debug messages. Typically this is used + * during core debugging, or to emit panic messages. Message content will + * not contain newlines, but the output will add them. + */ +void nni_debug_out(const char *); + +/* + * nni_set_debug_output is used to redirect debug output; for example an + * application could replace the default output routine with one that sends + * it's output to syslog. If NULL is specified, then a default handler + * used instead. The handler should add any newlines to the output as + * required. The default handler writes to standard error. + */ +void nni_set_debug_out(void (*)(const char *)); + +/* + * nni_alloc allocates memory. In most cases this can just be malloc(). + * However, you may provide a different allocator, for example it is + * possible to use a slab allocator or somesuch. It is permissible for this + * to return NULL if memory cannot be allocated. + */ +void *nni_alloc(size_t); + +/* + * nni_free frees memory allocated with nni_alloc. It takes a size because + * some allocators do not track size, or can operate more efficiently if + * the size is provided with the free call. Examples of this are slab + * allocators like this found in Solaris/illumos (see libumem or kmem). + * This routine does nothing if supplied with a NULL pointer and zero size. + * Most implementations can just call free() here. + */ +void nni_free(void *, size_t); + +typedef struct nni_mutex *nni_mutex_t; +typedef struct nni_cond *nni_cond_t; + +/* + * Mutex handling. + */ +int nni_mutex_create(nni_mutex_t *); +void nni_mutex_destroy(nni_mutex_t); +void nni_mutex_enter(nni_mutex_t); +void nni_mutex_exit(nni_mutex_t); +int nni_mutex_tryenter(nni_mutex_t); +int nni_cond_create(nni_cond_t *, nni_mutex_t); +void nni_cond_destroy(nni_cond_t); + +/* + * nni_cond_broadcast wakes all waiters on the condition. This should be + * called with the lock held. + */ +int nni_cond_broadcast(nni_cond_t); + +/* + * nni_cond_signal wakes a signal waiter. + */ +int nni_cond_signal(nni_cond_t); + +/* + * nni_condwait waits for a wake up on the condition variable. The + * associated lock is atomically released and reacquired upon wake up. + * Callers can be spuriously woken. The return value is 0 on success, + * or an error code. (Most implementations should never return an error.) + * Most callers will ignore the return value. The associated lock must + * be held. + */ +int nni_cond_wait(nni_cond_t); + +/* + * nni_cond_timedwait waits for a wakeup on the condition variable, just + * as with nni_condwait, but it will also wake after the given number of + * milliseconds has passed. (This is a relative timed wait.) Early + * wakeups are permitted, and the caller must take care to double check any + * conditions. The return value is 0 on success, or an error code, which + * can be NNG_ETIMEDOUT. + */ +int nnp_cond_timedwait(nni_cond_t, int); + +#endif /* PLATFORM_H */ diff --git a/src/platform/posix/posix_alloc.h b/src/platform/posix/posix_alloc.h new file mode 100644 index 00000000..8451cc9c --- /dev/null +++ b/src/platform/posix/posix_alloc.h @@ -0,0 +1,45 @@ +/* + * Copyright 2016 Garrett D'Amore <garrett@damore.org> + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), + * to deal in the Software without restriction, including without limitation + * the rights to use, copy, modify, merge, publish, distribute, sublicense, + * and/or sell copies of the Software, and to permit persons to whom + * the Software is furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + * IN THE SOFTWARE. + */ + +/* + * This is more of a direct #include of a .c rather than .h file. + * But having it be a .h makes compiler rules work out properly. Do + * not include this more than once into your program, or you will + * get multiple symbols defined. + */ + +/* + * POSIX memory allocation. This is pretty much standard C. + */ + +void * +nni_alloc(size_t size) +{ + return (malloc(size)); +} + +void +nni_free(void *ptr, size_t size) +{ + NNI_ARG_UNUSED(size); + free(ptr); +} diff --git a/src/platform/posix/posix_debug.h b/src/platform/posix/posix_debug.h new file mode 100644 index 00000000..d25a6c11 --- /dev/null +++ b/src/platform/posix/posix_debug.h @@ -0,0 +1,48 @@ +/* + * Copyright 2016 Garrett D'Amore <garrett@damore.org> + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), + * to deal in the Software without restriction, including without limitation + * the rights to use, copy, modify, merge, publish, distribute, sublicense, + * and/or sell copies of the Software, and to permit persons to whom + * the Software is furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + * IN THE SOFTWARE. + */ + +#include <stdlib.h> +#include <stdio.h> + +void (*debug_out)(const char *line); + +void +nni_abort(void) +{ + abort(); +} + +void +nni_debug_out(const char *message) +{ + if (debug_out != NULL) { + debug_out(message); + } else { + (void) fprintf(stderr, "%s\n", message); + } +} + +void +nni_set_debug_out(void (*out)(const char *)) +{ + debug_out = out; +} diff --git a/src/platform/posix/posix_impl.h b/src/platform/posix/posix_impl.h new file mode 100644 index 00000000..291e3f2e --- /dev/null +++ b/src/platform/posix/posix_impl.h @@ -0,0 +1,41 @@ +/* + * Copyright 2016 Garrett D'Amore <garrett@damore.org> + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), + * to deal in the Software without restriction, including without limitation + * the rights to use, copy, modify, merge, publish, distribute, sublicense, + * and/or sell copies of the Software, and to permit persons to whom + * the Software is furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + * IN THE SOFTWARE. + */ + +/* + * This is more of a direct #include of a .c rather than .h file. + * But having it be a .h makes compiler rules work out properly. Do + * not include this more than once into your program, or you will + * get multiple symbols defined. + * + * The file itself pulls in POSIX implementations for platform specific + * functionality. + */ + +#ifdef PLATFORM_POSIX + +#include "platform/posix/posix_debug.h" +#include "platform/posix/posix_alloc.h" +#include "platform/posix/posix_synch.h" +/* #include "platform/posix/posix_thread.h" */ +#include "platform/posix/posix_vsnprintf.h" + +#endif diff --git a/src/platform/posix/posix_synch.h b/src/platform/posix/posix_synch.h new file mode 100644 index 00000000..4a3a152d --- /dev/null +++ b/src/platform/posix/posix_synch.h @@ -0,0 +1,143 @@ +/* + * Copyright 2016 Garrett D'Amore <garrett@damore.org> + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), + * to deal in the Software without restriction, including without limitation + * the rights to use, copy, modify, merge, publish, distribute, sublicense, + * and/or sell copies of the Software, and to permit persons to whom + * the Software is furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + * IN THE SOFTWARE. + */ + +/* + * This is more of a direct #include of a .c rather than .h file. + * But having it be a .h makes compiler rules work out properly. Do + * not include this more than once into your program, or you will + * get multiple symbols defined. + */ + +/* + * POSIX synchronization (mutexes and condition variables). + */ + +#include <pthread.h> + +struct nni_mutex { + pthread_mutex_t mx; +}; + +struct nni_cond { + pthread_cond_t cv; + pthread_mutex_t *mx; +}; + +int +nni_mutex_create(nni_mutex_t *mp) +{ + struct nni_mutex *m; + pthread_mutexattr_t attr; + int rv; + + if ((m = nni_alloc(sizeof (*m))) == NULL) { + return (NNG_ENOMEM); + } + + /* We ask for more error checking... */ + if (pthread_mutexattr_init(&attr) != 0) { + nni_free(m, sizeof (*m)); + return (NNG_ENOMEM); + } + + if (pthread_mutexattr_settype(&attr, PTHREAD_MUTEX_ERRORCHECK) != 0) { + nni_panic("pthread_mutexattr_settype failed"); + } + + rv = pthread_mutex_init(&m->mx, &attr); + + if (pthread_mutexattr_destroy(&attr) != 0) { + nni_panic("pthread_mutexattr_destroy failed"); + } + + if (rv != 0) { + nni_free(m, sizeof (*m)); + return (NNG_ENOMEM); + } + *mp = m; + return (0); +} + +void +nni_mutex_destroy(nni_mutex_t m) +{ + if (pthread_mutex_destroy(&m->mx) != 0) { + nni_panic("pthread_mutex_destroy failed"); + } + /* + * If destroy fails for some reason, we can't really do + * anything about it. This would actually represent a programming + * bug, and the right thing to do here would be to panic. + */ + nni_free(m, sizeof (*m)); +} + +void +nni_mutex_enter(nni_mutex_t m) +{ + if (pthread_mutex_lock(&m->mx) != 0) { + nni_panic("pthread_mutex_lock failed"); + } +} + +void +nni_mutex_exit(nni_mutex_t m) +{ + if (pthread_mutex_unlock(&m->mx) != 0) { + nni_panic("pthread_mutex_unlock failed"); + } +} + +int +nni_mutex_tryenter(nni_mutex_t m) +{ + if (pthread_mutex_trylock(&m->mx) != 0) { + return (NNG_EBUSY); + } + return (0); +} + +int +nni_cond_create(nni_cond_t *cvp, nni_mutex_t mx) +{ + struct nni_cond *c; + if ((c = nni_alloc(sizeof (*c))) == NULL) { + return (NNG_ENOMEM); + } + c->mx = &mx->mx; + if (pthread_cond_init(&c->cv, NULL) != 0) { + /* In theory could be EAGAIN, but handle like ENOMEM */ + nni_free(c, sizeof (*c)); + return (NNG_ENOMEM); + } + *cvp = c; + return (0); +} + +void +nni_cond_destroy(nni_cond_t c) +{ + if (pthread_cond_destroy(&c->cv) != 0) { + nni_panic("pthread_cond_destroy failed"); + } + nni_free(c, sizeof (*c)); +} diff --git a/src/platform/posix/posix_vsnprintf.h b/src/platform/posix/posix_vsnprintf.h new file mode 100644 index 00000000..8270d255 --- /dev/null +++ b/src/platform/posix/posix_vsnprintf.h @@ -0,0 +1,30 @@ +/* + * Copyright 2016 Garrett D'Amore <garrett@damore.org> + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), + * to deal in the Software without restriction, including without limitation + * the rights to use, copy, modify, merge, publish, distribute, sublicense, + * and/or sell copies of the Software, and to permit persons to whom + * the Software is furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included + * in all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL + * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + * IN THE SOFTWARE. + */ + +#include <stdarg.h> +#include <stdio.h> + +void +nni_vsnprintf(char *dst, size_t sz, const char *fmt, va_list va) +{ + (void) vsnprintf(dst, sz, fmt, va); +} |
