libprocstat.h revision 249681
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: head/lib/libprocstat/libprocstat.h 249681 2013-04-20 08:10:47Z trociny $
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
100struct kinfo_vmentry;
101struct procstat;
102struct rlimit;
103struct filestat {
104	int	fs_type;	/* Descriptor type. */
105	int	fs_flags;	/* filestat specific flags. */
106	int	fs_fflags;	/* Descriptor access flags. */
107	int	fs_uflags;	/* How this file is used. */
108	int	fs_fd;		/* File descriptor number. */
109	int	fs_ref_count;	/* Reference count. */
110	off_t	fs_offset;	/* Seek location. */
111	void	*fs_typedep;	/* Type dependent data. */
112	char	*fs_path;
113	STAILQ_ENTRY(filestat)	next;
114	cap_rights_t	fs_cap_rights;	/* Capability rights, if flag set. */
115};
116struct vnstat {
117	uint64_t	vn_fileid;
118	uint64_t	vn_size;
119	char		*vn_mntdir;
120	uint32_t	vn_dev;
121	uint32_t	vn_fsid;
122	int		vn_type;
123	uint16_t	vn_mode;
124	char		vn_devname[SPECNAMELEN + 1];
125};
126struct ptsstat {
127	uint32_t	dev;
128	char		devname[SPECNAMELEN + 1];
129};
130struct pipestat {
131	size_t		buffer_cnt;
132	uint64_t	addr;
133	uint64_t	peer;
134};
135struct shmstat {
136	uint64_t	size;
137	uint16_t	mode;
138};
139struct sockstat {
140	uint64_t	inp_ppcb;
141	uint64_t	so_addr;
142	uint64_t	so_pcb;
143	uint64_t	unp_conn;
144	int		dom_family;
145	int		proto;
146	int		so_rcv_sb_state;
147	int		so_snd_sb_state;
148	struct sockaddr_storage	sa_local;	/* Socket address. */
149	struct sockaddr_storage	sa_peer;	/* Peer address. */
150	int		type;
151	char		dname[32];
152};
153
154STAILQ_HEAD(filestat_list, filestat);
155
156__BEGIN_DECLS
157void	procstat_close(struct procstat *procstat);
158void	procstat_freeargv(struct procstat *procstat);
159#ifndef ZFS
160void	procstat_freeauxv(struct procstat *procstat, Elf_Auxinfo *auxv);
161#endif
162void	procstat_freeenvv(struct procstat *procstat);
163void	procstat_freegroups(struct procstat *procstat, gid_t *groups);
164void	procstat_freeprocs(struct procstat *procstat, struct kinfo_proc *p);
165void	procstat_freefiles(struct procstat *procstat,
166    struct filestat_list *head);
167void	procstat_freevmmap(struct procstat *procstat,
168    struct kinfo_vmentry *vmmap);
169struct filestat_list	*procstat_getfiles(struct procstat *procstat,
170    struct kinfo_proc *kp, int mmapped);
171struct kinfo_proc	*procstat_getprocs(struct procstat *procstat,
172    int what, int arg, unsigned int *count);
173int	procstat_get_pipe_info(struct procstat *procstat, struct filestat *fst,
174    struct pipestat *pipe, char *errbuf);
175int	procstat_get_pts_info(struct procstat *procstat, struct filestat *fst,
176    struct ptsstat *pts, char *errbuf);
177int	procstat_get_shm_info(struct procstat *procstat, struct filestat *fst,
178    struct shmstat *shm, char *errbuf);
179int	procstat_get_socket_info(struct procstat *procstat, struct filestat *fst,
180    struct sockstat *sock, char *errbuf);
181int	procstat_get_vnode_info(struct procstat *procstat, struct filestat *fst,
182    struct vnstat *vn, char *errbuf);
183char	**procstat_getargv(struct procstat *procstat, struct kinfo_proc *p,
184    size_t nchr);
185#ifndef ZFS
186Elf_Auxinfo	*procstat_getauxv(struct procstat *procstat,
187    struct kinfo_proc *kp, unsigned int *cntp);
188#endif
189char	**procstat_getenvv(struct procstat *procstat, struct kinfo_proc *p,
190    size_t nchr);
191gid_t	*procstat_getgroups(struct procstat *procstat, struct kinfo_proc *kp,
192    unsigned int *count);
193int	procstat_getosrel(struct procstat *procstat, struct kinfo_proc *kp,
194    int *osrelp);
195int	procstat_getpathname(struct procstat *procstat, struct kinfo_proc *kp,
196    char *pathname, size_t maxlen);
197int	procstat_getrlimit(struct procstat *procstat, struct kinfo_proc *kp,
198    int which, struct rlimit* rlimit);
199int	procstat_getumask(struct procstat *procstat, struct kinfo_proc *kp,
200    unsigned short* umask);
201struct kinfo_vmentry	*procstat_getvmmap(struct procstat *procstat,
202    struct kinfo_proc *kp, unsigned int *count);
203struct procstat	*procstat_open_core(const char *filename);
204struct procstat	*procstat_open_sysctl(void);
205struct procstat	*procstat_open_kvm(const char *nlistf, const char *memf);
206__END_DECLS
207
208#endif	/* !_LIBPROCSTAT_H_ */
209