Thread-safe ARP / ND throttling
[vpp.git] / src / vnet / ip / ip6.h
1 /*
2  * Copyright (c) 2016 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 /*
16  * ip/ip6.h: ip6 main include file
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
20  * Permission is hereby granted, free of charge, to any person obtaining
21  * a copy of this software and associated documentation files (the
22  * "Software"), to deal in the Software without restriction, including
23  * without limitation the rights to use, copy, modify, merge, publish,
24  * distribute, sublicense, and/or sell copies of the Software, and to
25  * permit persons to whom the Software is furnished to do so, subject to
26  * the following conditions:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
31  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34  *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35  *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36  *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37  *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38  */
39
40 #ifndef included_ip_ip6_h
41 #define included_ip_ip6_h
42
43 #include <vlib/mc.h>
44 #include <vlib/buffer.h>
45 #include <vnet/ethernet/packet.h>
46 #include <vnet/ip/ip6_packet.h>
47 #include <vnet/ip/ip6_hop_by_hop_packet.h>
48 #include <vnet/ip/lookup.h>
49 #include <stdbool.h>
50 #include <vppinfra/bihash_24_8.h>
51 #include <vppinfra/bihash_template.h>
52 #include <vnet/util/radix.h>
53
54 /*
55  * Default size of the ip6 fib hash table
56  */
57 #define IP6_FIB_DEFAULT_HASH_NUM_BUCKETS (64 * 1024)
58 #define IP6_FIB_DEFAULT_HASH_MEMORY_SIZE (32<<20)
59
60 typedef struct
61 {
62   ip6_address_t addr;
63   u32 dst_address_length;
64   u32 vrf_index;
65 } ip6_fib_key_t;
66
67 typedef struct
68 {
69   /* required for pool_get_aligned. */
70   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
71
72   /* Table ID (hash key) for this FIB. */
73   u32 table_id;
74
75   /* Index into FIB vector. */
76   u32 index;
77 } ip6_fib_t;
78
79 typedef struct ip6_mfib_t
80 {
81   /* Table ID (hash key) for this FIB. */
82   u32 table_id;
83
84   /* Index into FIB vector. */
85   u32 index;
86
87   /*
88    *  Pointer to the top of a radix tree.
89    * This cannot be realloc'd, hence it cannot be inlined with this table
90    */
91   struct radix_node_head *rhead;
92 } ip6_mfib_t;
93
94 struct ip6_main_t;
95
96 typedef void (ip6_add_del_interface_address_function_t)
97   (struct ip6_main_t * im,
98    uword opaque,
99    u32 sw_if_index,
100    ip6_address_t * address,
101    u32 address_length, u32 if_address_index, u32 is_del);
102
103 typedef struct
104 {
105   ip6_add_del_interface_address_function_t *function;
106   uword function_opaque;
107 } ip6_add_del_interface_address_callback_t;
108
109 typedef void (ip6_table_bind_function_t)
110   (struct ip6_main_t * im,
111    uword opaque, u32 sw_if_index, u32 new_fib_index, u32 old_fib_index);
112
113 typedef struct
114 {
115   ip6_table_bind_function_t *function;
116   uword function_opaque;
117 } ip6_table_bind_callback_t;
118
119 /**
120  * Enumeration of the FIB table instance types
121  */
122 typedef enum ip6_fib_table_instance_type_t_
123 {
124     /**
125      * This table stores the routes that are used to forward traffic.
126      * The key is the prefix, the result the adjacnecy to forward on.
127      */
128   IP6_FIB_TABLE_FWDING,
129     /**
130      * The table that stores ALL routes learned by the DP.
131      * Some of these routes may not be ready to install in forwarding
132      * at a given time.
133      * The key in this table is the prefix, the result is the fib_entry_t
134      */
135   IP6_FIB_TABLE_NON_FWDING,
136 } ip6_fib_table_instance_type_t;
137
138 #define IP6_FIB_NUM_TABLES (IP6_FIB_TABLE_NON_FWDING+1)
139
140 /**
141  * A represenation of a single IP6 table
142  */
143 typedef struct ip6_fib_table_instance_t_
144 {
145   /* The hash table */
146   BVT (clib_bihash) ip6_hash;
147
148   /* bitmap / refcounts / vector of mask widths to search */
149   uword *non_empty_dst_address_length_bitmap;
150   u8 *prefix_lengths_in_search_order;
151   i32 dst_address_length_refcounts[129];
152 } ip6_fib_table_instance_t;
153
154 typedef struct ip6_main_t
155 {
156   /**
157    * The two FIB tables; fwding and non-fwding
158    */
159   ip6_fib_table_instance_t ip6_table[IP6_FIB_NUM_TABLES];
160
161   ip_lookup_main_t lookup_main;
162
163   /* Pool of FIBs. */
164   struct fib_table_t_ *fibs;
165
166   /* Pool of V6 FIBs. */
167   ip6_fib_t *v6_fibs;
168
169   /** Vector of MFIBs. */
170   struct mfib_table_t_ *mfibs;
171
172   /* Network byte orders subnet mask for each prefix length */
173   ip6_address_t fib_masks[129];
174
175   /* Table index indexed by software interface. */
176   u32 *fib_index_by_sw_if_index;
177
178   /** Table index indexed by software interface. */
179   u32 *mfib_index_by_sw_if_index;
180
181   /* IP6 enabled count by software interface */
182   u8 *ip_enabled_by_sw_if_index;
183
184   /* Hash table mapping table id to fib index.
185      ID space is not necessarily dense; index space is dense. */
186   uword *fib_index_by_table_id;
187
188   /** Hash table mapping table id to multicast fib index.
189      ID space is not necessarily dense; index space is dense. */
190   uword *mfib_index_by_table_id;
191
192   /* Hash table mapping interface rewrite adjacency index by sw if index. */
193   uword *interface_route_adj_index_by_sw_if_index;
194
195   /* Functions to call when interface address changes. */
196     ip6_add_del_interface_address_callback_t
197     * add_del_interface_address_callbacks;
198
199   /** Functions to call when interface to table biding changes. */
200   ip6_table_bind_callback_t *table_bind_callbacks;
201
202   /* Template used to generate IP6 neighbor solicitation packets. */
203   vlib_packet_template_t discover_neighbor_packet_template;
204
205   /* ip6 lookup table config parameters */
206   u32 lookup_table_nbuckets;
207   uword lookup_table_size;
208
209   /* Seed for Jenkins hash used to compute ip6 flow hash. */
210   u32 flow_hash_seed;
211
212   struct
213   {
214     /* TTL to use for host generated packets. */
215     u8 ttl;
216
217     u8 pad[3];
218   } host_config;
219
220   /* HBH processing enabled? */
221   u8 hbh_enabled;
222
223   /** ND throttling */
224   uword **nd_throttle_bitmaps;
225   u64 *nd_throttle_seeds;
226   f64 *nd_throttle_last_seed_change_time;
227
228 } ip6_main_t;
229
230 #define ND_THROTTLE_BITS 512
231
232 /* Global ip6 main structure. */
233 extern ip6_main_t ip6_main;
234
235 /* Global ip6 input node.  Errors get attached to ip6 input node. */
236 extern vlib_node_registration_t ip6_input_node;
237 extern vlib_node_registration_t ip6_rewrite_node;
238 extern vlib_node_registration_t ip6_rewrite_mcast_node;
239 extern vlib_node_registration_t ip6_rewrite_local_node;
240 extern vlib_node_registration_t ip6_discover_neighbor_node;
241 extern vlib_node_registration_t ip6_glean_node;
242 extern vlib_node_registration_t ip6_midchain_node;
243
244 extern void ip6_forward_next_trace (vlib_main_t * vm,
245                                     vlib_node_runtime_t * node,
246                                     vlib_frame_t * frame,
247                                     vlib_rx_or_tx_t which_adj_index);
248
249 always_inline uword
250 ip6_destination_matches_route (const ip6_main_t * im,
251                                const ip6_address_t * key,
252                                const ip6_address_t * dest, uword dest_length)
253 {
254   int i;
255   for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
256     {
257       if ((key->as_uword[i] ^ dest->as_uword[i]) & im->
258           fib_masks[dest_length].as_uword[i])
259         return 0;
260     }
261   return 1;
262 }
263
264 always_inline uword
265 ip6_destination_matches_interface (ip6_main_t * im,
266                                    ip6_address_t * key,
267                                    ip_interface_address_t * ia)
268 {
269   ip6_address_t *a = ip_interface_address_get_address (&im->lookup_main, ia);
270   return ip6_destination_matches_route (im, key, a, ia->address_length);
271 }
272
273 /* As above but allows for unaligned destinations (e.g. works right from IP header of packet). */
274 always_inline uword
275 ip6_unaligned_destination_matches_route (ip6_main_t * im,
276                                          ip6_address_t * key,
277                                          ip6_address_t * dest,
278                                          uword dest_length)
279 {
280   int i;
281   for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
282     {
283       if ((clib_mem_unaligned (&key->as_uword[i], uword) ^ dest->as_uword[i])
284           & im->fib_masks[dest_length].as_uword[i])
285         return 0;
286     }
287   return 1;
288 }
289
290 extern int ip6_get_ll_address (u32 sw_if_index, ip6_address_t * addr);
291
292 always_inline int
293 ip6_src_address_for_packet (ip_lookup_main_t * lm,
294                             u32 sw_if_index,
295                             const ip6_address_t * dst, ip6_address_t * src)
296 {
297   if (ip6_address_is_link_local_unicast (dst))
298     {
299       return ip6_get_ll_address (sw_if_index, src);
300     }
301   else
302     {
303       u32 if_add_index =
304         lm->if_address_pool_index_by_sw_if_index[sw_if_index];
305       if (PREDICT_TRUE (if_add_index != ~0))
306         {
307           ip_interface_address_t *if_add =
308             pool_elt_at_index (lm->if_address_pool, if_add_index);
309           ip6_address_t *if_ip =
310             ip_interface_address_get_address (lm, if_add);
311           *src = *if_ip;
312           return (!0);
313         }
314     }
315
316   src->as_u64[0] = 0;
317   src->as_u64[1] = 0;
318
319   return (0);
320 }
321
322 /* Find interface address which matches destination. */
323 always_inline ip6_address_t *
324 ip6_interface_address_matching_destination (ip6_main_t * im,
325                                             ip6_address_t * dst,
326                                             u32 sw_if_index,
327                                             ip_interface_address_t **
328                                             result_ia)
329 {
330   ip_lookup_main_t *lm = &im->lookup_main;
331   ip_interface_address_t *ia;
332   ip6_address_t *result = 0;
333
334   /* *INDENT-OFF* */
335   foreach_ip_interface_address (lm, ia, sw_if_index,
336                                 1 /* honor unnumbered */,
337   ({
338     ip6_address_t * a = ip_interface_address_get_address (lm, ia);
339     if (ip6_destination_matches_route (im, dst, a, ia->address_length))
340       {
341         result = a;
342         break;
343       }
344   }));
345   /* *INDENT-ON* */
346   if (result_ia)
347     *result_ia = result ? ia : 0;
348   return result;
349 }
350
351 clib_error_t *ip6_add_del_interface_address (vlib_main_t * vm,
352                                              u32 sw_if_index,
353                                              ip6_address_t * address,
354                                              u32 address_length, u32 is_del);
355 void ip6_sw_interface_enable_disable (u32 sw_if_index, u32 is_enable);
356
357 /**
358  * @brie get first IPv6 interface address
359  */
360 ip6_address_t *ip6_interface_first_address (ip6_main_t * im, u32 sw_if_index);
361
362 int ip6_address_compare (ip6_address_t * a1, ip6_address_t * a2);
363
364 clib_error_t *ip6_probe_neighbor (vlib_main_t * vm, ip6_address_t * dst,
365                                   u32 sw_if_index, u8 refresh);
366
367 uword
368 ip6_udp_register_listener (vlib_main_t * vm,
369                            u16 dst_port, u32 next_node_index);
370
371 u16 ip6_tcp_udp_icmp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0,
372                                        ip6_header_t * ip0,
373                                        int *bogus_lengthp);
374
375 void ip6_register_protocol (u32 protocol, u32 node_index);
376
377 serialize_function_t serialize_vnet_ip6_main, unserialize_vnet_ip6_main;
378
379 void ip6_ethernet_update_adjacency (vnet_main_t * vnm,
380                                     u32 sw_if_index, u32 ai);
381
382
383 void
384 ip6_link_local_address_from_ethernet_mac_address (ip6_address_t * ip,
385                                                   u8 * mac);
386
387 void
388 ip6_ethernet_mac_address_from_link_local_address (u8 * mac,
389                                                   ip6_address_t * ip);
390
391 int vnet_set_ip6_flow_hash (u32 table_id,
392                             flow_hash_config_t flow_hash_config);
393
394 clib_error_t *enable_ip6_interface (vlib_main_t * vm, u32 sw_if_index);
395
396 clib_error_t *disable_ip6_interface (vlib_main_t * vm, u32 sw_if_index);
397
398 int ip6_interface_enabled (vlib_main_t * vm, u32 sw_if_index);
399
400 clib_error_t *set_ip6_link_local_address (vlib_main_t * vm,
401                                           u32 sw_if_index,
402                                           ip6_address_t * address);
403
404 int vnet_add_del_ip6_nd_change_event (vnet_main_t * vnm,
405                                       void *data_callback,
406                                       u32 pid,
407                                       void *address_arg,
408                                       uword node_index,
409                                       uword type_opaque,
410                                       uword data, int is_add);
411
412 int vnet_ip6_nd_term (vlib_main_t * vm,
413                       vlib_node_runtime_t * node,
414                       vlib_buffer_t * p0,
415                       ethernet_header_t * eth,
416                       ip6_header_t * ip, u32 sw_if_index, u16 bd_index);
417
418 void send_ip6_na (vlib_main_t * vm, u32 sw_if_index);
419 void send_ip6_na_w_addr (vlib_main_t * vm,
420                          const ip6_address_t * addr, u32 sw_if_index);
421
422 u8 *format_ip6_forward_next_trace (u8 * s, va_list * args);
423
424 u32 ip6_tcp_udp_icmp_validate_checksum (vlib_main_t * vm, vlib_buffer_t * p0);
425
426 void ip6_punt_policer_add_del (u8 is_add, u32 policer_index);
427 void ip6_punt_redirect_add (u32 rx_sw_if_index,
428                             u32 tx_sw_if_index, ip46_address_t * nh);
429 void ip6_punt_redirect_del (u32 rx_sw_if_index);
430
431 int vnet_set_ip6_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
432                                  u32 table_index);
433 extern vlib_node_registration_t ip6_lookup_node;
434
435 /* Compute flow hash.  We'll use it to select which Sponge to use for this
436    flow.  And other things. */
437 always_inline u32
438 ip6_compute_flow_hash (const ip6_header_t * ip,
439                        flow_hash_config_t flow_hash_config)
440 {
441   tcp_header_t *tcp;
442   u64 a, b, c;
443   u64 t1, t2;
444   uword is_tcp_udp = 0;
445   u8 protocol = ip->protocol;
446
447   if (PREDICT_TRUE
448       ((ip->protocol == IP_PROTOCOL_TCP)
449        || (ip->protocol == IP_PROTOCOL_UDP)))
450     {
451       is_tcp_udp = 1;
452       tcp = (void *) (ip + 1);
453     }
454   else if (ip->protocol == IP_PROTOCOL_IP6_HOP_BY_HOP_OPTIONS)
455     {
456       ip6_hop_by_hop_header_t *hbh = (ip6_hop_by_hop_header_t *) (ip + 1);
457       if ((hbh->protocol == IP_PROTOCOL_TCP) ||
458           (hbh->protocol == IP_PROTOCOL_UDP))
459         {
460           is_tcp_udp = 1;
461           tcp = (tcp_header_t *) ((u8 *) hbh + ((hbh->length + 1) << 3));
462         }
463       protocol = hbh->protocol;
464     }
465
466   t1 = (ip->src_address.as_u64[0] ^ ip->src_address.as_u64[1]);
467   t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR) ? t1 : 0;
468
469   t2 = (ip->dst_address.as_u64[0] ^ ip->dst_address.as_u64[1]);
470   t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR) ? t2 : 0;
471
472   a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
473   b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
474   b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? protocol : 0;
475
476   t1 = is_tcp_udp ? tcp->src : 0;
477   t2 = is_tcp_udp ? tcp->dst : 0;
478
479   t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
480   t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
481
482   c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
483     ((t1 << 16) | t2) : ((t2 << 16) | t1);
484
485   hash_mix64 (a, b, c);
486   return (u32) c;
487 }
488
489 /* ip6_locate_header
490  *
491  * This function is to search for the header specified by the protocol number
492  * in find_hdr_type.
493  * This is used to locate a specific IPv6 extension header
494  * or to find transport layer header.
495  *   1. If the find_hdr_type < 0 then it finds and returns the protocol number and
496  *   offset stored in *offset of the transport or ESP header in the chain if
497  *   found.
498  *   2. If a header with find_hdr_type > 0 protocol number is found then the
499  *      offset is stored in *offset and protocol number of the header is
500  *      returned.
501  *   3. If find_hdr_type is not found or packet is malformed or
502  *      it is a non-first fragment -1 is returned.
503  */
504 always_inline int
505 ip6_locate_header (vlib_buffer_t * p0,
506                    ip6_header_t * ip0, int find_hdr_type, u32 * offset)
507 {
508   u8 next_proto = ip0->protocol;
509   u8 *next_header;
510   u8 done = 0;
511   u32 cur_offset;
512   u8 *temp_nxthdr = 0;
513   u32 exthdr_len = 0;
514
515   next_header = ip6_next_header (ip0);
516   cur_offset = sizeof (ip6_header_t);
517   while (1)
518     {
519       done = (next_proto == find_hdr_type);
520       if (PREDICT_FALSE
521           (next_header >=
522            (u8 *) vlib_buffer_get_current (p0) + p0->current_length))
523         {
524           //A malicious packet could set an extension header with a too big size
525           return (-1);
526         }
527       if (done)
528         break;
529       if ((!ip6_ext_hdr (next_proto)) || next_proto == IP_PROTOCOL_IP6_NONXT)
530         {
531           if (find_hdr_type < 0)
532             break;
533           return -1;
534         }
535       if (next_proto == IP_PROTOCOL_IPV6_FRAGMENTATION)
536         {
537           ip6_frag_hdr_t *frag_hdr = (ip6_frag_hdr_t *) next_header;
538           u16 frag_off = ip6_frag_hdr_offset (frag_hdr);
539           /* Non first fragment return -1 */
540           if (frag_off)
541             return (-1);
542           exthdr_len = sizeof (ip6_frag_hdr_t);
543           temp_nxthdr = next_header + exthdr_len;
544         }
545       else if (next_proto == IP_PROTOCOL_IPSEC_AH)
546         {
547           exthdr_len =
548             ip6_ext_authhdr_len (((ip6_ext_header_t *) next_header));
549           temp_nxthdr = next_header + exthdr_len;
550         }
551       else
552         {
553           exthdr_len =
554             ip6_ext_header_len (((ip6_ext_header_t *) next_header));
555           temp_nxthdr = next_header + exthdr_len;
556         }
557       next_proto = ((ip6_ext_header_t *) next_header)->next_hdr;
558       next_header = temp_nxthdr;
559       cur_offset += exthdr_len;
560     }
561
562   *offset = cur_offset;
563   return (next_proto);
564 }
565
566 u8 *format_ip6_hop_by_hop_ext_hdr (u8 * s, va_list * args);
567 /*
568  * Hop-by-Hop handling
569  */
570 typedef struct
571 {
572   /* Array of function pointers to HBH option handling routines */
573   int (*options[256]) (vlib_buffer_t * b, ip6_header_t * ip,
574                        ip6_hop_by_hop_option_t * opt);
575   u8 *(*trace[256]) (u8 * s, ip6_hop_by_hop_option_t * opt);
576   uword next_override;
577 } ip6_hop_by_hop_main_t;
578
579 extern ip6_hop_by_hop_main_t ip6_hop_by_hop_main;
580
581 int ip6_hbh_register_option (u8 option,
582                              int options (vlib_buffer_t * b,
583                                           ip6_header_t * ip,
584                                           ip6_hop_by_hop_option_t * opt),
585                              u8 * trace (u8 * s,
586                                          ip6_hop_by_hop_option_t * opt));
587 int ip6_hbh_unregister_option (u8 option);
588 void ip6_hbh_set_next_override (uword next);
589
590 /**
591  * Push IPv6 header to buffer
592  *
593  * @param vm - vlib_main
594  * @param b - buffer to write the header to
595  * @param src - source IP
596  * @param dst - destination IP
597  * @param prot - payload proto
598  *
599  * @return - pointer to start of IP header
600  */
601 always_inline void *
602 vlib_buffer_push_ip6 (vlib_main_t * vm, vlib_buffer_t * b,
603                       ip6_address_t * src, ip6_address_t * dst, int proto)
604 {
605   ip6_header_t *ip6h;
606   u16 payload_length;
607
608   /* make some room */
609   ip6h = vlib_buffer_push_uninit (b, sizeof (ip6_header_t));
610
611   ip6h->ip_version_traffic_class_and_flow_label =
612     clib_host_to_net_u32 (0x6 << 28);
613
614   /* calculate ip6 payload length */
615   payload_length = vlib_buffer_length_in_chain (vm, b);
616   payload_length -= sizeof (*ip6h);
617
618   ip6h->payload_length = clib_host_to_net_u16 (payload_length);
619
620   ip6h->hop_limit = 0xff;
621   ip6h->protocol = proto;
622   clib_memcpy (ip6h->src_address.as_u8, src->as_u8,
623                sizeof (ip6h->src_address));
624   clib_memcpy (ip6h->dst_address.as_u8, dst->as_u8,
625                sizeof (ip6h->src_address));
626   b->flags |= VNET_BUFFER_F_IS_IP6;
627
628   return ip6h;
629 }
630
631 #endif /* included_ip_ip6_h */
632
633 /*
634  * fd.io coding-style-patch-verification: ON
635  *
636  * Local Variables:
637  * eval: (c-set-style "gnu")
638  * End:
639  */