(deallocate_tsd): Mark as internal_function.
[kopensolaris-gnu/glibc.git] / nptl / pthread_create.c
1 /* Copyright (C) 2002, 2003 Free Software Foundation, Inc.
2    This file is part of the GNU C Library.
3    Contributed by Ulrich Drepper <drepper@redhat.com>, 2002.
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 <stdbool.h>
22 #include <stdlib.h>
23 #include <string.h>
24 #include "pthreadP.h"
25 #include <hp-timing.h>
26 #include <ldsodefs.h>
27 #include <atomic.h>
28
29 #include <shlib-compat.h>
30
31
32 /* Local function to start thread and handle cleanup.  */
33 static int start_thread (void *arg);
34 /* Similar version used when debugging.  */
35 static int start_thread_debug (void *arg);
36
37
38 /* Nozero if debugging mode is enabled.  */
39 int __pthread_debug;
40
41 /* Globally enabled events.  */
42 static td_thr_events_t __nptl_threads_events;
43
44 /* Pointer to descriptor with the last event.  */
45 static struct pthread *__nptl_last_event;
46
47 /* Number of threads running.  */
48 unsigned int __nptl_nthreads = 1;
49
50
51 /* Code to allocate and deallocate a stack.  */
52 #define DEFINE_DEALLOC
53 #include "allocatestack.c"
54
55 /* Code to create the thread.  */
56 #include "createthread.c"
57
58
59 /* Table of the key information.  */
60 struct pthread_key_struct __pthread_keys[PTHREAD_KEYS_MAX]
61   __attribute__ ((section (".bss")));
62 hidden_def (__pthread_keys)
63
64 /* This is for libthread_db only.  */
65 const int __pthread_pthread_sizeof_descr = sizeof (struct pthread);
66
67 struct pthread *
68 internal_function
69 __find_in_stack_list (pd)
70      struct pthread *pd;
71 {
72   list_t *entry;
73   struct pthread *result = NULL;
74
75   lll_lock (stack_cache_lock);
76
77   list_for_each (entry, &stack_used)
78     {
79       struct pthread *curp;
80
81       curp = list_entry (entry, struct pthread, header.data.list);
82       if (curp == pd)
83         {
84           result = curp;
85           break;
86         }
87     }
88
89   if (result == NULL)
90     list_for_each (entry, &__stack_user)
91       {
92         struct pthread *curp;
93
94         curp = list_entry (entry, struct pthread, header.data.list);
95         if (curp == pd)
96           {
97             result = curp;
98             break;
99           }
100       }
101
102   lll_unlock (stack_cache_lock);
103
104   return result;
105 }
106
107
108 /* Deallocate POSIX thread-local-storage.  */
109 static void
110 internal_function
111 deallocate_tsd (struct pthread *pd)
112 {
113   /* Maybe no data was ever allocated.  This happens often so we have
114      a flag for this.  */
115   if (pd->specific_used)
116     {
117       size_t round;
118       bool found_nonzero;
119
120       for (round = 0, found_nonzero = true;
121            found_nonzero && round < PTHREAD_DESTRUCTOR_ITERATIONS;
122            ++round)
123         {
124           size_t cnt;
125           size_t idx;
126
127           for (cnt = idx = 0; cnt < PTHREAD_KEY_1STLEVEL_SIZE; ++cnt)
128             if (pd->specific[cnt] != NULL)
129               {
130                 size_t inner;
131
132                 for (inner = 0; inner < PTHREAD_KEY_2NDLEVEL_SIZE;
133                      ++inner, ++idx)
134                   {
135                     void *data = pd->specific[cnt][inner].data;
136
137                     if (data != NULL
138                         /* Make sure the data corresponds to a valid
139                            key.  This test fails if the key was
140                            deallocated and also if it was
141                            re-allocated.  It is the user's
142                            responsibility to free the memory in this
143                            case.  */
144                         && (pd->specific[cnt][inner].seq
145                             == __pthread_keys[idx].seq)
146                         /* It is not necessary to register a destructor
147                            function.  */
148                         && __pthread_keys[idx].destr != NULL)
149                       {
150                         pd->specific[cnt][inner].data = NULL;
151                         __pthread_keys[idx].destr (data);
152                         found_nonzero = true;
153                       }
154                   }
155
156                 if (cnt != 0)
157                   {
158                     /* The first block is allocated as part of the thread
159                        descriptor.  */
160                     free (pd->specific[cnt]);
161                     pd->specific[cnt] = NULL;
162                   }
163                 else
164                   /* Clear the memory of the first block for reuse.  */
165                   memset (pd->specific[0], '\0',
166                           sizeof (struct pthread_key_data));
167               }
168             else
169               idx += PTHREAD_KEY_1STLEVEL_SIZE;
170         }
171
172       pd->specific_used = false;
173     }
174 }
175
176
177 /* Deallocate a thread's stack after optionally making sure the thread
178    descriptor is still valid.  */
179 void
180 internal_function
181 __free_tcb (struct pthread *pd)
182 {
183   /* The thread is exiting now.  */
184   if (__builtin_expect (atomic_bit_test_set (&pd->cancelhandling,
185                                              TERMINATED_BIT) == 0, 1))
186     {
187       /* Remove the descriptor from the list.  */
188       if (DEBUGGING_P && __find_in_stack_list (pd) == NULL)
189         /* Something is really wrong.  The descriptor for a still
190            running thread is gone.  */
191         abort ();
192
193       /* Run the destructor for the thread-local data.  */
194       deallocate_tsd (pd);
195
196       /* Queue the stack memory block for reuse and exit the process.  The
197          kernel will signal via writing to the address returned by
198          QUEUE-STACK when the stack is available.  */
199       __deallocate_stack (pd);
200     }
201 }
202
203
204 static int
205 start_thread (void *arg)
206 {
207   /* One more thread.  */
208   atomic_increment (&__nptl_nthreads);
209
210   struct pthread *pd = (struct pthread *) arg;
211
212 #if HP_TIMING_AVAIL
213   /* Remember the time when the thread was started.  */
214   hp_timing_t now;
215   HP_TIMING_NOW (now);
216   THREAD_SETMEM (pd, cpuclock_offset, now);
217 #endif
218
219   /* This is where the try/finally block should be created.  For
220      compilers without that support we do use setjmp.  */
221   if (setjmp (pd->cancelbuf) == 0)
222     {
223       /* Run the code the user provided.  */
224       pd->result = pd->start_routine (pd->arg);
225     }
226
227
228   /* If this is the last thread we terminate the process now.  We
229      do not notify the debugger, it might just irritate it if there
230      is no thread left.  */
231   if (__builtin_expect (atomic_decrement_and_test (&__nptl_nthreads), 0))
232     /* This was the last thread.  */
233     exit (0);
234
235
236   /* Report the death of the thread if this is wanted.  */
237   if (__builtin_expect (pd->report_events, 0))
238     {
239       /* See whether TD_DEATH is in any of the mask.  */
240       const int idx = __td_eventword (TD_DEATH);
241       const uint32_t mask = __td_eventmask (TD_DEATH);
242
243       if ((mask & (__nptl_threads_events.event_bits[idx]
244                    | pd->eventbuf.eventmask.event_bits[idx])) != 0)
245         {
246           /* Yep, we have to signal the death.  Add the descriptor to
247              the list but only if it is not already on it.  */
248           if (pd->nextevent == NULL)
249             {
250               pd->eventbuf.eventnum = TD_DEATH;
251               pd->eventbuf.eventdata = pd;
252
253               do
254                 pd->nextevent = __nptl_last_event;
255               while (atomic_compare_and_exchange_acq (&__nptl_last_event, pd,
256                                                       pd->nextevent) != 0);
257             }
258
259           /* Now call the function to signal the event.  */
260           __nptl_death_event ();
261         }
262     }
263
264
265   /* The thread is exiting now.  */
266   atomic_bit_set (&pd->cancelhandling, EXITING_BIT);
267
268   /* If the thread is detached free the TCB.  */
269   if (IS_DETACHED (pd))
270     /* Free the TCB.  */
271     __free_tcb (pd);
272
273   /* We cannot call '_exit' here.  '_exit' will terminate the process.
274
275      The 'exit' implementation in the kernel will signal when the
276      process is really dead since 'clone' got passed the CLONE_CLEARTID
277      flag.  The 'tid' field in the TCB will be set to zero.
278
279      The exit code is zero since in case all threads exit by calling
280      'pthread_exit' the exit status must be 0 (zero).  */
281   __exit_thread_inline (0);
282
283   /* NOTREACHED */
284   return 0;
285 }
286
287
288 /* Just list start_thread but we do some more things needed for a run
289    with a debugger attached.  */
290 static int
291 start_thread_debug (void *arg)
292 {
293   struct pthread *pd = (struct pthread *) arg;
294
295   /* Get the lock the parent locked to force synchronization.  */
296   lll_lock (pd->lock);
297   /* And give it up right away.  */
298   lll_unlock (pd->lock);
299
300   /* Now do the actual startup.  */
301   return start_thread (arg);
302 }
303
304
305 /* Default thread attributes for the case when the user does not
306    provide any.  */
307 static const struct pthread_attr default_attr =
308   {
309     /* Just some value > 0 which gets rounded to the nearest page size.  */
310     .guardsize = 1,
311   };
312
313
314 int
315 __pthread_create_2_1 (newthread, attr, start_routine, arg)
316      pthread_t *newthread;
317      const pthread_attr_t *attr;
318      void *(*start_routine) (void *);
319      void *arg;
320 {
321   STACK_VARIABLES;
322   const struct pthread_attr *iattr;
323   struct pthread *pd;
324   int err;
325
326   iattr = (struct pthread_attr *) attr;
327   if (iattr == NULL)
328     /* Is this the best idea?  On NUMA machines this could mean
329        accessing far-away memory.  */
330     iattr = &default_attr;
331
332   err = ALLOCATE_STACK (iattr, &pd);
333   if (__builtin_expect (err != 0, 0))
334     /* Something went wrong.  Maybe a parameter of the attributes is
335        invalid or we could not allocate memory.  */
336     return err;
337
338
339   /* Initialize the TCB.  All initializations with zero should be
340      performed in 'get_cached_stack'.  This way we avoid doing this if
341      the stack freshly allocated with 'mmap'.  */
342
343   /* Reference to the TCB itself.  */
344   pd->header.data.self = pd;
345
346 #ifdef TLS_TCB_AT_TP
347   /* Self-reference.  */
348   pd->header.data.tcb = pd;
349 #endif
350
351   /* Store the address of the start routine and the parameter.  Since
352      we do not start the function directly the stillborn thread will
353      get the information from its thread descriptor.  */
354   pd->start_routine = start_routine;
355   pd->arg = arg;
356
357   /* Copy the thread attribute flags.  */
358   pd->flags = iattr->flags;
359
360   /* Initialize the field for the ID of the thread which is waiting
361      for us.  This is a self-reference in case the thread is created
362      detached.  */
363   pd->joinid = iattr->flags & ATTR_FLAG_DETACHSTATE ? pd : NULL;
364
365   /* The debug events are inherited from the parent.  */
366   pd->eventbuf = THREAD_SELF->eventbuf;
367
368
369   /* Determine scheduling parameters for the thread.
370      XXX How to determine whether scheduling handling is needed?  */
371   if (0 && attr != NULL)
372     {
373       if (iattr->flags & ATTR_FLAG_NOTINHERITSCHED)
374         {
375           /* Use the scheduling parameters the user provided.  */
376           pd->schedpolicy = iattr->schedpolicy;
377           memcpy (&pd->schedparam, &iattr->schedparam,
378                   sizeof (struct sched_param));
379         }
380       else
381         {
382           /* Just store the scheduling attributes of the parent.  */
383           pd->schedpolicy = __sched_getscheduler (0);
384           __sched_getparam (0, &pd->schedparam);
385         }
386     }
387
388   /* Pass the descriptor to the caller.  */
389   *newthread = (pthread_t) pd;
390
391   /* Start the thread.  */
392   err = create_thread (pd, STACK_VARIABLES_ARGS);
393   if (err != 0)
394     {
395       /* Something went wrong.  Free the resources.  */
396       __deallocate_stack (pd);
397       return err;
398     }
399
400   return 0;
401 }
402 versioned_symbol (libpthread, __pthread_create_2_1, pthread_create, GLIBC_2_1);
403
404
405 #if SHLIB_COMPAT(libpthread, GLIBC_2_0, GLIBC_2_1)
406 int
407 __pthread_create_2_0 (newthread, attr, start_routine, arg)
408      pthread_t *newthread;
409      const pthread_attr_t *attr;
410      void *(*start_routine) (void *);
411      void *arg;
412 {
413   /* The ATTR attribute is not really of type `pthread_attr_t *'.  It has
414      the old size and access to the new members might crash the program.
415      We convert the struct now.  */
416   struct pthread_attr new_attr;
417
418   if (attr != NULL)
419     {
420       struct pthread_attr *iattr = (struct pthread_attr *) attr;
421       size_t ps = __getpagesize ();
422
423       /* Copy values from the user-provided attributes.  */
424       new_attr.schedparam = iattr->schedparam;
425       new_attr.schedpolicy = iattr->schedpolicy;
426       new_attr.flags = iattr->flags;
427
428       /* Fill in default values for the fields not present in the old
429          implementation.  */
430       new_attr.guardsize = ps;
431       new_attr.stackaddr = NULL;
432       new_attr.stacksize = 0;
433
434       /* We will pass this value on to the real implementation.  */
435       attr = (pthread_attr_t *) &new_attr;
436     }
437
438   return __pthread_create_2_1 (newthread, attr, start_routine, arg);
439 }
440 compat_symbol (libpthread, __pthread_create_2_0, pthread_create,
441                GLIBC_2_0);
442 #endif