devel/migration/uadk-compression.rst

4 UADK is a general-purpose user space accelerator framework that uses shared
8 UADK includes Unified/User-space-access-intended Accelerator Framework (UACCE),
24 different character devices with UACCE by using kernel-mode drivers of the
25 vendors. A user can access the hardware accelerators by performing user-mode
26 operations on the character devices.
30           +----------------------------------+
32           +----+------------------------+----+
35        +-------+--------+       +-------+-------+
37        +-------+--------+       +-------+-------+
41                |                +--------+------+
43                |                +-+-------------+
46             +--+------------------+--+
48     User    +----+-------------+-----+
49     --------------------------------------------------
50     Kernel    +--+-----+   +------+
52               +---+----+   +------+
54               +---+------------------+
56               +----------------------+
57     --------------------------------------------------
58              +----------------------+
60              +----------------------+
63 -----------------
64 Build UADK
67 .. code-block:: shell
71     mkdir build
73     ./configure --prefix=$PWD/build
77 Without --prefix, UADK will be installed to /usr/local/lib by default.
78 If get error:"cannot find -lnuma", please install the libnuma-dev
80 Run pkg-config libwd to ensure env is setup correctly
83 * export PKG_CONFIG_PATH=$PWD/build/lib/pkgconfig
84 * pkg-config libwd --cflags --libs
85   -I/usr/local/include -L/usr/local/lib -lwd
91 -----------------------------
99 ``UACCE`` could be built as module or built-in.
116 --------------------------------
118 UADK and char devices are created in dev directory. In order to access resources
119 on hardware accelerator devices, write permission should be provided to user.
121 .. code-block:: shell
123     $ sudo chmod 777 /dev/hisi_zip-*
126 ---------------------------------------------
128 * Build ``QEMU`` with ``--enable-uadk`` parameter
130   E.g. configure --target-list=aarch64-softmmu --enable-kvm ``--enable-uadk``
134   Set ``migrate_set_parameter multifd-compression uadk``
139 please make sure to specify ``-mem-prealloc`` parameter to the destination VM