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