xref: /freebsd/sys/arm64/vmm/vmm_stat.h (revision e1e636193db45630c7881246d25902e57c43d24e)
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 _VMM_STAT_H_
33 #define	_VMM_STAT_H_
34 
35 struct vm;
36 
37 #define	MAX_VMM_STAT_ELEMS	64		/* arbitrary */
38 
39 enum vmm_stat_scope {
40 	VMM_STAT_SCOPE_ANY,
41 };
42 
43 struct vmm_stat_type;
44 typedef void (*vmm_stat_func_t)(struct vcpu *vcpu,
45     struct vmm_stat_type *stat);
46 
47 struct vmm_stat_type {
48 	int	index;			/* position in the stats buffer */
49 	int	nelems;			/* standalone or array */
50 	const char *desc;		/* description of statistic */
51 	vmm_stat_func_t func;
52 	enum vmm_stat_scope scope;
53 };
54 
55 void	vmm_stat_register(void *arg);
56 
57 #define	VMM_STAT_FDEFINE(type, nelems, desc, func, scope)		\
58 	struct vmm_stat_type type[1] = {				\
59 		{ -1, nelems, desc, func, scope }			\
60 	};								\
61 	SYSINIT(type##_stat, SI_SUB_KLD, SI_ORDER_ANY, vmm_stat_register, type)
62 
63 #define VMM_STAT_DEFINE(type, nelems, desc, scope) 			\
64 	VMM_STAT_FDEFINE(type, nelems, desc, NULL, scope)
65 
66 #define	VMM_STAT_DECLARE(type)						\
67 	extern struct vmm_stat_type type[1]
68 
69 #define	VMM_STAT(type, desc)		\
70 	VMM_STAT_DEFINE(type, 1, desc, VMM_STAT_SCOPE_ANY)
71 
72 #define	VMM_STAT_FUNC(type, desc, func)	\
73 	VMM_STAT_FDEFINE(type, 1, desc, func, VMM_STAT_SCOPE_ANY)
74 
75 #define	VMM_STAT_ARRAY(type, nelems, desc)	\
76 	VMM_STAT_DEFINE(type, nelems, desc, VMM_STAT_SCOPE_ANY)
77 
78 void	*vmm_stat_alloc(void);
79 void	vmm_stat_init(void *vp);
80 void 	vmm_stat_free(void *vp);
81 
82 int	vmm_stat_copy(struct vcpu *vcpu, int index, int count,
83 	    int *num_stats, uint64_t *buf);
84 int	vmm_stat_desc_copy(int index, char *buf, int buflen);
85 
86 static void __inline
87 vmm_stat_array_incr(struct vcpu *vcpu, struct vmm_stat_type *vst, int statidx,
88     uint64_t x)
89 {
90 #ifdef VMM_KEEP_STATS
91 	uint64_t *stats;
92 
93 	stats = vcpu_stats(vcpu);
94 
95 	if (vst->index >= 0 && statidx < vst->nelems)
96 		stats[vst->index + statidx] += x;
97 #endif
98 }
99 
100 static void __inline
101 vmm_stat_array_set(struct vcpu *vcpu, struct vmm_stat_type *vst, int statidx,
102     uint64_t val)
103 {
104 #ifdef VMM_KEEP_STATS
105 	uint64_t *stats;
106 
107 	stats = vcpu_stats(vcpu);
108 
109 	if (vst->index >= 0 && statidx < vst->nelems)
110 		stats[vst->index + statidx] = val;
111 #endif
112 }
113 
114 static void __inline
115 vmm_stat_incr(struct vcpu *vcpu, struct vmm_stat_type *vst, uint64_t x)
116 {
117 
118 #ifdef VMM_KEEP_STATS
119 	vmm_stat_array_incr(vcpu, vst, 0, x);
120 #endif
121 }
122 
123 static void __inline
124 vmm_stat_set(struct vcpu *vcpu, struct vmm_stat_type *vst, uint64_t val)
125 {
126 
127 #ifdef VMM_KEEP_STATS
128 	vmm_stat_array_set(vcpu, vst, 0, val);
129 #endif
130 }
131 
132 VMM_STAT_DECLARE(VMEXIT_COUNT);
133 VMM_STAT_DECLARE(VMEXIT_UNKNOWN);
134 VMM_STAT_DECLARE(VMEXIT_WFI);
135 VMM_STAT_DECLARE(VMEXIT_WFE);
136 VMM_STAT_DECLARE(VMEXIT_HVC);
137 VMM_STAT_DECLARE(VMEXIT_MSR);
138 VMM_STAT_DECLARE(VMEXIT_DATA_ABORT);
139 VMM_STAT_DECLARE(VMEXIT_INSN_ABORT);
140 VMM_STAT_DECLARE(VMEXIT_UNHANDLED_SYNC);
141 VMM_STAT_DECLARE(VMEXIT_IRQ);
142 VMM_STAT_DECLARE(VMEXIT_FIQ);
143 VMM_STAT_DECLARE(VMEXIT_UNHANDLED_EL2);
144 VMM_STAT_DECLARE(VMEXIT_UNHANDLED);
145 #endif
146