xref: /freebsd/sys/kern/kern_thread.c (revision dcf58f92e2c19a32fc171f763698e711c719badc)
1 /*-
2  * Copyright (C) 2001 Julian Elischer <julian@freebsd.org>.
3  *  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice(s), this list of conditions and the following disclaimer as
10  *    the first lines of this file unmodified other than the possible
11  *    addition of one or more copyright notices.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice(s), this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
22  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
23  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
26  * DAMAGE.
27  */
28 
29 #include "opt_witness.h"
30 #include "opt_hwpmc_hooks.h"
31 
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
34 
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/kernel.h>
38 #include <sys/lock.h>
39 #include <sys/mutex.h>
40 #include <sys/proc.h>
41 #include <sys/rangelock.h>
42 #include <sys/resourcevar.h>
43 #include <sys/sdt.h>
44 #include <sys/smp.h>
45 #include <sys/sched.h>
46 #include <sys/sleepqueue.h>
47 #include <sys/selinfo.h>
48 #include <sys/turnstile.h>
49 #include <sys/ktr.h>
50 #include <sys/rwlock.h>
51 #include <sys/umtx.h>
52 #include <sys/cpuset.h>
53 #ifdef	HWPMC_HOOKS
54 #include <sys/pmckern.h>
55 #endif
56 
57 #include <security/audit/audit.h>
58 
59 #include <vm/vm.h>
60 #include <vm/vm_extern.h>
61 #include <vm/uma.h>
62 #include <sys/eventhandler.h>
63 
64 SDT_PROVIDER_DECLARE(proc);
65 SDT_PROBE_DEFINE(proc, , , lwp__exit);
66 
67 
68 /*
69  * thread related storage.
70  */
71 static uma_zone_t thread_zone;
72 
73 TAILQ_HEAD(, thread) zombie_threads = TAILQ_HEAD_INITIALIZER(zombie_threads);
74 static struct mtx zombie_lock;
75 MTX_SYSINIT(zombie_lock, &zombie_lock, "zombie lock", MTX_SPIN);
76 
77 static void thread_zombie(struct thread *);
78 
79 #define TID_BUFFER_SIZE	1024
80 
81 struct mtx tid_lock;
82 static struct unrhdr *tid_unrhdr;
83 static lwpid_t tid_buffer[TID_BUFFER_SIZE];
84 static int tid_head, tid_tail;
85 static MALLOC_DEFINE(M_TIDHASH, "tidhash", "thread hash");
86 
87 struct	tidhashhead *tidhashtbl;
88 u_long	tidhash;
89 struct	rwlock tidhash_lock;
90 
91 static lwpid_t
92 tid_alloc(void)
93 {
94 	lwpid_t	tid;
95 
96 	tid = alloc_unr(tid_unrhdr);
97 	if (tid != -1)
98 		return (tid);
99 	mtx_lock(&tid_lock);
100 	if (tid_head == tid_tail) {
101 		mtx_unlock(&tid_lock);
102 		return (-1);
103 	}
104 	tid = tid_buffer[tid_head];
105 	tid_head = (tid_head + 1) % TID_BUFFER_SIZE;
106 	mtx_unlock(&tid_lock);
107 	return (tid);
108 }
109 
110 static void
111 tid_free(lwpid_t tid)
112 {
113 	lwpid_t tmp_tid = -1;
114 
115 	mtx_lock(&tid_lock);
116 	if ((tid_tail + 1) % TID_BUFFER_SIZE == tid_head) {
117 		tmp_tid = tid_buffer[tid_head];
118 		tid_head = (tid_head + 1) % TID_BUFFER_SIZE;
119 	}
120 	tid_buffer[tid_tail] = tid;
121 	tid_tail = (tid_tail + 1) % TID_BUFFER_SIZE;
122 	mtx_unlock(&tid_lock);
123 	if (tmp_tid != -1)
124 		free_unr(tid_unrhdr, tmp_tid);
125 }
126 
127 /*
128  * Prepare a thread for use.
129  */
130 static int
131 thread_ctor(void *mem, int size, void *arg, int flags)
132 {
133 	struct thread	*td;
134 
135 	td = (struct thread *)mem;
136 	td->td_state = TDS_INACTIVE;
137 	td->td_oncpu = NOCPU;
138 
139 	td->td_tid = tid_alloc();
140 
141 	/*
142 	 * Note that td_critnest begins life as 1 because the thread is not
143 	 * running and is thereby implicitly waiting to be on the receiving
144 	 * end of a context switch.
145 	 */
146 	td->td_critnest = 1;
147 	td->td_lend_user_pri = PRI_MAX;
148 	EVENTHANDLER_INVOKE(thread_ctor, td);
149 #ifdef AUDIT
150 	audit_thread_alloc(td);
151 #endif
152 	umtx_thread_alloc(td);
153 	return (0);
154 }
155 
156 /*
157  * Reclaim a thread after use.
158  */
159 static void
160 thread_dtor(void *mem, int size, void *arg)
161 {
162 	struct thread *td;
163 
164 	td = (struct thread *)mem;
165 
166 #ifdef INVARIANTS
167 	/* Verify that this thread is in a safe state to free. */
168 	switch (td->td_state) {
169 	case TDS_INHIBITED:
170 	case TDS_RUNNING:
171 	case TDS_CAN_RUN:
172 	case TDS_RUNQ:
173 		/*
174 		 * We must never unlink a thread that is in one of
175 		 * these states, because it is currently active.
176 		 */
177 		panic("bad state for thread unlinking");
178 		/* NOTREACHED */
179 	case TDS_INACTIVE:
180 		break;
181 	default:
182 		panic("bad thread state");
183 		/* NOTREACHED */
184 	}
185 #endif
186 #ifdef AUDIT
187 	audit_thread_free(td);
188 #endif
189 	/* Free all OSD associated to this thread. */
190 	osd_thread_exit(td);
191 
192 	EVENTHANDLER_INVOKE(thread_dtor, td);
193 	tid_free(td->td_tid);
194 }
195 
196 /*
197  * Initialize type-stable parts of a thread (when newly created).
198  */
199 static int
200 thread_init(void *mem, int size, int flags)
201 {
202 	struct thread *td;
203 
204 	td = (struct thread *)mem;
205 
206 	td->td_sleepqueue = sleepq_alloc();
207 	td->td_turnstile = turnstile_alloc();
208 	td->td_rlqe = NULL;
209 	EVENTHANDLER_INVOKE(thread_init, td);
210 	td->td_sched = (struct td_sched *)&td[1];
211 	umtx_thread_init(td);
212 	td->td_kstack = 0;
213 	return (0);
214 }
215 
216 /*
217  * Tear down type-stable parts of a thread (just before being discarded).
218  */
219 static void
220 thread_fini(void *mem, int size)
221 {
222 	struct thread *td;
223 
224 	td = (struct thread *)mem;
225 	EVENTHANDLER_INVOKE(thread_fini, td);
226 	rlqentry_free(td->td_rlqe);
227 	turnstile_free(td->td_turnstile);
228 	sleepq_free(td->td_sleepqueue);
229 	umtx_thread_fini(td);
230 	seltdfini(td);
231 }
232 
233 /*
234  * For a newly created process,
235  * link up all the structures and its initial threads etc.
236  * called from:
237  * {arch}/{arch}/machdep.c   {arch}_init(), init386() etc.
238  * proc_dtor() (should go away)
239  * proc_init()
240  */
241 void
242 proc_linkup0(struct proc *p, struct thread *td)
243 {
244 	TAILQ_INIT(&p->p_threads);	     /* all threads in proc */
245 	proc_linkup(p, td);
246 }
247 
248 void
249 proc_linkup(struct proc *p, struct thread *td)
250 {
251 
252 	sigqueue_init(&p->p_sigqueue, p);
253 	p->p_ksi = ksiginfo_alloc(1);
254 	if (p->p_ksi != NULL) {
255 		/* XXX p_ksi may be null if ksiginfo zone is not ready */
256 		p->p_ksi->ksi_flags = KSI_EXT | KSI_INS;
257 	}
258 	LIST_INIT(&p->p_mqnotifier);
259 	p->p_numthreads = 0;
260 	thread_link(td, p);
261 }
262 
263 /*
264  * Initialize global thread allocation resources.
265  */
266 void
267 threadinit(void)
268 {
269 
270 	mtx_init(&tid_lock, "TID lock", NULL, MTX_DEF);
271 
272 	/*
273 	 * pid_max cannot be greater than PID_MAX.
274 	 * leave one number for thread0.
275 	 */
276 	tid_unrhdr = new_unrhdr(PID_MAX + 2, INT_MAX, &tid_lock);
277 
278 	thread_zone = uma_zcreate("THREAD", sched_sizeof_thread(),
279 	    thread_ctor, thread_dtor, thread_init, thread_fini,
280 	    16 - 1, 0);
281 	tidhashtbl = hashinit(maxproc / 2, M_TIDHASH, &tidhash);
282 	rw_init(&tidhash_lock, "tidhash");
283 }
284 
285 /*
286  * Place an unused thread on the zombie list.
287  * Use the slpq as that must be unused by now.
288  */
289 void
290 thread_zombie(struct thread *td)
291 {
292 	mtx_lock_spin(&zombie_lock);
293 	TAILQ_INSERT_HEAD(&zombie_threads, td, td_slpq);
294 	mtx_unlock_spin(&zombie_lock);
295 }
296 
297 /*
298  * Release a thread that has exited after cpu_throw().
299  */
300 void
301 thread_stash(struct thread *td)
302 {
303 	atomic_subtract_rel_int(&td->td_proc->p_exitthreads, 1);
304 	thread_zombie(td);
305 }
306 
307 /*
308  * Reap zombie resources.
309  */
310 void
311 thread_reap(void)
312 {
313 	struct thread *td_first, *td_next;
314 
315 	/*
316 	 * Don't even bother to lock if none at this instant,
317 	 * we really don't care about the next instant..
318 	 */
319 	if (!TAILQ_EMPTY(&zombie_threads)) {
320 		mtx_lock_spin(&zombie_lock);
321 		td_first = TAILQ_FIRST(&zombie_threads);
322 		if (td_first)
323 			TAILQ_INIT(&zombie_threads);
324 		mtx_unlock_spin(&zombie_lock);
325 		while (td_first) {
326 			td_next = TAILQ_NEXT(td_first, td_slpq);
327 			if (td_first->td_ucred)
328 				crfree(td_first->td_ucred);
329 			thread_free(td_first);
330 			td_first = td_next;
331 		}
332 	}
333 }
334 
335 /*
336  * Allocate a thread.
337  */
338 struct thread *
339 thread_alloc(int pages)
340 {
341 	struct thread *td;
342 
343 	thread_reap(); /* check if any zombies to get */
344 
345 	td = (struct thread *)uma_zalloc(thread_zone, M_WAITOK);
346 	KASSERT(td->td_kstack == 0, ("thread_alloc got thread with kstack"));
347 	if (!vm_thread_new(td, pages)) {
348 		uma_zfree(thread_zone, td);
349 		return (NULL);
350 	}
351 	cpu_thread_alloc(td);
352 	return (td);
353 }
354 
355 int
356 thread_alloc_stack(struct thread *td, int pages)
357 {
358 
359 	KASSERT(td->td_kstack == 0,
360 	    ("thread_alloc_stack called on a thread with kstack"));
361 	if (!vm_thread_new(td, pages))
362 		return (0);
363 	cpu_thread_alloc(td);
364 	return (1);
365 }
366 
367 /*
368  * Deallocate a thread.
369  */
370 void
371 thread_free(struct thread *td)
372 {
373 
374 	lock_profile_thread_exit(td);
375 	if (td->td_cpuset)
376 		cpuset_rel(td->td_cpuset);
377 	td->td_cpuset = NULL;
378 	cpu_thread_free(td);
379 	if (td->td_kstack != 0)
380 		vm_thread_dispose(td);
381 	uma_zfree(thread_zone, td);
382 }
383 
384 /*
385  * Discard the current thread and exit from its context.
386  * Always called with scheduler locked.
387  *
388  * Because we can't free a thread while we're operating under its context,
389  * push the current thread into our CPU's deadthread holder. This means
390  * we needn't worry about someone else grabbing our context before we
391  * do a cpu_throw().
392  */
393 void
394 thread_exit(void)
395 {
396 	uint64_t runtime, new_switchtime;
397 	struct thread *td;
398 	struct thread *td2;
399 	struct proc *p;
400 	int wakeup_swapper;
401 
402 	td = curthread;
403 	p = td->td_proc;
404 
405 	PROC_SLOCK_ASSERT(p, MA_OWNED);
406 	mtx_assert(&Giant, MA_NOTOWNED);
407 
408 	PROC_LOCK_ASSERT(p, MA_OWNED);
409 	KASSERT(p != NULL, ("thread exiting without a process"));
410 	CTR3(KTR_PROC, "thread_exit: thread %p (pid %ld, %s)", td,
411 	    (long)p->p_pid, td->td_name);
412 	KASSERT(TAILQ_EMPTY(&td->td_sigqueue.sq_list), ("signal pending"));
413 
414 #ifdef AUDIT
415 	AUDIT_SYSCALL_EXIT(0, td);
416 #endif
417 	umtx_thread_exit(td);
418 	/*
419 	 * drop FPU & debug register state storage, or any other
420 	 * architecture specific resources that
421 	 * would not be on a new untouched process.
422 	 */
423 	cpu_thread_exit(td);	/* XXXSMP */
424 
425 	/*
426 	 * The last thread is left attached to the process
427 	 * So that the whole bundle gets recycled. Skip
428 	 * all this stuff if we never had threads.
429 	 * EXIT clears all sign of other threads when
430 	 * it goes to single threading, so the last thread always
431 	 * takes the short path.
432 	 */
433 	if (p->p_flag & P_HADTHREADS) {
434 		if (p->p_numthreads > 1) {
435 			atomic_add_int(&td->td_proc->p_exitthreads, 1);
436 			thread_unlink(td);
437 			td2 = FIRST_THREAD_IN_PROC(p);
438 			sched_exit_thread(td2, td);
439 
440 			/*
441 			 * The test below is NOT true if we are the
442 			 * sole exiting thread. P_STOPPED_SINGLE is unset
443 			 * in exit1() after it is the only survivor.
444 			 */
445 			if (P_SHOULDSTOP(p) == P_STOPPED_SINGLE) {
446 				if (p->p_numthreads == p->p_suspcount) {
447 					thread_lock(p->p_singlethread);
448 					wakeup_swapper = thread_unsuspend_one(
449 						p->p_singlethread);
450 					thread_unlock(p->p_singlethread);
451 					if (wakeup_swapper)
452 						kick_proc0();
453 				}
454 			}
455 
456 			PCPU_SET(deadthread, td);
457 		} else {
458 			/*
459 			 * The last thread is exiting.. but not through exit()
460 			 */
461 			panic ("thread_exit: Last thread exiting on its own");
462 		}
463 	}
464 #ifdef	HWPMC_HOOKS
465 	/*
466 	 * If this thread is part of a process that is being tracked by hwpmc(4),
467 	 * inform the module of the thread's impending exit.
468 	 */
469 	if (PMC_PROC_IS_USING_PMCS(td->td_proc))
470 		PMC_SWITCH_CONTEXT(td, PMC_FN_CSW_OUT);
471 #endif
472 	PROC_UNLOCK(p);
473 	PROC_STATLOCK(p);
474 	thread_lock(td);
475 	PROC_SUNLOCK(p);
476 
477 	/* Do the same timestamp bookkeeping that mi_switch() would do. */
478 	new_switchtime = cpu_ticks();
479 	runtime = new_switchtime - PCPU_GET(switchtime);
480 	td->td_runtime += runtime;
481 	td->td_incruntime += runtime;
482 	PCPU_SET(switchtime, new_switchtime);
483 	PCPU_SET(switchticks, ticks);
484 	PCPU_INC(cnt.v_swtch);
485 
486 	/* Save our resource usage in our process. */
487 	td->td_ru.ru_nvcsw++;
488 	ruxagg(p, td);
489 	rucollect(&p->p_ru, &td->td_ru);
490 	PROC_STATUNLOCK(p);
491 
492 	td->td_state = TDS_INACTIVE;
493 #ifdef WITNESS
494 	witness_thread_exit(td);
495 #endif
496 	CTR1(KTR_PROC, "thread_exit: cpu_throw() thread %p", td);
497 	sched_throw(td);
498 	panic("I'm a teapot!");
499 	/* NOTREACHED */
500 }
501 
502 /*
503  * Do any thread specific cleanups that may be needed in wait()
504  * called with Giant, proc and schedlock not held.
505  */
506 void
507 thread_wait(struct proc *p)
508 {
509 	struct thread *td;
510 
511 	mtx_assert(&Giant, MA_NOTOWNED);
512 	KASSERT(p->p_numthreads == 1, ("multiple threads in thread_wait()"));
513 	KASSERT(p->p_exitthreads == 0, ("p_exitthreads leaking"));
514 	td = FIRST_THREAD_IN_PROC(p);
515 	/* Lock the last thread so we spin until it exits cpu_throw(). */
516 	thread_lock(td);
517 	thread_unlock(td);
518 	lock_profile_thread_exit(td);
519 	cpuset_rel(td->td_cpuset);
520 	td->td_cpuset = NULL;
521 	cpu_thread_clean(td);
522 	crfree(td->td_ucred);
523 	thread_reap();	/* check for zombie threads etc. */
524 }
525 
526 /*
527  * Link a thread to a process.
528  * set up anything that needs to be initialized for it to
529  * be used by the process.
530  */
531 void
532 thread_link(struct thread *td, struct proc *p)
533 {
534 
535 	/*
536 	 * XXX This can't be enabled because it's called for proc0 before
537 	 * its lock has been created.
538 	 * PROC_LOCK_ASSERT(p, MA_OWNED);
539 	 */
540 	td->td_state    = TDS_INACTIVE;
541 	td->td_proc     = p;
542 	td->td_flags    = TDF_INMEM;
543 
544 	LIST_INIT(&td->td_contested);
545 	LIST_INIT(&td->td_lprof[0]);
546 	LIST_INIT(&td->td_lprof[1]);
547 	sigqueue_init(&td->td_sigqueue, p);
548 	callout_init(&td->td_slpcallout, CALLOUT_MPSAFE);
549 	TAILQ_INSERT_TAIL(&p->p_threads, td, td_plist);
550 	p->p_numthreads++;
551 }
552 
553 /*
554  * Called from:
555  *  thread_exit()
556  */
557 void
558 thread_unlink(struct thread *td)
559 {
560 	struct proc *p = td->td_proc;
561 
562 	PROC_LOCK_ASSERT(p, MA_OWNED);
563 	TAILQ_REMOVE(&p->p_threads, td, td_plist);
564 	p->p_numthreads--;
565 	/* could clear a few other things here */
566 	/* Must  NOT clear links to proc! */
567 }
568 
569 static int
570 calc_remaining(struct proc *p, int mode)
571 {
572 	int remaining;
573 
574 	PROC_LOCK_ASSERT(p, MA_OWNED);
575 	PROC_SLOCK_ASSERT(p, MA_OWNED);
576 	if (mode == SINGLE_EXIT)
577 		remaining = p->p_numthreads;
578 	else if (mode == SINGLE_BOUNDARY)
579 		remaining = p->p_numthreads - p->p_boundary_count;
580 	else if (mode == SINGLE_NO_EXIT)
581 		remaining = p->p_numthreads - p->p_suspcount;
582 	else
583 		panic("calc_remaining: wrong mode %d", mode);
584 	return (remaining);
585 }
586 
587 /*
588  * Enforce single-threading.
589  *
590  * Returns 1 if the caller must abort (another thread is waiting to
591  * exit the process or similar). Process is locked!
592  * Returns 0 when you are successfully the only thread running.
593  * A process has successfully single threaded in the suspend mode when
594  * There are no threads in user mode. Threads in the kernel must be
595  * allowed to continue until they get to the user boundary. They may even
596  * copy out their return values and data before suspending. They may however be
597  * accelerated in reaching the user boundary as we will wake up
598  * any sleeping threads that are interruptable. (PCATCH).
599  */
600 int
601 thread_single(int mode)
602 {
603 	struct thread *td;
604 	struct thread *td2;
605 	struct proc *p;
606 	int remaining, wakeup_swapper;
607 
608 	td = curthread;
609 	p = td->td_proc;
610 	mtx_assert(&Giant, MA_NOTOWNED);
611 	PROC_LOCK_ASSERT(p, MA_OWNED);
612 
613 	if ((p->p_flag & P_HADTHREADS) == 0)
614 		return (0);
615 
616 	/* Is someone already single threading? */
617 	if (p->p_singlethread != NULL && p->p_singlethread != td)
618 		return (1);
619 
620 	if (mode == SINGLE_EXIT) {
621 		p->p_flag |= P_SINGLE_EXIT;
622 		p->p_flag &= ~P_SINGLE_BOUNDARY;
623 	} else {
624 		p->p_flag &= ~P_SINGLE_EXIT;
625 		if (mode == SINGLE_BOUNDARY)
626 			p->p_flag |= P_SINGLE_BOUNDARY;
627 		else
628 			p->p_flag &= ~P_SINGLE_BOUNDARY;
629 	}
630 	p->p_flag |= P_STOPPED_SINGLE;
631 	PROC_SLOCK(p);
632 	p->p_singlethread = td;
633 	remaining = calc_remaining(p, mode);
634 	while (remaining != 1) {
635 		if (P_SHOULDSTOP(p) != P_STOPPED_SINGLE)
636 			goto stopme;
637 		wakeup_swapper = 0;
638 		FOREACH_THREAD_IN_PROC(p, td2) {
639 			if (td2 == td)
640 				continue;
641 			thread_lock(td2);
642 			td2->td_flags |= TDF_ASTPENDING | TDF_NEEDSUSPCHK;
643 			if (TD_IS_INHIBITED(td2)) {
644 				switch (mode) {
645 				case SINGLE_EXIT:
646 					if (TD_IS_SUSPENDED(td2))
647 						wakeup_swapper |=
648 						    thread_unsuspend_one(td2);
649 					if (TD_ON_SLEEPQ(td2) &&
650 					    (td2->td_flags & TDF_SINTR))
651 						wakeup_swapper |=
652 						    sleepq_abort(td2, EINTR);
653 					break;
654 				case SINGLE_BOUNDARY:
655 					if (TD_IS_SUSPENDED(td2) &&
656 					    !(td2->td_flags & TDF_BOUNDARY))
657 						wakeup_swapper |=
658 						    thread_unsuspend_one(td2);
659 					if (TD_ON_SLEEPQ(td2) &&
660 					    (td2->td_flags & TDF_SINTR))
661 						wakeup_swapper |=
662 						    sleepq_abort(td2, ERESTART);
663 					break;
664 				case SINGLE_NO_EXIT:
665 					if (TD_IS_SUSPENDED(td2) &&
666 					    !(td2->td_flags & TDF_BOUNDARY))
667 						wakeup_swapper |=
668 						    thread_unsuspend_one(td2);
669 					if (TD_ON_SLEEPQ(td2) &&
670 					    (td2->td_flags & TDF_SINTR))
671 						wakeup_swapper |=
672 						    sleepq_abort(td2, ERESTART);
673 					break;
674 				default:
675 					break;
676 				}
677 			}
678 #ifdef SMP
679 			else if (TD_IS_RUNNING(td2) && td != td2) {
680 				forward_signal(td2);
681 			}
682 #endif
683 			thread_unlock(td2);
684 		}
685 		if (wakeup_swapper)
686 			kick_proc0();
687 		remaining = calc_remaining(p, mode);
688 
689 		/*
690 		 * Maybe we suspended some threads.. was it enough?
691 		 */
692 		if (remaining == 1)
693 			break;
694 
695 stopme:
696 		/*
697 		 * Wake us up when everyone else has suspended.
698 		 * In the mean time we suspend as well.
699 		 */
700 		thread_suspend_switch(td);
701 		remaining = calc_remaining(p, mode);
702 	}
703 	if (mode == SINGLE_EXIT) {
704 		/*
705 		 * Convert the process to an unthreaded process.  The
706 		 * SINGLE_EXIT is called by exit1() or execve(), in
707 		 * both cases other threads must be retired.
708 		 */
709 		KASSERT(p->p_numthreads == 1, ("Unthreading with >1 threads"));
710 		p->p_singlethread = NULL;
711 		p->p_flag &= ~(P_STOPPED_SINGLE | P_SINGLE_EXIT | P_HADTHREADS);
712 
713 		/*
714 		 * Wait for any remaining threads to exit cpu_throw().
715 		 */
716 		while (p->p_exitthreads != 0) {
717 			PROC_SUNLOCK(p);
718 			PROC_UNLOCK(p);
719 			sched_relinquish(td);
720 			PROC_LOCK(p);
721 			PROC_SLOCK(p);
722 		}
723 	}
724 	PROC_SUNLOCK(p);
725 	return (0);
726 }
727 
728 /*
729  * Called in from locations that can safely check to see
730  * whether we have to suspend or at least throttle for a
731  * single-thread event (e.g. fork).
732  *
733  * Such locations include userret().
734  * If the "return_instead" argument is non zero, the thread must be able to
735  * accept 0 (caller may continue), or 1 (caller must abort) as a result.
736  *
737  * The 'return_instead' argument tells the function if it may do a
738  * thread_exit() or suspend, or whether the caller must abort and back
739  * out instead.
740  *
741  * If the thread that set the single_threading request has set the
742  * P_SINGLE_EXIT bit in the process flags then this call will never return
743  * if 'return_instead' is false, but will exit.
744  *
745  * P_SINGLE_EXIT | return_instead == 0| return_instead != 0
746  *---------------+--------------------+---------------------
747  *       0       | returns 0          |   returns 0 or 1
748  *               | when ST ends       |   immediately
749  *---------------+--------------------+---------------------
750  *       1       | thread exits       |   returns 1
751  *               |                    |  immediately
752  * 0 = thread_exit() or suspension ok,
753  * other = return error instead of stopping the thread.
754  *
755  * While a full suspension is under effect, even a single threading
756  * thread would be suspended if it made this call (but it shouldn't).
757  * This call should only be made from places where
758  * thread_exit() would be safe as that may be the outcome unless
759  * return_instead is set.
760  */
761 int
762 thread_suspend_check(int return_instead)
763 {
764 	struct thread *td;
765 	struct proc *p;
766 	int wakeup_swapper;
767 
768 	td = curthread;
769 	p = td->td_proc;
770 	mtx_assert(&Giant, MA_NOTOWNED);
771 	PROC_LOCK_ASSERT(p, MA_OWNED);
772 	while (P_SHOULDSTOP(p) ||
773 	      ((p->p_flag & P_TRACED) && (td->td_dbgflags & TDB_SUSPEND))) {
774 		if (P_SHOULDSTOP(p) == P_STOPPED_SINGLE) {
775 			KASSERT(p->p_singlethread != NULL,
776 			    ("singlethread not set"));
777 			/*
778 			 * The only suspension in action is a
779 			 * single-threading. Single threader need not stop.
780 			 * XXX Should be safe to access unlocked
781 			 * as it can only be set to be true by us.
782 			 */
783 			if (p->p_singlethread == td)
784 				return (0);	/* Exempt from stopping. */
785 		}
786 		if ((p->p_flag & P_SINGLE_EXIT) && return_instead)
787 			return (EINTR);
788 
789 		/* Should we goto user boundary if we didn't come from there? */
790 		if (P_SHOULDSTOP(p) == P_STOPPED_SINGLE &&
791 		    (p->p_flag & P_SINGLE_BOUNDARY) && return_instead)
792 			return (ERESTART);
793 
794 		/*
795 		 * Ignore suspend requests for stop signals if they
796 		 * are deferred.
797 		 */
798 		if (P_SHOULDSTOP(p) == P_STOPPED_SIG &&
799 		    td->td_flags & TDF_SBDRY) {
800 			KASSERT(return_instead,
801 			    ("TDF_SBDRY set for unsafe thread_suspend_check"));
802 			return (0);
803 		}
804 
805 		/*
806 		 * If the process is waiting for us to exit,
807 		 * this thread should just suicide.
808 		 * Assumes that P_SINGLE_EXIT implies P_STOPPED_SINGLE.
809 		 */
810 		if ((p->p_flag & P_SINGLE_EXIT) && (p->p_singlethread != td)) {
811 			PROC_UNLOCK(p);
812 			tidhash_remove(td);
813 			PROC_LOCK(p);
814 			tdsigcleanup(td);
815 			PROC_SLOCK(p);
816 			thread_stopped(p);
817 			thread_exit();
818 		}
819 
820 		PROC_SLOCK(p);
821 		thread_stopped(p);
822 		if (P_SHOULDSTOP(p) == P_STOPPED_SINGLE) {
823 			if (p->p_numthreads == p->p_suspcount + 1) {
824 				thread_lock(p->p_singlethread);
825 				wakeup_swapper =
826 				    thread_unsuspend_one(p->p_singlethread);
827 				thread_unlock(p->p_singlethread);
828 				if (wakeup_swapper)
829 					kick_proc0();
830 			}
831 		}
832 		PROC_UNLOCK(p);
833 		thread_lock(td);
834 		/*
835 		 * When a thread suspends, it just
836 		 * gets taken off all queues.
837 		 */
838 		thread_suspend_one(td);
839 		if (return_instead == 0) {
840 			p->p_boundary_count++;
841 			td->td_flags |= TDF_BOUNDARY;
842 		}
843 		PROC_SUNLOCK(p);
844 		mi_switch(SW_INVOL | SWT_SUSPEND, NULL);
845 		if (return_instead == 0)
846 			td->td_flags &= ~TDF_BOUNDARY;
847 		thread_unlock(td);
848 		PROC_LOCK(p);
849 		if (return_instead == 0) {
850 			PROC_SLOCK(p);
851 			p->p_boundary_count--;
852 			PROC_SUNLOCK(p);
853 		}
854 	}
855 	return (0);
856 }
857 
858 void
859 thread_suspend_switch(struct thread *td)
860 {
861 	struct proc *p;
862 
863 	p = td->td_proc;
864 	KASSERT(!TD_IS_SUSPENDED(td), ("already suspended"));
865 	PROC_LOCK_ASSERT(p, MA_OWNED);
866 	PROC_SLOCK_ASSERT(p, MA_OWNED);
867 	/*
868 	 * We implement thread_suspend_one in stages here to avoid
869 	 * dropping the proc lock while the thread lock is owned.
870 	 */
871 	thread_stopped(p);
872 	p->p_suspcount++;
873 	PROC_UNLOCK(p);
874 	thread_lock(td);
875 	td->td_flags &= ~TDF_NEEDSUSPCHK;
876 	TD_SET_SUSPENDED(td);
877 	sched_sleep(td, 0);
878 	PROC_SUNLOCK(p);
879 	DROP_GIANT();
880 	mi_switch(SW_VOL | SWT_SUSPEND, NULL);
881 	thread_unlock(td);
882 	PICKUP_GIANT();
883 	PROC_LOCK(p);
884 	PROC_SLOCK(p);
885 }
886 
887 void
888 thread_suspend_one(struct thread *td)
889 {
890 	struct proc *p = td->td_proc;
891 
892 	PROC_SLOCK_ASSERT(p, MA_OWNED);
893 	THREAD_LOCK_ASSERT(td, MA_OWNED);
894 	KASSERT(!TD_IS_SUSPENDED(td), ("already suspended"));
895 	p->p_suspcount++;
896 	td->td_flags &= ~TDF_NEEDSUSPCHK;
897 	TD_SET_SUSPENDED(td);
898 	sched_sleep(td, 0);
899 }
900 
901 int
902 thread_unsuspend_one(struct thread *td)
903 {
904 	struct proc *p = td->td_proc;
905 
906 	PROC_SLOCK_ASSERT(p, MA_OWNED);
907 	THREAD_LOCK_ASSERT(td, MA_OWNED);
908 	KASSERT(TD_IS_SUSPENDED(td), ("Thread not suspended"));
909 	TD_CLR_SUSPENDED(td);
910 	p->p_suspcount--;
911 	return (setrunnable(td));
912 }
913 
914 /*
915  * Allow all threads blocked by single threading to continue running.
916  */
917 void
918 thread_unsuspend(struct proc *p)
919 {
920 	struct thread *td;
921 	int wakeup_swapper;
922 
923 	PROC_LOCK_ASSERT(p, MA_OWNED);
924 	PROC_SLOCK_ASSERT(p, MA_OWNED);
925 	wakeup_swapper = 0;
926 	if (!P_SHOULDSTOP(p)) {
927                 FOREACH_THREAD_IN_PROC(p, td) {
928 			thread_lock(td);
929 			if (TD_IS_SUSPENDED(td)) {
930 				wakeup_swapper |= thread_unsuspend_one(td);
931 			}
932 			thread_unlock(td);
933 		}
934 	} else if ((P_SHOULDSTOP(p) == P_STOPPED_SINGLE) &&
935 	    (p->p_numthreads == p->p_suspcount)) {
936 		/*
937 		 * Stopping everything also did the job for the single
938 		 * threading request. Now we've downgraded to single-threaded,
939 		 * let it continue.
940 		 */
941 		thread_lock(p->p_singlethread);
942 		wakeup_swapper = thread_unsuspend_one(p->p_singlethread);
943 		thread_unlock(p->p_singlethread);
944 	}
945 	if (wakeup_swapper)
946 		kick_proc0();
947 }
948 
949 /*
950  * End the single threading mode..
951  */
952 void
953 thread_single_end(void)
954 {
955 	struct thread *td;
956 	struct proc *p;
957 	int wakeup_swapper;
958 
959 	td = curthread;
960 	p = td->td_proc;
961 	PROC_LOCK_ASSERT(p, MA_OWNED);
962 	p->p_flag &= ~(P_STOPPED_SINGLE | P_SINGLE_EXIT | P_SINGLE_BOUNDARY);
963 	PROC_SLOCK(p);
964 	p->p_singlethread = NULL;
965 	wakeup_swapper = 0;
966 	/*
967 	 * If there are other threads they may now run,
968 	 * unless of course there is a blanket 'stop order'
969 	 * on the process. The single threader must be allowed
970 	 * to continue however as this is a bad place to stop.
971 	 */
972 	if ((p->p_numthreads != 1) && (!P_SHOULDSTOP(p))) {
973                 FOREACH_THREAD_IN_PROC(p, td) {
974 			thread_lock(td);
975 			if (TD_IS_SUSPENDED(td)) {
976 				wakeup_swapper |= thread_unsuspend_one(td);
977 			}
978 			thread_unlock(td);
979 		}
980 	}
981 	PROC_SUNLOCK(p);
982 	if (wakeup_swapper)
983 		kick_proc0();
984 }
985 
986 struct thread *
987 thread_find(struct proc *p, lwpid_t tid)
988 {
989 	struct thread *td;
990 
991 	PROC_LOCK_ASSERT(p, MA_OWNED);
992 	FOREACH_THREAD_IN_PROC(p, td) {
993 		if (td->td_tid == tid)
994 			break;
995 	}
996 	return (td);
997 }
998 
999 /* Locate a thread by number; return with proc lock held. */
1000 struct thread *
1001 tdfind(lwpid_t tid, pid_t pid)
1002 {
1003 #define RUN_THRESH	16
1004 	struct thread *td;
1005 	int run = 0;
1006 
1007 	rw_rlock(&tidhash_lock);
1008 	LIST_FOREACH(td, TIDHASH(tid), td_hash) {
1009 		if (td->td_tid == tid) {
1010 			if (pid != -1 && td->td_proc->p_pid != pid) {
1011 				td = NULL;
1012 				break;
1013 			}
1014 			PROC_LOCK(td->td_proc);
1015 			if (td->td_proc->p_state == PRS_NEW) {
1016 				PROC_UNLOCK(td->td_proc);
1017 				td = NULL;
1018 				break;
1019 			}
1020 			if (run > RUN_THRESH) {
1021 				if (rw_try_upgrade(&tidhash_lock)) {
1022 					LIST_REMOVE(td, td_hash);
1023 					LIST_INSERT_HEAD(TIDHASH(td->td_tid),
1024 						td, td_hash);
1025 					rw_wunlock(&tidhash_lock);
1026 					return (td);
1027 				}
1028 			}
1029 			break;
1030 		}
1031 		run++;
1032 	}
1033 	rw_runlock(&tidhash_lock);
1034 	return (td);
1035 }
1036 
1037 void
1038 tidhash_add(struct thread *td)
1039 {
1040 	rw_wlock(&tidhash_lock);
1041 	LIST_INSERT_HEAD(TIDHASH(td->td_tid), td, td_hash);
1042 	rw_wunlock(&tidhash_lock);
1043 }
1044 
1045 void
1046 tidhash_remove(struct thread *td)
1047 {
1048 	rw_wlock(&tidhash_lock);
1049 	LIST_REMOVE(td, td_hash);
1050 	rw_wunlock(&tidhash_lock);
1051 }
1052