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