b80317e0687ce33262715545cd2830ff7485187c
[vpp.git] / vnet / vnet / ip / ip6.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 /*
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 <vnet/ip/ip_feature_registration.h>
50 #include <stdbool.h>
51 #include <vppinfra/bihash_24_8.h>
52 #include <vppinfra/bihash_template.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   ip6_address_t addr;
62   u32 dst_address_length;
63   u32 vrf_index;
64 } ip6_fib_key_t;
65
66 typedef struct {
67   /* Table ID (hash key) for this FIB. */
68   u32 table_id;
69
70   /* Index into FIB vector. */
71   u32 index;
72
73   /* flow hash configuration */
74   flow_hash_config_t flow_hash_config;
75 } ip6_fib_t;
76
77 struct ip6_main_t;
78
79 typedef void (ip6_add_del_interface_address_function_t)
80   (struct ip6_main_t * im,
81    uword opaque,
82    u32 sw_if_index,
83    ip6_address_t * address,
84    u32 address_length,
85    u32 if_address_index,
86    u32 is_del);
87
88 typedef struct {
89   ip6_add_del_interface_address_function_t * function;
90   uword function_opaque;
91 } ip6_add_del_interface_address_callback_t;
92
93 /**
94  * Enumeration of the FIB table instance types
95  */
96 typedef enum ip6_fib_table_instance_type_t_ {
97     /**
98      * This table stores the routes that are used to forward traffic.
99      * The key is the prefix, the result the adjacnecy to forward on.
100      */
101     IP6_FIB_TABLE_FWDING,
102     /**
103      * The table that stores ALL routes learned by the DP.
104      * Some of these routes may not be ready to install in forwarding 
105      * at a given time. 
106      * The key in this table is the prefix, the result is the fib_entry_t
107      */
108     IP6_FIB_TABLE_NON_FWDING,
109 } ip6_fib_table_instance_type_t;
110
111 #define IP6_FIB_NUM_TABLES (IP6_FIB_TABLE_NON_FWDING+1)
112
113 /**
114  * A represenation of a single IP6 table
115  */
116 typedef struct ip6_fib_table_instance_t_ {
117   /* The hash table */
118   BVT(clib_bihash) ip6_hash;
119
120   /* bitmap / refcounts / vector of mask widths to search */
121   uword * non_empty_dst_address_length_bitmap;
122   u8 * prefix_lengths_in_search_order;
123   i32 dst_address_length_refcounts[129];
124 } ip6_fib_table_instance_t;
125
126 typedef struct ip6_main_t {
127   /**
128    * The two FIB tables; fwding and non-fwding
129    */
130   ip6_fib_table_instance_t ip6_table[IP6_FIB_NUM_TABLES];
131
132   ip_lookup_main_t lookup_main;
133   
134   /* Pool of FIBs. */
135   struct fib_table_t_ * fibs;
136
137   /* Network byte orders subnet mask for each prefix length */
138   ip6_address_t fib_masks[129];
139
140   /* Table index indexed by software interface. */
141   u32 * fib_index_by_sw_if_index;
142
143   /* IP6 enabled count by software interface */
144   u8 * ip_enabled_by_sw_if_index;
145
146   /* Hash table mapping table id to fib index.
147      ID space is not necessarily dense; index space is dense. */
148   uword * fib_index_by_table_id;
149
150   /* Hash table mapping interface rewrite adjacency index by sw if index. */
151   uword * interface_route_adj_index_by_sw_if_index;
152
153   /* Functions to call when interface address changes. */
154   ip6_add_del_interface_address_callback_t * add_del_interface_address_callbacks;
155
156   /* Template used to generate IP6 neighbor solicitation packets. */
157   vlib_packet_template_t discover_neighbor_packet_template;
158
159   /* ip6 lookup table config parameters */
160   u32 lookup_table_nbuckets;
161   uword lookup_table_size;
162
163   /* feature path configuration lists */
164   vnet_ip_feature_registration_t * next_feature[VNET_N_IP_FEAT];
165
166   /* Built-in unicast feature path indices, see ip_feature_init_cast(...)  */
167   u32 ip6_unicast_rx_feature_check_access;
168   u32 ip6_unicast_rx_feature_policer_classify;
169   u32 ip6_unicast_rx_feature_flow_classify;
170   u32 ip6_unicast_rx_feature_ipsec;
171   u32 ip6_unicast_rx_feature_l2tp_decap;
172   u32 ip6_unicast_rx_feature_vpath;
173   u32 ip6_unicast_rx_feature_lookup;
174   u32 ip6_unicast_rx_feature_drop;
175
176   /* Built-in multicast feature path indices */
177   u32 ip6_multicast_rx_feature_drop;
178   u32 ip6_multicast_rx_feature_vpath;
179   u32 ip6_multicast_rx_feature_lookup;
180   
181   /* Built-in tx feature path index */
182   u32 ip6_tx_feature_interface_output;
183
184   /* Save results for show command */
185   char ** feature_nodes[VNET_N_IP_FEAT];
186
187   /* Seed for Jenkins hash used to compute ip6 flow hash. */
188   u32 flow_hash_seed;
189
190   struct {
191     /* TTL to use for host generated packets. */
192     u8 ttl;
193
194     u8 pad[3];
195   } host_config;
196
197   /* HBH processing enabled? */
198   u8 hbh_enabled;
199 } ip6_main_t;
200
201 /* Global ip6 main structure. */
202 extern ip6_main_t ip6_main;
203
204 #define VNET_IP6_UNICAST_FEATURE_INIT(x,...)                    \
205   __VA_ARGS__ vnet_ip_feature_registration_t uc_##x;            \
206 static void __vnet_add_feature_registration_uc_##x (void)       \
207   __attribute__((__constructor__)) ;                            \
208 static void __vnet_add_feature_registration_uc_##x (void)       \
209 {                                                               \
210   ip6_main_t * im = &ip6_main;                                  \
211   uc_##x.next = im->next_feature[VNET_IP_RX_UNICAST_FEAT];      \
212   im->next_feature[VNET_IP_RX_UNICAST_FEAT] = &uc_##x;          \
213 }                                                               \
214 __VA_ARGS__ vnet_ip_feature_registration_t uc_##x 
215
216 #define VNET_IP6_MULTICAST_FEATURE_INIT(x,...)                  \
217   __VA_ARGS__ vnet_ip_feature_registration_t mc_##x;            \
218 static void __vnet_add_feature_registration_mc_##x (void)       \
219   __attribute__((__constructor__)) ;                            \
220 static void __vnet_add_feature_registration_mc_##x (void)       \
221 {                                                               \
222   ip6_main_t * im = &ip6_main;                                  \
223   mc_##x.next = im->next_feature[VNET_IP_RX_MULTICAST_FEAT];    \
224   im->next_feature[VNET_IP_RX_MULTICAST_FEAT] = &mc_##x;        \
225 }                                                               \
226 __VA_ARGS__ vnet_ip_feature_registration_t mc_##x 
227
228 #define VNET_IP6_TX_FEATURE_INIT(x,...)                         \
229   __VA_ARGS__ vnet_ip_feature_registration_t tx_##x;            \
230 static void __vnet_add_feature_registration_tx_##x (void)       \
231   __attribute__((__constructor__)) ;                            \
232 static void __vnet_add_feature_registration_tx_##x (void)       \
233 {                                                               \
234   ip6_main_t * im = &ip6_main;                                  \
235   tx_##x.next = im->next_feature[VNET_IP_TX_FEAT];              \
236   im->next_feature[VNET_IP_TX_FEAT] = &tx_##x;                  \
237 }                                                               \
238 __VA_ARGS__ vnet_ip_feature_registration_t tx_##x 
239
240
241 /* Global ip6 input node.  Errors get attached to ip6 input node. */
242 extern vlib_node_registration_t ip6_input_node;
243 extern vlib_node_registration_t ip6_rewrite_node;
244 extern vlib_node_registration_t ip6_rewrite_local_node;
245 extern vlib_node_registration_t ip6_discover_neighbor_node;
246 extern vlib_node_registration_t ip6_glean_node;
247 extern vlib_node_registration_t ip6_midchain_node;
248
249 extern vlib_node_registration_t ip6_icmp_neighbor_discovery_event_node;
250
251 /* ipv6 neighbor discovery - timer/event types */
252 typedef enum {
253   ICMP6_ND_EVENT_INIT,
254 } ip6_icmp_neighbor_discovery_event_type_t;
255
256 typedef union {
257   u32 add_del_swindex;
258   struct {
259     u32 up_down_swindex;
260     u32 fib_index;
261   } up_down_event;
262 } ip6_icmp_neighbor_discovery_event_data_t;
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,
268                                uword dest_length)
269 {
270   int i;
271   for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
272     {
273       if ((key->as_uword[i] ^ dest->as_uword[i]) & im->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]) & im->fib_masks[dest_length].as_uword[i])
299         return 0;
300     }
301   return 1;
302 }
303
304 always_inline int
305 ip6_src_address_for_packet (ip_lookup_main_t * lm,
306                             u32 sw_if_index,
307                             ip6_address_t * src)
308 {
309     u32 if_add_index = 
310         lm->if_address_pool_index_by_sw_if_index[sw_if_index];
311     if (PREDICT_TRUE(if_add_index != ~0)) {
312         ip_interface_address_t *if_add = 
313             pool_elt_at_index(lm->if_address_pool, if_add_index);
314         ip6_address_t *if_ip = 
315             ip_interface_address_get_address(lm, if_add);
316         *src = *if_ip;
317         return (0);
318     }
319     else
320     {
321         src->as_u64[0] = 0;
322         src->as_u64[1] = 0;
323     }
324     return (!0);
325 }
326
327 /* Find interface address which matches destination. */
328 always_inline ip6_address_t *
329 ip6_interface_address_matching_destination (ip6_main_t * im, ip6_address_t * dst, u32 sw_if_index,
330                                             ip_interface_address_t ** result_ia)
331 {
332   ip_lookup_main_t * lm = &im->lookup_main;
333   ip_interface_address_t * ia;
334   ip6_address_t * result = 0;
335
336   foreach_ip_interface_address (lm, ia, sw_if_index, 
337                                 1 /* honor unnumbered */,
338   ({
339     ip6_address_t * a = ip_interface_address_get_address (lm, ia);
340     if (ip6_destination_matches_route (im, dst, a, ia->address_length))
341       {
342         result = a;
343         break;
344       }
345   }));
346   if (result_ia)
347     *result_ia = result ? ia : 0;
348   return result;
349 }
350
351 clib_error_t *
352 ip6_add_del_interface_address (vlib_main_t * vm, u32 sw_if_index,
353                                ip6_address_t * address, u32 address_length,
354                                u32 is_del);
355 void
356 ip6_sw_interface_enable_disable (u32 sw_if_index,
357                                  u32 is_enable);
358
359 int ip6_address_compare (ip6_address_t * a1, ip6_address_t * a2);
360
361 clib_error_t *
362 ip6_probe_neighbor (vlib_main_t * vm, ip6_address_t * dst, u32 sw_if_index);
363
364 clib_error_t *
365 ip6_set_neighbor_limit (u32 neighbor_limit);
366
367 uword
368 ip6_udp_register_listener (vlib_main_t * vm,
369                            u16 dst_port,
370                            u32 next_node_index);
371
372 u16 ip6_tcp_udp_icmp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0, ip6_header_t * ip0, int *bogus_lengthp);
373
374 void ip6_register_protocol (u32 protocol, u32 node_index);
375
376 serialize_function_t serialize_vnet_ip6_main, unserialize_vnet_ip6_main;
377
378 int
379 vnet_set_ip6_ethernet_neighbor (vlib_main_t * vm,
380                                 u32 sw_if_index,
381                                 ip6_address_t * a,
382                                 u8 * link_layer_address,
383                                 uword n_bytes_link_layer_address,
384                                 int is_static);
385 int
386 vnet_unset_ip6_ethernet_neighbor (vlib_main_t * vm,
387                                   u32 sw_if_index,
388                                   ip6_address_t * a,
389                                   u8 * link_layer_address,
390                                   uword n_bytes_link_layer_address);
391
392 void 
393 ip6_link_local_address_from_ethernet_mac_address (ip6_address_t *ip,
394                                                   u8 *mac);
395
396 void 
397 ip6_ethernet_mac_address_from_link_local_address (u8 *mac, 
398                                                   ip6_address_t *ip);
399
400 int vnet_set_ip6_flow_hash (u32 table_id,
401                             flow_hash_config_t flow_hash_config);
402
403 int
404 ip6_neighbor_ra_config(vlib_main_t * vm, u32 sw_if_index, 
405                        u8 suppress, u8 managed, u8 other,
406                        u8 ll_option,  u8 send_unicast,  u8 cease, 
407                        u8 use_lifetime,  u32 lifetime,
408                        u32 initial_count,  u32 initial_interval,  
409                        u32 max_interval,  u32 min_interval,
410                        u8 is_no);
411
412 int
413 ip6_neighbor_ra_prefix(vlib_main_t * vm, u32 sw_if_index,  
414                        ip6_address_t *prefix_addr,  u8 prefix_len,
415                        u8 use_default,  u32 val_lifetime, u32 pref_lifetime,
416                        u8 no_advertise,  u8 off_link, u8 no_autoconfig, u8 no_onlink,
417                        u8 is_no);
418
419
420 clib_error_t *
421 enable_ip6_interface(vlib_main_t * vm,
422                      u32 sw_if_index);
423
424 clib_error_t * 
425 disable_ip6_interface(vlib_main_t * vm,
426                      u32 sw_if_index);
427
428 int
429 ip6_interface_enabled(vlib_main_t * vm,
430                       u32 sw_if_index);
431
432 clib_error_t *
433 set_ip6_link_local_address(vlib_main_t * vm,
434                            u32 sw_if_index,
435                            ip6_address_t *address,
436                            u8 address_length);
437
438 void vnet_register_ip6_neighbor_resolution_event(vnet_main_t * vnm, 
439                                                  void * address_arg,
440                                                  uword node_index,
441                                                  uword type_opaque,
442                                                  uword data);
443
444 int vnet_add_del_ip6_nd_change_event (vnet_main_t * vnm, 
445                                       void * data_callback,
446                                       u32 pid,
447                                       void * address_arg,
448                                       uword node_index,
449                                       uword type_opaque,
450                                       uword data, 
451                                       int is_add);
452
453 int vnet_ip6_nd_term (vlib_main_t * vm,
454                       vlib_node_runtime_t * node,
455                       vlib_buffer_t * p0,
456                       ethernet_header_t * eth,
457                       ip6_header_t * ip,
458                       u32 sw_if_index,
459                       u16 bd_index,
460                       u8 shg);
461
462 int vnet_set_ip6_classify_intfc (vlib_main_t * vm, u32 sw_if_index, 
463                                  u32 table_index);
464 extern vlib_node_registration_t ip6_lookup_node;
465
466 /* Compute flow hash.  We'll use it to select which Sponge to use for this
467    flow.  And other things. */
468 always_inline u32
469 ip6_compute_flow_hash (const ip6_header_t * ip,
470                        flow_hash_config_t flow_hash_config)
471 {
472     tcp_header_t * tcp = (void *) (ip + 1);
473     u64 a, b, c;
474     u64 t1, t2;
475     uword is_tcp_udp = (ip->protocol == IP_PROTOCOL_TCP
476                         || ip->protocol == IP_PROTOCOL_UDP);
477
478     t1 = (ip->src_address.as_u64[0] ^ ip->src_address.as_u64[1]);
479     t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR) ? t1 : 0;
480     
481     t2 = (ip->dst_address.as_u64[0] ^ ip->dst_address.as_u64[1]);
482     t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR) ? t2 : 0;
483     
484     a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
485     b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
486     b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? ip->protocol : 0;
487
488     t1 = is_tcp_udp ? tcp->ports.src : 0;
489     t2 = is_tcp_udp ? tcp->ports.dst : 0;
490
491     t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
492     t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
493     
494     c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
495         ((t1<<16) | t2) : ((t2<<16) | t1);
496
497     hash_mix64 (a, b, c);
498     return (u32) c;
499 }
500
501 /*
502  * Hop-by-Hop handling
503  */
504 typedef struct {
505   /* Array of function pointers to HBH option handling routines */
506   int (*options[256])(vlib_buffer_t *b, ip6_header_t *ip, ip6_hop_by_hop_option_t *opt);
507   u8 *(*trace[256])(u8 *s, ip6_hop_by_hop_option_t *opt);
508   uword next_override;
509 } ip6_hop_by_hop_main_t;
510
511 extern ip6_hop_by_hop_main_t ip6_hop_by_hop_main;
512
513 int ip6_hbh_register_option (u8 option,
514                              int options(vlib_buffer_t *b, ip6_header_t *ip, ip6_hop_by_hop_option_t *opt),
515                              u8 *trace(u8 *s, ip6_hop_by_hop_option_t *opt));
516 int ip6_hbh_unregister_option (u8 option);
517 void ip6_hbh_set_next_override (uword next);
518
519 /* Flag used by IOAM code. Classifier sets it pop-hop-by-hop checks it */
520 #define OI_DECAP   100
521
522 #endif /* included_ip_ip6_h */