Commit 1fa9d91e authored by Jakub Kicinski's avatar Jakub Kicinski
Browse files

Merge branch 'netlink-specs-mptcp-fixes-for-some-descriptions' 

Matthieu Baerts says:

====================
netlink: specs: mptcp: fixes for some descriptions

When looking at the MPTCP PM Netlink specs rendered version [1], a few
small issues have been found with the descriptions, and fixed here:

- Patch 1: add a missing attribute for two events. For >= v5.19.

- Patch 2: clearly mention the attributes. For >= v6.7.

- Patch 3: fix missing descriptions and replace a wrong one. For >= v6.7.

Link: https://docs.kernel.org/networking/netlink_spec/mptcp_pm.html [1]

v1: https://lore.kernel.org/20241219-net-mptcp-netlink-specs-pm-doc-fixes-v1-0-825d3b45f27b@kernel.org
====================

Link: https://patch.msgid.link/20241221-net-mptcp-netlink-specs-pm-doc-fixes-v2-0-e54f2db3f844@kernel.org


Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parents b3a69c55 4f363fe9

Documentation/netlink/specs/mptcp_pm.yaml

+31 −29
Original line number Diff line number Diff line
@@ -22,65 +22,67 @@ definitions: 
      doc: unused event

     -

      name: created

      doc:

        token, family, saddr4 | saddr6, daddr4 | daddr6, sport, dport

      doc: >-

        A new MPTCP connection has been created. It is the good time to

        allocate memory and send ADD_ADDR if needed. Depending on the

        traffic-patterns it can take a long time until the

        MPTCP_EVENT_ESTABLISHED is sent.

        Attributes: token, family, saddr4 | saddr6, daddr4 | daddr6, sport,

        dport, server-side.

     -

      name: established

      doc:

        token, family, saddr4 | saddr6, daddr4 | daddr6, sport, dport

      doc: >-

        A MPTCP connection is established (can start new subflows).

        Attributes: token, family, saddr4 | saddr6, daddr4 | daddr6, sport,

        dport, server-side.

     -

      name: closed

      doc:

        token

      doc: >-

        A MPTCP connection has stopped.

        Attribute: token.

     -

      name: announced

      value: 6

      doc:

        token, rem_id, family, daddr4 | daddr6 [, dport]

      doc: >-

        A new address has been announced by the peer.

        Attributes: token, rem_id, family, daddr4 | daddr6 [, dport].

     -

      name: removed

      doc:

        token, rem_id

      doc: >-

        An address has been lost by the peer.

        Attributes: token, rem_id.

     -

      name: sub-established

      value: 10

      doc:

        token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 | daddr6, sport,

        dport, backup, if_idx [, error]

      doc: >-

        A new subflow has been established. 'error' should not be set.

        Attributes: token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 |

        daddr6, sport, dport, backup, if_idx [, error].

     -

      name: sub-closed

      doc:

        token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 | daddr6, sport,

        dport, backup, if_idx [, error]

      doc: >-

        A subflow has been closed. An error (copy of sk_err) could be set if an

        error has been detected for this subflow.

        Attributes: token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 |

        daddr6, sport, dport, backup, if_idx [, error].

     -

      name: sub-priority

      value: 13

      doc:

        token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 | daddr6, sport,

        dport, backup, if_idx [, error]

      doc: >-

        The priority of a subflow has changed. 'error' should not be set.

        Attributes: token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 |

        daddr6, sport, dport, backup, if_idx [, error].

     -

      name: listener-created

      value: 15

      doc:

        family, sport, saddr4 | saddr6

      doc: >-

        A new PM listener is created.

        Attributes: family, sport, saddr4 | saddr6.

     -

      name: listener-closed

      doc:

        family, sport, saddr4 | saddr6

      doc: >-

        A PM listener is closed.

        Attributes: family, sport, saddr4 | saddr6.



attribute-sets:

  -
@@ -307,7 +309,7 @@ operations: 
           - addr

    -

      name: flush-addrs

      doc: flush addresses

      doc: Flush addresses

      attribute-set: endpoint

      dont-validate: [ strict ]

      flags: [ uns-admin-perm ]
@@ -351,7 +353,7 @@ operations: 
            - addr-remote

    -

      name: announce

      doc: announce new sf

      doc: Announce new address

      attribute-set: attr

      dont-validate: [ strict ]

      flags: [ uns-admin-perm ]
@@ -362,7 +364,7 @@ operations: 
            - token

    -

      name: remove

      doc: announce removal

      doc: Announce removal

      attribute-set: attr

      dont-validate: [ strict ]

      flags: [ uns-admin-perm ]
@@ -373,7 +375,7 @@ operations: 
           - loc-id

    -

      name: subflow-create

      doc: todo

      doc: Create subflow

      attribute-set: attr

      dont-validate: [ strict ]

      flags: [ uns-admin-perm ]
@@ -385,7 +387,7 @@ operations: 
            - addr-remote

    -

      name: subflow-destroy

      doc: todo

      doc: Destroy subflow

      attribute-set: attr

      dont-validate: [ strict ]

      flags: [ uns-admin-perm ]

include/uapi/linux/mptcp_pm.h

+26 −24
Original line number Diff line number Diff line
@@ -12,31 +12,33 @@ 
/**

 * enum mptcp_event_type

 * @MPTCP_EVENT_UNSPEC: unused event

 * @MPTCP_EVENT_CREATED: token, family, saddr4 | saddr6, daddr4 | daddr6,

 *   sport, dport A new MPTCP connection has been created. It is the good time

 *   to allocate memory and send ADD_ADDR if needed. Depending on the

 * @MPTCP_EVENT_CREATED: A new MPTCP connection has been created. It is the

 *   good time to allocate memory and send ADD_ADDR if needed. Depending on the

 *   traffic-patterns it can take a long time until the MPTCP_EVENT_ESTABLISHED

 *   is sent.

 * @MPTCP_EVENT_ESTABLISHED: token, family, saddr4 | saddr6, daddr4 | daddr6,

 *   sport, dport A MPTCP connection is established (can start new subflows).

 * @MPTCP_EVENT_CLOSED: token A MPTCP connection has stopped.

 * @MPTCP_EVENT_ANNOUNCED: token, rem_id, family, daddr4 | daddr6 [, dport] A

 *   new address has been announced by the peer.

 * @MPTCP_EVENT_REMOVED: token, rem_id An address has been lost by the peer.

 * @MPTCP_EVENT_SUB_ESTABLISHED: token, family, loc_id, rem_id, saddr4 |

 *   saddr6, daddr4 | daddr6, sport, dport, backup, if_idx [, error] A new

 *   subflow has been established. 'error' should not be set.

 * @MPTCP_EVENT_SUB_CLOSED: token, family, loc_id, rem_id, saddr4 | saddr6,

 *   daddr4 | daddr6, sport, dport, backup, if_idx [, error] A subflow has been

 *   closed. An error (copy of sk_err) could be set if an error has been

 *   detected for this subflow.

 * @MPTCP_EVENT_SUB_PRIORITY: token, family, loc_id, rem_id, saddr4 | saddr6,

 *   daddr4 | daddr6, sport, dport, backup, if_idx [, error] The priority of a

 *   subflow has changed. 'error' should not be set.

 * @MPTCP_EVENT_LISTENER_CREATED: family, sport, saddr4 | saddr6 A new PM

 *   listener is created.

 * @MPTCP_EVENT_LISTENER_CLOSED: family, sport, saddr4 | saddr6 A PM listener

 *   is closed.

 *   is sent. Attributes: token, family, saddr4 | saddr6, daddr4 | daddr6,

 *   sport, dport, server-side.

 * @MPTCP_EVENT_ESTABLISHED: A MPTCP connection is established (can start new

 *   subflows). Attributes: token, family, saddr4 | saddr6, daddr4 | daddr6,

 *   sport, dport, server-side.

 * @MPTCP_EVENT_CLOSED: A MPTCP connection has stopped. Attribute: token.

 * @MPTCP_EVENT_ANNOUNCED: A new address has been announced by the peer.

 *   Attributes: token, rem_id, family, daddr4 | daddr6 [, dport].

 * @MPTCP_EVENT_REMOVED: An address has been lost by the peer. Attributes:

 *   token, rem_id.

 * @MPTCP_EVENT_SUB_ESTABLISHED: A new subflow has been established. 'error'

 *   should not be set. Attributes: token, family, loc_id, rem_id, saddr4 |

 *   saddr6, daddr4 | daddr6, sport, dport, backup, if_idx [, error].

 * @MPTCP_EVENT_SUB_CLOSED: A subflow has been closed. An error (copy of

 *   sk_err) could be set if an error has been detected for this subflow.

 *   Attributes: token, family, loc_id, rem_id, saddr4 | saddr6, daddr4 |

 *   daddr6, sport, dport, backup, if_idx [, error].

 * @MPTCP_EVENT_SUB_PRIORITY: The priority of a subflow has changed. 'error'

 *   should not be set. Attributes: token, family, loc_id, rem_id, saddr4 |

 *   saddr6, daddr4 | daddr6, sport, dport, backup, if_idx [, error].

 * @MPTCP_EVENT_LISTENER_CREATED: A new PM listener is created. Attributes:

 *   family, sport, saddr4 | saddr6.

 * @MPTCP_EVENT_LISTENER_CLOSED: A PM listener is closed. Attributes: family,

 *   sport, saddr4 | saddr6.

 */

enum mptcp_event_type {

	MPTCP_EVENT_UNSPEC,