diff options
Diffstat (limited to 'src')
| -rw-r--r-- | src/CMakeLists.txt | 11 | ||||
| -rw-r--r-- | src/core/platform.h | 8 | ||||
| -rw-r--r-- | src/nng.c | 2 | ||||
| -rw-r--r-- | src/nng.h | 18 | ||||
| -rw-r--r-- | src/supplemental/util/CMakeLists.txt | 15 | ||||
| -rw-r--r-- | src/supplemental/util/platform.c | 166 | ||||
| -rw-r--r-- | src/supplemental/util/platform.h | 106 |
7 files changed, 301 insertions, 25 deletions
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 48262751..b245d6ae 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -1,8 +1,9 @@ # -# Copyright (c) 2012-2013 Martin Sustrik All rights reserved. -# Copyright (c) 2013 GoPivotal, Inc. All rights reserved. -# Copyright (c) 2015-2016 Jack R. Dunaway. All rights reserved. -# Copyright 2017 Garrett D'Amore <garrett@damore.org> +# Copyright 2018 Capitar IT Group BV <info@capitar.com> +# Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> +# Copyright (c) 2012-2013 Martin Sustrik All rights reserved. +# Copyright (c) 2013 GoPivotal, Inc. All rights reserved. +# Copyright (c) 2015-2016 Jack R. Dunaway. All rights reserved. # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), @@ -129,6 +130,7 @@ add_subdirectory(supplemental/base64) add_subdirectory(supplemental/http) add_subdirectory(supplemental/sha1) add_subdirectory(supplemental/tls) +add_subdirectory(supplemental/util) add_subdirectory(supplemental/websocket) add_subdirectory(protocol/bus0) @@ -152,6 +154,7 @@ include_directories(AFTER SYSTEM ${PROJECT_SOURCE_DIR}/src add_definitions(${NNG_DEFINES}) # Provide same folder structure in IDE as on disk +# XXX: Consider replacing this with source_group(TREE...) foreach (f ${NNG_SOURCES}) # Get the path of the file relative to source directory if (IS_ABSOLUTE "${f}") diff --git a/src/core/platform.h b/src/core/platform.h index 73b6785b..cf635f4a 100644 --- a/src/core/platform.h +++ b/src/core/platform.h @@ -145,12 +145,12 @@ extern void nni_plat_thr_fini(nni_plat_thr *); // Clock Support // -// nn_plat_clock returns a number of microseconds since some arbitrary time +// nn_plat_clock returns a number of milliseconds since some arbitrary time // in the past. The values returned by nni_clock must use the same base // as the times used in nni_plat_cond_waituntil. The nni_plat_clock() must -// returnvalues > 0, and must return values smaller than 2^63. (We could relax -// this last constraint, but there is no reason to, and leaves us the option -// of using negative values for other purposes in the future.) +// return values > 0, and must return values smaller than 2^63. (We could +// relax this last constraint, but there is no reason to, and leaves us the +// option of using negative values for other purposes in the future.) extern nni_time nni_plat_clock(void); // nni_plat_sleep sleeps for the specified number of milliseconds (at least). @@ -1194,6 +1194,7 @@ nng_stat_value(nng_stat *stat) } #endif +#if 0 // These routines exist as utility functions, exposing some of our // "guts" to the external world for the purposes of test code and // bundled utilities. They should not be considered part of our public @@ -1237,6 +1238,7 @@ nng_thread_destroy(void *arg) NNI_FREE_STRUCT(thr); } +#endif int nng_url_parse(nng_url **result, const char *ustr) @@ -536,22 +536,6 @@ NNG_DECL int64_t nng_stat_value(nng_stat *); // which means that messages from one side are forwarded to the other. NNG_DECL int nng_device(nng_socket, nng_socket); -// The following functions are not intrinsic to nanomsg, and so do not -// represent our public API. Avoid their use in other applications. - -#ifdef NNG_PRIVATE - -// Sleep for specified msecs. -NNG_DECL void nng_msleep(nng_duration); - -// Create and start a thread. -NNG_DECL int nng_thread_create(void **, void (*)(void *), void *); - -// Destroy a thread (waiting for it to complete.) -NNG_DECL void nng_thread_destroy(void *); - -#endif // NNG_PRIVATE - // Symbol name and visibility. TBD. The only symbols that really should // be directly exported to runtimes IMO are the option symbols. And frankly // they have enough special logic around them that it might be best not to @@ -985,7 +969,7 @@ NNG_DECL int nng_http_res_set_data(nng_http_res *, const void *, size_t); // probably set the content-type header. NNG_DECL int nng_http_res_copy_data(nng_http_res *, const void *, size_t); -// An nng_http_conn represents an underlyinjg "connection". It may be +// An nng_http_conn represents an underlying "connection". It may be // a TCP channel, or a TLS channel, but the main thing is that this is // normally only used for exchanging HTTP requests and responses. typedef struct nng_http_conn nng_http_conn; diff --git a/src/supplemental/util/CMakeLists.txt b/src/supplemental/util/CMakeLists.txt new file mode 100644 index 00000000..07dba939 --- /dev/null +++ b/src/supplemental/util/CMakeLists.txt @@ -0,0 +1,15 @@ +# +# Copyright 2018 Capitar IT Group BV <info@capitar.com> +# Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> +# +# This software is supplied under the terms of the MIT License, a +# copy of which should be located in the distribution where this +# file was obtained (LICENSE.txt). A copy of the license may also be +# found online at https://opensource.org/licenses/MIT. +# + +set(SUPP_PLATFORM_SOURCES + supplemental/util/platform.c) + +install(FILES platform.h DESTINATION include/nng/supplemental/util) +set(NNG_SOURCES ${NNG_SOURCES} ${SUPP_PLATFORM_SOURCES} PARENT_SCOPE) diff --git a/src/supplemental/util/platform.c b/src/supplemental/util/platform.c new file mode 100644 index 00000000..ce52491a --- /dev/null +++ b/src/supplemental/util/platform.c @@ -0,0 +1,166 @@ +// +// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2018 Capitar IT Group BV <info@capitar.com> +// +// This software is supplied under the terms of the MIT License, a +// copy of which should be located in the distribution where this +// file was obtained (LICENSE.txt). A copy of the license may also be +// found online at https://opensource.org/licenses/MIT. +// + +#include <stdlib.h> +#include <string.h> + +#include "core/nng_impl.h" +#include "supplemental/util/platform.h" + +nng_time +nng_clock(void) +{ + (void) nni_init(); + return (nni_plat_clock()); +} + +// Sleep for specified msecs. +void +nng_msleep(nng_duration dur) +{ + (void) nni_init(); + nni_msleep(dur); +} + +// nng_thread is a handle to a "thread", which may be a real system +// thread, or a coroutine on some platforms. +typedef struct nng_thread nng_thread; + +// Create and start a thread. Note that on some platforms, this might +// actually be a coroutine, with limitations about what system APIs +// you can call. Therefore, these threads should only be used with the +// I/O APIs provided by nng. The thread runs until completion. +int +nng_thread_create(nng_thread **thrp, void (*func)(void *), void *arg) +{ + nni_thr *thr; + int rv; + + (void) nni_init(); + + if ((thr = NNI_ALLOC_STRUCT(thr)) == NULL) { + return (NNG_ENOMEM); + } + memset(thr, 0, sizeof(*thr)); + *thrp = (void *) thr; + if ((rv = nni_thr_init(thr, func, arg)) != 0) { + return (rv); + } + nni_thr_run(thr); + return (0); +} + +// Destroy a thread (waiting for it to complete.) When this function +// returns all resources for the thread are cleaned up. +void +nng_thread_destroy(nng_thread *thrp) +{ + nni_thr *t = (void *) thrp; + nni_thr_fini(t); + NNI_FREE_STRUCT(t); +} + +struct nng_mtx { + nni_mtx m; +}; + +int +nng_mtx_alloc(nng_mtx **mpp) +{ + nng_mtx *mp; + + (void) nni_init(); + + if ((mp = NNI_ALLOC_STRUCT(mp)) == NULL) { + return (NNG_ENOMEM); + } + nni_mtx_init(&mp->m); + *mpp = mp; + return (0); +} + +void +nng_mtx_free(nng_mtx *mp) +{ + if (mp != NULL) { + nni_mtx_fini(&mp->m); + NNI_FREE_STRUCT(mp); + } +} + +void +nng_mtx_lock(nng_mtx *mp) +{ + nni_mtx_lock(&mp->m); +} + +void +nng_mtx_unlock(nng_mtx *mp) +{ + nni_mtx_unlock(&mp->m); +} + +struct nng_cv { + nni_cv c; +}; + +typedef struct nng_cv nng_cv; + +int +nng_cv_alloc(nng_cv **cvp, nng_mtx *mx) +{ + nng_cv *cv; + + if ((cv = NNI_ALLOC_STRUCT(cv)) == NULL) { + return (NNG_ENOMEM); + } + nni_cv_init(&cv->c, &mx->m); + *cvp = cv; + return (0); +} + +void +nng_cv_free(nng_cv *cv) +{ + if (cv != NULL) { + nni_cv_fini(&cv->c); + NNI_FREE_STRUCT(cv); + } +} + +void +nng_cv_wait(nng_cv *cv) +{ + nni_cv_wait(&cv->c); +} + +int +nng_cv_until(nng_cv *cv, nng_time when) +{ + return (nni_cv_until(&cv->c, (nni_time) when)); +} + +void +nng_cv_wake(nng_cv *cv) +{ + nni_cv_wake(&cv->c); +} + +void +nng_cv_wake1(nng_cv *cv) +{ + nni_cv_wake1(&cv->c); +} + +uint32_t +nng_random(void) +{ + return (nni_random()); +} diff --git a/src/supplemental/util/platform.h b/src/supplemental/util/platform.h new file mode 100644 index 00000000..1383fe15 --- /dev/null +++ b/src/supplemental/util/platform.h @@ -0,0 +1,106 @@ +// +// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2018 Capitar IT Group BV <info@capitar.com> +// +// This software is supplied under the terms of the MIT License, a +// copy of which should be located in the distribution where this +// file was obtained (LICENSE.txt). A copy of the license may also be +// found online at https://opensource.org/licenses/MIT. +// + +#ifndef NNG_SUPPLEMENTAL_UTIL_PLATFORM_H +#define NNG_SUPPLEMENTAL_UTIL_PLATFORM_H + +// The declarations in this file are provided to assist with application +// portability. Conceptually these APIs are based on work we have already +// done for NNG internals, and we find that they are useful in building +// portable applications. + +// If it is more natural to use native system APIs like pthreads or C11 +// APIs or Windows APIs, then by all means please feel free to simply +// ignore this. + +#ifdef __cplusplus +extern "C" { +#endif + +#include <stddef.h> +#include <stdint.h> + +// nng_time represents an absolute time since some arbitrary point in the +// past, measured in milliseconds. The values are always positive. +typedef uint64_t nng_time; + +// Return an absolute time from some arbitrary point. The value is +// provided in milliseconds, and is of limited resolution based on the +// system clock. (Do not use it for fine grained performance measurements.) +NNG_DECL uint64_t nng_clock(void); + +// Sleep for specified msecs. +NNG_DECL void nng_msleep(nng_duration); + +// nng_thread is a handle to a "thread", which may be a real system +// thread, or a coroutine on some platforms. +typedef struct nng_thread nng_thread; + +// Create and start a thread. Note that on some platforms, this might +// actually be a coroutine, with limitations about what system APIs +// you can call. Therefore, these threads should only be used with the +// I/O APIs provided by nng. The thread runs until completion. +NNG_DECL int nng_thread_create(nng_thread **, void (*)(void *), void *); + +// Destroy a thread (waiting for it to complete.) When this function +// returns all resources for the thread are cleaned up. +NNG_DECL void nng_thread_destroy(nng_thread *); + +// nng_mtx represents a mutex, which is a simple, non-retrant, boolean lock. +typedef struct nng_mtx nng_mtx; + +// nng_mtx_alloc allocates a mutex structure. +NNG_DECL int nng_mtx_alloc(nng_mtx **); + +// nng_mtx_free frees the mutex. It most not be locked. +NNG_DECL void nng_mtx_free(nng_mtx *); + +// nng_mtx_lock locks the mutex; if it is already locked it will block +// until it can be locked. If the caller already holds the lock, the +// results are undefined (a panic may occur). +NNG_DECL void nng_mtx_lock(nng_mtx *); + +// nng_mtx_unlock unlocks a previously locked mutex. It is an error to +// call this on a mutex which is not owned by caller. +NNG_DECL void nng_mtx_unlock(nng_mtx *); + +// nng_cv is a condition variable. It is always allocated with an +// associated mutex, which must be held when waiting for it, or +// when signaling it. +typedef struct nng_cv nng_cv; + +NNG_DECL int nng_cv_alloc(nng_cv **, nng_mtx *); + +// nng_cv_free frees the condition variable. +NNG_DECL void nng_cv_free(nng_cv *); + +// nng_cv_wait waits until the condition variable is "signaled". +NNG_DECL void nng_cv_wait(nng_cv *); + +// nng_cv_until waits until either the condition is signaled, or +// the timeout expires. It returns NNG_ETIMEDOUT in that case. +NNG_DECL int nng_cv_until(nng_cv *, nng_time); + +// nng_cv_wake wakes all threads waiting on the condition. +NNG_DECL void nng_cv_wake(nng_cv *); + +// nng_cv_wake1 wakes only one thread waiting on the condition. This may +// reduce the thundering herd problem, but care must be taken to ensure +// that no waiter starves forvever. +NNG_DECL void nng_cv_wake1(nng_cv *); + +// nng_random returns a "strong" (cryptographic sense) random number. +NNG_DECL uint32_t nng_random(void); + +#ifdef __cplusplus +} +#endif + +#endif // NNG_SUPPLEMENTAL_UTIL_PLATFORM_H |