diff options
author | 2025-07-05 11:08:47 +0800 | |
---|---|---|
committer | 2025-07-06 21:13:41 +0800 | |
commit | 6b818ef57d0140ad96d300dbb0e0c3e372add9ac (patch) | |
tree | 765bbfd6929494498bce5b85670048a4df67b652 | |
parent | Docs/zh_CN: Translate xfrm_proc.rst to Simplified Chinese (diff) | |
download | wireguard-linux-6b818ef57d0140ad96d300dbb0e0c3e372add9ac.tar.xz wireguard-linux-6b818ef57d0140ad96d300dbb0e0c3e372add9ac.zip |
Docs/zh_CN: Translate netmem.rst to Simplified Chinese
translate the "netmem.rst" into Simplified Chinese.
Update the translation through commit 383faec0fd64
("net: enable driver support for netmem TX")
Signed-off-by: Wang Yaxin <wang.yaxin@zte.com.cn>
Signed-off-by: Jiang Kun <jiang.kun2@zte.com.cn>
Reviewed-by: xu xin <xu.xin16@zte.com.cn>
Reviewed-by: Yanteng Si <siyanteng@cqsoftware.com.cn>
Signed-off-by: Alex Shi <alexs@kernel.org>
-rw-r--r-- | Documentation/translations/zh_CN/networking/index.rst | 2 | ||||
-rw-r--r-- | Documentation/translations/zh_CN/networking/netmem.rst | 92 |
2 files changed, 93 insertions, 1 deletions
diff --git a/Documentation/translations/zh_CN/networking/index.rst b/Documentation/translations/zh_CN/networking/index.rst index 61e7600cd5a9..b0c23d11ab3e 100644 --- a/Documentation/translations/zh_CN/networking/index.rst +++ b/Documentation/translations/zh_CN/networking/index.rst @@ -25,6 +25,7 @@ vxlan netif-msg xfrm_proc + netmem Todolist: @@ -103,7 +104,6 @@ Todolist: * netdev-features * netdevices * netfilter-sysctl -* netmem * nexthop-group-resilient * nf_conntrack-sysctl * nf_flowtable diff --git a/Documentation/translations/zh_CN/networking/netmem.rst b/Documentation/translations/zh_CN/networking/netmem.rst new file mode 100644 index 000000000000..fe351a240f02 --- /dev/null +++ b/Documentation/translations/zh_CN/networking/netmem.rst @@ -0,0 +1,92 @@ +.. SPDX-License-Identifier: GPL-2.0 + +.. include:: ../disclaimer-zh_CN.rst + +:Original: Documentation/networking/netmem.rst + +:翻译: + + 王亚鑫 Wang Yaxin <wang.yaxin@zte.com.cn> + +================== +网络驱动支持Netmem +================== + +本文档概述了网络驱动支持netmem(一种抽象内存类型)的要求,该内存类型 +支持设备内存 TCP 等功能。通过支持netmem,驱动可以灵活适配不同底层内 +存类型(如设备内存TCP),且无需或仅需少量修改。 + +Netmem的优势: + +* 灵活性:netmem 可由不同内存类型(如 struct page、DMA-buf)支持, + 使驱动程序能够支持设备内存 TCP 等各种用例。 +* 前瞻性:支持netmem的驱动可无缝适配未来依赖此功能的新特性。 +* 简化开发:驱动通过统一API与netmem交互,无需关注底层内存的实现差异。 + +驱动RX要求 +========== + +1. 驱动必须支持page_pool。 + +2. 驱动必须支持tcp-data-split ethtool选项。 + +3. 驱动必须使用page_pool netmem API处理有效载荷内存。当前netmem API + 与page API一一对应。转换时需要将page API替换为netmem API,并用驱动 + 中的netmem_refs跟踪内存而非 `struct page *`: + + - page_pool_alloc -> page_pool_alloc_netmem + - page_pool_get_dma_addr -> page_pool_get_dma_addr_netmem + - page_pool_put_page -> page_pool_put_netmem + + 目前并非所有页 pageAPI 都有对应的 netmem 等效接口。如果你的驱动程序 + 依赖某个尚未实现的 netmem API,请直接实现并提交至 netdev@邮件列表, + 或联系维护者及 almasrymina@google.com 协助添加该 netmem API。 + +4. 驱动必须设置以下PP_FLAGS: + + - PP_FLAG_DMA_MAP:驱动程序无法对 netmem 执行 DMA 映射。此时驱动 + 程序必须将 DMA 映射操作委托给 page_pool,由其判断何时适合(或不适合) + 进行 DMA 映射。 + - PP_FLAG_DMA_SYNC_DEV:驱动程序无法保证 netmem 的 DMA 地址一定能 + 完成 DMA 同步。此时驱动程序必须将 DMA 同步操作委托给 page_pool,由 + 其判断何时适合(或不适合)进行 DMA 同步。 + - PP_FLAG_ALLOW_UNREADABLE_NETMEM:仅当启用 tcp-data-split 时, + 驱动程序必须显式设置此标志。 + +5. 驱动不得假设netmem可读或基于页。当netmem_address()返回NULL时,表示 +内存不可读。驱动需正确处理不可读的netmem,例如,当netmem_address()返回 +NULL时,避免访问内容。 + + 理想情况下,驱动程序不应通过netmem_is_net_iov()等辅助函数检查底层 + netmem 类型,也不应通过netmem_to_page()或netmem_to_net_iov()将 + netmem 转换为其底层类型。在大多数情况下,系统会提供抽象这些复杂性的 + netmem 或 page_pool 辅助函数(并可根据需要添加更多)。 + +6. 驱动程序必须使用page_pool_dma_sync_netmem_for_cpu()代替dma_sync_single_range_for_cpu()。 +对于某些内存提供者,CPU 的 DMA 同步将由 page_pool 完成;而对于其他提供者 +(特别是 dmabuf 内存提供者),CPU 的 DMA 同步由使用 dmabuf API 的用户空 +间负责。驱动程序必须将整个 DMA 同步操作委托给 page_pool,以确保操作正确执行。 + +7. 避免在 page_pool 之上实现特定于驱动程序内存回收机制。由于 netmem 可能 +不由struct page支持,驱动程序不能保留struct page来进行自定义回收。不过, +可为此目的通过page_pool_fragment_netmem()或page_pool_ref_netmem()保留 +page_pool 引用,但需注意某些 netmem 类型的循环时间可能更长(例如零拷贝场景 +下用户空间持有引用的情况)。 + +驱动TX要求 +========== + +1. 驱动程序绝对不能直接把 netmem 的 dma_addr 传递给任何 dma-mapping API。这 +是由于 netmem 的 dma_addr 可能源自 dma-buf 这类和 dma-mapping API 不兼容的 +源头。 + +应当使用netmem_dma_unmap_page_attrs()和netmem_dma_unmap_addr_set()等辅助 +函数来替代dma_unmap_page[_attrs]()、dma_unmap_addr_set()。不管 dma_addr +来源如何,netmem 的这些变体都能正确处理 netmem dma_addr,在合适的时候会委托给 +dma-mapping API 去处理。 + +目前,并非所有的 dma-mapping API 都有对应的 netmem 版本。要是你的驱动程序需要 +使用某个还不存在的 netmem API,你可以自行添加并提交到 netdev@,也可以联系维护 +人员或者发送邮件至 almasrymina@google.com 寻求帮助。 + +2. 驱动程序应通过设置 netdev->netmem_tx = true 来表明自身支持 netmem 功能。 |