vnet/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
  24 /**
  25  * A typedef of a node index.
  26  * we make this typedef so the code becomes easier for a human to parse.
  27  */
  28 typedef u32 fib_node_index_t;
  29 #define FIB_NODE_INDEX_INVALID ((fib_node_index_t)(~0))
  30
  31 /**
  32  * Protocol Type. packed so it consumes a u8 only
  33  */
  34 typedef enum fib_protocol_t_ {
  35 #if CLIB_DEBUG > 0
  36     FIB_PROTOCOL_IP4 = 1,
  37 #else
  38     FIB_PROTOCOL_IP4 = 0,
  39 #endif
  40     FIB_PROTOCOL_IP6,
  41     FIB_PROTOCOL_MPLS,
  42 }  __attribute__ ((packed)) fib_protocol_t;
  43
  44 #define FIB_PROTOCOLS {                 \
  45     [FIB_PROTOCOL_IP4] = "ipv4",        \
  46     [FIB_PROTOCOL_IP6] = "ipv6",        \
  47     [FIB_PROTOCOL_MPLS] = "MPLS",       \
  48 }
  49
  50 /**
  51  * Definition outside of enum so it does not need to be included in non-defaulted
  52  * switch statements
  53  */
  54 #define FIB_PROTOCOL_MAX (FIB_PROTOCOL_MPLS + 1)
  55
  56 /**
  57  * Not part of the enum so it does not have to be handled in switch statements
  58  */
  59 #define FIB_PROTOCOL_NONE (FIB_PROTOCOL_MAX+1)
  60
  61 #define FOR_EACH_FIB_PROTOCOL(_item)    \
  62     for (_item = FIB_PROTOCOL_IP4;      \
  63          _item <= FIB_PROTOCOL_MPLS;    \
  64          _item++)
  65
  66 #define FOR_EACH_FIB_IP_PROTOCOL(_item)    \
  67     for (_item = FIB_PROTOCOL_IP4;         \
  68          _item <= FIB_PROTOCOL_IP6;        \
  69          _item++)
  70
  71
  72 /**
  73  * Link Type. This maps directly into the ethertype.
  74  */
  75 typedef enum fib_link_t_ {
  76     FIB_LINK_IP4 = VNET_LINK_IP4,
  77     FIB_LINK_IP6 = VNET_LINK_IP6,
  78     FIB_LINK_MPLS = VNET_LINK_MPLS,
  79     FIB_LINK_ETHERNET = VNET_LINK_ETHERNET,
  80 }  __attribute__ ((packed)) fib_link_t;
  81
  82 /**
  83  * Definition outside of enum so it does not need to be included in non-defaulted
  84  * switch statements
  85  */
  86 #define FIB_LINK_NUM (FIB_LINK_ETHERNET+1)
  87
  88 #define FIB_LINKS {                   \
  89     [FIB_LINK_ETHERNET] = "ethernet", \
  90     [FIB_LINK_IP4] = "ipv4",          \
  91     [FIB_LINK_IP6] = "ipv6",          \
  92     [FIB_LINK_MPLS] = "mpls",         \
  93 }
  94
  95 #define FOR_EACH_FIB_LINK(_item)    \
  96     for (_item = FIB_LINK_IP4;      \
  97          _item <= FIB_LINK_MPLS;    \
  98          _item++)
  99
 100 #define FOR_EACH_FIB_IP_LINK(_item)  \
 101     for (_item = FIB_LINK_IP4;       \
 102          _item <= FIB_LINK_IP6;      \
 103          _item++)
 104
 105 /**
 106  * @brief Convert from a protocol to a link type
 107  */
 108 fib_link_t fib_proto_to_link (fib_protocol_t proto);
 109
 110 /**
 111  * FIB output chain type. When a child object requests a forwarding contribution
 112  * from a parent, it does so for a particular scenario. This enumererates those
 113  * sceanrios
 114  */
 115 typedef enum fib_forward_chain_type_t_ {
 116     /**
 117      * Contribute an object that is to be used to forward IP4 packets
 118      */
 119     FIB_FORW_CHAIN_TYPE_UNICAST_IP4,
 120     /**
 121      * Contribute an object that is to be used to forward IP6 packets
 122      */
 123     FIB_FORW_CHAIN_TYPE_UNICAST_IP6,
 124     /**
 125      * Contribute an object that is to be used to forward non-end-of-stack
 126      * MPLS packets
 127      */
 128     FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS,
 129     /**
 130      * Contribute an object that is to be used to forward end-of-stack
 131      * MPLS packets. This is a convenient ID for clients. A real EOS chain
 132      * must be pay-load protocol specific. This
 133      * option is converted into one of the other three internally.
 134      */
 135     FIB_FORW_CHAIN_TYPE_MPLS_EOS,
 136     /**
 137      * Contribute an object that is to be used to forward Ethernet packets.
 138      * This is last in the list since it is not valid for many FIB objects,
 139      * and thus their array of per-chain-type DPOs can be sized smaller.
 140      */
 141     FIB_FORW_CHAIN_TYPE_ETHERNET,
 142 }  __attribute__ ((packed)) fib_forward_chain_type_t;
 143
 144 #define FIB_FORW_CHAINS {                                       \
 145     [FIB_FORW_CHAIN_TYPE_ETHERNET]      = "ethernet",           \
 146     [FIB_FORW_CHAIN_TYPE_UNICAST_IP4]   = "unicast-ip4",        \
 147     [FIB_FORW_CHAIN_TYPE_UNICAST_IP6]   = "unicast-ip6",        \
 148     [FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS]  = "mpls-neos",          \
 149     [FIB_FORW_CHAIN_TYPE_MPLS_EOS]      = "mpls-eos",           \
 150 }
 151
 152 #define FIB_FORW_CHAIN_NUM (FIB_FORW_CHAIN_TYPE_MPLS_ETHERNET+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_ETHERNET;           \
 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 adjacencies link type
 167  */
 168 extern fib_link_t fib_forw_chain_type_to_link_type(fib_forward_chain_type_t fct);
 169
 170 /**
 171  * @brief Convert from a payload-protocol to a chain type.
 172  */
 173 extern fib_forward_chain_type_t fib_forw_chain_type_from_dpo_proto(dpo_proto_t proto);
 174
 175 /**
 176  * @brief Convert from a chain type to the DPO proto it will install
 177  */
 178 extern dpo_proto_t fib_forw_chain_type_to_dpo_proto(fib_forward_chain_type_t fct);
 179
 180 /**
 181  * Aggregrate type for a prefix
 182  */
 183 typedef struct fib_prefix_t_ {
 184     /**
 185      * The mask length
 186      */
 187     u16 fp_len;
 188
 189     /**
 190      * protocol type
 191      */
 192     fib_protocol_t fp_proto;
 193
 194     /**
 195      * Pad to keep the address 4 byte aligned
 196      */
 197     u8 ___fp___pad;
 198
 199     union {
 200         /**
 201          * The address type is not deriveable from the fp_addr member.
 202          * If it's v4, then the first 3 u32s of the address will be 0.
 203          * v6 addresses (even v4 mapped ones) have at least 2 u32s assigned
 204          * to non-zero values. true. but when it's all zero, one cannot decide.
 205          */
 206         ip46_address_t fp_addr;
 207
 208         struct {
 209             mpls_label_t fp_label;
 210             mpls_eos_bit_t fp_eos;
 211             /**
 212              * This protocol determines the payload protocol of packets
 213              * that will be forwarded by this entry once the label is popped.
 214              * For a non-eos entry it will be MPLS.
 215              */
 216             dpo_proto_t fp_payload_proto;
 217         };
 218     };
 219 } fib_prefix_t;
 220
 221 _Static_assert(STRUCT_OFFSET_OF(fib_prefix_t, fp_addr) == 4,
 222                "FIB Prefix's address is 4 byte aligned.");
 223
 224 /**
 225  * \brief Compare two prefixes for equality
 226  */
 227 extern int fib_prefix_cmp(const fib_prefix_t *p1,
 228                           const fib_prefix_t *p2);
 229
 230 /**
 231  * \brief Compare two prefixes for covering relationship
 232  *
 233  * \return non-zero if the first prefix is a cover for the second
 234  */
 235 extern int fib_prefix_is_cover(const fib_prefix_t *p1,
 236                                const fib_prefix_t *p2);
 237
 238 /**
 239  * \brief Return true is the prefix is a host prefix
 240  */
 241 extern int fib_prefix_is_host(const fib_prefix_t *p);
 242
 243 extern u8 * format_fib_prefix(u8 * s, va_list * args);
 244 extern u8 * format_fib_forw_chain_type(u8 * s, va_list * args);
 245
 246 extern dpo_proto_t fib_proto_to_dpo(fib_protocol_t fib_proto);
 247 extern dpo_proto_t fib_link_to_dpo_proto(fib_link_t linkt);
 248 extern fib_protocol_t dpo_proto_to_fib(dpo_proto_t dpo_proto);
 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_fib_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 } fib_route_path_flags_t;
 299
 300 /**
 301  * @brief
 302  * A representation of a path as described by a route producer.
 303  * These paramenters will determine the path 'type', of which there are:
 304  * 1) Attached-next-hop:
 305  *   a single peer on a link.
 306  *   It is 'attached' because it is in the same sub-net as the router, on a link
 307  *   directly connected to the route.
 308  *   It is 'next=hop' since the next-hop address of the peer is known.
 309  * 2) Attached:
 310  *  the next-hop is not known. but we can ARP for it.
 311  * 3) Recursive.
 312  *  The next-hop is known but the interface is not. So to find the adj to use
 313  *  we must recursively resolve the next-hop.
 314  * 3) deaggregate (deag)
 315  *  A further lookup is required.
 316  */
 317 typedef struct fib_route_path_t_ {
 318     /**
 319      * The protocol of the address below. We need this since the all
 320      * zeros address is ambiguous.
 321      */
 322     fib_protocol_t frp_proto;
 323     /**
 324      * The next-hop address.
 325      * Will be NULL for attached paths.
 326      * Will be all zeros for attached-next-hop paths on a p2p interface
 327      * Will be all zeros for a deag path.
 328      */
 329     ip46_address_t frp_addr;
 330     /**
 331      * The interface.
 332      * Will be invalid for recursive paths.
 333      */
 334     u32 frp_sw_if_index;
 335     /**
 336      * The FIB index to lookup the nexthop
 337      * Only valid for recursive paths.
 338      */
 339     u32 frp_fib_index;
 340     /**
 341      * [un]equal cost path weight
 342      */
 343     u32 frp_weight;
 344     /**
 345      * flags on the path
 346      */
 347     fib_route_path_flags_t frp_flags;
 348     /**
 349      * The outgoing MPLS label. INVALID implies no label.
 350      */
 351     mpls_label_t frp_label;
 352 } fib_route_path_t;
 353
 354 #endif