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