(tcbhead_t): Rename private membe to __private.
[kopensolaris-gnu/glibc.git] / nptl / sysdeps / ia64 / tls.h
1 /* Definition for thread-local data handling.  nptl/IA-64 version.
2    Copyright (C) 2003, 2004, 2005, 2006 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, write to the Free
17    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
18    02111-1307 USA.  */
19
20 #ifndef _TLS_H
21 #define _TLS_H  1
22
23 #include <dl-sysdep.h>
24 #ifndef __ASSEMBLER__
25 # include <stdbool.h>
26 # include <stddef.h>
27 # include <stdint.h>
28 # include <stdlib.h>
29 # include <list.h>
30
31
32 /* Type for the dtv.  */
33 typedef union dtv
34 {
35   size_t counter;
36   struct
37   {
38     void *val;
39     bool is_static;
40   } pointer;
41 } dtv_t;
42
43
44 typedef struct
45 {
46   dtv_t *dtv;
47   void *__private;
48 } tcbhead_t;
49
50 register struct pthread *__thread_self __asm__("r13");
51
52 # define TLS_MULTIPLE_THREADS_IN_TCB 1
53
54 #else /* __ASSEMBLER__ */
55 # include <tcb-offsets.h>
56 #endif
57
58
59 /* We require TLS support in the tools.  */
60 #ifndef HAVE_TLS_SUPPORT
61 # error "TLS support is required."
62 #endif
63
64 /* Signal that TLS support is available.  */
65 #define USE_TLS 1
66
67 /* Alignment requirement for the stack.  */
68 #define STACK_ALIGN     16
69
70 #ifndef __ASSEMBLER__
71 /* Get system call information.  */
72 # include <sysdep.h>
73
74 /* This is the size of the initial TCB.  */
75 # define TLS_INIT_TCB_SIZE sizeof (tcbhead_t)
76
77 /* Alignment requirements for the initial TCB.  */
78 # define TLS_INIT_TCB_ALIGN __alignof__ (tcbhead_t)
79
80 /* This is the size of the TCB.  */
81 # define TLS_TCB_SIZE sizeof (tcbhead_t)
82
83 /* This is the size we need before TCB.
84    If there is not any room for uintptr_t stack_guard and
85    uintptr_t pointer_guard in struct pthread's final padding,
86    we need to put struct pthread 16 byte slower.  */
87 # define TLS_PRE_TCB_SIZE \
88   (sizeof (struct pthread)                                              \
89    + (PTHREAD_STRUCT_END_PADDING < 2 * sizeof (uintptr_t)               \
90       ? ((2 * sizeof (uintptr_t) + __alignof__ (struct pthread) - 1)    \
91          & ~(__alignof__ (struct pthread) - 1))                         \
92       : 0))
93
94 /* Alignment requirements for the TCB.  */
95 # define TLS_TCB_ALIGN __alignof__ (struct pthread)
96
97 /* The DTV is allocated at the TP; the TCB is placed elsewhere.  */
98 # define TLS_DTV_AT_TP  1
99
100 /* Get the thread descriptor definition.  */
101 # include <nptl/descr.h>
102
103 /* Install the dtv pointer.  The pointer passed is to the element with
104    index -1 which contain the length.  */
105 #  define INSTALL_DTV(descr, dtvp) \
106   ((tcbhead_t *) (descr))->dtv = (dtvp) + 1
107
108 /* Install new dtv for current thread.  */
109 #  define INSTALL_NEW_DTV(DTV) \
110   (((tcbhead_t *)__thread_self)->dtv = (DTV))
111
112 /* Return dtv of given thread descriptor.  */
113 #  define GET_DTV(descr) \
114   (((tcbhead_t *) (descr))->dtv)
115
116 #define THREAD_SELF_SYSINFO     (((tcbhead_t *) __thread_self)->__private)
117 #define THREAD_SYSINFO(pd) \
118   (((tcbhead_t *) ((char *) (pd) + TLS_PRE_TCB_SIZE))->__private)
119
120 #if defined NEED_DL_SYSINFO
121 # define INIT_SYSINFO   THREAD_SELF_SYSINFO = (void *) GLRO(dl_sysinfo)
122 #else
123 # define INIT_SYSINFO   NULL
124 #endif
125
126 /* Code to initially initialize the thread pointer.  This might need
127    special attention since 'errno' is not yet available and if the
128    operation can cause a failure 'errno' must not be touched.  */
129 # define TLS_INIT_TP(thrdescr, secondcall) \
130   (__thread_self = (thrdescr), INIT_SYSINFO, NULL)
131
132 /* Return the address of the dtv for the current thread.  */
133 #  define THREAD_DTV() \
134   (((tcbhead_t *)__thread_self)->dtv)
135
136 /* Return the thread descriptor for the current thread.  */
137 # define THREAD_SELF \
138   ((struct pthread *) ((char *) __thread_self - TLS_PRE_TCB_SIZE))
139
140 /* Magic for libthread_db to know how to do THREAD_SELF.  */
141 # define DB_THREAD_SELF REGISTER (64, 64, 13 * 8, -TLS_PRE_TCB_SIZE)
142
143 /* Access to data in the thread descriptor is easy.  */
144 #define THREAD_GETMEM(descr, member) \
145   descr->member
146 #define THREAD_GETMEM_NC(descr, member, idx) \
147   descr->member[idx]
148 #define THREAD_SETMEM(descr, member, value) \
149   descr->member = (value)
150 #define THREAD_SETMEM_NC(descr, member, idx, value) \
151   descr->member[idx] = (value)
152
153 /* Set the stack guard field in TCB head.  */
154 #define THREAD_SET_STACK_GUARD(value) \
155   (((uintptr_t *) __thread_self)[-1] = (value))
156 #define THREAD_COPY_STACK_GUARD(descr) \
157   (((uintptr_t *) ((char *) (descr) + TLS_PRE_TCB_SIZE))[-1] \
158    = ((uintptr_t *) __thread_self)[-1])
159
160 /* Set the pointer guard field in TCB head.  */
161 #define THREAD_GET_POINTER_GUARD() \
162   (((uintptr_t *) __thread_self)[-2])
163 #define THREAD_SET_POINTER_GUARD(value) \
164   (((uintptr_t *) __thread_self)[-2] = (value))
165 #define THREAD_COPY_POINTER_GUARD(descr) \
166   (((uintptr_t *) ((char *) (descr) + TLS_PRE_TCB_SIZE))[-2] \
167    = THREAD_GET_POINTER_GUARD ())
168
169 #endif /* __ASSEMBLER__ */
170
171 #endif  /* tls.h */