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
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);
38 typedef enum __attribute__ ((__packed__))
40 MAP_DOMAIN_PREFIX = 1 << 0, MAP_DOMAIN_TRANSLATION = 1 << 1, // The domain uses MAP-T
44 * IP4 reassembly logic:
45 * One virtually reassembled flow requires a map_ip4_reass_t structure in order
46 * to keep the first-fragment port number and, optionally, cache out of sequence
48 * There are up to MAP_IP4_REASS_MAX_REASSEMBLY such structures.
49 * When in use, those structures are stored in a hash table of MAP_IP4_REASS_BUCKETS buckets.
50 * When a new structure needs to be used, it is allocated from available ones.
51 * If there is no structure available, the oldest in use is selected and used if and
52 * only if it was first allocated more than MAP_IP4_REASS_LIFETIME seconds ago.
53 * In case no structure can be allocated, the fragment is dropped.
56 #define MAP_IP4_REASS_LIFETIME_DEFAULT (100) /* ms */
57 #define MAP_IP4_REASS_HT_RATIO_DEFAULT (1.0)
58 #define MAP_IP4_REASS_POOL_SIZE_DEFAULT 1024 // Number of reassembly structures
59 #define MAP_IP4_REASS_BUFFERS_DEFAULT 2048
61 #define MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY 5 // Number of fragment per reassembly
63 #define MAP_IP6_REASS_LIFETIME_DEFAULT (100) /* ms */
64 #define MAP_IP6_REASS_HT_RATIO_DEFAULT (1.0)
65 #define MAP_IP6_REASS_POOL_SIZE_DEFAULT 1024 // Number of reassembly structures
66 #define MAP_IP6_REASS_BUFFERS_DEFAULT 2048
68 #define MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY 5
70 #define MAP_IP6_REASS_COUNT_BYTES
71 #define MAP_IP4_REASS_COUNT_BYTES
73 //#define IP6_MAP_T_OVERRIDE_TOS 0
76 * This structure _MUST_ be no larger than a single cache line (64 bytes).
77 * If more space is needed make a union of ip6_prefix and *rules, those are mutually exclusive.
81 ip6_address_t ip6_src;
82 ip6_address_t ip6_prefix;
85 ip4_address_t ip4_prefix;
88 map_domain_flags_e flags;
100 /* not used by forwarding */
104 STATIC_ASSERT ((sizeof (map_domain_t) <= CLIB_CACHE_LINE_BYTES),
105 "MAP domain fits in one cacheline");
107 #define MAP_REASS_INDEX_NONE ((u16)0xffff)
110 * Hash key, padded out to 16 bytes for fast compare
114 CLIB_PACKED (struct {
122 } map_ip4_reass_key_t;
127 map_ip4_reass_key_t key;
129 #ifdef MAP_IP4_REASS_COUNT_BYTES
138 u32 fragments[MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY];
142 * MAP domain counters
146 /* Simple counters */
147 MAP_DOMAIN_IPV4_FRAGMENT = 0,
148 /* Combined counters */
149 MAP_DOMAIN_COUNTER_RX = 0,
150 MAP_DOMAIN_COUNTER_TX,
152 } map_domain_counter_t;
159 CLIB_PACKED (struct {
167 } map_ip6_reass_key_t;
171 u32 pi; //Cached packet or ~0
172 u16 next_data_offset; //The data offset of the additional 20 bytes or ~0
173 u8 next_data_len; //Number of bytes ready to be copied (20 if not last fragment)
174 u8 next_data[20]; //The 20 additional bytes
175 } map_ip6_fragment_t;
178 map_ip6_reass_key_t key;
180 #ifdef MAP_IP6_REASS_COUNT_BYTES
184 u16 bucket; //What hash bucket this element is linked in
188 ip4_header_t ip4_header;
189 map_ip6_fragment_t fragments[MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY];
192 #ifdef MAP_SKIP_IP6_LOOKUP
194 * A pre-resolved next-hop
196 typedef struct map_main_pre_resolved_t_
199 * Linkage into the FIB graph
204 * The FIB entry index of the next-hop
206 fib_node_index_t fei;
209 * This object sibling index on the FIB entry's child dependency list
214 * The Load-balance object index to use to forward
217 } map_main_pre_resolved_t;
220 * Pre-resolved next hops for v4 and v6. Why these are global and not
221 * per-domain is beyond me.
223 extern map_main_pre_resolved_t pre_resolved[FIB_PROTOCOL_MAX];
227 /* pool of MAP domains */
228 map_domain_t *domains;
230 /* MAP Domain packet/byte counters indexed by map domain index */
231 vlib_simple_counter_main_t *simple_domain_counters;
232 vlib_combined_counter_main_t *domain_counters;
233 volatile u32 *counter_lock;
235 /* Traffic class: zero, copy (~0) or fixed value */
239 bool sec_check; /* Inbound security check */
240 bool sec_check_frag; /* Inbound security check for (subsequent) fragments */
241 bool icmp6_enabled; /* Send destination unreachable for security check failure */
243 /* ICMPv6 -> ICMPv4 relay parameters */
244 ip4_address_t icmp4_src_address;
245 vlib_simple_counter_main_t icmp_relayed;
248 vlib_main_t *vlib_main;
249 vnet_main_t *vnet_main;
252 * IPv4 encap and decap reassembly
255 f32 ip4_reass_conf_ht_ratio; //Size of ht is 2^ceil(log2(ratio*pool_size))
256 u16 ip4_reass_conf_pool_size; //Max number of allocated reass structures
257 u16 ip4_reass_conf_lifetime_ms; //Time a reassembly struct is considered valid in ms
258 u32 ip4_reass_conf_buffers; //Maximum number of buffers used by ip4 reassembly
261 map_ip4_reass_t *ip4_reass_pool;
262 u8 ip4_reass_ht_log2len; //Hash table size is 2^log2len
263 u16 ip4_reass_allocated;
264 u16 *ip4_reass_hash_table;
265 u16 ip4_reass_fifo_last;
266 volatile u32 *ip4_reass_lock;
269 u32 ip4_reass_buffered_counter;
271 bool frag_inner; /* Inner or outer fragmentation */
272 bool frag_ignore_df; /* Fragment (outer) packet even if DF is set */
275 * IPv6 decap reassembly
278 f32 ip6_reass_conf_ht_ratio; //Size of ht is 2^ceil(log2(ratio*pool_size))
279 u16 ip6_reass_conf_pool_size; //Max number of allocated reass structures
280 u16 ip6_reass_conf_lifetime_ms; //Time a reassembly struct is considered valid in ms
281 u32 ip6_reass_conf_buffers; //Maximum number of buffers used by ip6 reassembly
284 map_ip6_reass_t *ip6_reass_pool;
285 u8 ip6_reass_ht_log2len; //Hash table size is 2^log2len
286 u16 ip6_reass_allocated;
287 u16 *ip6_reass_hash_table;
288 u16 ip6_reass_fifo_last;
289 volatile u32 *ip6_reass_lock;
292 u32 ip6_reass_buffered_counter;
297 * MAP Error counters/messages
299 #define foreach_map_error \
300 /* Must be first. */ \
301 _(NONE, "valid MAP packets") \
302 _(BAD_PROTOCOL, "bad protocol") \
303 _(SEC_CHECK, "security check failed") \
304 _(ENCAP_SEC_CHECK, "encap security check failed") \
305 _(DECAP_SEC_CHECK, "decap security check failed") \
306 _(ICMP, "unable to translate ICMP") \
307 _(ICMP_RELAY, "unable to relay ICMP") \
308 _(UNKNOWN, "unknown") \
309 _(NO_BINDING, "no binding") \
310 _(NO_DOMAIN, "no domain") \
311 _(FRAGMENTED, "packet is a fragment") \
312 _(FRAGMENT_MEMORY, "could not cache fragment") \
313 _(FRAGMENT_MALFORMED, "fragment has unexpected format")\
314 _(FRAGMENT_DROPPED, "dropped cached fragment") \
315 _(MALFORMED, "malformed packet") \
316 _(DF_SET, "can't fragment, DF set")
319 #define _(sym,str) MAP_ERROR_##sym,
325 u64 map_error_counter_get(u32 node_index, map_error_t map_error);
328 u32 map_domain_index;
332 extern map_main_t map_main;
334 extern vlib_node_registration_t ip4_map_node;
335 extern vlib_node_registration_t ip6_map_node;
337 extern vlib_node_registration_t ip4_map_t_node;
338 extern vlib_node_registration_t ip4_map_t_fragmented_node;
339 extern vlib_node_registration_t ip4_map_t_tcp_udp_node;
340 extern vlib_node_registration_t ip4_map_t_icmp_node;
342 extern vlib_node_registration_t ip6_map_t_node;
343 extern vlib_node_registration_t ip6_map_t_fragmented_node;
344 extern vlib_node_registration_t ip6_map_t_tcp_udp_node;
345 extern vlib_node_registration_t ip6_map_t_icmp_node;
350 static_always_inline u64
351 map_get_pfx (map_domain_t *d, u32 addr, u16 port)
353 u16 psid = (port >> d->psid_shift) & d->psid_mask;
355 if (d->ea_bits_len == 0 && d->rules)
356 return clib_net_to_host_u64(d->rules[psid].as_u64[0]);
358 u32 suffix = (addr >> d->suffix_shift) & d->suffix_mask;
359 u64 ea = d->ea_bits_len == 0 ? 0 : (((u64) suffix << d->psid_length)) | psid;
361 return clib_net_to_host_u64(d->ip6_prefix.as_u64[0]) | ea << d->ea_shift;
364 static_always_inline u64
365 map_get_pfx_net (map_domain_t *d, u32 addr, u16 port)
367 return clib_host_to_net_u64(map_get_pfx(d, clib_net_to_host_u32(addr),
368 clib_net_to_host_u16(port)));
374 static_always_inline u64
375 map_get_sfx (map_domain_t *d, u32 addr, u16 port)
377 u16 psid = (port >> d->psid_shift) & d->psid_mask;
379 /* Shared 1:1 mode. */
380 if (d->ea_bits_len == 0 && d->rules)
381 return clib_net_to_host_u64(d->rules[psid].as_u64[1]);
382 if (d->ip6_prefix_len == 128)
383 return clib_net_to_host_u64(d->ip6_prefix.as_u64[1]);
386 if (d->flags & MAP_DOMAIN_PREFIX)
387 return (u64) (addr & (0xFFFFFFFF << d->suffix_shift)) << 16;
389 /* Shared or full IPv4 address */
390 return ((u64) addr << 16) | psid;
393 static_always_inline u64
394 map_get_sfx_net (map_domain_t *d, u32 addr, u16 port)
396 return clib_host_to_net_u64(map_get_sfx(d, clib_net_to_host_u32(addr),
397 clib_net_to_host_u16(port)));
400 static_always_inline u32
401 map_get_ip4 (ip6_address_t *addr)
403 return clib_host_to_net_u32(clib_net_to_host_u64(addr->as_u64[1]) >> 16);
407 * Get the MAP domain from an IPv4 lookup adjacency.
409 static_always_inline map_domain_t *
410 ip4_map_get_domain (u32 mdi)
412 map_main_t *mm = &map_main;
414 return pool_elt_at_index(mm->domains, mdi);
418 * Get the MAP domain from an IPv6 lookup adjacency.
419 * If the IPv6 address or prefix is not shared, no lookup is required.
420 * The IPv4 address is used otherwise.
422 static_always_inline map_domain_t *
423 ip6_map_get_domain (u32 mdi,
425 u32 *map_domain_index,
428 map_main_t *mm = &map_main;
431 * Disable direct MAP domain lookup on decap, until the security check is updated to verify IPv4 SA.
432 * (That's done implicitly when MAP domain is looked up in the IPv4 FIB)
434 #ifdef MAP_NONSHARED_DOMAIN_ENABLED
435 #error "How can you be sure this domain is not shared?"
436 *map_domain_index = mdi;
437 return pool_elt_at_index(mm->domains, mdi);
440 u32 lbi = ip4_fib_forwarding_lookup(0, addr);
441 const dpo_id_t *dpo = load_balance_get_bucket(lbi, 0);
442 if (PREDICT_TRUE(dpo->dpoi_type == map_dpo_type ||
443 dpo->dpoi_type == map_t_dpo_type))
445 *map_domain_index = dpo->dpoi_index;
446 return pool_elt_at_index(mm->domains, *map_domain_index);
448 *error = MAP_ERROR_NO_DOMAIN;
453 map_ip4_reass_get(u32 src, u32 dst, u16 fragment_id,
454 u8 protocol, u32 **pi_to_drop);
456 map_ip4_reass_free(map_ip4_reass_t *r, u32 **pi_to_drop);
458 #define map_ip4_reass_lock() while (__sync_lock_test_and_set(map_main.ip4_reass_lock, 1)) {}
459 #define map_ip4_reass_unlock() do {CLIB_MEMORY_BARRIER(); *map_main.ip4_reass_lock = 0;} while(0)
461 static_always_inline void
462 map_ip4_reass_get_fragments(map_ip4_reass_t *r, u32 **pi)
465 for (i=0; i<MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY; i++)
466 if(r->fragments[i] != ~0) {
467 vec_add1(*pi, r->fragments[i]);
468 r->fragments[i] = ~0;
469 map_main.ip4_reass_buffered_counter--;
473 int map_ip4_reass_add_fragment(map_ip4_reass_t *r, u32 pi);
476 map_ip6_reass_get(ip6_address_t *src, ip6_address_t *dst, u32 fragment_id,
477 u8 protocol, u32 **pi_to_drop);
479 map_ip6_reass_free(map_ip6_reass_t *r, u32 **pi_to_drop);
481 #define map_ip6_reass_lock() while (__sync_lock_test_and_set(map_main.ip6_reass_lock, 1)) {}
482 #define map_ip6_reass_unlock() do {CLIB_MEMORY_BARRIER(); *map_main.ip6_reass_lock = 0;} while(0)
485 map_ip6_reass_add_fragment(map_ip6_reass_t *r, u32 pi,
486 u16 data_offset, u16 next_data_offset,
487 u8 *data_start, u16 data_len);
489 void map_ip4_drop_pi(u32 pi);
491 int map_ip4_reass_conf_ht_ratio(f32 ht_ratio, u32 *trashed_reass, u32 *dropped_packets);
492 #define MAP_IP4_REASS_CONF_HT_RATIO_MAX 100
493 int map_ip4_reass_conf_pool_size(u16 pool_size, u32 *trashed_reass, u32 *dropped_packets);
494 #define MAP_IP4_REASS_CONF_POOL_SIZE_MAX (0xfeff)
495 int map_ip4_reass_conf_lifetime(u16 lifetime_ms);
496 #define MAP_IP4_REASS_CONF_LIFETIME_MAX 0xffff
497 int map_ip4_reass_conf_buffers(u32 buffers);
498 #define MAP_IP4_REASS_CONF_BUFFERS_MAX (0xffffffff)
500 void map_ip6_drop_pi(u32 pi);
503 int map_ip6_reass_conf_ht_ratio(f32 ht_ratio, u32 *trashed_reass, u32 *dropped_packets);
504 #define MAP_IP6_REASS_CONF_HT_RATIO_MAX 100
505 int map_ip6_reass_conf_pool_size(u16 pool_size, u32 *trashed_reass, u32 *dropped_packets);
506 #define MAP_IP6_REASS_CONF_POOL_SIZE_MAX (0xfeff)
507 int map_ip6_reass_conf_lifetime(u16 lifetime_ms);
508 #define MAP_IP6_REASS_CONF_LIFETIME_MAX 0xffff
509 int map_ip6_reass_conf_buffers(u32 buffers);
510 #define MAP_IP6_REASS_CONF_BUFFERS_MAX (0xffffffff)
513 #define u8_ptr_add(ptr, index) (((u8 *)ptr) + index)
514 #define u16_net_add(u, val) clib_host_to_net_u16(clib_net_to_host_u16(u) + (val))
516 static_always_inline void
517 ip4_map_t_embedded_address (map_domain_t *d,
518 ip6_address_t *ip6, const ip4_address_t *ip4)
520 ASSERT(d->ip6_src_len == 96); //No support for other lengths for now
521 ip6->as_u64[0] = d->ip6_src.as_u64[0];
522 ip6->as_u32[2] = d->ip6_src.as_u32[2];
523 ip6->as_u32[3] = ip4->as_u32;
526 static_always_inline u32
527 ip6_map_t_embedded_address (map_domain_t *d, ip6_address_t *addr)
529 ASSERT(d->ip6_src_len == 96); //No support for other lengths for now
530 return addr->as_u32[3];
534 map_domain_counter_lock (map_main_t *mm)
536 if (mm->counter_lock)
537 while (__sync_lock_test_and_set(mm->counter_lock, 1))
541 map_domain_counter_unlock (map_main_t *mm)
543 if (mm->counter_lock)
544 *mm->counter_lock = 0;
548 static_always_inline void
549 map_send_all_to_node(vlib_main_t *vm, u32 *pi_vector,
550 vlib_node_runtime_t *node, vlib_error_t *error,
553 u32 n_left_from, *from, next_index, *to_next, n_left_to_next;
554 //Deal with fragments that are ready
556 n_left_from = vec_len(pi_vector);
557 next_index = node->cached_next_index;
558 while (n_left_from > 0) {
559 vlib_get_next_frame(vm, node, next_index, to_next, n_left_to_next);
560 while (n_left_from > 0 && n_left_to_next > 0) {
561 u32 pi0 = to_next[0] = from[0];
566 vlib_buffer_t *p0 = vlib_get_buffer(vm, pi0);
568 vlib_validate_buffer_enqueue_x1(vm, node, next_index, to_next, n_left_to_next, pi0, next);
570 vlib_put_next_frame(vm, node, next_index, n_left_to_next);
575 * fd.io coding-style-patch-verification: ON
578 * eval: (c-set-style "gnu")