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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
/* -*- 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_TSS_IMPL_DOC_H
#define SIMPLEOPS_TSS_IMPL_DOC_H
#ifndef SIMPLEOPS_TSS_IMPL_H
#error Private header used directly
#endif
#if ! SIMPLEOPS_HAVE_TSS_IMPL && \
SIMPLEOPS_DOC
/**
* Defined whenever the simpleops library is providing an
* implementation of TSS (thread-specific storage) operations.
*
* Thread-specific 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 TSS operations, the application must define
* SIMPLEOPS_PREFIX.
*/
#define SIMPLEOPS_HAVE_TSS_IMPL 1
/**
* SIMPLEOPS_HAVE_TSS_IMPL_* identifies which implementation is being
* used in the simpleops library to provide TSS operations.
*/
#define SIMPLEOPS_HAVE_TSS_IMPL_DOC 1
/**
* Allocate a TSS key.
*
* \param[in,out] key the key to be allocated.
* \param[in] dtor the destructor for values associated with key.
*
* Create a thread-specific storage pointer with destructor dtor,
* which may be null.
*
* \return if the function is successful, it sets the thread-specific
* storage pointed to by key to a value that uniquely identifies the
* newly created pointer and returns #simpleops_thrd_success;
* otherwise, #simpleops_thrd_error is returned and the
* thread-specific storage pointed to by key is set to an undefined
* value.
*/
static simpleops_always_inline int
simpleops_tss_create (simpleops_tss_t *key, simpleops_tss_dtor_t dtor)
{
}
/**
* Release a TSS key.
*
* \param[in] key the key to be released.
*
* Release any resources used by the thread-specific storage
* identified by key.
*/
static simpleops_always_inline void
simpleops_tss_delete (simpleops_tss_t key)
{
}
/**
* Get the TSS value associated with a key.
*
* \param[in] key the key.
*
* Return the value for the current thread held in the thread-specific
* storage identified by key.
*
* \return the value for the current thread if successful, or zero if
* unsuccessful.
*/
static simpleops_always_inline void *
simpleops_tss_get (simpleops_tss_t key)
{
}
/**
* Set the TSS value associated with a key.
*
* \param[in] key the key.
* \param[in] val the value.
*
* Set the value for the current thread held in the thread-specific
* storage identified by key to val.
*
* \return #simpleops_thrd_success on success or #simpleops_thrd_error
* if the request could not be honored.
*/
static simpleops_always_inline int
simpleops_tss_set (simpleops_tss_t key, void *val)
{
}
#endif
#endif
|
