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