Skip to contentSkip to conversation

Documentation: add description for a couple of sctp sysctl options

PATCH Superseded Xin Long 2 participants 5 messages Jun 3, 2022 – Jun 6, 2022

Subsystems (4)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
author maintainer
#4 lore raw

PATCH 3/3 Documentation: add description for net.sctp.ecn_enable

In reply to Xin Long

Describe it in networking/ip-sysctl.rst like other SCTP options.

Fixes 2f5268a9249b ("sctp: allow users to set netns ecn flag with sysctl")
---
 Documentation/networking/ip-sysctl.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)
Documentation/networking/ip-sysctl.rst +12 -0
index b67f2f83ff32..52ce71aceb5a 100644
@@ -2955,6 +2955,18 @@ intl_enable - BOOLEAN
 
 	Default: 0
 
+ecn_enable - BOOLEAN
+        Control use of Explicit Congestion Notification (ECN) by SCTP.
+        Like in TCP, ECN is used only when both ends of the SCTP connection
+        indicate support for it. This feature is useful in avoiding losses
+        due to congestion by allowing supporting routers to signal congestion
+        before having to drop packets.
+
+        1: Enable ecn.
+        0: Disable ecn.
+
+        Default: 1
+
 
 ``/proc/sys/net/core/*``
 ========================
Signature · 1 line
2.31.1

Xin Long

author maintainer
#0 lore raw

cover Documentation: add description for a couple of sctp sysctl options

These are a couple of sysctl options I recently added, but missed adding documents for them. Especially for net.sctp.intl_enable, it's hard for users to setup stream interleaving, as it also needs to call some socket options.

This patchset is to add documents for them.

Xin Long (3):
Documentation: add description for net.sctp.reconf_enable
Documentation: add description for net.sctp.intl_enable
Documentation: add description for net.sctp.ecn_enable

 Documentation/networking/ip-sysctl.rst | 37 ++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
Signature · 1 line
2.31.1
author maintainer
#2 lore raw

PATCH 2/3 Documentation: add description for net.sctp.intl_enable

Describe it in networking/ip-sysctl.rst like other SCTP options. We need to document this especailly as when using the feature of User Message Interleaving, some socket options also needs to be set.

Fixes 463118c34a35 ("sctp: support sysctl to allow users to use stream interleave")
---
 Documentation/networking/ip-sysctl.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
Documentation/networking/ip-sysctl.rst +14 -0
index 3abd494053a9..b67f2f83ff32 100644
@@ -2941,6 +2941,20 @@ reconf_enable - BOOLEAN
 
 	Default: 0
 
+intl_enable - BOOLEAN
+        Enable or disable extension of User Message Interleaving functionality
+        specified in RFC8260. This extension allow the interleaving of user
+        messages sent on different streams. With this feature enabled, I-DATA
+        chunk will replace DATA chunk to carry user messages. Note that to use
+        this feature, with this option set to 1, we also need socket options
+        SCTP_FRAGMENT_INTERLEAVE set to 2 and SCTP_INTERLEAVING_SUPPORTED set
+        to 1.
+
+	- 1: Enable extension.
+	- 0: Disable extension.
+
+	Default: 0
+
 
 ``/proc/sys/net/core/*``
 ========================
Signature · 1 line
2.31.1
author maintainer
#1 lore raw

PATCH 1/3 Documentation: add description for net.sctp.reconf_enable

In reply to Xin Long

Describe it in networking/ip-sysctl.rst like other SCTP options.

Fixes c0d8bab6ae51 ("sctp: add get and set sockopt for reconf_enable")
---
 Documentation/networking/ip-sysctl.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)
Documentation/networking/ip-sysctl.rst +11 -0
index b882d4238581..3abd494053a9 100644
@@ -2930,6 +2930,17 @@ plpmtud_probe_interval - INTEGER
 
 	Default: 0
 
+reconf_enable - BOOLEAN
+        Enable or disable extension of Stream Reconfiguration functionality
+        specified in RFC6525. This extension provides the ability to "reset"
+        a stream, and it includes the Parameters of "Outgoing/Incoming SSN
+        Reset", "SSN/TSN Reset" and "Add Outgoing/Incoming Streams".
+
+	- 1: Enable extension.
+	- 0: Disable extension.
+
+	Default: 0
+
 
 ``/proc/sys/net/core/*``
 ========================
Signature · 1 line
2.31.1
#3 lore raw

Re: [PATCH net 2/3] Documentation: add description for net.sctp.intl_enable

In reply to Xin Long

Hi,

Quoted 2 lines · Xin Long

Describe it in networking/ip-sysctl.rst like other SCTP options. We need to document this especailly as when using the feature

especially

Quoted 14 lines

of User Message Interleaving, some socket options also needs to be set.

Fixes 463118c34a35 ("sctp: support sysctl to allow users to use stream interleave")
---
 Documentation/networking/ip-sysctl.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
Documentation/networking/ip-sysctl.rst +0 -0
index 3abd494053a9..b67f2f83ff32 100644

Documentation/networking/ip-sysctl.rst reconf_enable - BOOLEAN · line 2946

Quoted 6 lines
Documentation/networking/ip-sysctl.rst +3 -0
@@ -2941,6 +2941,20 @@ reconf_enable - BOOLEAN
 
 	Default: 0
 
+intl_enable - BOOLEAN
+        Enable or disable extension of User Message Interleaving functionality
+        specified in RFC8260. This extension allow the interleaving of user

allows

Documentation/networking/ip-sysctl.rst reconf_enable - BOOLEAN · line 2948

Quoted 2 lines
Documentation/networking/ip-sysctl.rst +2 -0
+        messages sent on different streams. With this feature enabled, I-DATA
+        chunk will replace DATA chunk to carry user messages. Note that to use

.. to carry user messages if also supported by the peer.

Documentation/networking/ip-sysctl.rst reconf_enable - BOOLEAN · line 2951

Quoted 3 lines
Documentation/networking/ip-sysctl.rst +3 -0
+        this feature, with this option set to 1, we also need socket options
+        SCTP_FRAGMENT_INTERLEAVE set to 2 and SCTP_INTERLEAVING_SUPPORTED set
+        to 1.

Perhaps for this last sentence:
Note that to use this feature, one needs to set this option to 1 and also need to set socket options SCTP_FRAGMENT_INTERLEAVE to 2 and SCTP_INTERLEAVING_SUPPORTED to 1.

My only comments on the set. Otherwise LGTM.

Quoted 12 lines
Documentation/networking/ip-sysctl.rst +6 -0
+
+	- 1: Enable extension.
+	- 0: Disable extension.
+
+	Default: 0
+
 
 ``/proc/sys/net/core/*``
 ========================
Signature · 1 line
2.31.1