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