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