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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
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>
25 #include <vppinfra/lock.h>
27 #define MAP_SKIP_IP6_LOOKUP 1
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
36 int map_create_domain (ip4_address_t * ip4_prefix, u8 ip4_prefix_len,
37 ip6_address_t * ip6_prefix, u8 ip6_prefix_len,
38 ip6_address_t * ip6_src, u8 ip6_src_len,
39 u8 ea_bits_len, u8 psid_offset, u8 psid_length,
40 u32 * map_domain_index, u16 mtu, u8 flags, u8 * tag);
41 int map_delete_domain (u32 map_domain_index);
42 int map_add_del_psid (u32 map_domain_index, u16 psid, ip6_address_t * tep,
44 int map_if_enable_disable (bool is_enable, u32 sw_if_index,
46 u8 *format_map_trace (u8 * s, va_list * args);
48 int map_param_set_fragmentation (bool inner, bool ignore_df);
49 int map_param_set_icmp (ip4_address_t * ip4_err_relay_src);
50 int map_param_set_icmp6 (u8 enable_unreachable);
51 void map_pre_resolve (ip4_address_t * ip4, ip6_address_t * ip6, bool is_del);
52 int map_param_set_reassembly (bool is_ipv6, u16 lifetime_ms,
53 u16 pool_size, u32 buffers, f64 ht_ratio,
54 u32 * reass, u32 * packets);
55 int map_param_set_security_check (bool enable, bool fragments);
56 int map_param_set_traffic_class (bool copy, u8 tc);
57 int map_param_set_tcp (u16 tcp_mss);
62 MAP_DOMAIN_PREFIX = 1 << 0,
63 MAP_DOMAIN_TRANSLATION = 1 << 1, // The domain uses MAP-T
64 MAP_DOMAIN_RFC6052 = 1 << 2,
65 } __attribute__ ((__packed__)) map_domain_flags_e;
68 * IP4 reassembly logic:
69 * One virtually reassembled flow requires a map_ip4_reass_t structure in order
70 * to keep the first-fragment port number and, optionally, cache out of sequence
72 * There are up to MAP_IP4_REASS_MAX_REASSEMBLY such structures.
73 * When in use, those structures are stored in a hash table of MAP_IP4_REASS_BUCKETS buckets.
74 * When a new structure needs to be used, it is allocated from available ones.
75 * If there is no structure available, the oldest in use is selected and used if and
76 * only if it was first allocated more than MAP_IP4_REASS_LIFETIME seconds ago.
77 * In case no structure can be allocated, the fragment is dropped.
80 #define MAP_IP4_REASS_LIFETIME_DEFAULT (100) /* ms */
81 #define MAP_IP4_REASS_HT_RATIO_DEFAULT (1.0)
82 #define MAP_IP4_REASS_POOL_SIZE_DEFAULT 1024 // Number of reassembly structures
83 #define MAP_IP4_REASS_BUFFERS_DEFAULT 2048
85 #define MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY 5 // Number of fragment per reassembly
87 #define MAP_IP6_REASS_LIFETIME_DEFAULT (100) /* ms */
88 #define MAP_IP6_REASS_HT_RATIO_DEFAULT (1.0)
89 #define MAP_IP6_REASS_POOL_SIZE_DEFAULT 1024 // Number of reassembly structures
90 #define MAP_IP6_REASS_BUFFERS_DEFAULT 2048
92 #define MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY 5
94 #define MAP_IP6_REASS_COUNT_BYTES
95 #define MAP_IP4_REASS_COUNT_BYTES
97 //#define IP6_MAP_T_OVERRIDE_TOS 0
100 * This structure _MUST_ be no larger than a single cache line (64 bytes).
101 * If more space is needed make a union of ip6_prefix and *rules, as
102 * those are mutually exclusive.
106 /* Required for pool_get_aligned */
107 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
108 ip6_address_t ip6_src;
109 ip6_address_t ip6_prefix;
110 ip6_address_t *rules;
112 ip4_address_t ip4_prefix;
115 map_domain_flags_e flags;
127 /* not used by forwarding */
131 STATIC_ASSERT ((sizeof (map_domain_t) <= CLIB_CACHE_LINE_BYTES),
132 "MAP domain fits in one cacheline");
135 * Extra data about a domain that doesn't need to be time/space critical.
136 * This structure is in a vector parallel to the main map_domain_t,
137 * and indexed by the same map-domain-index values.
141 u8 *tag; /* Probably a user-assigned domain name. */
142 } map_domain_extra_t;
144 #define MAP_REASS_INDEX_NONE ((u16)0xffff)
147 * Hash key, padded out to 16 bytes for fast compare
151 CLIB_PACKED (struct {
159 } map_ip4_reass_key_t;
164 map_ip4_reass_key_t key;
166 #ifdef MAP_IP4_REASS_COUNT_BYTES
175 u32 fragments[MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY];
179 * MAP domain counters
183 /* Simple counters */
184 MAP_DOMAIN_IPV4_FRAGMENT = 0,
185 /* Combined counters */
186 MAP_DOMAIN_COUNTER_RX = 0,
187 MAP_DOMAIN_COUNTER_TX,
189 } map_domain_counter_t;
196 CLIB_PACKED (struct {
204 } map_ip6_reass_key_t;
208 u32 pi; //Cached packet or ~0
209 u16 next_data_offset; //The data offset of the additional 20 bytes or ~0
210 u8 next_data_len; //Number of bytes ready to be copied (20 if not last fragment)
211 u8 next_data[20]; //The 20 additional bytes
212 } map_ip6_fragment_t;
215 map_ip6_reass_key_t key;
217 #ifdef MAP_IP6_REASS_COUNT_BYTES
221 u16 bucket; //What hash bucket this element is linked in
225 ip4_header_t ip4_header;
226 map_ip6_fragment_t fragments[MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY];
229 #ifdef MAP_SKIP_IP6_LOOKUP
231 * A pre-resolved next-hop
233 typedef struct map_main_pre_resolved_t_
236 * Linkage into the FIB graph
241 * The FIB entry index of the next-hop
243 fib_node_index_t fei;
246 * This object sibling index on the FIB entry's child dependency list
251 * The Load-balance object index to use to forward
254 } map_main_pre_resolved_t;
257 * Pre-resolved next hops for v4 and v6. Why these are global and not
258 * per-domain is beyond me.
260 extern map_main_pre_resolved_t pre_resolved[FIB_PROTOCOL_MAX];
264 /* pool of MAP domains */
265 map_domain_t *domains;
266 map_domain_extra_t *domain_extras;
268 /* MAP Domain packet/byte counters indexed by map domain index */
269 vlib_simple_counter_main_t *simple_domain_counters;
270 vlib_combined_counter_main_t *domain_counters;
271 volatile u32 *counter_lock;
273 /* API message id base */
276 /* Traffic class: zero, copy (~0) or fixed value */
280 bool sec_check; /* Inbound security check */
281 bool sec_check_frag; /* Inbound security check for (subsequent) fragments */
282 bool icmp6_enabled; /* Send destination unreachable for security check failure */
284 u16 tcp_mss; /* TCP MSS clamp value */
286 /* ICMPv6 -> ICMPv4 relay parameters */
287 ip4_address_t icmp4_src_address;
288 vlib_simple_counter_main_t icmp_relayed;
291 vlib_main_t *vlib_main;
292 vnet_main_t *vnet_main;
295 * IPv4 encap and decap reassembly
298 f32 ip4_reass_conf_ht_ratio; //Size of ht is 2^ceil(log2(ratio*pool_size))
299 u16 ip4_reass_conf_pool_size; //Max number of allocated reass structures
300 u16 ip4_reass_conf_lifetime_ms; //Time a reassembly struct is considered valid in ms
301 u32 ip4_reass_conf_buffers; //Maximum number of buffers used by ip4 reassembly
304 map_ip4_reass_t *ip4_reass_pool;
305 u8 ip4_reass_ht_log2len; //Hash table size is 2^log2len
306 u16 ip4_reass_allocated;
307 u16 *ip4_reass_hash_table;
308 u16 ip4_reass_fifo_last;
309 clib_spinlock_t ip4_reass_lock;
312 u32 ip4_reass_buffered_counter;
314 bool frag_inner; /* Inner or outer fragmentation */
315 bool frag_ignore_df; /* Fragment (outer) packet even if DF is set */
318 * IPv6 decap reassembly
321 f32 ip6_reass_conf_ht_ratio; //Size of ht is 2^ceil(log2(ratio*pool_size))
322 u16 ip6_reass_conf_pool_size; //Max number of allocated reass structures
323 u16 ip6_reass_conf_lifetime_ms; //Time a reassembly struct is considered valid in ms
324 u32 ip6_reass_conf_buffers; //Maximum number of buffers used by ip6 reassembly
327 map_ip6_reass_t *ip6_reass_pool;
328 u8 ip6_reass_ht_log2len; //Hash table size is 2^log2len
329 u16 ip6_reass_allocated;
330 u16 *ip6_reass_hash_table;
331 u16 ip6_reass_fifo_last;
332 clib_spinlock_t ip6_reass_lock;
335 u32 ip6_reass_buffered_counter;
337 /* Graph node state */
338 uword *bm_trans_enabled_by_sw_if;
339 uword *bm_encap_enabled_by_sw_if;
342 lpm_t *ip4_prefix_tbl;
343 lpm_t *ip6_prefix_tbl;
344 lpm_t *ip6_src_prefix_tbl;
348 * MAP Error counters/messages
350 #define foreach_map_error \
351 /* Must be first. */ \
352 _(NONE, "valid MAP packets") \
353 _(BAD_PROTOCOL, "bad protocol") \
354 _(SEC_CHECK, "security check failed") \
355 _(ENCAP_SEC_CHECK, "encap security check failed") \
356 _(DECAP_SEC_CHECK, "decap security check failed") \
357 _(ICMP, "unable to translate ICMP") \
358 _(ICMP_RELAY, "unable to relay ICMP") \
359 _(UNKNOWN, "unknown") \
360 _(NO_BINDING, "no binding") \
361 _(NO_DOMAIN, "no domain") \
362 _(FRAGMENTED, "packet is a fragment") \
363 _(FRAGMENT_MEMORY, "could not cache fragment") \
364 _(FRAGMENT_MALFORMED, "fragment has unexpected format")\
365 _(FRAGMENT_DROPPED, "dropped cached fragment") \
366 _(MALFORMED, "malformed packet") \
367 _(DF_SET, "can't fragment, DF set")
370 #define _(sym,str) MAP_ERROR_##sym,
376 u64 map_error_counter_get(u32 node_index, map_error_t map_error);
379 u32 map_domain_index;
383 extern map_main_t map_main;
385 extern vlib_node_registration_t ip4_map_node;
386 extern vlib_node_registration_t ip6_map_node;
388 extern vlib_node_registration_t ip4_map_t_node;
389 extern vlib_node_registration_t ip4_map_t_fragmented_node;
390 extern vlib_node_registration_t ip4_map_t_tcp_udp_node;
391 extern vlib_node_registration_t ip4_map_t_icmp_node;
393 extern vlib_node_registration_t ip6_map_t_node;
394 extern vlib_node_registration_t ip6_map_t_fragmented_node;
395 extern vlib_node_registration_t ip6_map_t_tcp_udp_node;
396 extern vlib_node_registration_t ip6_map_t_icmp_node;
401 static_always_inline u64
402 map_get_pfx (map_domain_t *d, u32 addr, u16 port)
404 u16 psid = (port >> d->psid_shift) & d->psid_mask;
406 if (d->ea_bits_len == 0 && d->rules)
407 return clib_net_to_host_u64(d->rules[psid].as_u64[0]);
409 u32 suffix = (addr >> d->suffix_shift) & d->suffix_mask;
410 u64 ea = d->ea_bits_len == 0 ? 0 : (((u64) suffix << d->psid_length)) | psid;
412 return clib_net_to_host_u64(d->ip6_prefix.as_u64[0]) | ea << d->ea_shift;
415 static_always_inline u64
416 map_get_pfx_net (map_domain_t *d, u32 addr, u16 port)
418 return clib_host_to_net_u64(map_get_pfx(d, clib_net_to_host_u32(addr),
419 clib_net_to_host_u16(port)));
425 static_always_inline u64
426 map_get_sfx (map_domain_t *d, u32 addr, u16 port)
428 u16 psid = (port >> d->psid_shift) & d->psid_mask;
430 /* Shared 1:1 mode. */
431 if (d->ea_bits_len == 0 && d->rules)
432 return clib_net_to_host_u64(d->rules[psid].as_u64[1]);
433 if (d->ip6_prefix_len == 128)
434 return clib_net_to_host_u64(d->ip6_prefix.as_u64[1]);
436 if (d->ip6_src_len == 96)
437 return (clib_net_to_host_u64(d->ip6_prefix.as_u64[1]) | addr);
440 if (d->flags & MAP_DOMAIN_PREFIX)
441 return (u64) (addr & (0xFFFFFFFF << d->suffix_shift)) << 16;
443 /* Shared or full IPv4 address */
444 return ((u64) addr << 16) | psid;
447 static_always_inline u64
448 map_get_sfx_net (map_domain_t *d, u32 addr, u16 port)
450 return clib_host_to_net_u64(map_get_sfx(d, clib_net_to_host_u32(addr),
451 clib_net_to_host_u16(port)));
454 static_always_inline u32
455 map_get_ip4 (ip6_address_t *addr, u16 prefix_len)
457 ASSERT(prefix_len == 64 || prefix_len == 96);
458 if (prefix_len == 96)
459 return clib_host_to_net_u32(clib_net_to_host_u64(addr->as_u64[1]));
461 return clib_host_to_net_u32(clib_net_to_host_u64(addr->as_u64[1]) >> 16);
464 static_always_inline map_domain_t *
465 ip4_map_get_domain (ip4_address_t *addr, u32 *map_domain_index, u8 *error)
467 map_main_t *mm = &map_main;
469 u32 mdi = mm->ip4_prefix_tbl->lookup(mm->ip4_prefix_tbl, addr, 32);
471 *error = MAP_ERROR_NO_DOMAIN;
474 *map_domain_index = mdi;
475 return pool_elt_at_index(mm->domains, mdi);
479 * Get the MAP domain from an IPv6 address.
480 * If the IPv6 address or
481 * prefix is shared the IPv4 address must be used.
483 static_always_inline map_domain_t *
484 ip6_map_get_domain (ip6_address_t *addr,
485 u32 *map_domain_index,
488 map_main_t *mm = &map_main;
489 u32 mdi = mm->ip6_src_prefix_tbl->lookup(mm->ip6_src_prefix_tbl, addr, 128);
491 *error = MAP_ERROR_NO_DOMAIN;
495 *map_domain_index = mdi;
496 return pool_elt_at_index(mm->domains, mdi);
500 map_ip4_reass_get(u32 src, u32 dst, u16 fragment_id,
501 u8 protocol, u32 **pi_to_drop);
503 map_ip4_reass_free(map_ip4_reass_t *r, u32 **pi_to_drop);
505 #define map_ip4_reass_lock() clib_spinlock_lock (&map_main.ip4_reass_lock)
506 #define map_ip4_reass_unlock() clib_spinlock_unlock (&map_main.ip4_reass_lock)
508 static_always_inline void
509 map_ip4_reass_get_fragments(map_ip4_reass_t *r, u32 **pi)
512 for (i=0; i<MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY; i++)
513 if(r->fragments[i] != ~0) {
514 vec_add1(*pi, r->fragments[i]);
515 r->fragments[i] = ~0;
516 map_main.ip4_reass_buffered_counter--;
520 clib_error_t * map_plugin_api_hookup (vlib_main_t * vm);
522 int map_ip4_reass_add_fragment(map_ip4_reass_t *r, u32 pi);
525 map_ip6_reass_get(ip6_address_t *src, ip6_address_t *dst, u32 fragment_id,
526 u8 protocol, u32 **pi_to_drop);
528 map_ip6_reass_free(map_ip6_reass_t *r, u32 **pi_to_drop);
530 #define map_ip6_reass_lock() clib_spinlock_lock (&map_main.ip6_reass_lock)
531 #define map_ip6_reass_unlock() clib_spinlock_unlock (&map_main.ip6_reass_lock)
534 map_ip6_reass_add_fragment(map_ip6_reass_t *r, u32 pi,
535 u16 data_offset, u16 next_data_offset,
536 u8 *data_start, u16 data_len);
538 void map_ip4_drop_pi(u32 pi);
540 int map_ip4_reass_conf_ht_ratio(f32 ht_ratio, u32 *trashed_reass, u32 *dropped_packets);
541 #define MAP_IP4_REASS_CONF_HT_RATIO_MAX 100
542 int map_ip4_reass_conf_pool_size(u16 pool_size, u32 *trashed_reass, u32 *dropped_packets);
543 #define MAP_IP4_REASS_CONF_POOL_SIZE_MAX (0xfeff)
544 int map_ip4_reass_conf_lifetime(u16 lifetime_ms);
545 #define MAP_IP4_REASS_CONF_LIFETIME_MAX 0xffff
546 int map_ip4_reass_conf_buffers(u32 buffers);
547 #define MAP_IP4_REASS_CONF_BUFFERS_MAX (0xffffffff)
549 void map_ip6_drop_pi(u32 pi);
552 int map_ip6_reass_conf_ht_ratio(f32 ht_ratio, u32 *trashed_reass, u32 *dropped_packets);
553 #define MAP_IP6_REASS_CONF_HT_RATIO_MAX 100
554 int map_ip6_reass_conf_pool_size(u16 pool_size, u32 *trashed_reass, u32 *dropped_packets);
555 #define MAP_IP6_REASS_CONF_POOL_SIZE_MAX (0xfeff)
556 int map_ip6_reass_conf_lifetime(u16 lifetime_ms);
557 #define MAP_IP6_REASS_CONF_LIFETIME_MAX 0xffff
558 int map_ip6_reass_conf_buffers(u32 buffers);
559 #define MAP_IP6_REASS_CONF_BUFFERS_MAX (0xffffffff)
562 * Supports prefix of 96 or 64 (with u-octet)
564 static_always_inline void
565 ip4_map_t_embedded_address (map_domain_t *d,
566 ip6_address_t *ip6, const ip4_address_t *ip4)
568 ASSERT(d->ip6_src_len == 96 || d->ip6_src_len == 64); //No support for other lengths for now
569 u8 offset = d->ip6_src_len == 64 ? 9 : 12;
570 ip6->as_u64[0] = d->ip6_src.as_u64[0];
571 ip6->as_u64[1] = d->ip6_src.as_u64[1];
572 clib_memcpy_fast(&ip6->as_u8[offset], ip4, 4);
575 static_always_inline u32
576 ip6_map_t_embedded_address (map_domain_t *d, ip6_address_t *addr)
578 ASSERT(d->ip6_src_len == 64 || d->ip6_src_len == 96);
580 u8 offset = d->ip6_src_len == 64 ? 9 : 12;
581 clib_memcpy(&x, &addr->as_u8[offset], 4);
586 map_domain_counter_lock (map_main_t *mm)
588 if (mm->counter_lock)
589 while (clib_atomic_test_and_set (mm->counter_lock))
594 map_domain_counter_unlock (map_main_t *mm)
596 if (mm->counter_lock)
597 clib_atomic_release (mm->counter_lock);
601 static_always_inline void
602 map_send_all_to_node(vlib_main_t *vm, u32 *pi_vector,
603 vlib_node_runtime_t *node, vlib_error_t *error,
606 u32 n_left_from, *from, next_index, *to_next, n_left_to_next;
607 //Deal with fragments that are ready
609 n_left_from = vec_len(pi_vector);
610 next_index = node->cached_next_index;
611 while (n_left_from > 0) {
612 vlib_get_next_frame(vm, node, next_index, to_next, n_left_to_next);
613 while (n_left_from > 0 && n_left_to_next > 0) {
614 u32 pi0 = to_next[0] = from[0];
619 vlib_buffer_t *p0 = vlib_get_buffer(vm, pi0);
621 vlib_validate_buffer_enqueue_x1(vm, node, next_index, to_next, n_left_to_next, pi0, next);
623 vlib_put_next_frame(vm, node, next_index, n_left_to_next);
627 static_always_inline void
628 map_mss_clamping (tcp_header_t * tcp, ip_csum_t * sum, u16 mss_clamping)
631 u8 opt_len, opts_len, kind;
633 u16 mss_value_net = clib_host_to_net_u16(mss_clamping);
638 opts_len = (tcp_doff (tcp) << 2) - sizeof (tcp_header_t);
639 data = (u8 *) (tcp + 1);
640 for (; opts_len > 0; opts_len -= opt_len, data += opt_len)
644 if (kind == TCP_OPTION_EOL)
646 else if (kind == TCP_OPTION_NOOP)
657 if (opt_len < 2 || opt_len > opts_len)
661 if (kind == TCP_OPTION_MSS)
663 mss = *(u16 *) (data + 2);
664 if (clib_net_to_host_u16 (mss) > mss_clamping)
667 ip_csum_update (*sum, mss, mss_value_net, ip4_header_t,
669 clib_memcpy (data + 2, &mss_value_net, 2);
677 * fd.io coding-style-patch-verification: ON
680 * eval: (c-set-style "gnu")