xref: /freebsd/sys/kern/kern_thread.c (revision 7b5190779b459031cc46fe9850c5cfb196c55ebe)
19454b2d8SWarner Losh /*-
244990b8cSJulian Elischer  * Copyright (C) 2001 Julian Elischer <julian@freebsd.org>.
344990b8cSJulian Elischer  *  All rights reserved.
444990b8cSJulian Elischer  *
544990b8cSJulian Elischer  * Redistribution and use in source and binary forms, with or without
644990b8cSJulian Elischer  * modification, are permitted provided that the following conditions
744990b8cSJulian Elischer  * are met:
844990b8cSJulian Elischer  * 1. Redistributions of source code must retain the above copyright
944990b8cSJulian Elischer  *    notice(s), this list of conditions and the following disclaimer as
1044990b8cSJulian Elischer  *    the first lines of this file unmodified other than the possible
1144990b8cSJulian Elischer  *    addition of one or more copyright notices.
1244990b8cSJulian Elischer  * 2. Redistributions in binary form must reproduce the above copyright
1344990b8cSJulian Elischer  *    notice(s), this list of conditions and the following disclaimer in the
1444990b8cSJulian Elischer  *    documentation and/or other materials provided with the distribution.
1544990b8cSJulian Elischer  *
1644990b8cSJulian Elischer  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
1744990b8cSJulian Elischer  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
1844990b8cSJulian Elischer  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
1944990b8cSJulian Elischer  * DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
2044990b8cSJulian Elischer  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
2144990b8cSJulian Elischer  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
2244990b8cSJulian Elischer  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
2344990b8cSJulian Elischer  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2444990b8cSJulian Elischer  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2544990b8cSJulian Elischer  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
2644990b8cSJulian Elischer  * DAMAGE.
2744990b8cSJulian Elischer  */
2844990b8cSJulian Elischer 
293d06b4b3SAttilio Rao #include "opt_witness.h"
3016d95d4fSJoseph Koshy #include "opt_hwpmc_hooks.h"
313d06b4b3SAttilio Rao 
32677b542eSDavid E. O'Brien #include <sys/cdefs.h>
33677b542eSDavid E. O'Brien __FBSDID("$FreeBSD$");
34677b542eSDavid E. O'Brien 
3544990b8cSJulian Elischer #include <sys/param.h>
3644990b8cSJulian Elischer #include <sys/systm.h>
3744990b8cSJulian Elischer #include <sys/kernel.h>
3844990b8cSJulian Elischer #include <sys/lock.h>
3944990b8cSJulian Elischer #include <sys/mutex.h>
4044990b8cSJulian Elischer #include <sys/proc.h>
41e170bfdaSDavid Xu #include <sys/resourcevar.h>
4294e0a4cdSJulian Elischer #include <sys/smp.h>
43de028f5aSJeff Roberson #include <sys/sched.h>
4444f3b092SJohn Baldwin #include <sys/sleepqueue.h>
45ace8398dSJeff Roberson #include <sys/selinfo.h>
46961a7b24SJohn Baldwin #include <sys/turnstile.h>
4744990b8cSJulian Elischer #include <sys/ktr.h>
48cf7d9a8cSDavid Xu #include <sys/rwlock.h>
49bc8e6d81SDavid Xu #include <sys/umtx.h>
50d7f687fcSJeff Roberson #include <sys/cpuset.h>
5116d95d4fSJoseph Koshy #ifdef	HWPMC_HOOKS
5216d95d4fSJoseph Koshy #include <sys/pmckern.h>
5316d95d4fSJoseph Koshy #endif
5444990b8cSJulian Elischer 
55911b84b0SRobert Watson #include <security/audit/audit.h>
56911b84b0SRobert Watson 
5744990b8cSJulian Elischer #include <vm/vm.h>
5849a2507bSAlan Cox #include <vm/vm_extern.h>
5944990b8cSJulian Elischer #include <vm/uma.h>
60b209f889SRandall Stewart #include <sys/eventhandler.h>
6102fb42b0SPeter Wemm 
628460a577SJohn Birrell /*
638460a577SJohn Birrell  * thread related storage.
648460a577SJohn Birrell  */
6544990b8cSJulian Elischer static uma_zone_t thread_zone;
6644990b8cSJulian Elischer 
675215b187SJeff Roberson TAILQ_HEAD(, thread) zombie_threads = TAILQ_HEAD_INITIALIZER(zombie_threads);
68c8790f5dSAttilio Rao static struct mtx zombie_lock;
69a54e85fdSJeff Roberson MTX_SYSINIT(zombie_lock, &zombie_lock, "zombie lock", MTX_SPIN);
7044990b8cSJulian Elischer 
71ff8fbcffSJeff Roberson static void thread_zombie(struct thread *);
72ff8fbcffSJeff Roberson 
73ec6ea5e8SDavid Xu #define TID_BUFFER_SIZE	1024
74ec6ea5e8SDavid Xu 
75fdcac928SMarcel Moolenaar struct mtx tid_lock;
761ea7a6f8SPoul-Henning Kamp static struct unrhdr *tid_unrhdr;
77ec6ea5e8SDavid Xu static lwpid_t tid_buffer[TID_BUFFER_SIZE];
78ec6ea5e8SDavid Xu static int tid_head, tid_tail;
79cf7d9a8cSDavid Xu static MALLOC_DEFINE(M_TIDHASH, "tidhash", "thread hash");
80cf7d9a8cSDavid Xu 
81cf7d9a8cSDavid Xu struct	tidhashhead *tidhashtbl;
82cf7d9a8cSDavid Xu u_long	tidhash;
83cf7d9a8cSDavid Xu struct	rwlock tidhash_lock;
84cf7d9a8cSDavid Xu 
85ec6ea5e8SDavid Xu static lwpid_t
86ec6ea5e8SDavid Xu tid_alloc(void)
87ec6ea5e8SDavid Xu {
88ec6ea5e8SDavid Xu 	lwpid_t	tid;
89ec6ea5e8SDavid Xu 
90ec6ea5e8SDavid Xu 	tid = alloc_unr(tid_unrhdr);
91ec6ea5e8SDavid Xu 	if (tid != -1)
92ec6ea5e8SDavid Xu 		return (tid);
93ec6ea5e8SDavid Xu 	mtx_lock(&tid_lock);
94ec6ea5e8SDavid Xu 	if (tid_head == tid_tail) {
95ec6ea5e8SDavid Xu 		mtx_unlock(&tid_lock);
96ec6ea5e8SDavid Xu 		return (-1);
97ec6ea5e8SDavid Xu 	}
98ec6ea5e8SDavid Xu 	tid = tid_buffer[tid_head++];
99ec6ea5e8SDavid Xu 	tid_head %= TID_BUFFER_SIZE;
100ec6ea5e8SDavid Xu 	mtx_unlock(&tid_lock);
101ec6ea5e8SDavid Xu 	return (tid);
102ec6ea5e8SDavid Xu }
103ec6ea5e8SDavid Xu 
104ec6ea5e8SDavid Xu static void
105ec6ea5e8SDavid Xu tid_free(lwpid_t tid)
106ec6ea5e8SDavid Xu {
107ec6ea5e8SDavid Xu 	lwpid_t tmp_tid = -1;
108ec6ea5e8SDavid Xu 
109ec6ea5e8SDavid Xu 	mtx_lock(&tid_lock);
110ec6ea5e8SDavid Xu 	if ((tid_tail + 1) % TID_BUFFER_SIZE == tid_head) {
111ec6ea5e8SDavid Xu 		tmp_tid = tid_buffer[tid_head++];
112ec6ea5e8SDavid Xu 		tid_head = (tid_head + 1) % TID_BUFFER_SIZE;
113ec6ea5e8SDavid Xu 	}
114ec6ea5e8SDavid Xu 	tid_buffer[tid_tail++] = tid;
115ec6ea5e8SDavid Xu 	tid_tail %= TID_BUFFER_SIZE;
116ec6ea5e8SDavid Xu 	mtx_unlock(&tid_lock);
117ec6ea5e8SDavid Xu 	if (tmp_tid != -1)
118ec6ea5e8SDavid Xu 		free_unr(tid_unrhdr, tmp_tid);
119ec6ea5e8SDavid Xu }
120ec6ea5e8SDavid Xu 
121fdcac928SMarcel Moolenaar /*
122696058c3SJulian Elischer  * Prepare a thread for use.
12344990b8cSJulian Elischer  */
124b23f72e9SBrian Feldman static int
125b23f72e9SBrian Feldman thread_ctor(void *mem, int size, void *arg, int flags)
12644990b8cSJulian Elischer {
12744990b8cSJulian Elischer 	struct thread	*td;
12844990b8cSJulian Elischer 
12944990b8cSJulian Elischer 	td = (struct thread *)mem;
13071fad9fdSJulian Elischer 	td->td_state = TDS_INACTIVE;
131060563ecSJulian Elischer 	td->td_oncpu = NOCPU;
1326c27c603SJuli Mallett 
133ec6ea5e8SDavid Xu 	td->td_tid = tid_alloc();
134773eff9dSPoul-Henning Kamp 
1356c27c603SJuli Mallett 	/*
1366c27c603SJuli Mallett 	 * Note that td_critnest begins life as 1 because the thread is not
1376c27c603SJuli Mallett 	 * running and is thereby implicitly waiting to be on the receiving
138a54e85fdSJeff Roberson 	 * end of a context switch.
1396c27c603SJuli Mallett 	 */
140139b7550SJohn Baldwin 	td->td_critnest = 1;
141acbe332aSDavid Xu 	td->td_lend_user_pri = PRI_MAX;
142b209f889SRandall Stewart 	EVENTHANDLER_INVOKE(thread_ctor, td);
143911b84b0SRobert Watson #ifdef AUDIT
144911b84b0SRobert Watson 	audit_thread_alloc(td);
145911b84b0SRobert Watson #endif
146d10183d9SDavid Xu 	umtx_thread_alloc(td);
147b23f72e9SBrian Feldman 	return (0);
14844990b8cSJulian Elischer }
14944990b8cSJulian Elischer 
15044990b8cSJulian Elischer /*
15144990b8cSJulian Elischer  * Reclaim a thread after use.
15244990b8cSJulian Elischer  */
15344990b8cSJulian Elischer static void
15444990b8cSJulian Elischer thread_dtor(void *mem, int size, void *arg)
15544990b8cSJulian Elischer {
15644990b8cSJulian Elischer 	struct thread *td;
15744990b8cSJulian Elischer 
15844990b8cSJulian Elischer 	td = (struct thread *)mem;
15944990b8cSJulian Elischer 
16044990b8cSJulian Elischer #ifdef INVARIANTS
16144990b8cSJulian Elischer 	/* Verify that this thread is in a safe state to free. */
16244990b8cSJulian Elischer 	switch (td->td_state) {
16371fad9fdSJulian Elischer 	case TDS_INHIBITED:
16471fad9fdSJulian Elischer 	case TDS_RUNNING:
16571fad9fdSJulian Elischer 	case TDS_CAN_RUN:
16644990b8cSJulian Elischer 	case TDS_RUNQ:
16744990b8cSJulian Elischer 		/*
16844990b8cSJulian Elischer 		 * We must never unlink a thread that is in one of
16944990b8cSJulian Elischer 		 * these states, because it is currently active.
17044990b8cSJulian Elischer 		 */
17144990b8cSJulian Elischer 		panic("bad state for thread unlinking");
17244990b8cSJulian Elischer 		/* NOTREACHED */
17371fad9fdSJulian Elischer 	case TDS_INACTIVE:
17444990b8cSJulian Elischer 		break;
17544990b8cSJulian Elischer 	default:
17644990b8cSJulian Elischer 		panic("bad thread state");
17744990b8cSJulian Elischer 		/* NOTREACHED */
17844990b8cSJulian Elischer 	}
17944990b8cSJulian Elischer #endif
1806e8525ceSRobert Watson #ifdef AUDIT
1816e8525ceSRobert Watson 	audit_thread_free(td);
1826e8525ceSRobert Watson #endif
1831ba4a712SPawel Jakub Dawidek 	/* Free all OSD associated to this thread. */
1841ba4a712SPawel Jakub Dawidek 	osd_thread_exit(td);
1851ba4a712SPawel Jakub Dawidek 
186b209f889SRandall Stewart 	EVENTHANDLER_INVOKE(thread_dtor, td);
187ec6ea5e8SDavid Xu 	tid_free(td->td_tid);
18844990b8cSJulian Elischer }
18944990b8cSJulian Elischer 
19044990b8cSJulian Elischer /*
19144990b8cSJulian Elischer  * Initialize type-stable parts of a thread (when newly created).
19244990b8cSJulian Elischer  */
193b23f72e9SBrian Feldman static int
194b23f72e9SBrian Feldman thread_init(void *mem, int size, int flags)
19544990b8cSJulian Elischer {
19644990b8cSJulian Elischer 	struct thread *td;
19744990b8cSJulian Elischer 
19844990b8cSJulian Elischer 	td = (struct thread *)mem;
199247aba24SMarcel Moolenaar 
20044f3b092SJohn Baldwin 	td->td_sleepqueue = sleepq_alloc();
201961a7b24SJohn Baldwin 	td->td_turnstile = turnstile_alloc();
202b209f889SRandall Stewart 	EVENTHANDLER_INVOKE(thread_init, td);
203de028f5aSJeff Roberson 	td->td_sched = (struct td_sched *)&td[1];
204d10183d9SDavid Xu 	umtx_thread_init(td);
20589b57fcfSKonstantin Belousov 	td->td_kstack = 0;
206b23f72e9SBrian Feldman 	return (0);
20744990b8cSJulian Elischer }
20844990b8cSJulian Elischer 
20944990b8cSJulian Elischer /*
21044990b8cSJulian Elischer  * Tear down type-stable parts of a thread (just before being discarded).
21144990b8cSJulian Elischer  */
21244990b8cSJulian Elischer static void
21344990b8cSJulian Elischer thread_fini(void *mem, int size)
21444990b8cSJulian Elischer {
21544990b8cSJulian Elischer 	struct thread *td;
21644990b8cSJulian Elischer 
21744990b8cSJulian Elischer 	td = (struct thread *)mem;
218b209f889SRandall Stewart 	EVENTHANDLER_INVOKE(thread_fini, td);
219961a7b24SJohn Baldwin 	turnstile_free(td->td_turnstile);
22044f3b092SJohn Baldwin 	sleepq_free(td->td_sleepqueue);
221d10183d9SDavid Xu 	umtx_thread_fini(td);
222ace8398dSJeff Roberson 	seltdfini(td);
22344990b8cSJulian Elischer }
2245215b187SJeff Roberson 
2255c8329edSJulian Elischer /*
2265215b187SJeff Roberson  * For a newly created process,
2275215b187SJeff Roberson  * link up all the structures and its initial threads etc.
228ed062c8dSJulian Elischer  * called from:
229ed062c8dSJulian Elischer  * {arch}/{arch}/machdep.c   ia64_init(), init386() etc.
230ed062c8dSJulian Elischer  * proc_dtor() (should go away)
231ed062c8dSJulian Elischer  * proc_init()
2325c8329edSJulian Elischer  */
2335c8329edSJulian Elischer void
23489b57fcfSKonstantin Belousov proc_linkup0(struct proc *p, struct thread *td)
23589b57fcfSKonstantin Belousov {
23689b57fcfSKonstantin Belousov 	TAILQ_INIT(&p->p_threads);	     /* all threads in proc */
23789b57fcfSKonstantin Belousov 	proc_linkup(p, td);
23889b57fcfSKonstantin Belousov }
23989b57fcfSKonstantin Belousov 
24089b57fcfSKonstantin Belousov void
2418460a577SJohn Birrell proc_linkup(struct proc *p, struct thread *td)
2425c8329edSJulian Elischer {
243a54e85fdSJeff Roberson 
2449104847fSDavid Xu 	sigqueue_init(&p->p_sigqueue, p);
245ebceaf6dSDavid Xu 	p->p_ksi = ksiginfo_alloc(1);
246ebceaf6dSDavid Xu 	if (p->p_ksi != NULL) {
2475c474517SDavid Xu 		/* XXX p_ksi may be null if ksiginfo zone is not ready */
248ebceaf6dSDavid Xu 		p->p_ksi->ksi_flags = KSI_EXT | KSI_INS;
249ebceaf6dSDavid Xu 	}
250b2f92ef9SDavid Xu 	LIST_INIT(&p->p_mqnotifier);
2515c8329edSJulian Elischer 	p->p_numthreads = 0;
2528460a577SJohn Birrell 	thread_link(td, p);
2535c8329edSJulian Elischer }
2545c8329edSJulian Elischer 
2555c8329edSJulian Elischer /*
25644990b8cSJulian Elischer  * Initialize global thread allocation resources.
25744990b8cSJulian Elischer  */
25844990b8cSJulian Elischer void
25944990b8cSJulian Elischer threadinit(void)
26044990b8cSJulian Elischer {
26144990b8cSJulian Elischer 
2621ea7a6f8SPoul-Henning Kamp 	mtx_init(&tid_lock, "TID lock", NULL, MTX_DEF);
2636829a5c5SJulian Elischer 	/* leave one number for thread0 */
2646829a5c5SJulian Elischer 	tid_unrhdr = new_unrhdr(PID_MAX + 2, INT_MAX, &tid_lock);
2651ea7a6f8SPoul-Henning Kamp 
266de028f5aSJeff Roberson 	thread_zone = uma_zcreate("THREAD", sched_sizeof_thread(),
26744990b8cSJulian Elischer 	    thread_ctor, thread_dtor, thread_init, thread_fini,
2684649e92bSJohn Baldwin 	    16 - 1, 0);
269cf7d9a8cSDavid Xu 	tidhashtbl = hashinit(maxproc / 2, M_TIDHASH, &tidhash);
270cf7d9a8cSDavid Xu 	rw_init(&tidhash_lock, "tidhash");
27144990b8cSJulian Elischer }
27244990b8cSJulian Elischer 
27344990b8cSJulian Elischer /*
274ff8fbcffSJeff Roberson  * Place an unused thread on the zombie list.
275ad1e7d28SJulian Elischer  * Use the slpq as that must be unused by now.
27644990b8cSJulian Elischer  */
27744990b8cSJulian Elischer void
278ff8fbcffSJeff Roberson thread_zombie(struct thread *td)
27944990b8cSJulian Elischer {
280a54e85fdSJeff Roberson 	mtx_lock_spin(&zombie_lock);
281ad1e7d28SJulian Elischer 	TAILQ_INSERT_HEAD(&zombie_threads, td, td_slpq);
282a54e85fdSJeff Roberson 	mtx_unlock_spin(&zombie_lock);
28344990b8cSJulian Elischer }
28444990b8cSJulian Elischer 
2855c8329edSJulian Elischer /*
286ff8fbcffSJeff Roberson  * Release a thread that has exited after cpu_throw().
287ff8fbcffSJeff Roberson  */
288ff8fbcffSJeff Roberson void
289ff8fbcffSJeff Roberson thread_stash(struct thread *td)
290ff8fbcffSJeff Roberson {
291ff8fbcffSJeff Roberson 	atomic_subtract_rel_int(&td->td_proc->p_exitthreads, 1);
292ff8fbcffSJeff Roberson 	thread_zombie(td);
293ff8fbcffSJeff Roberson }
294ff8fbcffSJeff Roberson 
295ff8fbcffSJeff Roberson /*
2966617724cSJeff Roberson  * Reap zombie resources.
29744990b8cSJulian Elischer  */
29844990b8cSJulian Elischer void
29944990b8cSJulian Elischer thread_reap(void)
30044990b8cSJulian Elischer {
3015c8329edSJulian Elischer 	struct thread *td_first, *td_next;
30244990b8cSJulian Elischer 
30344990b8cSJulian Elischer 	/*
3045215b187SJeff Roberson 	 * Don't even bother to lock if none at this instant,
3055215b187SJeff Roberson 	 * we really don't care about the next instant..
30644990b8cSJulian Elischer 	 */
3078460a577SJohn Birrell 	if (!TAILQ_EMPTY(&zombie_threads)) {
308a54e85fdSJeff Roberson 		mtx_lock_spin(&zombie_lock);
3095c8329edSJulian Elischer 		td_first = TAILQ_FIRST(&zombie_threads);
3105c8329edSJulian Elischer 		if (td_first)
3115c8329edSJulian Elischer 			TAILQ_INIT(&zombie_threads);
312a54e85fdSJeff Roberson 		mtx_unlock_spin(&zombie_lock);
3135c8329edSJulian Elischer 		while (td_first) {
314ad1e7d28SJulian Elischer 			td_next = TAILQ_NEXT(td_first, td_slpq);
3155215b187SJeff Roberson 			if (td_first->td_ucred)
3165215b187SJeff Roberson 				crfree(td_first->td_ucred);
3175c8329edSJulian Elischer 			thread_free(td_first);
3185c8329edSJulian Elischer 			td_first = td_next;
31944990b8cSJulian Elischer 		}
32044990b8cSJulian Elischer 	}
321ed062c8dSJulian Elischer }
32244990b8cSJulian Elischer 
3234f0db5e0SJulian Elischer /*
32444990b8cSJulian Elischer  * Allocate a thread.
32544990b8cSJulian Elischer  */
32644990b8cSJulian Elischer struct thread *
3278a945d10SKonstantin Belousov thread_alloc(int pages)
32844990b8cSJulian Elischer {
32989b57fcfSKonstantin Belousov 	struct thread *td;
3308460a577SJohn Birrell 
33144990b8cSJulian Elischer 	thread_reap(); /* check if any zombies to get */
33289b57fcfSKonstantin Belousov 
33389b57fcfSKonstantin Belousov 	td = (struct thread *)uma_zalloc(thread_zone, M_WAITOK);
33489b57fcfSKonstantin Belousov 	KASSERT(td->td_kstack == 0, ("thread_alloc got thread with kstack"));
3358a945d10SKonstantin Belousov 	if (!vm_thread_new(td, pages)) {
33689b57fcfSKonstantin Belousov 		uma_zfree(thread_zone, td);
33789b57fcfSKonstantin Belousov 		return (NULL);
33889b57fcfSKonstantin Belousov 	}
3390c3967e7SMarcel Moolenaar 	cpu_thread_alloc(td);
34089b57fcfSKonstantin Belousov 	return (td);
34144990b8cSJulian Elischer }
34244990b8cSJulian Elischer 
3438a945d10SKonstantin Belousov int
3448a945d10SKonstantin Belousov thread_alloc_stack(struct thread *td, int pages)
3458a945d10SKonstantin Belousov {
3468a945d10SKonstantin Belousov 
3478a945d10SKonstantin Belousov 	KASSERT(td->td_kstack == 0,
3488a945d10SKonstantin Belousov 	    ("thread_alloc_stack called on a thread with kstack"));
3498a945d10SKonstantin Belousov 	if (!vm_thread_new(td, pages))
3508a945d10SKonstantin Belousov 		return (0);
3518a945d10SKonstantin Belousov 	cpu_thread_alloc(td);
3528a945d10SKonstantin Belousov 	return (1);
3538a945d10SKonstantin Belousov }
3544f0db5e0SJulian Elischer 
3554f0db5e0SJulian Elischer /*
35644990b8cSJulian Elischer  * Deallocate a thread.
35744990b8cSJulian Elischer  */
35844990b8cSJulian Elischer void
35944990b8cSJulian Elischer thread_free(struct thread *td)
36044990b8cSJulian Elischer {
3612e6b8de4SJeff Roberson 
3622e6b8de4SJeff Roberson 	lock_profile_thread_exit(td);
36345aea8deSJeff Roberson 	if (td->td_cpuset)
364d7f687fcSJeff Roberson 		cpuset_rel(td->td_cpuset);
365d7f687fcSJeff Roberson 	td->td_cpuset = NULL;
3660c3967e7SMarcel Moolenaar 	cpu_thread_free(td);
36789b57fcfSKonstantin Belousov 	if (td->td_kstack != 0)
36889b57fcfSKonstantin Belousov 		vm_thread_dispose(td);
36944990b8cSJulian Elischer 	uma_zfree(thread_zone, td);
37044990b8cSJulian Elischer }
37144990b8cSJulian Elischer 
37244990b8cSJulian Elischer /*
37344990b8cSJulian Elischer  * Discard the current thread and exit from its context.
37494e0a4cdSJulian Elischer  * Always called with scheduler locked.
37544990b8cSJulian Elischer  *
37644990b8cSJulian Elischer  * Because we can't free a thread while we're operating under its context,
377696058c3SJulian Elischer  * push the current thread into our CPU's deadthread holder. This means
378696058c3SJulian Elischer  * we needn't worry about someone else grabbing our context before we
3796617724cSJeff Roberson  * do a cpu_throw().
38044990b8cSJulian Elischer  */
38144990b8cSJulian Elischer void
38244990b8cSJulian Elischer thread_exit(void)
38344990b8cSJulian Elischer {
384e170bfdaSDavid Xu 	uint64_t new_switchtime;
38544990b8cSJulian Elischer 	struct thread *td;
3861c4bcd05SJeff Roberson 	struct thread *td2;
38744990b8cSJulian Elischer 	struct proc *p;
3887847a9daSJohn Baldwin 	int wakeup_swapper;
38944990b8cSJulian Elischer 
39044990b8cSJulian Elischer 	td = curthread;
39144990b8cSJulian Elischer 	p = td->td_proc;
39244990b8cSJulian Elischer 
393a54e85fdSJeff Roberson 	PROC_SLOCK_ASSERT(p, MA_OWNED);
394ed062c8dSJulian Elischer 	mtx_assert(&Giant, MA_NOTOWNED);
395a54e85fdSJeff Roberson 
39644990b8cSJulian Elischer 	PROC_LOCK_ASSERT(p, MA_OWNED);
397ed062c8dSJulian Elischer 	KASSERT(p != NULL, ("thread exiting without a process"));
398cc701b73SRobert Watson 	CTR3(KTR_PROC, "thread_exit: thread %p (pid %ld, %s)", td,
399e01eafefSJulian Elischer 	    (long)p->p_pid, td->td_name);
4009104847fSDavid Xu 	KASSERT(TAILQ_EMPTY(&td->td_sigqueue.sq_list), ("signal pending"));
40144990b8cSJulian Elischer 
40289964dd2SRobert Watson #ifdef AUDIT
40389964dd2SRobert Watson 	AUDIT_SYSCALL_EXIT(0, td);
40489964dd2SRobert Watson #endif
405d10183d9SDavid Xu 	umtx_thread_exit(td);
406ed062c8dSJulian Elischer 	/*
407ed062c8dSJulian Elischer 	 * drop FPU & debug register state storage, or any other
408ed062c8dSJulian Elischer 	 * architecture specific resources that
409ed062c8dSJulian Elischer 	 * would not be on a new untouched process.
410ed062c8dSJulian Elischer 	 */
41144990b8cSJulian Elischer 	cpu_thread_exit(td);	/* XXXSMP */
41244990b8cSJulian Elischer 
413e170bfdaSDavid Xu 	/* Do the same timestamp bookkeeping that mi_switch() would do. */
414e170bfdaSDavid Xu 	new_switchtime = cpu_ticks();
415e170bfdaSDavid Xu 	p->p_rux.rux_runtime += (new_switchtime - PCPU_GET(switchtime));
416e170bfdaSDavid Xu 	PCPU_SET(switchtime, new_switchtime);
417e170bfdaSDavid Xu 	PCPU_SET(switchticks, ticks);
418b4b70819SAttilio Rao 	PCPU_INC(cnt.v_swtch);
419a140976eSAttilio Rao 	/* Save our resource usage in our process. */
420a140976eSAttilio Rao 	td->td_ru.ru_nvcsw++;
421a140976eSAttilio Rao 	rucollect(&p->p_ru, &td->td_ru);
422ed062c8dSJulian Elischer 	/*
4231faf202eSJulian Elischer 	 * The last thread is left attached to the process
4241faf202eSJulian Elischer 	 * So that the whole bundle gets recycled. Skip
425ed062c8dSJulian Elischer 	 * all this stuff if we never had threads.
426ed062c8dSJulian Elischer 	 * EXIT clears all sign of other threads when
427ed062c8dSJulian Elischer 	 * it goes to single threading, so the last thread always
428ed062c8dSJulian Elischer 	 * takes the short path.
4291faf202eSJulian Elischer 	 */
430ed062c8dSJulian Elischer 	if (p->p_flag & P_HADTHREADS) {
4311faf202eSJulian Elischer 		if (p->p_numthreads > 1) {
432d3a0bd78SJulian Elischer 			thread_unlink(td);
4331c4bcd05SJeff Roberson 			td2 = FIRST_THREAD_IN_PROC(p);
4341c4bcd05SJeff Roberson 			sched_exit_thread(td2, td);
435ed062c8dSJulian Elischer 
436ed062c8dSJulian Elischer 			/*
43744990b8cSJulian Elischer 			 * The test below is NOT true if we are the
4389182554aSKonstantin Belousov 			 * sole exiting thread. P_STOPPED_SINGLE is unset
43944990b8cSJulian Elischer 			 * in exit1() after it is the only survivor.
44044990b8cSJulian Elischer 			 */
4411279572aSDavid Xu 			if (P_SHOULDSTOP(p) == P_STOPPED_SINGLE) {
44244990b8cSJulian Elischer 				if (p->p_numthreads == p->p_suspcount) {
443a54e85fdSJeff Roberson 					thread_lock(p->p_singlethread);
4447847a9daSJohn Baldwin 					wakeup_swapper = thread_unsuspend_one(
4457847a9daSJohn Baldwin 						p->p_singlethread);
446a54e85fdSJeff Roberson 					thread_unlock(p->p_singlethread);
4477847a9daSJohn Baldwin 					if (wakeup_swapper)
4487847a9daSJohn Baldwin 						kick_proc0();
44944990b8cSJulian Elischer 				}
45044990b8cSJulian Elischer 			}
45148bfcdddSJulian Elischer 
452ff8fbcffSJeff Roberson 			atomic_add_int(&td->td_proc->p_exitthreads, 1);
453696058c3SJulian Elischer 			PCPU_SET(deadthread, td);
4541faf202eSJulian Elischer 		} else {
455ed062c8dSJulian Elischer 			/*
456ed062c8dSJulian Elischer 			 * The last thread is exiting.. but not through exit()
457ed062c8dSJulian Elischer 			 */
458ed062c8dSJulian Elischer 			panic ("thread_exit: Last thread exiting on its own");
459ed062c8dSJulian Elischer 		}
4601faf202eSJulian Elischer 	}
46116d95d4fSJoseph Koshy #ifdef	HWPMC_HOOKS
46216d95d4fSJoseph Koshy 	/*
46316d95d4fSJoseph Koshy 	 * If this thread is part of a process that is being tracked by hwpmc(4),
46416d95d4fSJoseph Koshy 	 * inform the module of the thread's impending exit.
46516d95d4fSJoseph Koshy 	 */
46616d95d4fSJoseph Koshy 	if (PMC_PROC_IS_USING_PMCS(td->td_proc))
46716d95d4fSJoseph Koshy 		PMC_SWITCH_CONTEXT(td, PMC_FN_CSW_OUT);
46816d95d4fSJoseph Koshy #endif
469a54e85fdSJeff Roberson 	PROC_UNLOCK(p);
47041fd9c63SKonstantin Belousov 	ruxagg(p, td);
471a54e85fdSJeff Roberson 	thread_lock(td);
472a54e85fdSJeff Roberson 	PROC_SUNLOCK(p);
473dcc9954eSJulian Elischer 	td->td_state = TDS_INACTIVE;
4743d06b4b3SAttilio Rao #ifdef WITNESS
4753d06b4b3SAttilio Rao 	witness_thread_exit(td);
4763d06b4b3SAttilio Rao #endif
477732d9528SJulian Elischer 	CTR1(KTR_PROC, "thread_exit: cpu_throw() thread %p", td);
478a54e85fdSJeff Roberson 	sched_throw(td);
479cc66ebe2SPeter Wemm 	panic("I'm a teapot!");
48044990b8cSJulian Elischer 	/* NOTREACHED */
48144990b8cSJulian Elischer }
48244990b8cSJulian Elischer 
48344990b8cSJulian Elischer /*
484696058c3SJulian Elischer  * Do any thread specific cleanups that may be needed in wait()
48537814395SPeter Wemm  * called with Giant, proc and schedlock not held.
486696058c3SJulian Elischer  */
487696058c3SJulian Elischer void
488696058c3SJulian Elischer thread_wait(struct proc *p)
489696058c3SJulian Elischer {
490696058c3SJulian Elischer 	struct thread *td;
491696058c3SJulian Elischer 
49237814395SPeter Wemm 	mtx_assert(&Giant, MA_NOTOWNED);
49385495c72SJens Schweikhardt 	KASSERT((p->p_numthreads == 1), ("Multiple threads in wait1()"));
494ff8fbcffSJeff Roberson 	td = FIRST_THREAD_IN_PROC(p);
495ff8fbcffSJeff Roberson 	/* Lock the last thread so we spin until it exits cpu_throw(). */
496ff8fbcffSJeff Roberson 	thread_lock(td);
497ff8fbcffSJeff Roberson 	thread_unlock(td);
498ff8fbcffSJeff Roberson 	/* Wait for any remaining threads to exit cpu_throw(). */
499ff8fbcffSJeff Roberson 	while (p->p_exitthreads)
500ff8fbcffSJeff Roberson 		sched_relinquish(curthread);
5012e6b8de4SJeff Roberson 	lock_profile_thread_exit(td);
502d7f687fcSJeff Roberson 	cpuset_rel(td->td_cpuset);
503d7f687fcSJeff Roberson 	td->td_cpuset = NULL;
504696058c3SJulian Elischer 	cpu_thread_clean(td);
505ed062c8dSJulian Elischer 	crfree(td->td_ucred);
506696058c3SJulian Elischer 	thread_reap();	/* check for zombie threads etc. */
507696058c3SJulian Elischer }
508696058c3SJulian Elischer 
509696058c3SJulian Elischer /*
51044990b8cSJulian Elischer  * Link a thread to a process.
5111faf202eSJulian Elischer  * set up anything that needs to be initialized for it to
5121faf202eSJulian Elischer  * be used by the process.
51344990b8cSJulian Elischer  */
51444990b8cSJulian Elischer void
5158460a577SJohn Birrell thread_link(struct thread *td, struct proc *p)
51644990b8cSJulian Elischer {
51744990b8cSJulian Elischer 
518a54e85fdSJeff Roberson 	/*
519a54e85fdSJeff Roberson 	 * XXX This can't be enabled because it's called for proc0 before
520374ae2a3SJeff Roberson 	 * its lock has been created.
521374ae2a3SJeff Roberson 	 * PROC_LOCK_ASSERT(p, MA_OWNED);
522a54e85fdSJeff Roberson 	 */
52371fad9fdSJulian Elischer 	td->td_state    = TDS_INACTIVE;
52444990b8cSJulian Elischer 	td->td_proc     = p;
525b61ce5b0SJeff Roberson 	td->td_flags    = TDF_INMEM;
52644990b8cSJulian Elischer 
5271faf202eSJulian Elischer 	LIST_INIT(&td->td_contested);
528eea4f254SJeff Roberson 	LIST_INIT(&td->td_lprof[0]);
529eea4f254SJeff Roberson 	LIST_INIT(&td->td_lprof[1]);
5309104847fSDavid Xu 	sigqueue_init(&td->td_sigqueue, p);
531c06eb4e2SSam Leffler 	callout_init(&td->td_slpcallout, CALLOUT_MPSAFE);
53244990b8cSJulian Elischer 	TAILQ_INSERT_HEAD(&p->p_threads, td, td_plist);
53344990b8cSJulian Elischer 	p->p_numthreads++;
53444990b8cSJulian Elischer }
53544990b8cSJulian Elischer 
536ed062c8dSJulian Elischer /*
537e5bedcefSJulian Elischer  * Convert a process with one thread to an unthreaded process.
538e5bedcefSJulian Elischer  */
539e5bedcefSJulian Elischer void
540e5bedcefSJulian Elischer thread_unthread(struct thread *td)
541e5bedcefSJulian Elischer {
542e5bedcefSJulian Elischer 	struct proc *p = td->td_proc;
543e5bedcefSJulian Elischer 
544e5bedcefSJulian Elischer 	KASSERT((p->p_numthreads == 1), ("Unthreading with >1 threads"));
5458460a577SJohn Birrell 	p->p_flag &= ~P_HADTHREADS;
546e5bedcefSJulian Elischer }
547e5bedcefSJulian Elischer 
548e5bedcefSJulian Elischer /*
549ed062c8dSJulian Elischer  * Called from:
550ed062c8dSJulian Elischer  *  thread_exit()
551ed062c8dSJulian Elischer  */
552d3a0bd78SJulian Elischer void
553d3a0bd78SJulian Elischer thread_unlink(struct thread *td)
554d3a0bd78SJulian Elischer {
555d3a0bd78SJulian Elischer 	struct proc *p = td->td_proc;
556d3a0bd78SJulian Elischer 
557374ae2a3SJeff Roberson 	PROC_LOCK_ASSERT(p, MA_OWNED);
558d3a0bd78SJulian Elischer 	TAILQ_REMOVE(&p->p_threads, td, td_plist);
559d3a0bd78SJulian Elischer 	p->p_numthreads--;
560d3a0bd78SJulian Elischer 	/* could clear a few other things here */
5618460a577SJohn Birrell 	/* Must  NOT clear links to proc! */
5625c8329edSJulian Elischer }
5635c8329edSJulian Elischer 
56479799053SKonstantin Belousov static int
56579799053SKonstantin Belousov calc_remaining(struct proc *p, int mode)
56679799053SKonstantin Belousov {
56779799053SKonstantin Belousov 	int remaining;
56879799053SKonstantin Belousov 
569*7b519077SKonstantin Belousov 	PROC_LOCK_ASSERT(p, MA_OWNED);
570*7b519077SKonstantin Belousov 	PROC_SLOCK_ASSERT(p, MA_OWNED);
57179799053SKonstantin Belousov 	if (mode == SINGLE_EXIT)
57279799053SKonstantin Belousov 		remaining = p->p_numthreads;
57379799053SKonstantin Belousov 	else if (mode == SINGLE_BOUNDARY)
57479799053SKonstantin Belousov 		remaining = p->p_numthreads - p->p_boundary_count;
57579799053SKonstantin Belousov 	else if (mode == SINGLE_NO_EXIT)
57679799053SKonstantin Belousov 		remaining = p->p_numthreads - p->p_suspcount;
57779799053SKonstantin Belousov 	else
57879799053SKonstantin Belousov 		panic("calc_remaining: wrong mode %d", mode);
57979799053SKonstantin Belousov 	return (remaining);
58079799053SKonstantin Belousov }
58179799053SKonstantin Belousov 
5825215b187SJeff Roberson /*
58344990b8cSJulian Elischer  * Enforce single-threading.
58444990b8cSJulian Elischer  *
58544990b8cSJulian Elischer  * Returns 1 if the caller must abort (another thread is waiting to
58644990b8cSJulian Elischer  * exit the process or similar). Process is locked!
58744990b8cSJulian Elischer  * Returns 0 when you are successfully the only thread running.
58844990b8cSJulian Elischer  * A process has successfully single threaded in the suspend mode when
58944990b8cSJulian Elischer  * There are no threads in user mode. Threads in the kernel must be
59044990b8cSJulian Elischer  * allowed to continue until they get to the user boundary. They may even
59144990b8cSJulian Elischer  * copy out their return values and data before suspending. They may however be
592e2668f55SMaxim Konovalov  * accelerated in reaching the user boundary as we will wake up
59344990b8cSJulian Elischer  * any sleeping threads that are interruptable. (PCATCH).
59444990b8cSJulian Elischer  */
59544990b8cSJulian Elischer int
596906ac69dSDavid Xu thread_single(int mode)
59744990b8cSJulian Elischer {
59844990b8cSJulian Elischer 	struct thread *td;
59944990b8cSJulian Elischer 	struct thread *td2;
60044990b8cSJulian Elischer 	struct proc *p;
601da7bbd2cSJohn Baldwin 	int remaining, wakeup_swapper;
60244990b8cSJulian Elischer 
60344990b8cSJulian Elischer 	td = curthread;
60444990b8cSJulian Elischer 	p = td->td_proc;
60537814395SPeter Wemm 	mtx_assert(&Giant, MA_NOTOWNED);
60644990b8cSJulian Elischer 	PROC_LOCK_ASSERT(p, MA_OWNED);
60744990b8cSJulian Elischer 	KASSERT((td != NULL), ("curthread is NULL"));
60844990b8cSJulian Elischer 
609ed062c8dSJulian Elischer 	if ((p->p_flag & P_HADTHREADS) == 0)
61044990b8cSJulian Elischer 		return (0);
61144990b8cSJulian Elischer 
612e3b9bf71SJulian Elischer 	/* Is someone already single threading? */
613906ac69dSDavid Xu 	if (p->p_singlethread != NULL && p->p_singlethread != td)
61444990b8cSJulian Elischer 		return (1);
61544990b8cSJulian Elischer 
616906ac69dSDavid Xu 	if (mode == SINGLE_EXIT) {
617906ac69dSDavid Xu 		p->p_flag |= P_SINGLE_EXIT;
618906ac69dSDavid Xu 		p->p_flag &= ~P_SINGLE_BOUNDARY;
619906ac69dSDavid Xu 	} else {
620906ac69dSDavid Xu 		p->p_flag &= ~P_SINGLE_EXIT;
621906ac69dSDavid Xu 		if (mode == SINGLE_BOUNDARY)
622906ac69dSDavid Xu 			p->p_flag |= P_SINGLE_BOUNDARY;
623906ac69dSDavid Xu 		else
624906ac69dSDavid Xu 			p->p_flag &= ~P_SINGLE_BOUNDARY;
625906ac69dSDavid Xu 	}
6261279572aSDavid Xu 	p->p_flag |= P_STOPPED_SINGLE;
6277b4a950aSDavid Xu 	PROC_SLOCK(p);
628112afcb2SJohn Baldwin 	p->p_singlethread = td;
62979799053SKonstantin Belousov 	remaining = calc_remaining(p, mode);
630ec008e96SDavid Xu 	while (remaining != 1) {
631bf1a3220SDavid Xu 		if (P_SHOULDSTOP(p) != P_STOPPED_SINGLE)
632bf1a3220SDavid Xu 			goto stopme;
633da7bbd2cSJohn Baldwin 		wakeup_swapper = 0;
63444990b8cSJulian Elischer 		FOREACH_THREAD_IN_PROC(p, td2) {
63544990b8cSJulian Elischer 			if (td2 == td)
63644990b8cSJulian Elischer 				continue;
637a54e85fdSJeff Roberson 			thread_lock(td2);
638b7edba77SJeff Roberson 			td2->td_flags |= TDF_ASTPENDING | TDF_NEEDSUSPCHK;
63971fad9fdSJulian Elischer 			if (TD_IS_INHIBITED(td2)) {
640906ac69dSDavid Xu 				switch (mode) {
641906ac69dSDavid Xu 				case SINGLE_EXIT:
642906ac69dSDavid Xu 					if (TD_IS_SUSPENDED(td2))
6437847a9daSJohn Baldwin 						wakeup_swapper |=
64471fad9fdSJulian Elischer 						    thread_unsuspend_one(td2);
64533862f40SDavid Xu 					if (TD_ON_SLEEPQ(td2) &&
646906ac69dSDavid Xu 					    (td2->td_flags & TDF_SINTR))
6477847a9daSJohn Baldwin 						wakeup_swapper |=
64894f0972bSDavid Xu 						    sleepq_abort(td2, EINTR);
649906ac69dSDavid Xu 					break;
650906ac69dSDavid Xu 				case SINGLE_BOUNDARY:
651ffdc5a34SDavid Xu 					if (TD_IS_SUSPENDED(td2) &&
652ffdc5a34SDavid Xu 					    !(td2->td_flags & TDF_BOUNDARY))
653ffdc5a34SDavid Xu 						wakeup_swapper |=
654ffdc5a34SDavid Xu 						    thread_unsuspend_one(td2);
655ffdc5a34SDavid Xu 					if (TD_ON_SLEEPQ(td2) &&
656ffdc5a34SDavid Xu 					    (td2->td_flags & TDF_SINTR))
657ffdc5a34SDavid Xu 						wakeup_swapper |=
658ffdc5a34SDavid Xu 						    sleepq_abort(td2, ERESTART);
659906ac69dSDavid Xu 					break;
660f33a947bSKonstantin Belousov 				case SINGLE_NO_EXIT:
661f33a947bSKonstantin Belousov 					if (TD_IS_SUSPENDED(td2) &&
662f33a947bSKonstantin Belousov 					    !(td2->td_flags & TDF_BOUNDARY))
663f33a947bSKonstantin Belousov 						wakeup_swapper |=
664f33a947bSKonstantin Belousov 						    thread_unsuspend_one(td2);
665f33a947bSKonstantin Belousov 					if (TD_ON_SLEEPQ(td2) &&
666f33a947bSKonstantin Belousov 					    (td2->td_flags & TDF_SINTR))
667f33a947bSKonstantin Belousov 						wakeup_swapper |=
668f33a947bSKonstantin Belousov 						    sleepq_abort(td2, ERESTART);
669f33a947bSKonstantin Belousov 					break;
670906ac69dSDavid Xu 				default:
671906ac69dSDavid Xu 					break;
67244990b8cSJulian Elischer 				}
67344990b8cSJulian Elischer 			}
674d8267df7SDavid Xu #ifdef SMP
675d8267df7SDavid Xu 			else if (TD_IS_RUNNING(td2) && td != td2) {
676d8267df7SDavid Xu 				forward_signal(td2);
677d8267df7SDavid Xu 			}
678d8267df7SDavid Xu #endif
679a54e85fdSJeff Roberson 			thread_unlock(td2);
6809d102777SJulian Elischer 		}
681da7bbd2cSJohn Baldwin 		if (wakeup_swapper)
682da7bbd2cSJohn Baldwin 			kick_proc0();
68379799053SKonstantin Belousov 		remaining = calc_remaining(p, mode);
684ec008e96SDavid Xu 
6859d102777SJulian Elischer 		/*
6869d102777SJulian Elischer 		 * Maybe we suspended some threads.. was it enough?
6879d102777SJulian Elischer 		 */
688ec008e96SDavid Xu 		if (remaining == 1)
6899d102777SJulian Elischer 			break;
6909d102777SJulian Elischer 
691bf1a3220SDavid Xu stopme:
69244990b8cSJulian Elischer 		/*
69344990b8cSJulian Elischer 		 * Wake us up when everyone else has suspended.
694e3b9bf71SJulian Elischer 		 * In the mean time we suspend as well.
69544990b8cSJulian Elischer 		 */
696a54e85fdSJeff Roberson 		thread_suspend_switch(td);
69779799053SKonstantin Belousov 		remaining = calc_remaining(p, mode);
69844990b8cSJulian Elischer 	}
699906ac69dSDavid Xu 	if (mode == SINGLE_EXIT) {
70091599697SJulian Elischer 		/*
70191599697SJulian Elischer 		 * We have gotten rid of all the other threads and we
70291599697SJulian Elischer 		 * are about to either exit or exec. In either case,
70391599697SJulian Elischer 		 * we try our utmost  to revert to being a non-threaded
70491599697SJulian Elischer 		 * process.
70591599697SJulian Elischer 		 */
706ed062c8dSJulian Elischer 		p->p_singlethread = NULL;
70764895117SDavid Xu 		p->p_flag &= ~(P_STOPPED_SINGLE | P_SINGLE_EXIT);
708e5bedcefSJulian Elischer 		thread_unthread(td);
70991599697SJulian Elischer 	}
7107b4a950aSDavid Xu 	PROC_SUNLOCK(p);
71144990b8cSJulian Elischer 	return (0);
71244990b8cSJulian Elischer }
71344990b8cSJulian Elischer 
71444990b8cSJulian Elischer /*
71544990b8cSJulian Elischer  * Called in from locations that can safely check to see
71644990b8cSJulian Elischer  * whether we have to suspend or at least throttle for a
71744990b8cSJulian Elischer  * single-thread event (e.g. fork).
71844990b8cSJulian Elischer  *
71944990b8cSJulian Elischer  * Such locations include userret().
72044990b8cSJulian Elischer  * If the "return_instead" argument is non zero, the thread must be able to
72144990b8cSJulian Elischer  * accept 0 (caller may continue), or 1 (caller must abort) as a result.
72244990b8cSJulian Elischer  *
72344990b8cSJulian Elischer  * The 'return_instead' argument tells the function if it may do a
72444990b8cSJulian Elischer  * thread_exit() or suspend, or whether the caller must abort and back
72544990b8cSJulian Elischer  * out instead.
72644990b8cSJulian Elischer  *
72744990b8cSJulian Elischer  * If the thread that set the single_threading request has set the
72844990b8cSJulian Elischer  * P_SINGLE_EXIT bit in the process flags then this call will never return
72944990b8cSJulian Elischer  * if 'return_instead' is false, but will exit.
73044990b8cSJulian Elischer  *
73144990b8cSJulian Elischer  * P_SINGLE_EXIT | return_instead == 0| return_instead != 0
73244990b8cSJulian Elischer  *---------------+--------------------+---------------------
73344990b8cSJulian Elischer  *       0       | returns 0          |   returns 0 or 1
73444990b8cSJulian Elischer  *               | when ST ends       |   immediatly
73544990b8cSJulian Elischer  *---------------+--------------------+---------------------
73644990b8cSJulian Elischer  *       1       | thread exits       |   returns 1
73744990b8cSJulian Elischer  *               |                    |  immediatly
73844990b8cSJulian Elischer  * 0 = thread_exit() or suspension ok,
73944990b8cSJulian Elischer  * other = return error instead of stopping the thread.
74044990b8cSJulian Elischer  *
74144990b8cSJulian Elischer  * While a full suspension is under effect, even a single threading
74244990b8cSJulian Elischer  * thread would be suspended if it made this call (but it shouldn't).
74344990b8cSJulian Elischer  * This call should only be made from places where
74444990b8cSJulian Elischer  * thread_exit() would be safe as that may be the outcome unless
74544990b8cSJulian Elischer  * return_instead is set.
74644990b8cSJulian Elischer  */
74744990b8cSJulian Elischer int
74844990b8cSJulian Elischer thread_suspend_check(int return_instead)
74944990b8cSJulian Elischer {
750ecafb24bSJuli Mallett 	struct thread *td;
751ecafb24bSJuli Mallett 	struct proc *p;
7527847a9daSJohn Baldwin 	int wakeup_swapper;
75344990b8cSJulian Elischer 
75444990b8cSJulian Elischer 	td = curthread;
75544990b8cSJulian Elischer 	p = td->td_proc;
75637814395SPeter Wemm 	mtx_assert(&Giant, MA_NOTOWNED);
75744990b8cSJulian Elischer 	PROC_LOCK_ASSERT(p, MA_OWNED);
758cbf4e354SDavid Xu 	while (P_SHOULDSTOP(p) ||
759904c5ec4SDavid Xu 	      ((p->p_flag & P_TRACED) && (td->td_dbgflags & TDB_SUSPEND))) {
7601279572aSDavid Xu 		if (P_SHOULDSTOP(p) == P_STOPPED_SINGLE) {
76144990b8cSJulian Elischer 			KASSERT(p->p_singlethread != NULL,
76244990b8cSJulian Elischer 			    ("singlethread not set"));
76344990b8cSJulian Elischer 			/*
764e3b9bf71SJulian Elischer 			 * The only suspension in action is a
765e3b9bf71SJulian Elischer 			 * single-threading. Single threader need not stop.
766b6d5995eSJulian Elischer 			 * XXX Should be safe to access unlocked
767b6d5995eSJulian Elischer 			 * as it can only be set to be true by us.
76844990b8cSJulian Elischer 			 */
769e3b9bf71SJulian Elischer 			if (p->p_singlethread == td)
77044990b8cSJulian Elischer 				return (0);	/* Exempt from stopping. */
77144990b8cSJulian Elischer 		}
77245a4bfa1SDavid Xu 		if ((p->p_flag & P_SINGLE_EXIT) && return_instead)
77394f0972bSDavid Xu 			return (EINTR);
77444990b8cSJulian Elischer 
775906ac69dSDavid Xu 		/* Should we goto user boundary if we didn't come from there? */
776906ac69dSDavid Xu 		if (P_SHOULDSTOP(p) == P_STOPPED_SINGLE &&
777906ac69dSDavid Xu 		    (p->p_flag & P_SINGLE_BOUNDARY) && return_instead)
77894f0972bSDavid Xu 			return (ERESTART);
779906ac69dSDavid Xu 
78044990b8cSJulian Elischer 		/*
78144990b8cSJulian Elischer 		 * If the process is waiting for us to exit,
78244990b8cSJulian Elischer 		 * this thread should just suicide.
7831279572aSDavid Xu 		 * Assumes that P_SINGLE_EXIT implies P_STOPPED_SINGLE.
78444990b8cSJulian Elischer 		 */
785cf7d9a8cSDavid Xu 		if ((p->p_flag & P_SINGLE_EXIT) && (p->p_singlethread != td)) {
786cf7d9a8cSDavid Xu 			PROC_UNLOCK(p);
787cf7d9a8cSDavid Xu 			tidhash_remove(td);
788cf7d9a8cSDavid Xu 			PROC_LOCK(p);
78921ecd1e9SDavid Xu 			tdsigcleanup(td);
790cf7d9a8cSDavid Xu 			PROC_SLOCK(p);
79121ecd1e9SDavid Xu 			thread_stopped(p);
79244990b8cSJulian Elischer 			thread_exit();
793cf7d9a8cSDavid Xu 		}
79421ecd1e9SDavid Xu 
79521ecd1e9SDavid Xu 		PROC_SLOCK(p);
79621ecd1e9SDavid Xu 		thread_stopped(p);
797a54e85fdSJeff Roberson 		if (P_SHOULDSTOP(p) == P_STOPPED_SINGLE) {
798a54e85fdSJeff Roberson 			if (p->p_numthreads == p->p_suspcount + 1) {
799a54e85fdSJeff Roberson 				thread_lock(p->p_singlethread);
8007847a9daSJohn Baldwin 				wakeup_swapper =
801a54e85fdSJeff Roberson 				    thread_unsuspend_one(p->p_singlethread);
802a54e85fdSJeff Roberson 				thread_unlock(p->p_singlethread);
8037847a9daSJohn Baldwin 				if (wakeup_swapper)
8047847a9daSJohn Baldwin 					kick_proc0();
805a54e85fdSJeff Roberson 			}
806a54e85fdSJeff Roberson 		}
8073f9be10eSDavid Xu 		PROC_UNLOCK(p);
8087b4a950aSDavid Xu 		thread_lock(td);
80944990b8cSJulian Elischer 		/*
81044990b8cSJulian Elischer 		 * When a thread suspends, it just
811ad1e7d28SJulian Elischer 		 * gets taken off all queues.
81244990b8cSJulian Elischer 		 */
81371fad9fdSJulian Elischer 		thread_suspend_one(td);
814906ac69dSDavid Xu 		if (return_instead == 0) {
815906ac69dSDavid Xu 			p->p_boundary_count++;
816906ac69dSDavid Xu 			td->td_flags |= TDF_BOUNDARY;
817cf19bf91SJulian Elischer 		}
8187b4a950aSDavid Xu 		PROC_SUNLOCK(p);
8198df78c41SJeff Roberson 		mi_switch(SW_INVOL | SWT_SUSPEND, NULL);
820a54e85fdSJeff Roberson 		if (return_instead == 0)
821906ac69dSDavid Xu 			td->td_flags &= ~TDF_BOUNDARY;
822a54e85fdSJeff Roberson 		thread_unlock(td);
82344990b8cSJulian Elischer 		PROC_LOCK(p);
824*7b519077SKonstantin Belousov 		if (return_instead == 0) {
825*7b519077SKonstantin Belousov 			PROC_SLOCK(p);
826a54e85fdSJeff Roberson 			p->p_boundary_count--;
827*7b519077SKonstantin Belousov 			PROC_SUNLOCK(p);
828*7b519077SKonstantin Belousov 		}
82944990b8cSJulian Elischer 	}
83044990b8cSJulian Elischer 	return (0);
83144990b8cSJulian Elischer }
83244990b8cSJulian Elischer 
83335c32a76SDavid Xu void
834a54e85fdSJeff Roberson thread_suspend_switch(struct thread *td)
835a54e85fdSJeff Roberson {
836a54e85fdSJeff Roberson 	struct proc *p;
837a54e85fdSJeff Roberson 
838a54e85fdSJeff Roberson 	p = td->td_proc;
839a54e85fdSJeff Roberson 	KASSERT(!TD_IS_SUSPENDED(td), ("already suspended"));
840a54e85fdSJeff Roberson 	PROC_LOCK_ASSERT(p, MA_OWNED);
8417b4a950aSDavid Xu 	PROC_SLOCK_ASSERT(p, MA_OWNED);
842a54e85fdSJeff Roberson 	/*
843a54e85fdSJeff Roberson 	 * We implement thread_suspend_one in stages here to avoid
844a54e85fdSJeff Roberson 	 * dropping the proc lock while the thread lock is owned.
845a54e85fdSJeff Roberson 	 */
846a54e85fdSJeff Roberson 	thread_stopped(p);
847a54e85fdSJeff Roberson 	p->p_suspcount++;
8483f9be10eSDavid Xu 	PROC_UNLOCK(p);
8497b4a950aSDavid Xu 	thread_lock(td);
850b7edba77SJeff Roberson 	td->td_flags &= ~TDF_NEEDSUSPCHK;
851a54e85fdSJeff Roberson 	TD_SET_SUSPENDED(td);
852c5aa6b58SJeff Roberson 	sched_sleep(td, 0);
8537b4a950aSDavid Xu 	PROC_SUNLOCK(p);
854a54e85fdSJeff Roberson 	DROP_GIANT();
8558df78c41SJeff Roberson 	mi_switch(SW_VOL | SWT_SUSPEND, NULL);
856a54e85fdSJeff Roberson 	thread_unlock(td);
857a54e85fdSJeff Roberson 	PICKUP_GIANT();
858a54e85fdSJeff Roberson 	PROC_LOCK(p);
8597b4a950aSDavid Xu 	PROC_SLOCK(p);
860a54e85fdSJeff Roberson }
861a54e85fdSJeff Roberson 
862a54e85fdSJeff Roberson void
86335c32a76SDavid Xu thread_suspend_one(struct thread *td)
86435c32a76SDavid Xu {
86535c32a76SDavid Xu 	struct proc *p = td->td_proc;
86635c32a76SDavid Xu 
8677b4a950aSDavid Xu 	PROC_SLOCK_ASSERT(p, MA_OWNED);
868a54e85fdSJeff Roberson 	THREAD_LOCK_ASSERT(td, MA_OWNED);
869e574e444SDavid Xu 	KASSERT(!TD_IS_SUSPENDED(td), ("already suspended"));
87035c32a76SDavid Xu 	p->p_suspcount++;
871b7edba77SJeff Roberson 	td->td_flags &= ~TDF_NEEDSUSPCHK;
87271fad9fdSJulian Elischer 	TD_SET_SUSPENDED(td);
873c5aa6b58SJeff Roberson 	sched_sleep(td, 0);
87435c32a76SDavid Xu }
87535c32a76SDavid Xu 
8767847a9daSJohn Baldwin int
87735c32a76SDavid Xu thread_unsuspend_one(struct thread *td)
87835c32a76SDavid Xu {
87935c32a76SDavid Xu 	struct proc *p = td->td_proc;
88035c32a76SDavid Xu 
8817b4a950aSDavid Xu 	PROC_SLOCK_ASSERT(p, MA_OWNED);
882a54e85fdSJeff Roberson 	THREAD_LOCK_ASSERT(td, MA_OWNED);
883ad1e7d28SJulian Elischer 	KASSERT(TD_IS_SUSPENDED(td), ("Thread not suspended"));
88471fad9fdSJulian Elischer 	TD_CLR_SUSPENDED(td);
88535c32a76SDavid Xu 	p->p_suspcount--;
8867847a9daSJohn Baldwin 	return (setrunnable(td));
88735c32a76SDavid Xu }
88835c32a76SDavid Xu 
88944990b8cSJulian Elischer /*
89044990b8cSJulian Elischer  * Allow all threads blocked by single threading to continue running.
89144990b8cSJulian Elischer  */
89244990b8cSJulian Elischer void
89344990b8cSJulian Elischer thread_unsuspend(struct proc *p)
89444990b8cSJulian Elischer {
89544990b8cSJulian Elischer 	struct thread *td;
8967847a9daSJohn Baldwin 	int wakeup_swapper;
89744990b8cSJulian Elischer 
89844990b8cSJulian Elischer 	PROC_LOCK_ASSERT(p, MA_OWNED);
8997b4a950aSDavid Xu 	PROC_SLOCK_ASSERT(p, MA_OWNED);
9007847a9daSJohn Baldwin 	wakeup_swapper = 0;
90144990b8cSJulian Elischer 	if (!P_SHOULDSTOP(p)) {
902ad1e7d28SJulian Elischer                 FOREACH_THREAD_IN_PROC(p, td) {
903a54e85fdSJeff Roberson 			thread_lock(td);
904ad1e7d28SJulian Elischer 			if (TD_IS_SUSPENDED(td)) {
9057847a9daSJohn Baldwin 				wakeup_swapper |= thread_unsuspend_one(td);
90644990b8cSJulian Elischer 			}
907a54e85fdSJeff Roberson 			thread_unlock(td);
908ad1e7d28SJulian Elischer 		}
9091279572aSDavid Xu 	} else if ((P_SHOULDSTOP(p) == P_STOPPED_SINGLE) &&
91044990b8cSJulian Elischer 	    (p->p_numthreads == p->p_suspcount)) {
91144990b8cSJulian Elischer 		/*
91244990b8cSJulian Elischer 		 * Stopping everything also did the job for the single
91344990b8cSJulian Elischer 		 * threading request. Now we've downgraded to single-threaded,
91444990b8cSJulian Elischer 		 * let it continue.
91544990b8cSJulian Elischer 		 */
916a54e85fdSJeff Roberson 		thread_lock(p->p_singlethread);
9177847a9daSJohn Baldwin 		wakeup_swapper = thread_unsuspend_one(p->p_singlethread);
918a54e85fdSJeff Roberson 		thread_unlock(p->p_singlethread);
91944990b8cSJulian Elischer 	}
9207847a9daSJohn Baldwin 	if (wakeup_swapper)
9217847a9daSJohn Baldwin 		kick_proc0();
92244990b8cSJulian Elischer }
92344990b8cSJulian Elischer 
924ed062c8dSJulian Elischer /*
925ed062c8dSJulian Elischer  * End the single threading mode..
926ed062c8dSJulian Elischer  */
92744990b8cSJulian Elischer void
92844990b8cSJulian Elischer thread_single_end(void)
92944990b8cSJulian Elischer {
93044990b8cSJulian Elischer 	struct thread *td;
93144990b8cSJulian Elischer 	struct proc *p;
9327847a9daSJohn Baldwin 	int wakeup_swapper;
93344990b8cSJulian Elischer 
93444990b8cSJulian Elischer 	td = curthread;
93544990b8cSJulian Elischer 	p = td->td_proc;
93644990b8cSJulian Elischer 	PROC_LOCK_ASSERT(p, MA_OWNED);
937906ac69dSDavid Xu 	p->p_flag &= ~(P_STOPPED_SINGLE | P_SINGLE_EXIT | P_SINGLE_BOUNDARY);
9387b4a950aSDavid Xu 	PROC_SLOCK(p);
93944990b8cSJulian Elischer 	p->p_singlethread = NULL;
9407847a9daSJohn Baldwin 	wakeup_swapper = 0;
94149539972SJulian Elischer 	/*
9427847a9daSJohn Baldwin 	 * If there are other threads they may now run,
94349539972SJulian Elischer 	 * unless of course there is a blanket 'stop order'
94449539972SJulian Elischer 	 * on the process. The single threader must be allowed
94549539972SJulian Elischer 	 * to continue however as this is a bad place to stop.
94649539972SJulian Elischer 	 */
94749539972SJulian Elischer 	if ((p->p_numthreads != 1) && (!P_SHOULDSTOP(p))) {
948ad1e7d28SJulian Elischer                 FOREACH_THREAD_IN_PROC(p, td) {
949a54e85fdSJeff Roberson 			thread_lock(td);
950ad1e7d28SJulian Elischer 			if (TD_IS_SUSPENDED(td)) {
9517847a9daSJohn Baldwin 				wakeup_swapper |= thread_unsuspend_one(td);
95244990b8cSJulian Elischer 			}
953a54e85fdSJeff Roberson 			thread_unlock(td);
95449539972SJulian Elischer 		}
955ad1e7d28SJulian Elischer 	}
9567b4a950aSDavid Xu 	PROC_SUNLOCK(p);
9577847a9daSJohn Baldwin 	if (wakeup_swapper)
9587847a9daSJohn Baldwin 		kick_proc0();
95949539972SJulian Elischer }
9604fc21c09SDaniel Eischen 
96144355392SDavid Xu struct thread *
96244355392SDavid Xu thread_find(struct proc *p, lwpid_t tid)
96344355392SDavid Xu {
96444355392SDavid Xu 	struct thread *td;
96544355392SDavid Xu 
96644355392SDavid Xu 	PROC_LOCK_ASSERT(p, MA_OWNED);
96744355392SDavid Xu 	FOREACH_THREAD_IN_PROC(p, td) {
96844355392SDavid Xu 		if (td->td_tid == tid)
96944355392SDavid Xu 			break;
97044355392SDavid Xu 	}
97144355392SDavid Xu 	return (td);
97244355392SDavid Xu }
973cf7d9a8cSDavid Xu 
974cf7d9a8cSDavid Xu /* Locate a thread by number; return with proc lock held. */
975cf7d9a8cSDavid Xu struct thread *
976cf7d9a8cSDavid Xu tdfind(lwpid_t tid, pid_t pid)
977cf7d9a8cSDavid Xu {
978cf7d9a8cSDavid Xu #define RUN_THRESH	16
979cf7d9a8cSDavid Xu 	struct thread *td;
980cf7d9a8cSDavid Xu 	int run = 0;
981cf7d9a8cSDavid Xu 
982cf7d9a8cSDavid Xu 	rw_rlock(&tidhash_lock);
983cf7d9a8cSDavid Xu 	LIST_FOREACH(td, TIDHASH(tid), td_hash) {
984cf7d9a8cSDavid Xu 		if (td->td_tid == tid) {
985cf7d9a8cSDavid Xu 			if (pid != -1 && td->td_proc->p_pid != pid) {
986cf7d9a8cSDavid Xu 				td = NULL;
987cf7d9a8cSDavid Xu 				break;
988cf7d9a8cSDavid Xu 			}
9898e6fa660SJohn Baldwin 			PROC_LOCK(td->td_proc);
990cf7d9a8cSDavid Xu 			if (td->td_proc->p_state == PRS_NEW) {
9918e6fa660SJohn Baldwin 				PROC_UNLOCK(td->td_proc);
992cf7d9a8cSDavid Xu 				td = NULL;
993cf7d9a8cSDavid Xu 				break;
994cf7d9a8cSDavid Xu 			}
995cf7d9a8cSDavid Xu 			if (run > RUN_THRESH) {
996cf7d9a8cSDavid Xu 				if (rw_try_upgrade(&tidhash_lock)) {
997cf7d9a8cSDavid Xu 					LIST_REMOVE(td, td_hash);
998cf7d9a8cSDavid Xu 					LIST_INSERT_HEAD(TIDHASH(td->td_tid),
999cf7d9a8cSDavid Xu 						td, td_hash);
1000cf7d9a8cSDavid Xu 					rw_wunlock(&tidhash_lock);
1001cf7d9a8cSDavid Xu 					return (td);
1002cf7d9a8cSDavid Xu 				}
1003cf7d9a8cSDavid Xu 			}
1004cf7d9a8cSDavid Xu 			break;
1005cf7d9a8cSDavid Xu 		}
1006cf7d9a8cSDavid Xu 		run++;
1007cf7d9a8cSDavid Xu 	}
1008cf7d9a8cSDavid Xu 	rw_runlock(&tidhash_lock);
1009cf7d9a8cSDavid Xu 	return (td);
1010cf7d9a8cSDavid Xu }
1011cf7d9a8cSDavid Xu 
1012cf7d9a8cSDavid Xu void
1013cf7d9a8cSDavid Xu tidhash_add(struct thread *td)
1014cf7d9a8cSDavid Xu {
1015cf7d9a8cSDavid Xu 	rw_wlock(&tidhash_lock);
1016cf7d9a8cSDavid Xu 	LIST_INSERT_HEAD(TIDHASH(td->td_tid), td, td_hash);
1017cf7d9a8cSDavid Xu 	rw_wunlock(&tidhash_lock);
1018cf7d9a8cSDavid Xu }
1019cf7d9a8cSDavid Xu 
1020cf7d9a8cSDavid Xu void
1021cf7d9a8cSDavid Xu tidhash_remove(struct thread *td)
1022cf7d9a8cSDavid Xu {
1023cf7d9a8cSDavid Xu 	rw_wlock(&tidhash_lock);
1024cf7d9a8cSDavid Xu 	LIST_REMOVE(td, td_hash);
1025cf7d9a8cSDavid Xu 	rw_wunlock(&tidhash_lock);
1026cf7d9a8cSDavid Xu }
1027