diff options
Diffstat (limited to 'tls/impl/simpleops-tls-impl-doc.h')
-rw-r--r-- | tls/impl/simpleops-tls-impl-doc.h | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/tls/impl/simpleops-tls-impl-doc.h b/tls/impl/simpleops-tls-impl-doc.h new file mode 100644 index 0000000..97b12de --- /dev/null +++ b/tls/impl/simpleops-tls-impl-doc.h @@ -0,0 +1,61 @@ +/* -*- Mode: c; c-basic-offset: 4; indent-tabs-mode: t; tab-width: 8; -*- */ +/* + * Copyright 2010-2011 Andrea Canciani + * + * 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. + * + * Author(s): Andrea Canciani <ranma42@gmail.com> + */ + +#ifndef SIMPLEOPS_TLS_IMPL_DOC_H +#define SIMPLEOPS_TLS_IMPL_DOC_H + +#ifndef SIMPLEOPS_TLS_IMPL_H +#error Private header used directly +#endif + +#if ! SIMPLEOPS_HAVE_TLS_IMPL && \ + SIMPLEOPS_DOC + +/** + * Defined whenever the simpleops library is providing an + * implementation of TLS (thread-local storage) operations. + * + * Thread-local storage can be used to have internal data structure + * which are not shared between threads. This can be useful to avoid + * race conditions and cache contention and to make adaptive data + * structures which reflect the behavior of each thread more + * accurately. + * + * In order to use the TLS operations, the application must define + * SIMPLEOPS_PREFIX. + */ +#define SIMPLEOPS_HAVE_TLS_IMPL 1 + +/** + * SIMPLEOPS_HAVE_TLS_IMPL_* identifies which implementation is being + * used in the simpleops library to provide TLS operations. + */ +#define SIMPLEOPS_HAVE_TLS_IMPL_DOC 1 + +#endif + +#endif |