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. */
44 #include <sys/filedesc.h>
46 #include <sys/queue.h>
47 #include <sys/_lock.h>
48 #include <sys/_mutex.h>
49 #include <sys/priority.h>
50 #include <sys/rtprio.h> /* XXX. */
52 #include <sys/resource.h>
53 #include <sys/sigio.h>
54 #include <sys/signal.h>
55 #include <sys/signalvar.h>
57 #include <sys/time.h> /* For structs itimerval, timeval. */
61 #include <sys/ucontext.h>
62 #include <sys/ucred.h>
63 #include <machine/proc.h> /* Machine-dependent proc substruct. */
66 * One structure allocated per session.
69 * (m) locked by s_mtx mtx
70 * (e) locked by proctree_lock sx
71 * (c) const until freeing
74 int s_count; /* (m) Ref cnt; pgrps in session. */
75 struct proc *s_leader; /* (m + e) Session leader. */
76 struct vnode *s_ttyvp; /* (m) Vnode of controlling tty. */
77 struct tty *s_ttyp; /* (m) Controlling tty. */
78 pid_t s_sid; /* (c) Session ID. */
79 /* (m) Setlogin() name: */
80 char s_login[roundup(MAXLOGNAME, sizeof(long))];
81 struct mtx s_mtx; /* Mutex to protect members. */
85 * One structure allocated per process group.
88 * (m) locked by pg_mtx mtx
89 * (e) locked by proctree_lock sx
90 * (c) const until freeing
93 LIST_ENTRY(pgrp) pg_hash; /* (e) Hash chain. */
94 LIST_HEAD(, proc) pg_members; /* (m + e) Pointer to pgrp members. */
95 struct session *pg_session; /* (c) Pointer to session. */
96 struct sigiolst pg_sigiolst; /* (m) List of sigio sources. */
97 pid_t pg_id; /* (c) Process group id. */
98 int pg_jobc; /* (m) Job control process count. */
99 struct mtx pg_mtx; /* Mutex to protect members */
103 * pargs, used to hold a copy of the command line, if it had a sane length.
106 u_int ar_ref; /* Reference count. */
107 u_int ar_length; /* Length. */
108 u_char ar_args[1]; /* Arguments. */
112 * Description of a process.
114 * This structure contains the information needed to manage a thread of
115 * control, known in UN*X as a process; it has references to substructures
116 * containing descriptions of things that the process uses, but may share
117 * with related processes. The process structure and the substructures
118 * are always addressable except for those marked "(CPU)" below,
119 * which might be addressable only on a processor on which the process
122 * Below is a key of locks used to protect each member of struct proc. The
123 * lock is indicated by a reference to a specific character in parens in the
124 * associated comment.
125 * * - not yet protected
126 * a - only touched by curproc or parent during fork/wait
127 * b - created at fork, never changes
128 * (exception aiods switch vmspaces, but they are also
129 * marked 'P_SYSTEM' so hopefully it will be left alone)
130 * c - locked by proc mtx
131 * d - locked by allproc_lock lock
132 * e - locked by proctree_lock lock
134 * g - process group mtx
135 * h - callout_lock mtx
136 * i - by curproc or the master session mtx
137 * j - locked by proc slock
138 * k - only accessed by curthread
139 * k*- only accessed by curthread and from an interrupt
140 * l - the attaching proc or attaching proc parent
142 * n - not locked, lazy
144 * p - select lock (sellock)
145 * q - td_contested lock
148 * x - created at fork, only changes during single threading in exec
149 * z - zombie threads lock
151 * If the locking key specifies two identifiers (for example, p_pptr) then
152 * either lock is sufficient for read access, but both locks must be held
155 struct kaudit_record;
165 struct mqueue_notifier;
168 * Here we define the two structures used for process information.
170 * The first is the thread. It might be thought of as a "Kernel
171 * Schedulable Entity Context".
172 * This structure contains all the information as to where a thread of
173 * execution is now, or was when it was suspended, why it was suspended,
174 * and anything else that will be needed to restart it when it is
175 * rescheduled. It includes a scheduler specific substructure that is different
176 * for each scheduler.
179 * It is important to remember that when using M:N threading,
180 * a particular thread structure may only exist as long as
181 * the system call or kernel entrance (e.g. by pagefault)
182 * which it is currently executing. It should therefore NEVER be referenced
183 * by pointers in long lived structures that live longer than a single
184 * request. If several threads complete their work at the same time,
185 * they will all rewind their stacks to the user boundary, report their
186 * completion state, and all but one will be freed. That last one will
187 * be kept to provide a kernel stack and pcb for the NEXT syscall or kernel
188 * entrance (basically to save freeing and then re-allocating it). The existing
189 * thread keeps a cached spare thread available to allow it to quickly
190 * get one when it needs a new one. There is also a system
191 * cache of free threads. Threads have priority and partake in priority
192 * inheritance schemes.
194 * The second is the proc (process) which owns all the resources of a process
195 * other than CPU cycles, which are parceled out to the threads.
199 * Kernel runnable context (thread).
200 * This is what is put to sleep and reactivated.
201 * Thread context. Processes may have multiple threads.
204 struct mtx *volatile td_lock; /* replaces sched lock */
205 struct proc *td_proc; /* (*) Associated process. */
206 TAILQ_ENTRY(thread) td_plist; /* (*) All threads in this proc. */
208 /* The two queues below should someday be merged. */
209 TAILQ_ENTRY(thread) td_slpq; /* (t) Sleep queue. */
210 TAILQ_ENTRY(thread) td_lockq; /* (t) Lock queue. */
212 TAILQ_HEAD(, selinfo) td_selq; /* (p) List of selinfos. */
213 struct sleepqueue *td_sleepqueue; /* (k) Associated sleep queue. */
214 struct turnstile *td_turnstile; /* (k) Associated turnstile. */
215 struct umtx_q *td_umtxq; /* (c?) Link for when we're blocked. */
216 lwpid_t td_tid; /* (b) Thread ID. */
217 sigqueue_t td_sigqueue; /* (c) Sigs arrived, not delivered. */
218 #define td_siglist td_sigqueue.sq_signals
220 /* Cleared during fork1() or thread_schedule_upcall(). */
221 #define td_startzero td_flags
222 int td_flags; /* (t) TDF_* flags. */
223 int td_inhibitors; /* (t) Why can not run. */
224 int td_pflags; /* (k) Private thread (TDP_*) flags. */
225 int td_dupfd; /* (k) Ret value from fdopen. XXX */
226 int td_sqqueue; /* (t) Sleepqueue queue blocked on. */
227 void *td_wchan; /* (t) Sleep address. */
228 const char *td_wmesg; /* (t) Reason for sleep. */
229 u_char td_lastcpu; /* (t) Last cpu we were on. */
230 u_char td_oncpu; /* (t) Which cpu we are on. */
231 volatile u_char td_owepreempt; /* (k*) Preempt on last critical_exit */
232 short td_locks; /* (k) Count of non-spin locks. */
233 u_char td_tsqueue; /* (t) Turnstile queue blocked on. */
234 struct turnstile *td_blocked; /* (t) Lock thread is blocked on. */
235 const char *td_lockname; /* (t) Name of lock blocked on. */
236 LIST_HEAD(, turnstile) td_contested; /* (q) Contested locks. */
237 struct lock_list_entry *td_sleeplocks; /* (k) Held sleep locks. */
238 int td_intr_nesting_level; /* (k) Interrupt recursion. */
239 int td_pinned; /* (k) Temporary cpu pin count. */
240 struct kse_thr_mailbox *td_mailbox; /* (*) Userland mailbox address. */
241 struct ucred *td_ucred; /* (k) Reference to credentials. */
242 struct thread *td_standin; /* (k + a) Use this for an upcall. */
243 struct kse_upcall *td_upcall; /* (k + t) Upcall structure. */
244 u_int td_estcpu; /* (t) estimated cpu utilization */
245 u_int td_slptick; /* (t) Time at sleep. */
246 struct rusage td_ru; /* (t) rusage information */
247 uint64_t td_runtime; /* (t) How many cpu ticks we've run. */
248 u_int td_pticks; /* (t) Statclock hits for profiling */
249 u_int td_sticks; /* (t) Statclock hits in system mode. */
250 u_int td_iticks; /* (t) Statclock hits in intr mode. */
251 u_int td_uticks; /* (t) Statclock hits in user mode. */
252 u_int td_uuticks; /* (k) Statclock hits (usr), for UTS. */
253 u_int td_usticks; /* (k) Statclock hits (sys), for UTS. */
254 int td_intrval; /* (t) Return value of TDF_INTERRUPT. */
255 sigset_t td_oldsigmask; /* (k) Saved mask from pre sigpause. */
256 sigset_t td_sigmask; /* (c) Current signal mask. */
257 volatile u_int td_generation; /* (k) For detection of preemption */
258 stack_t td_sigstk; /* (k) Stack ptr and on-stack flag. */
259 int td_kflags; /* (c) Flags for KSE threading. */
260 int td_xsig; /* (c) Signal for ptrace */
261 u_long td_profil_addr; /* (k) Temporary addr until AST. */
262 u_int td_profil_ticks; /* (k) Temporary ticks until AST. */
263 char td_name[MAXCOMLEN + 1]; /* (*) Thread name. */
264 #define td_endzero td_base_pri
266 /* Copied during fork1() or thread_sched_upcall(). */
267 #define td_startcopy td_endzero
268 u_char td_base_pri; /* (t) Thread base kernel priority. */
269 u_char td_priority; /* (t) Thread active priority. */
270 u_char td_pri_class; /* (t) Scheduling class. */
271 u_char td_user_pri; /* (t) User pri from estcpu and nice. */
272 u_char td_base_user_pri; /* (t) Base user pri */
273 #define td_endcopy td_pcb
276 * Fields that must be manually set in fork1() or thread_sched_upcall()
277 * or already have been set in the allocator, constructor, etc.
279 struct pcb *td_pcb; /* (k) Kernel VA of pcb and kstack. */
286 } td_state; /* (t) thread state */
287 register_t td_retval[2]; /* (k) Syscall aux returns. */
288 struct callout td_slpcallout; /* (h) Callout for sleep. */
289 struct trapframe *td_frame; /* (k) */
290 struct vm_object *td_kstack_obj;/* (a) Kstack object. */
291 vm_offset_t td_kstack; /* (a) Kernel VA of kstack. */
292 int td_kstack_pages; /* (a) Size of the kstack. */
293 struct vm_object *td_altkstack_obj;/* (a) Alternate kstack object. */
294 vm_offset_t td_altkstack; /* (a) Kernel VA of alternate kstack. */
295 int td_altkstack_pages; /* (a) Size of alternate kstack. */
296 volatile u_int td_critnest; /* (k*) Critical section nest level. */
297 struct mdthread td_md; /* (k) Any machine-dependent fields. */
298 struct td_sched *td_sched; /* (*) Scheduler-specific data. */
299 struct kaudit_record *td_ar; /* (k) Active audit record, if any. */
300 int td_syscalls; /* per-thread syscall count (used by NFS :)) */
303 struct mtx *thread_lock_block(struct thread *);
304 void thread_lock_unblock(struct thread *, struct mtx *);
305 void thread_lock_set(struct thread *, struct mtx *);
306 #define THREAD_LOCK_ASSERT(td, type) \
308 struct mtx *__m = (td)->td_lock; \
309 if (__m != &blocked_lock) \
310 mtx_assert(__m, (type)); \
314 * Flags kept in td_flags:
315 * To change these you MUST have the scheduler lock.
317 #define TDF_BORROWING 0x00000001 /* Thread is borrowing pri from another. */
318 #define TDF_INPANIC 0x00000002 /* Caused a panic, let it drive crashdump. */
319 #define TDF_INMEM 0x00000004 /* Thread's stack is in memory. */
320 #define TDF_SINTR 0x00000008 /* Sleep is interruptible. */
321 #define TDF_TIMEOUT 0x00000010 /* Timing out during sleep. */
322 #define TDF_IDLETD 0x00000020 /* This is a per-CPU idle thread. */
323 #define TDF_SELECT 0x00000040 /* Selecting; wakeup/waiting danger. */
324 #define TDF_SLEEPABORT 0x00000080 /* sleepq_abort was called. */
325 #define TDF_UNUSEDx100 0x00000100 /* --available-- */
326 #define TDF_UBORROWING 0x00000200 /* Thread is borrowing user pri. */
327 #define TDF_BOUNDARY 0x00000400 /* Thread suspended at user boundary */
328 #define TDF_ASTPENDING 0x00000800 /* Thread has some asynchronous events. */
329 #define TDF_TIMOFAIL 0x00001000 /* Timeout from sleep after we were awake. */
330 #define TDF_INTERRUPT 0x00002000 /* Thread is marked as interrupted. */
331 #define TDF_UPIBLOCKED 0x00004000 /* Thread blocked on user PI mutex. */
332 #define TDF_UNUSED15 0x00008000 /* --available-- */
333 #define TDF_NEEDRESCHED 0x00010000 /* Thread needs to yield. */
334 #define TDF_NEEDSIGCHK 0x00020000 /* Thread may need signal delivery. */
335 #define TDF_XSIG 0x00040000 /* Thread is exchanging signal under trace */
336 #define TDF_UNUSED19 0x00080000 /* Thread is sleeping on a umtx. */
337 #define TDF_THRWAKEUP 0x00100000 /* Libthr thread must not suspend itself. */
338 #define TDF_DBSUSPEND 0x00200000 /* Thread is suspended by debugger */
339 #define TDF_SWAPINREQ 0x00400000 /* Swapin request due to wakeup. */
340 #define TDF_UNUSED23 0x00800000 /* --available-- */
341 #define TDF_SCHED0 0x01000000 /* Reserved for scheduler private use */
342 #define TDF_SCHED1 0x02000000 /* Reserved for scheduler private use */
343 #define TDF_SCHED2 0x04000000 /* Reserved for scheduler private use */
344 #define TDF_SCHED3 0x08000000 /* Reserved for scheduler private use */
345 #define TDF_ALRMPEND 0x10000000 /* Pending SIGVTALRM needs to be posted. */
346 #define TDF_PROFPEND 0x20000000 /* Pending SIGPROF needs to be posted. */
347 #define TDF_MACPEND 0x40000000 /* AST-based MAC event pending. */
350 * "Private" flags kept in td_pflags:
351 * These are only accessed by curthread and thus need no locking.
353 #define TDP_OLDMASK 0x00000001 /* Need to restore mask after suspend. */
354 #define TDP_INKTR 0x00000002 /* Thread is currently in KTR code. */
355 #define TDP_INKTRACE 0x00000004 /* Thread is currently in KTRACE code. */
356 #define TDP_UPCALLING 0x00000008 /* This thread is doing an upcall. */
357 #define TDP_COWINPROGRESS 0x00000010 /* Snapshot copy-on-write in progress. */
358 #define TDP_ALTSTACK 0x00000020 /* Have alternate signal stack. */
359 #define TDP_DEADLKTREAT 0x00000040 /* Lock aquisition - deadlock treatment. */
360 #define TDP_SA 0x00000080 /* A scheduler activation based thread. */
361 #define TDP_NOSLEEPING 0x00000100 /* Thread is not allowed to sleep on a sq. */
362 #define TDP_OWEUPC 0x00000200 /* Call addupc() at next AST. */
363 #define TDP_ITHREAD 0x00000400 /* Thread is an interrupt thread. */
364 #define TDP_CAN_UNBIND 0x00000800 /* Only temporarily bound. */
365 #define TDP_SCHED1 0x00001000 /* Reserved for scheduler private use */
366 #define TDP_SCHED2 0x00002000 /* Reserved for scheduler private use */
367 #define TDP_SCHED3 0x00004000 /* Reserved for scheduler private use */
368 #define TDP_SCHED4 0x00008000 /* Reserved for scheduler private use */
369 #define TDP_GEOM 0x00010000 /* Settle GEOM before finishing syscall */
370 #define TDP_SOFTDEP 0x00020000 /* Stuck processing softdep worklist */
371 #define TDP_NORUNNINGBUF 0x00040000 /* Ignore runningbufspace check */
372 #define TDP_WAKEUP 0x00080000 /* Don't sleep in umtx cond_wait */
373 #define TDP_INBDFLUSH 0x00100000 /* Already in BO_BDFLUSH, do not recurse */
376 * Reasons that the current thread can not be run yet.
377 * More than one may apply.
379 #define TDI_SUSPENDED 0x0001 /* On suspension queue. */
380 #define TDI_SLEEPING 0x0002 /* Actually asleep! (tricky). */
381 #define TDI_SWAPPED 0x0004 /* Stack not in mem. Bad juju if run. */
382 #define TDI_LOCK 0x0008 /* Stopped on a lock. */
383 #define TDI_IWAIT 0x0010 /* Awaiting interrupt. */
386 * flags (in kflags) related to M:N threading.
388 #define TDK_KSEREL 0x0001 /* Blocked in msleep on p->p_completed. */
389 #define TDK_KSERELSIG 0x0002 /* Blocked in msleep on p->p_siglist. */
390 #define TDK_WAKEUP 0x0004 /* Thread has been woken by kse_wakeup. */
392 #define TD_CAN_UNBIND(td) \
393 (((td)->td_pflags & TDP_CAN_UNBIND) && \
394 ((td)->td_upcall != NULL))
396 #define TD_IS_SLEEPING(td) ((td)->td_inhibitors & TDI_SLEEPING)
397 #define TD_ON_SLEEPQ(td) ((td)->td_wchan != NULL)
398 #define TD_IS_SUSPENDED(td) ((td)->td_inhibitors & TDI_SUSPENDED)
399 #define TD_IS_SWAPPED(td) ((td)->td_inhibitors & TDI_SWAPPED)
400 #define TD_ON_LOCK(td) ((td)->td_inhibitors & TDI_LOCK)
401 #define TD_AWAITING_INTR(td) ((td)->td_inhibitors & TDI_IWAIT)
402 #define TD_IS_RUNNING(td) ((td)->td_state == TDS_RUNNING)
403 #define TD_ON_RUNQ(td) ((td)->td_state == TDS_RUNQ)
404 #define TD_CAN_RUN(td) ((td)->td_state == TDS_CAN_RUN)
405 #define TD_IS_INHIBITED(td) ((td)->td_state == TDS_INHIBITED)
406 #define TD_ON_UPILOCK(td) ((td)->td_flags & TDF_UPIBLOCKED)
408 #define TD_IS_IDLETHREAD(td) ((td) == pcpu(idlethread))
410 #define TD_IS_IDLETHREAD(td) ((td)->td_flags & TDF_IDLETD)
414 #define TD_SET_INHIB(td, inhib) do { \
415 (td)->td_state = TDS_INHIBITED; \
416 (td)->td_inhibitors |= (inhib); \
419 #define TD_CLR_INHIB(td, inhib) do { \
420 if (((td)->td_inhibitors & (inhib)) && \
421 (((td)->td_inhibitors &= ~(inhib)) == 0)) \
422 (td)->td_state = TDS_CAN_RUN; \
425 #define TD_SET_SLEEPING(td) TD_SET_INHIB((td), TDI_SLEEPING)
426 #define TD_SET_SWAPPED(td) TD_SET_INHIB((td), TDI_SWAPPED)
427 #define TD_SET_LOCK(td) TD_SET_INHIB((td), TDI_LOCK)
428 #define TD_SET_SUSPENDED(td) TD_SET_INHIB((td), TDI_SUSPENDED)
429 #define TD_SET_IWAIT(td) TD_SET_INHIB((td), TDI_IWAIT)
430 #define TD_SET_EXITING(td) TD_SET_INHIB((td), TDI_EXITING)
432 #define TD_CLR_SLEEPING(td) TD_CLR_INHIB((td), TDI_SLEEPING)
433 #define TD_CLR_SWAPPED(td) TD_CLR_INHIB((td), TDI_SWAPPED)
434 #define TD_CLR_LOCK(td) TD_CLR_INHIB((td), TDI_LOCK)
435 #define TD_CLR_SUSPENDED(td) TD_CLR_INHIB((td), TDI_SUSPENDED)
436 #define TD_CLR_IWAIT(td) TD_CLR_INHIB((td), TDI_IWAIT)
438 #define TD_SET_RUNNING(td) (td)->td_state = TDS_RUNNING
439 #define TD_SET_RUNQ(td) (td)->td_state = TDS_RUNQ
440 #define TD_SET_CAN_RUN(td) (td)->td_state = TDS_CAN_RUN
443 * An upcall is used when returning to userland. If a thread does not have
444 * an upcall on return to userland the thread exports its context and exits.
447 TAILQ_ENTRY(kse_upcall) ku_link; /* List of upcalls in proc. */
448 struct proc *ku_proc; /* Associated proc. */
449 struct thread *ku_owner; /* Owning thread. */
450 int ku_flags; /* KUF_* flags. */
451 struct kse_mailbox *ku_mailbox; /* Userland mailbox address. */
452 stack_t ku_stack; /* Userland upcall stack. */
453 void *ku_func; /* Userland upcall function. */
454 unsigned int ku_mflags; /* Cached upcall mbox flags. */
457 #define KUF_DOUPCALL 0x00001 /* Do upcall now; don't wait. */
458 #define KUF_EXITING 0x00002 /* Upcall structure is exiting. */
461 * XXX: Does this belong in resource.h or resourcevar.h instead?
462 * Resource usage extension. The times in rusage structs in the kernel are
463 * never up to date. The actual times are kept as runtimes and tick counts
464 * (with control info in the "previous" times), and are converted when
465 * userland asks for rusage info. Backwards compatibility prevents putting
466 * this directly in the user-visible rusage struct.
468 * Locking: (cj) means (j) for p_rux and (c) for p_crux.
471 u_int64_t rux_runtime; /* (cj) Real time. */
472 u_int64_t rux_uticks; /* (cj) Statclock hits in user mode. */
473 u_int64_t rux_sticks; /* (cj) Statclock hits in sys mode. */
474 u_int64_t rux_iticks; /* (cj) Statclock hits in intr mode. */
475 u_int64_t rux_uu; /* (c) Previous user time in usec. */
476 u_int64_t rux_su; /* (c) Previous sys time in usec. */
477 u_int64_t rux_tu; /* (c) Previous total time in usec. */
481 * The old fashionned process. May have multiple threads.
482 * Starts off with a single embedded THREAD.
485 LIST_ENTRY(proc) p_list; /* (d) List of all processes. */
486 TAILQ_HEAD(, thread) p_threads; /* (j) all threads. */
487 TAILQ_HEAD(, kse_upcall) p_upcalls; /* (j) All upcalls in the proc. */
488 struct mtx p_slock; /* process spin lock */
489 struct ucred *p_ucred; /* (c) Process owner's identity. */
490 struct filedesc *p_fd; /* (b) Open files. */
491 struct filedesc_to_leader *p_fdtol; /* (b) Tracking node */
492 /* Accumulated stats for all threads? */
493 struct pstats *p_stats; /* (b) Accounting/statistics (CPU). */
494 struct plimit *p_limit; /* (c) Process limits. */
495 struct callout p_limco; /* (c) Limit callout handle */
496 struct sigacts *p_sigacts; /* (x) Signal actions, state (CPU). */
499 * The following don't make too much sense.
500 * See the td_ or ke_ versions of the same flags.
502 int p_flag; /* (c) P_* flags. */
504 PRS_NEW = 0, /* In creation */
505 PRS_NORMAL, /* threads can be run. */
507 } p_state; /* (j/c) S* process status. */
508 pid_t p_pid; /* (b) Process identifier. */
509 LIST_ENTRY(proc) p_hash; /* (d) Hash chain. */
510 LIST_ENTRY(proc) p_pglist; /* (g + e) List of processes in pgrp. */
511 struct proc *p_pptr; /* (c + e) Pointer to parent process. */
512 LIST_ENTRY(proc) p_sibling; /* (e) List of sibling processes. */
513 LIST_HEAD(, proc) p_children; /* (e) Pointer to list of children. */
514 struct mtx p_mtx; /* (n) Lock for this struct. */
515 struct ksiginfo *p_ksi; /* Locked by parent proc lock */
516 sigqueue_t p_sigqueue; /* (c) Sigs not delivered to a td. */
517 #define p_siglist p_sigqueue.sq_signals
519 /* The following fields are all zeroed upon creation in fork. */
520 #define p_startzero p_oppid
521 pid_t p_oppid; /* (c + e) Save ppid in ptrace. XXX */
522 struct vmspace *p_vmspace; /* (b) Address space. */
523 u_int p_swtick; /* (j) Tick when swapped in or out. */
524 struct itimerval p_realtimer; /* (c) Alarm timer. */
525 struct rusage p_ru; /* (a) Exit information. */
526 struct rusage_ext p_rux; /* (cj) Internal resource usage. */
527 struct rusage_ext p_crux; /* (c) Internal child resource usage. */
528 int p_profthreads; /* (c) Num threads in addupc_task. */
529 volatile int p_exitthreads; /* (j) Number of threads exiting */
530 int p_traceflag; /* (o) Kernel trace points. */
531 struct vnode *p_tracevp; /* (c + o) Trace to vnode. */
532 struct ucred *p_tracecred; /* (o) Credentials to trace with. */
533 struct vnode *p_textvp; /* (b) Vnode of executable. */
534 char p_lock; /* (c) Proclock (prevent swap) count. */
535 struct sigiolst p_sigiolst; /* (c) List of sigio sources. */
536 int p_sigparent; /* (c) Signal to parent on exit. */
537 int p_sig; /* (n) For core dump/debugger XXX. */
538 u_long p_code; /* (n) For core dump/debugger XXX. */
539 u_int p_stops; /* (c) Stop event bitmask. */
540 u_int p_stype; /* (c) Stop event type. */
541 char p_step; /* (c) Process is stopped. */
542 u_char p_pfsflags; /* (c) Procfs flags. */
543 struct nlminfo *p_nlminfo; /* (?) Only used by/for lockd. */
544 struct kaioinfo *p_aioinfo; /* (c) ASYNC I/O info. */
545 struct thread *p_singlethread;/* (c + j) If single threading this is it */
546 int p_suspcount; /* (j) Num threads in suspended mode. */
547 struct thread *p_xthread; /* (c) Trap thread */
548 int p_boundary_count;/* (c) Num threads at user boundary */
549 int p_pendingcnt; /* how many signals are pending */
550 struct itimers *p_itimers; /* (c) POSIX interval timers. */
551 int p_numupcalls; /* (j) Num upcalls. */
552 int p_upsleeps; /* (c) Num threads in kse_release(). */
553 struct kse_thr_mailbox *p_completed; /* (c) Completed thread mboxes. */
554 int p_nextupcall; /* (n) Next upcall time. */
555 int p_upquantum; /* (n) Quantum to schedule an upcall. */
556 /* End area that is zeroed on creation. */
557 #define p_endzero p_magic
559 /* The following fields are all copied upon creation in fork. */
560 #define p_startcopy p_endzero
561 u_int p_magic; /* (b) Magic number. */
562 char p_comm[MAXCOMLEN + 1]; /* (b) Process name. */
563 struct pgrp *p_pgrp; /* (c + e) Pointer to process group. */
564 struct sysentvec *p_sysent; /* (b) Syscall dispatch info. */
565 struct pargs *p_args; /* (c) Process arguments. */
566 rlim_t p_cpulimit; /* (c) Current CPU limit in seconds. */
567 signed char p_nice; /* (c + j) Process "nice" value. */
568 /* End area that is copied on creation. */
569 #define p_endcopy p_xstat
571 u_short p_xstat; /* (c) Exit status; also stop sig. */
572 struct knlist p_klist; /* (c) Knotes attached to this proc. */
573 int p_numthreads; /* (j) Number of threads. */
574 struct mdproc p_md; /* Any machine-dependent fields. */
575 struct callout p_itcallout; /* (h + c) Interval timer callout. */
576 u_short p_acflag; /* (c) Accounting flags. */
577 struct proc *p_peers; /* (r) */
578 struct proc *p_leader; /* (b) */
579 void *p_emuldata; /* (c) Emulator state data. */
580 struct label *p_label; /* (*) Proc (not subject) MAC label. */
581 struct p_sched *p_sched; /* (*) Scheduler-specific data. */
582 STAILQ_HEAD(, ktr_request) p_ktr; /* (o) KTR event queue. */
583 LIST_HEAD(, mqueue_notifier) p_mqnotifier; /* (c) mqueue notifiers.*/
586 #define p_session p_pgrp->pg_session
587 #define p_pgid p_pgrp->pg_id
589 #define NOCPU 0xff /* For when we aren't on a CPU. */
591 #define PROC_SLOCK(p) mtx_lock_spin(&(p)->p_slock)
592 #define PROC_SUNLOCK(p) mtx_unlock_spin(&(p)->p_slock)
593 #define PROC_SLOCK_ASSERT(p, type) mtx_assert(&(p)->p_slock, (type))
595 /* These flags are kept in p_flag. */
596 #define P_ADVLOCK 0x00001 /* Process may hold a POSIX advisory lock. */
597 #define P_CONTROLT 0x00002 /* Has a controlling terminal. */
598 #define P_KTHREAD 0x00004 /* Kernel thread (*). */
599 #define P_NOLOAD 0x00008 /* Ignore during load avg calculations. */
600 #define P_PPWAIT 0x00010 /* Parent is waiting for child to exec/exit. */
601 #define P_PROFIL 0x00020 /* Has started profiling. */
602 #define P_STOPPROF 0x00040 /* Has thread requesting to stop profiling. */
603 #define P_HADTHREADS 0x00080 /* Has had threads (no cleanup shortcuts) */
604 #define P_SUGID 0x00100 /* Had set id privileges since last exec. */
605 #define P_SYSTEM 0x00200 /* System proc: no sigs, stats or swapping. */
606 #define P_SINGLE_EXIT 0x00400 /* Threads suspending should exit, not wait. */
607 #define P_TRACED 0x00800 /* Debugged process being traced. */
608 #define P_WAITED 0x01000 /* Someone is waiting for us. */
609 #define P_WEXIT 0x02000 /* Working on exiting. */
610 #define P_EXEC 0x04000 /* Process called exec. */
611 #define P_SA 0x08000 /* Using scheduler activations. */
612 #define P_CONTINUED 0x10000 /* Proc has continued from a stopped state. */
613 #define P_STOPPED_SIG 0x20000 /* Stopped due to SIGSTOP/SIGTSTP. */
614 #define P_STOPPED_TRACE 0x40000 /* Stopped because of tracing. */
615 #define P_STOPPED_SINGLE 0x80000 /* Only 1 thread can continue (not to user). */
616 #define P_PROTECTED 0x100000 /* Do not kill on memory overcommit. */
617 #define P_SIGEVENT 0x200000 /* Process pending signals changed. */
618 #define P_SINGLE_BOUNDARY 0x400000 /* Threads should suspend at user boundary. */
619 #define P_HWPMC 0x800000 /* Process is using HWPMCs */
621 #define P_JAILED 0x1000000 /* Process is in jail. */
622 #define P_INEXEC 0x4000000 /* Process is in execve(). */
623 #define P_STATCHILD 0x8000000 /* Child process stopped or exited. */
624 #define P_INMEM 0x10000000 /* Loaded into memory. */
625 #define P_SWAPPINGOUT 0x20000000 /* Process is being swapped out. */
626 #define P_SWAPPINGIN 0x40000000 /* Process is being swapped in. */
628 #define P_STOPPED (P_STOPPED_SIG|P_STOPPED_SINGLE|P_STOPPED_TRACE)
629 #define P_SHOULDSTOP(p) ((p)->p_flag & P_STOPPED)
632 * These were process status values (p_stat), now they are only used in
633 * legacy conversion code.
635 #define SIDL 1 /* Process being created by fork. */
636 #define SRUN 2 /* Currently runnable. */
637 #define SSLEEP 3 /* Sleeping on an address. */
638 #define SSTOP 4 /* Process debugging or suspension. */
639 #define SZOMB 5 /* Awaiting collection by parent. */
640 #define SWAIT 6 /* Waiting for interrupt. */
641 #define SLOCK 7 /* Blocked on a lock. */
643 #define P_MAGIC 0xbeefface
647 /* Flags for mi_switch(). */
648 #define SW_VOL 0x0001 /* Voluntary switch. */
649 #define SW_INVOL 0x0002 /* Involuntary switch. */
650 #define SW_PREEMPT 0x0004 /* The invol switch is a preemption */
652 /* How values for thread_single(). */
653 #define SINGLE_NO_EXIT 0
654 #define SINGLE_EXIT 1
655 #define SINGLE_BOUNDARY 2
657 /* XXXKSE: Missing values for thread_suspend_check(). */
659 #ifdef MALLOC_DECLARE
660 MALLOC_DECLARE(M_PARGS);
661 MALLOC_DECLARE(M_PGRP);
662 MALLOC_DECLARE(M_SESSION);
663 MALLOC_DECLARE(M_SUBPROC);
664 MALLOC_DECLARE(M_ZOMBIE);
667 #define FOREACH_PROC_IN_SYSTEM(p) \
668 LIST_FOREACH((p), &allproc, p_list)
669 #define FOREACH_THREAD_IN_PROC(p, td) \
670 TAILQ_FOREACH((td), &(p)->p_threads, td_plist)
671 #define FOREACH_UPCALL_IN_PROC(p, ku) \
672 TAILQ_FOREACH((ku), &(p)->p_upcalls, ku_link)
674 /* XXXKSE the following lines should probably only be used in 1:1 code: */
675 #define FIRST_THREAD_IN_PROC(p) TAILQ_FIRST(&(p)->p_threads)
678 * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t,
679 * as it is used to represent "no process group".
681 #define PID_MAX 99999
682 #define NO_PID 100000
684 #define SESS_LEADER(p) ((p)->p_session->s_leader == (p))
685 #define SESSHOLD(s) ((s)->s_count++)
686 #define SESSRELE(s) sessrele(s)
689 #define STOPEVENT(p, e, v) do { \
690 if ((p)->p_stops & (e)) { \
692 stopevent((p), (e), (v)); \
696 #define _STOPEVENT(p, e, v) do { \
697 PROC_LOCK_ASSERT(p, MA_OWNED); \
698 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, &p->p_mtx.lock_object, \
699 "checking stopevent %d", (e)); \
700 if ((p)->p_stops & (e)) \
701 stopevent((p), (e), (v)); \
704 /* Lock and unlock a process. */
705 #define PROC_LOCK(p) mtx_lock(&(p)->p_mtx)
706 #define PROC_TRYLOCK(p) mtx_trylock(&(p)->p_mtx)
707 #define PROC_UNLOCK(p) mtx_unlock(&(p)->p_mtx)
708 #define PROC_LOCKED(p) mtx_owned(&(p)->p_mtx)
709 #define PROC_LOCK_ASSERT(p, type) mtx_assert(&(p)->p_mtx, (type))
711 /* Lock and unlock a process group. */
712 #define PGRP_LOCK(pg) mtx_lock(&(pg)->pg_mtx)
713 #define PGRP_UNLOCK(pg) mtx_unlock(&(pg)->pg_mtx)
714 #define PGRP_LOCKED(pg) mtx_owned(&(pg)->pg_mtx)
715 #define PGRP_LOCK_ASSERT(pg, type) mtx_assert(&(pg)->pg_mtx, (type))
717 #define PGRP_LOCK_PGSIGNAL(pg) do { \
721 #define PGRP_UNLOCK_PGSIGNAL(pg) do { \
726 /* Lock and unlock a session. */
727 #define SESS_LOCK(s) mtx_lock(&(s)->s_mtx)
728 #define SESS_UNLOCK(s) mtx_unlock(&(s)->s_mtx)
729 #define SESS_LOCKED(s) mtx_owned(&(s)->s_mtx)
730 #define SESS_LOCK_ASSERT(s, type) mtx_assert(&(s)->s_mtx, (type))
732 /* Hold process U-area in memory, normally for ptrace/procfs work. */
733 #define PHOLD(p) do { \
738 #define _PHOLD(p) do { \
739 PROC_LOCK_ASSERT((p), MA_OWNED); \
740 KASSERT(!((p)->p_flag & P_WEXIT) || (p) == curproc, \
741 ("PHOLD of exiting process")); \
743 if (((p)->p_flag & P_INMEM) == 0) \
746 #define PROC_ASSERT_HELD(p) do { \
747 KASSERT((p)->p_lock > 0, ("process not held")); \
750 #define PRELE(p) do { \
755 #define _PRELE(p) do { \
756 PROC_LOCK_ASSERT((p), MA_OWNED); \
758 if (((p)->p_flag & P_WEXIT) && (p)->p_lock == 0) \
759 wakeup(&(p)->p_lock); \
761 #define PROC_ASSERT_NOT_HELD(p) do { \
762 KASSERT((p)->p_lock == 0, ("process held")); \
765 /* Check whether a thread is safe to be swapped out. */
766 #define thread_safetoswapout(td) (TD_IS_SLEEPING(td) || TD_IS_SUSPENDED(td))
768 /* Control whether or not it is safe for curthread to sleep. */
769 #define THREAD_NO_SLEEPING() do { \
770 KASSERT(!(curthread->td_pflags & TDP_NOSLEEPING), \
771 ("nested no sleeping")); \
772 curthread->td_pflags |= TDP_NOSLEEPING; \
775 #define THREAD_SLEEPING_OK() do { \
776 KASSERT((curthread->td_pflags & TDP_NOSLEEPING), \
777 ("nested sleeping ok")); \
778 curthread->td_pflags &= ~TDP_NOSLEEPING; \
781 #define PIDHASH(pid) (&pidhashtbl[(pid) & pidhash])
782 extern LIST_HEAD(pidhashhead, proc) *pidhashtbl;
783 extern u_long pidhash;
785 #define PGRPHASH(pgid) (&pgrphashtbl[(pgid) & pgrphash])
786 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
787 extern u_long pgrphash;
789 extern struct sx allproc_lock;
790 extern struct sx proctree_lock;
791 extern struct mtx ppeers_lock;
792 extern struct proc proc0; /* Process slot for swapper. */
793 extern struct thread thread0; /* Primary thread in proc0. */
794 extern struct vmspace vmspace0; /* VM space for proc0. */
795 extern int hogticks; /* Limit on kernel cpu hogs. */
797 extern int nprocs, maxproc; /* Current and max number of procs. */
798 extern int maxprocperuid; /* Max procs per uid. */
799 extern u_long ps_arg_cache_limit;
801 LIST_HEAD(proclist, proc);
802 TAILQ_HEAD(procqueue, proc);
803 TAILQ_HEAD(threadqueue, thread);
804 extern struct proclist allproc; /* List of all processes. */
805 extern struct proclist zombproc; /* List of zombie processes. */
806 extern struct proc *initproc, *pageproc; /* Process slots for init, pager. */
808 extern struct uma_zone *proc_zone;
810 struct proc *pfind(pid_t); /* Find process by id. */
811 struct pgrp *pgfind(pid_t); /* Find process group by id. */
812 struct proc *zpfind(pid_t); /* Find zombie process by id. */
814 void ast(struct trapframe *framep);
815 struct thread *choosethread(void);
816 int cr_cansignal(struct ucred *cred, struct proc *proc, int signum);
817 int enterpgrp(struct proc *p, pid_t pgid, struct pgrp *pgrp,
818 struct session *sess);
819 int enterthispgrp(struct proc *p, struct pgrp *pgrp);
820 void faultin(struct proc *p);
821 void fixjobc(struct proc *p, struct pgrp *pgrp, int entering);
822 int fork1(struct thread *, int, int, struct proc **);
823 void fork_exit(void (*)(void *, struct trapframe *), void *,
825 void fork_return(struct thread *, struct trapframe *);
826 int inferior(struct proc *p);
827 void kick_proc0(void);
828 int leavepgrp(struct proc *p);
829 int maybe_preempt(struct thread *td);
830 void mi_switch(int flags, struct thread *newtd);
831 int p_candebug(struct thread *td, struct proc *p);
832 int p_cansee(struct thread *td, struct proc *p);
833 int p_cansched(struct thread *td, struct proc *p);
834 int p_cansignal(struct thread *td, struct proc *p, int signum);
835 int p_canwait(struct thread *td, struct proc *p);
836 struct pargs *pargs_alloc(int len);
837 void pargs_drop(struct pargs *pa);
838 void pargs_free(struct pargs *pa);
839 void pargs_hold(struct pargs *pa);
841 void proc_linkup(struct proc *p, struct thread *td);
842 void proc_reparent(struct proc *child, struct proc *newparent);
843 struct pstats *pstats_alloc(void);
844 void pstats_fork(struct pstats *src, struct pstats *dst);
845 void pstats_free(struct pstats *ps);
846 int securelevel_ge(struct ucred *cr, int level);
847 int securelevel_gt(struct ucred *cr, int level);
848 void sessrele(struct session *);
849 void setrunnable(struct thread *);
850 void setsugid(struct proc *p);
851 int sigonstack(size_t sp);
852 void sleepinit(void);
853 void stopevent(struct proc *, u_int, u_int);
854 void threadinit(void);
856 extern void (*cpu_idle_hook)(void); /* Hook to machdep CPU idler. */
857 void cpu_switch(struct thread *, struct thread *, struct mtx *);
858 void cpu_throw(struct thread *, struct thread *) __dead2;
859 void unsleep(struct thread *);
860 void userret(struct thread *, struct trapframe *);
862 void cpu_exit(struct thread *);
863 void exit1(struct thread *, int) __dead2;
864 void cpu_fork(struct thread *, struct proc *, struct thread *, int);
865 void cpu_set_fork_handler(struct thread *, void (*)(void *), void *);
869 void kse_unlink(struct thread *);
871 void upcall_reap(void);
872 void upcall_remove(struct thread *td);
874 void cpu_set_upcall(struct thread *td, struct thread *td0);
875 void cpu_set_upcall_kse(struct thread *, void (*)(void *), void *, stack_t *);
876 int cpu_set_user_tls(struct thread *, void *tls_base);
877 void cpu_thread_clean(struct thread *);
878 void cpu_thread_exit(struct thread *);
879 void cpu_thread_setup(struct thread *td);
880 void cpu_thread_swapin(struct thread *);
881 void cpu_thread_swapout(struct thread *);
882 struct thread *thread_alloc(void);
883 void thread_continued(struct proc *p);
884 void thread_exit(void) __dead2;
885 int thread_export_context(struct thread *td, int willexit);
886 void thread_free(struct thread *td);
887 void thread_link(struct thread *td, struct proc *p);
888 void thread_reap(void);
889 void thread_signal_add(struct thread *td, ksiginfo_t *);
890 int thread_single(int how);
891 void thread_single_end(void);
892 void thread_stash(struct thread *td);
893 int thread_statclock(int user);
894 void thread_stopped(struct proc *p);
895 void childproc_stopped(struct proc *child, int reason);
896 void childproc_continued(struct proc *child);
897 void childproc_exited(struct proc *child);
898 int thread_suspend_check(int how);
899 void thread_suspend_switch(struct thread *);
900 void thread_suspend_one(struct thread *td);
901 struct thread *thread_switchout(struct thread *td, int flags,
902 struct thread *newtd);
903 void thread_unlink(struct thread *td);
904 void thread_unsuspend(struct proc *p);
905 void thread_unsuspend_one(struct thread *td);
906 void thread_unthread(struct thread *td);
907 int thread_userret(struct thread *td, struct trapframe *frame);
908 void thread_user_enter(struct thread *td);
909 void thread_wait(struct proc *p);
910 struct thread *thread_find(struct proc *p, lwpid_t tid);
911 void thr_exit1(void);
915 #endif /* !_SYS_PROC_H_ */