bond: send gratuitous arp when the active slave went down in active-backup mode
[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 } ip6_main_t;
223
224 /* Global ip6 main structure. */
225 extern ip6_main_t ip6_main;
226
227 /* Global ip6 input node.  Errors get attached to ip6 input node. */
228 extern vlib_node_registration_t ip6_input_node;
229 extern vlib_node_registration_t ip6_rewrite_node;
230 extern vlib_node_registration_t ip6_rewrite_mcast_node;
231 extern vlib_node_registration_t ip6_rewrite_local_node;
232 extern vlib_node_registration_t ip6_discover_neighbor_node;
233 extern vlib_node_registration_t ip6_glean_node;
234 extern vlib_node_registration_t ip6_midchain_node;
235
236 extern void ip6_forward_next_trace (vlib_main_t * vm,
237                                     vlib_node_runtime_t * node,
238                                     vlib_frame_t * frame,
239                                     vlib_rx_or_tx_t which_adj_index);
240
241 always_inline uword
242 ip6_destination_matches_route (const ip6_main_t * im,
243                                const ip6_address_t * key,
244                                const ip6_address_t * dest, uword dest_length)
245 {
246   int i;
247   for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
248     {
249       if ((key->as_uword[i] ^ dest->as_uword[i]) & im->
250           fib_masks[dest_length].as_uword[i])
251         return 0;
252     }
253   return 1;
254 }
255
256 always_inline uword
257 ip6_destination_matches_interface (ip6_main_t * im,
258                                    ip6_address_t * key,
259                                    ip_interface_address_t * ia)
260 {
261   ip6_address_t *a = ip_interface_address_get_address (&im->lookup_main, ia);
262   return ip6_destination_matches_route (im, key, a, ia->address_length);
263 }
264
265 /* As above but allows for unaligned destinations (e.g. works right from IP header of packet). */
266 always_inline uword
267 ip6_unaligned_destination_matches_route (ip6_main_t * im,
268                                          ip6_address_t * key,
269                                          ip6_address_t * dest,
270                                          uword dest_length)
271 {
272   int i;
273   for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
274     {
275       if ((clib_mem_unaligned (&key->as_uword[i], uword) ^ dest->as_uword[i])
276           & im->fib_masks[dest_length].as_uword[i])
277         return 0;
278     }
279   return 1;
280 }
281
282 extern int ip6_get_ll_address (u32 sw_if_index, ip6_address_t * addr);
283
284 always_inline int
285 ip6_src_address_for_packet (ip_lookup_main_t * lm,
286                             u32 sw_if_index,
287                             const ip6_address_t * dst, ip6_address_t * src)
288 {
289   if (ip6_address_is_link_local_unicast (dst))
290     {
291       return ip6_get_ll_address (sw_if_index, src);
292     }
293   else
294     {
295       u32 if_add_index =
296         lm->if_address_pool_index_by_sw_if_index[sw_if_index];
297       if (PREDICT_TRUE (if_add_index != ~0))
298         {
299           ip_interface_address_t *if_add =
300             pool_elt_at_index (lm->if_address_pool, if_add_index);
301           ip6_address_t *if_ip =
302             ip_interface_address_get_address (lm, if_add);
303           *src = *if_ip;
304           return (!0);
305         }
306     }
307
308   src->as_u64[0] = 0;
309   src->as_u64[1] = 0;
310
311   return (0);
312 }
313
314 /* Find interface address which matches destination. */
315 always_inline ip6_address_t *
316 ip6_interface_address_matching_destination (ip6_main_t * im,
317                                             ip6_address_t * dst,
318                                             u32 sw_if_index,
319                                             ip_interface_address_t **
320                                             result_ia)
321 {
322   ip_lookup_main_t *lm = &im->lookup_main;
323   ip_interface_address_t *ia;
324   ip6_address_t *result = 0;
325
326   /* *INDENT-OFF* */
327   foreach_ip_interface_address (lm, ia, sw_if_index,
328                                 1 /* honor unnumbered */,
329   ({
330     ip6_address_t * a = ip_interface_address_get_address (lm, ia);
331     if (ip6_destination_matches_route (im, dst, a, ia->address_length))
332       {
333         result = a;
334         break;
335       }
336   }));
337   /* *INDENT-ON* */
338   if (result_ia)
339     *result_ia = result ? ia : 0;
340   return result;
341 }
342
343 clib_error_t *ip6_add_del_interface_address (vlib_main_t * vm,
344                                              u32 sw_if_index,
345                                              ip6_address_t * address,
346                                              u32 address_length, u32 is_del);
347 void ip6_sw_interface_enable_disable (u32 sw_if_index, u32 is_enable);
348
349 /**
350  * @brie get first IPv6 interface address
351  */
352 ip6_address_t *ip6_interface_first_address (ip6_main_t * im, u32 sw_if_index);
353
354 int ip6_address_compare (ip6_address_t * a1, ip6_address_t * a2);
355
356 clib_error_t *ip6_probe_neighbor (vlib_main_t * vm, ip6_address_t * dst,
357                                   u32 sw_if_index);
358
359 uword
360 ip6_udp_register_listener (vlib_main_t * vm,
361                            u16 dst_port, u32 next_node_index);
362
363 u16 ip6_tcp_udp_icmp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0,
364                                        ip6_header_t * ip0,
365                                        int *bogus_lengthp);
366
367 void ip6_register_protocol (u32 protocol, u32 node_index);
368
369 serialize_function_t serialize_vnet_ip6_main, unserialize_vnet_ip6_main;
370
371 void ip6_ethernet_update_adjacency (vnet_main_t * vnm,
372                                     u32 sw_if_index, u32 ai);
373
374
375 void
376 ip6_link_local_address_from_ethernet_mac_address (ip6_address_t * ip,
377                                                   u8 * mac);
378
379 void
380 ip6_ethernet_mac_address_from_link_local_address (u8 * mac,
381                                                   ip6_address_t * ip);
382
383 int vnet_set_ip6_flow_hash (u32 table_id,
384                             flow_hash_config_t flow_hash_config);
385
386 clib_error_t *enable_ip6_interface (vlib_main_t * vm, u32 sw_if_index);
387
388 clib_error_t *disable_ip6_interface (vlib_main_t * vm, u32 sw_if_index);
389
390 int ip6_interface_enabled (vlib_main_t * vm, u32 sw_if_index);
391
392 clib_error_t *set_ip6_link_local_address (vlib_main_t * vm,
393                                           u32 sw_if_index,
394                                           ip6_address_t * address);
395
396 int vnet_add_del_ip6_nd_change_event (vnet_main_t * vnm,
397                                       void *data_callback,
398                                       u32 pid,
399                                       void *address_arg,
400                                       uword node_index,
401                                       uword type_opaque,
402                                       uword data, int is_add);
403
404 int vnet_ip6_nd_term (vlib_main_t * vm,
405                       vlib_node_runtime_t * node,
406                       vlib_buffer_t * p0,
407                       ethernet_header_t * eth,
408                       ip6_header_t * ip, u32 sw_if_index, u16 bd_index);
409
410 void send_ip6_na (vlib_main_t * vm, u32 sw_if_index);
411 void send_ip6_na_w_addr (vlib_main_t * vm,
412                          const ip6_address_t * addr, u32 sw_if_index);
413
414 u8 *format_ip6_forward_next_trace (u8 * s, va_list * args);
415
416 u32 ip6_tcp_udp_icmp_validate_checksum (vlib_main_t * vm, vlib_buffer_t * p0);
417
418 void ip6_punt_policer_add_del (u8 is_add, u32 policer_index);
419 void ip6_punt_redirect_add (u32 rx_sw_if_index,
420                             u32 tx_sw_if_index, ip46_address_t * nh);
421 void ip6_punt_redirect_del (u32 rx_sw_if_index);
422
423 int vnet_set_ip6_classify_intfc (vlib_main_t * vm, u32 sw_if_index,
424                                  u32 table_index);
425 extern vlib_node_registration_t ip6_lookup_node;
426
427 /* Compute flow hash.  We'll use it to select which Sponge to use for this
428    flow.  And other things. */
429 always_inline u32
430 ip6_compute_flow_hash (const ip6_header_t * ip,
431                        flow_hash_config_t flow_hash_config)
432 {
433   tcp_header_t *tcp;
434   u64 a, b, c;
435   u64 t1, t2;
436   uword is_tcp_udp = 0;
437   u8 protocol = ip->protocol;
438
439   if (PREDICT_TRUE
440       ((ip->protocol == IP_PROTOCOL_TCP)
441        || (ip->protocol == IP_PROTOCOL_UDP)))
442     {
443       is_tcp_udp = 1;
444       tcp = (void *) (ip + 1);
445     }
446   else if (ip->protocol == IP_PROTOCOL_IP6_HOP_BY_HOP_OPTIONS)
447     {
448       ip6_hop_by_hop_header_t *hbh = (ip6_hop_by_hop_header_t *) (ip + 1);
449       if ((hbh->protocol == IP_PROTOCOL_TCP) ||
450           (hbh->protocol == IP_PROTOCOL_UDP))
451         {
452           is_tcp_udp = 1;
453           tcp = (tcp_header_t *) ((u8 *) hbh + ((hbh->length + 1) << 3));
454         }
455       protocol = hbh->protocol;
456     }
457
458   t1 = (ip->src_address.as_u64[0] ^ ip->src_address.as_u64[1]);
459   t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR) ? t1 : 0;
460
461   t2 = (ip->dst_address.as_u64[0] ^ ip->dst_address.as_u64[1]);
462   t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR) ? t2 : 0;
463
464   a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
465   b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
466   b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? protocol : 0;
467
468   t1 = is_tcp_udp ? tcp->src : 0;
469   t2 = is_tcp_udp ? tcp->dst : 0;
470
471   t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
472   t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
473
474   c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
475     ((t1 << 16) | t2) : ((t2 << 16) | t1);
476
477   hash_mix64 (a, b, c);
478   return (u32) c;
479 }
480
481 /* ip6_locate_header
482  *
483  * This function is to search for the header specified by the protocol number
484  * in find_hdr_type.
485  * This is used to locate a specific IPv6 extension header
486  * or to find transport layer header.
487  *   1. If the find_hdr_type < 0 then it finds and returns the protocol number and
488  *   offset stored in *offset of the transport or ESP header in the chain if
489  *   found.
490  *   2. If a header with find_hdr_type > 0 protocol number is found then the
491  *      offset is stored in *offset and protocol number of the header is
492  *      returned.
493  *   3. If find_hdr_type is not found or packet is malformed or
494  *      it is a non-first fragment -1 is returned.
495  */
496 always_inline int
497 ip6_locate_header (vlib_buffer_t * p0,
498                    ip6_header_t * ip0, int find_hdr_type, u32 * offset)
499 {
500   u8 next_proto = ip0->protocol;
501   u8 *next_header;
502   u8 done = 0;
503   u32 cur_offset;
504   u8 *temp_nxthdr = 0;
505   u32 exthdr_len = 0;
506
507   next_header = ip6_next_header (ip0);
508   cur_offset = sizeof (ip6_header_t);
509   while (1)
510     {
511       done = (next_proto == find_hdr_type);
512       if (PREDICT_FALSE
513           (next_header >=
514            (u8 *) vlib_buffer_get_current (p0) + p0->current_length))
515         {
516           //A malicious packet could set an extension header with a too big size
517           return (-1);
518         }
519       if (done)
520         break;
521       if ((!ip6_ext_hdr (next_proto)) || next_proto == IP_PROTOCOL_IP6_NONXT)
522         {
523           if (find_hdr_type < 0)
524             break;
525           return -1;
526         }
527       if (next_proto == IP_PROTOCOL_IPV6_FRAGMENTATION)
528         {
529           ip6_frag_hdr_t *frag_hdr = (ip6_frag_hdr_t *) next_header;
530           u16 frag_off = ip6_frag_hdr_offset (frag_hdr);
531           /* Non first fragment return -1 */
532           if (frag_off)
533             return (-1);
534           exthdr_len = sizeof (ip6_frag_hdr_t);
535           temp_nxthdr = next_header + exthdr_len;
536         }
537       else if (next_proto == IP_PROTOCOL_IPSEC_AH)
538         {
539           exthdr_len =
540             ip6_ext_authhdr_len (((ip6_ext_header_t *) next_header));
541           temp_nxthdr = next_header + exthdr_len;
542         }
543       else
544         {
545           exthdr_len =
546             ip6_ext_header_len (((ip6_ext_header_t *) next_header));
547           temp_nxthdr = next_header + exthdr_len;
548         }
549       next_proto = ((ip6_ext_header_t *) next_header)->next_hdr;
550       next_header = temp_nxthdr;
551       cur_offset += exthdr_len;
552     }
553
554   *offset = cur_offset;
555   return (next_proto);
556 }
557
558 u8 *format_ip6_hop_by_hop_ext_hdr (u8 * s, va_list * args);
559 /*
560  * Hop-by-Hop handling
561  */
562 typedef struct
563 {
564   /* Array of function pointers to HBH option handling routines */
565   int (*options[256]) (vlib_buffer_t * b, ip6_header_t * ip,
566                        ip6_hop_by_hop_option_t * opt);
567   u8 *(*trace[256]) (u8 * s, ip6_hop_by_hop_option_t * opt);
568   uword next_override;
569 } ip6_hop_by_hop_main_t;
570
571 extern ip6_hop_by_hop_main_t ip6_hop_by_hop_main;
572
573 int ip6_hbh_register_option (u8 option,
574                              int options (vlib_buffer_t * b,
575                                           ip6_header_t * ip,
576                                           ip6_hop_by_hop_option_t * opt),
577                              u8 * trace (u8 * s,
578                                          ip6_hop_by_hop_option_t * opt));
579 int ip6_hbh_unregister_option (u8 option);
580 void ip6_hbh_set_next_override (uword next);
581
582 /**
583  * Push IPv6 header to buffer
584  *
585  * @param vm - vlib_main
586  * @param b - buffer to write the header to
587  * @param src - source IP
588  * @param dst - destination IP
589  * @param prot - payload proto
590  *
591  * @return - pointer to start of IP header
592  */
593 always_inline void *
594 vlib_buffer_push_ip6 (vlib_main_t * vm, vlib_buffer_t * b,
595                       ip6_address_t * src, ip6_address_t * dst, int proto)
596 {
597   ip6_header_t *ip6h;
598   u16 payload_length;
599
600   /* make some room */
601   ip6h = vlib_buffer_push_uninit (b, sizeof (ip6_header_t));
602
603   ip6h->ip_version_traffic_class_and_flow_label =
604     clib_host_to_net_u32 (0x6 << 28);
605
606   /* calculate ip6 payload length */
607   payload_length = vlib_buffer_length_in_chain (vm, b);
608   payload_length -= sizeof (*ip6h);
609
610   ip6h->payload_length = clib_host_to_net_u16 (payload_length);
611
612   ip6h->hop_limit = 0xff;
613   ip6h->protocol = proto;
614   clib_memcpy (ip6h->src_address.as_u8, src->as_u8,
615                sizeof (ip6h->src_address));
616   clib_memcpy (ip6h->dst_address.as_u8, dst->as_u8,
617                sizeof (ip6h->src_address));
618   b->flags |= VNET_BUFFER_F_IS_IP6;
619
620   return ip6h;
621 }
622
623 #endif /* included_ip_ip6_h */
624
625 /*
626  * fd.io coding-style-patch-verification: ON
627  *
628  * Local Variables:
629  * eval: (c-set-style "gnu")
630  * End:
631  */