summaryrefslogtreecommitdiff
path: root/tls/impl/simpleops-tls-impl-doc.h
blob: 97b12de2c1e8cb8a1c67485599df8a371d35dac5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
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