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/adj/adj.h>
  57 #include <vnet/dpo/dpo.h>
  58 #include <vnet/feature/feature.h>
  59
  60 /** Flow hash configuration */
  61 #define IP_FLOW_HASH_SRC_ADDR (1<<0)
  62 #define IP_FLOW_HASH_DST_ADDR (1<<1)
  63 #define IP_FLOW_HASH_PROTO (1<<2)
  64 #define IP_FLOW_HASH_SRC_PORT (1<<3)
  65 #define IP_FLOW_HASH_DST_PORT (1<<4)
  66 #define IP_FLOW_HASH_REVERSE_SRC_DST (1<<5)
  67 #define IP_FLOW_HASH_SYMMETRIC (1<<6)
  68
  69 /** Default: 5-tuple without the "reverse" bit */
  70 #define IP_FLOW_HASH_DEFAULT (0x1F)
  71
  72 #define foreach_flow_hash_bit                   \
  73 _(src, IP_FLOW_HASH_SRC_ADDR)                   \
  74 _(dst, IP_FLOW_HASH_DST_ADDR)                   \
  75 _(sport, IP_FLOW_HASH_SRC_PORT)                 \
  76 _(dport, IP_FLOW_HASH_DST_PORT)                 \
  77 _(proto, IP_FLOW_HASH_PROTO)                    \
  78 _(reverse, IP_FLOW_HASH_REVERSE_SRC_DST)        \
  79 _(symmetric, IP_FLOW_HASH_SYMMETRIC)
  80
  81 /**
  82  * A flow hash configuration is a mask of the flow hash options
  83  */
  84 typedef u32 flow_hash_config_t;
  85
  86 /* An all zeros address */
  87 extern const ip46_address_t zero_addr;
  88
  89 typedef struct
  90 {
  91   fib_prefix_t prefix;
  92
  93   u32 sw_if_index;
  94 } ip_interface_prefix_key_t;
  95
  96 typedef struct
  97 {
  98   /* key - prefix and sw_if_index */
  99   ip_interface_prefix_key_t key;
 100
 101   /* number of addresses in this prefix on the interface */
 102   u16 ref_count;
 103
 104   /* index of the interface address used as a default source address */
 105   u32 src_ia_index;
 106 } ip_interface_prefix_t;
 107
 108 typedef struct
 109 {
 110   /* Key for mhash; in fact, just a byte offset into mhash key vector. */
 111   u32 address_key;
 112
 113   /* Interface which has this address. */
 114   u32 sw_if_index;
 115
 116   /* Address (prefix) length for this interface. */
 117   u16 address_length;
 118
 119   /* Will be used for something eventually.  Primary vs. secondary? */
 120   u16 flags;
 121
 122   /* Next and previous pointers for doubly linked list of
 123      addresses per software interface. */
 124   u32 next_this_sw_interface;
 125   u32 prev_this_sw_interface;
 126 } ip_interface_address_t;
 127
 128 typedef enum
 129 {
 130   IP_LOCAL_NEXT_DROP,
 131   IP_LOCAL_NEXT_PUNT,
 132   IP_LOCAL_NEXT_UDP_LOOKUP,
 133   IP_LOCAL_NEXT_ICMP,
 134   IP_LOCAL_NEXT_REASSEMBLY,
 135   IP_LOCAL_N_NEXT,
 136 } ip_local_next_t;
 137
 138 struct ip_lookup_main_t;
 139
 140 typedef struct ip_lookup_main_t
 141 {
 142   /** Pool of addresses that are assigned to interfaces. */
 143   ip_interface_address_t *if_address_pool;
 144
 145   /** Hash table mapping address to index in interface address pool. */
 146   mhash_t address_to_if_address_index;
 147
 148   /** Head of doubly linked list of interface addresses for each software interface.
 149      ~0 means this interface has no address. */
 150   u32 *if_address_pool_index_by_sw_if_index;
 151
 152   /** Pool of prefixes containing addresses assigned to interfaces */
 153   ip_interface_prefix_t *if_prefix_pool;
 154
 155   /** Hash table mapping prefix to index in interface prefix pool */
 156   mhash_t prefix_to_if_prefix_index;
 157
 158   /** First table index to use for this interface, ~0 => none */
 159   u32 *classify_table_index_by_sw_if_index;
 160
 161   /** Feature arc indices */
 162   u8 mcast_feature_arc_index;
 163   u8 ucast_feature_arc_index;
 164   u8 output_feature_arc_index;
 165
 166   /** Number of bytes in a fib result.  Must be at least
 167      sizeof (uword).  First word is always adjacency index. */
 168   u32 fib_result_n_bytes, fib_result_n_words;
 169
 170   /** 1 for ip6; 0 for ip4. */
 171   u32 is_ip6;
 172
 173   /** Either format_ip4_address_and_length or format_ip6_address_and_length. */
 174   format_function_t *format_address_and_length;
 175
 176   /** Table mapping ip protocol to ip[46]-local node next index. */
 177   u8 local_next_by_ip_protocol[256];
 178
 179   /** IP_BUILTIN_PROTOCOL_{TCP,UDP,ICMP,OTHER} by protocol in IP header. */
 180   u8 builtin_protocol_by_ip_protocol[256];
 181 } ip_lookup_main_t;
 182
 183 clib_error_t *ip_interface_address_add_del (ip_lookup_main_t * lm,
 184                                             u32 sw_if_index,
 185                                             void *address,
 186                                             u32 address_length,
 187                                             u32 is_del, u32 * result_index);
 188
 189 u8 *format_ip_flow_hash_config (u8 * s, va_list * args);
 190
 191 always_inline ip_interface_address_t *
 192 ip_get_interface_address (ip_lookup_main_t * lm, void *addr_fib)
 193 {
 194   uword *p = mhash_get (&lm->address_to_if_address_index, addr_fib);
 195   return p ? pool_elt_at_index (lm->if_address_pool, p[0]) : 0;
 196 }
 197
 198 always_inline void *
 199 ip_interface_address_get_address (ip_lookup_main_t * lm,
 200                                   ip_interface_address_t * a)
 201 {
 202   return mhash_key_to_mem (&lm->address_to_if_address_index, a->address_key);
 203 }
 204
 205 always_inline ip_interface_prefix_t *
 206 ip_get_interface_prefix (ip_lookup_main_t * lm, ip_interface_prefix_key_t * k)
 207 {
 208   uword *p = mhash_get (&lm->prefix_to_if_prefix_index, k);
 209   return p ? pool_elt_at_index (lm->if_prefix_pool, p[0]) : 0;
 210 }
 211
 212 /* *INDENT-OFF* */
 213 #define foreach_ip_interface_address(lm,a,sw_if_index,loop,body)        \
 214 do {                                                                    \
 215     vnet_main_t *_vnm = vnet_get_main();                                \
 216     u32 _sw_if_index = sw_if_index;                                     \
 217     vnet_sw_interface_t *_swif;                                         \
 218     _swif = vnet_get_sw_interface (_vnm, _sw_if_index);                 \
 219                                                                         \
 220     /*                                                                  \
 221      * Loop => honor unnumbered interface addressing.                   \
 222      */                                                                 \
 223     if (_swif->flags & VNET_SW_INTERFACE_FLAG_UNNUMBERED)               \
 224       {                                                                 \
 225         if (loop)                                                       \
 226           _sw_if_index = _swif->unnumbered_sw_if_index;                 \
 227         else                                                            \
 228           /* the interface is unnumbered, by the caller does not want   \
 229            * unnumbered interfaces considered/honoured */               \
 230           break;                                                        \
 231       }                                                                 \
 232     u32 _ia = ((vec_len((lm)->if_address_pool_index_by_sw_if_index)     \
 233                 > (_sw_if_index)) ?                                     \
 234                vec_elt ((lm)->if_address_pool_index_by_sw_if_index,     \
 235                         (_sw_if_index)) :                               \
 236                (u32)~0);                                                \
 237     ip_interface_address_t * _a;                                        \
 238     while (_ia != ~0)                                                   \
 239     {                                                                   \
 240         _a = pool_elt_at_index ((lm)->if_address_pool, _ia);            \
 241         _ia = _a->next_this_sw_interface;                               \
 242         (a) = _a;                                                       \
 243         body;                                                           \
 244     }                                                                   \
 245 } while (0)
 246 /* *INDENT-ON* */
 247
 248 always_inline void
 249 ip_lookup_set_buffer_fib_index (u32 * fib_index_by_sw_if_index,
 250                                 vlib_buffer_t * b)
 251 {
 252   /* *INDENT-OFF* */
 253   vnet_buffer (b)->ip.fib_index =
 254     vec_elt (fib_index_by_sw_if_index, vnet_buffer (b)->sw_if_index[VLIB_RX]);
 255   vnet_buffer (b)->ip.fib_index =
 256     ((vnet_buffer (b)->sw_if_index[VLIB_TX] ==  (u32) ~ 0) ?
 257      vnet_buffer (b)->ip.fib_index :
 258      vnet_buffer (b)->sw_if_index[VLIB_TX]);
 259   /* *INDENT-ON* */
 260 }
 261
 262 typedef struct _vnet_ip_container_proxy_args
 263 {
 264   fib_prefix_t prefix;
 265   u32 sw_if_index;
 266   u8 is_add;
 267 } vnet_ip_container_proxy_args_t;
 268
 269 clib_error_t *vnet_ip_container_proxy_add_del (vnet_ip_container_proxy_args_t
 270                                                * args);
 271
 272 typedef int (*ip_container_proxy_cb_t) (const fib_prefix_t * pfx,
 273                                         u32 sw_if_index, void *ctx);
 274 void ip_container_proxy_walk (ip_container_proxy_cb_t cb, void *ctx);
 275
 276 void ip_lookup_init (ip_lookup_main_t * lm, u32 ip_lookup_node_index);
 277
 278 #endif /* included_ip_lookup_h */
 279 /*
 280  * fd.io coding-style-patch-verification: ON
 281  *
 282  * Local Variables:
 283  * eval: (c-set-style "gnu")
 284  * End:
 285  */