MAP: Decrement TTL of payload IPv4 packet.
[vpp.git] / vnet / vnet / map / map.h
1 /*
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:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 #include <stdbool.h>
16 #include <vppinfra/error.h>
17 #include <vnet/vnet.h>
18 #include <vnet/ip/ip.h>
19 #include <vlib/vlib.h>
20
21 #define MAP_SKIP_IP6_LOOKUP 1
22
23 typedef enum {
24   MAP_SENDER,
25   MAP_RECEIVER
26 } map_dir_e;
27
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);
39
40 typedef enum __attribute__ ((__packed__)) {
41   MAP_DOMAIN_PREFIX        = 1 << 0,
42   MAP_DOMAIN_TRANSLATION   = 1 << 1, // The domain uses MAP-T
43 } map_domain_flags_e;
44
45 /**
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
49  * packets.
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.
56  */
57
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
62
63 #define MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY 5    // Number of fragment per reassembly
64
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
69
70 #define MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY 5
71
72 #define MAP_IP6_REASS_COUNT_BYTES
73 #define MAP_IP4_REASS_COUNT_BYTES
74
75 //#define IP6_MAP_T_OVERRIDE_TOS 0
76
77 /*
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.
80  */
81 typedef struct {
82   ip6_address_t ip6_src;
83   ip6_address_t ip6_prefix;
84   ip6_address_t *rules;
85   u32 suffix_mask;
86   ip4_address_t ip4_prefix;
87   u16 psid_mask;
88   u16 mtu;
89   map_domain_flags_e flags;
90   u8 ip6_prefix_len;
91   u8 ip6_src_len;
92   u8 ea_bits_len;
93   u8 psid_offset;
94   u8 psid_length;
95
96   /* helpers */
97   u8 psid_shift;
98   u8 suffix_shift;
99   u8 ea_shift;
100
101   /* not used by forwarding */
102   u8 ip4_prefix_len;
103 } map_domain_t;
104
105 #define MAP_REASS_INDEX_NONE ((u16)0xffff)
106
107 /*
108  * Hash key, padded out to 16 bytes for fast compare
109  */
110 typedef union {
111   CLIB_PACKED (struct {
112     ip4_address_t src;
113     ip4_address_t dst;
114     u16 fragment_id;
115     u8 protocol;
116   });
117   u64 as_u64[2];
118   u32 as_u32[4];
119 } map_ip4_reass_key_t;
120
121 typedef struct {
122   map_ip4_reass_key_t key;
123   f64 ts;
124 #ifdef MAP_IP4_REASS_COUNT_BYTES
125   u16 expected_total;
126   u16 forwarded;
127 #endif
128   i32 port;
129   u16 bucket;
130   u16 bucket_next;
131   u16 fifo_prev;
132   u16 fifo_next;
133   u32 fragments[MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY];
134 } map_ip4_reass_t;
135
136 /*
137  * MAP domain counters
138  */
139 typedef enum {
140   /* Simple counters */
141   MAP_DOMAIN_IPV4_FRAGMENT = 0,
142   /* Combined counters */
143   MAP_DOMAIN_COUNTER_RX = 0,
144   MAP_DOMAIN_COUNTER_TX,
145   MAP_N_DOMAIN_COUNTER
146 } map_domain_counter_t;
147
148 /*
149  * main_main_t
150  */
151 typedef union {
152   CLIB_PACKED (struct {
153     ip6_address_t src;
154     ip6_address_t dst;
155     u32 fragment_id;
156     u8 protocol;
157   });
158   u64 as_u64[5];
159   u32 as_u32[10];
160 } map_ip6_reass_key_t;
161
162 typedef struct {
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;
168
169 typedef struct {
170   map_ip6_reass_key_t key;
171   f64 ts;
172 #ifdef MAP_IP6_REASS_COUNT_BYTES
173   u16 expected_total;
174   u16 forwarded;
175 #endif
176   u16 bucket; //What hash bucket this element is linked in
177   u16 bucket_next;
178   u16 fifo_prev;
179   u16 fifo_next;
180   ip4_header_t ip4_header;
181   map_ip6_fragment_t fragments[MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY];
182 } map_ip6_reass_t;
183
184 typedef struct {
185   /* pool of MAP domains */
186   map_domain_t *domains;
187
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;
192
193   /* Global counters */
194   vlib_simple_counter_main_t icmp_relayed;
195
196 #ifdef MAP_SKIP_IP6_LOOKUP
197   /* pre-presolve */
198   u32 adj6_index, adj4_index;
199   ip4_address_t preresolve_ip4;
200   ip6_address_t preresolve_ip6;
201 #endif
202
203   /* Traffic class: zero, copy (~0) or fixed value */
204   u8 tc;
205   bool tc_copy;
206   bool sec_check;
207   bool sec_check_frag;
208
209   /* ICMPv6 -> ICMPv4 relay parameters */
210   ip4_address_t icmp_src_address;
211
212   /* convenience */
213   vlib_main_t *vlib_main;
214   vnet_main_t *vnet_main;
215
216   /*
217    * IPv4 encap and decap reassembly
218    */
219   //Conf
220   f32 ip4_reass_conf_ht_ratio; //Size of ht is 2^ceil(log2(ratio*pool_size))
221   u16 ip4_reass_conf_pool_size; //Max number of allocated reass structures
222   u16 ip4_reass_conf_lifetime_ms; //Time a reassembly struct is considered valid in ms
223   u32 ip4_reass_conf_buffers; //Maximum number of buffers used by ip4 reassembly
224
225   //Runtime
226   map_ip4_reass_t *ip4_reass_pool;
227   u8 ip4_reass_ht_log2len; //Hash table size is 2^log2len
228   u16 ip4_reass_allocated;
229   u16 *ip4_reass_hash_table;
230   u16 ip4_reass_fifo_last;
231   volatile u32 *ip4_reass_lock;
232
233   //Counters
234   u32 ip4_reass_buffered_counter;
235
236   /*
237    * IPv6 decap reassembly
238    */
239   //Conf
240   f32 ip6_reass_conf_ht_ratio; //Size of ht is 2^ceil(log2(ratio*pool_size))
241   u16 ip6_reass_conf_pool_size; //Max number of allocated reass structures
242   u16 ip6_reass_conf_lifetime_ms; //Time a reassembly struct is considered valid in ms
243   u32 ip6_reass_conf_buffers; //Maximum number of buffers used by ip6 reassembly
244
245   //Runtime
246   map_ip6_reass_t *ip6_reass_pool;
247   u8 ip6_reass_ht_log2len; //Hash table size is 2^log2len
248   u16 ip6_reass_allocated;
249   u16 *ip6_reass_hash_table;
250   u16 ip6_reass_fifo_last;
251   volatile u32 *ip6_reass_lock;
252
253   //Counters
254   u32 ip6_reass_buffered_counter;
255
256 } map_main_t;
257
258 /*
259  * TODO: Remove SEC_CHECK / TRANSLATED_4TO6 / TRANSLATED_6TO4
260  */
261 #define foreach_map_error                               \
262   /* Must be first. */                                  \
263  _(NONE, "valid MAP packets")                           \
264  _(BAD_PROTOCOL, "bad protocol")                        \
265  _(WRONG_ICMP_TYPE, "wrong icmp type")                  \
266  _(SEC_CHECK, "security check failed")                  \
267  _(ENCAP_SEC_CHECK, "encap security check failed")      \
268  _(DECAP_SEC_CHECK, "decap security check failed")      \
269  _(ICMP, "unable to translate ICMP")                    \
270  _(ICMP_RELAY, "unable to relay ICMP")                  \
271  _(UNKNOWN, "unknown")                                  \
272  _(NO_DOMAIN, "no domain")                              \
273  _(FRAGMENTED, "packet is a fragment")                  \
274  _(FRAGMENT_MEMORY, "could not cache fragment")         \
275  _(FRAGMENT_MALFORMED, "fragment has unexpected format")\
276  _(FRAGMENT_DROPPED, "dropped cached fragment")         \
277  _(MALFORMED, "malformed packet")                       \
278  _(IP4_ERROR_TIME_EXPIRED, "time expired")
279
280 typedef enum {
281 #define _(sym,str) MAP_ERROR_##sym,
282    foreach_map_error
283 #undef _
284    MAP_N_ERROR,
285  } map_error_t;
286
287 u64 map_error_counter_get(u32 node_index, map_error_t map_error);
288
289 typedef struct {
290   u32 map_domain_index;
291   u16 port;
292 } map_trace_t;
293
294 map_main_t map_main;
295
296 vlib_node_registration_t ip4_map_node;
297 vlib_node_registration_t ip6_map_node;
298
299 vlib_node_registration_t ip4_map_t_node;
300 vlib_node_registration_t ip4_map_t_fragmented_node;
301 vlib_node_registration_t ip4_map_t_tcp_udp_node;
302 vlib_node_registration_t ip4_map_t_icmp_node;
303
304 vlib_node_registration_t ip6_map_t_node;
305 vlib_node_registration_t ip6_map_t_fragmented_node;
306 vlib_node_registration_t ip6_map_t_tcp_udp_node;
307 vlib_node_registration_t ip6_map_t_icmp_node;
308
309 /*
310  * map_get_pfx
311  */
312 static_always_inline u64
313 map_get_pfx (map_domain_t *d, u32 addr, u16 port)
314 {
315   u16 psid = (port >> d->psid_shift) & d->psid_mask;
316
317   if (d->ea_bits_len == 0 && d->rules)
318     return clib_net_to_host_u64(d->rules[psid].as_u64[0]);
319
320   u32 suffix = (addr >> d->suffix_shift) & d->suffix_mask;
321   u64 ea = d->ea_bits_len == 0 ? 0 : (((u64) suffix << d->psid_length)) | psid;
322
323   return clib_net_to_host_u64(d->ip6_prefix.as_u64[0]) | ea << d->ea_shift;
324 }
325
326 static_always_inline u64
327 map_get_pfx_net (map_domain_t *d, u32 addr, u16 port)
328 {
329   return clib_host_to_net_u64(map_get_pfx(d, clib_net_to_host_u32(addr),
330                                           clib_net_to_host_u16(port)));
331 }
332
333 /*
334  * map_get_sfx
335  */
336 static_always_inline u64
337 map_get_sfx (map_domain_t *d, u32 addr, u16 port)
338 {
339   u16 psid = (port >> d->psid_shift) & d->psid_mask;
340
341   /* Shared 1:1 mode. */
342   if (d->ea_bits_len == 0 && d->rules)
343     return clib_net_to_host_u64(d->rules[psid].as_u64[1]);
344   if (d->ip6_prefix_len == 128)
345     return clib_net_to_host_u64(d->ip6_prefix.as_u64[1]);
346
347   /* IPv4 prefix */
348   if (d->flags & MAP_DOMAIN_PREFIX)
349     return (u64) (addr & ~d->suffix_mask) << 16;
350
351   /* Shared or full IPv4 address */
352   return ((u64) addr << 16) | psid;
353 }
354
355 static_always_inline u64
356 map_get_sfx_net (map_domain_t *d, u32 addr, u16 port)
357 {
358   return clib_host_to_net_u64(map_get_sfx(d, clib_net_to_host_u32(addr),
359                                           clib_net_to_host_u16(port)));
360 }
361
362 static_always_inline u32
363 map_get_ip4 (ip6_address_t *addr)
364 {
365   return clib_host_to_net_u32(clib_net_to_host_u64(addr->as_u64[1]) >> 16);
366 }
367
368 /*
369  * Get the MAP domain from an IPv4 lookup adjacency.
370  */
371 static_always_inline map_domain_t *
372 ip4_map_get_domain (u32 adj_index, u32 *map_domain_index)
373 {
374   map_main_t *mm = &map_main;
375   ip_lookup_main_t *lm = &ip4_main.lookup_main;
376   ip_adjacency_t *adj = ip_get_adjacency(lm, adj_index);
377   ASSERT(adj);
378   uword *p = (uword *)adj->rewrite_data;
379   ASSERT(p);
380   *map_domain_index = p[0];
381   return pool_elt_at_index(mm->domains, p[0]);
382 }
383
384 /*
385  * Get the MAP domain from an IPv6 lookup adjacency.
386  * If the IPv6 address or prefix is not shared, no lookup is required.
387  * The IPv4 address is used otherwise.
388  */
389 static_always_inline map_domain_t *
390 ip6_map_get_domain (u32 adj_index, ip4_address_t *addr,
391                     u32 *map_domain_index, u8 *error)
392 {
393   map_main_t *mm = &map_main;
394   ip4_main_t *im4 = &ip4_main;
395   ip_lookup_main_t *lm4 = &ip4_main.lookup_main;
396
397   /*
398    * Disable direct MAP domain lookup on decap, until the security check is updated to verify IPv4 SA.
399    * (That's done implicitly when MAP domain is looked up in the IPv4 FIB)
400    */
401 #ifdef MAP_NONSHARED_DOMAIN_ENABLED
402   ip_lookup_main_t *lm6 = &ip6_main.lookup_main;
403   ip_adjacency_t *adj = ip_get_adjacency(lm6, adj_index);
404   ASSERT(adj);
405   uword *p = (uword *)adj->rewrite_data;
406   ASSERT(p);
407   *map_domain_index = p[0];
408   if (p[0] != ~0)
409     return pool_elt_at_index(mm->domains, p[0]);
410 #endif
411
412   u32 ai = ip4_fib_lookup_with_table(im4, 0, addr, 0);
413   ip_adjacency_t *adj4 = ip_get_adjacency (lm4, ai);
414   if (PREDICT_TRUE(adj4->lookup_next_index == IP_LOOKUP_NEXT_MAP ||
415                    adj4->lookup_next_index == IP_LOOKUP_NEXT_MAP_T)) {
416     uword *p = (uword *)adj4->rewrite_data;
417     *map_domain_index = p[0];
418     return pool_elt_at_index(mm->domains, *map_domain_index);
419   }
420   *error = MAP_ERROR_NO_DOMAIN;
421   return NULL;
422 }
423
424 map_ip4_reass_t *
425 map_ip4_reass_get(u32 src, u32 dst, u16 fragment_id,
426                   u8 protocol, u32 **pi_to_drop);
427 void
428 map_ip4_reass_free(map_ip4_reass_t *r, u32 **pi_to_drop);
429
430 #define map_ip4_reass_lock() while (__sync_lock_test_and_set(map_main.ip4_reass_lock, 1)) {}
431 #define map_ip4_reass_unlock() do {CLIB_MEMORY_BARRIER(); *map_main.ip4_reass_lock = 0;} while(0)
432
433 static_always_inline void
434 map_ip4_reass_get_fragments(map_ip4_reass_t *r, u32 **pi)
435 {
436   int i;
437   for (i=0; i<MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY; i++)
438     if(r->fragments[i] != ~0) {
439       vec_add1(*pi, r->fragments[i]);
440       r->fragments[i] = ~0;
441       map_main.ip4_reass_buffered_counter--;
442     }
443 }
444
445 int map_ip4_reass_add_fragment(map_ip4_reass_t *r, u32 pi);
446
447 map_ip6_reass_t *
448 map_ip6_reass_get(ip6_address_t *src, ip6_address_t *dst, u32 fragment_id,
449                   u8 protocol, u32 **pi_to_drop);
450 void
451 map_ip6_reass_free(map_ip6_reass_t *r, u32 **pi_to_drop);
452
453 #define map_ip6_reass_lock() while (__sync_lock_test_and_set(map_main.ip6_reass_lock, 1)) {}
454 #define map_ip6_reass_unlock() do {CLIB_MEMORY_BARRIER(); *map_main.ip6_reass_lock = 0;} while(0)
455
456 int
457 map_ip6_reass_add_fragment(map_ip6_reass_t *r, u32 pi,
458                            u16 data_offset, u16 next_data_offset,
459                            u8 *data_start, u16 data_len);
460
461 void map_ip4_drop_pi(u32 pi);
462
463 int map_ip4_reass_conf_ht_ratio(f32 ht_ratio, u32 *trashed_reass, u32 *dropped_packets);
464 #define MAP_IP4_REASS_CONF_HT_RATIO_MAX 100
465 int map_ip4_reass_conf_pool_size(u16 pool_size, u32 *trashed_reass, u32 *dropped_packets);
466 #define MAP_IP4_REASS_CONF_POOL_SIZE_MAX (0xfeff)
467 int map_ip4_reass_conf_lifetime(u16 lifetime_ms);
468 #define MAP_IP4_REASS_CONF_LIFETIME_MAX 0xffff
469 int map_ip4_reass_conf_buffers(u32 buffers);
470 #define MAP_IP4_REASS_CONF_BUFFERS_MAX (0xffffffff)
471
472 void map_ip6_drop_pi(u32 pi);
473
474
475 int map_ip6_reass_conf_ht_ratio(f32 ht_ratio, u32 *trashed_reass, u32 *dropped_packets);
476 #define MAP_IP6_REASS_CONF_HT_RATIO_MAX 100
477 int map_ip6_reass_conf_pool_size(u16 pool_size, u32 *trashed_reass, u32 *dropped_packets);
478 #define MAP_IP6_REASS_CONF_POOL_SIZE_MAX (0xfeff)
479 int map_ip6_reass_conf_lifetime(u16 lifetime_ms);
480 #define MAP_IP6_REASS_CONF_LIFETIME_MAX 0xffff
481 int map_ip6_reass_conf_buffers(u32 buffers);
482 #define MAP_IP6_REASS_CONF_BUFFERS_MAX (0xffffffff)
483
484 static_always_inline
485 int ip6_parse(const ip6_header_t *ip6, u32 buff_len,
486               u8 *l4_protocol, u16 *l4_offset, u16 *frag_hdr_offset)
487 {
488   if (ip6->protocol == IP_PROTOCOL_IPV6_FRAGMENTATION) {
489     *l4_protocol = ((ip6_frag_hdr_t *)(ip6 + 1))->next_hdr;
490     *frag_hdr_offset = sizeof(*ip6);
491     *l4_offset = sizeof(*ip6) + sizeof(ip6_frag_hdr_t);
492   } else {
493     *l4_protocol = ip6->protocol;
494     *frag_hdr_offset = 0;
495     *l4_offset = sizeof(*ip6);
496   }
497
498   return (buff_len < (*l4_offset + 4)) ||
499       (clib_net_to_host_u16(ip6->payload_length) < (*l4_offset + 4 - sizeof(*ip6)));
500 }
501
502
503 #define u8_ptr_add(ptr, index) (((u8 *)ptr) + index)
504 #define u16_net_add(u, val) clib_host_to_net_u16(clib_net_to_host_u16(u) + (val))
505
506 #define frag_id_6to4(id) ((id) ^ ((id) >> 16))
507
508 static_always_inline void
509 ip4_map_t_embedded_address (map_domain_t *d,
510                                 ip6_address_t *ip6, const ip4_address_t *ip4)
511 {
512   ASSERT(d->ip6_src_len == 96); //No support for other lengths for now
513   ip6->as_u64[0] = d->ip6_src.as_u64[0];
514   ip6->as_u32[2] = d->ip6_src.as_u32[2];
515   ip6->as_u32[3] = ip4->as_u32;
516 }
517
518 static_always_inline u32
519 ip6_map_t_embedded_address (map_domain_t *d, ip6_address_t *addr)
520 {
521   ASSERT(d->ip6_src_len == 96); //No support for other lengths for now
522   return addr->as_u32[3];
523 }
524
525 static inline void
526 map_domain_counter_lock (map_main_t *mm)
527 {
528   if (mm->counter_lock)
529     while (__sync_lock_test_and_set(mm->counter_lock, 1))
530       /* zzzz */ ;
531 }
532 static inline void
533 map_domain_counter_unlock (map_main_t *mm)
534 {
535   if (mm->counter_lock)
536     *mm->counter_lock = 0;
537 }
538
539
540 static_always_inline void
541 map_send_all_to_node(vlib_main_t *vm, u32 *pi_vector,
542                      vlib_node_runtime_t *node, vlib_error_t *error,
543                      u32 next)
544 {
545   u32 n_left_from, *from, next_index, *to_next, n_left_to_next;
546   //Deal with fragments that are ready
547   from = pi_vector;
548   n_left_from = vec_len(pi_vector);
549   next_index = node->cached_next_index;
550   while (n_left_from > 0) {
551     vlib_get_next_frame(vm, node, next_index, to_next, n_left_to_next);
552     while (n_left_from > 0 && n_left_to_next > 0) {
553       u32 pi0 = to_next[0] = from[0];
554       from += 1;
555       n_left_from -= 1;
556       to_next += 1;
557       n_left_to_next -= 1;
558       vlib_buffer_t *p0 = vlib_get_buffer(vm, pi0);
559       p0->error = *error;
560       vlib_validate_buffer_enqueue_x1(vm, node, next_index, to_next, n_left_to_next, pi0, next);
561     }
562     vlib_put_next_frame(vm, node, next_index, n_left_to_next);
563   }
564 }