xref: /freebsd/sys/kern/kern_thread.c (revision 0c3967e7febd9b1c9cbbe632214ed2cc0c30dae7)
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 
29677b542eSDavid E. O'Brien #include <sys/cdefs.h>
30677b542eSDavid E. O'Brien __FBSDID("$FreeBSD$");
31677b542eSDavid E. O'Brien 
3244990b8cSJulian Elischer #include <sys/param.h>
3344990b8cSJulian Elischer #include <sys/systm.h>
3444990b8cSJulian Elischer #include <sys/kernel.h>
3544990b8cSJulian Elischer #include <sys/lock.h>
3644990b8cSJulian Elischer #include <sys/mutex.h>
3744990b8cSJulian Elischer #include <sys/proc.h>
38e170bfdaSDavid Xu #include <sys/resourcevar.h>
3994e0a4cdSJulian Elischer #include <sys/smp.h>
4044990b8cSJulian Elischer #include <sys/sysctl.h>
41de028f5aSJeff Roberson #include <sys/sched.h>
4244f3b092SJohn Baldwin #include <sys/sleepqueue.h>
43961a7b24SJohn Baldwin #include <sys/turnstile.h>
4444990b8cSJulian Elischer #include <sys/ktr.h>
45bc8e6d81SDavid Xu #include <sys/umtx.h>
4644990b8cSJulian Elischer 
47911b84b0SRobert Watson #include <security/audit/audit.h>
48911b84b0SRobert Watson 
4944990b8cSJulian Elischer #include <vm/vm.h>
5049a2507bSAlan Cox #include <vm/vm_extern.h>
5144990b8cSJulian Elischer #include <vm/uma.h>
5202fb42b0SPeter Wemm 
538460a577SJohn Birrell /*
548460a577SJohn Birrell  * thread related storage.
558460a577SJohn Birrell  */
5644990b8cSJulian Elischer static uma_zone_t thread_zone;
5744990b8cSJulian Elischer 
5844990b8cSJulian Elischer SYSCTL_NODE(_kern, OID_AUTO, threads, CTLFLAG_RW, 0, "thread allocation");
59fdc5ecd2SDavid Xu 
60345ad866SJulian Elischer int max_threads_per_proc = 1500;
61fdc5ecd2SDavid Xu SYSCTL_INT(_kern_threads, OID_AUTO, max_threads_per_proc, CTLFLAG_RW,
624f0db5e0SJulian Elischer 	&max_threads_per_proc, 0, "Limit on threads per proc");
634f0db5e0SJulian Elischer 
64345ad866SJulian Elischer int max_threads_hits;
650252d203SDavid Xu SYSCTL_INT(_kern_threads, OID_AUTO, max_threads_hits, CTLFLAG_RD,
660252d203SDavid Xu 	&max_threads_hits, 0, "");
670252d203SDavid Xu 
688460a577SJohn Birrell #ifdef KSE
6994e0a4cdSJulian Elischer int virtual_cpu;
7094e0a4cdSJulian Elischer 
718460a577SJohn Birrell #endif
725215b187SJeff Roberson TAILQ_HEAD(, thread) zombie_threads = TAILQ_HEAD_INITIALIZER(zombie_threads);
73c8790f5dSAttilio Rao static struct mtx zombie_lock;
74a54e85fdSJeff Roberson MTX_SYSINIT(zombie_lock, &zombie_lock, "zombie lock", MTX_SPIN);
7544990b8cSJulian Elischer 
76ff8fbcffSJeff Roberson static void thread_zombie(struct thread *);
77ff8fbcffSJeff Roberson 
788460a577SJohn Birrell #ifdef KSE
7994e0a4cdSJulian Elischer static int
8094e0a4cdSJulian Elischer sysctl_kse_virtual_cpu(SYSCTL_HANDLER_ARGS)
8194e0a4cdSJulian Elischer {
8294e0a4cdSJulian Elischer 	int error, new_val;
8394e0a4cdSJulian Elischer 	int def_val;
8494e0a4cdSJulian Elischer 
8594e0a4cdSJulian Elischer 	def_val = mp_ncpus;
8694e0a4cdSJulian Elischer 	if (virtual_cpu == 0)
8794e0a4cdSJulian Elischer 		new_val = def_val;
8894e0a4cdSJulian Elischer 	else
8994e0a4cdSJulian Elischer 		new_val = virtual_cpu;
9094e0a4cdSJulian Elischer 	error = sysctl_handle_int(oidp, &new_val, 0, req);
9194e0a4cdSJulian Elischer 	if (error != 0 || req->newptr == NULL)
9294e0a4cdSJulian Elischer 		return (error);
9394e0a4cdSJulian Elischer 	if (new_val < 0)
9494e0a4cdSJulian Elischer 		return (EINVAL);
9594e0a4cdSJulian Elischer 	virtual_cpu = new_val;
9694e0a4cdSJulian Elischer 	return (0);
9794e0a4cdSJulian Elischer }
9894e0a4cdSJulian Elischer 
9994e0a4cdSJulian Elischer /* DEBUG ONLY */
10094e0a4cdSJulian Elischer SYSCTL_PROC(_kern_threads, OID_AUTO, virtual_cpu, CTLTYPE_INT|CTLFLAG_RW,
10194e0a4cdSJulian Elischer 	0, sizeof(virtual_cpu), sysctl_kse_virtual_cpu, "I",
10294e0a4cdSJulian Elischer 	"debug virtual cpus");
1038460a577SJohn Birrell #endif
1045c8329edSJulian Elischer 
105fdcac928SMarcel Moolenaar struct mtx tid_lock;
1061ea7a6f8SPoul-Henning Kamp static struct unrhdr *tid_unrhdr;
107fdcac928SMarcel Moolenaar 
108fdcac928SMarcel Moolenaar /*
109696058c3SJulian Elischer  * Prepare a thread for use.
11044990b8cSJulian Elischer  */
111b23f72e9SBrian Feldman static int
112b23f72e9SBrian Feldman thread_ctor(void *mem, int size, void *arg, int flags)
11344990b8cSJulian Elischer {
11444990b8cSJulian Elischer 	struct thread	*td;
11544990b8cSJulian Elischer 
11644990b8cSJulian Elischer 	td = (struct thread *)mem;
11771fad9fdSJulian Elischer 	td->td_state = TDS_INACTIVE;
118060563ecSJulian Elischer 	td->td_oncpu = NOCPU;
1196c27c603SJuli Mallett 
120773eff9dSPoul-Henning Kamp 	td->td_tid = alloc_unr(tid_unrhdr);
121f9bb7538SMohan Srinivasan 	td->td_syscalls = 0;
122773eff9dSPoul-Henning Kamp 
1236c27c603SJuli Mallett 	/*
1246c27c603SJuli Mallett 	 * Note that td_critnest begins life as 1 because the thread is not
1256c27c603SJuli Mallett 	 * running and is thereby implicitly waiting to be on the receiving
126a54e85fdSJeff Roberson 	 * end of a context switch.
1276c27c603SJuli Mallett 	 */
128139b7550SJohn Baldwin 	td->td_critnest = 1;
129911b84b0SRobert Watson 
130911b84b0SRobert Watson #ifdef AUDIT
131911b84b0SRobert Watson 	audit_thread_alloc(td);
132911b84b0SRobert Watson #endif
133d10183d9SDavid Xu 	umtx_thread_alloc(td);
134b23f72e9SBrian Feldman 	return (0);
13544990b8cSJulian Elischer }
13644990b8cSJulian Elischer 
13744990b8cSJulian Elischer /*
13844990b8cSJulian Elischer  * Reclaim a thread after use.
13944990b8cSJulian Elischer  */
14044990b8cSJulian Elischer static void
14144990b8cSJulian Elischer thread_dtor(void *mem, int size, void *arg)
14244990b8cSJulian Elischer {
14344990b8cSJulian Elischer 	struct thread *td;
14444990b8cSJulian Elischer 
14544990b8cSJulian Elischer 	td = (struct thread *)mem;
14644990b8cSJulian Elischer 
14744990b8cSJulian Elischer #ifdef INVARIANTS
14844990b8cSJulian Elischer 	/* Verify that this thread is in a safe state to free. */
14944990b8cSJulian Elischer 	switch (td->td_state) {
15071fad9fdSJulian Elischer 	case TDS_INHIBITED:
15171fad9fdSJulian Elischer 	case TDS_RUNNING:
15271fad9fdSJulian Elischer 	case TDS_CAN_RUN:
15344990b8cSJulian Elischer 	case TDS_RUNQ:
15444990b8cSJulian Elischer 		/*
15544990b8cSJulian Elischer 		 * We must never unlink a thread that is in one of
15644990b8cSJulian Elischer 		 * these states, because it is currently active.
15744990b8cSJulian Elischer 		 */
15844990b8cSJulian Elischer 		panic("bad state for thread unlinking");
15944990b8cSJulian Elischer 		/* NOTREACHED */
16071fad9fdSJulian Elischer 	case TDS_INACTIVE:
16144990b8cSJulian Elischer 		break;
16244990b8cSJulian Elischer 	default:
16344990b8cSJulian Elischer 		panic("bad thread state");
16444990b8cSJulian Elischer 		/* NOTREACHED */
16544990b8cSJulian Elischer 	}
16644990b8cSJulian Elischer #endif
1676e8525ceSRobert Watson #ifdef AUDIT
1686e8525ceSRobert Watson 	audit_thread_free(td);
1696e8525ceSRobert Watson #endif
170773eff9dSPoul-Henning Kamp 	free_unr(tid_unrhdr, td->td_tid);
171ed062c8dSJulian Elischer 	sched_newthread(td);
17244990b8cSJulian Elischer }
17344990b8cSJulian Elischer 
17444990b8cSJulian Elischer /*
17544990b8cSJulian Elischer  * Initialize type-stable parts of a thread (when newly created).
17644990b8cSJulian Elischer  */
177b23f72e9SBrian Feldman static int
178b23f72e9SBrian Feldman thread_init(void *mem, int size, int flags)
17944990b8cSJulian Elischer {
18044990b8cSJulian Elischer 	struct thread *td;
18144990b8cSJulian Elischer 
18244990b8cSJulian Elischer 	td = (struct thread *)mem;
183247aba24SMarcel Moolenaar 
18444f3b092SJohn Baldwin 	td->td_sleepqueue = sleepq_alloc();
185961a7b24SJohn Baldwin 	td->td_turnstile = turnstile_alloc();
186de028f5aSJeff Roberson 	td->td_sched = (struct td_sched *)&td[1];
187ed062c8dSJulian Elischer 	sched_newthread(td);
188d10183d9SDavid Xu 	umtx_thread_init(td);
18989b57fcfSKonstantin Belousov 	td->td_kstack = 0;
190b23f72e9SBrian Feldman 	return (0);
19144990b8cSJulian Elischer }
19244990b8cSJulian Elischer 
19344990b8cSJulian Elischer /*
19444990b8cSJulian Elischer  * Tear down type-stable parts of a thread (just before being discarded).
19544990b8cSJulian Elischer  */
19644990b8cSJulian Elischer static void
19744990b8cSJulian Elischer thread_fini(void *mem, int size)
19844990b8cSJulian Elischer {
19944990b8cSJulian Elischer 	struct thread *td;
20044990b8cSJulian Elischer 
20144990b8cSJulian Elischer 	td = (struct thread *)mem;
202961a7b24SJohn Baldwin 	turnstile_free(td->td_turnstile);
20344f3b092SJohn Baldwin 	sleepq_free(td->td_sleepqueue);
204d10183d9SDavid Xu 	umtx_thread_fini(td);
20544990b8cSJulian Elischer }
2065215b187SJeff Roberson 
2075c8329edSJulian Elischer /*
2085215b187SJeff Roberson  * For a newly created process,
2095215b187SJeff Roberson  * link up all the structures and its initial threads etc.
210ed062c8dSJulian Elischer  * called from:
211ed062c8dSJulian Elischer  * {arch}/{arch}/machdep.c   ia64_init(), init386() etc.
212ed062c8dSJulian Elischer  * proc_dtor() (should go away)
213ed062c8dSJulian Elischer  * proc_init()
2145c8329edSJulian Elischer  */
2155c8329edSJulian Elischer void
21689b57fcfSKonstantin Belousov proc_linkup0(struct proc *p, struct thread *td)
21789b57fcfSKonstantin Belousov {
21889b57fcfSKonstantin Belousov 	TAILQ_INIT(&p->p_threads);	     /* all threads in proc */
21989b57fcfSKonstantin Belousov 	proc_linkup(p, td);
22089b57fcfSKonstantin Belousov }
22189b57fcfSKonstantin Belousov 
22289b57fcfSKonstantin Belousov void
2238460a577SJohn Birrell proc_linkup(struct proc *p, struct thread *td)
2245c8329edSJulian Elischer {
225a54e85fdSJeff Roberson 
226e7c8d2e9SJeff Roberson #ifdef KSE
227ad1e7d28SJulian Elischer 	TAILQ_INIT(&p->p_upcalls);	     /* upcall list */
228e7c8d2e9SJeff Roberson #endif
2299104847fSDavid Xu 	sigqueue_init(&p->p_sigqueue, p);
230ebceaf6dSDavid Xu 	p->p_ksi = ksiginfo_alloc(1);
231ebceaf6dSDavid Xu 	if (p->p_ksi != NULL) {
2325c474517SDavid Xu 		/* XXX p_ksi may be null if ksiginfo zone is not ready */
233ebceaf6dSDavid Xu 		p->p_ksi->ksi_flags = KSI_EXT | KSI_INS;
234ebceaf6dSDavid Xu 	}
235ca081fdbSJulian Elischer 	bcopy(p->p_comm, td->td_name, sizeof(td->td_name));
236b2f92ef9SDavid Xu 	LIST_INIT(&p->p_mqnotifier);
2375c8329edSJulian Elischer 	p->p_numthreads = 0;
2388460a577SJohn Birrell 	thread_link(td, p);
2395c8329edSJulian Elischer }
2405c8329edSJulian Elischer 
2415c8329edSJulian Elischer /*
24244990b8cSJulian Elischer  * Initialize global thread allocation resources.
24344990b8cSJulian Elischer  */
24444990b8cSJulian Elischer void
24544990b8cSJulian Elischer threadinit(void)
24644990b8cSJulian Elischer {
24744990b8cSJulian Elischer 
2481ea7a6f8SPoul-Henning Kamp 	mtx_init(&tid_lock, "TID lock", NULL, MTX_DEF);
2491ea7a6f8SPoul-Henning Kamp 	tid_unrhdr = new_unrhdr(PID_MAX + 1, INT_MAX, &tid_lock);
2501ea7a6f8SPoul-Henning Kamp 
251de028f5aSJeff Roberson 	thread_zone = uma_zcreate("THREAD", sched_sizeof_thread(),
25244990b8cSJulian Elischer 	    thread_ctor, thread_dtor, thread_init, thread_fini,
2534649e92bSJohn Baldwin 	    16 - 1, 0);
2548460a577SJohn Birrell #ifdef KSE
255ed062c8dSJulian Elischer 	kseinit();	/* set up kse specific stuff  e.g. upcall zone*/
2568460a577SJohn Birrell #endif
25744990b8cSJulian Elischer }
25844990b8cSJulian Elischer 
25944990b8cSJulian Elischer /*
260ff8fbcffSJeff Roberson  * Place an unused thread on the zombie list.
261ad1e7d28SJulian Elischer  * Use the slpq as that must be unused by now.
26244990b8cSJulian Elischer  */
26344990b8cSJulian Elischer void
264ff8fbcffSJeff Roberson thread_zombie(struct thread *td)
26544990b8cSJulian Elischer {
266a54e85fdSJeff Roberson 	mtx_lock_spin(&zombie_lock);
267ad1e7d28SJulian Elischer 	TAILQ_INSERT_HEAD(&zombie_threads, td, td_slpq);
268a54e85fdSJeff Roberson 	mtx_unlock_spin(&zombie_lock);
26944990b8cSJulian Elischer }
27044990b8cSJulian Elischer 
2715c8329edSJulian Elischer /*
272ff8fbcffSJeff Roberson  * Release a thread that has exited after cpu_throw().
273ff8fbcffSJeff Roberson  */
274ff8fbcffSJeff Roberson void
275ff8fbcffSJeff Roberson thread_stash(struct thread *td)
276ff8fbcffSJeff Roberson {
277ff8fbcffSJeff Roberson 	atomic_subtract_rel_int(&td->td_proc->p_exitthreads, 1);
278ff8fbcffSJeff Roberson 	thread_zombie(td);
279ff8fbcffSJeff Roberson }
280ff8fbcffSJeff Roberson 
281ff8fbcffSJeff Roberson /*
2825215b187SJeff Roberson  * Reap zombie kse resource.
28344990b8cSJulian Elischer  */
28444990b8cSJulian Elischer void
28544990b8cSJulian Elischer thread_reap(void)
28644990b8cSJulian Elischer {
2875c8329edSJulian Elischer 	struct thread *td_first, *td_next;
28844990b8cSJulian Elischer 
28944990b8cSJulian Elischer 	/*
2905215b187SJeff Roberson 	 * Don't even bother to lock if none at this instant,
2915215b187SJeff Roberson 	 * we really don't care about the next instant..
29244990b8cSJulian Elischer 	 */
2938460a577SJohn Birrell 	if (!TAILQ_EMPTY(&zombie_threads)) {
294a54e85fdSJeff Roberson 		mtx_lock_spin(&zombie_lock);
2955c8329edSJulian Elischer 		td_first = TAILQ_FIRST(&zombie_threads);
2965c8329edSJulian Elischer 		if (td_first)
2975c8329edSJulian Elischer 			TAILQ_INIT(&zombie_threads);
298a54e85fdSJeff Roberson 		mtx_unlock_spin(&zombie_lock);
2995c8329edSJulian Elischer 		while (td_first) {
300ad1e7d28SJulian Elischer 			td_next = TAILQ_NEXT(td_first, td_slpq);
3015215b187SJeff Roberson 			if (td_first->td_ucred)
3025215b187SJeff Roberson 				crfree(td_first->td_ucred);
3035c8329edSJulian Elischer 			thread_free(td_first);
3045c8329edSJulian Elischer 			td_first = td_next;
30544990b8cSJulian Elischer 		}
30644990b8cSJulian Elischer 	}
30734ed0400SAttilio Rao #ifdef KSE
30834ed0400SAttilio Rao 	upcall_reap();
30934ed0400SAttilio Rao #endif
310ed062c8dSJulian Elischer }
31144990b8cSJulian Elischer 
3124f0db5e0SJulian Elischer /*
31344990b8cSJulian Elischer  * Allocate a thread.
31444990b8cSJulian Elischer  */
31544990b8cSJulian Elischer struct thread *
31644990b8cSJulian Elischer thread_alloc(void)
31744990b8cSJulian Elischer {
31889b57fcfSKonstantin Belousov 	struct thread *td;
3198460a577SJohn Birrell 
32044990b8cSJulian Elischer 	thread_reap(); /* check if any zombies to get */
32189b57fcfSKonstantin Belousov 
32289b57fcfSKonstantin Belousov 	td = (struct thread *)uma_zalloc(thread_zone, M_WAITOK);
32389b57fcfSKonstantin Belousov 	KASSERT(td->td_kstack == 0, ("thread_alloc got thread with kstack"));
32489b57fcfSKonstantin Belousov 	if (!vm_thread_new(td, 0)) {
32589b57fcfSKonstantin Belousov 		uma_zfree(thread_zone, td);
32689b57fcfSKonstantin Belousov 		return (NULL);
32789b57fcfSKonstantin Belousov 	}
3280c3967e7SMarcel Moolenaar 	cpu_thread_alloc(td);
32989b57fcfSKonstantin Belousov 	return (td);
33044990b8cSJulian Elischer }
33144990b8cSJulian Elischer 
3324f0db5e0SJulian Elischer 
3334f0db5e0SJulian Elischer /*
33444990b8cSJulian Elischer  * Deallocate a thread.
33544990b8cSJulian Elischer  */
33644990b8cSJulian Elischer void
33744990b8cSJulian Elischer thread_free(struct thread *td)
33844990b8cSJulian Elischer {
339696058c3SJulian Elischer 
3400c3967e7SMarcel Moolenaar 	cpu_thread_free(td);
34189b57fcfSKonstantin Belousov 	if (td->td_altkstack != 0)
34289b57fcfSKonstantin Belousov 		vm_thread_dispose_altkstack(td);
34389b57fcfSKonstantin Belousov 	if (td->td_kstack != 0)
34489b57fcfSKonstantin Belousov 		vm_thread_dispose(td);
34544990b8cSJulian Elischer 	uma_zfree(thread_zone, td);
34644990b8cSJulian Elischer }
34744990b8cSJulian Elischer 
34844990b8cSJulian Elischer /*
34944990b8cSJulian Elischer  * Discard the current thread and exit from its context.
35094e0a4cdSJulian Elischer  * Always called with scheduler locked.
35144990b8cSJulian Elischer  *
35244990b8cSJulian Elischer  * Because we can't free a thread while we're operating under its context,
353696058c3SJulian Elischer  * push the current thread into our CPU's deadthread holder. This means
354696058c3SJulian Elischer  * we needn't worry about someone else grabbing our context before we
35594e0a4cdSJulian Elischer  * do a cpu_throw().  This may not be needed now as we are under schedlock.
35694e0a4cdSJulian Elischer  * Maybe we can just do a thread_stash() as thr_exit1 does.
35794e0a4cdSJulian Elischer  */
35894e0a4cdSJulian Elischer /*  XXX
35994e0a4cdSJulian Elischer  * libthr expects its thread exit to return for the last
36094e0a4cdSJulian Elischer  * thread, meaning that the program is back to non-threaded
36194e0a4cdSJulian Elischer  * mode I guess. Because we do this (cpu_throw) unconditionally
36294e0a4cdSJulian Elischer  * here, they have their own version of it. (thr_exit1())
36394e0a4cdSJulian Elischer  * that doesn't do it all if this was the last thread.
36494e0a4cdSJulian Elischer  * It is also called from thread_suspend_check().
36594e0a4cdSJulian Elischer  * Of course in the end, they end up coming here through exit1
36694e0a4cdSJulian Elischer  * anyhow..  After fixing 'thr' to play by the rules we should be able
36794e0a4cdSJulian Elischer  * to merge these two functions together.
368ed062c8dSJulian Elischer  *
369ed062c8dSJulian Elischer  * called from:
370ed062c8dSJulian Elischer  * exit1()
371ed062c8dSJulian Elischer  * kse_exit()
372ed062c8dSJulian Elischer  * thr_exit()
3738460a577SJohn Birrell  * ifdef KSE
374ed062c8dSJulian Elischer  * thread_user_enter()
375ed062c8dSJulian Elischer  * thread_userret()
3768460a577SJohn Birrell  * endif
377ed062c8dSJulian Elischer  * thread_suspend_check()
37844990b8cSJulian Elischer  */
37944990b8cSJulian Elischer void
38044990b8cSJulian Elischer thread_exit(void)
38144990b8cSJulian Elischer {
382e170bfdaSDavid Xu 	uint64_t new_switchtime;
38344990b8cSJulian Elischer 	struct thread *td;
3841c4bcd05SJeff Roberson 	struct thread *td2;
38544990b8cSJulian Elischer 	struct proc *p;
38644990b8cSJulian Elischer 
38744990b8cSJulian Elischer 	td = curthread;
38844990b8cSJulian Elischer 	p = td->td_proc;
38944990b8cSJulian Elischer 
390a54e85fdSJeff Roberson 	PROC_SLOCK_ASSERT(p, MA_OWNED);
391ed062c8dSJulian Elischer 	mtx_assert(&Giant, MA_NOTOWNED);
392a54e85fdSJeff Roberson 
39344990b8cSJulian Elischer 	PROC_LOCK_ASSERT(p, MA_OWNED);
394ed062c8dSJulian Elischer 	KASSERT(p != NULL, ("thread exiting without a process"));
395cc701b73SRobert Watson 	CTR3(KTR_PROC, "thread_exit: thread %p (pid %ld, %s)", td,
396e01eafefSJulian Elischer 	    (long)p->p_pid, td->td_name);
3979104847fSDavid Xu 	KASSERT(TAILQ_EMPTY(&td->td_sigqueue.sq_list), ("signal pending"));
39844990b8cSJulian Elischer 
39989964dd2SRobert Watson #ifdef AUDIT
40089964dd2SRobert Watson 	AUDIT_SYSCALL_EXIT(0, td);
40189964dd2SRobert Watson #endif
40289964dd2SRobert Watson 
4038460a577SJohn Birrell #ifdef KSE
40448bfcdddSJulian Elischer 	if (td->td_standin != NULL) {
405ed062c8dSJulian Elischer 		/*
406ed062c8dSJulian Elischer 		 * Note that we don't need to free the cred here as it
407ed062c8dSJulian Elischer 		 * is done in thread_reap().
408ed062c8dSJulian Elischer 		 */
409ff8fbcffSJeff Roberson 		thread_zombie(td->td_standin);
41048bfcdddSJulian Elischer 		td->td_standin = NULL;
41148bfcdddSJulian Elischer 	}
4128460a577SJohn Birrell #endif
41348bfcdddSJulian Elischer 
414d10183d9SDavid Xu 	umtx_thread_exit(td);
415d10183d9SDavid Xu 
416ed062c8dSJulian Elischer 	/*
417ed062c8dSJulian Elischer 	 * drop FPU & debug register state storage, or any other
418ed062c8dSJulian Elischer 	 * architecture specific resources that
419ed062c8dSJulian Elischer 	 * would not be on a new untouched process.
420ed062c8dSJulian Elischer 	 */
42144990b8cSJulian Elischer 	cpu_thread_exit(td);	/* XXXSMP */
42244990b8cSJulian Elischer 
423e170bfdaSDavid Xu 	/* Do the same timestamp bookkeeping that mi_switch() would do. */
424e170bfdaSDavid Xu 	new_switchtime = cpu_ticks();
425e170bfdaSDavid Xu 	p->p_rux.rux_runtime += (new_switchtime - PCPU_GET(switchtime));
426e170bfdaSDavid Xu 	PCPU_SET(switchtime, new_switchtime);
427e170bfdaSDavid Xu 	PCPU_SET(switchticks, ticks);
428b4b70819SAttilio Rao 	PCPU_INC(cnt.v_swtch);
429a140976eSAttilio Rao 	/* Save our resource usage in our process. */
430a140976eSAttilio Rao 	td->td_ru.ru_nvcsw++;
431a140976eSAttilio Rao 	rucollect(&p->p_ru, &td->td_ru);
432ed062c8dSJulian Elischer 	/*
4331faf202eSJulian Elischer 	 * The last thread is left attached to the process
4341faf202eSJulian Elischer 	 * So that the whole bundle gets recycled. Skip
435ed062c8dSJulian Elischer 	 * all this stuff if we never had threads.
436ed062c8dSJulian Elischer 	 * EXIT clears all sign of other threads when
437ed062c8dSJulian Elischer 	 * it goes to single threading, so the last thread always
438ed062c8dSJulian Elischer 	 * takes the short path.
4391faf202eSJulian Elischer 	 */
440ed062c8dSJulian Elischer 	if (p->p_flag & P_HADTHREADS) {
4411faf202eSJulian Elischer 		if (p->p_numthreads > 1) {
442a54e85fdSJeff Roberson 			thread_lock(td);
443a54e85fdSJeff Roberson #ifdef KSE
444a54e85fdSJeff Roberson 			kse_unlink(td);
445a54e85fdSJeff Roberson #else
446d3a0bd78SJulian Elischer 			thread_unlink(td);
447a54e85fdSJeff Roberson #endif
448a54e85fdSJeff Roberson 			thread_unlock(td);
4491c4bcd05SJeff Roberson 			td2 = FIRST_THREAD_IN_PROC(p);
4501c4bcd05SJeff Roberson 			sched_exit_thread(td2, td);
451ed062c8dSJulian Elischer 
452ed062c8dSJulian Elischer 			/*
45344990b8cSJulian Elischer 			 * The test below is NOT true if we are the
4541faf202eSJulian Elischer 			 * sole exiting thread. P_STOPPED_SNGL is unset
45544990b8cSJulian Elischer 			 * in exit1() after it is the only survivor.
45644990b8cSJulian Elischer 			 */
4571279572aSDavid Xu 			if (P_SHOULDSTOP(p) == P_STOPPED_SINGLE) {
45844990b8cSJulian Elischer 				if (p->p_numthreads == p->p_suspcount) {
459a54e85fdSJeff Roberson 					thread_lock(p->p_singlethread);
46071fad9fdSJulian Elischer 					thread_unsuspend_one(p->p_singlethread);
461a54e85fdSJeff Roberson 					thread_unlock(p->p_singlethread);
46244990b8cSJulian Elischer 				}
46344990b8cSJulian Elischer 			}
46448bfcdddSJulian Elischer 
465ff8fbcffSJeff Roberson 			atomic_add_int(&td->td_proc->p_exitthreads, 1);
466696058c3SJulian Elischer 			PCPU_SET(deadthread, td);
4671faf202eSJulian Elischer 		} else {
468ed062c8dSJulian Elischer 			/*
469ed062c8dSJulian Elischer 			 * The last thread is exiting.. but not through exit()
470ed062c8dSJulian Elischer 			 * what should we do?
471ed062c8dSJulian Elischer 			 * Theoretically this can't happen
472ed062c8dSJulian Elischer  			 * exit1() - clears threading flags before coming here
473ed062c8dSJulian Elischer  			 * kse_exit() - treats last thread specially
474ed062c8dSJulian Elischer  			 * thr_exit() - treats last thread specially
4758460a577SJohn Birrell 			 * ifdef KSE
476ed062c8dSJulian Elischer  			 * thread_user_enter() - only if more exist
477ed062c8dSJulian Elischer  			 * thread_userret() - only if more exist
4788460a577SJohn Birrell 			 * endif
479ed062c8dSJulian Elischer  			 * thread_suspend_check() - only if more exist
480ed062c8dSJulian Elischer 			 */
481ed062c8dSJulian Elischer 			panic ("thread_exit: Last thread exiting on its own");
482ed062c8dSJulian Elischer 		}
4831faf202eSJulian Elischer 	}
484a54e85fdSJeff Roberson 	PROC_UNLOCK(p);
485a54e85fdSJeff Roberson 	thread_lock(td);
486a140976eSAttilio Rao 	/* Save our tick information with both the thread and proc locked */
487a54e85fdSJeff Roberson 	ruxagg(&p->p_rux, td);
488a54e85fdSJeff Roberson 	PROC_SUNLOCK(p);
489dcc9954eSJulian Elischer 	td->td_state = TDS_INACTIVE;
490732d9528SJulian Elischer 	CTR1(KTR_PROC, "thread_exit: cpu_throw() thread %p", td);
491a54e85fdSJeff Roberson 	sched_throw(td);
492cc66ebe2SPeter Wemm 	panic("I'm a teapot!");
49344990b8cSJulian Elischer 	/* NOTREACHED */
49444990b8cSJulian Elischer }
49544990b8cSJulian Elischer 
49644990b8cSJulian Elischer /*
497696058c3SJulian Elischer  * Do any thread specific cleanups that may be needed in wait()
49837814395SPeter Wemm  * called with Giant, proc and schedlock not held.
499696058c3SJulian Elischer  */
500696058c3SJulian Elischer void
501696058c3SJulian Elischer thread_wait(struct proc *p)
502696058c3SJulian Elischer {
503696058c3SJulian Elischer 	struct thread *td;
504696058c3SJulian Elischer 
50537814395SPeter Wemm 	mtx_assert(&Giant, MA_NOTOWNED);
50685495c72SJens Schweikhardt 	KASSERT((p->p_numthreads == 1), ("Multiple threads in wait1()"));
507ff8fbcffSJeff Roberson 	td = FIRST_THREAD_IN_PROC(p);
5088460a577SJohn Birrell #ifdef KSE
509696058c3SJulian Elischer 	if (td->td_standin != NULL) {
510b75b0311SJulian Elischer 		if (td->td_standin->td_ucred != NULL) {
511b75b0311SJulian Elischer 			crfree(td->td_standin->td_ucred);
512b75b0311SJulian Elischer 			td->td_standin->td_ucred = NULL;
513b75b0311SJulian Elischer 		}
514696058c3SJulian Elischer 		thread_free(td->td_standin);
515696058c3SJulian Elischer 		td->td_standin = NULL;
516696058c3SJulian Elischer 	}
5178460a577SJohn Birrell #endif
518ff8fbcffSJeff Roberson 	/* Lock the last thread so we spin until it exits cpu_throw(). */
519ff8fbcffSJeff Roberson 	thread_lock(td);
520ff8fbcffSJeff Roberson 	thread_unlock(td);
521ff8fbcffSJeff Roberson 	/* Wait for any remaining threads to exit cpu_throw(). */
522ff8fbcffSJeff Roberson 	while (p->p_exitthreads)
523ff8fbcffSJeff Roberson 		sched_relinquish(curthread);
524696058c3SJulian Elischer 	cpu_thread_clean(td);
525ed062c8dSJulian Elischer 	crfree(td->td_ucred);
526696058c3SJulian Elischer 	thread_reap();	/* check for zombie threads etc. */
527696058c3SJulian Elischer }
528696058c3SJulian Elischer 
529696058c3SJulian Elischer /*
53044990b8cSJulian Elischer  * Link a thread to a process.
5311faf202eSJulian Elischer  * set up anything that needs to be initialized for it to
5321faf202eSJulian Elischer  * be used by the process.
53344990b8cSJulian Elischer  *
53444990b8cSJulian Elischer  * Note that we do not link to the proc's ucred here.
53544990b8cSJulian Elischer  * The thread is linked as if running but no KSE assigned.
536ed062c8dSJulian Elischer  * Called from:
537ed062c8dSJulian Elischer  *  proc_linkup()
538ed062c8dSJulian Elischer  *  thread_schedule_upcall()
539ed062c8dSJulian Elischer  *  thr_create()
54044990b8cSJulian Elischer  */
54144990b8cSJulian Elischer void
5428460a577SJohn Birrell thread_link(struct thread *td, struct proc *p)
54344990b8cSJulian Elischer {
54444990b8cSJulian Elischer 
545a54e85fdSJeff Roberson 	/*
546a54e85fdSJeff Roberson 	 * XXX This can't be enabled because it's called for proc0 before
547a54e85fdSJeff Roberson 	 * it's spinlock has been created.
548a54e85fdSJeff Roberson 	 * PROC_SLOCK_ASSERT(p, MA_OWNED);
549a54e85fdSJeff Roberson 	 */
55071fad9fdSJulian Elischer 	td->td_state    = TDS_INACTIVE;
55144990b8cSJulian Elischer 	td->td_proc     = p;
552b61ce5b0SJeff Roberson 	td->td_flags    = TDF_INMEM;
55344990b8cSJulian Elischer 
5541faf202eSJulian Elischer 	LIST_INIT(&td->td_contested);
5559104847fSDavid Xu 	sigqueue_init(&td->td_sigqueue, p);
556c06eb4e2SSam Leffler 	callout_init(&td->td_slpcallout, CALLOUT_MPSAFE);
55744990b8cSJulian Elischer 	TAILQ_INSERT_HEAD(&p->p_threads, td, td_plist);
55844990b8cSJulian Elischer 	p->p_numthreads++;
55944990b8cSJulian Elischer }
56044990b8cSJulian Elischer 
561ed062c8dSJulian Elischer /*
562e5bedcefSJulian Elischer  * Convert a process with one thread to an unthreaded process.
563e5bedcefSJulian Elischer  * Called from:
564e5bedcefSJulian Elischer  *  thread_single(exit)  (called from execve and exit)
565e5bedcefSJulian Elischer  *  kse_exit()		XXX may need cleaning up wrt KSE stuff
566e5bedcefSJulian Elischer  */
567e5bedcefSJulian Elischer void
568e5bedcefSJulian Elischer thread_unthread(struct thread *td)
569e5bedcefSJulian Elischer {
570e5bedcefSJulian Elischer 	struct proc *p = td->td_proc;
571e5bedcefSJulian Elischer 
572e5bedcefSJulian Elischer 	KASSERT((p->p_numthreads == 1), ("Unthreading with >1 threads"));
5738460a577SJohn Birrell #ifdef KSE
574ac8094e4SAttilio Rao 	thread_lock(td);
575e5bedcefSJulian Elischer 	upcall_remove(td);
576ac8094e4SAttilio Rao 	thread_unlock(td);
577e5bedcefSJulian Elischer 	p->p_flag &= ~(P_SA|P_HADTHREADS);
578e5bedcefSJulian Elischer 	td->td_mailbox = NULL;
579e5bedcefSJulian Elischer 	td->td_pflags &= ~(TDP_SA | TDP_CAN_UNBIND);
580e5bedcefSJulian Elischer 	if (td->td_standin != NULL) {
581ff8fbcffSJeff Roberson 		thread_zombie(td->td_standin);
582e5bedcefSJulian Elischer 		td->td_standin = NULL;
583e5bedcefSJulian Elischer 	}
5848460a577SJohn Birrell #else
5858460a577SJohn Birrell 	p->p_flag &= ~P_HADTHREADS;
5868460a577SJohn Birrell #endif
587e5bedcefSJulian Elischer }
588e5bedcefSJulian Elischer 
589e5bedcefSJulian Elischer /*
590ed062c8dSJulian Elischer  * Called from:
591ed062c8dSJulian Elischer  *  thread_exit()
592ed062c8dSJulian Elischer  */
593d3a0bd78SJulian Elischer void
594d3a0bd78SJulian Elischer thread_unlink(struct thread *td)
595d3a0bd78SJulian Elischer {
596d3a0bd78SJulian Elischer 	struct proc *p = td->td_proc;
597d3a0bd78SJulian Elischer 
598a54e85fdSJeff Roberson 	PROC_SLOCK_ASSERT(p, MA_OWNED);
599d3a0bd78SJulian Elischer 	TAILQ_REMOVE(&p->p_threads, td, td_plist);
600d3a0bd78SJulian Elischer 	p->p_numthreads--;
601d3a0bd78SJulian Elischer 	/* could clear a few other things here */
6028460a577SJohn Birrell 	/* Must  NOT clear links to proc! */
6035c8329edSJulian Elischer }
6045c8329edSJulian Elischer 
6055215b187SJeff Roberson /*
60644990b8cSJulian Elischer  * Enforce single-threading.
60744990b8cSJulian Elischer  *
60844990b8cSJulian Elischer  * Returns 1 if the caller must abort (another thread is waiting to
60944990b8cSJulian Elischer  * exit the process or similar). Process is locked!
61044990b8cSJulian Elischer  * Returns 0 when you are successfully the only thread running.
61144990b8cSJulian Elischer  * A process has successfully single threaded in the suspend mode when
61244990b8cSJulian Elischer  * There are no threads in user mode. Threads in the kernel must be
61344990b8cSJulian Elischer  * allowed to continue until they get to the user boundary. They may even
61444990b8cSJulian Elischer  * copy out their return values and data before suspending. They may however be
615e2668f55SMaxim Konovalov  * accelerated in reaching the user boundary as we will wake up
61644990b8cSJulian Elischer  * any sleeping threads that are interruptable. (PCATCH).
61744990b8cSJulian Elischer  */
61844990b8cSJulian Elischer int
619906ac69dSDavid Xu thread_single(int mode)
62044990b8cSJulian Elischer {
62144990b8cSJulian Elischer 	struct thread *td;
62244990b8cSJulian Elischer 	struct thread *td2;
62344990b8cSJulian Elischer 	struct proc *p;
624ec008e96SDavid Xu 	int remaining;
62544990b8cSJulian Elischer 
62644990b8cSJulian Elischer 	td = curthread;
62744990b8cSJulian Elischer 	p = td->td_proc;
62837814395SPeter Wemm 	mtx_assert(&Giant, MA_NOTOWNED);
62944990b8cSJulian Elischer 	PROC_LOCK_ASSERT(p, MA_OWNED);
63044990b8cSJulian Elischer 	KASSERT((td != NULL), ("curthread is NULL"));
63144990b8cSJulian Elischer 
632ed062c8dSJulian Elischer 	if ((p->p_flag & P_HADTHREADS) == 0)
63344990b8cSJulian Elischer 		return (0);
63444990b8cSJulian Elischer 
635e3b9bf71SJulian Elischer 	/* Is someone already single threading? */
636906ac69dSDavid Xu 	if (p->p_singlethread != NULL && p->p_singlethread != td)
63744990b8cSJulian Elischer 		return (1);
63844990b8cSJulian Elischer 
639906ac69dSDavid Xu 	if (mode == SINGLE_EXIT) {
640906ac69dSDavid Xu 		p->p_flag |= P_SINGLE_EXIT;
641906ac69dSDavid Xu 		p->p_flag &= ~P_SINGLE_BOUNDARY;
642906ac69dSDavid Xu 	} else {
643906ac69dSDavid Xu 		p->p_flag &= ~P_SINGLE_EXIT;
644906ac69dSDavid Xu 		if (mode == SINGLE_BOUNDARY)
645906ac69dSDavid Xu 			p->p_flag |= P_SINGLE_BOUNDARY;
646906ac69dSDavid Xu 		else
647906ac69dSDavid Xu 			p->p_flag &= ~P_SINGLE_BOUNDARY;
648906ac69dSDavid Xu 	}
6491279572aSDavid Xu 	p->p_flag |= P_STOPPED_SINGLE;
650a54e85fdSJeff Roberson 	PROC_SLOCK(p);
651112afcb2SJohn Baldwin 	p->p_singlethread = td;
652906ac69dSDavid Xu 	if (mode == SINGLE_EXIT)
653ec008e96SDavid Xu 		remaining = p->p_numthreads;
654906ac69dSDavid Xu 	else if (mode == SINGLE_BOUNDARY)
655906ac69dSDavid Xu 		remaining = p->p_numthreads - p->p_boundary_count;
656906ac69dSDavid Xu 	else
657ec008e96SDavid Xu 		remaining = p->p_numthreads - p->p_suspcount;
658ec008e96SDavid Xu 	while (remaining != 1) {
659bf1a3220SDavid Xu 		if (P_SHOULDSTOP(p) != P_STOPPED_SINGLE)
660bf1a3220SDavid Xu 			goto stopme;
66144990b8cSJulian Elischer 		FOREACH_THREAD_IN_PROC(p, td2) {
66244990b8cSJulian Elischer 			if (td2 == td)
66344990b8cSJulian Elischer 				continue;
664a54e85fdSJeff Roberson 			thread_lock(td2);
665588257e8SDavid Xu 			td2->td_flags |= TDF_ASTPENDING;
66671fad9fdSJulian Elischer 			if (TD_IS_INHIBITED(td2)) {
667906ac69dSDavid Xu 				switch (mode) {
668906ac69dSDavid Xu 				case SINGLE_EXIT:
669cbf4e354SDavid Xu 					if (td->td_flags & TDF_DBSUSPEND)
670cbf4e354SDavid Xu 						td->td_flags &= ~TDF_DBSUSPEND;
671906ac69dSDavid Xu 					if (TD_IS_SUSPENDED(td2))
67271fad9fdSJulian Elischer 						thread_unsuspend_one(td2);
67333862f40SDavid Xu 					if (TD_ON_SLEEPQ(td2) &&
674906ac69dSDavid Xu 					    (td2->td_flags & TDF_SINTR))
67594f0972bSDavid Xu 						sleepq_abort(td2, EINTR);
676906ac69dSDavid Xu 					break;
677906ac69dSDavid Xu 				case SINGLE_BOUNDARY:
678906ac69dSDavid Xu 					break;
679906ac69dSDavid Xu 				default:
680a54e85fdSJeff Roberson 					if (TD_IS_SUSPENDED(td2)) {
681a54e85fdSJeff Roberson 						thread_unlock(td2);
6829d102777SJulian Elischer 						continue;
683a54e85fdSJeff Roberson 					}
6845215b187SJeff Roberson 					/*
6852da78e38SRobert Watson 					 * maybe other inhibited states too?
6865215b187SJeff Roberson 					 */
6878acf6057SDavid Xu 					if ((td2->td_flags & TDF_SINTR) &&
6888acf6057SDavid Xu 					    (td2->td_inhibitors &
6898acf6057SDavid Xu 					    (TDI_SLEEPING | TDI_SWAPPED)))
6909d102777SJulian Elischer 						thread_suspend_one(td2);
691906ac69dSDavid Xu 					break;
69244990b8cSJulian Elischer 				}
69344990b8cSJulian Elischer 			}
694d8267df7SDavid Xu #ifdef SMP
695d8267df7SDavid Xu 			else if (TD_IS_RUNNING(td2) && td != td2) {
696d8267df7SDavid Xu 				forward_signal(td2);
697d8267df7SDavid Xu 			}
698d8267df7SDavid Xu #endif
699a54e85fdSJeff Roberson 			thread_unlock(td2);
7009d102777SJulian Elischer 		}
701906ac69dSDavid Xu 		if (mode == SINGLE_EXIT)
702ec008e96SDavid Xu 			remaining = p->p_numthreads;
703906ac69dSDavid Xu 		else if (mode == SINGLE_BOUNDARY)
704906ac69dSDavid Xu 			remaining = p->p_numthreads - p->p_boundary_count;
705ec008e96SDavid Xu 		else
706ec008e96SDavid Xu 			remaining = p->p_numthreads - p->p_suspcount;
707ec008e96SDavid Xu 
7089d102777SJulian Elischer 		/*
7099d102777SJulian Elischer 		 * Maybe we suspended some threads.. was it enough?
7109d102777SJulian Elischer 		 */
711ec008e96SDavid Xu 		if (remaining == 1)
7129d102777SJulian Elischer 			break;
7139d102777SJulian Elischer 
714bf1a3220SDavid Xu stopme:
71544990b8cSJulian Elischer 		/*
71644990b8cSJulian Elischer 		 * Wake us up when everyone else has suspended.
717e3b9bf71SJulian Elischer 		 * In the mean time we suspend as well.
71844990b8cSJulian Elischer 		 */
719a54e85fdSJeff Roberson 		thread_suspend_switch(td);
720906ac69dSDavid Xu 		if (mode == SINGLE_EXIT)
721ec008e96SDavid Xu 			remaining = p->p_numthreads;
722906ac69dSDavid Xu 		else if (mode == SINGLE_BOUNDARY)
723906ac69dSDavid Xu 			remaining = p->p_numthreads - p->p_boundary_count;
724ec008e96SDavid Xu 		else
725ec008e96SDavid Xu 			remaining = p->p_numthreads - p->p_suspcount;
72644990b8cSJulian Elischer 	}
727906ac69dSDavid Xu 	if (mode == SINGLE_EXIT) {
72891599697SJulian Elischer 		/*
72991599697SJulian Elischer 		 * We have gotten rid of all the other threads and we
73091599697SJulian Elischer 		 * are about to either exit or exec. In either case,
73191599697SJulian Elischer 		 * we try our utmost  to revert to being a non-threaded
73291599697SJulian Elischer 		 * process.
73391599697SJulian Elischer 		 */
734ed062c8dSJulian Elischer 		p->p_singlethread = NULL;
73564895117SDavid Xu 		p->p_flag &= ~(P_STOPPED_SINGLE | P_SINGLE_EXIT);
736e5bedcefSJulian Elischer 		thread_unthread(td);
73791599697SJulian Elischer 	}
738a54e85fdSJeff Roberson 	PROC_SUNLOCK(p);
73944990b8cSJulian Elischer 	return (0);
74044990b8cSJulian Elischer }
74144990b8cSJulian Elischer 
74244990b8cSJulian Elischer /*
74344990b8cSJulian Elischer  * Called in from locations that can safely check to see
74444990b8cSJulian Elischer  * whether we have to suspend or at least throttle for a
74544990b8cSJulian Elischer  * single-thread event (e.g. fork).
74644990b8cSJulian Elischer  *
74744990b8cSJulian Elischer  * Such locations include userret().
74844990b8cSJulian Elischer  * If the "return_instead" argument is non zero, the thread must be able to
74944990b8cSJulian Elischer  * accept 0 (caller may continue), or 1 (caller must abort) as a result.
75044990b8cSJulian Elischer  *
75144990b8cSJulian Elischer  * The 'return_instead' argument tells the function if it may do a
75244990b8cSJulian Elischer  * thread_exit() or suspend, or whether the caller must abort and back
75344990b8cSJulian Elischer  * out instead.
75444990b8cSJulian Elischer  *
75544990b8cSJulian Elischer  * If the thread that set the single_threading request has set the
75644990b8cSJulian Elischer  * P_SINGLE_EXIT bit in the process flags then this call will never return
75744990b8cSJulian Elischer  * if 'return_instead' is false, but will exit.
75844990b8cSJulian Elischer  *
75944990b8cSJulian Elischer  * P_SINGLE_EXIT | return_instead == 0| return_instead != 0
76044990b8cSJulian Elischer  *---------------+--------------------+---------------------
76144990b8cSJulian Elischer  *       0       | returns 0          |   returns 0 or 1
76244990b8cSJulian Elischer  *               | when ST ends       |   immediatly
76344990b8cSJulian Elischer  *---------------+--------------------+---------------------
76444990b8cSJulian Elischer  *       1       | thread exits       |   returns 1
76544990b8cSJulian Elischer  *               |                    |  immediatly
76644990b8cSJulian Elischer  * 0 = thread_exit() or suspension ok,
76744990b8cSJulian Elischer  * other = return error instead of stopping the thread.
76844990b8cSJulian Elischer  *
76944990b8cSJulian Elischer  * While a full suspension is under effect, even a single threading
77044990b8cSJulian Elischer  * thread would be suspended if it made this call (but it shouldn't).
77144990b8cSJulian Elischer  * This call should only be made from places where
77244990b8cSJulian Elischer  * thread_exit() would be safe as that may be the outcome unless
77344990b8cSJulian Elischer  * return_instead is set.
77444990b8cSJulian Elischer  */
77544990b8cSJulian Elischer int
77644990b8cSJulian Elischer thread_suspend_check(int return_instead)
77744990b8cSJulian Elischer {
778ecafb24bSJuli Mallett 	struct thread *td;
779ecafb24bSJuli Mallett 	struct proc *p;
78044990b8cSJulian Elischer 
78144990b8cSJulian Elischer 	td = curthread;
78244990b8cSJulian Elischer 	p = td->td_proc;
78337814395SPeter Wemm 	mtx_assert(&Giant, MA_NOTOWNED);
78444990b8cSJulian Elischer 	PROC_LOCK_ASSERT(p, MA_OWNED);
785cbf4e354SDavid Xu 	while (P_SHOULDSTOP(p) ||
786cbf4e354SDavid Xu 	      ((p->p_flag & P_TRACED) && (td->td_flags & TDF_DBSUSPEND))) {
7871279572aSDavid Xu 		if (P_SHOULDSTOP(p) == P_STOPPED_SINGLE) {
78844990b8cSJulian Elischer 			KASSERT(p->p_singlethread != NULL,
78944990b8cSJulian Elischer 			    ("singlethread not set"));
79044990b8cSJulian Elischer 			/*
791e3b9bf71SJulian Elischer 			 * The only suspension in action is a
792e3b9bf71SJulian Elischer 			 * single-threading. Single threader need not stop.
793b6d5995eSJulian Elischer 			 * XXX Should be safe to access unlocked
794b6d5995eSJulian Elischer 			 * as it can only be set to be true by us.
79544990b8cSJulian Elischer 			 */
796e3b9bf71SJulian Elischer 			if (p->p_singlethread == td)
79744990b8cSJulian Elischer 				return (0);	/* Exempt from stopping. */
79844990b8cSJulian Elischer 		}
79945a4bfa1SDavid Xu 		if ((p->p_flag & P_SINGLE_EXIT) && return_instead)
80094f0972bSDavid Xu 			return (EINTR);
80144990b8cSJulian Elischer 
802906ac69dSDavid Xu 		/* Should we goto user boundary if we didn't come from there? */
803906ac69dSDavid Xu 		if (P_SHOULDSTOP(p) == P_STOPPED_SINGLE &&
804906ac69dSDavid Xu 		    (p->p_flag & P_SINGLE_BOUNDARY) && return_instead)
80594f0972bSDavid Xu 			return (ERESTART);
806906ac69dSDavid Xu 
8079104847fSDavid Xu 		/* If thread will exit, flush its pending signals */
8089104847fSDavid Xu 		if ((p->p_flag & P_SINGLE_EXIT) && (p->p_singlethread != td))
8099104847fSDavid Xu 			sigqueue_flush(&td->td_sigqueue);
8109104847fSDavid Xu 
811a54e85fdSJeff Roberson 		PROC_SLOCK(p);
812e574e444SDavid Xu 		thread_stopped(p);
81344990b8cSJulian Elischer 		/*
81444990b8cSJulian Elischer 		 * If the process is waiting for us to exit,
81544990b8cSJulian Elischer 		 * this thread should just suicide.
8161279572aSDavid Xu 		 * Assumes that P_SINGLE_EXIT implies P_STOPPED_SINGLE.
81744990b8cSJulian Elischer 		 */
818906ac69dSDavid Xu 		if ((p->p_flag & P_SINGLE_EXIT) && (p->p_singlethread != td))
81944990b8cSJulian Elischer 			thread_exit();
820a54e85fdSJeff Roberson 		if (P_SHOULDSTOP(p) == P_STOPPED_SINGLE) {
821a54e85fdSJeff Roberson 			if (p->p_numthreads == p->p_suspcount + 1) {
822a54e85fdSJeff Roberson 				thread_lock(p->p_singlethread);
823a54e85fdSJeff Roberson 				thread_unsuspend_one(p->p_singlethread);
824a54e85fdSJeff Roberson 				thread_unlock(p->p_singlethread);
825a54e85fdSJeff Roberson 			}
826a54e85fdSJeff Roberson 		}
827a54e85fdSJeff Roberson 		PROC_UNLOCK(p);
828a54e85fdSJeff Roberson 		thread_lock(td);
82944990b8cSJulian Elischer 		/*
83044990b8cSJulian Elischer 		 * When a thread suspends, it just
831ad1e7d28SJulian Elischer 		 * gets taken off all queues.
83244990b8cSJulian Elischer 		 */
83371fad9fdSJulian Elischer 		thread_suspend_one(td);
834906ac69dSDavid Xu 		if (return_instead == 0) {
835906ac69dSDavid Xu 			p->p_boundary_count++;
836906ac69dSDavid Xu 			td->td_flags |= TDF_BOUNDARY;
837cf19bf91SJulian Elischer 		}
838a54e85fdSJeff Roberson 		PROC_SUNLOCK(p);
839bf0acc27SJohn Baldwin 		mi_switch(SW_INVOL, NULL);
840a54e85fdSJeff Roberson 		if (return_instead == 0)
841906ac69dSDavid Xu 			td->td_flags &= ~TDF_BOUNDARY;
842a54e85fdSJeff Roberson 		thread_unlock(td);
84344990b8cSJulian Elischer 		PROC_LOCK(p);
844a54e85fdSJeff Roberson 		if (return_instead == 0)
845a54e85fdSJeff Roberson 			p->p_boundary_count--;
84644990b8cSJulian Elischer 	}
84744990b8cSJulian Elischer 	return (0);
84844990b8cSJulian Elischer }
84944990b8cSJulian Elischer 
85035c32a76SDavid Xu void
851a54e85fdSJeff Roberson thread_suspend_switch(struct thread *td)
852a54e85fdSJeff Roberson {
853a54e85fdSJeff Roberson 	struct proc *p;
854a54e85fdSJeff Roberson 
855a54e85fdSJeff Roberson 	p = td->td_proc;
856a54e85fdSJeff Roberson 	KASSERT(!TD_IS_SUSPENDED(td), ("already suspended"));
857a54e85fdSJeff Roberson 	PROC_LOCK_ASSERT(p, MA_OWNED);
858a54e85fdSJeff Roberson 	PROC_SLOCK_ASSERT(p, MA_OWNED);
859a54e85fdSJeff Roberson 	/*
860a54e85fdSJeff Roberson 	 * We implement thread_suspend_one in stages here to avoid
861a54e85fdSJeff Roberson 	 * dropping the proc lock while the thread lock is owned.
862a54e85fdSJeff Roberson 	 */
863a54e85fdSJeff Roberson 	thread_stopped(p);
864a54e85fdSJeff Roberson 	p->p_suspcount++;
865a54e85fdSJeff Roberson 	PROC_UNLOCK(p);
866a54e85fdSJeff Roberson 	thread_lock(td);
867f4625017SJeff Roberson 	sched_sleep(td);
868a54e85fdSJeff Roberson 	TD_SET_SUSPENDED(td);
869a54e85fdSJeff Roberson 	PROC_SUNLOCK(p);
870a54e85fdSJeff Roberson 	DROP_GIANT();
871a54e85fdSJeff Roberson 	mi_switch(SW_VOL, NULL);
872a54e85fdSJeff Roberson 	thread_unlock(td);
873a54e85fdSJeff Roberson 	PICKUP_GIANT();
874a54e85fdSJeff Roberson 	PROC_LOCK(p);
875a54e85fdSJeff Roberson 	PROC_SLOCK(p);
876a54e85fdSJeff Roberson }
877a54e85fdSJeff Roberson 
878a54e85fdSJeff Roberson void
87935c32a76SDavid Xu thread_suspend_one(struct thread *td)
88035c32a76SDavid Xu {
88135c32a76SDavid Xu 	struct proc *p = td->td_proc;
88235c32a76SDavid Xu 
883a54e85fdSJeff Roberson 	PROC_SLOCK_ASSERT(p, MA_OWNED);
884a54e85fdSJeff Roberson 	THREAD_LOCK_ASSERT(td, MA_OWNED);
885e574e444SDavid Xu 	KASSERT(!TD_IS_SUSPENDED(td), ("already suspended"));
88635c32a76SDavid Xu 	p->p_suspcount++;
887f4625017SJeff Roberson 	sched_sleep(td);
88871fad9fdSJulian Elischer 	TD_SET_SUSPENDED(td);
88935c32a76SDavid Xu }
89035c32a76SDavid Xu 
89135c32a76SDavid Xu void
89235c32a76SDavid Xu thread_unsuspend_one(struct thread *td)
89335c32a76SDavid Xu {
89435c32a76SDavid Xu 	struct proc *p = td->td_proc;
89535c32a76SDavid Xu 
896a54e85fdSJeff Roberson 	PROC_SLOCK_ASSERT(p, MA_OWNED);
897a54e85fdSJeff Roberson 	THREAD_LOCK_ASSERT(td, MA_OWNED);
898ad1e7d28SJulian Elischer 	KASSERT(TD_IS_SUSPENDED(td), ("Thread not suspended"));
89971fad9fdSJulian Elischer 	TD_CLR_SUSPENDED(td);
90035c32a76SDavid Xu 	p->p_suspcount--;
90171fad9fdSJulian Elischer 	setrunnable(td);
90235c32a76SDavid Xu }
90335c32a76SDavid Xu 
90444990b8cSJulian Elischer /*
90544990b8cSJulian Elischer  * Allow all threads blocked by single threading to continue running.
90644990b8cSJulian Elischer  */
90744990b8cSJulian Elischer void
90844990b8cSJulian Elischer thread_unsuspend(struct proc *p)
90944990b8cSJulian Elischer {
91044990b8cSJulian Elischer 	struct thread *td;
91144990b8cSJulian Elischer 
91244990b8cSJulian Elischer 	PROC_LOCK_ASSERT(p, MA_OWNED);
913a54e85fdSJeff Roberson 	PROC_SLOCK_ASSERT(p, MA_OWNED);
91444990b8cSJulian Elischer 	if (!P_SHOULDSTOP(p)) {
915ad1e7d28SJulian Elischer                 FOREACH_THREAD_IN_PROC(p, td) {
916a54e85fdSJeff Roberson 			thread_lock(td);
917ad1e7d28SJulian Elischer 			if (TD_IS_SUSPENDED(td)) {
91835c32a76SDavid Xu 				thread_unsuspend_one(td);
91944990b8cSJulian Elischer 			}
920a54e85fdSJeff Roberson 			thread_unlock(td);
921ad1e7d28SJulian Elischer 		}
9221279572aSDavid Xu 	} else if ((P_SHOULDSTOP(p) == P_STOPPED_SINGLE) &&
92344990b8cSJulian Elischer 	    (p->p_numthreads == p->p_suspcount)) {
92444990b8cSJulian Elischer 		/*
92544990b8cSJulian Elischer 		 * Stopping everything also did the job for the single
92644990b8cSJulian Elischer 		 * threading request. Now we've downgraded to single-threaded,
92744990b8cSJulian Elischer 		 * let it continue.
92844990b8cSJulian Elischer 		 */
929a54e85fdSJeff Roberson 		thread_lock(p->p_singlethread);
93035c32a76SDavid Xu 		thread_unsuspend_one(p->p_singlethread);
931a54e85fdSJeff Roberson 		thread_unlock(p->p_singlethread);
93244990b8cSJulian Elischer 	}
93344990b8cSJulian Elischer }
93444990b8cSJulian Elischer 
935ed062c8dSJulian Elischer /*
936ed062c8dSJulian Elischer  * End the single threading mode..
937ed062c8dSJulian Elischer  */
93844990b8cSJulian Elischer void
93944990b8cSJulian Elischer thread_single_end(void)
94044990b8cSJulian Elischer {
94144990b8cSJulian Elischer 	struct thread *td;
94244990b8cSJulian Elischer 	struct proc *p;
94344990b8cSJulian Elischer 
94444990b8cSJulian Elischer 	td = curthread;
94544990b8cSJulian Elischer 	p = td->td_proc;
94644990b8cSJulian Elischer 	PROC_LOCK_ASSERT(p, MA_OWNED);
947906ac69dSDavid Xu 	p->p_flag &= ~(P_STOPPED_SINGLE | P_SINGLE_EXIT | P_SINGLE_BOUNDARY);
948a54e85fdSJeff Roberson 	PROC_SLOCK(p);
94944990b8cSJulian Elischer 	p->p_singlethread = NULL;
95049539972SJulian Elischer 	/*
95149539972SJulian Elischer 	 * If there are other threads they mey now run,
95249539972SJulian Elischer 	 * unless of course there is a blanket 'stop order'
95349539972SJulian Elischer 	 * on the process. The single threader must be allowed
95449539972SJulian Elischer 	 * to continue however as this is a bad place to stop.
95549539972SJulian Elischer 	 */
95649539972SJulian Elischer 	if ((p->p_numthreads != 1) && (!P_SHOULDSTOP(p))) {
957ad1e7d28SJulian Elischer                 FOREACH_THREAD_IN_PROC(p, td) {
958a54e85fdSJeff Roberson 			thread_lock(td);
959ad1e7d28SJulian Elischer 			if (TD_IS_SUSPENDED(td)) {
96071fad9fdSJulian Elischer 				thread_unsuspend_one(td);
96144990b8cSJulian Elischer 			}
962a54e85fdSJeff Roberson 			thread_unlock(td);
96349539972SJulian Elischer 		}
964ad1e7d28SJulian Elischer 	}
965a54e85fdSJeff Roberson 	PROC_SUNLOCK(p);
96649539972SJulian Elischer }
9674fc21c09SDaniel Eischen 
96844355392SDavid Xu struct thread *
96944355392SDavid Xu thread_find(struct proc *p, lwpid_t tid)
97044355392SDavid Xu {
97144355392SDavid Xu 	struct thread *td;
97244355392SDavid Xu 
97344355392SDavid Xu 	PROC_LOCK_ASSERT(p, MA_OWNED);
974a54e85fdSJeff Roberson 	PROC_SLOCK(p);
97544355392SDavid Xu 	FOREACH_THREAD_IN_PROC(p, td) {
97644355392SDavid Xu 		if (td->td_tid == tid)
97744355392SDavid Xu 			break;
97844355392SDavid Xu 	}
979a54e85fdSJeff Roberson 	PROC_SUNLOCK(p);
98044355392SDavid Xu 	return (td);
98144355392SDavid Xu }
982