netlink/specs/mptcp_pm.yaml

1 # SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)
4 protocol: genetlink-legacy
7 c-family-name: mptcp-pm-name
8 c-version-name: mptcp-pm-ver
9 max-by-define: true
10 kernel-policy: per-op
11 cmd-cnt-name: --mptcp-pm-cmd-after-last
14   -
16     name: event-type
17     enum-name: mptcp-event-type
18     name-prefix: mptcp-event-
20      -
23      -
29         traffic-patterns it can take a long time until the
31      -
36      -
41      -
47      -
52      -
53       name: sub-established
58         A new subflow has been established. 'error' should not be set.
59      -
60       name: sub-closed
64         A subflow has been closed. An error (copy of sk_err) could be set if an
66      -
67       name: sub-priority
72         The priority of a subflow has changed. 'error' should not be set.
73      -
74       name: listener-created
79      -
80       name: listener-closed
85 attribute-sets:
86   -
88     name-prefix: mptcp-pm-addr-attr-
90       -
94       -
97       -
100       -
103         byte-order: big-endian
104       -
108           exact-len: 16
109       -
112         byte-order: big-endian
113       -
116       -
117         name: if-idx
119   -
120     name: subflow-attribute
121     name-prefix: mptcp-subflow-attr-
123       -
127       -
128         name: token-rem
130       -
131         name: token-loc
133       -
134         name: relwrite-seq
136       -
137         name: map-seq
139       -
140         name: map-sfseq
142       -
143         name: ssn-offset
145       -
146         name: map-datalen
148       -
151       -
152         name: id-rem
154       -
155         name: id-loc
157       -
160   -
162     name-prefix: mptcp-pm-endpoint-
164       -
167         nested-attributes: address
168   -
170     name-prefix: mptcp-pm-attr-
171     attr-cnt-name: --mptcp-attr-after-last
173       -
177       -
180         nested-attributes: address
181       -
182         name: rcv-add-addrs
184       -
187       -
190       -
191         name: loc-id
193       -
194         name: addr-remote
196         nested-attributes: address
197   -
198     name: event-attr
199     enum-name: mptcp-event-attr
200     name-prefix: mptcp-attr-
202       -
206       -
209       -
212       -
213         name: loc-id
215       -
216         name: rem-id
218       -
221         byte-order: big-endian
222       -
226           min-len: 16
227       -
230         byte-order: big-endian
231       -
235           min-len: 16
236       -
239         byte-order: big-endian
240       -
243         byte-order: big-endian
244       -
247       -
250       -
253       -
256       -
259       -
260         name: reset-reason
262       -
263         name: reset-flags
265       -
266         name: server-side
271     -
275     -
276       name: add-addr
278       attribute-set: endpoint
279       dont-validate: [ strict ]
280       flags: [ uns-admin-perm ]
281       do: &add-addr-attrs
284             - addr
285     -
286       name: del-addr
288       attribute-set: endpoint
289       dont-validate: [ strict ]
290       flags: [ uns-admin-perm ]
291       do: *add-addr-attrs
292     -
293       name: get-addr
295       attribute-set: endpoint
296       dont-validate: [ strict ]
297       flags: [ uns-admin-perm ]
298       do: &get-addr-attrs
301            - addr
304            - addr
308            - addr
309     -
310       name:  flush-addrs
312       attribute-set: endpoint
313       dont-validate: [ strict ]
314       flags: [ uns-admin-perm ]
315       do: *add-addr-attrs
316     -
317       name: set-limits
318       doc: Set protocol limits
319       attribute-set: attr
320       dont-validate: [ strict ]
321       flags: [ uns-admin-perm ]
322       do: &mptcp-limits
325             - rcv-add-addrs
326             - subflows
327     -
328       name: get-limits
330       attribute-set: attr
331       dont-validate: [ strict ]
332       do: &mptcp-get-limits
335             - rcv-add-addrs
336             - subflows
339             - rcv-add-addrs
340             - subflows
341     -
342       name: set-flags
344       attribute-set: attr
345       dont-validate: [ strict ]
346       flags: [ uns-admin-perm ]
347       do: &mptcp-set-flags
350             - addr
351             - token
352             - addr-remote
353     -
356       attribute-set: attr
357       dont-validate: [ strict ]
358       flags: [ uns-admin-perm ]
359       do: &announce-add
362             - addr
363             - token
364     -
367       attribute-set: attr
368       dont-validate: [ strict ]
369       flags: [ uns-admin-perm ]
373            - token
374            - loc-id
375     -
376       name: subflow-create
378       attribute-set: attr
379       dont-validate: [ strict ]
380       flags: [ uns-admin-perm ]
381       do: &sf-create
384             - addr
385             - token
386             - addr-remote
387     -
388       name: subflow-destroy
390       attribute-set: attr
391       dont-validate: [ strict ]
392       flags: [ uns-admin-perm ]
393       do: *sf-create