devicestat.h revision 112288 
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 112288 2003-03-15 21:59:06Z 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	   6
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#define DEVSTAT_N_TRANS_FLAGS	4
72
73typedef enum {
74	DEVSTAT_TAG_SIMPLE	= 0x00,
75	DEVSTAT_TAG_HEAD	= 0x01,
76	DEVSTAT_TAG_ORDERED	= 0x02,
77	DEVSTAT_TAG_NONE	= 0x03
78} devstat_tag_type;
79
80typedef enum {
81	DEVSTAT_PRIORITY_MIN	= 0x000,
82	DEVSTAT_PRIORITY_OTHER	= 0x020,
83	DEVSTAT_PRIORITY_PASS	= 0x030,
84	DEVSTAT_PRIORITY_FD	= 0x040,
85	DEVSTAT_PRIORITY_WFD	= 0x050,
86	DEVSTAT_PRIORITY_TAPE	= 0x060,
87	DEVSTAT_PRIORITY_CD	= 0x090,
88	DEVSTAT_PRIORITY_DISK	= 0x110,
89	DEVSTAT_PRIORITY_ARRAY	= 0x120,
90	DEVSTAT_PRIORITY_MAX	= 0xfff
91} devstat_priority;
92
93/*
94 * These types are intended to aid statistics gathering/display programs.
95 * The first 13 types (up to the 'target' flag) are identical numerically
96 * to the SCSI device type numbers.  The next 3 types designate the device
97 * interface.  Currently the choices are IDE, SCSI, and 'other'.  The last
98 * flag specifies whether or not the given device is a passthrough device
99 * or not.  If it is a passthrough device, the lower 4 bits specify which
100 * type of physical device lies under the passthrough device, and the next
101 * 4 bits specify the interface.
102 */
103typedef enum {
104	DEVSTAT_TYPE_DIRECT	= 0x000,
105	DEVSTAT_TYPE_SEQUENTIAL	= 0x001,
106	DEVSTAT_TYPE_PRINTER	= 0x002,
107	DEVSTAT_TYPE_PROCESSOR	= 0x003,
108	DEVSTAT_TYPE_WORM	= 0x004,
109	DEVSTAT_TYPE_CDROM	= 0x005,
110	DEVSTAT_TYPE_SCANNER	= 0x006,
111	DEVSTAT_TYPE_OPTICAL	= 0x007,
112	DEVSTAT_TYPE_CHANGER	= 0x008,
113	DEVSTAT_TYPE_COMM	= 0x009,
114	DEVSTAT_TYPE_ASC0	= 0x00a,
115	DEVSTAT_TYPE_ASC1	= 0x00b,
116	DEVSTAT_TYPE_STORARRAY	= 0x00c,
117	DEVSTAT_TYPE_ENCLOSURE	= 0x00d,
118	DEVSTAT_TYPE_FLOPPY	= 0x00e,
119	DEVSTAT_TYPE_MASK	= 0x00f,
120	DEVSTAT_TYPE_IF_SCSI	= 0x010,
121	DEVSTAT_TYPE_IF_IDE	= 0x020,
122	DEVSTAT_TYPE_IF_OTHER	= 0x030,
123	DEVSTAT_TYPE_IF_MASK	= 0x0f0,
124	DEVSTAT_TYPE_PASS	= 0x100
125} devstat_type_flags;
126
127struct devstat {
128	/* Internal house-keeping fields */
129	u_int			sequence0;	     /* Update sequence# */
130	int			allocated;	     /* Allocated entry */
131	u_int			start_count;	     /* started ops */
132	u_int			end_count;	     /* completed ops */
133	struct bintime		busy_from;	     /*
134						      * busy time unaccounted
135						      * for since this time
136						      */
137	STAILQ_ENTRY(devstat) 	dev_links;
138	u_int32_t		device_number;	     /*
139						      * Devstat device
140						      * number.
141						      */
142	char			device_name[DEVSTAT_NAME_LEN];
143	int			unit_number;
144	u_int64_t		bytes[DEVSTAT_N_TRANS_FLAGS];
145	u_int64_t		operations[DEVSTAT_N_TRANS_FLAGS];
146	struct bintime		duration[DEVSTAT_N_TRANS_FLAGS];
147	struct bintime		busy_time;
148	struct bintime          creation_time;       /*
149						      * Time the device was
150						      * created.
151						      */
152	u_int32_t		block_size;	     /* Block size, bytes */
153	u_int64_t		tag_types[3];	     /*
154						      * The number of
155						      * simple, ordered,
156						      * and head of queue
157						      * tags sent.
158						      */
159	devstat_support_flags	flags;		     /*
160						      * Which statistics
161						      * are supported by a
162						      * given device.
163						      */
164	devstat_type_flags	device_type;	     /* Device type */
165	devstat_priority	priority;	     /* Controls list pos. */
166	void			*id;		     /*
167						      * Identification for
168						      * GEOM nodes
169						      */
170	u_int			sequence1;	     /* Update sequence# */
171};
172
173STAILQ_HEAD(devstatlist, devstat);
174
175#ifdef _KERNEL
176struct bio;
177
178struct devstat *devstat_new_entry(const char *dev_name, int unit_number,
179				  u_int32_t block_size,
180				  devstat_support_flags flags,
181				  devstat_type_flags device_type,
182				  devstat_priority priority);
183
184void devstat_remove_entry(struct devstat *ds);
185void devstat_start_transaction(struct devstat *ds, struct bintime *now);
186void devstat_start_transaction_bio(struct devstat *ds, struct bio *bp);
187void devstat_end_transaction(struct devstat *ds, u_int32_t bytes,
188			     devstat_tag_type tag_type,
189			     devstat_trans_flags flags,
190			     struct bintime *now, struct bintime *then);
191void devstat_end_transaction_bio(struct devstat *ds, struct bio *bp);
192#endif
193
194#endif /* _DEVICESTAT_H */
195