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