devicestat.h revision 39229
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 * $Id$ 29 */ 30 31#ifndef _DEVICESTAT_H 32#define _DEVICESTAT_H 33 34#include <sys/queue.h> 35#include <sys/time.h> 36 37#define DEVSTAT_NAME_LEN 16 38 39/* 40 * ATTENTION: The devstat version below should be incremented any time a 41 * change is made in struct devstat, or any time a change is made in the 42 * enumerated types that struct devstat uses. (Only if those changes 43 * would require a recompile -- i.e. re-arranging the order of an 44 * enumerated type or something like that.) This version number is used by 45 * userland utilities to determine whether or not they are in sync with the 46 * kernel. 47 */ 48#define DEVSTAT_VERSION 1 49 50/* 51 * These flags specify which statistics features are supported or not 52 * supported by a particular device. The default is all statistics are 53 * supported. 54 */ 55typedef enum { 56 DEVSTAT_ALL_SUPPORTED = 0x00, 57 DEVSTAT_NO_BLOCKSIZE = 0x01, 58 DEVSTAT_NO_ORDERED_TAGS = 0x02, 59 DEVSTAT_BS_UNAVAILABLE = 0x04 60} devstat_support_flags; 61 62typedef enum { 63 DEVSTAT_NO_DATA = 0x00, 64 DEVSTAT_READ = 0x01, 65 DEVSTAT_WRITE = 0x02 66} devstat_trans_flags; 67 68typedef enum { 69 DEVSTAT_TAG_SIMPLE = 0x00, 70 DEVSTAT_TAG_HEAD = 0x01, 71 DEVSTAT_TAG_ORDERED = 0x02, 72 DEVSTAT_TAG_NONE = 0x03 73} devstat_tag_type; 74 75/* 76 * These types are intended to aid statistics gathering/display programs. 77 * The first 13 types (up to the 'target' flag) are identical numerically 78 * to the SCSI device type numbers. The next 3 types designate the device 79 * interface. Currently the choices are IDE, SCSI, and 'other'. The last 80 * flag specifies whether or not the given device is a passthrough device 81 * or not. If it is a passthrough device, the lower 4 bits specify which 82 * type of physical device lies under the passthrough device, and the next 83 * 4 bits specify the interface. 84 */ 85typedef enum { 86 DEVSTAT_TYPE_DIRECT = 0x000, 87 DEVSTAT_TYPE_SEQUENTIAL = 0x001, 88 DEVSTAT_TYPE_PRINTER = 0x002, 89 DEVSTAT_TYPE_PROCESSOR = 0x003, 90 DEVSTAT_TYPE_WORM = 0x004, 91 DEVSTAT_TYPE_CDROM = 0x005, 92 DEVSTAT_TYPE_SCANNER = 0x006, 93 DEVSTAT_TYPE_OPTICAL = 0x007, 94 DEVSTAT_TYPE_CHANGER = 0x008, 95 DEVSTAT_TYPE_COMM = 0x009, 96 DEVSTAT_TYPE_ASC0 = 0x00a, 97 DEVSTAT_TYPE_ASC1 = 0x00b, 98 DEVSTAT_TYPE_STORARRAY = 0x00c, 99 DEVSTAT_TYPE_ENCLOSURE = 0x00d, 100 DEVSTAT_TYPE_FLOPPY = 0x00e, 101 DEVSTAT_TYPE_MASK = 0x00f, 102 DEVSTAT_TYPE_IF_SCSI = 0x010, 103 DEVSTAT_TYPE_IF_IDE = 0x020, 104 DEVSTAT_TYPE_IF_OTHER = 0x030, 105 DEVSTAT_TYPE_IF_MASK = 0x0f0, 106 DEVSTAT_TYPE_PASS = 0x100 107} devstat_type_flags; 108 109struct devstat { 110 STAILQ_ENTRY(devstat) dev_links; 111 u_int32_t device_number; /* 112 * Devstat device 113 * number. 114 */ 115 char device_name[DEVSTAT_NAME_LEN]; 116 int unit_number; 117 u_int64_t bytes_written; /* 118 * Total bytes written 119 * to a device. 120 */ 121 u_int64_t bytes_read; /* 122 * Total bytes read 123 * from a device. 124 */ 125 u_int64_t num_reads; /* 126 * Total number of 127 * read requests to 128 * the device. 129 */ 130 u_int64_t num_writes; /* 131 * Total number of 132 * write requests to 133 * the device. 134 */ 135 u_int64_t num_other; /* 136 * Total number of 137 * transactions that 138 * don't read or write 139 * data. 140 */ 141 int32_t busy_count; /* 142 * Total number of 143 * transactions 144 * outstanding for 145 * the device. 146 */ 147 u_int32_t block_size; /* Block size, bytes */ 148 u_int64_t tag_types[3]; /* 149 * The number of 150 * simple, ordered, 151 * and head of queue 152 * tags sent. 153 */ 154 struct timeval dev_creation_time; /* 155 * Time the device was 156 * created. 157 */ 158 struct timeval busy_time; /* 159 * Total amount of 160 * time drive has spent 161 * processing requests. 162 */ 163 struct timeval start_time; /* 164 * The time when 165 * busy_count was 166 * last == 0. Or, the 167 * start of the latest 168 * busy period. 169 */ 170 struct timeval last_comp_time; /* 171 * Last time a 172 * transaction was 173 * completed. 174 */ 175 176 devstat_support_flags flags; /* 177 * Which statistics 178 * are supported by a 179 * given device. 180 */ 181 devstat_type_flags device_type; /* Device type */ 182}; 183 184#ifdef KERNEL 185void devstat_add_entry(struct devstat *ds, char *dev_name, 186 int unit_number, u_int32_t block_size, 187 devstat_support_flags flags, 188 devstat_type_flags device_type); 189void devstat_remove_entry(struct devstat *ds); 190void devstat_start_transaction(struct devstat *ds); 191void devstat_end_transaction(struct devstat *ds, u_int32_t bytes, 192 devstat_tag_type tag_type, 193 devstat_trans_flags flags); 194#endif 195 196#endif /* _DEVICESTAT_H */ 197