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