src/vnet/ipip/ipip.c

   1 /*
   2  * ipip.c: ipip
   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 aipiped 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 #include <stddef.h>
  19 #include <vnet/adj/adj_midchain.h>
  20 #include <vnet/ipip/ipip.h>
  21 #include <vnet/vnet.h>
  22 #include <vnet/adj/adj_nbr.h>
  23 #include <vnet/adj/adj_midchain.h>
  24 #include <vnet/fib/ip4_fib.h>
  25 #include <vnet/fib/ip6_fib.h>
  26 #include <vnet/ip/format.h>
  27 #include <vnet/ipip/ipip.h>
  28
  29 ipip_main_t ipip_main;
  30
  31 /* Packet trace structure */
  32 typedef struct
  33 {
  34   u32 tunnel_id;
  35   u32 length;
  36   ip46_address_t src;
  37   ip46_address_t dst;
  38 } ipip_tx_trace_t;
  39
  40 u8 *
  41 format_ipip_tx_trace (u8 * s, va_list * args)
  42 {
  43   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
  44   CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
  45   ipip_tx_trace_t *t = va_arg (*args, ipip_tx_trace_t *);
  46
  47   s =
  48     format (s, "IPIP: tunnel %d len %d src %U dst %U", t->tunnel_id,
  49             t->length, format_ip46_address, &t->src, IP46_TYPE_ANY,
  50             format_ip46_address, &t->dst, IP46_TYPE_ANY);
  51   return s;
  52 }
  53
  54 static u8 *
  55 ipip_build_rewrite (vnet_main_t * vnm, u32 sw_if_index,
  56                     vnet_link_t link_type, const void *dst_address)
  57 {
  58   ip4_header_t *ip4;
  59   ip6_header_t *ip6;
  60   u8 *rewrite = NULL;
  61   ipip_tunnel_t *t = ipip_tunnel_db_find_by_sw_if_index (sw_if_index);
  62
  63   if (!t)
  64     /* not one of ours */
  65     return (0);
  66
  67   switch (t->transport)
  68     {
  69     case IPIP_TRANSPORT_IP4:
  70       vec_validate (rewrite, sizeof (*ip4) - 1);
  71       ip4 = (ip4_header_t *) rewrite;
  72       ip4->ip_version_and_header_length = 0x45;
  73       ip4->ttl = 64;
  74       /* fixup ip4 header length, protocol and checksum after-the-fact */
  75       ip4->src_address.as_u32 = t->tunnel_src.ip4.as_u32;
  76       ip4->dst_address.as_u32 = t->tunnel_dst.ip4.as_u32;
  77       ip4->checksum = ip4_header_checksum (ip4);
  78       if (!(t->flags & IPIP_TUNNEL_FLAG_ENCAP_COPY_DSCP))
  79         ip4_header_set_dscp (ip4, t->dscp);
  80       if (t->flags & IPIP_TUNNEL_FLAG_ENCAP_SET_DF)
  81         ip4_header_set_df (ip4);
  82       break;
  83
  84     case IPIP_TRANSPORT_IP6:
  85       vec_validate (rewrite, sizeof (*ip6) - 1);
  86       ip6 = (ip6_header_t *) rewrite;
  87       ip6->ip_version_traffic_class_and_flow_label =
  88         clib_host_to_net_u32 (6 << 28);
  89       ip6->hop_limit = 64;
  90       /* fixup ip6 header length and protocol after-the-fact */
  91       ip6->src_address.as_u64[0] = t->tunnel_src.ip6.as_u64[0];
  92       ip6->src_address.as_u64[1] = t->tunnel_src.ip6.as_u64[1];
  93       ip6->dst_address.as_u64[0] = t->tunnel_dst.ip6.as_u64[0];
  94       ip6->dst_address.as_u64[1] = t->tunnel_dst.ip6.as_u64[1];
  95       if (!(t->flags & IPIP_TUNNEL_FLAG_ENCAP_COPY_DSCP))
  96         ip6_set_dscp_network_order (ip6, t->dscp);
  97       break;
  98
  99     default:
 100       /* pass through */
 101       ;
 102     }
 103   return (rewrite);
 104 }
 105
 106 static void
 107 ipip4_fixup (vlib_main_t * vm, ip_adjacency_t * adj, vlib_buffer_t * b,
 108              const void *data)
 109 {
 110   ip4_header_t *ip4;
 111   const ipip_tunnel_t *t = data;
 112
 113   ip4 = vlib_buffer_get_current (b);
 114   ip4->length = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b));
 115   switch (adj->ia_link)
 116     {
 117     case VNET_LINK_IP6:
 118       ip4->protocol = IP_PROTOCOL_IPV6;
 119       if (t->flags & IPIP_TUNNEL_FLAG_ENCAP_COPY_DSCP)
 120         ip4_header_set_dscp (ip4,
 121                              ip6_dscp_network_order ((ip6_header_t *) (ip4 +
 122                                                                        1)));
 123       if (t->flags & IPIP_TUNNEL_FLAG_ENCAP_COPY_ECN)
 124         ip4_header_set_ecn (ip4,
 125                             ip6_ecn_network_order ((ip6_header_t *) (ip4 +
 126                                                                      1)));
 127       break;
 128
 129     case VNET_LINK_IP4:
 130       ip4->protocol = IP_PROTOCOL_IP_IN_IP;
 131       if (t->flags & IPIP_TUNNEL_FLAG_ENCAP_COPY_DSCP)
 132         ip4_header_set_dscp (ip4, ip4_header_get_dscp (ip4 + 1));
 133       if (t->flags & IPIP_TUNNEL_FLAG_ENCAP_COPY_ECN)
 134         ip4_header_set_ecn (ip4, ip4_header_get_ecn (ip4 + 1));
 135       if ((t->flags & IPIP_TUNNEL_FLAG_ENCAP_COPY_DF) &&
 136           ip4_header_get_df (ip4 + 1))
 137         ip4_header_set_df (ip4);
 138       break;
 139
 140     default:
 141       break;
 142     }
 143
 144   ip4->checksum = ip4_header_checksum (ip4);
 145 }
 146
 147 static void
 148 ipip6_fixup (vlib_main_t * vm, ip_adjacency_t * adj, vlib_buffer_t * b,
 149              const void *data)
 150 {
 151   ip6_header_t *ip6;
 152   const ipip_tunnel_t *t = data;
 153
 154   /* Must set locally originated otherwise we're not allowed to
 155      fragment the packet later */
 156   b->flags |= VNET_BUFFER_F_LOCALLY_ORIGINATED;
 157
 158   ip6 = vlib_buffer_get_current (b);
 159   ip6->payload_length =
 160     clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b) -
 161                           sizeof (*ip6));
 162   switch (adj->ia_link)
 163     {
 164     case VNET_LINK_IP6:
 165       ip6->protocol = IP_PROTOCOL_IPV6;
 166       if (t->flags & IPIP_TUNNEL_FLAG_ENCAP_COPY_DSCP)
 167         ip6_set_dscp_network_order (ip6, ip6_dscp_network_order (ip6 + 1));
 168       if (t->flags & IPIP_TUNNEL_FLAG_ENCAP_COPY_ECN)
 169         ip6_set_ecn_network_order (ip6, ip6_ecn_network_order (ip6 + 1));
 170       break;
 171
 172     case VNET_LINK_IP4:
 173       ip6->protocol = IP_PROTOCOL_IP_IN_IP;
 174       if (t->flags & IPIP_TUNNEL_FLAG_ENCAP_COPY_DSCP)
 175         ip6_set_dscp_network_order
 176           (ip6, ip4_header_get_dscp ((ip4_header_t *) (ip6 + 1)));
 177       if (t->flags & IPIP_TUNNEL_FLAG_ENCAP_COPY_ECN)
 178         ip6_set_ecn_network_order
 179           (ip6, ip4_header_get_ecn ((ip4_header_t *) (ip6 + 1)));
 180       break;
 181
 182     default:
 183       break;
 184     }
 185 }
 186
 187 static void
 188 ipip_tunnel_stack (adj_index_t ai)
 189 {
 190   ip_adjacency_t *adj;
 191   ipip_tunnel_t *t;
 192   u32 sw_if_index;
 193
 194   adj = adj_get (ai);
 195   sw_if_index = adj->rewrite_header.sw_if_index;
 196
 197   t = ipip_tunnel_db_find_by_sw_if_index (sw_if_index);
 198   if (!t)
 199     return;
 200
 201   if ((vnet_hw_interface_get_flags (vnet_get_main (), t->hw_if_index) &
 202        VNET_HW_INTERFACE_FLAG_LINK_UP) == 0)
 203     {
 204       adj_midchain_delegate_unstack (ai);
 205     }
 206   else
 207     {
 208       /* *INDENT-OFF* */
 209       fib_prefix_t dst = {
 210         .fp_len = t->transport == IPIP_TRANSPORT_IP6 ? 128 : 32,
 211         .fp_proto = (t->transport == IPIP_TRANSPORT_IP6 ?
 212                      FIB_PROTOCOL_IP6 :
 213                      FIB_PROTOCOL_IP4),
 214         .fp_addr = t->tunnel_dst
 215       };
 216       /* *INDENT-ON* */
 217
 218       adj_midchain_delegate_stack (ai, t->fib_index, &dst);
 219     }
 220 }
 221
 222 static adj_walk_rc_t
 223 ipip_adj_walk_cb (adj_index_t ai, void *ctx)
 224 {
 225   ipip_tunnel_stack (ai);
 226
 227   return (ADJ_WALK_RC_CONTINUE);
 228 }
 229
 230 static void
 231 ipip_tunnel_restack (ipip_tunnel_t * gt)
 232 {
 233   fib_protocol_t proto;
 234
 235   /*
 236    * walk all the adjacencies on th IPIP interface and restack them
 237    */
 238   FOR_EACH_FIB_IP_PROTOCOL (proto)
 239   {
 240     adj_nbr_walk (gt->sw_if_index, proto, ipip_adj_walk_cb, NULL);
 241   }
 242 }
 243
 244 void
 245 ipip_update_adj (vnet_main_t * vnm, u32 sw_if_index, adj_index_t ai)
 246 {
 247   adj_midchain_fixup_t f;
 248   ipip_tunnel_t *t;
 249   adj_flags_t af;
 250
 251   t = ipip_tunnel_db_find_by_sw_if_index (sw_if_index);
 252   if (!t)
 253     return;
 254
 255   f = t->transport == IPIP_TRANSPORT_IP6 ? ipip6_fixup : ipip4_fixup;
 256   af = ADJ_FLAG_MIDCHAIN_IP_STACK;
 257   if (VNET_LINK_ETHERNET == adj_get_link_type (ai))
 258     af |= ADJ_FLAG_MIDCHAIN_NO_COUNT;
 259
 260   adj_nbr_midchain_update_rewrite (ai, f, t, af,
 261                                    ipip_build_rewrite (vnm,
 262                                                        sw_if_index,
 263                                                        adj_get_link_type
 264                                                        (ai), NULL));
 265   ipip_tunnel_stack (ai);
 266 }
 267
 268 u8 *
 269 format_ipip_tunnel_flags (u8 * s, va_list * args)
 270 {
 271   ipip_tunnel_flags_t f = va_arg (*args, int);
 272
 273   if (f == IPIP_TUNNEL_FLAG_NONE)
 274     return (format (s, "none"));
 275
 276 #define _(a,b,c) if (f & IPIP_TUNNEL_FLAG_##a) s = format(s, "%s ", b);
 277   forech_ipip_tunnel_flag
 278 #undef _
 279     return (s);
 280 }
 281
 282 static u8 *
 283 format_ipip_tunnel_name (u8 * s, va_list * args)
 284 {
 285   u32 dev_instance = va_arg (*args, u32);
 286   ipip_main_t *gm = &ipip_main;
 287   ipip_tunnel_t *t;
 288
 289   if (dev_instance >= vec_len (gm->tunnels))
 290     return format (s, "<improperly-referenced>");
 291
 292   t = pool_elt_at_index (gm->tunnels, dev_instance);
 293   return format (s, "ipip%d", t->user_instance);
 294 }
 295
 296 static u8 *
 297 format_ipip_device (u8 * s, va_list * args)
 298 {
 299   u32 dev_instance = va_arg (*args, u32);
 300   CLIB_UNUSED (int verbose) = va_arg (*args, int);
 301
 302   s = format (s, "IPIP tunnel: id %d\n", dev_instance);
 303   return s;
 304 }
 305
 306 static clib_error_t *
 307 ipip_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
 308 {
 309   vnet_hw_interface_t *hi;
 310   ipip_tunnel_t *t;
 311
 312   hi = vnet_get_hw_interface (vnm, hw_if_index);
 313
 314   t = ipip_tunnel_db_find_by_sw_if_index (hi->sw_if_index);
 315   if (!t)
 316     return 0;
 317
 318   if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
 319     vnet_hw_interface_set_flags (vnm, hw_if_index,
 320                                  VNET_HW_INTERFACE_FLAG_LINK_UP);
 321   else
 322     vnet_hw_interface_set_flags (vnm, hw_if_index, 0 /* down */ );
 323
 324   ipip_tunnel_restack (t);
 325
 326   return /* no error */ 0;
 327 }
 328
 329 static int
 330 ipip_tunnel_desc (u32 sw_if_index,
 331                   ip46_address_t * src, ip46_address_t * dst, u8 * is_l2)
 332 {
 333   ipip_tunnel_t *t;
 334
 335   t = ipip_tunnel_db_find_by_sw_if_index (sw_if_index);
 336   if (!t)
 337     return -1;
 338
 339   *src = t->tunnel_src;
 340   *dst = t->tunnel_dst;
 341   *is_l2 = 0;
 342
 343   return (0);
 344 }
 345
 346 /* *INDENT-OFF* */
 347 VNET_DEVICE_CLASS(ipip_device_class) = {
 348     .name = "IPIP tunnel device",
 349     .format_device_name = format_ipip_tunnel_name,
 350     .format_device = format_ipip_device,
 351     .format_tx_trace = format_ipip_tx_trace,
 352     .admin_up_down_function = ipip_interface_admin_up_down,
 353     .ip_tun_desc = ipip_tunnel_desc,
 354 #ifdef SOON
 355     .clear counter = 0;
 356 #endif
 357 };
 358
 359 VNET_HW_INTERFACE_CLASS(ipip_hw_interface_class) = {
 360     .name = "IPIP",
 361     //.format_header = format_ipip_header_with_length,
 362     //.unformat_header = unformat_ipip_header,
 363     .build_rewrite = ipip_build_rewrite,
 364     .update_adjacency = ipip_update_adj,
 365     .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
 366 };
 367 /* *INDENT-ON* */
 368
 369 ipip_tunnel_t *
 370 ipip_tunnel_db_find (ipip_tunnel_key_t * key)
 371 {
 372   ipip_main_t *gm = &ipip_main;
 373   uword *p;
 374
 375   p = hash_get_mem (gm->tunnel_by_key, key);
 376   if (!p)
 377     return (NULL);
 378   return (pool_elt_at_index (gm->tunnels, p[0]));
 379 }
 380
 381 ipip_tunnel_t *
 382 ipip_tunnel_db_find_by_sw_if_index (u32 sw_if_index)
 383 {
 384   ipip_main_t *gm = &ipip_main;
 385   if (vec_len (gm->tunnel_index_by_sw_if_index) <= sw_if_index)
 386     return NULL;
 387   u32 ti = gm->tunnel_index_by_sw_if_index[sw_if_index];
 388   if (ti == ~0)
 389     return NULL;
 390   return pool_elt_at_index (gm->tunnels, ti);
 391 }
 392
 393 void
 394 ipip_tunnel_db_add (ipip_tunnel_t * t, ipip_tunnel_key_t * key)
 395 {
 396   ipip_main_t *gm = &ipip_main;
 397
 398   t->key = clib_mem_alloc (sizeof (*t->key));
 399   clib_memcpy (t->key, key, sizeof (*key));
 400   hash_set_mem (gm->tunnel_by_key, t->key, t->dev_instance);
 401 }
 402
 403 void
 404 ipip_tunnel_db_remove (ipip_tunnel_t * t)
 405 {
 406   ipip_main_t *gm = &ipip_main;
 407
 408   hash_unset_mem (gm->tunnel_by_key, t->key);
 409   clib_mem_free (t->key);
 410   t->key = NULL;
 411 }
 412
 413 int
 414 ipip_add_tunnel (ipip_transport_t transport,
 415                  u32 instance, ip46_address_t * src, ip46_address_t * dst,
 416                  u32 fib_index, ipip_tunnel_flags_t flags,
 417                  ip_dscp_t dscp, u32 * sw_if_indexp)
 418 {
 419   ipip_main_t *gm = &ipip_main;
 420   vnet_main_t *vnm = gm->vnet_main;
 421   ip4_main_t *im4 = &ip4_main;
 422   ip6_main_t *im6 = &ip6_main;
 423   ipip_tunnel_t *t;
 424   vnet_hw_interface_t *hi;
 425   u32 hw_if_index, sw_if_index;
 426   ipip_tunnel_key_t key = {.transport = transport,
 427     .fib_index = fib_index,
 428     .src = *src,
 429     .dst = *dst
 430   };
 431   t = ipip_tunnel_db_find (&key);
 432   if (t)
 433     return VNET_API_ERROR_IF_ALREADY_EXISTS;
 434
 435   pool_get_aligned (gm->tunnels, t, CLIB_CACHE_LINE_BYTES);
 436   clib_memset (t, 0, sizeof (*t));
 437
 438   /* Reconcile the real dev_instance and a possible requested instance */
 439   u32 t_idx = t - gm->tunnels;  /* tunnel index (or instance) */
 440   u32 u_idx = instance;         /* user specified instance */
 441   if (u_idx == ~0)
 442     u_idx = t_idx;
 443   if (hash_get (gm->instance_used, u_idx))
 444     {
 445       pool_put (gm->tunnels, t);
 446       return VNET_API_ERROR_INSTANCE_IN_USE;
 447     }
 448   hash_set (gm->instance_used, u_idx, 1);
 449
 450   t->dev_instance = t_idx;      /* actual */
 451   t->user_instance = u_idx;     /* name */
 452
 453   hw_if_index = vnet_register_interface (vnm, ipip_device_class.index, t_idx,
 454                                          ipip_hw_interface_class.index,
 455                                          t_idx);
 456
 457   hi = vnet_get_hw_interface (vnm, hw_if_index);
 458   sw_if_index = hi->sw_if_index;
 459
 460   t->hw_if_index = hw_if_index;
 461   t->fib_index = fib_index;
 462   t->sw_if_index = sw_if_index;
 463   t->dscp = dscp;
 464   t->flags = flags;
 465   t->transport = transport;
 466
 467   vec_validate_init_empty (gm->tunnel_index_by_sw_if_index, sw_if_index, ~0);
 468   gm->tunnel_index_by_sw_if_index[sw_if_index] = t_idx;
 469
 470   if (t->transport == IPIP_TRANSPORT_IP4)
 471     {
 472       vec_validate (im4->fib_index_by_sw_if_index, sw_if_index);
 473       hi->min_packet_bytes = 64 + sizeof (ip4_header_t);
 474     }
 475   else
 476     {
 477       vec_validate (im6->fib_index_by_sw_if_index, sw_if_index);
 478       hi->min_packet_bytes = 64 + sizeof (ip6_header_t);
 479     }
 480
 481   /* Standard default ipip MTU. */
 482   vnet_sw_interface_set_mtu (vnm, sw_if_index, 9000);
 483
 484   t->tunnel_src = *src;
 485   t->tunnel_dst = *dst;
 486
 487   ipip_tunnel_db_add (t, &key);
 488
 489   if (sw_if_indexp)
 490     *sw_if_indexp = sw_if_index;
 491
 492   if (t->transport == IPIP_TRANSPORT_IP6 && !gm->ip6_protocol_registered)
 493     {
 494       ip6_register_protocol (IP_PROTOCOL_IP_IN_IP, ipip6_input_node.index);
 495       ip6_register_protocol (IP_PROTOCOL_IPV6, ipip6_input_node.index);
 496       gm->ip6_protocol_registered = true;
 497     }
 498   else if (t->transport == IPIP_TRANSPORT_IP4 && !gm->ip4_protocol_registered)
 499     {
 500       ip4_register_protocol (IP_PROTOCOL_IP_IN_IP, ipip4_input_node.index);
 501       ip4_register_protocol (IP_PROTOCOL_IPV6, ipip4_input_node.index);
 502       gm->ip4_protocol_registered = true;
 503     }
 504   return 0;
 505 }
 506
 507 int
 508 ipip_del_tunnel (u32 sw_if_index)
 509 {
 510   ipip_main_t *gm = &ipip_main;
 511   vnet_main_t *vnm = gm->vnet_main;
 512   ipip_tunnel_t *t;
 513
 514
 515   t = ipip_tunnel_db_find_by_sw_if_index (sw_if_index);
 516   if (t == NULL)
 517     return VNET_API_ERROR_NO_SUCH_ENTRY;
 518
 519   vnet_sw_interface_set_flags (vnm, sw_if_index, 0 /* down */ );
 520   gm->tunnel_index_by_sw_if_index[sw_if_index] = ~0;
 521   vnet_delete_hw_interface (vnm, t->hw_if_index);
 522   hash_unset (gm->instance_used, t->user_instance);
 523   ipip_tunnel_db_remove (t);
 524   pool_put (gm->tunnels, t);
 525
 526   return 0;
 527 }
 528
 529 static clib_error_t *
 530 ipip_init (vlib_main_t * vm)
 531 {
 532   ipip_main_t *gm = &ipip_main;
 533
 534   clib_memset (gm, 0, sizeof (gm[0]));
 535   gm->vlib_main = vm;
 536   gm->vnet_main = vnet_get_main ();
 537   gm->tunnel_by_key =
 538     hash_create_mem (0, sizeof (ipip_tunnel_key_t), sizeof (uword));
 539
 540   return 0;
 541 }
 542
 543 VLIB_INIT_FUNCTION (ipip_init);
 544
 545 /*
 546  * fd.io coding-style-patch-verification: ON
 547  *
 548  * Local Variables:
 549  * eval: (c-set-style "gnu")
 550  * End:
 551  */