devel/migration/qatzip-compression.rst

21    |-----------|--------|---------|----------|----------|------|------|
24    |-----------|--------|---------|----------|----------|------|------|
26    |-----------|--------|---------|----------|----------|------|------|
28    |-----------|--------|---------|----------|----------|------|------|
30    |-----------|--------|---------|----------|----------|------|------|
41 <https://github.com/intel/QATzip?tab=readme-ov-file#introductionl>`_
45   +----------------+
47   +-------+--------+
50   +-------+--------+
52   +-------+--------+
54   +-------+--------+
56   +-------+--------+
58   --------+---------------------
60    +------+-------+
62    +------+-------+
64    +------+-------+
66    +--------------+
70 -------------------
73 distributions and can be installed directly. For example, the Ubuntu Server
74 24.04 LTS system can be installed using below command
76 .. code-block:: shell
79    libqatzip-dev/noble 1.2.0-0ubuntu3 amd64
82    libqatzip3/noble 1.2.0-0ubuntu3 amd64
85    qatzip/noble,now 1.2.0-0ubuntu3 amd64 [installed]
86      Compression user-space tool for Intel QuickAssist Technology
88    #sudo apt install libqatzip-dev libqatzip3 qatzip
90 If your system does not support the ``QATzip`` installation package, you can
91 use the source code to build and install, please refer to `QATzip source code installation
92 <https://github.com/intel/QATzip?tab=readme-ov-file#build-intel-quickassist-technology-driver>`_
95 -----------------------
103 For more ``QAT`` hardware introduction, please refer to `intel-quick-assist-technology-overview
104 <https://www.intel.com/content/www/us/en/architecture-and-technology/intel-quick-assist-technology-…
109 1 - Install ``QATzip`` library
111 2 - Build ``QEMU`` with ``--enable-qatzip`` parameter
113   E.g. configure --target-list=x86_64-softmmu --enable-kvm ``--enable-qatzip``
115 3 - Set ``migrate_set_parameter multifd-compression qatzip``
117 4 - Set ``migrate_set_parameter multifd-qatzip-level comp_level``, the default
123 The user needs to reserve system memory for the QAT memory management to
124 allocate DMA memory. The size of the reserved system memory depends on the
132 .. list-table:: An example of a PF used for migration
133   :header-rows: 1
135   * - Number of channels
136     - Sender memory usage
137     - Receiver memory usage
138   * - 2
139     - 10M
140     - 10M
141   * - 4
142     - 12M
143     - 14M
144   * - 8
145     - 16M
146     - 20M
151 processor(``SPR``), multiple built-in accelerators are supported including
157 1 - If the live migration scenario is limited by network bandwidth and ``QAT``
161 2 - If the system cannot support shared virtual memory (SVM) technology, use
165 3 - For other scenarios, use the ``QPL`` method first.