sys/sys/kinfo.h

   1 /*
   2  * Copyright (c) 2004 The DragonFly Project.  All rights reserved.
   3  *
   4  * This code is derived from software contributed to The DragonFly Project
   5  * by Joerg Sonnenberger <joerg@bec.de>.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  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
  15  *    the documentation and/or other materials provided with the
  16  *    distribution.
  17  * 3. Neither the name of The DragonFly Project nor the names of its
  18  *    contributors may be used to endorse or promote products derived
  19  *    from this software without specific, prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  25  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  31  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  */
  34
  35 #ifndef _SYS_KINFO_H_
  36 #define _SYS_KINFO_H_
  37
  38 #ifndef _KERNEL_STRUCTURES
  39 #define _KERNEL_STRUCTURES
  40 #endif
  41
  42 #ifndef _SYS_TYPES_H_
  43 #include <sys/types.h>
  44 #endif
  45 #ifndef _SYS_PARAM_H_
  46 #include <sys/param.h>
  47 #endif
  48 #include <sys/resource.h>
  49 #include <sys/rtprio.h>
  50 #include <sys/proc.h>
  51
  52 struct kinfo_file {
  53         size_t   f_size;        /* size of struct kinfo_file */
  54         pid_t    f_pid;         /* owning process */
  55         uid_t    f_uid;         /* effective uid of owning process */
  56         int      f_fd;          /* descriptor number */
  57         void    *f_file;        /* address of struct file */
  58         short    f_type;        /* descriptor type */
  59         int      f_count;       /* reference count */
  60         int      f_msgcount;    /* references from message queue */
  61         off_t    f_offset;      /* file offset */
  62         void    *f_data;        /* file descriptor specific data */
  63         u_int    f_flag;        /* flags (see fcntl.h) */
  64 };
  65
  66 /*
  67  * CPU time statistics
  68  */
  69 struct kinfo_cputime {
  70         uint64_t        cp_user;
  71         uint64_t        cp_nice;
  72         uint64_t        cp_sys;
  73         uint64_t        cp_intr;
  74         uint64_t        cp_idle;
  75         uint64_t        cp_unused01;
  76         uint64_t        cp_unused02;
  77         uint64_t        cp_sample_pc;
  78         uint64_t        cp_sample_sp;
  79         char            cp_msg[32];     /* code stall token or mplock */
  80 };
  81
  82 /*
  83  * CPU system/interrupt program counter sampler
  84  */
  85 #define PCTRACK_ARYSIZE 32      /* must be a power of 2 */
  86 #define PCTRACK_ARYMASK (PCTRACK_ARYSIZE - 1)
  87
  88 struct kinfo_pcheader {
  89         int             pc_ntrack;      /* number of tracks per cpu (2) */
  90         int             pc_arysize;     /* size of storage array (32) */
  91 };
  92
  93 struct kinfo_pctrack {
  94         int             pc_index;
  95         void            *pc_array[PCTRACK_ARYSIZE];
  96 };
  97
  98 #define PCTRACK_SYS     0
  99 #define PCTRACK_INT     1
 100 #define PCTRACK_SIZE    2
 101
 102 struct kinfo_clockinfo {
 103         int     ci_hz;          /* clock frequency */
 104         int     ci_tick;        /* micro-seconds per hz tick */
 105         int     ci_tickadj;     /* clock skew rate for adjtime() */
 106         int     ci_stathz;      /* statistics clock frequency */
 107         int     ci_profhz;      /* profiling clock frequency */
 108 };
 109
 110 /*
 111  * Structure definition for the lwp-specific data in struct kinfo_proc.
 112  */
 113 struct kinfo_lwp {
 114         pid_t           kl_pid;         /* PID of our associated proc */
 115         lwpid_t         kl_tid;         /* thread id */
 116
 117         int             kl_flags;       /* LWP_ flags */
 118         enum lwpstat    kl_stat;        /* LS* lwp status */
 119         int             kl_lock;        /* lwp lock (prevent destruct) count */
 120         int             kl_tdflags;     /* thread flags */
 121         int             kl_mpcount;     /* MP lock held count */
 122         int             kl_prio;        /* scheduling priority */
 123         int             kl_tdprio;      /* lwkt sched priority */
 124         struct rtprio   kl_rtprio;      /* real-time scheduling prio */
 125
 126         /* accounting */
 127         uint64_t        kl_uticks;      /* time accounting */
 128         uint64_t        kl_sticks;
 129         uint64_t        kl_iticks;
 130         uint64_t        kl_cpticks;     /* sched quantums used */
 131         u_int           kl_pctcpu;      /* percentage cputime */
 132         u_int           kl_slptime;     /* time since last blocked */
 133         int             kl_origcpu;     /* originally scheduled on cpu */
 134         int             kl_estcpu;
 135         int             kl_cpuid;       /* CPU this lwp was last scheduled on */
 136
 137         struct rusage   kl_ru;          /* resource usage stats */
 138
 139         sigset_t        kl_siglist;     /* pending signals */
 140         sigset_t        kl_sigmask;     /* masked signals */
 141 #define WMESGLEN 8
 142         uintptr_t       kl_wchan;       /* waiting channel */
 143         char            kl_wmesg[WMESGLEN+1];   /* waiting message */
 144
 145         char            kl_comm[MAXCOMLEN+1];   /* lwp name */
 146 };
 147
 148 /*
 149  * KERN_PROC subtype ops return arrays of normalized proc structures:
 150  */
 151 struct kinfo_proc {
 152         uintptr_t       kp_paddr;       /* address of this proc */
 153
 154         /* proc information */
 155         int             kp_flags;
 156         enum procstat   kp_stat;
 157         int             kp_lock;
 158         int             kp_acflag;      /* accounting flags */
 159         int             kp_traceflag;
 160
 161         uintptr_t       kp_fd;          /* address of the proc's files */
 162
 163         sigset_t        kp_siglist;
 164         sigset_t        kp_sigignore;
 165         sigset_t        kp_sigcatch;
 166         int             kp_sigflag;     /* from ps_flag */
 167         struct timeval  kp_start;
 168
 169         char            kp_comm[MAXCOMLEN+1];
 170
 171         /* cred information */
 172         uid_t           kp_uid;
 173         short           kp_ngroups;
 174         gid_t           kp_groups[NGROUPS];
 175         uid_t           kp_ruid;
 176         uid_t           kp_svuid;
 177         gid_t           kp_rgid;
 178         gid_t           kp_svgid;
 179
 180         pid_t           kp_pid; /* process id */
 181         pid_t           kp_ppid;        /* parent process id */
 182         pid_t           kp_pgid;        /* process group id */
 183         int             kp_jobc;        /* job control counter */
 184         pid_t           kp_sid; /* session id */
 185         char            kp_login[roundup(MAXLOGNAME, sizeof(long))];    /* setlogin() name */
 186         dev_t           kp_tdev;        /* controlling tty dev */
 187         pid_t           kp_tpgid;       /* tty process group id */
 188         pid_t           kp_tsid;        /* tty session id */
 189
 190         u_short         kp_exitstat;    /* exit status information */
 191         int             kp_nthreads;
 192         int             kp_nice;
 193         unsigned int    kp_swtime;
 194
 195         vm_size_t       kp_vm_map_size; /* vmmap virtual size in bytes */
 196         segsz_t         kp_vm_rssize;           /* resident set size in pages */
 197         segsz_t         kp_vm_swrss;            /* rss before last swap in pages */
 198         segsz_t         kp_vm_tsize;            /* text size in pages */
 199         segsz_t         kp_vm_dsize;            /* data size in pages */
 200         segsz_t         kp_vm_ssize;            /* stack size in pages */
 201         u_int           kp_vm_prssize;          /* proportional rss in pages */
 202
 203         int             kp_jailid;
 204
 205         struct rusage   kp_ru;
 206         struct rusage   kp_cru;
 207
 208         int             kp_auxflags;    /* generated flags */
 209 #define KI_CTTY 1
 210 #define KI_SLEADER      2
 211
 212         struct kinfo_lwp kp_lwp;
 213
 214         uintptr_t       kp_ktaddr;      /* address of this kernel thread */
 215         int             kp_spare[2];
 216 };
 217
 218 /*
 219  * KERN_SIGTRAMP
 220  */
 221 struct kinfo_sigtramp {
 222         void            *ksigtramp_start;
 223         void            *ksigtramp_end;
 224         void            *ksigtramp_spare[4];
 225 };
 226
 227 struct proc;
 228 struct lwp;
 229 struct thread;
 230
 231 void fill_kinfo_proc(struct proc *, struct kinfo_proc *);
 232 void fill_kinfo_lwp(struct lwp *, struct kinfo_lwp *);
 233 void fill_kinfo_proc_kthread(struct thread *, struct kinfo_proc *);
 234
 235 #define KINFO_NEXT(kp)  ((union kinfo *)((uintptr_t)kp + kp->gen.len))
 236 #define KINFO_END(kp)   (kp->gen.type == KINFO_TYPE_END)
 237
 238 #if defined(_KERNEL)
 239 #define cpu_time        cputime_percpu[mycpuid]
 240 #endif
 241
 242 #if defined(_KERNEL)
 243 extern struct kinfo_cputime cputime_percpu[MAXCPU];
 244 #endif
 245
 246 #endif /* !_SYS_KINFO_H_ */