]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/sys/proc.h
- Make SCHED_STATS more generic by adding a wrapper to create the
[FreeBSD/FreeBSD.git] / sys / sys / proc.h
1 /*-
2  * Copyright (c) 1986, 1989, 1991, 1993
3  *      The Regents of the University of California.  All rights reserved.
4  * (c) UNIX System Laboratories, Inc.
5  * All or some portions of this file are derived from material licensed
6  * to the University of California by American Telephone and Telegraph
7  * Co. or Unix System Laboratories, Inc. and are reproduced herein with
8  * the permission of UNIX System Laboratories, Inc.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 4. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *      @(#)proc.h      8.15 (Berkeley) 5/19/95
35  * $FreeBSD$
36  */
37
38 #ifndef _SYS_PROC_H_
39 #define _SYS_PROC_H_
40
41 #include <sys/callout.h>                /* For struct callout. */
42 #include <sys/event.h>                  /* For struct klist. */
43 #ifndef _KERNEL
44 #include <sys/filedesc.h>
45 #endif
46 #include <sys/queue.h>
47 #include <sys/_lock.h>
48 #include <sys/lock_profile.h>
49 #include <sys/_mutex.h>
50 #include <sys/priority.h>
51 #include <sys/rtprio.h>                 /* XXX. */
52 #include <sys/runq.h>
53 #include <sys/resource.h>
54 #include <sys/sigio.h>
55 #include <sys/signal.h>
56 #include <sys/signalvar.h>
57 #ifndef _KERNEL
58 #include <sys/time.h>                   /* For structs itimerval, timeval. */
59 #else
60 #include <sys/pcpu.h>
61 #endif
62 #include <sys/ucontext.h>
63 #include <sys/ucred.h>
64 #include <machine/proc.h>               /* Machine-dependent proc substruct. */
65
66 /*
67  * One structure allocated per session.
68  *
69  * List of locks
70  * (m)          locked by s_mtx mtx
71  * (e)          locked by proctree_lock sx
72  * (c)          const until freeing
73  */
74 struct session {
75         int             s_count;        /* (m) Ref cnt; pgrps in session. */
76         struct proc     *s_leader;      /* (m + e) Session leader. */
77         struct vnode    *s_ttyvp;       /* (m) Vnode of controlling tty. */
78         struct tty      *s_ttyp;        /* (m) Controlling tty. */
79         pid_t           s_sid;          /* (c) Session ID. */
80                                         /* (m) Setlogin() name: */
81         char            s_login[roundup(MAXLOGNAME, sizeof(long))];
82         struct mtx      s_mtx;          /* Mutex to protect members. */
83 };
84
85 /*
86  * One structure allocated per process group.
87  *
88  * List of locks
89  * (m)          locked by pg_mtx mtx
90  * (e)          locked by proctree_lock sx
91  * (c)          const until freeing
92  */
93 struct pgrp {
94         LIST_ENTRY(pgrp) pg_hash;       /* (e) Hash chain. */
95         LIST_HEAD(, proc) pg_members;   /* (m + e) Pointer to pgrp members. */
96         struct session  *pg_session;    /* (c) Pointer to session. */
97         struct sigiolst pg_sigiolst;    /* (m) List of sigio sources. */
98         pid_t           pg_id;          /* (c) Process group id. */
99         int             pg_jobc;        /* (m) Job control process count. */
100         struct mtx      pg_mtx;         /* Mutex to protect members */
101 };
102
103 /*
104  * pargs, used to hold a copy of the command line, if it had a sane length.
105  */
106 struct pargs {
107         u_int   ar_ref;         /* Reference count. */
108         u_int   ar_length;      /* Length. */
109         u_char  ar_args[1];     /* Arguments. */
110 };
111
112 /*-
113  * Description of a process.
114  *
115  * This structure contains the information needed to manage a thread of
116  * control, known in UN*X as a process; it has references to substructures
117  * containing descriptions of things that the process uses, but may share
118  * with related processes.  The process structure and the substructures
119  * are always addressable except for those marked "(CPU)" below,
120  * which might be addressable only on a processor on which the process
121  * is running.
122  *
123  * Below is a key of locks used to protect each member of struct proc.  The
124  * lock is indicated by a reference to a specific character in parens in the
125  * associated comment.
126  *      * - not yet protected
127  *      a - only touched by curproc or parent during fork/wait
128  *      b - created at fork, never changes
129  *              (exception aiods switch vmspaces, but they are also
130  *              marked 'P_SYSTEM' so hopefully it will be left alone)
131  *      c - locked by proc mtx
132  *      d - locked by allproc_lock lock
133  *      e - locked by proctree_lock lock
134  *      f - session mtx
135  *      g - process group mtx
136  *      h - callout_lock mtx
137  *      i - by curproc or the master session mtx
138  *      j - locked by proc slock
139  *      k - only accessed by curthread
140  *      k*- only accessed by curthread and from an interrupt
141  *      l - the attaching proc or attaching proc parent
142  *      m - Giant
143  *      n - not locked, lazy
144  *      o - ktrace lock
145  *      q - td_contested lock
146  *      r - p_peers lock
147  *      t - thread lock
148  *      x - created at fork, only changes during single threading in exec
149  *      z - zombie threads lock
150  *
151  * If the locking key specifies two identifiers (for example, p_pptr) then
152  * either lock is sufficient for read access, but both locks must be held
153  * for write access.
154  */
155 struct kaudit_record;
156 struct td_sched;
157 struct nlminfo;
158 struct kaioinfo;
159 struct p_sched;
160 struct proc;
161 struct sleepqueue;
162 struct thread;
163 struct trapframe;
164 struct turnstile;
165 struct mqueue_notifier;
166 struct cpuset;
167
168 /*
169  * Kernel runnable context (thread).
170  * This is what is put to sleep and reactivated.
171  * Thread context.  Processes may have multiple threads.
172  */
173 struct thread {
174         struct mtx      *volatile td_lock; /* replaces sched lock */
175         struct proc     *td_proc;       /* (*) Associated process. */
176         TAILQ_ENTRY(thread) td_plist;   /* (*) All threads in this proc. */
177         TAILQ_ENTRY(thread) td_runq;    /* (t) Run queue. */
178         TAILQ_ENTRY(thread) td_slpq;    /* (t) Sleep queue. */
179         TAILQ_ENTRY(thread) td_lockq;   /* (t) Lock queue. */
180         struct cpuset   *td_cpuset;     /* (t) CPU affinity mask. */
181         struct seltd    *td_sel;        /* Select queue/channel. */
182         struct sleepqueue *td_sleepqueue; /* (k) Associated sleep queue. */
183         struct turnstile *td_turnstile; /* (k) Associated turnstile. */
184         struct umtx_q   *td_umtxq;      /* (c?) Link for when we're blocked. */
185         lwpid_t         td_tid;         /* (b) Thread ID. */
186         sigqueue_t      td_sigqueue;    /* (c) Sigs arrived, not delivered. */
187 #define td_siglist      td_sigqueue.sq_signals
188
189 /* Cleared during fork1() */
190 #define td_startzero td_flags
191         int             td_flags;       /* (t) TDF_* flags. */
192         int             td_inhibitors;  /* (t) Why can not run. */
193         int             td_pflags;      /* (k) Private thread (TDP_*) flags. */
194         int             td_dupfd;       /* (k) Ret value from fdopen. XXX */
195         int             td_sqqueue;     /* (t) Sleepqueue queue blocked on. */
196         void            *td_wchan;      /* (t) Sleep address. */
197         const char      *td_wmesg;      /* (t) Reason for sleep. */
198         u_char          td_lastcpu;     /* (t) Last cpu we were on. */
199         u_char          td_oncpu;       /* (t) Which cpu we are on. */
200         volatile u_char td_owepreempt;  /* (k*) Preempt on last critical_exit */
201         u_char          td_tsqueue;     /* (t) Turnstile queue blocked on. */
202         short           td_locks;       /* (k) Count of non-spin locks. */
203         short           td_rw_rlocks;   /* (k) Count of rwlock read locks. */
204         short           td_lk_slocks;   /* (k) Count of lockmgr shared locks. */
205         struct turnstile *td_blocked;   /* (t) Lock thread is blocked on. */
206         const char      *td_lockname;   /* (t) Name of lock blocked on. */
207         LIST_HEAD(, turnstile) td_contested;    /* (q) Contested locks. */
208         struct lock_list_entry *td_sleeplocks; /* (k) Held sleep locks. */
209         int             td_intr_nesting_level; /* (k) Interrupt recursion. */
210         int             td_pinned;      /* (k) Temporary cpu pin count. */
211         struct ucred    *td_ucred;      /* (k) Reference to credentials. */
212         u_int           td_estcpu;      /* (t) estimated cpu utilization */
213         u_int           td_slptick;     /* (t) Time at sleep. */
214         struct rusage   td_ru;          /* (t) rusage information */
215         uint64_t        td_incruntime;  /* (t) Cpu ticks to transfer to proc. */
216         uint64_t        td_runtime;     /* (t) How many cpu ticks we've run. */
217         u_int           td_pticks;      /* (t) Statclock hits for profiling */
218         u_int           td_sticks;      /* (t) Statclock hits in system mode. */
219         u_int           td_iticks;      /* (t) Statclock hits in intr mode. */
220         u_int           td_uticks;      /* (t) Statclock hits in user mode. */
221         u_int           td_uuticks;     /* (k) Statclock hits (usr), for UTS. */
222         u_int           td_usticks;     /* (k) Statclock hits (sys), for UTS. */
223         int             td_intrval;     /* (t) Return value for sleepq. */
224         sigset_t        td_oldsigmask;  /* (k) Saved mask from pre sigpause. */
225         sigset_t        td_sigmask;     /* (c) Current signal mask. */
226         volatile u_int  td_generation;  /* (k) For detection of preemption */
227         stack_t         td_sigstk;      /* (k) Stack ptr and on-stack flag. */
228         int             td_xsig;        /* (c) Signal for ptrace */
229         u_long          td_profil_addr; /* (k) Temporary addr until AST. */
230         u_int           td_profil_ticks; /* (k) Temporary ticks until AST. */
231         char            td_name[MAXCOMLEN + 1]; /* (*) Thread name. */
232 #define td_endzero td_base_pri
233
234 /* Copied during fork1() or thread_sched_upcall(). */
235 #define td_startcopy td_endzero
236         u_char          td_rqindex;     /* (t) Run queue index. */
237         u_char          td_base_pri;    /* (t) Thread base kernel priority. */
238         u_char          td_priority;    /* (t) Thread active priority. */
239         u_char          td_pri_class;   /* (t) Scheduling class. */
240         u_char          td_user_pri;    /* (t) User pri from estcpu and nice. */
241         u_char          td_base_user_pri; /* (t) Base user pri */
242 #define td_endcopy td_pcb
243
244 /*
245  * Fields that must be manually set in fork1() or thread_sched_upcall()
246  * or already have been set in the allocator, constructor, etc.
247  */
248         struct pcb      *td_pcb;        /* (k) Kernel VA of pcb and kstack. */
249         enum {
250                 TDS_INACTIVE = 0x0,
251                 TDS_INHIBITED,
252                 TDS_CAN_RUN,
253                 TDS_RUNQ,
254                 TDS_RUNNING
255         } td_state;                     /* (t) thread state */
256         register_t      td_retval[2];   /* (k) Syscall aux returns. */
257         struct callout  td_slpcallout;  /* (h) Callout for sleep. */
258         struct trapframe *td_frame;     /* (k) */
259         struct vm_object *td_kstack_obj;/* (a) Kstack object. */
260         vm_offset_t     td_kstack;      /* (a) Kernel VA of kstack. */
261         int             td_kstack_pages; /* (a) Size of the kstack. */
262         struct vm_object *td_altkstack_obj;/* (a) Alternate kstack object. */
263         vm_offset_t     td_altkstack;   /* (a) Kernel VA of alternate kstack. */
264         int             td_altkstack_pages; /* (a) Size of alternate kstack. */
265         volatile u_int  td_critnest;    /* (k*) Critical section nest level. */
266         struct mdthread td_md;          /* (k) Any machine-dependent fields. */
267         struct td_sched *td_sched;      /* (*) Scheduler-specific data. */
268         struct kaudit_record    *td_ar; /* (k) Active audit record, if any. */
269         int             td_syscalls;    /* per-thread syscall count (used by NFS :)) */
270         struct lpohead  td_lprof[2];    /* (a) lock profiling objects. */
271 };
272
273 struct mtx *thread_lock_block(struct thread *);
274 void thread_lock_unblock(struct thread *, struct mtx *);
275 void thread_lock_set(struct thread *, struct mtx *);
276 #define THREAD_LOCK_ASSERT(td, type)                                    \
277 do {                                                                    \
278         struct mtx *__m = (td)->td_lock;                                \
279         if (__m != &blocked_lock)                                       \
280                 mtx_assert(__m, (type));                                \
281 } while (0)
282
283 #ifdef INVARIANTS
284 #define THREAD_LOCKPTR_ASSERT(td, lock)                                 \
285 do {                                                                    \
286         struct mtx *__m = (td)->td_lock;                                \
287         KASSERT((__m == &blocked_lock || __m == (lock)),                \
288             ("Thread %p lock %p does not match %p", td, __m, (lock)));  \
289 } while (0)
290 #else
291 #define THREAD_LOCKPTR_ASSERT(td, lock)
292 #endif
293
294 /*
295  * Flags kept in td_flags:
296  * To change these you MUST have the scheduler lock.
297  */
298 #define TDF_BORROWING   0x00000001 /* Thread is borrowing pri from another. */
299 #define TDF_INPANIC     0x00000002 /* Caused a panic, let it drive crashdump. */
300 #define TDF_INMEM       0x00000004 /* Thread's stack is in memory. */
301 #define TDF_SINTR       0x00000008 /* Sleep is interruptible. */
302 #define TDF_TIMEOUT     0x00000010 /* Timing out during sleep. */
303 #define TDF_IDLETD      0x00000020 /* This is a per-CPU idle thread. */
304 #define TDF_CANSWAP     0x00000040 /* Thread can be swapped. */
305 #define TDF_SLEEPABORT  0x00000080 /* sleepq_abort was called. */
306 #define TDF_KTH_SUSP    0x00000100 /* kthread is suspended */
307 #define TDF_UBORROWING  0x00000200 /* Thread is borrowing user pri. */
308 #define TDF_BOUNDARY    0x00000400 /* Thread suspended at user boundary */
309 #define TDF_ASTPENDING  0x00000800 /* Thread has some asynchronous events. */
310 #define TDF_TIMOFAIL    0x00001000 /* Timeout from sleep after we were awake. */
311 #define TDF_UNUSED2000  0x00002000 /* --available-- */
312 #define TDF_UPIBLOCKED  0x00004000 /* Thread blocked on user PI mutex. */
313 #define TDF_NEEDSUSPCHK 0x00008000 /* Thread may need to suspend. */
314 #define TDF_NEEDRESCHED 0x00010000 /* Thread needs to yield. */
315 #define TDF_NEEDSIGCHK  0x00020000 /* Thread may need signal delivery. */
316 #define TDF_XSIG        0x00040000 /* Thread is exchanging signal under trace */
317 #define TDF_UNUSED19    0x00080000 /* Thread is sleeping on a umtx. */
318 #define TDF_THRWAKEUP   0x00100000 /* Libthr thread must not suspend itself. */
319 #define TDF_DBSUSPEND   0x00200000 /* Thread is suspended by debugger */
320 #define TDF_SWAPINREQ   0x00400000 /* Swapin request due to wakeup. */
321 #define TDF_UNUSED23    0x00800000 /* --available-- */
322 #define TDF_SCHED0      0x01000000 /* Reserved for scheduler private use */
323 #define TDF_SCHED1      0x02000000 /* Reserved for scheduler private use */
324 #define TDF_SCHED2      0x04000000 /* Reserved for scheduler private use */
325 #define TDF_SCHED3      0x08000000 /* Reserved for scheduler private use */
326 #define TDF_ALRMPEND    0x10000000 /* Pending SIGVTALRM needs to be posted. */
327 #define TDF_PROFPEND    0x20000000 /* Pending SIGPROF needs to be posted. */
328 #define TDF_MACPEND     0x40000000 /* AST-based MAC event pending. */
329
330 /*
331  * "Private" flags kept in td_pflags:
332  * These are only written by curthread and thus need no locking.
333  */
334 #define TDP_OLDMASK     0x00000001 /* Need to restore mask after suspend. */
335 #define TDP_INKTR       0x00000002 /* Thread is currently in KTR code. */
336 #define TDP_INKTRACE    0x00000004 /* Thread is currently in KTRACE code. */
337 #define TDP_UNUSED8     0x00000008 /* available */
338 #define TDP_COWINPROGRESS 0x00000010 /* Snapshot copy-on-write in progress. */
339 #define TDP_ALTSTACK    0x00000020 /* Have alternate signal stack. */
340 #define TDP_DEADLKTREAT 0x00000040 /* Lock aquisition - deadlock treatment. */
341 #define TDP_UNUSED80    0x00000080 /* available. */
342 #define TDP_NOSLEEPING  0x00000100 /* Thread is not allowed to sleep on a sq. */
343 #define TDP_OWEUPC      0x00000200 /* Call addupc() at next AST. */
344 #define TDP_ITHREAD     0x00000400 /* Thread is an interrupt thread. */
345 #define TDP_UNUSED800   0x00000800 /* available. */
346 #define TDP_SCHED1      0x00001000 /* Reserved for scheduler private use */
347 #define TDP_SCHED2      0x00002000 /* Reserved for scheduler private use */
348 #define TDP_SCHED3      0x00004000 /* Reserved for scheduler private use */
349 #define TDP_SCHED4      0x00008000 /* Reserved for scheduler private use */
350 #define TDP_GEOM        0x00010000 /* Settle GEOM before finishing syscall */
351 #define TDP_SOFTDEP     0x00020000 /* Stuck processing softdep worklist */
352 #define TDP_NORUNNINGBUF 0x00040000 /* Ignore runningbufspace check */
353 #define TDP_WAKEUP      0x00080000 /* Don't sleep in umtx cond_wait */
354 #define TDP_INBDFLUSH   0x00100000 /* Already in BO_BDFLUSH, do not recurse */
355 #define TDP_KTHREAD     0x00200000 /* This is an official kernel thread */
356 #define TDP_CALLCHAIN   0x00400000 /* Capture thread's callchain */
357
358 /*
359  * Reasons that the current thread can not be run yet.
360  * More than one may apply.
361  */
362 #define TDI_SUSPENDED   0x0001  /* On suspension queue. */
363 #define TDI_SLEEPING    0x0002  /* Actually asleep! (tricky). */
364 #define TDI_SWAPPED     0x0004  /* Stack not in mem.  Bad juju if run. */
365 #define TDI_LOCK        0x0008  /* Stopped on a lock. */
366 #define TDI_IWAIT       0x0010  /* Awaiting interrupt. */
367
368 #define TD_IS_SLEEPING(td)      ((td)->td_inhibitors & TDI_SLEEPING)
369 #define TD_ON_SLEEPQ(td)        ((td)->td_wchan != NULL)
370 #define TD_IS_SUSPENDED(td)     ((td)->td_inhibitors & TDI_SUSPENDED)
371 #define TD_IS_SWAPPED(td)       ((td)->td_inhibitors & TDI_SWAPPED)
372 #define TD_ON_LOCK(td)          ((td)->td_inhibitors & TDI_LOCK)
373 #define TD_AWAITING_INTR(td)    ((td)->td_inhibitors & TDI_IWAIT)
374 #define TD_IS_RUNNING(td)       ((td)->td_state == TDS_RUNNING)
375 #define TD_ON_RUNQ(td)          ((td)->td_state == TDS_RUNQ)
376 #define TD_CAN_RUN(td)          ((td)->td_state == TDS_CAN_RUN)
377 #define TD_IS_INHIBITED(td)     ((td)->td_state == TDS_INHIBITED)
378 #define TD_ON_UPILOCK(td)       ((td)->td_flags & TDF_UPIBLOCKED)
379 #define TD_IS_IDLETHREAD(td)    ((td)->td_flags & TDF_IDLETD)
380
381
382 #define TD_SET_INHIB(td, inhib) do {                    \
383         (td)->td_state = TDS_INHIBITED;                 \
384         (td)->td_inhibitors |= (inhib);                 \
385 } while (0)
386
387 #define TD_CLR_INHIB(td, inhib) do {                    \
388         if (((td)->td_inhibitors & (inhib)) &&          \
389             (((td)->td_inhibitors &= ~(inhib)) == 0))   \
390                 (td)->td_state = TDS_CAN_RUN;           \
391 } while (0)
392
393 #define TD_SET_SLEEPING(td)     TD_SET_INHIB((td), TDI_SLEEPING)
394 #define TD_SET_SWAPPED(td)      TD_SET_INHIB((td), TDI_SWAPPED)
395 #define TD_SET_LOCK(td)         TD_SET_INHIB((td), TDI_LOCK)
396 #define TD_SET_SUSPENDED(td)    TD_SET_INHIB((td), TDI_SUSPENDED)
397 #define TD_SET_IWAIT(td)        TD_SET_INHIB((td), TDI_IWAIT)
398 #define TD_SET_EXITING(td)      TD_SET_INHIB((td), TDI_EXITING)
399
400 #define TD_CLR_SLEEPING(td)     TD_CLR_INHIB((td), TDI_SLEEPING)
401 #define TD_CLR_SWAPPED(td)      TD_CLR_INHIB((td), TDI_SWAPPED)
402 #define TD_CLR_LOCK(td)         TD_CLR_INHIB((td), TDI_LOCK)
403 #define TD_CLR_SUSPENDED(td)    TD_CLR_INHIB((td), TDI_SUSPENDED)
404 #define TD_CLR_IWAIT(td)        TD_CLR_INHIB((td), TDI_IWAIT)
405
406 #define TD_SET_RUNNING(td)      (td)->td_state = TDS_RUNNING
407 #define TD_SET_RUNQ(td)         (td)->td_state = TDS_RUNQ
408 #define TD_SET_CAN_RUN(td)      (td)->td_state = TDS_CAN_RUN
409
410 /*
411  * XXX: Does this belong in resource.h or resourcevar.h instead?
412  * Resource usage extension.  The times in rusage structs in the kernel are
413  * never up to date.  The actual times are kept as runtimes and tick counts
414  * (with control info in the "previous" times), and are converted when
415  * userland asks for rusage info.  Backwards compatibility prevents putting
416  * this directly in the user-visible rusage struct.
417  *
418  * Locking: (cj) means (j) for p_rux and (c) for p_crux.
419  */
420 struct rusage_ext {
421         u_int64_t       rux_runtime;    /* (cj) Real time. */
422         u_int64_t       rux_uticks;     /* (cj) Statclock hits in user mode. */
423         u_int64_t       rux_sticks;     /* (cj) Statclock hits in sys mode. */
424         u_int64_t       rux_iticks;     /* (cj) Statclock hits in intr mode. */
425         u_int64_t       rux_uu;         /* (c) Previous user time in usec. */
426         u_int64_t       rux_su;         /* (c) Previous sys time in usec. */
427         u_int64_t       rux_tu;         /* (c) Previous total time in usec. */
428 };
429
430 /*
431  * Process structure.
432  */
433 struct proc {
434         LIST_ENTRY(proc) p_list;        /* (d) List of all processes. */
435         TAILQ_HEAD(, thread) p_threads; /* (c) all threads. */
436         struct mtx      p_slock;        /* process spin lock */
437         struct ucred    *p_ucred;       /* (c) Process owner's identity. */
438         struct filedesc *p_fd;          /* (b) Open files. */
439         struct filedesc_to_leader *p_fdtol; /* (b) Tracking node */
440         struct pstats   *p_stats;       /* (b) Accounting/statistics (CPU). */
441         struct plimit   *p_limit;       /* (c) Process limits. */
442         struct callout  p_limco;        /* (c) Limit callout handle */
443         struct sigacts  *p_sigacts;     /* (x) Signal actions, state (CPU). */
444
445         /*
446          * The following don't make too much sense.
447          * See the td_ or ke_ versions of the same flags.
448          */
449         int             p_flag;         /* (c) P_* flags. */
450         enum {
451                 PRS_NEW = 0,            /* In creation */
452                 PRS_NORMAL,             /* threads can be run. */
453                 PRS_ZOMBIE
454         } p_state;                      /* (j/c) S* process status. */
455         pid_t           p_pid;          /* (b) Process identifier. */
456         LIST_ENTRY(proc) p_hash;        /* (d) Hash chain. */
457         LIST_ENTRY(proc) p_pglist;      /* (g + e) List of processes in pgrp. */
458         struct proc     *p_pptr;        /* (c + e) Pointer to parent process. */
459         LIST_ENTRY(proc) p_sibling;     /* (e) List of sibling processes. */
460         LIST_HEAD(, proc) p_children;   /* (e) Pointer to list of children. */
461         struct mtx      p_mtx;          /* (n) Lock for this struct. */
462         struct ksiginfo *p_ksi; /* Locked by parent proc lock */
463         sigqueue_t      p_sigqueue;     /* (c) Sigs not delivered to a td. */
464 #define p_siglist       p_sigqueue.sq_signals
465
466 /* The following fields are all zeroed upon creation in fork. */
467 #define p_startzero     p_oppid
468         pid_t           p_oppid;        /* (c + e) Save ppid in ptrace. XXX */
469         struct vmspace  *p_vmspace;     /* (b) Address space. */
470         u_int           p_swtick;       /* (c) Tick when swapped in or out. */
471         struct itimerval p_realtimer;   /* (c) Alarm timer. */
472         struct rusage   p_ru;           /* (a) Exit information. */
473         struct rusage_ext p_rux;        /* (cj) Internal resource usage. */
474         struct rusage_ext p_crux;       /* (c) Internal child resource usage. */
475         int             p_profthreads;  /* (c) Num threads in addupc_task. */
476         volatile int    p_exitthreads;  /* (j) Number of threads exiting */
477         int             p_traceflag;    /* (o) Kernel trace points. */
478         struct vnode    *p_tracevp;     /* (c + o) Trace to vnode. */
479         struct ucred    *p_tracecred;   /* (o) Credentials to trace with. */
480         struct vnode    *p_textvp;      /* (b) Vnode of executable. */
481         char            p_lock;         /* (c) Proclock (prevent swap) count. */
482         struct sigiolst p_sigiolst;     /* (c) List of sigio sources. */
483         int             p_sigparent;    /* (c) Signal to parent on exit. */
484         int             p_sig;          /* (n) For core dump/debugger XXX. */
485         u_long          p_code;         /* (n) For core dump/debugger XXX. */
486         u_int           p_stops;        /* (c) Stop event bitmask. */
487         u_int           p_stype;        /* (c) Stop event type. */
488         char            p_step;         /* (c) Process is stopped. */
489         u_char          p_pfsflags;     /* (c) Procfs flags. */
490         struct nlminfo  *p_nlminfo;     /* (?) Only used by/for lockd. */
491         struct kaioinfo *p_aioinfo;     /* (c) ASYNC I/O info. */
492         struct thread   *p_singlethread;/* (c + j) If single threading this is it */
493         int             p_suspcount;    /* (j) Num threads in suspended mode. */
494         struct thread   *p_xthread;     /* (c) Trap thread */
495         int             p_boundary_count;/* (c) Num threads at user boundary */
496         int             p_pendingcnt;   /* how many signals are pending */
497         struct itimers  *p_itimers;     /* (c) POSIX interval timers. */
498 /* End area that is zeroed on creation. */
499 #define p_endzero       p_magic
500
501 /* The following fields are all copied upon creation in fork. */
502 #define p_startcopy     p_endzero
503         u_int           p_magic;        /* (b) Magic number. */
504         int             p_osrel;        /* (x) osreldate for the
505                                                binary (from ELF note, if any) */
506         char            p_comm[MAXCOMLEN + 1];  /* (b) Process name. */
507         struct pgrp     *p_pgrp;        /* (c + e) Pointer to process group. */
508         struct sysentvec *p_sysent;     /* (b) Syscall dispatch info. */
509         struct pargs    *p_args;        /* (c) Process arguments. */
510         rlim_t          p_cpulimit;     /* (c) Current CPU limit in seconds. */
511         signed char     p_nice;         /* (c) Process "nice" value. */
512 /* End area that is copied on creation. */
513 #define p_endcopy       p_xstat
514
515         u_short         p_xstat;        /* (c) Exit status; also stop sig. */
516         struct knlist   p_klist;        /* (c) Knotes attached to this proc. */
517         int             p_numthreads;   /* (c) Number of threads. */
518         struct mdproc   p_md;           /* Any machine-dependent fields. */
519         struct callout  p_itcallout;    /* (h + c) Interval timer callout. */
520         u_short         p_acflag;       /* (c) Accounting flags. */
521         struct proc     *p_peers;       /* (r) */
522         struct proc     *p_leader;      /* (b) */
523         void            *p_emuldata;    /* (c) Emulator state data. */
524         struct label    *p_label;       /* (*) Proc (not subject) MAC label. */
525         struct p_sched  *p_sched;       /* (*) Scheduler-specific data. */
526         STAILQ_HEAD(, ktr_request)      p_ktr;  /* (o) KTR event queue. */
527         LIST_HEAD(, mqueue_notifier)    p_mqnotifier; /* (c) mqueue notifiers.*/
528 };
529
530 #define p_session       p_pgrp->pg_session
531 #define p_pgid          p_pgrp->pg_id
532
533 #define NOCPU   0xff            /* For when we aren't on a CPU. */
534
535 #define PROC_SLOCK(p)   mtx_lock_spin(&(p)->p_slock)
536 #define PROC_SUNLOCK(p) mtx_unlock_spin(&(p)->p_slock)
537 #define PROC_SLOCK_ASSERT(p, type)      mtx_assert(&(p)->p_slock, (type))
538
539 /* These flags are kept in p_flag. */
540 #define P_ADVLOCK       0x00001 /* Process may hold a POSIX advisory lock. */
541 #define P_CONTROLT      0x00002 /* Has a controlling terminal. */
542 #define P_KTHREAD       0x00004 /* Kernel thread (*). */
543 #define P_NOLOAD        0x00008 /* Ignore during load avg calculations. */
544 #define P_PPWAIT        0x00010 /* Parent is waiting for child to exec/exit. */
545 #define P_PROFIL        0x00020 /* Has started profiling. */
546 #define P_STOPPROF      0x00040 /* Has thread requesting to stop profiling. */
547 #define P_HADTHREADS    0x00080 /* Has had threads (no cleanup shortcuts) */
548 #define P_SUGID         0x00100 /* Had set id privileges since last exec. */
549 #define P_SYSTEM        0x00200 /* System proc: no sigs, stats or swapping. */
550 #define P_SINGLE_EXIT   0x00400 /* Threads suspending should exit, not wait. */
551 #define P_TRACED        0x00800 /* Debugged process being traced. */
552 #define P_WAITED        0x01000 /* Someone is waiting for us. */
553 #define P_WEXIT         0x02000 /* Working on exiting. */
554 #define P_EXEC          0x04000 /* Process called exec. */
555 #define P_UNUSED8000    0x08000 /* available. */
556 #define P_CONTINUED     0x10000 /* Proc has continued from a stopped state. */
557 #define P_STOPPED_SIG   0x20000 /* Stopped due to SIGSTOP/SIGTSTP. */
558 #define P_STOPPED_TRACE 0x40000 /* Stopped because of tracing. */
559 #define P_STOPPED_SINGLE 0x80000 /* Only 1 thread can continue (not to user). */
560 #define P_PROTECTED     0x100000 /* Do not kill on memory overcommit. */
561 #define P_SIGEVENT      0x200000 /* Process pending signals changed. */
562 #define P_SINGLE_BOUNDARY 0x400000 /* Threads should suspend at user boundary. */
563 #define P_HWPMC         0x800000 /* Process is using HWPMCs */
564
565 #define P_JAILED        0x1000000 /* Process is in jail. */
566 #define P_INEXEC        0x4000000 /* Process is in execve(). */
567 #define P_STATCHILD     0x8000000 /* Child process stopped or exited. */
568 #define P_INMEM         0x10000000 /* Loaded into memory. */
569 #define P_SWAPPINGOUT   0x20000000 /* Process is being swapped out. */
570 #define P_SWAPPINGIN    0x40000000 /* Process is being swapped in. */
571
572 #define P_STOPPED       (P_STOPPED_SIG|P_STOPPED_SINGLE|P_STOPPED_TRACE)
573 #define P_SHOULDSTOP(p) ((p)->p_flag & P_STOPPED)
574
575 /*
576  * These were process status values (p_stat), now they are only used in
577  * legacy conversion code.
578  */
579 #define SIDL    1               /* Process being created by fork. */
580 #define SRUN    2               /* Currently runnable. */
581 #define SSLEEP  3               /* Sleeping on an address. */
582 #define SSTOP   4               /* Process debugging or suspension. */
583 #define SZOMB   5               /* Awaiting collection by parent. */
584 #define SWAIT   6               /* Waiting for interrupt. */
585 #define SLOCK   7               /* Blocked on a lock. */
586
587 #define P_MAGIC         0xbeefface
588
589 #ifdef _KERNEL
590
591 /* Types and flags for mi_switch(). */
592 #define SW_TYPE_MASK            0xff    /* First 8 bits are switch type */
593 #define SWT_NONE                0       /* Unspecified switch. */
594 #define SWT_PREEMPT             1       /* Switching due to preemption. */
595 #define SWT_OWEPREEMPT          2       /* Switching due to opepreempt. */
596 #define SWT_TURNSTILE           3       /* Turnstile contention. */
597 #define SWT_SLEEPQ              4       /* Sleepq wait. */
598 #define SWT_SLEEPQTIMO          5       /* Sleepq timeout wait. */
599 #define SWT_RELINQUISH          6       /* yield call. */
600 #define SWT_NEEDRESCHED         7       /* NEEDRESCHED was set. */
601 #define SWT_IDLE                8       /* Switching from the idle thread. */
602 #define SWT_IWAIT               9       /* Waiting for interrupts. */
603 #define SWT_SUSPEND             10      /* Thread suspended. */
604 #define SWT_REMOTEPREEMPT       11      /* Remote processor preempted. */
605 #define SWT_REMOTEWAKEIDLE      12      /* Remote processor preempted idle. */
606 #define SWT_COUNT               13      /* Number of switch types. */
607 /* Flags */
608 #define SW_VOL          0x0100          /* Voluntary switch. */
609 #define SW_INVOL        0x0200          /* Involuntary switch. */
610 #define SW_PREEMPT      0x0400          /* The invol switch is a preemption */
611
612 /* How values for thread_single(). */
613 #define SINGLE_NO_EXIT  0
614 #define SINGLE_EXIT     1
615 #define SINGLE_BOUNDARY 2
616
617 #ifdef MALLOC_DECLARE
618 MALLOC_DECLARE(M_PARGS);
619 MALLOC_DECLARE(M_PGRP);
620 MALLOC_DECLARE(M_SESSION);
621 MALLOC_DECLARE(M_SUBPROC);
622 MALLOC_DECLARE(M_ZOMBIE);
623 #endif
624
625 #define FOREACH_PROC_IN_SYSTEM(p)                                       \
626         LIST_FOREACH((p), &allproc, p_list)
627 #define FOREACH_THREAD_IN_PROC(p, td)                                   \
628         TAILQ_FOREACH((td), &(p)->p_threads, td_plist)
629
630 #define FIRST_THREAD_IN_PROC(p) TAILQ_FIRST(&(p)->p_threads)
631
632 /*
633  * We use process IDs <= PID_MAX; PID_MAX + 1 must also fit in a pid_t,
634  * as it is used to represent "no process group".
635  */
636 #define PID_MAX         99999
637 #define NO_PID          100000
638
639 #define SESS_LEADER(p)  ((p)->p_session->s_leader == (p))
640 #define SESSHOLD(s)     ((s)->s_count++)
641 #define SESSRELE(s)     sessrele(s)
642
643
644 #define STOPEVENT(p, e, v) do {                                         \
645         if ((p)->p_stops & (e)) {                                       \
646                 PROC_LOCK(p);                                           \
647                 stopevent((p), (e), (v));                               \
648                 PROC_UNLOCK(p);                                         \
649         }                                                               \
650 } while (0)
651 #define _STOPEVENT(p, e, v) do {                                        \
652         PROC_LOCK_ASSERT(p, MA_OWNED);                                  \
653         WITNESS_WARN(WARN_GIANTOK | WARN_SLEEPOK, &p->p_mtx.lock_object, \
654             "checking stopevent %d", (e));                              \
655         if ((p)->p_stops & (e))                                         \
656                 stopevent((p), (e), (v));                               \
657 } while (0)
658
659 /* Lock and unlock a process. */
660 #define PROC_LOCK(p)    mtx_lock(&(p)->p_mtx)
661 #define PROC_TRYLOCK(p) mtx_trylock(&(p)->p_mtx)
662 #define PROC_UNLOCK(p)  mtx_unlock(&(p)->p_mtx)
663 #define PROC_LOCKED(p)  mtx_owned(&(p)->p_mtx)
664 #define PROC_LOCK_ASSERT(p, type)       mtx_assert(&(p)->p_mtx, (type))
665
666 /* Lock and unlock a process group. */
667 #define PGRP_LOCK(pg)   mtx_lock(&(pg)->pg_mtx)
668 #define PGRP_UNLOCK(pg) mtx_unlock(&(pg)->pg_mtx)
669 #define PGRP_LOCKED(pg) mtx_owned(&(pg)->pg_mtx)
670 #define PGRP_LOCK_ASSERT(pg, type)      mtx_assert(&(pg)->pg_mtx, (type))
671
672 #define PGRP_LOCK_PGSIGNAL(pg) do {                                     \
673         if ((pg) != NULL)                                               \
674                 PGRP_LOCK(pg);                                          \
675 } while (0)
676 #define PGRP_UNLOCK_PGSIGNAL(pg) do {                                   \
677         if ((pg) != NULL)                                               \
678                 PGRP_UNLOCK(pg);                                        \
679 } while (0)
680
681 /* Lock and unlock a session. */
682 #define SESS_LOCK(s)    mtx_lock(&(s)->s_mtx)
683 #define SESS_UNLOCK(s)  mtx_unlock(&(s)->s_mtx)
684 #define SESS_LOCKED(s)  mtx_owned(&(s)->s_mtx)
685 #define SESS_LOCK_ASSERT(s, type)       mtx_assert(&(s)->s_mtx, (type))
686
687 /* Hold process U-area in memory, normally for ptrace/procfs work. */
688 #define PHOLD(p) do {                                                   \
689         PROC_LOCK(p);                                                   \
690         _PHOLD(p);                                                      \
691         PROC_UNLOCK(p);                                                 \
692 } while (0)
693 #define _PHOLD(p) do {                                                  \
694         PROC_LOCK_ASSERT((p), MA_OWNED);                                \
695         KASSERT(!((p)->p_flag & P_WEXIT) || (p) == curproc,             \
696             ("PHOLD of exiting process"));                              \
697         (p)->p_lock++;                                                  \
698         if (((p)->p_flag & P_INMEM) == 0)                               \
699                 faultin((p));                                           \
700 } while (0)
701 #define PROC_ASSERT_HELD(p) do {                                        \
702         KASSERT((p)->p_lock > 0, ("process not held"));                 \
703 } while (0)
704
705 #define PRELE(p) do {                                                   \
706         PROC_LOCK((p));                                                 \
707         _PRELE((p));                                                    \
708         PROC_UNLOCK((p));                                               \
709 } while (0)
710 #define _PRELE(p) do {                                                  \
711         PROC_LOCK_ASSERT((p), MA_OWNED);                                \
712         (--(p)->p_lock);                                                \
713         if (((p)->p_flag & P_WEXIT) && (p)->p_lock == 0)                \
714                 wakeup(&(p)->p_lock);                                   \
715 } while (0)
716 #define PROC_ASSERT_NOT_HELD(p) do {                                    \
717         KASSERT((p)->p_lock == 0, ("process held"));                    \
718 } while (0)
719
720 /* Check whether a thread is safe to be swapped out. */
721 #define thread_safetoswapout(td)        ((td)->td_flags & TDF_CANSWAP)
722
723 /* Control whether or not it is safe for curthread to sleep. */
724 #define THREAD_NO_SLEEPING() do {                                       \
725         KASSERT(!(curthread->td_pflags & TDP_NOSLEEPING),               \
726             ("nested no sleeping"));                                    \
727         curthread->td_pflags |= TDP_NOSLEEPING;                         \
728 } while (0)
729
730 #define THREAD_SLEEPING_OK() do {                                       \
731         KASSERT((curthread->td_pflags & TDP_NOSLEEPING),                \
732             ("nested sleeping ok"));                                    \
733         curthread->td_pflags &= ~TDP_NOSLEEPING;                        \
734 } while (0)
735
736 #define PIDHASH(pid)    (&pidhashtbl[(pid) & pidhash])
737 extern LIST_HEAD(pidhashhead, proc) *pidhashtbl;
738 extern u_long pidhash;
739
740 #define PGRPHASH(pgid)  (&pgrphashtbl[(pgid) & pgrphash])
741 extern LIST_HEAD(pgrphashhead, pgrp) *pgrphashtbl;
742 extern u_long pgrphash;
743
744 extern struct sx allproc_lock;
745 extern struct sx proctree_lock;
746 extern struct mtx ppeers_lock;
747 extern struct proc proc0;               /* Process slot for swapper. */
748 extern struct thread thread0;           /* Primary thread in proc0. */
749 extern struct vmspace vmspace0;         /* VM space for proc0. */
750 extern int hogticks;                    /* Limit on kernel cpu hogs. */
751 extern int lastpid;
752 extern int nprocs, maxproc;             /* Current and max number of procs. */
753 extern int maxprocperuid;               /* Max procs per uid. */
754 extern u_long ps_arg_cache_limit;
755
756 LIST_HEAD(proclist, proc);
757 TAILQ_HEAD(procqueue, proc);
758 TAILQ_HEAD(threadqueue, thread);
759 extern struct proclist allproc;         /* List of all processes. */
760 extern struct proclist zombproc;        /* List of zombie processes. */
761 extern struct proc *initproc, *pageproc; /* Process slots for init, pager. */
762
763 extern struct uma_zone *proc_zone;
764
765 struct  proc *pfind(pid_t);             /* Find process by id. */
766 struct  pgrp *pgfind(pid_t);            /* Find process group by id. */
767 struct  proc *zpfind(pid_t);            /* Find zombie process by id. */
768
769 void    ast(struct trapframe *framep);
770 struct  thread *choosethread(void);
771 int     cr_cansignal(struct ucred *cred, struct proc *proc, int signum);
772 int     enterpgrp(struct proc *p, pid_t pgid, struct pgrp *pgrp,
773             struct session *sess);
774 int     enterthispgrp(struct proc *p, struct pgrp *pgrp);
775 void    faultin(struct proc *p);
776 void    fixjobc(struct proc *p, struct pgrp *pgrp, int entering);
777 int     fork1(struct thread *, int, int, struct proc **);
778 void    fork_exit(void (*)(void *, struct trapframe *), void *,
779             struct trapframe *);
780 void    fork_return(struct thread *, struct trapframe *);
781 int     inferior(struct proc *p);
782 void    kick_proc0(void);
783 int     leavepgrp(struct proc *p);
784 int     maybe_preempt(struct thread *td);
785 void    mi_switch(int flags, struct thread *newtd);
786 int     p_candebug(struct thread *td, struct proc *p);
787 int     p_cansee(struct thread *td, struct proc *p);
788 int     p_cansched(struct thread *td, struct proc *p);
789 int     p_cansignal(struct thread *td, struct proc *p, int signum);
790 int     p_canwait(struct thread *td, struct proc *p);
791 struct  pargs *pargs_alloc(int len);
792 void    pargs_drop(struct pargs *pa);
793 void    pargs_free(struct pargs *pa);
794 void    pargs_hold(struct pargs *pa);
795 void    procinit(void);
796 void    proc_linkup0(struct proc *p, struct thread *td);
797 void    proc_linkup(struct proc *p, struct thread *td);
798 void    proc_reparent(struct proc *child, struct proc *newparent);
799 struct  pstats *pstats_alloc(void);
800 void    pstats_fork(struct pstats *src, struct pstats *dst);
801 void    pstats_free(struct pstats *ps);
802 int     securelevel_ge(struct ucred *cr, int level);
803 int     securelevel_gt(struct ucred *cr, int level);
804 void    sessrele(struct session *);
805 void    setrunnable(struct thread *);
806 void    setsugid(struct proc *p);
807 int     sigonstack(size_t sp);
808 void    sleepinit(void);
809 void    stopevent(struct proc *, u_int, u_int);
810 void    threadinit(void);
811 void    cpu_idle(void);
812 extern  void (*cpu_idle_hook)(void);    /* Hook to machdep CPU idler. */
813 void    cpu_switch(struct thread *, struct thread *, struct mtx *);
814 void    cpu_throw(struct thread *, struct thread *) __dead2;
815 void    unsleep(struct thread *);
816 void    userret(struct thread *, struct trapframe *);
817
818 void    cpu_exit(struct thread *);
819 void    exit1(struct thread *, int) __dead2;
820 void    cpu_fork(struct thread *, struct proc *, struct thread *, int);
821 void    cpu_set_fork_handler(struct thread *, void (*)(void *), void *);
822
823 void    cpu_set_upcall(struct thread *td, struct thread *td0);
824 void    cpu_set_upcall_kse(struct thread *, void (*)(void *), void *,
825             stack_t *);
826 int     cpu_set_user_tls(struct thread *, void *tls_base);
827 void    cpu_thread_alloc(struct thread *);
828 void    cpu_thread_clean(struct thread *);
829 void    cpu_thread_exit(struct thread *);
830 void    cpu_thread_free(struct thread *);
831 void    cpu_thread_swapin(struct thread *);
832 void    cpu_thread_swapout(struct thread *);
833 struct  thread *thread_alloc(void);
834 void    thread_exit(void) __dead2;
835 void    thread_free(struct thread *td);
836 void    thread_link(struct thread *td, struct proc *p);
837 void    thread_reap(void);
838 int     thread_single(int how);
839 void    thread_single_end(void);
840 void    thread_stash(struct thread *td);
841 void    thread_stopped(struct proc *p);
842 void    childproc_stopped(struct proc *child, int reason);
843 void    childproc_continued(struct proc *child);
844 void    childproc_exited(struct proc *child);
845 int     thread_suspend_check(int how);
846 void    thread_suspend_switch(struct thread *);
847 void    thread_suspend_one(struct thread *td);
848 void    thread_unlink(struct thread *td);
849 void    thread_unsuspend(struct proc *p);
850 void    thread_unsuspend_one(struct thread *td);
851 void    thread_unthread(struct thread *td);
852 void    thread_wait(struct proc *p);
853 struct thread   *thread_find(struct proc *p, lwpid_t tid);
854 void    thr_exit1(void);
855
856 #endif  /* _KERNEL */
857
858 #endif  /* !_SYS_PROC_H_ */