policer classify
[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 <vnet/ip/ip6_packet.h>
45 #include <vnet/ip/ip6_hop_by_hop_packet.h>
46 #include <vnet/ip/lookup.h>
47 #include <vnet/ip/ip_feature_registration.h>
48 #include <stdbool.h>
49 #include <vppinfra/bihash_24_8.h>
50 #include <vppinfra/bihash_template.h>
51
52 /*
53  * Default size of the ip6 fib hash table
54  */
55 #define IP6_FIB_DEFAULT_HASH_NUM_BUCKETS (64 * 1024)
56 #define IP6_FIB_DEFAULT_HASH_MEMORY_SIZE (32<<20)
57
58 typedef struct {
59   ip6_address_t addr;
60   u32 dst_address_length;
61   u32 vrf_index;
62 } ip6_fib_key_t;
63
64 typedef struct {
65   /* Table ID (hash key) for this FIB. */
66   u32 table_id;
67
68   /* Index into FIB vector. */
69   u32 index;
70
71   /* flow hash configuration */
72   u32 flow_hash_config;
73 } ip6_fib_t;
74
75 struct ip6_main_t;
76
77 typedef void (ip6_add_del_route_function_t)
78   (struct ip6_main_t * im,
79    uword opaque,
80    ip6_fib_t * fib,
81    u32 flags,
82    ip6_address_t * address,
83    u32 address_length,
84    void * old_result,
85    void * new_result);
86
87 typedef struct {
88   ip6_add_del_route_function_t * function;
89   uword required_flags;
90   uword function_opaque;
91 } ip6_add_del_route_callback_t;
92
93 typedef void (ip6_add_del_interface_address_function_t)
94   (struct ip6_main_t * im,
95    uword opaque,
96    u32 sw_if_index,
97    ip6_address_t * address,
98    u32 address_length,
99    u32 if_address_index,
100    u32 is_del);
101
102 typedef struct {
103   ip6_add_del_interface_address_function_t * function;
104   uword function_opaque;
105 } ip6_add_del_interface_address_callback_t;
106
107 typedef struct ip6_main_t {
108   BVT(clib_bihash) ip6_lookup_table;
109
110   ip_lookup_main_t lookup_main;
111
112   /* bitmap / refcounts / vector of mask widths to search */
113   uword * non_empty_dst_address_length_bitmap;
114   u8 * prefix_lengths_in_search_order;
115   i32 dst_address_length_refcounts[129];
116   
117   /* Vector of FIBs. */
118   ip6_fib_t * fibs;
119
120   ip6_address_t fib_masks[129];
121
122   /* Table index indexed by software interface. */
123   u32 * fib_index_by_sw_if_index;
124
125   /* Hash table mapping table id to fib index.
126      ID space is not necessarily dense; index space is dense. */
127   uword * fib_index_by_table_id;
128
129   /* Vector of functions to call when routes are added/deleted. */
130   ip6_add_del_route_callback_t * add_del_route_callbacks;
131
132   /* Hash table mapping interface rewrite adjacency index by sw if index. */
133   uword * interface_route_adj_index_by_sw_if_index;
134
135   /* Functions to call when interface address changes. */
136   ip6_add_del_interface_address_callback_t * add_del_interface_address_callbacks;
137
138   /* Template used to generate IP6 neighbor solicitation packets. */
139   vlib_packet_template_t discover_neighbor_packet_template;
140
141   /* ip6 lookup table config parameters */
142   u32 lookup_table_nbuckets;
143   uword lookup_table_size;
144
145   /* feature path configuration lists */
146   vnet_ip_feature_registration_t * next_uc_feature;
147   vnet_ip_feature_registration_t * next_mc_feature;
148
149   /* Built-in unicast feature path indices, see ip_feature_init_cast(...)  */
150   u32 ip6_unicast_rx_feature_check_access;
151   u32 ip6_unicast_rx_feature_policer_classify;
152   u32 ip6_unicast_rx_feature_ipsec;
153   u32 ip6_unicast_rx_feature_l2tp_decap;
154   u32 ip6_unicast_rx_feature_vpath;
155   u32 ip6_unicast_rx_feature_lookup;
156
157   /* Built-in multicast feature path indices */
158   u32 ip6_multicast_rx_feature_vpath;
159   u32 ip6_multicast_rx_feature_lookup;
160
161   /* Save results for show command */
162   char ** feature_nodes[VNET_N_CAST];
163
164   /* Seed for Jenkins hash used to compute ip6 flow hash. */
165   u32 flow_hash_seed;
166
167   struct {
168     /* TTL to use for host generated packets. */
169     u8 ttl;
170
171     u8 pad[3];
172   } host_config;
173
174   /* HBH processing enabled? */
175   u8 hbh_enabled;
176 } ip6_main_t;
177
178 /* Global ip6 main structure. */
179 extern ip6_main_t ip6_main;
180
181 #define VNET_IP6_UNICAST_FEATURE_INIT(x,...)                    \
182   __VA_ARGS__ vnet_ip_feature_registration_t uc_##x;            \
183 static void __vnet_add_feature_registration_uc_##x (void)       \
184   __attribute__((__constructor__)) ;                            \
185 static void __vnet_add_feature_registration_uc_##x (void)       \
186 {                                                               \
187   ip6_main_t * im = &ip6_main;                                  \
188   uc_##x.next = im->next_uc_feature;                            \
189   im->next_uc_feature = &uc_##x;                                \
190 }                                                               \
191 __VA_ARGS__ vnet_ip_feature_registration_t uc_##x 
192
193 #define VNET_IP6_MULTICAST_FEATURE_INIT(x,...)                  \
194   __VA_ARGS__ vnet_ip_feature_registration_t mc_##x;            \
195 static void __vnet_add_feature_registration_mc_##x (void)       \
196   __attribute__((__constructor__)) ;                            \
197 static void __vnet_add_feature_registration_mc_##x (void)       \
198 {                                                               \
199   ip6_main_t * im = &ip6_main;                                  \
200   mc_##x.next = im->next_mc_feature;                            \
201   im->next_mc_feature = &mc_##x;                                \
202 }                                                               \
203 __VA_ARGS__ vnet_ip_feature_registration_t mc_##x 
204
205 /* Global ip6 input node.  Errors get attached to ip6 input node. */
206 extern vlib_node_registration_t ip6_input_node;
207 extern vlib_node_registration_t ip6_rewrite_node;
208 extern vlib_node_registration_t ip6_rewrite_local_node;
209 extern vlib_node_registration_t ip6_discover_neighbor_node;
210
211 extern vlib_node_registration_t ip6_icmp_neighbor_discovery_event_node;
212
213 /* ipv6 neighbor discovery - timer/event types */
214 typedef enum {
215   ICMP6_ND_EVENT_INIT,
216 } ip6_icmp_neighbor_discovery_event_type_t;
217
218 typedef union {
219   u32 add_del_swindex;
220   struct {
221     u32 up_down_swindex;
222     u32 fib_index;
223   } up_down_event;
224 } ip6_icmp_neighbor_discovery_event_data_t;
225
226 u32 ip6_fib_lookup (ip6_main_t * im, u32 sw_if_index, ip6_address_t * dst);
227 u32 ip6_fib_lookup_with_table (ip6_main_t * im, u32 fib_index, 
228                                ip6_address_t * dst);
229
230 /**
231  * \brief Get or create an IPv6 fib.
232  *
233  * Get or create an IPv6 fib with the provided fib ID or index.
234  * The fib ID is a possibly-sparse user-defined value while
235  * the fib index defines the position of the fib in the fib vector.
236  *
237  * \param im
238  *      ip6_main pointer.
239  * \param table_index_or_id
240  *      The table index if \c IP6_ROUTE_FLAG_FIB_INDEX bit is set in \p flags.
241  *      Otherwise, when set to \c ~0, an arbitrary and unused fib ID is picked
242  *      and can be retrieved with \c ret->table_id.
243  *      Otherwise, it is the fib ID to be used to retrieve or create the desired fib.
244  * \param flags
245  *      Indicates whether \p table_index_or_id is the fib index or ID.
246  *      When the bit \c IP6_ROUTE_FLAG_FIB_INDEX is set, \p table_index_or_id
247  *      is considered as the fib index, and the fib ID otherwise.
248  * \return A pointer to the retrieved or created fib.
249  *
250  * \remark When getting a fib with the fib index, the fib MUST already exist.
251  */
252 ip6_fib_t * find_ip6_fib_by_table_index_or_id (ip6_main_t * im, 
253                                                u32 table_index_or_id, 
254                                                u32 flags);
255
256 always_inline uword
257 ip6_destination_matches_route (ip6_main_t * im,
258                                ip6_address_t * key,
259                                ip6_address_t * dest,
260                                uword dest_length)
261 {
262   int i;
263   for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
264     {
265       if ((key->as_uword[i] ^ dest->as_uword[i]) & im->fib_masks[dest_length].as_uword[i])
266         return 0;
267     }
268   return 1;
269 }
270
271 always_inline uword
272 ip6_destination_matches_interface (ip6_main_t * im,
273                                    ip6_address_t * key,
274                                    ip_interface_address_t * ia)
275 {
276   ip6_address_t * a = ip_interface_address_get_address (&im->lookup_main, ia);
277   return ip6_destination_matches_route (im, key, a, ia->address_length);
278 }
279
280 /* As above but allows for unaligned destinations (e.g. works right from IP header of packet). */
281 always_inline uword
282 ip6_unaligned_destination_matches_route (ip6_main_t * im,
283                                          ip6_address_t * key,
284                                          ip6_address_t * dest,
285                                          uword dest_length)
286 {
287   int i;
288   for (i = 0; i < ARRAY_LEN (key->as_uword); i++)
289     {
290       if ((clib_mem_unaligned (&key->as_uword[i], uword) ^ dest->as_uword[i]) & im->fib_masks[dest_length].as_uword[i])
291         return 0;
292     }
293   return 1;
294 }
295
296 always_inline int
297 ip6_src_address_for_packet (ip6_main_t * im, vlib_buffer_t * p, ip6_address_t * src, u32 sw_if_index)
298 {
299   ip_lookup_main_t * lm = &im->lookup_main;
300   ip_interface_address_t * ia = ip_interface_address_for_packet (lm, p, sw_if_index);
301   if (ia == NULL)
302     return -1;
303   ip6_address_t * a = ip_interface_address_get_address (lm, ia);
304   *src = a[0];
305   return 0;
306 }
307
308 always_inline u32
309 ip6_src_lookup_for_packet (ip6_main_t * im, vlib_buffer_t * b, ip6_header_t * i)
310 {
311   if (vnet_buffer (b)->ip.adj_index[VLIB_RX] == ~0)
312     vnet_buffer (b)->ip.adj_index[VLIB_RX]
313       = ip6_fib_lookup (im, vnet_buffer (b)->sw_if_index[VLIB_RX],
314                         &i->src_address);
315   return vnet_buffer (b)->ip.adj_index[VLIB_RX];
316 }
317
318 /* Find interface address which matches destination. */
319 always_inline ip6_address_t *
320 ip6_interface_address_matching_destination (ip6_main_t * im, ip6_address_t * dst, u32 sw_if_index,
321                                             ip_interface_address_t ** result_ia)
322 {
323   ip_lookup_main_t * lm = &im->lookup_main;
324   ip_interface_address_t * ia;
325   ip6_address_t * result = 0;
326
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   if (result_ia)
338     *result_ia = result ? ia : 0;
339   return result;
340 }
341
342 clib_error_t *
343 ip6_add_del_interface_address (vlib_main_t * vm, u32 sw_if_index,
344                                ip6_address_t * address, u32 address_length,
345                                u32 is_del);
346
347 int ip6_address_compare (ip6_address_t * a1, ip6_address_t * a2);
348
349 /* Add/del a route to the FIB. */
350
351 #define IP6_ROUTE_FLAG_ADD (0 << 0)
352 #define IP6_ROUTE_FLAG_DEL (1 << 0)
353 #define IP6_ROUTE_FLAG_TABLE_ID  (0 << 1)
354 #define IP6_ROUTE_FLAG_FIB_INDEX (1 << 1)
355 #define IP6_ROUTE_FLAG_KEEP_OLD_ADJACENCY (1 << 2)
356 #define IP6_ROUTE_FLAG_NO_REDISTRIBUTE (1 << 3)
357 #define IP6_ROUTE_FLAG_NOT_LAST_IN_GROUP (1 << 4)
358 /* Dynamic route created via neighbor discovery. */
359 #define IP6_ROUTE_FLAG_NEIGHBOR (1 << 5)
360
361 typedef struct {
362   /* IP6_ROUTE_FLAG_* */
363   u32 flags;
364
365   /* Either index of fib or table_id to hash and get fib.
366      IP6_ROUTE_FLAG_FIB_INDEX specifies index; otherwise table_id is assumed. */
367   u32 table_index_or_table_id;
368
369   /* Destination address (prefix) and length. */
370   ip6_address_t dst_address;
371   u32 dst_address_length;
372
373   /* Adjacency to use for this destination. */
374   u32 adj_index;
375
376   /* If specified adjacencies to add and then
377      use for this destination.  add_adj/n_add_adj
378      are override adj_index if specified. */
379   ip_adjacency_t * add_adj;
380   u32 n_add_adj;
381 } ip6_add_del_route_args_t;
382
383 void ip6_add_del_route (ip6_main_t * im, ip6_add_del_route_args_t * args);
384
385 void ip6_add_del_route_next_hop (ip6_main_t * im,
386                                  u32 flags,
387                                  ip6_address_t * dst_address,
388                                  u32 dst_address_length,
389                                  ip6_address_t * next_hop,
390                                  u32 next_hop_sw_if_index,
391                                  u32 next_hop_weight, u32 adj_index,
392                                  u32 explicit_fib_index);
393
394 u32
395 ip6_route_get_next_hop_adj (ip6_main_t * im,
396                             u32 fib_index,
397                             ip6_address_t *next_hop,
398                             u32 next_hop_sw_if_index,
399                             u32 explicit_fib_index);
400
401 u32
402 ip6_get_route (ip6_main_t * im,
403                u32 fib_index_or_table_id,
404                u32 flags,
405                ip6_address_t * address,
406                u32 address_length);
407
408 void
409 ip6_foreach_matching_route (ip6_main_t * im,
410                             u32 table_index_or_table_id,
411                             u32 flags,
412                             ip6_address_t * address,
413                             u32 address_length,
414                             ip6_address_t ** results,
415                             u8 ** result_length);
416
417 void ip6_delete_matching_routes (ip6_main_t * im,
418                                  u32 table_index_or_table_id,
419                                  u32 flags,
420                                  ip6_address_t * address,
421                                  u32 address_length);
422
423 void ip6_maybe_remap_adjacencies (ip6_main_t * im,
424                                   u32 table_index_or_table_id,
425                                   u32 flags);
426
427 void ip6_adjacency_set_interface_route (vnet_main_t * vnm,
428                                         ip_adjacency_t * adj,
429                                         u32 sw_if_index,
430                                         u32 if_address_index);
431
432 u32
433 vnet_ip6_neighbor_glean_add(u32 fib_index, void * next_hop_arg);
434
435 clib_error_t *
436 ip6_probe_neighbor (vlib_main_t * vm, ip6_address_t * dst, u32 sw_if_index);
437
438 clib_error_t *
439 ip6_set_neighbor_limit (u32 neighbor_limit);
440
441 uword
442 ip6_udp_register_listener (vlib_main_t * vm,
443                            u16 dst_port,
444                            u32 next_node_index);
445
446 u16 ip6_tcp_udp_icmp_compute_checksum (vlib_main_t * vm, vlib_buffer_t * p0, ip6_header_t * ip0, int *bogus_lengthp);
447
448 void ip6_register_protocol (u32 protocol, u32 node_index);
449
450 serialize_function_t serialize_vnet_ip6_main, unserialize_vnet_ip6_main;
451
452 int
453 vnet_set_ip6_ethernet_neighbor (vlib_main_t * vm,
454                                 u32 sw_if_index,
455                                 ip6_address_t * a,
456                                 u8 * link_layer_address,
457                                 uword n_bytes_link_layer_address,
458                                 int is_static);
459 int
460 vnet_unset_ip6_ethernet_neighbor (vlib_main_t * vm,
461                                   u32 sw_if_index,
462                                   ip6_address_t * a,
463                                   u8 * link_layer_address,
464                                   uword n_bytes_link_layer_address);
465 void
466 vnet_ip6_fib_init (ip6_main_t * im, u32 fib_index);
467
468 void 
469 ip6_link_local_address_from_ethernet_mac_address (ip6_address_t *ip,
470                                                   u8 *mac);
471
472 void 
473 ip6_ethernet_mac_address_from_link_local_address (u8 *mac, 
474                                                   ip6_address_t *ip);
475
476 int vnet_set_ip6_flow_hash (u32 table_id, u32 flow_hash_config);
477
478 int
479 ip6_neighbor_ra_config(vlib_main_t * vm, u32 sw_if_index, 
480                        u8 suppress, u8 managed, u8 other,
481                        u8 ll_option,  u8 send_unicast,  u8 cease, 
482                        u8 use_lifetime,  u32 lifetime,
483                        u32 initial_count,  u32 initial_interval,  
484                        u32 max_interval,  u32 min_interval,
485                        u8 is_no);
486
487 int
488 ip6_neighbor_ra_prefix(vlib_main_t * vm, u32 sw_if_index,  
489                        ip6_address_t *prefix_addr,  u8 prefix_len,
490                        u8 use_default,  u32 val_lifetime, u32 pref_lifetime,
491                        u8 no_advertise,  u8 off_link, u8 no_autoconfig, u8 no_onlink,
492                        u8 is_no);
493
494
495 clib_error_t *
496 enable_ip6_interface(vlib_main_t * vm,
497                      u32 sw_if_index);
498
499 clib_error_t * 
500 disable_ip6_interface(vlib_main_t * vm,
501                      u32 sw_if_index);
502
503 int
504 ip6_interface_enabled(vlib_main_t * vm,
505                       u32 sw_if_index);
506
507 clib_error_t *
508 set_ip6_link_local_address(vlib_main_t * vm,
509                            u32 sw_if_index,
510                            ip6_address_t *address,
511                            u8 address_length);
512
513 void vnet_register_ip6_neighbor_resolution_event(vnet_main_t * vnm, 
514                                                  void * address_arg,
515                                                  uword node_index,
516                                                  uword type_opaque,
517                                                  uword data);
518
519 int vnet_set_ip6_classify_intfc (vlib_main_t * vm, u32 sw_if_index, 
520                                  u32 table_index);
521 extern vlib_node_registration_t ip6_lookup_node;
522
523 /* Compute flow hash.  We'll use it to select which Sponge to use for this
524    flow.  And other things. */
525 always_inline u32
526 ip6_compute_flow_hash (ip6_header_t * ip, u32 flow_hash_config)
527 {
528     tcp_header_t * tcp = (void *) (ip + 1);
529     u64 a, b, c;
530     u64 t1, t2;
531     uword is_tcp_udp = (ip->protocol == IP_PROTOCOL_TCP
532                         || ip->protocol == IP_PROTOCOL_UDP);
533
534     t1 = (ip->src_address.as_u64[0] ^ ip->src_address.as_u64[1]);
535     t1 = (flow_hash_config & IP_FLOW_HASH_SRC_ADDR) ? t1 : 0;
536     
537     t2 = (ip->dst_address.as_u64[0] ^ ip->dst_address.as_u64[1]);
538     t2 = (flow_hash_config & IP_FLOW_HASH_DST_ADDR) ? t2 : 0;
539     
540     a = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t2 : t1;
541     b = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ? t1 : t2;
542     b ^= (flow_hash_config & IP_FLOW_HASH_PROTO) ? ip->protocol : 0;
543
544     t1 = is_tcp_udp ? tcp->ports.src : 0;
545     t2 = is_tcp_udp ? tcp->ports.dst : 0;
546
547     t1 = (flow_hash_config & IP_FLOW_HASH_SRC_PORT) ? t1 : 0;
548     t2 = (flow_hash_config & IP_FLOW_HASH_DST_PORT) ? t2 : 0;
549     
550     c = (flow_hash_config & IP_FLOW_HASH_REVERSE_SRC_DST) ?
551         ((t1<<16) | t2) : ((t2<<16) | t1);
552
553     hash_mix64 (a, b, c);
554     return (u32) c;
555 }
556
557 /*
558  * Hop-by-Hop handling
559  */
560 typedef struct {
561   /* Array of function pointers to HBH option handling routines */
562   int (*options[256])(vlib_buffer_t *b, ip6_header_t *ip, ip6_hop_by_hop_option_t *opt);
563   u8 *(*trace[256])(u8 *s, ip6_hop_by_hop_option_t *opt);
564 } ip6_hop_by_hop_main_t;
565
566 extern ip6_hop_by_hop_main_t ip6_hop_by_hop_main;
567
568 int ip6_hbh_register_option (u8 option,
569                              int options(vlib_buffer_t *b, ip6_header_t *ip, ip6_hop_by_hop_option_t *opt),
570                              u8 *trace(u8 *s, ip6_hop_by_hop_option_t *opt));
571 int ip6_hbh_unregister_option (u8 option);
572
573 /* Flag used by IOAM code. Classifier sets it pop-hop-by-hop checks it */
574 #define OI_DECAP   100
575
576 #endif /* included_ip_ip6_h */