[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v14 02/21] multi-process: add configure and usage information
From: |
elena . ufimtseva |
Subject: |
[PATCH v14 02/21] multi-process: add configure and usage information |
Date: |
Thu, 17 Dec 2020 19:57:49 -0800 |
From: Elena Ufimtseva <elena.ufimtseva@oracle.com>
Adds documentation explaining the command-line arguments needed
to use multi-process.
Signed-off-by: Elena Ufimtseva <elena.ufimtseva@oracle.com>
Signed-off-by: Jagannathan Raman <jag.raman@oracle.com>
Signed-off-by: John G Johnson <john.g.johnson@oracle.com>
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
---
docs/multi-process.rst | 64 ++++++++++++++++++++++++++++++++++++++++++
MAINTAINERS | 1 +
2 files changed, 65 insertions(+)
create mode 100644 docs/multi-process.rst
diff --git a/docs/multi-process.rst b/docs/multi-process.rst
new file mode 100644
index 0000000000..46bb0cafc2
--- /dev/null
+++ b/docs/multi-process.rst
@@ -0,0 +1,64 @@
+Multi-process QEMU
+==================
+
+This document describes how to configure and use multi-process qemu.
+For the design document refer to docs/devel/qemu-multiprocess.
+
+1) Configuration
+----------------
+
+multi-process is enabled by default for targets that enable KVM
+
+
+2) Usage
+--------
+
+Multi-process QEMU requires an orchestrator to launch.
+
+Following is a description of command-line used to launch mpqemu.
+
+* Orchestrator:
+
+ - The Orchestrator creates a unix socketpair
+
+ - It launches the remote process and passes one of the
+ sockets to it via command-line.
+
+ - It then launches QEMU and specifies the other socket as an option
+ to the Proxy device object
+
+* Remote Process:
+
+ - QEMU can enter remote process mode by using the "remote" machine
+ option.
+
+ - The orchestrator creates a "remote-object" with details about
+ the device and the file descriptor for the device
+
+ - The remaining options are no different from how one launches QEMU with
+ devices.
+
+ - Example command-line for the remote process is as follows:
+
+ /usr/bin/qemu-system-x86_64 \
+ -machine x-remote \
+ -device lsi53c895a,id=lsi0 \
+ -drive id=drive_image2,file=/build/ol7-nvme-test-1.qcow2 \
+ -device scsi-hd,id=drive2,drive=drive_image2,bus=lsi0.0,scsi-id=0 \
+ -object x-remote-object,id=robj1,devid=lsi1,fd=4,
+
+* QEMU:
+
+ - Since parts of the RAM are shared between QEMU & remote process, a
+ memory-backend-memfd is required to facilitate this, as follows:
+
+ -object memory-backend-memfd,id=mem,size=2G
+
+ - A "x-pci-proxy-dev" device is created for each of the PCI devices emulated
+ in the remote process. A "socket" sub-option specifies the other end of
+ unix channel created by orchestrator. The "id" sub-option must be specified
+ and should be the same as the "id" specified for the remote PCI device
+
+ - Example commandline for QEMU is as follows:
+
+ -device x-pci-proxy-dev,id=lsi0,socket=3
diff --git a/MAINTAINERS b/MAINTAINERS
index c8c29a2814..398973ca91 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -3168,6 +3168,7 @@ M: Jagannathan Raman <jag.raman@oracle.com>
M: John G Johnson <john.g.johnson@oracle.com>
S: Maintained
F: docs/devel/multi-process.rst
+F: docs/multi-process.rst
Build and test automation
-------------------------
--
2.25.GIT
- [PATCH v14 00/21] Initial support for multi-process Qemu, elena . ufimtseva, 2020/12/17
- [PATCH v14 04/21] socket: export socket_get_fd() function, elena . ufimtseva, 2020/12/17
- [PATCH v14 02/21] multi-process: add configure and usage information,
elena . ufimtseva <=
- [PATCH v14 03/21] memory: alloc RAM from file at offset, elena . ufimtseva, 2020/12/17
- [PATCH v14 01/21] multi-process: add the concept description to docs/devel/qemu-multiprocess, elena . ufimtseva, 2020/12/17
- Re: [PATCH v14 00/21] Initial support for multi-process Qemu, Elena Ufimtseva, 2020/12/18
- [PATCH v14 RESEND 06/21] multi-process: setup PCI host bridge for remote device, elena . ufimtseva, 2020/12/18
- [PATCH v14 RESEND 07/21] multi-process: setup a machine object for remote device process, elena . ufimtseva, 2020/12/18
- [PATCH v14 RESEND 05/21] multi-process: Add config option for multi-process QEMU, elena . ufimtseva, 2020/12/18
- [PATCH v14 RESEND 09/21] multi-process: add qio channel read function, elena . ufimtseva, 2020/12/18
- [PATCH v14 RESEND 10/21] multi-process: define MPQemuMsg format and transmission functions, elena . ufimtseva, 2020/12/18