lib/libdevstat/devstat.h

   1 /*
   2  * Copyright (c) 1997, 1998 Kenneth D. Merry.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. The name of the author may not be used to endorse or promote products
  14  *    derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #ifndef _DEVSTAT_H
  32 #define _DEVSTAT_H
  33 #include <sys/cdefs.h>
  34 #include <sys/devicestat.h>
  35 #include <sys/resource.h>
  36
  37 #include <kvm.h>
  38
  39 /*
  40  * Bumped every time we change the userland API.  Hopefully this doesn't
  41  * happen very often!  This should be bumped every time we have to
  42  * increment SHLIB_MAJOR in the libdevstat Makefile (for non-backwards
  43  * compatible API changes) and should also be bumped every time we make
  44  * backwards-compatible API changes, so application writers have a way to
  45  * determine when a particular feature is available.
  46  */
  47 #define DEVSTAT_USER_API_VER    6
  48
  49 #define DEVSTAT_ERRBUF_SIZE  2048 /* size of the devstat library error string */
  50
  51 extern char devstat_errbuf[];
  52
  53 typedef enum {
  54         DEVSTAT_MATCH_NONE      = 0x00,
  55         DEVSTAT_MATCH_TYPE      = 0x01,
  56         DEVSTAT_MATCH_IF        = 0x02,
  57         DEVSTAT_MATCH_PASS      = 0x04
  58 } devstat_match_flags;
  59
  60 typedef enum {
  61         DSM_NONE,
  62         DSM_TOTAL_BYTES,
  63         DSM_TOTAL_BYTES_READ,
  64         DSM_TOTAL_BYTES_WRITE,
  65         DSM_TOTAL_TRANSFERS,
  66         DSM_TOTAL_TRANSFERS_READ,
  67         DSM_TOTAL_TRANSFERS_WRITE,
  68         DSM_TOTAL_TRANSFERS_OTHER,
  69         DSM_TOTAL_BLOCKS,
  70         DSM_TOTAL_BLOCKS_READ,
  71         DSM_TOTAL_BLOCKS_WRITE,
  72         DSM_KB_PER_TRANSFER,
  73         DSM_KB_PER_TRANSFER_READ,
  74         DSM_KB_PER_TRANSFER_WRITE,
  75         DSM_TRANSFERS_PER_SECOND,
  76         DSM_TRANSFERS_PER_SECOND_READ,
  77         DSM_TRANSFERS_PER_SECOND_WRITE,
  78         DSM_TRANSFERS_PER_SECOND_OTHER,
  79         DSM_MB_PER_SECOND,
  80         DSM_MB_PER_SECOND_READ,
  81         DSM_MB_PER_SECOND_WRITE,
  82         DSM_BLOCKS_PER_SECOND,
  83         DSM_BLOCKS_PER_SECOND_READ,
  84         DSM_BLOCKS_PER_SECOND_WRITE,
  85         DSM_MS_PER_TRANSACTION,
  86         DSM_MS_PER_TRANSACTION_READ,
  87         DSM_MS_PER_TRANSACTION_WRITE,
  88         DSM_SKIP,
  89         DSM_TOTAL_BYTES_FREE,
  90         DSM_TOTAL_TRANSFERS_FREE,
  91         DSM_TOTAL_BLOCKS_FREE,
  92         DSM_KB_PER_TRANSFER_FREE,
  93         DSM_MB_PER_SECOND_FREE,
  94         DSM_TRANSFERS_PER_SECOND_FREE,
  95         DSM_BLOCKS_PER_SECOND_FREE,
  96         DSM_MS_PER_TRANSACTION_OTHER,
  97         DSM_MS_PER_TRANSACTION_FREE,
  98         DSM_BUSY_PCT,
  99         DSM_QUEUE_LENGTH,
 100         DSM_MAX
 101 } devstat_metric;
 102
 103 struct devstat_match {
 104         devstat_match_flags     match_fields;
 105         devstat_type_flags      device_type;
 106         int                     num_match_categories;
 107 };
 108
 109 struct devstat_match_table {
 110         const char *            match_str;
 111         devstat_type_flags      type;
 112         devstat_match_flags     match_field;
 113 };
 114
 115 struct device_selection {
 116         u_int32_t       device_number;
 117         char            device_name[DEVSTAT_NAME_LEN];
 118         int             unit_number;
 119         int             selected;
 120         u_int64_t       bytes;
 121         int             position;
 122 };
 123
 124 struct devinfo {
 125         struct devstat  *devices;
 126         u_int8_t        *mem_ptr;
 127         long            generation;
 128         int             numdevs;
 129 };
 130
 131 struct statinfo {
 132         long            cp_time[CPUSTATES];
 133         long            tk_nin;
 134         long            tk_nout;
 135         struct devinfo  *dinfo;
 136         long double     snap_time;
 137 };
 138
 139 typedef enum {
 140         DS_SELECT_ADD,
 141         DS_SELECT_ONLY,
 142         DS_SELECT_REMOVE,
 143         DS_SELECT_ADDONLY
 144 } devstat_select_mode;
 145
 146 __BEGIN_DECLS
 147
 148 int devstat_getnumdevs(kvm_t *kd);
 149 long devstat_getgeneration(kvm_t *kd);
 150 int devstat_getversion(kvm_t *kd);
 151 int devstat_checkversion(kvm_t *kd);
 152 int devstat_getdevs(kvm_t *kd, struct statinfo *stats);
 153 int devstat_selectdevs(struct device_selection **dev_select, int *num_selected,
 154                        int *num_selections, long *select_generation,
 155                        long current_generation, struct devstat *devices,
 156                        int numdevs, struct devstat_match *matches,
 157                        int num_matches, char **dev_selections,
 158                        int num_dev_selections, devstat_select_mode select_mode,
 159                        int maxshowdevs, int perf_select);
 160 int devstat_buildmatch(char *match_str, struct devstat_match **matches,
 161                        int *num_matches);
 162 int devstat_compute_statistics(struct devstat *current,
 163                                struct devstat *previous,
 164                                long double etime, ...);
 165 long double devstat_compute_etime(struct bintime *cur_time,
 166                                   struct bintime *prev_time);
 167 __END_DECLS
 168
 169 #endif /* _DEVSTAT_H  */