Skip to contentSkip to conversation

docs: net: document guidance of implementing the SR-IOV NDOs

PATCH Applied Jakub Kicinski 4 participants 4 messages Jun 20, 2024 – Jun 21, 2024

Subsystems (3)
lore
Share & tools
lore

Jakub Kicinski

author maintainer
#0 lore raw

PATCH v2 1/1 docs: net: document guidance of implementing the SR-IOV NDOs

New drivers were prevented from adding ndo_set_vf_* callbacks over the last few years. This was expected to result in broader switchdev adoption, but seems to have had little effect.

Based on recent netdev meeting there is broad support for allowing adding those ops.

There is a problem with the current API supporting a limited number of VFs (100+, which is less than some modern HW supports). We can try to solve it by adding similar functionality on devlink ports, but that'd be another API variation to maintain. So a netlink attribute reshuffling is a more likely outcome.

Document the guidance, make it clear that the API is frozen.

---
v2:
- edits from Randy
v1: https://lore.kernel.org/all/[email protected]/

---
 Documentation/networking/index.rst |  1 +
 Documentation/networking/sriov.rst | 25 +++++++++++++++++++++++++
 2 files changed, 26 insertions(+)
 create mode 100644 Documentation/networking/sriov.rst
Documentation/networking/index.rst +1 -0
index a6443851a142..b4b2a002f183 100644
@@ -105,6 +105,7 @@ Refer to :ref:`netdev-FAQ` for a guide on netdev development process specifics.
    seg6-sysctl
    skbuff
    smc-sysctl
+   sriov
    statistics
    strparser
    switchdev
Documentation/networking/sriov.rst new file +25 -0
new file mode 100644
index 000000000000..5deb4ff3154f
@@ -0,0 +1,25 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+===============
+NIC SR-IOV APIs
+===============
+
+Modern NICs are strongly encouraged to focus on implementing the ``switchdev``
+model (see :ref:`switchdev`) to configure forwarding and security of SR-IOV
+functionality.
+
+Legacy API
+==========
+
+The old SR-IOV API is implemented in ``rtnetlink`` Netlink family as part of
+the ``RTM_GETLINK`` and ``RTM_SETLINK`` commands. On the driver side
+it consists of a number of ``ndo_set_vf_*`` and ``ndo_get_vf_*`` callbacks.
+
+Since the legacy APIs do not integrate well with the rest of the stack
+the API is considered frozen; no new functionality or extensions
+will be accepted. New drivers should not implement the uncommon callbacks;
+namely the following callbacks are off limits:
+
+ - ``ndo_get_vf_port``
+ - ``ndo_set_vf_port``
+ - ``ndo_set_vf_rss_query_en``
Signature · 1 line
2.45.2
reviewer Reviewed-by on v2 1/1
#1 lore raw
Quoted 21 lines · Jakub Kicinski

New drivers were prevented from adding ndo_set_vf_* callbacks over the last few years. This was expected to result in broader switchdev adoption, but seems to have had little effect.

Based on recent netdev meeting there is broad support for allowing adding those ops.

There is a problem with the current API supporting a limited number of VFs (100+, which is less than some modern HW supports). We can try to solve it by adding similar functionality on devlink ports, but that'd be another API variation to maintain. So a netlink attribute reshuffling is a more likely outcome.

Document the guidance, make it clear that the API is frozen.

---
v2:
- edits from Randy
v1: https://lore.kernel.org/all/[email protected]/

Quoted 8 lines
---
 Documentation/networking/index.rst |  1 +
 Documentation/networking/sriov.rst | 25 +++++++++++++++++++++++++
 2 files changed, 26 insertions(+)
 create mode 100644 Documentation/networking/sriov.rst

Thanks.

Signature · 1 line
~Randy
reviewer Reviewed-by on v2 1/1
#2 lore raw
In reply to Jakub Kicinski
Quoted 13 lines · Jakub Kicinski

New drivers were prevented from adding ndo_set_vf_* callbacks over the last few years. This was expected to result in broader switchdev adoption, but seems to have had little effect.

Based on recent netdev meeting there is broad support for allowing adding those ops.

There is a problem with the current API supporting a limited number of VFs (100+, which is less than some modern HW supports). We can try to solve it by adding similar functionality on devlink ports, but that'd be another API variation to maintain. So a netlink attribute reshuffling is a more likely outcome.

Quoted 3 lines

Document the guidance, make it clear that the API is frozen.

Thanks Jakub,

This is as was discussed at the public netdev call the other day [1]. And a change I supported in that meeting.

[1] https://lore.kernel.org/netdev/[email protected]/

#3 lore raw
In reply to Jakub Kicinski
This patch was applied to netdev/net-next.git (main) by David S. Miller <[email protected]>:

Hello:

This patch was applied to netdev/net-next.git (main) by David S. Miller <[email protected]>:

Quoted 8 lines · On Wed, 19 Jun 2024 17:27:41 -0700 you wrote:

New drivers were prevented from adding ndo_set_vf_* callbacks over the last few years. This was expected to result in broader switchdev adoption, but seems to have had little effect.

Based on recent netdev meeting there is broad support for allowing adding those ops.

[...]

Here is the summary with links:
- [net-next,v2] docs: net: document guidance of implementing the SR-IOV NDOs

    https://git.kernel.org/netdev/net-next/c/4558645d139c

You are awesome, thank you!

Signature · 2 lines
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html