KVM: x86: Add proper ReST tables for userspace MSR exits/flags
Commit Message
Add ReST formatting to the set of userspace MSR exits/flags so that the
resulting HTML docs generate a table instead of malformed gunk. This
also fixes a warning that was introduced by a recent cleanup of the
relevant documentation (yay copy+paste).
>> Documentation/virt/kvm/api.rst:7287: WARNING: Block quote ends
without a blank line; unexpected unindent.
Fixes: 1ae099540e8c ("KVM: x86: Allow deflecting unknown MSR accesses to user space")
Fixes: 1f158147181b ("KVM: x86: Clean up KVM_CAP_X86_USER_SPACE_MSR documentation")
Reported-by: kernel test robot <lkp@intel.com>
Signed-off-by: Sean Christopherson <seanjc@google.com>
---
Documentation/virt/kvm/api.rst | 20 ++++++++++++--------
1 file changed, 12 insertions(+), 8 deletions(-)
base-commit: 3d7af7c5e000c68581429d533ed63414e4a48e6d
Comments
On 12/7/22 01:09, Sean Christopherson wrote:
> Add ReST formatting to the set of userspace MSR exits/flags so that the
> resulting HTML docs generate a table instead of malformed gunk. This
> also fixes a warning that was introduced by a recent cleanup of the
> relevant documentation (yay copy+paste).
>
> >> Documentation/virt/kvm/api.rst:7287: WARNING: Block quote ends
> without a blank line; unexpected unindent.
Queued, thanks.
Paolo
> Fixes: 1ae099540e8c ("KVM: x86: Allow deflecting unknown MSR accesses to user space")
> Fixes: 1f158147181b ("KVM: x86: Clean up KVM_CAP_X86_USER_SPACE_MSR documentation")
> Reported-by: kernel test robot <lkp@intel.com>
> Signed-off-by: Sean Christopherson <seanjc@google.com>
> ---
> Documentation/virt/kvm/api.rst | 20 ++++++++++++--------
> 1 file changed, 12 insertions(+), 8 deletions(-)
>
> diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
> index c618fae44ad7..778c6460d1de 100644
> --- a/Documentation/virt/kvm/api.rst
> +++ b/Documentation/virt/kvm/api.rst
> @@ -6455,9 +6455,11 @@ The "reason" field specifies why the MSR interception occurred. Userspace will
> only receive MSR exits when a particular reason was requested during through
> ENABLE_CAP. Currently valid exit reasons are:
>
> - KVM_MSR_EXIT_REASON_UNKNOWN - access to MSR that is unknown to KVM
> - KVM_MSR_EXIT_REASON_INVAL - access to invalid MSRs or reserved bits
> - KVM_MSR_EXIT_REASON_FILTER - access blocked by KVM_X86_SET_MSR_FILTER
> +============================ ========================================
> + KVM_MSR_EXIT_REASON_UNKNOWN access to MSR that is unknown to KVM
> + KVM_MSR_EXIT_REASON_INVAL access to invalid MSRs or reserved bits
> + KVM_MSR_EXIT_REASON_FILTER access blocked by KVM_X86_SET_MSR_FILTER
> +============================ ========================================
>
> For KVM_EXIT_X86_RDMSR, the "index" field tells userspace which MSR the guest
> wants to read. To respond to this request with a successful read, userspace
> @@ -7256,11 +7258,13 @@ to inform a user that an MSR was not emulated/virtualized by KVM.
>
> The valid mask flags are:
>
> - KVM_MSR_EXIT_REASON_UNKNOWN - intercept accesses to unknown (to KVM) MSRs
> - KVM_MSR_EXIT_REASON_INVAL - intercept accesses that are architecturally
> - invalid according to the vCPU model and/or mode
> - KVM_MSR_EXIT_REASON_FILTER - intercept accesses that are denied by userspace
> - via KVM_X86_SET_MSR_FILTER
> +============================ ===============================================
> + KVM_MSR_EXIT_REASON_UNKNOWN intercept accesses to unknown (to KVM) MSRs
> + KVM_MSR_EXIT_REASON_INVAL intercept accesses that are architecturally
> + invalid according to the vCPU model and/or mode
> + KVM_MSR_EXIT_REASON_FILTER intercept accesses that are denied by userspace
> + via KVM_X86_SET_MSR_FILTER
> +============================ ===============================================
>
> 7.22 KVM_CAP_X86_BUS_LOCK_EXIT
> -------------------------------
>
> base-commit: 3d7af7c5e000c68581429d533ed63414e4a48e6d
@@ -6455,9 +6455,11 @@ The "reason" field specifies why the MSR interception occurred. Userspace will
only receive MSR exits when a particular reason was requested during through
ENABLE_CAP. Currently valid exit reasons are:
- KVM_MSR_EXIT_REASON_UNKNOWN - access to MSR that is unknown to KVM
- KVM_MSR_EXIT_REASON_INVAL - access to invalid MSRs or reserved bits
- KVM_MSR_EXIT_REASON_FILTER - access blocked by KVM_X86_SET_MSR_FILTER
+============================ ========================================
+ KVM_MSR_EXIT_REASON_UNKNOWN access to MSR that is unknown to KVM
+ KVM_MSR_EXIT_REASON_INVAL access to invalid MSRs or reserved bits
+ KVM_MSR_EXIT_REASON_FILTER access blocked by KVM_X86_SET_MSR_FILTER
+============================ ========================================
For KVM_EXIT_X86_RDMSR, the "index" field tells userspace which MSR the guest
wants to read. To respond to this request with a successful read, userspace
@@ -7256,11 +7258,13 @@ to inform a user that an MSR was not emulated/virtualized by KVM.
The valid mask flags are:
- KVM_MSR_EXIT_REASON_UNKNOWN - intercept accesses to unknown (to KVM) MSRs
- KVM_MSR_EXIT_REASON_INVAL - intercept accesses that are architecturally
- invalid according to the vCPU model and/or mode
- KVM_MSR_EXIT_REASON_FILTER - intercept accesses that are denied by userspace
- via KVM_X86_SET_MSR_FILTER
+============================ ===============================================
+ KVM_MSR_EXIT_REASON_UNKNOWN intercept accesses to unknown (to KVM) MSRs
+ KVM_MSR_EXIT_REASON_INVAL intercept accesses that are architecturally
+ invalid according to the vCPU model and/or mode
+ KVM_MSR_EXIT_REASON_FILTER intercept accesses that are denied by userspace
+ via KVM_X86_SET_MSR_FILTER
+============================ ===============================================
7.22 KVM_CAP_X86_BUS_LOCK_EXIT
-------------------------------