Move all files into ports/ subdirectory in preparation for merge with glibc
[jlayton/glibc.git] / ports / sysdeps / alpha / nptl / tls.h
1 /* Definition for thread-local data handling.  NPTL/Alpha version.
2    Copyright (C) 2003, 2005, 2006, 2007, 2012 Free Software Foundation, Inc.
3    This file is part of the GNU C Library.
4
5    The GNU C Library is free software; you can redistribute it and/or
6    modify it under the terms of the GNU Lesser General Public
7    License as published by the Free Software Foundation; either
8    version 2.1 of the License, or (at your option) any later version.
9
10    The GNU C Library is distributed in the hope that it will be useful,
11    but WITHOUT ANY WARRANTY; without even the implied warranty of
12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13    Lesser General Public License for more details.
14
15    You should have received a copy of the GNU Lesser General Public
16    License along with the GNU C Library.  If not, see
17    <http://www.gnu.org/licenses/>.  */
18
19 #ifndef _TLS_H
20 #define _TLS_H  1
21
22 # include <dl-sysdep.h>
23
24 #ifndef __ASSEMBLER__
25 # include <stdbool.h>
26 # include <stddef.h>
27 # include <stdint.h>
28
29 /* Type for the dtv.  */
30 typedef union dtv
31 {
32   size_t counter;
33   struct
34   {
35     void *val;
36     bool is_static;
37   } pointer;
38 } dtv_t;
39
40 /* Get system call information.  */
41 # include <sysdep.h>
42
43 /* The TP points to the start of the thread blocks.  */
44 # define TLS_DTV_AT_TP  1
45
46 /* Get the thread descriptor definition.  */
47 # include <nptl/descr.h>
48
49 typedef struct
50 {
51   dtv_t *dtv;
52   void *__private;
53 } tcbhead_t;
54
55 /* This is the size of the initial TCB.  */
56 # define TLS_INIT_TCB_SIZE      sizeof (tcbhead_t)
57
58 /* Alignment requirements for the initial TCB.  */
59 # define TLS_INIT_TCB_ALIGN     16
60
61 /* This is the size of the TCB.  */
62 # define TLS_TCB_SIZE           sizeof (tcbhead_t)
63
64 /* This is the size we need before TCB.  */
65 # define TLS_PRE_TCB_SIZE       sizeof (struct pthread)
66
67 /* Alignment requirements for the TCB.  */
68 # define TLS_TCB_ALIGN          16
69
70 /* Install the dtv pointer.  The pointer passed is to the element with
71    index -1 which contain the length.  */
72 # define INSTALL_DTV(tcbp, dtvp) \
73   (((tcbhead_t *) (tcbp))->dtv = (dtvp) + 1)
74
75 /* Install new dtv for current thread.  */
76 # define INSTALL_NEW_DTV(dtv) \
77   (THREAD_DTV() = (dtv))
78
79 /* Return dtv of given thread descriptor.  */
80 # define GET_DTV(tcbp) \
81   (((tcbhead_t *) (tcbp))->dtv)
82
83 /* Code to initially initialize the thread pointer.  This might need
84    special attention since 'errno' is not yet available and if the
85    operation can cause a failure 'errno' must not be touched.  */
86 # define TLS_INIT_TP(tcbp, secondcall) \
87   (__builtin_set_thread_pointer ((void *)(tcbp)), NULL)
88
89 /* Return the address of the dtv for the current thread.  */
90 # define THREAD_DTV() \
91   (((tcbhead_t *) __builtin_thread_pointer ())->dtv)
92
93 /* Return the thread descriptor for the current thread.  */
94 # define THREAD_SELF \
95  ((struct pthread *)__builtin_thread_pointer () - 1)
96
97 /* Magic for libthread_db to know how to do THREAD_SELF.  */
98 # define DB_THREAD_SELF \
99   REGISTER (64, 64, 32 * 8, -sizeof (struct pthread))
100
101 /* Access to data in the thread descriptor is easy.  */
102 #define THREAD_GETMEM(descr, member) \
103   descr->member
104 #define THREAD_GETMEM_NC(descr, member, idx) \
105   descr->member[idx]
106 #define THREAD_SETMEM(descr, member, value) \
107   descr->member = (value)
108 #define THREAD_SETMEM_NC(descr, member, idx, value) \
109   descr->member[idx] = (value)
110
111 /* Get and set the global scope generation counter in struct pthread.  */
112 #define THREAD_GSCOPE_FLAG_UNUSED 0
113 #define THREAD_GSCOPE_FLAG_USED   1
114 #define THREAD_GSCOPE_FLAG_WAIT   2
115 #define THREAD_GSCOPE_RESET_FLAG() \
116   do                                                                         \
117     { int __res                                                              \
118         = atomic_exchange_rel (&THREAD_SELF->header.gscope_flag,             \
119                                THREAD_GSCOPE_FLAG_UNUSED);                   \
120       if (__res == THREAD_GSCOPE_FLAG_WAIT)                                  \
121         lll_futex_wake (&THREAD_SELF->header.gscope_flag, 1, LLL_PRIVATE);   \
122     }                                                                        \
123   while (0)
124 #define THREAD_GSCOPE_SET_FLAG() \
125   do                                                                         \
126     {                                                                        \
127       THREAD_SELF->header.gscope_flag = THREAD_GSCOPE_FLAG_USED;             \
128       atomic_write_barrier ();                                               \
129     }                                                                        \
130   while (0)
131 #define THREAD_GSCOPE_WAIT() \
132   GL(dl_wait_lookup_done) ()
133
134 #else /* __ASSEMBLER__ */
135 # include <tcb-offsets.h>
136 #endif /* __ASSEMBLER__ */
137
138 #endif  /* tls.h */