From nobody Sat Dec 28 23:43:55 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=1720666409; cv=none; d=zohomail.com; s=zohoarc; b=JdoT0mB/DDaBu7WI9b8hSYgmrtZZbJZCndrRAzMP8AYXAkXvp5CUpQydnsRlRl/eTLdmCs9uQPI4fTlw09B91SzmjD0l/H8jNRRbtZYWbW5j+fYZWLFXyfYDFfjBzKAFP+Zek+JbiXa8W5dwG6yUi+30MhZkrcUmABb9KOCMgOg= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1720666409; 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=RsQMTo2GmrbXbjpXtE53U6XutJbaFd+iPB0DBR8xsnHlueKewigfJBbfJSJ/bHN96IosYSGGmCkh9660tiY+YEQ1PYMS8VYM8u5qb0Kd3eCzDnjxAOQQGkhWGNERg568ss8t7JXscGtz+j8lr9GG+x+MUiYyHQCoTc0YXcuBKGE= 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 1720666409766409.39381128173; Wed, 10 Jul 2024 19:53:29 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sRjvM-0003oN-K8; Wed, 10 Jul 2024 22:52:48 -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 1sRjvK-0003nG-M9 for qemu-devel@nongnu.org; Wed, 10 Jul 2024 22:52:46 -0400 Received: from mail-oi1-x22f.google.com ([2607:f8b0:4864:20::22f]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1sRjvG-0007rb-1t for qemu-devel@nongnu.org; Wed, 10 Jul 2024 22:52:46 -0400 Received: by mail-oi1-x22f.google.com with SMTP id 5614622812f47-3d92df7e83cso654396b6e.0 for ; Wed, 10 Jul 2024 19:52:38 -0700 (PDT) Received: from DY4X0N7X05.bytedance.net ([208.184.112.130]) by smtp.gmail.com with ESMTPSA id 5614622812f47-3daa12f4f7csm117827b6e.41.2024.07.10.19.52.35 (version=TLS1_3 cipher=TLS_CHACHA20_POLY1305_SHA256 bits=256/256); Wed, 10 Jul 2024 19:52:36 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bytedance.com; s=google; t=1720666357; x=1721271157; 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=ExNa3LvoXrRwkFf1i9ZhIjwqfJVAwuewo7Cxh5lExirmog5OrJZYDOaOyyZBJjrySN NavgsLyZaj9v22ldIPd+mwgJ7zkzf//fsTiRj5PNXyFS44hxIihPPoQkmf14TG47hoj1 NQGY0FGlP5591Ye99r2A9p/C4H1mhUjOefBHeByttVf5ZfQ6wdGCNxcqajK6L2HkXCxS GuATY/FWOWOO5DbwPesYCl4qYg7MJoHR68pwBGM26omsVMx6TbKLLbRAOpEsiSHO9JjW MiZuBDihkALYGF6sCjvz2J37DkD9a35dsPdzC/uLa0O+fE+24Bjj4F11kn5xPFNmX/4F Nlqg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1720666357; x=1721271157; 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=MG73gam18hmEAmi3yFv8UlkOMh6gqAeooaHiAm2QiogRooAwA4EkfjGa+hI5I2MUpY 26rUxl3z3Opr303bYvl+KX0mba+2J4rUUTE7pPh9c7N6Ac2Qoal5lE2AMuyeCZ2POz+4 M//ewoQ35LfKua5qdCjKkRnMHGNm/GptZOzfs9s2Q5+I3lhjK49BxObpyp3DDIciXFLS np3ZFsXJJM44PoI3UyREGJMQzapzoj7I+3vfkaO7iyOdnrOFmFSbcNHc6NK5uVL0o7Q3 R0j3eUAfCaZGqL3mU3Yt6P90kY0aUQr5FCTG0B/fC7NITCUIhnDFHHEB48oI2qwmlT7y De6w== X-Forwarded-Encrypted: i=1; AJvYcCUgHwFTCInOvSomfLF0657TJR1+eEXNFhrzNECN3CUj/LswbaO25SrgFnbjuR6I0UzDo0Gy95Y0b2lTMnKuh9qJlmoJAfM= X-Gm-Message-State: AOJu0Yy6Z2QsMGlvHXQvTsTm4m9d9+3bvyRmnhDGKri5cRetFr0IHFxl 0+MqoPz2yxQ3T+qbGiE5ZlJ2esLo0MPGGEhp58Ng5DefGFy2+FwrQ55jFRpysyU= X-Google-Smtp-Source: AGHT+IF9q22DwXwIFfWUbgTPTCF6f2lNNsdBLCMDlh1lySiidxT1nNHUoL+C70/oStzmTmnnl9azRw== X-Received: by 2002:a05:6808:180c:b0:3d9:25ec:d9ff with SMTP id 5614622812f47-3da9feef910mr544537b6e.20.1720666357231; Wed, 10 Jul 2024 19:52:37 -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 v5 1/5] docs/migration: add qatzip compression feature Date: Wed, 10 Jul 2024 19:52:25 -0700 Message-Id: <20240711025229.66260-2-yichen.wang@bytedance.com> X-Mailer: git-send-email 2.39.3 (Apple Git-146) In-Reply-To: <20240711025229.66260-1-yichen.wang@bytedance.com> References: <20240711025229.66260-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::22f; envelope-from=yichen.wang@bytedance.com; helo=mail-oi1-x22f.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: 1720666410854116300 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 Sat Dec 28 23:43:55 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=1720666459; cv=none; d=zohomail.com; s=zohoarc; b=J841WdxzLGZHth2l867ZY0Ue1+n6wVRXeNM+0i5GWjVyKrtGMFPMEWP4ERxi8PehRPT2DJYwCKWMT/fXGEz1HWYHQ76TthuaQlQnT2JhQpjCIFPK9jLU/yFfZZI36bNrBjmZYv7QZpNJdM3WGtvnsqu+zQUSr2p2FU2CoTBegsE= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1720666459; 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=Vo6TPNuQ//PS3YOs/6S69A0ZsG+hGvRUod5UOX06zaT5GqH0lnj5f+AJG3g++svBW6uQlqI6YuUIB/5rE/LHeVdWYnZ4In87rW8xsrbmfYnUvWSCpkCFiL/+AmsxAfjsVYb4ixDvmvv7pNbmgK5J1dKtjwa5hnqgCT07G6EUZe0= 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 1720666459735276.9267991320951; Wed, 10 Jul 2024 19:54:19 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sRjvO-0003v6-4p; Wed, 10 Jul 2024 22:52:50 -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 1sRjvM-0003oL-5r for qemu-devel@nongnu.org; Wed, 10 Jul 2024 22:52:48 -0400 Received: from mail-oi1-x231.google.com ([2607:f8b0:4864:20::231]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1sRjvH-0007rp-RI for qemu-devel@nongnu.org; Wed, 10 Jul 2024 22:52:47 -0400 Received: by mail-oi1-x231.google.com with SMTP id 5614622812f47-3d92df7e83cso654417b6e.0 for ; Wed, 10 Jul 2024 19:52:40 -0700 (PDT) Received: from DY4X0N7X05.bytedance.net ([208.184.112.130]) by smtp.gmail.com with ESMTPSA id 5614622812f47-3daa12f4f7csm117827b6e.41.2024.07.10.19.52.37 (version=TLS1_3 cipher=TLS_CHACHA20_POLY1305_SHA256 bits=256/256); Wed, 10 Jul 2024 19:52:38 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bytedance.com; s=google; t=1720666359; x=1721271159; 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=clhA3PTomgjhLxV5WG8TL2XkYhsMt733HI9sd19+CjKi0JuNh0fJnzoTXPLvsIY84V cQ2+PDBF6mr6jHIbbPrNftimLscstjUpCdcHtT9JDcSAMrluOPfDstlgsPGvHqeJfxFm N4pgr+MwjA2kJscjzfPOC8/aYrECbs6yEDYALGBvIhE1qDvLe6azDyyD8SpsPcYjvBpg glbVEyXWCpFuKqn0yuTXrDZoHgsQUDmeyUn6O+DXgv02h26BHcuQlUG/GplWHw5Rpizx +3way8kVD5Hy4gKLRGWhOt1aHGdsyW16Kf8YNwnq116yxniMqxhPLLdyUbLQuleeHrrB GjcA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1720666359; x=1721271159; 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=Bb4CdgiAu6zaQUky4C3bXu4pBOWNIEB1In5nbc/6yKu2rWTp3CCtwC856WILumPIDY VggE8GBrepAz0n5T+mzq+JKl6KMkXdqpZ9cJyv9/Mc+LC4M98iDaxm+WFZ25H8PfDI4s 0IcN4/VunonyrD9m8GOAJxyu1jxEqqJkOIjArEdFwo6cx1lSXclvfI2bWgpuUu8fNG3j E9lacXVJvcHs4ECVlGjigtlufPbPcJ7gz0WO4HprzHuL99yN3RThVlJoTRyCTlS6a9Eh xq8u0Xj1gsLY/X1eYgzLUb5nB+rXGYBXsOK4kee5rCV8/LlMFwA86clLw5HSd7592qQj abqA== X-Forwarded-Encrypted: i=1; AJvYcCX/GSs6ZOqtDGyobWNTdHIBuQ3Azz4VDqzWY7mrWLWarrZeKwQTcelmPOcmj0eOEqGVVv+gkz2HCn0+dzG8cNgTfWHe/3I= X-Gm-Message-State: AOJu0YynsCyob4m4vpyIw/VODCuV0RBt86iyRjfOF4UM4kXgIS/DcdNL r4H3x1DwDOTpSzFh4W1oyKP52wbh9WDipOr1ePz5HvdZbGXxLRd/TTWoSHCnyRw= X-Google-Smtp-Source: AGHT+IE3sWN84hlTDvdDE9LQvMcxAr5h4yKOsEpmp8/omQB4xbjNWTa8TeUk/LrdOTKNNhRXqwWl5A== X-Received: by 2002:a05:6808:10d4:b0:3d9:3f0d:8ed3 with SMTP id 5614622812f47-3daa3c5759bmr155454b6e.16.1720666359018; Wed, 10 Jul 2024 19:52:39 -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 v5 2/5] meson: Introduce 'qatzip' feature to the build system Date: Wed, 10 Jul 2024 19:52:26 -0700 Message-Id: <20240711025229.66260-3-yichen.wang@bytedance.com> X-Mailer: git-send-email 2.39.3 (Apple Git-146) In-Reply-To: <20240711025229.66260-1-yichen.wang@bytedance.com> References: <20240711025229.66260-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::231; envelope-from=yichen.wang@bytedance.com; helo=mail-oi1-x231.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: 1720666460982116300 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 Sat Dec 28 23:43:55 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=1720666459; cv=none; d=zohomail.com; s=zohoarc; b=ftzSSsETAAlweaYbkHcaveSqxIkhkp/uWs8PJdxUHX0IAAxVRW3IeT/oI1w2M0OtI3/b7Hzjmmmew7S99MM9Q2Tkmcf/dnihtgFudE3OYeMAIZEX35OJYrni53+KjfsLUEKaIujeuZKv9gkpmNWN2ie9Kxkk0lBA48TBERTy+hY= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1720666459; 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=gs6/NOGrxGGy2dXhOXNpceehqkBF0VzIDCoOZ5ryQPrDT7DUHvY/komGTKzyaNerkbRz8nCNkWLCTnEIepukPZr2RWDU2Q1ibg6L7bia+gN5RwPfbiCQDa2E05AZBsU/Nu0nQpk8DgsOaTJuiadJuMVvNCuxrxgBdzBG1VbjlDk= 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 1720666459600731.889895734341; Wed, 10 Jul 2024 19:54:19 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sRjvO-0003x3-OG; Wed, 10 Jul 2024 22:52:50 -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 1sRjvM-0003p0-HE for qemu-devel@nongnu.org; Wed, 10 Jul 2024 22:52:48 -0400 Received: from mail-oi1-x233.google.com ([2607:f8b0:4864:20::233]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1sRjvI-0007s1-3P for qemu-devel@nongnu.org; Wed, 10 Jul 2024 22:52:48 -0400 Received: by mail-oi1-x233.google.com with SMTP id 5614622812f47-3d9dd3c1e59so256400b6e.0 for ; Wed, 10 Jul 2024 19:52:41 -0700 (PDT) Received: from DY4X0N7X05.bytedance.net ([208.184.112.130]) by smtp.gmail.com with ESMTPSA id 5614622812f47-3daa12f4f7csm117827b6e.41.2024.07.10.19.52.39 (version=TLS1_3 cipher=TLS_CHACHA20_POLY1305_SHA256 bits=256/256); Wed, 10 Jul 2024 19:52:40 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bytedance.com; s=google; t=1720666361; x=1721271161; 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=PDOBLiXIQaPlGDZhs51oieFird9FBzr97R+A2uZNQfhFQCNqoib9RVlzztmZrA3VHg UD0hcRIjnq4hWX6TTilNxLfEDtPmfSTtvVW4B3L9colNjkQg9T1JBmU3FWLH3zSNtHNt L71GqBuWXuUHM2a4D5EVesngiTq3HDX35f/NV7RFvWNCMWMF4EQ5MDPgy6mRuzGiIRwQ 6uhPYVR1qGK+hKaDFXW8rxBSgRu4Kki4CVUwBb5xTB7MaAYRKA9lzDHDdwdtkP2R9ewP NAp4EW71b8BU6Ne5Ab5wDKb5OicQwRdcHcHpD9Oy61zk1u+HYjnYqZO6OPZoK13RAAeP XS6Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1720666361; x=1721271161; 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=vT9pgxlOrRBa1JHpTzwGkr6xIasa6mKYk7Xl6sZ7xEADoSXK1amh0TgCQXOGkIn6PH Ik3d23EyCPuxNvX6rjiLr0JhZOYftzyG8sg2tLggIYf+sm9mjnrwmypPiiSNW9W6/ICL PndLB3U92UxMax3CI8A1paYynai/pYdCYqSFsML9uRrirr7f3BotweTHtgokvvKIX4wd rtE+KNqjql7T1sec7SMEQWsbVtQZ3kAf1ZCF9TWVVe8sTarrHhZWQaOVH/63RlCyXd6d j+vNwKTV797EC2FcaplfCTczcXicwuop6HKjgQTNrEZilDR39jLZ6VtV/qz0YCf1cvPM dEfw== X-Forwarded-Encrypted: i=1; AJvYcCUQSqKCh9ZcnxBnVB26z5eeI/zF9acos6xu344pFp4iBpm2s/5/xjRDXvRXcIIGityq79sTedjVKLGBS8aZE5rUJqjjo5M= X-Gm-Message-State: AOJu0YxStEXNV57oBKgbqDByYS1mbTelDzLKTBs+wo7WbJWb+FHhaNvA 4KjQ3ORJrNRykOo2CS+z/mDQ0AmIpQt3WBzCOCJyQAdrtOsOOBTl36NvmP8DmuU= X-Google-Smtp-Source: AGHT+IGxTjV+JOxhbqYV18bA0vldygq9qYAdHDtVGX4epP2UcrXrOIPkFDYGsv5F/OXULhPLnXebHA== X-Received: by 2002:a05:6808:bcb:b0:3d9:2ac4:5d63 with SMTP id 5614622812f47-3d93c021450mr8434382b6e.25.1720666360827; Wed, 10 Jul 2024 19:52:40 -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 v5 3/5] migration: Add migration parameters for QATzip Date: Wed, 10 Jul 2024 19:52:27 -0700 Message-Id: <20240711025229.66260-4-yichen.wang@bytedance.com> X-Mailer: git-send-email 2.39.3 (Apple Git-146) In-Reply-To: <20240711025229.66260-1-yichen.wang@bytedance.com> References: <20240711025229.66260-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::233; envelope-from=yichen.wang@bytedance.com; helo=mail-oi1-x233.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: 1720666461022116300 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 --- 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 Sat Dec 28 23:43:55 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=1720666426; cv=none; d=zohomail.com; s=zohoarc; b=hq+XSn+M/A8wKuAYnCEo7SEUELOYw4sCajSZeI4oZkK6OWcBgWSuJcKtt0fBFYl0782CcVn1ptMORhfD4Tps02Sm9YSGiZeyN5OKn2uHvj65S4HuY6Bq7C5cs74N4lRtEA/R5hKFLyePaiSAIFJHEenT0arfwdN30bqaMvmRMdI= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1720666426; 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=QPSVV5we5gSNTaloIadk8enBm9gzXLNPNMXWqTWw/Qc=; b=T13Vw9HZrqpRk1d9z+o1f5bTqDcbUFAq6TwTjxlpGccnybuv2kq2PT8EVqTeD1nGUt8hRR0NvaChgwogeN9RV1X0+Z5x5Hw0nc8bXdGo8USrSjq1boxdz/CUQmrk7A0EX3cYhgqE8zihF1d1R74eRP9hkt9RR/CfwepEBk/U5o4= 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 1720666426451779.1223924449646; Wed, 10 Jul 2024 19:53:46 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sRjvP-0003xz-04; Wed, 10 Jul 2024 22:52:51 -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 1sRjvN-0003r3-1B for qemu-devel@nongnu.org; Wed, 10 Jul 2024 22:52:49 -0400 Received: from mail-oi1-x22f.google.com ([2607:f8b0:4864:20::22f]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1sRjvI-0007sI-1T for qemu-devel@nongnu.org; Wed, 10 Jul 2024 22:52:48 -0400 Received: by mail-oi1-x22f.google.com with SMTP id 5614622812f47-3c9cc66c649so224241b6e.1 for ; Wed, 10 Jul 2024 19:52:43 -0700 (PDT) Received: from DY4X0N7X05.bytedance.net ([208.184.112.130]) by smtp.gmail.com with ESMTPSA id 5614622812f47-3daa12f4f7csm117827b6e.41.2024.07.10.19.52.41 (version=TLS1_3 cipher=TLS_CHACHA20_POLY1305_SHA256 bits=256/256); Wed, 10 Jul 2024 19:52:42 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bytedance.com; s=google; t=1720666363; x=1721271163; 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=QPSVV5we5gSNTaloIadk8enBm9gzXLNPNMXWqTWw/Qc=; b=FJznW3y5mUlK+hiFAcw7h01IWbnhqRD+NllAYXxLwCut3b3tcS2dLCDg9DbcFLPOjK lJBg4gNfL9LSjRuOG3CuMaoNy3eM0XXeWcg8AGJmTDx8/T+92U1q1b/08OcbuiyU4u7x 21rsdUtnwQ0S8GBC274OtmDTtt4GsqHAPNjGF+F+oxT8XpTJgtK96vOMvEGUv0X2+bjw GlZsaQZgIDLZBRrlUx7fkIL5uIEI3ZMa5croJbPRmugh61YnChQBXD+V3cmAjk40finK UavUlet8jWRvId3K15+zbUYyRpEbJ8sG/r7v2UKnX0sSexyb6qyNlS4XuclPALX23/7N 5Ilg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1720666363; x=1721271163; 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=QPSVV5we5gSNTaloIadk8enBm9gzXLNPNMXWqTWw/Qc=; b=QsEl+EeaFR7xUA6ZmaMEe72I6v74PyrbLlFvfwCjkHcBBpFNyN0yFF8hZCb8wDyp2f 0SfFp1nKhiwyg+1Agd6qwHm/g8qjBYYiQEVIMFXdOlJCwAIQNHQykLFntThWVQ38rqvm fykMVHG+IFg/O8BG47+ciVtuxns/a+xFm19ooB/yWmeHnSVr1siPXQcXD3IuLX6kdRlv Pbg/pTstgk5d5yylj2CfCvVjFMPbFi+7c1CYLAxCn5LXuPaCtDrCRuubJnlm9iS78MPE 2WA10zj1wnsYQeCcRFFz3Z83X2W6/zVDRuuaUxGyuqzrTyLr1KyYg8LFtmKg36Xhvfl0 g0Tg== X-Forwarded-Encrypted: i=1; AJvYcCXjbl5nY2DMM4AI5L90AE/wz9alXZPumGkIEkvHGZwAQKywp31VUipfEL5vDheQ3dO/HGHQYefpzatoQrSzGL2qOzh+EE8= X-Gm-Message-State: AOJu0Yw0VNnJsBpd4bP70gVOxYb9D9Vna0LYP5h7UDjP09lueW4kKa4J z4jtZqhbNsiiKOsI6vUfoFRS+H50YshSY9WpMs8XkaCtgflQC6DvSszm6Ifgfe8= X-Google-Smtp-Source: AGHT+IHHslnGO0B8QEV7q0NJIOmKYsoM0oQJe2bhh6fTHJI4oQQwGYMYptHUP/Z3VzQ8A+lrp6vVUQ== X-Received: by 2002:a05:6808:2023:b0:3d9:263b:3a35 with SMTP id 5614622812f47-3d93c0a9dcdmr8241627b6e.47.1720666362626; Wed, 10 Jul 2024 19:52:42 -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 v5 4/5] migration: Introduce 'qatzip' compression method Date: Wed, 10 Jul 2024 19:52:28 -0700 Message-Id: <20240711025229.66260-5-yichen.wang@bytedance.com> X-Mailer: git-send-email 2.39.3 (Apple Git-146) In-Reply-To: <20240711025229.66260-1-yichen.wang@bytedance.com> References: <20240711025229.66260-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::22f; envelope-from=yichen.wang@bytedance.com; helo=mail-oi1-x22f.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: 1720666428690116300 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 --- hw/core/qdev-properties-system.c | 6 +- migration/meson.build | 1 + migration/multifd-qatzip.c | 403 +++++++++++++++++++++++++++++++ migration/multifd.h | 5 +- qapi/migration.json | 3 + tests/qtest/meson.build | 4 + 6 files changed, 419 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..eb50d6ec5b 100644 --- a/hw/core/qdev-properties-system.c +++ b/hw/core/qdev-properties-system.c @@ -659,7 +659,11 @@ 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" +#ifdef CONFIG_QATZIP + "/qatzip" +#endif + , .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..d01d51de8f --- /dev/null +++ b/migration/multifd-qatzip.c @@ -0,0 +1,403 @@ +/* + * 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("Initilizing QAT with sw_fallback..."); + ret =3D qzInit(&q->sess, true); + if (ret !=3D QZ_OK && ret !=3D QZ_DUPLICATE) { + /* Warn, and try with sw_fallback. */ + err_msg =3D "qzInit failed"; + goto err_free_q; + } + } + + ret =3D qzGetDefaultsDeflate(¶ms); + if (ret !=3D QZ_OK) { + err_msg =3D "qzGetDefaultsDeflate failed"; + goto err_close; + } + + /* 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_close; + } + + if (MULTIFD_PACKET_SIZE > UINT32_MAX) { + err_msg =3D "packet size too large for QAT"; + goto err_close; + } + + 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_close; + } + + 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_free_inbuf; + } + + return 0; + +err_free_inbuf: + qzFree(q->in_buf); +err_close: + qzClose(&q->sess); +err_free_q: + g_free(q); + g_free(p->iov); + p->iov =3D NULL; + p->compress_data =3D NULL; + error_setg(errp, "multifd %u: %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; + const char *err_msg; + int ret; + + ret =3D qzTeardownSession(&q->sess); + if (ret !=3D QZ_OK) { + err_msg =3D "qzTeardownSession failed"; + goto err; + } + + ret =3D qzClose(&q->sess); + if (ret !=3D QZ_OK) { + err_msg =3D "qzClose failed"; + goto err; + } + + qzFree(q->in_buf); + q->in_buf =3D NULL; + qzFree(q->out_buf); + q->out_buf =3D NULL; + g_free(p->iov); + p->iov =3D NULL; + g_free(p->compress_data); + p->compress_data =3D NULL; + return; + +err: + error_setg(errp, "multifd %u: %s", p->id, err_msg); +} + +/** + * 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-streaming API and place all the data into one buffer, rather th= an + * sending each page to the compression API at a time. */ + for (int i =3D 0; i < pages->normal_num; i++) { + memcpy(q->in_buf + (i * p->page_size), + p->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; + + /* + * Unlike other multifd compression implementations, we use a non-stre= aming + * API and place all the data into one buffer, rather than sending eac= h 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. + */ + 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("Initilizing QAT with sw_fallback..."); + ret =3D qzInit(&q->sess, true); + if (ret !=3D QZ_OK && ret !=3D QZ_DUPLICATE) { + /* Warn, and try with sw_fallback. */ + err_msg =3D "qzInit failed"; + goto err_free_q; + } + } + + ret =3D qzGetDefaultsDeflate(¶ms); + if (ret !=3D QZ_OK) { + err_msg =3D "qzGetDefaultsDeflate failed"; + goto err_close; + } + + ret =3D qzSetupSessionDeflate(&q->sess, ¶ms); + if (ret !=3D QZ_OK && ret !=3D QZ_DUPLICATE) { + err_msg =3D "qzSetupSessionDeflate failed"; + goto err_close; + } + + /* + * Mimic multifd-zlib, which reserves extra space for the + * incoming packet. + */ + 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_close; + } + + 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_free_inbuf; + } + + return 0; + +err_free_inbuf: + qzFree(q->in_buf); +err_close: + qzClose(&q->sess); +err_free_q: + g_free(q); + p->compress_data =3D NULL; + error_setg(errp, "multifd %u: %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; + + /* Ignoring return values here due to function signature. */ + qzTeardownSession(&q->sess); + qzClose(&q->sess); + qzFree(q->in_buf); + qzFree(q->out_buf); + g_free(p->compress_data); +} + + +/** + * 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 Sat Dec 28 23:43:55 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=1720666464; cv=none; d=zohomail.com; s=zohoarc; b=kymTfEHkgmFmvXchMdalyg1ukdzd7IPGDiy5wl6EAOuua8nTRRSYqAU2YDxSr9jvpfwMbX27edThlGFwCfumGtxQoQyeYeVhFl2EI0Tw9MujyLrbvTGJh7MDD7UC6zuX3RHDsGDfcmikNW9yfESP/FqSIrkpgJdYjD+i2osVPfE= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1720666464; 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=cApDvkpHgcDvEBUZlaSazyrta9dSUlvo1AUuexPKHyE=; b=oKns5LKUXGp9jdZiq3hV1GtjWAX0nXDac2JrAVjEJt05UEfqUcN7pmFgVtB2wdBLJLzevE8XZBrLXf8yy1rAcFZtj2ZXRj77rjAgBfzvFmafY5ZG85DXP3i4vNOx7a0HNbo+DikHJQ87aMC2/lKB3ddG5WazBF9zUe3Sq1pKL2E= 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 1720666464523563.0479736189552; Wed, 10 Jul 2024 19:54:24 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sRjvO-0003vg-B5; Wed, 10 Jul 2024 22:52:50 -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 1sRjvM-0003oe-Bt for qemu-devel@nongnu.org; Wed, 10 Jul 2024 22:52:48 -0400 Received: from mail-oi1-x230.google.com ([2607:f8b0:4864:20::230]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1sRjvJ-0007sT-LK for qemu-devel@nongnu.org; Wed, 10 Jul 2024 22:52:48 -0400 Received: by mail-oi1-x230.google.com with SMTP id 5614622812f47-3c9cc681ee0so246072b6e.0 for ; Wed, 10 Jul 2024 19:52:45 -0700 (PDT) Received: from DY4X0N7X05.bytedance.net ([208.184.112.130]) by smtp.gmail.com with ESMTPSA id 5614622812f47-3daa12f4f7csm117827b6e.41.2024.07.10.19.52.42 (version=TLS1_3 cipher=TLS_CHACHA20_POLY1305_SHA256 bits=256/256); Wed, 10 Jul 2024 19:52:44 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bytedance.com; s=google; t=1720666364; x=1721271164; 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=cApDvkpHgcDvEBUZlaSazyrta9dSUlvo1AUuexPKHyE=; b=J/9Qb5utnTsJEzweD4GsJ7f9zxwDWSN+jExcspMXxmf2NRaZSA1R8g+yYHdSQ9d+LX ddrdCBcL+Bf0JtTzm47D7lWwlMMmoblF1hV6Sp/CVeSdQel2QYxEJo+ZmOZOr8KiotdT 5oswnmthMIf/02b26QquaaBdTb3e26VlHdp173VOMJsIm79aVksDLnNw/8UBp1delRNc l2V5aB+buWuqBK3SnyrQQ3SLxjgm0p7ceg3fuu9wJGwG3leACSVqfyoDu2FhM3jQkuXO QwPMYhFsyz0HFkI9k7u39IuVz3PDT49K1JhwcI8TgwAKYC4bXbeyl+plHkBB3CBmFFEP DAaw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1720666364; x=1721271164; 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=cApDvkpHgcDvEBUZlaSazyrta9dSUlvo1AUuexPKHyE=; b=pKN3/PApgpyI1zoIYwjJRDc+E4DzXbWB+gC4R+trzmn2Nke/MzyLiA1uBOel48jo5a vO3c86BZVBX+vQzqY4nUva9mtb6g6kHjkHK1ovEMy7aFFB2GOIWdmPbWlCsAOxkvs47y 4LfPzy354iCWOBoSEkIwxlhFJg65yneloQdYucotx2cb7VR+iGEq0b0YdLBI/lHJRF8E LHFWZuv9Kmn0WzMcLAvWWRvE6vQPbVBIOn2RQsW7+RAWITsmN1mPW+Icm180MzHQ0LX2 st6cA4Yt2PK9G82iKM7XGVupRg2A2iS8JwVltL9H+6bvv4Ut1JvPl/iygfnHLo1X2dTT vrbw== X-Forwarded-Encrypted: i=1; AJvYcCVOe0weEbgL/BEMm8z2PEcbcKfr8sQf9hGf2OXZgyhN9FIFQIcVeVPmZx/tT32JR6gPZBc91l16inw0/LO4f3+gZaFARZg= X-Gm-Message-State: AOJu0YzmIEFWN4BdmwZJcrBLuakuIiOzCU76lXNyAzUk0BeyOjPCwfhV din4r5TnJo3R96okQ4rgfHX90TAQiwqGO0HNhy0Uq/qBh7CpQZqR+uNNCNjFa48= X-Google-Smtp-Source: AGHT+IE/h/MdfIYVRq4e/+LOOcGb11ueLZ7gK1IFWztEhXtnnM7ZF2ogj6FebcLruoTEDnFX+IwwdQ== X-Received: by 2002:a05:6808:8e4:b0:3da:a279:ac1 with SMTP id 5614622812f47-3daa2793766mr566510b6e.52.1720666364359; Wed, 10 Jul 2024 19:52:44 -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 v5 5/5] tests/migration: Add integration test for 'qatzip' compression method Date: Wed, 10 Jul 2024 19:52:29 -0700 Message-Id: <20240711025229.66260-6-yichen.wang@bytedance.com> X-Mailer: git-send-email 2.39.3 (Apple Git-146) In-Reply-To: <20240711025229.66260-1-yichen.wang@bytedance.com> References: <20240711025229.66260-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::230; envelope-from=yichen.wang@bytedance.com; helo=mail-oi1-x230.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: 1720666464788116300 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 Signed-off-by: Yichen Wang --- tests/qtest/migration-test.c | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/tests/qtest/migration-test.c b/tests/qtest/migration-test.c index 70b606b888..b796dd21cb 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,22 @@ 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); + + /* SW fallback is disabled by default, so enable it for testing. */ + migrate_set_parameter_bool(from, "multifd-qatzip-sw-fallback", true); + migrate_set_parameter_bool(to, "multifd-qatzip-sw-fallback", true); + + 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 +3109,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 +4023,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