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
34struct vmx;
35
36void vmx_msr_init(void);
37void vmx_msr_guest_init(struct vmx *vmx, int vcpuid);
38void vmx_msr_guest_enter_tsc_aux(struct vmx *vmx, int vcpuid);
39void vmx_msr_guest_enter(struct vmx *vmx, int vcpuid);
40void vmx_msr_guest_exit(struct vmx *vmx, int vcpuid);
41void vmx_msr_guest_exit_tsc_aux(struct vmx *vmx, int vcpuid);
42int vmx_rdmsr(struct vmx *, int vcpuid, u_int num, uint64_t *val, bool *retu);
43int vmx_wrmsr(struct vmx *, int vcpuid, u_int num, uint64_t val, bool *retu);
44
45uint32_t vmx_revision(void);
46
47int vmx_set_ctlreg(int ctl_reg, int true_ctl_reg, uint32_t ones_mask,
48		   uint32_t zeros_mask, uint32_t *retval);
49
50/*
51 * According to Section 21.10.4 "Software Access to Related Structures",
52 * changes to data structures pointed to by the VMCS must be made only when
53 * there is no logical processor with a current VMCS that points to the
54 * data structure.
55 *
56 * This pretty much limits us to configuring the MSR bitmap before VMCS
57 * initialization for SMP VMs. Unless of course we do it the hard way - which
58 * would involve some form of synchronization between the vcpus to vmclear
59 * all VMCSs' that point to the bitmap.
60 */
61#define	MSR_BITMAP_ACCESS_NONE	0x0
62#define	MSR_BITMAP_ACCESS_READ	0x1
63#define	MSR_BITMAP_ACCESS_WRITE	0x2
64#define	MSR_BITMAP_ACCESS_RW	(MSR_BITMAP_ACCESS_READ|MSR_BITMAP_ACCESS_WRITE)
65void	msr_bitmap_initialize(char *bitmap);
66int	msr_bitmap_change_access(char *bitmap, u_int msr, int access);
67
68#define	guest_msr_rw(vmx, msr) \
69    msr_bitmap_change_access((vmx)->msr_bitmap, (msr), MSR_BITMAP_ACCESS_RW)
70
71#define	guest_msr_ro(vmx, msr) \
72    msr_bitmap_change_access((vmx)->msr_bitmap, (msr), MSR_BITMAP_ACCESS_READ)
73
74#endif
75