xref: /freebsd/sys/dev/vmm/vmm_stat.h (revision 240c614d48cb0484bfe7876decdf6bbdcc99ba73)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 2011 NetApp, Inc.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 #ifndef _DEV_VMM_STAT_H_
33 #define	_DEV_VMM_STAT_H_
34 
35 #include <dev/vmm/vmm_vm.h>
36 
37 struct vm;
38 
39 #define	MAX_VMM_STAT_ELEMS	64		/* arbitrary */
40 
41 struct vmm_stat_type;
42 typedef void (*vmm_stat_func_t)(struct vcpu *vcpu,
43     struct vmm_stat_type *stat);
44 typedef bool (*vmm_stat_func_pred_t)(void);
45 
46 struct vmm_stat_type {
47 	int	index;			/* position in the stats buffer */
48 	int	nelems;			/* standalone or array */
49 	const char *desc;		/* description of statistic */
50 	vmm_stat_func_t func;
51 	vmm_stat_func_pred_t pred;	/* predicate to check during registration */
52 };
53 
54 void	vmm_stat_register(void *arg);
55 
56 #define	VMM_STAT_FDEFINE(type, _nelems, _desc, _func, _pred)		\
57 	struct vmm_stat_type type[1] = {				\
58 		{							\
59 			.index = -1,					\
60 			.nelems = _nelems,				\
61 			.desc = _desc,					\
62 			.func = _func,					\
63 			.pred = _pred,					\
64 		}							\
65 	};								\
66 	SYSINIT(type##_stat, SI_SUB_KLD, SI_ORDER_ANY, vmm_stat_register, type)
67 
68 #define VMM_STAT_DEFINE(type, nelems, desc, pred) 			\
69 	VMM_STAT_FDEFINE(type, nelems, desc, NULL, pred)
70 
71 #define	VMM_STAT_DECLARE(type)						\
72 	extern struct vmm_stat_type type[1]
73 
74 #define	VMM_STAT(type, desc)		\
75 	VMM_STAT_DEFINE(type, 1, desc, NULL)
76 
77 #define	VMM_STAT_FUNC(type, desc, func)	\
78 	VMM_STAT_FDEFINE(type, 1, desc, func, NULL)
79 
80 #define	VMM_STAT_ARRAY(type, nelems, desc)	\
81 	VMM_STAT_DEFINE(type, nelems, desc, NULL)
82 
83 void	*vmm_stat_alloc(void);
84 void	vmm_stat_init(void *vp);
85 void 	vmm_stat_free(void *vp);
86 
87 int	vmm_stat_copy(struct vcpu *vcpu, int index, int count,
88 	    int *num_stats, uint64_t *buf);
89 int	vmm_stat_desc_copy(int index, char *buf, int buflen);
90 
91 static void __inline
92 vmm_stat_array_incr(struct vcpu *vcpu, struct vmm_stat_type *vst, int statidx,
93     uint64_t x)
94 {
95 #ifdef VMM_KEEP_STATS
96 	uint64_t *stats;
97 
98 	stats = vcpu_stats(vcpu);
99 
100 	if (vst->index >= 0 && statidx < vst->nelems)
101 		stats[vst->index + statidx] += x;
102 #endif
103 }
104 
105 static void __inline
106 vmm_stat_array_set(struct vcpu *vcpu, struct vmm_stat_type *vst, int statidx,
107     uint64_t val)
108 {
109 #ifdef VMM_KEEP_STATS
110 	uint64_t *stats;
111 
112 	stats = vcpu_stats(vcpu);
113 
114 	if (vst->index >= 0 && statidx < vst->nelems)
115 		stats[vst->index + statidx] = val;
116 #endif
117 }
118 
119 static void __inline
120 vmm_stat_incr(struct vcpu *vcpu, struct vmm_stat_type *vst, uint64_t x)
121 {
122 
123 #ifdef VMM_KEEP_STATS
124 	vmm_stat_array_incr(vcpu, vst, 0, x);
125 #endif
126 }
127 
128 static void __inline
129 vmm_stat_set(struct vcpu *vcpu, struct vmm_stat_type *vst, uint64_t val)
130 {
131 
132 #ifdef VMM_KEEP_STATS
133 	vmm_stat_array_set(vcpu, vst, 0, val);
134 #endif
135 }
136 
137 #endif /* !_DEV_VMM_STAT_H_ */
138