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