xref: /dragonfly/sys/sys/kinfo.h (revision 8a7bdfea)
1 /*
2  * Copyright (c) 2004 The DragonFly Project.  All rights reserved.
3  *
4  * This code is derived from software contributed to The DragonFly Project
5  * by Joerg Sonnenberger <joerg@bec.de>.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in
15  *    the documentation and/or other materials provided with the
16  *    distribution.
17  * 3. Neither the name of The DragonFly Project nor the names of its
18  *    contributors may be used to endorse or promote products derived
19  *    from this software without specific, prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  * $DragonFly: src/sys/sys/kinfo.h,v 1.13 2007/02/18 16:17:09 corecode Exp $
35  */
36 
37 #ifndef _SYS_KINFO_H_
38 #define _SYS_KINFO_H_
39 
40 #ifndef _SYS_TYPES_H_
41 #include <sys/types.h>
42 #endif
43 #ifndef _SYS_PARAM_H_
44 #include <sys/param.h>
45 #endif
46 #include <sys/resource.h>
47 #include <sys/rtprio.h>
48 #ifndef _KERNEL_STRUCTURES
49 #define _KERNEL_STRUCTURES
50 #endif
51 #include <sys/proc.h>
52 
53 struct kinfo_file {
54 	size_t	 f_size;	/* size of struct kinfo_file */
55 	pid_t	 f_pid;		/* owning process */
56 	uid_t	 f_uid;		/* effective uid of owning process */
57 	int	 f_fd;		/* descriptor number */
58 	void	*f_file;	/* address of struct file */
59 	short	 f_type;	/* descriptor type */
60 	int	 f_count;	/* reference count */
61 	int	 f_msgcount;	/* references from message queue */
62 	off_t	 f_offset;	/* file offset */
63 	void	*f_data;	/* file descriptor specific data */
64 	u_int	 f_flag;	/* flags (see fcntl.h) */
65 };
66 
67 /*
68  * CPU time statistics
69  */
70 struct kinfo_cputime {
71 	uint64_t	cp_user;
72 	uint64_t	cp_nice;
73 	uint64_t	cp_sys;
74 	uint64_t	cp_intr;
75 	uint64_t	cp_idle;
76 };
77 
78 /*
79  * CPU system/interrupt program counter sampler
80  */
81 #define PCTRACK_ARYSIZE	32	/* must be a power of 2 */
82 #define PCTRACK_ARYMASK	(PCTRACK_ARYSIZE - 1)
83 
84 struct kinfo_pcheader {
85 	int		pc_ntrack;	/* number of tracks per cpu (2) */
86 	int		pc_arysize;	/* size of storage array (32) */
87 };
88 
89 struct kinfo_pctrack {
90 	int		pc_index;
91 	void		*pc_array[PCTRACK_ARYSIZE];
92 };
93 
94 #define PCTRACK_SYS	0
95 #define PCTRACK_INT	1
96 #define PCTRACK_SIZE	2
97 
98 struct kinfo_clockinfo {
99 	int	ci_hz;		/* clock frequency */
100 	int	ci_tick;	/* micro-seconds per hz tick */
101 	int	ci_tickadj;	/* clock skew rate for adjtime() */
102 	int	ci_stathz;	/* statistics clock frequency */
103 	int	ci_profhz;	/* profiling clock frequency */
104 };
105 
106 /*
107  * Structure definition for the lwp-specific data in struct kinfo_proc.
108  */
109 struct kinfo_lwp {
110 	pid_t		kl_pid;		/* PID of our associated proc */
111 	lwpid_t		kl_tid;		/* thread id */
112 
113 	int		kl_flags;	/* LWP_ flags */
114 	enum lwpstat	kl_stat;	/* LS* lwp status */
115 	int		kl_lock;	/* lwp lock (prevent destruct) count */
116 	int		kl_tdflags;	/* thread flags */
117 	int		kl_mpcount;	/* MP lock held count */
118 	int		kl_prio;	/* scheduling priority */
119 	int		kl_tdprio;	/* lwkt sched priority */
120 	struct rtprio	kl_rtprio;	/* real-time scheduling prio */
121 
122 	/* accounting */
123 	uint64_t	kl_uticks;	/* time accounting */
124 	uint64_t	kl_sticks;
125 	uint64_t	kl_iticks;
126 	uint64_t	kl_cpticks;	/* sched quantums used */
127 	u_int		kl_pctcpu;	/* percentage cputime */
128 	u_int		kl_slptime;	/* time since last blocked */
129 	int		kl_origcpu;	/* originally scheduled on cpu */
130 	int		kl_estcpu;
131 	int		kl_cpuid;	/* CPU this lwp was last scheduled on */
132 
133 	struct rusage	kl_ru;		/* resource usage stats */
134 
135 	sigset_t	kl_siglist;	/* pending signals */
136 	sigset_t	kl_sigmask;	/* masked signals */
137 #define WMESGLEN 7
138 	uintptr_t	kl_wchan;	/* waiting channel */
139 	char		kl_wmesg[WMESGLEN+1];	/* waiting message */
140 };
141 
142 /*
143  * KERN_PROC subtype ops return arrays of normalized proc structures:
144  */
145 struct kinfo_proc {
146 	uintptr_t	kp_paddr;	/* address of this proc */
147 
148 	/* proc information */
149 	int		kp_flags;
150 	enum procstat	kp_stat;
151 	int		kp_lock;
152 	int		kp_acflag;	/* accounting flags */
153 	int		kp_traceflag;
154 
155 	uintptr_t	kp_fd;		/* address of the proc's files */
156 
157 	sigset_t	kp_siglist;
158 	sigset_t	kp_sigignore;
159 	sigset_t	kp_sigcatch;
160 	int		kp_sigflag;	/* from ps_flag */
161 	struct timeval	kp_start;
162 
163 	char		kp_comm[MAXCOMLEN+1];
164 
165 	/* cred information */
166 	uid_t		kp_uid;
167 	short		kp_ngroups;
168 	gid_t		kp_groups[NGROUPS];
169 	uid_t		kp_ruid;
170 	uid_t		kp_svuid;
171 	gid_t		kp_rgid;
172 	gid_t		kp_svgid;
173 
174 	pid_t		kp_pid;	/* process id */
175 	pid_t		kp_ppid;	/* parent process id */
176 	pid_t		kp_pgid;	/* process group id */
177 	int		kp_jobc;	/* job control counter */
178 	pid_t		kp_sid;	/* session id */
179 	char		kp_login[roundup(MAXLOGNAME, sizeof(long))];	/* setlogin() name */
180 	dev_t		kp_tdev;	/* controlling tty dev */
181 	pid_t		kp_tpgid;	/* tty process group id */
182 	pid_t		kp_tsid;	/* tty session id */
183 
184 	u_short		kp_exitstat;	/* exit status information */
185 	int		kp_nthreads;
186 	int		kp_nice;
187 	unsigned int	kp_swtime;
188 
189 	vm_size_t	kp_vm_map_size;	/* vmmap virtual size */
190 	segsz_t		kp_vm_rssize;		/* resident set size */
191 	segsz_t		kp_vm_swrss;		/* rss before last swap */
192 	segsz_t		kp_vm_tsize;		/* text size */
193 	segsz_t		kp_vm_dsize;		/* data size */
194 	segsz_t		kp_vm_ssize;		/* stack size */
195 
196 	int		kp_jailid;
197 
198 	struct rusage	kp_ru;
199 	struct rusage	kp_cru;
200 
201 	int		kp_auxflags;	/* generated flags */
202 #define KI_CTTY	1
203 #define KI_SLEADER	2
204 
205 	struct kinfo_lwp kp_lwp;
206 
207 	int		kp_spare[4];
208 };
209 
210 struct proc;
211 struct lwp;
212 struct thread;
213 
214 void fill_kinfo_proc(struct proc *, struct kinfo_proc *);
215 void fill_kinfo_lwp(struct lwp *, struct kinfo_lwp *);
216 void fill_kinfo_proc_kthread(struct thread *, struct kinfo_proc *);
217 
218 #define KINFO_NEXT(kp)	((union kinfo *)((uintptr_t)kp + kp->gen.len))
219 #define KINFO_END(kp)	(kp->gen.type == KINFO_TYPE_END)
220 
221 #if defined(_KERNEL)
222 #ifdef SMP
223 #define cpu_time	cputime_percpu[mycpuid]
224 #else
225 #define cpu_time	cputime_percpu[0]
226 #endif
227 #endif
228 
229 #if defined(_KERNEL)
230 extern struct kinfo_cputime cputime_percpu[MAXCPU];
231 #endif
232 
233 #endif /* !_SYS_KINFO_H_ */
234