xref: /freebsd/lib/libprocstat/libprocstat.h (revision ef36b3f75658d201edb495068db5e1be49593de5)
1 /*-
2  * Copyright (c) 2009 Stanislav Sedov <stas@FreeBSD.org>
3  * Copyright (c) 2017 Dell EMC
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  *
27  * $FreeBSD$
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 #define	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 
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 ptrace_lwpinfo;
107 struct rlimit;
108 struct filestat {
109 	int	fs_type;	/* Descriptor type. */
110 	int	fs_flags;	/* filestat specific flags. */
111 	int	fs_fflags;	/* Descriptor access flags. */
112 	int	fs_uflags;	/* How this file is used. */
113 	int	fs_fd;		/* File descriptor number. */
114 	int	fs_ref_count;	/* Reference count. */
115 	off_t	fs_offset;	/* Seek location. */
116 	void	*fs_typedep;	/* Type dependent data. */
117 	char	*fs_path;
118 	STAILQ_ENTRY(filestat)	next;
119 	cap_rights_t	fs_cap_rights;	/* Capability rights, if flag set. */
120 };
121 struct vnstat {
122 	uint64_t	vn_fileid;
123 	uint64_t	vn_size;
124 	uint64_t	vn_dev;
125 	uint64_t	vn_fsid;
126 	char		*vn_mntdir;
127 	int		vn_type;
128 	uint16_t	vn_mode;
129 	char		vn_devname[SPECNAMELEN + 1];
130 };
131 struct ptsstat {
132 	uint64_t	dev;
133 	char		devname[SPECNAMELEN + 1];
134 };
135 struct pipestat {
136 	size_t		buffer_cnt;
137 	uint64_t	addr;
138 	uint64_t	peer;
139 };
140 struct semstat {
141 	uint32_t	value;
142 	uint16_t	mode;
143 };
144 struct shmstat {
145 	uint64_t	size;
146 	uint16_t	mode;
147 };
148 struct sockstat {
149 	uint64_t	inp_ppcb;
150 	uint64_t	so_addr;
151 	uint64_t	so_pcb;
152 	uint64_t	unp_conn;
153 	int		dom_family;
154 	int		proto;
155 	int		so_rcv_sb_state;
156 	int		so_snd_sb_state;
157 	struct sockaddr_storage	sa_local;	/* Socket address. */
158 	struct sockaddr_storage	sa_peer;	/* Peer address. */
159 	int		type;
160 	char		dname[32];
161 	unsigned int	sendq;
162 	unsigned int	recvq;
163 };
164 
165 STAILQ_HEAD(filestat_list, filestat);
166 
167 __BEGIN_DECLS
168 void	procstat_close(struct procstat *procstat);
169 void	procstat_freeargv(struct procstat *procstat);
170 #ifndef ZFS
171 void	procstat_freeauxv(struct procstat *procstat, Elf_Auxinfo *auxv);
172 #endif
173 void	procstat_freeenvv(struct procstat *procstat);
174 void	procstat_freegroups(struct procstat *procstat, gid_t *groups);
175 void	procstat_freekstack(struct procstat *procstat,
176     struct kinfo_kstack *kkstp);
177 void	procstat_freeprocs(struct procstat *procstat, struct kinfo_proc *p);
178 void	procstat_freefiles(struct procstat *procstat,
179     struct filestat_list *head);
180 void	procstat_freeptlwpinfo(struct procstat *procstat,
181     struct ptrace_lwpinfo *pl);
182 void	procstat_freevmmap(struct procstat *procstat,
183     struct kinfo_vmentry *vmmap);
184 struct filestat_list	*procstat_getfiles(struct procstat *procstat,
185     struct kinfo_proc *kp, int mmapped);
186 struct kinfo_proc	*procstat_getprocs(struct procstat *procstat,
187     int what, int arg, unsigned int *count);
188 int	procstat_get_pipe_info(struct procstat *procstat, struct filestat *fst,
189     struct pipestat *pipe, char *errbuf);
190 int	procstat_get_pts_info(struct procstat *procstat, struct filestat *fst,
191     struct ptsstat *pts, char *errbuf);
192 int	procstat_get_sem_info(struct procstat *procstat, struct filestat *fst,
193     struct semstat *sem, char *errbuf);
194 int	procstat_get_shm_info(struct procstat *procstat, struct filestat *fst,
195     struct shmstat *shm, char *errbuf);
196 int	procstat_get_socket_info(struct procstat *procstat, struct filestat *fst,
197     struct sockstat *sock, char *errbuf);
198 int	procstat_get_vnode_info(struct procstat *procstat, struct filestat *fst,
199     struct vnstat *vn, char *errbuf);
200 char	**procstat_getargv(struct procstat *procstat, struct kinfo_proc *p,
201     size_t nchr);
202 #ifndef ZFS
203 Elf_Auxinfo	*procstat_getauxv(struct procstat *procstat,
204     struct kinfo_proc *kp, unsigned int *cntp);
205 #endif
206 struct ptrace_lwpinfo	*procstat_getptlwpinfo(struct procstat *procstat,
207     unsigned int *cntp);
208 char	**procstat_getenvv(struct procstat *procstat, struct kinfo_proc *p,
209     size_t nchr);
210 gid_t	*procstat_getgroups(struct procstat *procstat, struct kinfo_proc *kp,
211     unsigned int *count);
212 struct kinfo_kstack	*procstat_getkstack(struct procstat *procstat,
213     struct kinfo_proc *kp, unsigned int *count);
214 int	procstat_getosrel(struct procstat *procstat, struct kinfo_proc *kp,
215     int *osrelp);
216 int	procstat_getpathname(struct procstat *procstat, struct kinfo_proc *kp,
217     char *pathname, size_t maxlen);
218 int	procstat_getrlimit(struct procstat *procstat, struct kinfo_proc *kp,
219     int which, struct rlimit* rlimit);
220 int	procstat_getumask(struct procstat *procstat, struct kinfo_proc *kp,
221     unsigned short* umask);
222 struct kinfo_vmentry	*procstat_getvmmap(struct procstat *procstat,
223     struct kinfo_proc *kp, unsigned int *count);
224 struct procstat	*procstat_open_core(const char *filename);
225 struct procstat	*procstat_open_sysctl(void);
226 struct procstat	*procstat_open_kvm(const char *nlistf, const char *memf);
227 __END_DECLS
228 
229 #endif	/* !_LIBPROCSTAT_H_ */
230