VCL: Refactor VCL test (part 1)
[vpp.git] / src / 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 #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>
25
26 #define MAP_SKIP_IP6_LOOKUP 1
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,
35                       u8 is_add);
36 u8 *format_map_trace (u8 * s, va_list * args);
37
38 typedef enum
39 {
40   MAP_DOMAIN_PREFIX = 1 << 0,
41   MAP_DOMAIN_TRANSLATION = 1 << 1,      // The domain uses MAP-T
42   MAP_DOMAIN_RFC6052 = 1 << 2,
43 } __attribute__ ((__packed__)) 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 {
83   /* Required for pool_get_aligned */
84   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
85   ip6_address_t ip6_src;
86   ip6_address_t ip6_prefix;
87   ip6_address_t *rules;
88   u32 suffix_mask;
89   ip4_address_t ip4_prefix;
90   u16 psid_mask;
91   u16 mtu;
92   map_domain_flags_e flags;
93   u8 ip6_prefix_len;
94   u8 ip6_src_len;
95   u8 ea_bits_len;
96   u8 psid_offset;
97   u8 psid_length;
98
99   /* helpers */
100   u8 psid_shift;
101   u8 suffix_shift;
102   u8 ea_shift;
103
104   /* not used by forwarding */
105   u8 ip4_prefix_len;
106 } map_domain_t;
107
108 STATIC_ASSERT ((sizeof (map_domain_t) <= CLIB_CACHE_LINE_BYTES),
109                "MAP domain fits in one cacheline");
110
111 #define MAP_REASS_INDEX_NONE ((u16)0xffff)
112
113 /*
114  * Hash key, padded out to 16 bytes for fast compare
115  */
116 /* *INDENT-OFF* */
117 typedef union {
118   CLIB_PACKED (struct {
119     ip4_address_t src;
120     ip4_address_t dst;
121     u16 fragment_id;
122     u8 protocol;
123   });
124   u64 as_u64[2];
125   u32 as_u32[4];
126 } map_ip4_reass_key_t;
127 /* *INDENT-ON* */
128
129 typedef struct
130 {
131   map_ip4_reass_key_t key;
132   f64 ts;
133 #ifdef MAP_IP4_REASS_COUNT_BYTES
134   u16 expected_total;
135   u16 forwarded;
136 #endif
137   i32 port;
138   u16 bucket;
139   u16 bucket_next;
140   u16 fifo_prev;
141   u16 fifo_next;
142   u32 fragments[MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY];
143 } map_ip4_reass_t;
144
145 /*
146  * MAP domain counters
147  */
148 typedef enum
149 {
150   /* Simple counters */
151   MAP_DOMAIN_IPV4_FRAGMENT = 0,
152   /* Combined counters */
153   MAP_DOMAIN_COUNTER_RX = 0,
154   MAP_DOMAIN_COUNTER_TX,
155   MAP_N_DOMAIN_COUNTER
156 } map_domain_counter_t;
157
158 /*
159  * main_main_t
160  */
161 /* *INDENT-OFF* */
162 typedef union {
163   CLIB_PACKED (struct {
164     ip6_address_t src;
165     ip6_address_t dst;
166     u32 fragment_id;
167     u8 protocol;
168   });
169   u64 as_u64[5];
170   u32 as_u32[10];
171 } map_ip6_reass_key_t;
172 /* *INDENT-OFF* */
173
174 typedef struct {
175   u32 pi; //Cached packet or ~0
176   u16 next_data_offset; //The data offset of the additional 20 bytes or ~0
177   u8 next_data_len; //Number of bytes ready to be copied (20 if not last fragment)
178   u8 next_data[20]; //The 20 additional bytes
179 } map_ip6_fragment_t;
180
181 typedef struct {
182   map_ip6_reass_key_t key;
183   f64 ts;
184 #ifdef MAP_IP6_REASS_COUNT_BYTES
185   u16 expected_total;
186   u16 forwarded;
187 #endif
188   u16 bucket; //What hash bucket this element is linked in
189   u16 bucket_next;
190   u16 fifo_prev;
191   u16 fifo_next;
192   ip4_header_t ip4_header;
193   map_ip6_fragment_t fragments[MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY];
194 } map_ip6_reass_t;
195
196 #ifdef MAP_SKIP_IP6_LOOKUP
197 /**
198  * A pre-resolved next-hop
199  */
200 typedef struct map_main_pre_resolved_t_
201 {
202   /**
203    * Linkage into the FIB graph
204    */
205   fib_node_t node;
206
207   /**
208    * The FIB entry index of the next-hop
209    */
210   fib_node_index_t fei;
211
212   /**
213    * This object sibling index on the FIB entry's child dependency list
214    */
215   u32 sibling;
216
217   /**
218    * The Load-balance object index to use to forward
219    */
220   dpo_id_t dpo;
221 } map_main_pre_resolved_t;
222
223 /**
224  * Pre-resolved next hops for v4 and v6. Why these are global and not
225  * per-domain is beyond me.
226  */
227 extern map_main_pre_resolved_t pre_resolved[FIB_PROTOCOL_MAX];
228 #endif
229
230 typedef struct {
231   /* pool of MAP domains */
232   map_domain_t *domains;
233
234   /* MAP Domain packet/byte counters indexed by map domain index */
235   vlib_simple_counter_main_t *simple_domain_counters;
236   vlib_combined_counter_main_t *domain_counters;
237   volatile u32 *counter_lock;
238
239   /* Traffic class: zero, copy (~0) or fixed value */
240   u8 tc;
241   bool tc_copy;
242
243   bool sec_check;               /* Inbound security check */
244   bool sec_check_frag;          /* Inbound security check for (subsequent) fragments */
245   bool icmp6_enabled;           /* Send destination unreachable for security check failure */
246
247   bool is_ce;                   /* If this MAP node is a Customer Edge router*/
248
249   /* ICMPv6 -> ICMPv4 relay parameters */
250   ip4_address_t icmp4_src_address;
251   vlib_simple_counter_main_t icmp_relayed;
252
253   /* convenience */
254   vlib_main_t *vlib_main;
255   vnet_main_t *vnet_main;
256
257   /*
258    * IPv4 encap and decap reassembly
259    */
260   /* Configuration */
261   f32 ip4_reass_conf_ht_ratio; //Size of ht is 2^ceil(log2(ratio*pool_size))
262   u16 ip4_reass_conf_pool_size; //Max number of allocated reass structures
263   u16 ip4_reass_conf_lifetime_ms; //Time a reassembly struct is considered valid in ms
264   u32 ip4_reass_conf_buffers; //Maximum number of buffers used by ip4 reassembly
265
266   /* Runtime */
267   map_ip4_reass_t *ip4_reass_pool;
268   u8 ip4_reass_ht_log2len; //Hash table size is 2^log2len
269   u16 ip4_reass_allocated;
270   u16 *ip4_reass_hash_table;
271   u16 ip4_reass_fifo_last;
272   volatile u32 *ip4_reass_lock;
273
274   /* Counters */
275   u32 ip4_reass_buffered_counter;
276
277   bool frag_inner;              /* Inner or outer fragmentation */
278   bool frag_ignore_df;          /* Fragment (outer) packet even if DF is set */
279
280   /*
281    * IPv6 decap reassembly
282    */
283   /* Configuration */
284   f32 ip6_reass_conf_ht_ratio; //Size of ht is 2^ceil(log2(ratio*pool_size))
285   u16 ip6_reass_conf_pool_size; //Max number of allocated reass structures
286   u16 ip6_reass_conf_lifetime_ms; //Time a reassembly struct is considered valid in ms
287   u32 ip6_reass_conf_buffers; //Maximum number of buffers used by ip6 reassembly
288
289   /* Runtime */
290   map_ip6_reass_t *ip6_reass_pool;
291   u8 ip6_reass_ht_log2len; //Hash table size is 2^log2len
292   u16 ip6_reass_allocated;
293   u16 *ip6_reass_hash_table;
294   u16 ip6_reass_fifo_last;
295   volatile u32 *ip6_reass_lock;
296
297   /* Counters */
298   u32 ip6_reass_buffered_counter;
299
300 } map_main_t;
301
302 /*
303  * MAP Error counters/messages
304  */
305 #define foreach_map_error                               \
306   /* Must be first. */                                  \
307  _(NONE, "valid MAP packets")                           \
308  _(BAD_PROTOCOL, "bad protocol")                        \
309  _(SEC_CHECK, "security check failed")                  \
310  _(ENCAP_SEC_CHECK, "encap security check failed")      \
311  _(DECAP_SEC_CHECK, "decap security check failed")      \
312  _(ICMP, "unable to translate ICMP")                    \
313  _(ICMP_RELAY, "unable to relay ICMP")                  \
314  _(UNKNOWN, "unknown")                                  \
315  _(NO_BINDING, "no binding")                            \
316  _(NO_DOMAIN, "no domain")                              \
317  _(FRAGMENTED, "packet is a fragment")                  \
318  _(FRAGMENT_MEMORY, "could not cache fragment")         \
319  _(FRAGMENT_MALFORMED, "fragment has unexpected format")\
320  _(FRAGMENT_DROPPED, "dropped cached fragment")         \
321  _(MALFORMED, "malformed packet")                       \
322  _(DF_SET, "can't fragment, DF set")
323
324 typedef enum {
325 #define _(sym,str) MAP_ERROR_##sym,
326    foreach_map_error
327 #undef _
328    MAP_N_ERROR,
329  } map_error_t;
330
331 u64 map_error_counter_get(u32 node_index, map_error_t map_error);
332
333 typedef struct {
334   u32 map_domain_index;
335   u16 port;
336 } map_trace_t;
337
338 extern map_main_t map_main;
339
340 extern vlib_node_registration_t ip4_map_node;
341 extern vlib_node_registration_t ip6_map_node;
342
343 extern vlib_node_registration_t ip4_map_t_node;
344 extern vlib_node_registration_t ip4_map_t_fragmented_node;
345 extern vlib_node_registration_t ip4_map_t_tcp_udp_node;
346 extern vlib_node_registration_t ip4_map_t_icmp_node;
347
348 extern vlib_node_registration_t ip6_map_t_node;
349 extern vlib_node_registration_t ip6_map_t_fragmented_node;
350 extern vlib_node_registration_t ip6_map_t_tcp_udp_node;
351 extern vlib_node_registration_t ip6_map_t_icmp_node;
352
353 /*
354  * map_get_pfx
355  */
356 static_always_inline u64
357 map_get_pfx (map_domain_t *d, u32 addr, u16 port)
358 {
359   u16 psid = (port >> d->psid_shift) & d->psid_mask;
360
361   if (d->ea_bits_len == 0 && d->rules)
362     return clib_net_to_host_u64(d->rules[psid].as_u64[0]);
363
364   u32 suffix = (addr >> d->suffix_shift) & d->suffix_mask;
365   u64 ea = d->ea_bits_len == 0 ? 0 : (((u64) suffix << d->psid_length)) | psid;
366
367   return clib_net_to_host_u64(d->ip6_prefix.as_u64[0]) | ea << d->ea_shift;
368 }
369
370 static_always_inline u64
371 map_get_pfx_net (map_domain_t *d, u32 addr, u16 port)
372 {
373   return clib_host_to_net_u64(map_get_pfx(d, clib_net_to_host_u32(addr),
374                                           clib_net_to_host_u16(port)));
375 }
376
377 /*
378  * map_get_sfx
379  */
380 static_always_inline u64
381 map_get_sfx (map_domain_t *d, u32 addr, u16 port)
382 {
383   u16 psid = (port >> d->psid_shift) & d->psid_mask;
384
385   /* Shared 1:1 mode. */
386   if (d->ea_bits_len == 0 && d->rules)
387     return clib_net_to_host_u64(d->rules[psid].as_u64[1]);
388   if (d->ip6_prefix_len == 128)
389     return clib_net_to_host_u64(d->ip6_prefix.as_u64[1]);
390
391   if (d->flags & MAP_DOMAIN_RFC6052)
392     return (clib_net_to_host_u64(d->ip6_prefix.as_u64[1]) | addr);
393
394   /* IPv4 prefix */
395   if (d->flags & MAP_DOMAIN_PREFIX)
396     return (u64) (addr & (0xFFFFFFFF << d->suffix_shift)) << 16;
397
398   /* Shared or full IPv4 address */
399   return ((u64) addr << 16) | psid;
400 }
401
402 static_always_inline u64
403 map_get_sfx_net (map_domain_t *d, u32 addr, u16 port)
404 {
405   return clib_host_to_net_u64(map_get_sfx(d, clib_net_to_host_u32(addr),
406                                           clib_net_to_host_u16(port)));
407 }
408
409 static_always_inline u32
410 map_get_ip4 (ip6_address_t *addr, map_domain_flags_e flags)
411 {
412   if (flags & MAP_DOMAIN_RFC6052)
413     return clib_host_to_net_u32(clib_net_to_host_u64(addr->as_u64[1]));
414   else
415     return clib_host_to_net_u32(clib_net_to_host_u64(addr->as_u64[1]) >> 16);
416 }
417
418 /*
419  * Get the MAP domain from an IPv4 lookup adjacency.
420  */
421 static_always_inline map_domain_t *
422 ip4_map_get_domain (u32 mdi)
423 {
424   map_main_t *mm = &map_main;
425
426   return pool_elt_at_index(mm->domains, mdi);
427 }
428
429 /*
430  * Get the MAP domain from an IPv6 lookup adjacency.
431  * If the IPv6 address or prefix is not shared, no lookup is required.
432  * The IPv4 address is used otherwise.
433  */
434 static_always_inline map_domain_t *
435 ip6_map_get_domain (u32 mdi,
436                     ip4_address_t *addr,
437                     u32 *map_domain_index,
438                     u8 *error)
439 {
440   map_main_t *mm = &map_main;
441
442 #ifdef TODO
443   /*
444    * Disable direct MAP domain lookup on decap, until the security check is updated to verify IPv4 SA.
445    * (That's done implicitly when MAP domain is looked up in the IPv4 FIB)
446    */
447   //#ifdef MAP_NONSHARED_DOMAIN_ENABLED
448   //#error "How can you be sure this domain is not shared?"
449 #endif
450
451   *map_domain_index = mdi;
452   return pool_elt_at_index(mm->domains, mdi);
453
454 #ifdef TODO
455   u32 lbi = ip4_fib_forwarding_lookup(0, addr);
456   const dpo_id_t *dpo = load_balance_get_bucket(lbi, 0);
457   if (PREDICT_TRUE(dpo->dpoi_type == map_dpo_type ||
458                    dpo->dpoi_type == map_t_dpo_type))
459     {
460       *map_domain_index = dpo->dpoi_index;
461       return pool_elt_at_index(mm->domains, *map_domain_index);
462     }
463   *error = MAP_ERROR_NO_DOMAIN;
464   return NULL;
465 #endif
466 }
467
468 map_ip4_reass_t *
469 map_ip4_reass_get(u32 src, u32 dst, u16 fragment_id,
470                   u8 protocol, u32 **pi_to_drop);
471 void
472 map_ip4_reass_free(map_ip4_reass_t *r, u32 **pi_to_drop);
473
474 #define map_ip4_reass_lock() while (__sync_lock_test_and_set(map_main.ip4_reass_lock, 1)) {}
475 #define map_ip4_reass_unlock() do {CLIB_MEMORY_BARRIER(); *map_main.ip4_reass_lock = 0;} while(0)
476
477 static_always_inline void
478 map_ip4_reass_get_fragments(map_ip4_reass_t *r, u32 **pi)
479 {
480   int i;
481   for (i=0; i<MAP_IP4_REASS_MAX_FRAGMENTS_PER_REASSEMBLY; i++)
482     if(r->fragments[i] != ~0) {
483       vec_add1(*pi, r->fragments[i]);
484       r->fragments[i] = ~0;
485       map_main.ip4_reass_buffered_counter--;
486     }
487 }
488
489 int map_ip4_reass_add_fragment(map_ip4_reass_t *r, u32 pi);
490
491 map_ip6_reass_t *
492 map_ip6_reass_get(ip6_address_t *src, ip6_address_t *dst, u32 fragment_id,
493                   u8 protocol, u32 **pi_to_drop);
494 void
495 map_ip6_reass_free(map_ip6_reass_t *r, u32 **pi_to_drop);
496
497 #define map_ip6_reass_lock() while (__sync_lock_test_and_set(map_main.ip6_reass_lock, 1)) {}
498 #define map_ip6_reass_unlock() do {CLIB_MEMORY_BARRIER(); *map_main.ip6_reass_lock = 0;} while(0)
499
500 int
501 map_ip6_reass_add_fragment(map_ip6_reass_t *r, u32 pi,
502                            u16 data_offset, u16 next_data_offset,
503                            u8 *data_start, u16 data_len);
504
505 void map_ip4_drop_pi(u32 pi);
506
507 int map_ip4_reass_conf_ht_ratio(f32 ht_ratio, u32 *trashed_reass, u32 *dropped_packets);
508 #define MAP_IP4_REASS_CONF_HT_RATIO_MAX 100
509 int map_ip4_reass_conf_pool_size(u16 pool_size, u32 *trashed_reass, u32 *dropped_packets);
510 #define MAP_IP4_REASS_CONF_POOL_SIZE_MAX (0xfeff)
511 int map_ip4_reass_conf_lifetime(u16 lifetime_ms);
512 #define MAP_IP4_REASS_CONF_LIFETIME_MAX 0xffff
513 int map_ip4_reass_conf_buffers(u32 buffers);
514 #define MAP_IP4_REASS_CONF_BUFFERS_MAX (0xffffffff)
515
516 void map_ip6_drop_pi(u32 pi);
517
518
519 int map_ip6_reass_conf_ht_ratio(f32 ht_ratio, u32 *trashed_reass, u32 *dropped_packets);
520 #define MAP_IP6_REASS_CONF_HT_RATIO_MAX 100
521 int map_ip6_reass_conf_pool_size(u16 pool_size, u32 *trashed_reass, u32 *dropped_packets);
522 #define MAP_IP6_REASS_CONF_POOL_SIZE_MAX (0xfeff)
523 int map_ip6_reass_conf_lifetime(u16 lifetime_ms);
524 #define MAP_IP6_REASS_CONF_LIFETIME_MAX 0xffff
525 int map_ip6_reass_conf_buffers(u32 buffers);
526 #define MAP_IP6_REASS_CONF_BUFFERS_MAX (0xffffffff)
527
528 static_always_inline void
529 ip4_map_t_embedded_address (map_domain_t *d,
530                                 ip6_address_t *ip6, const ip4_address_t *ip4)
531 {
532   ASSERT(d->ip6_src_len == 96); //No support for other lengths for now
533   ip6->as_u64[0] = d->ip6_src.as_u64[0];
534   ip6->as_u32[2] = d->ip6_src.as_u32[2];
535   ip6->as_u32[3] = ip4->as_u32;
536 }
537
538 static_always_inline u32
539 ip6_map_t_embedded_address (map_domain_t *d, ip6_address_t *addr)
540 {
541   ASSERT(d->ip6_src_len == 96); //No support for other lengths for now
542   return addr->as_u32[3];
543 }
544
545 static inline void
546 map_domain_counter_lock (map_main_t *mm)
547 {
548   if (mm->counter_lock)
549     while (__sync_lock_test_and_set(mm->counter_lock, 1))
550       /* zzzz */ ;
551 }
552 static inline void
553 map_domain_counter_unlock (map_main_t *mm)
554 {
555   if (mm->counter_lock)
556     *mm->counter_lock = 0;
557 }
558
559
560 static_always_inline void
561 map_send_all_to_node(vlib_main_t *vm, u32 *pi_vector,
562                      vlib_node_runtime_t *node, vlib_error_t *error,
563                      u32 next)
564 {
565   u32 n_left_from, *from, next_index, *to_next, n_left_to_next;
566   //Deal with fragments that are ready
567   from = pi_vector;
568   n_left_from = vec_len(pi_vector);
569   next_index = node->cached_next_index;
570   while (n_left_from > 0) {
571     vlib_get_next_frame(vm, node, next_index, to_next, n_left_to_next);
572     while (n_left_from > 0 && n_left_to_next > 0) {
573       u32 pi0 = to_next[0] = from[0];
574       from += 1;
575       n_left_from -= 1;
576       to_next += 1;
577       n_left_to_next -= 1;
578       vlib_buffer_t *p0 = vlib_get_buffer(vm, pi0);
579       p0->error = *error;
580       vlib_validate_buffer_enqueue_x1(vm, node, next_index, to_next, n_left_to_next, pi0, next);
581     }
582     vlib_put_next_frame(vm, node, next_index, n_left_to_next);
583   }
584 }
585
586 /*
587  * fd.io coding-style-patch-verification: ON
588  *
589  * Local Variables:
590  * eval: (c-set-style "gnu")
591  * End:
592  */