user.h revision 83366
1/*
2 * Copyright (c) 1982, 1986, 1989, 1991, 1993
3 *	The Regents of the University of California.  All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 *    must display the following acknowledgement:
15 *	This product includes software developed by the University of
16 *	California, Berkeley and its contributors.
17 * 4. Neither the name of the University nor the names of its contributors
18 *    may be used to endorse or promote products derived from this software
19 *    without specific prior written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * SUCH DAMAGE.
32 *
33 *	@(#)user.h	8.2 (Berkeley) 9/23/93
34 * $FreeBSD: head/sys/sys/user.h 83366 2001-09-12 08:38:13Z julian $
35 */
36
37#ifndef _SYS_USER_H_
38#define _SYS_USER_H_
39
40#include <machine/pcb.h>
41#ifndef _KERNEL
42/* stuff that *used* to be included by user.h, or is now needed */
43#include <sys/errno.h>
44#include <sys/time.h>
45#include <sys/resource.h>
46#include <sys/ucred.h>
47#include <sys/uio.h>
48#include <sys/_lock.h>
49#include <sys/_mutex.h>
50#include <sys/proc.h>
51#include <vm/vm.h>		/* XXX */
52#include <vm/vm_param.h>	/* XXX */
53#include <vm/pmap.h>		/* XXX */
54#include <vm/vm_map.h>		/* XXX */
55#endif /* !_KERNEL */
56#ifndef _SYS_RESOURCEVAR_H_
57#include <sys/resourcevar.h>
58#endif
59#ifndef _SYS_SIGNALVAR_H_
60#include <sys/signalvar.h>
61#endif
62
63/*
64 * KERN_PROC subtype ops return arrays of selected proc structure entries:
65 *
66 * When adding new fields to this structure, ALWAYS add them at the end
67 * and decrease the size of the spare field by the amount of space that
68 * you are adding.  Byte aligned data should be added to the ki_sparestring
69 * space; other entries should be added to the ki_spare space. Always
70 * verify that sizeof(struct kinfo_proc) == KINFO_PROC_SIZE when you are
71 * done. If you change the size of this structure, many programs will stop
72 * working! Once you have added the new field, you will need to add code
73 * to initialize it in two places: kern/kern_proc.c in the function
74 * fill_kinfo_proc and in lib/libkvm/kvm_proc.c in the function kvm_proclist.
75 */
76#ifdef	__alpha__
77#define	KINFO_PROC_SIZE	912		/* the correct size for kinfo_proc */
78#endif
79#ifdef	__ia64__
80#define KINFO_PROC_SIZE 888
81#endif
82#ifdef	__i386__
83#define	KINFO_PROC_SIZE	648		/* the correct size for kinfo_proc */
84#endif
85#ifdef  __powerpc__
86#define	KINFO_PROC_SIZE	656
87#endif
88#ifdef	__sparc64__
89#define	KINFO_PROC_SIZE 888
90#endif
91#ifndef	KINFO_PROC_SIZE
92#error	"Unknown architecture"
93#endif
94#define	WMESGLEN	8		/* size of returned wchan message */
95#define	MTXNAMELEN	8		/* size of returned mutex name */
96#define	OCOMMLEN	16		/* size of returned ki_ocomm name */
97#define	COMMLEN		19		/* size of returned ki_comm name */
98#define	KI_NGROUPS	16		/* number of groups in ki_groups */
99#define	LOGNAMELEN	17		/* size of returned ki_login */
100
101struct kinfo_proc {
102	int	ki_structsize;		/* size of this structure */
103	int	ki_layout;		/* reserved: layout identifier */
104	struct	pargs *ki_args;		/* address of command arguments */
105	struct	proc *ki_paddr;		/* address of proc */
106	struct	user *ki_addr;		/* kernel virtual addr of u-area */
107	struct	vnode *ki_tracep;	/* pointer to trace file */
108	struct	vnode *ki_textvp;	/* pointer to executable file */
109	struct	filedesc *ki_fd;	/* pointer to open file info */
110	struct	vmspace *ki_vmspace;	/* pointer to kernel vmspace struct */
111	void	*ki_wchan;		/* sleep address */
112	pid_t	ki_pid;			/* Process identifier */
113	pid_t	ki_ppid;		/* parent process id */
114	pid_t	ki_pgid;		/* process group id */
115	pid_t	ki_tpgid;		/* tty process group id */
116	pid_t	ki_sid;			/* Process session ID */
117	pid_t	ki_tsid;		/* Terminal session ID */
118	short	ki_jobc;		/* job control counter */
119	udev_t	ki_tdev;		/* controlling tty dev */
120	sigset_t ki_siglist;		/* Signals arrived but not delivered */
121	sigset_t ki_sigmask;		/* Current signal mask */
122	sigset_t ki_sigignore;		/* Signals being ignored */
123	sigset_t ki_sigcatch;		/* Signals being caught by user */
124	uid_t	ki_uid;			/* effective user id */
125	uid_t	ki_ruid;		/* Real user id */
126	uid_t	ki_svuid;		/* Saved effective user id */
127	gid_t	ki_rgid;		/* Real group id */
128	gid_t	ki_svgid;		/* Saved effective group id */
129	short	ki_ngroups;		/* number of groups */
130	gid_t	ki_groups[KI_NGROUPS];	/* groups */
131	vm_size_t ki_size;		/* virtual size */
132	segsz_t ki_rssize;		/* current resident set size in pages */
133	segsz_t ki_swrss;		/* resident set size before last swap */
134	segsz_t ki_tsize;		/* text size (pages) XXX */
135	segsz_t ki_dsize;		/* data size (pages) XXX */
136	segsz_t ki_ssize;		/* stack size (pages) */
137	u_short	ki_xstat;		/* Exit status for wait & stop signal */
138	u_short	ki_acflag;		/* Accounting flags */
139	fixpt_t	ki_pctcpu;	 	/* %cpu for process during ki_swtime */
140	u_int	ki_estcpu;	 	/* Time averaged value of ki_cpticks */
141	u_int	ki_slptime;	 	/* Time since last blocked */
142	u_int	ki_swtime;	 	/* Time swapped in or out */
143	u_int64_t ki_runtime;		/* Real time in microsec */
144	struct	timeval ki_start;	/* starting time */
145	struct	timeval ki_childtime;	/* time used by process children */
146	long	ki_flag;		/* P_* flags */
147	long	ki_kiflag;		/* KI_* flags (below) */
148	int	ki_traceflag;		/* Kernel trace points */
149	char	ki_stat;		/* S* process status */
150	char	ki_nice;		/* Process "nice" value */
151	char	ki_lock;		/* Process lock (prevent swap) count */
152	char	ki_rqindex;		/* Run queue index */
153	u_char	ki_oncpu;		/* Which cpu we are on */
154	u_char	ki_lastcpu;		/* Last cpu we were on */
155	char	ki_ocomm[OCOMMLEN+1];	/* command name */
156	char	ki_wmesg[WMESGLEN+1];	/* wchan message */
157	char	ki_login[LOGNAMELEN+1];	/* setlogin name */
158	char	ki_mtxname[MTXNAMELEN+1]; /* mutex name */
159	char	ki_comm[COMMLEN+1];	/* command name */
160	char	ki_sparestrings[85];	/* spare string space */
161	struct	rusage ki_rusage;	/* process rusage statistics */
162	long	ki_sflag;		/* PS_* flags */
163	struct	priority ki_pri;	/* process priority */
164	long	ki_tdflags;		/* XXXKSE kthread flag */
165	struct	pcb *ki_pcb;		/* kernel virtual addr of pcb */
166	void	*ki_kstack;		/* kernel virtual addr of stack */
167	long	ki_spare[22];		/* spare constants */
168};
169void fill_kinfo_proc __P((struct proc *, struct kinfo_proc *));
170
171/* ki_sessflag values */
172#define	KI_CTTY		0x00000001	/* controlling tty vnode active */
173#define	KI_SLEADER	0x00000002	/* session leader */
174#define	KI_MTXBLOCK	0x00000004	/* proc blocked on mutex ki_mtxname */
175
176/*
177 * Per process structure containing data that isn't needed in core
178 * when the process isn't running (esp. when swapped out).
179 * This structure may or may not be at the same kernel address
180 * in all processes.
181 */
182
183struct	user {
184	struct	sigacts u_sigacts;	/* *p_sigacts */
185	struct	pstats u_stats;		/* *p_stats */
186	/*
187	 * Remaining fields only for
188	 * core dump and/or ptrace--
189	 * not valid at other times!
190	 */
191	struct	kinfo_proc u_kproc;	/* eproc */
192	struct	md_coredump u_md;	/* glop */
193};
194
195#endif
196