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