Documentation / netlink / specs / rt_rule.yaml


Based on kernel version 6.13. Page generated on 2025-01-21 08:21 EST.

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
# SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause)

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

doc:
  FIB rule management over rtnetlink.

definitions:
  -
    name: rtgenmsg
    type: struct
    members:
      -
        name: family
        type: u8
      -
        name: pad
        type: pad
        len: 3
  -
    name: fib-rule-hdr
    type: struct
    members:
      -
        name: family
        type: u8
      -
        name: dst-len
        type: u8
      -
        name: src-len
        type: u8
      -
        name: tos
        type: u8
      -
        name: table
        type: u8
      -
        name: res1
        type: pad
        len: 1
      -
        name: res2
        type: pad
        len: 1
      -
        name: action
        type: u8
        enum: fr-act
      -
        name: flags
        type: u32
  -
    name: fr-act
    type: enum
    entries:
      - unspec
      - to-tbl
      - goto
      - nop
      - res3
      - res4
      - blackhole
      - unreachable
      - prohibit
  -
    name: fib-rule-port-range
    type: struct
    members:
      -
        name: start
        type: u16
      -
        name: end
        type: u16
  -
    name: fib-rule-uid-range
    type: struct
    members:
      -
        name: start
        type: u32
      -
        name: end
        type: u32

attribute-sets:
  -
    name: fib-rule-attrs
    attributes:
      -
        name: dst
        type: u32
      -
        name: src
        type: u32
      -
        name: iifname
        type: string
      -
        name: goto
        type: u32
      -
        name: unused2
        type: pad
      -
        name: priority
        type: u32
      -
        name: unused3
        type: pad
      -
        name: unused4
        type: pad
      -
        name: unused5
        type: pad
      -
        name: fwmark
        type: u32
        display-hint: hex
      -
        name: flow
        type: u32
      -
        name: tun-id
        type: u64
      -
        name: suppress-ifgroup
        type: u32
      -
        name: suppress-prefixlen
        type: u32
        display-hint: hex
      -
        name: table
        type: u32
      -
        name: fwmask
        type: u32
        display-hint: hex
      -
        name: oifname
        type: string
      -
        name: pad
        type: pad
      -
        name: l3mdev
        type: u8
      -
        name: uid-range
        type: binary
        struct: fib-rule-uid-range
      -
        name: protocol
        type: u8
      -
        name: ip-proto
        type: u8
      -
        name: sport-range
        type: binary
        struct: fib-rule-port-range
      -
        name: dport-range
        type: binary
        struct: fib-rule-port-range
      -
        name: dscp
        type: u8

operations:
  enum-model: directional
  fixed-header: fib-rule-hdr
  list:
    -
      name: newrule
      doc: Add new FIB rule
      attribute-set: fib-rule-attrs
      do:
        request:
          value: 32
          attributes: &fib-rule-all
            - iifname
            - oifname
            - priority
            - fwmark
            - flow
            - tun-id
            - fwmask
            - table
            - suppress-prefixlen
            - suppress-ifgroup
            - goto
            - l3mdev
            - uid-range
            - protocol
            - ip-proto
            - sport-range
            - dport-range
            - dscp
    -
      name: newrule-ntf
      doc: Notify a rule creation
      value: 32
      notify: newrule
    -
      name: delrule
      doc: Remove an existing FIB rule
      attribute-set: fib-rule-attrs
      do:
        request:
          value: 33
          attributes: *fib-rule-all
    -
      name: delrule-ntf
      doc: Notify a rule deletion
      value: 33
      notify: delrule
    -
      name: getrule
      doc: Dump all FIB rules
      attribute-set: fib-rule-attrs
      dump:
        request:
          value: 34
        reply:
          value: 32
          attributes: *fib-rule-all

mcast-groups:
  list:
    -
      name: rtnlgrp-ipv4-rule
      value: 8
    -
      name: rtnlgrp-ipv6-rule
      value: 19