From nobody Sun Dec 29 01:18:59 2024 Delivered-To: importer2@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+importer2=patchew.org@nongnu.org; dmarc=pass(p=quarantine dis=none) header.from=bytedance.com ARC-Seal: i=1; a=rsa-sha256; t=1721081637; cv=none; d=zohomail.com; s=zohoarc; b=aAh3f7U2JQ8fBvFH3EQRcO6FS/gNIccTPDYg45QtzeqWzqWAibjYmwUlopUnEbi3mqwWQAwNjzlb7aE/SB3NkxQZ38gxpWq+A3jB4pEg7Ag8k9H4FnG5SooLKeAP3mo7CmzDWaT610IapokeSeoQd/AEsmNyPO849nvctSdDfNw= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1721081637; 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=+MGC2Kn8K5/OSwfmUdmDEoAYSPqg+YzbcoDs108eAWs=; b=nvEVPYR15TlohNYd6fmo4bphetjIeoX0pFtsyI5JCuJ2FFKSjlZ8OOdlJCOgvGChjeM7aG5MaeFDlvkb8bnIlNiTAtFkNq5uUWLO16VzNX8W2aqsD0C4hWwI9kJ6stKqLEWGkKbOSj24q02M7J3O+5QluIJgpOWgJYbOCz32sHY= 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+importer2=patchew.org@nongnu.org; dmarc=pass header.from= (p=quarantine dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1721081637517861.0091380817788; Mon, 15 Jul 2024 15:13:57 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sTTwe-00057f-JK; Mon, 15 Jul 2024 18:13:21 -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 1sTTwV-00051v-O3 for qemu-devel@nongnu.org; Mon, 15 Jul 2024 18:13:12 -0400 Received: from mail-ot1-x32e.google.com ([2607:f8b0:4864:20::32e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1sTTwS-0006Iv-MX for qemu-devel@nongnu.org; Mon, 15 Jul 2024 18:13:11 -0400 Received: by mail-ot1-x32e.google.com with SMTP id 46e09a7af769-7037c464792so2525756a34.2 for ; Mon, 15 Jul 2024 15:13:04 -0700 (PDT) Received: from DY4X0N7X05.bytedance.net (ec2-52-8-182-0.us-west-1.compute.amazonaws.com. [52.8.182.0]) by smtp.gmail.com with ESMTPSA id 6a1803df08f44-6b76198aca3sm25398326d6.51.2024.07.15.15.13.00 (version=TLS1_3 cipher=TLS_CHACHA20_POLY1305_SHA256 bits=256/256); Mon, 15 Jul 2024 15:13:01 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bytedance.com; s=google; t=1721081582; x=1721686382; darn=nongnu.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=+MGC2Kn8K5/OSwfmUdmDEoAYSPqg+YzbcoDs108eAWs=; b=BcxaWn73RNZ2NWRa4T60RBB44v0n5uh5irI4Y6bIk6Z4BrBDiuAw8nv+9mcSvweTXB clVGlniv5G+01qkfVr85T+tOhlTP5qSO5cl0oXk3fELu/3P9ez/7SaRUbUtVxEOS7NTi ESdfSecE1kvmOwTlQBij+GSLU8vHyd2j4NKPCHQyGgevULcCkd1Eo4daldBSh5KZwx+p bGyHySGhlLLJIayvZjO4AT+m1qCo1Z921jvetMHb5DbaplaV4wugJGETb68Ko8C7esFO zXJHUr+w5ljCQQERS2vg19ed8b5bfcoKgBEKJj9ShMeUiIdZBRqSMYAepPR8FtDz9/8L L40Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1721081582; x=1721686382; 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=+MGC2Kn8K5/OSwfmUdmDEoAYSPqg+YzbcoDs108eAWs=; b=SolQn4l6ANA63z7UdYSU67aJsRNgOdXOy7aRtBHNWYIMZ5yxRXxFdS/eEwPGiQYzuR tIbQbHy5P4isJ3WPjXyBImxuuSt95KZmORwql3lRCyRSJLiNQwtkrhYLltG/W3KXOC8i Kmd9/CGPBlZAXRhC8LI684OwLqCLXD3d54AVbP82C7HhQwVaww/hjx8q3Qui7v5H4vam xqm7jorIKFQZTNfqU+4xnBzmPpsEPZg7iNvEi5wtefpFmTHIKCStqVTCEvlv2MOCjRtF AcZHYiJ2ulv8kK3A2BDISHckZQTXER6gSe4knh/8Y9j3XTe5ondTRT2Jd5M0d3dAnzKa hDsw== X-Forwarded-Encrypted: i=1; AJvYcCU8cS5gF+THMIQCZF0KT/S+PcHO/+8v3c2vUR4DnrqiMRn+4EB+q9x5gr3Ie/TBZEQh1WDcwwKwbkY0cEWduVVwiE9kK0I= X-Gm-Message-State: AOJu0YxBRyHREW+jN/YeqQAqTBMpQlfpjYhTMCtLJGW5WjtngUejYypo 9dMAyS6uNJUl/uVF5G29INVfsV2seS+OZLnDcQVaCqqR/hiynqXNkxh+Oypd0bc= X-Google-Smtp-Source: AGHT+IGBDp/SkftPlG8ZLmvJDUsGTyFmuXj1B4ma65WFB+fpkZ8GL0d/n0Ia/wmu1oItGg5ABZl39g== X-Received: by 2002:a05:6830:6d19:b0:703:6496:b9ab with SMTP id 46e09a7af769-708d990b3femr619532a34.7.1721081581874; Mon, 15 Jul 2024 15:13:01 -0700 (PDT) From: Yichen Wang To: Peter Xu , Fabiano Rosas , Paolo Bonzini , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Eduardo Habkost , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Thomas Huth , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Eric Blake , Markus Armbruster , Laurent Vivier , qemu-devel@nongnu.org Cc: "Hao Xiang" , "Liu, Yuan1" , "Zou, Nanhai" , "Ho-Ren (Jack) Chuang" , "Yichen Wang" Subject: [PATCH v6 1/5] docs/migration: add qatzip compression feature Date: Mon, 15 Jul 2024 15:12:41 -0700 Message-Id: <20240715221245.12435-2-yichen.wang@bytedance.com> X-Mailer: git-send-email 2.39.3 (Apple Git-146) In-Reply-To: <20240715221245.12435-1-yichen.wang@bytedance.com> References: <20240715221245.12435-1-yichen.wang@bytedance.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+importer2=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2607:f8b0:4864:20::32e; envelope-from=yichen.wang@bytedance.com; helo=mail-ot1-x32e.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, 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+importer2=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer2=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @bytedance.com) X-ZM-MESSAGEID: 1721081639305116300 Content-Type: text/plain; charset="utf-8" From: Yuan Liu add Intel QATzip compression method introduction Signed-off-by: Yuan Liu Reviewed-by: Nanhai Zou Reviewed-by: Peter Xu Reviewed-by: Yichen Wang --- docs/devel/migration/features.rst | 1 + docs/devel/migration/qatzip-compression.rst | 251 ++++++++++++++++++++ 2 files changed, 252 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..72fa3e2826 --- /dev/null +++ b/docs/devel/migration/qatzip-compression.rst @@ -0,0 +1,251 @@ +=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. + +``QATzip`` is a user space library which builds on top of the Intel QuickA= ssist +Technology user space library, to provide extended accelerated compression= and +decompression services. + +For more ``QATzip`` introduction, please refer to `QATzip Introduction +`_ + +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 + +:: + + +----------------+ + | 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 + + +Performance Testing with QATzip +=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 + +Testing environment is being set as below: + +VM configuration:16 vCPU, 64G memory; + +VM Workload: all vCPUs are idle and 54G memory is filled with Silesia data; + +QAT Devices: 4; + +Sender migration parameters: + +.. code-block:: shell + + migrate_set_capability multifd on + migrate_set_parameter multifd-channels 2/4/8 + migrate_set_parameter max-bandwidth 1G/10G + migrate_set_parameter multifd-compression qatzip/zstd + +Receiver migration parameters: + +.. code-block:: shell + + migrate_set_capability multifd on + migrate_set_parameter multifd-channels 2 + migrate_set_parameter multifd-compression qatzip/zstd + +max-bandwidth: 1 GBps (Gbytes/sec) + +.. code-block:: text + + |-----------|--------|---------|----------|------|------| + |2 Channels |Total |down |throughput| send | recv | + | |time(ms)|time(ms) |(mbps) | cpu %| cpu% | + |-----------|--------|---------|----------|------|------| + |qatzip | 21607| 77| 8051| 88| 125| + |-----------|--------|---------|----------|------|------| + |zstd | 78351| 96| 2199| 204| 80| + |-----------|--------|---------|----------|------|------| + + |-----------|--------|---------|----------|------|------| + |4 Channels |Total |down |throughput| send | recv | + | |time(ms)|time(ms) |(mbps) | cpu %| cpu% | + |-----------|--------|---------|----------|------|------| + |qatzip | 20336| 25| 8557| 110| 190| + |-----------|--------|---------|----------|------|------| + |zstd | 39324| 31| 4389| 406| 160| + |-----------|--------|---------|----------|------|------| + + |-----------|--------|---------|----------|------|------| + |8 Channels |Total |down |throughput| send | recv | + | |time(ms)|time(ms) |(mbps) | cpu %| cpu% | + |-----------|--------|---------|----------|------|------| + |qatzip | 20208| 22| 8613| 125| 300| + |-----------|--------|---------|----------|------|------| + |zstd | 20515| 22| 8438| 800| 340| + |-----------|--------|---------|----------|------|------| + +max-bandwidth: 10 GBps (Gbytes/sec) + +.. code-block:: text + + |-----------|--------|---------|----------|------|------| + |2 Channels |Total |down |throughput| send | recv | + | |time(ms)|time(ms) |(mbps) | cpu %| cpu% | + |-----------|--------|---------|----------|------|------| + |qatzip | 22450| 77| 7748| 80| 125| + |-----------|--------|---------|----------|------|------| + |zstd | 78339| 76| 2199| 204| 80| + |-----------|--------|---------|----------|------|------| + + |-----------|--------|---------|----------|------|------| + |4 Channels |Total |down |throughput| send | recv | + | |time(ms)|time(ms) |(mbps) | cpu %| cpu% | + |-----------|--------|---------|----------|------|------| + |qatzip | 13017| 24| 13401| 180| 285| + |-----------|--------|---------|----------|------|------| + |zstd | 39466| 21| 4373| 406| 160| + |-----------|--------|---------|----------|------|------| + + |-----------|--------|---------|----------|------|------| + |8 Channels |Total |down |throughput| send | recv | + | |time(ms)|time(ms) |(mbps) | cpu %| cpu% | + |-----------|--------|---------|----------|------|------| + |qatzip | 10255| 22| 17037| 280| 590| + |-----------|--------|---------|----------|------|------| + |zstd | 20126| 77| 8595| 810| 340| + |-----------|--------|---------|----------|------|------| + +max-bandwidth: 1.25 GBps (Gbytes/sec) + +.. code-block:: text + + |-----------|--------|---------|----------|----------|------|------| + |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| + |-----------|--------|---------|----------|----------|------|------| + +If the user has enabled compression in live migration, using QAT can save = the +host CPU resources. + +When compression is enabled, the bottleneck of migration is usually the +compression throughput on the sender side, since CPU decompression through= put +is higher than compression, some reference data +https://github.com/inikep/lzbench, so more CPU resources need to be alloca= ted +to the sender side. + +Summary: + +1. In the 1GBps case, QAT only uses 88% CPU utilization to reach 1GBps, but + ZSTD needs 800%. + +2. In the 10Gbps case, QAT uses 180% CPU utilization to reach 10GBps. but = ZSTD + still cannot reach 10Gbps even if it uses 810%. + +3. The QAT decompression CPU utilization is higher than compression and ZS= TD, + because: + + a. When using QAT compression, the data needs to be copied to the QAT m= emory + (for DMA operations), and the same for decompression. However, + do_user_addr_fault will be triggered during decompression because the Q= AT + decompressed data is copied to the VM address space for the first time,= in + addition, both compression and decompression are processed by QAT and d= o not + consume CPU resources, so the CPU utilization of the receiver is slight= ly + higher than the sender. + + b. Since zstd decompression decompresses data directly into the VM addr= ess + space, there is one less memory copy than QAT, so the CPU utilization o= n the + receiver is better than QAT. For the 1GBps case, the receiver CPU + utilization is 125%, and the memory copy occupies ~80% of CPU utilizati= on. + +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 Intel 4th Gen Intel Xeon Scalable processors, codenamed Sapp= hire +Rapids processor(``SPR``), it supports multiple build-in accelerators incl= uding +``QAT`` and ``IAA``, the former can accelerate ``QATzip``, and the latter = is +used to accelerate ``QPL``. + +Here are some suggestions: + +1 - If your live migration scenario is limited network bandwidth and ``QAT= `` +hardware resources exceed ``IAA``, then use the ``QATzip`` method, which +can save a lot of host CPU resources for compression. + +2 - If your system cannot support shared virtual memory(SVM) technology, p= lease +use ``QATzip`` method because ``QPL`` performance is not good without SVM +support. + +3 - For other scenarios, please use the ``QPL`` method first. --=20 Yichen Wang From nobody Sun Dec 29 01:18:59 2024 Delivered-To: importer2@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+importer2=patchew.org@nongnu.org; dmarc=pass(p=quarantine dis=none) header.from=bytedance.com ARC-Seal: i=1; a=rsa-sha256; t=1721081672; cv=none; d=zohomail.com; s=zohoarc; b=YtNTpewpdOMbU2ZmrirpodPotkZNAAMH9RyYgFg5j4DZAiwxYEGjB5BTUdg85vbpOh0wXq2356ajaLpLE3NwGLf89+mV8BGc/e1Jvh4qcHFgNNI6De6tz/za3+WIjS1LCvGRkka2SJUQmv1XGY4NyPZ5zuC21cTtbRyFpgULdGQ= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1721081672; 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=FlMvMSAMvhZyUe5kybi6fOi/LKJ/sjw1cIOEtywcrWw=; b=UqQp4arkB1Yv8J5EYXSPjxsIFWYA8TPEBF0aMjViOzqlRsom35trU2T0ZKl6VMfrq1AIRfWMmIelhVmKyC69nCLKO7YJRsac3w38HQE5Bb3j/ni353E18RB5E7Pbpp3YumwODzSMLSrgDt64CPXN2zTBle7KCak8jyXedlj6owI= 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+importer2=patchew.org@nongnu.org; dmarc=pass header.from= (p=quarantine dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1721081672004265.89501561786597; Mon, 15 Jul 2024 15:14:32 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sTTwa-00052c-Ab; Mon, 15 Jul 2024 18:13:16 -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 1sTTwV-00050d-1d for qemu-devel@nongnu.org; Mon, 15 Jul 2024 18:13:11 -0400 Received: from mail-qk1-x72e.google.com ([2607:f8b0:4864:20::72e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1sTTwS-0006JD-MU for qemu-devel@nongnu.org; Mon, 15 Jul 2024 18:13:10 -0400 Received: by mail-qk1-x72e.google.com with SMTP id af79cd13be357-79efd2151d9so325850385a.0 for ; Mon, 15 Jul 2024 15:13:05 -0700 (PDT) Received: from DY4X0N7X05.bytedance.net (ec2-52-8-182-0.us-west-1.compute.amazonaws.com. [52.8.182.0]) by smtp.gmail.com with ESMTPSA id 6a1803df08f44-6b76198aca3sm25398326d6.51.2024.07.15.15.13.02 (version=TLS1_3 cipher=TLS_CHACHA20_POLY1305_SHA256 bits=256/256); Mon, 15 Jul 2024 15:13:04 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bytedance.com; s=google; t=1721081584; x=1721686384; darn=nongnu.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=FlMvMSAMvhZyUe5kybi6fOi/LKJ/sjw1cIOEtywcrWw=; b=kyMPzGWUL4mD04l1tbbpCs5DazF+ypyYpcNgB1a9dZ7N778/JuVPiPNdycag0ALudN FIhJpSXRtnGqCiviT8JFIwl3lUhlSmFKsjkQaw4ZmxEtL6mhhfREKOnzCJDdShe6h7yt MFR8xZLOtOnbO1RqyRuMzvb9xIBFHg2ALpuJY1UMqcXbLEtjQZC/efde/NRanQ0O+Aoo tYBdYmAB6AhfClBdtitAVnyLK9GB/qUXEZNSDviJFV6sdSwumX7A+GqMOixYzwWXehHn SCHPzFFB8pK08ObrdBvwbiFN/6lD0Y1ylcbwvPzPoe25dQn3altNwV7JvqgkAA5RKNrT qqeA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1721081584; x=1721686384; 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=FlMvMSAMvhZyUe5kybi6fOi/LKJ/sjw1cIOEtywcrWw=; b=YWZhOlyuc//zzAFbO/QkWlVEW33pyG0Y7TrOBxHSuCA8gv0Too7bnWe51CtTqDzgLY ItsRhxWsQDyxustDo/X2ocfgLyEVDXd0LCwCtfBA+kLHfuCS8XNcI2HGEmpuoOvLVN2J RG62nq32uIZvUd2T9yEY62cVj5/Yt0Cq5bNO1YGwu/hxEFGhZsBUX3UVXq0sWit9mFlC efCA9VefPY3J9US4xepjxvAz8UxgLkTZClhC4dJCrq6N55ehGQYv9wi6FjTmrveLuCp6 PWiSCDpGtP0BAHByapmgJwIkFug/n0hY3d4Rzs9xptpqWBSoYhISL400KUpVbEQWWapU HUHw== X-Forwarded-Encrypted: i=1; AJvYcCX2pTteAS/zfxVxyAy24cRgeLycd100B89DJ/SpGWw9D/8js7nsEEJS5gaD8Ko6sM3VhPO90Y/fsdbdT0gUjl8yldqi+yw= X-Gm-Message-State: AOJu0YzRQ0VVBlvfIn9zQJNMa88HQmgiOYpSfootL/I1eEuU3mHfVKEp 6OtXl0plBcT+omNnGjdE5GI0EpdhZ04JrZKLRHMbaf2aRFgAvvxoUGrde8734Oo= X-Google-Smtp-Source: AGHT+IEr8Z9Jm4UsWSnJ5A6XOgSQFaX2fzgHcQL/W7DXPomngSGsP38tv/OhRWCxiXFLIepXX3lOpA== X-Received: by 2002:a05:6214:5a04:b0:6b2:da3d:999f with SMTP id 6a1803df08f44-6b77f5d0fb3mr8491556d6.41.1721081584445; Mon, 15 Jul 2024 15:13:04 -0700 (PDT) From: Yichen Wang To: Peter Xu , Fabiano Rosas , Paolo Bonzini , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Eduardo Habkost , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Thomas Huth , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Eric Blake , Markus Armbruster , Laurent Vivier , qemu-devel@nongnu.org Cc: "Hao Xiang" , "Liu, Yuan1" , "Zou, Nanhai" , "Ho-Ren (Jack) Chuang" , "Yichen Wang" , Bryan Zhang Subject: [PATCH v6 2/5] meson: Introduce 'qatzip' feature to the build system Date: Mon, 15 Jul 2024 15:12:42 -0700 Message-Id: <20240715221245.12435-3-yichen.wang@bytedance.com> X-Mailer: git-send-email 2.39.3 (Apple Git-146) In-Reply-To: <20240715221245.12435-1-yichen.wang@bytedance.com> References: <20240715221245.12435-1-yichen.wang@bytedance.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+importer2=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2607:f8b0:4864:20::72e; envelope-from=yichen.wang@bytedance.com; helo=mail-qk1-x72e.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, 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+importer2=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer2=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @bytedance.com) X-ZM-MESSAGEID: 1721081673308116300 Content-Type: text/plain; charset="utf-8" From: Bryan Zhang Add a 'qatzip' feature, which is automatically disabled, and which depends on the QATzip library if enabled. Signed-off-by: Bryan Zhang Signed-off-by: Hao Xiang Signed-off-by: Yichen Wang --- meson.build | 10 ++++++++++ meson_options.txt | 2 ++ scripts/meson-buildoptions.sh | 3 +++ 3 files changed, 15 insertions(+) diff --git a/meson.build b/meson.build index 6a93da48e1..ea977c6cbf 100644 --- a/meson.build +++ b/meson.build @@ -1244,6 +1244,14 @@ if not get_option('uadk').auto() or have_system uadk =3D declare_dependency(dependencies: [libwd, libwd_comp]) endif endif + +qatzip =3D not_found +if get_option('qatzip').enabled() + qatzip =3D dependency('qatzip', version: '>=3D1.1.2', + required: get_option('qatzip'), + method: 'pkg-config') +endif + virgl =3D not_found =20 have_vhost_user_gpu =3D have_tools and host_os =3D=3D 'linux' and pixman.f= ound() @@ -2378,6 +2386,7 @@ config_host_data.set('CONFIG_STATX_MNT_ID', has_statx= _mnt_id) config_host_data.set('CONFIG_ZSTD', zstd.found()) config_host_data.set('CONFIG_QPL', qpl.found()) config_host_data.set('CONFIG_UADK', uadk.found()) +config_host_data.set('CONFIG_QATZIP', qatzip.found()) config_host_data.set('CONFIG_FUSE', fuse.found()) config_host_data.set('CONFIG_FUSE_LSEEK', fuse_lseek.found()) config_host_data.set('CONFIG_SPICE_PROTOCOL', spice_protocol.found()) @@ -4484,6 +4493,7 @@ summary_info +=3D {'lzfse support': liblzfse} summary_info +=3D {'zstd support': zstd} summary_info +=3D {'Query Processing Library support': qpl} summary_info +=3D {'UADK Library support': uadk} +summary_info +=3D {'qatzip support': qatzip} summary_info +=3D {'NUMA host support': numa} summary_info +=3D {'capstone': capstone} summary_info +=3D {'libpmem support': libpmem} diff --git a/meson_options.txt b/meson_options.txt index 0269fa0f16..35a69f6697 100644 --- a/meson_options.txt +++ b/meson_options.txt @@ -261,6 +261,8 @@ option('qpl', type : 'feature', value : 'auto', description: 'Query Processing Library support') option('uadk', type : 'feature', value : 'auto', description: 'UADK Library support') +option('qatzip', type: 'feature', value: 'disabled', + description: 'QATzip compression support') option('fuse', type: 'feature', value: 'auto', description: 'FUSE block device export') option('fuse_lseek', type : 'feature', value : 'auto', diff --git a/scripts/meson-buildoptions.sh b/scripts/meson-buildoptions.sh index cfadb5ea86..1ce467e9cc 100644 --- a/scripts/meson-buildoptions.sh +++ b/scripts/meson-buildoptions.sh @@ -163,6 +163,7 @@ meson_options_help() { printf "%s\n" ' pixman pixman support' printf "%s\n" ' plugins TCG plugins via shared library loading' printf "%s\n" ' png PNG support with libpng' + printf "%s\n" ' qatzip QATzip compression support' printf "%s\n" ' qcow1 qcow1 image format support' printf "%s\n" ' qed qed image format support' printf "%s\n" ' qga-vss build QGA VSS support (broken with MinG= W)' @@ -427,6 +428,8 @@ _meson_option_parse() { --enable-png) printf "%s" -Dpng=3Denabled ;; --disable-png) printf "%s" -Dpng=3Ddisabled ;; --prefix=3D*) quote_sh "-Dprefix=3D$2" ;; + --enable-qatzip) printf "%s" -Dqatzip=3Denabled ;; + --disable-qatzip) printf "%s" -Dqatzip=3Ddisabled ;; --enable-qcow1) printf "%s" -Dqcow1=3Denabled ;; --disable-qcow1) printf "%s" -Dqcow1=3Ddisabled ;; --enable-qed) printf "%s" -Dqed=3Denabled ;; --=20 Yichen Wang From nobody Sun Dec 29 01:18:59 2024 Delivered-To: importer2@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+importer2=patchew.org@nongnu.org; dmarc=pass(p=quarantine dis=none) header.from=bytedance.com ARC-Seal: i=1; a=rsa-sha256; t=1721081673; cv=none; d=zohomail.com; s=zohoarc; b=mjr988IQXYjTBV44yi544FZxRlKJn0MWz5DsYTeioDrHfYbaeLpdodRz/fCJH7+c0CLwdSSCJXbsuXeGeki9p+avpFonw/pRWL8ItmXfaJwJ7FkOxrfNk8whWyaoCzGjhytBtYJ6KXtth5rnwKnQtTibM0fIYPtEGSsOTKNCGgE= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1721081673; 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=ZIzAMwf8jnXRHDk1Vfuw/rfwfjSU1OWcjjUQkenM57c=; b=MDMIfCqW7YjdkGH1qzxMRjcL7qRLuXHE3A6SxNh+jetp26ha+wWRmAfEmOi28NZyH1R3urzxijcHhlh+6x9ftEN7Bw80DHzK0H8XqmUnElPhxfy+gKM+ChkgsaujOSgPdg1MgAnpIGQZ49+GyLpjCeiuhBMhZvzE71Iwa9yFWL4= 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+importer2=patchew.org@nongnu.org; dmarc=pass header.from= (p=quarantine dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1721081673417979.56407980026; Mon, 15 Jul 2024 15:14:33 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sTTwf-0005FJ-Qv; Mon, 15 Jul 2024 18:13:21 -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 1sTTwV-00051L-Bv for qemu-devel@nongnu.org; Mon, 15 Jul 2024 18:13:11 -0400 Received: from mail-qv1-xf35.google.com ([2607:f8b0:4864:20::f35]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1sTTwS-0006JR-Ma for qemu-devel@nongnu.org; Mon, 15 Jul 2024 18:13:11 -0400 Received: by mail-qv1-xf35.google.com with SMTP id 6a1803df08f44-6b5eb69e04cso32966956d6.1 for ; Mon, 15 Jul 2024 15:13:07 -0700 (PDT) Received: from DY4X0N7X05.bytedance.net (ec2-52-8-182-0.us-west-1.compute.amazonaws.com. [52.8.182.0]) by smtp.gmail.com with ESMTPSA id 6a1803df08f44-6b76198aca3sm25398326d6.51.2024.07.15.15.13.04 (version=TLS1_3 cipher=TLS_CHACHA20_POLY1305_SHA256 bits=256/256); Mon, 15 Jul 2024 15:13:06 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bytedance.com; s=google; t=1721081587; x=1721686387; darn=nongnu.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=ZIzAMwf8jnXRHDk1Vfuw/rfwfjSU1OWcjjUQkenM57c=; b=IdRYaTR5ml1pfzhYzakVUjsbjMeHKduUhZF5nMuNgFI4VyIF3vyZZFHKWAkt/2xsql 8Sz99Dj+AfZ+fqJ7Hv3a6nVZpR6qeF+4JaD3Z2zhki879GYFldbxxqZsOF0uoLKjQRkH yyiler63FDkhqE+1o/sRrqzAIirela50vlhrnN/8iBaJPz34uEMqXqDXzIYpFpfLQqwz RyXFIh4iEqEDSVkms+fDstHSJVIcUCBFDPgNAgzA2aSDtelzBLyY51dt/kWra8OA5PTQ wsWbmhxR1wMpRB+vjefACeXLZkh/39NajW4i7bmSgSrGfOw6xAhljb5kqPAylf8rtNkI s8iw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1721081587; x=1721686387; 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=ZIzAMwf8jnXRHDk1Vfuw/rfwfjSU1OWcjjUQkenM57c=; b=k5rB0Vbj6IYXIrW68la0XQmOnOjY07fftcmDZ5EYuxT0uBnWH1/7gl1n3tRsFVd9kv QCYAGk8lGA2bYG1MaxwIy435rUMRikibTfer0iB/7tcnW5QfDInCDN+lD+/i2m1g8210 +e5JcpZZZadKRFxyj+hjdHXpmll54tBDAq0gSX33sat6RmVuXm+e5VfPqne76pMiAgJZ hRJYVYGhN9GKxSjouGPGp1Fwlh5FcSp9YOr6nJ8r3gvZakEQFjGwEs/w6vyePk5j5MaU FSswj1A65HsxbwV7huPB558opBEGKKQUCrr5d2dH/QeY+ZpQYcI1YqfYHS0hAR9J2zgU gFMA== X-Forwarded-Encrypted: i=1; AJvYcCX1sh8nOaHJtNXX744adYXdsnsIapK08UiRMYnlvD8D1ukIMwUROxJENM1RNaDCVa+qNIQKXV7VKNvCtrfRqSJR6CoXW4s= X-Gm-Message-State: AOJu0YzOM3LxNN5a8gxkPaXjq9i4ukgj39GPySOAEHbgiXauiF/h4HAK REWuAGymKiTY8d5iQGmUtLZt3E51IC2nNrvVaP0he3UJmnJuQleCmjDNjRG/WLw= X-Google-Smtp-Source: AGHT+IFt3uYcHuuDrWym3oxLrdFY/OEFDaOm+l7AU1ur5OSXxMPk/CVnoTvmKhi/DyaNOEelr0srLw== X-Received: by 2002:a05:6214:c6b:b0:6b0:9228:5a86 with SMTP id 6a1803df08f44-6b77f3a8392mr9227826d6.22.1721081586734; Mon, 15 Jul 2024 15:13:06 -0700 (PDT) From: Yichen Wang To: Peter Xu , Fabiano Rosas , Paolo Bonzini , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Eduardo Habkost , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Thomas Huth , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Eric Blake , Markus Armbruster , Laurent Vivier , qemu-devel@nongnu.org Cc: "Hao Xiang" , "Liu, Yuan1" , "Zou, Nanhai" , "Ho-Ren (Jack) Chuang" , "Yichen Wang" , Bryan Zhang Subject: [PATCH v6 3/5] migration: Add migration parameters for QATzip Date: Mon, 15 Jul 2024 15:12:43 -0700 Message-Id: <20240715221245.12435-4-yichen.wang@bytedance.com> X-Mailer: git-send-email 2.39.3 (Apple Git-146) In-Reply-To: <20240715221245.12435-1-yichen.wang@bytedance.com> References: <20240715221245.12435-1-yichen.wang@bytedance.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+importer2=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2607:f8b0:4864:20::f35; envelope-from=yichen.wang@bytedance.com; helo=mail-qv1-xf35.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, 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+importer2=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer2=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @bytedance.com) X-ZM-MESSAGEID: 1721081675272116300 Content-Type: text/plain; charset="utf-8" From: Bryan Zhang Adds support for migration parameters to control QATzip compression level and to enable/disable software fallback when QAT hardware is unavailable. This is a preparatory commit for a subsequent commit that will actually use QATzip compression. Signed-off-by: Bryan Zhang Signed-off-by: Hao Xiang Signed-off-by: Yichen Wang Acked-by: Markus Armbruster --- migration/migration-hmp-cmds.c | 4 ++++ migration/options.c | 34 ++++++++++++++++++++++++++++++++++ migration/options.h | 1 + qapi/migration.json | 18 ++++++++++++++++++ 4 files changed, 57 insertions(+) diff --git a/migration/migration-hmp-cmds.c b/migration/migration-hmp-cmds.c index 7d608d26e1..28165cfc9e 100644 --- a/migration/migration-hmp-cmds.c +++ b/migration/migration-hmp-cmds.c @@ -576,6 +576,10 @@ void hmp_migrate_set_parameter(Monitor *mon, const QDi= ct *qdict) p->has_multifd_zlib_level =3D true; visit_type_uint8(v, param, &p->multifd_zlib_level, &err); break; + case MIGRATION_PARAMETER_MULTIFD_QATZIP_LEVEL: + p->has_multifd_qatzip_level =3D true; + visit_type_uint8(v, param, &p->multifd_qatzip_level, &err); + break; case MIGRATION_PARAMETER_MULTIFD_ZSTD_LEVEL: p->has_multifd_zstd_level =3D true; visit_type_uint8(v, param, &p->multifd_zstd_level, &err); diff --git a/migration/options.c b/migration/options.c index 645f55003d..147cd2b8fd 100644 --- a/migration/options.c +++ b/migration/options.c @@ -55,6 +55,13 @@ #define DEFAULT_MIGRATE_MULTIFD_COMPRESSION MULTIFD_COMPRESSION_NONE /* 0: means nocompress, 1: best speed, ... 9: best compress ratio */ #define DEFAULT_MIGRATE_MULTIFD_ZLIB_LEVEL 1 +/* + * 1: best speed, ... 9: best compress ratio + * There is some nuance here. Refer to QATzip documentation to understand + * the mapping of QATzip levels to standard deflate levels. + */ +#define DEFAULT_MIGRATE_MULTIFD_QATZIP_LEVEL 1 + /* 0: means nocompress, 1: best speed, ... 20: best compress ratio */ #define DEFAULT_MIGRATE_MULTIFD_ZSTD_LEVEL 1 =20 @@ -123,6 +130,9 @@ Property migration_properties[] =3D { DEFINE_PROP_UINT8("multifd-zlib-level", MigrationState, parameters.multifd_zlib_level, DEFAULT_MIGRATE_MULTIFD_ZLIB_LEVEL), + DEFINE_PROP_UINT8("multifd-qatzip-level", MigrationState, + parameters.multifd_qatzip_level, + DEFAULT_MIGRATE_MULTIFD_QATZIP_LEVEL), DEFINE_PROP_UINT8("multifd-zstd-level", MigrationState, parameters.multifd_zstd_level, DEFAULT_MIGRATE_MULTIFD_ZSTD_LEVEL), @@ -787,6 +797,13 @@ int migrate_multifd_zlib_level(void) return s->parameters.multifd_zlib_level; } =20 +int migrate_multifd_qatzip_level(void) +{ + MigrationState *s =3D migrate_get_current(); + + return s->parameters.multifd_qatzip_level; +} + int migrate_multifd_zstd_level(void) { MigrationState *s =3D migrate_get_current(); @@ -892,6 +909,8 @@ MigrationParameters *qmp_query_migrate_parameters(Error= **errp) params->multifd_compression =3D s->parameters.multifd_compression; params->has_multifd_zlib_level =3D true; params->multifd_zlib_level =3D s->parameters.multifd_zlib_level; + params->has_multifd_qatzip_level =3D true; + params->multifd_qatzip_level =3D s->parameters.multifd_qatzip_level; params->has_multifd_zstd_level =3D true; params->multifd_zstd_level =3D s->parameters.multifd_zstd_level; params->has_xbzrle_cache_size =3D true; @@ -946,6 +965,7 @@ void migrate_params_init(MigrationParameters *params) params->has_multifd_channels =3D true; params->has_multifd_compression =3D true; params->has_multifd_zlib_level =3D true; + params->has_multifd_qatzip_level =3D true; params->has_multifd_zstd_level =3D true; params->has_xbzrle_cache_size =3D true; params->has_max_postcopy_bandwidth =3D true; @@ -1038,6 +1058,14 @@ bool migrate_params_check(MigrationParameters *param= s, Error **errp) return false; } =20 + if (params->has_multifd_qatzip_level && + ((params->multifd_qatzip_level > 9) || + (params->multifd_qatzip_level < 1))) { + error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "multifd_qatzip_lev= el", + "a value between 1 and 9"); + return false; + } + if (params->has_multifd_zstd_level && (params->multifd_zstd_level > 20)) { error_setg(errp, QERR_INVALID_PARAMETER_VALUE, "multifd_zstd_level= ", @@ -1195,6 +1223,9 @@ static void migrate_params_test_apply(MigrateSetParam= eters *params, if (params->has_multifd_compression) { dest->multifd_compression =3D params->multifd_compression; } + if (params->has_multifd_qatzip_level) { + dest->multifd_qatzip_level =3D params->multifd_qatzip_level; + } if (params->has_multifd_zlib_level) { dest->multifd_zlib_level =3D params->multifd_zlib_level; } @@ -1315,6 +1346,9 @@ static void migrate_params_apply(MigrateSetParameters= *params, Error **errp) if (params->has_multifd_compression) { s->parameters.multifd_compression =3D params->multifd_compression; } + if (params->has_multifd_qatzip_level) { + s->parameters.multifd_qatzip_level =3D params->multifd_qatzip_leve= l; + } if (params->has_multifd_zlib_level) { s->parameters.multifd_zlib_level =3D params->multifd_zlib_level; } diff --git a/migration/options.h b/migration/options.h index a2397026db..a0bd6edc06 100644 --- a/migration/options.h +++ b/migration/options.h @@ -78,6 +78,7 @@ uint64_t migrate_max_postcopy_bandwidth(void); int migrate_multifd_channels(void); MultiFDCompression migrate_multifd_compression(void); int migrate_multifd_zlib_level(void); +int migrate_multifd_qatzip_level(void); int migrate_multifd_zstd_level(void); uint8_t migrate_throttle_trigger_threshold(void); const char *migrate_tls_authz(void); diff --git a/qapi/migration.json b/qapi/migration.json index 1234bef888..cd08f2f710 100644 --- a/qapi/migration.json +++ b/qapi/migration.json @@ -789,6 +789,11 @@ # speed, and 9 means best compression ratio which will consume # more CPU. Defaults to 1. (Since 5.0) # +# @multifd-qatzip-level: Set the compression level to be used in live +# migration. The level is an integer between 1 and 9, where 1 means +# the best compression speed, and 9 means the best compression +# ratio which will consume more CPU. Defaults to 1. (Since 9.1) +# # @multifd-zstd-level: Set the compression level to be used in live # migration, the compression level is an integer between 0 and 20, # where 0 means no compression, 1 means the best compression @@ -849,6 +854,7 @@ 'xbzrle-cache-size', 'max-postcopy-bandwidth', 'max-cpu-throttle', 'multifd-compression', 'multifd-zlib-level', 'multifd-zstd-level', + 'multifd-qatzip-level', 'block-bitmap-mapping', { 'name': 'x-vcpu-dirty-limit-period', 'features': ['unstable']= }, 'vcpu-dirty-limit', @@ -964,6 +970,11 @@ # speed, and 9 means best compression ratio which will consume # more CPU. Defaults to 1. (Since 5.0) # +# @multifd-qatzip-level: Set the compression level to be used in live +# migration. The level is an integer between 1 and 9, where 1 means +# the best compression speed, and 9 means the best compression +# ratio which will consume more CPU. Defaults to 1. (Since 9.1) +# # @multifd-zstd-level: Set the compression level to be used in live # migration, the compression level is an integer between 0 and 20, # where 0 means no compression, 1 means the best compression @@ -1037,6 +1048,7 @@ '*max-cpu-throttle': 'uint8', '*multifd-compression': 'MultiFDCompression', '*multifd-zlib-level': 'uint8', + '*multifd-qatzip-level': 'uint8', '*multifd-zstd-level': 'uint8', '*block-bitmap-mapping': [ 'BitmapMigrationNodeAlias' ], '*x-vcpu-dirty-limit-period': { 'type': 'uint64', @@ -1168,6 +1180,11 @@ # speed, and 9 means best compression ratio which will consume # more CPU. Defaults to 1. (Since 5.0) # +# @multifd-qatzip-level: Set the compression level to be used in live +# migration. The level is an integer between 1 and 9, where 1 means +# the best compression speed, and 9 means the best compression +# ratio which will consume more CPU. Defaults to 1. (Since 9.1) +# # @multifd-zstd-level: Set the compression level to be used in live # migration, the compression level is an integer between 0 and 20, # where 0 means no compression, 1 means the best compression @@ -1238,6 +1255,7 @@ '*max-cpu-throttle': 'uint8', '*multifd-compression': 'MultiFDCompression', '*multifd-zlib-level': 'uint8', + '*multifd-qatzip-level': 'uint8', '*multifd-zstd-level': 'uint8', '*block-bitmap-mapping': [ 'BitmapMigrationNodeAlias' ], '*x-vcpu-dirty-limit-period': { 'type': 'uint64', --=20 Yichen Wang From nobody Sun Dec 29 01:18:59 2024 Delivered-To: importer2@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+importer2=patchew.org@nongnu.org; dmarc=pass(p=quarantine dis=none) header.from=bytedance.com ARC-Seal: i=1; a=rsa-sha256; t=1721081637; cv=none; d=zohomail.com; s=zohoarc; b=dU5UMROrgBQAKnoiBYRs7Pqnn8rIeOPAQLAdBjEUgBh0HNzotqiDyyaWL1Nv6GqeXhqIo2HfkBPDPNB8TsXNxlP/mjRzpNAhbTowaxwreq5YemGf0JP5in8V85gjerOFOfNeRSVnlH4GTFN+UP02mztw182O4hr4gKaZFN3f2Qs= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1721081637; 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=NtQRXR081mPdg+iBE1h9Ruh0NVDJquglGauP30LQ6ak=; b=IqRQUxVjOB6eDuXGevSuH6zcEMawKT2lx7bH3r3tjLiyVDL0LxS94XkDEVmhsO4TxntFbHk7clzoDlUNFHFOPH79p/+fnGudCtW7Pg1m+9PfJSPm7F/jcP9AC/gqxKo5ihuARo928nPPWM6XXU+ZlM+jrosyigDzY5PF1rgUMY8= 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+importer2=patchew.org@nongnu.org; dmarc=pass header.from= (p=quarantine dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 172108163752217.45558793261398; Mon, 15 Jul 2024 15:13:57 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sTTwk-0005OC-Rx; Mon, 15 Jul 2024 18:13:26 -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 1sTTwX-00052b-3M for qemu-devel@nongnu.org; Mon, 15 Jul 2024 18:13:14 -0400 Received: from mail-qk1-x72b.google.com ([2607:f8b0:4864:20::72b]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1sTTwU-0006Jd-D0 for qemu-devel@nongnu.org; Mon, 15 Jul 2024 18:13:12 -0400 Received: by mail-qk1-x72b.google.com with SMTP id af79cd13be357-7a05b7c8e38so299769885a.0 for ; Mon, 15 Jul 2024 15:13:10 -0700 (PDT) Received: from DY4X0N7X05.bytedance.net (ec2-52-8-182-0.us-west-1.compute.amazonaws.com. [52.8.182.0]) by smtp.gmail.com with ESMTPSA id 6a1803df08f44-6b76198aca3sm25398326d6.51.2024.07.15.15.13.07 (version=TLS1_3 cipher=TLS_CHACHA20_POLY1305_SHA256 bits=256/256); Mon, 15 Jul 2024 15:13:08 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bytedance.com; s=google; t=1721081589; x=1721686389; darn=nongnu.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=NtQRXR081mPdg+iBE1h9Ruh0NVDJquglGauP30LQ6ak=; b=LBDdu93bUrtJHKIwEW49XJUKb9z8jeikMwuJMGMG93gVdbqOeTmofsRPfR9YE9eaTq UKC3fulxuGrBcVLFXCWV7oxXvrLbhoVOVVIKTQOPPjD/qIkaxscstiUxehlKxWrvbHZS 6MhJDxFGCd7eVi4c9i3TEaWIRiv+yOLNGms3//qcOAK8PIs02NCVZyA78IlMY40mozmb aUykFOZP3JLfbBe1fawOD5rtJwqLIi9nKTkQZO3jFkuXowmmACYjy+Wk4I7vx8A1EsVa WkdIiDlbBiKtxVuIYRHDXqg+wUKUaJdkoMbTTeEXdROZzU7DuFKdbEGDBb6I6mSK66B0 z2PQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1721081589; x=1721686389; 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=NtQRXR081mPdg+iBE1h9Ruh0NVDJquglGauP30LQ6ak=; b=QJcaEUyFxamPe/pDCIGx3Aw1e++vFl2fL4akpWueIwYgQ6R9e3uBXYjFsNgXZW+EvP BuKzuOR5iMEXWZr8ziqVjdB7ceM9N1JMhP3w9aNoDvpOGRKjWF7hnKCH51azViOn9+gk rFGMZm7FmkFx1MSExltwzDjOtoqlcWlcouEeKGCNk6JoU5bFultZ+XwKvpVt7CXsU9+m p94r3aU2g1jUJXrMczIkVy49GM9J6nDkJsdRO4TTrlyP6h42GRSG1T11+ql+z+ErV2C3 eZ+y9rhJRuU61WoEYsXz2oC5nMzztEH5WvY2P5QMQCRX/6PXjJeK628mTiyWL2hFF/7H WXcw== X-Forwarded-Encrypted: i=1; AJvYcCWPm4RyITN2sUMAxvpTMg92PTOe4w+yURUckxVDU4KMMqErGyjObVim7NASsBbx3pIy26Z9hLVYmMZbPqVJlR6Y1k+5i8Y= X-Gm-Message-State: AOJu0Yz+V+OMc0bg5QPBV+9nzFk9wMh67pvGzxWIYhs26LcSlXGvQnrm n/RXpQESY4iNuiwdGlaUoJOrq54ZqZV1v7PAKLifyM6y8zEOva6Ft47d0+aMIyY= X-Google-Smtp-Source: AGHT+IG1O70h1bBEad9Ej2nzjmlU4QO5EvL5hHI68l7Inyr/9wyKwStT/+7VuvBRbs7r5w1TtBv2Mg== X-Received: by 2002:a05:6214:ca8:b0:6b5:fa20:9b3d with SMTP id 6a1803df08f44-6b77f5b472cmr5539676d6.46.1721081588962; Mon, 15 Jul 2024 15:13:08 -0700 (PDT) From: Yichen Wang To: Peter Xu , Fabiano Rosas , Paolo Bonzini , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Eduardo Habkost , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Thomas Huth , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Eric Blake , Markus Armbruster , Laurent Vivier , qemu-devel@nongnu.org Cc: "Hao Xiang" , "Liu, Yuan1" , "Zou, Nanhai" , "Ho-Ren (Jack) Chuang" , "Yichen Wang" , Bryan Zhang Subject: [PATCH v6 4/5] migration: Introduce 'qatzip' compression method Date: Mon, 15 Jul 2024 15:12:44 -0700 Message-Id: <20240715221245.12435-5-yichen.wang@bytedance.com> X-Mailer: git-send-email 2.39.3 (Apple Git-146) In-Reply-To: <20240715221245.12435-1-yichen.wang@bytedance.com> References: <20240715221245.12435-1-yichen.wang@bytedance.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+importer2=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2607:f8b0:4864:20::72b; envelope-from=yichen.wang@bytedance.com; helo=mail-qk1-x72b.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, 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+importer2=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer2=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @bytedance.com) X-ZM-MESSAGEID: 1721081639304116300 Content-Type: text/plain; charset="utf-8" From: Bryan Zhang Adds support for 'qatzip' as an option for the multifd compression method parameter, and implements using QAT for 'qatzip' compression and decompression. Signed-off-by: Bryan Zhang Signed-off-by: Hao Xiang Signed-off-by: Yichen Wang Acked-by: Markus Armbruster --- hw/core/qdev-properties-system.c | 2 +- migration/meson.build | 1 + migration/multifd-qatzip.c | 382 +++++++++++++++++++++++++++++++ migration/multifd.h | 5 +- qapi/migration.json | 3 + tests/qtest/meson.build | 4 + 6 files changed, 394 insertions(+), 3 deletions(-) create mode 100644 migration/multifd-qatzip.c diff --git a/hw/core/qdev-properties-system.c b/hw/core/qdev-properties-sys= tem.c index f13350b4fb..a56fbf728d 100644 --- a/hw/core/qdev-properties-system.c +++ b/hw/core/qdev-properties-system.c @@ -659,7 +659,7 @@ const PropertyInfo qdev_prop_fdc_drive_type =3D { const PropertyInfo qdev_prop_multifd_compression =3D { .name =3D "MultiFDCompression", .description =3D "multifd_compression values, " - "none/zlib/zstd/qpl/uadk", + "none/zlib/zstd/qpl/uadk/qatzip", .enum_table =3D &MultiFDCompression_lookup, .get =3D qdev_propinfo_get_enum, .set =3D qdev_propinfo_set_enum, diff --git a/migration/meson.build b/migration/meson.build index 5ce2acb41e..c9454c26ae 100644 --- a/migration/meson.build +++ b/migration/meson.build @@ -41,6 +41,7 @@ system_ss.add(when: rdma, if_true: files('rdma.c')) system_ss.add(when: zstd, if_true: files('multifd-zstd.c')) system_ss.add(when: qpl, if_true: files('multifd-qpl.c')) system_ss.add(when: uadk, if_true: files('multifd-uadk.c')) +system_ss.add(when: qatzip, if_true: files('multifd-qatzip.c')) =20 specific_ss.add(when: 'CONFIG_SYSTEM_ONLY', if_true: files('ram.c', diff --git a/migration/multifd-qatzip.c b/migration/multifd-qatzip.c new file mode 100644 index 0000000000..b74cda503a --- /dev/null +++ b/migration/multifd-qatzip.c @@ -0,0 +1,382 @@ +/* + * Multifd QATzip compression implementation + * + * Copyright (c) Bytedance + * + * Authors: + * Bryan Zhang + * Hao Xiang + * Yichen Wang + * + * This work is licensed under the terms of the GNU GPL, version 2 or late= r. + * See the COPYING file in the top-level directory. + */ + +#include "qemu/osdep.h" +#include "exec/ramblock.h" +#include "qapi/error.h" +#include "qemu/error-report.h" +#include "qapi/qapi-types-migration.h" +#include "options.h" +#include "multifd.h" +#include + +typedef struct { + /* + * Unique session for use with QATzip API + */ + QzSession_T sess; + + /* + * For compression: Buffer for pages to compress + * For decompression: Buffer for data to decompress + */ + uint8_t *in_buf; + uint32_t in_len; + + /* + * For compression: Output buffer of compressed data + * For decompression: Output buffer of decompressed data + */ + uint8_t *out_buf; + uint32_t out_len; +} QatzipData; + +/** + * qatzip_send_setup: Set up QATzip session and private buffers. + * + * @param p Multifd channel params + * @param errp Pointer to error, which will be set in case of error + * @return 0 on success, -1 on error (and *errp will be set) + */ +static int qatzip_send_setup(MultiFDSendParams *p, Error **errp) +{ + QatzipData *q; + QzSessionParamsDeflate_T params; + const char *err_msg; + int ret; + + q =3D g_new0(QatzipData, 1); + p->compress_data =3D q; + /* We need one extra place for the packet header */ + p->iov =3D g_new0(struct iovec, 2); + + /* + * Prefer without sw_fallback because of bad performance with sw_fallb= ack. + * Warn if sw_fallback needs to be used. + */ + ret =3D qzInit(&q->sess, false); + if (ret !=3D QZ_OK && ret !=3D QZ_DUPLICATE) { + /* Warn, and try with sw_fallback. */ + warn_report_once( + "[Sender] Initializing QAT with software fallback..."); + ret =3D qzInit(&q->sess, true); + if (ret !=3D QZ_OK && ret !=3D QZ_DUPLICATE) { + err_msg =3D "qzInit failed"; + goto err; + } + } + + ret =3D qzGetDefaultsDeflate(¶ms); + if (ret !=3D QZ_OK) { + err_msg =3D "qzGetDefaultsDeflate failed"; + goto err; + } + + /* Make sure to use configured QATzip compression level. */ + params.common_params.comp_lvl =3D migrate_multifd_qatzip_level(); + ret =3D qzSetupSessionDeflate(&q->sess, ¶ms); + if (ret !=3D QZ_OK && ret !=3D QZ_DUPLICATE) { + err_msg =3D "qzSetupSessionDeflate failed"; + goto err; + } + + if (MULTIFD_PACKET_SIZE > UINT32_MAX) { + err_msg =3D "packet size too large for QAT"; + goto err; + } + + q->in_len =3D MULTIFD_PACKET_SIZE; + q->in_buf =3D qzMalloc(q->in_len, 0, PINNED_MEM); + if (!q->in_buf) { + err_msg =3D "qzMalloc failed"; + goto err; + } + + q->out_len =3D qzMaxCompressedLength(MULTIFD_PACKET_SIZE, &q->sess); + q->out_buf =3D qzMalloc(q->out_len, 0, PINNED_MEM); + if (!q->out_buf) { + err_msg =3D "qzMalloc failed"; + goto err; + } + + return 0; + +err: + error_setg(errp, "multifd %u: [sender] %s", p->id, err_msg); + return -1; +} + +/** + * qatzip_send_cleanup: Tear down QATzip session and release private buffe= rs. + * + * @param p Multifd channel params + * @param errp Pointer to error, which will be set in case of error + * @return None + */ +static void qatzip_send_cleanup(MultiFDSendParams *p, Error **errp) +{ + QatzipData *q =3D p->compress_data; + + if (q->in_buf) { + qzFree(q->in_buf); + } + if (q->out_buf) { + qzFree(q->out_buf); + } + (void)qzTeardownSession(&q->sess); + (void)qzClose(&q->sess); + + g_free(p->iov); + p->iov =3D NULL; + g_free(q); + p->compress_data =3D NULL; +} + +/** + * qatzip_send_prepare: Compress pages and update IO channel info. + * + * @param p Multifd channel params + * @param errp Pointer to error, which will be set in case of error + * @return 0 on success, -1 on error (and *errp will be set) + */ +static int qatzip_send_prepare(MultiFDSendParams *p, Error **errp) +{ + MultiFDPages_t *pages =3D p->pages; + QatzipData *q =3D p->compress_data; + int ret; + unsigned int in_len, out_len; + + if (!multifd_send_prepare_common(p)) { + goto out; + } + + /* + * Unlike other multifd compression implementations, we use a non-stre= aming + * API and place all the data into one buffer, rather than sending each + * page to the compression API at a time. Based on initial benchmarks,= the + * non-streaming API outperforms the streaming API. Plus, the logic in= QEMU + * is friendly to using the non-streaming API anyway. If either of the= se + * statements becomes no longer true, we can revisit adding a streaming + * implementation. + */ + for (int i =3D 0; i < pages->normal_num; i++) { + memcpy(q->in_buf + (i * p->page_size), + pages->block->host + pages->offset[i], + p->page_size); + } + + in_len =3D pages->normal_num * p->page_size; + if (in_len > q->in_len) { + error_setg(errp, "multifd %u: unexpectedly large input", p->id); + return -1; + } + out_len =3D q->out_len; + + ret =3D qzCompress(&q->sess, q->in_buf, &in_len, q->out_buf, &out_len,= 1); + if (ret !=3D QZ_OK) { + error_setg(errp, "multifd %u: QATzip returned %d instead of QZ_OK", + p->id, ret); + return -1; + } + if (in_len !=3D pages->normal_num * p->page_size) { + error_setg(errp, "multifd %u: QATzip failed to compress all input", + p->id); + return -1; + } + + p->iov[p->iovs_num].iov_base =3D q->out_buf; + p->iov[p->iovs_num].iov_len =3D out_len; + p->iovs_num++; + p->next_packet_size =3D out_len; + +out: + p->flags |=3D MULTIFD_FLAG_QATZIP; + multifd_send_fill_packet(p); + return 0; +} + +/** + * qatzip_recv_setup: Set up QATzip session and allocate private buffers. + * + * @param p Multifd channel params + * @param errp Pointer to error, which will be set in case of error + * @return 0 on success, -1 on error (and *errp will be set) + */ +static int qatzip_recv_setup(MultiFDRecvParams *p, Error **errp) +{ + QatzipData *q; + QzSessionParamsDeflate_T params; + const char *err_msg; + int ret; + + q =3D g_new0(QatzipData, 1); + p->compress_data =3D q; + + /* + * Prefer without sw_fallback because of bad performance with sw_fallb= ack. + * Warn if sw_fallback needs to be used. + */ + ret =3D qzInit(&q->sess, false); + if (ret !=3D QZ_OK && ret !=3D QZ_DUPLICATE) { + /* Warn, and try with sw_fallback. */ + warn_report_once( + "[Receiver] Initializing QAT with software fallback..."); + ret =3D qzInit(&q->sess, true); + if (ret !=3D QZ_OK && ret !=3D QZ_DUPLICATE) { + err_msg =3D "qzInit failed"; + goto err; + } + } + + ret =3D qzGetDefaultsDeflate(¶ms); + if (ret !=3D QZ_OK) { + err_msg =3D "qzGetDefaultsDeflate failed"; + goto err; + } + + ret =3D qzSetupSessionDeflate(&q->sess, ¶ms); + if (ret !=3D QZ_OK && ret !=3D QZ_DUPLICATE) { + err_msg =3D "qzSetupSessionDeflate failed"; + goto err; + } + + /* + * Reserve extra spaces for the incoming packets. Current implementati= on + * doesn't send uncompressed pages in case the compression gets too bi= g. + */ + q->in_len =3D MULTIFD_PACKET_SIZE * 2; + /* + * PINNED_MEM is an enum from qatzip headers, which means to use + * kzalloc_node() to allocate memory for QAT DMA purposes. + */ + q->in_buf =3D qzMalloc(q->in_len, 0, PINNED_MEM); + if (!q->in_buf) { + err_msg =3D "qzMalloc failed"; + goto err; + } + + q->out_len =3D MULTIFD_PACKET_SIZE; + q->out_buf =3D qzMalloc(q->out_len, 0, PINNED_MEM); + if (!q->out_buf) { + err_msg =3D "qzMalloc failed"; + goto err; + } + + return 0; + +err: + error_setg(errp, "multifd %u: [receiver] %s", p->id, err_msg); + return -1; +} + +/** + * qatzip_recv_cleanup: Tear down QATzip session and release private buffe= rs. + * + * @param p Multifd channel params + * @return None + */ +static void qatzip_recv_cleanup(MultiFDRecvParams *p) +{ + QatzipData *q =3D p->compress_data; + + if (q->in_buf) { + qzFree(q->in_buf); + } + if (q->out_buf) { + qzFree(q->out_buf); + } + (void)qzTeardownSession(&q->sess); + (void)qzClose(&q->sess); + g_free(q); + p->compress_data =3D NULL; +} + + +/** + * qatzip_recv: Decompress pages and copy them to the appropriate + * locations. + * + * @param p Multifd channel params + * @param errp Pointer to error, which will be set in case of error + * @return 0 on success, -1 on error (and *errp will be set) + */ +static int qatzip_recv(MultiFDRecvParams *p, Error **errp) +{ + QatzipData *q =3D p->compress_data; + int ret; + unsigned int in_len, out_len; + uint32_t in_size =3D p->next_packet_size; + uint32_t expected_size =3D p->normal_num * p->page_size; + uint32_t flags =3D p->flags & MULTIFD_FLAG_COMPRESSION_MASK; + + if (in_size > q->in_len) { + error_setg(errp, "multifd %u: received unexpectedly large packet", + p->id); + return -1; + } + + if (flags !=3D MULTIFD_FLAG_QATZIP) { + error_setg(errp, "multifd %u: flags received %x flags expected %x", + p->id, flags, MULTIFD_FLAG_QATZIP); + return -1; + } + + multifd_recv_zero_page_process(p); + if (!p->normal_num) { + assert(in_size =3D=3D 0); + return 0; + } + + ret =3D qio_channel_read_all(p->c, (void *)q->in_buf, in_size, errp); + if (ret !=3D 0) { + return ret; + } + + in_len =3D in_size; + out_len =3D q->out_len; + ret =3D qzDecompress(&q->sess, q->in_buf, &in_len, q->out_buf, &out_le= n); + if (ret !=3D QZ_OK) { + error_setg(errp, "multifd %u: qzDecompress failed", p->id); + return -1; + } + if (out_len !=3D expected_size) { + error_setg(errp, "multifd %u: packet size received %u size expecte= d %u", + p->id, out_len, expected_size); + return -1; + } + + /* Copy each page to its appropriate location. */ + for (int i =3D 0; i < p->normal_num; i++) { + memcpy(p->host + p->normal[i], + q->out_buf + p->page_size * i, + p->page_size); + } + return 0; +} + +static MultiFDMethods multifd_qatzip_ops =3D { + .send_setup =3D qatzip_send_setup, + .send_cleanup =3D qatzip_send_cleanup, + .send_prepare =3D qatzip_send_prepare, + .recv_setup =3D qatzip_recv_setup, + .recv_cleanup =3D qatzip_recv_cleanup, + .recv =3D qatzip_recv +}; + +static void multifd_qatzip_register(void) +{ + multifd_register_ops(MULTIFD_COMPRESSION_QATZIP, &multifd_qatzip_ops); +} + +migration_init(multifd_qatzip_register); diff --git a/migration/multifd.h b/migration/multifd.h index 0ecd6f47d7..adceb65050 100644 --- a/migration/multifd.h +++ b/migration/multifd.h @@ -34,14 +34,15 @@ MultiFDRecvData *multifd_get_recv_data(void); /* Multifd Compression flags */ #define MULTIFD_FLAG_SYNC (1 << 0) =20 -/* We reserve 4 bits for compression methods */ -#define MULTIFD_FLAG_COMPRESSION_MASK (0xf << 1) +/* We reserve 5 bits for compression methods */ +#define MULTIFD_FLAG_COMPRESSION_MASK (0x1f << 1) /* we need to be compatible. Before compression value was 0 */ #define MULTIFD_FLAG_NOCOMP (0 << 1) #define MULTIFD_FLAG_ZLIB (1 << 1) #define MULTIFD_FLAG_ZSTD (2 << 1) #define MULTIFD_FLAG_QPL (4 << 1) #define MULTIFD_FLAG_UADK (8 << 1) +#define MULTIFD_FLAG_QATZIP (16 << 1) =20 /* This value needs to be a multiple of qemu_target_page_size() */ #define MULTIFD_PACKET_SIZE (512 * 1024) diff --git a/qapi/migration.json b/qapi/migration.json index cd08f2f710..42b5363449 100644 --- a/qapi/migration.json +++ b/qapi/migration.json @@ -558,6 +558,8 @@ # # @zstd: use zstd compression method. # +# @qatzip: use qatzip compression method. (Since 9.1) +# # @qpl: use qpl compression method. Query Processing Library(qpl) is # based on the deflate compression algorithm and use the Intel # In-Memory Analytics Accelerator(IAA) accelerated compression @@ -570,6 +572,7 @@ { 'enum': 'MultiFDCompression', 'data': [ 'none', 'zlib', { 'name': 'zstd', 'if': 'CONFIG_ZSTD' }, + { 'name': 'qatzip', 'if': 'CONFIG_QATZIP'}, { 'name': 'qpl', 'if': 'CONFIG_QPL' }, { 'name': 'uadk', 'if': 'CONFIG_UADK' } ] } =20 diff --git a/tests/qtest/meson.build b/tests/qtest/meson.build index 6508bfb1a2..3068d73e08 100644 --- a/tests/qtest/meson.build +++ b/tests/qtest/meson.build @@ -327,6 +327,10 @@ if gnutls.found() endif endif =20 +if qatzip.found() + migration_files +=3D [qatzip] +endif + qtests =3D { 'bios-tables-test': [io, 'boot-sector.c', 'acpi-utils.c', 'tpm-emu.c'], 'cdrom-test': files('boot-sector.c'), --=20 Yichen Wang From nobody Sun Dec 29 01:18:59 2024 Delivered-To: importer2@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+importer2=patchew.org@nongnu.org; dmarc=pass(p=quarantine dis=none) header.from=bytedance.com ARC-Seal: i=1; a=rsa-sha256; t=1721081653; cv=none; d=zohomail.com; s=zohoarc; b=V3CgxzE1MuUaZrZ6liztmBdkdcB1Yszx4ptIss7dTj21hVVJQKF0eNo95w98cNlBvS2EsXz9EKFAYf+F/rwnnBeok+gKw7yOMIZwhIo3LmHb44WCLGeM3VWlqQN9bE74bOf0SOi5cS/Lbh6Huu4j7JZZePZyrVuNYthospPvZ5c= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1721081653; 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=n/pLSkEkVMQ2EG9E68S2CQhpC5K2Hr/bhI+bVnZfMKI=; b=eC41sbioE0zWji326jZY8M8qD13gt+/3qXBtNZWhm59omo4j1ediRRffj+jmPEd5qQSm3hgNH+yFAfvvgBkilhdgBl/re3uDHwSqSu8luNdQQVnNXo2bwXiF/fQo+55ZjPxBFelET5dIBs9BcDM2uSmxT3Nv2XSapN+iFA/KZLA= 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+importer2=patchew.org@nongnu.org; dmarc=pass header.from= (p=quarantine dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1721081653335740.5079839737471; Mon, 15 Jul 2024 15:14:13 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sTTwq-0005sV-Jq; Mon, 15 Jul 2024 18:13:32 -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 1sTTwX-00052e-Tg for qemu-devel@nongnu.org; Mon, 15 Jul 2024 18:13:14 -0400 Received: from mail-qv1-xf2d.google.com ([2607:f8b0:4864:20::f2d]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1sTTwW-0006Jy-Aj for qemu-devel@nongnu.org; Mon, 15 Jul 2024 18:13:13 -0400 Received: by mail-qv1-xf2d.google.com with SMTP id 6a1803df08f44-6b5dfa44f24so26610686d6.3 for ; Mon, 15 Jul 2024 15:13:11 -0700 (PDT) Received: from DY4X0N7X05.bytedance.net (ec2-52-8-182-0.us-west-1.compute.amazonaws.com. [52.8.182.0]) by smtp.gmail.com with ESMTPSA id 6a1803df08f44-6b76198aca3sm25398326d6.51.2024.07.15.15.13.09 (version=TLS1_3 cipher=TLS_CHACHA20_POLY1305_SHA256 bits=256/256); Mon, 15 Jul 2024 15:13:11 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bytedance.com; s=google; t=1721081591; x=1721686391; darn=nongnu.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=n/pLSkEkVMQ2EG9E68S2CQhpC5K2Hr/bhI+bVnZfMKI=; b=JjhbKBOjMfjhYCuIeZ/z0jtMtKAGhhhpIUauA22g3NqENkY9TzT0sjHn2sCe6dBC5z dpOuwpEtqjQ7RM21H69GggX2ZIVN5oezYCAWI2F8IZu9Nsdt2NJyiI/3I2HF/DNl8HFr LRmRSIqpyI92Noh/SoTcx+78SGsUn0GpJenwqBgnu0O7TEweA+7GEekSGdpJAkFFjAA9 mIa77CEYR3Hj1XhGfrvywvqXjj4Pe39ggWXi9F7xu7lIzseQytEeQCIZoN94277UpqmY 8gO5x6LS66cKFEOHM4k92D/VeuIX3q9RkoQRzBNC4M4+tHThBnm1vVEqTS3EEiq8T3kn x+xQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1721081591; x=1721686391; 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=n/pLSkEkVMQ2EG9E68S2CQhpC5K2Hr/bhI+bVnZfMKI=; b=X0nQxvZEuGNT/ckG+M+5KBuzStjC5bniOw9b67faHpXwaOpMJJ1sKSMZ1WTTWYJquH 02F9zMDl1K3HzhLtkvSGjMiaXb0GWfl61pnYSSxdW7NkvwyzKGTAhLLZoY+2ck3Kt0LR d24VkUAS+oNIc+fdee/6P7gqoPa2Ox8E55u9uQActVxTualOTmw2VcZdkT5to3ynlPht /8s27UyGhrR0QytFkqrxePNtVoY7hDB4b57vvGhfQH18eFt75TyA6203QRA+4B//zCAX vvtgEVTpd1U4FO4A17fxK3p/95uhlcd+cYLwd/ihtzslNSZbO1UMS115Zp6uGy2LTR/Y gItQ== X-Forwarded-Encrypted: i=1; AJvYcCUDCA9ieWgVv+tN/IVkbGo8hf5BK90LwA04PsNI+gQa4YkyLxnyDy/AZ328LZuDHGkMEy0jhiuNDKB/pSsuqTbvh18vjq4= X-Gm-Message-State: AOJu0YyeCVtXflLHCA0bBoXzYW7VD1frZnlN1NNpHkeCASiR+Na4nNKy zS38+L12bbugg1VnA0JOQvOrCUobebeyDWAxcaaqm9OrEcRGNSQ9ipI4ga3Cv0E= X-Google-Smtp-Source: AGHT+IEcAQJV4HFi+QnPk5O8ti203cBdLdrgyoq50Cf7vB2f0qQpx0859LP8Qhk4r5W6mQtlcl+E8w== X-Received: by 2002:ad4:5cab:0:b0:6b5:6c27:642e with SMTP id 6a1803df08f44-6b77f4dbcfbmr7858916d6.14.1721081591273; Mon, 15 Jul 2024 15:13:11 -0700 (PDT) From: Yichen Wang To: Peter Xu , Fabiano Rosas , Paolo Bonzini , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Eduardo Habkost , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Thomas Huth , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Eric Blake , Markus Armbruster , Laurent Vivier , qemu-devel@nongnu.org Cc: "Hao Xiang" , "Liu, Yuan1" , "Zou, Nanhai" , "Ho-Ren (Jack) Chuang" , "Yichen Wang" , Bryan Zhang Subject: [PATCH v6 5/5] tests/migration: Add integration test for 'qatzip' compression method Date: Mon, 15 Jul 2024 15:12:45 -0700 Message-Id: <20240715221245.12435-6-yichen.wang@bytedance.com> X-Mailer: git-send-email 2.39.3 (Apple Git-146) In-Reply-To: <20240715221245.12435-1-yichen.wang@bytedance.com> References: <20240715221245.12435-1-yichen.wang@bytedance.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+importer2=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2607:f8b0:4864:20::f2d; envelope-from=yichen.wang@bytedance.com; helo=mail-qv1-xf2d.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, 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+importer2=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer2=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @bytedance.com) X-ZM-MESSAGEID: 1721081655146116300 Content-Type: text/plain; charset="utf-8" From: Bryan Zhang Adds an integration test for 'qatzip'. Signed-off-by: Bryan Zhang Signed-off-by: Hao Xiang Signed-off-by: Yichen Wang Reviewed-by: Fabiano Rosas --- tests/qtest/migration-test.c | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/tests/qtest/migration-test.c b/tests/qtest/migration-test.c index 70b606b888..98f60d58a7 100644 --- a/tests/qtest/migration-test.c +++ b/tests/qtest/migration-test.c @@ -32,6 +32,10 @@ # endif /* CONFIG_TASN1 */ #endif /* CONFIG_GNUTLS */ =20 +#ifdef CONFIG_QATZIP +#include +#endif /* CONFIG_QATZIP */ + /* For dirty ring test; so far only x86_64 is supported */ #if defined(__linux__) && defined(HOST_X86_64) #include "linux/kvm.h" @@ -2992,6 +2996,18 @@ test_migrate_precopy_tcp_multifd_zstd_start(QTestSta= te *from, } #endif /* CONFIG_ZSTD */ =20 +#ifdef CONFIG_QATZIP +static void * +test_migrate_precopy_tcp_multifd_qatzip_start(QTestState *from, + QTestState *to) +{ + migrate_set_parameter_int(from, "multifd-qatzip-level", 2); + migrate_set_parameter_int(to, "multifd-qatzip-level", 2); + + return test_migrate_precopy_tcp_multifd_start_common(from, to, "qatzip= "); +} +#endif + #ifdef CONFIG_QPL static void * test_migrate_precopy_tcp_multifd_qpl_start(QTestState *from, @@ -3089,6 +3105,17 @@ static void test_multifd_tcp_zstd(void) } #endif =20 +#ifdef CONFIG_QATZIP +static void test_multifd_tcp_qatzip(void) +{ + MigrateCommon args =3D { + .listen_uri =3D "defer", + .start_hook =3D test_migrate_precopy_tcp_multifd_qatzip_start, + }; + test_precopy_common(&args); +} +#endif + #ifdef CONFIG_QPL static void test_multifd_tcp_qpl(void) { @@ -3992,6 +4019,10 @@ int main(int argc, char **argv) migration_test_add("/migration/multifd/tcp/plain/zstd", test_multifd_tcp_zstd); #endif +#ifdef CONFIG_QATZIP + migration_test_add("/migration/multifd/tcp/plain/qatzip", + test_multifd_tcp_qatzip); +#endif #ifdef CONFIG_QPL migration_test_add("/migration/multifd/tcp/plain/qpl", test_multifd_tcp_qpl); --=20 Yichen Wang