[PATCH] KVM: Document KVM_NMI

[PATCH] KVM: Document KVM_NMI

[Sasha Levin]

Cc: Avi Kivity <avi@redhat.com>
Cc: Marcelo Tosatti <mtosatti@redhat.com>
Cc: kvm@vger.kernel.org
Signed-off-by: Sasha Levin <levinsasha928@gmail.com>
---
 Documentation/virtual/kvm/api.txt |   13 +++++++++++++
 1 files changed, 13 insertions(+), 0 deletions(-)

diff --git a/Documentation/virtual/kvm/api.txt b/Documentation/virtual/kvm/api.txt
index 7945b0b..0b7b8f2 100644
--- a/Documentation/virtual/kvm/api.txt
+++ b/Documentation/virtual/kvm/api.txt
@@ -1450,6 +1450,19 @@ is supported; 2 if the processor requires all virtual machines to have
 an RMA, or 1 if the processor can use an RMA but doesn't require it,
 because it supports the Virtual RMA (VRMA) facility.
 
+4.64 KVM_NMI
+
+Capability: basic
+Architectures: none
+Type: vcpu ioctl
+Parameters: none
+Returns: 0 on success, -1 on error
+
+Trigger an NMI on the specified VCPU.
+
+This can be used to cause a panic in the guest, which in turn would result
+in a backtrace/dump.
+
 5. The kvm_run structure
 
 Application code obtains a pointer to the kvm_run structure by
-- 
1.7.8

Re: [PATCH] KVM: Document KVM_NMI

[Avi Kivity]

On 12/06/2011 10:50 PM, Sasha Levin wrote:
> Cc: Avi Kivity <avi@redhat.com>
> Cc: Marcelo Tosatti <mtosatti@redhat.com>
> Cc: kvm@vger.kernel.org

Somehow, the changelog became the place where people manage their cc lists.

>  
> +4.64 KVM_NMI
> +
> +Capability: basic
> +Architectures: none
> +Type: vcpu ioctl
> +Parameters: none
> +Returns: 0 on success, -1 on error
> +
> +Trigger an NMI on the specified VCPU.
> +
> +This can be used to cause a panic in the guest, which in turn would result
> +in a backtrace/dump.
> +

I'm nitpicking, but this is too strongly worded.  It's completely up to
the guest how to interpret the NMI.

It's also subtly broken with kernel irqchip - it injects an NMI
unconditionally even though LINT1 can be configured to mask NMIs, or to
do something other than queue an NMI (for example, queue a regular
interrupt).  Please note this.

On second thoughts, I'll just document this instead of telling you what
to write.

-- 
error compiling committee.c: too many arguments to function