src/vnet/ipip/sixrd.c

   1 /*
   2  * sixrd.c - 6RD specific functions (RFC5969)
   3  *
   4  * Copyright (c) 2018 Cisco and/or its affiliates.
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at:
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18 /**
  19  * This code supports the following sixrd modes:
  20  *
  21  * 32 EA bits (Complete IPv4 address is embedded):
  22  *   ea_bits_len = 32
  23  * IPv4 suffix is embedded:
  24  *   ea_bits_len = < 32
  25  * No embedded address bits (1:1 mode):
  26  *   ea_bits_len = 0
  27  */
  28
  29 #include "ipip.h"
  30 #include <vlibapi/api.h>
  31 #include <vlibmemory/api.h>
  32 #include <vnet/adj/adj.h>
  33 #include <vnet/adj/adj_delegate.h>
  34 #include <vnet/adj/adj_midchain.h>
  35 #include <vnet/dpo/lookup_dpo.h>
  36 #include <vnet/fib/fib_table.h>
  37 #include <vnet/fib/ip6_fib.h>
  38 #include <vnet/plugin/plugin.h>
  39 #include <vpp/app/version.h>    // Really needed?
  40
  41 extern vlib_node_registration_t ip4_sixrd_node;
  42
  43 /**
  44  * Adj delegate data
  45  */
  46 typedef struct sixrd_adj_delegate_t_
  47 {
  48   u32 adj_index;
  49   fib_node_t sixrd_node;
  50   fib_node_index_t sixrd_fib_entry_index;
  51   u32 sixrd_sibling;
  52 } sixrd_adj_delegate_t;
  53
  54 /**
  55  * Pool of delegate structs
  56  */
  57 static sixrd_adj_delegate_t *sixrd_adj_delegate_pool;
  58
  59 /**
  60  * Adj delegate registered type
  61  */
  62 static adj_delegate_type_t sixrd_adj_delegate_type;
  63
  64 /**
  65  * FIB node registered type
  66  */
  67 static fib_node_type_t sixrd_fib_node_type;
  68
  69 static inline sixrd_adj_delegate_t *
  70 sixrd_adj_from_base (adj_delegate_t * ad)
  71 {
  72   if (ad == NULL)
  73     return (NULL);
  74   return (pool_elt_at_index (sixrd_adj_delegate_pool, ad->ad_index));
  75 }
  76
  77 static inline const sixrd_adj_delegate_t *
  78 sixrd_adj_from_const_base (const adj_delegate_t * ad)
  79 {
  80   if (ad == NULL)
  81     {
  82       return (NULL);
  83     }
  84   return (pool_elt_at_index (sixrd_adj_delegate_pool, ad->ad_index));
  85 }
  86
  87 static void
  88 sixrd_fixup (vlib_main_t * vm, ip_adjacency_t * adj, vlib_buffer_t * b0,
  89              const void *data)
  90 {
  91   ip4_header_t *ip4 = vlib_buffer_get_current (b0);
  92   ip6_header_t *ip6 = vlib_buffer_get_current (b0) + sizeof (ip4_header_t);
  93   const ipip_tunnel_t *t = data;
  94
  95   ip4->length = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
  96   ip4->dst_address.as_u32 =
  97     sixrd_get_addr_net (t, ip6->dst_address.as_u64[0]);
  98   ip4->checksum = ip4_header_checksum (ip4);
  99 }
 100
 101 static void
 102 ip6ip_fixup (vlib_main_t * vm, ip_adjacency_t * adj, vlib_buffer_t * b0,
 103              const void *data)
 104 {
 105   const ipip_tunnel_t *t = data;
 106   ip4_header_t *ip4 = vlib_buffer_get_current (b0);
 107   ip4->length = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
 108   ip4->dst_address.as_u32 =
 109     sixrd_get_addr_net (t, adj->sub_type.nbr.next_hop.as_u64[0]);
 110   ip4->checksum = ip4_header_checksum (ip4);
 111 }
 112
 113 static u8 *
 114 sixrd_build_rewrite (vnet_main_t * vnm, u32 sw_if_index,
 115                      vnet_link_t link_type, const void *dst_address)
 116 {
 117   u8 *rewrite = NULL;
 118   ipip_tunnel_t *t;
 119
 120   t = ipip_tunnel_db_find_by_sw_if_index (sw_if_index);
 121   if (!t)
 122     return 0;
 123
 124   vec_validate (rewrite, sizeof (ip4_header_t) - 1);
 125   ip4_header_t *ip4 = (ip4_header_t *) rewrite;
 126   ip4->ip_version_and_header_length = 0x45;
 127   ip4->ttl = 64;
 128   ip4->protocol = IP_PROTOCOL_IPV6;
 129   /* fixup ip4 header length and checksum after-the-fact */
 130   ip4->src_address.as_u32 = t->tunnel_src.ip4.as_u32;
 131   ip4->dst_address.as_u32 = 0;
 132   ip4->checksum = ip4_header_checksum (ip4);
 133
 134   return rewrite;
 135 }
 136
 137 static void
 138 ip6ip_tunnel_stack (adj_index_t ai, u32 fib_entry_index)
 139 {
 140   ip_adjacency_t *adj = adj_get (ai);
 141   ipip_tunnel_t *t;
 142   u32 sw_if_index = adj->rewrite_header.sw_if_index;
 143
 144   t = ipip_tunnel_db_find_by_sw_if_index (sw_if_index);
 145   if (!t)
 146     return;
 147
 148   /*
 149    * find the adjacency that is contributed by the FIB entry
 150    * that this tunnel resolves via, and use it as the next adj
 151    * in the midchain
 152    */
 153   if (vnet_hw_interface_get_flags (vnet_get_main (), t->hw_if_index) &
 154       VNET_HW_INTERFACE_FLAG_LINK_UP)
 155     {
 156       adj_nbr_midchain_stack (ai,
 157                               fib_entry_contribute_ip_forwarding
 158                               (fib_entry_index));
 159     }
 160   else
 161     {
 162       adj_nbr_midchain_unstack (ai);
 163     }
 164 }
 165
 166 static void
 167 sixrd_tunnel_stack (adj_index_t ai, u32 fib_index)
 168 {
 169   dpo_id_t dpo = DPO_INVALID;
 170   ip_adjacency_t *adj = adj_get (ai);
 171   u32 sw_if_index = adj->rewrite_header.sw_if_index;
 172
 173   ipip_tunnel_t *t = ipip_tunnel_db_find_by_sw_if_index (sw_if_index);
 174   if (!t)
 175     return;
 176
 177   lookup_dpo_add_or_lock_w_fib_index (fib_index, DPO_PROTO_IP4,
 178                                       LOOKUP_UNICAST, LOOKUP_INPUT_DST_ADDR,
 179                                       LOOKUP_TABLE_FROM_CONFIG, &dpo);
 180   adj_nbr_midchain_stack (ai, &dpo);
 181 }
 182
 183 const static ip46_address_t sixrd_special_nh = {
 184   .ip6 = {
 185           .as_u64 = {
 186                      [0] = 0xffffffffffffffff,
 187                      [1] = 0xffffffffffffffff,
 188                      },
 189           },
 190 };
 191
 192 static void
 193 sixrd_update_adj (vnet_main_t * vnm, u32 sw_if_index, adj_index_t ai)
 194 {
 195   ip_adjacency_t *adj = adj_get (ai);
 196   ipip_tunnel_t *t = ipip_tunnel_db_find_by_sw_if_index (sw_if_index);
 197
 198   /* Not our tunnel */
 199   if (!t)
 200     return;
 201   if (!memcmp (&sixrd_special_nh, &adj->sub_type.nbr.next_hop,
 202                sizeof (sixrd_special_nh)))
 203     {
 204       adj_nbr_midchain_update_rewrite (ai, sixrd_fixup, t, ADJ_FLAG_NONE,
 205                                        sixrd_build_rewrite (vnm, sw_if_index,
 206                                                             adj_get_link_type
 207                                                             (ai), NULL));
 208       sixrd_tunnel_stack (ai, t->fib_index);
 209     }
 210   else
 211     {
 212       sixrd_adj_delegate_t *sixrd_ad;
 213       ip4_address_t da4;
 214
 215       da4.as_u32 =
 216         sixrd_get_addr_net (t, adj->sub_type.nbr.next_hop.as_u64[0]);
 217
 218       fib_prefix_t pfx = {
 219         .fp_proto = FIB_PROTOCOL_IP4,
 220         .fp_len = 32,
 221         .fp_addr = {
 222                     .ip4 = da4,
 223                     }
 224         ,
 225       };
 226
 227       adj_nbr_midchain_update_rewrite (ai, ip6ip_fixup, t, ADJ_FLAG_NONE,
 228                                        sixrd_build_rewrite (vnm, sw_if_index,
 229                                                             adj_get_link_type
 230                                                             (ai), NULL));
 231
 232       sixrd_ad =
 233         sixrd_adj_from_base (adj_delegate_get (adj, sixrd_adj_delegate_type));
 234       if (sixrd_ad == NULL)
 235         {
 236           pool_get (sixrd_adj_delegate_pool, sixrd_ad);
 237           fib_node_init (&sixrd_ad->sixrd_node, sixrd_fib_node_type);
 238           sixrd_ad->adj_index = ai;
 239           sixrd_ad->sixrd_fib_entry_index =
 240             fib_table_entry_special_add (t->fib_index, &pfx, FIB_SOURCE_RR,
 241                                          FIB_ENTRY_FLAG_NONE);
 242           sixrd_ad->sixrd_sibling =
 243             fib_entry_child_add (sixrd_ad->sixrd_fib_entry_index,
 244                                  sixrd_fib_node_type,
 245                                  sixrd_ad - sixrd_adj_delegate_pool);
 246
 247           adj_delegate_add (adj, sixrd_adj_delegate_type,
 248                             sixrd_ad - sixrd_adj_delegate_pool);
 249
 250           ip6ip_tunnel_stack (ai, sixrd_ad->sixrd_fib_entry_index);
 251         }
 252     }
 253 }
 254
 255 clib_error_t *
 256 sixrd_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
 257 {
 258   /* Always up */
 259   vnet_hw_interface_set_flags (vnm, hw_if_index,
 260                                VNET_HW_INTERFACE_FLAG_LINK_UP);
 261   return /* no error */ 0;
 262 }
 263
 264 /* *INDENT-OFF* */
 265 VNET_HW_INTERFACE_CLASS(sixrd_hw_interface_class) = {
 266     .name = "ip6ip-6rd",
 267     .build_rewrite = sixrd_build_rewrite,
 268     .update_adjacency = sixrd_update_adj,
 269 };
 270
 271 VNET_DEVICE_CLASS(sixrd_device_class) = {
 272     .name = "ip6ip-6rd",
 273     .admin_up_down_function = sixrd_interface_admin_up_down,
 274 #ifdef SOON
 275     .clear counter = 0;
 276 #endif
 277 }
 278 ;
 279 /* *INDENT-ON* */
 280
 281 int
 282 sixrd_add_tunnel (ip6_address_t * ip6_prefix, u8 ip6_prefix_len,
 283                   ip4_address_t * ip4_prefix, u8 ip4_prefix_len,
 284                   ip4_address_t * ip4_src, bool security_check,
 285                   u32 fib_index, u32 * sw_if_index)
 286 {
 287   ipip_main_t *gm = &ipip_main;
 288   ipip_tunnel_t *t;
 289
 290   if (fib_index == ~0)
 291     return VNET_API_ERROR_NO_SUCH_FIB;
 292
 293   if ((ip6_prefix_len + 32 - ip4_prefix_len) > 64)
 294     return VNET_API_ERROR_INVALID_VALUE;
 295
 296   /* Tunnel already configured */
 297   ip46_address_t src = ip46_address_initializer, dst =
 298     ip46_address_initializer;
 299   ip_set (&src, ip4_src, true);
 300   ipip_tunnel_key_t key = {.transport = IPIP_TRANSPORT_IP4,
 301     .fib_index = fib_index,
 302     .src = src,
 303     .dst = dst
 304   };
 305
 306   t = ipip_tunnel_db_find (&key);
 307   if (t)
 308     return VNET_API_ERROR_IF_ALREADY_EXISTS;
 309
 310   /* Get tunnel index */
 311   pool_get_aligned (gm->tunnels, t, CLIB_CACHE_LINE_BYTES);
 312   memset (t, 0, sizeof (*t));
 313   u32 t_idx = t - gm->tunnels;  /* tunnel index (or instance) */
 314
 315   /* Init tunnel struct */
 316   t->mode = IPIP_MODE_6RD;
 317   t->sixrd.ip4_prefix.as_u32 = ip4_prefix->as_u32;
 318   t->sixrd.ip4_prefix_len = ip4_prefix_len;
 319   t->sixrd.ip6_prefix = *ip6_prefix;
 320   t->sixrd.ip6_prefix_len = ip6_prefix_len;
 321   t->tunnel_src = src;
 322   t->sixrd.security_check = security_check;
 323   t->sixrd.shift =
 324     (ip4_prefix_len < 32) ? 64 - ip6_prefix_len - (32 - ip4_prefix_len) : 0;
 325
 326   /* Create interface */
 327   u32 hw_if_index =
 328     vnet_register_interface (vnet_get_main (), sixrd_device_class.index,
 329                              t_idx,
 330                              sixrd_hw_interface_class.index, t_idx);
 331
 332   /* Default the interface to up and enable IPv6 (payload) */
 333   vnet_hw_interface_t *hi =
 334     vnet_get_hw_interface (vnet_get_main (), hw_if_index);
 335   t->hw_if_index = hw_if_index;
 336   t->fib_index = fib_index;
 337   t->sw_if_index = hi->sw_if_index;
 338   t->dev_instance = t_idx;
 339   t->user_instance = t_idx;
 340
 341   hi->max_l3_packet_bytes[VLIB_RX] = hi->max_l3_packet_bytes[VLIB_TX] = 1480;
 342
 343   ipip_tunnel_db_add (t, &key);
 344
 345   vec_validate_init_empty (gm->tunnel_index_by_sw_if_index, hi->sw_if_index,
 346                            ~0);
 347   gm->tunnel_index_by_sw_if_index[hi->sw_if_index] = t_idx;
 348
 349   vnet_hw_interface_set_flags (vnet_get_main (), hw_if_index,
 350                                VNET_HW_INTERFACE_FLAG_LINK_UP);
 351   vnet_sw_interface_set_flags (vnet_get_main (), hi->sw_if_index,
 352                                VNET_SW_INTERFACE_FLAG_ADMIN_UP);
 353   ip6_sw_interface_enable_disable (hi->sw_if_index, true);
 354
 355   /* Create IPv6 route/adjacency */
 356   fib_prefix_t pfx6 = {
 357     .fp_proto = FIB_PROTOCOL_IP6,
 358     .fp_len = t->sixrd.ip6_prefix_len,
 359     .fp_addr = {
 360                 .ip6 = t->sixrd.ip6_prefix,
 361                 }
 362     ,
 363   };
 364
 365   fib_table_entry_update_one_path (fib_index, &pfx6, FIB_SOURCE_CLI,
 366                                    FIB_ENTRY_FLAG_ATTACHED, DPO_PROTO_IP6,
 367                                    &sixrd_special_nh, hi->sw_if_index, ~0, 1,
 368                                    NULL, FIB_ROUTE_PATH_FLAG_NONE);
 369
 370   *sw_if_index = hi->sw_if_index;
 371
 372   if (!gm->ip4_protocol_registered)
 373     {
 374       vlib_node_t *ipip4_input =
 375         vlib_get_node_by_name (gm->vlib_main, (u8 *) "ipip4-input");
 376       ASSERT (ipip4_input);
 377       ip4_register_protocol (IP_PROTOCOL_IPV6, ipip4_input->index);
 378     }
 379   return 0;
 380 }
 381
 382 /*
 383  * sixrd_del_tunnel
 384  */
 385 int
 386 sixrd_del_tunnel (u32 sw_if_index)
 387 {
 388   ipip_main_t *gm = &ipip_main;
 389   ipip_tunnel_t *t = ipip_tunnel_db_find_by_sw_if_index (sw_if_index);
 390
 391   if (!t)
 392     {
 393       clib_warning ("SIXRD tunnel delete: tunnel does not exist: %d",
 394                     sw_if_index);
 395       return -1;
 396     }
 397
 398   fib_prefix_t pfx6 = {
 399     .fp_proto = FIB_PROTOCOL_IP6,
 400     .fp_len = t->sixrd.ip6_prefix_len,
 401     .fp_addr = {
 402                 .ip6 = t->sixrd.ip6_prefix,
 403                 }
 404     ,
 405   };
 406   fib_table_entry_special_remove (0, &pfx6, FIB_SOURCE_CLI);
 407   vnet_sw_interface_set_flags (vnet_get_main (), t->sw_if_index,
 408                                0 /* down */ );
 409   ip6_sw_interface_enable_disable (t->sw_if_index, false);
 410   gm->tunnel_index_by_sw_if_index[t->sw_if_index] = ~0;
 411
 412   vnet_delete_hw_interface (vnet_get_main (), t->hw_if_index);
 413   ipip_tunnel_db_remove (t);
 414   pool_put (gm->tunnels, t);
 415
 416   return 0;
 417 }
 418
 419 static void
 420 sixrd_adj_delegate_adj_deleted (adj_delegate_t * aed)
 421 {
 422   sixrd_adj_delegate_t *sixrd_ad;
 423
 424   sixrd_ad = sixrd_adj_from_base (aed);
 425   fib_entry_child_remove (sixrd_ad->sixrd_fib_entry_index,
 426                           sixrd_ad->sixrd_sibling);
 427   fib_table_entry_delete_index (sixrd_ad->sixrd_fib_entry_index,
 428                                 FIB_SOURCE_RR);
 429   pool_put (sixrd_adj_delegate_pool, sixrd_ad);
 430 }
 431
 432 static u8 *
 433 sixrd_adj_delegate_format (const adj_delegate_t * aed, u8 * s)
 434 {
 435   const sixrd_adj_delegate_t *sixrd_ad;
 436
 437   sixrd_ad = sixrd_adj_from_const_base (aed);
 438   s = format (s, "SIXRD:[fib-entry:%d]", sixrd_ad->sixrd_fib_entry_index);
 439
 440   return (s);
 441 }
 442
 443 static void
 444 sixrd_fib_node_last_lock_gone (fib_node_t * node)
 445 {
 446   /* top of the dependency tree, locks not managed here. */
 447 }
 448
 449 static sixrd_adj_delegate_t *
 450 sixrd_adj_delegate_from_fib_node (fib_node_t * node)
 451 {
 452   return ((sixrd_adj_delegate_t *) (((char *) node) -
 453                                     STRUCT_OFFSET_OF (sixrd_adj_delegate_t,
 454                                                       sixrd_node)));
 455 }
 456
 457 static fib_node_back_walk_rc_t
 458 sixrd_fib_node_back_walk_notify (fib_node_t * node,
 459                                  fib_node_back_walk_ctx_t * ctx)
 460 {
 461   sixrd_adj_delegate_t *sixrd_ad;
 462
 463   sixrd_ad = sixrd_adj_delegate_from_fib_node (node);
 464   ip6ip_tunnel_stack (sixrd_ad->adj_index, sixrd_ad->sixrd_fib_entry_index);
 465
 466   return (FIB_NODE_BACK_WALK_CONTINUE);
 467 }
 468
 469 /**
 470  * Function definition to get a FIB node from its index
 471  */
 472 static fib_node_t *
 473 sixrd_fib_node_get (fib_node_index_t index)
 474 {
 475   sixrd_adj_delegate_t *sixrd_ad;
 476
 477   sixrd_ad = pool_elt_at_index (sixrd_adj_delegate_pool, index);
 478
 479   return (&sixrd_ad->sixrd_node);
 480 }
 481
 482 /**
 483  * VFT registered with the adjacency delegate
 484  */
 485 const static adj_delegate_vft_t sixrd_adj_delegate_vft = {
 486   .adv_adj_deleted = sixrd_adj_delegate_adj_deleted,
 487   .adv_format = sixrd_adj_delegate_format,
 488 };
 489
 490 /**
 491  * VFT registered with the FIB node for the adj delegate
 492  */
 493 const static fib_node_vft_t sixrd_fib_node_vft = {
 494   .fnv_get = sixrd_fib_node_get,
 495   .fnv_last_lock = sixrd_fib_node_last_lock_gone,
 496   .fnv_back_walk = sixrd_fib_node_back_walk_notify,
 497 };
 498
 499 static clib_error_t *
 500 sixrd_init (vlib_main_t * vm)
 501 {
 502   clib_error_t *error = 0;
 503
 504   /* Make sure the IPIP tunnel subsystem is initialised */
 505   vlib_call_init_function (vm, ipip_init);
 506
 507   sixrd_adj_delegate_type =
 508     adj_delegate_register_new_type (&sixrd_adj_delegate_vft);
 509   sixrd_fib_node_type = fib_node_register_new_type (&sixrd_fib_node_vft);
 510
 511   return error;
 512 }
 513
 514 VLIB_INIT_FUNCTION (sixrd_init);
 515
 516 /*
 517  * fd.io coding-style-patch-verification: ON
 518  *
 519  * Local Variables:
 520  * eval: (c-set-style "gnu")
 521  * End:
 522  */