From nobody Sun Nov 24 08:46:30 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1725912798; cv=none; d=zohomail.com; s=zohoarc; b=Pt4ttBuxSIScRRPsitlXurCQGkuxA8nv/xcYdG6FNCXbblbI6dfwsj3/oFk7Wx8BMl8d79EvqwZjkkOAhPC/aWYt5FWx7GAFaIG3himyUOAgc8Myz62bygQBHMlIh7ldWkngbg27A8zDXoWLxmUT6IijhW2rV8U8vafT4vWzA6A= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1725912798; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=HNelb35Lz3HQub41/Z2JM0wVsojlW9d18+WONVrmQ+4=; b=f8LMF1WN5/DUb1WVcxd4X/3iC0TcRei0CHAbVHsw3mkXF3VU5k/l6CDZInE2x5VsyCyTrQ2fOt5fvFjwzWHtQOG3bg4QY9B89QlaPP2vv7O2KsIPgEprWULmmTPJpGgRvA4mY7t3hmgjf2TWdjNb2fDwMkj9QAH7Uhn5Ksg9uDI= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1725912798654610.1974024451215; Mon, 9 Sep 2024 13:13:18 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1snkk1-0000Qu-9v; Mon, 09 Sep 2024 16:12:05 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1snkjz-0000Jp-KW for qemu-devel@nongnu.org; Mon, 09 Sep 2024 16:12:03 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1snkjx-00052K-J8 for qemu-devel@nongnu.org; Mon, 09 Sep 2024 16:12:03 -0400 Received: from mail-qt1-f200.google.com (mail-qt1-f200.google.com [209.85.160.200]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-660-IgE0wJ-0M6SsM6MVj1vShg-1; Mon, 09 Sep 2024 16:11:59 -0400 Received: by mail-qt1-f200.google.com with SMTP id d75a77b69052e-457cde3fd7bso60821cf.3 for ; Mon, 09 Sep 2024 13:11:59 -0700 (PDT) Received: from x1n.redhat.com (pool-99-254-121-117.cpe.net.cable.rogers.com. [99.254.121.117]) by smtp.gmail.com with ESMTPSA id d75a77b69052e-45822f93978sm22838561cf.83.2024.09.09.13.11.55 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 09 Sep 2024 13:11:56 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1725912721; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=HNelb35Lz3HQub41/Z2JM0wVsojlW9d18+WONVrmQ+4=; b=Z7MgcqV+oltulFj63pYECY8mYLxvKOiJ97bdObmBuvw2kiH1QBXrwj2Wq2LggJEX3F/mOS vX9TMNbINKon9dzL9z1OeFThVldZH3Yya+32REKepw7lZmjSfDIWmKKbnNDSOCF+YyMCHP f2coAnkmrjXvt/bnq4APDF8POnDMHrM= X-MC-Unique: IgE0wJ-0M6SsM6MVj1vShg-1 X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1725912718; x=1726517518; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=HNelb35Lz3HQub41/Z2JM0wVsojlW9d18+WONVrmQ+4=; b=U4FGHxlrfMJnaletVdr/qc0f1YSkkbdQmGAS24hqCL8PnNOsfytgFpSBQeoO010jUJ VXsnD/rWVun71H0wkaQPGzOpzS8SMVQchQXlYNo0En2MY/SZrGiYakp4eGcL2ko+LC/E AIcwLctDAka3wwvDzDyWNJMXgYXmJcLufysDqmzlEHlQo7iEA4IwyYkFginVexajvpbp uc+XHx0Vr9FMqOe0EMTgcWSxw7w151jLd1hl+wG3551/8otqfEg0AzcfffP0skuF5QhY 9JfRwICyKx9u8ohI9icz+XUfkcR07/UUOKORMoP+fBVi4c++CFhDlvbow+SKmjR3c3Aq ltDg== X-Gm-Message-State: AOJu0YxW7FsYJ2GZcNJkENOVn5oBuv6853RZv26yp25D6bi2imR0depp Wf1ZK2O3E9v0yqAieWUWt3KE1zCvgnXl1iIvjH9P/6xdDNMzyqwpzC4aVoeEBNLA+0W7XB6qjac fKnCn3NPZSuyymo5ay7WYxTu6ry3B1B+MAEAW/brHm7dqmc7pwWfQVO8qjoJcPDcsllValIoQLw 438cTt8iIBChMmTKG1CNELsC5/KKj0I93mIA== X-Received: by 2002:ac8:584e:0:b0:456:45c6:2c30 with SMTP id d75a77b69052e-4581f6f6a7bmr100772871cf.53.1725912718098; Mon, 09 Sep 2024 13:11:58 -0700 (PDT) X-Google-Smtp-Source: AGHT+IEOrEkLSxXtaOjmBMWOBgp2bxdh3qkgdOu9VnHMg5IuBwaisJ/KzDkcXGGe+iHlMRl/IVwKUQ== X-Received: by 2002:ac8:584e:0:b0:456:45c6:2c30 with SMTP id d75a77b69052e-4581f6f6a7bmr100772261cf.53.1725912717448; Mon, 09 Sep 2024 13:11:57 -0700 (PDT) From: Peter Xu To: qemu-devel@nongnu.org Cc: Peter Maydell , Peter Xu , Fabiano Rosas , Yuan Liu , Nanhai Zou , Yichen Wang Subject: [PULL 4/9] docs/migration: add qatzip compression feature Date: Mon, 9 Sep 2024 16:11:42 -0400 Message-ID: <20240909201147.3761639-5-peterx@redhat.com> X-Mailer: git-send-email 2.45.0 In-Reply-To: <20240909201147.3761639-1-peterx@redhat.com> References: <20240909201147.3761639-1-peterx@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.133.124; envelope-from=peterx@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -21 X-Spam_score: -2.2 X-Spam_bar: -- X-Spam_report: (-2.2 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.141, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1725912800604116600 Content-Type: text/plain; charset="utf-8" From: Yuan Liu add Intel QATzip compression method introduction Reviewed-by: Nanhai Zou Reviewed-by: Peter Xu Reviewed-by: Fabiano Rosas Signed-off-by: Yuan Liu Signed-off-by: Yichen Wang Link: https://lore.kernel.org/r/20240830232722.58272-2-yichen.wang@bytedanc= e.com Signed-off-by: Peter Xu --- docs/devel/migration/features.rst | 1 + docs/devel/migration/qatzip-compression.rst | 165 ++++++++++++++++++++ 2 files changed, 166 insertions(+) create mode 100644 docs/devel/migration/qatzip-compression.rst diff --git a/docs/devel/migration/features.rst b/docs/devel/migration/featu= res.rst index 58f8fd9e16..8f431d52f9 100644 --- a/docs/devel/migration/features.rst +++ b/docs/devel/migration/features.rst @@ -14,3 +14,4 @@ Migration has plenty of features to support different use= cases. CPR qpl-compression uadk-compression + qatzip-compression diff --git a/docs/devel/migration/qatzip-compression.rst b/docs/devel/migra= tion/qatzip-compression.rst new file mode 100644 index 0000000000..862b383164 --- /dev/null +++ b/docs/devel/migration/qatzip-compression.rst @@ -0,0 +1,165 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +QATzip Compression +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +In scenarios with limited network bandwidth, the ``QATzip`` solution can h= elp +users save a lot of host CPU resources by accelerating compression and +decompression through the Intel QuickAssist Technology(``QAT``) hardware. + + +The following test was conducted using 8 multifd channels and 10Gbps netwo= rk +bandwidth. The results show that, compared to zstd, ``QATzip`` significant= ly +saves CPU resources on the sender and reduces migration time. Compared to = the +uncompressed solution, ``QATzip`` greatly improves the dirty page processi= ng +capability, indicated by the Pages per Second metric, and also reduces the +total migration time. + +:: + + VM Configuration: 16 vCPU and 64G memory + VM Workload: all vCPUs are idle and 54G memory is filled with Silesia d= ata. + QAT Devices: 4 + |-----------|--------|---------|----------|----------|------|------| + |8 Channels |Total |down |throughput|pages per | send | recv | + | |time(ms)|time(ms) |(mbps) |second | cpu %| cpu% | + |-----------|--------|---------|----------|----------|------|------| + |qatzip | 16630| 28| 10467| 2940235| 160| 360| + |-----------|--------|---------|----------|----------|------|------| + |zstd | 20165| 24| 8579| 2391465| 810| 340| + |-----------|--------|---------|----------|----------|------|------| + |none | 46063| 40| 10848| 330240| 45| 85| + |-----------|--------|---------|----------|----------|------|------| + + +QATzip Compression Framework +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D + +``QATzip`` is a user space library which builds on top of the Intel QuickA= ssist +Technology to provide extended accelerated compression and decompression +services. + +For more ``QATzip`` introduction, please refer to `QATzip Introduction +`_ + +:: + + +----------------+ + | MultiFd Thread | + +-------+--------+ + | + | compress/decompress + +-------+--------+ + | QATzip library | + +-------+--------+ + | + +-------+--------+ + | QAT library | + +-------+--------+ + | user space + --------+--------------------- + | kernel space + +------+-------+ + | QAT Driver | + +------+-------+ + | + +------+-------+ + | QAT Devices | + +--------------+ + + +QATzip Installation +------------------- + +The ``QATzip`` installation package has been integrated into some Linux +distributions and can be installed directly. For example, the Ubuntu Server +24.04 LTS system can be installed using below command + +.. code-block:: shell + + #apt search qatzip + libqatzip-dev/noble 1.2.0-0ubuntu3 amd64 + Intel QuickAssist user space library development files + + libqatzip3/noble 1.2.0-0ubuntu3 amd64 + Intel QuickAssist user space library + + qatzip/noble,now 1.2.0-0ubuntu3 amd64 [installed] + Compression user-space tool for Intel QuickAssist Technology + + #sudo apt install libqatzip-dev libqatzip3 qatzip + +If your system does not support the ``QATzip`` installation package, you c= an +use the source code to build and install, please refer to `QATzip source c= ode installation +`_ + +QAT Hardware Deployment +----------------------- + +``QAT`` supports physical functions(PFs) and virtual functions(VFs) for +deployment, and users can configure ``QAT`` resources for migration accord= ing +to actual needs. For more details about ``QAT`` deployment, please refer to +`Intel QuickAssist Technology Documentation +`_ + +For more ``QAT`` hardware introduction, please refer to `intel-quick-assis= t-technology-overview +`_ + +How To Use QATzip Compression +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D + +1 - Install ``QATzip`` library + +2 - Build ``QEMU`` with ``--enable-qatzip`` parameter + + E.g. configure --target-list=3Dx86_64-softmmu --enable-kvm ``--enable-qa= tzip`` + +3 - Set ``migrate_set_parameter multifd-compression qatzip`` + +4 - Set ``migrate_set_parameter multifd-qatzip-level comp_level``, the def= ault +comp_level value is 1, and it supports levels from 1 to 9 + +QAT Memory Requirements +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +The user needs to reserve system memory for the QAT memory management to +allocate DMA memory. The size of the reserved system memory depends on the +number of devices used for migration and the number of multifd channels. + +Because memory usage depends on QAT configuration, please refer to `QAT Me= mory +Driver Queries +`_ +for memory usage calculation. + +.. list-table:: An example of a PF used for migration + :header-rows: 1 + + * - Number of channels + - Sender memory usage + - Receiver memory usage + * - 2 + - 10M + - 10M + * - 4 + - 12M + - 14M + * - 8 + - 16M + - 20M + +How To Choose Between QATzip and QPL +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +Starting from 4th Gen Intel Xeon Scalable processors, codenamed Sapphire R= apids +processor(``SPR``), multiple built-in accelerators are supported including +``QAT`` and ``IAA``. The former can accelerate ``QATzip`` and the latter = is +used to accelerate ``QPL``. + +Here are some suggestions: + +1 - If the live migration scenario is limited by network bandwidth and ``Q= AT`` +hardware resources exceed ``IAA``, use the ``QATzip`` method, which can sa= ve a +lot of host CPU resources for compression. + +2 - If the system cannot support shared virtual memory (SVM) technology, u= se +the ``QATzip`` method because ``QPL`` performance is not good without SVM +support. + +3 - For other scenarios, use the ``QPL`` method first. --=20 2.45.0