xref: /NextBSD/lib/libprocstat/libprocstat.h (revision 33da5adc555b3bc29986eeadca03829e4ad06b1e)
1 /*-
2  * Copyright (c) 2009 Stanislav Sedov <stas@FreeBSD.org>
3  * 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  *
14  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #ifndef _LIBPROCSTAT_H_
30 #define	_LIBPROCSTAT_H_
31 
32 /*
33  * XXX: sys/elf.h conflicts with zfs_context.h. Workaround this by not
34  * including conflicting parts when building zfs code.
35  */
36 #ifndef ZFS
37 #include <sys/elf.h>
38 #endif
39 #include <sys/caprights.h>
40 
41 /*
42  * Vnode types.
43  */
44 #define	PS_FST_VTYPE_VNON	1
45 #define	PS_FST_VTYPE_VREG	2
46 #define	PS_FST_VTYPE_VDIR	3
47 #define	PS_FST_VTYPE_VBLK	4
48 #define	PS_FST_VTYPE_VCHR	5
49 #define	PS_FST_VTYPE_VLNK	6
50 #define	PS_FST_VTYPE_VSOCK	7
51 #define	PS_FST_VTYPE_VFIFO	8
52 #define	PS_FST_VTYPE_VBAD	9
53 #define	PS_FST_VTYPE_UNKNOWN	255
54 
55 /*
56  * Descriptor types.
57  */
58 #define	PS_FST_TYPE_VNODE	1
59 #define	PS_FST_TYPE_FIFO	2
60 #define	PS_FST_TYPE_SOCKET	3
61 #define	PS_FST_TYPE_PIPE	4
62 #define	PS_FST_TYPE_PTS		5
63 #define	PS_FST_TYPE_KQUEUE	6
64 #define	PS_FST_TYPE_CRYPTO	7
65 #define	PS_FST_TYPE_MQUEUE	8
66 #define	PS_FST_TYPE_SHM		9
67 #define	PS_FST_TYPE_SEM		10
68 #define	PS_FST_TYPE_UNKNOWN	11
69 #define	PS_FST_TYPE_NONE	12
70 #define	PS_FST_TYPE_PORT	13
71 #define	PS_FST_TYPE_PORTSET	14
72 
73 /*
74  * Special descriptor numbers.
75  */
76 #define	PS_FST_UFLAG_RDIR	0x0001
77 #define	PS_FST_UFLAG_CDIR	0x0002
78 #define	PS_FST_UFLAG_JAIL	0x0004
79 #define	PS_FST_UFLAG_TRACE	0x0008
80 #define	PS_FST_UFLAG_TEXT	0x0010
81 #define	PS_FST_UFLAG_MMAP	0x0020
82 #define	PS_FST_UFLAG_CTTY	0x0040
83 
84 /*
85  * Descriptor flags.
86  */
87 #define PS_FST_FFLAG_READ	0x0001
88 #define PS_FST_FFLAG_WRITE	0x0002
89 #define	PS_FST_FFLAG_NONBLOCK	0x0004
90 #define	PS_FST_FFLAG_APPEND	0x0008
91 #define	PS_FST_FFLAG_SHLOCK	0x0010
92 #define	PS_FST_FFLAG_EXLOCK	0x0020
93 #define	PS_FST_FFLAG_ASYNC	0x0040
94 #define	PS_FST_FFLAG_SYNC	0x0080
95 #define	PS_FST_FFLAG_NOFOLLOW	0x0100
96 #define	PS_FST_FFLAG_CREAT	0x0200
97 #define	PS_FST_FFLAG_TRUNC	0x0400
98 #define	PS_FST_FFLAG_EXCL	0x0800
99 #define	PS_FST_FFLAG_DIRECT	0x1000
100 #define	PS_FST_FFLAG_EXEC	0x2000
101 #define	PS_FST_FFLAG_HASLOCK	0x4000
102 
103 struct kinfo_kstack;
104 struct kinfo_vmentry;
105 struct procstat;
106 struct rlimit;
107 struct filestat {
108 	int	fs_type;	/* Descriptor type. */
109 	int	fs_flags;	/* filestat specific flags. */
110 	int	fs_fflags;	/* Descriptor access flags. */
111 	int	fs_uflags;	/* How this file is used. */
112 	int	fs_fd;		/* File descriptor number. */
113 	int	fs_ref_count;	/* Reference count. */
114 	off_t	fs_offset;	/* Seek location. */
115 	void	*fs_typedep;	/* Type dependent data. */
116 	char	*fs_path;
117 	STAILQ_ENTRY(filestat)	next;
118 	cap_rights_t	fs_cap_rights;	/* Capability rights, if flag set. */
119 };
120 struct vnstat {
121 	uint64_t	vn_fileid;
122 	uint64_t	vn_size;
123 	char		*vn_mntdir;
124 	uint32_t	vn_dev;
125 	uint32_t	vn_fsid;
126 	int		vn_type;
127 	uint16_t	vn_mode;
128 	char		vn_devname[SPECNAMELEN + 1];
129 };
130 struct ptsstat {
131 	uint32_t	dev;
132 	char		devname[SPECNAMELEN + 1];
133 };
134 struct pipestat {
135 	size_t		buffer_cnt;
136 	uint64_t	addr;
137 	uint64_t	peer;
138 };
139 struct semstat {
140 	uint32_t	value;
141 	uint16_t	mode;
142 };
143 struct shmstat {
144 	uint64_t	size;
145 	uint16_t	mode;
146 };
147 struct sockstat {
148 	uint64_t	inp_ppcb;
149 	uint64_t	so_addr;
150 	uint64_t	so_pcb;
151 	uint64_t	unp_conn;
152 	int		dom_family;
153 	int		proto;
154 	int		so_rcv_sb_state;
155 	int		so_snd_sb_state;
156 	struct sockaddr_storage	sa_local;	/* Socket address. */
157 	struct sockaddr_storage	sa_peer;	/* Peer address. */
158 	int		type;
159 	char		dname[32];
160 };
161 
162 STAILQ_HEAD(filestat_list, filestat);
163 
164 __BEGIN_DECLS
165 void	procstat_close(struct procstat *procstat);
166 void	procstat_freeargv(struct procstat *procstat);
167 #ifndef ZFS
168 void	procstat_freeauxv(struct procstat *procstat, Elf_Auxinfo *auxv);
169 #endif
170 void	procstat_freeenvv(struct procstat *procstat);
171 void	procstat_freegroups(struct procstat *procstat, gid_t *groups);
172 void	procstat_freekstack(struct procstat *procstat,
173     struct kinfo_kstack *kkstp);
174 void	procstat_freeprocs(struct procstat *procstat, struct kinfo_proc *p);
175 void	procstat_freefiles(struct procstat *procstat,
176     struct filestat_list *head);
177 void	procstat_freevmmap(struct procstat *procstat,
178     struct kinfo_vmentry *vmmap);
179 struct filestat_list	*procstat_getfiles(struct procstat *procstat,
180     struct kinfo_proc *kp, int mmapped);
181 struct kinfo_proc	*procstat_getprocs(struct procstat *procstat,
182     int what, int arg, unsigned int *count);
183 int	procstat_get_pipe_info(struct procstat *procstat, struct filestat *fst,
184     struct pipestat *pipe, char *errbuf);
185 int	procstat_get_pts_info(struct procstat *procstat, struct filestat *fst,
186     struct ptsstat *pts, char *errbuf);
187 int	procstat_get_sem_info(struct procstat *procstat, struct filestat *fst,
188     struct semstat *sem, char *errbuf);
189 int	procstat_get_shm_info(struct procstat *procstat, struct filestat *fst,
190     struct shmstat *shm, char *errbuf);
191 int	procstat_get_socket_info(struct procstat *procstat, struct filestat *fst,
192     struct sockstat *sock, char *errbuf);
193 int	procstat_get_vnode_info(struct procstat *procstat, struct filestat *fst,
194     struct vnstat *vn, char *errbuf);
195 char	**procstat_getargv(struct procstat *procstat, struct kinfo_proc *p,
196     size_t nchr);
197 #ifndef ZFS
198 Elf_Auxinfo	*procstat_getauxv(struct procstat *procstat,
199     struct kinfo_proc *kp, unsigned int *cntp);
200 #endif
201 char	**procstat_getenvv(struct procstat *procstat, struct kinfo_proc *p,
202     size_t nchr);
203 gid_t	*procstat_getgroups(struct procstat *procstat, struct kinfo_proc *kp,
204     unsigned int *count);
205 struct kinfo_kstack	*procstat_getkstack(struct procstat *procstat,
206     struct kinfo_proc *kp, unsigned int *count);
207 int	procstat_getosrel(struct procstat *procstat, struct kinfo_proc *kp,
208     int *osrelp);
209 int	procstat_getpathname(struct procstat *procstat, struct kinfo_proc *kp,
210     char *pathname, size_t maxlen);
211 int	procstat_getrlimit(struct procstat *procstat, struct kinfo_proc *kp,
212     int which, struct rlimit* rlimit);
213 int	procstat_getumask(struct procstat *procstat, struct kinfo_proc *kp,
214     unsigned short* umask);
215 struct kinfo_vmentry	*procstat_getvmmap(struct procstat *procstat,
216     struct kinfo_proc *kp, unsigned int *count);
217 struct procstat	*procstat_open_core(const char *filename);
218 struct procstat	*procstat_open_sysctl(void);
219 struct procstat	*procstat_open_kvm(const char *nlistf, const char *memf);
220 __END_DECLS
221 
222 #endif	/* !_LIBPROCSTAT_H_ */
223