FreeBSD/Linux Kernel Cross Reference
sys/sys/proc.h
1 /*-
2 * SPDX-License-Identifier: BSD-3-Clause
3 *
4 * Copyright (c) 1986, 1989, 1991, 1993
5 * The Regents of the University of California. All rights reserved.
6 * (c) UNIX System Laboratories, Inc.
7 * All or some portions of this file are derived from material licensed
8 * to the University of California by American Telephone and Telegraph
9 * Co. or Unix System Laboratories, Inc. and are reproduced herein with
10 * the permission of UNIX System Laboratories, Inc.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * SUCH DAMAGE.
35 *
36 * @(#)proc.h 8.15 (Berkeley) 5/19/95
37 * $FreeBSD$
38 */
39
40 #ifndef _SYS_PROC_H_
41 #define _SYS_PROC_H_
42
43 #include <sys/callout.h> /* For struct callout. */
44 #include <sys/event.h> /* For struct klist. */
45 #include <sys/condvar.h>
46 #ifndef _KERNEL
47 #include <sys/filedesc.h>
48 #endif
49 #include <sys/queue.h>
50 #include <sys/_lock.h>
51 #include <sys/lock_profile.h>
52 #include <sys/_mutex.h>
53 #include <sys/osd.h>
54 #include <sys/priority.h>
55 #include <sys/rtprio.h> /* XXX. */
56 #include <sys/runq.h>
57 #include <sys/resource.h>
58 #include <sys/sigio.h>
59 #include <sys/signal.h>
60 #include <sys/signalvar.h>
61 #ifndef _KERNEL
62 #include <sys/time.h> /* For structs itimerval, timeval. */
63 #else
64 #include <sys/pcpu.h>
65 #include <sys/systm.h>
66 #endif
67 #include <sys/ucontext.h>
68 #include <sys/ucred.h>
69 #include <sys/types.h>
70 #include <sys/_domainset.h>
71
72 #include <machine/proc.h> /* Machine-dependent proc substruct. */
73 #ifdef _KERNEL
74 #include <machine/cpu.h>
75 #endif
76
77 /*
78 * One structure allocated per session.
79 *
80 * List of locks
81 * (m) locked by s_mtx mtx
82 * (e) locked by proctree_lock sx
83 * (c) const until freeing
84 */
85 struct session {
86 u_int s_count; /* Ref cnt; pgrps in session - atomic. */
87 struct proc *s_leader; /* (m + e) Session leader. */
88 struct vnode *s_ttyvp; /* (m) Vnode of controlling tty. */
89 struct cdev_priv *s_ttydp; /* (m) Device of controlling tty. */
90 struct tty *s_ttyp; /* (e) Controlling tty. */
91 pid_t s_sid; /* (c) Session ID. */
92 /* (m) Setlogin() name: */
93 char s_login[roundup(MAXLOGNAME, sizeof(long))];
94 struct mtx s_mtx; /* Mutex to protect members. */
95 };
96
97 /*
98 * One structure allocated per process group.
99 *
100 * List of locks
101 * (m) locked by pg_mtx mtx
102 * (e) locked by proctree_lock sx
103 * (c) const until freeing
104 */
105 struct pgrp {
106 LIST_ENTRY(pgrp) pg_hash; /* (e) Hash chain. */
107 LIST_HEAD(, proc) pg_members; /* (m + e) Pointer to pgrp members. */
108 struct session *pg_session; /* (c) Pointer to session. */
109 struct sigiolst pg_sigiolst; /* (m) List of sigio sources. */
110 pid_t pg_id; /* (c) Process group id. */
111 int pg_jobc; /* (m) Job control process count. */
112 struct mtx pg_mtx; /* Mutex to protect members */
113 int pg_flags; /* (m) PGRP_ flags */
114 };
115
116 #define PGRP_ORPHANED 0x00000001 /* Group is orphaned */
117
118 /*
119 * pargs, used to hold a copy of the command line, if it had a sane length.
120 */
121 struct pargs {
122 u_int ar_ref; /* Reference count. */
123 u_int ar_length; /* Length. */
124 u_char ar_args[1]; /* Arguments. */
125 };
126
127 /*-
128 * Description of a process.
129 *
130 * This structure contains the information needed to manage a thread of
131 * control, known in UN*X as a process; it has references to substructures
132 * containing descriptions of things that the process uses, but may share
133 * with related processes. The process structure and the substructures
134 * are always addressable except for those marked "(CPU)" below,
135 * which might be addressable only on a processor on which the process
136 * is running.
137 *
138 * Below is a key of locks used to protect each member of struct proc. The
139 * lock is indicated by a reference to a specific character in parens in the
140 * associated comment.
141 * * - not yet protected
142 * a - only touched by curproc or parent during fork/wait
143 * b - created at fork, never changes
144 * (exception aiods switch vmspaces, but they are also
145 * marked 'P_SYSTEM' so hopefully it will be left alone)
146 * c - locked by proc mtx
147 * d - locked by allproc_lock lock
148 * e - locked by proctree_lock lock
149 * f - session mtx
150 * g - process group mtx
151 * h - callout_lock mtx
152 * i - by curproc or the master session mtx
153 * j - locked by proc slock
154 * k - only accessed by curthread
155 * k*- only accessed by curthread and from an interrupt
156 * kx- only accessed by curthread and by debugger
157 * l - the attaching proc or attaching proc parent
158 * m - Giant
159 * n - not locked, lazy
160 * o - ktrace lock
161 * q - td_contested lock
162 * r - p_peers lock
163 * s - see sleepq_switch(), sleeping_on_old_rtc(), and sleep(9)
164 * t - thread lock
165 * u - process stat lock
166 * w - process timer lock
167 * x - created at fork, only changes during single threading in exec
168 * y - created at first aio, doesn't change until exit or exec at which
169 * point we are single-threaded and only curthread changes it
170 * z - zombie threads lock
171 *
172 * If the locking key specifies two identifiers (for example, p_pptr) then
173 * either lock is sufficient for read access, but both locks must be held
174 * for write access.
175 */
176 struct cpuset;
177 struct filecaps;
178 struct filemon;
179 struct kaioinfo;
180 struct kaudit_record;
181 struct kdtrace_proc;
182 struct kdtrace_thread;
183 struct mqueue_notifier;
184 struct nlminfo;
185 struct p_sched;
186 struct proc;
187 struct procdesc;
188 struct racct;
189 struct sbuf;
190 struct sleepqueue;
191 struct socket;
192 struct syscall_args;
193 struct td_sched;
194 struct thread;
195 struct trapframe;
196 struct turnstile;
197 struct vm_map;
198 struct vm_map_entry;
199
200 /*
201 * XXX: Does this belong in resource.h or resourcevar.h instead?
202 * Resource usage extension. The times in rusage structs in the kernel are
203 * never up to date. The actual times are kept as runtimes and tick counts
204 * (with control info in the "previous" times), and are converted when
205 * userland asks for rusage info. Backwards compatibility prevents putting
206 * this directly in the user-visible rusage struct.
207 *
208 * Locking for p_rux: (cu) means (u) for p_rux and (c) for p_crux.
209 * Locking for td_rux: (t) for all fields.
210 */
211 struct rusage_ext {
212 uint64_t rux_runtime; /* (cu) Real time. */
213 uint64_t rux_uticks; /* (cu) Statclock hits in user mode. */
214 uint64_t rux_sticks; /* (cu) Statclock hits in sys mode. */
215 uint64_t rux_iticks; /* (cu) Statclock hits in intr mode. */
216 uint64_t rux_uu; /* (c) Previous user time in usec. */
217 uint64_t rux_su; /* (c) Previous sys time in usec. */
218 uint64_t rux_tu; /* (c) Previous total time in usec. */
219 };
220
221 /*
222 * Kernel runnable context (thread).
223 * This is what is put to sleep and reactivated.
224 * Thread context. Processes may have multiple threads.
225 */
226 struct thread {
227 struct mtx *volatile td_lock; /* replaces sched lock */
228 struct proc *td_proc; /* (*) Associated process. */
229 TAILQ_ENTRY(thread) td_plist; /* (*) All threads in this proc. */
230 TAILQ_ENTRY(thread) td_runq; /* (t) Run queue. */
231 TAILQ_ENTRY(thread) td_slpq; /* (t) Sleep queue. */
232 TAILQ_ENTRY(thread) td_lockq; /* (t) Lock queue. */
233 LIST_ENTRY(thread) td_hash; /* (d) Hash chain. */
234 struct cpuset *td_cpuset; /* (t) CPU affinity mask. */
235 struct domainset_ref td_domain; /* (a) NUMA policy */
236 struct seltd *td_sel; /* Select queue/channel. */
237 struct sleepqueue *td_sleepqueue; /* (k) Associated sleep queue. */
238 struct turnstile *td_turnstile; /* (k) Associated turnstile. */
239 struct rl_q_entry *td_rlqe; /* (k) Associated range lock entry. */
240 struct umtx_q *td_umtxq; /* (c?) Link for when we're blocked. */
241 lwpid_t td_tid; /* (b) Thread ID. */
242 sigqueue_t td_sigqueue; /* (c) Sigs arrived, not delivered. */
243 #define td_siglist td_sigqueue.sq_signals
244 u_char td_lend_user_pri; /* (t) Lend user pri. */
245
246 /* Cleared during fork1() */
247 #define td_startzero td_epochnest
248 u_char td_epochnest; /* (k) Epoch nest counter. */
249 int td_flags; /* (t) TDF_* flags. */
250 int td_inhibitors; /* (t) Why can not run. */
251 int td_pflags; /* (k) Private thread (TDP_*) flags. */
252 int td_dupfd; /* (k) Ret value from fdopen. XXX */
253 int td_sqqueue; /* (t) Sleepqueue queue blocked on. */
254 void *td_wchan; /* (t) Sleep address. */
255 const char *td_wmesg; /* (t) Reason for sleep. */
256 volatile u_char td_owepreempt; /* (k*) Preempt on last critical_exit */
257 u_char td_tsqueue; /* (t) Turnstile queue blocked on. */
258 short td_locks; /* (k) Debug: count of non-spin locks */
259 short td_rw_rlocks; /* (k) Count of rwlock read locks. */
260 short td_sx_slocks; /* (k) Count of sx shared locks. */
261 short td_lk_slocks; /* (k) Count of lockmgr shared locks. */
262 short td_stopsched; /* (k) Scheduler stopped. */
263 struct turnstile *td_blocked; /* (t) Lock thread is blocked on. */
264 const char *td_lockname; /* (t) Name of lock blocked on. */
265 LIST_HEAD(, turnstile) td_contested; /* (q) Contested locks. */
266 struct lock_list_entry *td_sleeplocks; /* (k) Held sleep locks. */
267 int td_intr_nesting_level; /* (k) Interrupt recursion. */
268 int td_pinned; /* (k) Temporary cpu pin count. */
269 struct ucred *td_ucred; /* (k) Reference to credentials. */
270 struct plimit *td_limit; /* (k) Resource limits. */
271 int td_slptick; /* (t) Time at sleep. */
272 int td_blktick; /* (t) Time spent blocked. */
273 int td_swvoltick; /* (t) Time at last SW_VOL switch. */
274 int td_swinvoltick; /* (t) Time at last SW_INVOL switch. */
275 u_int td_cow; /* (*) Number of copy-on-write faults */
276 struct rusage td_ru; /* (t) rusage information. */
277 struct rusage_ext td_rux; /* (t) Internal rusage information. */
278 uint64_t td_incruntime; /* (t) Cpu ticks to transfer to proc. */
279 uint64_t td_runtime; /* (t) How many cpu ticks we've run. */
280 u_int td_pticks; /* (t) Statclock hits for profiling */
281 u_int td_sticks; /* (t) Statclock hits in system mode. */
282 u_int td_iticks; /* (t) Statclock hits in intr mode. */
283 u_int td_uticks; /* (t) Statclock hits in user mode. */
284 int td_intrval; /* (t) Return value for sleepq. */
285 sigset_t td_oldsigmask; /* (k) Saved mask from pre sigpause. */
286 volatile u_int td_generation; /* (k) For detection of preemption */
287 stack_t td_sigstk; /* (k) Stack ptr and on-stack flag. */
288 int td_xsig; /* (c) Signal for ptrace */
289 u_long td_profil_addr; /* (k) Temporary addr until AST. */
290 u_int td_profil_ticks; /* (k) Temporary ticks until AST. */
291 char td_name[MAXCOMLEN + 1]; /* (*) Thread name. */
292 struct file *td_fpop; /* (k) file referencing cdev under op */
293 int td_dbgflags; /* (c) Userland debugger flags */
294 siginfo_t td_si; /* (c) For debugger or core file */
295 int td_ng_outbound; /* (k) Thread entered ng from above. */
296 struct osd td_osd; /* (k) Object specific data. */
297 struct vm_map_entry *td_map_def_user; /* (k) Deferred entries. */
298 pid_t td_dbg_forked; /* (c) Child pid for debugger. */
299 u_int td_vp_reserv; /* (k) Count of reserved vnodes. */
300 int td_no_sleeping; /* (k) Sleeping disabled count. */
301 void *td_su; /* (k) FFS SU private */
302 sbintime_t td_sleeptimo; /* (t) Sleep timeout. */
303 int td_rtcgen; /* (s) rtc_generation of abs. sleep */
304 size_t td_vslock_sz; /* (k) amount of vslock-ed space */
305 #define td_endzero td_sigmask
306
307 /* Copied during fork1() or create_thread(). */
308 #define td_startcopy td_endzero
309 sigset_t td_sigmask; /* (c) Current signal mask. */
310 u_char td_rqindex; /* (t) Run queue index. */
311 u_char td_base_pri; /* (t) Thread base kernel priority. */
312 u_char td_priority; /* (t) Thread active priority. */
313 u_char td_pri_class; /* (t) Scheduling class. */
314 u_char td_user_pri; /* (t) User pri from estcpu and nice. */
315 u_char td_base_user_pri; /* (t) Base user pri */
316 u_char td_pre_epoch_prio; /* (k) User pri on entry to epoch */
317 uintptr_t td_rb_list; /* (k) Robust list head. */
318 uintptr_t td_rbp_list; /* (k) Robust priv list head. */
319 uintptr_t td_rb_inact; /* (k) Current in-action mutex loc. */
320 struct syscall_args td_sa; /* (kx) Syscall parameters. Copied on
321 fork for child tracing. */
322 #define td_endcopy td_pcb
323
324 /*
325 * Fields that must be manually set in fork1() or create_thread()
326 * or already have been set in the allocator, constructor, etc.
327 */
328 struct pcb *td_pcb; /* (k) Kernel VA of pcb and kstack. */
329 enum {
330 TDS_INACTIVE = 0x0,
331 TDS_INHIBITED,
332 TDS_CAN_RUN,
333 TDS_RUNQ,
334 TDS_RUNNING
335 } td_state; /* (t) thread state */
336 union {
337 register_t tdu_retval[2];
338 off_t tdu_off;
339 } td_uretoff; /* (k) Syscall aux returns. */
340 #define td_retval td_uretoff.tdu_retval
341 u_int td_cowgen; /* (k) Generation of COW pointers. */
342 /* LP64 hole */
343 struct callout td_slpcallout; /* (h) Callout for sleep. */
344 struct trapframe *td_frame; /* (k) */
345 struct vm_object *td_kstack_obj;/* (a) Kstack object. */
346 vm_offset_t td_kstack; /* (a) Kernel VA of kstack. */
347 int td_kstack_pages; /* (a) Size of the kstack. */
348 volatile u_int td_critnest; /* (k*) Critical section nest level. */
349 #ifdef __amd64__
350 uint32_t td_md_pad0[16];
351 #else
352 struct mdthread td_md; /* (k) Any machine-dependent fields. */
353 #endif
354 struct kaudit_record *td_ar; /* (k) Active audit record, if any. */
355 struct lpohead td_lprof[2]; /* (a) lock profiling objects. */
356 struct kdtrace_thread *td_dtrace; /* (*) DTrace-specific data. */
357 int td_errno; /* Error returned by last syscall. */
358 /* LP64 hole */
359 struct vnet *td_vnet; /* (k) Effective vnet. */
360 const char *td_vnet_lpush; /* (k) Debugging vnet push / pop. */
361 struct trapframe *td_intr_frame;/* (k) Frame of the current irq */
362 struct proc *td_rfppwait_p; /* (k) The vforked child */
363 struct vm_page **td_ma; /* (k) uio pages held */
364 int td_ma_cnt; /* (k) size of *td_ma */
365 /* LP64 hole */
366 void *td_emuldata; /* Emulator state data */
367 int td_lastcpu; /* (t) Last cpu we were on. */
368 int td_oncpu; /* (t) Which cpu we are on. */
369 void *td_lkpi_task; /* LinuxKPI task struct pointer */
370 int td_pmcpend;
371 #ifdef __amd64__
372 struct mdthread td_md; /* (k) Any machine-dependent fields. */
373 #endif
374 int td_pflags2; /* (k) Private thread (TDP2_*) flags. */
375 };
376
377 struct thread0_storage {
378 struct thread t0st_thread;
379 uint64_t t0st_sched[10];
380 };
381
382 struct mtx *thread_lock_block(struct thread *);
383 void thread_lock_unblock(struct thread *, struct mtx *);
384 void thread_lock_set(struct thread *, struct mtx *);
385 #define THREAD_LOCK_ASSERT(td, type) \
386 do { \
387 struct mtx *__m = (td)->td_lock; \
388 if (__m != &blocked_lock) \
389 mtx_assert(__m, (type)); \
390 } while (0)
391
392 #ifdef INVARIANTS
393 #define THREAD_LOCKPTR_ASSERT(td, lock) \
394 do { \
395 struct mtx *__m = (td)->td_lock; \
396 KASSERT((__m == &blocked_lock || __m == (lock)), \
397 ("Thread %p lock %p does not match %p", td, __m, (lock))); \
398 } while (0)
399
400 #define TD_LOCKS_INC(td) ((td)->td_locks++)
401 #define TD_LOCKS_DEC(td) do { \
402 KASSERT(SCHEDULER_STOPPED_TD(td) || (td)->td_locks > 0, \
403 ("thread %p owns no locks", (td))); \
404 (td)->td_locks--; \
405 } while (0)
406 #else
407 #define THREAD_LOCKPTR_ASSERT(td, lock)
408
409 #define TD_LOCKS_INC(td)
410 #define TD_LOCKS_DEC(td)
411 #endif
412
413 /*
414 * Flags kept in td_flags:
415 * To change these you MUST have the scheduler lock.
416 */
417 #define TDF_BORROWING 0x00000001 /* Thread is borrowing pri from another. */
418 #define TDF_INPANIC 0x00000002 /* Caused a panic, let it drive crashdump. */
419 #define TDF_INMEM 0x00000004 /* Thread's stack is in memory. */
420 #define TDF_SINTR 0x00000008 /* Sleep is interruptible. */
421 #define TDF_TIMEOUT 0x00000010 /* Timing out during sleep. */
422 #define TDF_IDLETD 0x00000020 /* This is a per-CPU idle thread. */
423 #define TDF_CANSWAP 0x00000040 /* Thread can be swapped. */
424 #define TDF_SLEEPABORT 0x00000080 /* sleepq_abort was called. */
425 #define TDF_KTH_SUSP 0x00000100 /* kthread is suspended */
426 #define TDF_ALLPROCSUSP 0x00000200 /* suspended by SINGLE_ALLPROC */
427 #define TDF_BOUNDARY 0x00000400 /* Thread suspended at user boundary */
428 #define TDF_ASTPENDING 0x00000800 /* Thread has some asynchronous events. */
429 #define TDF_UNUSED12 0x00001000 /* --available-- */
430 #define TDF_SBDRY 0x00002000 /* Stop only on usermode boundary. */
431 #define TDF_UPIBLOCKED 0x00004000 /* Thread blocked on user PI mutex. */
432 #define TDF_NEEDSUSPCHK 0x00008000 /* Thread may need to suspend. */
433 #define TDF_NEEDRESCHED 0x00010000 /* Thread needs to yield. */
434 #define TDF_NEEDSIGCHK 0x00020000 /* Thread may need signal delivery. */
435 #define TDF_NOLOAD 0x00040000 /* Ignore during load avg calculations. */
436 #define TDF_SERESTART 0x00080000 /* ERESTART on stop attempts. */
437 #define TDF_THRWAKEUP 0x00100000 /* Libthr thread must not suspend itself. */
438 #define TDF_SEINTR 0x00200000 /* EINTR on stop attempts. */
439 #define TDF_SWAPINREQ 0x00400000 /* Swapin request due to wakeup. */
440 #define TDF_UNUSED23 0x00800000 /* --available-- */
441 #define TDF_SCHED0 0x01000000 /* Reserved for scheduler private use */
442 #define TDF_SCHED1 0x02000000 /* Reserved for scheduler private use */
443 #define TDF_SCHED2 0x04000000 /* Reserved for scheduler private use */
444 #define TDF_SCHED3 0x08000000 /* Reserved for scheduler private use */
445 #define TDF_ALRMPEND 0x10000000 /* Pending SIGVTALRM needs to be posted. */
446 #define TDF_PROFPEND 0x20000000 /* Pending SIGPROF needs to be posted. */
447 #define TDF_MACPEND 0x40000000 /* AST-based MAC event pending. */
448
449 /* Userland debug flags */
450 #define TDB_SUSPEND 0x00000001 /* Thread is suspended by debugger */
451 #define TDB_XSIG 0x00000002 /* Thread is exchanging signal under trace */
452 #define TDB_USERWR 0x00000004 /* Debugger modified memory or registers */
453 #define TDB_SCE 0x00000008 /* Thread performs syscall enter */
454 #define TDB_SCX 0x00000010 /* Thread performs syscall exit */
455 #define TDB_EXEC 0x00000020 /* TDB_SCX from exec(2) family */
456 #define TDB_FORK 0x00000040 /* TDB_SCX from fork(2) that created new
457 process */
458 #define TDB_STOPATFORK 0x00000080 /* Stop at the return from fork (child
459 only) */
460 #define TDB_CHILD 0x00000100 /* New child indicator for ptrace() */
461 #define TDB_BORN 0x00000200 /* New LWP indicator for ptrace() */
462 #define TDB_EXIT 0x00000400 /* Exiting LWP indicator for ptrace() */
463 #define TDB_VFORK 0x00000800 /* vfork indicator for ptrace() */
464 #define TDB_FSTP 0x00001000 /* The thread is PT_ATTACH leader */
465 #define TDB_STEP 0x00002000 /* (x86) PSL_T set for PT_STEP */
466
467 /*
468 * "Private" flags kept in td_pflags:
469 * These are only written by curthread and thus need no locking.
470 */
471 #define TDP_OLDMASK 0x00000001 /* Need to restore mask after suspend. */
472 #define TDP_INKTR 0x00000002 /* Thread is currently in KTR code. */
473 #define TDP_INKTRACE 0x00000004 /* Thread is currently in KTRACE code. */
474 #define TDP_BUFNEED 0x00000008 /* Do not recurse into the buf flush */
475 #define TDP_COWINPROGRESS 0x00000010 /* Snapshot copy-on-write in progress. */
476 #define TDP_ALTSTACK 0x00000020 /* Have alternate signal stack. */
477 #define TDP_DEADLKTREAT 0x00000040 /* Lock acquisition - deadlock treatment. */
478 #define TDP_NOFAULTING 0x00000080 /* Do not handle page faults. */
479 #define TDP_UNUSED9 0x00000100 /* --available-- */
480 #define TDP_OWEUPC 0x00000200 /* Call addupc() at next AST. */
481 #define TDP_ITHREAD 0x00000400 /* Thread is an interrupt thread. */
482 #define TDP_SYNCIO 0x00000800 /* Local override, disable async i/o. */
483 #define TDP_SCHED1 0x00001000 /* Reserved for scheduler private use */
484 #define TDP_SCHED2 0x00002000 /* Reserved for scheduler private use */
485 #define TDP_SCHED3 0x00004000 /* Reserved for scheduler private use */
486 #define TDP_SCHED4 0x00008000 /* Reserved for scheduler private use */
487 #define TDP_GEOM 0x00010000 /* Settle GEOM before finishing syscall */
488 #define TDP_SOFTDEP 0x00020000 /* Stuck processing softdep worklist */
489 #define TDP_NORUNNINGBUF 0x00040000 /* Ignore runningbufspace check */
490 #define TDP_WAKEUP 0x00080000 /* Don't sleep in umtx cond_wait */
491 #define TDP_INBDFLUSH 0x00100000 /* Already in BO_BDFLUSH, do not recurse */
492 #define TDP_KTHREAD 0x00200000 /* This is an official kernel thread */
493 #define TDP_CALLCHAIN 0x00400000 /* Capture thread's callchain */
494 #define TDP_IGNSUSP 0x00800000 /* Permission to ignore the MNTK_SUSPEND* */
495 #define TDP_AUDITREC 0x01000000 /* Audit record pending on thread */
496 #define TDP_RFPPWAIT 0x02000000 /* Handle RFPPWAIT on syscall exit */
497 #define TDP_RESETSPUR 0x04000000 /* Reset spurious page fault history. */
498 #define TDP_NERRNO 0x08000000 /* Last errno is already in td_errno */
499 #define TDP_UIOHELD 0x10000000 /* Current uio has pages held in td_ma */
500 #define TDP_FORKING 0x20000000 /* Thread is being created through fork() */
501 #define TDP_EXECVMSPC 0x40000000 /* Execve destroyed old vmspace */
502
503 #define TDP2_SBPAGES 0x00000001 /* Owns sbusy on some pages */
504 #define TDP2_COMPAT32RB 0x00000002 /* compat32 robust lists */
505
506 /*
507 * Reasons that the current thread can not be run yet.
508 * More than one may apply.
509 */
510 #define TDI_SUSPENDED 0x0001 /* On suspension queue. */
511 #define TDI_SLEEPING 0x0002 /* Actually asleep! (tricky). */
512 #define TDI_SWAPPED 0x0004 /* Stack not in mem. Bad juju if run. */
513 #define TDI_LOCK 0x0008 /* Stopped on a lock. */
514 #define TDI_IWAIT 0x0010 /* Awaiting interrupt. */
515
516 #define TD_IS_SLEEPING(td) ((td)->td_inhibitors & TDI_SLEEPING)
517 #define TD_ON_SLEEPQ(td) ((td)->td_wchan != NULL)
518 #define TD_IS_SUSPENDED(td) ((td)->td_inhibitors & TDI_SUSPENDED)
519 #define TD_IS_SWAPPED(td) ((td)->td_inhibitors & TDI_SWAPPED)
520 #define TD_ON_LOCK(td) ((td)->td_inhibitors & TDI_LOCK)
521 #define TD_AWAITING_INTR(td) ((td)->td_inhibitors & TDI_IWAIT)
522 #define TD_IS_RUNNING(td) ((td)->td_state == TDS_RUNNING)
523 #define TD_ON_RUNQ(td) ((td)->td_state == TDS_RUNQ)
524 #define TD_CAN_RUN(td) ((td)->td_state == TDS_CAN_RUN)
525 #define TD_IS_INHIBITED(td) ((td)->td_state == TDS_INHIBITED)
526 #define TD_ON_UPILOCK(td) ((td)->td_flags & TDF_UPIBLOCKED)
527 #define TD_IS_IDLETHREAD(td) ((td)->td_flags & TDF_IDLETD)
528
529 #define KTDSTATE(td) \
530 (((td)->td_inhibitors & TDI_SLEEPING) != 0 ? "sleep" : \
531 ((td)->td_inhibitors & TDI_SUSPENDED) != 0 ? "suspended" : \
532 ((td)->td_inhibitors & TDI_SWAPPED) != 0 ? "swapped" : \
533 ((td)->td_inhibitors & TDI_LOCK) != 0 ? "blocked" : \
534 ((td)->td_inhibitors & TDI_IWAIT) != 0 ? "iwait" : "yielding")
535
536 #define TD_SET_INHIB(td, inhib) do { \
537 (td)->td_state = TDS_INHIBITED; \
538 (td)->td_inhibitors |= (inhib); \
539 } while (0)
540
541 #define TD_CLR_INHIB(td, inhib) do { \
542 if (((td)->td_inhibitors & (inhib)) && \
543 (((td)->td_inhibitors &= ~(inhib)) == 0)) \
544 (td)->td_state = TDS_CAN_RUN; \
545 } while (0)
546
547 #define TD_SET_SLEEPING(td) TD_SET_INHIB((td), TDI_SLEEPING)
548 #define TD_SET_SWAPPED(td) TD_SET_INHIB((td), TDI_SWAPPED)
549 #define TD_SET_LOCK(td) TD_SET_INHIB((td), TDI_LOCK)
550 #define TD_SET_SUSPENDED(td) TD_SET_INHIB((td), TDI_SUSPENDED)
551 #define TD_SET_IWAIT(td) TD_SET_INHIB((td), TDI_IWAIT)
552 #define TD_SET_EXITING(td) TD_SET_INHIB((td), TDI_EXITING)
553
554 #define TD_CLR_SLEEPING(td) TD_CLR_INHIB((td), TDI_SLEEPING)
555 #define TD_CLR_SWAPPED(td) TD_CLR_INHIB((td), TDI_SWAPPED)
556 #define TD_CLR_LOCK(td) TD_CLR_INHIB((td), TDI_LOCK)
557 #define TD_CLR_SUSPENDED(td) TD_CLR_INHIB((td), TDI_SUSPENDED)
558 #define TD_CLR_IWAIT(td) TD_CLR_INHIB((td), TDI_IWAIT)
559
560 #define TD_SET_RUNNING(td) (td)->td_state = TDS_RUNNING
561 #define TD_SET_RUNQ(td) (td)->td_state = TDS_RUNQ
562 #define TD_SET_CAN_RUN(td) (td)->td_state = TDS_CAN_RUN
563
564 #define TD_SBDRY_INTR(td) \
565 (((td)->td_flags & (TDF_SEINTR | TDF_SERESTART)) != 0)
566 #define TD_SBDRY_ERRNO(td) \
567 (((td)->td_flags & TDF_SEINTR) != 0 ? EINTR : ERESTART)
568
569 /*
570 * Process structure.
571 */
572 struct proc {
573 LIST_ENTRY(proc) p_list; /* (d) List of all processes. */
574 TAILQ_HEAD(, thread) p_threads; /* (c) all threads. */
575 struct mtx p_slock; /* process spin lock */
576 struct ucred *p_ucred; /* (c) Process owner's identity. */
577 struct filedesc *p_fd; /* (b) Open files. */
578 struct filedesc_to_leader *p_fdtol; /* (b) Tracking node */
579 struct pstats *p_stats; /* (b) Accounting/statistics (CPU). */
580 struct plimit *p_limit; /* (c) Resource limits. */
581 struct callout p_limco; /* (c) Limit callout handle */
582 struct sigacts *p_sigacts; /* (x) Signal actions, state (CPU). */
583
584 int p_flag; /* (c) P_* flags. */
585 int p_flag2; /* (c) P2_* flags. */
586 enum {
587 PRS_NEW = 0, /* In creation */
588 PRS_NORMAL, /* threads can be run. */
589 PRS_ZOMBIE
590 } p_state; /* (j/c) Process status. */
591 pid_t p_pid; /* (b) Process identifier. */
592 LIST_ENTRY(proc) p_hash; /* (d) Hash chain. */
593 LIST_ENTRY(proc) p_pglist; /* (g + e) List of processes in pgrp. */
594 struct proc *p_pptr; /* (c + e) Pointer to parent process. */
595 LIST_ENTRY(proc) p_sibling; /* (e) List of sibling processes. */
596 LIST_HEAD(, proc) p_children; /* (e) Pointer to list of children. */
597 struct proc *p_reaper; /* (e) My reaper. */
598 LIST_HEAD(, proc) p_reaplist; /* (e) List of my descendants
599 (if I am reaper). */
600 LIST_ENTRY(proc) p_reapsibling; /* (e) List of siblings - descendants of
601 the same reaper. */
602 struct mtx p_mtx; /* (n) Lock for this struct. */
603 struct mtx p_statmtx; /* Lock for the stats */
604 struct mtx p_itimmtx; /* Lock for the virt/prof timers */
605 struct mtx p_profmtx; /* Lock for the profiling */
606 struct ksiginfo *p_ksi; /* Locked by parent proc lock */
607 sigqueue_t p_sigqueue; /* (c) Sigs not delivered to a td. */
608 #define p_siglist p_sigqueue.sq_signals
609 pid_t p_oppid; /* (c + e) Real parent pid. */
610
611 /* The following fields are all zeroed upon creation in fork. */
612 #define p_startzero p_vmspace
613 struct vmspace *p_vmspace; /* (b) Address space. */
614 u_int p_swtick; /* (c) Tick when swapped in or out. */
615 u_int p_cowgen; /* (c) Generation of COW pointers. */
616 struct itimerval p_realtimer; /* (c) Alarm timer. */
617 struct rusage p_ru; /* (a) Exit information. */
618 struct rusage_ext p_rux; /* (cu) Internal resource usage. */
619 struct rusage_ext p_crux; /* (c) Internal child resource usage. */
620 int p_profthreads; /* (c) Num threads in addupc_task. */
621 volatile int p_exitthreads; /* (j) Number of threads exiting */
622 int p_traceflag; /* (o) Kernel trace points. */
623 struct vnode *p_tracevp; /* (c + o) Trace to vnode. */
624 struct ucred *p_tracecred; /* (o) Credentials to trace with. */
625 struct vnode *p_textvp; /* (b) Vnode of executable. */
626 u_int p_lock; /* (c) Proclock (prevent swap) count. */
627 struct sigiolst p_sigiolst; /* (c) List of sigio sources. */
628 int p_sigparent; /* (c) Signal to parent on exit. */
629 int p_sig; /* (n) For core dump/debugger XXX. */
630 u_long p_code; /* (n) For core dump/debugger XXX. */
631 u_int p_stops; /* (c) Stop event bitmask. */
632 u_int p_stype; /* (c) Stop event type. */
633 char p_step; /* (c) Process is stopped. */
634 u_char p_pfsflags; /* (c) Procfs flags. */
635 u_int p_ptevents; /* (c + e) ptrace() event mask. */
636 struct nlminfo *p_nlminfo; /* (?) Only used by/for lockd. */
637 struct kaioinfo *p_aioinfo; /* (y) ASYNC I/O info. */
638 struct thread *p_singlethread;/* (c + j) If single threading this is it */
639 int p_suspcount; /* (j) Num threads in suspended mode. */
640 struct thread *p_xthread; /* (c) Trap thread */
641 int p_boundary_count;/* (j) Num threads at user boundary */
642 int p_pendingcnt; /* how many signals are pending */
643 struct itimers *p_itimers; /* (c) POSIX interval timers. */
644 struct procdesc *p_procdesc; /* (e) Process descriptor, if any. */
645 u_int p_treeflag; /* (e) P_TREE flags */
646 int p_pendingexits; /* (c) Count of pending thread exits. */
647 struct filemon *p_filemon; /* (c) filemon-specific data. */
648 int p_pdeathsig; /* (c) Signal from parent on exit. */
649 /* End area that is zeroed on creation. */
650 #define p_endzero p_magic
651
652 /* The following fields are all copied upon creation in fork. */
653 #define p_startcopy p_endzero
654 u_int p_magic; /* (b) Magic number. */
655 int p_osrel; /* (x) osreldate for the
656 binary (from ELF note, if any) */
657 char p_comm[MAXCOMLEN + 1]; /* (x) Process name. */
658 struct sysentvec *p_sysent; /* (b) Syscall dispatch info. */
659 struct pargs *p_args; /* (c) Process arguments. */
660 rlim_t p_cpulimit; /* (c) Current CPU limit in seconds. */
661 signed char p_nice; /* (c) Process "nice" value. */
662 int p_fibnum; /* in this routing domain XXX MRT */
663 pid_t p_reapsubtree; /* (e) Pid of the direct child of the
664 reaper which spawned
665 our subtree. */
666 uint16_t p_elf_machine; /* (x) ELF machine type */
667 uint64_t p_elf_flags; /* (x) ELF flags */
668 /* End area that is copied on creation. */
669 #define p_endcopy p_xexit
670
671 u_int p_xexit; /* (c) Exit code. */
672 u_int p_xsig; /* (c) Stop/kill sig. */
673 struct pgrp *p_pgrp; /* (c + e) Pointer to process group. */
674 struct knlist *p_klist; /* (c) Knotes attached to this proc. */
675 int p_numthreads; /* (c) Number of threads. */
676 struct mdproc p_md; /* Any machine-dependent fields. */
677 struct callout p_itcallout; /* (h + c) Interval timer callout. */
678 u_short p_acflag; /* (c) Accounting flags. */
679 struct proc *p_peers; /* (r) */
680 struct proc *p_leader; /* (b) */
681 void *p_emuldata; /* (c) Emulator state data. */
682 struct label *p_label; /* (*) Proc (not subject) MAC label. */
683 STAILQ_HEAD(, ktr_request) p_ktr; /* (o) KTR event queue. */
684 LIST_HEAD(, mqueue_notifier) p_mqnotifier; /* (c) mqueue notifiers.*/
685 struct kdtrace_proc *p_dtrace; /* (*) DTrace-specific data. */
686 struct cv p_pwait; /* (*) wait cv for exit/exec. */
687 uint64_t p_prev_runtime; /* (c) Resource usage accounting. */
688 struct racct *p_racct; /* (b) Resource accounting. */
689 int p_throttled; /* (c) Flag for racct pcpu throttling */
690 /*
691 * An orphan is the child that has been re-parented to the
692 * debugger as a result of attaching to it. Need to keep
693 * track of them for parent to be able to collect the exit
694 * status of what used to be children.
695 */
696 LIST_ENTRY(proc) p_orphan; /* (e) List of orphan processes. */
697 LIST_HEAD(, proc) p_orphans; /* (e) Pointer to list of orphans. */
698 uint32_t p_fctl0; /* (x) ABI feature control, ELF note */
699 u_int p_amd64_md_flags; /* (c) md process flags P_MD */
700 };
701
702 #define p_session p_pgrp->pg_session
703 #define p_pgid p_pgrp->pg_id
704
705 #define NOCPU (-1) /* For when we aren't on a CPU. */
706 #define NOCPU_OLD (255)
707 #define MAXCPU_OLD (254)
708
709 #define PROC_SLOCK(p) mtx_lock_spin(&(p)->p_slock)
710 #define PROC_SUNLOCK(p) mtx_unlock_spin(&(p)->p_slock)
711 #define PROC_SLOCK_ASSERT(p, type) mtx_assert(&(p)->p_slock, (type))
712
713 #define PROC_STATLOCK(p) mtx_lock_spin(&(p)->p_statmtx)
714 #define PROC_STATUNLOCK(p) mtx_unlock_spin(&(p)->p_statmtx)
715 #define PROC_STATLOCK_ASSERT(p, type) mtx_assert(&(p)->p_statmtx, (type))
716
717 #define PROC_ITIMLOCK(p) mtx_lock_spin(&(p)->p_itimmtx)
718 #define PROC_ITIMUNLOCK(p) mtx_unlock_spin(&(p)->p_itimmtx)
719 #define PROC_ITIMLOCK_ASSERT(p, type) mtx_assert(&(p)->p_itimmtx, (type))
720
721 #define PROC_PROFLOCK(p) mtx_lock_spin(&(p)->p_profmtx)
722 #define PROC_PROFUNLOCK(p) mtx_unlock_spin(&(p)->p_profmtx)
723 #define PROC_PROFLOCK_ASSERT(p, type) mtx_assert(&(p)->p_profmtx, (type))
724
725 /* These flags are kept in p_flag. */
726 #define P_ADVLOCK 0x00000001 /* Process may hold a POSIX advisory
727 lock. */
728 #define P_CONTROLT 0x00000002 /* Has a controlling terminal. */
729 #define P_KPROC 0x00000004 /* Kernel process. */
730 #define P_UNUSED3 0x00000008 /* --available-- */
731 #define P_PPWAIT 0x00000010 /* Parent is waiting for child to
732 exec/exit. */
733 #define P_PROFIL 0x00000020 /* Has started profiling. */
734 #define P_STOPPROF 0x00000040 /* Has thread requesting to stop
735 profiling. */
736 #define P_HADTHREADS 0x00000080 /* Has had threads (no cleanup
737 shortcuts) */
738 #define P_SUGID 0x00000100 /* Had set id privileges since last
739 exec. */
740 #define P_SYSTEM 0x00000200 /* System proc: no sigs, stats or
741 swapping. */
742 #define P_SINGLE_EXIT 0x00000400 /* Threads suspending should exit,
743 not wait. */
744 #define P_TRACED 0x00000800 /* Debugged process being traced. */
745 #define P_WAITED 0x00001000 /* Someone is waiting for us. */
746 #define P_WEXIT 0x00002000 /* Working on exiting. */
747 #define P_EXEC 0x00004000 /* Process called exec. */
748 #define P_WKILLED 0x00008000 /* Killed, go to kernel/user boundary
749 ASAP. */
750 #define P_CONTINUED 0x00010000 /* Proc has continued from a stopped
751 state. */
752 #define P_STOPPED_SIG 0x00020000 /* Stopped due to SIGSTOP/SIGTSTP. */
753 #define P_STOPPED_TRACE 0x00040000 /* Stopped because of tracing. */
754 #define P_STOPPED_SINGLE 0x00080000 /* Only 1 thread can continue (not to
755 user). */
756 #define P_PROTECTED 0x00100000 /* Do not kill on memory overcommit. */
757 #define P_SIGEVENT 0x00200000 /* Process pending signals changed. */
758 #define P_SINGLE_BOUNDARY 0x00400000 /* Threads should suspend at user
759 boundary. */
760 #define P_HWPMC 0x00800000 /* Process is using HWPMCs */
761 #define P_JAILED 0x01000000 /* Process is in jail. */
762 #define P_TOTAL_STOP 0x02000000 /* Stopped in stop_all_proc. */
763 #define P_INEXEC 0x04000000 /* Process is in execve(). */
764 #define P_STATCHILD 0x08000000 /* Child process stopped or exited. */
765 #define P_INMEM 0x10000000 /* Loaded into memory. */
766 #define P_SWAPPINGOUT 0x20000000 /* Process is being swapped out. */
767 #define P_SWAPPINGIN 0x40000000 /* Process is being swapped in. */
768 #define P_PPTRACE 0x80000000 /* PT_TRACEME by vforked child. */
769
770 #define P_STOPPED (P_STOPPED_SIG|P_STOPPED_SINGLE|P_STOPPED_TRACE)
771 #define P_SHOULDSTOP(p) ((p)->p_flag & P_STOPPED)
772 #define P_KILLED(p) ((p)->p_flag & P_WKILLED)
773
774 /* These flags are kept in p_flag2. */
775 #define P2_INHERIT_PROTECTED 0x00000001 /* New children get
776 P_PROTECTED. */
777 #define P2_NOTRACE 0x00000002 /* No ptrace(2) attach or
778 coredumps. */
779 #define P2_NOTRACE_EXEC 0x00000004 /* Keep P2_NOPTRACE on
780 exec(2). */
781 #define P2_AST_SU 0x00000008 /* Handles SU ast for
782 kthreads. */
783 #define P2_PTRACE_FSTP 0x00000010 /* SIGSTOP from PT_ATTACH not
784 yet handled. */
785 #define P2_TRAPCAP 0x00000020 /* SIGTRAP on ENOTCAPABLE */
786 #define P2_ASLR_ENABLE 0x00000040 /* Force enable ASLR. */
787 #define P2_ASLR_DISABLE 0x00000080 /* Force disable ASLR. */
788 #define P2_ASLR_IGNSTART 0x00000100 /* Enable ASLR to consume sbrk
789 area. */
790 #define P2_STKGAP_DISABLE 0x00000800 /* Disable stack gap for
791 MAP_STACK */
792 #define P2_STKGAP_DISABLE_EXEC 0x00001000 /* Stack gap disabled
793 after exec */
794
795 /* Flags protected by proctree_lock, kept in p_treeflags. */
796 #define P_TREE_ORPHANED 0x00000001 /* Reparented, on orphan list */
797 #define P_TREE_FIRST_ORPHAN 0x00000002 /* First element of orphan
798 list */
799 #define P_TREE_REAPER 0x00000004 /* Reaper of subtree */
800 #define P_TREE_GRPEXITED 0x00000008 /* exit1() done with job ctl */
801
802 /*
803 * These were process status values (p_stat), now they are only used in
804 * legacy conversion code.
805 */
806 #define SIDL 1 /* Process being created by fork. */
807 #define SRUN 2 /* Currently runnable. */
808 #define SSLEEP 3 /* Sleeping on an address. */
809 #define SSTOP 4 /* Process debugging or suspension. */
810 #define SZOMB 5 /* Awaiting collection by parent. */
811 #define SWAIT 6 /* Waiting for interrupt. */
812 #define SLOCK 7 /* Blocked on a lock. */
813
814 #define P_MAGIC 0xbeefface
815
816 #ifdef _KERNEL
817
818 /* Types and flags for mi_switch(). */
819 #define SW_TYPE_MASK 0xff /* First 8 bits are switch type */
820 #define SWT_NONE 0 /* Unspecified switch. */
821 #define SWT_PREEMPT 1 /* Switching due to preemption. */
822 #define SWT_OWEPREEMPT 2 /* Switching due to owepreempt. */
823 #define SWT_TURNSTILE 3 /* Turnstile contention. */
824 #define SWT_SLEEPQ 4 /* Sleepq wait. */
825 #define SWT_SLEEPQTIMO 5 /* Sleepq timeout wait. */
826 #define SWT_RELINQUISH 6 /* yield call. */
827 #define SWT_NEEDRESCHED 7 /* NEEDRESCHED was set. */
828 #define SWT_IDLE 8 /* Switching from the idle thread. */
829 #define SWT_IWAIT 9 /* Waiting for interrupts. */
830 #define SWT_SUSPEND 10 /* Thread suspended. */
831 #define SWT_REMOTEPREEMPT 11 /* Remote processor preempted. */
832 #define SWT_REMOTEWAKEIDLE 12 /* Remote processor preempted idle. */
833 #define SWT_COUNT 13 /* Number of switch types. */
834 /* Flags */
835 #define SW_VOL 0x0100 /* Voluntary switch. */
836 #define SW_INVOL 0x0200 /* Involuntary switch. */
837 #define SW_PREEMPT 0x0400 /* The invol switch is a preemption */
838
839 /* How values for thread_single(). */
840 #define SINGLE_NO_EXIT 0
841 #define SINGLE_EXIT 1
842 #define SINGLE_BOUNDARY 2
843 #define SINGLE_ALLPROC 3
844
845 #ifdef MALLOC_DECLARE
846 MALLOC_DECLARE(M_PARGS);
847 MALLOC_DECLARE(M_SESSION);
848 MALLOC_DECLARE(M_SUBPROC);
849 #endif
850
851 #define FOREACH_PROC_IN_SYSTEM(p) \
852 LIST_FOREACH((p), &allproc, p_list)
853 #define FOREACH_THREAD_IN_PROC(p, td) \
854 TAILQ_FOREACH((td), &(p)->p_threads, td_plist)
855
856 #define FIRST_THREAD_IN_PROC(p) TAILQ_FIRST(&(p)->p_threads)
857
858 /*
859 * We use process IDs <= pid_max <= PID_MAX; PID_MAX + 1 must also fit
860 * in a pid_t, as it is used to represent "no process group".
861 */
862 #define PID_MAX 99999
863 #define NO_PID 100000
864 extern pid_t pid_max;
865
866 #define SESS_LEADER(p) ((p)->p_session->s_leader == (p))
867
868
869 #define STOPEVENT(p, e, v) do { \
870 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, NULL, \
871 "checking stopevent %d", (e)); \
872 if ((p)->p_stops & (e)) { \
873 PROC_LOCK(p); \
874 stopevent((p), (e), (v)); \
875 PROC_UNLOCK(p); \
876 } \
877 } while (0)
878 #define _STOPEVENT(p, e, v) do { \
879 PROC_LOCK_ASSERT(p, MA_OWNED); \
880 WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, &p->p_mtx.lock_object, \
881 "checking stopevent %d", (e)); \
882 if ((p)->p_stops & (e)) \
883 stopevent((p), (e), (v)); \
884 } while (0)
885
886 /* Lock and unlock a process. */
887 #define PROC_LOCK(p) mtx_lock(&(p)->p_mtx)
888 #define PROC_TRYLOCK(p) mtx_trylock(&(p)->p_mtx)
889 #define PROC_UNLOCK(p) mtx_unlock(&(p)->p_mtx)
890 #define PROC_LOCKED(p) mtx_owned(&(p)->p_mtx)
891 #define PROC_LOCK_ASSERT(p, type) mtx_assert(&(p)->p_mtx, (type))
892
893 /* Lock and unlock a process group. */
894 #define PGRP_LOCK(pg) mtx_lock(&(pg)->pg_mtx)
895 #define PGRP_UNLOCK(pg) mtx_unlock(&(pg)->pg_mtx)
896 #define PGRP_LOCKED(pg) mtx_owned(&(pg)->pg_mtx)
897 #define PGRP_LOCK_ASSERT(pg, type) mtx_assert(&(pg)->pg_mtx, (type))
898
899 #define PGRP_LOCK_PGSIGNAL(pg) do { \
900 if ((pg) != NULL) \
901 PGRP_LOCK(pg); \
902 } while (0)
903 #define PGRP_UNLOCK_PGSIGNAL(pg) do { \
904 if ((pg) != NULL) \
905 PGRP_UNLOCK(pg); \
906 } while (0)
907
908 /* Lock and unlock a session. */
909 #define SESS_LOCK(s) mtx_lock(&(s)->s_mtx)
910 #define SESS_UNLOCK(s) mtx_unlock(&(s)->s_mtx)
911 #define SESS_LOCKED(s) mtx_owned(&(s)->s_mtx)
912 #define SESS_LOCK_ASSERT(s, type) mtx_assert(&(s)->s_mtx, (type))
913
914 /*
915 * Non-zero p_lock ensures that:
916 * - exit1() is not performed until p_lock reaches zero;
917 * - the process' threads stack are not swapped out if they are currently
918 * not (P_INMEM).
919 *
920 * PHOLD() asserts that the process (except the current process) is
921 * not exiting, increments p_lock and swaps threads stacks into memory,
922 * if needed.
923 * _PHOLD() is same as PHOLD(), it takes the process locked.
924 * _PHOLD_LITE() also takes the process locked, but comparing with
925 * _PHOLD(), it only guarantees that exit1() is not executed,
926 * faultin() is not called.
927 */
928 #define PHOLD(p) do { \
929 PROC_LOCK(p); \
930 _PHOLD(p); \
931 PROC_UNLOCK(p); \
932 } while (0)
933 #define _PHOLD(p) do { \
934 PROC_LOCK_ASSERT((p), MA_OWNED); \
935 KASSERT(!((p)->p_flag & P_WEXIT) || (p) == curproc, \
936 ("PHOLD of exiting process %p", p)); \
937 (p)->p_lock++; \
938 if (((p)->p_flag & P_INMEM) == 0) \
939 faultin((p)); \
940 } while (0)
941 #define _PHOLD_LITE(p) do { \
942 PROC_LOCK_ASSERT((p), MA_OWNED); \
943 KASSERT(!((p)->p_flag & P_WEXIT) || (p) == curproc, \
944 ("PHOLD of exiting process %p", p)); \
945 (p)->p_lock++; \
946 } while (0)
947 #define PROC_ASSERT_HELD(p) do { \
948 KASSERT((p)->p_lock > 0, ("process %p not held", p)); \
949 } while (0)
950
951 #define PRELE(p) do { \
952 PROC_LOCK((p)); \
953 _PRELE((p)); \
954 PROC_UNLOCK((p)); \
955 } while (0)
956 #define _PRELE(p) do { \
957 PROC_LOCK_ASSERT((p), MA_OWNED); \
958 PROC_ASSERT_HELD(p); \
959 (--(p)->p_lock); \
960 if (((p)->p_flag & P_WEXIT) && (p)->p_lock == 0) \
961 wakeup(&(p)->p_lock); \
962 } while (0)
963 #define PROC_ASSERT_NOT_HELD(p) do { \
964 KASSERT((p)->p_lock == 0, ("process %p held", p)); \
965 } while (0)
966
967 #define PROC_UPDATE_COW(p) do { \
968 PROC_LOCK_ASSERT((p), MA_OWNED); \
969 (p)->p_cowgen++; \
970 } while (0)
971
972 /* Check whether a thread is safe to be swapped out. */
973 #define thread_safetoswapout(td) ((td)->td_flags & TDF_CANSWAP)
974
975 /* Control whether or not it is safe for curthread to sleep. */
976 #define THREAD_NO_SLEEPING() ((curthread)->td_no_sleeping++)
977
978 #define THREAD_SLEEPING_OK() ((curthread)->td_no_sleeping--)
979
980 #define THREAD_CAN_SLEEP() ((curthread)->td_no_sleeping == 0)
981
982 #define PIDHASH(pid) (&pidhashtbl[(pid) & pidhash])
983 extern LIST_HEAD(pidhashhead, proc) *pidhashtbl;
984 extern u_long pidhash;
985 #define TIDHASH(tid) (&tidhashtbl[(tid) & tidhash])
986 extern LIST_HEAD(tidhashhead, thread) *tidhashtbl;
987 extern u_long tidhash;
988 extern struct rwlock tidhash_lock;
989
990 #define PGRPHASH(pgid) (&pgrphashtbl[(pgid) & pgrphash])
991 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
992 extern u_long pgrphash;
993
994 extern struct sx allproc_lock;
995 extern int allproc_gen;
996 extern struct sx proctree_lock;
997 extern struct mtx ppeers_lock;
998 extern struct proc proc0; /* Process slot for swapper. */
999 extern struct thread0_storage thread0_st; /* Primary thread in proc0. */
1000 #define thread0 (thread0_st.t0st_thread)
1001 extern struct vmspace vmspace0; /* VM space for proc0. */
1002 extern int hogticks; /* Limit on kernel cpu hogs. */
1003 extern int lastpid;
1004 extern int nprocs, maxproc; /* Current and max number of procs. */
1005 extern int maxprocperuid; /* Max procs per uid. */
1006 extern u_long ps_arg_cache_limit;
1007
1008 LIST_HEAD(proclist, proc);
1009 TAILQ_HEAD(procqueue, proc);
1010 TAILQ_HEAD(threadqueue, thread);
1011 extern struct proclist allproc; /* List of all processes. */
1012 extern struct proclist zombproc; /* List of zombie processes. */
1013 extern struct proc *initproc, *pageproc; /* Process slots for init, pager. */
1014
1015 extern struct uma_zone *proc_zone;
1016 extern struct uma_zone *pgrp_zone;
1017
1018 struct proc *pfind(pid_t); /* Find process by id. */
1019 struct proc *pfind_any(pid_t); /* Find (zombie) process by id. */
1020 struct proc *pfind_locked(pid_t pid);
1021 struct pgrp *pgfind(pid_t); /* Find process group by id. */
1022 struct proc *zpfind(pid_t); /* Find zombie process by id. */
1023
1024 struct fork_req {
1025 int fr_flags;
1026 int fr_pages;
1027 int *fr_pidp;
1028 struct proc **fr_procp;
1029 int *fr_pd_fd;
1030 int fr_pd_flags;
1031 struct filecaps *fr_pd_fcaps;
1032 int fr_flags2;
1033 #define FR2_DROPSIG_CAUGHT 0x00001 /* Drop caught non-DFL signals */
1034 };
1035
1036 /*
1037 * pget() flags.
1038 */
1039 #define PGET_HOLD 0x00001 /* Hold the process. */
1040 #define PGET_CANSEE 0x00002 /* Check against p_cansee(). */
1041 #define PGET_CANDEBUG 0x00004 /* Check against p_candebug(). */
1042 #define PGET_ISCURRENT 0x00008 /* Check that the found process is current. */
1043 #define PGET_NOTWEXIT 0x00010 /* Check that the process is not in P_WEXIT. */
1044 #define PGET_NOTINEXEC 0x00020 /* Check that the process is not in P_INEXEC. */
1045 #define PGET_NOTID 0x00040 /* Do not assume tid if pid > PID_MAX. */
1046
1047 #define PGET_WANTREAD (PGET_HOLD | PGET_CANDEBUG | PGET_NOTWEXIT)
1048
1049 int pget(pid_t pid, int flags, struct proc **pp);
1050
1051 void ast(struct trapframe *framep);
1052 struct thread *choosethread(void);
1053 int cr_cansee(struct ucred *u1, struct ucred *u2);
1054 int cr_canseesocket(struct ucred *cred, struct socket *so);
1055 int cr_canseeothergids(struct ucred *u1, struct ucred *u2);
1056 int cr_canseeotheruids(struct ucred *u1, struct ucred *u2);
1057 int cr_canseejailproc(struct ucred *u1, struct ucred *u2);
1058 int cr_cansignal(struct ucred *cred, struct proc *proc, int signum);
1059 int enterpgrp(struct proc *p, pid_t pgid, struct pgrp *pgrp,
1060 struct session *sess);
1061 int enterthispgrp(struct proc *p, struct pgrp *pgrp);
1062 void faultin(struct proc *p);
1063 int fork1(struct thread *, struct fork_req *);
1064 void fork_exit(void (*)(void *, struct trapframe *), void *,
1065 struct trapframe *);
1066 void fork_return(struct thread *, struct trapframe *);
1067 int inferior(struct proc *p);
1068 void kern_proc_vmmap_resident(struct vm_map *map, struct vm_map_entry *entry,
1069 int *resident_count, bool *super);
1070 void kern_yield(int);
1071 void kick_proc0(void);
1072 void killjobc(void);
1073 int leavepgrp(struct proc *p);
1074 int maybe_preempt(struct thread *td);
1075 void maybe_yield(void);
1076 void mi_switch(int flags, struct thread *newtd);
1077 int p_candebug(struct thread *td, struct proc *p);
1078 int p_cansee(struct thread *td, struct proc *p);
1079 int p_cansched(struct thread *td, struct proc *p);
1080 int p_cansignal(struct thread *td, struct proc *p, int signum);
1081 int p_canwait(struct thread *td, struct proc *p);
1082 struct pargs *pargs_alloc(int len);
1083 void pargs_drop(struct pargs *pa);
1084 void pargs_hold(struct pargs *pa);
1085 int proc_getargv(struct thread *td, struct proc *p, struct sbuf *sb);
1086 int proc_getauxv(struct thread *td, struct proc *p, struct sbuf *sb);
1087 int proc_getenvv(struct thread *td, struct proc *p, struct sbuf *sb);
1088 void procinit(void);
1089 void proc_linkup0(struct proc *p, struct thread *td);
1090 void proc_linkup(struct proc *p, struct thread *td);
1091 struct proc *proc_realparent(struct proc *child);
1092 void proc_reap(struct thread *td, struct proc *p, int *status, int options);
1093 void proc_reparent(struct proc *child, struct proc *newparent, bool set_oppid);
1094 void proc_add_orphan(struct proc *child, struct proc *parent);
1095 void proc_set_traced(struct proc *p, bool stop);
1096 void proc_wkilled(struct proc *p);
1097 struct pstats *pstats_alloc(void);
1098 void pstats_fork(struct pstats *src, struct pstats *dst);
1099 void pstats_free(struct pstats *ps);
1100 void proc_clear_orphan(struct proc *p);
1101 void reaper_abandon_children(struct proc *p, bool exiting);
1102 int securelevel_ge(struct ucred *cr, int level);
1103 int securelevel_gt(struct ucred *cr, int level);
1104 void sess_hold(struct session *);
1105 void sess_release(struct session *);
1106 int setrunnable(struct thread *);
1107 void setsugid(struct proc *p);
1108 int should_yield(void);
1109 int sigonstack(size_t sp);
1110 void stopevent(struct proc *, u_int, u_int);
1111 struct thread *tdfind(lwpid_t, pid_t);
1112 void threadinit(void);
1113 void tidhash_add(struct thread *);
1114 void tidhash_remove(struct thread *);
1115 void cpu_idle(int);
1116 int cpu_idle_wakeup(int);
1117 extern void (*cpu_idle_hook)(sbintime_t); /* Hook to machdep CPU idler. */
1118 void cpu_switch(struct thread *, struct thread *, struct mtx *);
1119 void cpu_throw(struct thread *, struct thread *) __dead2;
1120 void unsleep(struct thread *);
1121 void userret(struct thread *, struct trapframe *);
1122
1123 void cpu_exit(struct thread *);
1124 void exit1(struct thread *, int, int) __dead2;
1125 void cpu_copy_thread(struct thread *td, struct thread *td0);
1126 bool cpu_exec_vmspace_reuse(struct proc *p, struct vm_map *map);
1127 int cpu_fetch_syscall_args(struct thread *td);
1128 void cpu_fork(struct thread *, struct proc *, struct thread *, int);
1129 void cpu_fork_kthread_handler(struct thread *, void (*)(void *), void *);
1130 int cpu_procctl(struct thread *td, int idtype, id_t id, int com,
1131 void *data);
1132 void cpu_set_syscall_retval(struct thread *, int);
1133 void cpu_set_upcall(struct thread *, void (*)(void *), void *,
1134 stack_t *);
1135 int cpu_set_user_tls(struct thread *, void *tls_base);
1136 void cpu_thread_alloc(struct thread *);
1137 void cpu_thread_clean(struct thread *);
1138 void cpu_thread_exit(struct thread *);
1139 void cpu_thread_free(struct thread *);
1140 void cpu_thread_swapin(struct thread *);
1141 void cpu_thread_swapout(struct thread *);
1142 struct thread *thread_alloc(int pages);
1143 int thread_alloc_stack(struct thread *, int pages);
1144 int thread_check_susp(struct thread *td, bool sleep);
1145 void thread_cow_get_proc(struct thread *newtd, struct proc *p);
1146 void thread_cow_get(struct thread *newtd, struct thread *td);
1147 void thread_cow_free(struct thread *td);
1148 void thread_cow_update(struct thread *td);
1149 int thread_create(struct thread *td, struct rtprio *rtp,
1150 int (*initialize_thread)(struct thread *, void *), void *thunk);
1151 void thread_exit(void) __dead2;
1152 void thread_free(struct thread *td);
1153 void thread_link(struct thread *td, struct proc *p);
1154 void thread_reap(void);
1155 int thread_single(struct proc *p, int how);
1156 void thread_single_end(struct proc *p, int how);
1157 void thread_stash(struct thread *td);
1158 void thread_stopped(struct proc *p);
1159 void childproc_stopped(struct proc *child, int reason);
1160 void childproc_continued(struct proc *child);
1161 void childproc_exited(struct proc *child);
1162 int thread_suspend_check(int how);
1163 bool thread_suspend_check_needed(void);
1164 void thread_suspend_switch(struct thread *, struct proc *p);
1165 void thread_suspend_one(struct thread *td);
1166 void thread_unlink(struct thread *td);
1167 void thread_unsuspend(struct proc *p);
1168 void thread_wait(struct proc *p);
1169 struct thread *thread_find(struct proc *p, lwpid_t tid);
1170
1171 void stop_all_proc(void);
1172 void resume_all_proc(void);
1173
1174 static __inline int
1175 curthread_pflags_set(int flags)
1176 {
1177 struct thread *td;
1178 int save;
1179
1180 td = curthread;
1181 save = ~flags | (td->td_pflags & flags);
1182 td->td_pflags |= flags;
1183 return (save);
1184 }
1185
1186 static __inline void
1187 curthread_pflags_restore(int save)
1188 {
1189
1190 curthread->td_pflags &= save;
1191 }
1192
1193 static __inline int
1194 curthread_pflags2_set(int flags)
1195 {
1196 struct thread *td;
1197 int save;
1198
1199 td = curthread;
1200 save = ~flags | (td->td_pflags2 & flags);
1201 td->td_pflags2 |= flags;
1202 return (save);
1203 }
1204
1205 static __inline void
1206 curthread_pflags2_restore(int save)
1207 {
1208
1209 curthread->td_pflags2 &= save;
1210 }
1211
1212 static __inline __pure2 struct td_sched *
1213 td_get_sched(struct thread *td)
1214 {
1215
1216 return ((struct td_sched *)&td[1]);
1217 }
1218
1219 extern void (*softdep_ast_cleanup)(struct thread *);
1220 static __inline void
1221 td_softdep_cleanup(struct thread *td)
1222 {
1223
1224 if (td->td_su != NULL && softdep_ast_cleanup != NULL)
1225 softdep_ast_cleanup(td);
1226 }
1227
1228 #endif /* _KERNEL */
1229
1230 #endif /* !_SYS_PROC_H_ */
Cache object: 91c88b6fb2dda8e1cac4c96b6c9ab176
|