src/vnet/ip/lookup.h

   1 /*
   2  * Copyright (c) 2015 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  * ip/ip_lookup.h: ip (4 or 6) lookup structures, adjacencies, ...
  17  *
  18  * Copyright (c) 2008 Eliot Dresselhaus
  19  *
  20  * Permission is hereby granted, free of charge, to any person obtaining
  21  * a copy of this software and associated documentation files (the
  22  * "Software"), to deal in the Software without restriction, including
  23  * without limitation the rights to use, copy, modify, merge, publish,
  24  * distribute, sublicense, and/or sell copies of the Software, and to
  25  * permit persons to whom the Software is furnished to do so, subject to
  26  * the following conditions:
  27  *
  28  * The above copyright notice and this permission notice shall be
  29  * included in all copies or substantial portions of the Software.
  30  *
  31  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  32  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  33  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  34  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  35  *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  36  *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  37  *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  38  */
  39
  40 /**
  41  * @file
  42  * Definitions for all things IP (v4|v6) unicast and multicast lookup related.
  43  *
  44  * - Adjacency definitions and registration.
  45  * - Callbacks on route add.
  46  * - Callbacks on interface address change.
  47  */
  48 #ifndef included_ip_lookup_h
  49 #define included_ip_lookup_h
  50
  51 #include <vnet/vnet.h>
  52 #include <vlib/buffer.h>
  53 #include <vnet/ip/ip4_packet.h>
  54 #include <vnet/ip/ip6_packet.h>
  55 #include <vnet/fib/fib_node.h>
  56 #include <vnet/dpo/dpo.h>
  57 #include <vnet/feature/feature.h>
  58
  59 /** @brief Common (IP4/IP6) next index stored in adjacency. */
  60 typedef enum
  61 {
  62   /** Adjacency to drop this packet. */
  63   IP_LOOKUP_NEXT_DROP,
  64   /** Adjacency to punt this packet. */
  65   IP_LOOKUP_NEXT_PUNT,
  66
  67   /** This packet is for one of our own IP addresses. */
  68   IP_LOOKUP_NEXT_LOCAL,
  69
  70   /** This packet matches an "incomplete adjacency" and packets
  71      need to be passed to ARP to find rewrite string for
  72      this destination. */
  73   IP_LOOKUP_NEXT_ARP,
  74
  75   /** This packet matches an "interface route" and packets
  76      need to be passed to ARP to find rewrite string for
  77      this destination. */
  78   IP_LOOKUP_NEXT_GLEAN,
  79
  80   /** This packet is to be rewritten and forwarded to the next
  81      processing node.  This is typically the output interface but
  82      might be another node for further output processing. */
  83   IP_LOOKUP_NEXT_REWRITE,
  84
  85   /** This packets follow a load-balance */
  86   IP_LOOKUP_NEXT_LOAD_BALANCE,
  87
  88   /** This packets follow a mid-chain adjacency */
  89   IP_LOOKUP_NEXT_MIDCHAIN,
  90
  91   /** This packets needs to go to ICMP error */
  92   IP_LOOKUP_NEXT_ICMP_ERROR,
  93
  94   /** Multicast Adjacency. */
  95   IP_LOOKUP_NEXT_MCAST,
  96
  97   IP_LOOKUP_N_NEXT,
  98 } ip_lookup_next_t;
  99
 100 typedef enum
 101 {
 102   IP4_LOOKUP_N_NEXT = IP_LOOKUP_N_NEXT,
 103 } ip4_lookup_next_t;
 104
 105 typedef enum
 106 {
 107   /* Hop-by-hop header handling */
 108   IP6_LOOKUP_NEXT_HOP_BY_HOP = IP_LOOKUP_N_NEXT,
 109   IP6_LOOKUP_NEXT_ADD_HOP_BY_HOP,
 110   IP6_LOOKUP_NEXT_POP_HOP_BY_HOP,
 111   IP6_LOOKUP_N_NEXT,
 112 } ip6_lookup_next_t;
 113
 114 #define IP4_LOOKUP_NEXT_NODES {                                 \
 115     [IP_LOOKUP_NEXT_DROP] = "ip4-drop",                         \
 116     [IP_LOOKUP_NEXT_PUNT] = "ip4-punt",                         \
 117     [IP_LOOKUP_NEXT_LOCAL] = "ip4-local",                       \
 118     [IP_LOOKUP_NEXT_ARP] = "ip4-arp",                           \
 119     [IP_LOOKUP_NEXT_GLEAN] = "ip4-glean",                       \
 120     [IP_LOOKUP_NEXT_REWRITE] = "ip4-rewrite",                   \
 121     [IP_LOOKUP_NEXT_MCAST] = "ip4-rewrite-mcast",               \
 122     [IP_LOOKUP_NEXT_MIDCHAIN] = "ip4-midchain",                 \
 123     [IP_LOOKUP_NEXT_LOAD_BALANCE] = "ip4-load-balance",         \
 124     [IP_LOOKUP_NEXT_ICMP_ERROR] = "ip4-icmp-error",             \
 125 }
 126
 127 #define IP6_LOOKUP_NEXT_NODES {                                 \
 128     [IP_LOOKUP_NEXT_DROP] = "ip6-drop",                         \
 129     [IP_LOOKUP_NEXT_PUNT] = "ip6-punt",                         \
 130     [IP_LOOKUP_NEXT_LOCAL] = "ip6-local",                       \
 131     [IP_LOOKUP_NEXT_ARP] = "ip6-discover-neighbor",             \
 132     [IP_LOOKUP_NEXT_GLEAN] = "ip6-glean",                       \
 133     [IP_LOOKUP_NEXT_REWRITE] = "ip6-rewrite",                   \
 134     [IP_LOOKUP_NEXT_MCAST] = "ip6-rewrite-mcast",               \
 135     [IP_LOOKUP_NEXT_MIDCHAIN] = "ip6-midchain",                 \
 136     [IP_LOOKUP_NEXT_LOAD_BALANCE] = "ip6-load-balance",         \
 137     [IP_LOOKUP_NEXT_ICMP_ERROR] = "ip6-icmp-error",             \
 138     [IP6_LOOKUP_NEXT_HOP_BY_HOP] = "ip6-hop-by-hop",            \
 139     [IP6_LOOKUP_NEXT_ADD_HOP_BY_HOP] = "ip6-add-hop-by-hop",    \
 140     [IP6_LOOKUP_NEXT_POP_HOP_BY_HOP] = "ip6-pop-hop-by-hop",    \
 141 }
 142
 143 /** Flow hash configuration */
 144 #define IP_FLOW_HASH_SRC_ADDR (1<<0)
 145 #define IP_FLOW_HASH_DST_ADDR (1<<1)
 146 #define IP_FLOW_HASH_PROTO (1<<2)
 147 #define IP_FLOW_HASH_SRC_PORT (1<<3)
 148 #define IP_FLOW_HASH_DST_PORT (1<<4)
 149 #define IP_FLOW_HASH_REVERSE_SRC_DST (1<<5)
 150
 151 /** Default: 5-tuple without the "reverse" bit */
 152 #define IP_FLOW_HASH_DEFAULT (0x1F)
 153
 154 #define foreach_flow_hash_bit                   \
 155 _(src, IP_FLOW_HASH_SRC_ADDR)                   \
 156 _(dst, IP_FLOW_HASH_DST_ADDR)                   \
 157 _(sport, IP_FLOW_HASH_SRC_PORT)                 \
 158 _(dport, IP_FLOW_HASH_DST_PORT)                 \
 159 _(proto, IP_FLOW_HASH_PROTO)                    \
 160 _(reverse, IP_FLOW_HASH_REVERSE_SRC_DST)
 161
 162 /**
 163  * A flow hash configuration is a mask of the flow hash options
 164  */
 165 typedef u32 flow_hash_config_t;
 166
 167 /**
 168  * Forward delcartion
 169  */
 170 struct ip_adjacency_t_;
 171
 172 /**
 173  * @brief A function type for post-rewrite fixups on midchain adjacency
 174  */
 175 typedef void (*adj_midchain_fixup_t) (vlib_main_t * vm,
 176                                       struct ip_adjacency_t_ * adj,
 177                                       vlib_buffer_t * b0);
 178
 179 /**
 180  * @brief Flags on an IP adjacency
 181  */
 182 typedef enum ip_adjacency_flags_t_
 183 {
 184     /**
 185      * Currently a sync walk is active. Used to prevent re-entrant walking
 186      */
 187   IP_ADJ_SYNC_WALK_ACTIVE = (1 << 0),
 188 } ip_adjacency_flags_t;
 189
 190 /** @brief IP unicast adjacency.
 191     @note cache aligned.
 192 */
 193 typedef struct ip_adjacency_t_
 194 {
 195   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 196
 197   /** Number of adjecencies in block.  Greater than 1 means multipath;
 198      otherwise equal to 1. */
 199   u16 n_adj;
 200
 201   /** Next hop after ip4-lookup. */
 202   union
 203   {
 204     ip_lookup_next_t lookup_next_index:16;
 205     u16 lookup_next_index_as_int;
 206   };
 207
 208   /** Interface address index for this local/arp adjacency. */
 209   u32 if_address_index;
 210
 211   /*
 212    * link/ether-type
 213    */
 214   vnet_link_t ia_link;
 215   u8 ia_nh_proto;
 216
 217   union
 218   {
 219     /**
 220      * IP_LOOKUP_NEXT_ARP/IP_LOOKUP_NEXT_REWRITE
 221      *
 222      * neighbour adjacency sub-type;
 223      */
 224     struct
 225     {
 226       ip46_address_t next_hop;
 227     } nbr;
 228       /**
 229        * IP_LOOKUP_NEXT_MIDCHAIN
 230        *
 231        * A nbr adj that is also recursive. Think tunnels.
 232        * A nbr adj can transition to be of type MDICHAIN
 233        * so be sure to leave the two structs with the next_hop
 234        * fields aligned.
 235        */
 236     struct
 237     {
 238       /**
 239        * The recursive next-hop
 240        */
 241       ip46_address_t next_hop;
 242       /**
 243        * The node index of the tunnel's post rewrite/TX function.
 244        */
 245       u32 tx_function_node;
 246       /**
 247        * The next DPO to use
 248        */
 249       dpo_id_t next_dpo;
 250       /**
 251        * A function to perform the post-rewrite fixup
 252        */
 253       adj_midchain_fixup_t fixup_func;
 254     } midchain;
 255     /**
 256      * IP_LOOKUP_NEXT_GLEAN
 257      *
 258      * Glean the address to ARP for from the packet's destination
 259      */
 260     struct
 261     {
 262       ip46_address_t receive_addr;
 263     } glean;
 264   } sub_type;
 265
 266     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 267
 268   /* Rewrite in second/third cache lines */
 269     vnet_declare_rewrite (VLIB_BUFFER_PRE_DATA_SIZE);
 270
 271   /*
 272    * member not accessed in the data plane are relgated to the
 273    * remaining cachelines
 274    */
 275   fib_node_t ia_node;
 276
 277   /**
 278    * Flags on the adjacency
 279    */
 280   ip_adjacency_flags_t ia_flags;
 281
 282 } ip_adjacency_t;
 283
 284 STATIC_ASSERT ((STRUCT_OFFSET_OF (ip_adjacency_t, cacheline0) == 0),
 285                "IP adjacency cachline 0 is not offset");
 286 STATIC_ASSERT ((STRUCT_OFFSET_OF (ip_adjacency_t, cacheline1) ==
 287                 CLIB_CACHE_LINE_BYTES),
 288                "IP adjacency cachline 1 is more than one cachline size offset");
 289
 290 /* An all zeros address */
 291 extern const ip46_address_t zero_addr;
 292
 293
 294 typedef struct
 295 {
 296   /* Key for mhash; in fact, just a byte offset into mhash key vector. */
 297   u32 address_key;
 298
 299   /* Interface which has this address. */
 300   u32 sw_if_index;
 301
 302   /* Adjacency for neighbor probe (ARP) for this interface address. */
 303   u32 neighbor_probe_adj_index;
 304
 305   /* Address (prefix) length for this interface. */
 306   u16 address_length;
 307
 308   /* Will be used for something eventually.  Primary vs. secondary? */
 309   u16 flags;
 310
 311   /* Next and previous pointers for doubly linked list of
 312      addresses per software interface. */
 313   u32 next_this_sw_interface;
 314   u32 prev_this_sw_interface;
 315 } ip_interface_address_t;
 316
 317 typedef enum
 318 {
 319   IP_LOCAL_NEXT_DROP,
 320   IP_LOCAL_NEXT_PUNT,
 321   IP_LOCAL_NEXT_UDP_LOOKUP,
 322   IP_LOCAL_NEXT_ICMP,
 323   IP_LOCAL_N_NEXT,
 324 } ip_local_next_t;
 325
 326 struct ip_lookup_main_t;
 327
 328 typedef struct ip_lookup_main_t
 329 {
 330   /* Adjacency heap. */
 331   ip_adjacency_t *adjacency_heap;
 332
 333   /** load-balance  packet/byte counters indexed by LB index. */
 334   vlib_combined_counter_main_t load_balance_counters;
 335
 336   /** Pool of addresses that are assigned to interfaces. */
 337   ip_interface_address_t *if_address_pool;
 338
 339   /** Hash table mapping address to index in interface address pool. */
 340   mhash_t address_to_if_address_index;
 341
 342   /** Head of doubly linked list of interface addresses for each software interface.
 343      ~0 means this interface has no address. */
 344   u32 *if_address_pool_index_by_sw_if_index;
 345
 346   /** First table index to use for this interface, ~0 => none */
 347   u32 *classify_table_index_by_sw_if_index;
 348
 349   /** Feature arc indices */
 350   u8 mcast_feature_arc_index;
 351   u8 ucast_feature_arc_index;
 352   u8 output_feature_arc_index;
 353
 354   /** Number of bytes in a fib result.  Must be at least
 355      sizeof (uword).  First word is always adjacency index. */
 356   u32 fib_result_n_bytes, fib_result_n_words;
 357
 358   format_function_t *format_fib_result;
 359
 360   /** 1 for ip6; 0 for ip4. */
 361   u32 is_ip6;
 362
 363   /** Either format_ip4_address_and_length or format_ip6_address_and_length. */
 364   format_function_t *format_address_and_length;
 365
 366   /** Special adjacency format functions */
 367   format_function_t **special_adjacency_format_functions;
 368
 369   /** Table mapping ip protocol to ip[46]-local node next index. */
 370   u8 local_next_by_ip_protocol[256];
 371
 372   /** IP_BUILTIN_PROTOCOL_{TCP,UDP,ICMP,OTHER} by protocol in IP header. */
 373   u8 builtin_protocol_by_ip_protocol[256];
 374 } ip_lookup_main_t;
 375
 376 always_inline ip_adjacency_t *
 377 ip_get_adjacency (ip_lookup_main_t * lm, u32 adj_index)
 378 {
 379   ip_adjacency_t *adj;
 380
 381   adj = vec_elt_at_index (lm->adjacency_heap, adj_index);
 382
 383   return adj;
 384 }
 385
 386 #define ip_prefetch_adjacency(lm,adj_index,type)                \
 387 do {                                                            \
 388   ip_adjacency_t * _adj = (lm)->adjacency_heap + (adj_index);   \
 389   CLIB_PREFETCH (_adj, sizeof (_adj[0]), type);                 \
 390 } while (0)
 391
 392 clib_error_t *ip_interface_address_add_del (ip_lookup_main_t * lm,
 393                                             u32 sw_if_index,
 394                                             void *address,
 395                                             u32 address_length,
 396                                             u32 is_del, u32 * result_index);
 397
 398 u8 *format_ip_flow_hash_config (u8 * s, va_list * args);
 399
 400 always_inline ip_interface_address_t *
 401 ip_get_interface_address (ip_lookup_main_t * lm, void *addr_fib)
 402 {
 403   uword *p = mhash_get (&lm->address_to_if_address_index, addr_fib);
 404   return p ? pool_elt_at_index (lm->if_address_pool, p[0]) : 0;
 405 }
 406
 407 u32 fib_table_id_find_fib_index (fib_protocol_t proto, u32 table_id);
 408
 409 always_inline void *
 410 ip_interface_address_get_address (ip_lookup_main_t * lm,
 411                                   ip_interface_address_t * a)
 412 {
 413   return mhash_key_to_mem (&lm->address_to_if_address_index, a->address_key);
 414 }
 415
 416 /* *INDENT-OFF* */
 417 #define foreach_ip_interface_address(lm,a,sw_if_index,loop,body)        \
 418 do {                                                                    \
 419     vnet_main_t *_vnm = vnet_get_main();                                     \
 420     u32 _sw_if_index = sw_if_index;                                     \
 421     vnet_sw_interface_t *_swif;                                         \
 422     _swif = vnet_get_sw_interface (_vnm, _sw_if_index);                 \
 423                                                                         \
 424     /*                                                                  \
 425      * Loop => honor unnumbered interface addressing.                   \
 426      */                                                                 \
 427     if (loop && _swif->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED)       \
 428       _sw_if_index = _swif->unnumbered_sw_if_index;                     \
 429     u32 _ia =                                                           \
 430       (vec_len((lm)->if_address_pool_index_by_sw_if_index)              \
 431        > (_sw_if_index))                                                \
 432         ? vec_elt ((lm)->if_address_pool_index_by_sw_if_index,          \
 433                    (_sw_if_index)) : (u32)~0;                           \
 434     ip_interface_address_t * _a;                                        \
 435     while (_ia != ~0)                                                   \
 436     {                                                                   \
 437         _a = pool_elt_at_index ((lm)->if_address_pool, _ia);            \
 438         _ia = _a->next_this_sw_interface;                               \
 439         (a) = _a;                                                       \
 440         body;                                                           \
 441     }                                                                   \
 442 } while (0)
 443 /* *INDENT-ON* */
 444
 445 void ip_lookup_init (ip_lookup_main_t * lm, u32 ip_lookup_node_index);
 446
 447 #endif /* included_ip_lookup_h */
 448
 449 /*
 450  * fd.io coding-style-patch-verification: ON
 451  *
 452  * Local Variables:
 453  * eval: (c-set-style "gnu")
 454  * End:
 455  */