src/vnet/fib/fib_types.h

   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_TYPES_H__
  17 #define __FIB_TYPES_H__
  18
  19 #include <vlib/vlib.h>
  20 #include <vnet/ip/ip6_packet.h>
  21 #include <vnet/mpls/packet.h>
  22 #include <vnet/dpo/dpo.h>
  23 #include <vnet/bier/bier_types.h>
  24
  25 /**
  26  * A typedef of a node index.
  27  * we make this typedef so the code becomes easier for a human to parse.
  28  */
  29 typedef u32 fib_node_index_t;
  30 #define FIB_NODE_INDEX_INVALID ((fib_node_index_t)(~0))
  31
  32 /**
  33  * Protocol Type. packed so it consumes a u8 only
  34  */
  35 typedef enum fib_protocol_t_ {
  36     FIB_PROTOCOL_IP4 = DPO_PROTO_IP4,
  37     FIB_PROTOCOL_IP6 = DPO_PROTO_IP6,
  38     FIB_PROTOCOL_MPLS = DPO_PROTO_MPLS,
  39 }  __attribute__ ((packed)) fib_protocol_t;
  40
  41 #define FIB_PROTOCOLS {                 \
  42     [FIB_PROTOCOL_IP4] = "ipv4",        \
  43     [FIB_PROTOCOL_IP6] = "ipv6",        \
  44     [FIB_PROTOCOL_MPLS] = "MPLS",       \
  45 }
  46
  47 /**
  48  * Definition outside of enum so it does not need to be included in non-defaulted
  49  * switch statements
  50  */
  51 #define FIB_PROTOCOL_MAX (FIB_PROTOCOL_MPLS + 1)
  52
  53 /**
  54  * Definition outside of enum so it does not need to be included in non-defaulted
  55  * switch statements
  56  */
  57 #define FIB_PROTOCOL_IP_MAX (FIB_PROTOCOL_IP6 + 1)
  58
  59 /**
  60  * Not part of the enum so it does not have to be handled in switch statements
  61  */
  62 #define FIB_PROTOCOL_NONE (FIB_PROTOCOL_MAX+1)
  63
  64 #define FOR_EACH_FIB_PROTOCOL(_item)    \
  65     for (_item = FIB_PROTOCOL_IP4;      \
  66          _item <= FIB_PROTOCOL_MPLS;    \
  67          _item++)
  68
  69 #define FOR_EACH_FIB_IP_PROTOCOL(_item)    \
  70     for (_item = FIB_PROTOCOL_IP4;         \
  71          _item <= FIB_PROTOCOL_IP6;        \
  72          _item++)
  73
  74 /**
  75  * @brief Convert from a protocol to a link type
  76  */
  77 vnet_link_t fib_proto_to_link (fib_protocol_t proto);
  78
  79 /**
  80  * FIB output chain type. When a child object requests a forwarding contribution
  81  * from a parent, it does so for a particular scenario. This enumererates those
  82  * sceanrios
  83  */
  84 typedef enum fib_forward_chain_type_t_ {
  85     /**
  86      * Contribute an object that is to be used to forward IP4 packets
  87      */
  88     FIB_FORW_CHAIN_TYPE_UNICAST_IP4,
  89     /**
  90      * Contribute an object that is to be used to forward IP6 packets
  91      */
  92     FIB_FORW_CHAIN_TYPE_UNICAST_IP6,
  93     /**
  94      * Contribute an object that is to be used to forward non-end-of-stack
  95      * MPLS packets
  96      */
  97     FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS,
  98     /**
  99      * Contribute an object that is to be used to forward BIER packets.
 100      */
 101     FIB_FORW_CHAIN_TYPE_BIER,
 102     /**
 103      * Contribute an object that is to be used to forward end-of-stack
 104      * MPLS packets. This is a convenient ID for clients. A real EOS chain
 105      * must be pay-load protocol specific. This
 106      * option is converted into one of the other three internally.
 107      */
 108     FIB_FORW_CHAIN_TYPE_MPLS_EOS,
 109     /**
 110      * Contribute an object that is to be used to forward IP4 packets
 111      */
 112     FIB_FORW_CHAIN_TYPE_MCAST_IP4,
 113     /**
 114      * Contribute an object that is to be used to forward IP6 packets
 115      */
 116     FIB_FORW_CHAIN_TYPE_MCAST_IP6,
 117     /**
 118      * Contribute an object that is to be used to forward Ethernet packets.
 119      */
 120     FIB_FORW_CHAIN_TYPE_ETHERNET,
 121     /**
 122      * Contribute an object that is to be used to forward NSH packets.
 123      * This is last in the list since it is not valid for many FIB objects,
 124      * and thus their array of per-chain-type DPOs can be sized smaller.
 125      */
 126     FIB_FORW_CHAIN_TYPE_NSH,
 127 }  __attribute__ ((packed)) fib_forward_chain_type_t;
 128
 129 #define FIB_FORW_CHAINS {                                       \
 130     [FIB_FORW_CHAIN_TYPE_ETHERNET]      = "ethernet",           \
 131     [FIB_FORW_CHAIN_TYPE_BIER]          = "bier",               \
 132     [FIB_FORW_CHAIN_TYPE_UNICAST_IP4]   = "unicast-ip4",        \
 133     [FIB_FORW_CHAIN_TYPE_UNICAST_IP6]   = "unicast-ip6",        \
 134     [FIB_FORW_CHAIN_TYPE_MCAST_IP4]     = "multicast-ip4",      \
 135     [FIB_FORW_CHAIN_TYPE_MCAST_IP6]     = "multicast-ip6",      \
 136     [FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS]  = "mpls-neos",          \
 137     [FIB_FORW_CHAIN_TYPE_MPLS_EOS]      = "mpls-eos",           \
 138     [FIB_FORW_CHAIN_TYPE_NSH]           = "nsh",                \
 139 }
 140
 141 #define FIB_FORW_CHAIN_NUM (FIB_FORW_CHAIN_TYPE_NSH+1)
 142 #define FIB_FORW_CHAIN_MPLS_NUM (FIB_FORW_CHAIN_TYPE_MPLS_EOS+1)
 143
 144 #define FOR_EACH_FIB_FORW_CHAIN(_item)                    \
 145     for (_item = FIB_FORW_CHAIN_TYPE_UNICAST_IP4;         \
 146          _item <= FIB_FORW_CHAIN_TYPE_NSH;                \
 147          _item++)
 148
 149 #define FOR_EACH_FIB_FORW_MPLS_CHAIN(_item)               \
 150     for (_item = FIB_FORW_CHAIN_TYPE_UNICAST_IP4;         \
 151          _item <= FIB_FORW_CHAIN_TYPE_MPLS_EOS;           \
 152          _item++)
 153
 154 /**
 155  * @brief Convert from a chain type to the adjacencies link type
 156  */
 157 extern vnet_link_t fib_forw_chain_type_to_link_type(fib_forward_chain_type_t fct);
 158
 159 /**
 160  * @brief Convert from a payload-protocol to a chain type.
 161  */
 162 extern fib_forward_chain_type_t fib_forw_chain_type_from_dpo_proto(dpo_proto_t proto);
 163
 164 /**
 165  * @brief Convert from a chain type to the DPO proto it will install
 166  */
 167 extern dpo_proto_t fib_forw_chain_type_to_dpo_proto(fib_forward_chain_type_t fct);
 168
 169 /**
 170  * Aggregrate type for a prefix
 171  */
 172 typedef struct fib_prefix_t_ {
 173     /**
 174      * The mask length
 175      */
 176     u16 fp_len;
 177
 178     /**
 179      * protocol type
 180      */
 181     fib_protocol_t fp_proto;
 182
 183     /**
 184      * Pad to keep the address 4 byte aligned
 185      */
 186     u8 ___fp___pad;
 187
 188     union {
 189         /**
 190          * The address type is not deriveable from the fp_addr member.
 191          * If it's v4, then the first 3 u32s of the address will be 0.
 192          * v6 addresses (even v4 mapped ones) have at least 2 u32s assigned
 193          * to non-zero values. true. but when it's all zero, one cannot decide.
 194          */
 195         ip46_address_t fp_addr;
 196
 197         struct {
 198             mpls_label_t fp_label;
 199             mpls_eos_bit_t fp_eos;
 200             /**
 201              * This protocol determines the payload protocol of packets
 202              * that will be forwarded by this entry once the label is popped.
 203              * For a non-eos entry it will be MPLS.
 204              */
 205             dpo_proto_t fp_payload_proto;
 206         };
 207     };
 208 } fib_prefix_t;
 209
 210 STATIC_ASSERT(STRUCT_OFFSET_OF(fib_prefix_t, fp_addr) == 4,
 211               "FIB Prefix's address is 4 byte aligned.");
 212
 213 /**
 214  * \brief Compare two prefixes for equality
 215  */
 216 extern int fib_prefix_cmp(const fib_prefix_t *p1,
 217                           const fib_prefix_t *p2);
 218
 219 /**
 220  * \brief Compare two prefixes for covering relationship
 221  *
 222  * \return non-zero if the first prefix is a cover for the second
 223  */
 224 extern int fib_prefix_is_cover(const fib_prefix_t *p1,
 225                                const fib_prefix_t *p2);
 226
 227 /**
 228  * \brief Return true is the prefix is a host prefix
 229  */
 230 extern int fib_prefix_is_host(const fib_prefix_t *p);
 231
 232
 233 /**
 234  * \brief Host prefix from ip
 235  */
 236 extern void fib_prefix_from_ip46_addr (const ip46_address_t *addr,
 237                            fib_prefix_t *pfx);
 238
 239 extern u8 * format_fib_prefix(u8 * s, va_list * args);
 240 extern u8 * format_fib_forw_chain_type(u8 * s, va_list * args);
 241
 242 extern dpo_proto_t fib_proto_to_dpo(fib_protocol_t fib_proto);
 243 extern fib_protocol_t dpo_proto_to_fib(dpo_proto_t dpo_proto);
 244
 245 /**
 246  * Convert from BIER next-hop proto to FIB proto
 247  */
 248 extern fib_protocol_t bier_hdr_proto_to_fib(bier_hdr_proto_id_t bproto);
 249
 250 /**
 251  * Enurmeration of special path/entry types
 252  */
 253 typedef enum fib_special_type_t_ {
 254     /**
 255      * Marker. Add new types after this one.
 256      */
 257     FIB_SPECIAL_TYPE_FIRST = 0,
 258     /**
 259      * Local/for-us paths
 260      */
 261     FIB_SPECIAL_TYPE_LOCAL = FIB_SPECIAL_TYPE_FIRST,
 262     /**
 263      * drop paths
 264      */
 265     FIB_SPECIAL_TYPE_DROP,
 266     /**
 267      * Marker. Add new types before this one, then update it.
 268      */
 269     FIB_SPECIAL_TYPE_LAST = FIB_SPECIAL_TYPE_DROP,
 270 } __attribute__ ((packed)) fib_special_type_t;
 271
 272 /**
 273  * The maximum number of types
 274  */
 275 #define FIB_SPEICAL_TYPE_MAX (FIB_SPEICAL_TYPE_LAST + 1)
 276
 277 #define FOR_EACH_FIB_SPEICAL_TYPE(_item)                \
 278     for (_item = FIB_TYPE_SPEICAL_FIRST;                \
 279          _item <= FIB_SPEICAL_TYPE_LAST; _item++)
 280
 281 extern u8 * format_fib_protocol(u8 * s, va_list *ap);
 282 extern u8 * format_vnet_link(u8 *s, va_list *ap);
 283
 284 /**
 285  * Path flags from the control plane
 286  */
 287 typedef enum fib_route_path_flags_t_
 288 {
 289     FIB_ROUTE_PATH_FLAG_NONE = 0,
 290     /**
 291      * Recursion constraint of via a host prefix
 292      */
 293     FIB_ROUTE_PATH_RESOLVE_VIA_HOST = (1 << 0),
 294     /**
 295      * Recursion constraint of via an attahced prefix
 296      */
 297     FIB_ROUTE_PATH_RESOLVE_VIA_ATTACHED = (1 << 1),
 298     /**
 299      * A for-us/local path
 300      */
 301     FIB_ROUTE_PATH_LOCAL = (1 << 2),
 302     /**
 303      * Attached path
 304      */
 305     FIB_ROUTE_PATH_ATTACHED = (1 << 3),
 306     /**
 307      * A Drop path - resolve the path on the drop DPO
 308      */
 309     FIB_ROUTE_PATH_DROP = (1 << 4),
 310     /**
 311      * Don't resolve the path, use the DPO the client provides
 312      */
 313     FIB_ROUTE_PATH_EXCLUSIVE = (1 << 5),
 314     /**
 315      * A path that result in received traffic being recieved/recirculated
 316      * so that it appears to have arrived on the new interface
 317      */
 318     FIB_ROUTE_PATH_INTF_RX = (1 << 6),
 319     /**
 320      * A local path with a RPF-ID => multicast traffic
 321      */
 322     FIB_ROUTE_PATH_RPF_ID = (1 << 7),
 323     /**
 324      * A deag path using the packet's source not destination address.
 325      */
 326     FIB_ROUTE_PATH_SOURCE_LOOKUP = (1 << 8),
 327     /**
 328      * A path via a UDP encap object.
 329      */
 330     FIB_ROUTE_PATH_UDP_ENCAP = (1 << 9),
 331     /**
 332      * A path that resolves via a BIER F-Mask
 333      */
 334     FIB_ROUTE_PATH_BIER_FMASK = (1 << 10),
 335     /**
 336      * A path that resolves via a BIER [ECMP] Table
 337      */
 338     FIB_ROUTE_PATH_BIER_TABLE = (1 << 11),
 339     /**
 340      * A path that resolves via a BIER impostion object
 341      */
 342     FIB_ROUTE_PATH_BIER_IMP = (1 << 12),
 343     /**
 344      * A path that resolves via another table
 345      */
 346     FIB_ROUTE_PATH_DEAG = (1 << 13),
 347     /**
 348      * A path that resolves via a DVR DPO
 349      */
 350     FIB_ROUTE_PATH_DVR = (1 << 14),
 351 } fib_route_path_flags_t;
 352
 353 /**
 354  * An RPF-ID is numerical value that is used RPF validate. An entry
 355  * has-a RPF-ID, when a packet egress from (e.g. an LSP) it gains an
 356  * RPF-ID, these two are compared for the RPF check.
 357  * This replaces the interfce based chack (since the LSP has no associated
 358  * interface.
 359  */
 360 typedef u32 fib_rpf_id_t;
 361
 362 #define MFIB_RPF_ID_NONE (0)
 363
 364 /**
 365  * @brief
 366  * A representation of a path as described by a route producer.
 367  * These paramenters will determine the path 'type', of which there are:
 368  * 1) Attached-next-hop:
 369  *   a single peer on a link.
 370  *   It is 'attached' because it is in the same sub-net as the router, on a link
 371  *   directly connected to the route.
 372  *   It is 'next=hop' since the next-hop address of the peer is known.
 373  * 2) Attached:
 374  *  the next-hop is not known. but we can ARP for it.
 375  * 3) Recursive.
 376  *  The next-hop is known but the interface is not. So to find the adj to use
 377  *  we must recursively resolve the next-hop.
 378  * 3) deaggregate (deag)
 379  *  A further lookup is required.
 380  */
 381 typedef struct fib_route_path_t_ {
 382     /**
 383      * The protocol of the address below. We need this since the all
 384      * zeros address is ambiguous.
 385      */
 386     dpo_proto_t frp_proto;
 387
 388     union {
 389         struct {
 390             union {
 391                 /**
 392                  * The next-hop address.
 393                  * Will be NULL for attached paths.
 394                  * Will be all zeros for attached-next-hop paths on a p2p interface
 395                  * Will be all zeros for a deag path.
 396                  */
 397                 ip46_address_t frp_addr;
 398
 399                 struct {
 400                     /**
 401                      * The MPLS local Label to reursively resolve through.
 402                      * This is valid when the path type is MPLS.
 403                      */
 404                     mpls_label_t frp_local_label;
 405                     /**
 406                      * EOS bit for the resolving label
 407                      */
 408                     mpls_eos_bit_t frp_eos;
 409                 };
 410             };
 411             union {
 412                 /**
 413                  * The interface.
 414                  * Will be invalid for recursive paths.
 415                  */
 416                 u32 frp_sw_if_index;
 417                 /**
 418                  * The RPF-ID
 419                  */
 420                 fib_rpf_id_t frp_rpf_id;
 421             };
 422             union {
 423                 /**
 424                  * The FIB index to lookup the nexthop
 425                  * Only valid for recursive paths.
 426                  */
 427                 u32 frp_fib_index;
 428                 /**
 429                  * The BIER table to resolve the fmask in
 430                  */
 431                 u32 frp_bier_fib_index;
 432             };
 433             /**
 434              * The outgoing MPLS label Stack. NULL implies no label.
 435              */
 436             mpls_label_t *frp_label_stack;
 437         };
 438         /**
 439          * A path that resolves via a BIER Table.
 440          * This would be for a MPLS label at a BIER midpoint or tail
 441          */
 442         bier_table_id_t frp_bier_tbl;
 443
 444         /**
 445          * A path via a BIER imposition object.
 446          * Present in an mfib path list
 447          */
 448         index_t frp_bier_imp;
 449
 450         /**
 451          * UDP encap ID
 452          */
 453         u32 frp_udp_encap_id;
 454
 455         /**
 456          * Resolving via a BIER Fmask
 457          */
 458         index_t frp_bier_fmask;
 459     };
 460     /**
 461      * [un]equal cost path weight
 462      */
 463     u8 frp_weight;
 464     /**
 465      * A path preference. 0 is the best.
 466      * Only paths of the best preference, that are 'up', are considered
 467      * for forwarding.
 468      */
 469     u8 frp_preference;
 470     /**
 471      * flags on the path
 472      */
 473     fib_route_path_flags_t frp_flags;
 474 } fib_route_path_t;
 475
 476 /**
 477  * Unformat a fib_route_path_t from CLI input
 478  */
 479 extern uword unformat_fib_route_path(unformat_input_t * input, va_list * args);
 480
 481 /**
 482  * A help string to list the FIB path options
 483  */
 484 #define FIB_ROUTE_PATH_HELP "[next-hop-address] [next-hop-interface] [next-hop-table <value>] [weight <value>] [preference <value>] [udp-encap-id <value>] [ip4-lookup-in-table <value>] [ip6-lookup-in-table <value>] [mpls-lookup-in-table <value>] [resolve-via-host] [resolve-via-connected] [rx-ip4 <interface>] [out-labels <value value value>]"
 485
 486 /**
 487  * @brief
 488  * A representation of a fib path for fib_path_encode to convey the information to the caller
 489  */
 490 typedef struct fib_route_path_encode_t_ {
 491     fib_route_path_t rpath;
 492     dpo_id_t dpo;
 493 } fib_route_path_encode_t;
 494
 495 /**
 496  * return code to control pat-hlist walk
 497  */
 498 typedef enum fib_path_list_walk_rc_t_
 499 {
 500     FIB_PATH_LIST_WALK_STOP,
 501     FIB_PATH_LIST_WALK_CONTINUE,
 502 } fib_path_list_walk_rc_t;
 503
 504 /**
 505  * A list of path-extensions
 506  */
 507 typedef struct fib_path_ext_list_t_
 508 {
 509     struct fib_path_ext_t_ *fpel_exts;
 510 } fib_path_ext_list_t;
 511
 512 #endif