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 #if CLIB_DEBUG > 0
  77     FIB_LINK_IP4 = 1,
  78 #else
  79     FIB_LINK_IP4 = 0,
  80 #endif
  81     FIB_LINK_IP6,
  82     FIB_LINK_ETHERNET,
  83     FIB_LINK_MPLS,
  84 }  __attribute__ ((packed)) fib_link_t;
  85
  86 /**
  87  * Definition outside of enum so it does not need to be included in non-defaulted
  88  * switch statements
  89  */
  90 #define FIB_LINK_NUM (FIB_LINK_MPLS+1)
  91
  92 #define FIB_LINKS {                   \
  93     [FIB_LINK_ETHERNET] = "ethernet", \
  94     [FIB_LINK_IP4] = "ipv4",          \
  95     [FIB_LINK_IP6] = "ipv6",          \
  96     [FIB_LINK_MPLS] = "mpls",         \
  97 }
  98
  99 #define FOR_EACH_FIB_LINK(_item)    \
 100     for (_item = FIB_LINK_IP4;      \
 101          _item <= FIB_LINK_MPLS;    \
 102          _item++)
 103
 104 #define FOR_EACH_FIB_IP_LINK(_item)  \
 105     for (_item = FIB_LINK_IP4;       \
 106          _item <= FIB_LINK_IP6;      \
 107          _item++)
 108
 109 /**
 110  * @brief Convert from a protocol to a link type
 111  */
 112 fib_link_t fib_proto_to_link (fib_protocol_t proto);
 113
 114 /**
 115  * FIB output chain type. When a child object requests a forwarding contribution
 116  * from a parent, it does so for a particular scenario. This enumererates those
 117  * sceanrios
 118  */
 119 typedef enum fib_forward_chain_type_t_ {
 120     /**
 121      * Contribute an object that is to be used to forward IP4 packets
 122      */
 123     FIB_FORW_CHAIN_TYPE_UNICAST_IP4,
 124     /**
 125      * Contribute an object that is to be used to forward IP6 packets
 126      */
 127     FIB_FORW_CHAIN_TYPE_UNICAST_IP6,
 128     /**
 129      * Contribute an object that is to be used to forward non-end-of-stack
 130      * MPLS packets
 131      */
 132     FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS,
 133     /**
 134      * Contribute an object that is to be used to forward end-of-stack
 135      * MPLS packets. This is a convenient ID for clients. A real EOS chain
 136      * must be pay-load protocol specific. This
 137      * option is converted into one of the other three internally.
 138      */
 139     FIB_FORW_CHAIN_TYPE_MPLS_EOS,
 140     /**
 141      * Contribute an object that is to be used to forward Ethernet packets.
 142      * This is last in the list since it is not valid for many FIB objects,
 143      * and thus their array of per-chain-type DPOs can be sized smaller.
 144      */
 145     FIB_FORW_CHAIN_TYPE_ETHERNET,
 146 }  __attribute__ ((packed)) fib_forward_chain_type_t;
 147
 148 #define FIB_FORW_CHAINS {                                       \
 149     [FIB_FORW_CHAIN_TYPE_ETHERNET]      = "ethernet",           \
 150     [FIB_FORW_CHAIN_TYPE_UNICAST_IP4]   = "unicast-ip4",        \
 151     [FIB_FORW_CHAIN_TYPE_UNICAST_IP6]   = "unicast-ip6",        \
 152     [FIB_FORW_CHAIN_TYPE_MPLS_NON_EOS]  = "mpls-neos",          \
 153     [FIB_FORW_CHAIN_TYPE_MPLS_EOS]      = "mpls-eos",           \
 154 }
 155
 156 #define FIB_FORW_CHAIN_NUM (FIB_FORW_CHAIN_TYPE_MPLS_ETHERNET+1)
 157 #define FIB_FORW_CHAIN_MPLS_NUM (FIB_FORW_CHAIN_TYPE_MPLS_EOS+1)
 158
 159 #define FOR_EACH_FIB_FORW_CHAIN(_item)                    \
 160     for (_item = FIB_FORW_CHAIN_TYPE_ETHERNET;            \
 161          _item <= FIB_FORW_CHAIN_TYPE_MPLS_EOS;           \
 162          _item++)
 163
 164 /**
 165  * @brief Convert from a chain type to the adjacencies link type
 166  */
 167 extern fib_link_t fib_forw_chain_type_to_link_type(fib_forward_chain_type_t fct);
 168
 169 /**
 170  * @brief Convert from a payload-protocol to a chain type.
 171  */
 172 extern fib_forward_chain_type_t fib_forw_chain_type_from_dpo_proto(dpo_proto_t proto);
 173
 174 /**
 175  * @brief Convert from a chain type to the DPO proto it will install
 176  */
 177 extern dpo_proto_t fib_forw_chain_type_to_dpo_proto(fib_forward_chain_type_t fct);
 178
 179 /**
 180  * Aggregrate type for a prefix
 181  */
 182 typedef struct fib_prefix_t_ {
 183     /**
 184      * The mask length
 185      */
 186     u16 fp_len;
 187
 188     /**
 189      * protocol type
 190      */
 191     fib_protocol_t fp_proto;
 192
 193     /**
 194      * Pad to keep the address 4 byte aligned
 195      */
 196     u8 ___fp___pad;
 197
 198     union {
 199         /**
 200          * The address type is not deriveable from the fp_addr member.
 201          * If it's v4, then the first 3 u32s of the address will be 0.
 202          * v6 addresses (even v4 mapped ones) have at least 2 u32s assigned
 203          * to non-zero values. true. but when it's all zero, one cannot decide.
 204          */
 205         ip46_address_t fp_addr;
 206
 207         struct {
 208             mpls_label_t fp_label;
 209             mpls_eos_bit_t fp_eos;
 210             /**
 211              * This protocol determines the payload protocol of packets
 212              * that will be forwarded by this entry once the label is popped.
 213              * For a non-eos entry it will be MPLS.
 214              */
 215             dpo_proto_t fp_payload_proto;
 216         };
 217     };
 218 } fib_prefix_t;
 219
 220 _Static_assert(STRUCT_OFFSET_OF(fib_prefix_t, fp_addr) == 4,
 221                "FIB Prefix's address is 4 byte aligned.");
 222
 223 /**
 224  * \brief Compare two prefixes for equality
 225  */
 226 extern int fib_prefix_cmp(const fib_prefix_t *p1,
 227                           const fib_prefix_t *p2);
 228
 229 /**
 230  * \brief Compare two prefixes for covering relationship
 231  *
 232  * \return non-zero if the first prefix is a cover for the second
 233  */
 234 extern int fib_prefix_is_cover(const fib_prefix_t *p1,
 235                                const fib_prefix_t *p2);
 236
 237 /**
 238  * \brief Return true is the prefix is a host prefix
 239  */
 240 extern int fib_prefix_is_host(const fib_prefix_t *p);
 241
 242 extern u8 * format_fib_prefix(u8 * s, va_list * args);
 243 extern u8 * format_fib_forw_chain_type(u8 * s, va_list * args);
 244
 245 extern dpo_proto_t fib_proto_to_dpo(fib_protocol_t fib_proto);
 246 extern dpo_proto_t fib_link_to_dpo_proto(fib_link_t linkt);
 247 extern fib_protocol_t dpo_proto_to_fib(dpo_proto_t dpo_proto);
 248
 249 /**
 250  * Enurmeration of special path/entry types
 251  */
 252 typedef enum fib_special_type_t_ {
 253     /**
 254      * Marker. Add new types after this one.
 255      */
 256     FIB_SPECIAL_TYPE_FIRST = 0,
 257     /**
 258      * Local/for-us paths
 259      */
 260     FIB_SPECIAL_TYPE_LOCAL = FIB_SPECIAL_TYPE_FIRST,
 261     /**
 262      * drop paths
 263      */
 264     FIB_SPECIAL_TYPE_DROP,
 265     /**
 266      * Marker. Add new types before this one, then update it.
 267      */
 268     FIB_SPECIAL_TYPE_LAST = FIB_SPECIAL_TYPE_DROP,
 269 } __attribute__ ((packed)) fib_special_type_t;
 270
 271 /**
 272  * The maximum number of types
 273  */
 274 #define FIB_SPEICAL_TYPE_MAX (FIB_SPEICAL_TYPE_LAST + 1)
 275
 276 #define FOR_EACH_FIB_SPEICAL_TYPE(_item)                \
 277     for (_item = FIB_TYPE_SPEICAL_FIRST;                \
 278          _item <= FIB_SPEICAL_TYPE_LAST; _item++)
 279
 280 extern u8 * format_fib_protocol(u8 * s, va_list ap);
 281 extern u8 * format_fib_link(u8 *s, va_list ap);
 282
 283 /**
 284  * Path flags from the control plane
 285  */
 286 typedef enum fib_route_path_flags_t_
 287 {
 288     FIB_ROUTE_PATH_FLAG_NONE = 0,
 289     /**
 290      * Recursion constraint of via a host prefix
 291      */
 292     FIB_ROUTE_PATH_RESOLVE_VIA_HOST = (1 << 0),
 293     /**
 294      * Recursion constraint of via an attahced prefix
 295      */
 296     FIB_ROUTE_PATH_RESOLVE_VIA_ATTACHED = (1 << 1),
 297 } fib_route_path_flags_t;
 298
 299 /**
 300  * @brief
 301  * A representation of a path as described by a route producer.
 302  * These paramenters will determine the path 'type', of which there are:
 303  * 1) Attached-next-hop:
 304  *   a single peer on a link.
 305  *   It is 'attached' because it is in the same sub-net as the router, on a link
 306  *   directly connected to the route.
 307  *   It is 'next=hop' since the next-hop address of the peer is known.
 308  * 2) Attached:
 309  *  the next-hop is not known. but we can ARP for it.
 310  * 3) Recursive.
 311  *  The next-hop is known but the interface is not. So to find the adj to use
 312  *  we must recursively resolve the next-hop.
 313  * 3) deaggregate (deag)
 314  *  A further lookup is required.
 315  */
 316 typedef struct fib_route_path_t_ {
 317     /**
 318      * The protocol of the address below. We need this since the all
 319      * zeros address is ambiguous.
 320      */
 321     fib_protocol_t frp_proto;
 322     /**
 323      * The next-hop address.
 324      * Will be NULL for attached paths.
 325      * Will be all zeros for attached-next-hop paths on a p2p interface
 326      * Will be all zeros for a deag path.
 327      */
 328     ip46_address_t frp_addr;
 329     /**
 330      * The interface.
 331      * Will be invalid for recursive paths.
 332      */
 333     u32 frp_sw_if_index;
 334     /**
 335      * The FIB index to lookup the nexthop
 336      * Only valid for recursive paths.
 337      */
 338     u32 frp_fib_index;
 339     /**
 340      * [un]equal cost path weight
 341      */
 342     u32 frp_weight;
 343     /**
 344      * flags on the path
 345      */
 346     fib_route_path_flags_t frp_flags;
 347     /**
 348      * The outgoing MPLS label. INVALID implies no label.
 349      */
 350     mpls_label_t frp_label;
 351 } fib_route_path_t;
 352
 353 #endif