From: Damien Hedde <damien.hedde@greensocs.com> To: qemu-devel@nongnu.org Cc: "Peter Maydell" <peter.maydell@linaro.org>, "Michael S. Tsirkin" <mst@redhat.com>, "David Hildenbrand" <david@redhat.com>, "Peter Xu" <peterx@redhat.com>, mirela.grujic@greensocs.com, "Alistair Francis" <Alistair.Francis@wdc.com>, "Gerd Hoffmann" <kraxel@redhat.com>, "Ani Sinha" <ani@anisinha.ca>, "Eric Blake" <eblake@redhat.com>, "Stefano Stabellini" <sstabellini@kernel.org>, xen-devel@lists.xenproject.org, "Paul Durrant" <paul@xen.org>, "Markus Armbruster" <armbru@redhat.com>, "Anthony Perard" <anthony.perard@citrix.com>, "Marc-André Lureau" <marcandre.lureau@redhat.com>, "Eduardo Habkost" <ehabkost@redhat.com>, "Dr. David Alan Gilbert" <dgilbert@redhat.com>, "Eric Auger" <eric.auger@redhat.com>, "Paolo Bonzini" <pbonzini@redhat.com>, qemu-riscv@nongnu.org, "Damien Hedde" <damien.hedde@greensocs.com>, "Daniel P. Berrangé" <berrange@redhat.com>, mark.burton@greensocs.com, edgari@xilinx.com, "Igor Mammedov" <imammedo@redhat.com> Subject: [RFC PATCH v2 14/16] docs/system: add doc about the initialized machine phase and an example Date: Wed, 22 Sep 2021 18:14:03 +0200 [thread overview] Message-ID: <20210922161405.140018-15-damien.hedde@greensocs.com> (raw) In-Reply-To: <20210922161405.140018-1-damien.hedde@greensocs.com> Signed-off-by: Damien Hedde <damien.hedde@greensocs.com> --- docs/system/managed-startup.rst | 77 +++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) diff --git a/docs/system/managed-startup.rst b/docs/system/managed-startup.rst index 9bcf98ea79..af12a10d27 100644 --- a/docs/system/managed-startup.rst +++ b/docs/system/managed-startup.rst @@ -32,4 +32,81 @@ machine, including but not limited to: - ``query-qmp-schema`` - ``query-commands`` - ``query-status`` +- ``x-machine-init`` - ``x-exit-preconfig`` + +In particular these commands allow to advance and stop qemu at different +phases of the VM creation and finally to leave the "preconfig" state. The +accessible phases are: + +- ``accel-created`` +- ``initialized`` +- ``ready`` + +The order of the phases is enforced. It is not possible to go backwards. +Note that other early phases exist, but they are not attainable with +``--preconfig``. Depending on the phase, QMP commands can be issued to modify +some part of the VM creation. + +accel-created phase +------------------- + +Initial phase entered with ``--preconfig``. + +initialized phase +----------------- + +``x-machine-init`` advances to ``initialized`` phase. During this phase, the +machine is initialized and populated with buses and devices. The following QMP +commands are available to manually populate or modify the machine: + +- ``device_add`` +- ``x-sysbus-mmio-map`` +- ``qom-set`` + +ready phase +----------- + +``x-exit-preconfig`` advances to the final phase. When entering this phase, +the VM creation finishes. "preconfig" state is then done and QEMU goes to +normal execution. + +Machine creation example +------------------------ + +The following is an example that shows how to add some devices with qmp +commands, memory map them, and add interrupts:: + + x-machine-init + + device_add driver=sysbus-memory id=rom size=0x4000 readonly=true + x-sysbus-mmio-map device=rom addr=32768 + + device_add driver=sysbus-memory id=flash size=0x80000 readonly=true + x-sysbus-mmio-map device=flash addr=536870912 + + device_add driver=sysbus-memory id=ram size=0x10000 + x-sysbus-mmio-map device=ram addr=268435456 + + device_add driver=ibex-plic id=plic + x-sysbus-mmio-map device=plic addr=1090584576 + + device_add driver=ibex-uart id=uart chardev=serial0 + x-sysbus-mmio-map device=uart addr=1073741824 + qom-set path=uart property=sysbus-irq[0] value=plic/unnamed-gpio-in[1] + qom-set path=uart property=sysbus-irq[1] value=plic/unnamed-gpio-in[2] + qom-set path=uart property=sysbus-irq[2] value=plic/unnamed-gpio-in[3] + qom-set path=uart property=sysbus-irq[3] value=plic/unnamed-gpio-in[4] + + x-exit-preconfig + +These commands reproduce a subset of the riscv32 opentitan (hw/riscv/opentitan) +machine. We can start qemu using:: + + qemu-sytem-riscv32 -preconfig -qmp unix:./qmp-sock,server \ + -machine none -cpu lowriscv-ibex -serial mon:stdio ... + +Then we just have to issue the commands, for example using `qmp-shell`. If the +previous commands were in a file named `machine.qmp`, we could do:: + + qmp-shell ./qmp-sock < machine.qmp -- 2.33.0
WARNING: multiple messages have this Message-ID (diff)
From: Damien Hedde <damien.hedde@greensocs.com> To: qemu-devel@nongnu.org Cc: "Damien Hedde" <damien.hedde@greensocs.com>, "Alistair Francis" <Alistair.Francis@wdc.com>, "Marc-André Lureau" <marcandre.lureau@redhat.com>, "Paolo Bonzini" <pbonzini@redhat.com>, "Eduardo Habkost" <ehabkost@redhat.com>, "Marcel Apfelbaum" <marcel.apfelbaum@gmail.com>, "Daniel P. Berrangé" <berrange@redhat.com>, "Michael S. Tsirkin" <mst@redhat.com>, "Igor Mammedov" <imammedo@redhat.com>, "Ani Sinha" <ani@anisinha.ca>, "Gerd Hoffmann" <kraxel@redhat.com>, "Eric Auger" <eric.auger@redhat.com>, "Stefano Stabellini" <sstabellini@kernel.org>, "Anthony Perard" <anthony.perard@citrix.com>, "Paul Durrant" <paul@xen.org>, "Peter Xu" <peterx@redhat.com>, "David Hildenbrand" <david@redhat.com>, "Dr. David Alan Gilbert" <dgilbert@redhat.com>, "Markus Armbruster" <armbru@redhat.com>, "Eric Blake" <eblake@redhat.com>, qemu-riscv@nongnu.org, xen-devel@lists.xenproject.org, mark.burton@greensocs.com, mirela.grujic@greensocs.com, edgari@xilinx.com, "Peter Maydell" <peter.maydell@linaro.org> Subject: [RFC PATCH v2 14/16] docs/system: add doc about the initialized machine phase and an example Date: Wed, 22 Sep 2021 18:14:03 +0200 [thread overview] Message-ID: <20210922161405.140018-15-damien.hedde@greensocs.com> (raw) In-Reply-To: <20210922161405.140018-1-damien.hedde@greensocs.com> Signed-off-by: Damien Hedde <damien.hedde@greensocs.com> --- docs/system/managed-startup.rst | 77 +++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) diff --git a/docs/system/managed-startup.rst b/docs/system/managed-startup.rst index 9bcf98ea79..af12a10d27 100644 --- a/docs/system/managed-startup.rst +++ b/docs/system/managed-startup.rst @@ -32,4 +32,81 @@ machine, including but not limited to: - ``query-qmp-schema`` - ``query-commands`` - ``query-status`` +- ``x-machine-init`` - ``x-exit-preconfig`` + +In particular these commands allow to advance and stop qemu at different +phases of the VM creation and finally to leave the "preconfig" state. The +accessible phases are: + +- ``accel-created`` +- ``initialized`` +- ``ready`` + +The order of the phases is enforced. It is not possible to go backwards. +Note that other early phases exist, but they are not attainable with +``--preconfig``. Depending on the phase, QMP commands can be issued to modify +some part of the VM creation. + +accel-created phase +------------------- + +Initial phase entered with ``--preconfig``. + +initialized phase +----------------- + +``x-machine-init`` advances to ``initialized`` phase. During this phase, the +machine is initialized and populated with buses and devices. The following QMP +commands are available to manually populate or modify the machine: + +- ``device_add`` +- ``x-sysbus-mmio-map`` +- ``qom-set`` + +ready phase +----------- + +``x-exit-preconfig`` advances to the final phase. When entering this phase, +the VM creation finishes. "preconfig" state is then done and QEMU goes to +normal execution. + +Machine creation example +------------------------ + +The following is an example that shows how to add some devices with qmp +commands, memory map them, and add interrupts:: + + x-machine-init + + device_add driver=sysbus-memory id=rom size=0x4000 readonly=true + x-sysbus-mmio-map device=rom addr=32768 + + device_add driver=sysbus-memory id=flash size=0x80000 readonly=true + x-sysbus-mmio-map device=flash addr=536870912 + + device_add driver=sysbus-memory id=ram size=0x10000 + x-sysbus-mmio-map device=ram addr=268435456 + + device_add driver=ibex-plic id=plic + x-sysbus-mmio-map device=plic addr=1090584576 + + device_add driver=ibex-uart id=uart chardev=serial0 + x-sysbus-mmio-map device=uart addr=1073741824 + qom-set path=uart property=sysbus-irq[0] value=plic/unnamed-gpio-in[1] + qom-set path=uart property=sysbus-irq[1] value=plic/unnamed-gpio-in[2] + qom-set path=uart property=sysbus-irq[2] value=plic/unnamed-gpio-in[3] + qom-set path=uart property=sysbus-irq[3] value=plic/unnamed-gpio-in[4] + + x-exit-preconfig + +These commands reproduce a subset of the riscv32 opentitan (hw/riscv/opentitan) +machine. We can start qemu using:: + + qemu-sytem-riscv32 -preconfig -qmp unix:./qmp-sock,server \ + -machine none -cpu lowriscv-ibex -serial mon:stdio ... + +Then we just have to issue the commands, for example using `qmp-shell`. If the +previous commands were in a file named `machine.qmp`, we could do:: + + qmp-shell ./qmp-sock < machine.qmp -- 2.33.0
next prev parent reply other threads:[~2021-09-22 17:36 UTC|newest] Thread overview: 82+ messages / expand[flat|nested] mbox.gz Atom feed top 2021-09-22 16:13 [RFC PATCH v2 00/16] Initial support for machine creation via QMP Damien Hedde 2021-09-22 16:13 ` Damien Hedde 2021-09-22 16:13 ` [RFC PATCH v2 01/16] rename MachineInitPhase enum constants for QAPI compatibility Damien Hedde 2021-09-22 16:13 ` Damien Hedde 2021-09-22 16:13 ` [RFC PATCH v2 02/16] qapi: Implement query-machine-phase QMP command Damien Hedde 2021-09-22 16:13 ` Damien Hedde 2021-09-22 17:37 ` Philippe Mathieu-Daudé 2021-09-22 17:37 ` Philippe Mathieu-Daudé 2021-09-23 12:43 ` Damien Hedde 2021-09-23 12:43 ` Damien Hedde 2021-09-23 13:46 ` Ani Sinha 2021-09-23 13:46 ` Ani Sinha 2021-10-12 22:08 ` Alistair Francis 2021-10-12 22:08 ` Alistair Francis 2021-09-22 16:13 ` [RFC PATCH v2 03/16] qapi: Implement x-machine-init " Damien Hedde 2021-09-22 16:13 ` Damien Hedde 2021-10-12 22:19 ` Alistair Francis 2021-10-12 22:19 ` Alistair Francis 2021-09-22 16:13 ` [RFC PATCH v2 04/16] softmmu/qdev-monitor: add error handling in qdev_set_id Damien Hedde 2021-09-22 16:13 ` Damien Hedde 2021-10-13 7:10 ` Alistair Francis 2021-10-13 7:10 ` Alistair Francis 2021-10-13 14:30 ` Damien Hedde 2021-10-13 14:30 ` Damien Hedde 2021-09-22 16:13 ` [RFC PATCH v2 05/16] qdev-monitor: prevent conflicts between qmp/device_add and cli/-device Damien Hedde 2021-09-22 16:13 ` Damien Hedde 2021-09-22 16:13 ` [RFC PATCH v2 06/16] qapi: Allow device_add to execute in machine initialized phase Damien Hedde 2021-09-22 16:13 ` Damien Hedde 2021-10-12 22:25 ` Alistair Francis 2021-10-12 22:25 ` Alistair Francis 2021-09-22 16:13 ` [RFC PATCH v2 07/16] hw/core/machine: add machine_class_is_dynamic_sysbus_dev_allowed Damien Hedde 2021-09-22 16:13 ` Damien Hedde 2021-09-23 10:51 ` Ani Sinha 2021-09-23 10:51 ` Ani Sinha 2021-09-23 13:07 ` Damien Hedde 2021-09-23 13:07 ` Damien Hedde 2021-09-22 16:13 ` [RFC PATCH v2 08/16] qdev-monitor: Check sysbus device type before creating it Damien Hedde 2021-09-22 16:13 ` Damien Hedde 2021-10-12 22:42 ` Alistair Francis 2021-10-12 22:42 ` Alistair Francis 2021-09-22 16:13 ` [RFC PATCH v2 09/16] hw/core/machine: Remove the dynamic sysbus devices type check Damien Hedde 2021-09-22 16:13 ` Damien Hedde 2021-10-12 23:07 ` Alistair Francis 2021-10-12 23:07 ` Alistair Francis 2021-09-22 16:13 ` [RFC PATCH v2 10/16] qdev-monitor: allow adding any sysbus device before machine is ready Damien Hedde 2021-09-22 16:13 ` Damien Hedde 2021-09-23 11:04 ` Ani Sinha 2021-09-23 11:04 ` Ani Sinha 2021-09-23 11:55 ` Ani Sinha 2021-09-23 11:55 ` Ani Sinha 2021-09-23 14:04 ` Damien Hedde 2021-09-23 14:04 ` Damien Hedde 2021-09-22 16:14 ` [RFC PATCH v2 11/16] softmmu/memory: add memory_region_try_add_subregion function Damien Hedde 2021-09-22 16:14 ` Damien Hedde 2021-09-22 17:42 ` Philippe Mathieu-Daudé 2021-09-22 17:42 ` Philippe Mathieu-Daudé 2021-09-22 17:49 ` David Hildenbrand 2021-09-22 17:49 ` David Hildenbrand 2021-10-13 7:12 ` Alistair Francis 2021-10-13 7:12 ` Alistair Francis 2021-09-22 16:14 ` [RFC PATCH v2 12/16] add x-sysbus-mmio-map qmp command Damien Hedde 2021-09-22 16:14 ` Damien Hedde 2021-10-13 7:16 ` Alistair Francis 2021-10-13 7:16 ` Alistair Francis 2021-09-22 16:14 ` [RFC PATCH v2 13/16] hw/mem/system-memory: add a memory sysbus device Damien Hedde 2021-09-22 16:14 ` Damien Hedde 2021-09-22 16:14 ` Damien Hedde [this message] 2021-09-22 16:14 ` [RFC PATCH v2 14/16] docs/system: add doc about the initialized machine phase and an example Damien Hedde 2021-09-22 16:14 ` [RFC PATCH v2 15/16] hw/char/ibex_uart: set user_creatable Damien Hedde 2021-09-22 16:14 ` Damien Hedde 2021-09-22 16:14 ` [RFC PATCH v2 16/16] hw/intc/ibex_plic: " Damien Hedde 2021-09-22 16:14 ` Damien Hedde 2021-09-22 17:50 ` [RFC PATCH v2 00/16] Initial support for machine creation via QMP Philippe Mathieu-Daudé 2021-09-22 17:50 ` Philippe Mathieu-Daudé 2021-09-23 11:08 ` Damien Hedde 2021-09-23 11:08 ` Damien Hedde 2021-10-04 15:56 ` Damien Hedde 2021-10-04 15:56 ` Damien Hedde 2021-10-12 22:16 ` Alistair Francis 2021-10-12 22:16 ` Alistair Francis 2021-10-13 5:56 ` Mark Burton 2021-10-13 5:56 ` Mark Burton
Reply instructions: You may reply publicly to this message via plain-text email using any one of the following methods: * Save the following mbox file, import it into your mail client, and reply-to-all from there: mbox Avoid top-posting and favor interleaved quoting: https://en.wikipedia.org/wiki/Posting_style#Interleaved_style * Reply using the --to, --cc, and --in-reply-to switches of git-send-email(1): git send-email \ --in-reply-to=20210922161405.140018-15-damien.hedde@greensocs.com \ --to=damien.hedde@greensocs.com \ --cc=Alistair.Francis@wdc.com \ --cc=ani@anisinha.ca \ --cc=anthony.perard@citrix.com \ --cc=armbru@redhat.com \ --cc=berrange@redhat.com \ --cc=david@redhat.com \ --cc=dgilbert@redhat.com \ --cc=eblake@redhat.com \ --cc=edgari@xilinx.com \ --cc=ehabkost@redhat.com \ --cc=eric.auger@redhat.com \ --cc=imammedo@redhat.com \ --cc=kraxel@redhat.com \ --cc=marcandre.lureau@redhat.com \ --cc=mark.burton@greensocs.com \ --cc=mirela.grujic@greensocs.com \ --cc=mst@redhat.com \ --cc=paul@xen.org \ --cc=pbonzini@redhat.com \ --cc=peter.maydell@linaro.org \ --cc=peterx@redhat.com \ --cc=qemu-devel@nongnu.org \ --cc=qemu-riscv@nongnu.org \ --cc=sstabellini@kernel.org \ --cc=xen-devel@lists.xenproject.org \ /path/to/YOUR_REPLY https://kernel.org/pub/software/scm/git/docs/git-send-email.html * If your mail client supports setting the In-Reply-To header via mailto: links, try the mailto: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.