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 int map_create_domain (ip4_address_t * ip4_prefix, u8 ip4_prefix_len,
29 ip6_address_t * ip6_prefix, u8 ip6_prefix_len,
30 ip6_address_t * ip6_src, u8 ip6_src_len,
31 u8 ea_bits_len, u8 psid_offset, u8 psid_length,
32 u32 * map_domain_index, u16 mtu, u8 flags);
33 int map_delete_domain (u32 map_domain_index);
34 int map_add_del_psid (u32 map_domain_index, u16 psid, ip6_address_t * tep,
36 u8 *format_map_trace (u8 * s, va_list * args);
40 MAP_DOMAIN_PREFIX = 1 << 0,
41 MAP_DOMAIN_TRANSLATION = 1 << 1, // The domain uses MAP-T
42 MAP_DOMAIN_RFC6052 = 1 << 2,
43 } __attribute__ ((__packed__)) map_domain_flags_e;
46 * IP4 reassembly logic:
47 * One virtually reassembled flow requires a map_ip4_reass_t structure in order
48 * to keep the first-fragment port number and, optionally, cache out of sequence
50 * There are up to MAP_IP4_REASS_MAX_REASSEMBLY such structures.
51 * When in use, those structures are stored in a hash table of MAP_IP4_REASS_BUCKETS buckets.
52 * When a new structure needs to be used, it is allocated from available ones.
53 * If there is no structure available, the oldest in use is selected and used if and
54 * only if it was first allocated more than MAP_IP4_REASS_LIFETIME seconds ago.
55 * In case no structure can be allocated, the fragment is dropped.
58 #define MAP_IP4_REASS_LIFETIME_DEFAULT (100) /* ms */
59 #define MAP_IP4_REASS_HT_RATIO_DEFAULT (1.0)
60 #define MAP_IP4_REASS_POOL_SIZE_DEFAULT 1024 // Number of reassembly structures
61 #define MAP_IP4_REASS_BUFFERS_DEFAULT 2048
63 #define MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY 5 // Number of fragment per reassembly
65 #define MAP_IP6_REASS_LIFETIME_DEFAULT (100) /* ms */
66 #define MAP_IP6_REASS_HT_RATIO_DEFAULT (1.0)
67 #define MAP_IP6_REASS_POOL_SIZE_DEFAULT 1024 // Number of reassembly structures
68 #define MAP_IP6_REASS_BUFFERS_DEFAULT 2048
70 #define MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY 5
72 #define MAP_IP6_REASS_COUNT_BYTES
73 #define MAP_IP4_REASS_COUNT_BYTES
75 //#define IP6_MAP_T_OVERRIDE_TOS 0
78 * This structure _MUST_ be no larger than a single cache line (64 bytes).
79 * If more space is needed make a union of ip6_prefix and *rules, those are mutually exclusive.
83 /* Required for pool_get_aligned */
84 CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
85 ip6_address_t ip6_src;
86 ip6_address_t ip6_prefix;
89 ip4_address_t ip4_prefix;
92 map_domain_flags_e flags;
104 /* not used by forwarding */
108 STATIC_ASSERT ((sizeof (map_domain_t) <= CLIB_CACHE_LINE_BYTES),
109 "MAP domain fits in one cacheline");
111 #define MAP_REASS_INDEX_NONE ((u16)0xffff)
114 * Hash key, padded out to 16 bytes for fast compare
118 CLIB_PACKED (struct {
126 } map_ip4_reass_key_t;
131 map_ip4_reass_key_t key;
133 #ifdef MAP_IP4_REASS_COUNT_BYTES
142 u32 fragments[MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY];
146 * MAP domain counters
150 /* Simple counters */
151 MAP_DOMAIN_IPV4_FRAGMENT = 0,
152 /* Combined counters */
153 MAP_DOMAIN_COUNTER_RX = 0,
154 MAP_DOMAIN_COUNTER_TX,
156 } map_domain_counter_t;
163 CLIB_PACKED (struct {
171 } map_ip6_reass_key_t;
175 u32 pi; //Cached packet or ~0
176 u16 next_data_offset; //The data offset of the additional 20 bytes or ~0
177 u8 next_data_len; //Number of bytes ready to be copied (20 if not last fragment)
178 u8 next_data[20]; //The 20 additional bytes
179 } map_ip6_fragment_t;
182 map_ip6_reass_key_t key;
184 #ifdef MAP_IP6_REASS_COUNT_BYTES
188 u16 bucket; //What hash bucket this element is linked in
192 ip4_header_t ip4_header;
193 map_ip6_fragment_t fragments[MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY];
196 #ifdef MAP_SKIP_IP6_LOOKUP
198 * A pre-resolved next-hop
200 typedef struct map_main_pre_resolved_t_
203 * Linkage into the FIB graph
208 * The FIB entry index of the next-hop
210 fib_node_index_t fei;
213 * This object sibling index on the FIB entry's child dependency list
218 * The Load-balance object index to use to forward
221 } map_main_pre_resolved_t;
224 * Pre-resolved next hops for v4 and v6. Why these are global and not
225 * per-domain is beyond me.
227 extern map_main_pre_resolved_t pre_resolved[FIB_PROTOCOL_MAX];
231 /* pool of MAP domains */
232 map_domain_t *domains;
234 /* MAP Domain packet/byte counters indexed by map domain index */
235 vlib_simple_counter_main_t *simple_domain_counters;
236 vlib_combined_counter_main_t *domain_counters;
237 volatile u32 *counter_lock;
239 /* API message id base */
242 /* Traffic class: zero, copy (~0) or fixed value */
246 bool sec_check; /* Inbound security check */
247 bool sec_check_frag; /* Inbound security check for (subsequent) fragments */
248 bool icmp6_enabled; /* Send destination unreachable for security check failure */
250 /* ICMPv6 -> ICMPv4 relay parameters */
251 ip4_address_t icmp4_src_address;
252 vlib_simple_counter_main_t icmp_relayed;
255 vlib_main_t *vlib_main;
256 vnet_main_t *vnet_main;
259 * IPv4 encap and decap reassembly
262 f32 ip4_reass_conf_ht_ratio; //Size of ht is 2^ceil(log2(ratio*pool_size))
263 u16 ip4_reass_conf_pool_size; //Max number of allocated reass structures
264 u16 ip4_reass_conf_lifetime_ms; //Time a reassembly struct is considered valid in ms
265 u32 ip4_reass_conf_buffers; //Maximum number of buffers used by ip4 reassembly
268 map_ip4_reass_t *ip4_reass_pool;
269 u8 ip4_reass_ht_log2len; //Hash table size is 2^log2len
270 u16 ip4_reass_allocated;
271 u16 *ip4_reass_hash_table;
272 u16 ip4_reass_fifo_last;
273 volatile u32 *ip4_reass_lock;
276 u32 ip4_reass_buffered_counter;
278 bool frag_inner; /* Inner or outer fragmentation */
279 bool frag_ignore_df; /* Fragment (outer) packet even if DF is set */
282 * IPv6 decap reassembly
285 f32 ip6_reass_conf_ht_ratio; //Size of ht is 2^ceil(log2(ratio*pool_size))
286 u16 ip6_reass_conf_pool_size; //Max number of allocated reass structures
287 u16 ip6_reass_conf_lifetime_ms; //Time a reassembly struct is considered valid in ms
288 u32 ip6_reass_conf_buffers; //Maximum number of buffers used by ip6 reassembly
291 map_ip6_reass_t *ip6_reass_pool;
292 u8 ip6_reass_ht_log2len; //Hash table size is 2^log2len
293 u16 ip6_reass_allocated;
294 u16 *ip6_reass_hash_table;
295 u16 ip6_reass_fifo_last;
296 volatile u32 *ip6_reass_lock;
299 u32 ip6_reass_buffered_counter;
304 * MAP Error counters/messages
306 #define foreach_map_error \
307 /* Must be first. */ \
308 _(NONE, "valid MAP packets") \
309 _(BAD_PROTOCOL, "bad protocol") \
310 _(SEC_CHECK, "security check failed") \
311 _(ENCAP_SEC_CHECK, "encap security check failed") \
312 _(DECAP_SEC_CHECK, "decap security check failed") \
313 _(ICMP, "unable to translate ICMP") \
314 _(ICMP_RELAY, "unable to relay ICMP") \
315 _(UNKNOWN, "unknown") \
316 _(NO_BINDING, "no binding") \
317 _(NO_DOMAIN, "no domain") \
318 _(FRAGMENTED, "packet is a fragment") \
319 _(FRAGMENT_MEMORY, "could not cache fragment") \
320 _(FRAGMENT_MALFORMED, "fragment has unexpected format")\
321 _(FRAGMENT_DROPPED, "dropped cached fragment") \
322 _(MALFORMED, "malformed packet") \
323 _(DF_SET, "can't fragment, DF set")
326 #define _(sym,str) MAP_ERROR_##sym,
332 u64 map_error_counter_get(u32 node_index, map_error_t map_error);
335 u32 map_domain_index;
339 extern map_main_t map_main;
341 extern vlib_node_registration_t ip4_map_node;
342 extern vlib_node_registration_t ip6_map_node;
344 extern vlib_node_registration_t ip4_map_t_node;
345 extern vlib_node_registration_t ip4_map_t_fragmented_node;
346 extern vlib_node_registration_t ip4_map_t_tcp_udp_node;
347 extern vlib_node_registration_t ip4_map_t_icmp_node;
349 extern vlib_node_registration_t ip6_map_t_node;
350 extern vlib_node_registration_t ip6_map_t_fragmented_node;
351 extern vlib_node_registration_t ip6_map_t_tcp_udp_node;
352 extern vlib_node_registration_t ip6_map_t_icmp_node;
357 static_always_inline u64
358 map_get_pfx (map_domain_t *d, u32 addr, u16 port)
360 u16 psid = (port >> d->psid_shift) & d->psid_mask;
362 if (d->ea_bits_len == 0 && d->rules)
363 return clib_net_to_host_u64(d->rules[psid].as_u64[0]);
365 u32 suffix = (addr >> d->suffix_shift) & d->suffix_mask;
366 u64 ea = d->ea_bits_len == 0 ? 0 : (((u64) suffix << d->psid_length)) | psid;
368 return clib_net_to_host_u64(d->ip6_prefix.as_u64[0]) | ea << d->ea_shift;
371 static_always_inline u64
372 map_get_pfx_net (map_domain_t *d, u32 addr, u16 port)
374 return clib_host_to_net_u64(map_get_pfx(d, clib_net_to_host_u32(addr),
375 clib_net_to_host_u16(port)));
381 static_always_inline u64
382 map_get_sfx (map_domain_t *d, u32 addr, u16 port)
384 u16 psid = (port >> d->psid_shift) & d->psid_mask;
386 /* Shared 1:1 mode. */
387 if (d->ea_bits_len == 0 && d->rules)
388 return clib_net_to_host_u64(d->rules[psid].as_u64[1]);
389 if (d->ip6_prefix_len == 128)
390 return clib_net_to_host_u64(d->ip6_prefix.as_u64[1]);
392 if (d->flags & MAP_DOMAIN_RFC6052)
393 return (clib_net_to_host_u64(d->ip6_prefix.as_u64[1]) | addr);
396 if (d->flags & MAP_DOMAIN_PREFIX)
397 return (u64) (addr & (0xFFFFFFFF << d->suffix_shift)) << 16;
399 /* Shared or full IPv4 address */
400 return ((u64) addr << 16) | psid;
403 static_always_inline u64
404 map_get_sfx_net (map_domain_t *d, u32 addr, u16 port)
406 return clib_host_to_net_u64(map_get_sfx(d, clib_net_to_host_u32(addr),
407 clib_net_to_host_u16(port)));
410 static_always_inline u32
411 map_get_ip4 (ip6_address_t *addr, map_domain_flags_e flags)
413 if (flags & MAP_DOMAIN_RFC6052)
414 return clib_host_to_net_u32(clib_net_to_host_u64(addr->as_u64[1]));
416 return clib_host_to_net_u32(clib_net_to_host_u64(addr->as_u64[1]) >> 16);
420 * Get the MAP domain from an IPv4 lookup adjacency.
422 static_always_inline map_domain_t *
423 ip4_map_get_domain (u32 mdi)
425 map_main_t *mm = &map_main;
427 return pool_elt_at_index(mm->domains, mdi);
431 * Get the MAP domain from an IPv6 lookup adjacency.
432 * If the IPv6 address or prefix is not shared, no lookup is required.
433 * The IPv4 address is used otherwise.
435 static_always_inline map_domain_t *
436 ip6_map_get_domain (u32 mdi,
438 u32 *map_domain_index,
441 map_main_t *mm = &map_main;
445 * Disable direct MAP domain lookup on decap, until the security check is updated to verify IPv4 SA.
446 * (That's done implicitly when MAP domain is looked up in the IPv4 FIB)
448 //#ifdef MAP_NONSHARED_DOMAIN_ENABLED
449 //#error "How can you be sure this domain is not shared?"
452 *map_domain_index = mdi;
453 return pool_elt_at_index(mm->domains, mdi);
456 u32 lbi = ip4_fib_forwarding_lookup(0, addr);
457 const dpo_id_t *dpo = load_balance_get_bucket(lbi, 0);
458 if (PREDICT_TRUE(dpo->dpoi_type == map_dpo_type ||
459 dpo->dpoi_type == map_t_dpo_type))
461 *map_domain_index = dpo->dpoi_index;
462 return pool_elt_at_index(mm->domains, *map_domain_index);
464 *error = MAP_ERROR_NO_DOMAIN;
470 map_ip4_reass_get(u32 src, u32 dst, u16 fragment_id,
471 u8 protocol, u32 **pi_to_drop);
473 map_ip4_reass_free(map_ip4_reass_t *r, u32 **pi_to_drop);
475 #define map_ip4_reass_lock() while (clib_atomic_test_and_set (map_main.ip4_reass_lock)) {}
476 #define map_ip4_reass_unlock() do {CLIB_MEMORY_BARRIER(); *map_main.ip4_reass_lock = 0;} while(0)
478 static_always_inline void
479 map_ip4_reass_get_fragments(map_ip4_reass_t *r, u32 **pi)
482 for (i=0; i<MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY; i++)
483 if(r->fragments[i] != ~0) {
484 vec_add1(*pi, r->fragments[i]);
485 r->fragments[i] = ~0;
486 map_main.ip4_reass_buffered_counter--;
490 clib_error_t * map_plugin_api_hookup (vlib_main_t * vm);
492 int map_ip4_reass_add_fragment(map_ip4_reass_t *r, u32 pi);
495 map_ip6_reass_get(ip6_address_t *src, ip6_address_t *dst, u32 fragment_id,
496 u8 protocol, u32 **pi_to_drop);
498 map_ip6_reass_free(map_ip6_reass_t *r, u32 **pi_to_drop);
500 #define map_ip6_reass_lock() while (clib_atomic_test_and_set (map_main.ip6_reass_lock)) {}
501 #define map_ip6_reass_unlock() do {CLIB_MEMORY_BARRIER(); *map_main.ip6_reass_lock = 0;} while(0)
504 map_ip6_reass_add_fragment(map_ip6_reass_t *r, u32 pi,
505 u16 data_offset, u16 next_data_offset,
506 u8 *data_start, u16 data_len);
508 void map_ip4_drop_pi(u32 pi);
510 int map_ip4_reass_conf_ht_ratio(f32 ht_ratio, u32 *trashed_reass, u32 *dropped_packets);
511 #define MAP_IP4_REASS_CONF_HT_RATIO_MAX 100
512 int map_ip4_reass_conf_pool_size(u16 pool_size, u32 *trashed_reass, u32 *dropped_packets);
513 #define MAP_IP4_REASS_CONF_POOL_SIZE_MAX (0xfeff)
514 int map_ip4_reass_conf_lifetime(u16 lifetime_ms);
515 #define MAP_IP4_REASS_CONF_LIFETIME_MAX 0xffff
516 int map_ip4_reass_conf_buffers(u32 buffers);
517 #define MAP_IP4_REASS_CONF_BUFFERS_MAX (0xffffffff)
519 void map_ip6_drop_pi(u32 pi);
522 int map_ip6_reass_conf_ht_ratio(f32 ht_ratio, u32 *trashed_reass, u32 *dropped_packets);
523 #define MAP_IP6_REASS_CONF_HT_RATIO_MAX 100
524 int map_ip6_reass_conf_pool_size(u16 pool_size, u32 *trashed_reass, u32 *dropped_packets);
525 #define MAP_IP6_REASS_CONF_POOL_SIZE_MAX (0xfeff)
526 int map_ip6_reass_conf_lifetime(u16 lifetime_ms);
527 #define MAP_IP6_REASS_CONF_LIFETIME_MAX 0xffff
528 int map_ip6_reass_conf_buffers(u32 buffers);
529 #define MAP_IP6_REASS_CONF_BUFFERS_MAX (0xffffffff)
531 static_always_inline void
532 ip4_map_t_embedded_address (map_domain_t *d,
533 ip6_address_t *ip6, const ip4_address_t *ip4)
535 ASSERT(d->ip6_src_len == 96 || d->ip6_src_len == 64); //No support for other lengths for now
536 u8 offset = d->ip6_src_len == 64 ? 9 : 12;
537 ip6->as_u64[0] = d->ip6_src.as_u64[0];
538 ip6->as_u64[1] = d->ip6_src.as_u64[1];
539 clib_memcpy_fast(&ip6->as_u8[offset], ip4, 4);
542 static_always_inline u32
543 ip6_map_t_embedded_address (map_domain_t *d, ip6_address_t *addr)
545 ASSERT(d->ip6_src_len == 64 || d->ip6_src_len == 96);
547 u8 offset = d->ip6_src_len == 64 ? 9 : 12;
548 clib_memcpy(&x, &addr->as_u8[offset], 4);
553 map_domain_counter_lock (map_main_t *mm)
555 if (mm->counter_lock)
556 while (clib_atomic_test_and_set (mm->counter_lock))
560 map_domain_counter_unlock (map_main_t *mm)
562 if (mm->counter_lock)
563 clib_atomic_release (mm->counter_lock);
567 static_always_inline void
568 map_send_all_to_node(vlib_main_t *vm, u32 *pi_vector,
569 vlib_node_runtime_t *node, vlib_error_t *error,
572 u32 n_left_from, *from, next_index, *to_next, n_left_to_next;
573 //Deal with fragments that are ready
575 n_left_from = vec_len(pi_vector);
576 next_index = node->cached_next_index;
577 while (n_left_from > 0) {
578 vlib_get_next_frame(vm, node, next_index, to_next, n_left_to_next);
579 while (n_left_from > 0 && n_left_to_next > 0) {
580 u32 pi0 = to_next[0] = from[0];
585 vlib_buffer_t *p0 = vlib_get_buffer(vm, pi0);
587 vlib_validate_buffer_enqueue_x1(vm, node, next_index, to_next, n_left_to_next, pi0, next);
589 vlib_put_next_frame(vm, node, next_index, n_left_to_next);
594 * fd.io coding-style-patch-verification: ON
597 * eval: (c-set-style "gnu")