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