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
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, u8 is_add);
35 u8 *format_map_trace(u8 *s, va_list *args);
36 i32 ip4_get_port(ip4_header_t *ip, map_dir_e dir, u16 buffer_len);
37 i32 ip6_get_port(ip6_header_t *ip6, map_dir_e dir, u16 buffer_len);
38 u16 ip4_map_get_port (ip4_header_t *ip, map_dir_e dir);
40 typedef enum __attribute__ ((__packed__)) {
41 MAP_DOMAIN_PREFIX = 1 << 0,
42 MAP_DOMAIN_TRANSLATION = 1 << 1, // The domain uses MAP-T
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.
82 ip6_address_t ip6_src;
83 ip6_address_t ip6_prefix;
86 ip4_address_t ip4_prefix;
89 map_domain_flags_e flags;
101 /* not used by forwarding */
105 #define MAP_REASS_INDEX_NONE ((u16)0xffff)
108 * Hash key, padded out to 16 bytes for fast compare
111 CLIB_PACKED (struct {
119 } map_ip4_reass_key_t;
122 map_ip4_reass_key_t key;
124 #ifdef MAP_IP4_REASS_COUNT_BYTES
133 u32 fragments[MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY];
137 * MAP domain counters
140 /* Simple counters */
141 MAP_DOMAIN_IPV4_FRAGMENT = 0,
142 /* Combined counters */
143 MAP_DOMAIN_COUNTER_RX = 0,
144 MAP_DOMAIN_COUNTER_TX,
146 } map_domain_counter_t;
152 CLIB_PACKED (struct {
160 } map_ip6_reass_key_t;
163 u32 pi; //Cached packet or ~0
164 u16 next_data_offset; //The data offset of the additional 20 bytes or ~0
165 u8 next_data_len; //Number of bytes ready to be copied (20 if not last fragment)
166 u8 next_data[20]; //The 20 additional bytes
167 } map_ip6_fragment_t;
170 map_ip6_reass_key_t key;
172 #ifdef MAP_IP6_REASS_COUNT_BYTES
176 u16 bucket; //What hash bucket this element is linked in
180 ip4_header_t ip4_header;
181 map_ip6_fragment_t fragments[MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY];
185 /* pool of MAP domains */
186 map_domain_t *domains;
188 /* MAP Domain packet/byte counters indexed by map domain index */
189 vlib_simple_counter_main_t *simple_domain_counters;
190 vlib_combined_counter_main_t *domain_counters;
191 volatile u32 *counter_lock;
193 /* Global counters */
194 vlib_simple_counter_main_t icmp_relayed;
196 #ifdef MAP_SKIP_IP6_LOOKUP
198 u32 adj6_index, adj4_index;
199 ip4_address_t preresolve_ip4;
200 ip6_address_t preresolve_ip6;
203 /* Traffic class: zero, copy (~0) or fixed value */
210 /* ICMPv6 -> ICMPv4 relay parameters */
211 ip4_address_t icmp4_src_address;
214 vlib_main_t *vlib_main;
215 vnet_main_t *vnet_main;
218 * IPv4 encap and decap reassembly
221 f32 ip4_reass_conf_ht_ratio; //Size of ht is 2^ceil(log2(ratio*pool_size))
222 u16 ip4_reass_conf_pool_size; //Max number of allocated reass structures
223 u16 ip4_reass_conf_lifetime_ms; //Time a reassembly struct is considered valid in ms
224 u32 ip4_reass_conf_buffers; //Maximum number of buffers used by ip4 reassembly
227 map_ip4_reass_t *ip4_reass_pool;
228 u8 ip4_reass_ht_log2len; //Hash table size is 2^log2len
229 u16 ip4_reass_allocated;
230 u16 *ip4_reass_hash_table;
231 u16 ip4_reass_fifo_last;
232 volatile u32 *ip4_reass_lock;
235 u32 ip4_reass_buffered_counter;
238 * IPv6 decap reassembly
241 f32 ip6_reass_conf_ht_ratio; //Size of ht is 2^ceil(log2(ratio*pool_size))
242 u16 ip6_reass_conf_pool_size; //Max number of allocated reass structures
243 u16 ip6_reass_conf_lifetime_ms; //Time a reassembly struct is considered valid in ms
244 u32 ip6_reass_conf_buffers; //Maximum number of buffers used by ip6 reassembly
247 map_ip6_reass_t *ip6_reass_pool;
248 u8 ip6_reass_ht_log2len; //Hash table size is 2^log2len
249 u16 ip6_reass_allocated;
250 u16 *ip6_reass_hash_table;
251 u16 ip6_reass_fifo_last;
252 volatile u32 *ip6_reass_lock;
255 u32 ip6_reass_buffered_counter;
260 * TODO: Remove SEC_CHECK / TRANSLATED_4TO6 / TRANSLATED_6TO4
262 #define foreach_map_error \
263 /* Must be first. */ \
264 _(NONE, "valid MAP packets") \
265 _(BAD_PROTOCOL, "bad protocol") \
266 _(WRONG_ICMP_TYPE, "wrong icmp type") \
267 _(SEC_CHECK, "security check failed") \
268 _(ENCAP_SEC_CHECK, "encap security check failed") \
269 _(DECAP_SEC_CHECK, "decap security check failed") \
270 _(ICMP, "unable to translate ICMP") \
271 _(ICMP_RELAY, "unable to relay ICMP") \
272 _(UNKNOWN, "unknown") \
273 _(NO_BINDING, "no binding") \
274 _(NO_DOMAIN, "no domain") \
275 _(FRAGMENTED, "packet is a fragment") \
276 _(FRAGMENT_MEMORY, "could not cache fragment") \
277 _(FRAGMENT_MALFORMED, "fragment has unexpected format")\
278 _(FRAGMENT_DROPPED, "dropped cached fragment") \
279 _(MALFORMED, "malformed packet") \
280 _(IP4_ERROR_TIME_EXPIRED, "time expired")
283 #define _(sym,str) MAP_ERROR_##sym,
289 u64 map_error_counter_get(u32 node_index, map_error_t map_error);
292 u32 map_domain_index;
298 vlib_node_registration_t ip4_map_node;
299 vlib_node_registration_t ip6_map_node;
301 vlib_node_registration_t ip4_map_t_node;
302 vlib_node_registration_t ip4_map_t_fragmented_node;
303 vlib_node_registration_t ip4_map_t_tcp_udp_node;
304 vlib_node_registration_t ip4_map_t_icmp_node;
306 vlib_node_registration_t ip6_map_t_node;
307 vlib_node_registration_t ip6_map_t_fragmented_node;
308 vlib_node_registration_t ip6_map_t_tcp_udp_node;
309 vlib_node_registration_t ip6_map_t_icmp_node;
314 static_always_inline u64
315 map_get_pfx (map_domain_t *d, u32 addr, u16 port)
317 u16 psid = (port >> d->psid_shift) & d->psid_mask;
319 if (d->ea_bits_len == 0 && d->rules)
320 return clib_net_to_host_u64(d->rules[psid].as_u64[0]);
322 u32 suffix = (addr >> d->suffix_shift) & d->suffix_mask;
323 u64 ea = d->ea_bits_len == 0 ? 0 : (((u64) suffix << d->psid_length)) | psid;
325 return clib_net_to_host_u64(d->ip6_prefix.as_u64[0]) | ea << d->ea_shift;
328 static_always_inline u64
329 map_get_pfx_net (map_domain_t *d, u32 addr, u16 port)
331 return clib_host_to_net_u64(map_get_pfx(d, clib_net_to_host_u32(addr),
332 clib_net_to_host_u16(port)));
338 static_always_inline u64
339 map_get_sfx (map_domain_t *d, u32 addr, u16 port)
341 u16 psid = (port >> d->psid_shift) & d->psid_mask;
343 /* Shared 1:1 mode. */
344 if (d->ea_bits_len == 0 && d->rules)
345 return clib_net_to_host_u64(d->rules[psid].as_u64[1]);
346 if (d->ip6_prefix_len == 128)
347 return clib_net_to_host_u64(d->ip6_prefix.as_u64[1]);
350 if (d->flags & MAP_DOMAIN_PREFIX)
351 return (u64) (addr & ~d->suffix_mask) << 16;
353 /* Shared or full IPv4 address */
354 return ((u64) addr << 16) | psid;
357 static_always_inline u64
358 map_get_sfx_net (map_domain_t *d, u32 addr, u16 port)
360 return clib_host_to_net_u64(map_get_sfx(d, clib_net_to_host_u32(addr),
361 clib_net_to_host_u16(port)));
364 static_always_inline u32
365 map_get_ip4 (ip6_address_t *addr)
367 return clib_host_to_net_u32(clib_net_to_host_u64(addr->as_u64[1]) >> 16);
371 * Get the MAP domain from an IPv4 lookup adjacency.
373 static_always_inline map_domain_t *
374 ip4_map_get_domain (u32 adj_index, u32 *map_domain_index)
376 map_main_t *mm = &map_main;
377 ip_lookup_main_t *lm = &ip4_main.lookup_main;
378 ip_adjacency_t *adj = ip_get_adjacency(lm, adj_index);
380 uword *p = (uword *)adj->rewrite_data;
382 *map_domain_index = p[0];
383 return pool_elt_at_index(mm->domains, p[0]);
387 * Get the MAP domain from an IPv6 lookup adjacency.
388 * If the IPv6 address or prefix is not shared, no lookup is required.
389 * The IPv4 address is used otherwise.
391 static_always_inline map_domain_t *
392 ip6_map_get_domain (u32 adj_index, ip4_address_t *addr,
393 u32 *map_domain_index, u8 *error)
395 map_main_t *mm = &map_main;
396 ip4_main_t *im4 = &ip4_main;
397 ip_lookup_main_t *lm4 = &ip4_main.lookup_main;
400 * Disable direct MAP domain lookup on decap, until the security check is updated to verify IPv4 SA.
401 * (That's done implicitly when MAP domain is looked up in the IPv4 FIB)
403 #ifdef MAP_NONSHARED_DOMAIN_ENABLED
404 ip_lookup_main_t *lm6 = &ip6_main.lookup_main;
405 ip_adjacency_t *adj = ip_get_adjacency(lm6, adj_index);
407 uword *p = (uword *)adj->rewrite_data;
409 *map_domain_index = p[0];
411 return pool_elt_at_index(mm->domains, p[0]);
414 u32 ai = ip4_fib_lookup_with_table(im4, 0, addr, 0);
415 ip_adjacency_t *adj4 = ip_get_adjacency (lm4, ai);
416 if (PREDICT_TRUE(adj4->lookup_next_index == IP_LOOKUP_NEXT_MAP ||
417 adj4->lookup_next_index == IP_LOOKUP_NEXT_MAP_T)) {
418 uword *p = (uword *)adj4->rewrite_data;
419 *map_domain_index = p[0];
420 return pool_elt_at_index(mm->domains, *map_domain_index);
422 *error = MAP_ERROR_NO_DOMAIN;
427 map_ip4_reass_get(u32 src, u32 dst, u16 fragment_id,
428 u8 protocol, u32 **pi_to_drop);
430 map_ip4_reass_free(map_ip4_reass_t *r, u32 **pi_to_drop);
432 #define map_ip4_reass_lock() while (__sync_lock_test_and_set(map_main.ip4_reass_lock, 1)) {}
433 #define map_ip4_reass_unlock() do {CLIB_MEMORY_BARRIER(); *map_main.ip4_reass_lock = 0;} while(0)
435 static_always_inline void
436 map_ip4_reass_get_fragments(map_ip4_reass_t *r, u32 **pi)
439 for (i=0; i<MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY; i++)
440 if(r->fragments[i] != ~0) {
441 vec_add1(*pi, r->fragments[i]);
442 r->fragments[i] = ~0;
443 map_main.ip4_reass_buffered_counter--;
447 int map_ip4_reass_add_fragment(map_ip4_reass_t *r, u32 pi);
450 map_ip6_reass_get(ip6_address_t *src, ip6_address_t *dst, u32 fragment_id,
451 u8 protocol, u32 **pi_to_drop);
453 map_ip6_reass_free(map_ip6_reass_t *r, u32 **pi_to_drop);
455 #define map_ip6_reass_lock() while (__sync_lock_test_and_set(map_main.ip6_reass_lock, 1)) {}
456 #define map_ip6_reass_unlock() do {CLIB_MEMORY_BARRIER(); *map_main.ip6_reass_lock = 0;} while(0)
459 map_ip6_reass_add_fragment(map_ip6_reass_t *r, u32 pi,
460 u16 data_offset, u16 next_data_offset,
461 u8 *data_start, u16 data_len);
463 void map_ip4_drop_pi(u32 pi);
465 int map_ip4_reass_conf_ht_ratio(f32 ht_ratio, u32 *trashed_reass, u32 *dropped_packets);
466 #define MAP_IP4_REASS_CONF_HT_RATIO_MAX 100
467 int map_ip4_reass_conf_pool_size(u16 pool_size, u32 *trashed_reass, u32 *dropped_packets);
468 #define MAP_IP4_REASS_CONF_POOL_SIZE_MAX (0xfeff)
469 int map_ip4_reass_conf_lifetime(u16 lifetime_ms);
470 #define MAP_IP4_REASS_CONF_LIFETIME_MAX 0xffff
471 int map_ip4_reass_conf_buffers(u32 buffers);
472 #define MAP_IP4_REASS_CONF_BUFFERS_MAX (0xffffffff)
474 void map_ip6_drop_pi(u32 pi);
477 int map_ip6_reass_conf_ht_ratio(f32 ht_ratio, u32 *trashed_reass, u32 *dropped_packets);
478 #define MAP_IP6_REASS_CONF_HT_RATIO_MAX 100
479 int map_ip6_reass_conf_pool_size(u16 pool_size, u32 *trashed_reass, u32 *dropped_packets);
480 #define MAP_IP6_REASS_CONF_POOL_SIZE_MAX (0xfeff)
481 int map_ip6_reass_conf_lifetime(u16 lifetime_ms);
482 #define MAP_IP6_REASS_CONF_LIFETIME_MAX 0xffff
483 int map_ip6_reass_conf_buffers(u32 buffers);
484 #define MAP_IP6_REASS_CONF_BUFFERS_MAX (0xffffffff)
487 int ip6_parse(const ip6_header_t *ip6, u32 buff_len,
488 u8 *l4_protocol, u16 *l4_offset, u16 *frag_hdr_offset)
490 if (ip6->protocol == IP_PROTOCOL_IPV6_FRAGMENTATION) {
491 *l4_protocol = ((ip6_frag_hdr_t *)(ip6 + 1))->next_hdr;
492 *frag_hdr_offset = sizeof(*ip6);
493 *l4_offset = sizeof(*ip6) + sizeof(ip6_frag_hdr_t);
495 *l4_protocol = ip6->protocol;
496 *frag_hdr_offset = 0;
497 *l4_offset = sizeof(*ip6);
500 return (buff_len < (*l4_offset + 4)) ||
501 (clib_net_to_host_u16(ip6->payload_length) < (*l4_offset + 4 - sizeof(*ip6)));
505 #define u8_ptr_add(ptr, index) (((u8 *)ptr) + index)
506 #define u16_net_add(u, val) clib_host_to_net_u16(clib_net_to_host_u16(u) + (val))
508 #define frag_id_6to4(id) ((id) ^ ((id) >> 16))
510 static_always_inline void
511 ip4_map_t_embedded_address (map_domain_t *d,
512 ip6_address_t *ip6, const ip4_address_t *ip4)
514 ASSERT(d->ip6_src_len == 96); //No support for other lengths for now
515 ip6->as_u64[0] = d->ip6_src.as_u64[0];
516 ip6->as_u32[2] = d->ip6_src.as_u32[2];
517 ip6->as_u32[3] = ip4->as_u32;
520 static_always_inline u32
521 ip6_map_t_embedded_address (map_domain_t *d, ip6_address_t *addr)
523 ASSERT(d->ip6_src_len == 96); //No support for other lengths for now
524 return addr->as_u32[3];
528 map_domain_counter_lock (map_main_t *mm)
530 if (mm->counter_lock)
531 while (__sync_lock_test_and_set(mm->counter_lock, 1))
535 map_domain_counter_unlock (map_main_t *mm)
537 if (mm->counter_lock)
538 *mm->counter_lock = 0;
542 static_always_inline void
543 map_send_all_to_node(vlib_main_t *vm, u32 *pi_vector,
544 vlib_node_runtime_t *node, vlib_error_t *error,
547 u32 n_left_from, *from, next_index, *to_next, n_left_to_next;
548 //Deal with fragments that are ready
550 n_left_from = vec_len(pi_vector);
551 next_index = node->cached_next_index;
552 while (n_left_from > 0) {
553 vlib_get_next_frame(vm, node, next_index, to_next, n_left_to_next);
554 while (n_left_from > 0 && n_left_to_next > 0) {
555 u32 pi0 = to_next[0] = from[0];
560 vlib_buffer_t *p0 = vlib_get_buffer(vm, pi0);
562 vlib_validate_buffer_enqueue_x1(vm, node, next_index, to_next, n_left_to_next, pi0, next);
564 vlib_put_next_frame(vm, node, next_index, n_left_to_next);