Documentation: networking: Clarify switchdev devices behavior
Subsystems (4)
PATCH v2 1/1 Documentation: networking: Clarify switchdev devices behavior
This patch provides details on the expected behavior of switchdev enabled network devices when operating in a "stand alone" mode, as well as when being bridge members. This clarifies a number of things that recently came up during a bug fixing session on the b53 DSA switch driver.
---
Changes in v2:
- clarified a few parts about VLAN devices wrt. VLAN filtering and their behavior during enslaving.
Ido, hopefully this captures correctly what we just talked about this morning. Thanks!
Documentation/networking/switchdev.txt | 95 ++++++++++++++++++++++++++ 1 file changed, 95 insertions(+)
Documentation/networking/switchdev.txt +95 -0
@@ -392,3 +392,98 @@ switchdev_trans_item_dequeue() If a transaction is aborted during "prepare" phase, switchdev code will handle cleanup of the queued-up objects. + +Switchdev enabled network device expected behavior +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Below is a set of defined behavior that switchdev enabled network device must be +adhering to. + +Configuration less state +------------------------ + +Upon driver bring up, the network devices must be fully operational, and the +backing driver must be configuring the network device such that it is possible +to send and receive to this network device such that it is properly separate +from other network devices/ports (e.g: as is frequently with a switch ASIC). +How this is achieved is heavily hardware dependent, but a simple solution can +be to use per-port VLAN identifiers unless a better mechanism is available +(proprietary metadata for each network ports for instance). + +The network device must be capable of running a full IP protocol stack must be +working, including multicast, DHCP, IPv4/6, etc. If necessary, it should be +programming the appropriate filters for VLAN, multicast, unicast etc. The +underlying device driver must effectively be configured in a similar fashion to +what it would do when IGMP snooping is enabled for IP multicast over these +switchdev network devices and unsollicited multicast must be filtered as early +as possible into the hardware. + +When configuring VLANs on top of the network device, all VLANs must be working, +irrespective of the state of other network devices (e.g: other ports being part +of a VLAN aware bridge doing ingress VID checking). See below for details. + +Bridged network devices +----------------------- + +When a switchdev enabled network device is added as a bridge member, it should +not be disrupting any functionality of non-bridged network devices and they +should continue to behave as normal network devices. Depending on the bridge +configuration knobs below, the expected behavior is documented. + +VLAN filtering +~~~~~~~~~~~~~~ + +The Linux bridge allows the configuration of a VLAN filtering mode (compile and +run time) which must be observed by the underlying switchdev network +device/hardware: + +- with VLAN filtering turned off: frames ingressing the device with a VID that + is not programmed into the bridge/switch's VLAN table must be forwarded. + +- with VLAN filtering turned on: frames ingressing the device with a VID that is + not programmed into the bridges/switch's VLAN table must be dropped. + +Non-bridged network ports of the same switch fabric must not be disturbed in any +way, shape or form by the enabling of VLAN filtering. + +VLAN devices configured on top of a switchdev network device (e.g: sw0p1.100) +which is a bridge port member must also observe the following behavior: + +- with VLAN filtering turned off, these VLAN devices must be fully functional + since the hardware is allowed VID frames. Enslaving VLAN devices into the + bridge might be allowed provided that there is sufficient separatation using + e.g: a reserved VLAN ID (4095 for instance) for untagged traffic. + +- with VLAN filtering turned on, these VLAN devices should not be allowed to + be created because they duplicate functionality/use case with the bridge's + VLAN functionality. + +Because VLAN filtering can be turned on/off at runtime, the switchdev driver +must be able to re-configure the underlying hardware on the fly to honor the +toggling of that option and behave appropriately. + +A switchdev driver can also refuse to support dynamic toggling of the VLAN +filtering knob at runtime and require a destruction of the bridge device(s) and +a creation of new bridge device(s) with a different VLAN filtering value to +ensure VLAN awareness is pushed down to the HW. + +IGMP snooping +~~~~~~~~~~~~~ + +The Linux bridge allows the configuration of IGMP snooping (compile and run +time) which must be observed by the underlying switchdev network device/hardware +in the following way: + +- when IGMP snooping is turned off, multicast traffic must be flooded to all + switch ports within the same broadcast domain, including the CPU/management + port of the switch (if handled separately). + +- when IGMP snooping is turned on, multicast traffic must be selectively flowing + to the appropriate network ports and not flood the entire switch, that must + include the CPU/management port. + +Because IGMP snooping can be turned on/off at runtime, the switchdev driver must +be able to re-configure the underlying hardware on the fly to honor the toggling +of that option and behave appropriately. + +Similarly to VLAN filtering, if dynamic toggling of the IGMP snooping
Signature · 1 line
2.17.1
Randy Dunlap
reviewerHi,
Comments below.
Quoted 24 lines · Florian Fainelli
This patch provides details on the expected behavior of switchdev enabled network devices when operating in a "stand alone" mode, as well as when being bridge members. This clarifies a number of things that recently came up during a bug fixing session on the b53 DSA switch driver.
Signed-off-by Florian Fainelli <[email protected]>---
Changes in v2:- clarified a few parts about VLAN devices wrt. VLAN filtering and their behavior during enslaving.
Ido, hopefully this captures correctly what we just talked about this morning. Thanks!
Documentation/networking/switchdev.txt | 95 ++++++++++++++++++++++++++ 1 file changed, 95 insertions(+)Documentation/networking/switchdev.txt +0
-0
Documentation/networking/switchdev.txt switchdev_trans_item_dequeue() · line 399
Quoted 8 lines
Documentation/networking/switchdev.txt +5
-0@@ -392,3 +392,98 @@ switchdev_trans_item_dequeue() If a transaction is aborted during "prepare" phase, switchdev code will handle cleanup of the queued-up objects. + +Switchdev enabled network device expected behavior +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Below is a set of defined behavior that switchdev enabled network device must be
devices must
Documentation/networking/switchdev.txt switchdev_trans_item_dequeue() · line 400
Quoted 1 line
Documentation/networking/switchdev.txt +1
-0+adhering to.
adhere to.
Documentation/networking/switchdev.txt switchdev_trans_item_dequeue() · line 406
Quoted 6 lines
Documentation/networking/switchdev.txt +6
-0+ +Configuration less state +------------------------ + +Upon driver bring up, the network devices must be fully operational, and the +backing driver must be configuring the network device such that it is possible
must configure the
Documentation/networking/switchdev.txt switchdev_trans_item_dequeue() · line 408
Quoted 2 lines
Documentation/networking/switchdev.txt +2
-0+to send and receive to this network device such that it is properly separate +from other network devices/ports (e.g: as is frequently with a switch ASIC).
(e.g.:
Documentation/networking/switchdev.txt switchdev_trans_item_dequeue() · line 411
Quoted 3 lines
Documentation/networking/switchdev.txt +3
-0+How this is achieved is heavily hardware dependent, but a simple solution can +be to use per-port VLAN identifiers unless a better mechanism is available +(proprietary metadata for each network ports for instance).
port
Documentation/networking/switchdev.txt switchdev_trans_item_dequeue() · line 414
Quoted 3 lines
Documentation/networking/switchdev.txt +3
-0+ +The network device must be capable of running a full IP protocol stack must be +working, including multicast, DHCP, IPv4/6, etc. If necessary, it should be
garbled? too many verb phrases.
Documentation/networking/switchdev.txt switchdev_trans_item_dequeue() · line 418
Quoted 4 lines
Documentation/networking/switchdev.txt +4
-0+programming the appropriate filters for VLAN, multicast, unicast etc. The +underlying device driver must effectively be configured in a similar fashion to +what it would do when IGMP snooping is enabled for IP multicast over these +switchdev network devices and unsollicited multicast must be filtered as early
unsolicited
Documentation/networking/switchdev.txt switchdev_trans_item_dequeue() · line 422
Quoted 4 lines
Documentation/networking/switchdev.txt +4
-0+as possible into the hardware. + +When configuring VLANs on top of the network device, all VLANs must be working, +irrespective of the state of other network devices (e.g: other ports being part
(e.g.:
Documentation/networking/switchdev.txt switchdev_trans_item_dequeue() · line 429
Quoted 7 lines
Documentation/networking/switchdev.txt +7
-0+of a VLAN aware bridge doing ingress VID checking). See below for details. + +Bridged network devices +----------------------- + +When a switchdev enabled network device is added as a bridge member, it should +not be disrupting any functionality of non-bridged network devices and they
not disrupt any
Quoted 15 lines
Documentation/networking/switchdev.txt +15
-0+should continue to behave as normal network devices. Depending on the bridge +configuration knobs below, the expected behavior is documented. + +VLAN filtering +~~~~~~~~~~~~~~ + +The Linux bridge allows the configuration of a VLAN filtering mode (compile and +run time) which must be observed by the underlying switchdev network +device/hardware: + +- with VLAN filtering turned off: frames ingressing the device with a VID that + is not programmed into the bridge/switch's VLAN table must be forwarded. + +- with VLAN filtering turned on: frames ingressing the device with a VID that is + not programmed into the bridges/switch's VLAN table must be dropped.
Documentation/networking/switchdev.txt switchdev_trans_item_dequeue() · line 454
Quoted 10 lines
Documentation/networking/switchdev.txt +10
-0+ +Non-bridged network ports of the same switch fabric must not be disturbed in any +way, shape or form by the enabling of VLAN filtering. + +VLAN devices configured on top of a switchdev network device (e.g: sw0p1.100) +which is a bridge port member must also observe the following behavior: + +- with VLAN filtering turned off, these VLAN devices must be fully functional + since the hardware is allowed VID frames. Enslaving VLAN devices into the + bridge might be allowed provided that there is sufficient separatation using
separation
Documentation/networking/switchdev.txt switchdev_trans_item_dequeue() · line 455
Quoted 1 line
Documentation/networking/switchdev.txt +1
-0+ e.g: a reserved VLAN ID (4095 for instance) for untagged traffic.
e.g.:
Quoted 16 lines
Documentation/networking/switchdev.txt +16
-0+ +- with VLAN filtering turned on, these VLAN devices should not be allowed to + be created because they duplicate functionality/use case with the bridge's + VLAN functionality. + +Because VLAN filtering can be turned on/off at runtime, the switchdev driver +must be able to re-configure the underlying hardware on the fly to honor the +toggling of that option and behave appropriately. + +A switchdev driver can also refuse to support dynamic toggling of the VLAN +filtering knob at runtime and require a destruction of the bridge device(s) and +a creation of new bridge device(s) with a different VLAN filtering value to +ensure VLAN awareness is pushed down to the HW. + +IGMP snooping +~~~~~~~~~~~~~
Documentation/networking/switchdev.txt switchdev_trans_item_dequeue() · line 481
Quoted 10 lines
Documentation/networking/switchdev.txt +10
-0+ +The Linux bridge allows the configuration of IGMP snooping (compile and run +time) which must be observed by the underlying switchdev network device/hardware +in the following way: + +- when IGMP snooping is turned off, multicast traffic must be flooded to all + switch ports within the same broadcast domain, including the CPU/management + port of the switch (if handled separately). + +- when IGMP snooping is turned on, multicast traffic must be selectively flowing
must selectively flow
Documentation/networking/switchdev.txt switchdev_trans_item_dequeue() · line 489
Quoted 9 lines
Documentation/networking/switchdev.txt +8
-0+ to the appropriate network ports and not flood the entire switch, that must + include the CPU/management port. + +Because IGMP snooping can be turned on/off at runtime, the switchdev driver must +be able to re-configure the underlying hardware on the fly to honor the toggling +of that option and behave appropriately. + +Similarly to VLAN filtering, if dynamic toggling of the IGMP snooping
missing something here??
thanks.
Signature · 1 line
~Randy
Quoted 4 lines · Florian Fainelli
Documentation/networking/switchdev.txt +4
-0+A switchdev driver can also refuse to support dynamic toggling of the VLAN +filtering knob at runtime and require a destruction of the bridge device(s) and +a creation of new bridge device(s) with a different VLAN filtering value to +ensure VLAN awareness is pushed down to the HW.
...
Quoted 1 line
+Similarly to VLAN filtering, if dynamic toggling of the IGMP snooping
I think you meant to continue this sentence with something about vetoing the operation. Note that it is not currently possible as br_mc_disabled_update() returns void. Can be extended if needed.
Quoted 3 lines
Signature · 1 line
2.17.1
Le 1/4/19 à 5:58 AM, Ido Schimmel a écrit :
Quoted 8 lines · Florian Fainelli
Quoted 4 lines
Documentation/networking/switchdev.txt +4
-0+A switchdev driver can also refuse to support dynamic toggling of the VLAN +filtering knob at runtime and require a destruction of the bridge device(s) and +a creation of new bridge device(s) with a different VLAN filtering value to +ensure VLAN awareness is pushed down to the HW....
Quoted 5 lines
Quoted 1 line
+Similarly to VLAN filtering, if dynamic toggling of the IGMP snooping
I think you meant to continue this sentence with something about vetoing the operation. Note that it is not currently possible as
br_mc_disabled_update()returns void. Can be extended if needed.
Yes, that's what I meant, that change is queued in my local branch right now which will get submitted once net-next open backs again.
Thanks!
Signature · 1 line
Florian