[PATCH] qapi: document leftover members in qapi/run-state.json
Suggested-by: Markus Armbruster Signed-off-by: Paolo Bonzini --- qapi/run-state.json | 26 +- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/qapi/run-state.json b/qapi/run-state.json index 789fc34559a..cb4a2b43293 100644 --- a/qapi/run-state.json +++ b/qapi/run-state.json @@ -377,9 +377,17 @@ ## # @watchdog-set-action: # -# Set watchdog action +# Set watchdog action. +# +# @action: @WatchdogAction action taken when watchdog timer expires. # # Since: 2.11 +# +# Example: +# +# -> { "execute": "watchdog-set-action", +# "arguments": { "action": "inject-nmi" } } +# <- { "return": {} } ## { 'command': 'watchdog-set-action', 'data' : {'action': 'WatchdogAction'} } @@ -505,6 +513,22 @@ # # Hyper-V specific guest panic information (HV crash MSRs) # +# @arg1: for Windows, STOP code for the guest crash. For Linux, +#an error code. +# +# @arg2: for Windows, first argument of the STOP. For Linux, the +#guest OS id, which has the kernel version in bits 16-47 +#and 0x8100 in bits 48-63. +# +# @arg3: for Windows, second argument of the STOP. For Linux, the +#program counter of the guest. +# +# @arg4: for Windows, third argument of the STOP. For Linux, the +#RAX register (x86) or the stack pointer (aarch64) of the guest. +# +# @arg5: for Windows, fourth argument of the STOP. For x86 Linux, the +#stack pointer of the guest. +# # Since: 2.9 ## {'struct': 'GuestPanicInformationHyperV', -- 2.44.0
Re: [PATCH] qapi: document leftover members in qapi/run-state.json
Paolo Bonzini writes: > Suggested-by: Markus Armbruster > Signed-off-by: Paolo Bonzini > --- > qapi/run-state.json | 26 +- > 1 file changed, 25 insertions(+), 1 deletion(-) > > diff --git a/qapi/run-state.json b/qapi/run-state.json > index 789fc34559a..cb4a2b43293 100644 > --- a/qapi/run-state.json > +++ b/qapi/run-state.json > @@ -377,9 +377,17 @@ > ## > # @watchdog-set-action: > # > -# Set watchdog action > +# Set watchdog action. > +# > +# @action: @WatchdogAction action taken when watchdog timer expires. > # > # Since: 2.11 > +# > +# Example: > +# > +# -> { "execute": "watchdog-set-action", > +# "arguments": { "action": "inject-nmi" } } > +# <- { "return": {} } > ## > { 'command': 'watchdog-set-action', 'data' : {'action': 'WatchdogAction'} } > Appreciate the example! > @@ -505,6 +513,22 @@ > # > # Hyper-V specific guest panic information (HV crash MSRs) > # > +# @arg1: for Windows, STOP code for the guest crash. For Linux, > +#an error code. > +# > +# @arg2: for Windows, first argument of the STOP. For Linux, the > +#guest OS id, which has the kernel version in bits 16-47 Mind if I capitalize ID? > +#and 0x8100 in bits 48-63. > +# > +# @arg3: for Windows, second argument of the STOP. For Linux, the > +#program counter of the guest. > +# > +# @arg4: for Windows, third argument of the STOP. For Linux, the > +#RAX register (x86) or the stack pointer (aarch64) of the guest. > +# > +# @arg5: for Windows, fourth argument of the STOP. For x86 Linux, the > +#stack pointer of the guest. > +# > # Since: 2.9 > ## > {'struct': 'GuestPanicInformationHyperV', Reviewed-by: Markus Armbruster
Re: [PATCH] qapi: document leftover members in qapi/run-state.json
Il lun 25 mar 2024, 12:36 Markus Armbruster ha scritto: > Paolo Bonzini writes: > > > Suggested-by: Markus Armbruster > > Signed-off-by: Paolo Bonzini > > --- > > qapi/run-state.json | 26 +- > > 1 file changed, 25 insertions(+), 1 deletion(-) > > > > diff --git a/qapi/run-state.json b/qapi/run-state.json > > index 789fc34559a..cb4a2b43293 100644 > > --- a/qapi/run-state.json > > +++ b/qapi/run-state.json > > @@ -377,9 +377,17 @@ > > ## > > # @watchdog-set-action: > > # > > -# Set watchdog action > > +# Set watchdog action. > > +# > > +# @action: @WatchdogAction action taken when watchdog timer expires. > > # > > # Since: 2.11 > > +# > > +# Example: > > +# > > +# -> { "execute": "watchdog-set-action", > > +# "arguments": { "action": "inject-nmi" } } > > +# <- { "return": {} } > > ## > > { 'command': 'watchdog-set-action', 'data' : {'action': > 'WatchdogAction'} } > > > > Appreciate the example! > It may even be worth deprecating the command, since action-set is a clean superset. But I didn't check if libvirt knows about action-set and it's cheap enough to implement watchdog-set-action as well. > @@ -505,6 +513,22 @@ > > # > > # Hyper-V specific guest panic information (HV crash MSRs) > > # > > +# @arg1: for Windows, STOP code for the guest crash. For Linux, > > +#an error code. > > +# > > +# @arg2: for Windows, first argument of the STOP. For Linux, the > > +#guest OS id, which has the kernel version in bits 16-47 > > Mind if I capitalize ID? > Go ahead if you are going to queue it. Paolo > > +#and 0x8100 in bits 48-63. > > +# > > +# @arg3: for Windows, second argument of the STOP. For Linux, the > > +#program counter of the guest. > > +# > > +# @arg4: for Windows, third argument of the STOP. For Linux, the > > +#RAX register (x86) or the stack pointer (aarch64) of the guest. > > +# > > +# @arg5: for Windows, fourth argument of the STOP. For x86 Linux, the > > +#stack pointer of the guest. > > +# > > # Since: 2.9 > > ## > > {'struct': 'GuestPanicInformationHyperV', > > Reviewed-by: Markus Armbruster > >
Re: [PATCH] qapi: document leftover members in qapi/run-state.json
Paolo Bonzini writes: > Il lun 25 mar 2024, 12:36 Markus Armbruster ha scritto: > >> Paolo Bonzini writes: >> >> > Suggested-by: Markus Armbruster >> > Signed-off-by: Paolo Bonzini >> > --- >> > qapi/run-state.json | 26 +- >> > 1 file changed, 25 insertions(+), 1 deletion(-) >> > >> > diff --git a/qapi/run-state.json b/qapi/run-state.json >> > index 789fc34559a..cb4a2b43293 100644 >> > --- a/qapi/run-state.json >> > +++ b/qapi/run-state.json >> > @@ -377,9 +377,17 @@ >> > ## >> > # @watchdog-set-action: >> > # >> > -# Set watchdog action >> > +# Set watchdog action. >> > +# >> > +# @action: @WatchdogAction action taken when watchdog timer expires. >> > # >> > # Since: 2.11 >> > +# >> > +# Example: >> > +# >> > +# -> { "execute": "watchdog-set-action", >> > +# "arguments": { "action": "inject-nmi" } } >> > +# <- { "return": {} } >> > ## >> > { 'command': 'watchdog-set-action', 'data' : {'action': 'WatchdogAction'} >> > } >> > >> >> Appreciate the example! > > It may even be worth deprecating the command, since action-set is a clean > superset. But I didn't check if libvirt knows about action-set and it's > cheap enough to implement watchdog-set-action as well. Quick grep... libvirt appears to use watchdog-set-action, but not action-set. >> @@ -505,6 +513,22 @@ >> > # >> > # Hyper-V specific guest panic information (HV crash MSRs) >> > # >> > +# @arg1: for Windows, STOP code for the guest crash. For Linux, >> > +#an error code. >> > +# >> > +# @arg2: for Windows, first argument of the STOP. For Linux, the >> > +#guest OS id, which has the kernel version in bits 16-47 >> >> Mind if I capitalize ID? >> > > Go ahead if you are going to queue it. Done. Queued, thanks! [...]
Re: [PATCH] qapi: document leftover members in qapi/run-state.json
Squashing in diff --git a/qapi/pragma.json b/qapi/pragma.json index 92715d22b3..1a302981c1 100644 --- a/qapi/pragma.json +++ b/qapi/pragma.json @@ -57,7 +57,6 @@ 'DummyForceArrays', 'DummyVirtioForceArrays', 'GrabToggleKeys', -'GuestPanicInformationHyperV', 'HotKeyMod', 'ImageInfoSpecificKind', 'InputAxis', @@ -93,8 +92,7 @@ 'query-cpu-model-expansion', 'query-rocker', 'query-rocker-ports', -'query-stats-schemas', -'watchdog-set-action' ], +'query-stats-schemas' ], # Externally visible types whose member names may use uppercase 'member-name-exceptions': [ # visible in: 'ACPISlotType', # query-acpi-ospm-status