xref: /freebsd/lib/libthr/thread/thr_exit.c (revision 39beb93c)
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$
30  */
31 
32 #include "namespace.h"
33 #include <errno.h>
34 #include <stdio.h>
35 #include <stdlib.h>
36 #include <pthread.h>
37 #include "un-namespace.h"
38 
39 #include "libc_private.h"
40 #include "thr_private.h"
41 
42 void	_pthread_exit(void *status);
43 
44 __weak_reference(_pthread_exit, pthread_exit);
45 
46 void
47 _thread_exit(const char *fname, int lineno, const char *msg)
48 {
49 
50 	/* Write an error message to the standard error file descriptor: */
51 	_thread_printf(2,
52 	    "Fatal error '%s' at line %d in file %s (errno = %d)\n",
53 	    msg, lineno, fname, errno);
54 
55 	abort();
56 }
57 
58 /*
59  * Only called when a thread is cancelled.  It may be more useful
60  * to call it from pthread_exit() if other ways of asynchronous or
61  * abnormal thread termination can be found.
62  */
63 void
64 _thr_exit_cleanup(void)
65 {
66 }
67 
68 void
69 _pthread_exit(void *status)
70 {
71 	struct pthread *curthread = _get_curthread();
72 
73 	/* Check if this thread is already in the process of exiting: */
74 	if (curthread->cancelling) {
75 		char msg[128];
76 		snprintf(msg, sizeof(msg), "Thread %p has called "
77 		    "pthread_exit() from a destructor. POSIX 1003.1 "
78 		    "1996 s16.2.5.2 does not allow this!", curthread);
79 		PANIC(msg);
80 	}
81 
82 	/* Flag this thread as exiting. */
83 	curthread->cancelling = 1;
84 
85 	_thr_exit_cleanup();
86 
87 	/* Save the return value: */
88 	curthread->ret = status;
89 	while (curthread->cleanup != NULL) {
90 		_pthread_cleanup_pop(1);
91 	}
92 
93 	/* Check if there is thread specific data: */
94 	if (curthread->specific != NULL) {
95 		/* Run the thread-specific data destructors: */
96 		_thread_cleanupspecific();
97 	}
98 
99 	if (!_thr_isthreaded())
100 		exit(0);
101 
102 	THREAD_LIST_LOCK(curthread);
103 	_thread_active_threads--;
104 	if (_thread_active_threads == 0) {
105 		THREAD_LIST_UNLOCK(curthread);
106 		exit(0);
107 		/* Never reach! */
108 	}
109 	THREAD_LIST_UNLOCK(curthread);
110 
111 	/* Tell malloc that the thread is exiting. */
112 	_malloc_thread_cleanup();
113 
114 	THREAD_LIST_LOCK(curthread);
115 	THR_LOCK(curthread);
116 	curthread->state = PS_DEAD;
117 	if (curthread->flags & THR_FLAGS_NEED_SUSPEND) {
118 		curthread->cycle++;
119 		_thr_umtx_wake(&curthread->cycle, INT_MAX, 0);
120 	}
121 	THR_UNLOCK(curthread);
122 	/*
123 	 * Thread was created with initial refcount 1, we drop the
124 	 * reference count to allow it to be garbage collected.
125 	 */
126 	curthread->refcount--;
127 	if (curthread->tlflags & TLFLAGS_DETACHED)
128 		THR_GCLIST_ADD(curthread);
129 	THREAD_LIST_UNLOCK(curthread);
130 	if (!curthread->force_exit && SHOULD_REPORT_EVENT(curthread, TD_DEATH))
131 		_thr_report_death(curthread);
132 
133 	/*
134 	 * Kernel will do wakeup at the address, so joiner thread
135 	 * will be resumed if it is sleeping at the address.
136 	 */
137 	thr_exit(&curthread->tid);
138 	PANIC("thr_exit() returned");
139 	/* Never reach! */
140 }
141