summaryrefslogtreecommitdiff
path: root/Documentation/netlink/specs/rt_neigh.yaml
blob: e670b6dc07be4f552133bfe458ebfee7ef8f2067 (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
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
# SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)

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

doc:
  IP neighbour management over rtnetlink.

definitions:
  -
    name: ndmsg
    type: struct
    members:
      -
        name: family
        type: u8
      -
        name: pad
        type: pad
        len: 3
      -
        name: ifindex
        type: s32
      -
        name: state
        type: u16
        enum: nud-state
      -
        name: flags
        type: u8
        enum: ntf-flags
      -
        name: type
        type: u8
        enum: rtm-type
  -
    name: ndtmsg
    type: struct
    members:
      -
        name: family
        type: u8
      -
        name: pad
        type: pad
        len: 3
  -
    name: nud-state
    type: flags
    entries:
      - incomplete
      - reachable
      - stale
      - delay
      - probe
      - failed
      - noarp
      - permanent
  -
    name: ntf-flags
    type: flags
    entries:
      - use
      - self
      - master
      - proxy
      - ext-learned
      - offloaded
      - sticky
      - router
  -
    name: ntf-ext-flags
    type: flags
    entries:
      - managed
      - locked
  -
    name: rtm-type
    type: enum
    entries:
      - unspec
      - unicast
      - local
      - broadcast
      - anycast
      - multicast
      - blackhole
      - unreachable
      - prohibit
      - throw
      - nat
      - xresolve
  -
    name: nda-cacheinfo
    type: struct
    members:
      -
        name: confirmed
        type: u32
      -
        name: used
        type: u32
      -
        name: updated
        type: u32
      -
        name: refcnt
        type: u32
  -
    name: ndt-config
    type: struct
    members:
      -
        name: key-len
        type: u16
      -
        name: entry-size
        type: u16
      -
        name: entries
        type: u32
      -
        name: last-flush
        type: u32
      -
        name: last-rand
        type: u32
      -
        name: hash-rnd
        type: u32
      -
        name: hash-mask
        type: u32
      -
        name: hash-chain-gc
        type: u32
      -
        name: proxy-qlen
        type: u32
  -
    name: ndt-stats
    type: struct
    members:
      -
        name: allocs
        type: u64
      -
        name: destroys
        type: u64
      -
        name: hash-grows
        type: u64
      -
        name: res-failed
        type: u64
      -
        name: lookups
        type: u64
      -
        name: hits
        type: u64
      -
        name: rcv-probes-mcast
        type: u64
      -
        name: rcv-probes-ucast
        type: u64
      -
        name: periodic-gc-runs
        type: u64
      -
        name: forced-gc-runs
        type: u64
      -
        name: table-fulls
        type: u64

attribute-sets:
  -
    name: neighbour-attrs
    attributes:
      -
        name: unspec
        type: binary
        value: 0
      -
        name: dst
        type: binary
        display-hint: ipv4
      -
        name: lladr
        type: binary
        display-hint: mac
      -
        name: cacheinfo
        type: binary
        struct: nda-cacheinfo
      -
        name: probes
        type: u32
      -
        name: vlan
        type: u16
      -
        name: port
        type: u16
      -
        name: vni
        type: u32
      -
        name: ifindex
        type: u32
      -
        name: master
        type: u32
      -
        name: link-netnsid
        type: s32
      -
        name: src-vni
        type: u32
      -
        name: protocol
        type: u8
      -
        name: nh-id
        type: u32
      -
        name: fdb-ext-attrs
        type: binary
      -
        name: flags-ext
        type: u32
        enum: ntf-ext-flags
      -
        name: ndm-state-mask
        type: u16
      -
        name: ndm-flags-mask
        type: u8
  -
    name: ndt-attrs
    attributes:
      -
        name: name
        type: string
      -
        name: thresh1
        type: u32
      -
        name: thresh2
        type: u32
      -
        name: thresh3
        type: u32
      -
        name: config
        type: binary
        struct: ndt-config
      -
        name: parms
        type: nest
        nested-attributes: ndtpa-attrs
      -
        name: stats
        type: binary
        struct: ndt-stats
      -
        name: gc-interval
        type: u64
      -
        name: pad
        type: pad
  -
    name: ndtpa-attrs
    attributes:
      -
        name: ifindex
        type: u32
      -
        name: refcnt
        type: u32
      -
        name: reachable-time
        type: u64
      -
        name: base-reachable-time
        type: u64
      -
        name: retrans-time
        type: u64
      -
        name: gc-staletime
        type: u64
      -
        name: delay-probe-time
        type: u64
      -
        name: queue-len
        type: u32
      -
        name: app-probes
        type: u32
      -
        name: ucast-probes
        type: u32
      -
        name: mcast-probes
        type: u32
      -
        name: anycast-delay
        type: u64
      -
        name: proxy-delay
        type: u64
      -
        name: proxy-qlen
        type: u32
      -
        name: locktime
        type: u64
      -
        name: queue-lenbytes
        type: u32
      -
        name: mcast-reprobes
        type: u32
      -
        name: pad
        type: pad
      -
        name: interval-probe-time-ms
        type: u64

operations:
  enum-model: directional
  list:
    -
      name: newneigh
      doc: Add new neighbour entry
      fixed-header: ndmsg
      attribute-set: neighbour-attrs
      do:
        request:
          value: 28
          attributes: &neighbour-all
            - dst
            - lladdr
            - probes
            - vlan
            - port
            - vni
            - ifindex
            - master
            - protocol
            - nh-id
            - flags-ext
            - fdb-ext-attrs
    -
      name: delneigh
      doc: Remove an existing neighbour entry
      fixed-header: ndmsg
      attribute-set: neighbour-attrs
      do:
        request:
          value: 29
          attributes:
            - dst
            - ifindex
    -
      name: delneigh-ntf
      doc: Notify a neighbour deletion
      value: 29
      notify: delneigh
      fixed-header: ndmsg
    -
      name: getneigh
      doc: Get or dump neighbour entries
      fixed-header: ndmsg
      attribute-set: neighbour-attrs
      do:
        request:
          value: 30
          attributes:
            - dst
        reply:
          value: 28
          attributes: *neighbour-all
      dump:
        request:
          attributes:
            - ifindex
            - master
        reply:
          attributes: *neighbour-all
    -
      name: newneigh-ntf
      doc: Notify a neighbour creation
      value: 28
      notify: getneigh
      fixed-header: ndmsg
    -
      name: getneightbl
      doc: Get or dump neighbour tables
      fixed-header: ndtmsg
      attribute-set: ndt-attrs
      dump:
        request:
          value: 66
        reply:
          value: 64
          attributes:
            - name
            - thresh1
            - thresh2
            - thresh3
            - config
            - parms
            - stats
            - gc-interval
    -
      name: setneightbl
      doc: Set neighbour tables
      fixed-header: ndtmsg
      attribute-set: ndt-attrs
      do:
        request:
          value: 67
          attributes:
            - name
            - thresh1
            - thresh2
            - thresh3
            - parms
            - gc-interval

mcast-groups:
  list:
    -
      name: rtnlgrp-neigh
      value: 3