1139825Simp/*- 243819Sken * Copyright (c) 1997, 1998, 1999 Kenneth D. Merry. 339229Sgibbs * All rights reserved. 439229Sgibbs * 539229Sgibbs * Redistribution and use in source and binary forms, with or without 639229Sgibbs * modification, are permitted provided that the following conditions 739229Sgibbs * are met: 839229Sgibbs * 1. Redistributions of source code must retain the above copyright 939229Sgibbs * notice, this list of conditions and the following disclaimer. 1039229Sgibbs * 2. Redistributions in binary form must reproduce the above copyright 1139229Sgibbs * notice, this list of conditions and the following disclaimer in the 1239229Sgibbs * documentation and/or other materials provided with the distribution. 1339229Sgibbs * 3. The name of the author may not be used to endorse or promote products 1439229Sgibbs * derived from this software without specific prior written permission. 1539229Sgibbs * 1639229Sgibbs * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1739229Sgibbs * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1839229Sgibbs * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1939229Sgibbs * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 2039229Sgibbs * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2139229Sgibbs * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2239229Sgibbs * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2339229Sgibbs * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2439229Sgibbs * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2539229Sgibbs * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2639229Sgibbs * SUCH DAMAGE. 2739229Sgibbs * 2850477Speter * $FreeBSD$ 2939229Sgibbs */ 3039229Sgibbs 3139229Sgibbs#ifndef _DEVICESTAT_H 3239229Sgibbs#define _DEVICESTAT_H 3339229Sgibbs 3439229Sgibbs#include <sys/queue.h> 3539229Sgibbs#include <sys/time.h> 3639229Sgibbs 37112000Sphk/* 38112000Sphk * XXX: Should really be SPECNAMELEN 39112000Sphk */ 4039229Sgibbs#define DEVSTAT_NAME_LEN 16 4139229Sgibbs 4239229Sgibbs/* 43112326Sphk * device name for the mmap device 44112326Sphk */ 45112326Sphk#define DEVSTAT_DEVICE_NAME "devstat" 46112326Sphk 47112326Sphk/* 4839229Sgibbs * ATTENTION: The devstat version below should be incremented any time a 4939229Sgibbs * change is made in struct devstat, or any time a change is made in the 5039229Sgibbs * enumerated types that struct devstat uses. (Only if those changes 5139229Sgibbs * would require a recompile -- i.e. re-arranging the order of an 5239229Sgibbs * enumerated type or something like that.) This version number is used by 5339229Sgibbs * userland utilities to determine whether or not they are in sync with the 5439229Sgibbs * kernel. 5539229Sgibbs */ 56112288Sphk#define DEVSTAT_VERSION 6 5739229Sgibbs 5839229Sgibbs/* 5939229Sgibbs * These flags specify which statistics features are supported or not 6039229Sgibbs * supported by a particular device. The default is all statistics are 6139229Sgibbs * supported. 6239229Sgibbs */ 6339229Sgibbstypedef enum { 6439229Sgibbs DEVSTAT_ALL_SUPPORTED = 0x00, 6539229Sgibbs DEVSTAT_NO_BLOCKSIZE = 0x01, 6639229Sgibbs DEVSTAT_NO_ORDERED_TAGS = 0x02, 6739229Sgibbs DEVSTAT_BS_UNAVAILABLE = 0x04 6839229Sgibbs} devstat_support_flags; 6939229Sgibbs 7039229Sgibbstypedef enum { 7139229Sgibbs DEVSTAT_NO_DATA = 0x00, 7239229Sgibbs DEVSTAT_READ = 0x01, 7351375Sphk DEVSTAT_WRITE = 0x02, 7451375Sphk DEVSTAT_FREE = 0x03 7539229Sgibbs} devstat_trans_flags; 76112288Sphk#define DEVSTAT_N_TRANS_FLAGS 4 7739229Sgibbs 7839229Sgibbstypedef enum { 7939229Sgibbs DEVSTAT_TAG_SIMPLE = 0x00, 8039229Sgibbs DEVSTAT_TAG_HEAD = 0x01, 8139229Sgibbs DEVSTAT_TAG_ORDERED = 0x02, 8239229Sgibbs DEVSTAT_TAG_NONE = 0x03 8339229Sgibbs} devstat_tag_type; 8439229Sgibbs 8543819Skentypedef enum { 8643819Sken DEVSTAT_PRIORITY_MIN = 0x000, 8743819Sken DEVSTAT_PRIORITY_OTHER = 0x020, 8843819Sken DEVSTAT_PRIORITY_PASS = 0x030, 8943819Sken DEVSTAT_PRIORITY_FD = 0x040, 9043819Sken DEVSTAT_PRIORITY_WFD = 0x050, 9154279Sken DEVSTAT_PRIORITY_TAPE = 0x060, 9243819Sken DEVSTAT_PRIORITY_CD = 0x090, 9354279Sken DEVSTAT_PRIORITY_DISK = 0x110, 9454279Sken DEVSTAT_PRIORITY_ARRAY = 0x120, 9543819Sken DEVSTAT_PRIORITY_MAX = 0xfff 9643819Sken} devstat_priority; 9743819Sken 9839229Sgibbs/* 9939229Sgibbs * These types are intended to aid statistics gathering/display programs. 10039229Sgibbs * The first 13 types (up to the 'target' flag) are identical numerically 10139229Sgibbs * to the SCSI device type numbers. The next 3 types designate the device 10239229Sgibbs * interface. Currently the choices are IDE, SCSI, and 'other'. The last 10339229Sgibbs * flag specifies whether or not the given device is a passthrough device 10439229Sgibbs * or not. If it is a passthrough device, the lower 4 bits specify which 10539229Sgibbs * type of physical device lies under the passthrough device, and the next 10639229Sgibbs * 4 bits specify the interface. 10739229Sgibbs */ 10839229Sgibbstypedef enum { 10939229Sgibbs DEVSTAT_TYPE_DIRECT = 0x000, 11039229Sgibbs DEVSTAT_TYPE_SEQUENTIAL = 0x001, 11139229Sgibbs DEVSTAT_TYPE_PRINTER = 0x002, 11239229Sgibbs DEVSTAT_TYPE_PROCESSOR = 0x003, 11339229Sgibbs DEVSTAT_TYPE_WORM = 0x004, 11439229Sgibbs DEVSTAT_TYPE_CDROM = 0x005, 11539229Sgibbs DEVSTAT_TYPE_SCANNER = 0x006, 11639229Sgibbs DEVSTAT_TYPE_OPTICAL = 0x007, 11739229Sgibbs DEVSTAT_TYPE_CHANGER = 0x008, 11839229Sgibbs DEVSTAT_TYPE_COMM = 0x009, 11939229Sgibbs DEVSTAT_TYPE_ASC0 = 0x00a, 12039229Sgibbs DEVSTAT_TYPE_ASC1 = 0x00b, 12139229Sgibbs DEVSTAT_TYPE_STORARRAY = 0x00c, 12239229Sgibbs DEVSTAT_TYPE_ENCLOSURE = 0x00d, 12339229Sgibbs DEVSTAT_TYPE_FLOPPY = 0x00e, 12439229Sgibbs DEVSTAT_TYPE_MASK = 0x00f, 12539229Sgibbs DEVSTAT_TYPE_IF_SCSI = 0x010, 12639229Sgibbs DEVSTAT_TYPE_IF_IDE = 0x020, 12739229Sgibbs DEVSTAT_TYPE_IF_OTHER = 0x030, 12839229Sgibbs DEVSTAT_TYPE_IF_MASK = 0x0f0, 12939229Sgibbs DEVSTAT_TYPE_PASS = 0x100 13039229Sgibbs} devstat_type_flags; 13139229Sgibbs 132115567Sphk/* 133115567Sphk * XXX: Next revision should add 134115567Sphk * off_t offset[DEVSTAT_N_TRANS_FLAGS]; 135115567Sphk * XXX: which should contain the offset of the last completed transfer. 136115567Sphk */ 13739229Sgibbsstruct devstat { 138112288Sphk /* Internal house-keeping fields */ 139112288Sphk u_int sequence0; /* Update sequence# */ 140112000Sphk int allocated; /* Allocated entry */ 141112288Sphk u_int start_count; /* started ops */ 142112288Sphk u_int end_count; /* completed ops */ 143112288Sphk struct bintime busy_from; /* 144112288Sphk * busy time unaccounted 145112288Sphk * for since this time 146112288Sphk */ 14760938Sjake STAILQ_ENTRY(devstat) dev_links; 14839229Sgibbs u_int32_t device_number; /* 14939229Sgibbs * Devstat device 15039229Sgibbs * number. 15139229Sgibbs */ 15239229Sgibbs char device_name[DEVSTAT_NAME_LEN]; 15339229Sgibbs int unit_number; 154112288Sphk u_int64_t bytes[DEVSTAT_N_TRANS_FLAGS]; 155112288Sphk u_int64_t operations[DEVSTAT_N_TRANS_FLAGS]; 156112288Sphk struct bintime duration[DEVSTAT_N_TRANS_FLAGS]; 157112288Sphk struct bintime busy_time; 158112288Sphk struct bintime creation_time; /* 159112288Sphk * Time the device was 160112288Sphk * created. 16151375Sphk */ 16239229Sgibbs u_int32_t block_size; /* Block size, bytes */ 16339229Sgibbs u_int64_t tag_types[3]; /* 16439229Sgibbs * The number of 16539229Sgibbs * simple, ordered, 16639229Sgibbs * and head of queue 16739229Sgibbs * tags sent. 16839229Sgibbs */ 16939229Sgibbs devstat_support_flags flags; /* 17039229Sgibbs * Which statistics 17139229Sgibbs * are supported by a 17239229Sgibbs * given device. 17339229Sgibbs */ 17439229Sgibbs devstat_type_flags device_type; /* Device type */ 17543819Sken devstat_priority priority; /* Controls list pos. */ 176112326Sphk const void *id; /* 177112288Sphk * Identification for 178112288Sphk * GEOM nodes 179112288Sphk */ 180112288Sphk u_int sequence1; /* Update sequence# */ 18139229Sgibbs}; 18239229Sgibbs 18381129StmmSTAILQ_HEAD(devstatlist, devstat); 18481129Stmm 18555205Speter#ifdef _KERNEL 18658969Sphkstruct bio; 18760395Sbde 188112365Sphkstruct devstat *devstat_new_entry(const void *dev_name, int unit_number, 189112288Sphk u_int32_t block_size, 190112288Sphk devstat_support_flags flags, 191112288Sphk devstat_type_flags device_type, 192112288Sphk devstat_priority priority); 193112000Sphk 19439229Sgibbsvoid devstat_remove_entry(struct devstat *ds); 195112288Sphkvoid devstat_start_transaction(struct devstat *ds, struct bintime *now); 196112258Sphkvoid devstat_start_transaction_bio(struct devstat *ds, struct bio *bp); 19739229Sgibbsvoid devstat_end_transaction(struct devstat *ds, u_int32_t bytes, 19839229Sgibbs devstat_tag_type tag_type, 199112288Sphk devstat_trans_flags flags, 200112288Sphk struct bintime *now, struct bintime *then); 20160395Sbdevoid devstat_end_transaction_bio(struct devstat *ds, struct bio *bp); 202256603Smavvoid devstat_end_transaction_bio_bt(struct devstat *ds, struct bio *bp, 203256603Smav struct bintime *now); 20439229Sgibbs#endif 20539229Sgibbs 20639229Sgibbs#endif /* _DEVICESTAT_H */ 207