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       -
115       -
116         name: if-idx
118   -
119     name: subflow-attribute
120     name-prefix: mptcp-subflow-attr-
122       -
126       -
127         name: token-rem
129       -
130         name: token-loc
132       -
133         name: relwrite-seq
135       -
136         name: map-seq
138       -
139         name: map-sfseq
141       -
142         name: ssn-offset
144       -
145         name: map-datalen
147       -
150       -
151         name: id-rem
153       -
154         name: id-loc
156       -
159   -
161     name-prefix: mptcp-pm-endpoint-
163       -
166         nested-attributes: address
167   -
169     name-prefix: mptcp-pm-attr-
170     attr-cnt-name: --mptcp-attr-after-last
172       -
176       -
179         nested-attributes: address
180       -
181         name: rcv-add-addrs
183       -
186       -
189       -
190         name: loc-id
192       -
193         name: addr-remote
195         nested-attributes: address
196   -
197     name: event-attr
198     enum-name: mptcp-event-attr
199     name-prefix: mptcp-attr-
201       -
205       -
208       -
211       -
212         name: loc-id
214       -
215         name: rem-id
217       -
220         byte-order: big-endian
221       -
225           min-len: 16
226       -
229         byte-order: big-endian
230       -
234           min-len: 16
235       -
238         byte-order: big-endian
239       -
242         byte-order: big-endian
243       -
246       -
249       -
252       -
255       -
258       -
259         name: reset-reason
261       -
262         name: reset-flags
264       -
265         name: server-side
270     -
274     -
275       name: add-addr
277       attribute-set: endpoint
278       dont-validate: [ strict ]
279       flags: [ uns-admin-perm ]
280       do: &add-addr-attrs
283             - addr
284     -
285       name: del-addr
287       attribute-set: endpoint
288       dont-validate: [ strict ]
289       flags: [ uns-admin-perm ]
290       do: *add-addr-attrs
291     -
292       name: get-addr
294       attribute-set: attr
295       dont-validate: [ strict ]
296       do: &get-addr-attrs
299            - addr
300            - token
303            - addr
307            - addr
308     -
309       name:  flush-addrs
311       attribute-set: endpoint
312       dont-validate: [ strict ]
313       flags: [ uns-admin-perm ]
314       do: *add-addr-attrs
315     -
316       name: set-limits
317       doc: Set protocol limits
318       attribute-set: attr
319       dont-validate: [ strict ]
320       flags: [ uns-admin-perm ]
321       do: &mptcp-limits
324             - rcv-add-addrs
325             - subflows
326     -
327       name: get-limits
329       attribute-set: attr
330       dont-validate: [ strict ]
331       do: &mptcp-get-limits
334             - rcv-add-addrs
335             - subflows
338             - rcv-add-addrs
339             - subflows
340     -
341       name: set-flags
343       attribute-set: attr
344       dont-validate: [ strict ]
345       flags: [ uns-admin-perm ]
346       do: &mptcp-set-flags
349             - addr
350             - token
351             - addr-remote
352     -
355       attribute-set: attr
356       dont-validate: [ strict ]
357       flags: [ uns-admin-perm ]
358       do: &announce-add
361             - addr
362             - token
363     -
366       attribute-set: attr
367       dont-validate: [ strict ]
368       flags: [ uns-admin-perm ]
372            - token
373            - loc-id
374     -
375       name: subflow-create
377       attribute-set: attr
378       dont-validate: [ strict ]
379       flags: [ uns-admin-perm ]
380       do: &sf-create
383             - addr
384             - token
385             - addr-remote
386     -
387       name: subflow-destroy
389       attribute-set: attr
390       dont-validate: [ strict ]
391       flags: [ uns-admin-perm ]
392       do: *sf-create