usr/src/cmd/prstat/prstat.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21
  22 /*
  23  * Copyright (c) 2013 Gary Mills
  24  *
  25  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
  26  * Use is subject to license terms.
  27  *
  28  * Portions Copyright 2009 Chad Mynhier
  29  * Copyright 2018 Joyent, Inc.  All rights reserved.
  30  */
  31
  32 #ifndef _PRSTAT_H
  33 #define _PRSTAT_H
  34
  35 #include <sys/sysmacros.h>
  36 #include <sys/time.h>
  37 #include <sys/types.h>
  38 #include <procfs.h>
  39
  40 #ifdef  __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 /*
  45  * FRC2PCT macro is used to convert 16-bit binary fractions in the range
  46  * 0.0 to 1.0 with binary point to the right of the high order bit
  47  * (i.e. 1.0 == 0x8000) to percentage value.
  48  */
  49
  50 #define FRC2PCT(pp)     (((float)(pp))/0x8000*100)
  51
  52 #define TIME2NSEC(__t)\
  53 (hrtime_t)(((hrtime_t)__t.tv_sec * (hrtime_t)NANOSEC) + (hrtime_t)__t.tv_nsec)
  54 #define TIME2SEC(__t)\
  55 (hrtime_t)(__t.tv_sec)
  56
  57 /*
  58  * List of available output modes
  59  */
  60 #define OPT_PSINFO      0x0001          /* read process's data from "psinfo" */
  61 #define OPT_LWPS        0x0002          /* report about all lwps */
  62 #define OPT_USERS       0x0004          /* report about most active users */
  63 #define OPT_UNUSED      0x0008          /* reserved for future use */
  64 #define OPT_REALTIME    0x0010          /* real-time scheduling class flag */
  65 #define OPT_MSACCT      0x0020          /* microstate accounting flag */
  66 #define OPT_TERMCAP     0x0040          /* use termcap data to move cursor */
  67 #define OPT_SPLIT       0x0080          /* split-screen mode flag */
  68 #define OPT_TTY         0x0100          /* report results to tty or file */
  69 #define OPT_FULLSCREEN  0x0200          /* full-screen mode flag */
  70 #define OPT_USEHOME     0x0400          /* use 'home' to move cursor up */
  71 #define OPT_TASKS       0x0800          /* report about system tasks */
  72 #define OPT_PROJECTS    0x1000          /* report about system projects */
  73 #define OPT_ZONES       0x2000          /* report about zones */
  74 #define OPT_PSETS       0x4000          /* report for specified psets */
  75 #define OPT_LGRP        0x8000          /* report home lgroups */
  76 #define OPT_UDATE       0x20000         /* print unix timestamp */
  77 #define OPT_DDATE       0x40000         /* print timestamp in date(1) format */
  78 #define OPT_NORESOLVE   0x80000         /* no nsswitch lookups */
  79 #define OPT_TRUNC       0x100000        /* truncate long names */
  80
  81 /*
  82  * Flags to keep track of process or lwp status
  83  */
  84 #define LWP_ALIVE       0x0008          /* this pid/lwp still exists */
  85 #define LWP_REPRESENT   0x0010          /* this LWP represents the process */
  86
  87 /*
  88  * Possible list types
  89  */
  90 #define LT_LWPS         0x0001
  91 #define LT_USERS        0x0002
  92 #define LT_TASKS        0x0004
  93 #define LT_PROJECTS     0x0008
  94 #define LT_ZONES        0x0010
  95 #define LT_LGRPS        0x0020
  96
  97 /*
  98  * Linked list of per-process or per-lwp statistics
  99  */
 100 typedef struct lwp_info {
 101         psinfo_t        li_info;        /* data read from psinfo file */
 102         prusage_t       li_usage;       /* data read from usage file */
 103         ulong_t         li_key;         /* value of the key for this lwp */
 104         int             li_flags;       /* process/lwp flags */
 105         float           li_usr;         /* user level CPU time */
 106         float           li_sys;         /* system call CPU time */
 107         float           li_trp;         /* other system trap CPU time */
 108         float           li_tfl;         /* text page fault sleep time */
 109         float           li_dfl;         /* data page fault sleep time */
 110         float           li_lck;         /* user lock wait sleep time */
 111         float           li_slp;         /* all other sleep time */
 112         float           li_lat;         /* wait-cpu (latency) time */
 113         ulong_t         li_vcx;         /* voluntary context switches */
 114         ulong_t         li_icx;         /* involuntary context switches */
 115         ulong_t         li_scl;         /* system calls */
 116         ulong_t         li_sig;         /* received signals */
 117         char            li_lwpname[THREAD_NAME_MAX];
 118         struct lwp_info *li_next;       /* pointer to next lwp */
 119         struct lwp_info *li_prev;       /* pointer to previous lwp */
 120 } lwp_info_t;
 121
 122 /*
 123  * Linked list of collective per-uid, per-taskid, per-projid or per-lgroup
 124  * statistics
 125  */
 126 typedef struct id_info {
 127         uid_t           id_uid;         /* user id */
 128         taskid_t        id_taskid;      /* task id */
 129         projid_t        id_projid;      /* project id */
 130         zoneid_t        id_zoneid;      /* zone id */
 131         int             id_lgroup;      /* lgroup id */
 132         uint_t          id_nproc;       /* number of processes */
 133         boolean_t       id_sizematch;   /* size/rssize from getvmusage() */
 134         size_t          id_size;        /* memory usage */
 135         size_t          id_rssize;      /* resident set size */
 136         ulong_t         id_time;        /* cpu time (in secs) */
 137         float           id_pctcpu;      /* percentage of cpu usage */
 138         float           id_pctmem;      /* percentage of memory usage */
 139         ulong_t         id_key;         /* sort key value */
 140         struct id_info *id_next;        /* pointer to next entry */
 141         struct id_info *id_prev;        /* pointer to previous entry */
 142 } id_info_t;
 143
 144 typedef ulong_t (*keyfunc_t)(void *);
 145
 146 /*
 147  * Per-list structure
 148  */
 149 typedef struct list {
 150         int             l_type;         /* list type */
 151         int             l_count;        /* number of entries in the list */
 152         void            *l_head;        /* pointer to the head of the list */
 153         void            *l_tail;        /* pointer to the tail of the list */
 154
 155         int             l_size;         /* number of allocated pointers */
 156         int             l_used;         /* number of used pointers */
 157         int             l_sortorder;    /* sorting order for the list */
 158         keyfunc_t       l_func;         /* pointer to key function */
 159         void            **l_ptrs;       /* pointer to an array of pointers */
 160 } list_t;
 161
 162 /*
 163  * Command line options
 164  */
 165 typedef struct optdesc {
 166         int             o_interval;     /* interval between updates */
 167         int             o_ntop;         /* number of lines in top half */
 168         int             o_nbottom;      /* number of lines in bottom half */
 169         int             o_count;        /* number of iterations */
 170         int             o_outpmode;     /* selected output mode */
 171         int             o_sortorder;    /* +1 ascending, -1 descending */
 172         int             o_cols;         /* number of columns */
 173 } optdesc_t;
 174
 175 extern optdesc_t opts;
 176
 177 #ifdef  __cplusplus
 178 }
 179 #endif
 180
 181 #endif  /* _PRSTAT_H */