4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright 2010 Sun Microsystems, Inc. All rights reserved.
24 * Use is subject to license terms.
31 #include <sys/types.h>
32 #include <sys/t_lock.h>
35 #include <sys/signal.h>
37 #if defined(__GNUC__) && defined(_ASM_INLINES) && defined(_KERNEL)
38 #include <asm/thread.h>
46 * The thread object, its states, and the methods by which it
51 * Values that t_state may assume. Note that t_state cannot have more
52 * than one of these flags set at a time.
54 #define TS_FREE 0x00 /* Thread at loose ends */
55 #define TS_SLEEP 0x01 /* Awaiting an event */
56 #define TS_RUN 0x02 /* Runnable, but not yet on a processor */
57 #define TS_ONPROC 0x04 /* Thread is being run on a processor */
58 #define TS_ZOMB 0x08 /* Thread has died but hasn't been reaped */
59 #define TS_STOPPED 0x10 /* Stopped, initial state */
60 #define TS_WAIT 0x20 /* Waiting to become runnable */
62 typedef struct ctxop
{
63 void (*save_op
)(void *); /* function to invoke to save context */
64 void (*restore_op
)(void *); /* function to invoke to restore ctx */
65 void (*fork_op
)(void *, void *); /* invoke to fork context */
66 void (*lwp_create_op
)(void *, void *); /* lwp_create context */
67 void (*exit_op
)(void *); /* invoked during {thread,lwp}_exit() */
68 void (*free_op
)(void *, int); /* function which frees the context */
69 void *arg
; /* argument to above functions, ctx pointer */
70 struct ctxop
*next
; /* next context ops */
74 * The active file descriptor table.
75 * Each member of a_fd[] not equalling -1 represents an active fd.
76 * The structure is initialized on first use; all zeros means uninitialized.
79 kmutex_t a_fdlock
; /* protects a_fd and a_nfd */
80 int *a_fd
; /* pointer to list of fds */
81 int a_nfd
; /* number of entries in *a_fd */
82 int a_stale
; /* one of the active fds is being closed */
83 int a_buf
[2]; /* buffer to which a_fd initially refers */
87 * An lwpchan provides uniqueness when sleeping on user-level
88 * synchronization primitives. The lc_wchan member is used
89 * for sleeping on kernel synchronization primitives.
96 typedef struct _kthread
*kthread_id_t
;
99 struct panic_trap_info
;
107 /* Definition for kernel thread identifier type */
108 typedef uint64_t kt_did_t
;
110 typedef struct _kthread
{
111 struct _kthread
*t_link
; /* dispq, sleepq, and free queue link */
113 caddr_t t_stk
; /* base of stack (kernel sp value to use) */
114 void (*t_startpc
)(void); /* PC where thread started */
115 struct cpu
*t_bound_cpu
; /* cpu bound to, or NULL if not bound */
116 short t_affinitycnt
; /* nesting level of kernel affinity-setting */
117 short t_bind_cpu
; /* user-specified CPU binding (-1 if none) */
118 ushort_t t_flag
; /* modified only by current thread */
119 ushort_t t_proc_flag
; /* modified holding ttproc(t)->p_lock */
120 ushort_t t_schedflag
; /* modified holding thread_lock(t) */
121 volatile char t_preempt
; /* don't preempt thread if set */
122 volatile char t_preempt_lk
;
123 uint_t t_state
; /* thread state (protected by thread_lock) */
124 pri_t t_pri
; /* assigned thread priority */
125 pri_t t_epri
; /* inherited thread priority */
126 pri_t t_cpri
; /* thread scheduling class priority */
127 char t_writer
; /* sleeping in lwp_rwlock_lock(RW_WRITE_LOCK) */
128 uchar_t t_bindflag
; /* CPU and pset binding type */
129 label_t t_pcb
; /* pcb, save area when switching */
130 lwpchan_t t_lwpchan
; /* reason for blocking */
131 #define t_wchan0 t_lwpchan.lc_wchan0
132 #define t_wchan t_lwpchan.lc_wchan
133 struct _sobj_ops
*t_sobj_ops
;
134 id_t t_cid
; /* scheduling class id */
135 struct thread_ops
*t_clfuncs
; /* scheduling class ops vector */
136 void *t_cldata
; /* per scheduling class specific data */
137 ctxop_t
*t_ctx
; /* thread context */
138 uintptr_t t_lofault
; /* ret pc for failed page faults */
139 label_t
*t_onfault
; /* on_fault() setjmp buf */
140 struct on_trap_data
*t_ontrap
; /* on_trap() protection data */
141 caddr_t t_swap
; /* the bottom of the stack, if from segkp */
142 lock_t t_lock
; /* used to resume() a thread */
143 uint8_t t_lockstat
; /* set while thread is in lockstat code */
144 uint8_t t_pil
; /* interrupt thread PIL */
145 disp_lock_t t_pi_lock
; /* lock protecting t_prioinv list */
146 char t_nomigrate
; /* do not migrate if set */
147 struct cpu
*t_cpu
; /* CPU that thread last ran on */
148 struct cpu
*t_weakbound_cpu
; /* cpu weakly bound to */
149 struct lgrp_ld
*t_lpl
; /* load average for home lgroup */
150 void *t_lgrp_reserv
[2]; /* reserved for future */
151 struct _kthread
*t_intr
; /* interrupted (pinned) thread */
152 uint64_t t_intr_start
; /* timestamp when time slice began */
153 kt_did_t t_did
; /* thread id for kernel debuggers */
154 caddr_t t_tnf_tpdp
; /* Trace facility data pointer */
155 struct _kcpc_ctx
*t_cpc_ctx
; /* performance counter context */
156 struct _kcpc_set
*t_cpc_set
; /* set this thread has bound */
158 id_t t_tid
; /* lwp's id */
159 id_t t_waitfor
; /* target lwp id in lwp_wait() */
160 struct sigqueue
*t_sigqueue
; /* queue of siginfo structs */
161 k_sigset_t t_sig
; /* signals pending to this process */
162 k_sigset_t t_extsig
; /* signals sent from another contract */
163 k_sigset_t t_hold
; /* hold signal bit mask */
164 k_sigset_t t_sigwait
; /* sigtimedwait/sigfd accepting these */
165 struct _kthread
*t_forw
; /* process's forward thread link */
166 struct _kthread
*t_back
; /* process's backward thread link */
167 struct _kthread
*t_thlink
; /* tid (lwpid) lookup hash link */
168 klwp_t
*t_lwp
; /* thread's lwp pointer */
169 struct proc
*t_procp
; /* proc pointer */
170 struct t_audit_data
*t_audit_data
; /* per thread audit data */
171 struct _kthread
*t_next
; /* doubly linked list of all threads */
172 struct _kthread
*t_prev
;
173 ushort_t t_whystop
; /* reason for stopping */
174 ushort_t t_whatstop
; /* more detailed reason */
175 int t_dslot
; /* index in proc's thread directory */
176 struct pollstate
*t_pollstate
; /* state used during poll(2) */
177 struct pollcache
*t_pollcache
; /* to pass a pcache ptr by /dev/poll */
178 struct cred
*t_cred
; /* pointer to current cred */
179 time_t t_start
; /* start time, seconds since epoch */
180 clock_t t_lbolt
; /* lbolt at last clock_tick() */
181 hrtime_t t_stoptime
; /* timestamp at stop() */
182 uint_t t_pctcpu
; /* %cpu at last clock_tick(), binary */
183 /* point at right of high-order bit */
184 short t_sysnum
; /* system call number */
185 kcondvar_t t_delay_cv
;
186 kmutex_t t_delay_lock
;
189 * Pointer to the dispatcher lock protecting t_state and state-related
190 * flags. This pointer can change during waits on the lock, so
191 * it should be grabbed only by thread_lock().
193 disp_lock_t
*t_lockp
; /* pointer to the dispatcher lock */
194 ushort_t t_oldspl
; /* spl level before dispatcher locked */
195 volatile char t_pre_sys
; /* pre-syscall work needed */
196 lock_t t_lock_flush
; /* for lock_mutex_flush() impl */
197 struct _disp
*t_disp_queue
; /* run queue for chosen CPU */
198 clock_t t_disp_time
; /* last time this thread was running */
199 uint_t t_kpri_req
; /* kernel priority required */
202 * Post-syscall / post-trap flags.
203 * No lock is required to set these.
204 * These must be cleared only by the thread itself.
206 * t_astflag indicates that some post-trap processing is required,
207 * possibly a signal or a preemption. The thread will not
208 * return to user with this set.
209 * t_post_sys indicates that some unusualy post-system call
210 * handling is required, such as an error or tracing.
211 * t_sig_check indicates that some condition in ISSIG() must be
212 * checked, but doesn't prevent returning to user.
213 * t_post_sys_ast is a way of checking whether any of these three
218 volatile char _t_astflag
; /* AST requested */
219 volatile char _t_sig_check
; /* ISSIG required */
220 volatile char _t_post_sys
; /* post_syscall req */
221 volatile char _t_trapret
; /* call CL_TRAPRET */
223 volatile int _t_post_sys_ast
; /* OR of these flags */
225 #define t_astflag _tu._ts._t_astflag
226 #define t_sig_check _tu._ts._t_sig_check
227 #define t_post_sys _tu._ts._t_post_sys
228 #define t_trapret _tu._ts._t_trapret
229 #define t_post_sys_ast _tu._t_post_sys_ast
232 * Real time microstate profiling.
234 /* possible 4-byte filler */
235 hrtime_t t_waitrq
; /* timestamp for run queue wait time */
236 int t_mstate
; /* current microstate */
238 int rp_anystate
; /* set if any state non-zero */
239 uint_t rp_state
[NMSTATES
]; /* mstate profiling counts */
243 * There is a turnstile inserted into the list below for
244 * every priority inverted synchronization object that
248 struct turnstile
*t_prioinv
;
251 * Pointer to the turnstile attached to the synchronization
252 * object where this thread is blocked.
255 struct turnstile
*t_ts
;
258 * kernel thread specific data
259 * Borrowed from userland implementation of POSIX tsd
262 struct tsd_thread
*ts_next
; /* threads with TSD */
263 struct tsd_thread
*ts_prev
; /* threads with TSD */
264 uint_t ts_nkeys
; /* entries in value array */
265 void **ts_value
; /* array of value/key */
268 struct door_data
*t_door
; /* door invocation data */
269 kmutex_t
*t_plockp
; /* pointer to process's p_lock */
271 struct sc_shared
*t_schedctl
; /* scheduler activations shared data */
272 uintptr_t t_sc_uaddr
; /* user-level address of shared data */
274 struct cpupart
*t_cpupart
; /* partition containing thread */
275 int t_bind_pset
; /* processor set binding */
277 struct copyops
*t_copyops
; /* copy in/out ops vector */
279 caddr_t t_stkbase
; /* base of the the stack */
280 struct page
*t_red_pp
; /* if non-NULL, redzone is mapped */
282 afd_t t_activefd
; /* active file descriptor table */
284 struct _kthread
*t_priforw
; /* sleepq per-priority sublist */
285 struct _kthread
*t_priback
;
287 struct sleepq
*t_sleepq
; /* sleep queue thread is waiting on */
288 struct panic_trap_info
*t_panic_trap
; /* saved data from fatal trap */
289 int *t_lgrp_affinity
; /* lgroup affinity */
290 struct upimutex
*t_upimutex
; /* list of upimutexes owned by thread */
291 uint32_t t_nupinest
; /* number of nested held upi mutexes */
292 struct kproject
*t_proj
; /* project containing this thread */
293 uint8_t t_unpark
; /* modified holding t_delay_lock */
294 uint8_t t_release
; /* lwp_release() waked up the thread */
295 uint8_t t_hatdepth
; /* depth of recursive hat_memloads */
296 uint8_t t_xpvcntr
; /* see xen_block_migrate() */
297 kcondvar_t t_joincv
; /* cv used to wait for thread exit */
298 void *t_taskq
; /* for threads belonging to taskq */
299 hrtime_t t_anttime
; /* most recent time anticipatory load */
300 /* was added to an lgroup's load */
301 /* on this thread's behalf */
302 char *t_pdmsg
; /* privilege debugging message */
304 uint_t t_predcache
; /* DTrace predicate cache */
305 hrtime_t t_dtrace_vtime
; /* DTrace virtual time */
306 hrtime_t t_dtrace_start
; /* DTrace slice start time */
308 uint8_t t_dtrace_stop
; /* indicates a DTrace-desired stop */
309 uint8_t t_dtrace_sig
; /* signal sent via DTrace's raise() */
313 uint8_t _t_dtrace_on
; /* hit a fasttrap tracepoint */
314 uint8_t _t_dtrace_step
; /* about to return to kernel */
315 uint8_t _t_dtrace_ret
; /* handling a return probe */
316 uint8_t _t_dtrace_ast
; /* saved ast flag */
318 uint8_t _t_dtrace_reg
; /* modified register */
321 ulong_t _t_dtrace_ft
; /* bitwise or of these flags */
323 #define t_dtrace_ft _tdu._t_dtrace_ft
324 #define t_dtrace_on _tdu._tds._t_dtrace_on
325 #define t_dtrace_step _tdu._tds._t_dtrace_step
326 #define t_dtrace_ret _tdu._tds._t_dtrace_ret
327 #define t_dtrace_ast _tdu._tds._t_dtrace_ast
329 #define t_dtrace_reg _tdu._tds._t_dtrace_reg
332 uintptr_t t_dtrace_pc
; /* DTrace saved pc from fasttrap */
333 uintptr_t t_dtrace_npc
; /* DTrace next pc from fasttrap */
334 uintptr_t t_dtrace_scrpc
; /* DTrace per-thread scratch location */
335 uintptr_t t_dtrace_astpc
; /* DTrace return sequence location */
337 uint64_t t_dtrace_regv
; /* DTrace saved reg from fasttrap */
338 uint64_t t_useracc
; /* SMAP state saved across swtch() */
340 hrtime_t t_hrtime
; /* high-res last time on cpu */
341 kmutex_t t_ctx_lock
; /* protects t_ctx in removectx() */
342 struct waitq
*t_waitq
; /* wait queue */
343 kmutex_t t_wait_mutex
; /* used in CV wait functions */
347 * Thread flag (t_flag) definitions.
348 * These flags must be changed only for the current thread,
349 * and not during preemption code, since the code being
350 * preempted could be modifying the flags.
352 * For the most part these flags do not need locking.
353 * The following flags will only be changed while the thread_lock is held,
354 * to give assurrance that they are consistent with t_state:
357 #define T_INTR_THREAD 0x0001 /* thread is an interrupt thread */
358 #define T_WAKEABLE 0x0002 /* thread is blocked, signals enabled */
359 #define T_TOMASK 0x0004 /* use lwp_sigoldmask on return from signal */
360 #define T_TALLOCSTK 0x0008 /* thread structure allocated from stk */
361 #define T_FORKALL 0x0010 /* thread was cloned by forkall() */
362 #define T_WOULDBLOCK 0x0020 /* for lockfs */
363 #define T_DONTBLOCK 0x0040 /* for lockfs */
364 #define T_DONTPEND 0x0080 /* for lockfs */
365 #define T_SYS_PROF 0x0100 /* profiling on for duration of system call */
366 #define T_WAITCVSEM 0x0200 /* waiting for a lwp_cv or lwp_sema on sleepq */
367 #define T_WATCHPT 0x0400 /* thread undergoing a watchpoint emulation */
368 #define T_PANIC 0x0800 /* thread initiated a system panic */
369 #define T_LWPREUSE 0x1000 /* stack and LWP can be reused */
370 #define T_CAPTURING 0x2000 /* thread is in page capture logic */
371 #define T_VFPARENT 0x4000 /* thread is vfork parent, must call vfwait */
372 #define T_DONTDTRACE 0x8000 /* disable DTrace probes */
375 * Flags in t_proc_flag.
376 * These flags must be modified only when holding the p_lock
377 * for the associated process.
379 #define TP_DAEMON 0x0001 /* this is an LWP_DAEMON lwp */
380 #define TP_HOLDLWP 0x0002 /* hold thread's lwp */
381 #define TP_TWAIT 0x0004 /* wait to be freed by lwp_wait() */
382 #define TP_LWPEXIT 0x0008 /* lwp has exited */
383 #define TP_PRSTOP 0x0010 /* thread is being stopped via /proc */
384 #define TP_CHKPT 0x0020 /* thread is being stopped via CPR checkpoint */
385 #define TP_EXITLWP 0x0040 /* terminate this lwp */
386 #define TP_PRVSTOP 0x0080 /* thread is virtually stopped via /proc */
387 #define TP_MSACCT 0x0100 /* collect micro-state accounting information */
388 #define TP_STOPPING 0x0200 /* thread is executing stop() */
389 #define TP_WATCHPT 0x0400 /* process has watchpoints in effect */
390 #define TP_PAUSE 0x0800 /* process is being stopped via pauselwps() */
391 #define TP_CHANGEBIND 0x1000 /* thread has a new cpu/cpupart binding */
392 #define TP_ZTHREAD 0x2000 /* this is a kernel thread for a zone */
393 #define TP_WATCHSTOP 0x4000 /* thread is stopping via holdwatch() */
396 * Thread scheduler flag (t_schedflag) definitions.
397 * The thread must be locked via thread_lock() or equiv. to change these.
399 #define TS_SIGNALLED 0x0010 /* thread was awakened by cv_signal() */
400 #define TS_PROJWAITQ 0x0020 /* thread is on its project's waitq */
401 #define TS_ZONEWAITQ 0x0040 /* thread is on its zone's waitq */
402 #define TS_CSTART 0x0100 /* setrun() by continuelwps() */
403 #define TS_UNPAUSE 0x0200 /* setrun() by unpauselwps() */
404 #define TS_XSTART 0x0400 /* setrun() by SIGCONT */
405 #define TS_PSTART 0x0800 /* setrun() by /proc */
406 #define TS_RESUME 0x1000 /* setrun() by CPR resume process */
407 #define TS_CREATE 0x2000 /* setrun() by syslwp_create() */
408 #define TS_RUNQMATCH 0x4000 /* exact run queue balancing by setbackdq() */
409 #define TS_ALLSTART \
410 (TS_CSTART|TS_UNPAUSE|TS_XSTART|TS_PSTART|TS_RESUME|TS_CREATE)
411 #define TS_ANYWAITQ (TS_PROJWAITQ|TS_ZONEWAITQ)
414 * Thread binding types
417 #define TB_CPU_SOFT 0x01 /* soft binding to CPU */
418 #define TB_PSET_SOFT 0x02 /* soft binding to pset */
420 #define TB_CPU_SOFT_SET(t) ((t)->t_bindflag |= TB_CPU_SOFT)
421 #define TB_CPU_HARD_SET(t) ((t)->t_bindflag &= ~TB_CPU_SOFT)
422 #define TB_PSET_SOFT_SET(t) ((t)->t_bindflag |= TB_PSET_SOFT)
423 #define TB_PSET_HARD_SET(t) ((t)->t_bindflag &= ~TB_PSET_SOFT)
424 #define TB_CPU_IS_SOFT(t) ((t)->t_bindflag & TB_CPU_SOFT)
425 #define TB_CPU_IS_HARD(t) (!TB_CPU_IS_SOFT(t))
426 #define TB_PSET_IS_SOFT(t) ((t)->t_bindflag & TB_PSET_SOFT)
429 * No locking needed for AST field.
431 #define aston(t) ((t)->t_astflag = 1)
432 #define astoff(t) ((t)->t_astflag = 0)
434 /* True if thread is stopped on an event of interest */
435 #define ISTOPPED(t) ((t)->t_state == TS_STOPPED && \
436 !((t)->t_schedflag & TS_PSTART))
438 /* True if thread is asleep and wakeable */
439 #define ISWAKEABLE(t) (((t)->t_state == TS_SLEEP && \
440 ((t)->t_flag & T_WAKEABLE)))
442 /* True if thread is on the wait queue */
443 #define ISWAITING(t) ((t)->t_state == TS_WAIT)
445 /* similar to ISTOPPED except the event of interest is CPR */
446 #define CPR_ISTOPPED(t) ((t)->t_state == TS_STOPPED && \
447 !((t)->t_schedflag & TS_RESUME))
450 * True if thread is virtually stopped (is or was asleep in
451 * one of the lwp_*() system calls and marked to stop by /proc.)
453 #define VSTOPPED(t) ((t)->t_proc_flag & TP_PRVSTOP)
455 /* similar to VSTOPPED except the point of interest is CPR */
456 #define CPR_VSTOPPED(t) \
457 ((t)->t_state == TS_SLEEP && \
458 (t)->t_wchan0 != NULL && \
459 ((t)->t_flag & T_WAKEABLE) && \
460 ((t)->t_proc_flag & TP_CHKPT))
462 /* True if thread has been stopped by hold*() or was created stopped */
463 #define SUSPENDED(t) ((t)->t_state == TS_STOPPED && \
464 ((t)->t_schedflag & (TS_CSTART|TS_UNPAUSE)) != (TS_CSTART|TS_UNPAUSE))
466 /* True if thread possesses an inherited priority */
467 #define INHERITED(t) ((t)->t_epri != 0)
469 /* The dispatch priority of a thread */
470 #define DISP_PRIO(t) ((t)->t_epri > (t)->t_pri ? (t)->t_epri : (t)->t_pri)
472 /* The assigned priority of a thread */
473 #define ASSIGNED_PRIO(t) ((t)->t_pri)
477 * convert a proc pointer to a thread pointer. this only works with
478 * procs that have only one lwp.
481 * convert a proc pointer to a lwp pointer. this only works with
482 * procs that have only one lwp.
485 * convert a thread pointer to its lwp pointer.
488 * convert a thread pointer to its proc pointer.
491 * convert a thread pointer to its project pointer.
494 * convert a thread pointer to its zone pointer.
497 * convert a lwp pointer to its thread pointer.
500 * convert a lwp to its proc pointer.
502 #define proctot(x) ((x)->p_tlist)
503 #define proctolwp(x) ((x)->p_tlist->t_lwp)
504 #define ttolwp(x) ((x)->t_lwp)
505 #define ttoproc(x) ((x)->t_procp)
506 #define ttoproj(x) ((x)->t_proj)
507 #define ttozone(x) ((x)->t_procp->p_zone)
508 #define lwptot(x) ((x)->lwp_thread)
509 #define lwptoproc(x) ((x)->lwp_procp)
511 #define t_pc t_pcb.val[0]
512 #define t_sp t_pcb.val[1]
516 extern kthread_t
*threadp(void); /* inline, returns thread pointer */
517 #define curthread (threadp()) /* current thread pointer */
518 #define curproc (ttoproc(curthread)) /* current process pointer */
519 #define curproj (ttoproj(curthread)) /* current project pointer */
520 #define curzone (curproc->p_zone) /* current zone pointer */
522 extern struct _kthread t0
; /* the scheduler thread */
523 extern kmutex_t pidlock
; /* global process lock */
526 * thread_free_lock is used by the tick accounting thread to keep a thread
527 * from being freed while it is being examined.
529 * Thread structures are 32-byte aligned structures. That is why we use the
532 #define THREAD_FREE_BITS 10
533 #define THREAD_FREE_NUM (1 << THREAD_FREE_BITS)
534 #define THREAD_FREE_MASK (THREAD_FREE_NUM - 1)
535 #define THREAD_FREE_1 PTR24_LSB
536 #define THREAD_FREE_2 (PTR24_LSB + THREAD_FREE_BITS)
537 #define THREAD_FREE_SHIFT(t) \
538 (((ulong_t)(t) >> THREAD_FREE_1) ^ ((ulong_t)(t) >> THREAD_FREE_2))
539 #define THREAD_FREE_HASH(t) (THREAD_FREE_SHIFT(t) & THREAD_FREE_MASK)
541 typedef struct thread_free_lock
{
543 uchar_t tf_pad
[64 - sizeof (kmutex_t
)];
544 } thread_free_lock_t
;
546 extern void thread_free_prevent(kthread_t
*);
547 extern void thread_free_allow(kthread_t
*);
550 * Routines to change the priority and effective priority
551 * of a thread-locked thread, whatever its state.
553 extern int thread_change_pri(kthread_t
*t
, pri_t disp_pri
, int front
);
554 extern void thread_change_epri(kthread_t
*t
, pri_t disp_pri
);
557 * Routines that manipulate the dispatcher lock for the thread.
558 * The locking heirarchy is as follows:
559 * cpu_lock > sleepq locks > run queue locks
561 void thread_transition(kthread_t
*); /* move to transition lock */
562 void thread_stop(kthread_t
*); /* move to stop lock */
563 void thread_lock(kthread_t
*); /* lock thread and its queue */
564 void thread_lock_high(kthread_t
*); /* lock thread and its queue */
565 void thread_onproc(kthread_t
*, struct cpu
*); /* set onproc state lock */
567 #define thread_unlock(t) disp_lock_exit((t)->t_lockp)
568 #define thread_unlock_high(t) disp_lock_exit_high((t)->t_lockp)
569 #define thread_unlock_nopreempt(t) disp_lock_exit_nopreempt((t)->t_lockp)
571 #define THREAD_LOCK_HELD(t) (DISP_LOCK_HELD((t)->t_lockp))
573 extern disp_lock_t transition_lock
; /* lock protecting transiting threads */
574 extern disp_lock_t stop_lock
; /* lock protecting stopped threads */
576 caddr_t
thread_stk_init(caddr_t
); /* init thread stack */
578 extern int default_binding_mode
;
583 * Macros to indicate that the thread holds resources that could be critical
584 * to other kernel threads, so this thread needs to have kernel priority
585 * if it blocks or is preempted. Note that this is not necessary if the
586 * resource is a mutex or a writer lock because of priority inheritance.
588 * The only way one thread may legally manipulate another thread's t_kpri_req
589 * is to hold the target thread's thread lock while that thread is asleep.
590 * (The rwlock code does this to implement direct handoff to waiting readers.)
592 #define THREAD_KPRI_REQUEST() (curthread->t_kpri_req++)
593 #define THREAD_KPRI_RELEASE() (curthread->t_kpri_req--)
594 #define THREAD_KPRI_RELEASE_N(n) (curthread->t_kpri_req -= (n))
597 * Macro to change a thread's priority.
599 #define THREAD_CHANGE_PRI(t, pri) { \
600 pri_t __new_pri = (pri); \
601 DTRACE_SCHED2(change__pri, kthread_t *, (t), pri_t, __new_pri); \
602 (t)->t_pri = __new_pri; \
603 schedctl_set_cidpri(t); \
607 * Macro to indicate that a thread's priority is about to be changed.
609 #define THREAD_WILLCHANGE_PRI(t, pri) { \
610 DTRACE_SCHED2(change__pri, kthread_t *, (t), pri_t, (pri)); \
614 * Macros to change thread state and the associated lock.
616 #define THREAD_SET_STATE(tp, state, lp) \
617 ((tp)->t_state = state, (tp)->t_lockp = lp)
620 * Point it at the transition lock, which is always held.
621 * The previosly held lock is dropped.
623 #define THREAD_TRANSITION(tp) thread_transition(tp);
625 * Set the thread's lock to be the transition lock, without dropping
626 * previosly held lock.
628 #define THREAD_TRANSITION_NOLOCK(tp) ((tp)->t_lockp = &transition_lock)
631 * Put thread in run state, and set the lock pointer to the dispatcher queue
632 * lock pointer provided. This lock should be held.
634 #define THREAD_RUN(tp, lp) THREAD_SET_STATE(tp, TS_RUN, lp)
637 * Put thread in wait state, and set the lock pointer to the wait queue
638 * lock pointer provided. This lock should be held.
640 #define THREAD_WAIT(tp, lp) THREAD_SET_STATE(tp, TS_WAIT, lp)
643 * Put the thread in zombie state and set the lock pointer to NULL.
644 * The NULL will catch anything that tries to lock a zombie.
646 #define THREAD_ZOMB(tp) THREAD_SET_STATE(tp, TS_ZOMB, NULL)
649 * Set the thread into ONPROC state, and point the lock at the CPUs
650 * lock for the onproc thread(s). This lock should be held, so the
651 * thread deoes not become unlocked, since these stores can be reordered.
653 #define THREAD_ONPROC(tp, cpu) \
654 THREAD_SET_STATE(tp, TS_ONPROC, &(cpu)->cpu_thread_lock)
657 * Set the thread into the TS_SLEEP state, and set the lock pointer to
658 * to some sleep queue's lock. The new lock should already be held.
660 #define THREAD_SLEEP(tp, lp) { \
662 tlp = (tp)->t_lockp; \
663 THREAD_SET_STATE(tp, TS_SLEEP, lp); \
664 disp_lock_exit_high(tlp); \
668 * Interrupt threads are created in TS_FREE state, and their lock
669 * points at the associated CPU's lock.
671 #define THREAD_FREEINTR(tp, cpu) \
672 THREAD_SET_STATE(tp, TS_FREE, &(cpu)->cpu_thread_lock)
674 /* if tunable kmem_stackinfo is set, fill kthread stack with a pattern */
675 #define KMEM_STKINFO_PATTERN 0xbadcbadcbadcbadcULL
678 * If tunable kmem_stackinfo is set, log the latest KMEM_LOG_STK_USAGE_SIZE
679 * dead kthreads that used their kernel stack the most.
681 #define KMEM_STKINFO_LOG_SIZE 16
683 /* kthread name (cmd/lwpid) string size in the stackinfo log */
684 #define KMEM_STKINFO_STR_SIZE 64
687 * stackinfo logged data.
689 typedef struct kmem_stkinfo
{
690 caddr_t kthread
; /* kthread pointer */
691 caddr_t t_startpc
; /* where kthread started */
692 caddr_t start
; /* kthread stack start address */
693 size_t stksz
; /* kthread stack size */
694 size_t percent
; /* kthread stack high water mark */
695 id_t t_tid
; /* kthread id */
696 char cmd
[KMEM_STKINFO_STR_SIZE
]; /* kthread name (cmd/lwpid) */
703 #endif /* _SYS_THREAD_H */