lib/libprocstat/libprocstat.h

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