Update copyright notices with scripts/update-copyrights.
[jlayton/glibc.git] / nptl / pthread_cancel.c
1 /* Copyright (C) 2002-2013 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, see
17    <http://www.gnu.org/licenses/>.  */
18
19 #include <errno.h>
20 #include <signal.h>
21 #include "pthreadP.h"
22 #include "atomic.h"
23 #include <sysdep.h>
24 #include <kernel-features.h>
25
26
27 int
28 pthread_cancel (th)
29      pthread_t th;
30 {
31   volatile struct pthread *pd = (volatile struct pthread *) th;
32
33   /* Make sure the descriptor is valid.  */
34   if (INVALID_TD_P (pd))
35     /* Not a valid thread handle.  */
36     return ESRCH;
37
38 #ifdef SHARED
39   pthread_cancel_init ();
40 #endif
41   int result = 0;
42   int oldval;
43   int newval;
44   do
45     {
46     again:
47       oldval = pd->cancelhandling;
48       newval = oldval | CANCELING_BITMASK | CANCELED_BITMASK;
49
50       /* Avoid doing unnecessary work.  The atomic operation can
51          potentially be expensive if the bug has to be locked and
52          remote cache lines have to be invalidated.  */
53       if (oldval == newval)
54         break;
55
56       /* If the cancellation is handled asynchronously just send a
57          signal.  We avoid this if possible since it's more
58          expensive.  */
59       if (CANCEL_ENABLED_AND_CANCELED_AND_ASYNCHRONOUS (newval))
60         {
61           /* Mark the cancellation as "in progress".  */
62           if (atomic_compare_and_exchange_bool_acq (&pd->cancelhandling,
63                                                     oldval | CANCELING_BITMASK,
64                                                     oldval))
65             goto again;
66
67           /* The cancellation handler will take care of marking the
68              thread as canceled.  */
69           INTERNAL_SYSCALL_DECL (err);
70
71           /* One comment: The PID field in the TCB can temporarily be
72              changed (in fork).  But this must not affect this code
73              here.  Since this function would have to be called while
74              the thread is executing fork, it would have to happen in
75              a signal handler.  But this is no allowed, pthread_cancel
76              is not guaranteed to be async-safe.  */
77           int val;
78           val = INTERNAL_SYSCALL (tgkill, err, 3,
79                                   THREAD_GETMEM (THREAD_SELF, pid), pd->tid,
80                                   SIGCANCEL);
81
82           if (INTERNAL_SYSCALL_ERROR_P (val, err))
83             result = INTERNAL_SYSCALL_ERRNO (val, err);
84
85           break;
86         }
87
88         /* A single-threaded process should be able to kill itself, since there is
89            nothing in the POSIX specification that says that it cannot.  So we set
90            multiple_threads to true so that cancellation points get executed.  */
91         THREAD_SETMEM (THREAD_SELF, header.multiple_threads, 1);
92 #ifndef TLS_MULTIPLE_THREADS_IN_TCB
93         __pthread_multiple_threads = *__libc_multiple_threads_ptr = 1;
94 #endif
95     }
96   /* Mark the thread as canceled.  This has to be done
97      atomically since other bits could be modified as well.  */
98   while (atomic_compare_and_exchange_bool_acq (&pd->cancelhandling, newval,
99                                                oldval));
100
101   return result;
102 }
103
104 PTHREAD_STATIC_FN_REQUIRE (pthread_create)