[PATCH mptcp-net] mptcp: add missing documented NL params

[PATCH mptcp-net] mptcp: add missing documented NL params

[Matthieu Baerts]

'loc_id' and 'rem_id' are set in all events linked to subflows but those
were missing in the events description in the comments.

Fixes: b911c97c7dc7 ("mptcp: add netlink event support")
Signed-off-by: Matthieu Baerts <matthieu.baerts@tessares.net>
---
 include/uapi/linux/mptcp.h | 18 ++++++++++--------
 1 file changed, 10 insertions(+), 8 deletions(-)

diff --git a/include/uapi/linux/mptcp.h b/include/uapi/linux/mptcp.h
index c8cc46f80a16..f106a3941cdf 100644
--- a/include/uapi/linux/mptcp.h
+++ b/include/uapi/linux/mptcp.h
@@ -136,19 +136,21 @@ struct mptcp_info {
  * MPTCP_EVENT_REMOVED: token, rem_id
  * An address has been lost by the peer.
  *
- * MPTCP_EVENT_SUB_ESTABLISHED: token, family, saddr4 | saddr6,
- *                              daddr4 | daddr6, sport, dport, backup,
- *                              if_idx [, error]
+ * 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, saddr4 | saddr6, daddr4 | daddr6,
- *                         sport, dport, backup, if_idx [, error]
+ * 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, saddr4 | saddr6, daddr4 | daddr6,
- *                           sport, dport, backup, if_idx [, error]
- *       The priority of a subflow has changed. 'error' should not be set.
+ * 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.
  */
 enum mptcp_event_type {
 	MPTCP_EVENT_UNSPEC = 0,
-- 
2.32.0

Re: [PATCH mptcp-net] mptcp: add missing documented NL params

[Mat Martineau]

On Tue, 30 Nov 2021, Matthieu Baerts wrote:

> 'loc_id' and 'rem_id' are set in all events linked to subflows but those
> were missing in the events description in the comments.
>
> Fixes: b911c97c7dc7 ("mptcp: add netlink event support")
> Signed-off-by: Matthieu Baerts <matthieu.baerts@tessares.net>
> ---
> include/uapi/linux/mptcp.h | 18 ++++++++++--------
> 1 file changed, 10 insertions(+), 8 deletions(-)
>

Thanks for the fix Matthieu, looks good to me.

Reviewed-by: Mat Martineau <mathew.j.martineau@linux.intel.com>

> diff --git a/include/uapi/linux/mptcp.h b/include/uapi/linux/mptcp.h
> index c8cc46f80a16..f106a3941cdf 100644
> --- a/include/uapi/linux/mptcp.h
> +++ b/include/uapi/linux/mptcp.h
> @@ -136,19 +136,21 @@ struct mptcp_info {
>  * MPTCP_EVENT_REMOVED: token, rem_id
>  * An address has been lost by the peer.
>  *
> - * MPTCP_EVENT_SUB_ESTABLISHED: token, family, saddr4 | saddr6,
> - *                              daddr4 | daddr6, sport, dport, backup,
> - *                              if_idx [, error]
> + * 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, saddr4 | saddr6, daddr4 | daddr6,
> - *                         sport, dport, backup, if_idx [, error]
> + * 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, saddr4 | saddr6, daddr4 | daddr6,
> - *                           sport, dport, backup, if_idx [, error]
> - *       The priority of a subflow has changed. 'error' should not be set.
> + * 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.
>  */
> enum mptcp_event_type {
> 	MPTCP_EVENT_UNSPEC = 0,
> -- 
> 2.32.0

--
Mat Martineau
Intel

Re: [PATCH mptcp-net] mptcp: add missing documented NL params

[Matthieu Baerts]

Hi Mat,

On 01/12/2021 03:08, Mat Martineau wrote:
> On Tue, 30 Nov 2021, Matthieu Baerts wrote:
> 
>> 'loc_id' and 'rem_id' are set in all events linked to subflows but those
>> were missing in the events description in the comments.
>>
>> Fixes: b911c97c7dc7 ("mptcp: add netlink event support")
>> Signed-off-by: Matthieu Baerts <matthieu.baerts@tessares.net>
>> ---
>> include/uapi/linux/mptcp.h | 18 ++++++++++--------
>> 1 file changed, 10 insertions(+), 8 deletions(-)
>>
> 
> Thanks for the fix Matthieu, looks good to me.
> 
> Reviewed-by: Mat Martineau <mathew.j.martineau@linux.intel.com>

Thank you for the review!

Now in our tree (fix for net but we can send it to net-next if you prefer)

- b5eb1109c9f2: mptcp: add missing documented NL params

- Results: 3851d2148681..afbf49f90abe

Builds and tests are now in progress:



https://cirrus-ci.com/github/multipath-tcp/mptcp_net-next/export/20211202T174706

https://github.com/multipath-tcp/mptcp_net-next/actions/workflows/build-validation.yml?query=branch:export

Cheers,
Matt
-- 
Tessares | Belgium | Hybrid Access Solutions
www.tessares.net