src/plugins/map/map.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 #include <stdbool.h>
  16 #include <vppinfra/error.h>
  17 #include <vnet/vnet.h>
  18 #include <vnet/ip/ip.h>
  19 #include <vlib/vlib.h>
  20 #include <vnet/fib/fib_types.h>
  21 #include <vnet/fib/ip4_fib.h>
  22 #include <vnet/adj/adj.h>
  23 #include <vnet/dpo/load_balance.h>
  24 #include "lpm.h"
  25 #include <vppinfra/lock.h>
  26
  27 #define MAP_SKIP_IP6_LOOKUP 1
  28
  29 #define MAP_ERR_GOOD                    0
  30 #define MAP_ERR_BAD_POOL_SIZE           -1
  31 #define MAP_ERR_BAD_HT_RATIO            -2
  32 #define MAP_ERR_BAD_LIFETIME            -3
  33 #define MAP_ERR_BAD_BUFFERS             -4
  34 #define MAP_ERR_BAD_BUFFERS_TOO_LARGE   -5
  35 #define MAP_ERR_UNSUPPORTED             -6
  36
  37 int map_create_domain (ip4_address_t * ip4_prefix, u8 ip4_prefix_len,
  38                        ip6_address_t * ip6_prefix, u8 ip6_prefix_len,
  39                        ip6_address_t * ip6_src, u8 ip6_src_len,
  40                        u8 ea_bits_len, u8 psid_offset, u8 psid_length,
  41                        u32 * map_domain_index, u16 mtu, u8 flags, u8 * tag);
  42 int map_delete_domain (u32 map_domain_index);
  43 int map_add_del_psid (u32 map_domain_index, u16 psid, ip6_address_t * tep,
  44                       bool is_add);
  45 int map_if_enable_disable (bool is_enable, u32 sw_if_index,
  46                            bool is_translation);
  47 u8 *format_map_trace (u8 * s, va_list * args);
  48
  49 int map_param_set_fragmentation (bool inner, bool ignore_df);
  50 int map_param_set_icmp (ip4_address_t * ip4_err_relay_src);
  51 int map_param_set_icmp6 (u8 enable_unreachable);
  52 void map_pre_resolve (ip4_address_t * ip4, ip6_address_t * ip6, bool is_del);
  53 int map_param_set_reassembly (bool is_ipv6, u16 lifetime_ms, u16 pool_size,
  54                               u32 buffers, f64 ht_ratio, u32 * reass,
  55                               u32 * packets);
  56 int map_param_set_security_check (bool enable, bool fragments);
  57 int map_param_set_traffic_class (bool copy, u8 tc);
  58 int map_param_set_tcp (u16 tcp_mss);
  59
  60
  61 typedef enum
  62 {
  63   MAP_DOMAIN_PREFIX = 1 << 0,
  64   MAP_DOMAIN_TRANSLATION = 1 << 1,      // The domain uses MAP-T
  65   MAP_DOMAIN_RFC6052 = 1 << 2,
  66 } __attribute__ ((__packed__)) map_domain_flags_e;
  67
  68 #define MAP_IP6_REASS_LIFETIME_DEFAULT (100)    /* ms */
  69 #define MAP_IP6_REASS_HT_RATIO_DEFAULT (1.0)
  70 #define MAP_IP6_REASS_POOL_SIZE_DEFAULT 1024    // Number of reassembly structures
  71 #define MAP_IP6_REASS_BUFFERS_DEFAULT 2048
  72
  73 #define MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY 5
  74
  75 #define MAP_IP6_REASS_COUNT_BYTES
  76
  77 //#define IP6_MAP_T_OVERRIDE_TOS 0
  78
  79 /*
  80  * This structure _MUST_ be no larger than a single cache line (64 bytes).
  81  * If more space is needed make a union of ip6_prefix and *rules, as
  82  * those are mutually exclusive.
  83  */
  84 typedef struct
  85 {
  86   /* Required for pool_get_aligned */
  87   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  88   ip6_address_t ip6_src;
  89   ip6_address_t ip6_prefix;
  90   ip6_address_t *rules;
  91   u32 suffix_mask;
  92   ip4_address_t ip4_prefix;
  93   u16 psid_mask;
  94   u16 mtu;
  95   map_domain_flags_e flags;
  96   u8 ip6_prefix_len;
  97   u8 ip6_src_len;
  98   u8 ea_bits_len;
  99   u8 psid_offset;
 100   u8 psid_length;
 101
 102   /* helpers */
 103   u8 psid_shift;
 104   u8 suffix_shift;
 105   u8 ea_shift;
 106
 107   /* not used by forwarding */
 108   u8 ip4_prefix_len;
 109 } map_domain_t;
 110
 111 STATIC_ASSERT ((sizeof (map_domain_t) <= CLIB_CACHE_LINE_BYTES),
 112                "MAP domain fits in one cacheline");
 113
 114 /*
 115  * Extra data about a domain that doesn't need to be time/space critical.
 116  * This structure is in a vector parallel to the main map_domain_t,
 117  * and indexed by the same map-domain-index values.
 118  */
 119 typedef struct
 120 {
 121   u8 *tag;                      /* Probably a user-assigned domain name. */
 122 } map_domain_extra_t;
 123
 124 #define MAP_REASS_INDEX_NONE ((u16)0xffff)
 125
 126 /*
 127  * MAP domain counters
 128  */
 129 typedef enum
 130 {
 131   /* Simple counters */
 132   MAP_DOMAIN_IPV4_FRAGMENT = 0,
 133   /* Combined counters */
 134   MAP_DOMAIN_COUNTER_RX = 0,
 135   MAP_DOMAIN_COUNTER_TX,
 136   MAP_N_DOMAIN_COUNTER
 137 } map_domain_counter_t;
 138
 139 /*
 140  * main_main_t
 141  */
 142 /* *INDENT-OFF* */
 143 typedef union {
 144   CLIB_PACKED (struct {
 145     ip6_address_t src;
 146     ip6_address_t dst;
 147     u32 fragment_id;
 148     u8 protocol;
 149   });
 150   u64 as_u64[5];
 151   u32 as_u32[10];
 152 } map_ip6_reass_key_t;
 153 /* *INDENT-OFF* */
 154
 155 typedef struct {
 156   u32 pi; //Cached packet or ~0
 157   u16 next_data_offset; //The data offset of the additional 20 bytes or ~0
 158   u8 next_data_len; //Number of bytes ready to be copied (20 if not last fragment)
 159   u8 next_data[20]; //The 20 additional bytes
 160 } map_ip6_fragment_t;
 161
 162 typedef struct {
 163   map_ip6_reass_key_t key;
 164   f64 ts;
 165 #ifdef MAP_IP6_REASS_COUNT_BYTES
 166   u16 expected_total;
 167   u16 forwarded;
 168 #endif
 169   u16 bucket; //What hash bucket this element is linked in
 170   u16 bucket_next;
 171   u16 fifo_prev;
 172   u16 fifo_next;
 173   ip4_header_t ip4_header;
 174   map_ip6_fragment_t fragments[MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY];
 175 } map_ip6_reass_t;
 176
 177 #ifdef MAP_SKIP_IP6_LOOKUP
 178 /**
 179  * A pre-resolved next-hop
 180  */
 181 typedef struct map_main_pre_resolved_t_
 182 {
 183   /**
 184    * Linkage into the FIB graph
 185    */
 186   fib_node_t node;
 187
 188   /**
 189    * The FIB entry index of the next-hop
 190    */
 191   fib_node_index_t fei;
 192
 193   /**
 194    * This object sibling index on the FIB entry's child dependency list
 195    */
 196   u32 sibling;
 197
 198   /**
 199    * The Load-balance object index to use to forward
 200    */
 201   dpo_id_t dpo;
 202 } map_main_pre_resolved_t;
 203
 204 /**
 205  * Pre-resolved next hops for v4 and v6. Why these are global and not
 206  * per-domain is beyond me.
 207  */
 208 extern map_main_pre_resolved_t pre_resolved[FIB_PROTOCOL_MAX];
 209 #endif
 210
 211 typedef struct {
 212   /* pool of MAP domains */
 213   map_domain_t *domains;
 214   map_domain_extra_t *domain_extras;
 215
 216   /* MAP Domain packet/byte counters indexed by map domain index */
 217   vlib_simple_counter_main_t *simple_domain_counters;
 218   vlib_combined_counter_main_t *domain_counters;
 219   volatile u32 *counter_lock;
 220
 221   /* API message id base */
 222   u16 msg_id_base;
 223
 224   /* Traffic class: zero, copy (~0) or fixed value */
 225   u8 tc;
 226   bool tc_copy;
 227
 228   bool sec_check;               /* Inbound security check */
 229   bool sec_check_frag;          /* Inbound security check for (subsequent) fragments */
 230   bool icmp6_enabled;           /* Send destination unreachable for security check failure */
 231
 232   u16 tcp_mss;                  /* TCP MSS clamp value */
 233
 234   /* ICMPv6 -> ICMPv4 relay parameters */
 235   ip4_address_t icmp4_src_address;
 236   vlib_simple_counter_main_t icmp_relayed;
 237
 238   /* convenience */
 239   vlib_main_t *vlib_main;
 240   vnet_main_t *vnet_main;
 241
 242   bool frag_inner;              /* Inner or outer fragmentation */
 243   bool frag_ignore_df;          /* Fragment (outer) packet even if DF is set */
 244
 245   /*
 246    * IPv6 decap reassembly
 247    */
 248   /* Configuration */
 249   f32 ip6_reass_conf_ht_ratio; //Size of ht is 2^ceil(log2(ratio*pool_size))
 250   u16 ip6_reass_conf_pool_size; //Max number of allocated reass structures
 251   u16 ip6_reass_conf_lifetime_ms; //Time a reassembly struct is considered valid in ms
 252   u32 ip6_reass_conf_buffers; //Maximum number of buffers used by ip6 reassembly
 253
 254   /* Runtime */
 255   map_ip6_reass_t *ip6_reass_pool;
 256   u8 ip6_reass_ht_log2len; //Hash table size is 2^log2len
 257   u16 ip6_reass_allocated;
 258   u16 *ip6_reass_hash_table;
 259   u16 ip6_reass_fifo_last;
 260   clib_spinlock_t ip6_reass_lock;
 261
 262   /* Counters */
 263   u32 ip6_reass_buffered_counter;
 264
 265   /* Graph node state */
 266   uword *bm_trans_enabled_by_sw_if;
 267   uword *bm_encap_enabled_by_sw_if;
 268
 269   /* Lookup tables */
 270   lpm_t *ip4_prefix_tbl;
 271   lpm_t *ip6_prefix_tbl;
 272   lpm_t *ip6_src_prefix_tbl;
 273
 274   uword ip4_sv_reass_custom_next_index;
 275 } map_main_t;
 276
 277 /*
 278  * MAP Error counters/messages
 279  */
 280 #define foreach_map_error                               \
 281   /* Must be first. */                                  \
 282  _(NONE, "valid MAP packets")                           \
 283  _(BAD_PROTOCOL, "bad protocol")                        \
 284  _(SEC_CHECK, "security check failed")                  \
 285  _(ENCAP_SEC_CHECK, "encap security check failed")      \
 286  _(DECAP_SEC_CHECK, "decap security check failed")      \
 287  _(ICMP, "unable to translate ICMP")                    \
 288  _(ICMP_RELAY, "unable to relay ICMP")                  \
 289  _(UNKNOWN, "unknown")                                  \
 290  _(NO_BINDING, "no binding")                            \
 291  _(NO_DOMAIN, "no domain")                              \
 292  _(FRAGMENTED, "packet is a fragment")                  \
 293  _(FRAGMENT_MEMORY, "could not cache fragment")         \
 294  _(FRAGMENT_MALFORMED, "fragment has unexpected format")\
 295  _(FRAGMENT_DROPPED, "dropped cached fragment")         \
 296  _(MALFORMED, "malformed packet")                       \
 297  _(DF_SET, "can't fragment, DF set")
 298
 299 typedef enum {
 300 #define _(sym,str) MAP_ERROR_##sym,
 301    foreach_map_error
 302 #undef _
 303    MAP_N_ERROR,
 304  } map_error_t;
 305
 306 u64 map_error_counter_get(u32 node_index, map_error_t map_error);
 307
 308 typedef struct {
 309   u32 map_domain_index;
 310   u16 port;
 311 } map_trace_t;
 312
 313 always_inline void
 314 map_add_trace (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_buffer_t *b,
 315                u32 map_domain_index, u16 port)
 316 {
 317   map_trace_t *tr = vlib_add_trace (vm, node, b, sizeof (*tr));
 318   tr->map_domain_index = map_domain_index;
 319   tr->port = port;
 320 }
 321
 322 extern map_main_t map_main;
 323
 324 extern vlib_node_registration_t ip4_map_node;
 325 extern vlib_node_registration_t ip6_map_node;
 326
 327 extern vlib_node_registration_t ip4_map_t_node;
 328 extern vlib_node_registration_t ip4_map_t_fragmented_node;
 329 extern vlib_node_registration_t ip4_map_t_tcp_udp_node;
 330 extern vlib_node_registration_t ip4_map_t_icmp_node;
 331
 332 extern vlib_node_registration_t ip6_map_t_node;
 333 extern vlib_node_registration_t ip6_map_t_fragmented_node;
 334 extern vlib_node_registration_t ip6_map_t_tcp_udp_node;
 335 extern vlib_node_registration_t ip6_map_t_icmp_node;
 336
 337 /*
 338  * map_get_pfx
 339  */
 340 static_always_inline u64
 341 map_get_pfx (map_domain_t *d, u32 addr, u16 port)
 342 {
 343   u16 psid = (port >> d->psid_shift) & d->psid_mask;
 344
 345   if (d->ea_bits_len == 0 && d->rules)
 346     return clib_net_to_host_u64(d->rules[psid].as_u64[0]);
 347
 348   u32 suffix = (addr >> d->suffix_shift) & d->suffix_mask;
 349   u64 ea = d->ea_bits_len == 0 ? 0 : (((u64) suffix << d->psid_length)) | psid;
 350
 351   return clib_net_to_host_u64(d->ip6_prefix.as_u64[0]) | ea << d->ea_shift;
 352 }
 353
 354 static_always_inline u64
 355 map_get_pfx_net (map_domain_t *d, u32 addr, u16 port)
 356 {
 357   return clib_host_to_net_u64(map_get_pfx(d, clib_net_to_host_u32(addr),
 358                                           clib_net_to_host_u16(port)));
 359 }
 360
 361 /*
 362  * map_get_sfx
 363  */
 364 static_always_inline u64
 365 map_get_sfx (map_domain_t *d, u32 addr, u16 port)
 366 {
 367   u16 psid = (port >> d->psid_shift) & d->psid_mask;
 368
 369   /* Shared 1:1 mode. */
 370   if (d->ea_bits_len == 0 && d->rules)
 371     return clib_net_to_host_u64(d->rules[psid].as_u64[1]);
 372   if (d->ip6_prefix_len == 128)
 373     return clib_net_to_host_u64(d->ip6_prefix.as_u64[1]);
 374
 375   if (d->ip6_src_len == 96)
 376     return (clib_net_to_host_u64(d->ip6_prefix.as_u64[1]) | addr);
 377
 378   /* IPv4 prefix */
 379   if (d->flags & MAP_DOMAIN_PREFIX)
 380     return (u64) (addr & (0xFFFFFFFF << d->suffix_shift)) << 16;
 381
 382   /* Shared or full IPv4 address */
 383   return ((u64) addr << 16) | psid;
 384 }
 385
 386 static_always_inline u64
 387 map_get_sfx_net (map_domain_t *d, u32 addr, u16 port)
 388 {
 389   return clib_host_to_net_u64(map_get_sfx(d, clib_net_to_host_u32(addr),
 390                                           clib_net_to_host_u16(port)));
 391 }
 392
 393 static_always_inline u32
 394 map_get_ip4 (ip6_address_t *addr, u16 prefix_len)
 395 {
 396   ASSERT(prefix_len == 64 || prefix_len == 96);
 397   if (prefix_len == 96)
 398     return clib_host_to_net_u32(clib_net_to_host_u64(addr->as_u64[1]));
 399   else
 400     return clib_host_to_net_u32(clib_net_to_host_u64(addr->as_u64[1]) >> 16);
 401 }
 402
 403 static_always_inline map_domain_t *
 404 ip4_map_get_domain (ip4_address_t *addr, u32 *map_domain_index, u8 *error)
 405 {
 406   map_main_t *mm = &map_main;
 407
 408   u32 mdi = mm->ip4_prefix_tbl->lookup(mm->ip4_prefix_tbl, addr, 32);
 409   if (mdi == ~0) {
 410     *error = MAP_ERROR_NO_DOMAIN;
 411     return 0;
 412   }
 413   *map_domain_index = mdi;
 414   return pool_elt_at_index(mm->domains, mdi);
 415 }
 416
 417 /*
 418  * Get the MAP domain from an IPv6 address.
 419  * If the IPv6 address or
 420  * prefix is shared the IPv4 address must be used.
 421  */
 422 static_always_inline map_domain_t *
 423 ip6_map_get_domain (ip6_address_t *addr,
 424                     u32 *map_domain_index,
 425                     u8 *error)
 426 {
 427   map_main_t *mm = &map_main;
 428   u32 mdi = mm->ip6_src_prefix_tbl->lookup(mm->ip6_src_prefix_tbl, addr, 128);
 429   if (mdi == ~0) {
 430     *error = MAP_ERROR_NO_DOMAIN;
 431     return 0;
 432   }
 433
 434   *map_domain_index = mdi;
 435   return pool_elt_at_index(mm->domains, mdi);
 436 }
 437
 438 clib_error_t * map_plugin_api_hookup (vlib_main_t * vm);
 439
 440 map_ip6_reass_t *
 441 map_ip6_reass_get(ip6_address_t *src, ip6_address_t *dst, u32 fragment_id,
 442                   u8 protocol, u32 **pi_to_drop);
 443 void
 444 map_ip6_reass_free(map_ip6_reass_t *r, u32 **pi_to_drop);
 445
 446 #define map_ip6_reass_lock() clib_spinlock_lock (&map_main.ip6_reass_lock)
 447 #define map_ip6_reass_unlock() clib_spinlock_unlock (&map_main.ip6_reass_lock)
 448
 449 int
 450 map_ip6_reass_add_fragment(map_ip6_reass_t *r, u32 pi,
 451                            u16 data_offset, u16 next_data_offset,
 452                            u8 *data_start, u16 data_len);
 453
 454 void map_ip4_drop_pi(u32 pi);
 455
 456 void map_ip6_drop_pi(u32 pi);
 457
 458
 459 int map_ip6_reass_conf_ht_ratio(f32 ht_ratio, u32 *trashed_reass, u32 *dropped_packets);
 460 #define MAP_IP6_REASS_CONF_HT_RATIO_MAX 100
 461 int map_ip6_reass_conf_pool_size(u16 pool_size, u32 *trashed_reass, u32 *dropped_packets);
 462 #define MAP_IP6_REASS_CONF_POOL_SIZE_MAX (0xfeff)
 463 int map_ip6_reass_conf_lifetime(u16 lifetime_ms);
 464 #define MAP_IP6_REASS_CONF_LIFETIME_MAX 0xffff
 465 int map_ip6_reass_conf_buffers(u32 buffers);
 466 #define MAP_IP6_REASS_CONF_BUFFERS_MAX (0xffffffff)
 467
 468 /*
 469  * Supports prefix of 96 or 64 (with u-octet)
 470  */
 471 static_always_inline void
 472 ip4_map_t_embedded_address (map_domain_t *d,
 473                             ip6_address_t *ip6, const ip4_address_t *ip4)
 474 {
 475   ASSERT(d->ip6_src_len == 96 || d->ip6_src_len == 64); //No support for other lengths for now
 476   u8 offset = d->ip6_src_len == 64 ? 9 : 12;
 477   ip6->as_u64[0] = d->ip6_src.as_u64[0];
 478   ip6->as_u64[1] = d->ip6_src.as_u64[1];
 479   clib_memcpy_fast(&ip6->as_u8[offset], ip4, 4);
 480 }
 481
 482 static_always_inline u32
 483 ip6_map_t_embedded_address (map_domain_t *d, ip6_address_t *addr)
 484 {
 485   ASSERT(d->ip6_src_len == 64 || d->ip6_src_len == 96);
 486   u32 x;
 487   u8 offset = d->ip6_src_len == 64 ? 9 : 12;
 488   clib_memcpy(&x, &addr->as_u8[offset], 4);
 489   return x;
 490 }
 491
 492 static inline void
 493 map_domain_counter_lock (map_main_t *mm)
 494 {
 495   if (mm->counter_lock)
 496     while (clib_atomic_test_and_set (mm->counter_lock))
 497       /* zzzz */ ;
 498 }
 499
 500 static inline void
 501 map_domain_counter_unlock (map_main_t *mm)
 502 {
 503   if (mm->counter_lock)
 504     clib_atomic_release (mm->counter_lock);
 505 }
 506
 507
 508 static_always_inline void
 509 map_send_all_to_node(vlib_main_t *vm, u32 *pi_vector,
 510                      vlib_node_runtime_t *node, vlib_error_t *error,
 511                      u32 next)
 512 {
 513   u32 n_left_from, *from, next_index, *to_next, n_left_to_next;
 514   //Deal with fragments that are ready
 515   from = pi_vector;
 516   n_left_from = vec_len(pi_vector);
 517   next_index = node->cached_next_index;
 518   while (n_left_from > 0) {
 519     vlib_get_next_frame(vm, node, next_index, to_next, n_left_to_next);
 520     while (n_left_from > 0 && n_left_to_next > 0) {
 521       u32 pi0 = to_next[0] = from[0];
 522       from += 1;
 523       n_left_from -= 1;
 524       to_next += 1;
 525       n_left_to_next -= 1;
 526       vlib_buffer_t *p0 = vlib_get_buffer(vm, pi0);
 527       p0->error = *error;
 528       vlib_validate_buffer_enqueue_x1(vm, node, next_index, to_next, n_left_to_next, pi0, next);
 529     }
 530     vlib_put_next_frame(vm, node, next_index, n_left_to_next);
 531   }
 532 }
 533
 534 static_always_inline void
 535 map_mss_clamping (tcp_header_t * tcp, ip_csum_t * sum, u16 mss_clamping)
 536 {
 537   u8 *data;
 538   u8 opt_len, opts_len, kind;
 539   u16 mss;
 540   u16 mss_value_net = clib_host_to_net_u16(mss_clamping);
 541
 542   if (!tcp_syn (tcp))
 543     return;
 544
 545   opts_len = (tcp_doff (tcp) << 2) - sizeof (tcp_header_t);
 546   data = (u8 *) (tcp + 1);
 547   for (; opts_len > 0; opts_len -= opt_len, data += opt_len)
 548     {
 549       kind = data[0];
 550
 551       if (kind == TCP_OPTION_EOL)
 552         break;
 553       else if (kind == TCP_OPTION_NOOP)
 554         {
 555           opt_len = 1;
 556           continue;
 557         }
 558       else
 559         {
 560           if (opts_len < 2)
 561             return;
 562           opt_len = data[1];
 563
 564           if (opt_len < 2 || opt_len > opts_len)
 565             return;
 566         }
 567
 568       if (kind == TCP_OPTION_MSS)
 569         {
 570           mss = *(u16 *) (data + 2);
 571           if (clib_net_to_host_u16 (mss) > mss_clamping)
 572             {
 573               *sum =
 574                 ip_csum_update (*sum, mss, mss_value_net, ip4_header_t,
 575                                 length);
 576               clib_memcpy (data + 2, &mss_value_net, 2);
 577             }
 578           return;
 579         }
 580     }
 581 }
 582
 583 /*
 584  * fd.io coding-style-patch-verification: ON
 585  *
 586  * Local Variables:
 587  * eval: (c-set-style "gnu")
 588  * End:
 589  */