1/*
2Copyright (c) 2012, Broadcom Europe Ltd
3All rights reserved.
4
5Redistribution and use in source and binary forms, with or without
6modification, are permitted provided that the following conditions are met:
7 * Redistributions of source code must retain the above copyright
8 notice, this list of conditions and the following disclaimer.
9 * Redistributions in binary form must reproduce the above copyright
10 notice, this list of conditions and the following disclaimer in the
11 documentation and/or other materials provided with the distribution.
12 * Neither the name of the copyright holder nor the
13 names of its contributors may be used to endorse or promote products
14 derived from this software without specific prior written permission.
15
16THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
20DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26*/
27
28/*=============================================================================
29VideoCore OS Abstraction Layer - thread local storage
30=============================================================================*/
31
32#ifndef VCOS_TLS_H
33#define VCOS_TLS_H
34
35#ifdef __cplusplus
36extern "C" {
37#endif
38
39#include "interface/vcos/vcos_types.h"
40#include "vcos.h"
41
42
43/** Create a new thread local storage data key visible to all threads in
44 * the current process.
45 *
46 * @param key The key to create
47 */
48VCOS_INLINE_DECL
49VCOS_STATUS_T vcos_tls_create(VCOS_TLS_KEY_T *key);
50
51/** Delete an existing TLS data key.
52 */
53VCOS_INLINE_DECL
54void vcos_tls_delete(VCOS_TLS_KEY_T tls);
55
56/** Set the value seen by the current thread.
57 *
58 * @param key The key to update
59 * @param v The value to set for the current thread.
60 *
61 * @return VCOS_SUCCESS, or VCOS_ENOMEM if memory for this slot
62 * could not be allocated.
63 *
64 * If TLS is being emulated via VCOS then the memory required
65 * can be preallocated at thread creation time
66 */
67VCOS_INLINE_DECL
68VCOS_STATUS_T vcos_tls_set(VCOS_TLS_KEY_T tls, void *v);
69
70/** Get the value for the current thread.
71 *
72 * @param key The key to update
73 *
74 * @return The current value for this thread.
75 */
76VCOS_INLINE_DECL
77void *vcos_tls_get(VCOS_TLS_KEY_T tls);
78
79#ifdef __cplusplus
80}
81#endif
82
83#endif
84
85