2 * Copyright (c) 1986, 1989, 1991, 1993
3 * The Regents of the University of California. All rights reserved.
4 * (c) UNIX System Laboratories, Inc.
5 * All or some portions of this file are derived from material licensed
6 * to the University of California by American Telephone and Telegraph
7 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8 * the permission of UNIX System Laboratories, Inc.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 4. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * @(#)proc.h 8.15 (Berkeley) 5/19/95
41 #include <sys/callout.h> /* For struct callout. */
42 #include <sys/event.h> /* For struct klist. */
43 #include <sys/condvar.h>
45 #include <sys/filedesc.h>
47 #include <sys/queue.h>
48 #include <sys/_lock.h>
49 #include <sys/lock_profile.h>
50 #include <sys/_mutex.h>
52 #include <sys/priority.h>
53 #include <sys/rtprio.h> /* XXX. */
55 #include <sys/resource.h>
56 #include <sys/sigio.h>
57 #include <sys/signal.h>
58 #include <sys/signalvar.h>
60 #include <sys/time.h> /* For structs itimerval, timeval. */
64 #include <sys/ucontext.h>
65 #include <sys/ucred.h>
66 #include <machine/proc.h> /* Machine-dependent proc substruct. */
69 * One structure allocated per session.
72 * (m) locked by s_mtx mtx
73 * (e) locked by proctree_lock sx
74 * (c) const until freeing
77 u_int s_count; /* Ref cnt; pgrps in session - atomic. */
78 struct proc *s_leader; /* (m + e) Session leader. */
79 struct vnode *s_ttyvp; /* (m) Vnode of controlling tty. */
80 struct tty *s_ttyp; /* (e) Controlling tty. */
81 pid_t s_sid; /* (c) Session ID. */
82 /* (m) Setlogin() name: */
83 char s_login[roundup(MAXLOGNAME, sizeof(long))];
84 struct mtx s_mtx; /* Mutex to protect members. */
88 * One structure allocated per process group.
91 * (m) locked by pg_mtx mtx
92 * (e) locked by proctree_lock sx
93 * (c) const until freeing
96 LIST_ENTRY(pgrp) pg_hash; /* (e) Hash chain. */
97 LIST_HEAD(, proc) pg_members; /* (m + e) Pointer to pgrp members. */
98 struct session *pg_session; /* (c) Pointer to session. */
99 struct sigiolst pg_sigiolst; /* (m) List of sigio sources. */
100 pid_t pg_id; /* (c) Process group id. */
101 int pg_jobc; /* (m) Job control process count. */
102 struct mtx pg_mtx; /* Mutex to protect members */
106 * pargs, used to hold a copy of the command line, if it had a sane length.
109 u_int ar_ref; /* Reference count. */
110 u_int ar_length; /* Length. */
111 u_char ar_args[1]; /* Arguments. */
115 * Description of a process.
117 * This structure contains the information needed to manage a thread of
118 * control, known in UN*X as a process; it has references to substructures
119 * containing descriptions of things that the process uses, but may share
120 * with related processes. The process structure and the substructures
121 * are always addressable except for those marked "(CPU)" below,
122 * which might be addressable only on a processor on which the process
125 * Below is a key of locks used to protect each member of struct proc. The
126 * lock is indicated by a reference to a specific character in parens in the
127 * associated comment.
128 * * - not yet protected
129 * a - only touched by curproc or parent during fork/wait
130 * b - created at fork, never changes
131 * (exception aiods switch vmspaces, but they are also
132 * marked 'P_SYSTEM' so hopefully it will be left alone)
133 * c - locked by proc mtx
134 * d - locked by allproc_lock lock
135 * e - locked by proctree_lock lock
137 * g - process group mtx
138 * h - callout_lock mtx
139 * i - by curproc or the master session mtx
140 * j - locked by proc slock
141 * k - only accessed by curthread
142 * k*- only accessed by curthread and from an interrupt
143 * l - the attaching proc or attaching proc parent
145 * n - not locked, lazy
147 * q - td_contested lock
150 * x - created at fork, only changes during single threading in exec
151 * y - created at first aio, doesn't change until exit or exec at which
152 * point we are single-threaded and only curthread changes it
153 * z - zombie threads lock
155 * If the locking key specifies two identifiers (for example, p_pptr) then
156 * either lock is sufficient for read access, but both locks must be held
159 struct kaudit_record;
169 struct mqueue_notifier;
171 struct kdtrace_thread;
175 * Kernel runnable context (thread).
176 * This is what is put to sleep and reactivated.
177 * Thread context. Processes may have multiple threads.
180 struct mtx *volatile td_lock; /* replaces sched lock */
181 struct proc *td_proc; /* (*) Associated process. */
182 TAILQ_ENTRY(thread) td_plist; /* (*) All threads in this proc. */
183 TAILQ_ENTRY(thread) td_runq; /* (t) Run queue. */
184 TAILQ_ENTRY(thread) td_slpq; /* (t) Sleep queue. */
185 TAILQ_ENTRY(thread) td_lockq; /* (t) Lock queue. */
186 struct cpuset *td_cpuset; /* (t) CPU affinity mask. */
187 struct seltd *td_sel; /* Select queue/channel. */
188 struct sleepqueue *td_sleepqueue; /* (k) Associated sleep queue. */
189 struct turnstile *td_turnstile; /* (k) Associated turnstile. */
190 struct umtx_q *td_umtxq; /* (c?) Link for when we're blocked. */
191 lwpid_t td_tid; /* (b) Thread ID. */
192 sigqueue_t td_sigqueue; /* (c) Sigs arrived, not delivered. */
193 #define td_siglist td_sigqueue.sq_signals
195 /* Cleared during fork1() */
196 #define td_startzero td_flags
197 int td_flags; /* (t) TDF_* flags. */
198 int td_inhibitors; /* (t) Why can not run. */
199 int td_pflags; /* (k) Private thread (TDP_*) flags. */
200 int td_dupfd; /* (k) Ret value from fdopen. XXX */
201 int td_sqqueue; /* (t) Sleepqueue queue blocked on. */
202 void *td_wchan; /* (t) Sleep address. */
203 const char *td_wmesg; /* (t) Reason for sleep. */
204 u_char td_lastcpu; /* (t) Last cpu we were on. */
205 u_char td_oncpu; /* (t) Which cpu we are on. */
206 volatile u_char td_owepreempt; /* (k*) Preempt on last critical_exit */
207 u_char td_tsqueue; /* (t) Turnstile queue blocked on. */
208 short td_locks; /* (k) Count of non-spin locks. */
209 short td_rw_rlocks; /* (k) Count of rwlock read locks. */
210 short td_lk_slocks; /* (k) Count of lockmgr shared locks. */
211 struct turnstile *td_blocked; /* (t) Lock thread is blocked on. */
212 const char *td_lockname; /* (t) Name of lock blocked on. */
213 LIST_HEAD(, turnstile) td_contested; /* (q) Contested locks. */
214 struct lock_list_entry *td_sleeplocks; /* (k) Held sleep locks. */
215 int td_intr_nesting_level; /* (k) Interrupt recursion. */
216 int td_pinned; /* (k) Temporary cpu pin count. */
217 struct ucred *td_ucred; /* (k) Reference to credentials. */
218 u_int td_estcpu; /* (t) estimated cpu utilization */
219 u_int td_slptick; /* (t) Time at sleep. */
220 struct rusage td_ru; /* (t) rusage information */
221 uint64_t td_incruntime; /* (t) Cpu ticks to transfer to proc. */
222 uint64_t td_runtime; /* (t) How many cpu ticks we've run. */
223 u_int td_pticks; /* (t) Statclock hits for profiling */
224 u_int td_sticks; /* (t) Statclock hits in system mode. */
225 u_int td_iticks; /* (t) Statclock hits in intr mode. */
226 u_int td_uticks; /* (t) Statclock hits in user mode. */
227 int td_intrval; /* (t) Return value for sleepq. */
228 sigset_t td_oldsigmask; /* (k) Saved mask from pre sigpause. */
229 sigset_t td_sigmask; /* (c) Current signal mask. */
230 volatile u_int td_generation; /* (k) For detection of preemption */
231 stack_t td_sigstk; /* (k) Stack ptr and on-stack flag. */
232 int td_xsig; /* (c) Signal for ptrace */
233 u_long td_profil_addr; /* (k) Temporary addr until AST. */
234 u_int td_profil_ticks; /* (k) Temporary ticks until AST. */
235 char td_name[MAXCOMLEN + 1]; /* (*) Thread name. */
236 struct file *td_fpop; /* (k) file referencing cdev under op */
237 int td_dbgflags; /* (c) Userland debugger flags */
238 int td_ng_outbound; /* (k) Thread entered ng from above. */
239 struct osd td_osd; /* (k) Object specific data. */
240 #define td_endzero td_base_pri
242 /* Copied during fork1() or thread_sched_upcall(). */
243 #define td_startcopy td_endzero
244 u_char td_rqindex; /* (t) Run queue index. */
245 u_char td_base_pri; /* (t) Thread base kernel priority. */
246 u_char td_priority; /* (t) Thread active priority. */
247 u_char td_pri_class; /* (t) Scheduling class. */
248 u_char td_user_pri; /* (t) User pri from estcpu and nice. */
249 u_char td_base_user_pri; /* (t) Base user pri */
250 #define td_endcopy td_pcb
253 * Fields that must be manually set in fork1() or thread_sched_upcall()
254 * or already have been set in the allocator, constructor, etc.
256 struct pcb *td_pcb; /* (k) Kernel VA of pcb and kstack. */
263 } td_state; /* (t) thread state */
264 register_t td_retval[2]; /* (k) Syscall aux returns. */
265 struct callout td_slpcallout; /* (h) Callout for sleep. */
266 struct trapframe *td_frame; /* (k) */
267 struct vm_object *td_kstack_obj;/* (a) Kstack object. */
268 vm_offset_t td_kstack; /* (a) Kernel VA of kstack. */
269 int td_kstack_pages; /* (a) Size of the kstack. */
271 vm_offset_t td_space2;
273 volatile u_int td_critnest; /* (k*) Critical section nest level. */
274 struct mdthread td_md; /* (k) Any machine-dependent fields. */
275 struct td_sched *td_sched; /* (*) Scheduler-specific data. */
276 struct kaudit_record *td_ar; /* (k) Active audit record, if any. */
277 int td_syscalls; /* per-thread syscall count (used by NFS :)) */
278 struct lpohead td_lprof[2]; /* (a) lock profiling objects. */
279 struct kdtrace_thread *td_dtrace; /* (*) DTrace-specific data. */
280 int td_errno; /* Error returned by last syscall. */
281 struct vnet *td_vnet; /* (k) Effective vnet. */
282 const char *td_vnet_lpush; /* (k) Debugging vnet push / pop. */
285 struct mtx *thread_lock_block(struct thread *);
286 void thread_lock_unblock(struct thread *, struct mtx *);
287 void thread_lock_set(struct thread *, struct mtx *);
288 #define THREAD_LOCK_ASSERT(td, type) \
290 struct mtx *__m = (td)->td_lock; \
291 if (__m != &blocked_lock) \
292 mtx_assert(__m, (type)); \
296 #define THREAD_LOCKPTR_ASSERT(td, lock) \
298 struct mtx *__m = (td)->td_lock; \
299 KASSERT((__m == &blocked_lock || __m == (lock)), \
300 ("Thread %p lock %p does not match %p", td, __m, (lock))); \
303 #define THREAD_LOCKPTR_ASSERT(td, lock)
307 * Flags kept in td_flags:
308 * To change these you MUST have the scheduler lock.
310 #define TDF_BORROWING 0x00000001 /* Thread is borrowing pri from another. */
311 #define TDF_INPANIC 0x00000002 /* Caused a panic, let it drive crashdump. */
312 #define TDF_INMEM 0x00000004 /* Thread's stack is in memory. */
313 #define TDF_SINTR 0x00000008 /* Sleep is interruptible. */
314 #define TDF_TIMEOUT 0x00000010 /* Timing out during sleep. */
315 #define TDF_IDLETD 0x00000020 /* This is a per-CPU idle thread. */
316 #define TDF_CANSWAP 0x00000040 /* Thread can be swapped. */
317 #define TDF_SLEEPABORT 0x00000080 /* sleepq_abort was called. */
318 #define TDF_KTH_SUSP 0x00000100 /* kthread is suspended */
319 #define TDF_UBORROWING 0x00000200 /* Thread is borrowing user pri. */
320 #define TDF_BOUNDARY 0x00000400 /* Thread suspended at user boundary */
321 #define TDF_ASTPENDING 0x00000800 /* Thread has some asynchronous events. */
322 #define TDF_TIMOFAIL 0x00001000 /* Timeout from sleep after we were awake. */
323 #define TDF_SBDRY 0x00002000 /* Stop only on usermode boundary. */
324 #define TDF_UPIBLOCKED 0x00004000 /* Thread blocked on user PI mutex. */
325 #define TDF_NEEDSUSPCHK 0x00008000 /* Thread may need to suspend. */
326 #define TDF_NEEDRESCHED 0x00010000 /* Thread needs to yield. */
327 #define TDF_NEEDSIGCHK 0x00020000 /* Thread may need signal delivery. */
328 #define TDF_UNUSED18 0x00040000 /* --available-- */
329 #define TDF_UNUSED19 0x00080000 /* Thread is sleeping on a umtx. */
330 #define TDF_THRWAKEUP 0x00100000 /* Libthr thread must not suspend itself. */
331 #define TDF_UNUSED21 0x00200000 /* --available-- */
332 #define TDF_SWAPINREQ 0x00400000 /* Swapin request due to wakeup. */
333 #define TDF_UNUSED23 0x00800000 /* --available-- */
334 #define TDF_SCHED0 0x01000000 /* Reserved for scheduler private use */
335 #define TDF_SCHED1 0x02000000 /* Reserved for scheduler private use */
336 #define TDF_SCHED2 0x04000000 /* Reserved for scheduler private use */
337 #define TDF_SCHED3 0x08000000 /* Reserved for scheduler private use */
338 #define TDF_ALRMPEND 0x10000000 /* Pending SIGVTALRM needs to be posted. */
339 #define TDF_PROFPEND 0x20000000 /* Pending SIGPROF needs to be posted. */
340 #define TDF_MACPEND 0x40000000 /* AST-based MAC event pending. */
342 /* Userland debug flags */
343 #define TDB_SUSPEND 0x00000001 /* Thread is suspended by debugger */
344 #define TDB_XSIG 0x00000002 /* Thread is exchanging signal under trace */
347 * "Private" flags kept in td_pflags:
348 * These are only written by curthread and thus need no locking.
350 #define TDP_OLDMASK 0x00000001 /* Need to restore mask after suspend. */
351 #define TDP_INKTR 0x00000002 /* Thread is currently in KTR code. */
352 #define TDP_INKTRACE 0x00000004 /* Thread is currently in KTRACE code. */
353 #define TDP_BUFNEED 0x00000008 /* Do not recurse into the buf flush */
354 #define TDP_COWINPROGRESS 0x00000010 /* Snapshot copy-on-write in progress. */
355 #define TDP_ALTSTACK 0x00000020 /* Have alternate signal stack. */
356 #define TDP_DEADLKTREAT 0x00000040 /* Lock aquisition - deadlock treatment. */
357 #define TDP_UNUSED80 0x00000080 /* available. */
358 #define TDP_NOSLEEPING 0x00000100 /* Thread is not allowed to sleep on a sq. */
359 #define TDP_OWEUPC 0x00000200 /* Call addupc() at next AST. */
360 #define TDP_ITHREAD 0x00000400 /* Thread is an interrupt thread. */
361 #define TDP_UNUSED800 0x00000800 /* available. */
362 #define TDP_SCHED1 0x00001000 /* Reserved for scheduler private use */
363 #define TDP_SCHED2 0x00002000 /* Reserved for scheduler private use */
364 #define TDP_SCHED3 0x00004000 /* Reserved for scheduler private use */
365 #define TDP_SCHED4 0x00008000 /* Reserved for scheduler private use */
366 #define TDP_GEOM 0x00010000 /* Settle GEOM before finishing syscall */
367 #define TDP_SOFTDEP 0x00020000 /* Stuck processing softdep worklist */
368 #define TDP_NORUNNINGBUF 0x00040000 /* Ignore runningbufspace check */
369 #define TDP_WAKEUP 0x00080000 /* Don't sleep in umtx cond_wait */
370 #define TDP_INBDFLUSH 0x00100000 /* Already in BO_BDFLUSH, do not recurse */
371 #define TDP_KTHREAD 0x00200000 /* This is an official kernel thread */
372 #define TDP_CALLCHAIN 0x00400000 /* Capture thread's callchain */
373 #define TDP_IGNSUSP 0x00800000 /* Permission to ignore the MNTK_SUSPEND* */
374 #define TDP_AUDITREC 0x01000000 /* Audit record pending on thread */
377 * Reasons that the current thread can not be run yet.
378 * More than one may apply.
380 #define TDI_SUSPENDED 0x0001 /* On suspension queue. */
381 #define TDI_SLEEPING 0x0002 /* Actually asleep! (tricky). */
382 #define TDI_SWAPPED 0x0004 /* Stack not in mem. Bad juju if run. */
383 #define TDI_LOCK 0x0008 /* Stopped on a lock. */
384 #define TDI_IWAIT 0x0010 /* Awaiting interrupt. */
386 #define TD_IS_SLEEPING(td) ((td)->td_inhibitors & TDI_SLEEPING)
387 #define TD_ON_SLEEPQ(td) ((td)->td_wchan != NULL)
388 #define TD_IS_SUSPENDED(td) ((td)->td_inhibitors & TDI_SUSPENDED)
389 #define TD_IS_SWAPPED(td) ((td)->td_inhibitors & TDI_SWAPPED)
390 #define TD_ON_LOCK(td) ((td)->td_inhibitors & TDI_LOCK)
391 #define TD_AWAITING_INTR(td) ((td)->td_inhibitors & TDI_IWAIT)
392 #define TD_IS_RUNNING(td) ((td)->td_state == TDS_RUNNING)
393 #define TD_ON_RUNQ(td) ((td)->td_state == TDS_RUNQ)
394 #define TD_CAN_RUN(td) ((td)->td_state == TDS_CAN_RUN)
395 #define TD_IS_INHIBITED(td) ((td)->td_state == TDS_INHIBITED)
396 #define TD_ON_UPILOCK(td) ((td)->td_flags & TDF_UPIBLOCKED)
397 #define TD_IS_IDLETHREAD(td) ((td)->td_flags & TDF_IDLETD)
400 #define TD_SET_INHIB(td, inhib) do { \
401 (td)->td_state = TDS_INHIBITED; \
402 (td)->td_inhibitors |= (inhib); \
405 #define TD_CLR_INHIB(td, inhib) do { \
406 if (((td)->td_inhibitors & (inhib)) && \
407 (((td)->td_inhibitors &= ~(inhib)) == 0)) \
408 (td)->td_state = TDS_CAN_RUN; \
411 #define TD_SET_SLEEPING(td) TD_SET_INHIB((td), TDI_SLEEPING)
412 #define TD_SET_SWAPPED(td) TD_SET_INHIB((td), TDI_SWAPPED)
413 #define TD_SET_LOCK(td) TD_SET_INHIB((td), TDI_LOCK)
414 #define TD_SET_SUSPENDED(td) TD_SET_INHIB((td), TDI_SUSPENDED)
415 #define TD_SET_IWAIT(td) TD_SET_INHIB((td), TDI_IWAIT)
416 #define TD_SET_EXITING(td) TD_SET_INHIB((td), TDI_EXITING)
418 #define TD_CLR_SLEEPING(td) TD_CLR_INHIB((td), TDI_SLEEPING)
419 #define TD_CLR_SWAPPED(td) TD_CLR_INHIB((td), TDI_SWAPPED)
420 #define TD_CLR_LOCK(td) TD_CLR_INHIB((td), TDI_LOCK)
421 #define TD_CLR_SUSPENDED(td) TD_CLR_INHIB((td), TDI_SUSPENDED)
422 #define TD_CLR_IWAIT(td) TD_CLR_INHIB((td), TDI_IWAIT)
424 #define TD_SET_RUNNING(td) (td)->td_state = TDS_RUNNING
425 #define TD_SET_RUNQ(td) (td)->td_state = TDS_RUNQ
426 #define TD_SET_CAN_RUN(td) (td)->td_state = TDS_CAN_RUN
429 * XXX: Does this belong in resource.h or resourcevar.h instead?
430 * Resource usage extension. The times in rusage structs in the kernel are
431 * never up to date. The actual times are kept as runtimes and tick counts
432 * (with control info in the "previous" times), and are converted when
433 * userland asks for rusage info. Backwards compatibility prevents putting
434 * this directly in the user-visible rusage struct.
436 * Locking: (cj) means (j) for p_rux and (c) for p_crux.
439 u_int64_t rux_runtime; /* (cj) Real time. */
440 u_int64_t rux_uticks; /* (cj) Statclock hits in user mode. */
441 u_int64_t rux_sticks; /* (cj) Statclock hits in sys mode. */
442 u_int64_t rux_iticks; /* (cj) Statclock hits in intr mode. */
443 u_int64_t rux_uu; /* (c) Previous user time in usec. */
444 u_int64_t rux_su; /* (c) Previous sys time in usec. */
445 u_int64_t rux_tu; /* (c) Previous total time in usec. */
452 LIST_ENTRY(proc) p_list; /* (d) List of all processes. */
453 TAILQ_HEAD(, thread) p_threads; /* (c) all threads. */
454 struct mtx p_slock; /* process spin lock */
455 struct ucred *p_ucred; /* (c) Process owner's identity. */
456 struct filedesc *p_fd; /* (b) Open files. */
457 struct filedesc_to_leader *p_fdtol; /* (b) Tracking node */
458 struct pstats *p_stats; /* (b) Accounting/statistics (CPU). */
459 struct plimit *p_limit; /* (c) Process limits. */
460 struct callout p_limco; /* (c) Limit callout handle */
461 struct sigacts *p_sigacts; /* (x) Signal actions, state (CPU). */
464 * The following don't make too much sense.
465 * See the td_ or ke_ versions of the same flags.
467 int p_flag; /* (c) P_* flags. */
469 PRS_NEW = 0, /* In creation */
470 PRS_NORMAL, /* threads can be run. */
472 } p_state; /* (j/c) S* process status. */
473 pid_t p_pid; /* (b) Process identifier. */
474 LIST_ENTRY(proc) p_hash; /* (d) Hash chain. */
475 LIST_ENTRY(proc) p_pglist; /* (g + e) List of processes in pgrp. */
476 struct proc *p_pptr; /* (c + e) Pointer to parent process. */
477 LIST_ENTRY(proc) p_sibling; /* (e) List of sibling processes. */
478 LIST_HEAD(, proc) p_children; /* (e) Pointer to list of children. */
479 struct mtx p_mtx; /* (n) Lock for this struct. */
480 struct ksiginfo *p_ksi; /* Locked by parent proc lock */
481 sigqueue_t p_sigqueue; /* (c) Sigs not delivered to a td. */
482 #define p_siglist p_sigqueue.sq_signals
484 /* The following fields are all zeroed upon creation in fork. */
485 #define p_startzero p_oppid
486 pid_t p_oppid; /* (c + e) Save ppid in ptrace. XXX */
487 struct vmspace *p_vmspace; /* (b) Address space. */
488 u_int p_swtick; /* (c) Tick when swapped in or out. */
489 struct itimerval p_realtimer; /* (c) Alarm timer. */
490 struct rusage p_ru; /* (a) Exit information. */
491 struct rusage_ext p_rux; /* (cj) Internal resource usage. */
492 struct rusage_ext p_crux; /* (c) Internal child resource usage. */
493 int p_profthreads; /* (c) Num threads in addupc_task. */
494 volatile int p_exitthreads; /* (j) Number of threads exiting */
495 int p_traceflag; /* (o) Kernel trace points. */
496 struct vnode *p_tracevp; /* (c + o) Trace to vnode. */
497 struct ucred *p_tracecred; /* (o) Credentials to trace with. */
498 struct vnode *p_textvp; /* (b) Vnode of executable. */
499 u_int p_lock; /* (c) Proclock (prevent swap) count. */
500 struct sigiolst p_sigiolst; /* (c) List of sigio sources. */
501 int p_sigparent; /* (c) Signal to parent on exit. */
502 int p_sig; /* (n) For core dump/debugger XXX. */
503 u_long p_code; /* (n) For core dump/debugger XXX. */
504 u_int p_stops; /* (c) Stop event bitmask. */
505 u_int p_stype; /* (c) Stop event type. */
506 char p_step; /* (c) Process is stopped. */
507 u_char p_pfsflags; /* (c) Procfs flags. */
508 struct nlminfo *p_nlminfo; /* (?) Only used by/for lockd. */
509 struct kaioinfo *p_aioinfo; /* (y) ASYNC I/O info. */
510 struct thread *p_singlethread;/* (c + j) If single threading this is it */
511 int p_suspcount; /* (j) Num threads in suspended mode. */
512 struct thread *p_xthread; /* (c) Trap thread */
513 int p_boundary_count;/* (c) Num threads at user boundary */
514 int p_pendingcnt; /* how many signals are pending */
515 struct itimers *p_itimers; /* (c) POSIX interval timers. */
516 /* End area that is zeroed on creation. */
517 #define p_endzero p_magic
519 /* The following fields are all copied upon creation in fork. */
520 #define p_startcopy p_endzero
521 u_int p_magic; /* (b) Magic number. */
522 int p_osrel; /* (x) osreldate for the
523 binary (from ELF note, if any) */
524 char p_comm[MAXCOMLEN + 1]; /* (b) Process name. */
525 struct pgrp *p_pgrp; /* (c + e) Pointer to process group. */
526 struct sysentvec *p_sysent; /* (b) Syscall dispatch info. */
527 struct pargs *p_args; /* (c) Process arguments. */
528 rlim_t p_cpulimit; /* (c) Current CPU limit in seconds. */
529 signed char p_nice; /* (c) Process "nice" value. */
530 int p_fibnum; /* in this routing domain XXX MRT */
531 /* End area that is copied on creation. */
532 #define p_endcopy p_xstat
534 u_short p_xstat; /* (c) Exit status; also stop sig. */
535 struct knlist p_klist; /* (c) Knotes attached to this proc. */
536 int p_numthreads; /* (c) Number of threads. */
537 struct mdproc p_md; /* Any machine-dependent fields. */
538 struct callout p_itcallout; /* (h + c) Interval timer callout. */
539 u_short p_acflag; /* (c) Accounting flags. */
540 struct proc *p_peers; /* (r) */
541 struct proc *p_leader; /* (b) */
542 void *p_emuldata; /* (c) Emulator state data. */
543 struct label *p_label; /* (*) Proc (not subject) MAC label. */
544 struct p_sched *p_sched; /* (*) Scheduler-specific data. */
545 STAILQ_HEAD(, ktr_request) p_ktr; /* (o) KTR event queue. */
546 LIST_HEAD(, mqueue_notifier) p_mqnotifier; /* (c) mqueue notifiers.*/
547 struct kdtrace_proc *p_dtrace; /* (*) DTrace-specific data. */
548 struct cv p_pwait; /* (*) wait cv for exit/exec */
551 #define p_session p_pgrp->pg_session
552 #define p_pgid p_pgrp->pg_id
554 #define NOCPU 0xff /* For when we aren't on a CPU. */
556 #define PROC_SLOCK(p) mtx_lock_spin(&(p)->p_slock)
557 #define PROC_SUNLOCK(p) mtx_unlock_spin(&(p)->p_slock)
558 #define PROC_SLOCK_ASSERT(p, type) mtx_assert(&(p)->p_slock, (type))
560 /* These flags are kept in p_flag. */
561 #define P_ADVLOCK 0x00001 /* Process may hold a POSIX advisory lock. */
562 #define P_CONTROLT 0x00002 /* Has a controlling terminal. */
563 #define P_KTHREAD 0x00004 /* Kernel thread (*). */
564 #define P_NOLOAD 0x00008 /* Ignore during load avg calculations. */
565 #define P_PPWAIT 0x00010 /* Parent is waiting for child to exec/exit. */
566 #define P_PROFIL 0x00020 /* Has started profiling. */
567 #define P_STOPPROF 0x00040 /* Has thread requesting to stop profiling. */
568 #define P_HADTHREADS 0x00080 /* Has had threads (no cleanup shortcuts) */
569 #define P_SUGID 0x00100 /* Had set id privileges since last exec. */
570 #define P_SYSTEM 0x00200 /* System proc: no sigs, stats or swapping. */
571 #define P_SINGLE_EXIT 0x00400 /* Threads suspending should exit, not wait. */
572 #define P_TRACED 0x00800 /* Debugged process being traced. */
573 #define P_WAITED 0x01000 /* Someone is waiting for us. */
574 #define P_WEXIT 0x02000 /* Working on exiting. */
575 #define P_EXEC 0x04000 /* Process called exec. */
576 #define P_UNUSED8000 0x08000 /* available. */
577 #define P_CONTINUED 0x10000 /* Proc has continued from a stopped state. */
578 #define P_STOPPED_SIG 0x20000 /* Stopped due to SIGSTOP/SIGTSTP. */
579 #define P_STOPPED_TRACE 0x40000 /* Stopped because of tracing. */
580 #define P_STOPPED_SINGLE 0x80000 /* Only 1 thread can continue (not to user). */
581 #define P_PROTECTED 0x100000 /* Do not kill on memory overcommit. */
582 #define P_SIGEVENT 0x200000 /* Process pending signals changed. */
583 #define P_SINGLE_BOUNDARY 0x400000 /* Threads should suspend at user boundary. */
584 #define P_HWPMC 0x800000 /* Process is using HWPMCs */
586 #define P_JAILED 0x1000000 /* Process is in jail. */
587 #define P_INEXEC 0x4000000 /* Process is in execve(). */
588 #define P_STATCHILD 0x8000000 /* Child process stopped or exited. */
589 #define P_INMEM 0x10000000 /* Loaded into memory. */
590 #define P_SWAPPINGOUT 0x20000000 /* Process is being swapped out. */
591 #define P_SWAPPINGIN 0x40000000 /* Process is being swapped in. */
593 #define P_STOPPED (P_STOPPED_SIG|P_STOPPED_SINGLE|P_STOPPED_TRACE)
594 #define P_SHOULDSTOP(p) ((p)->p_flag & P_STOPPED)
597 * These were process status values (p_stat), now they are only used in
598 * legacy conversion code.
600 #define SIDL 1 /* Process being created by fork. */
601 #define SRUN 2 /* Currently runnable. */
602 #define SSLEEP 3 /* Sleeping on an address. */
603 #define SSTOP 4 /* Process debugging or suspension. */
604 #define SZOMB 5 /* Awaiting collection by parent. */
605 #define SWAIT 6 /* Waiting for interrupt. */
606 #define SLOCK 7 /* Blocked on a lock. */
608 #define P_MAGIC 0xbeefface
612 /* Types and flags for mi_switch(). */
613 #define SW_TYPE_MASK 0xff /* First 8 bits are switch type */
614 #define SWT_NONE 0 /* Unspecified switch. */
615 #define SWT_PREEMPT 1 /* Switching due to preemption. */
616 #define SWT_OWEPREEMPT 2 /* Switching due to opepreempt. */
617 #define SWT_TURNSTILE 3 /* Turnstile contention. */
618 #define SWT_SLEEPQ 4 /* Sleepq wait. */
619 #define SWT_SLEEPQTIMO 5 /* Sleepq timeout wait. */
620 #define SWT_RELINQUISH 6 /* yield call. */
621 #define SWT_NEEDRESCHED 7 /* NEEDRESCHED was set. */
622 #define SWT_IDLE 8 /* Switching from the idle thread. */
623 #define SWT_IWAIT 9 /* Waiting for interrupts. */
624 #define SWT_SUSPEND 10 /* Thread suspended. */
625 #define SWT_REMOTEPREEMPT 11 /* Remote processor preempted. */
626 #define SWT_REMOTEWAKEIDLE 12 /* Remote processor preempted idle. */
627 #define SWT_COUNT 13 /* Number of switch types. */
629 #define SW_VOL 0x0100 /* Voluntary switch. */
630 #define SW_INVOL 0x0200 /* Involuntary switch. */
631 #define SW_PREEMPT 0x0400 /* The invol switch is a preemption */
633 /* How values for thread_single(). */
634 #define SINGLE_NO_EXIT 0
635 #define SINGLE_EXIT 1
636 #define SINGLE_BOUNDARY 2
638 #ifdef MALLOC_DECLARE
639 MALLOC_DECLARE(M_PARGS);
640 MALLOC_DECLARE(M_PGRP);
641 MALLOC_DECLARE(M_SESSION);
642 MALLOC_DECLARE(M_SUBPROC);
643 MALLOC_DECLARE(M_ZOMBIE);
646 #define FOREACH_PROC_IN_SYSTEM(p) \
647 LIST_FOREACH((p), &allproc, p_list)
648 #define FOREACH_THREAD_IN_PROC(p, td) \
649 TAILQ_FOREACH((td), &(p)->p_threads, td_plist)
651 #define FIRST_THREAD_IN_PROC(p) TAILQ_FIRST(&(p)->p_threads)
654 * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t,
655 * as it is used to represent "no process group".
657 #define PID_MAX 99999
658 #define NO_PID 100000
660 #define SESS_LEADER(p) ((p)->p_session->s_leader == (p))
663 #define STOPEVENT(p, e, v) do { \
664 if ((p)->p_stops & (e)) { \
666 stopevent((p), (e), (v)); \
670 #define _STOPEVENT(p, e, v) do { \
671 PROC_LOCK_ASSERT(p, MA_OWNED); \
672 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, &p->p_mtx.lock_object, \
673 "checking stopevent %d", (e)); \
674 if ((p)->p_stops & (e)) \
675 stopevent((p), (e), (v)); \
678 /* Lock and unlock a process. */
679 #define PROC_LOCK(p) mtx_lock(&(p)->p_mtx)
680 #define PROC_TRYLOCK(p) mtx_trylock(&(p)->p_mtx)
681 #define PROC_UNLOCK(p) mtx_unlock(&(p)->p_mtx)
682 #define PROC_LOCKED(p) mtx_owned(&(p)->p_mtx)
683 #define PROC_LOCK_ASSERT(p, type) mtx_assert(&(p)->p_mtx, (type))
685 /* Lock and unlock a process group. */
686 #define PGRP_LOCK(pg) mtx_lock(&(pg)->pg_mtx)
687 #define PGRP_UNLOCK(pg) mtx_unlock(&(pg)->pg_mtx)
688 #define PGRP_LOCKED(pg) mtx_owned(&(pg)->pg_mtx)
689 #define PGRP_LOCK_ASSERT(pg, type) mtx_assert(&(pg)->pg_mtx, (type))
691 #define PGRP_LOCK_PGSIGNAL(pg) do { \
695 #define PGRP_UNLOCK_PGSIGNAL(pg) do { \
700 /* Lock and unlock a session. */
701 #define SESS_LOCK(s) mtx_lock(&(s)->s_mtx)
702 #define SESS_UNLOCK(s) mtx_unlock(&(s)->s_mtx)
703 #define SESS_LOCKED(s) mtx_owned(&(s)->s_mtx)
704 #define SESS_LOCK_ASSERT(s, type) mtx_assert(&(s)->s_mtx, (type))
706 /* Hold process U-area in memory, normally for ptrace/procfs work. */
707 #define PHOLD(p) do { \
712 #define _PHOLD(p) do { \
713 PROC_LOCK_ASSERT((p), MA_OWNED); \
714 KASSERT(!((p)->p_flag & P_WEXIT) || (p) == curproc, \
715 ("PHOLD of exiting process")); \
717 if (((p)->p_flag & P_INMEM) == 0) \
720 #define PROC_ASSERT_HELD(p) do { \
721 KASSERT((p)->p_lock > 0, ("process not held")); \
724 #define PRELE(p) do { \
729 #define _PRELE(p) do { \
730 PROC_LOCK_ASSERT((p), MA_OWNED); \
732 if (((p)->p_flag & P_WEXIT) && (p)->p_lock == 0) \
733 wakeup(&(p)->p_lock); \
735 #define PROC_ASSERT_NOT_HELD(p) do { \
736 KASSERT((p)->p_lock == 0, ("process held")); \
739 /* Check whether a thread is safe to be swapped out. */
740 #define thread_safetoswapout(td) ((td)->td_flags & TDF_CANSWAP)
742 /* Control whether or not it is safe for curthread to sleep. */
743 #define THREAD_NO_SLEEPING() do { \
744 KASSERT(!(curthread->td_pflags & TDP_NOSLEEPING), \
745 ("nested no sleeping")); \
746 curthread->td_pflags |= TDP_NOSLEEPING; \
749 #define THREAD_SLEEPING_OK() do { \
750 KASSERT((curthread->td_pflags & TDP_NOSLEEPING), \
751 ("nested sleeping ok")); \
752 curthread->td_pflags &= ~TDP_NOSLEEPING; \
755 #define PIDHASH(pid) (&pidhashtbl[(pid) & pidhash])
756 extern LIST_HEAD(pidhashhead, proc) *pidhashtbl;
757 extern u_long pidhash;
759 #define PGRPHASH(pgid) (&pgrphashtbl[(pgid) & pgrphash])
760 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
761 extern u_long pgrphash;
763 extern struct sx allproc_lock;
764 extern struct sx proctree_lock;
765 extern struct mtx ppeers_lock;
766 extern struct proc proc0; /* Process slot for swapper. */
767 extern struct thread thread0; /* Primary thread in proc0. */
768 extern struct vmspace vmspace0; /* VM space for proc0. */
769 extern int hogticks; /* Limit on kernel cpu hogs. */
771 extern int nprocs, maxproc; /* Current and max number of procs. */
772 extern int maxprocperuid; /* Max procs per uid. */
773 extern u_long ps_arg_cache_limit;
775 LIST_HEAD(proclist, proc);
776 TAILQ_HEAD(procqueue, proc);
777 TAILQ_HEAD(threadqueue, thread);
778 extern struct proclist allproc; /* List of all processes. */
779 extern struct proclist zombproc; /* List of zombie processes. */
780 extern struct proc *initproc, *pageproc; /* Process slots for init, pager. */
782 extern struct uma_zone *proc_zone;
784 struct proc *pfind(pid_t); /* Find process by id. */
785 struct pgrp *pgfind(pid_t); /* Find process group by id. */
786 struct proc *zpfind(pid_t); /* Find zombie process by id. */
788 void ast(struct trapframe *framep);
789 struct thread *choosethread(void);
790 int cr_cansignal(struct ucred *cred, struct proc *proc, int signum);
791 int enterpgrp(struct proc *p, pid_t pgid, struct pgrp *pgrp,
792 struct session *sess);
793 int enterthispgrp(struct proc *p, struct pgrp *pgrp);
794 void faultin(struct proc *p);
795 void fixjobc(struct proc *p, struct pgrp *pgrp, int entering);
796 int fork1(struct thread *, int, int, struct proc **);
797 void fork_exit(void (*)(void *, struct trapframe *), void *,
799 void fork_return(struct thread *, struct trapframe *);
800 int inferior(struct proc *p);
801 void kick_proc0(void);
802 int leavepgrp(struct proc *p);
803 int maybe_preempt(struct thread *td);
804 void mi_switch(int flags, struct thread *newtd);
805 int p_candebug(struct thread *td, struct proc *p);
806 int p_cansee(struct thread *td, struct proc *p);
807 int p_cansched(struct thread *td, struct proc *p);
808 int p_cansignal(struct thread *td, struct proc *p, int signum);
809 int p_canwait(struct thread *td, struct proc *p);
810 struct pargs *pargs_alloc(int len);
811 void pargs_drop(struct pargs *pa);
812 void pargs_hold(struct pargs *pa);
814 void proc_linkup0(struct proc *p, struct thread *td);
815 void proc_linkup(struct proc *p, struct thread *td);
816 void proc_reparent(struct proc *child, struct proc *newparent);
817 struct pstats *pstats_alloc(void);
818 void pstats_fork(struct pstats *src, struct pstats *dst);
819 void pstats_free(struct pstats *ps);
820 int securelevel_ge(struct ucred *cr, int level);
821 int securelevel_gt(struct ucred *cr, int level);
822 void sess_hold(struct session *);
823 void sess_release(struct session *);
824 int setrunnable(struct thread *);
825 void setsugid(struct proc *p);
826 int sigonstack(size_t sp);
827 void sleepinit(void);
828 void stopevent(struct proc *, u_int, u_int);
829 void threadinit(void);
831 int cpu_idle_wakeup(int);
832 extern void (*cpu_idle_hook)(void); /* Hook to machdep CPU idler. */
833 void cpu_switch(struct thread *, struct thread *, struct mtx *);
834 void cpu_throw(struct thread *, struct thread *) __dead2;
835 void unsleep(struct thread *);
836 void userret(struct thread *, struct trapframe *);
838 void cpu_exit(struct thread *);
839 void exit1(struct thread *, int) __dead2;
840 void cpu_fork(struct thread *, struct proc *, struct thread *, int);
841 void cpu_set_fork_handler(struct thread *, void (*)(void *), void *);
843 void cpu_set_upcall(struct thread *td, struct thread *td0);
844 void cpu_set_upcall_kse(struct thread *, void (*)(void *), void *,
846 int cpu_set_user_tls(struct thread *, void *tls_base);
847 void cpu_thread_alloc(struct thread *);
848 void cpu_thread_clean(struct thread *);
849 void cpu_thread_exit(struct thread *);
850 void cpu_thread_free(struct thread *);
851 void cpu_thread_swapin(struct thread *);
852 void cpu_thread_swapout(struct thread *);
853 struct thread *thread_alloc(int pages);
854 int thread_alloc_stack(struct thread *, int pages);
855 void thread_exit(void) __dead2;
856 void thread_free(struct thread *td);
857 void thread_link(struct thread *td, struct proc *p);
858 void thread_reap(void);
859 int thread_single(int how);
860 void thread_single_end(void);
861 void thread_stash(struct thread *td);
862 void thread_stopped(struct proc *p);
863 void childproc_stopped(struct proc *child, int reason);
864 void childproc_continued(struct proc *child);
865 void childproc_exited(struct proc *child);
866 int thread_suspend_check(int how);
867 void thread_suspend_switch(struct thread *);
868 void thread_suspend_one(struct thread *td);
869 void thread_unlink(struct thread *td);
870 void thread_unsuspend(struct proc *p);
871 int thread_unsuspend_one(struct thread *td);
872 void thread_unthread(struct thread *td);
873 void thread_wait(struct proc *p);
874 struct thread *thread_find(struct proc *p, lwpid_t tid);
875 void thr_exit1(void);
879 #endif /* !_SYS_PROC_H_ */