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>
26 #define MAP_SKIP_IP6_LOOKUP 1
28 #define MAP_ERR_GOOD 0
29 #define MAP_ERR_BAD_POOL_SIZE -1
30 #define MAP_ERR_BAD_HT_RATIO -2
31 #define MAP_ERR_BAD_LIFETIME -3
32 #define MAP_ERR_BAD_BUFFERS -4
33 #define MAP_ERR_BAD_BUFFERS_TOO_LARGE -5
35 int map_create_domain (ip4_address_t * ip4_prefix, u8 ip4_prefix_len,
36 ip6_address_t * ip6_prefix, u8 ip6_prefix_len,
37 ip6_address_t * ip6_src, u8 ip6_src_len,
38 u8 ea_bits_len, u8 psid_offset, u8 psid_length,
39 u32 * map_domain_index, u16 mtu, u8 flags, char *tag);
40 int map_delete_domain (u32 map_domain_index);
41 int map_add_del_psid (u32 map_domain_index, u16 psid, ip6_address_t * tep,
43 int map_if_enable_disable (bool is_enable, u32 sw_if_index,
45 u8 *format_map_trace (u8 * s, va_list * args);
47 int map_param_set_fragmentation (bool inner, bool ignore_df);
48 int map_param_set_icmp (ip4_address_t * ip4_err_relay_src);
49 int map_param_set_icmp6 (u8 enable_unreachable);
50 void map_pre_resolve (ip4_address_t * ip4, ip6_address_t * ip6, bool is_del);
51 int map_param_set_reassembly (bool is_ipv6, u16 lifetime_ms,
52 u16 pool_size, u32 buffers, f64 ht_ratio,
53 u32 * reass, u32 * packets);
54 int map_param_set_security_check (bool enable, bool fragments);
55 int map_param_set_traffic_class (bool copy, u8 tc);
56 int map_param_set_tcp (u16 tcp_mss);
61 MAP_DOMAIN_PREFIX = 1 << 0,
62 MAP_DOMAIN_TRANSLATION = 1 << 1, // The domain uses MAP-T
63 MAP_DOMAIN_RFC6052 = 1 << 2,
64 } __attribute__ ((__packed__)) map_domain_flags_e;
67 * IP4 reassembly logic:
68 * One virtually reassembled flow requires a map_ip4_reass_t structure in order
69 * to keep the first-fragment port number and, optionally, cache out of sequence
71 * There are up to MAP_IP4_REASS_MAX_REASSEMBLY such structures.
72 * When in use, those structures are stored in a hash table of MAP_IP4_REASS_BUCKETS buckets.
73 * When a new structure needs to be used, it is allocated from available ones.
74 * If there is no structure available, the oldest in use is selected and used if and
75 * only if it was first allocated more than MAP_IP4_REASS_LIFETIME seconds ago.
76 * In case no structure can be allocated, the fragment is dropped.
79 #define MAP_IP4_REASS_LIFETIME_DEFAULT (100) /* ms */
80 #define MAP_IP4_REASS_HT_RATIO_DEFAULT (1.0)
81 #define MAP_IP4_REASS_POOL_SIZE_DEFAULT 1024 // Number of reassembly structures
82 #define MAP_IP4_REASS_BUFFERS_DEFAULT 2048
84 #define MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY 5 // Number of fragment per reassembly
86 #define MAP_IP6_REASS_LIFETIME_DEFAULT (100) /* ms */
87 #define MAP_IP6_REASS_HT_RATIO_DEFAULT (1.0)
88 #define MAP_IP6_REASS_POOL_SIZE_DEFAULT 1024 // Number of reassembly structures
89 #define MAP_IP6_REASS_BUFFERS_DEFAULT 2048
91 #define MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY 5
93 #define MAP_IP6_REASS_COUNT_BYTES
94 #define MAP_IP4_REASS_COUNT_BYTES
96 //#define IP6_MAP_T_OVERRIDE_TOS 0
99 * This structure _MUST_ be no larger than a single cache line (64 bytes).
100 * If more space is needed make a union of ip6_prefix and *rules, as
101 * those are mutually exclusive.
105 /* Required for pool_get_aligned */
106 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
107 ip6_address_t ip6_src;
108 ip6_address_t ip6_prefix;
109 ip6_address_t *rules;
111 ip4_address_t ip4_prefix;
114 map_domain_flags_e flags;
126 /* not used by forwarding */
130 STATIC_ASSERT ((sizeof (map_domain_t) <= CLIB_CACHE_LINE_BYTES),
131 "MAP domain fits in one cacheline");
134 * Extra data about a domain that doesn't need to be time/space critical.
135 * This structure is in a vector parallel to the main map_domain_t,
136 * and indexed by the same map-domain-index values.
140 char *tag; /* Probably a user-assigned domain name. */
141 } map_domain_extra_t;
143 #define MAP_REASS_INDEX_NONE ((u16)0xffff)
146 * Hash key, padded out to 16 bytes for fast compare
150 CLIB_PACKED (struct {
158 } map_ip4_reass_key_t;
163 map_ip4_reass_key_t key;
165 #ifdef MAP_IP4_REASS_COUNT_BYTES
174 u32 fragments[MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY];
178 * MAP domain counters
182 /* Simple counters */
183 MAP_DOMAIN_IPV4_FRAGMENT = 0,
184 /* Combined counters */
185 MAP_DOMAIN_COUNTER_RX = 0,
186 MAP_DOMAIN_COUNTER_TX,
188 } map_domain_counter_t;
195 CLIB_PACKED (struct {
203 } map_ip6_reass_key_t;
207 u32 pi; //Cached packet or ~0
208 u16 next_data_offset; //The data offset of the additional 20 bytes or ~0
209 u8 next_data_len; //Number of bytes ready to be copied (20 if not last fragment)
210 u8 next_data[20]; //The 20 additional bytes
211 } map_ip6_fragment_t;
214 map_ip6_reass_key_t key;
216 #ifdef MAP_IP6_REASS_COUNT_BYTES
220 u16 bucket; //What hash bucket this element is linked in
224 ip4_header_t ip4_header;
225 map_ip6_fragment_t fragments[MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY];
228 #ifdef MAP_SKIP_IP6_LOOKUP
230 * A pre-resolved next-hop
232 typedef struct map_main_pre_resolved_t_
235 * Linkage into the FIB graph
240 * The FIB entry index of the next-hop
242 fib_node_index_t fei;
245 * This object sibling index on the FIB entry's child dependency list
250 * The Load-balance object index to use to forward
253 } map_main_pre_resolved_t;
256 * Pre-resolved next hops for v4 and v6. Why these are global and not
257 * per-domain is beyond me.
259 extern map_main_pre_resolved_t pre_resolved[FIB_PROTOCOL_MAX];
263 /* pool of MAP domains */
264 map_domain_t *domains;
265 map_domain_extra_t *domain_extras;
267 /* MAP Domain packet/byte counters indexed by map domain index */
268 vlib_simple_counter_main_t *simple_domain_counters;
269 vlib_combined_counter_main_t *domain_counters;
270 volatile u32 *counter_lock;
272 /* API message id base */
275 /* Traffic class: zero, copy (~0) or fixed value */
279 bool sec_check; /* Inbound security check */
280 bool sec_check_frag; /* Inbound security check for (subsequent) fragments */
281 bool icmp6_enabled; /* Send destination unreachable for security check failure */
283 u16 tcp_mss; /* TCP MSS clamp value */
285 /* ICMPv6 -> ICMPv4 relay parameters */
286 ip4_address_t icmp4_src_address;
287 vlib_simple_counter_main_t icmp_relayed;
290 vlib_main_t *vlib_main;
291 vnet_main_t *vnet_main;
294 * IPv4 encap and decap reassembly
297 f32 ip4_reass_conf_ht_ratio; //Size of ht is 2^ceil(log2(ratio*pool_size))
298 u16 ip4_reass_conf_pool_size; //Max number of allocated reass structures
299 u16 ip4_reass_conf_lifetime_ms; //Time a reassembly struct is considered valid in ms
300 u32 ip4_reass_conf_buffers; //Maximum number of buffers used by ip4 reassembly
303 map_ip4_reass_t *ip4_reass_pool;
304 u8 ip4_reass_ht_log2len; //Hash table size is 2^log2len
305 u16 ip4_reass_allocated;
306 u16 *ip4_reass_hash_table;
307 u16 ip4_reass_fifo_last;
308 volatile u32 *ip4_reass_lock;
311 u32 ip4_reass_buffered_counter;
313 bool frag_inner; /* Inner or outer fragmentation */
314 bool frag_ignore_df; /* Fragment (outer) packet even if DF is set */
317 * IPv6 decap reassembly
320 f32 ip6_reass_conf_ht_ratio; //Size of ht is 2^ceil(log2(ratio*pool_size))
321 u16 ip6_reass_conf_pool_size; //Max number of allocated reass structures
322 u16 ip6_reass_conf_lifetime_ms; //Time a reassembly struct is considered valid in ms
323 u32 ip6_reass_conf_buffers; //Maximum number of buffers used by ip6 reassembly
326 map_ip6_reass_t *ip6_reass_pool;
327 u8 ip6_reass_ht_log2len; //Hash table size is 2^log2len
328 u16 ip6_reass_allocated;
329 u16 *ip6_reass_hash_table;
330 u16 ip6_reass_fifo_last;
331 volatile u32 *ip6_reass_lock;
334 u32 ip6_reass_buffered_counter;
336 /* Graph node state */
337 uword *bm_trans_enabled_by_sw_if;
338 uword *bm_encap_enabled_by_sw_if;
341 lpm_t *ip4_prefix_tbl;
342 lpm_t *ip6_prefix_tbl;
343 lpm_t *ip6_src_prefix_tbl;
347 * MAP Error counters/messages
349 #define foreach_map_error \
350 /* Must be first. */ \
351 _(NONE, "valid MAP packets") \
352 _(BAD_PROTOCOL, "bad protocol") \
353 _(SEC_CHECK, "security check failed") \
354 _(ENCAP_SEC_CHECK, "encap security check failed") \
355 _(DECAP_SEC_CHECK, "decap security check failed") \
356 _(ICMP, "unable to translate ICMP") \
357 _(ICMP_RELAY, "unable to relay ICMP") \
358 _(UNKNOWN, "unknown") \
359 _(NO_BINDING, "no binding") \
360 _(NO_DOMAIN, "no domain") \
361 _(FRAGMENTED, "packet is a fragment") \
362 _(FRAGMENT_MEMORY, "could not cache fragment") \
363 _(FRAGMENT_MALFORMED, "fragment has unexpected format")\
364 _(FRAGMENT_DROPPED, "dropped cached fragment") \
365 _(MALFORMED, "malformed packet") \
366 _(DF_SET, "can't fragment, DF set")
369 #define _(sym,str) MAP_ERROR_##sym,
375 u64 map_error_counter_get(u32 node_index, map_error_t map_error);
378 u32 map_domain_index;
382 extern map_main_t map_main;
384 extern vlib_node_registration_t ip4_map_node;
385 extern vlib_node_registration_t ip6_map_node;
387 extern vlib_node_registration_t ip4_map_t_node;
388 extern vlib_node_registration_t ip4_map_t_fragmented_node;
389 extern vlib_node_registration_t ip4_map_t_tcp_udp_node;
390 extern vlib_node_registration_t ip4_map_t_icmp_node;
392 extern vlib_node_registration_t ip6_map_t_node;
393 extern vlib_node_registration_t ip6_map_t_fragmented_node;
394 extern vlib_node_registration_t ip6_map_t_tcp_udp_node;
395 extern vlib_node_registration_t ip6_map_t_icmp_node;
400 static_always_inline u64
401 map_get_pfx (map_domain_t *d, u32 addr, u16 port)
403 u16 psid = (port >> d->psid_shift) & d->psid_mask;
405 if (d->ea_bits_len == 0 && d->rules)
406 return clib_net_to_host_u64(d->rules[psid].as_u64[0]);
408 u32 suffix = (addr >> d->suffix_shift) & d->suffix_mask;
409 u64 ea = d->ea_bits_len == 0 ? 0 : (((u64) suffix << d->psid_length)) | psid;
411 return clib_net_to_host_u64(d->ip6_prefix.as_u64[0]) | ea << d->ea_shift;
414 static_always_inline u64
415 map_get_pfx_net (map_domain_t *d, u32 addr, u16 port)
417 return clib_host_to_net_u64(map_get_pfx(d, clib_net_to_host_u32(addr),
418 clib_net_to_host_u16(port)));
424 static_always_inline u64
425 map_get_sfx (map_domain_t *d, u32 addr, u16 port)
427 u16 psid = (port >> d->psid_shift) & d->psid_mask;
429 /* Shared 1:1 mode. */
430 if (d->ea_bits_len == 0 && d->rules)
431 return clib_net_to_host_u64(d->rules[psid].as_u64[1]);
432 if (d->ip6_prefix_len == 128)
433 return clib_net_to_host_u64(d->ip6_prefix.as_u64[1]);
435 if (d->ip6_src_len == 96)
436 return (clib_net_to_host_u64(d->ip6_prefix.as_u64[1]) | addr);
439 if (d->flags & MAP_DOMAIN_PREFIX)
440 return (u64) (addr & (0xFFFFFFFF << d->suffix_shift)) << 16;
442 /* Shared or full IPv4 address */
443 return ((u64) addr << 16) | psid;
446 static_always_inline u64
447 map_get_sfx_net (map_domain_t *d, u32 addr, u16 port)
449 return clib_host_to_net_u64(map_get_sfx(d, clib_net_to_host_u32(addr),
450 clib_net_to_host_u16(port)));
453 static_always_inline u32
454 map_get_ip4 (ip6_address_t *addr, u16 prefix_len)
456 ASSERT(prefix_len == 64 || prefix_len == 96);
457 if (prefix_len == 96)
458 return clib_host_to_net_u32(clib_net_to_host_u64(addr->as_u64[1]));
460 return clib_host_to_net_u32(clib_net_to_host_u64(addr->as_u64[1]) >> 16);
463 static_always_inline map_domain_t *
464 ip4_map_get_domain (ip4_address_t *addr, u32 *map_domain_index, u8 *error)
466 map_main_t *mm = &map_main;
468 u32 mdi = mm->ip4_prefix_tbl->lookup(mm->ip4_prefix_tbl, addr, 32);
470 *error = MAP_ERROR_NO_DOMAIN;
473 *map_domain_index = mdi;
474 return pool_elt_at_index(mm->domains, mdi);
478 * Get the MAP domain from an IPv6 address.
479 * If the IPv6 address or
480 * prefix is shared the IPv4 address must be used.
482 static_always_inline map_domain_t *
483 ip6_map_get_domain (ip6_address_t *addr,
484 u32 *map_domain_index,
487 map_main_t *mm = &map_main;
488 u32 mdi = mm->ip6_src_prefix_tbl->lookup(mm->ip6_src_prefix_tbl, addr, 128);
490 *error = MAP_ERROR_NO_DOMAIN;
494 *map_domain_index = mdi;
495 return pool_elt_at_index(mm->domains, mdi);
499 map_ip4_reass_get(u32 src, u32 dst, u16 fragment_id,
500 u8 protocol, u32 **pi_to_drop);
502 map_ip4_reass_free(map_ip4_reass_t *r, u32 **pi_to_drop);
504 #define map_ip4_reass_lock() while (clib_atomic_test_and_set (map_main.ip4_reass_lock)) {}
505 #define map_ip4_reass_unlock() do {CLIB_MEMORY_BARRIER(); *map_main.ip4_reass_lock = 0;} while(0)
507 static_always_inline void
508 map_ip4_reass_get_fragments(map_ip4_reass_t *r, u32 **pi)
511 for (i=0; i<MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY; i++)
512 if(r->fragments[i] != ~0) {
513 vec_add1(*pi, r->fragments[i]);
514 r->fragments[i] = ~0;
515 map_main.ip4_reass_buffered_counter--;
519 clib_error_t * map_plugin_api_hookup (vlib_main_t * vm);
521 int map_ip4_reass_add_fragment(map_ip4_reass_t *r, u32 pi);
524 map_ip6_reass_get(ip6_address_t *src, ip6_address_t *dst, u32 fragment_id,
525 u8 protocol, u32 **pi_to_drop);
527 map_ip6_reass_free(map_ip6_reass_t *r, u32 **pi_to_drop);
529 #define map_ip6_reass_lock() while (clib_atomic_test_and_set (map_main.ip6_reass_lock)) {}
530 #define map_ip6_reass_unlock() do {CLIB_MEMORY_BARRIER(); *map_main.ip6_reass_lock = 0;} while(0)
533 map_ip6_reass_add_fragment(map_ip6_reass_t *r, u32 pi,
534 u16 data_offset, u16 next_data_offset,
535 u8 *data_start, u16 data_len);
537 void map_ip4_drop_pi(u32 pi);
539 int map_ip4_reass_conf_ht_ratio(f32 ht_ratio, u32 *trashed_reass, u32 *dropped_packets);
540 #define MAP_IP4_REASS_CONF_HT_RATIO_MAX 100
541 int map_ip4_reass_conf_pool_size(u16 pool_size, u32 *trashed_reass, u32 *dropped_packets);
542 #define MAP_IP4_REASS_CONF_POOL_SIZE_MAX (0xfeff)
543 int map_ip4_reass_conf_lifetime(u16 lifetime_ms);
544 #define MAP_IP4_REASS_CONF_LIFETIME_MAX 0xffff
545 int map_ip4_reass_conf_buffers(u32 buffers);
546 #define MAP_IP4_REASS_CONF_BUFFERS_MAX (0xffffffff)
548 void map_ip6_drop_pi(u32 pi);
551 int map_ip6_reass_conf_ht_ratio(f32 ht_ratio, u32 *trashed_reass, u32 *dropped_packets);
552 #define MAP_IP6_REASS_CONF_HT_RATIO_MAX 100
553 int map_ip6_reass_conf_pool_size(u16 pool_size, u32 *trashed_reass, u32 *dropped_packets);
554 #define MAP_IP6_REASS_CONF_POOL_SIZE_MAX (0xfeff)
555 int map_ip6_reass_conf_lifetime(u16 lifetime_ms);
556 #define MAP_IP6_REASS_CONF_LIFETIME_MAX 0xffff
557 int map_ip6_reass_conf_buffers(u32 buffers);
558 #define MAP_IP6_REASS_CONF_BUFFERS_MAX (0xffffffff)
561 * Supports prefix of 96 or 64 (with u-octet)
563 static_always_inline void
564 ip4_map_t_embedded_address (map_domain_t *d,
565 ip6_address_t *ip6, const ip4_address_t *ip4)
567 ASSERT(d->ip6_src_len == 96 || d->ip6_src_len == 64); //No support for other lengths for now
568 u8 offset = d->ip6_src_len == 64 ? 9 : 12;
569 ip6->as_u64[0] = d->ip6_src.as_u64[0];
570 ip6->as_u64[1] = d->ip6_src.as_u64[1];
571 clib_memcpy_fast(&ip6->as_u8[offset], ip4, 4);
574 static_always_inline u32
575 ip6_map_t_embedded_address (map_domain_t *d, ip6_address_t *addr)
577 ASSERT(d->ip6_src_len == 64 || d->ip6_src_len == 96);
579 u8 offset = d->ip6_src_len == 64 ? 9 : 12;
580 clib_memcpy(&x, &addr->as_u8[offset], 4);
585 map_domain_counter_lock (map_main_t *mm)
587 if (mm->counter_lock)
588 while (clib_atomic_test_and_set (mm->counter_lock))
592 map_domain_counter_unlock (map_main_t *mm)
594 if (mm->counter_lock)
595 clib_atomic_release (mm->counter_lock);
599 static_always_inline void
600 map_send_all_to_node(vlib_main_t *vm, u32 *pi_vector,
601 vlib_node_runtime_t *node, vlib_error_t *error,
604 u32 n_left_from, *from, next_index, *to_next, n_left_to_next;
605 //Deal with fragments that are ready
607 n_left_from = vec_len(pi_vector);
608 next_index = node->cached_next_index;
609 while (n_left_from > 0) {
610 vlib_get_next_frame(vm, node, next_index, to_next, n_left_to_next);
611 while (n_left_from > 0 && n_left_to_next > 0) {
612 u32 pi0 = to_next[0] = from[0];
617 vlib_buffer_t *p0 = vlib_get_buffer(vm, pi0);
619 vlib_validate_buffer_enqueue_x1(vm, node, next_index, to_next, n_left_to_next, pi0, next);
621 vlib_put_next_frame(vm, node, next_index, n_left_to_next);
625 static_always_inline void
626 map_mss_clamping (tcp_header_t * tcp, ip_csum_t * sum, u16 mss_clamping)
629 u8 opt_len, opts_len, kind;
631 u16 mss_value_net = clib_host_to_net_u16(mss_clamping);
636 opts_len = (tcp_doff (tcp) << 2) - sizeof (tcp_header_t);
637 data = (u8 *) (tcp + 1);
638 for (; opts_len > 0; opts_len -= opt_len, data += opt_len)
642 if (kind == TCP_OPTION_EOL)
644 else if (kind == TCP_OPTION_NOOP)
655 if (opt_len < 2 || opt_len > opts_len)
659 if (kind == TCP_OPTION_MSS)
661 mss = *(u16 *) (data + 2);
662 if (clib_net_to_host_u16 (mss) > mss_clamping)
665 ip_csum_update (*sum, mss, mss_value_net, ip4_header_t,
667 clib_memcpy (data + 2, &mss_value_net, 2);
675 * fd.io coding-style-patch-verification: ON
678 * eval: (c-set-style "gnu")