xref: /freebsd/lib/libprocstat/libprocstat.h (revision 328034527290b6f563f4cda3c60c0cb8b1b5beb5)
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 
40 /*
41  * Vnode types.
42  */
43 #define	PS_FST_VTYPE_VNON	1
44 #define	PS_FST_VTYPE_VREG	2
45 #define	PS_FST_VTYPE_VDIR	3
46 #define	PS_FST_VTYPE_VBLK	4
47 #define	PS_FST_VTYPE_VCHR	5
48 #define	PS_FST_VTYPE_VLNK	6
49 #define	PS_FST_VTYPE_VSOCK	7
50 #define	PS_FST_VTYPE_VFIFO	8
51 #define	PS_FST_VTYPE_VBAD	9
52 #define	PS_FST_VTYPE_UNKNOWN	255
53 
54 /*
55  * Descriptor types.
56  */
57 #define	PS_FST_TYPE_VNODE	1
58 #define	PS_FST_TYPE_FIFO	2
59 #define	PS_FST_TYPE_SOCKET	3
60 #define	PS_FST_TYPE_PIPE	4
61 #define	PS_FST_TYPE_PTS		5
62 #define	PS_FST_TYPE_KQUEUE	6
63 #define	PS_FST_TYPE_CRYPTO	7
64 #define	PS_FST_TYPE_MQUEUE	8
65 #define	PS_FST_TYPE_SHM		9
66 #define	PS_FST_TYPE_SEM		10
67 #define	PS_FST_TYPE_UNKNOWN	11
68 #define	PS_FST_TYPE_NONE	12
69 
70 /*
71  * Special descriptor numbers.
72  */
73 #define	PS_FST_UFLAG_RDIR	0x0001
74 #define	PS_FST_UFLAG_CDIR	0x0002
75 #define	PS_FST_UFLAG_JAIL	0x0004
76 #define	PS_FST_UFLAG_TRACE	0x0008
77 #define	PS_FST_UFLAG_TEXT	0x0010
78 #define	PS_FST_UFLAG_MMAP	0x0020
79 #define	PS_FST_UFLAG_CTTY	0x0040
80 
81 /*
82  * Descriptor flags.
83  */
84 #define PS_FST_FFLAG_READ	0x0001
85 #define PS_FST_FFLAG_WRITE	0x0002
86 #define	PS_FST_FFLAG_NONBLOCK	0x0004
87 #define	PS_FST_FFLAG_APPEND	0x0008
88 #define	PS_FST_FFLAG_SHLOCK	0x0010
89 #define	PS_FST_FFLAG_EXLOCK	0x0020
90 #define	PS_FST_FFLAG_ASYNC	0x0040
91 #define	PS_FST_FFLAG_SYNC	0x0080
92 #define	PS_FST_FFLAG_NOFOLLOW	0x0100
93 #define	PS_FST_FFLAG_CREAT	0x0200
94 #define	PS_FST_FFLAG_TRUNC	0x0400
95 #define	PS_FST_FFLAG_EXCL	0x0800
96 #define	PS_FST_FFLAG_DIRECT	0x1000
97 #define	PS_FST_FFLAG_EXEC	0x2000
98 #define	PS_FST_FFLAG_HASLOCK	0x4000
99 
100 struct kinfo_kstack;
101 struct kinfo_vmentry;
102 struct procstat;
103 struct rlimit;
104 struct filestat {
105 	int	fs_type;	/* Descriptor type. */
106 	int	fs_flags;	/* filestat specific flags. */
107 	int	fs_fflags;	/* Descriptor access flags. */
108 	int	fs_uflags;	/* How this file is used. */
109 	int	fs_fd;		/* File descriptor number. */
110 	int	fs_ref_count;	/* Reference count. */
111 	off_t	fs_offset;	/* Seek location. */
112 	void	*fs_typedep;	/* Type dependent data. */
113 	char	*fs_path;
114 	STAILQ_ENTRY(filestat)	next;
115 	cap_rights_t	fs_cap_rights;	/* Capability rights, if flag set. */
116 };
117 struct vnstat {
118 	uint64_t	vn_fileid;
119 	uint64_t	vn_size;
120 	char		*vn_mntdir;
121 	uint32_t	vn_dev;
122 	uint32_t	vn_fsid;
123 	int		vn_type;
124 	uint16_t	vn_mode;
125 	char		vn_devname[SPECNAMELEN + 1];
126 };
127 struct ptsstat {
128 	uint32_t	dev;
129 	char		devname[SPECNAMELEN + 1];
130 };
131 struct pipestat {
132 	size_t		buffer_cnt;
133 	uint64_t	addr;
134 	uint64_t	peer;
135 };
136 struct shmstat {
137 	uint64_t	size;
138 	uint16_t	mode;
139 };
140 struct sockstat {
141 	uint64_t	inp_ppcb;
142 	uint64_t	so_addr;
143 	uint64_t	so_pcb;
144 	uint64_t	unp_conn;
145 	int		dom_family;
146 	int		proto;
147 	int		so_rcv_sb_state;
148 	int		so_snd_sb_state;
149 	struct sockaddr_storage	sa_local;	/* Socket address. */
150 	struct sockaddr_storage	sa_peer;	/* Peer address. */
151 	int		type;
152 	char		dname[32];
153 };
154 
155 STAILQ_HEAD(filestat_list, filestat);
156 
157 __BEGIN_DECLS
158 void	procstat_close(struct procstat *procstat);
159 void	procstat_freeargv(struct procstat *procstat);
160 #ifndef ZFS
161 void	procstat_freeauxv(struct procstat *procstat, Elf_Auxinfo *auxv);
162 #endif
163 void	procstat_freeenvv(struct procstat *procstat);
164 void	procstat_freegroups(struct procstat *procstat, gid_t *groups);
165 void	procstat_freekstack(struct procstat *procstat,
166     struct kinfo_kstack *kkstp);
167 void	procstat_freeprocs(struct procstat *procstat, struct kinfo_proc *p);
168 void	procstat_freefiles(struct procstat *procstat,
169     struct filestat_list *head);
170 void	procstat_freevmmap(struct procstat *procstat,
171     struct kinfo_vmentry *vmmap);
172 struct filestat_list	*procstat_getfiles(struct procstat *procstat,
173     struct kinfo_proc *kp, int mmapped);
174 struct kinfo_proc	*procstat_getprocs(struct procstat *procstat,
175     int what, int arg, unsigned int *count);
176 int	procstat_get_pipe_info(struct procstat *procstat, struct filestat *fst,
177     struct pipestat *pipe, char *errbuf);
178 int	procstat_get_pts_info(struct procstat *procstat, struct filestat *fst,
179     struct ptsstat *pts, char *errbuf);
180 int	procstat_get_shm_info(struct procstat *procstat, struct filestat *fst,
181     struct shmstat *shm, char *errbuf);
182 int	procstat_get_socket_info(struct procstat *procstat, struct filestat *fst,
183     struct sockstat *sock, char *errbuf);
184 int	procstat_get_vnode_info(struct procstat *procstat, struct filestat *fst,
185     struct vnstat *vn, char *errbuf);
186 char	**procstat_getargv(struct procstat *procstat, struct kinfo_proc *p,
187     size_t nchr);
188 #ifndef ZFS
189 Elf_Auxinfo	*procstat_getauxv(struct procstat *procstat,
190     struct kinfo_proc *kp, unsigned int *cntp);
191 #endif
192 char	**procstat_getenvv(struct procstat *procstat, struct kinfo_proc *p,
193     size_t nchr);
194 gid_t	*procstat_getgroups(struct procstat *procstat, struct kinfo_proc *kp,
195     unsigned int *count);
196 struct kinfo_kstack	*procstat_getkstack(struct procstat *procstat,
197     struct kinfo_proc *kp, unsigned int *count);
198 int	procstat_getosrel(struct procstat *procstat, struct kinfo_proc *kp,
199     int *osrelp);
200 int	procstat_getpathname(struct procstat *procstat, struct kinfo_proc *kp,
201     char *pathname, size_t maxlen);
202 int	procstat_getrlimit(struct procstat *procstat, struct kinfo_proc *kp,
203     int which, struct rlimit* rlimit);
204 int	procstat_getumask(struct procstat *procstat, struct kinfo_proc *kp,
205     unsigned short* umask);
206 struct kinfo_vmentry	*procstat_getvmmap(struct procstat *procstat,
207     struct kinfo_proc *kp, unsigned int *count);
208 struct procstat	*procstat_open_core(const char *filename);
209 struct procstat	*procstat_open_sysctl(void);
210 struct procstat	*procstat_open_kvm(const char *nlistf, const char *memf);
211 __END_DECLS
212 
213 #endif	/* !_LIBPROCSTAT_H_ */
214