Patchwork [v15,4/6] pvpanic: add document of pvpanic

login
register
mail settings
Submitter Hu Tao
Date March 21, 2013, 8:35 a.m.
Message ID <88d002a0bd3acbd0d244f51fcef8f1d1860a2812.1363847790.git.hutao@cn.fujitsu.com>
Download mbox | patch
Permalink /patch/229581/
State New
Headers show

Comments

Hu Tao - March 21, 2013, 8:35 a.m.
Signed-off-by: Hu Tao <hutao@cn.fujitsu.com>
---
 docs/specs/pvpanic.txt | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 docs/specs/pvpanic.txt
Paolo Bonzini - March 21, 2013, 9:13 a.m.
Il 21/03/2013 09:35, Hu Tao ha scritto:
> Signed-off-by: Hu Tao <hutao@cn.fujitsu.com>
> ---
>  docs/specs/pvpanic.txt | 25 +++++++++++++++++++++++++
>  1 file changed, 25 insertions(+)
>  create mode 100644 docs/specs/pvpanic.txt
> 
> diff --git a/docs/specs/pvpanic.txt b/docs/specs/pvpanic.txt
> new file mode 100644
> index 0000000..761d20c
> --- /dev/null
> +++ b/docs/specs/pvpanic.txt
> @@ -0,0 +1,25 @@
> +PVPANIC DEVICE
> +==============
> +
> +pvpanic device is a simulated ISA device, through which guest panic
> +event is sent to qemu, and a QMP event is generated. This allows
> +management apps(e.g. libvirt) to be notified and respond to the
> +event.
> +
> +pvpanic uses port 0x505 by default to receive panic event from guest.
> +The port is configurable by specifying ioport property.

Please document the ISA interface too.

> +pvpanic device is defined with ACPI ID "QEMU0001". To send panic
> +event, guest evaluates method WRPT, specifying a byte, bit 0 set,
> +as argument. Other bits are reserved.

Please document RDPT too, and mention that the ACPI device will
automatically refer to the right port in case it is modified.

> +To use it, one will have to:
> +
> +1. add the device by specifying `-device pvpanic' in the qemu command
> +   line.

As mentioned earlier, I'd like this to be the default in 1.5 and newer
machine types.

Paolo

> +2. load pvpanic device driver in guest OS.
> +
> +The management app has the options of waiting for GUEST_PANICKED events,
> +and/or polling for guest-panicked RunState, to learn when the pvpanic
> +device has fired a panic event.
>
Eric Blake - March 22, 2013, 1:59 a.m.
On 03/21/2013 02:35 AM, Hu Tao wrote:
> Signed-off-by: Hu Tao <hutao@cn.fujitsu.com>
> ---
>  docs/specs/pvpanic.txt | 25 +++++++++++++++++++++++++
>  1 file changed, 25 insertions(+)
>  create mode 100644 docs/specs/pvpanic.txt

Grammar nits:

> 
> diff --git a/docs/specs/pvpanic.txt b/docs/specs/pvpanic.txt
> new file mode 100644
> index 0000000..761d20c
> --- /dev/null
> +++ b/docs/specs/pvpanic.txt
> @@ -0,0 +1,25 @@
> +PVPANIC DEVICE
> +==============
> +
> +pvpanic device is a simulated ISA device, through which guest panic

s/which/which a/

> +event is sent to qemu, and a QMP event is generated. This allows
> +management apps(e.g. libvirt) to be notified and respond to the

space before ( in English text.

> +event.
> +
> +pvpanic uses port 0x505 by default to receive panic event from guest.

s/receive/receive a/
s/from guest/from the guest/

> +The port is configurable by specifying ioport property.
> +
> +pvpanic device is defined with ACPI ID "QEMU0001". To send panic

s/send/send a/

> +event, guest evaluates method WRPT, specifying a byte, bit 0 set,
s/guest/the guest/
/byte, bit 0/byte with bit 0/

> +as argument. Other bits are reserved.
> +
> +To use it, one will have to:
> +
> +1. add the device by specifying `-device pvpanic' in the qemu command
> +   line.
> +
> +2. load pvpanic device driver in guest OS.

s/in/in the/

> +
> +The management app has the options of waiting for GUEST_PANICKED events,

s/options/option/

> +and/or polling for guest-panicked RunState, to learn when the pvpanic
> +device has fired a panic event.
>
Hu Tao - March 22, 2013, 7:15 a.m.
On Thu, Mar 21, 2013 at 10:13:50AM +0100, Paolo Bonzini wrote:
> Il 21/03/2013 09:35, Hu Tao ha scritto:
> > Signed-off-by: Hu Tao <hutao@cn.fujitsu.com>
> > ---
> >  docs/specs/pvpanic.txt | 25 +++++++++++++++++++++++++
> >  1 file changed, 25 insertions(+)
> >  create mode 100644 docs/specs/pvpanic.txt
> > 
> > diff --git a/docs/specs/pvpanic.txt b/docs/specs/pvpanic.txt
> > new file mode 100644
> > index 0000000..761d20c
> > --- /dev/null
> > +++ b/docs/specs/pvpanic.txt
> > @@ -0,0 +1,25 @@
> > +PVPANIC DEVICE
> > +==============
> > +
> > +pvpanic device is a simulated ISA device, through which guest panic
> > +event is sent to qemu, and a QMP event is generated. This allows
> > +management apps(e.g. libvirt) to be notified and respond to the
> > +event.
> > +
> > +pvpanic uses port 0x505 by default to receive panic event from guest.
> > +The port is configurable by specifying ioport property.
> 
> Please document the ISA interface too.
> 
> > +pvpanic device is defined with ACPI ID "QEMU0001". To send panic
> > +event, guest evaluates method WRPT, specifying a byte, bit 0 set,
> > +as argument. Other bits are reserved.
> 
> Please document RDPT too, and mention that the ACPI device will
> automatically refer to the right port in case it is modified.
> 
> > +To use it, one will have to:
> > +
> > +1. add the device by specifying `-device pvpanic' in the qemu command
> > +   line.
> 
> As mentioned earlier, I'd like this to be the default in 1.5 and newer
> machine types.

I must have missed it. Thanks for review!

> 
> Paolo
> 
> > +2. load pvpanic device driver in guest OS.
> > +
> > +The management app has the options of waiting for GUEST_PANICKED events,
> > +and/or polling for guest-panicked RunState, to learn when the pvpanic
> > +device has fired a panic event.
> >
Hu Tao - March 22, 2013, 7:15 a.m.
On Thu, Mar 21, 2013 at 07:59:12PM -0600, Eric Blake wrote:
> On 03/21/2013 02:35 AM, Hu Tao wrote:
> > Signed-off-by: Hu Tao <hutao@cn.fujitsu.com>
> > ---
> >  docs/specs/pvpanic.txt | 25 +++++++++++++++++++++++++
> >  1 file changed, 25 insertions(+)
> >  create mode 100644 docs/specs/pvpanic.txt
> 
> Grammar nits:
> 
> > 
> > diff --git a/docs/specs/pvpanic.txt b/docs/specs/pvpanic.txt
> > new file mode 100644
> > index 0000000..761d20c
> > --- /dev/null
> > +++ b/docs/specs/pvpanic.txt
> > @@ -0,0 +1,25 @@
> > +PVPANIC DEVICE
> > +==============
> > +
> > +pvpanic device is a simulated ISA device, through which guest panic
> 
> s/which/which a/
> 
> > +event is sent to qemu, and a QMP event is generated. This allows
> > +management apps(e.g. libvirt) to be notified and respond to the
> 
> space before ( in English text.
> 
> > +event.
> > +
> > +pvpanic uses port 0x505 by default to receive panic event from guest.
> 
> s/receive/receive a/
> s/from guest/from the guest/
> 
> > +The port is configurable by specifying ioport property.
> > +
> > +pvpanic device is defined with ACPI ID "QEMU0001". To send panic
> 
> s/send/send a/
> 
> > +event, guest evaluates method WRPT, specifying a byte, bit 0 set,
> s/guest/the guest/
> /byte, bit 0/byte with bit 0/
> 
> > +as argument. Other bits are reserved.
> > +
> > +To use it, one will have to:
> > +
> > +1. add the device by specifying `-device pvpanic' in the qemu command
> > +   line.
> > +
> > +2. load pvpanic device driver in guest OS.
> 
> s/in/in the/
> 
> > +
> > +The management app has the options of waiting for GUEST_PANICKED events,
> 
> s/options/option/

Thanks for review!

> 
> > +and/or polling for guest-panicked RunState, to learn when the pvpanic
> > +device has fired a panic event.
> > 
> 
> -- 
> Eric Blake   eblake redhat com    +1-919-301-3266
> Libvirt virtualization library http://libvirt.org
>

Patch

diff --git a/docs/specs/pvpanic.txt b/docs/specs/pvpanic.txt
new file mode 100644
index 0000000..761d20c
--- /dev/null
+++ b/docs/specs/pvpanic.txt
@@ -0,0 +1,25 @@ 
+PVPANIC DEVICE
+==============
+
+pvpanic device is a simulated ISA device, through which guest panic
+event is sent to qemu, and a QMP event is generated. This allows
+management apps(e.g. libvirt) to be notified and respond to the
+event.
+
+pvpanic uses port 0x505 by default to receive panic event from guest.
+The port is configurable by specifying ioport property.
+
+pvpanic device is defined with ACPI ID "QEMU0001". To send panic
+event, guest evaluates method WRPT, specifying a byte, bit 0 set,
+as argument. Other bits are reserved.
+
+To use it, one will have to:
+
+1. add the device by specifying `-device pvpanic' in the qemu command
+   line.
+
+2. load pvpanic device driver in guest OS.
+
+The management app has the options of waiting for GUEST_PANICKED events,
+and/or polling for guest-panicked RunState, to learn when the pvpanic
+device has fired a panic event.