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