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