1/*-
2 * Copyright (c) 2007 Pawel Jakub Dawidek <pjd@FreeBSD.org>
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 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 */
26
27#ifndef _OPENSOLARIS_SYS_KSTAT_H_
28#define	_OPENSOLARIS_SYS_KSTAT_H_
29
30#include <sys/sysctl.h>
31
32#define	KSTAT_TYPE_RAW		0	/* can be anything */
33					/* ks_ndata >= 1 */
34#define	KSTAT_TYPE_NAMED	1	/* name/value pair */
35					/* ks_ndata >= 1 */
36#define	KSTAT_TYPE_INTR		2	/* interrupt statistics */
37					/* ks_ndata == 1 */
38#define	KSTAT_TYPE_IO		3	/* I/O statistics */
39					/* ks_ndata == 1 */
40#define	KSTAT_TYPE_TIMER	4	/* event timer */
41					/* ks_ndata >= 1 */
42
43#define	KSTAT_NUM_TYPES		5
44
45#define	KSTAT_FLAG_VIRTUAL	0x01
46
47#define	KSTAT_READ	0
48#define	KSTAT_WRITE	1
49
50typedef struct kstat {
51	void	*ks_data;
52	u_int	 ks_ndata;
53#ifdef _KERNEL
54	struct sysctl_ctx_list ks_sysctl_ctx;
55	struct sysctl_oid *ks_sysctl_root;
56#endif
57	int		(*ks_update)(struct kstat *, int); /* dynamic update */
58	void		*ks_private;	/* arbitrary provider-private data */
59} kstat_t;
60
61typedef struct kstat_named {
62#define	KSTAT_STRLEN	31
63	char	name[KSTAT_STRLEN];
64#define	KSTAT_DATA_CHAR		0
65#define	KSTAT_DATA_INT32	1
66#define	KSTAT_DATA_UINT32	2
67#define	KSTAT_DATA_INT64	3
68#define	KSTAT_DATA_UINT64	4
69	uchar_t	data_type;
70#define	KSTAT_DESCLEN		128
71	char	desc[KSTAT_DESCLEN];
72	union {
73		uint64_t	ui64;
74	} value;
75} kstat_named_t;
76
77kstat_t *kstat_create(char *module, int instance, char *name, char *cls,
78    uchar_t type, ulong_t ndata, uchar_t flags);
79void kstat_install(kstat_t *ksp);
80void kstat_delete(kstat_t *ksp);
81void kstat_set_string(char *, const char *);
82void kstat_named_init(kstat_named_t *, const char *, uchar_t);
83
84#endif	/* _OPENSOLARIS_SYS_KSTAT_H_ */
85