1 /*
2  * Copyright (c) 1995-1998 John Birrell <jb@cimlogic.com.au>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the author nor the names of any co-contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  * $FreeBSD: src/lib/libpthread/thread/thr_exit.c,v 1.39 2004/10/23 23:37:54 davidxu Exp $
30  */
31 
32 #include "namespace.h"
33 #include <machine/tls.h>
34 #include <errno.h>
35 #include <unistd.h>
36 #include <fcntl.h>
37 #include <stdarg.h>
38 #include <stdio.h>
39 #include <stdlib.h>
40 #include <string.h>
41 #include <pthread.h>
42 #include "un-namespace.h"
43 
44 #include "thr_private.h"
45 
46 static void	exit_thread(void) __dead2;
47 
48 void
49 _thread_exitf(const char *fname, int lineno, const char *fmt, ...)
50 {
51 	va_list ap;
52 
53 	/* Write an error message to the standard error file descriptor: */
54 	_thread_printf(STDERR_FILENO, "Fatal error '");
55 
56 	va_start(ap, fmt);
57 	_thread_vprintf(STDERR_FILENO, fmt, ap);
58 	va_end(ap);
59 
60 	_thread_printf(STDERR_FILENO, "' at line %d in file %s (errno = %d)\n",
61 	    lineno, fname, errno);
62 
63 	abort();
64 }
65 
66 void
67 _thread_exit(const char *fname, int lineno, const char *msg)
68 {
69 	_thread_exitf(fname, lineno, "%s", msg);
70 }
71 
72 /*
73  * Only called when a thread is cancelled.  It may be more useful
74  * to call it from pthread_exit() if other ways of asynchronous or
75  * abnormal thread termination can be found.
76  */
77 void
78 _thr_exit_cleanup(void)
79 {
80 	struct pthread	*curthread = tls_get_curthread();
81 
82 	/*
83 	 * POSIX states that cancellation/termination of a thread should
84 	 * not release any visible resources (such as mutexes) and that
85 	 * it is the applications responsibility.  Resources that are
86 	 * internal to the threads library, including file and fd locks,
87 	 * are not visible to the application and need to be released.
88 	 */
89 	/* Unlock all private mutexes: */
90 	_mutex_unlock_private(curthread);
91 
92 	/*
93 	 * This still isn't quite correct because we don't account
94 	 * for held spinlocks (see libc/stdlib/malloc.c).
95 	 */
96 }
97 
98 void
99 _pthread_exit(void *status)
100 {
101 	struct pthread *curthread = tls_get_curthread();
102 
103 	/* Check if this thread is already in the process of exiting: */
104 	if ((curthread->cancelflags & THR_CANCEL_EXITING) != 0) {
105 		PANIC("Thread %p has called "
106 		    "pthread_exit() from a destructor. POSIX 1003.1 "
107 		    "1996 s16.2.5.2 does not allow this!", curthread);
108 	}
109 
110 	/* Flag this thread as exiting. */
111 	atomic_set_int(&curthread->cancelflags, THR_CANCEL_EXITING);
112 
113 	_thr_exit_cleanup();
114 
115 	/* Save the return value: */
116 	curthread->ret = status;
117 	while (curthread->cleanup != NULL) {
118 		_pthread_cleanup_pop(1);
119 	}
120 
121 	exit_thread();
122 }
123 
124 __strong_reference(_pthread_exit, pthread_exit);
125 
126 static void
127 exit_thread(void)
128 {
129 	struct pthread *curthread = tls_get_curthread();
130 
131 	/* Check if there is thread specific data: */
132 	if (curthread->specific != NULL) {
133 		/* Run the thread-specific data destructors: */
134 		_thread_cleanupspecific();
135 	}
136 
137 	if (!_thr_isthreaded())
138 		exit(0);
139 
140 	THREAD_LIST_LOCK(curthread);
141 	_thread_active_threads--;
142 	if (_thread_active_threads == 0) {
143 		THREAD_LIST_UNLOCK(curthread);
144 		exit(0);
145 		/* Never reach! */
146 	}
147 	THR_LOCK(curthread);
148 	curthread->state = PS_DEAD;
149 	THR_UNLOCK(curthread);
150 	curthread->refcount--;
151 	if (curthread->tlflags & TLFLAGS_DETACHED)
152 		THR_GCLIST_ADD(curthread);
153 	THREAD_LIST_UNLOCK(curthread);
154 	if (curthread->joiner)
155 		_thr_umtx_wake(&curthread->state, 0);
156 	if (SHOULD_REPORT_EVENT(curthread, TD_DEATH))
157 		_thr_report_death(curthread);
158 	/* Exit and set terminated to once we're really dead. */
159 	extexit(EXTEXIT_SETINT|EXTEXIT_LWP, 1, &curthread->terminated);
160 	PANIC("thr_exit() returned");
161 	/* Never reach! */
162 }
163