xref: /illumos-gate/usr/src/uts/intel/io/vmm/amd/svm_msr.c (revision f37b3cbb)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2014, Neel Natu (neel@freebsd.org)
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 unmodified, this list of conditions, and the following
12  *    disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28 /*
29  * This file and its contents are supplied under the terms of the
30  * Common Development and Distribution License ("CDDL"), version 1.0.
31  * You may only use this file in accordance with the terms of version
32  * 1.0 of the CDDL.
33  *
34  * A full copy of the text of the CDDL should have accompanied this
35  * source.  A copy of the CDDL is also available via the Internet at
36  * http://www.illumos.org/license/CDDL.
37  *
38  * Copyright 2020 Oxide Computer Company
39  */
40 
41 #include <sys/cdefs.h>
42 __FBSDID("$FreeBSD$");
43 
44 #include <sys/param.h>
45 #include <sys/errno.h>
46 #include <sys/systm.h>
47 #include <sys/x86_archext.h>
48 #include <sys/privregs.h>
49 
50 #include <machine/cpufunc.h>
51 #include <machine/specialreg.h>
52 #include <machine/vmm.h>
53 #include <sys/vmm_kernel.h>
54 
55 #include "svm.h"
56 #include "vmcb.h"
57 #include "svm_softc.h"
58 #include "svm_msr.h"
59 
60 #ifndef MSR_AMDK8_IPM
61 #define	MSR_AMDK8_IPM	0xc0010055
62 #endif
63 
64 enum {
65 	IDX_MSR_LSTAR,
66 	IDX_MSR_CSTAR,
67 	IDX_MSR_STAR,
68 	IDX_MSR_SF_MASK,
69 	HOST_MSR_NUM		/* must be the last enumeration */
70 };
71 CTASSERT(HOST_MSR_NUM == SVM_HOST_MSR_NUM);
72 
73 void
74 svm_msr_init(void)
75 {
76 	/*
77 	 * These MSRs do vary between CPUs on illumos, so saving system-wide
78 	 * values for them serves no purpose.
79 	 */
80 }
81 
82 void
83 svm_msr_guest_init(struct svm_softc *sc, int vcpu)
84 {
85 	/*
86 	 * All the MSRs accessible to the guest are either saved/restored by
87 	 * hardware on every #VMEXIT/VMRUN (e.g., G_PAT) or are saved/restored
88 	 * by VMSAVE/VMLOAD (e.g., MSR_GSBASE).
89 	 *
90 	 * There are no guest MSRs that are saved/restored "by hand" so nothing
91 	 * more to do here.
92 	 */
93 }
94 
95 void
96 svm_msr_guest_enter(struct svm_softc *sc, int vcpu)
97 {
98 	uint64_t *host_msrs = sc->host_msrs[vcpu];
99 
100 	/*
101 	 * Save host MSRs (if any) and restore guest MSRs (if any).
102 	 */
103 	host_msrs[IDX_MSR_LSTAR] = rdmsr(MSR_LSTAR);
104 	host_msrs[IDX_MSR_CSTAR] = rdmsr(MSR_CSTAR);
105 	host_msrs[IDX_MSR_STAR] = rdmsr(MSR_STAR);
106 	host_msrs[IDX_MSR_SF_MASK] = rdmsr(MSR_SF_MASK);
107 
108 	/*
109 	 * Set the frequency multiplier MSR to enable guest TSC scaling if
110 	 * needed.
111 	 */
112 	uint64_t mult = vm_get_freq_multiplier(sc->vm);
113 	if (mult != VM_TSCM_NOSCALE) {
114 		wrmsr(MSR_AMD_TSC_RATIO, mult);
115 	}
116 }
117 
118 void
119 svm_msr_guest_exit(struct svm_softc *sc, int vcpu)
120 {
121 	uint64_t *host_msrs = sc->host_msrs[vcpu];
122 
123 	/*
124 	 * Save guest MSRs (if any) and restore host MSRs.
125 	 */
126 	wrmsr(MSR_LSTAR, host_msrs[IDX_MSR_LSTAR]);
127 	wrmsr(MSR_CSTAR, host_msrs[IDX_MSR_CSTAR]);
128 	wrmsr(MSR_STAR, host_msrs[IDX_MSR_STAR]);
129 	wrmsr(MSR_SF_MASK, host_msrs[IDX_MSR_SF_MASK]);
130 
131 	/* Reset frequency multiplier MSR */
132 	wrmsr(MSR_AMD_TSC_RATIO, AMD_TSCM_RESET_VAL);
133 
134 	/* MSR_KGSBASE will be restored on the way back to userspace */
135 }
136 
137 vm_msr_result_t
138 svm_rdmsr(struct svm_softc *sc, int vcpu, uint32_t num, uint64_t *result)
139 {
140 	switch (num) {
141 	case MSR_SYSCFG:
142 	case MSR_AMDK8_IPM:
143 	case MSR_EXTFEATURES:
144 		*result = 0;
145 		break;
146 	case MSR_AMD_DE_CFG:
147 		*result = 0;
148 		/*
149 		 * Bit 1 of DE_CFG is defined by AMD to control whether the
150 		 * lfence instruction is serializing.  Practically all CPUs
151 		 * supported by bhyve also contain this MSR, making it safe to
152 		 * expose unconditionally.
153 		 */
154 		if (is_x86_feature(x86_featureset, X86FSET_LFENCE_SER)) {
155 			*result |= AMD_DE_CFG_LFENCE_DISPATCH;
156 		}
157 		break;
158 	default:
159 		return (VMR_UNHANLDED);
160 	}
161 	return (VMR_OK);
162 }
163 
164 vm_msr_result_t
165 svm_wrmsr(struct svm_softc *sc, int vcpu, uint32_t num, uint64_t val)
166 {
167 	switch (num) {
168 	case MSR_SYSCFG:
169 		/* Ignore writes */
170 		break;
171 	case MSR_AMD_DE_CFG:
172 		/* Ignore writes */
173 		break;
174 	case MSR_AMDK8_IPM:
175 		/*
176 		 * Ignore writes to the "Interrupt Pending Message" MSR.
177 		 */
178 		break;
179 	case MSR_K8_UCODE_UPDATE:
180 		/*
181 		 * Ignore writes to microcode update register.
182 		 */
183 		break;
184 	case MSR_EXTFEATURES:
185 		break;
186 	default:
187 		return (VMR_UNHANLDED);
188 	}
189 
190 	return (VMR_OK);
191 }
192