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/map/map_dpo.h>
24 #include <vnet/dpo/load_balance.h>
26 #define MAP_SKIP_IP6_LOOKUP 1
34 int map_create_domain (ip4_address_t * ip4_prefix, u8 ip4_prefix_len,
35 ip6_address_t * ip6_prefix, u8 ip6_prefix_len,
36 ip6_address_t * ip6_src, u8 ip6_src_len,
37 u8 ea_bits_len, u8 psid_offset, u8 psid_length,
38 u32 * map_domain_index, u16 mtu, u8 flags);
39 int map_delete_domain (u32 map_domain_index);
40 int map_add_del_psid (u32 map_domain_index, u16 psid, ip6_address_t * tep,
42 u8 *format_map_trace (u8 * s, va_list * args);
43 i32 ip4_get_port (ip4_header_t * ip, map_dir_e dir, u16 buffer_len);
44 i32 ip6_get_port (ip6_header_t * ip6, map_dir_e dir, u16 buffer_len);
45 u16 ip4_map_get_port (ip4_header_t * ip, map_dir_e dir);
47 typedef enum __attribute__ ((__packed__))
49 MAP_DOMAIN_PREFIX = 1 << 0, MAP_DOMAIN_TRANSLATION = 1 << 1, // The domain uses MAP-T
53 * IP4 reassembly logic:
54 * One virtually reassembled flow requires a map_ip4_reass_t structure in order
55 * to keep the first-fragment port number and, optionally, cache out of sequence
57 * There are up to MAP_IP4_REASS_MAX_REASSEMBLY such structures.
58 * When in use, those structures are stored in a hash table of MAP_IP4_REASS_BUCKETS buckets.
59 * When a new structure needs to be used, it is allocated from available ones.
60 * If there is no structure available, the oldest in use is selected and used if and
61 * only if it was first allocated more than MAP_IP4_REASS_LIFETIME seconds ago.
62 * In case no structure can be allocated, the fragment is dropped.
65 #define MAP_IP4_REASS_LIFETIME_DEFAULT (100) /* ms */
66 #define MAP_IP4_REASS_HT_RATIO_DEFAULT (1.0)
67 #define MAP_IP4_REASS_POOL_SIZE_DEFAULT 1024 // Number of reassembly structures
68 #define MAP_IP4_REASS_BUFFERS_DEFAULT 2048
70 #define MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY 5 // Number of fragment per reassembly
72 #define MAP_IP6_REASS_LIFETIME_DEFAULT (100) /* ms */
73 #define MAP_IP6_REASS_HT_RATIO_DEFAULT (1.0)
74 #define MAP_IP6_REASS_POOL_SIZE_DEFAULT 1024 // Number of reassembly structures
75 #define MAP_IP6_REASS_BUFFERS_DEFAULT 2048
77 #define MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY 5
79 #define MAP_IP6_REASS_COUNT_BYTES
80 #define MAP_IP4_REASS_COUNT_BYTES
82 //#define IP6_MAP_T_OVERRIDE_TOS 0
85 * This structure _MUST_ be no larger than a single cache line (64 bytes).
86 * If more space is needed make a union of ip6_prefix and *rules, those are mutually exclusive.
90 ip6_address_t ip6_src;
91 ip6_address_t ip6_prefix;
94 ip4_address_t ip4_prefix;
97 map_domain_flags_e flags;
109 /* not used by forwarding */
113 STATIC_ASSERT ((sizeof (map_domain_t) <= CLIB_CACHE_LINE_BYTES),
114 "MAP domain fits in one cacheline");
116 #define MAP_REASS_INDEX_NONE ((u16)0xffff)
119 * Hash key, padded out to 16 bytes for fast compare
123 CLIB_PACKED (struct {
131 } map_ip4_reass_key_t;
136 map_ip4_reass_key_t key;
138 #ifdef MAP_IP4_REASS_COUNT_BYTES
147 u32 fragments[MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY];
151 * MAP domain counters
155 /* Simple counters */
156 MAP_DOMAIN_IPV4_FRAGMENT = 0,
157 /* Combined counters */
158 MAP_DOMAIN_COUNTER_RX = 0,
159 MAP_DOMAIN_COUNTER_TX,
161 } map_domain_counter_t;
168 CLIB_PACKED (struct {
176 } map_ip6_reass_key_t;
180 u32 pi; //Cached packet or ~0
181 u16 next_data_offset; //The data offset of the additional 20 bytes or ~0
182 u8 next_data_len; //Number of bytes ready to be copied (20 if not last fragment)
183 u8 next_data[20]; //The 20 additional bytes
184 } map_ip6_fragment_t;
187 map_ip6_reass_key_t key;
189 #ifdef MAP_IP6_REASS_COUNT_BYTES
193 u16 bucket; //What hash bucket this element is linked in
197 ip4_header_t ip4_header;
198 map_ip6_fragment_t fragments[MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY];
201 #ifdef MAP_SKIP_IP6_LOOKUP
203 * A pre-resolved next-hop
205 typedef struct map_main_pre_resolved_t_
208 * Linkage into the FIB graph
213 * The FIB entry index of the next-hop
215 fib_node_index_t fei;
218 * This object sibling index on the FIB entry's child dependency list
223 * The Load-balance object index to use to forward
226 } map_main_pre_resolved_t;
229 * Pre-resolved next hops for v4 and v6. Why these are global and not
230 * per-domain is beyond me.
232 extern map_main_pre_resolved_t pre_resolved[FIB_PROTOCOL_MAX];
236 /* pool of MAP domains */
237 map_domain_t *domains;
239 /* MAP Domain packet/byte counters indexed by map domain index */
240 vlib_simple_counter_main_t *simple_domain_counters;
241 vlib_combined_counter_main_t *domain_counters;
242 volatile u32 *counter_lock;
244 /* Traffic class: zero, copy (~0) or fixed value */
248 bool sec_check; /* Inbound security check */
249 bool sec_check_frag; /* Inbound security check for (subsequent) fragments */
250 bool icmp6_enabled; /* Send destination unreachable for security check failure */
252 /* ICMPv6 -> ICMPv4 relay parameters */
253 ip4_address_t icmp4_src_address;
254 vlib_simple_counter_main_t icmp_relayed;
257 vlib_main_t *vlib_main;
258 vnet_main_t *vnet_main;
261 * IPv4 encap and decap reassembly
264 f32 ip4_reass_conf_ht_ratio; //Size of ht is 2^ceil(log2(ratio*pool_size))
265 u16 ip4_reass_conf_pool_size; //Max number of allocated reass structures
266 u16 ip4_reass_conf_lifetime_ms; //Time a reassembly struct is considered valid in ms
267 u32 ip4_reass_conf_buffers; //Maximum number of buffers used by ip4 reassembly
270 map_ip4_reass_t *ip4_reass_pool;
271 u8 ip4_reass_ht_log2len; //Hash table size is 2^log2len
272 u16 ip4_reass_allocated;
273 u16 *ip4_reass_hash_table;
274 u16 ip4_reass_fifo_last;
275 volatile u32 *ip4_reass_lock;
278 u32 ip4_reass_buffered_counter;
280 bool frag_inner; /* Inner or outer fragmentation */
281 bool frag_ignore_df; /* Fragment (outer) packet even if DF is set */
284 * IPv6 decap reassembly
287 f32 ip6_reass_conf_ht_ratio; //Size of ht is 2^ceil(log2(ratio*pool_size))
288 u16 ip6_reass_conf_pool_size; //Max number of allocated reass structures
289 u16 ip6_reass_conf_lifetime_ms; //Time a reassembly struct is considered valid in ms
290 u32 ip6_reass_conf_buffers; //Maximum number of buffers used by ip6 reassembly
293 map_ip6_reass_t *ip6_reass_pool;
294 u8 ip6_reass_ht_log2len; //Hash table size is 2^log2len
295 u16 ip6_reass_allocated;
296 u16 *ip6_reass_hash_table;
297 u16 ip6_reass_fifo_last;
298 volatile u32 *ip6_reass_lock;
301 u32 ip6_reass_buffered_counter;
306 * MAP Error counters/messages
308 #define foreach_map_error \
309 /* Must be first. */ \
310 _(NONE, "valid MAP packets") \
311 _(BAD_PROTOCOL, "bad protocol") \
312 _(SEC_CHECK, "security check failed") \
313 _(ENCAP_SEC_CHECK, "encap security check failed") \
314 _(DECAP_SEC_CHECK, "decap security check failed") \
315 _(ICMP, "unable to translate ICMP") \
316 _(ICMP_RELAY, "unable to relay ICMP") \
317 _(UNKNOWN, "unknown") \
318 _(NO_BINDING, "no binding") \
319 _(NO_DOMAIN, "no domain") \
320 _(FRAGMENTED, "packet is a fragment") \
321 _(FRAGMENT_MEMORY, "could not cache fragment") \
322 _(FRAGMENT_MALFORMED, "fragment has unexpected format")\
323 _(FRAGMENT_DROPPED, "dropped cached fragment") \
324 _(MALFORMED, "malformed packet") \
325 _(DF_SET, "can't fragment, DF set")
328 #define _(sym,str) MAP_ERROR_##sym,
334 u64 map_error_counter_get(u32 node_index, map_error_t map_error);
337 u32 map_domain_index;
343 extern vlib_node_registration_t ip4_map_node;
344 extern vlib_node_registration_t ip6_map_node;
346 extern vlib_node_registration_t ip4_map_t_node;
347 extern vlib_node_registration_t ip4_map_t_fragmented_node;
348 extern vlib_node_registration_t ip4_map_t_tcp_udp_node;
349 extern vlib_node_registration_t ip4_map_t_icmp_node;
351 extern vlib_node_registration_t ip6_map_t_node;
352 extern vlib_node_registration_t ip6_map_t_fragmented_node;
353 extern vlib_node_registration_t ip6_map_t_tcp_udp_node;
354 extern vlib_node_registration_t ip6_map_t_icmp_node;
359 static_always_inline u64
360 map_get_pfx (map_domain_t *d, u32 addr, u16 port)
362 u16 psid = (port >> d->psid_shift) & d->psid_mask;
364 if (d->ea_bits_len == 0 && d->rules)
365 return clib_net_to_host_u64(d->rules[psid].as_u64[0]);
367 u32 suffix = (addr >> d->suffix_shift) & d->suffix_mask;
368 u64 ea = d->ea_bits_len == 0 ? 0 : (((u64) suffix << d->psid_length)) | psid;
370 return clib_net_to_host_u64(d->ip6_prefix.as_u64[0]) | ea << d->ea_shift;
373 static_always_inline u64
374 map_get_pfx_net (map_domain_t *d, u32 addr, u16 port)
376 return clib_host_to_net_u64(map_get_pfx(d, clib_net_to_host_u32(addr),
377 clib_net_to_host_u16(port)));
383 static_always_inline u64
384 map_get_sfx (map_domain_t *d, u32 addr, u16 port)
386 u16 psid = (port >> d->psid_shift) & d->psid_mask;
388 /* Shared 1:1 mode. */
389 if (d->ea_bits_len == 0 && d->rules)
390 return clib_net_to_host_u64(d->rules[psid].as_u64[1]);
391 if (d->ip6_prefix_len == 128)
392 return clib_net_to_host_u64(d->ip6_prefix.as_u64[1]);
395 if (d->flags & MAP_DOMAIN_PREFIX)
396 return (u64) (addr & (0xFFFFFFFF << d->suffix_shift)) << 16;
398 /* Shared or full IPv4 address */
399 return ((u64) addr << 16) | psid;
402 static_always_inline u64
403 map_get_sfx_net (map_domain_t *d, u32 addr, u16 port)
405 return clib_host_to_net_u64(map_get_sfx(d, clib_net_to_host_u32(addr),
406 clib_net_to_host_u16(port)));
409 static_always_inline u32
410 map_get_ip4 (ip6_address_t *addr)
412 return clib_host_to_net_u32(clib_net_to_host_u64(addr->as_u64[1]) >> 16);
416 * Get the MAP domain from an IPv4 lookup adjacency.
418 static_always_inline map_domain_t *
419 ip4_map_get_domain (u32 mdi,
420 u32 *map_domain_index)
422 map_main_t *mm = &map_main;
425 md = map_dpo_get(mdi);
428 *map_domain_index = md->md_domain;
429 return pool_elt_at_index(mm->domains, *map_domain_index);
433 * Get the MAP domain from an IPv6 lookup adjacency.
434 * If the IPv6 address or prefix is not shared, no lookup is required.
435 * The IPv4 address is used otherwise.
437 static_always_inline map_domain_t *
438 ip6_map_get_domain (u32 mdi, ip4_address_t *addr,
439 u32 *map_domain_index, u8 *error)
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 md = map_dpo_get(mdi);
452 *map_domain_index = md->md_domain;
453 if (*map_domain_index != ~0)
454 return pool_elt_at_index(mm->domains, *map_domain_index);
457 u32 lbi = ip4_fib_forwarding_lookup(0, addr);
458 const dpo_id_t *dpo = load_balance_get_bucket(lbi, 0);
459 if (PREDICT_TRUE(dpo->dpoi_type == map_dpo_type ||
460 dpo->dpoi_type == map_t_dpo_type))
462 md = map_dpo_get(dpo->dpoi_index);
463 *map_domain_index = md->md_domain;
464 return pool_elt_at_index(mm->domains, *map_domain_index);
466 *error = MAP_ERROR_NO_DOMAIN;
471 map_ip4_reass_get(u32 src, u32 dst, u16 fragment_id,
472 u8 protocol, u32 **pi_to_drop);
474 map_ip4_reass_free(map_ip4_reass_t *r, u32 **pi_to_drop);
476 #define map_ip4_reass_lock() while (__sync_lock_test_and_set(map_main.ip4_reass_lock, 1)) {}
477 #define map_ip4_reass_unlock() do {CLIB_MEMORY_BARRIER(); *map_main.ip4_reass_lock = 0;} while(0)
479 static_always_inline void
480 map_ip4_reass_get_fragments(map_ip4_reass_t *r, u32 **pi)
483 for (i=0; i<MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY; i++)
484 if(r->fragments[i] != ~0) {
485 vec_add1(*pi, r->fragments[i]);
486 r->fragments[i] = ~0;
487 map_main.ip4_reass_buffered_counter--;
491 int map_ip4_reass_add_fragment(map_ip4_reass_t *r, u32 pi);
494 map_ip6_reass_get(ip6_address_t *src, ip6_address_t *dst, u32 fragment_id,
495 u8 protocol, u32 **pi_to_drop);
497 map_ip6_reass_free(map_ip6_reass_t *r, u32 **pi_to_drop);
499 #define map_ip6_reass_lock() while (__sync_lock_test_and_set(map_main.ip6_reass_lock, 1)) {}
500 #define map_ip6_reass_unlock() do {CLIB_MEMORY_BARRIER(); *map_main.ip6_reass_lock = 0;} while(0)
503 map_ip6_reass_add_fragment(map_ip6_reass_t *r, u32 pi,
504 u16 data_offset, u16 next_data_offset,
505 u8 *data_start, u16 data_len);
507 void map_ip4_drop_pi(u32 pi);
509 int map_ip4_reass_conf_ht_ratio(f32 ht_ratio, u32 *trashed_reass, u32 *dropped_packets);
510 #define MAP_IP4_REASS_CONF_HT_RATIO_MAX 100
511 int map_ip4_reass_conf_pool_size(u16 pool_size, u32 *trashed_reass, u32 *dropped_packets);
512 #define MAP_IP4_REASS_CONF_POOL_SIZE_MAX (0xfeff)
513 int map_ip4_reass_conf_lifetime(u16 lifetime_ms);
514 #define MAP_IP4_REASS_CONF_LIFETIME_MAX 0xffff
515 int map_ip4_reass_conf_buffers(u32 buffers);
516 #define MAP_IP4_REASS_CONF_BUFFERS_MAX (0xffffffff)
518 void map_ip6_drop_pi(u32 pi);
521 int map_ip6_reass_conf_ht_ratio(f32 ht_ratio, u32 *trashed_reass, u32 *dropped_packets);
522 #define MAP_IP6_REASS_CONF_HT_RATIO_MAX 100
523 int map_ip6_reass_conf_pool_size(u16 pool_size, u32 *trashed_reass, u32 *dropped_packets);
524 #define MAP_IP6_REASS_CONF_POOL_SIZE_MAX (0xfeff)
525 int map_ip6_reass_conf_lifetime(u16 lifetime_ms);
526 #define MAP_IP6_REASS_CONF_LIFETIME_MAX 0xffff
527 int map_ip6_reass_conf_buffers(u32 buffers);
528 #define MAP_IP6_REASS_CONF_BUFFERS_MAX (0xffffffff)
531 int ip6_parse(const ip6_header_t *ip6, u32 buff_len,
532 u8 *l4_protocol, u16 *l4_offset, u16 *frag_hdr_offset)
534 if (ip6->protocol == IP_PROTOCOL_IPV6_FRAGMENTATION) {
535 *l4_protocol = ((ip6_frag_hdr_t *)(ip6 + 1))->next_hdr;
536 *frag_hdr_offset = sizeof(*ip6);
537 *l4_offset = sizeof(*ip6) + sizeof(ip6_frag_hdr_t);
539 *l4_protocol = ip6->protocol;
540 *frag_hdr_offset = 0;
541 *l4_offset = sizeof(*ip6);
544 return (buff_len < (*l4_offset + 4)) ||
545 (clib_net_to_host_u16(ip6->payload_length) < (*l4_offset + 4 - sizeof(*ip6)));
549 #define u8_ptr_add(ptr, index) (((u8 *)ptr) + index)
550 #define u16_net_add(u, val) clib_host_to_net_u16(clib_net_to_host_u16(u) + (val))
552 #define frag_id_6to4(id) ((id) ^ ((id) >> 16))
554 static_always_inline void
555 ip4_map_t_embedded_address (map_domain_t *d,
556 ip6_address_t *ip6, const ip4_address_t *ip4)
558 ASSERT(d->ip6_src_len == 96); //No support for other lengths for now
559 ip6->as_u64[0] = d->ip6_src.as_u64[0];
560 ip6->as_u32[2] = d->ip6_src.as_u32[2];
561 ip6->as_u32[3] = ip4->as_u32;
564 static_always_inline u32
565 ip6_map_t_embedded_address (map_domain_t *d, ip6_address_t *addr)
567 ASSERT(d->ip6_src_len == 96); //No support for other lengths for now
568 return addr->as_u32[3];
572 map_domain_counter_lock (map_main_t *mm)
574 if (mm->counter_lock)
575 while (__sync_lock_test_and_set(mm->counter_lock, 1))
579 map_domain_counter_unlock (map_main_t *mm)
581 if (mm->counter_lock)
582 *mm->counter_lock = 0;
586 static_always_inline void
587 map_send_all_to_node(vlib_main_t *vm, u32 *pi_vector,
588 vlib_node_runtime_t *node, vlib_error_t *error,
591 u32 n_left_from, *from, next_index, *to_next, n_left_to_next;
592 //Deal with fragments that are ready
594 n_left_from = vec_len(pi_vector);
595 next_index = node->cached_next_index;
596 while (n_left_from > 0) {
597 vlib_get_next_frame(vm, node, next_index, to_next, n_left_to_next);
598 while (n_left_from > 0 && n_left_to_next > 0) {
599 u32 pi0 = to_next[0] = from[0];
604 vlib_buffer_t *p0 = vlib_get_buffer(vm, pi0);
606 vlib_validate_buffer_enqueue_x1(vm, node, next_index, to_next, n_left_to_next, pi0, next);
608 vlib_put_next_frame(vm, node, next_index, n_left_to_next);
613 * fd.io coding-style-patch-verification: ON
616 * eval: (c-set-style "gnu")