summaryrefslogtreecommitdiff
path: root/Documentation/netlink/specs/rt_route.yaml
blob: f4368be0caed9e343a3e28ca516af10812d89191 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
# SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)

name: rt-route
protocol: netlink-raw
protonum: 0

doc:
  Route configuration over rtnetlink.

definitions:
  -
    name: rtm-type
    name-prefix: rtn-
    type: enum
    entries:
      - unspec
      - unicast
      - local
      - broadcast
      - anycast
      - multicast
      - blackhole
      - unreachable
      - prohibit
      - throw
      - nat
      - xresolve
  -
    name: rtmsg
    type: struct
    members:
      -
        name: rtm-family
        type: u8
      -
        name: rtm-dst-len
        type: u8
      -
        name: rtm-src-len
        type: u8
      -
        name: rtm-tos
        type: u8
      -
        name: rtm-table
        type: u8
      -
        name: rtm-protocol
        type: u8
      -
        name: rtm-scope
        type: u8
      -
        name: rtm-type
        type: u8
        enum: rtm-type
      -
        name: rtm-flags
        type: u32
  -
    name: rta-cacheinfo
    type: struct
    members:
      -
        name: rta-clntref
        type: u32
      -
        name: rta-lastuse
        type: u32
      -
        name: rta-expires
        type: u32
      -
        name: rta-error
        type: u32
      -
        name: rta-used
        type: u32

attribute-sets:
  -
    name: route-attrs
    attributes:
      -
        name: rta-dst
        type: binary
        display-hint: ipv4
      -
        name: rta-src
        type: binary
        display-hint: ipv4
      -
        name: rta-iif
        type: u32
      -
        name: rta-oif
        type: u32
      -
        name: rta-gateway
        type: binary
        display-hint: ipv4
      -
        name: rta-priority
        type: u32
      -
        name: rta-prefsrc
        type: binary
        display-hint: ipv4
      -
        name: rta-metrics
        type: nest
        nested-attributes: rta-metrics
      -
        name: rta-multipath
        type: binary
      -
        name: rta-protoinfo # not used
        type: binary
      -
        name: rta-flow
        type: u32
      -
        name: rta-cacheinfo
        type: binary
        struct: rta-cacheinfo
      -
        name: rta-session # not used
        type: binary
      -
        name: rta-mp-algo # not used
        type: binary
      -
        name: rta-table
        type: u32
      -
        name: rta-mark
        type: u32
      -
        name: rta-mfc-stats
        type: binary
      -
        name: rta-via
        type: binary
      -
        name: rta-newdst
        type: binary
      -
        name: rta-pref
        type: u8
      -
        name: rta-encap-type
        type: u16
      -
        name: rta-encap
        type: binary # tunnel specific nest
      -
        name: rta-expires
        type: u32
      -
        name: rta-pad
        type: binary
      -
        name: rta-uid
        type: u32
      -
        name: rta-ttl-propagate
        type: u8
      -
        name: rta-ip-proto
        type: u8
      -
        name: rta-sport
        type: u16
      -
        name: rta-dport
        type: u16
      -
        name: rta-nh-id
        type: u32
  -
    name: rta-metrics
    attributes:
      -
        name: rtax-unspec
        type: unused
        value: 0
      -
        name: rtax-lock
        type: u32
      -
        name: rtax-mtu
        type: u32
      -
        name: rtax-window
        type: u32
      -
        name: rtax-rtt
        type: u32
      -
        name: rtax-rttvar
        type: u32
      -
        name: rtax-ssthresh
        type: u32
      -
        name: rtax-cwnd
        type: u32
      -
        name: rtax-advmss
        type: u32
      -
        name: rtax-reordering
        type: u32
      -
        name: rtax-hoplimit
        type: u32
      -
        name: rtax-initcwnd
        type: u32
      -
        name: rtax-features
        type: u32
      -
        name: rtax-rto-min
        type: u32
      -
        name: rtax-initrwnd
        type: u32
      -
        name: rtax-quickack
        type: u32
      -
        name: rtax-cc-algo
        type: string
      -
        name: rtax-fastopen-no-cookie
        type: u32

operations:
  enum-model: directional
  list:
    -
      name: getroute
      doc: Dump route information.
      attribute-set: route-attrs
      fixed-header: rtmsg
      do:
        request:
          value: 26
          attributes:
            - rtm-family
            - rta-src
            - rtm-src-len
            - rta-dst
            - rtm-dst-len
            - rta-iif
            - rta-oif
            - rta-ip-proto
            - rta-sport
            - rta-dport
            - rta-mark
            - rta-uid
        reply:
          value: 24
          attributes: &all-route-attrs
            - rtm-family
            - rtm-dst-len
            - rtm-src-len
            - rtm-tos
            - rtm-table
            - rtm-protocol
            - rtm-scope
            - rtm-type
            - rtm-flags
            - rta-dst
            - rta-src
            - rta-iif
            - rta-oif
            - rta-gateway
            - rta-priority
            - rta-prefsrc
            - rta-metrics
            - rta-multipath
            - rta-flow
            - rta-cacheinfo
            - rta-table
            - rta-mark
            - rta-mfc-stats
            - rta-via
            - rta-newdst
            - rta-pref
            - rta-encap-type
            - rta-encap
            - rta-expires
            - rta-pad
            - rta-uid
            - rta-ttl-propagate
            - rta-ip-proto
            - rta-sport
            - rta-dport
            - rta-nh-id
      dump:
        request:
          value: 26
          attributes:
            - rtm-family
        reply:
          value: 24
          attributes: *all-route-attrs
    -
      name: newroute
      doc: Create a new route
      attribute-set: route-attrs
      fixed-header: rtmsg
      do:
        request:
          value: 24
          attributes: *all-route-attrs
    -
      name: delroute
      doc: Delete an existing route
      attribute-set: route-attrs
      fixed-header: rtmsg
      do:
        request:
          value: 25
          attributes: *all-route-attrs