Commit 549a715b authored by Sean Christopherson's avatar Sean Christopherson Committed by Paolo Bonzini
Browse files

KVM: x86: Add proper ReST tables for userspace MSR exits/flags 



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: 1ae09954 ("KVM: x86: Allow deflecting unknown MSR accesses to user space")
Fixes: 1f158147 ("KVM: x86: Clean up KVM_CAP_X86_USER_SPACE_MSR documentation")
Reported-by: default avatarkernel test robot <lkp@intel.com>
Signed-off-by: default avatarSean Christopherson <seanjc@google.com>
Message-Id: <20221207000959.2035098-1-seanjc@google.com>
Signed-off-by: default avatarPaolo Bonzini <pbonzini@redhat.com>
parent 9352e747

Documentation/virt/kvm/api.rst

+12 −8
Original line number Diff line number Diff line
@@ -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

============================ ===============================================

 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

 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

-------------------------------