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