xref: /freebsd/sys/amd64/vmm/intel/vmx_msr.h (revision 0957b409a90fd597c1e9124cbaf3edd2b488f4ac)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
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  *
16  * THIS SOFTWARE IS PROVIDED BY NETAPP, INC ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL NETAPP, INC OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 #ifndef _VMX_MSR_H_
32 #define	_VMX_MSR_H_
33 
34 struct vmx;
35 
36 void vmx_msr_init(void);
37 void vmx_msr_guest_init(struct vmx *vmx, int vcpuid);
38 void vmx_msr_guest_enter(struct vmx *vmx, int vcpuid);
39 void vmx_msr_guest_exit(struct vmx *vmx, int vcpuid);
40 int vmx_rdmsr(struct vmx *, int vcpuid, u_int num, uint64_t *val, bool *retu);
41 int vmx_wrmsr(struct vmx *, int vcpuid, u_int num, uint64_t val, bool *retu);
42 
43 uint32_t vmx_revision(void);
44 
45 int vmx_set_ctlreg(int ctl_reg, int true_ctl_reg, uint32_t ones_mask,
46 		   uint32_t zeros_mask, uint32_t *retval);
47 
48 /*
49  * According to Section 21.10.4 "Software Access to Related Structures",
50  * changes to data structures pointed to by the VMCS must be made only when
51  * there is no logical processor with a current VMCS that points to the
52  * data structure.
53  *
54  * This pretty much limits us to configuring the MSR bitmap before VMCS
55  * initialization for SMP VMs. Unless of course we do it the hard way - which
56  * would involve some form of synchronization between the vcpus to vmclear
57  * all VMCSs' that point to the bitmap.
58  */
59 #define	MSR_BITMAP_ACCESS_NONE	0x0
60 #define	MSR_BITMAP_ACCESS_READ	0x1
61 #define	MSR_BITMAP_ACCESS_WRITE	0x2
62 #define	MSR_BITMAP_ACCESS_RW	(MSR_BITMAP_ACCESS_READ|MSR_BITMAP_ACCESS_WRITE)
63 void	msr_bitmap_initialize(char *bitmap);
64 int	msr_bitmap_change_access(char *bitmap, u_int msr, int access);
65 
66 #define	guest_msr_rw(vmx, msr) \
67     msr_bitmap_change_access((vmx)->msr_bitmap, (msr), MSR_BITMAP_ACCESS_RW)
68 
69 #define	guest_msr_ro(vmx, msr) \
70     msr_bitmap_change_access((vmx)->msr_bitmap, (msr), MSR_BITMAP_ACCESS_READ)
71 
72 #endif
73