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