Include resolv.h.
[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 #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 /* Similar version used when debugging.  */
37 static int start_thread_debug (void *arg);
38
39
40 /* Nozero if debugging mode is enabled.  */
41 int __pthread_debug;
42
43 /* Globally enabled events.  */
44 static td_thr_events_t __nptl_threads_events;
45
46 /* Pointer to descriptor with the last event.  */
47 static struct pthread *__nptl_last_event;
48
49 /* Number of threads running.  */
50 unsigned int __nptl_nthreads = 1;
51
52
53 /* Code to allocate and deallocate a stack.  */
54 #include "allocatestack.c"
55
56 /* Code to create the thread.  */
57 #include "createthread.c"
58
59
60 /* Table of the key information.  */
61 struct pthread_key_struct __pthread_keys[PTHREAD_KEYS_MAX]
62   __attribute__ ((nocommon));
63 hidden_data_def (__pthread_keys)
64
65 /* This is for libthread_db only.  */
66 const int __pthread_pthread_sizeof_descr = sizeof (struct pthread);
67
68 struct pthread *
69 internal_function
70 __find_in_stack_list (pd)
71      struct pthread *pd;
72 {
73   list_t *entry;
74   struct pthread *result = NULL;
75
76   lll_lock (stack_cache_lock);
77
78   list_for_each (entry, &stack_used)
79     {
80       struct pthread *curp;
81
82       curp = list_entry (entry, struct pthread, list);
83       if (curp == pd)
84         {
85           result = curp;
86           break;
87         }
88     }
89
90   if (result == NULL)
91     list_for_each (entry, &__stack_user)
92       {
93         struct pthread *curp;
94
95         curp = list_entry (entry, struct pthread, list);
96         if (curp == pd)
97           {
98             result = curp;
99             break;
100           }
101       }
102
103   lll_unlock (stack_cache_lock);
104
105   return result;
106 }
107
108
109 /* Deallocate POSIX thread-local-storage.  */
110 static void
111 internal_function
112 deallocate_tsd (void)
113 {
114   struct pthread *self = THREAD_SELF;
115
116   /* Maybe no data was ever allocated.  This happens often so we have
117      a flag for this.  */
118   if (THREAD_GETMEM (self, specific_used))
119     {
120       size_t round;
121       size_t cnt;
122
123       round = 0;
124       do
125         {
126           size_t idx;
127
128           /* So far no new nonzero data entry.  */
129           THREAD_SETMEM (self, specific_used, false);
130
131           for (cnt = idx = 0; cnt < PTHREAD_KEY_1STLEVEL_SIZE; ++cnt)
132             {
133               struct pthread_key_data *level2;
134
135               level2 = THREAD_GETMEM_NC (self, specific, cnt);
136
137               if (level2 != NULL)
138                 {
139                   size_t inner;
140
141                   for (inner = 0; inner < PTHREAD_KEY_2NDLEVEL_SIZE;
142                        ++inner, ++idx)
143                     {
144                       void *data = level2[inner].data;
145
146                       if (data != NULL)
147                         {
148                           /* Always clear the data.  */
149                           level2[inner].data = NULL;
150
151                           /* Make sure the data corresponds to a valid
152                              key.  This test fails if the key was
153                              deallocated and also if it was
154                              re-allocated.  It is the user's
155                              responsibility to free the memory in this
156                              case.  */
157                           if (level2[inner].seq
158                               == __pthread_keys[idx].seq
159                               /* It is not necessary to register a destructor
160                                  function.  */
161                               && __pthread_keys[idx].destr != NULL)
162                             /* Call the user-provided destructor.  */
163                             __pthread_keys[idx].destr (data);
164                         }
165                     }
166                 }
167               else
168                 idx += PTHREAD_KEY_1STLEVEL_SIZE;
169             }
170
171           if (THREAD_GETMEM (self, specific_used) == 0)
172             /* No data has been modified.  */
173             goto just_free;
174         }
175       /* We only repeat the process a fixed number of times.  */
176       while (__builtin_expect (++round < PTHREAD_DESTRUCTOR_ITERATIONS, 0));
177
178       /* Just clear the memory of the first block for reuse.  */
179       memset (&THREAD_SELF->specific_1stblock, '\0',
180               sizeof (self->specific_1stblock));
181
182     just_free:
183       /* Free the memory for the other blocks.  */
184       for (cnt = 1; cnt < PTHREAD_KEY_1STLEVEL_SIZE; ++cnt)
185         {
186           struct pthread_key_data *level2;
187
188           level2 = THREAD_GETMEM_NC (self, specific, cnt);
189           if (level2 != NULL)
190             {
191               /* The first block is allocated as part of the thread
192                  descriptor.  */
193               free (level2);
194               THREAD_SETMEM_NC (self, specific, cnt, NULL);
195             }
196         }
197
198       THREAD_SETMEM (self, specific_used, false);
199     }
200 }
201
202
203 /* Deallocate a thread's stack after optionally making sure the thread
204    descriptor is still valid.  */
205 void
206 internal_function
207 __free_tcb (struct pthread *pd)
208 {
209   /* The thread is exiting now.  */
210   if (__builtin_expect (atomic_bit_test_set (&pd->cancelhandling,
211                                              TERMINATED_BIT) == 0, 1))
212     {
213       /* Remove the descriptor from the list.  */
214       if (DEBUGGING_P && __find_in_stack_list (pd) == NULL)
215         /* Something is really wrong.  The descriptor for a still
216            running thread is gone.  */
217         abort ();
218
219       /* Queue the stack memory block for reuse and exit the process.  The
220          kernel will signal via writing to the address returned by
221          QUEUE-STACK when the stack is available.  */
222       __deallocate_stack (pd);
223     }
224 }
225
226
227 static int
228 start_thread (void *arg)
229 {
230   /* One more thread.  */
231   atomic_increment (&__nptl_nthreads);
232
233   struct pthread *pd = (struct pthread *) arg;
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   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 /* Just list start_thread but we do some more things needed for a run
335    with a debugger attached.  */
336 static int
337 start_thread_debug (void *arg)
338 {
339   struct pthread *pd = (struct pthread *) arg;
340
341   /* Get the lock the parent locked to force synchronization.  */
342   lll_lock (pd->lock);
343   /* And give it up right away.  */
344   lll_unlock (pd->lock);
345
346   /* Now do the actual startup.  */
347   return start_thread (arg);
348 }
349
350
351 /* Default thread attributes for the case when the user does not
352    provide any.  */
353 static const struct pthread_attr default_attr =
354   {
355     /* Just some value > 0 which gets rounded to the nearest page size.  */
356     .guardsize = 1,
357   };
358
359
360 int
361 __pthread_create_2_1 (newthread, attr, start_routine, arg)
362      pthread_t *newthread;
363      const pthread_attr_t *attr;
364      void *(*start_routine) (void *);
365      void *arg;
366 {
367   STACK_VARIABLES;
368   const struct pthread_attr *iattr;
369   struct pthread *pd;
370   int err;
371
372   iattr = (struct pthread_attr *) attr;
373   if (iattr == NULL)
374     /* Is this the best idea?  On NUMA machines this could mean
375        accessing far-away memory.  */
376     iattr = &default_attr;
377
378   err = ALLOCATE_STACK (iattr, &pd);
379   if (__builtin_expect (err != 0, 0))
380     /* Something went wrong.  Maybe a parameter of the attributes is
381        invalid or we could not allocate memory.  */
382     return err;
383
384
385   /* Initialize the TCB.  All initializations with zero should be
386      performed in 'get_cached_stack'.  This way we avoid doing this if
387      the stack freshly allocated with 'mmap'.  */
388
389 #ifdef TLS_TCB_AT_TP
390   /* Reference to the TCB itself.  */
391   pd->header.self = pd;
392
393   /* Self-reference for TLS.  */
394   pd->header.tcb = pd;
395 #endif
396
397   /* Store the address of the start routine and the parameter.  Since
398      we do not start the function directly the stillborn thread will
399      get the information from its thread descriptor.  */
400   pd->start_routine = start_routine;
401   pd->arg = arg;
402
403   /* Copy the thread attribute flags.  */
404   pd->flags = iattr->flags;
405
406   /* Initialize the field for the ID of the thread which is waiting
407      for us.  This is a self-reference in case the thread is created
408      detached.  */
409   pd->joinid = iattr->flags & ATTR_FLAG_DETACHSTATE ? pd : NULL;
410
411   /* The debug events are inherited from the parent.  */
412   pd->eventbuf = THREAD_SELF->eventbuf;
413
414
415   /* Determine scheduling parameters for the thread.
416      XXX How to determine whether scheduling handling is needed?  */
417   if (0 && attr != NULL)
418     {
419       if (iattr->flags & ATTR_FLAG_NOTINHERITSCHED)
420         {
421           /* Use the scheduling parameters the user provided.  */
422           pd->schedpolicy = iattr->schedpolicy;
423           memcpy (&pd->schedparam, &iattr->schedparam,
424                   sizeof (struct sched_param));
425         }
426       else
427         {
428           /* Just store the scheduling attributes of the parent.  */
429           pd->schedpolicy = __sched_getscheduler (0);
430           __sched_getparam (0, &pd->schedparam);
431         }
432     }
433
434   /* Pass the descriptor to the caller.  */
435   *newthread = (pthread_t) pd;
436
437   /* Start the thread.  */
438   err = create_thread (pd, iattr, STACK_VARIABLES_ARGS);
439   if (err != 0)
440     {
441       /* Something went wrong.  Free the resources.  */
442       __deallocate_stack (pd);
443       return err;
444     }
445
446   return 0;
447 }
448 versioned_symbol (libpthread, __pthread_create_2_1, pthread_create, GLIBC_2_1);
449
450
451 #if SHLIB_COMPAT(libpthread, GLIBC_2_0, GLIBC_2_1)
452 int
453 __pthread_create_2_0 (newthread, attr, start_routine, arg)
454      pthread_t *newthread;
455      const pthread_attr_t *attr;
456      void *(*start_routine) (void *);
457      void *arg;
458 {
459   /* The ATTR attribute is not really of type `pthread_attr_t *'.  It has
460      the old size and access to the new members might crash the program.
461      We convert the struct now.  */
462   struct pthread_attr new_attr;
463
464   if (attr != NULL)
465     {
466       struct pthread_attr *iattr = (struct pthread_attr *) attr;
467       size_t ps = __getpagesize ();
468
469       /* Copy values from the user-provided attributes.  */
470       new_attr.schedparam = iattr->schedparam;
471       new_attr.schedpolicy = iattr->schedpolicy;
472       new_attr.flags = iattr->flags;
473
474       /* Fill in default values for the fields not present in the old
475          implementation.  */
476       new_attr.guardsize = ps;
477       new_attr.stackaddr = NULL;
478       new_attr.stacksize = 0;
479
480       /* We will pass this value on to the real implementation.  */
481       attr = (pthread_attr_t *) &new_attr;
482     }
483
484   return __pthread_create_2_1 (newthread, attr, start_routine, arg);
485 }
486 compat_symbol (libpthread, __pthread_create_2_0, pthread_create,
487                GLIBC_2_0);
488 #endif