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