map: fix indent-off
[vpp.git] / src / plugins / 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/dpo/load_balance.h>
24 #include "lpm.h"
25 #include <vppinfra/lock.h>
26
27 #define MAP_SKIP_IP6_LOOKUP 1
28
29 #define MAP_ERR_GOOD                    0
30 #define MAP_ERR_BAD_POOL_SIZE           -1
31 #define MAP_ERR_BAD_HT_RATIO            -2
32 #define MAP_ERR_BAD_LIFETIME            -3
33 #define MAP_ERR_BAD_BUFFERS             -4
34 #define MAP_ERR_BAD_BUFFERS_TOO_LARGE   -5
35 #define MAP_ERR_UNSUPPORTED             -6
36
37 int map_create_domain (ip4_address_t * ip4_prefix, u8 ip4_prefix_len,
38                        ip6_address_t * ip6_prefix, u8 ip6_prefix_len,
39                        ip6_address_t * ip6_src, u8 ip6_src_len,
40                        u8 ea_bits_len, u8 psid_offset, u8 psid_length,
41                        u32 * map_domain_index, u16 mtu, u8 flags, u8 * tag);
42 int map_delete_domain (u32 map_domain_index);
43 int map_add_del_psid (u32 map_domain_index, u16 psid, ip6_address_t * tep,
44                       bool is_add);
45 int map_if_enable_disable (bool is_enable, u32 sw_if_index,
46                            bool is_translation);
47 u8 *format_map_trace (u8 * s, va_list * args);
48
49 int map_param_set_fragmentation (bool inner, bool ignore_df);
50 int map_param_set_icmp (ip4_address_t * ip4_err_relay_src);
51 int map_param_set_icmp6 (u8 enable_unreachable);
52 void map_pre_resolve (ip4_address_t * ip4, ip6_address_t * ip6, bool is_del);
53 int map_param_set_reassembly (bool is_ipv6, u16 lifetime_ms, u16 pool_size,
54                               u32 buffers, f64 ht_ratio, u32 * reass,
55                               u32 * packets);
56 int map_param_set_security_check (bool enable, bool fragments);
57 int map_param_set_traffic_class (bool copy, u8 tc);
58 int map_param_set_tcp (u16 tcp_mss);
59
60
61 typedef enum
62 {
63   MAP_DOMAIN_PREFIX = 1 << 0,
64   MAP_DOMAIN_TRANSLATION = 1 << 1,      // The domain uses MAP-T
65   MAP_DOMAIN_RFC6052 = 1 << 2,
66 } __attribute__ ((__packed__)) map_domain_flags_e;
67
68 #define MAP_IP6_REASS_LIFETIME_DEFAULT (100)    /* ms */
69 #define MAP_IP6_REASS_HT_RATIO_DEFAULT (1.0)
70 #define MAP_IP6_REASS_POOL_SIZE_DEFAULT 1024    // Number of reassembly structures
71 #define MAP_IP6_REASS_BUFFERS_DEFAULT 2048
72
73 #define MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY 5
74
75 #define MAP_IP6_REASS_COUNT_BYTES
76
77 //#define IP6_MAP_T_OVERRIDE_TOS 0
78
79 /*
80  * This structure _MUST_ be no larger than a single cache line (64 bytes).
81  * If more space is needed make a union of ip6_prefix and *rules, as
82  * those are mutually exclusive.
83  */
84 typedef struct
85 {
86   /* Required for pool_get_aligned */
87   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
88   ip6_address_t ip6_src;
89   ip6_address_t ip6_prefix;
90   ip6_address_t *rules;
91   u32 suffix_mask;
92   ip4_address_t ip4_prefix;
93   u16 psid_mask;
94   u16 mtu;
95   map_domain_flags_e flags;
96   u8 ip6_prefix_len;
97   u8 ip6_src_len;
98   u8 ea_bits_len;
99   u8 psid_offset;
100   u8 psid_length;
101
102   /* helpers */
103   u8 psid_shift;
104   u8 suffix_shift;
105   u8 ea_shift;
106
107   /* not used by forwarding */
108   u8 ip4_prefix_len;
109 } map_domain_t;
110
111 STATIC_ASSERT ((sizeof (map_domain_t) <= CLIB_CACHE_LINE_BYTES),
112                "MAP domain fits in one cacheline");
113
114 /*
115  * Extra data about a domain that doesn't need to be time/space critical.
116  * This structure is in a vector parallel to the main map_domain_t,
117  * and indexed by the same map-domain-index values.
118  */
119 typedef struct
120 {
121   u8 *tag;                      /* Probably a user-assigned domain name. */
122 } map_domain_extra_t;
123
124 #define MAP_REASS_INDEX_NONE ((u16)0xffff)
125
126 /*
127  * MAP domain counters
128  */
129 typedef enum
130 {
131   /* Simple counters */
132   MAP_DOMAIN_IPV4_FRAGMENT = 0,
133   /* Combined counters */
134   MAP_DOMAIN_COUNTER_RX = 0,
135   MAP_DOMAIN_COUNTER_TX,
136   MAP_N_DOMAIN_COUNTER
137 } map_domain_counter_t;
138
139 /*
140  * main_main_t
141  */
142 /* *INDENT-OFF* */
143 typedef union {
144   CLIB_PACKED (struct {
145     ip6_address_t src;
146     ip6_address_t dst;
147     u32 fragment_id;
148     u8 protocol;
149   });
150   u64 as_u64[5];
151   u32 as_u32[10];
152 } map_ip6_reass_key_t;
153 /* *INDENT-ON* */
154
155 typedef struct
156 {
157   u32 pi;                       //Cached packet or ~0
158   u16 next_data_offset;         //The data offset of the additional 20 bytes or ~0
159   u8 next_data_len;             //Number of bytes ready to be copied (20 if not last fragment)
160   u8 next_data[20];             //The 20 additional bytes
161 } map_ip6_fragment_t;
162
163 typedef struct
164 {
165   map_ip6_reass_key_t key;
166   f64 ts;
167 #ifdef MAP_IP6_REASS_COUNT_BYTES
168   u16 expected_total;
169   u16 forwarded;
170 #endif
171   u16 bucket;                   //What hash bucket this element is linked in
172   u16 bucket_next;
173   u16 fifo_prev;
174   u16 fifo_next;
175   ip4_header_t ip4_header;
176   map_ip6_fragment_t fragments[MAP_IP6_REASS_MAX_FRAGMENTS_PER_REASSEMBLY];
177 } map_ip6_reass_t;
178
179 #ifdef MAP_SKIP_IP6_LOOKUP
180 /**
181  * A pre-resolved next-hop
182  */
183 typedef struct map_main_pre_resolved_t_
184 {
185   /**
186    * Linkage into the FIB graph
187    */
188   fib_node_t node;
189
190   /**
191    * The FIB entry index of the next-hop
192    */
193   fib_node_index_t fei;
194
195   /**
196    * This object sibling index on the FIB entry's child dependency list
197    */
198   u32 sibling;
199
200   /**
201    * The Load-balance object index to use to forward
202    */
203   dpo_id_t dpo;
204 } map_main_pre_resolved_t;
205
206 /**
207  * Pre-resolved next hops for v4 and v6. Why these are global and not
208  * per-domain is beyond me.
209  */
210 extern map_main_pre_resolved_t pre_resolved[FIB_PROTOCOL_MAX];
211 #endif
212
213 typedef struct
214 {
215   /* pool of MAP domains */
216   map_domain_t *domains;
217   map_domain_extra_t *domain_extras;
218
219   /* MAP Domain packet/byte counters indexed by map domain index */
220   vlib_simple_counter_main_t *simple_domain_counters;
221   vlib_combined_counter_main_t *domain_counters;
222   volatile u32 *counter_lock;
223
224   /* API message id base */
225   u16 msg_id_base;
226
227   /* Traffic class: zero, copy (~0) or fixed value */
228   u8 tc;
229   bool tc_copy;
230
231   bool sec_check;               /* Inbound security check */
232   bool sec_check_frag;          /* Inbound security check for (subsequent) fragments */
233   bool icmp6_enabled;           /* Send destination unreachable for security check failure */
234
235   u16 tcp_mss;                  /* TCP MSS clamp value */
236
237   /* ICMPv6 -> ICMPv4 relay parameters */
238   ip4_address_t icmp4_src_address;
239   vlib_simple_counter_main_t icmp_relayed;
240
241   /* convenience */
242   vlib_main_t *vlib_main;
243   vnet_main_t *vnet_main;
244
245   bool frag_inner;              /* Inner or outer fragmentation */
246   bool frag_ignore_df;          /* Fragment (outer) packet even if DF is set */
247
248   /*
249    * IPv6 decap reassembly
250    */
251   /* Configuration */
252   f32 ip6_reass_conf_ht_ratio;  //Size of ht is 2^ceil(log2(ratio*pool_size))
253   u16 ip6_reass_conf_pool_size; //Max number of allocated reass structures
254   u16 ip6_reass_conf_lifetime_ms;       //Time a reassembly struct is considered valid in ms
255   u32 ip6_reass_conf_buffers;   //Maximum number of buffers used by ip6 reassembly
256
257   /* Runtime */
258   map_ip6_reass_t *ip6_reass_pool;
259   u8 ip6_reass_ht_log2len;      //Hash table size is 2^log2len
260   u16 ip6_reass_allocated;
261   u16 *ip6_reass_hash_table;
262   u16 ip6_reass_fifo_last;
263   clib_spinlock_t ip6_reass_lock;
264
265   /* Counters */
266   u32 ip6_reass_buffered_counter;
267
268   /* Graph node state */
269   uword *bm_trans_enabled_by_sw_if;
270   uword *bm_encap_enabled_by_sw_if;
271
272   /* Lookup tables */
273   lpm_t *ip4_prefix_tbl;
274   lpm_t *ip6_prefix_tbl;
275   lpm_t *ip6_src_prefix_tbl;
276
277   uword ip4_sv_reass_custom_next_index;
278 } map_main_t;
279
280 /*
281  * MAP Error counters/messages
282  */
283 #define foreach_map_error                               \
284   /* Must be first. */                                  \
285  _(NONE, "valid MAP packets")                           \
286  _(BAD_PROTOCOL, "bad protocol")                        \
287  _(SEC_CHECK, "security check failed")                  \
288  _(ENCAP_SEC_CHECK, "encap security check failed")      \
289  _(DECAP_SEC_CHECK, "decap security check failed")      \
290  _(ICMP, "unable to translate ICMP")                    \
291  _(ICMP_RELAY, "unable to relay ICMP")                  \
292  _(UNKNOWN, "unknown")                                  \
293  _(NO_BINDING, "no binding")                            \
294  _(NO_DOMAIN, "no domain")                              \
295  _(FRAGMENTED, "packet is a fragment")                  \
296  _(FRAGMENT_MEMORY, "could not cache fragment")         \
297  _(FRAGMENT_MALFORMED, "fragment has unexpected format")\
298  _(FRAGMENT_DROPPED, "dropped cached fragment")         \
299  _(MALFORMED, "malformed packet")                       \
300  _(DF_SET, "can't fragment, DF set")
301
302 typedef enum
303 {
304 #define _(sym,str) MAP_ERROR_##sym,
305   foreach_map_error
306 #undef _
307     MAP_N_ERROR,
308 } map_error_t;
309
310 u64 map_error_counter_get (u32 node_index, map_error_t map_error);
311
312 typedef struct
313 {
314   u32 map_domain_index;
315   u16 port;
316 } map_trace_t;
317
318 always_inline void
319 map_add_trace (vlib_main_t * vm, vlib_node_runtime_t * node,
320                vlib_buffer_t * b, u32 map_domain_index, u16 port)
321 {
322   map_trace_t *tr = vlib_add_trace (vm, node, b, sizeof (*tr));
323   tr->map_domain_index = map_domain_index;
324   tr->port = port;
325 }
326
327 extern map_main_t map_main;
328
329 extern vlib_node_registration_t ip4_map_node;
330 extern vlib_node_registration_t ip6_map_node;
331
332 extern vlib_node_registration_t ip4_map_t_node;
333 extern vlib_node_registration_t ip4_map_t_fragmented_node;
334 extern vlib_node_registration_t ip4_map_t_tcp_udp_node;
335 extern vlib_node_registration_t ip4_map_t_icmp_node;
336
337 extern vlib_node_registration_t ip6_map_t_node;
338 extern vlib_node_registration_t ip6_map_t_fragmented_node;
339 extern vlib_node_registration_t ip6_map_t_tcp_udp_node;
340 extern vlib_node_registration_t ip6_map_t_icmp_node;
341
342 /*
343  * map_get_pfx
344  */
345 static_always_inline u64
346 map_get_pfx (map_domain_t * d, u32 addr, u16 port)
347 {
348   u16 psid = (port >> d->psid_shift) & d->psid_mask;
349
350   if (d->ea_bits_len == 0 && d->rules)
351     return clib_net_to_host_u64 (d->rules[psid].as_u64[0]);
352
353   u32 suffix = (addr >> d->suffix_shift) & d->suffix_mask;
354   u64 ea =
355     d->ea_bits_len == 0 ? 0 : (((u64) suffix << d->psid_length)) | psid;
356
357   return clib_net_to_host_u64 (d->ip6_prefix.as_u64[0]) | ea << d->ea_shift;
358 }
359
360 static_always_inline u64
361 map_get_pfx_net (map_domain_t * d, u32 addr, u16 port)
362 {
363   return clib_host_to_net_u64 (map_get_pfx (d, clib_net_to_host_u32 (addr),
364                                             clib_net_to_host_u16 (port)));
365 }
366
367 /*
368  * map_get_sfx
369  */
370 static_always_inline u64
371 map_get_sfx (map_domain_t * d, u32 addr, u16 port)
372 {
373   u16 psid = (port >> d->psid_shift) & d->psid_mask;
374
375   /* Shared 1:1 mode. */
376   if (d->ea_bits_len == 0 && d->rules)
377     return clib_net_to_host_u64 (d->rules[psid].as_u64[1]);
378   if (d->ip6_prefix_len == 128)
379     return clib_net_to_host_u64 (d->ip6_prefix.as_u64[1]);
380
381   if (d->ip6_src_len == 96)
382     return (clib_net_to_host_u64 (d->ip6_prefix.as_u64[1]) | addr);
383
384   /* IPv4 prefix */
385   if (d->flags & MAP_DOMAIN_PREFIX)
386     return (u64) (addr & (0xFFFFFFFF << d->suffix_shift)) << 16;
387
388   /* Shared or full IPv4 address */
389   return ((u64) addr << 16) | psid;
390 }
391
392 static_always_inline u64
393 map_get_sfx_net (map_domain_t * d, u32 addr, u16 port)
394 {
395   return clib_host_to_net_u64 (map_get_sfx (d, clib_net_to_host_u32 (addr),
396                                             clib_net_to_host_u16 (port)));
397 }
398
399 static_always_inline u32
400 map_get_ip4 (ip6_address_t * addr, u16 prefix_len)
401 {
402   ASSERT (prefix_len == 64 || prefix_len == 96);
403   if (prefix_len == 96)
404     return clib_host_to_net_u32 (clib_net_to_host_u64 (addr->as_u64[1]));
405   else
406     return clib_host_to_net_u32 (clib_net_to_host_u64 (addr->as_u64[1]) >>
407                                  16);
408 }
409
410 static_always_inline map_domain_t *
411 ip4_map_get_domain (ip4_address_t * addr, u32 * map_domain_index, u8 * error)
412 {
413   map_main_t *mm = &map_main;
414
415   u32 mdi = mm->ip4_prefix_tbl->lookup (mm->ip4_prefix_tbl, addr, 32);
416   if (mdi == ~0)
417     {
418       *error = MAP_ERROR_NO_DOMAIN;
419       return 0;
420     }
421   *map_domain_index = mdi;
422   return pool_elt_at_index (mm->domains, mdi);
423 }
424
425 /*
426  * Get the MAP domain from an IPv6 address.
427  * If the IPv6 address or
428  * prefix is shared the IPv4 address must be used.
429  */
430 static_always_inline map_domain_t *
431 ip6_map_get_domain (ip6_address_t * addr, u32 * map_domain_index, u8 * error)
432 {
433   map_main_t *mm = &map_main;
434   u32 mdi =
435     mm->ip6_src_prefix_tbl->lookup (mm->ip6_src_prefix_tbl, addr, 128);
436   if (mdi == ~0)
437     {
438       *error = MAP_ERROR_NO_DOMAIN;
439       return 0;
440     }
441
442   *map_domain_index = mdi;
443   return pool_elt_at_index (mm->domains, mdi);
444 }
445
446 clib_error_t *map_plugin_api_hookup (vlib_main_t * vm);
447
448 map_ip6_reass_t *map_ip6_reass_get (ip6_address_t * src, ip6_address_t * dst,
449                                     u32 fragment_id, u8 protocol,
450                                     u32 ** pi_to_drop);
451 void map_ip6_reass_free (map_ip6_reass_t * r, u32 ** pi_to_drop);
452
453 #define map_ip6_reass_lock() clib_spinlock_lock (&map_main.ip6_reass_lock)
454 #define map_ip6_reass_unlock() clib_spinlock_unlock (&map_main.ip6_reass_lock)
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 void map_ip6_drop_pi (u32 pi);
464
465
466 int map_ip6_reass_conf_ht_ratio (f32 ht_ratio, u32 * trashed_reass,
467                                  u32 * dropped_packets);
468 #define MAP_IP6_REASS_CONF_HT_RATIO_MAX 100
469 int map_ip6_reass_conf_pool_size (u16 pool_size, u32 * trashed_reass,
470                                   u32 * dropped_packets);
471 #define MAP_IP6_REASS_CONF_POOL_SIZE_MAX (0xfeff)
472 int map_ip6_reass_conf_lifetime (u16 lifetime_ms);
473 #define MAP_IP6_REASS_CONF_LIFETIME_MAX 0xffff
474 int map_ip6_reass_conf_buffers (u32 buffers);
475 #define MAP_IP6_REASS_CONF_BUFFERS_MAX (0xffffffff)
476
477 /*
478  * Supports prefix of 96 or 64 (with u-octet)
479  */
480 static_always_inline void
481 ip4_map_t_embedded_address (map_domain_t * d,
482                             ip6_address_t * ip6, const ip4_address_t * ip4)
483 {
484   ASSERT (d->ip6_src_len == 96 || d->ip6_src_len == 64);        //No support for other lengths for now
485   u8 offset = d->ip6_src_len == 64 ? 9 : 12;
486   ip6->as_u64[0] = d->ip6_src.as_u64[0];
487   ip6->as_u64[1] = d->ip6_src.as_u64[1];
488   clib_memcpy_fast (&ip6->as_u8[offset], ip4, 4);
489 }
490
491 static_always_inline u32
492 ip6_map_t_embedded_address (map_domain_t * d, ip6_address_t * addr)
493 {
494   ASSERT (d->ip6_src_len == 64 || d->ip6_src_len == 96);
495   u32 x;
496   u8 offset = d->ip6_src_len == 64 ? 9 : 12;
497   clib_memcpy (&x, &addr->as_u8[offset], 4);
498   return x;
499 }
500
501 static inline void
502 map_domain_counter_lock (map_main_t * mm)
503 {
504   if (mm->counter_lock)
505     while (clib_atomic_test_and_set (mm->counter_lock))
506       /* zzzz */ ;
507 }
508
509 static inline void
510 map_domain_counter_unlock (map_main_t * mm)
511 {
512   if (mm->counter_lock)
513     clib_atomic_release (mm->counter_lock);
514 }
515
516
517 static_always_inline void
518 map_send_all_to_node (vlib_main_t * vm, u32 * pi_vector,
519                       vlib_node_runtime_t * node, vlib_error_t * error,
520                       u32 next)
521 {
522   u32 n_left_from, *from, next_index, *to_next, n_left_to_next;
523   //Deal with fragments that are ready
524   from = pi_vector;
525   n_left_from = vec_len (pi_vector);
526   next_index = node->cached_next_index;
527   while (n_left_from > 0)
528     {
529       vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
530       while (n_left_from > 0 && n_left_to_next > 0)
531         {
532           u32 pi0 = to_next[0] = from[0];
533           from += 1;
534           n_left_from -= 1;
535           to_next += 1;
536           n_left_to_next -= 1;
537           vlib_buffer_t *p0 = vlib_get_buffer (vm, pi0);
538           p0->error = *error;
539           vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
540                                            n_left_to_next, pi0, next);
541         }
542       vlib_put_next_frame (vm, node, next_index, n_left_to_next);
543     }
544 }
545
546 static_always_inline void
547 map_mss_clamping (tcp_header_t * tcp, ip_csum_t * sum, u16 mss_clamping)
548 {
549   u8 *data;
550   u8 opt_len, opts_len, kind;
551   u16 mss;
552   u16 mss_value_net = clib_host_to_net_u16 (mss_clamping);
553
554   if (!tcp_syn (tcp))
555     return;
556
557   opts_len = (tcp_doff (tcp) << 2) - sizeof (tcp_header_t);
558   data = (u8 *) (tcp + 1);
559   for (; opts_len > 0; opts_len -= opt_len, data += opt_len)
560     {
561       kind = data[0];
562
563       if (kind == TCP_OPTION_EOL)
564         break;
565       else if (kind == TCP_OPTION_NOOP)
566         {
567           opt_len = 1;
568           continue;
569         }
570       else
571         {
572           if (opts_len < 2)
573             return;
574           opt_len = data[1];
575
576           if (opt_len < 2 || opt_len > opts_len)
577             return;
578         }
579
580       if (kind == TCP_OPTION_MSS)
581         {
582           mss = *(u16 *) (data + 2);
583           if (clib_net_to_host_u16 (mss) > mss_clamping)
584             {
585               *sum =
586                 ip_csum_update (*sum, mss, mss_value_net, ip4_header_t,
587                                 length);
588               clib_memcpy (data + 2, &mss_value_net, 2);
589             }
590           return;
591         }
592     }
593 }
594
595 /*
596  * fd.io coding-style-patch-verification: ON
597  *
598  * Local Variables:
599  * eval: (c-set-style "gnu")
600  * End:
601  */