92ea62fce4358ab0695a27442bfc0f7e4fa302f3
[kopensolaris-gnu/glibc.git] / sysdeps / generic / libc-tls.c
1 /* Initialization code for TLS in statically linked application.
2    Copyright (C) 2002 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 #include <errno.h>
21 #include <ldsodefs.h>
22 #include <tls.h>
23 #include <unistd.h>
24
25 #ifdef SHARED
26  #error makefile bug, this file is for static only
27 #endif
28
29 #ifdef USE_TLS
30 extern ElfW(Phdr) *_dl_phdr;
31 extern size_t _dl_phnum;
32
33
34 /* DTV with just one element plus overhead.  */
35 static dtv_t static_dtv[3];
36
37
38 static struct
39 {
40   struct dtv_slotinfo_list si;
41   /* The dtv_slotinfo_list data structure does not include the actual
42      information since it is defined as an array of size zero.  We define
43      here the necessary entries.  Note that it is not important whether
44      there is padding or not since we will always access the information
45      through the 'si' element.  */
46   struct dtv_slotinfo info[2 + TLS_SLOTINFO_SURPLUS];
47 } static_slotinfo;
48
49 /* Fake link map for the application.  */
50 static struct link_map static_map;
51
52
53 /* Highest dtv index currently needed.  */
54 size_t _dl_tls_max_dtv_idx;
55 /* Flag signalling whether there are gaps in the module ID allocation.  */
56 bool _dl_tls_dtv_gaps;
57 /* Information about the dtv slots.  */
58 struct dtv_slotinfo_list *_dl_tls_dtv_slotinfo_list;
59 /* Number of modules in the static TLS block.  */
60 size_t _dl_tls_static_nelem;
61 /* Size of the static TLS block.  */
62 size_t _dl_tls_static_size;
63 /* Alignment requirement of the static TLS block.  */
64 size_t _dl_tls_static_align;
65
66 /* Generation counter for the dtv.  */
67 size_t _dl_tls_generation;
68
69
70 /* Additional definitions needed by TLS initialization.  */
71 #ifdef TLS_INIT_HELPER
72 TLS_INIT_HELPER
73 #endif
74
75
76 void
77 __libc_setup_tls (size_t tcbsize, size_t tcbalign)
78 {
79   void *tlsblock;
80   size_t memsz = 0;
81   size_t filesz = 0;
82   void *initimage = NULL;
83   size_t align = 0;
84   size_t max_align = tcbalign;
85   size_t tcb_offset;
86   ElfW(Phdr) *phdr;
87
88   /* Look through the TLS segment if there is any.  */
89   if (_dl_phdr != NULL)
90     for (phdr = _dl_phdr; phdr < &_dl_phdr[_dl_phnum]; ++phdr)
91       if (phdr->p_type == PT_TLS)
92         {
93           /* Remember the values we need.  */
94           memsz = phdr->p_memsz;
95           filesz = phdr->p_filesz;
96           initimage = (void *) phdr->p_vaddr;
97           align = phdr->p_align;
98           if (phdr->p_align > max_align)
99             max_align = phdr->p_align;
100           break;
101         }
102
103   if (memsz == 0 && tcbsize == 0)
104     /* We do not need a TLS block and no thread descriptor.  */
105     return;
106
107   /* We have to set up the TCB block which also (possibly) contains
108      'errno'.  Therefore we avoid 'malloc' which might touch 'errno'.
109      Instead we use 'sbrk' which would only uses 'errno' if it fails.
110      In this case we are right away out of memory and the user gets
111      what she/he deserves.  */
112 # if TLS_TCB_AT_TP
113   tlsblock = __sbrk (roundup (memsz, tcbalign) + tcbsize + max_align);
114 # elif TLS_DTV_AT_TP
115   tlsblock = __sbrk (roundup (tcbsize, align) + memsz + max_align);
116 # else
117   /* In case a model with a different layout for the TCB and DTV
118      is defined add another #elif here and in the following #ifs.  */
119 #  error "Either TLS_TCB_AT_TP or TLS_DTV_AT_TP must be defined"
120 # endif
121
122   /* Align the TLS block.  */
123   tlsblock = (void *) (((uintptr_t) tlsblock + max_align - 1)
124                        & ~(max_align - 1));
125
126   /* Initialize the dtv.  [0] is the length, [1] the generation counter.  */
127   static_dtv[0].counter = 1;
128   // static_dtv[1].counter = 0;         would be needed if not already done
129
130   /* Initialize the TLS block.  */
131 # if TLS_TCB_AT_TP
132   static_dtv[2].pointer = tlsblock;
133 # elif TLS_DTV_AT_TP
134   tcb_offset = roundup (tcbsize, align);
135   static_dtv[2].pointer = (char *) tlsblock + tcb_offset;
136 # else
137 #  error "Either TLS_TCB_AT_TP or TLS_DTV_AT_TP must be defined"
138 # endif
139   memset (__mempcpy (static_dtv[2].pointer, initimage, filesz),
140           '\0', memsz - filesz);
141
142   /* Install the pointer to the dtv.  */
143
144   /* Initialize the thread pointer.  */
145 # if TLS_TCB_AT_TP
146   tcb_offset = roundup (memsz, tcbalign);
147
148   INSTALL_DTV ((char *) tlsblock + tcb_offset, static_dtv);
149
150   TLS_INIT_TP ((char *) tlsblock + tcb_offset, 0);
151 # elif TLS_DTV_AT_TP
152   INSTALL_DTV (tlsblock, static_dtv);
153   TLS_INIT_TP (tlsblock, 0);
154 # else
155 #  error "Either TLS_TCB_AT_TP or TLS_DTV_AT_TP must be defined"
156 # endif
157
158   /* We have to create a fake link map which normally would be created
159      by the dynamic linker.  It just has to have enough information to
160      make the TLS routines happy.  */
161   static_map.l_tls_align = align;
162   static_map.l_tls_blocksize = memsz;
163   static_map.l_tls_initimage = initimage;
164   static_map.l_tls_initimage_size = filesz;
165   static_map.l_tls_offset = tcb_offset;
166   static_map.l_type = lt_executable;
167   static_map.l_tls_modid = 1;
168
169   /* Create the slotinfo list.  */
170   static_slotinfo.si.len = (((char *) (&static_slotinfo + 1)
171                              - (char *) &static_slotinfo.si.slotinfo[0])
172                             / sizeof static_slotinfo.si.slotinfo[0]);
173   // static_slotinfo.si.next = NULL;    already zero
174
175   static_slotinfo.si.slotinfo[1].gen = 0;
176   static_slotinfo.si.slotinfo[1].map = &static_map;
177
178   /* The slotinfo list.  Will be extended by the code doing dynamic
179      linking.  */
180   GL(dl_tls_max_dtv_idx) = 1;
181   GL(dl_tls_dtv_slotinfo_list) = &static_slotinfo.si;
182
183   /* That is the size of the TLS memory for this object.  */
184   GL(dl_tls_static_size) = (roundup (memsz, align ?: 1)
185 # if TLS_TCB_AT_TP
186                             + tcbsize
187 # endif
188                             );
189   /* The alignment requirement for the static TLS block.  */
190   GL(dl_tls_static_align) = MAX (TLS_TCB_ALIGN, max_align);
191   /* Number of elements in the static TLS block.  */
192   GL(dl_tls_static_nelem) = GL(dl_tls_max_dtv_idx);
193 }
194
195
196 /* This is the minimal initialization function used when libpthread is
197    not used.  */
198 void
199 __attribute__ ((weak))
200 __pthread_initialize_minimal (void)
201 {
202   __libc_setup_tls (TLS_INIT_TCB_SIZE, TLS_INIT_TCB_ALIGN);
203 }
204 #endif