[PATCH net 0/3] Documentation: add description for a couple of sctp sysctl options

[PATCH net 0/3] Documentation: add description for a couple of sctp sysctl options

[Xin Long]

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(+)

-- 
2.31.1

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

[Xin Long]

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

Fixes: c0d8bab6ae51 ("sctp: add get and set sockopt for reconf_enable")
Signed-off-by: Xin Long <lucien.xin@gmail.com>
---
 Documentation/networking/ip-sysctl.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/Documentation/networking/ip-sysctl.rst b/Documentation/networking/ip-sysctl.rst
index b882d4238581..3abd494053a9 100644
--- a/Documentation/networking/ip-sysctl.rst
+++ b/Documentation/networking/ip-sysctl.rst
@@ -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/*``
 ========================
-- 
2.31.1

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

[Xin Long]

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")
Signed-off-by: Xin Long <lucien.xin@gmail.com>
---
 Documentation/networking/ip-sysctl.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/Documentation/networking/ip-sysctl.rst b/Documentation/networking/ip-sysctl.rst
index 3abd494053a9..b67f2f83ff32 100644
--- a/Documentation/networking/ip-sysctl.rst
+++ b/Documentation/networking/ip-sysctl.rst
@@ -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/*``
 ========================
-- 
2.31.1

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

[Marcelo Ricardo Leitner]

Hi,

On Fri, Jun 03, 2022 at 02:09:24PM -0400, Xin Long wrote:
> Describe it in networking/ip-sysctl.rst like other SCTP options.
> We need to document this especailly as when using the feature
                           especially

> of User Message Interleaving, some socket options also needs
> to be set.
> 
> Fixes: 463118c34a35 ("sctp: support sysctl to allow users to use stream interleave")
> Signed-off-by: Xin Long <lucien.xin@gmail.com>
> ---
>  Documentation/networking/ip-sysctl.rst | 14 ++++++++++++++
>  1 file changed, 14 insertions(+)
> 
> diff --git a/Documentation/networking/ip-sysctl.rst b/Documentation/networking/ip-sysctl.rst
> index 3abd494053a9..b67f2f83ff32 100644
> --- a/Documentation/networking/ip-sysctl.rst
> +++ b/Documentation/networking/ip-sysctl.rst
> @@ -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

> +        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.

> +        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.

> +
> +	- 1: Enable extension.
> +	- 0: Disable extension.
> +
> +	Default: 0
> +
>  
>  ``/proc/sys/net/core/*``
>  ========================
> -- 
> 2.31.1
> 

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

[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")
Signed-off-by: Xin Long <lucien.xin@gmail.com>
---
 Documentation/networking/ip-sysctl.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/Documentation/networking/ip-sysctl.rst b/Documentation/networking/ip-sysctl.rst
index b67f2f83ff32..52ce71aceb5a 100644
--- a/Documentation/networking/ip-sysctl.rst
+++ b/Documentation/networking/ip-sysctl.rst
@@ -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/*``
 ========================
-- 
2.31.1