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