From patchwork Mon Aug 8 02:28:02 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Dou Liyang X-Patchwork-Id: 9266625 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 6961160754 for ; Mon, 8 Aug 2016 02:28:47 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 5CB902787C for ; Mon, 8 Aug 2016 02:28:47 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 512FB27D16; Mon, 8 Aug 2016 02:28:47 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.9 required=2.0 tests=BAYES_00,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from lists.gnu.org (lists.gnu.org [208.118.235.17]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id 9E06F2787C for ; Mon, 8 Aug 2016 02:28:45 +0000 (UTC) Received: from localhost ([::1]:54530 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bWaJ2-0002AP-Gn for patchwork-qemu-devel@patchwork.kernel.org; Sun, 07 Aug 2016 22:28:44 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:54901) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bWaIj-00029z-Qm for qemu-devel@nongnu.org; Sun, 07 Aug 2016 22:28:27 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1bWaIg-0001xk-B9 for qemu-devel@nongnu.org; Sun, 07 Aug 2016 22:28:25 -0400 Received: from [59.151.112.132] (port=41667 helo=heian.cn.fujitsu.com) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bWaIf-0001uk-7F for qemu-devel@nongnu.org; Sun, 07 Aug 2016 22:28:22 -0400 X-IronPort-AV: E=Sophos;i="5.22,518,1449504000"; d="scan'208";a="9656368" Received: from unknown (HELO cn.fujitsu.com) ([10.167.33.5]) by heian.cn.fujitsu.com with ESMTP; 08 Aug 2016 10:28:08 +0800 Received: from G08CNEXCHPEKD03.g08.fujitsu.local (unknown [10.167.33.85]) by cn.fujitsu.com (Postfix) with ESMTP id B6FF342CA574; Mon, 8 Aug 2016 10:28:05 +0800 (CST) Received: from localhost.localdomain.localdomain (10.167.226.106) by G08CNEXCHPEKD03.g08.fujitsu.local (10.167.33.89) with Microsoft SMTP Server (TLS) id 14.3.279.2; Mon, 8 Aug 2016 10:28:08 +0800 From: Dou Liyang To: Date: Mon, 8 Aug 2016 10:28:02 +0800 Message-ID: <1470623282-3837-1-git-send-email-douly.fnst@cn.fujitsu.com> X-Mailer: git-send-email 2.5.5 MIME-Version: 1.0 X-Originating-IP: [10.167.226.106] X-yoursite-MailScanner-ID: B6FF342CA574.A1F2D X-yoursite-MailScanner: Found to be clean X-yoursite-MailScanner-From: douly.fnst@cn.fujitsu.com X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 59.151.112.132 Subject: [Qemu-devel] [PATCH] docs: add cpu-hotplug.txt X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: imammedo@redhat.com, Dou Liyang Errors-To: qemu-devel-bounces+patchwork-qemu-devel=patchwork.kernel.org@nongnu.org Sender: "Qemu-devel" X-Virus-Scanned: ClamAV using ClamSMTP This document describes how to use cpu hotplug in QEMU. Signed-off-by: Dou Liyang --- docs/cpu-hotplug.txt | 110 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 110 insertions(+) create mode 100644 docs/cpu-hotplug.txt diff --git a/docs/cpu-hotplug.txt b/docs/cpu-hotplug.txt new file mode 100644 index 0000000..d62638e --- /dev/null +++ b/docs/cpu-hotplug.txt @@ -0,0 +1,110 @@ +QEMU CPU hotplug +=================== + +This document explains how to use the cpu hotplug feature in QEMU, +which is present since v2.6.0. + +Guest support is required for cpu hotplug to work. + +CPU hotplug +------------------- + +In order to be able to hotplug cpu, QEMU has to be told what is the +maximum amount of cpus the guest can grow. This is done at startup +time by means of the -smp command-line option, which has the following +format: + + -smp [cpus=]n[,maxcpus=cpus][,cores=cores][,threads=threads] + [,sockets=sockets] + +Where, + + - "cpus" set the number of CPUs to 'n' [default=1] + - "maxcpus" maximum number of total cpus, including offlineCPUs for + hotplug, etc + - "cores" number of CPU cores on one socket + - "threads= number of threads on one CPU core + - "sockets= number of discrete sockets in the system + + +For example, the following command-line: + + qemu [...] -smp 3,maxcpus=10,sockets=2,cores=2,threads=2 + +Creates a guest with 3 cpus and it support up to 10 cpus. The cpu +topology is sockets (2) * cores (2) * threads (2) and can't greater +than maxcpus. When the guest is just booted, the guest will see 3 +cpus. so there are seven cpus can be hotplugged by using any +combination of the available sockets,cores and threads topology or +using apic-id. + +cpu hot-plug +----------------------- + +A monitor commands are used to hotplug cpu: + + - "device_add": creates a cpu device and inserts it into the + specific topology as a device + +For example, the following commands add a cpu which id is cpu1 to +the guest discussed earlier: + + (qemu) device_add qemu64-x86_64-cpu,id=cpu1,apic-id=3 + + - "qemu64-x86_64-cpu" is the cpu modle. + - "id" is the unique identifier in the device sets. + - "apic-id" is the hotpluged cpu's physical identification. + +Another command uses the cpu topology to add the additional cpu in +the designated position. + +For example, the following commands add a cpu in the last position +of the guest cpu topology discussed earlier. + + (qemu) device_add qemu64-x86_64-cpu,id=cpu1,socket-id=2,core-id=1, + thread-id=1 + +It's also possible to start a guest with cpu cold-plugged into the +hotpluggable cpu topology. + +In the following command-line example, a guest which has 3 cpus is +created where one of the cpus comes from the "apic-id", and another +one comes from "socket-id...". After that, the guest has additional +seven cpus to be hot-plug when needed: + + qemu [...] -smp 1,maxcpus=10,sockets=2,cores=2,threads=2 + -device qemu64-x86_64-cpu,id=cpu1,apic-id=1 + -device qemu64-x86_64-cpu,socket-id=2,core-id=1,thread-id=0 + +cpu hot-unplug +------------------------ + +In order to be able to hot unplug cpu device, QEMU has two ways +to remove cpu device. + 1. Using the ids which were assigned when you hot plugged cpus. + 2. Using qom_path where the cpu is located in the guest. + +A monitor commands are used to hot unplug cpus: + + - "device_del": deletes a cpu device + +For example, assuming that the cpu device with id "cpu1" exists, +the following commands tries to remove it. + + (qemu) device_del cpu1 + +If you don't set the ids when you hot plugged cpus. + +First, you may need to obtain the cpu's qom_path. The following +commands list all hotplugable-cpus, you can get the qom_path +through the cpu topology. + + (qemu) info hotpluggable-cpus + +Then you can remove it by the qom_path. + +For example, assuming that the cpu device with qom_path "/machine +/unattached/device[0]" exists, the following commands tries to +remove it. + + (qemu) device_del /machine/unattached/device[0]