devicestat.h revision 50477 
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 50477 1999-08-28 01:08:13Z peter $
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	   3
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
75typedef enum {
76	DEVSTAT_PRIORITY_MIN	= 0x000,
77	DEVSTAT_PRIORITY_OTHER	= 0x020,
78	DEVSTAT_PRIORITY_PASS	= 0x030,
79	DEVSTAT_PRIORITY_FD	= 0x040,
80	DEVSTAT_PRIORITY_WFD	= 0x050,
81	DEVSTAT_PRIORITY_SA	= 0x060,
82	DEVSTAT_PRIORITY_OCD	= 0x070,
83	DEVSTAT_PRIORITY_WCD	= 0x080,
84	DEVSTAT_PRIORITY_CD	= 0x090,
85	DEVSTAT_PRIORITY_WD	= 0x100,
86	DEVSTAT_PRIORITY_DA	= 0x110,
87	DEVSTAT_PRIORITY_CCD	= 0x120,
88	DEVSTAT_PRIORITY_MAX	= 0xfff
89} devstat_priority;
90
91/*
92 * These types are intended to aid statistics gathering/display programs.
93 * The first 13 types (up to the 'target' flag) are identical numerically
94 * to the SCSI device type numbers.  The next 3 types designate the device
95 * interface.  Currently the choices are IDE, SCSI, and 'other'.  The last
96 * flag specifies whether or not the given device is a passthrough device
97 * or not.  If it is a passthrough device, the lower 4 bits specify which
98 * type of physical device lies under the passthrough device, and the next
99 * 4 bits specify the interface.
100 */
101typedef enum {
102	DEVSTAT_TYPE_DIRECT	= 0x000,
103	DEVSTAT_TYPE_SEQUENTIAL	= 0x001,
104	DEVSTAT_TYPE_PRINTER	= 0x002,
105	DEVSTAT_TYPE_PROCESSOR	= 0x003,
106	DEVSTAT_TYPE_WORM	= 0x004,
107	DEVSTAT_TYPE_CDROM	= 0x005,
108	DEVSTAT_TYPE_SCANNER	= 0x006,
109	DEVSTAT_TYPE_OPTICAL	= 0x007,
110	DEVSTAT_TYPE_CHANGER	= 0x008,
111	DEVSTAT_TYPE_COMM	= 0x009,
112	DEVSTAT_TYPE_ASC0	= 0x00a,
113	DEVSTAT_TYPE_ASC1	= 0x00b,
114	DEVSTAT_TYPE_STORARRAY	= 0x00c,
115	DEVSTAT_TYPE_ENCLOSURE	= 0x00d,
116	DEVSTAT_TYPE_FLOPPY	= 0x00e,
117	DEVSTAT_TYPE_MASK	= 0x00f,
118	DEVSTAT_TYPE_IF_SCSI	= 0x010,
119	DEVSTAT_TYPE_IF_IDE	= 0x020,
120	DEVSTAT_TYPE_IF_OTHER	= 0x030,
121	DEVSTAT_TYPE_IF_MASK	= 0x0f0,
122	DEVSTAT_TYPE_PASS	= 0x100
123} devstat_type_flags;
124
125struct devstat {
126	STAILQ_ENTRY(devstat) 	dev_links;
127	u_int32_t		device_number;	     /*
128						      * Devstat device
129						      * number.
130						      */
131	char			device_name[DEVSTAT_NAME_LEN];
132	int			unit_number;
133	u_int64_t		bytes_written;	     /*
134						      * Total bytes written
135						      * to a device.
136						      */
137	u_int64_t		bytes_read;	     /*
138						      * Total bytes read
139						      * from a device.
140						      */
141	u_int64_t		num_reads;	     /*
142						      * Total number of
143						      * read requests to
144						      * the device.
145						      */
146	u_int64_t		num_writes;	     /*
147						      * Total number of
148						      * write requests to
149						      * the device.
150						      */
151	u_int64_t		num_other;	     /*
152						      * Total number of
153						      * transactions that
154						      * don't read or write
155						      * data.
156						      */
157	int32_t			busy_count;	     /*
158						      * Total number of
159						      * transactions
160						      * outstanding for
161						      * the device.
162						      */
163	u_int32_t		block_size;	     /* Block size, bytes */
164	u_int64_t		tag_types[3];	     /*
165						      * The number of
166						      * simple, ordered,
167						      * and head of queue
168						      * tags sent.
169						      */
170	struct timeval		dev_creation_time;   /*
171						      * Time the device was
172						      * created.
173						      */
174	struct timeval 		busy_time;	     /*
175						      * Total amount of
176						      * time drive has spent
177						      * processing requests.
178						      */
179	struct timeval		start_time;	     /*
180						      * The time when
181						      * busy_count was
182						      * last == 0.  Or, the
183						      * start of the latest
184						      * busy period.
185						      */
186	struct timeval		last_comp_time;	     /*
187						      * Last time a
188						      * transaction was
189						      * completed.
190						      */
191
192	devstat_support_flags	flags;		     /*
193						      * Which statistics
194						      * are supported by a
195						      * given device.
196						      */
197	devstat_type_flags	device_type;	     /* Device type */
198	devstat_priority	priority;	     /* Controls list pos. */
199};
200
201#ifdef KERNEL
202void devstat_add_entry(struct devstat *ds, const char *dev_name,
203		       int unit_number, u_int32_t block_size,
204		       devstat_support_flags flags,
205		       devstat_type_flags device_type,
206		       devstat_priority priority);
207void devstat_remove_entry(struct devstat *ds);
208void devstat_start_transaction(struct devstat *ds);
209void devstat_end_transaction(struct devstat *ds, u_int32_t bytes,
210			     devstat_tag_type tag_type,
211			     devstat_trans_flags flags);
212#endif
213
214#endif /* _DEVICESTAT_H */
215