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