xref: /openbmc/qemu/backends/dbus-vmstate1.xml (revision 5316e12bb2b4408a1597b283ef4bb4794dd7b4f7)
1*d2f25776SMarc-André Lureau<?xml version="1.0" encoding="utf-8"?>
261534882SMarc-André Lureau<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
3*d2f25776SMarc-André Lureau  <!--
4*d2f25776SMarc-André Lureau      org.qemu.VMState1:
5*d2f25776SMarc-André Lureau
6*d2f25776SMarc-André Lureau      This interface must be implemented at the object path
7*d2f25776SMarc-André Lureau      ``/org/qemu/VMState1`` to support helper migration.
8*d2f25776SMarc-André Lureau  -->
961534882SMarc-André Lureau  <interface name="org.qemu.VMState1">
10*d2f25776SMarc-André Lureau
11*d2f25776SMarc-André Lureau    <!--
12*d2f25776SMarc-André Lureau        Id:
13*d2f25776SMarc-André Lureau
14*d2f25776SMarc-André Lureau        A string that identifies the helper uniquely. (maximum 256 bytes
15*d2f25776SMarc-André Lureau        including terminating NUL byte)
16*d2f25776SMarc-André Lureau
17*d2f25776SMarc-André Lureau        .. note::
18*d2f25776SMarc-André Lureau
19*d2f25776SMarc-André Lureau           The VMState helper ID namespace is its own namespace. In particular,
20*d2f25776SMarc-André Lureau           it is not related to QEMU "id" used in -object/-device objects.
21*d2f25776SMarc-André Lureau    -->
2261534882SMarc-André Lureau    <property name="Id" type="s" access="read"/>
23*d2f25776SMarc-André Lureau
24*d2f25776SMarc-André Lureau    <!--
25*d2f25776SMarc-André Lureau        Load:
26*d2f25776SMarc-André Lureau        @data: data to restore the state.
27*d2f25776SMarc-André Lureau
28*d2f25776SMarc-André Lureau        The method called on destination with the state to restore.
29*d2f25776SMarc-André Lureau
30*d2f25776SMarc-André Lureau        The helper may be initially started in a waiting state (with an
31*d2f25776SMarc-André Lureau        ``-incoming`` argument for example), and it may resume on success.
32*d2f25776SMarc-André Lureau
33*d2f25776SMarc-André Lureau        An error may be returned to the caller.
34*d2f25776SMarc-André Lureau    -->
3561534882SMarc-André Lureau    <method name="Load">
3661534882SMarc-André Lureau      <arg type="ay" name="data" direction="in"/>
3761534882SMarc-André Lureau    </method>
38*d2f25776SMarc-André Lureau
39*d2f25776SMarc-André Lureau    <!--
40*d2f25776SMarc-André Lureau        Save:
41*d2f25776SMarc-André Lureau        @data: state data to save for later resume.
42*d2f25776SMarc-André Lureau
43*d2f25776SMarc-André Lureau        The method called on the source to get the current state to be
44*d2f25776SMarc-André Lureau        migrated. The helper should continue to run normally.
45*d2f25776SMarc-André Lureau
46*d2f25776SMarc-André Lureau        An error may be returned to the caller.
47*d2f25776SMarc-André Lureau    -->
4861534882SMarc-André Lureau    <method name="Save">
4961534882SMarc-André Lureau      <arg type="ay" name="data" direction="out"/>
5061534882SMarc-André Lureau    </method>
5161534882SMarc-André Lureau  </interface>
5261534882SMarc-André Lureau</node>
53