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 <map/map_dpo.h>
24 #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);
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 u8 *format_map_trace (u8 * s, va_list * args);
45 int map_param_set_fragmentation (bool inner, bool ignore_df);
46 int map_param_set_icmp (ip4_address_t * ip4_err_relay_src);
47 int map_param_set_icmp6 (u8 enable_unreachable);
48 void map_pre_resolve (ip4_address_t * ip4, ip6_address_t * ip6, int is_del);
49 int map_param_set_reassembly (bool is_ipv6, u16 lifetime_ms,
50 u16 pool_size, u32 buffers, f64 ht_ratio,
51 u32 * reass, u32 * packets);
52 int map_param_set_security_check (bool enable, bool fragments);
53 int map_param_set_traffic_class (bool copy, u8 tc);
58 MAP_DOMAIN_PREFIX = 1 << 0,
59 MAP_DOMAIN_TRANSLATION = 1 << 1, // The domain uses MAP-T
60 MAP_DOMAIN_RFC6052 = 1 << 2,
61 } __attribute__ ((__packed__)) map_domain_flags_e;
64 * IP4 reassembly logic:
65 * One virtually reassembled flow requires a map_ip4_reass_t structure in order
66 * to keep the first-fragment port number and, optionally, cache out of sequence
68 * There are up to MAP_IP4_REASS_MAX_REASSEMBLY such structures.
69 * When in use, those structures are stored in a hash table of MAP_IP4_REASS_BUCKETS buckets.
70 * When a new structure needs to be used, it is allocated from available ones.
71 * If there is no structure available, the oldest in use is selected and used if and
72 * only if it was first allocated more than MAP_IP4_REASS_LIFETIME seconds ago.
73 * In case no structure can be allocated, the fragment is dropped.
76 #define MAP_IP4_REASS_LIFETIME_DEFAULT (100) /* ms */
77 #define MAP_IP4_REASS_HT_RATIO_DEFAULT (1.0)
78 #define MAP_IP4_REASS_POOL_SIZE_DEFAULT 1024 // Number of reassembly structures
79 #define MAP_IP4_REASS_BUFFERS_DEFAULT 2048
81 #define MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY 5 // Number of fragment per reassembly
83 #define MAP_IP6_REASS_LIFETIME_DEFAULT (100) /* ms */
84 #define MAP_IP6_REASS_HT_RATIO_DEFAULT (1.0)
85 #define MAP_IP6_REASS_POOL_SIZE_DEFAULT 1024 // Number of reassembly structures
86 #define MAP_IP6_REASS_BUFFERS_DEFAULT 2048
88 #define MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY 5
90 #define MAP_IP6_REASS_COUNT_BYTES
91 #define MAP_IP4_REASS_COUNT_BYTES
93 //#define IP6_MAP_T_OVERRIDE_TOS 0
96 * This structure _MUST_ be no larger than a single cache line (64 bytes).
97 * If more space is needed make a union of ip6_prefix and *rules, those are mutually exclusive.
101 /* Required for pool_get_aligned */
102 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
103 ip6_address_t ip6_src;
104 ip6_address_t ip6_prefix;
105 ip6_address_t *rules;
107 ip4_address_t ip4_prefix;
110 map_domain_flags_e flags;
122 /* not used by forwarding */
126 STATIC_ASSERT ((sizeof (map_domain_t) <= CLIB_CACHE_LINE_BYTES),
127 "MAP domain fits in one cacheline");
129 #define MAP_REASS_INDEX_NONE ((u16)0xffff)
132 * Hash key, padded out to 16 bytes for fast compare
136 CLIB_PACKED (struct {
144 } map_ip4_reass_key_t;
149 map_ip4_reass_key_t key;
151 #ifdef MAP_IP4_REASS_COUNT_BYTES
160 u32 fragments[MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY];
164 * MAP domain counters
168 /* Simple counters */
169 MAP_DOMAIN_IPV4_FRAGMENT = 0,
170 /* Combined counters */
171 MAP_DOMAIN_COUNTER_RX = 0,
172 MAP_DOMAIN_COUNTER_TX,
174 } map_domain_counter_t;
181 CLIB_PACKED (struct {
189 } map_ip6_reass_key_t;
193 u32 pi; //Cached packet or ~0
194 u16 next_data_offset; //The data offset of the additional 20 bytes or ~0
195 u8 next_data_len; //Number of bytes ready to be copied (20 if not last fragment)
196 u8 next_data[20]; //The 20 additional bytes
197 } map_ip6_fragment_t;
200 map_ip6_reass_key_t key;
202 #ifdef MAP_IP6_REASS_COUNT_BYTES
206 u16 bucket; //What hash bucket this element is linked in
210 ip4_header_t ip4_header;
211 map_ip6_fragment_t fragments[MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY];
214 #ifdef MAP_SKIP_IP6_LOOKUP
216 * A pre-resolved next-hop
218 typedef struct map_main_pre_resolved_t_
221 * Linkage into the FIB graph
226 * The FIB entry index of the next-hop
228 fib_node_index_t fei;
231 * This object sibling index on the FIB entry's child dependency list
236 * The Load-balance object index to use to forward
239 } map_main_pre_resolved_t;
242 * Pre-resolved next hops for v4 and v6. Why these are global and not
243 * per-domain is beyond me.
245 extern map_main_pre_resolved_t pre_resolved[FIB_PROTOCOL_MAX];
249 /* pool of MAP domains */
250 map_domain_t *domains;
252 /* MAP Domain packet/byte counters indexed by map domain index */
253 vlib_simple_counter_main_t *simple_domain_counters;
254 vlib_combined_counter_main_t *domain_counters;
255 volatile u32 *counter_lock;
257 /* API message id base */
260 /* Traffic class: zero, copy (~0) or fixed value */
264 bool sec_check; /* Inbound security check */
265 bool sec_check_frag; /* Inbound security check for (subsequent) fragments */
266 bool icmp6_enabled; /* Send destination unreachable for security check failure */
268 /* ICMPv6 -> ICMPv4 relay parameters */
269 ip4_address_t icmp4_src_address;
270 vlib_simple_counter_main_t icmp_relayed;
273 vlib_main_t *vlib_main;
274 vnet_main_t *vnet_main;
277 * IPv4 encap and decap reassembly
280 f32 ip4_reass_conf_ht_ratio; //Size of ht is 2^ceil(log2(ratio*pool_size))
281 u16 ip4_reass_conf_pool_size; //Max number of allocated reass structures
282 u16 ip4_reass_conf_lifetime_ms; //Time a reassembly struct is considered valid in ms
283 u32 ip4_reass_conf_buffers; //Maximum number of buffers used by ip4 reassembly
286 map_ip4_reass_t *ip4_reass_pool;
287 u8 ip4_reass_ht_log2len; //Hash table size is 2^log2len
288 u16 ip4_reass_allocated;
289 u16 *ip4_reass_hash_table;
290 u16 ip4_reass_fifo_last;
291 volatile u32 *ip4_reass_lock;
294 u32 ip4_reass_buffered_counter;
296 bool frag_inner; /* Inner or outer fragmentation */
297 bool frag_ignore_df; /* Fragment (outer) packet even if DF is set */
300 * IPv6 decap reassembly
303 f32 ip6_reass_conf_ht_ratio; //Size of ht is 2^ceil(log2(ratio*pool_size))
304 u16 ip6_reass_conf_pool_size; //Max number of allocated reass structures
305 u16 ip6_reass_conf_lifetime_ms; //Time a reassembly struct is considered valid in ms
306 u32 ip6_reass_conf_buffers; //Maximum number of buffers used by ip6 reassembly
309 map_ip6_reass_t *ip6_reass_pool;
310 u8 ip6_reass_ht_log2len; //Hash table size is 2^log2len
311 u16 ip6_reass_allocated;
312 u16 *ip6_reass_hash_table;
313 u16 ip6_reass_fifo_last;
314 volatile u32 *ip6_reass_lock;
317 u32 ip6_reass_buffered_counter;
322 * MAP Error counters/messages
324 #define foreach_map_error \
325 /* Must be first. */ \
326 _(NONE, "valid MAP packets") \
327 _(BAD_PROTOCOL, "bad protocol") \
328 _(SEC_CHECK, "security check failed") \
329 _(ENCAP_SEC_CHECK, "encap security check failed") \
330 _(DECAP_SEC_CHECK, "decap security check failed") \
331 _(ICMP, "unable to translate ICMP") \
332 _(ICMP_RELAY, "unable to relay ICMP") \
333 _(UNKNOWN, "unknown") \
334 _(NO_BINDING, "no binding") \
335 _(NO_DOMAIN, "no domain") \
336 _(FRAGMENTED, "packet is a fragment") \
337 _(FRAGMENT_MEMORY, "could not cache fragment") \
338 _(FRAGMENT_MALFORMED, "fragment has unexpected format")\
339 _(FRAGMENT_DROPPED, "dropped cached fragment") \
340 _(MALFORMED, "malformed packet") \
341 _(DF_SET, "can't fragment, DF set")
344 #define _(sym,str) MAP_ERROR_##sym,
350 u64 map_error_counter_get(u32 node_index, map_error_t map_error);
353 u32 map_domain_index;
357 extern map_main_t map_main;
359 extern vlib_node_registration_t ip4_map_node;
360 extern vlib_node_registration_t ip6_map_node;
362 extern vlib_node_registration_t ip4_map_t_node;
363 extern vlib_node_registration_t ip4_map_t_fragmented_node;
364 extern vlib_node_registration_t ip4_map_t_tcp_udp_node;
365 extern vlib_node_registration_t ip4_map_t_icmp_node;
367 extern vlib_node_registration_t ip6_map_t_node;
368 extern vlib_node_registration_t ip6_map_t_fragmented_node;
369 extern vlib_node_registration_t ip6_map_t_tcp_udp_node;
370 extern vlib_node_registration_t ip6_map_t_icmp_node;
375 static_always_inline u64
376 map_get_pfx (map_domain_t *d, u32 addr, u16 port)
378 u16 psid = (port >> d->psid_shift) & d->psid_mask;
380 if (d->ea_bits_len == 0 && d->rules)
381 return clib_net_to_host_u64(d->rules[psid].as_u64[0]);
383 u32 suffix = (addr >> d->suffix_shift) & d->suffix_mask;
384 u64 ea = d->ea_bits_len == 0 ? 0 : (((u64) suffix << d->psid_length)) | psid;
386 return clib_net_to_host_u64(d->ip6_prefix.as_u64[0]) | ea << d->ea_shift;
389 static_always_inline u64
390 map_get_pfx_net (map_domain_t *d, u32 addr, u16 port)
392 return clib_host_to_net_u64(map_get_pfx(d, clib_net_to_host_u32(addr),
393 clib_net_to_host_u16(port)));
399 static_always_inline u64
400 map_get_sfx (map_domain_t *d, u32 addr, u16 port)
402 u16 psid = (port >> d->psid_shift) & d->psid_mask;
404 /* Shared 1:1 mode. */
405 if (d->ea_bits_len == 0 && d->rules)
406 return clib_net_to_host_u64(d->rules[psid].as_u64[1]);
407 if (d->ip6_prefix_len == 128)
408 return clib_net_to_host_u64(d->ip6_prefix.as_u64[1]);
410 if (d->flags & MAP_DOMAIN_RFC6052)
411 return (clib_net_to_host_u64(d->ip6_prefix.as_u64[1]) | addr);
414 if (d->flags & MAP_DOMAIN_PREFIX)
415 return (u64) (addr & (0xFFFFFFFF << d->suffix_shift)) << 16;
417 /* Shared or full IPv4 address */
418 return ((u64) addr << 16) | psid;
421 static_always_inline u64
422 map_get_sfx_net (map_domain_t *d, u32 addr, u16 port)
424 return clib_host_to_net_u64(map_get_sfx(d, clib_net_to_host_u32(addr),
425 clib_net_to_host_u16(port)));
428 static_always_inline u32
429 map_get_ip4 (ip6_address_t *addr, map_domain_flags_e flags)
431 if (flags & MAP_DOMAIN_RFC6052)
432 return clib_host_to_net_u32(clib_net_to_host_u64(addr->as_u64[1]));
434 return clib_host_to_net_u32(clib_net_to_host_u64(addr->as_u64[1]) >> 16);
438 * Get the MAP domain from an IPv4 lookup adjacency.
440 static_always_inline map_domain_t *
441 ip4_map_get_domain (u32 mdi)
443 map_main_t *mm = &map_main;
445 return pool_elt_at_index(mm->domains, mdi);
449 * Get the MAP domain from an IPv6 lookup adjacency.
450 * If the IPv6 address or prefix is not shared, no lookup is required.
451 * The IPv4 address is used otherwise.
453 static_always_inline map_domain_t *
454 ip6_map_get_domain (u32 mdi,
456 u32 *map_domain_index,
459 map_main_t *mm = &map_main;
463 * Disable direct MAP domain lookup on decap, until the security check is updated to verify IPv4 SA.
464 * (That's done implicitly when MAP domain is looked up in the IPv4 FIB)
466 //#ifdef MAP_NONSHARED_DOMAIN_ENABLED
467 //#error "How can you be sure this domain is not shared?"
470 *map_domain_index = mdi;
471 return pool_elt_at_index(mm->domains, mdi);
474 u32 lbi = ip4_fib_forwarding_lookup(0, addr);
475 const dpo_id_t *dpo = load_balance_get_bucket(lbi, 0);
476 if (PREDICT_TRUE(dpo->dpoi_type == map_dpo_type ||
477 dpo->dpoi_type == map_t_dpo_type))
479 *map_domain_index = dpo->dpoi_index;
480 return pool_elt_at_index(mm->domains, *map_domain_index);
482 *error = MAP_ERROR_NO_DOMAIN;
488 map_ip4_reass_get(u32 src, u32 dst, u16 fragment_id,
489 u8 protocol, u32 **pi_to_drop);
491 map_ip4_reass_free(map_ip4_reass_t *r, u32 **pi_to_drop);
493 #define map_ip4_reass_lock() while (clib_atomic_test_and_set (map_main.ip4_reass_lock)) {}
494 #define map_ip4_reass_unlock() do {CLIB_MEMORY_BARRIER(); *map_main.ip4_reass_lock = 0;} while(0)
496 static_always_inline void
497 map_ip4_reass_get_fragments(map_ip4_reass_t *r, u32 **pi)
500 for (i=0; i<MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY; i++)
501 if(r->fragments[i] != ~0) {
502 vec_add1(*pi, r->fragments[i]);
503 r->fragments[i] = ~0;
504 map_main.ip4_reass_buffered_counter--;
508 clib_error_t * map_plugin_api_hookup (vlib_main_t * vm);
510 int map_ip4_reass_add_fragment(map_ip4_reass_t *r, u32 pi);
513 map_ip6_reass_get(ip6_address_t *src, ip6_address_t *dst, u32 fragment_id,
514 u8 protocol, u32 **pi_to_drop);
516 map_ip6_reass_free(map_ip6_reass_t *r, u32 **pi_to_drop);
518 #define map_ip6_reass_lock() while (clib_atomic_test_and_set (map_main.ip6_reass_lock)) {}
519 #define map_ip6_reass_unlock() do {CLIB_MEMORY_BARRIER(); *map_main.ip6_reass_lock = 0;} while(0)
522 map_ip6_reass_add_fragment(map_ip6_reass_t *r, u32 pi,
523 u16 data_offset, u16 next_data_offset,
524 u8 *data_start, u16 data_len);
526 void map_ip4_drop_pi(u32 pi);
528 int map_ip4_reass_conf_ht_ratio(f32 ht_ratio, u32 *trashed_reass, u32 *dropped_packets);
529 #define MAP_IP4_REASS_CONF_HT_RATIO_MAX 100
530 int map_ip4_reass_conf_pool_size(u16 pool_size, u32 *trashed_reass, u32 *dropped_packets);
531 #define MAP_IP4_REASS_CONF_POOL_SIZE_MAX (0xfeff)
532 int map_ip4_reass_conf_lifetime(u16 lifetime_ms);
533 #define MAP_IP4_REASS_CONF_LIFETIME_MAX 0xffff
534 int map_ip4_reass_conf_buffers(u32 buffers);
535 #define MAP_IP4_REASS_CONF_BUFFERS_MAX (0xffffffff)
537 void map_ip6_drop_pi(u32 pi);
540 int map_ip6_reass_conf_ht_ratio(f32 ht_ratio, u32 *trashed_reass, u32 *dropped_packets);
541 #define MAP_IP6_REASS_CONF_HT_RATIO_MAX 100
542 int map_ip6_reass_conf_pool_size(u16 pool_size, u32 *trashed_reass, u32 *dropped_packets);
543 #define MAP_IP6_REASS_CONF_POOL_SIZE_MAX (0xfeff)
544 int map_ip6_reass_conf_lifetime(u16 lifetime_ms);
545 #define MAP_IP6_REASS_CONF_LIFETIME_MAX 0xffff
546 int map_ip6_reass_conf_buffers(u32 buffers);
547 #define MAP_IP6_REASS_CONF_BUFFERS_MAX (0xffffffff)
549 static_always_inline void
550 ip4_map_t_embedded_address (map_domain_t *d,
551 ip6_address_t *ip6, const ip4_address_t *ip4)
553 ASSERT(d->ip6_src_len == 96 || d->ip6_src_len == 64); //No support for other lengths for now
554 u8 offset = d->ip6_src_len == 64 ? 9 : 12;
555 ip6->as_u64[0] = d->ip6_src.as_u64[0];
556 ip6->as_u64[1] = d->ip6_src.as_u64[1];
557 clib_memcpy_fast(&ip6->as_u8[offset], ip4, 4);
560 static_always_inline u32
561 ip6_map_t_embedded_address (map_domain_t *d, ip6_address_t *addr)
563 ASSERT(d->ip6_src_len == 64 || d->ip6_src_len == 96);
565 u8 offset = d->ip6_src_len == 64 ? 9 : 12;
566 clib_memcpy(&x, &addr->as_u8[offset], 4);
571 map_domain_counter_lock (map_main_t *mm)
573 if (mm->counter_lock)
574 while (clib_atomic_test_and_set (mm->counter_lock))
578 map_domain_counter_unlock (map_main_t *mm)
580 if (mm->counter_lock)
581 clib_atomic_release (mm->counter_lock);
585 static_always_inline void
586 map_send_all_to_node(vlib_main_t *vm, u32 *pi_vector,
587 vlib_node_runtime_t *node, vlib_error_t *error,
590 u32 n_left_from, *from, next_index, *to_next, n_left_to_next;
591 //Deal with fragments that are ready
593 n_left_from = vec_len(pi_vector);
594 next_index = node->cached_next_index;
595 while (n_left_from > 0) {
596 vlib_get_next_frame(vm, node, next_index, to_next, n_left_to_next);
597 while (n_left_from > 0 && n_left_to_next > 0) {
598 u32 pi0 = to_next[0] = from[0];
603 vlib_buffer_t *p0 = vlib_get_buffer(vm, pi0);
605 vlib_validate_buffer_enqueue_x1(vm, node, next_index, to_next, n_left_to_next, pi0, next);
607 vlib_put_next_frame(vm, node, next_index, n_left_to_next);
612 * fd.io coding-style-patch-verification: ON
615 * eval: (c-set-style "gnu")