src/vnet/adj/adj.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  * An adjacency is a representation of an attached L3 peer.
  17  *
  18  * Adjacency Sub-types:
  19  *   - neighbour: a representation of an attached L3 peer.
  20  *                Key:{addr,interface,link/ether-type}
  21  *           SHARED
  22  *   - glean: used to drive ARP/ND for packets destined to a local sub-net.
  23  *            'glean' mean use the packet's destination address as the target
  24  *            address in the ARP packet.
  25  *          UNSHARED. Only one per-interface.
  26  *   - midchain: a nighbour adj on a virtual/tunnel interface.
  27  *
  28  * The API to create and update the adjacency is very sub-type specific. This
  29  * is intentional as it encourages the user to carefully consider which adjacency
  30  * sub-type they are really using, and hence assign it data in the appropriate
  31  * sub-type space in the union of sub-types. This prevents the adj becoming a
  32  * disorganised dumping group for 'my features needs a u16 somewhere' data. It
  33  * is important to enforce this approach as space in the adjacency is a premium,
  34  * as we need it to fit in 1 cache line.
  35  *
  36  * the API is also based around an index to an ajdacency not a raw pointer. This
  37  * is so the user doesn't suffer the same limp inducing firearm injuries that
  38  * the author suffered as the adjacenices can realloc.
  39  */
  40
  41 #ifndef __ADJ_H__
  42 #define __ADJ_H__
  43
  44 #include <vnet/adj/adj_types.h>
  45 #include <vnet/adj/adj_nbr.h>
  46 #include <vnet/adj/adj_glean.h>
  47 #include <vnet/adj/rewrite.h>
  48
  49 /** @brief Common (IP4/IP6) next index stored in adjacency. */
  50 typedef enum
  51 {
  52   /** Adjacency to drop this packet. */
  53   IP_LOOKUP_NEXT_DROP,
  54   /** Adjacency to punt this packet. */
  55   IP_LOOKUP_NEXT_PUNT,
  56
  57   /** This packet is for one of our own IP addresses. */
  58   IP_LOOKUP_NEXT_LOCAL,
  59
  60   /** This packet matches an "incomplete adjacency" and packets
  61      need to be passed to ARP to find rewrite string for
  62      this destination. */
  63   IP_LOOKUP_NEXT_ARP,
  64
  65   /** This packet matches an "interface route" and packets
  66      need to be passed to ARP to find rewrite string for
  67      this destination. */
  68   IP_LOOKUP_NEXT_GLEAN,
  69
  70   /** This packet is to be rewritten and forwarded to the next
  71      processing node.  This is typically the output interface but
  72      might be another node for further output processing. */
  73   IP_LOOKUP_NEXT_REWRITE,
  74
  75   /** This packets follow a mid-chain adjacency */
  76   IP_LOOKUP_NEXT_MIDCHAIN,
  77
  78   /** This packets needs to go to ICMP error */
  79   IP_LOOKUP_NEXT_ICMP_ERROR,
  80
  81   /** Multicast Adjacency. */
  82   IP_LOOKUP_NEXT_MCAST,
  83
  84   /** Broadcasr Adjacency. */
  85   IP_LOOKUP_NEXT_BCAST,
  86
  87   /** Multicast Midchain Adjacency. An Adjacency for sending macst packets
  88    *  on a tunnel/virtual interface */
  89   IP_LOOKUP_NEXT_MCAST_MIDCHAIN,
  90
  91   IP_LOOKUP_N_NEXT,
  92 } __attribute__ ((packed)) ip_lookup_next_t;
  93
  94 typedef enum
  95 {
  96   IP4_LOOKUP_N_NEXT = IP_LOOKUP_N_NEXT,
  97 } ip4_lookup_next_t;
  98
  99 typedef enum
 100 {
 101   /* Hop-by-hop header handling */
 102   IP6_LOOKUP_NEXT_HOP_BY_HOP = IP_LOOKUP_N_NEXT,
 103   IP6_LOOKUP_NEXT_ADD_HOP_BY_HOP,
 104   IP6_LOOKUP_NEXT_POP_HOP_BY_HOP,
 105   IP6_LOOKUP_N_NEXT,
 106 } ip6_lookup_next_t;
 107
 108 #define IP4_LOOKUP_NEXT_NODES {                                 \
 109     [IP_LOOKUP_NEXT_DROP] = "ip4-drop",                         \
 110     [IP_LOOKUP_NEXT_PUNT] = "ip4-punt",                         \
 111     [IP_LOOKUP_NEXT_LOCAL] = "ip4-local",                       \
 112     [IP_LOOKUP_NEXT_ARP] = "ip4-arp",                           \
 113     [IP_LOOKUP_NEXT_GLEAN] = "ip4-glean",                       \
 114     [IP_LOOKUP_NEXT_REWRITE] = "ip4-rewrite",                   \
 115     [IP_LOOKUP_NEXT_MCAST] = "ip4-rewrite-mcast",               \
 116     [IP_LOOKUP_NEXT_BCAST] = "ip4-rewrite-bcast",               \
 117     [IP_LOOKUP_NEXT_MIDCHAIN] = "ip4-midchain",                 \
 118     [IP_LOOKUP_NEXT_MCAST_MIDCHAIN] = "ip4-mcast-midchain",     \
 119     [IP_LOOKUP_NEXT_ICMP_ERROR] = "ip4-icmp-error",             \
 120 }
 121
 122 #define IP6_LOOKUP_NEXT_NODES {                                 \
 123     [IP_LOOKUP_NEXT_DROP] = "ip6-drop",                         \
 124     [IP_LOOKUP_NEXT_PUNT] = "ip6-punt",                         \
 125     [IP_LOOKUP_NEXT_LOCAL] = "ip6-local",                       \
 126     [IP_LOOKUP_NEXT_ARP] = "ip6-discover-neighbor",             \
 127     [IP_LOOKUP_NEXT_GLEAN] = "ip6-glean",                       \
 128     [IP_LOOKUP_NEXT_REWRITE] = "ip6-rewrite",                   \
 129     [IP_LOOKUP_NEXT_BCAST] = "ip6-rewrite-bcast",               \
 130     [IP_LOOKUP_NEXT_MCAST] = "ip6-rewrite-mcast",               \
 131     [IP_LOOKUP_NEXT_MIDCHAIN] = "ip6-midchain",                 \
 132     [IP_LOOKUP_NEXT_MCAST_MIDCHAIN] = "ip6-mcast-midchain",     \
 133     [IP_LOOKUP_NEXT_ICMP_ERROR] = "ip6-icmp-error",             \
 134     [IP6_LOOKUP_NEXT_HOP_BY_HOP] = "ip6-hop-by-hop",            \
 135     [IP6_LOOKUP_NEXT_ADD_HOP_BY_HOP] = "ip6-add-hop-by-hop",    \
 136     [IP6_LOOKUP_NEXT_POP_HOP_BY_HOP] = "ip6-pop-hop-by-hop",    \
 137 }
 138
 139 /**
 140  * The special broadcast address (to construct a broadcast adjacency
 141  */
 142 extern const ip46_address_t ADJ_BCAST_ADDR;
 143
 144 /**
 145  * Forward delcartion
 146  */
 147 struct ip_adjacency_t_;
 148
 149 /**
 150  * @brief A function type for post-rewrite fixups on midchain adjacency
 151  */
 152 typedef void (*adj_midchain_fixup_t) (vlib_main_t * vm,
 153                                       struct ip_adjacency_t_ * adj,
 154                                       vlib_buffer_t * b0,
 155                                       const void *data);
 156
 157 /**
 158  * @brief Flags on an IP adjacency
 159  */
 160 typedef enum adj_attr_t_
 161 {
 162     /**
 163      * Currently a sync walk is active. Used to prevent re-entrant walking
 164      */
 165     ADJ_ATTR_SYNC_WALK_ACTIVE = 0,
 166
 167     /**
 168      * Packets TX through the midchain do not increment the interface
 169      * counters. This should be used when the adj is associated with an L2
 170      * interface and that L2 interface is in a bridege domain. In that case
 171      * the packet will have traversed the interface's TX node, and hence have
 172      * been counted, before it traverses ths midchain
 173      */
 174     ADJ_ATTR_MIDCHAIN_NO_COUNT,
 175     /**
 176      * When stacking midchains on a fib-entry extract the choice from the
 177      * load-balance returned based on an IP hash of the adj's rewrite
 178      */
 179     ADJ_ATTR_MIDCHAIN_IP_STACK,
 180     /**
 181      * If the midchain were to stack on its FIB entry a loop would form.
 182      */
 183     ADJ_ATTR_MIDCHAIN_LOOPED,
 184 }  adj_attr_t;
 185
 186 #define ADJ_ATTR_NAMES {                                        \
 187     [ADJ_ATTR_SYNC_WALK_ACTIVE] = "walk-active",                \
 188     [ADJ_ATTR_MIDCHAIN_NO_COUNT] = "midchain-no-count",         \
 189     [ADJ_ATTR_MIDCHAIN_IP_STACK] = "midchain-ip-stack",         \
 190     [ADJ_ATTR_MIDCHAIN_LOOPED] = "midchain-looped",             \
 191 }
 192
 193 #define FOR_EACH_ADJ_ATTR(_attr)                 \
 194     for (_attr = ADJ_ATTR_SYNC_WALK_ACTIVE;      \
 195          _attr <= ADJ_ATTR_MIDCHAIN_LOOPED;      \
 196          _attr++)
 197
 198 /**
 199  * @brief Flags on an IP adjacency
 200  */
 201 typedef enum adj_flags_t_
 202 {
 203     ADJ_FLAG_NONE = 0,
 204     ADJ_FLAG_SYNC_WALK_ACTIVE = (1 << ADJ_ATTR_SYNC_WALK_ACTIVE),
 205     ADJ_FLAG_MIDCHAIN_NO_COUNT = (1 << ADJ_ATTR_MIDCHAIN_NO_COUNT),
 206     ADJ_FLAG_MIDCHAIN_IP_STACK = (1 << ADJ_ATTR_MIDCHAIN_IP_STACK),
 207     ADJ_FLAG_MIDCHAIN_LOOPED = (1 << ADJ_ATTR_MIDCHAIN_LOOPED),
 208 }  __attribute__ ((packed)) adj_flags_t;
 209
 210 /**
 211  * @brief Format adjacency flags
 212  */
 213 extern u8* format_adj_flags(u8 * s, va_list * args);
 214
 215 /**
 216  * @brief IP unicast adjacency.
 217  *  @note cache aligned.
 218  *
 219  * An adjacency is a represenation of a peer on a particular link.
 220  */
 221 typedef struct ip_adjacency_t_
 222 {
 223   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 224
 225   /**
 226    * Linkage into the FIB node grpah. First member since this type
 227    * has 8 byte alignment requirements.
 228    */
 229   fib_node_t ia_node;
 230
 231   /**
 232    * Next hop after ip4-lookup.
 233    *  This is not accessed in the rewrite nodes.
 234    * 1-bytes
 235    */
 236   ip_lookup_next_t lookup_next_index;
 237
 238   /**
 239    * link/ether-type
 240    * 1 bytes
 241    */
 242   vnet_link_t ia_link;
 243
 244   /**
 245    * The protocol of the neighbor/peer. i.e. the protocol with
 246    * which to interpret the 'next-hop' attirbutes of the sub-types.
 247    * 1-btyes
 248    */
 249   fib_protocol_t ia_nh_proto;
 250
 251   /**
 252    * Flags on the adjacency
 253    * 1-bytes
 254    */
 255   adj_flags_t ia_flags;
 256
 257   union
 258   {
 259     /**
 260      * IP_LOOKUP_NEXT_ARP/IP_LOOKUP_NEXT_REWRITE
 261      *
 262      * neighbour adjacency sub-type;
 263      */
 264     struct
 265     {
 266       ip46_address_t next_hop;
 267     } nbr;
 268       /**
 269        * IP_LOOKUP_NEXT_MIDCHAIN
 270        *
 271        * A nbr adj that is also recursive. Think tunnels.
 272        * A nbr adj can transition to be of type MDICHAIN
 273        * so be sure to leave the two structs with the next_hop
 274        * fields aligned.
 275        */
 276     struct
 277     {
 278       /**
 279        * The recursive next-hop.
 280        *  This field MUST be at the same memory location as
 281        *   sub_type.nbr.next_hop
 282        */
 283       ip46_address_t next_hop;
 284       /**
 285        * The next DPO to use
 286        */
 287       dpo_id_t next_dpo;
 288       /**
 289        * A function to perform the post-rewrite fixup
 290        */
 291       adj_midchain_fixup_t fixup_func;
 292       /**
 293        * Fixup data passed back to the client in the fixup function
 294        */
 295       const void *fixup_data;
 296       /**
 297        * the FIB entry this midchain resolves through. required for recursive
 298        * loop detection.
 299        */
 300       fib_node_index_t fei;
 301     } midchain;
 302     /**
 303      * IP_LOOKUP_NEXT_GLEAN
 304      *
 305      * Glean the address to ARP for from the packet's destination.
 306      * Technically these aren't adjacencies, i.e. they are not a
 307      * representation of a peer. One day we might untangle this coupling
 308      * and use a new Glean DPO.
 309      */
 310     struct
 311     {
 312       ip46_address_t receive_addr;
 313     } glean;
 314   } sub_type;
 315
 316   CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 317
 318   /* Rewrite in second/third cache lines */
 319   vnet_declare_rewrite (VLIB_BUFFER_PRE_DATA_SIZE);
 320
 321   /**
 322    * more control plane members that do not fit on the first cacheline
 323    */
 324   /**
 325    * A sorted vector of delegates
 326    */
 327   struct adj_delegate_t_ *ia_delegates;
 328
 329 } ip_adjacency_t;
 330
 331 STATIC_ASSERT ((STRUCT_OFFSET_OF (ip_adjacency_t, cacheline0) == 0),
 332                "IP adjacency cachline 0 is not offset");
 333 STATIC_ASSERT ((STRUCT_OFFSET_OF (ip_adjacency_t, cacheline1) ==
 334                 CLIB_CACHE_LINE_BYTES),
 335                "IP adjacency cachline 1 is more than one cachline size offset");
 336
 337 /**
 338  * @brief
 339  *   Take a reference counting lock on the adjacency
 340  */
 341 extern void adj_lock(adj_index_t adj_index);
 342 /**
 343  * @brief
 344  *   Release a reference counting lock on the adjacency
 345  */
 346 extern void adj_unlock(adj_index_t adj_index);
 347
 348 /**
 349  * @brief
 350  *  Add a child dependent to an adjacency. The child will
 351  *  thus be informed via its registerd back-walk function
 352  *  when the adjacency state changes.
 353  */
 354 extern u32 adj_child_add(adj_index_t adj_index,
 355                          fib_node_type_t type,
 356                          fib_node_index_t child_index);
 357 /**
 358  * @brief
 359  *  Remove a child dependent
 360  */
 361 extern void adj_child_remove(adj_index_t adj_index,
 362                              u32 sibling_index);
 363
 364 /**
 365  * @brief Walk the Adjacencies on a given interface
 366  */
 367 extern void adj_walk (u32 sw_if_index,
 368                       adj_walk_cb_t cb,
 369                       void *ctx);
 370
 371 /**
 372  * @brief Return the link type of the adjacency
 373  */
 374 extern vnet_link_t adj_get_link_type (adj_index_t ai);
 375
 376 /**
 377  * @brief Return the sw interface index of the adjacency.
 378  */
 379 extern u32 adj_get_sw_if_index (adj_index_t ai);
 380
 381 /**
 382  * @brief Return true if the adjacency is 'UP', i.e. can be used for forwarding.
 383  * 0 is down, !0 is up.
 384  */
 385 extern int adj_is_up (adj_index_t ai);
 386
 387 /**
 388  * @brief Return the link type of the adjacency
 389  */
 390 extern const u8* adj_get_rewrite (adj_index_t ai);
 391
 392 /**
 393  * @brief Notify the adjacency subsystem that the features settings for
 394  * an interface have changed
 395  */
 396 extern void adj_feature_update (u32 sw_if_index, u8 arc_index, u8 is_enable);
 397
 398 /**
 399  * @brief descend the FIB graph looking for loops
 400  *
 401  * @param ai
 402  *  The adj index to traverse
 403  *
 404  * @param entry_indicies)
 405  *  A pointer to a vector of FIB entries already visited.
 406  */
 407 extern int adj_recursive_loop_detect (adj_index_t ai,
 408                                       fib_node_index_t **entry_indicies);
 409
 410 /**
 411  * @brief
 412  * The global adjacnecy pool. Exposed for fast/inline data-plane access
 413  */
 414 extern ip_adjacency_t *adj_pool;
 415
 416 /**
 417  * @brief
 418  * Adjacency packet counters
 419  */
 420 extern vlib_combined_counter_main_t adjacency_counters;
 421
 422 /**
 423  * @brief Global Config for enabling per-adjacency counters
 424  * This is configurable because it comes with  a non-negligible
 425  * performance cost. */
 426 extern int adj_per_adj_counters;
 427
 428 /**
 429  * @brief
 430  * Get a pointer to an adjacency object from its index
 431  */
 432 static inline ip_adjacency_t *
 433 adj_get (adj_index_t adj_index)
 434 {
 435     return (vec_elt_at_index(adj_pool, adj_index));
 436 }
 437
 438 /**
 439  * @brief Get the global configuration option for enabling per-adj counters
 440  */
 441 static inline int
 442 adj_are_counters_enabled (void)
 443 {
 444     return (adj_per_adj_counters);
 445 }
 446
 447 #endif