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