Skip to content

Commit 4d4e1b5

Browse files
committed
doc/radosgw: edit uadk-accel.rst
Incorporate Anthony D'Atri's suggested changes from ceph#60953 into doc/radosgw/uadk-accel.rst. Two questions from that PR remain unclear to me: one is about whether IOMMU should be disabled for performance on AMD EPYC systems, and the other is about UADK. The note about UADK will be rewritten in improved English in a near-future PR and any remaining technical questions that involve it can be discussed in that PR. Signed-off-by: Zac Dover <[email protected]>
1 parent 4b6a1eb commit 4d4e1b5

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

doc/radosgw/uadk-accel.rst

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ See `Compressor UADK Support`_.
1212
UADK in the Software Stack
1313
==========================
1414

15-
UADK is a general-purpose user space accelerator framework that uses shared
16-
virtual addressing (SVA) to provide a unified programming interface for hardware
17-
acceleration of cryptographic and compression algorithms.
15+
UADK is a general-purpose user space accelerator framework that uses Shared
16+
Virtual Addressing (SVA) to provide a unified programming interface for
17+
hardware acceleration of cryptographic and compression algorithms.
1818

1919
UADK includes Unified/User-space-access-intended Accelerator Framework (UACCE),
2020
which enables hardware accelerators that support SVA to adapt to UADK.
@@ -77,11 +77,12 @@ Configuration
7777

7878
#. Kernel Requirement
7979

80-
Users need to ensure that UACCE is supported by the Linux kernel release in
81-
use, which should be 5.9 or later with SVA (Shared Virtual Addressing) enabled.
80+
Users must ensure that UACCE is supported by the Linux kernel release in use,
81+
which should be 5.9 or later with SVA (Shared Virtual Addressing) enabled.
8282

83-
UACCE may be built as a module or built into the kernel. Here's an example to
84-
build UACCE with hardware accelerators for the HiSilicon Kunpeng platform.
83+
UACCE may be built as a loadable module or built into the kernel. Here's an
84+
example to build UACCE with hardware accelerators for the HiSilicon Kunpeng
85+
platform.
8586

8687
.. prompt:: bash $
8788

@@ -97,9 +98,9 @@ build UACCE with hardware accelerators for the HiSilicon Kunpeng platform.
9798
Make sure all these above kernel configurations are selected.
9899

99100
#. UADK enablement
100-
If the architecture is aarch64, it will automatically download the UADK source
101-
code to build the static library. If it runs on other architecture, user can
102-
enable it with build parameters `-DWITH_UADK=true`
101+
If the architecture is ``aarch64``, it will automatically download the UADK
102+
source code to build the static library. If it runs on other architecture, user
103+
can enable it with build parameters `-DWITH_UADK=true`
103104

104105
#. Manual Build UADK
105106
As the above paragraph shows, the UADK is enabled automatically, no need to build manually.
@@ -115,9 +116,9 @@ For developer who is interested in UADK, you can refer to the below steps for bu
115116
make
116117
make install
117118

118-
.. note:: Without prefix, UADK will be installed to ``/usr/local/lib`` by
119-
default. If you get the error: ``cannot find -lnuma``, install the
120-
``libnuma-dev`` package.
119+
.. note:: Without --prefix, UADK will be installed under ``/usr/local/lib``
120+
by default. If you get the error: ``cannot find -lnuma``,
121+
install the ``libnuma-dev`` package.
121122

122123
#. Configure
123124

0 commit comments

Comments
 (0)