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