cloud-hypervisor/docs/hotplug.md

8 or by using this kernel patch (available in 5.5-rc1 and later): https://git.kernel.org/pub/scm/linu…
12 Extra vCPUs can be added and removed from a running `cloud-hypervisor` instance. This is controlled…
21 $ sudo setcap cap_net_admin+ep ./cloud-hypervisor/target/release/cloud-hypervisor
22 $ ./cloud-hypervisor/target/release/cloud-hypervisor \
23 	--kernel custom-vmlinux.bin \
24 	--cmdline "console=ttyS0 console=hvc0 root=/dev/vda1 rw" \
25 	--disk path=focal-server-cloudimg-amd64.raw \
26 	--cpus boot=4,max=8 \
27 	--memory size=1024M \
28 	--net "tap=,mac=,ip=,mask=" \
29 	--rng \
30 	--api-socket=/tmp/ch-socket
34 Notice the addition of `--api-socket=/tmp/ch-socket` and a `max` parameter on `--cpus boot=4,max=8`.
36 To ask the VMM to add additional vCPUs then use the resize API:
39 ./ch-remote --api-socket=/tmp/ch-socket resize --cpus 8
42 …kernel. The kernel does not bring up the CPUs immediately and instead the user must "online" them …
45 root@ch-guest ~ # lscpu | grep list:
46 On-line CPU(s) list:             0-3
47 Off-line CPU(s) list:            4-7
48 root@ch-guest ~ # echo 1 | tee /sys/devices/system/cpu/cpu[4,5,6,7]/online
50 root@ch-guest ~ # lscpu | grep list:
51 On-line CPU(s) list:             0-7
59 ./ch-remote --api-socket=/tmp/ch-socket resize --cpus 2
68 Extra memory can be added from a running `cloud-hypervisor` instance. This is controlled by two mec…
75 Because the ACPI method is the default, there is no need to add the extra option `hotplug_method=ac…
79 $ sudo setcap cap_net_admin+ep ./cloud-hypervisor/target/release/cloud-hypervisor
80 $ ./cloud-hypervisor/target/release/cloud-hypervisor \
81 	--kernel custom-vmlinux.bin \
82 	--cmdline "console=ttyS0 console=hvc0 root=/dev/vda1 rw" \
83 	--disk path=focal-server-cloudimg-amd64.raw \
84 	--cpus boot=4,max=8 \
85 	--memory size=1024M,hotplug_size=8192M \
86 	--net "tap=,mac=,ip=,mask=" \
87 	--rng \
88 	--api-socket=/tmp/ch-socket
95 root@ch-guest ~ # echo online | sudo tee /sys/devices/system/memory/auto_online_blocks
101 ./ch-remote --api-socket=/tmp/ch-socket resize --memory 3G
107 free -h
119 ### virtio-mem method
126 …e size RAM in the `hotplug_size` parameter along with `hotplug_method=virtio-mem` to the memory co…
130 $ sudo setcap cap_net_admin+ep ./cloud-hypervisor/target/release/cloud-hypervisor
131 $ ./cloud-hypervisor/target/release/cloud-hypervisor \
132 	--kernel custom-vmlinux.bin \
133 	--cmdline "console=ttyS0 console=hvc0 root=/dev/vda1 rw" \
134 	--disk path=focal-server-cloudimg-amd64.raw \
135 	--memory size=1024M,hotplug_size=8192M,hotplug_method=virtio-mem \
136 	--net "tap=,mac=,ip=,mask=" \
137 	--api-socket=/tmp/ch-socket
144 ./ch-remote --api-socket=/tmp/ch-socket resize --memory 3G
150 free -h
158 ## PCI Device Hot Plug
160 …-hypervisor` instance. This is controlled by making a HTTP API request to the VMM to ask for the a…
162 …64 platform, PCI device hotplug can only be achieved using ACPI. Please refer to the [documentatio…
164 To use PCI device hotplug start the VM with the HTTP server.
167 $ sudo setcap cap_net_admin+ep ./cloud-hypervisor/target/release/cloud-hypervisor
168 $ ./cloud-hypervisor/target/release/cloud-hypervisor \
169 	--kernel custom-vmlinux.bin \
170 	--cmdline "console=ttyS0 console=hvc0 root=/dev/vda1 rw" \
171 	--disk path=focal-server-cloudimg-amd64.raw \
172 	--cpus boot=4 \
173 	--memory size=1024M \
174 	--net "tap=,mac=,ip=,mask=" \
175 	--api-socket=/tmp/ch-socket
178 Notice the addition of `--api-socket=/tmp/ch-socket`.
180 ### Add VFIO Device
182 To ask the VMM to add additional VFIO device then use the `add-device` API.
185 ./ch-remote --api-socket=/tmp/ch-socket add-device path=/sys/bus/pci/devices/0000:01:00.0/
188 ### Add Disk Device
190 To ask the VMM to add additional disk device then use the `add-disk` API.
193 ./ch-remote --api-socket=/tmp/ch-socket add-disk path=/foo/bar/cloud.img
196 ### Add Fs Device
198 To ask the VMM to add additional fs device then use the `add-fs` API.
201 ./ch-remote --api-socket=/tmp/ch-socket add-fs tag=myfs,socket=/foo/bar/virtiofs.sock
204 ### Add Net Device
206 To ask the VMM to add additional network device then use the `add-net` API.
209 ./ch-remote --api-socket=/tmp/ch-socket add-net tap=chtap0
212 ### Add Pmem Device
214 To ask the VMM to add additional PMEM device then use the `add-pmem` API.
217 ./ch-remote --api-socket=/tmp/ch-socket add-pmem file=/foo/bar.cloud.img
220 ### Add Vsock Device
222 To ask the VMM to add additional vsock device then use the `add-vsock` API.
225 ./ch-remote --api-socket=/tmp/ch-socket add-vsock cid=3,socket=/foo/bar/vsock.sock
230 The extra PCI device will be created and advertised to the running kernel. The new device can be fo…
233 root@ch-guest ~ # lspci
234 00:00.0 Host bridge: Intel Corporation Device 0d57
236 00:02.0 Mass storage controller: Red Hat, Inc. Virtio block device (rev 01)
240 After a reboot the added PCI device will remain.
242 ### Remove PCI device
244 …device works the same way for all kind of PCI devices. The unique identifier related to the device…
247 ./ch-remote --api-socket=/tmp/ch-socket remove-device _disk0
250 As per adding a PCI device to the guest, after a reboot the VM will be running without the removed …