xref: /netbsd/external/cddl/osnet/sys/sys/kstat.h (revision eada09ac)
1 /*	$NetBSD: kstat.h,v 1.4 2018/05/28 21:05:10 chs Exp $	*/
2 
3 /*-
4  * Copyright (c) 2009 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Andrew Doran.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 /*-
33  * Copyright (c) 2007 Pawel Jakub Dawidek <pjd@FreeBSD.org>
34  * All rights reserved.
35  *
36  * Redistribution and use in source and binary forms, with or without
37  * modification, are permitted provided that the following conditions
38  * are met:
39  * 1. Redistributions of source code must retain the above copyright
40  *    notice, this list of conditions and the following disclaimer.
41  * 2. Redistributions in binary form must reproduce the above copyright
42  *    notice, this list of conditions and the following disclaimer in the
43  *    documentation and/or other materials provided with the distribution.
44  *
45  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
46  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
47  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
48  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
49  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
50  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
51  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
52  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
53  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
54  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
55  * SUCH DAMAGE.
56  *
57  * $FreeBSD: head/sys/cddl/compat/opensolaris/sys/kstat.h 315896 2017-03-24 09:37:00Z mav $
58  */
59 
60 #ifndef _OPENSOLARIS_SYS_KSTAT_H_
61 #define	_OPENSOLARIS_SYS_KSTAT_H_
62 
63 #include <sys/sysctl.h>
64 
65 #define	KSTAT_TYPE_NAMED	1
66 
67 #define	KSTAT_FLAG_VIRTUAL	0x01
68 
69 #define	KSTAT_READ	0
70 #define	KSTAT_WRITE	1
71 
72 typedef struct kstat {
73 	void	*ks_data;
74 	u_int	 ks_ndata;
75 #ifdef _KERNEL
76 	struct sysctllog *ks_clog;
77 	const struct sysctlnode *ks_node;
78 #endif
79 	int		(*ks_update)(struct kstat *, int); /* dynamic update */
80 	void		*ks_private;	/* arbitrary provider-private data */
81 } kstat_t;
82 
83 typedef struct kstat_named {
84 #define	KSTAT_STRLEN	31
85 	char	name[KSTAT_STRLEN];
86 #define	KSTAT_DATA_CHAR		0
87 #define	KSTAT_DATA_INT32	1
88 #define	KSTAT_DATA_UINT32	2
89 #define	KSTAT_DATA_INT64	3
90 #define	KSTAT_DATA_UINT64	4
91 	uchar_t	data_type;
92 #define	KSTAT_DESCLEN		128
93 	char	desc[KSTAT_DESCLEN];
94 	union {
95 		uint64_t	ui64;
96 	} value;
97 } kstat_named_t;
98 
99 kstat_t *kstat_create(char *module, int instance, char *name, char *class,
100     uchar_t type, ulong_t ndata, uchar_t flags);
101 void kstat_install(kstat_t *ksp);
102 void kstat_delete(kstat_t *ksp);
103 void kstat_set_string(char *, const char *);
104 void kstat_named_init(kstat_named_t *, const char *, uchar_t);
105 
106 #endif	/* _OPENSOLARIS_SYS_KSTAT_H_ */
107