Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2016 Cisco and/or its affiliates. |
| 3 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | * you may not use this file except in compliance with the License. |
| 5 | * You may obtain a copy of the License at: |
| 6 | * |
| 7 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | * |
| 9 | * Unless required by applicable law or agreed to in writing, software |
| 10 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | * See the License for the specific language governing permissions and |
| 13 | * limitations under the License. |
| 14 | */ |
| 15 | |
| 16 | #ifndef __FIB_ENTRY_H__ |
| 17 | #define __FIB_ENTRY_H__ |
| 18 | |
| 19 | #include <vnet/fib/fib_node.h> |
Neale Ranns | ad422ed | 2016-11-02 14:20:04 +0000 | [diff] [blame] | 20 | #include <vnet/fib/fib_entry_delegate.h> |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 21 | #include <vnet/adj/adj.h> |
| 22 | #include <vnet/ip/ip.h> |
| 23 | #include <vnet/dpo/dpo.h> |
| 24 | |
| 25 | /** |
| 26 | * The different sources that can create a route. |
| 27 | * The sources are defined here the thier relative priority order. |
| 28 | * The lower the value the higher the priority |
| 29 | */ |
| 30 | typedef enum fib_source_t_ { |
| 31 | /** |
| 32 | * Marker. Add new values after this one. |
| 33 | */ |
| 34 | FIB_SOURCE_FIRST, |
| 35 | /** |
| 36 | * Special sources. These are for entries that are added to all |
| 37 | * FIBs by default, and should never be over-ridden (hence they |
| 38 | * are the highest priority) |
| 39 | */ |
| 40 | FIB_SOURCE_SPECIAL = FIB_SOURCE_FIRST, |
| 41 | /** |
| 42 | * Classify. A route that links directly to a classify adj |
| 43 | */ |
| 44 | FIB_SOURCE_CLASSIFY, |
| 45 | /** |
Andrew Yourtchenko | 5f3fcb9 | 2017-10-25 05:50:37 -0700 | [diff] [blame] | 46 | * A route the is being 'proxied' on behalf of another device |
| 47 | */ |
| 48 | FIB_SOURCE_PROXY, |
| 49 | /** |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 50 | * Route added as a result of interface configuration. |
| 51 | * this will also come from the API/CLI, but the distinction is |
| 52 | * that is from confiiguration on an interface, not a 'ip route' command |
| 53 | */ |
| 54 | FIB_SOURCE_INTERFACE, |
| 55 | /** |
Pablo Camarillo | 5d73eec | 2017-04-24 17:51:56 +0200 | [diff] [blame] | 56 | * SRv6 and SR-MPLS |
| 57 | */ |
| 58 | FIB_SOURCE_SR, |
| 59 | /** |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 60 | * A high priority source a plugin can use |
| 61 | */ |
| 62 | FIB_SOURCE_PLUGIN_HI, |
| 63 | /** |
Neale Ranns | d792d9c | 2017-10-21 10:53:20 -0700 | [diff] [blame] | 64 | * From the BIER subsystem |
| 65 | */ |
| 66 | FIB_SOURCE_BIER, |
| 67 | /** |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 68 | * From the control plane API |
| 69 | */ |
| 70 | FIB_SOURCE_API, |
| 71 | /** |
| 72 | * From the CLI. |
| 73 | */ |
| 74 | FIB_SOURCE_CLI, |
| 75 | /** |
| 76 | * LISP |
| 77 | */ |
| 78 | FIB_SOURCE_LISP, |
| 79 | /** |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 80 | * IPv[46] Mapping |
| 81 | */ |
| 82 | FIB_SOURCE_MAP, |
| 83 | /** |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 84 | * DHCP |
| 85 | */ |
| 86 | FIB_SOURCE_DHCP, |
| 87 | /** |
Neale Ranns | 3f844d0 | 2017-02-18 00:03:54 -0800 | [diff] [blame] | 88 | * IPv6 Proxy ND |
| 89 | */ |
| 90 | FIB_SOURCE_IP6_ND_PROXY, |
| 91 | /** |
Neale Ranns | 53da221 | 2018-02-24 02:11:19 -0800 | [diff] [blame] | 92 | * IPv6 ND (seen in the link-local tables) |
| 93 | */ |
| 94 | FIB_SOURCE_IP6_ND, |
| 95 | /** |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 96 | * Adjacency source. |
| 97 | * routes created as a result of ARP/ND entries. This is lower priority |
| 98 | * then the API/CLI. This is on purpose. trust me. |
| 99 | */ |
| 100 | FIB_SOURCE_ADJ, |
| 101 | /** |
| 102 | * MPLS label. The prefix has been assigned a local label. This source |
| 103 | * never provides forwarding information, instead it acts as a place-holder |
| 104 | * so the association of label to prefix can be maintained |
| 105 | */ |
| 106 | FIB_SOURCE_MPLS, |
| 107 | /** |
| 108 | * Attached Export source. |
| 109 | * routes created as a result of attahced export. routes thus sourced |
| 110 | * will be present in the export tables |
| 111 | */ |
| 112 | FIB_SOURCE_AE, |
| 113 | /** |
| 114 | * Recursive resolution source. |
Neale Ranns | 3ee4404 | 2016-10-03 13:05:48 +0100 | [diff] [blame] | 115 | * Used to install an entry that is the resolution traget of another. |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 116 | */ |
| 117 | FIB_SOURCE_RR, |
| 118 | /** |
Neale Ranns | 3ee4404 | 2016-10-03 13:05:48 +0100 | [diff] [blame] | 119 | * uRPF bypass/exemption. |
| 120 | * Used to install an entry that is exempt from the loose uRPF check |
| 121 | */ |
| 122 | FIB_SOURCE_URPF_EXEMPT, |
| 123 | /** |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 124 | * The default route source. |
| 125 | * The default route is always added to the FIB table (like the |
| 126 | * special sources) but we need to be able to over-ride it with |
| 127 | * 'ip route' sources when provided |
| 128 | */ |
| 129 | FIB_SOURCE_DEFAULT_ROUTE, |
| 130 | /** |
Neale Ranns | 2303cb1 | 2018-02-21 04:57:17 -0800 | [diff] [blame^] | 131 | * The interpose source. |
| 132 | * This is not a real source, so don't use it to source a prefix. |
| 133 | * It exists here to provide a value against which to register to the |
| 134 | * VFT for providing the interpose actions to a real source. |
| 135 | */ |
| 136 | FIB_SOURCE_INTERPOSE, |
| 137 | /** |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 138 | * Marker. add new entries before this one. |
| 139 | */ |
Neale Ranns | 2303cb1 | 2018-02-21 04:57:17 -0800 | [diff] [blame^] | 140 | FIB_SOURCE_LAST = FIB_SOURCE_INTERPOSE, |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 141 | } __attribute__ ((packed)) fib_source_t; |
| 142 | |
Damjan Marion | cf47894 | 2016-11-07 14:57:50 +0100 | [diff] [blame] | 143 | STATIC_ASSERT (sizeof(fib_source_t) == 1, |
| 144 | "FIB too many sources"); |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 145 | |
| 146 | /** |
| 147 | * The maximum number of sources |
| 148 | */ |
| 149 | #define FIB_SOURCE_MAX (FIB_SOURCE_LAST+1) |
| 150 | |
| 151 | #define FIB_SOURCES { \ |
| 152 | [FIB_SOURCE_SPECIAL] = "special", \ |
| 153 | [FIB_SOURCE_INTERFACE] = "interface", \ |
Andrew Yourtchenko | 5f3fcb9 | 2017-10-25 05:50:37 -0700 | [diff] [blame] | 154 | [FIB_SOURCE_PROXY] = "proxy", \ |
Neale Ranns | d792d9c | 2017-10-21 10:53:20 -0700 | [diff] [blame] | 155 | [FIB_SOURCE_BIER] = "BIER", \ |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 156 | [FIB_SOURCE_API] = "API", \ |
| 157 | [FIB_SOURCE_CLI] = "CLI", \ |
| 158 | [FIB_SOURCE_ADJ] = "adjacency", \ |
| 159 | [FIB_SOURCE_MAP] = "MAP", \ |
| 160 | [FIB_SOURCE_SR] = "SR", \ |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 161 | [FIB_SOURCE_LISP] = "LISP", \ |
| 162 | [FIB_SOURCE_CLASSIFY] = "classify", \ |
| 163 | [FIB_SOURCE_DHCP] = "DHCP", \ |
Neale Ranns | 3f844d0 | 2017-02-18 00:03:54 -0800 | [diff] [blame] | 164 | [FIB_SOURCE_IP6_ND_PROXY] = "IPv6-proxy-nd", \ |
Neale Ranns | 53da221 | 2018-02-24 02:11:19 -0800 | [diff] [blame] | 165 | [FIB_SOURCE_IP6_ND] = "IPv6-nd", \ |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 166 | [FIB_SOURCE_RR] = "recursive-resolution", \ |
| 167 | [FIB_SOURCE_AE] = "attached_export", \ |
| 168 | [FIB_SOURCE_MPLS] = "mpls", \ |
Neale Ranns | 3ee4404 | 2016-10-03 13:05:48 +0100 | [diff] [blame] | 169 | [FIB_SOURCE_URPF_EXEMPT] = "urpf-exempt", \ |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 170 | [FIB_SOURCE_DEFAULT_ROUTE] = "default-route", \ |
Neale Ranns | 8145842 | 2018-03-12 06:59:36 -0700 | [diff] [blame] | 171 | [FIB_SOURCE_PLUGIN_HI] = "plugin-hi", \ |
Neale Ranns | 2303cb1 | 2018-02-21 04:57:17 -0800 | [diff] [blame^] | 172 | [FIB_SOURCE_INTERPOSE] = "interpose", \ |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 173 | } |
| 174 | |
| 175 | #define FOR_EACH_FIB_SOURCE(_item) \ |
| 176 | for (_item = FIB_SOURCE_FIRST; _item < FIB_SOURCE_MAX; _item++) |
| 177 | |
| 178 | /** |
| 179 | * The different sources that can create a route. |
| 180 | * The sources are defined here the thier relative priority order. |
| 181 | * The lower the value the higher the priority |
| 182 | */ |
| 183 | typedef enum fib_entry_attribute_t_ { |
| 184 | /** |
| 185 | * Marker. Add new values after this one. |
| 186 | */ |
| 187 | FIB_ENTRY_ATTRIBUTE_FIRST, |
| 188 | /** |
| 189 | * Connected. The prefix is configured on an interface. |
| 190 | */ |
| 191 | FIB_ENTRY_ATTRIBUTE_CONNECTED = FIB_ENTRY_ATTRIBUTE_FIRST, |
| 192 | /** |
| 193 | * Attached. The prefix is attached to an interface. |
| 194 | */ |
| 195 | FIB_ENTRY_ATTRIBUTE_ATTACHED, |
| 196 | /** |
| 197 | * The route is an explicit drop. |
| 198 | */ |
| 199 | FIB_ENTRY_ATTRIBUTE_DROP, |
| 200 | /** |
| 201 | * The route is exclusive. The client creating the route is |
| 202 | * providing an exclusive adjacency. |
| 203 | */ |
| 204 | FIB_ENTRY_ATTRIBUTE_EXCLUSIVE, |
| 205 | /** |
| 206 | * The route is attached cross tables and thus imports covered |
| 207 | * prefixes from the other table. |
| 208 | */ |
| 209 | FIB_ENTRY_ATTRIBUTE_IMPORT, |
| 210 | /** |
| 211 | * The prefix/address is local to this device |
| 212 | */ |
| 213 | FIB_ENTRY_ATTRIBUTE_LOCAL, |
| 214 | /** |
Neale Ranns | 0f26c5a | 2017-03-01 15:12:11 -0800 | [diff] [blame] | 215 | * The prefix/address is a multicast prefix. |
| 216 | * this aplies only to MPLS. IP multicast is handled by mfib |
| 217 | */ |
| 218 | FIB_ENTRY_ATTRIBUTE_MULTICAST, |
| 219 | /** |
Shwetha Bhandari | 78372a9 | 2017-01-18 12:43:54 +0530 | [diff] [blame] | 220 | * The prefix/address exempted from loose uRPF check |
| 221 | * To be used with caution |
| 222 | */ |
| 223 | FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT, |
| 224 | /** |
Neale Ranns | 53da221 | 2018-02-24 02:11:19 -0800 | [diff] [blame] | 225 | * The prefix/address exempted from attached export |
| 226 | */ |
| 227 | FIB_ENTRY_ATTRIBUTE_NO_ATTACHED_EXPORT, |
| 228 | /** |
Neale Ranns | 8954199 | 2017-04-06 04:41:02 -0700 | [diff] [blame] | 229 | * This FIB entry imposes its source information on all prefixes |
| 230 | * that is covers |
| 231 | */ |
| 232 | FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT, |
| 233 | /** |
Neale Ranns | 2303cb1 | 2018-02-21 04:57:17 -0800 | [diff] [blame^] | 234 | * The interpose attribute. |
| 235 | * place the forwarding provided by the source infront of the forwarding |
| 236 | * provided by the best source, or failing that, by the cover. |
| 237 | */ |
| 238 | FIB_ENTRY_ATTRIBUTE_INTERPOSE, |
| 239 | /** |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 240 | * Marker. add new entries before this one. |
| 241 | */ |
Neale Ranns | 2303cb1 | 2018-02-21 04:57:17 -0800 | [diff] [blame^] | 242 | FIB_ENTRY_ATTRIBUTE_LAST = FIB_ENTRY_ATTRIBUTE_INTERPOSE, |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 243 | } fib_entry_attribute_t; |
| 244 | |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 245 | #define FIB_ENTRY_ATTRIBUTES { \ |
| 246 | [FIB_ENTRY_ATTRIBUTE_CONNECTED] = "connected", \ |
| 247 | [FIB_ENTRY_ATTRIBUTE_ATTACHED] = "attached", \ |
| 248 | [FIB_ENTRY_ATTRIBUTE_IMPORT] = "import", \ |
| 249 | [FIB_ENTRY_ATTRIBUTE_DROP] = "drop", \ |
| 250 | [FIB_ENTRY_ATTRIBUTE_EXCLUSIVE] = "exclusive", \ |
| 251 | [FIB_ENTRY_ATTRIBUTE_LOCAL] = "local", \ |
Neale Ranns | 0f26c5a | 2017-03-01 15:12:11 -0800 | [diff] [blame] | 252 | [FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT] = "uRPF-exempt", \ |
| 253 | [FIB_ENTRY_ATTRIBUTE_MULTICAST] = "multicast", \ |
Neale Ranns | 53da221 | 2018-02-24 02:11:19 -0800 | [diff] [blame] | 254 | [FIB_ENTRY_ATTRIBUTE_NO_ATTACHED_EXPORT] = "no-attached-export", \ |
Neale Ranns | 8954199 | 2017-04-06 04:41:02 -0700 | [diff] [blame] | 255 | [FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT] = "covered-inherit", \ |
Neale Ranns | 2303cb1 | 2018-02-21 04:57:17 -0800 | [diff] [blame^] | 256 | [FIB_ENTRY_ATTRIBUTE_INTERPOSE] = "interpose", \ |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 257 | } |
| 258 | |
| 259 | #define FOR_EACH_FIB_ATTRIBUTE(_item) \ |
| 260 | for (_item = FIB_ENTRY_ATTRIBUTE_FIRST; \ |
Neale Ranns | 808c5b2 | 2017-08-02 05:15:07 -0700 | [diff] [blame] | 261 | _item <= FIB_ENTRY_ATTRIBUTE_LAST; \ |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 262 | _item++) |
| 263 | |
| 264 | typedef enum fib_entry_flag_t_ { |
| 265 | FIB_ENTRY_FLAG_NONE = 0, |
| 266 | FIB_ENTRY_FLAG_CONNECTED = (1 << FIB_ENTRY_ATTRIBUTE_CONNECTED), |
| 267 | FIB_ENTRY_FLAG_ATTACHED = (1 << FIB_ENTRY_ATTRIBUTE_ATTACHED), |
| 268 | FIB_ENTRY_FLAG_DROP = (1 << FIB_ENTRY_ATTRIBUTE_DROP), |
| 269 | FIB_ENTRY_FLAG_EXCLUSIVE = (1 << FIB_ENTRY_ATTRIBUTE_EXCLUSIVE), |
| 270 | FIB_ENTRY_FLAG_LOCAL = (1 << FIB_ENTRY_ATTRIBUTE_LOCAL), |
| 271 | FIB_ENTRY_FLAG_IMPORT = (1 << FIB_ENTRY_ATTRIBUTE_IMPORT), |
Neale Ranns | 53da221 | 2018-02-24 02:11:19 -0800 | [diff] [blame] | 272 | FIB_ENTRY_FLAG_NO_ATTACHED_EXPORT = (1 << FIB_ENTRY_ATTRIBUTE_NO_ATTACHED_EXPORT), |
Shwetha Bhandari | 78372a9 | 2017-01-18 12:43:54 +0530 | [diff] [blame] | 273 | FIB_ENTRY_FLAG_LOOSE_URPF_EXEMPT = (1 << FIB_ENTRY_ATTRIBUTE_URPF_EXEMPT), |
Neale Ranns | 0f26c5a | 2017-03-01 15:12:11 -0800 | [diff] [blame] | 274 | FIB_ENTRY_FLAG_MULTICAST = (1 << FIB_ENTRY_ATTRIBUTE_MULTICAST), |
Neale Ranns | 8954199 | 2017-04-06 04:41:02 -0700 | [diff] [blame] | 275 | FIB_ENTRY_FLAG_COVERED_INHERIT = (1 << FIB_ENTRY_ATTRIBUTE_COVERED_INHERIT), |
Neale Ranns | 2303cb1 | 2018-02-21 04:57:17 -0800 | [diff] [blame^] | 276 | FIB_ENTRY_FLAG_INTERPOSE = (1 << FIB_ENTRY_ATTRIBUTE_INTERPOSE), |
Neale Ranns | 32e1c01 | 2016-11-22 17:07:28 +0000 | [diff] [blame] | 277 | } __attribute__((packed)) fib_entry_flag_t; |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 278 | |
| 279 | /** |
| 280 | * Flags for the source data |
| 281 | */ |
| 282 | typedef enum fib_entry_src_attribute_t_ { |
| 283 | /** |
| 284 | * Marker. Add new values after this one. |
| 285 | */ |
| 286 | FIB_ENTRY_SRC_ATTRIBUTE_FIRST, |
| 287 | /** |
| 288 | * the source has been added to the entry |
| 289 | */ |
| 290 | FIB_ENTRY_SRC_ATTRIBUTE_ADDED = FIB_ENTRY_SRC_ATTRIBUTE_FIRST, |
| 291 | /** |
Neale Ranns | 2303cb1 | 2018-02-21 04:57:17 -0800 | [diff] [blame^] | 292 | * the source is contributing forwarding |
| 293 | */ |
| 294 | FIB_ENTRY_SRC_ATTRIBUTE_CONTRIBUTING, |
| 295 | /** |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 296 | * the source is active/best |
| 297 | */ |
| 298 | FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE, |
| 299 | /** |
Neale Ranns | 8954199 | 2017-04-06 04:41:02 -0700 | [diff] [blame] | 300 | * the source is inherited from its cover |
| 301 | */ |
| 302 | FIB_ENTRY_SRC_ATTRIBUTE_INHERITED, |
| 303 | /** |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 304 | * Marker. add new entries before this one. |
| 305 | */ |
Neale Ranns | 8954199 | 2017-04-06 04:41:02 -0700 | [diff] [blame] | 306 | FIB_ENTRY_SRC_ATTRIBUTE_LAST = FIB_ENTRY_SRC_ATTRIBUTE_INHERITED, |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 307 | } fib_entry_src_attribute_t; |
| 308 | |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 309 | |
| 310 | #define FIB_ENTRY_SRC_ATTRIBUTES { \ |
| 311 | [FIB_ENTRY_SRC_ATTRIBUTE_ADDED] = "added", \ |
Neale Ranns | 2303cb1 | 2018-02-21 04:57:17 -0800 | [diff] [blame^] | 312 | [FIB_ENTRY_SRC_ATTRIBUTE_CONTRIBUTING] = "contributing", \ |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 313 | [FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE] = "active", \ |
Neale Ranns | 8954199 | 2017-04-06 04:41:02 -0700 | [diff] [blame] | 314 | [FIB_ENTRY_SRC_ATTRIBUTE_INHERITED] = "inherited", \ |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 315 | } |
| 316 | |
Neale Ranns | 8954199 | 2017-04-06 04:41:02 -0700 | [diff] [blame] | 317 | #define FOR_EACH_FIB_SRC_ATTRIBUTE(_item) \ |
| 318 | for (_item = FIB_ENTRY_SRC_ATTRIBUTE_FIRST; \ |
Neale Ranns | 2303cb1 | 2018-02-21 04:57:17 -0800 | [diff] [blame^] | 319 | _item <= FIB_ENTRY_SRC_ATTRIBUTE_LAST; \ |
Neale Ranns | 8954199 | 2017-04-06 04:41:02 -0700 | [diff] [blame] | 320 | _item++) |
| 321 | |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 322 | typedef enum fib_entry_src_flag_t_ { |
| 323 | FIB_ENTRY_SRC_FLAG_NONE = 0, |
| 324 | FIB_ENTRY_SRC_FLAG_ADDED = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ADDED), |
Neale Ranns | 2303cb1 | 2018-02-21 04:57:17 -0800 | [diff] [blame^] | 325 | FIB_ENTRY_SRC_FLAG_CONTRIBUTING = (1 << FIB_ENTRY_SRC_ATTRIBUTE_CONTRIBUTING), |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 326 | FIB_ENTRY_SRC_FLAG_ACTIVE = (1 << FIB_ENTRY_SRC_ATTRIBUTE_ACTIVE), |
Neale Ranns | 8954199 | 2017-04-06 04:41:02 -0700 | [diff] [blame] | 327 | FIB_ENTRY_SRC_FLAG_INHERITED = (1 << FIB_ENTRY_SRC_ATTRIBUTE_INHERITED), |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 328 | } __attribute__ ((packed)) fib_entry_src_flag_t; |
| 329 | |
| 330 | /* |
| 331 | * Keep the size of the flags field to 2 bytes, so it |
| 332 | * can be placed next to the 2 bytes reference count |
| 333 | */ |
Damjan Marion | cf47894 | 2016-11-07 14:57:50 +0100 | [diff] [blame] | 334 | STATIC_ASSERT (sizeof(fib_entry_src_flag_t) <= 2, |
| 335 | "FIB entry flags field size too big"); |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 336 | |
| 337 | /** |
| 338 | * Information related to the source of a FIB entry |
| 339 | */ |
| 340 | typedef struct fib_entry_src_t_ { |
| 341 | /** |
Neale Ranns | 6c3ebcc | 2016-10-02 21:20:15 +0100 | [diff] [blame] | 342 | * A vector of path extensions |
| 343 | */ |
Neale Ranns | 8142499 | 2017-05-18 03:03:22 -0700 | [diff] [blame] | 344 | fib_path_ext_list_t fes_path_exts; |
Neale Ranns | 6c3ebcc | 2016-10-02 21:20:15 +0100 | [diff] [blame] | 345 | |
| 346 | /** |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 347 | * The path-list created by the source |
| 348 | */ |
| 349 | fib_node_index_t fes_pl; |
Neale Ranns | 2303cb1 | 2018-02-21 04:57:17 -0800 | [diff] [blame^] | 350 | |
| 351 | /** |
| 352 | * Flags the source contributes to the entry |
| 353 | */ |
| 354 | fib_entry_flag_t fes_entry_flags; |
| 355 | |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 356 | /** |
| 357 | * Which source this info block is for |
| 358 | */ |
| 359 | fib_source_t fes_src; |
Neale Ranns | 2303cb1 | 2018-02-21 04:57:17 -0800 | [diff] [blame^] | 360 | |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 361 | /** |
| 362 | * Flags on the source |
| 363 | */ |
| 364 | fib_entry_src_flag_t fes_flags; |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 365 | |
| 366 | /** |
| 367 | * 1 bytes ref count. This is not the number of users of the Entry |
| 368 | * (which is itself not large, due to path-list sharing), but the number |
| 369 | * of times a given source has been added. Which is even fewer |
| 370 | */ |
| 371 | u8 fes_ref_count; |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 372 | |
| 373 | /** |
| 374 | * Source specific info |
| 375 | */ |
| 376 | union { |
| 377 | struct { |
| 378 | /** |
| 379 | * the index of the FIB entry that is the covering entry |
| 380 | */ |
| 381 | fib_node_index_t fesr_cover; |
| 382 | /** |
| 383 | * This source's index in the cover's list |
| 384 | */ |
| 385 | u32 fesr_sibling; |
| 386 | } rr; |
| 387 | struct { |
| 388 | /** |
| 389 | * the index of the FIB entry that is the covering entry |
| 390 | */ |
Neale Ranns | 2303cb1 | 2018-02-21 04:57:17 -0800 | [diff] [blame^] | 391 | fib_node_index_t fesi_cover; |
| 392 | /** |
| 393 | * This source's index in the cover's list |
| 394 | */ |
| 395 | u32 fesi_sibling; |
| 396 | /** |
| 397 | * DPO type to interpose. The dpo type needs to have registered |
| 398 | * it's 'contribute interpose' callback function. |
| 399 | */ |
| 400 | dpo_id_t fesi_dpo; |
| 401 | } interpose; |
| 402 | struct { |
| 403 | /** |
| 404 | * the index of the FIB entry that is the covering entry |
| 405 | */ |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 406 | fib_node_index_t fesa_cover; |
| 407 | /** |
| 408 | * This source's index in the cover's list |
| 409 | */ |
| 410 | u32 fesa_sibling; |
| 411 | } adj; |
| 412 | struct { |
| 413 | /** |
| 414 | * the index of the FIB entry that is the covering entry |
| 415 | */ |
| 416 | fib_node_index_t fesi_cover; |
| 417 | /** |
| 418 | * This source's index in the cover's list |
| 419 | */ |
| 420 | u32 fesi_sibling; |
| 421 | } interface; |
| 422 | struct { |
| 423 | /** |
| 424 | * This MPLS local label associated with the prefix. |
| 425 | */ |
| 426 | mpls_label_t fesm_label; |
| 427 | |
| 428 | /** |
| 429 | * the indicies of the LFIB entries created |
| 430 | */ |
| 431 | fib_node_index_t fesm_lfes[2]; |
| 432 | } mpls; |
| 433 | struct { |
| 434 | /** |
| 435 | * The source FIB index. |
| 436 | */ |
| 437 | fib_node_index_t fesl_fib_index; |
| 438 | } lisp; |
Neale Ranns | 2303cb1 | 2018-02-21 04:57:17 -0800 | [diff] [blame^] | 439 | } u; |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 440 | } fib_entry_src_t; |
| 441 | |
| 442 | /** |
| 443 | * An entry in a FIB table. |
| 444 | * |
| 445 | * This entry represents a route added to the FIB that is stored |
| 446 | * in one of the FIB tables. |
| 447 | */ |
| 448 | typedef struct fib_entry_t_ { |
| 449 | /** |
| 450 | * Base class. The entry's node representation in the graph. |
| 451 | */ |
| 452 | fib_node_t fe_node; |
| 453 | /** |
Neale Ranns | ad422ed | 2016-11-02 14:20:04 +0000 | [diff] [blame] | 454 | * The prefix of the route. this is const just to be sure. |
| 455 | * It is the entry's key/identity and so should never change. |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 456 | */ |
Neale Ranns | ad422ed | 2016-11-02 14:20:04 +0000 | [diff] [blame] | 457 | const fib_prefix_t fe_prefix; |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 458 | /** |
| 459 | * The index of the FIB table this entry is in |
| 460 | */ |
| 461 | u32 fe_fib_index; |
| 462 | /** |
| 463 | * The load-balance used for forwarding. |
| 464 | * |
| 465 | * We don't share the EOS and non-EOS even in case when they could be |
| 466 | * because: |
| 467 | * - complexity & reliability v. memory |
| 468 | * determining the conditions where sharing is possible is non-trivial. |
| 469 | * - separate LBs means we can get the EOS bit right in the MPLS label DPO |
| 470 | * and so save a few clock cycles in the DP imposition node since we can |
| 471 | * paint the header straight on without the need to check the packet |
| 472 | * type to derive the EOS bit value. |
| 473 | */ |
Neale Ranns | 0f26c5a | 2017-03-01 15:12:11 -0800 | [diff] [blame] | 474 | dpo_id_t fe_lb; |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 475 | /** |
Neale Ranns | a4e7766 | 2017-12-04 20:00:30 +0000 | [diff] [blame] | 476 | * Vector of source infos. |
| 477 | * Most entries will only have 1 source. So we optimise for memory usage, |
| 478 | * which is preferable since we have many entries. |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 479 | */ |
Neale Ranns | a4e7766 | 2017-12-04 20:00:30 +0000 | [diff] [blame] | 480 | fib_entry_src_t *fe_srcs; |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 481 | /** |
| 482 | * the path-list for which this entry is a child. This is also the path-list |
| 483 | * that is contributing forwarding for this entry. |
| 484 | */ |
| 485 | fib_node_index_t fe_parent; |
| 486 | /** |
| 487 | * index of this entry in the parent's child list. |
| 488 | * This is set when this entry is added as a child, but can also |
| 489 | * be changed by the parent as it manages its list. |
| 490 | */ |
| 491 | u32 fe_sibling; |
Neale Ranns | ad422ed | 2016-11-02 14:20:04 +0000 | [diff] [blame] | 492 | |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 493 | /** |
Neale Ranns | ad422ed | 2016-11-02 14:20:04 +0000 | [diff] [blame] | 494 | * A vector of delegates. |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 495 | */ |
Neale Ranns | ad422ed | 2016-11-02 14:20:04 +0000 | [diff] [blame] | 496 | fib_entry_delegate_t *fe_delegates; |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 497 | } fib_entry_t; |
| 498 | |
| 499 | #define FOR_EACH_FIB_ENTRY_FLAG(_item) \ |
| 500 | for (_item = FIB_ENTRY_FLAG_FIRST; _item < FIB_ENTRY_FLAG_MAX; _item++) |
| 501 | |
| 502 | #define FIB_ENTRY_FORMAT_BRIEF (0x0) |
| 503 | #define FIB_ENTRY_FORMAT_DETAIL (0x1) |
| 504 | #define FIB_ENTRY_FORMAT_DETAIL2 (0x2) |
| 505 | |
| 506 | extern u8 *format_fib_entry (u8 * s, va_list * args); |
Neale Ranns | 1500254 | 2017-09-10 04:39:11 -0700 | [diff] [blame] | 507 | extern u8 *format_fib_source (u8 * s, va_list * args); |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 508 | |
| 509 | extern fib_node_index_t fib_entry_create_special(u32 fib_index, |
| 510 | const fib_prefix_t *prefix, |
| 511 | fib_source_t source, |
| 512 | fib_entry_flag_t flags, |
| 513 | const dpo_id_t *dpo); |
| 514 | |
| 515 | extern fib_node_index_t fib_entry_create (u32 fib_index, |
| 516 | const fib_prefix_t *prefix, |
| 517 | fib_source_t source, |
| 518 | fib_entry_flag_t flags, |
| 519 | const fib_route_path_t *paths); |
| 520 | extern void fib_entry_update (fib_node_index_t fib_entry_index, |
| 521 | fib_source_t source, |
| 522 | fib_entry_flag_t flags, |
| 523 | const fib_route_path_t *paths); |
| 524 | |
| 525 | extern void fib_entry_path_add(fib_node_index_t fib_entry_index, |
| 526 | fib_source_t source, |
| 527 | fib_entry_flag_t flags, |
| 528 | const fib_route_path_t *rpath); |
| 529 | extern void fib_entry_special_add(fib_node_index_t fib_entry_index, |
| 530 | fib_source_t source, |
| 531 | fib_entry_flag_t flags, |
| 532 | const dpo_id_t *dpo); |
Neale Ranns | 948e00f | 2016-10-20 13:39:34 +0100 | [diff] [blame] | 533 | extern void fib_entry_special_update(fib_node_index_t fib_entry_index, |
| 534 | fib_source_t source, |
| 535 | fib_entry_flag_t flags, |
| 536 | const dpo_id_t *dpo); |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 537 | extern fib_entry_src_flag_t fib_entry_special_remove(fib_node_index_t fib_entry_index, |
| 538 | fib_source_t source); |
| 539 | |
| 540 | extern fib_entry_src_flag_t fib_entry_path_remove(fib_node_index_t fib_entry_index, |
| 541 | fib_source_t source, |
| 542 | const fib_route_path_t *rpath); |
Neale Ranns | 8954199 | 2017-04-06 04:41:02 -0700 | [diff] [blame] | 543 | |
| 544 | extern void fib_entry_inherit(fib_node_index_t cover, |
| 545 | fib_node_index_t covered); |
| 546 | |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 547 | extern fib_entry_src_flag_t fib_entry_delete(fib_node_index_t fib_entry_index, |
| 548 | fib_source_t source); |
| 549 | |
Neale Ranns | 2303cb1 | 2018-02-21 04:57:17 -0800 | [diff] [blame^] | 550 | extern void fib_entry_recalculate_forwarding( |
| 551 | fib_node_index_t fib_entry_index); |
Neale Ranns | 3ee4404 | 2016-10-03 13:05:48 +0100 | [diff] [blame] | 552 | extern void fib_entry_contribute_urpf(fib_node_index_t path_index, |
| 553 | index_t urpf); |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 554 | extern void fib_entry_contribute_forwarding( |
| 555 | fib_node_index_t fib_entry_index, |
| 556 | fib_forward_chain_type_t type, |
| 557 | dpo_id_t *dpo); |
| 558 | extern const dpo_id_t * fib_entry_contribute_ip_forwarding( |
| 559 | fib_node_index_t fib_entry_index); |
| 560 | extern adj_index_t fib_entry_get_adj_for_source( |
| 561 | fib_node_index_t fib_entry_index, |
| 562 | fib_source_t source); |
| 563 | extern const int fib_entry_get_dpo_for_source ( |
| 564 | fib_node_index_t fib_entry_index, |
| 565 | fib_source_t source, |
| 566 | dpo_id_t *dpo); |
| 567 | |
| 568 | extern adj_index_t fib_entry_get_adj(fib_node_index_t fib_entry_index); |
| 569 | |
| 570 | extern int fib_entry_cmp_for_sort(void *i1, void *i2); |
| 571 | |
| 572 | extern void fib_entry_cover_changed(fib_node_index_t fib_entry); |
| 573 | extern void fib_entry_cover_updated(fib_node_index_t fib_entry); |
| 574 | extern int fib_entry_recursive_loop_detect(fib_node_index_t entry_index, |
| 575 | fib_node_index_t **entry_indicies); |
| 576 | |
| 577 | extern void fib_entry_lock(fib_node_index_t fib_entry_index); |
| 578 | extern void fib_entry_unlock(fib_node_index_t fib_entry_index); |
| 579 | |
| 580 | extern u32 fib_entry_child_add(fib_node_index_t fib_entry_index, |
| 581 | fib_node_type_t type, |
| 582 | fib_node_index_t child_index); |
| 583 | extern void fib_entry_child_remove(fib_node_index_t fib_entry_index, |
| 584 | u32 sibling_index); |
| 585 | extern u32 fib_entry_get_resolving_interface(fib_node_index_t fib_entry_index); |
Neale Ranns | df089a8 | 2016-10-02 16:39:06 +0100 | [diff] [blame] | 586 | extern u32 fib_entry_get_resolving_interface_for_source( |
| 587 | fib_node_index_t fib_entry_index, |
| 588 | fib_source_t source); |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 589 | |
Steven | 01b0712 | 2016-11-02 10:40:09 -0700 | [diff] [blame] | 590 | extern void fib_entry_encode(fib_node_index_t fib_entry_index, |
| 591 | fib_route_path_encode_t **api_rpaths); |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 592 | extern void fib_entry_get_prefix(fib_node_index_t fib_entry_index, |
| 593 | fib_prefix_t *pfx); |
| 594 | extern u32 fib_entry_get_fib_index(fib_node_index_t fib_entry_index); |
| 595 | extern void fib_entry_set_source_data(fib_node_index_t fib_entry_index, |
| 596 | fib_source_t source, |
| 597 | const void *data); |
| 598 | extern const void* fib_entry_get_source_data(fib_node_index_t fib_entry_index, |
| 599 | fib_source_t source); |
| 600 | |
| 601 | extern fib_entry_flag_t fib_entry_get_flags(fib_node_index_t fib_entry_index); |
Neale Ranns | df089a8 | 2016-10-02 16:39:06 +0100 | [diff] [blame] | 602 | extern fib_entry_flag_t fib_entry_get_flags_for_source( |
| 603 | fib_node_index_t fib_entry_index, |
| 604 | fib_source_t source); |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 605 | extern fib_source_t fib_entry_get_best_source(fib_node_index_t fib_entry_index); |
| 606 | extern int fib_entry_is_sourced(fib_node_index_t fib_entry_index, |
| 607 | fib_source_t source); |
| 608 | |
| 609 | extern fib_node_index_t fib_entry_get_path_list(fib_node_index_t fib_entry_index); |
Neale Ranns | 88fc83e | 2017-04-05 08:11:14 -0700 | [diff] [blame] | 610 | extern int fib_entry_is_resolved(fib_node_index_t fib_entry_index); |
Neale Ranns | 227038a | 2017-04-21 01:07:59 -0700 | [diff] [blame] | 611 | extern void fib_entry_set_flow_hash_config(fib_node_index_t fib_entry_index, |
| 612 | flow_hash_config_t hash_config); |
Neale Ranns | 0bfe5d8 | 2016-08-25 15:29:12 +0100 | [diff] [blame] | 613 | |
| 614 | extern void fib_entry_module_init(void); |
| 615 | |
| 616 | /* |
| 617 | * unsafe... beware the raw pointer. |
| 618 | */ |
| 619 | extern fib_node_index_t fib_entry_get_index(const fib_entry_t * fib_entry); |
| 620 | extern fib_entry_t * fib_entry_get(fib_node_index_t fib_entry_index); |
| 621 | |
| 622 | /* |
| 623 | * for testing purposes. |
| 624 | */ |
| 625 | extern u32 fib_entry_pool_size(void); |
| 626 | |
| 627 | #endif |