2004-09-10 Roland McGrath <roland@redhat.com>
[kopensolaris-gnu/glibc.git] / nptl / pthread_create.c
1 /* Copyright (C) 2002, 2003, 2004 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 #include <resolv.h>
30
31 #include <shlib-compat.h>
32
33
34 /* Local function to start thread and handle cleanup.  */
35 static int start_thread (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 #include "allocatestack.c"
53
54 /* Code to create the thread.  */
55 #include "createthread.c"
56
57
58 /* Table of the key information.  */
59 struct pthread_key_struct __pthread_keys[PTHREAD_KEYS_MAX]
60   __attribute__ ((nocommon));
61 hidden_data_def (__pthread_keys)
62
63 struct pthread *
64 internal_function
65 __find_in_stack_list (pd)
66      struct pthread *pd;
67 {
68   list_t *entry;
69   struct pthread *result = NULL;
70
71   lll_lock (stack_cache_lock);
72
73   list_for_each (entry, &stack_used)
74     {
75       struct pthread *curp;
76
77       curp = list_entry (entry, struct pthread, list);
78       if (curp == pd)
79         {
80           result = curp;
81           break;
82         }
83     }
84
85   if (result == NULL)
86     list_for_each (entry, &__stack_user)
87       {
88         struct pthread *curp;
89
90         curp = list_entry (entry, struct pthread, list);
91         if (curp == pd)
92           {
93             result = curp;
94             break;
95           }
96       }
97
98   lll_unlock (stack_cache_lock);
99
100   return result;
101 }
102
103
104 /* Deallocate POSIX thread-local-storage.  */
105 void
106 attribute_hidden
107 __nptl_deallocate_tsd (void)
108 {
109   struct pthread *self = THREAD_SELF;
110
111   /* Maybe no data was ever allocated.  This happens often so we have
112      a flag for this.  */
113   if (THREAD_GETMEM (self, specific_used))
114     {
115       size_t round;
116       size_t cnt;
117
118       round = 0;
119       do
120         {
121           size_t idx;
122
123           /* So far no new nonzero data entry.  */
124           THREAD_SETMEM (self, specific_used, false);
125
126           for (cnt = idx = 0; cnt < PTHREAD_KEY_1STLEVEL_SIZE; ++cnt)
127             {
128               struct pthread_key_data *level2;
129
130               level2 = THREAD_GETMEM_NC (self, specific, cnt);
131
132               if (level2 != NULL)
133                 {
134                   size_t inner;
135
136                   for (inner = 0; inner < PTHREAD_KEY_2NDLEVEL_SIZE;
137                        ++inner, ++idx)
138                     {
139                       void *data = level2[inner].data;
140
141                       if (data != NULL)
142                         {
143                           /* Always clear the data.  */
144                           level2[inner].data = NULL;
145
146                           /* Make sure the data corresponds to a valid
147                              key.  This test fails if the key was
148                              deallocated and also if it was
149                              re-allocated.  It is the user's
150                              responsibility to free the memory in this
151                              case.  */
152                           if (level2[inner].seq
153                               == __pthread_keys[idx].seq
154                               /* It is not necessary to register a destructor
155                                  function.  */
156                               && __pthread_keys[idx].destr != NULL)
157                             /* Call the user-provided destructor.  */
158                             __pthread_keys[idx].destr (data);
159                         }
160                     }
161                 }
162               else
163                 idx += PTHREAD_KEY_1STLEVEL_SIZE;
164             }
165
166           if (THREAD_GETMEM (self, specific_used) == 0)
167             /* No data has been modified.  */
168             goto just_free;
169         }
170       /* We only repeat the process a fixed number of times.  */
171       while (__builtin_expect (++round < PTHREAD_DESTRUCTOR_ITERATIONS, 0));
172
173       /* Just clear the memory of the first block for reuse.  */
174       memset (&THREAD_SELF->specific_1stblock, '\0',
175               sizeof (self->specific_1stblock));
176
177     just_free:
178       /* Free the memory for the other blocks.  */
179       for (cnt = 1; cnt < PTHREAD_KEY_1STLEVEL_SIZE; ++cnt)
180         {
181           struct pthread_key_data *level2;
182
183           level2 = THREAD_GETMEM_NC (self, specific, cnt);
184           if (level2 != NULL)
185             {
186               /* The first block is allocated as part of the thread
187                  descriptor.  */
188               free (level2);
189               THREAD_SETMEM_NC (self, specific, cnt, NULL);
190             }
191         }
192
193       THREAD_SETMEM (self, specific_used, false);
194     }
195 }
196
197
198 /* Deallocate a thread's stack after optionally making sure the thread
199    descriptor is still valid.  */
200 void
201 internal_function
202 __free_tcb (struct pthread *pd)
203 {
204   /* The thread is exiting now.  */
205   if (__builtin_expect (atomic_bit_test_set (&pd->cancelhandling,
206                                              TERMINATED_BIT) == 0, 1))
207     {
208       /* Remove the descriptor from the list.  */
209       if (DEBUGGING_P && __find_in_stack_list (pd) == NULL)
210         /* Something is really wrong.  The descriptor for a still
211            running thread is gone.  */
212         abort ();
213
214       /* Queue the stack memory block for reuse and exit the process.  The
215          kernel will signal via writing to the address returned by
216          QUEUE-STACK when the stack is available.  */
217       __deallocate_stack (pd);
218     }
219 }
220
221
222 static int
223 start_thread (void *arg)
224 {
225   /* One more thread.  */
226   atomic_increment (&__nptl_nthreads);
227
228   struct pthread *pd = (struct pthread *) arg;
229
230   /* Get the lock the parent locked to force synchronization.  */
231   lll_lock (pd->lock);
232   /* And give it up right away.  */
233   lll_unlock (pd->lock);
234
235 #if HP_TIMING_AVAIL
236   /* Remember the time when the thread was started.  */
237   hp_timing_t now;
238   HP_TIMING_NOW (now);
239   THREAD_SETMEM (pd, cpuclock_offset, now);
240 #endif
241
242   /* Initialize resolver state pointer.  */
243   __resp = &pd->res;
244
245   /* This is where the try/finally block should be created.  For
246      compilers without that support we do use setjmp.  */
247   struct pthread_unwind_buf unwind_buf;
248
249   /* No previous handlers.  */
250   unwind_buf.priv.data.prev = NULL;
251   unwind_buf.priv.data.cleanup = NULL;
252
253   int not_first_call;
254   not_first_call = setjmp ((struct __jmp_buf_tag *) unwind_buf.cancel_jmp_buf);
255   if (__builtin_expect (! not_first_call, 1))
256     {
257       /* Store the new cleanup handler info.  */
258       THREAD_SETMEM (pd, cleanup_jmp_buf, &unwind_buf);
259
260       /* Run the code the user provided.  */
261 #ifdef CALL_THREAD_FCT
262       THREAD_SETMEM (pd, result, CALL_THREAD_FCT (pd));
263 #else
264       THREAD_SETMEM (pd, result, pd->start_routine (pd->arg));
265 #endif
266     }
267
268   /* Run the destructor for the thread-local data.  */
269   __nptl_deallocate_tsd ();
270
271   /* Clean up any state libc stored in thread-local variables.  */
272   __libc_thread_freeres ();
273
274   /* If this is the last thread we terminate the process now.  We
275      do not notify the debugger, it might just irritate it if there
276      is no thread left.  */
277   if (__builtin_expect (atomic_decrement_and_test (&__nptl_nthreads), 0))
278     /* This was the last thread.  */
279     exit (0);
280
281   /* Report the death of the thread if this is wanted.  */
282   if (__builtin_expect (pd->report_events, 0))
283     {
284       /* See whether TD_DEATH is in any of the mask.  */
285       const int idx = __td_eventword (TD_DEATH);
286       const uint32_t mask = __td_eventmask (TD_DEATH);
287
288       if ((mask & (__nptl_threads_events.event_bits[idx]
289                    | pd->eventbuf.eventmask.event_bits[idx])) != 0)
290         {
291           /* Yep, we have to signal the death.  Add the descriptor to
292              the list but only if it is not already on it.  */
293           if (pd->nextevent == NULL)
294             {
295               pd->eventbuf.eventnum = TD_DEATH;
296               pd->eventbuf.eventdata = pd;
297
298               do
299                 pd->nextevent = __nptl_last_event;
300               while (atomic_compare_and_exchange_bool_acq (&__nptl_last_event,
301                                                            pd, pd->nextevent));
302             }
303
304           /* Now call the function to signal the event.  */
305           __nptl_death_event ();
306         }
307     }
308
309   /* The thread is exiting now.  Don't set this bit until after we've hit
310      the event-reporting breakpoint, so that td_thr_get_info on us while at
311      the breakpoint reports TD_THR_RUN state rather than TD_THR_ZOMBIE.  */
312   atomic_bit_set (&pd->cancelhandling, EXITING_BIT);
313
314   /* If the thread is detached free the TCB.  */
315   if (IS_DETACHED (pd))
316     /* Free the TCB.  */
317     __free_tcb (pd);
318
319   /* We cannot call '_exit' here.  '_exit' will terminate the process.
320
321      The 'exit' implementation in the kernel will signal when the
322      process is really dead since 'clone' got passed the CLONE_CLEARTID
323      flag.  The 'tid' field in the TCB will be set to zero.
324
325      The exit code is zero since in case all threads exit by calling
326      'pthread_exit' the exit status must be 0 (zero).  */
327   __exit_thread_inline (0);
328
329   /* NOTREACHED */
330   return 0;
331 }
332
333
334 /* Default thread attributes for the case when the user does not
335    provide any.  */
336 static const struct pthread_attr default_attr =
337   {
338     /* Just some value > 0 which gets rounded to the nearest page size.  */
339     .guardsize = 1,
340   };
341
342
343 int
344 __pthread_create_2_1 (newthread, attr, start_routine, arg)
345      pthread_t *newthread;
346      const pthread_attr_t *attr;
347      void *(*start_routine) (void *);
348      void *arg;
349 {
350   STACK_VARIABLES;
351   const struct pthread_attr *iattr;
352   struct pthread *pd;
353   int err;
354
355   iattr = (struct pthread_attr *) attr;
356   if (iattr == NULL)
357     /* Is this the best idea?  On NUMA machines this could mean
358        accessing far-away memory.  */
359     iattr = &default_attr;
360
361   err = ALLOCATE_STACK (iattr, &pd);
362   if (__builtin_expect (err != 0, 0))
363     /* Something went wrong.  Maybe a parameter of the attributes is
364        invalid or we could not allocate memory.  */
365     return err;
366
367
368   /* Initialize the TCB.  All initializations with zero should be
369      performed in 'get_cached_stack'.  This way we avoid doing this if
370      the stack freshly allocated with 'mmap'.  */
371
372 #ifdef TLS_TCB_AT_TP
373   /* Reference to the TCB itself.  */
374   pd->header.self = pd;
375
376   /* Self-reference for TLS.  */
377   pd->header.tcb = pd;
378 #endif
379
380   /* Store the address of the start routine and the parameter.  Since
381      we do not start the function directly the stillborn thread will
382      get the information from its thread descriptor.  */
383   pd->start_routine = start_routine;
384   pd->arg = arg;
385
386   /* Copy the thread attribute flags.  */
387   struct pthread *self = THREAD_SELF;
388   pd->flags = ((iattr->flags & ~(ATTR_FLAG_SCHED_SET | ATTR_FLAG_POLICY_SET))
389                | (self->flags & (ATTR_FLAG_SCHED_SET | ATTR_FLAG_POLICY_SET)));
390
391   /* Initialize the field for the ID of the thread which is waiting
392      for us.  This is a self-reference in case the thread is created
393      detached.  */
394   pd->joinid = iattr->flags & ATTR_FLAG_DETACHSTATE ? pd : NULL;
395
396   /* The debug events are inherited from the parent.  */
397   pd->eventbuf = self->eventbuf;
398
399
400   /* Copy the parent's scheduling parameters.  The flags will say what
401      is valid and what is not.  */
402   pd->schedpolicy = self->schedpolicy;
403   pd->schedparam = self->schedparam;
404
405   /* Determine scheduling parameters for the thread.  */
406   if (attr != NULL
407       && __builtin_expect ((iattr->flags & ATTR_FLAG_NOTINHERITSCHED) != 0, 0)
408       && (iattr->flags & (ATTR_FLAG_SCHED_SET | ATTR_FLAG_POLICY_SET)) != 0)
409     {
410       INTERNAL_SYSCALL_DECL (err);
411
412       /* Use the scheduling parameters the user provided.  */
413       if (iattr->flags & ATTR_FLAG_POLICY_SET)
414         pd->schedpolicy = iattr->schedpolicy;
415       else if ((pd->flags & ATTR_FLAG_POLICY_SET) == 0)
416         {
417           pd->schedpolicy = INTERNAL_SYSCALL (sched_getscheduler, err, 1, 0);
418           pd->flags |= ATTR_FLAG_POLICY_SET;
419         }
420
421       if (iattr->flags & ATTR_FLAG_SCHED_SET)
422         memcpy (&pd->schedparam, &iattr->schedparam,
423                 sizeof (struct sched_param));
424       else if ((pd->flags & ATTR_FLAG_SCHED_SET) == 0)
425         {
426           INTERNAL_SYSCALL (sched_getparam, err, 2, 0, &pd->schedparam);
427           pd->flags |= ATTR_FLAG_SCHED_SET;
428         }
429
430       /* Check for valid priorities.  */
431       int minprio = INTERNAL_SYSCALL (sched_get_priority_min, err, 1,
432                                       iattr->schedpolicy);
433       int maxprio = INTERNAL_SYSCALL (sched_get_priority_max, err, 1,
434                                       iattr->schedpolicy);
435       if (pd->schedparam.sched_priority < minprio
436           || pd->schedparam.sched_priority > maxprio)
437         {
438           err = EINVAL;
439           goto errout;
440         }
441     }
442
443   /* Pass the descriptor to the caller.  */
444   *newthread = (pthread_t) pd;
445
446   /* Start the thread.  */
447   err = create_thread (pd, iattr, STACK_VARIABLES_ARGS);
448   if (err != 0)
449     {
450     errout:
451       /* Something went wrong.  Free the resources.  */
452       __deallocate_stack (pd);
453       return err;
454     }
455
456   return 0;
457 }
458 versioned_symbol (libpthread, __pthread_create_2_1, pthread_create, GLIBC_2_1);
459
460
461 #if SHLIB_COMPAT(libpthread, GLIBC_2_0, GLIBC_2_1)
462 int
463 __pthread_create_2_0 (newthread, attr, start_routine, arg)
464      pthread_t *newthread;
465      const pthread_attr_t *attr;
466      void *(*start_routine) (void *);
467      void *arg;
468 {
469   /* The ATTR attribute is not really of type `pthread_attr_t *'.  It has
470      the old size and access to the new members might crash the program.
471      We convert the struct now.  */
472   struct pthread_attr new_attr;
473
474   if (attr != NULL)
475     {
476       struct pthread_attr *iattr = (struct pthread_attr *) attr;
477       size_t ps = __getpagesize ();
478
479       /* Copy values from the user-provided attributes.  */
480       new_attr.schedparam = iattr->schedparam;
481       new_attr.schedpolicy = iattr->schedpolicy;
482       new_attr.flags = iattr->flags;
483
484       /* Fill in default values for the fields not present in the old
485          implementation.  */
486       new_attr.guardsize = ps;
487       new_attr.stackaddr = NULL;
488       new_attr.stacksize = 0;
489       new_attr.cpuset = NULL;
490
491       /* We will pass this value on to the real implementation.  */
492       attr = (pthread_attr_t *) &new_attr;
493     }
494
495   return __pthread_create_2_1 (newthread, attr, start_routine, arg);
496 }
497 compat_symbol (libpthread, __pthread_create_2_0, pthread_create,
498                GLIBC_2_0);
499 #endif
500 \f
501 /* Information for libthread_db.  */
502
503 #include "../nptl_db/db_info.c"