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