xref: /illumos-gate/usr/src/uts/intel/io/vmm/intel/vmx_msr.h (revision fdad6fbf87b201fdb96a704fc41fa8be1e4efbc8)
1 /*-
2  * SPDX-License-Identifier: BSD-2-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  *
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 /*
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 /* This file is dual-licensed; see usr/src/contrib/bhyve/LICENSE */
39 
40 /*
41  * Copyright 2021 Oxide Computer Company
42  */
43 
44 #ifndef _VMX_MSR_H_
45 #define	_VMX_MSR_H_
46 
47 void vmx_msr_init(void);
48 void vmx_msr_guest_init(struct vmx *vmx, int vcpuid);
49 void vmx_msr_guest_enter(struct vmx *vmx, int vcpuid);
50 void vmx_msr_guest_exit(struct vmx *vmx, int vcpuid);
51 vm_msr_result_t vmx_rdmsr(struct vmx *, int, uint32_t, uint64_t *);
52 vm_msr_result_t vmx_wrmsr(struct vmx *, int, uint32_t, uint64_t);
53 
54 int vmx_set_ctlreg(int ctl_reg, int true_ctl_reg, uint32_t ones_mask,
55     uint32_t zeros_mask, uint32_t *retval);
56 
57 /*
58  * According to Section 21.10.4 "Software Access to Related Structures",
59  * changes to data structures pointed to by the VMCS must be made only when
60  * there is no logical processor with a current VMCS that points to the
61  * data structure.
62  *
63  * This pretty much limits us to configuring the MSR bitmap before VMCS
64  * initialization for SMP VMs. Unless of course we do it the hard way - which
65  * would involve some form of synchronization between the vcpus to vmclear
66  * all VMCSs' that point to the bitmap.
67  */
68 #define	MSR_BITMAP_ACCESS_NONE	0x0
69 #define	MSR_BITMAP_ACCESS_READ	0x1
70 #define	MSR_BITMAP_ACCESS_WRITE	0x2
71 #define	MSR_BITMAP_ACCESS_RW	(MSR_BITMAP_ACCESS_READ|MSR_BITMAP_ACCESS_WRITE)
72 void vmx_msr_bitmap_initialize(struct vmx *);
73 void vmx_msr_bitmap_destroy(struct vmx *);
74 void vmx_msr_bitmap_change_access(struct vmx *, int, uint_t, int);
75 
76 #define	guest_msr_rw(vmx, vcpuid, msr) \
77     vmx_msr_bitmap_change_access((vmx), (vcpuid), (msr), MSR_BITMAP_ACCESS_RW)
78 
79 #define	guest_msr_ro(vmx, vcpuid, msr) \
80     vmx_msr_bitmap_change_access((vmx), (vcpuid), (msr), MSR_BITMAP_ACCESS_READ)
81 
82 #endif
83