From nobody Sun Nov 24 09:18:42 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=quarantine dis=none) header.from=bytedance.com ARC-Seal: i=1; a=rsa-sha256; t=1723681362; cv=none; d=zohomail.com; s=zohoarc; b=PuCpQ7ZC3huXE2QNEcy+lFWbygZiDwomquNGO3gvyVx6aGVq7YrhquduPQpBgfRC9TQydp6khC3uUtpmJzZykmFbsCAnErJrSSsvLj/Ri3nOqSaMHSHUZTAlCQ6zJ0BXe7YeuW9YxHtp1ZdU4GoyT5nZltKL2dLCWbOxTCGWPYI= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1723681362; 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=HmK5TfyzY33ZDiQRuyZXJNi/WWVL1YCFzt6nYT2pdjg=; b=E8oDGbBKPMAOorZDAw2ThTS4f81PYC6Zeb6AJFcaGsi3DKPEMIg7gTYlf8xOXph8A1gHxwggmkCGwVituBNmJDGWYLQme7EHlaEtF/22koqtpjbOqp2kj0N5sC5/aU9V/XPhb04Wt46wFHCWrg74UnE2IRinf6OSCM31lKFX/bw= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=quarantine dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1723681362535665.0911959244504; Wed, 14 Aug 2024 17:22:42 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1seOFK-000551-2K; Wed, 14 Aug 2024 20:21:42 -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 1seOFH-0004x3-PG for qemu-devel@nongnu.org; Wed, 14 Aug 2024 20:21:39 -0400 Received: from mail-pl1-x633.google.com ([2607:f8b0:4864:20::633]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1seOFB-0004GQ-De for qemu-devel@nongnu.org; Wed, 14 Aug 2024 20:21:39 -0400 Received: by mail-pl1-x633.google.com with SMTP id d9443c01a7336-201d6ac1426so3584715ad.1 for ; Wed, 14 Aug 2024 17:21:31 -0700 (PDT) Received: from DY4X0N7X05.bytedance.net ([72.29.204.230]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-201f02faa03sm1961185ad.19.2024.08.14.17.21.28 (version=TLS1_3 cipher=TLS_CHACHA20_POLY1305_SHA256 bits=256/256); Wed, 14 Aug 2024 17:21:29 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bytedance.com; s=google; t=1723681290; x=1724286090; 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=HmK5TfyzY33ZDiQRuyZXJNi/WWVL1YCFzt6nYT2pdjg=; b=KKZfbfH3BczfZ+zjc4T68q76WqRRffxYxyUlzKtg83XpGVDdq2HZdBTf40Vttf2tP9 Vk0zcdeHpBcxKPFWJ1rZHHRarH0+yxtgVuo4S5zCkIc3CErgL0MAWFkGWXPxN2HFQnBd CIgRAxY7xx0g+HQdzR+VX0mgeDfMULXAOtrOqbk/oiDBI/FxkTz0KvGv/GIpQ67cw/s1 sM4DpVSbRTWgQ1SlCtDV/gJgTiH4/OuTiXemqkuYD8Oa9gcbbAPoQoXt5wSjQKgRFEeu JopINRCxfL/fJYLZ9VI4CbML1Sr+aGvAWYBNjDjojXUw5HHJ4nASqGwK7l2TfqZxqBgE 4ajA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723681290; x=1724286090; 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=HmK5TfyzY33ZDiQRuyZXJNi/WWVL1YCFzt6nYT2pdjg=; b=L4a2rLn3SsPBHD2bsd+T82hUplRUTrFpy3vXUgYy0Rmk27o1mjstXGSbjbOhqAq0G5 UNG37KJYraO2cjeGqrkr7xBtFzk8ahQ9ZrplpCG9neMhQjeeoOCeKKnGzZlblpKSjRcd GMes1zvbZkEcR8l8fZcSblXq5hlUQLBn8ZQDBR1o/+wziZTtygoIghD9/r9bLU7tBbOg J6BSrWhzZjBaSa+LZRWYsxksSP9E2xuxSmdcpdqtOL2IJs7IEsU1ISVwgAA/n7VaX02O 5oCNvrBb/H7r8bowJelvL559hXtgvknBlPjb4XA4VuI2TQvXR5wlEamCFnLqGYMqw7n1 wurw== X-Forwarded-Encrypted: i=1; AJvYcCWZdTTfGi/Z3gf4EcgGtIUVfFsjQS0hxNThO2fUlfLHwC1EwGa+Q3uSwQrQxX+nC+oVaZao+lqozTHrwsY90lrdN5LLjUg= X-Gm-Message-State: AOJu0YwgcwZEJFcMD8LZaqUVtmU1osDvhnzo5VhxOSAqNkXnuSw/uObB xHPh6nggFCpnvtK+6BYkRrPogh5QBibUN86cG7NfJgmv5uEYGAyyrHC/3gyQ3I0= X-Google-Smtp-Source: AGHT+IFb2DCwe69SlQCgwvHfSEHhTESIz0otyIVLzPm1ArFTxy6MDYD5ke/O/8awxmTUVcRO8gXlVQ== X-Received: by 2002:a17:902:c949:b0:1fd:a5a2:5817 with SMTP id d9443c01a7336-201d63c73f1mr51410245ad.31.1723681289519; Wed, 14 Aug 2024 17:21:29 -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 , qemu-devel@nongnu.org Cc: "Hao Xiang" , "Liu, Yuan1" , "Zou, Nanhai" , "Ho-Ren (Jack) Chuang" , "Yichen Wang" Subject: [PATCH v7 1/5] docs/migration: add qatzip compression feature Date: Wed, 14 Aug 2024 17:21:20 -0700 Message-Id: <20240815002124.65384-2-yichen.wang@bytedance.com> X-Mailer: git-send-email 2.39.3 (Apple Git-146) In-Reply-To: <20240815002124.65384-1-yichen.wang@bytedance.com> References: <20240815002124.65384-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+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2607:f8b0:4864:20::633; envelope-from=yichen.wang@bytedance.com; helo=mail-pl1-x633.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, T_SCC_BODY_TEXT_LINE=-0.01, T_SPF_TEMPERROR=0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @bytedance.com) X-ZM-MESSAGEID: 1723681364626116600 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 | 165 ++++++++++++++++++++ 2 files changed, 166 insertions(+) create mode 100644 docs/devel/migration/qatzip-compression.rst diff --git a/docs/devel/migration/features.rst b/docs/devel/migration/featu= res.rst index 58f8fd9e16..8f431d52f9 100644 --- a/docs/devel/migration/features.rst +++ b/docs/devel/migration/features.rst @@ -14,3 +14,4 @@ Migration has plenty of features to support different use= cases. CPR qpl-compression uadk-compression + qatzip-compression diff --git a/docs/devel/migration/qatzip-compression.rst b/docs/devel/migra= tion/qatzip-compression.rst new file mode 100644 index 0000000000..a7f755eb7f --- /dev/null +++ b/docs/devel/migration/qatzip-compression.rst @@ -0,0 +1,165 @@ +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +QATzip Compression +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +In scenarios with limited network bandwidth, the ``QATzip`` solution can h= elp +users save a lot of host CPU resources by accelerating compression and +decompression through the Intel QuickAssist Technology(``QAT``) hardware. + + +The following test was conducted using 8 multifd channels and 10Gbps netwo= rk +bandwidth. The results show that, compared to zstd, ``QATzip`` significant= ly +saves CPU resources on the sender and reduces migration time. Compared to = the +uncompressed solution, ``QATzip`` greatly improves the dirty page processi= ng +capability, indicated by the Pages per Second metric, and also reduces the +total migration time. + +:: + + VM Configuration: 16 vCPU and 64G memory + VM Workload: all vCPUs are idle and 54G memory is filled with Silesia d= ata. + QAT Devices: 4 + |-----------|--------|---------|----------|----------|------|------| + |8 Channels |Total |down |throughput|pages per | send | recv | + | |time(ms)|time(ms) |(mbps) |second | cpu %| cpu% | + |-----------|--------|---------|----------|----------|------|------| + |qatzip | 16630| 28| 10467| 2940235| 160| 360| + |-----------|--------|---------|----------|----------|------|------| + |zstd | 20165| 24| 8579| 2391465| 810| 340| + |-----------|--------|---------|----------|----------|------|------| + |none | 46063| 40| 10848| 330240| 45| 85| + |-----------|--------|---------|----------|----------|------|------| + + +QATzip Compression Framework +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D + +``QATzip`` is a user space library which builds on top of the Intel QuickA= ssist +Technology user space library, to provide extended accelerated compression= and +decompression services. + +For more ``QATzip`` introduction, please refer to `QATzip Introduction +`_ + +:: + + +----------------+ + | MultiFd Thread | + +-------+--------+ + | + | compress/decompress + +-------+--------+ + | QATzip library | + +-------+--------+ + | + +-------+--------+ + | QAT library | + +-------+--------+ + | user space + --------+--------------------- + | kernel space + +------+-------+ + | QAT Driver | + +------+-------+ + | + +------+-------+ + | QAT Devices | + +--------------+ + + +QATzip Installation +------------------- + +The ``QATzip`` installation package has been integrated into some Linux +distributions and can be installed directly. For example, the Ubuntu Server +24.04 LTS system can be installed using below command + +.. code-block:: shell + + #apt search qatzip + libqatzip-dev/noble 1.2.0-0ubuntu3 amd64 + Intel QuickAssist user space library development files + + libqatzip3/noble 1.2.0-0ubuntu3 amd64 + Intel QuickAssist user space library + + qatzip/noble,now 1.2.0-0ubuntu3 amd64 [installed] + Compression user-space tool for Intel QuickAssist Technology + + #sudo apt install libqatzip-dev libqatzip3 qatzip + +If your system does not support the ``QATzip`` installation package, you c= an +use the source code to build and install, please refer to `QATzip source c= ode installation +`_ + +QAT Hardware Deployment +----------------------- + +``QAT`` supports physical functions(PFs) and virtual functions(VFs) for +deployment, and users can configure ``QAT`` resources for migration accord= ing +to actual needs. For more details about ``QAT`` deployment, please refer to +`Intel QuickAssist Technology Documentation +`_ + +For more ``QAT`` hardware introduction, please refer to `intel-quick-assis= t-technology-overview +`_ + +How To Use QATzip Compression +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D + +1 - Install ``QATzip`` library + +2 - Build ``QEMU`` with ``--enable-qatzip`` parameter + + E.g. configure --target-list=3Dx86_64-softmmu --enable-kvm ``--enable-qa= tzip`` + +3 - Set ``migrate_set_parameter multifd-compression qatzip`` + +4 - Set ``migrate_set_parameter multifd-qatzip-level comp_level``, the def= ault +comp_level value is 1, and it supports levels from 1 to 9 + +QAT Memory Requirements +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +The user needs to reserve system memory for the QAT memory management to +allocate DMA memory. The size of the reserved system memory depends on the +number of devices used for migration and the number of multifd channels. + +Because memory usage depends on QAT configuration, please refer to `QAT Me= mory +Driver Queires +`_ +for memory usage calculation. + +.. list-table:: An example of a PF used for migration + :header-rows: 1 + + * - Number of channels + - Sender memory usage + - Receiver memory usage + * - 2 + - 10M + - 10M + * - 4 + - 12M + - 14M + * - 8 + - 16M + - 20M + +How To Choose Between QATzip and QPL +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D +Starting from 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 Nov 24 09:18:42 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=quarantine dis=none) header.from=bytedance.com ARC-Seal: i=1; a=rsa-sha256; t=1723681316; cv=none; d=zohomail.com; s=zohoarc; b=Br4LYPwBW6S3P+o+h1+LuZW44BsRqAGgNOlYmFCwWlGmZ4WM8YHx3XbHT+1Oxm9a38kJcqQLVT/HDxtI44PeK1LS7HEJaKNlIioj+d//VJ+JyToRlG5w87j2/jVS0KiqnuAZDriXATYG2h/2JgxQ6PD//GPjk9vTLfTmeKEXkDE= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1723681316; 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=AbsMGU759tw6NTBLURH2+15n6uWZy/9JB+FIZCPq28k=; b=fp+b4/6JJEWDPiF0qY2aQgynY9kx1+AXkoXGPBCdIGiB+BR1MFMC077dm1lFlvyrU2yCgm3HpPBnQaaN3t7dsCpwo9TUUwl0AMn4qFJlrL3w5D48Dv95ePFoFgAfL/GLpzVdJeIHAdbZFji4B/yw6VGzARzPfeXHcpLGLxvJLeA= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=quarantine dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1723681316583433.6886524087105; Wed, 14 Aug 2024 17:21:56 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1seOFF-0004lF-Uv; Wed, 14 Aug 2024 20:21:37 -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 1seOFD-0004iJ-Rj for qemu-devel@nongnu.org; Wed, 14 Aug 2024 20:21:35 -0400 Received: from mail-pl1-x632.google.com ([2607:f8b0:4864:20::632]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1seOFA-0004GZ-T0 for qemu-devel@nongnu.org; Wed, 14 Aug 2024 20:21:35 -0400 Received: by mail-pl1-x632.google.com with SMTP id d9443c01a7336-1fd640a6454so4834635ad.3 for ; Wed, 14 Aug 2024 17:21:32 -0700 (PDT) Received: from DY4X0N7X05.bytedance.net ([72.29.204.230]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-201f02faa03sm1961185ad.19.2024.08.14.17.21.29 (version=TLS1_3 cipher=TLS_CHACHA20_POLY1305_SHA256 bits=256/256); Wed, 14 Aug 2024 17:21:31 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bytedance.com; s=google; t=1723681291; x=1724286091; 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=AbsMGU759tw6NTBLURH2+15n6uWZy/9JB+FIZCPq28k=; b=GlnqZM1PRUd7dNfPv+7HetvcogKyPxA9rrfAio6BXbQafpP+ymk5qD5wGR3H5JgZdk 2whu6jIAURhlnju6CJk3Ot4HHv2408kVdVXbinrj7xA67FDfYLEfN8hfXNsXVOy9NUQl B4Dmv4ACaubjAEAyXqUrTb8e6Rj1Ot0efIShwhPoTxGYNmRPK2rzJbBfkIWs94bomOQ4 TOoKQd0Lju1FFbKDsHy8iCBsRNpPaI/NPkawVLhucfUDcK7K3CDNl+xqEgQLIUm4gFyL BRcQVXQzW/J6y8a08Dx6mNKxaa/nGYZu1peGhXzOxZ5lkeiBXC5YfoN9ACvj/MlLoUuu x6gw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723681291; x=1724286091; 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=AbsMGU759tw6NTBLURH2+15n6uWZy/9JB+FIZCPq28k=; b=a+b3+qI21BUoIrkwKCabXFVR6iIMGgWRAVDBUmw68bBinOuJytU+sEQuo+toO6/nTW DsIycGUIBkE2+F5yLwfVy1C5yJTTEpA1W4BJQGDBWJmlAoUbITkquPcG/+lds5XKeGV7 V39PsHpV5dycBeL6c56rK5ILA2XL10hfsCUsNrnXEWXBb0JEqGorxstoQDlU56N0ZGZq Q2d1oKMm1qATP2QwWj3EF500tUFMreTdNY8NVnHQMhgFvJE/dxh1T7cyJY2qR0ePhQK8 7Ev/l+UB4Q/peu+22q8X7TwFlmzpJn9kdBtQhuZNEOGXd5+dWOcWFyo3GKaBxPtRw81v aVjw== X-Forwarded-Encrypted: i=1; AJvYcCWIixEr7+qJ3ZTKhpLV98KDUiLX9SJ3u9OeArgIw1SVcbqW456fK4oWhM0SHqku/Y/NseU54AqBrGjoj52hy0rREarG6i4= X-Gm-Message-State: AOJu0Yxz5a8YmAa2mkixkGlNmBVyoi1AssJolZi/ZfvHZal6Xu0SHiAz Dt6lnlIViqAfHNFu765c6oYPGUcuzO8TbokuO7WcIZb90s3FUU6++bNz68cbiNo= X-Google-Smtp-Source: AGHT+IHh9tej7HYgHwOTYzXgvNuOU+Tl4Urdf7y/QSlXDGNk9JQyL23PO5xSro8jePyawXNiDYwXmA== X-Received: by 2002:a17:903:1104:b0:1fd:7fac:a539 with SMTP id d9443c01a7336-201d63abfa0mr48415205ad.16.1723681291280; Wed, 14 Aug 2024 17:21:31 -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 , qemu-devel@nongnu.org Cc: "Hao Xiang" , "Liu, Yuan1" , "Zou, Nanhai" , "Ho-Ren (Jack) Chuang" , "Yichen Wang" , Bryan Zhang Subject: [PATCH v7 2/5] meson: Introduce 'qatzip' feature to the build system Date: Wed, 14 Aug 2024 17:21:21 -0700 Message-Id: <20240815002124.65384-3-yichen.wang@bytedance.com> X-Mailer: git-send-email 2.39.3 (Apple Git-146) In-Reply-To: <20240815002124.65384-1-yichen.wang@bytedance.com> References: <20240815002124.65384-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+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2607:f8b0:4864:20::632; envelope-from=yichen.wang@bytedance.com; helo=mail-pl1-x632.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, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @bytedance.com) X-ZM-MESSAGEID: 1723681318463116600 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 Reviewed-by: Fabiano Rosas --- 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 c2a050b844..5daaea15df 100644 --- a/meson.build +++ b/meson.build @@ -1257,6 +1257,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 not get_option('qatzip').auto() or have_system + 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() @@ -2405,6 +2413,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()) @@ -4528,6 +4537,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..f7b652b30d 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: 'auto', + 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 c97079a38c..5f377a6d81 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 Nov 24 09:18:42 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=quarantine dis=none) header.from=bytedance.com ARC-Seal: i=1; a=rsa-sha256; t=1723681337; cv=none; d=zohomail.com; s=zohoarc; b=Tn+P4rWeQ4d+phOm8IJjVNxr9o+LWHs5v4LwSaCn4ZyKeygSvX8jfC1e3A8g3Oygdw1SG5guAjpvQifAszbQiKWAYiuhvMw2qJj6pSV1BpZjMEEzgP0mZIedNMjURNNyb3oVInZ5fUCfl9uObnlvmvTrvKVk+YBzVPp3Arr/Big= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1723681337; 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=fSmtVkuTIatQvFoPy03zROe969GEcrj2NjmVN6S+iWs=; b=KXiReHj+KjGIqIF9a1KgTHcQH49Tv2mSdRBblWkoY5VtaJBiNO6wBNBq0LuPCtwi0giiKh/6Feq0teTo1qtPo7cixCu0m8B/Ltzig9zP62bPRNL1CRCyINJQeovSwUnojvIzYwjWNL/H5Zf9vegf4ft+ObzJelViwaCFMyI7o/E= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=quarantine dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1723681337462262.50035314927425; Wed, 14 Aug 2024 17:22:17 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1seOFG-0004qc-MK; Wed, 14 Aug 2024 20:21:38 -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 1seOFF-0004kL-OB for qemu-devel@nongnu.org; Wed, 14 Aug 2024 20:21:37 -0400 Received: from mail-pf1-x436.google.com ([2607:f8b0:4864:20::436]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1seOFD-0004Gh-Kd for qemu-devel@nongnu.org; Wed, 14 Aug 2024 20:21:37 -0400 Received: by mail-pf1-x436.google.com with SMTP id d2e1a72fcca58-70d18d4b94cso299887b3a.2 for ; Wed, 14 Aug 2024 17:21:34 -0700 (PDT) Received: from DY4X0N7X05.bytedance.net ([72.29.204.230]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-201f02faa03sm1961185ad.19.2024.08.14.17.21.31 (version=TLS1_3 cipher=TLS_CHACHA20_POLY1305_SHA256 bits=256/256); Wed, 14 Aug 2024 17:21:32 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bytedance.com; s=google; t=1723681293; x=1724286093; 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=fSmtVkuTIatQvFoPy03zROe969GEcrj2NjmVN6S+iWs=; b=LBKy74yWT9DjrtRu2f1FwecCZph+eaUh2z0ewFU6NpSowkwWqGZQoXFXdTRWWwkjJJ 6+GLw8TXStdPWZpj/tYi29liEnKMn67LzuOa6aALJgBHqbkkW8Z4PjfmxCltx8o6LEn/ Q/6nir1g5SHXJQsPNIIOigcq9ddFHWzOBTTrhmDK/RENpy57jftFfRiv++ltaQFDEJyf yxtvO4wafUGz2ZSJoAbXBbECP2yE1B6WUGsFRRKYALxQB9ti2761sWNj/iGEEsdZf4ed cByIs2SocDNATfaN/B6s2dRgngEl/95KdUGq4GWERsfONfvd8mV63Xu/kGE6rfs8fLV/ Inbw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723681293; x=1724286093; 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=fSmtVkuTIatQvFoPy03zROe969GEcrj2NjmVN6S+iWs=; b=tsd5sw0FG1ZrtONL96QCieXVhygTlx4Sg1apSagTozOMIVNZNRjudCuOVWsDGOWw3R JbJbPX+eIeSiVrKnldpdFMvnVt37Nuz/YJtaNyWfvsEC+NBLFGwnLoS3pNHzWmXjer4J /WPOInA1TpZxKVB4hosYJaRZ2GOBqYO0IvUBz2uLQJRNYbFy4VMipPNJZF2wN0WqBQ/N 32vr814Y1Ta8rGpws5k97/pELdIwU2IFWmfnq9sumlaEa7oRthi3pzhZ7iL3QHaI4TaW pdKdsfq9uZfhnCY1GiZPHqCRtlSUBXo16Oiu7BM5H8fBOXRBcLDwW1DXD2LfGu+90Y11 L4XA== X-Forwarded-Encrypted: i=1; AJvYcCXsgx7Ml2TvkwDRoIePg78BDAQc3QmoYm+kqGRG2Q0marFhmHIglhEgUA0gNcXN3/OnFOZihyWCjZqX3oUj7drK5W266lQ= X-Gm-Message-State: AOJu0YyjIHPn3dC4hZd+7+DPTsSKv5F8XEvW9n22NMwzH75mhh5bnrCX cssbMRl9UQE0RxawmoP4Q5UkXG6obmX28Np8IkHoP57OFkPVl0nICCLIv5rxYJg= X-Google-Smtp-Source: AGHT+IGPK8pMrJNY402wmsRFupyLUBPDQrD7p4vxujhAALbgPg85dGR7cQNXJaAhxKFbp/amvLK7OA== X-Received: by 2002:a05:6a20:d705:b0:1c0:e9dd:1197 with SMTP id adf61e73a8af0-1c8eaeaf752mr5703884637.22.1723681293018; Wed, 14 Aug 2024 17:21:33 -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 , qemu-devel@nongnu.org Cc: "Hao Xiang" , "Liu, Yuan1" , "Zou, Nanhai" , "Ho-Ren (Jack) Chuang" , "Yichen Wang" , Bryan Zhang Subject: [PATCH v7 3/5] migration: Add migration parameters for QATzip Date: Wed, 14 Aug 2024 17:21:22 -0700 Message-Id: <20240815002124.65384-4-yichen.wang@bytedance.com> X-Mailer: git-send-email 2.39.3 (Apple Git-146) In-Reply-To: <20240815002124.65384-1-yichen.wang@bytedance.com> References: <20240815002124.65384-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+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2607:f8b0:4864:20::436; envelope-from=yichen.wang@bytedance.com; helo=mail-pf1-x436.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, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @bytedance.com) X-ZM-MESSAGEID: 1723681338441116600 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 7324571e92..279a705cae 100644 --- a/qapi/migration.json +++ b/qapi/migration.json @@ -792,6 +792,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 @@ -852,6 +857,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', @@ -967,6 +973,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 @@ -1040,6 +1051,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', @@ -1171,6 +1183,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 @@ -1241,6 +1258,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 Nov 24 09:18:42 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=quarantine dis=none) header.from=bytedance.com ARC-Seal: i=1; a=rsa-sha256; t=1723681356; cv=none; d=zohomail.com; s=zohoarc; b=ZkkjpPo+X5QnNkasz/rVXve12es76AzaxjwHH+R7Tbtwtc+2gqDUBDkyk1ADUL4n/2I5WtHVRWUOGU1AErljV9Bu0yDDAAdqAEUVhrPk0nycEzjSDyaN1GLf3HOZKjpKUXKayBsitU4reSfxVGSctsCNd/apXjsUje9hN6nRPf4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1723681356; 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=mRZUAmH7P57wuTsSr2zUcQ+sbjj/+EfmGVCYcebQQOc=; b=NsZq19m1In5zEvYqrRCeRgFeS1iZPXURmSGSFJn1L/i7JLQWezZyWX7cohqA6xXXcJubQFXVNAI5ywNKPZtPw3IaWVG67uejJBCO+yv4sErFV+9yGV5O9hDrftjMdCN/qmC3yr335Cy/PTKwTlvE9Y2lyNCAfWP+MpvqWffb8Nc= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=quarantine dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1723681356829758.4328819978709; Wed, 14 Aug 2024 17:22:36 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1seOFI-0004zN-Ba; Wed, 14 Aug 2024 20:21:40 -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 1seOFH-0004vA-Fi for qemu-devel@nongnu.org; Wed, 14 Aug 2024 20:21:39 -0400 Received: from mail-pf1-x435.google.com ([2607:f8b0:4864:20::435]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1seOFE-0004H2-Ql for qemu-devel@nongnu.org; Wed, 14 Aug 2024 20:21:39 -0400 Received: by mail-pf1-x435.google.com with SMTP id d2e1a72fcca58-7126c9cb6deso278492b3a.0 for ; Wed, 14 Aug 2024 17:21:36 -0700 (PDT) Received: from DY4X0N7X05.bytedance.net ([72.29.204.230]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-201f02faa03sm1961185ad.19.2024.08.14.17.21.33 (version=TLS1_3 cipher=TLS_CHACHA20_POLY1305_SHA256 bits=256/256); Wed, 14 Aug 2024 17:21:34 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bytedance.com; s=google; t=1723681295; x=1724286095; 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=mRZUAmH7P57wuTsSr2zUcQ+sbjj/+EfmGVCYcebQQOc=; b=FLNksBmtW+2XcBZ53bDO1hZfg+5N0grM4pE/Vg3q/ElLYil2ZKeGuXlNowa1I9sL3x t68im6FJcgQSeAv/G/XcEwnv99epvdbOtoOzuyuynBa6/VVks8aDwFkp0rPWCr+jCD0y 6aJSwny9nHemWo/PtKz3akQXkzFIwT09XHkssQihuRUQe9czRdx5YSyoabihQUwwrCRG wJ4/8zLfLq1zKhJoE8OMMWn7pD25Ld8pM2qxriRQIgQRlEfnFHMNPdnzwZu4dn8Iv74S f6mZNwaTxPrr64Ji3bIpf51qDVHfCIeZNPJN8LhPQOib4wG46j6KO9MSEBGya3s+gbLP aVCA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723681295; x=1724286095; 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=mRZUAmH7P57wuTsSr2zUcQ+sbjj/+EfmGVCYcebQQOc=; b=W3RKvcQcoJZ8gZm3SzpFLeDTxnLQTZN5oWfxjuNIKG+G1LUoarM31cGx/B0g0RCUVs kyICyrIr5vVfKN7Y20pwfvh2uedfgWC8omm6RZJqhN+L21jQCsaH29eDADZa/2Q2WlhI m0lMsmbTX4SUjP4vZBsydTHSncFSSvMcGbzy3MskJpqIpnM2nsexyvTjgSU+mN7smV8t s0nYhzna6tsyvMhtD3fQh6lc+kOScInZ5GQ8VmYSkLu0aOGBD9HGTsxgb93rW2xKwgeq RYgrpwAAKOenD9NjgaJAdqe82iMsXKw1y4dBZlO4Fi/9xFhbPng3TuR37aNOF3ohcowm UD6g== X-Forwarded-Encrypted: i=1; AJvYcCU9k+fe3tyCjDyEoJQR6kfSpwMGPmlNlDIVR5B0E981v8FEsFiIbQqRrOWUeailWN+IXA8mTqTy3qyq@nongnu.org X-Gm-Message-State: AOJu0Yyw/b0F2bPK3NVKSaTng4xt1SnUDhvG+fSezngAdc59Z0Oe0Ike oCSNoiHsXwF859y7VH1UlIgfCAJi1wKK5SBVdKu/52LI2Z+SWUnqUOAi8tmNVIU= X-Google-Smtp-Source: AGHT+IFP3PkWOTmS6Yfs+I4pHdst/juWvOVfUswlpq45/bx9bqv9XCB/4UX7PDtb9yLUsKZisaI0Fg== X-Received: by 2002:a05:6a20:d49a:b0:1c4:214c:d885 with SMTP id adf61e73a8af0-1c8eaf6898amr6270387637.36.1723681295231; Wed, 14 Aug 2024 17:21:35 -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 , qemu-devel@nongnu.org Cc: "Hao Xiang" , "Liu, Yuan1" , "Zou, Nanhai" , "Ho-Ren (Jack) Chuang" , "Yichen Wang" , Bryan Zhang Subject: [PATCH v7 4/5] migration: Introduce 'qatzip' compression method Date: Wed, 14 Aug 2024 17:21:23 -0700 Message-Id: <20240815002124.65384-5-yichen.wang@bytedance.com> X-Mailer: git-send-email 2.39.3 (Apple Git-146) In-Reply-To: <20240815002124.65384-1-yichen.wang@bytedance.com> References: <20240815002124.65384-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+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2607:f8b0:4864:20::435; envelope-from=yichen.wang@bytedance.com; helo=mail-pf1-x435.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, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @bytedance.com) X-ZM-MESSAGEID: 1723681358528116600 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 Reviewed-by: Fabiano Rosas --- hw/core/qdev-properties-system.c | 2 +- migration/meson.build | 1 + migration/multifd-qatzip.c | 394 +++++++++++++++++++++++++++++++ migration/multifd.h | 5 +- qapi/migration.json | 3 + 5 files changed, 402 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..3c787ed879 --- /dev/null +++ b/migration/multifd-qatzip.c @@ -0,0 +1,394 @@ +/* + * 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); + + /* + * Initialize QAT device with software fallback by default. This allows + * QATzip to use CPU path when QAT hardware reaches maximum throughput. + */ + 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; + /* + * PINNED_MEM is an enum from qatzip headers, which means to use + * kzalloc_node() to allocate memory for QAT DMA purposes. When QAT de= vice + * is not available or software fallback is used, the malloc flag need= s to + * be set as COMMON_MEM. + */ + q->in_buf =3D qzMalloc(q->in_len, 0, PINNED_MEM); + if (!q->in_buf) { + q->in_buf =3D qzMalloc(q->in_len, 0, COMMON_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) { + q->out_buf =3D qzMalloc(q->out_len, 0, COMMON_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) { + 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); + } + + g_free(p->iov); + p->iov =3D NULL; + 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; + + /* + * Initialize QAT device with software fallback by default. This allows + * QATzip to use CPU path when QAT hardware reaches maximum throughput. + */ + 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. When QAT de= vice + * is not available or software fallback is used, the malloc flag need= s to + * be set as COMMON_MEM. + */ + q->in_buf =3D qzMalloc(q->in_len, 0, PINNED_MEM); + if (!q->in_buf) { + q->in_buf =3D qzMalloc(q->in_len, 0, COMMON_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) { + q->out_buf =3D qzMalloc(q->out_len, 0, COMMON_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) { + 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 279a705cae..dc65f90b44 100644 --- a/qapi/migration.json +++ b/qapi/migration.json @@ -561,6 +561,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 and @@ -573,6 +575,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 --=20 Yichen Wang From nobody Sun Nov 24 09:18:42 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=quarantine dis=none) header.from=bytedance.com ARC-Seal: i=1; a=rsa-sha256; t=1723681371; cv=none; d=zohomail.com; s=zohoarc; b=Scg76pPJ/cQ/+9GJc7AWw0fWE8+g8cp1Ex+smLjTZ9yw5Y0mwO1QyJnMNgRBY0RYNaAnoDlFSjZc018hYMMj0sb1fsO0Tw7GoYG7CjAHkdhDZJNx4xjxmWLZ/qRtUIUpZ/nybryjj7haXxZJiTPGD5X3uF52hevlMb+oB+Daj5Q= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1723681371; 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=70tmt7SXXA8xNV/GOXmAHGlkd6Y3uEXM0oMIn+MfWWk=; b=hpoY3GIjCoFrOjhTPat4wmJkU2Y2KAoJLo/Izev9L5Ojstv7MwQRpVaA/PmHIs2Rbvu0xUWOPG0RSLdicwMfU1wk+NUak9NaiaILRQgD1PWoEBDLbPgXwtgQgUbKzgiVSraPcsMcDmjhEll4VbjqNP4SD9X13VrZ4pjYSMMMc1k= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=quarantine dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 172368137130545.14605776056044; Wed, 14 Aug 2024 17:22:51 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1seOFK-00056I-5i; Wed, 14 Aug 2024 20:21:42 -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 1seOFI-00050J-He for qemu-devel@nongnu.org; Wed, 14 Aug 2024 20:21:40 -0400 Received: from mail-pf1-x42c.google.com ([2607:f8b0:4864:20::42c]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1seOFG-0004HF-Sq for qemu-devel@nongnu.org; Wed, 14 Aug 2024 20:21:40 -0400 Received: by mail-pf1-x42c.google.com with SMTP id d2e1a72fcca58-710ece280b6so312610b3a.2 for ; Wed, 14 Aug 2024 17:21:38 -0700 (PDT) Received: from DY4X0N7X05.bytedance.net ([72.29.204.230]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-201f02faa03sm1961185ad.19.2024.08.14.17.21.35 (version=TLS1_3 cipher=TLS_CHACHA20_POLY1305_SHA256 bits=256/256); Wed, 14 Aug 2024 17:21:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=bytedance.com; s=google; t=1723681297; x=1724286097; 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=70tmt7SXXA8xNV/GOXmAHGlkd6Y3uEXM0oMIn+MfWWk=; b=iHIxtynnJrMF5Y2BEuW4k8tsxIqy03xUQeWOubIq7mOVabANL4rtB4kSaLF3NEvzOh Z6elE+jr+4CyfBVC3gvBTNdYDchrOHYRK6nuZsj3MQcyCnMsSHLuLAFHMCokEI7lIUQ7 nF4IIEvhE4SBNnMV7x/jPWXfeC2ErzaKFWdy5cLvyc17vN5+7jdsEW3Sw0UMPRuG74Hr sBtOFe+gCFSwR2CR9afx54qYpPCtjJ8X1uxeh4zly1ls0NjqH8/b2io49upwr/pWSEWN kzkWRwURnSVk/PFokckS+zQR2CgDx4GdcC7S9AWv9LiPr+11VvT8bGs1lHEftTGVy9py 0aUQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1723681297; x=1724286097; 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=70tmt7SXXA8xNV/GOXmAHGlkd6Y3uEXM0oMIn+MfWWk=; b=Spf3O4VSJBvbz7JHjWck/5kecoz5hlJrHg9CMIr5N/pYxAZvTsQO4iLDxOb8v8+y29 wHzHp5axTKOfZk1/fNupAs11zyI8zO5TVuMH6Br2LOXj2EE2Az2AOLy4GT5uwlrt6emb IjJ7mV7cuHS8NwuBxKbAZqIt4kCDC1eL4xlGyN+BkRyNMjC2A2qm0g3YeJlsfvn+gVlu 75mTAGzDVpX/4Rm11U8WBfwKzCBDvCHgzuOsRiZZK6trylr3qwBF2McpOLChACO8HgAF qeFu5dnKfPaRGpR4z7anktjVtyKlW1VNMzm9jkDgaw2a+7N2aPEEk0CjlSca7Jlkjcht 3Vag== X-Forwarded-Encrypted: i=1; AJvYcCWpae2U7Erqk0A5d+K5KVAyLyKpyeri0u9vcufm3swM5gxz1FJJrMx9gfsoXDDdzVPPkHDm/ACtGozQBTgWnGY6CCxVeus= X-Gm-Message-State: AOJu0YyWkavz0ZehTNK3AJr6VnFVKDdt5LViRTR3jQ70sUlCSQQOx6pi hdsyxIzMSc4DO9XLFxTGaseGWbLrtC23FDZ3+BqqXUBv/yBB92n+iCQm0y/nwRA= X-Google-Smtp-Source: AGHT+IHcFOepqsH/6Q/9F/rNl7zNg+U6jP63+E2fx8QnWHphBOzjOXT1z63hJy2uE17YXxm6B1svVw== X-Received: by 2002:a05:6a20:c6c2:b0:1c6:a83c:d5db with SMTP id adf61e73a8af0-1c8eae97feamr3442947637.31.1723681297382; Wed, 14 Aug 2024 17:21: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 , qemu-devel@nongnu.org Cc: "Hao Xiang" , "Liu, Yuan1" , "Zou, Nanhai" , "Ho-Ren (Jack) Chuang" , "Yichen Wang" , Bryan Zhang Subject: [PATCH v7 5/5] tests/migration: Add integration test for 'qatzip' compression method Date: Wed, 14 Aug 2024 17:21:24 -0700 Message-Id: <20240815002124.65384-6-yichen.wang@bytedance.com> X-Mailer: git-send-email 2.39.3 (Apple Git-146) In-Reply-To: <20240815002124.65384-1-yichen.wang@bytedance.com> References: <20240815002124.65384-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+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2607:f8b0:4864:20::42c; envelope-from=yichen.wang@bytedance.com; helo=mail-pf1-x42c.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, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @bytedance.com) X-ZM-MESSAGEID: 1723681372526116600 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 | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/tests/qtest/migration-test.c b/tests/qtest/migration-test.c index 70b606b888..3aed5441f7 100644 --- a/tests/qtest/migration-test.c +++ b/tests/qtest/migration-test.c @@ -2992,6 +2992,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 +3101,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 +4015,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