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