xref: /freebsd/lib/libdevstat/devstat.h (revision 0640d357f29fb1c0daaaffadd0416c5981413afd)
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: devstat.h,v 1.1 1998/09/15 06:23:21 gibbs Exp $
29  */
30 
31 #ifndef _DEVSTAT_H
32 #define _DEVSTAT_H
33 #include <sys/cdefs.h>
34 #include <sys/devicestat.h>
35 
36 #define DEVSTAT_ERRBUF_SIZE  2048 /* size of the devstat library error string */
37 
38 extern char devstat_errbuf[];
39 
40 typedef enum {
41 	DEVSTAT_MATCH_NONE	= 0x00,
42 	DEVSTAT_MATCH_TYPE	= 0x01,
43 	DEVSTAT_MATCH_IF	= 0x02,
44 	DEVSTAT_MATCH_PASS	= 0x04
45 } devstat_match_flags;
46 
47 struct devstat_match {
48 	devstat_match_flags	match_fields;
49 	devstat_type_flags	device_type;
50 	int			num_match_categories;
51 };
52 
53 struct devstat_match_table {
54 	char 			*match_str;
55 	devstat_type_flags	type;
56 	devstat_match_flags	match_field;
57 };
58 
59 struct device_selection {
60 	u_int32_t	device_number;
61 	char		device_name[DEVSTAT_NAME_LEN];
62 	int		unit_number;
63 	int		selected;
64 	u_int64_t	bytes;
65 	int		position;
66 };
67 
68 struct devinfo {
69 	struct devstat	*devices;
70 	u_int8_t	*mem_ptr;
71 	long		generation;
72 	int		numdevs;
73 };
74 
75 struct statinfo {
76 	long		cp_time[CPUSTATES];
77 	long		tk_nin;
78 	long		tk_nout;
79 	struct devinfo	*dinfo;
80 	struct timeval	busy_time;
81 };
82 
83 typedef enum {
84 	DS_SELECT_ADD,
85 	DS_SELECT_ONLY,
86 	DS_SELECT_REMOVE,
87 	DS_SELECT_ADDONLY
88 } devstat_select_mode;
89 
90 __BEGIN_DECLS
91 int getnumdevs(void);
92 long getgeneration(void);
93 int getversion(void);
94 int checkversion(void);
95 int getdevs(struct statinfo *stats);
96 int selectdevs(struct device_selection **dev_select, int *num_selected,
97 	       int *num_selections, long *select_generation,
98 	       long current_generation, struct devstat *devices, int numdevs,
99 	       struct devstat_match *matches, int num_matches,
100 	       char **dev_selections, int num_dev_selections,
101 	       devstat_select_mode select_mode, int maxshowdevs,
102 	       int perf_select);
103 int buildmatch(char *match_str, struct devstat_match **matches,
104 	       int *num_matches);
105 int compute_stats(struct devstat *current, struct devstat *previous,
106 		  long double etime, u_int64_t *total_bytes,
107 		  u_int64_t *total_transfers, u_int64_t *total_blocks,
108 		  long double *kb_per_transfer,
109 		  long double *transfers_per_second, long double *mb_per_second,
110 		  long double *blocks_per_second,
111 		  long double *ms_per_transaction);
112 long double compute_etime(struct timeval cur_time, struct timeval prev_time);
113 __END_DECLS
114 
115 #endif /* _DEVSTAT_H  */
116