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