xref: /illumos-gate/usr/src/uts/i86pc/io/vmm/vmm_stat.h (revision 2606939d)
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  * $FreeBSD$
32  */
33 /*
34  * Copyright 2018 Joyent, Inc.
35  */
36 
37 #ifndef _VMM_STAT_H_
38 #define	_VMM_STAT_H_
39 
40 #include <machine/vmm.h>
41 
42 struct vm;
43 
44 #ifdef __FreeBSD__
45 #define	MAX_VMM_STAT_ELEMS	64			/* arbitrary */
46 #else
47 #define	MAX_VMM_STAT_ELEMS	(64 + VM_MAXCPU)	/* arbitrary */
48 #endif
49 
50 enum vmm_stat_scope {
51 	VMM_STAT_SCOPE_ANY,
52 	VMM_STAT_SCOPE_INTEL,		/* Intel VMX specific statistic */
53 	VMM_STAT_SCOPE_AMD,		/* AMD SVM specific statistic */
54 };
55 
56 struct vmm_stat_type;
57 typedef void (*vmm_stat_func_t)(struct vm *vm, int vcpu,
58     struct vmm_stat_type *stat);
59 
60 struct vmm_stat_type {
61 	int	index;			/* position in the stats buffer */
62 	int	nelems;			/* standalone or array */
63 	const char *desc;		/* description of statistic */
64 	vmm_stat_func_t func;
65 	enum vmm_stat_scope scope;
66 };
67 
68 void	vmm_stat_register(void *arg);
69 
70 #define	VMM_STAT_FDEFINE(type, nelems, desc, func, scope)		\
71 	struct vmm_stat_type type[1] = {				\
72 		{ -1, nelems, desc, func, scope }			\
73 	};								\
74 	SYSINIT(type##_stat, SI_SUB_KLD, SI_ORDER_ANY, vmm_stat_register, type)
75 
76 #define	VMM_STAT_DEFINE(type, nelems, desc, scope)			\
77 	VMM_STAT_FDEFINE(type, nelems, desc, NULL, scope)
78 
79 #define	VMM_STAT_DECLARE(type)						\
80 	extern struct vmm_stat_type type[1]
81 
82 #define	VMM_STAT(type, desc)		\
83 	VMM_STAT_DEFINE(type, 1, desc, VMM_STAT_SCOPE_ANY)
84 #define	VMM_STAT_INTEL(type, desc)	\
85 	VMM_STAT_DEFINE(type, 1, desc, VMM_STAT_SCOPE_INTEL)
86 #define	VMM_STAT_AMD(type, desc)	\
87 	VMM_STAT_DEFINE(type, 1, desc, VMM_STAT_SCOPE_AMD)
88 
89 #define	VMM_STAT_FUNC(type, desc, func)	\
90 	VMM_STAT_FDEFINE(type, 1, desc, func, VMM_STAT_SCOPE_ANY)
91 
92 #define	VMM_STAT_ARRAY(type, nelems, desc)	\
93 	VMM_STAT_DEFINE(type, nelems, desc, VMM_STAT_SCOPE_ANY)
94 
95 void	*vmm_stat_alloc(void);
96 void	vmm_stat_init(void *vp);
97 void	vmm_stat_free(void *vp);
98 
99 /*
100  * 'buf' should be at least fit 'MAX_VMM_STAT_TYPES' entries
101  */
102 int	vmm_stat_copy(struct vm *vm, int vcpu, int *num_stats, uint64_t *buf);
103 int	vmm_stat_desc_copy(int index, char *buf, int buflen);
104 
105 static __inline void
vmm_stat_array_incr(struct vm * vm,int vcpu,struct vmm_stat_type * vst,int statidx,uint64_t x)106 vmm_stat_array_incr(struct vm *vm, int vcpu, struct vmm_stat_type *vst,
107     int statidx, uint64_t x)
108 {
109 #ifdef VMM_KEEP_STATS
110 	uint64_t *stats;
111 
112 	stats = vcpu_stats(vm, vcpu);
113 
114 	if (vst->index >= 0 && statidx < vst->nelems)
115 		stats[vst->index + statidx] += x;
116 #endif
117 }
118 
119 static __inline void
vmm_stat_array_set(struct vm * vm,int vcpu,struct vmm_stat_type * vst,int statidx,uint64_t val)120 vmm_stat_array_set(struct vm *vm, int vcpu, struct vmm_stat_type *vst,
121     int statidx, uint64_t val)
122 {
123 #ifdef VMM_KEEP_STATS
124 	uint64_t *stats;
125 
126 	stats = vcpu_stats(vm, vcpu);
127 
128 	if (vst->index >= 0 && statidx < vst->nelems)
129 		stats[vst->index + statidx] = val;
130 #endif
131 }
132 
133 static __inline void
vmm_stat_incr(struct vm * vm,int vcpu,struct vmm_stat_type * vst,uint64_t x)134 vmm_stat_incr(struct vm *vm, int vcpu, struct vmm_stat_type *vst, uint64_t x)
135 {
136 
137 #ifdef VMM_KEEP_STATS
138 	vmm_stat_array_incr(vm, vcpu, vst, 0, x);
139 #endif
140 }
141 
142 static __inline void
vmm_stat_set(struct vm * vm,int vcpu,struct vmm_stat_type * vst,uint64_t val)143 vmm_stat_set(struct vm *vm, int vcpu, struct vmm_stat_type *vst, uint64_t val)
144 {
145 
146 #ifdef VMM_KEEP_STATS
147 	vmm_stat_array_set(vm, vcpu, vst, 0, val);
148 #endif
149 }
150 
151 VMM_STAT_DECLARE(VCPU_MIGRATIONS);
152 VMM_STAT_DECLARE(VMEXIT_COUNT);
153 VMM_STAT_DECLARE(VMEXIT_EXTINT);
154 VMM_STAT_DECLARE(VMEXIT_HLT);
155 VMM_STAT_DECLARE(VMEXIT_CR_ACCESS);
156 VMM_STAT_DECLARE(VMEXIT_RDMSR);
157 VMM_STAT_DECLARE(VMEXIT_WRMSR);
158 VMM_STAT_DECLARE(VMEXIT_MTRAP);
159 VMM_STAT_DECLARE(VMEXIT_PAUSE);
160 VMM_STAT_DECLARE(VMEXIT_INTR_WINDOW);
161 VMM_STAT_DECLARE(VMEXIT_NMI_WINDOW);
162 VMM_STAT_DECLARE(VMEXIT_INOUT);
163 VMM_STAT_DECLARE(VMEXIT_CPUID);
164 VMM_STAT_DECLARE(VMEXIT_NESTED_FAULT);
165 VMM_STAT_DECLARE(VMEXIT_MMIO_EMUL);
166 VMM_STAT_DECLARE(VMEXIT_UNKNOWN);
167 VMM_STAT_DECLARE(VMEXIT_ASTPENDING);
168 VMM_STAT_DECLARE(VMEXIT_EXCEPTION);
169 VMM_STAT_DECLARE(VMEXIT_REQIDLE);
170 VMM_STAT_DECLARE(VMEXIT_RUN_STATE);
171 #endif
172