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>
21 #define MAP_SKIP_IP6_LOOKUP 1
29 int map_create_domain (ip4_address_t * ip4_prefix, u8 ip4_prefix_len,
30 ip6_address_t * ip6_prefix, u8 ip6_prefix_len,
31 ip6_address_t * ip6_src, u8 ip6_src_len,
32 u8 ea_bits_len, u8 psid_offset, u8 psid_length,
33 u32 * map_domain_index, u16 mtu, u8 flags);
34 int map_delete_domain (u32 map_domain_index);
35 int map_add_del_psid (u32 map_domain_index, u16 psid, ip6_address_t * tep,
37 u8 *format_map_trace (u8 * s, va_list * args);
38 i32 ip4_get_port (ip4_header_t * ip, map_dir_e dir, u16 buffer_len);
39 i32 ip6_get_port (ip6_header_t * ip6, map_dir_e dir, u16 buffer_len);
40 u16 ip4_map_get_port (ip4_header_t * ip, map_dir_e dir);
42 typedef enum __attribute__ ((__packed__))
44 MAP_DOMAIN_PREFIX = 1 << 0, MAP_DOMAIN_TRANSLATION = 1 << 1, // The domain uses MAP-T
48 * IP4 reassembly logic:
49 * One virtually reassembled flow requires a map_ip4_reass_t structure in order
50 * to keep the first-fragment port number and, optionally, cache out of sequence
52 * There are up to MAP_IP4_REASS_MAX_REASSEMBLY such structures.
53 * When in use, those structures are stored in a hash table of MAP_IP4_REASS_BUCKETS buckets.
54 * When a new structure needs to be used, it is allocated from available ones.
55 * If there is no structure available, the oldest in use is selected and used if and
56 * only if it was first allocated more than MAP_IP4_REASS_LIFETIME seconds ago.
57 * In case no structure can be allocated, the fragment is dropped.
60 #define MAP_IP4_REASS_LIFETIME_DEFAULT (100) /* ms */
61 #define MAP_IP4_REASS_HT_RATIO_DEFAULT (1.0)
62 #define MAP_IP4_REASS_POOL_SIZE_DEFAULT 1024 // Number of reassembly structures
63 #define MAP_IP4_REASS_BUFFERS_DEFAULT 2048
65 #define MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY 5 // Number of fragment per reassembly
67 #define MAP_IP6_REASS_LIFETIME_DEFAULT (100) /* ms */
68 #define MAP_IP6_REASS_HT_RATIO_DEFAULT (1.0)
69 #define MAP_IP6_REASS_POOL_SIZE_DEFAULT 1024 // Number of reassembly structures
70 #define MAP_IP6_REASS_BUFFERS_DEFAULT 2048
72 #define MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY 5
74 #define MAP_IP6_REASS_COUNT_BYTES
75 #define MAP_IP4_REASS_COUNT_BYTES
77 //#define IP6_MAP_T_OVERRIDE_TOS 0
80 * This structure _MUST_ be no larger than a single cache line (64 bytes).
81 * If more space is needed make a union of ip6_prefix and *rules, those are mutually exclusive.
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 #define MAP_REASS_INDEX_NONE ((u16)0xffff)
111 * Hash key, padded out to 16 bytes for fast compare
115 CLIB_PACKED (struct {
123 } map_ip4_reass_key_t;
128 map_ip4_reass_key_t key;
130 #ifdef MAP_IP4_REASS_COUNT_BYTES
139 u32 fragments[MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY];
143 * MAP domain counters
147 /* Simple counters */
148 MAP_DOMAIN_IPV4_FRAGMENT = 0,
149 /* Combined counters */
150 MAP_DOMAIN_COUNTER_RX = 0,
151 MAP_DOMAIN_COUNTER_TX,
153 } map_domain_counter_t;
160 CLIB_PACKED (struct {
168 } map_ip6_reass_key_t;
172 u32 pi; //Cached packet or ~0
173 u16 next_data_offset; //The data offset of the additional 20 bytes or ~0
174 u8 next_data_len; //Number of bytes ready to be copied (20 if not last fragment)
175 u8 next_data[20]; //The 20 additional bytes
176 } map_ip6_fragment_t;
179 map_ip6_reass_key_t key;
181 #ifdef MAP_IP6_REASS_COUNT_BYTES
185 u16 bucket; //What hash bucket this element is linked in
189 ip4_header_t ip4_header;
190 map_ip6_fragment_t fragments[MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY];
194 /* pool of MAP domains */
195 map_domain_t *domains;
197 /* MAP Domain packet/byte counters indexed by map domain index */
198 vlib_simple_counter_main_t *simple_domain_counters;
199 vlib_combined_counter_main_t *domain_counters;
200 volatile u32 *counter_lock;
202 #ifdef MAP_SKIP_IP6_LOOKUP
204 u32 adj6_index, adj4_index;
205 ip4_address_t preresolve_ip4;
206 ip6_address_t preresolve_ip6;
209 /* Traffic class: zero, copy (~0) or fixed value */
213 bool sec_check; /* Inbound security check */
214 bool sec_check_frag; /* Inbound security check for (subsequent) fragments */
215 bool icmp6_enabled; /* Send destination unreachable for security check failure */
217 /* ICMPv6 -> ICMPv4 relay parameters */
218 ip4_address_t icmp4_src_address;
219 vlib_simple_counter_main_t icmp_relayed;
222 vlib_main_t *vlib_main;
223 vnet_main_t *vnet_main;
226 * IPv4 encap and decap reassembly
229 f32 ip4_reass_conf_ht_ratio; //Size of ht is 2^ceil(log2(ratio*pool_size))
230 u16 ip4_reass_conf_pool_size; //Max number of allocated reass structures
231 u16 ip4_reass_conf_lifetime_ms; //Time a reassembly struct is considered valid in ms
232 u32 ip4_reass_conf_buffers; //Maximum number of buffers used by ip4 reassembly
235 map_ip4_reass_t *ip4_reass_pool;
236 u8 ip4_reass_ht_log2len; //Hash table size is 2^log2len
237 u16 ip4_reass_allocated;
238 u16 *ip4_reass_hash_table;
239 u16 ip4_reass_fifo_last;
240 volatile u32 *ip4_reass_lock;
243 u32 ip4_reass_buffered_counter;
245 bool frag_inner; /* Inner or outer fragmentation */
246 bool frag_ignore_df; /* Fragment (outer) packet even if DF is set */
249 * IPv6 decap reassembly
252 f32 ip6_reass_conf_ht_ratio; //Size of ht is 2^ceil(log2(ratio*pool_size))
253 u16 ip6_reass_conf_pool_size; //Max number of allocated reass structures
254 u16 ip6_reass_conf_lifetime_ms; //Time a reassembly struct is considered valid in ms
255 u32 ip6_reass_conf_buffers; //Maximum number of buffers used by ip6 reassembly
258 map_ip6_reass_t *ip6_reass_pool;
259 u8 ip6_reass_ht_log2len; //Hash table size is 2^log2len
260 u16 ip6_reass_allocated;
261 u16 *ip6_reass_hash_table;
262 u16 ip6_reass_fifo_last;
263 volatile u32 *ip6_reass_lock;
266 u32 ip6_reass_buffered_counter;
271 * MAP Error counters/messages
273 #define foreach_map_error \
274 /* Must be first. */ \
275 _(NONE, "valid MAP packets") \
276 _(BAD_PROTOCOL, "bad protocol") \
277 _(SEC_CHECK, "security check failed") \
278 _(ENCAP_SEC_CHECK, "encap security check failed") \
279 _(DECAP_SEC_CHECK, "decap security check failed") \
280 _(ICMP, "unable to translate ICMP") \
281 _(ICMP_RELAY, "unable to relay ICMP") \
282 _(UNKNOWN, "unknown") \
283 _(NO_BINDING, "no binding") \
284 _(NO_DOMAIN, "no domain") \
285 _(FRAGMENTED, "packet is a fragment") \
286 _(FRAGMENT_MEMORY, "could not cache fragment") \
287 _(FRAGMENT_MALFORMED, "fragment has unexpected format")\
288 _(FRAGMENT_DROPPED, "dropped cached fragment") \
289 _(MALFORMED, "malformed packet") \
290 _(DF_SET, "can't fragment, DF set")
293 #define _(sym,str) MAP_ERROR_##sym,
299 u64 map_error_counter_get(u32 node_index, map_error_t map_error);
302 u32 map_domain_index;
308 extern vlib_node_registration_t ip4_map_node;
309 extern vlib_node_registration_t ip6_map_node;
311 extern vlib_node_registration_t ip4_map_t_node;
312 extern vlib_node_registration_t ip4_map_t_fragmented_node;
313 extern vlib_node_registration_t ip4_map_t_tcp_udp_node;
314 extern vlib_node_registration_t ip4_map_t_icmp_node;
316 extern vlib_node_registration_t ip6_map_t_node;
317 extern vlib_node_registration_t ip6_map_t_fragmented_node;
318 extern vlib_node_registration_t ip6_map_t_tcp_udp_node;
319 extern vlib_node_registration_t ip6_map_t_icmp_node;
324 static_always_inline u64
325 map_get_pfx (map_domain_t *d, u32 addr, u16 port)
327 u16 psid = (port >> d->psid_shift) & d->psid_mask;
329 if (d->ea_bits_len == 0 && d->rules)
330 return clib_net_to_host_u64(d->rules[psid].as_u64[0]);
332 u32 suffix = (addr >> d->suffix_shift) & d->suffix_mask;
333 u64 ea = d->ea_bits_len == 0 ? 0 : (((u64) suffix << d->psid_length)) | psid;
335 return clib_net_to_host_u64(d->ip6_prefix.as_u64[0]) | ea << d->ea_shift;
338 static_always_inline u64
339 map_get_pfx_net (map_domain_t *d, u32 addr, u16 port)
341 return clib_host_to_net_u64(map_get_pfx(d, clib_net_to_host_u32(addr),
342 clib_net_to_host_u16(port)));
348 static_always_inline u64
349 map_get_sfx (map_domain_t *d, u32 addr, u16 port)
351 u16 psid = (port >> d->psid_shift) & d->psid_mask;
353 /* Shared 1:1 mode. */
354 if (d->ea_bits_len == 0 && d->rules)
355 return clib_net_to_host_u64(d->rules[psid].as_u64[1]);
356 if (d->ip6_prefix_len == 128)
357 return clib_net_to_host_u64(d->ip6_prefix.as_u64[1]);
360 if (d->flags & MAP_DOMAIN_PREFIX)
361 return (u64) (addr & ~d->suffix_mask) << 16;
363 /* Shared or full IPv4 address */
364 return ((u64) addr << 16) | psid;
367 static_always_inline u64
368 map_get_sfx_net (map_domain_t *d, u32 addr, u16 port)
370 return clib_host_to_net_u64(map_get_sfx(d, clib_net_to_host_u32(addr),
371 clib_net_to_host_u16(port)));
374 static_always_inline u32
375 map_get_ip4 (ip6_address_t *addr)
377 return clib_host_to_net_u32(clib_net_to_host_u64(addr->as_u64[1]) >> 16);
381 * Get the MAP domain from an IPv4 lookup adjacency.
383 static_always_inline map_domain_t *
384 ip4_map_get_domain (u32 adj_index, u32 *map_domain_index)
386 map_main_t *mm = &map_main;
387 ip_lookup_main_t *lm = &ip4_main.lookup_main;
388 ip_adjacency_t *adj = ip_get_adjacency(lm, adj_index);
390 uword *p = (uword *)adj->rewrite_data;
392 *map_domain_index = p[0];
393 return pool_elt_at_index(mm->domains, p[0]);
397 * Get the MAP domain from an IPv6 lookup adjacency.
398 * If the IPv6 address or prefix is not shared, no lookup is required.
399 * The IPv4 address is used otherwise.
401 static_always_inline map_domain_t *
402 ip6_map_get_domain (u32 adj_index, ip4_address_t *addr,
403 u32 *map_domain_index, u8 *error)
405 map_main_t *mm = &map_main;
406 ip4_main_t *im4 = &ip4_main;
407 ip_lookup_main_t *lm4 = &ip4_main.lookup_main;
410 * Disable direct MAP domain lookup on decap, until the security check is updated to verify IPv4 SA.
411 * (That's done implicitly when MAP domain is looked up in the IPv4 FIB)
413 #ifdef MAP_NONSHARED_DOMAIN_ENABLED
414 ip_lookup_main_t *lm6 = &ip6_main.lookup_main;
415 ip_adjacency_t *adj = ip_get_adjacency(lm6, adj_index);
417 uword *p = (uword *)adj->rewrite_data;
419 *map_domain_index = p[0];
421 return pool_elt_at_index(mm->domains, p[0]);
424 u32 ai = ip4_fib_lookup_with_table(im4, 0, addr, 0);
425 ip_adjacency_t *adj4 = ip_get_adjacency (lm4, ai);
426 if (PREDICT_TRUE(adj4->lookup_next_index == IP_LOOKUP_NEXT_MAP ||
427 adj4->lookup_next_index == IP_LOOKUP_NEXT_MAP_T)) {
428 uword *p = (uword *)adj4->rewrite_data;
429 *map_domain_index = p[0];
430 return pool_elt_at_index(mm->domains, *map_domain_index);
432 *error = MAP_ERROR_NO_DOMAIN;
437 map_ip4_reass_get(u32 src, u32 dst, u16 fragment_id,
438 u8 protocol, u32 **pi_to_drop);
440 map_ip4_reass_free(map_ip4_reass_t *r, u32 **pi_to_drop);
442 #define map_ip4_reass_lock() while (__sync_lock_test_and_set(map_main.ip4_reass_lock, 1)) {}
443 #define map_ip4_reass_unlock() do {CLIB_MEMORY_BARRIER(); *map_main.ip4_reass_lock = 0;} while(0)
445 static_always_inline void
446 map_ip4_reass_get_fragments(map_ip4_reass_t *r, u32 **pi)
449 for (i=0; i<MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY; i++)
450 if(r->fragments[i] != ~0) {
451 vec_add1(*pi, r->fragments[i]);
452 r->fragments[i] = ~0;
453 map_main.ip4_reass_buffered_counter--;
457 int map_ip4_reass_add_fragment(map_ip4_reass_t *r, u32 pi);
460 map_ip6_reass_get(ip6_address_t *src, ip6_address_t *dst, u32 fragment_id,
461 u8 protocol, u32 **pi_to_drop);
463 map_ip6_reass_free(map_ip6_reass_t *r, u32 **pi_to_drop);
465 #define map_ip6_reass_lock() while (__sync_lock_test_and_set(map_main.ip6_reass_lock, 1)) {}
466 #define map_ip6_reass_unlock() do {CLIB_MEMORY_BARRIER(); *map_main.ip6_reass_lock = 0;} while(0)
469 map_ip6_reass_add_fragment(map_ip6_reass_t *r, u32 pi,
470 u16 data_offset, u16 next_data_offset,
471 u8 *data_start, u16 data_len);
473 void map_ip4_drop_pi(u32 pi);
475 int map_ip4_reass_conf_ht_ratio(f32 ht_ratio, u32 *trashed_reass, u32 *dropped_packets);
476 #define MAP_IP4_REASS_CONF_HT_RATIO_MAX 100
477 int map_ip4_reass_conf_pool_size(u16 pool_size, u32 *trashed_reass, u32 *dropped_packets);
478 #define MAP_IP4_REASS_CONF_POOL_SIZE_MAX (0xfeff)
479 int map_ip4_reass_conf_lifetime(u16 lifetime_ms);
480 #define MAP_IP4_REASS_CONF_LIFETIME_MAX 0xffff
481 int map_ip4_reass_conf_buffers(u32 buffers);
482 #define MAP_IP4_REASS_CONF_BUFFERS_MAX (0xffffffff)
484 void map_ip6_drop_pi(u32 pi);
487 int map_ip6_reass_conf_ht_ratio(f32 ht_ratio, u32 *trashed_reass, u32 *dropped_packets);
488 #define MAP_IP6_REASS_CONF_HT_RATIO_MAX 100
489 int map_ip6_reass_conf_pool_size(u16 pool_size, u32 *trashed_reass, u32 *dropped_packets);
490 #define MAP_IP6_REASS_CONF_POOL_SIZE_MAX (0xfeff)
491 int map_ip6_reass_conf_lifetime(u16 lifetime_ms);
492 #define MAP_IP6_REASS_CONF_LIFETIME_MAX 0xffff
493 int map_ip6_reass_conf_buffers(u32 buffers);
494 #define MAP_IP6_REASS_CONF_BUFFERS_MAX (0xffffffff)
497 int ip6_parse(const ip6_header_t *ip6, u32 buff_len,
498 u8 *l4_protocol, u16 *l4_offset, u16 *frag_hdr_offset)
500 if (ip6->protocol == IP_PROTOCOL_IPV6_FRAGMENTATION) {
501 *l4_protocol = ((ip6_frag_hdr_t *)(ip6 + 1))->next_hdr;
502 *frag_hdr_offset = sizeof(*ip6);
503 *l4_offset = sizeof(*ip6) + sizeof(ip6_frag_hdr_t);
505 *l4_protocol = ip6->protocol;
506 *frag_hdr_offset = 0;
507 *l4_offset = sizeof(*ip6);
510 return (buff_len < (*l4_offset + 4)) ||
511 (clib_net_to_host_u16(ip6->payload_length) < (*l4_offset + 4 - sizeof(*ip6)));
515 #define u8_ptr_add(ptr, index) (((u8 *)ptr) + index)
516 #define u16_net_add(u, val) clib_host_to_net_u16(clib_net_to_host_u16(u) + (val))
518 #define frag_id_6to4(id) ((id) ^ ((id) >> 16))
520 static_always_inline void
521 ip4_map_t_embedded_address (map_domain_t *d,
522 ip6_address_t *ip6, const ip4_address_t *ip4)
524 ASSERT(d->ip6_src_len == 96); //No support for other lengths for now
525 ip6->as_u64[0] = d->ip6_src.as_u64[0];
526 ip6->as_u32[2] = d->ip6_src.as_u32[2];
527 ip6->as_u32[3] = ip4->as_u32;
530 static_always_inline u32
531 ip6_map_t_embedded_address (map_domain_t *d, ip6_address_t *addr)
533 ASSERT(d->ip6_src_len == 96); //No support for other lengths for now
534 return addr->as_u32[3];
538 map_domain_counter_lock (map_main_t *mm)
540 if (mm->counter_lock)
541 while (__sync_lock_test_and_set(mm->counter_lock, 1))
545 map_domain_counter_unlock (map_main_t *mm)
547 if (mm->counter_lock)
548 *mm->counter_lock = 0;
552 static_always_inline void
553 map_send_all_to_node(vlib_main_t *vm, u32 *pi_vector,
554 vlib_node_runtime_t *node, vlib_error_t *error,
557 u32 n_left_from, *from, next_index, *to_next, n_left_to_next;
558 //Deal with fragments that are ready
560 n_left_from = vec_len(pi_vector);
561 next_index = node->cached_next_index;
562 while (n_left_from > 0) {
563 vlib_get_next_frame(vm, node, next_index, to_next, n_left_to_next);
564 while (n_left_from > 0 && n_left_to_next > 0) {
565 u32 pi0 = to_next[0] = from[0];
570 vlib_buffer_t *p0 = vlib_get_buffer(vm, pi0);
572 vlib_validate_buffer_enqueue_x1(vm, node, next_index, to_next, n_left_to_next, pi0, next);
574 vlib_put_next_frame(vm, node, next_index, n_left_to_next);
579 * fd.io coding-style-patch-verification: ON
582 * eval: (c-set-style "gnu")