src/vnet/geneve/geneve.c

   1 /*
   2  * Copyright (c) 2017 SUSE LLC.
   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 #include <vnet/geneve/geneve.h>
  16 #include <vnet/ip/format.h>
  17 #include <vnet/fib/fib_entry.h>
  18 #include <vnet/fib/fib_table.h>
  19 #include <vnet/mfib/mfib_table.h>
  20 #include <vnet/adj/adj_mcast.h>
  21 #include <vnet/interface.h>
  22 #include <vlib/vlib.h>
  23
  24 /**
  25  * @file
  26  * @brief GENEVE.
  27  *
  28  * GENEVE provides the features needed to allow L2 bridge domains (BDs)
  29  * to span multiple servers. This is done by building an L2 overlay on
  30  * top of an L3 network underlay using GENEVE tunnels.
  31  *
  32  * This makes it possible for servers to be co-located in the same data
  33  * center or be separated geographically as long as they are reachable
  34  * through the underlay L3 network.
  35  */
  36
  37
  38 geneve_main_t geneve_main;
  39
  40 static u8 *
  41 format_decap_next (u8 * s, va_list * args)
  42 {
  43   u32 next_index = va_arg (*args, u32);
  44
  45   switch (next_index)
  46     {
  47     case GENEVE_INPUT_NEXT_DROP:
  48       return format (s, "drop");
  49     case GENEVE_INPUT_NEXT_L2_INPUT:
  50       return format (s, "l2");
  51     default:
  52       return format (s, "index %d", next_index);
  53     }
  54   return s;
  55 }
  56
  57 u8 *
  58 format_geneve_tunnel (u8 * s, va_list * args)
  59 {
  60   geneve_tunnel_t *t = va_arg (*args, geneve_tunnel_t *);
  61   geneve_main_t *ngm = &geneve_main;
  62
  63   s = format (s, "[%d] local %U remote %U vni %d sw_if_index %d ",
  64               t - ngm->tunnels,
  65               format_ip46_address, &t->local, IP46_TYPE_ANY,
  66               format_ip46_address, &t->remote, IP46_TYPE_ANY,
  67               t->vni, t->sw_if_index);
  68
  69   if (ip46_address_is_multicast (&t->remote))
  70     s = format (s, "mcast_sw_if_index %d ", t->mcast_sw_if_index);
  71
  72   s = format (s, "encap_fib_index %d fib_entry_index %d decap_next %U\n",
  73               t->encap_fib_index, t->fib_entry_index,
  74               format_decap_next, t->decap_next_index);
  75   return s;
  76 }
  77
  78 static u8 *
  79 format_geneve_name (u8 * s, va_list * args)
  80 {
  81   u32 dev_instance = va_arg (*args, u32);
  82   return format (s, "geneve_tunnel%d", dev_instance);
  83 }
  84
  85 static uword
  86 dummy_interface_tx (vlib_main_t * vm,
  87                     vlib_node_runtime_t * node, vlib_frame_t * frame)
  88 {
  89   clib_warning ("you shouldn't be here, leaking buffers...");
  90   return frame->n_vectors;
  91 }
  92
  93 static clib_error_t *
  94 geneve_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
  95 {
  96   u32 hw_flags = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) ?
  97     VNET_HW_INTERFACE_FLAG_LINK_UP : 0;
  98   vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
  99
 100   return /* no error */ 0;
 101 }
 102
 103 /* *INDENT-OFF* */
 104 VNET_DEVICE_CLASS (geneve_device_class, static) = {
 105   .name = "GENEVE",
 106   .format_device_name = format_geneve_name,
 107   .format_tx_trace = format_geneve_encap_trace,
 108   .tx_function = dummy_interface_tx,
 109   .admin_up_down_function = geneve_interface_admin_up_down,
 110 };
 111 /* *INDENT-ON* */
 112
 113 static u8 *
 114 format_geneve_header_with_length (u8 * s, va_list * args)
 115 {
 116   u32 dev_instance = va_arg (*args, u32);
 117   s = format (s, "unimplemented dev %u", dev_instance);
 118   return s;
 119 }
 120
 121 /* *INDENT-OFF* */
 122 VNET_HW_INTERFACE_CLASS (geneve_hw_class) = {
 123   .name = "GENEVE",
 124   .format_header = format_geneve_header_with_length,
 125   .build_rewrite = default_build_rewrite,
 126 };
 127 /* *INDENT-ON* */
 128
 129 static void
 130 geneve_tunnel_restack_dpo (geneve_tunnel_t * t)
 131 {
 132   dpo_id_t dpo = DPO_INVALID;
 133   u32 encap_index = ip46_address_is_ip4 (&t->remote) ?
 134     geneve4_encap_node.index : geneve6_encap_node.index;
 135   fib_forward_chain_type_t forw_type = ip46_address_is_ip4 (&t->remote) ?
 136     FIB_FORW_CHAIN_TYPE_UNICAST_IP4 : FIB_FORW_CHAIN_TYPE_UNICAST_IP6;
 137
 138   fib_entry_contribute_forwarding (t->fib_entry_index, forw_type, &dpo);
 139   dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
 140   dpo_reset (&dpo);
 141 }
 142
 143 static geneve_tunnel_t *
 144 geneve_tunnel_from_fib_node (fib_node_t * node)
 145 {
 146 #if (CLIB_DEBUG > 0)
 147   ASSERT (FIB_NODE_TYPE_GENEVE_TUNNEL == node->fn_type);
 148 #endif
 149   return ((geneve_tunnel_t *) (((char *) node) -
 150                                STRUCT_OFFSET_OF (geneve_tunnel_t, node)));
 151 }
 152
 153 /**
 154  * Function definition to backwalk a FIB node -
 155  * Here we will restack the new dpo of GENEVE DIP to encap node.
 156  */
 157 static fib_node_back_walk_rc_t
 158 geneve_tunnel_back_walk (fib_node_t * node, fib_node_back_walk_ctx_t * ctx)
 159 {
 160   geneve_tunnel_restack_dpo (geneve_tunnel_from_fib_node (node));
 161   return (FIB_NODE_BACK_WALK_CONTINUE);
 162 }
 163
 164 /**
 165  * Function definition to get a FIB node from its index
 166  */
 167 static fib_node_t *
 168 geneve_tunnel_fib_node_get (fib_node_index_t index)
 169 {
 170   geneve_tunnel_t *t;
 171   geneve_main_t *vxm = &geneve_main;
 172
 173   t = pool_elt_at_index (vxm->tunnels, index);
 174
 175   return (&t->node);
 176 }
 177
 178 /**
 179  * Function definition to inform the FIB node that its last lock has gone.
 180  */
 181 static void
 182 geneve_tunnel_last_lock_gone (fib_node_t * node)
 183 {
 184   /*
 185    * The GENEVE tunnel is a root of the graph. As such
 186    * it never has children and thus is never locked.
 187    */
 188   ASSERT (0);
 189 }
 190
 191 /*
 192  * Virtual function table registered by GENEVE tunnels
 193  * for participation in the FIB object graph.
 194  */
 195 const static fib_node_vft_t geneve_vft = {
 196   .fnv_get = geneve_tunnel_fib_node_get,
 197   .fnv_last_lock = geneve_tunnel_last_lock_gone,
 198   .fnv_back_walk = geneve_tunnel_back_walk,
 199 };
 200
 201
 202 #define foreach_copy_field                      \
 203 _(vni)                                          \
 204 _(mcast_sw_if_index)                            \
 205 _(encap_fib_index)                              \
 206 _(decap_next_index)                             \
 207 _(local)                                          \
 208 _(remote)
 209
 210 static int
 211 geneve_rewrite (geneve_tunnel_t * t, bool is_ip6)
 212 {
 213   union
 214   {
 215     ip4_geneve_header_t *h4;
 216     ip6_geneve_header_t *h6;
 217     u8 *rw;
 218   } r =
 219   {
 220   .rw = 0};
 221   int len = is_ip6 ? sizeof *r.h6 : sizeof *r.h4;
 222 #if SUPPORT_OPTIONS_HEADER==1
 223   len += t->options_len;
 224 #endif
 225
 226   vec_validate_aligned (r.rw, len - 1, CLIB_CACHE_LINE_BYTES);
 227
 228   udp_header_t *udp;
 229   geneve_header_t *geneve;
 230   /* Fixed portion of the (outer) ip header */
 231   if (!is_ip6)
 232     {
 233       ip4_header_t *ip = &r.h4->ip4;
 234       udp = &r.h4->udp, geneve = &r.h4->geneve;
 235       ip->ip_version_and_header_length = 0x45;
 236       ip->ttl = 254;
 237       ip->protocol = IP_PROTOCOL_UDP;
 238
 239       ip->src_address = t->local.ip4;
 240       ip->dst_address = t->remote.ip4;
 241
 242       /* we fix up the ip4 header length and checksum after-the-fact */
 243       ip->checksum = ip4_header_checksum (ip);
 244     }
 245   else
 246     {
 247       ip6_header_t *ip = &r.h6->ip6;
 248       udp = &r.h6->udp, geneve = &r.h6->geneve;
 249       ip->ip_version_traffic_class_and_flow_label =
 250         clib_host_to_net_u32 (6 << 28);
 251       ip->hop_limit = 255;
 252       ip->protocol = IP_PROTOCOL_UDP;
 253
 254       ip->src_address = t->local.ip6;
 255       ip->dst_address = t->remote.ip6;
 256     }
 257
 258   /* UDP header, randomize local port on something, maybe? */
 259   udp->src_port = clib_host_to_net_u16 (5251);
 260   udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_geneve);
 261
 262   /* GENEVE header */
 263   vnet_set_geneve_version (geneve, GENEVE_VERSION);
 264 #if SUPPORT_OPTIONS_HEADER==1
 265   vnet_set_geneve_options_len (geneve, t->options_len);
 266 #else
 267   vnet_set_geneve_options_len (geneve, 0);
 268 #endif
 269   vnet_set_geneve_oamframe_bit (geneve, 0);
 270   vnet_set_geneve_critical_bit (geneve, 0);
 271   vnet_set_geneve_protocol (geneve, GENEVE_ETH_PROTOCOL);
 272
 273   vnet_geneve_hdr_1word_hton (geneve);
 274
 275   vnet_set_geneve_vni (geneve, t->vni);
 276
 277   t->rewrite = r.rw;
 278   return (0);
 279 }
 280
 281 static bool
 282 geneve_decap_next_is_valid (geneve_main_t * vxm, u32 is_ip6,
 283                             u32 decap_next_index)
 284 {
 285   vlib_main_t *vm = vxm->vlib_main;
 286   u32 input_idx =
 287     (!is_ip6) ? geneve4_input_node.index : geneve6_input_node.index;
 288   vlib_node_runtime_t *r = vlib_node_get_runtime (vm, input_idx);
 289
 290   return decap_next_index < r->n_next_nodes;
 291 }
 292
 293 static void
 294 hash_set_key_copy (uword ** h, void *key, uword v)
 295 {
 296   size_t ksz = hash_header (*h)->user;
 297   void *copy = clib_mem_alloc (ksz);
 298   clib_memcpy (copy, key, ksz);
 299   hash_set_mem (*h, copy, v);
 300 }
 301
 302 static void
 303 hash_unset_key_free (uword ** h, void *key)
 304 {
 305   hash_pair_t *hp = hash_get_pair_mem (*h, key);
 306   ASSERT (hp);
 307   key = uword_to_pointer (hp->key, void *);
 308   hash_unset_mem (*h, key);
 309   clib_mem_free (key);
 310 }
 311
 312 static uword
 313 vtep_addr_ref (ip46_address_t * ip)
 314 {
 315   uword *vtep = ip46_address_is_ip4 (ip) ?
 316     hash_get (geneve_main.vtep4, ip->ip4.as_u32) :
 317     hash_get_mem (geneve_main.vtep6, &ip->ip6);
 318   if (vtep)
 319     return ++(*vtep);
 320   ip46_address_is_ip4 (ip) ?
 321     hash_set (geneve_main.vtep4, ip->ip4.as_u32, 1) :
 322     hash_set_key_copy (&geneve_main.vtep6, &ip->ip6, 1);
 323   return 1;
 324 }
 325
 326 static uword
 327 vtep_addr_unref (ip46_address_t * ip)
 328 {
 329   uword *vtep = ip46_address_is_ip4 (ip) ?
 330     hash_get (geneve_main.vtep4, ip->ip4.as_u32) :
 331     hash_get_mem (geneve_main.vtep6, &ip->ip6);
 332   ASSERT (vtep);
 333   if (--(*vtep) != 0)
 334     return *vtep;
 335   ip46_address_is_ip4 (ip) ?
 336     hash_unset (geneve_main.vtep4, ip->ip4.as_u32) :
 337     hash_unset_key_free (&geneve_main.vtep6, &ip->ip6);
 338   return 0;
 339 }
 340
 341 typedef CLIB_PACKED (union
 342                      {
 343                      struct
 344                      {
 345                      fib_node_index_t mfib_entry_index;
 346                      adj_index_t mcast_adj_index;
 347                      }; u64 as_u64;
 348                      }) mcast_shared_t;
 349
 350 static inline mcast_shared_t
 351 mcast_shared_get (ip46_address_t * ip)
 352 {
 353   ASSERT (ip46_address_is_multicast (ip));
 354   uword *p = hash_get_mem (geneve_main.mcast_shared, ip);
 355   ASSERT (p);
 356   return (mcast_shared_t)
 357   {
 358   .as_u64 = *p};
 359 }
 360
 361 static inline void
 362 mcast_shared_add (ip46_address_t * remote,
 363                   fib_node_index_t mfei, adj_index_t ai)
 364 {
 365   mcast_shared_t new_ep = {
 366     .mcast_adj_index = ai,
 367     .mfib_entry_index = mfei,
 368   };
 369
 370   hash_set_key_copy (&geneve_main.mcast_shared, remote, new_ep.as_u64);
 371 }
 372
 373 static inline void
 374 mcast_shared_remove (ip46_address_t * remote)
 375 {
 376   mcast_shared_t ep = mcast_shared_get (remote);
 377
 378   adj_unlock (ep.mcast_adj_index);
 379   mfib_table_entry_delete_index (ep.mfib_entry_index, MFIB_SOURCE_GENEVE);
 380
 381   hash_unset_key_free (&geneve_main.mcast_shared, remote);
 382 }
 383
 384 static inline fib_protocol_t
 385 fib_ip_proto (bool is_ip6)
 386 {
 387   return (is_ip6) ? FIB_PROTOCOL_IP6 : FIB_PROTOCOL_IP4;
 388 }
 389
 390 int vnet_geneve_add_del_tunnel
 391   (vnet_geneve_add_del_tunnel_args_t * a, u32 * sw_if_indexp)
 392 {
 393   geneve_main_t *vxm = &geneve_main;
 394   geneve_tunnel_t *t = 0;
 395   vnet_main_t *vnm = vxm->vnet_main;
 396   uword *p;
 397   u32 hw_if_index = ~0;
 398   u32 sw_if_index = ~0;
 399   int rv;
 400   geneve4_tunnel_key_t key4;
 401   geneve6_tunnel_key_t key6;
 402   u32 is_ip6 = a->is_ip6;
 403
 404   if (!is_ip6)
 405     {
 406       key4.remote = a->remote.ip4.as_u32;
 407       key4.vni =
 408         clib_host_to_net_u32 ((a->vni << GENEVE_VNI_SHIFT) & GENEVE_VNI_MASK);
 409       p = hash_get (vxm->geneve4_tunnel_by_key, key4.as_u64);
 410     }
 411   else
 412     {
 413       key6.remote = a->remote.ip6;
 414       key6.vni =
 415         clib_host_to_net_u32 ((a->vni << GENEVE_VNI_SHIFT) & GENEVE_VNI_MASK);
 416       p = hash_get_mem (vxm->geneve6_tunnel_by_key, &key6);
 417     }
 418
 419   if (a->is_add)
 420     {
 421       l2input_main_t *l2im = &l2input_main;
 422
 423       /* adding a tunnel: tunnel must not already exist */
 424       if (p)
 425         return VNET_API_ERROR_TUNNEL_EXIST;
 426
 427       /*if not set explicitly, default to l2 */
 428       if (a->decap_next_index == ~0)
 429         a->decap_next_index = GENEVE_INPUT_NEXT_L2_INPUT;
 430       if (!geneve_decap_next_is_valid (vxm, is_ip6, a->decap_next_index))
 431         return VNET_API_ERROR_INVALID_DECAP_NEXT;
 432
 433       pool_get_aligned (vxm->tunnels, t, CLIB_CACHE_LINE_BYTES);
 434       memset (t, 0, sizeof (*t));
 435
 436       /* copy from arg structure */
 437 #define _(x) t->x = a->x;
 438       foreach_copy_field;
 439 #undef _
 440
 441       rv = geneve_rewrite (t, is_ip6);
 442       if (rv)
 443         {
 444           pool_put (vxm->tunnels, t);
 445           return rv;
 446         }
 447
 448       /* copy the key */
 449       if (is_ip6)
 450         hash_set_key_copy (&vxm->geneve6_tunnel_by_key, &key6,
 451                            t - vxm->tunnels);
 452       else
 453         hash_set (vxm->geneve4_tunnel_by_key, key4.as_u64, t - vxm->tunnels);
 454
 455       vnet_hw_interface_t *hi;
 456       if (vec_len (vxm->free_geneve_tunnel_hw_if_indices) > 0)
 457         {
 458           vnet_interface_main_t *im = &vnm->interface_main;
 459           hw_if_index = vxm->free_geneve_tunnel_hw_if_indices
 460             [vec_len (vxm->free_geneve_tunnel_hw_if_indices) - 1];
 461           _vec_len (vxm->free_geneve_tunnel_hw_if_indices) -= 1;
 462
 463           hi = vnet_get_hw_interface (vnm, hw_if_index);
 464           hi->dev_instance = t - vxm->tunnels;
 465           hi->hw_instance = hi->dev_instance;
 466
 467           /* clear old stats of freed tunnel before reuse */
 468           sw_if_index = hi->sw_if_index;
 469           vnet_interface_counter_lock (im);
 470           vlib_zero_combined_counter
 471             (&im->combined_sw_if_counters[VNET_INTERFACE_COUNTER_TX],
 472              sw_if_index);
 473           vlib_zero_combined_counter (&im->combined_sw_if_counters
 474                                       [VNET_INTERFACE_COUNTER_RX],
 475                                       sw_if_index);
 476           vlib_zero_simple_counter (&im->sw_if_counters
 477                                     [VNET_INTERFACE_COUNTER_DROP],
 478                                     sw_if_index);
 479           vnet_interface_counter_unlock (im);
 480         }
 481       else
 482         {
 483           hw_if_index = vnet_register_interface
 484             (vnm, geneve_device_class.index, t - vxm->tunnels,
 485              geneve_hw_class.index, t - vxm->tunnels);
 486           hi = vnet_get_hw_interface (vnm, hw_if_index);
 487         }
 488
 489       t->hw_if_index = hw_if_index;
 490       t->sw_if_index = sw_if_index = hi->sw_if_index;
 491
 492       vec_validate_init_empty (vxm->tunnel_index_by_sw_if_index, sw_if_index,
 493                                ~0);
 494       vxm->tunnel_index_by_sw_if_index[sw_if_index] = t - vxm->tunnels;
 495
 496       /* setup l2 input config with l2 feature and bd 0 to drop packet */
 497       vec_validate (l2im->configs, sw_if_index);
 498       l2im->configs[sw_if_index].feature_bitmap = L2INPUT_FEAT_DROP;
 499       l2im->configs[sw_if_index].bd_index = 0;
 500
 501       vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, sw_if_index);
 502       si->flags &= ~VNET_SW_INTERFACE_FLAG_HIDDEN;
 503       vnet_sw_interface_set_flags (vnm, sw_if_index,
 504                                    VNET_SW_INTERFACE_FLAG_ADMIN_UP);
 505
 506       fib_node_init (&t->node, FIB_NODE_TYPE_GENEVE_TUNNEL);
 507       fib_prefix_t tun_remote_pfx;
 508       u32 encap_index = !is_ip6 ?
 509         geneve4_encap_node.index : geneve6_encap_node.index;
 510       vnet_flood_class_t flood_class = VNET_FLOOD_CLASS_TUNNEL_NORMAL;
 511
 512       fib_prefix_from_ip46_addr (&t->remote, &tun_remote_pfx);
 513       if (!ip46_address_is_multicast (&t->remote))
 514         {
 515           /* Unicast tunnel -
 516            * source the FIB entry for the tunnel's destination
 517            * and become a child thereof. The tunnel will then get poked
 518            * when the forwarding for the entry updates, and the tunnel can
 519            * re-stack accordingly
 520            */
 521           vtep_addr_ref (&t->local);
 522           t->fib_entry_index = fib_table_entry_special_add
 523             (t->encap_fib_index, &tun_remote_pfx, FIB_SOURCE_RR,
 524              FIB_ENTRY_FLAG_NONE);
 525           t->sibling_index = fib_entry_child_add
 526             (t->fib_entry_index, FIB_NODE_TYPE_GENEVE_TUNNEL,
 527              t - vxm->tunnels);
 528           geneve_tunnel_restack_dpo (t);
 529         }
 530       else
 531         {
 532           /* Multicast tunnel -
 533            * as the same mcast group can be used for mutiple mcast tunnels
 534            * with different VNIs, create the output fib adjecency only if
 535            * it does not already exist
 536            */
 537           fib_protocol_t fp = fib_ip_proto (is_ip6);
 538
 539           if (vtep_addr_ref (&t->remote) == 1)
 540             {
 541               fib_node_index_t mfei;
 542               adj_index_t ai;
 543               fib_route_path_t path = {
 544                 .frp_proto = fib_proto_to_dpo (fp),
 545                 .frp_addr = zero_addr,
 546                 .frp_sw_if_index = 0xffffffff,
 547                 .frp_fib_index = ~0,
 548                 .frp_weight = 0,
 549                 .frp_flags = FIB_ROUTE_PATH_LOCAL,
 550               };
 551               const mfib_prefix_t mpfx = {
 552                 .fp_proto = fp,
 553                 .fp_len = (is_ip6 ? 128 : 32),
 554                 .fp_grp_addr = tun_remote_pfx.fp_addr,
 555               };
 556
 557               /*
 558                * Setup the (*,G) to receive traffic on the mcast group
 559                *  - the forwarding interface is for-us
 560                *  - the accepting interface is that from the API
 561                */
 562               mfib_table_entry_path_update (t->encap_fib_index,
 563                                             &mpfx,
 564                                             MFIB_SOURCE_GENEVE,
 565                                             &path, MFIB_ITF_FLAG_FORWARD);
 566
 567               path.frp_sw_if_index = a->mcast_sw_if_index;
 568               path.frp_flags = FIB_ROUTE_PATH_FLAG_NONE;
 569               mfei = mfib_table_entry_path_update (t->encap_fib_index,
 570                                                    &mpfx,
 571                                                    MFIB_SOURCE_GENEVE,
 572                                                    &path,
 573                                                    MFIB_ITF_FLAG_ACCEPT);
 574
 575               /*
 576                * Create the mcast adjacency to send traffic to the group
 577                */
 578               ai = adj_mcast_add_or_lock (fp,
 579                                           fib_proto_to_link (fp),
 580                                           a->mcast_sw_if_index);
 581
 582               /*
 583                * create a new end-point
 584                */
 585               mcast_shared_add (&t->remote, mfei, ai);
 586             }
 587
 588           dpo_id_t dpo = DPO_INVALID;
 589           mcast_shared_t ep = mcast_shared_get (&t->remote);
 590
 591           /* Stack shared mcast remote mac addr rewrite on encap */
 592           dpo_set (&dpo, DPO_ADJACENCY_MCAST,
 593                    fib_proto_to_dpo (fp), ep.mcast_adj_index);
 594
 595           dpo_stack_from_node (encap_index, &t->next_dpo, &dpo);
 596           dpo_reset (&dpo);
 597           flood_class = VNET_FLOOD_CLASS_TUNNEL_MASTER;
 598         }
 599
 600       /* Set geneve tunnel output node */
 601       hi->output_node_index = encap_index;
 602
 603       vnet_get_sw_interface (vnet_get_main (), sw_if_index)->flood_class =
 604         flood_class;
 605     }
 606   else
 607     {
 608       /* deleting a tunnel: tunnel must exist */
 609       if (!p)
 610         return VNET_API_ERROR_NO_SUCH_ENTRY;
 611
 612       t = pool_elt_at_index (vxm->tunnels, p[0]);
 613
 614       sw_if_index = t->sw_if_index;
 615       vnet_sw_interface_set_flags (vnm, t->sw_if_index, 0 /* down */ );
 616       vnet_sw_interface_t *si = vnet_get_sw_interface (vnm, t->sw_if_index);
 617       si->flags |= VNET_SW_INTERFACE_FLAG_HIDDEN;
 618
 619       /* make sure tunnel is removed from l2 bd or xconnect */
 620       set_int_l2_mode (vxm->vlib_main, vnm, MODE_L3, t->sw_if_index, 0, 0, 0,
 621                        0);
 622       vec_add1 (vxm->free_geneve_tunnel_hw_if_indices, t->hw_if_index);
 623
 624       vxm->tunnel_index_by_sw_if_index[t->sw_if_index] = ~0;
 625
 626       if (!is_ip6)
 627         hash_unset (vxm->geneve4_tunnel_by_key, key4.as_u64);
 628       else
 629         hash_unset_key_free (&vxm->geneve6_tunnel_by_key, &key6);
 630
 631       if (!ip46_address_is_multicast (&t->remote))
 632         {
 633           vtep_addr_unref (&t->local);
 634           fib_entry_child_remove (t->fib_entry_index, t->sibling_index);
 635           fib_table_entry_delete_index (t->fib_entry_index, FIB_SOURCE_RR);
 636         }
 637       else if (vtep_addr_unref (&t->remote) == 0)
 638         {
 639           mcast_shared_remove (&t->remote);
 640         }
 641
 642       fib_node_deinit (&t->node);
 643       vec_free (t->rewrite);
 644       pool_put (vxm->tunnels, t);
 645     }
 646
 647   if (sw_if_indexp)
 648     *sw_if_indexp = sw_if_index;
 649
 650   return 0;
 651 }
 652
 653 static uword
 654 get_decap_next_for_node (u32 node_index, u32 ipv4_set)
 655 {
 656   geneve_main_t *vxm = &geneve_main;
 657   vlib_main_t *vm = vxm->vlib_main;
 658   uword input_node = (ipv4_set) ? geneve4_input_node.index :
 659     geneve6_input_node.index;
 660
 661   return vlib_node_add_next (vm, input_node, node_index);
 662 }
 663
 664 static uword
 665 unformat_decap_next (unformat_input_t * input, va_list * args)
 666 {
 667   u32 *result = va_arg (*args, u32 *);
 668   u32 ipv4_set = va_arg (*args, int);
 669   geneve_main_t *vxm = &geneve_main;
 670   vlib_main_t *vm = vxm->vlib_main;
 671   u32 node_index;
 672   u32 tmp;
 673
 674   if (unformat (input, "l2"))
 675     *result = GENEVE_INPUT_NEXT_L2_INPUT;
 676   else if (unformat (input, "node %U", unformat_vlib_node, vm, &node_index))
 677     *result = get_decap_next_for_node (node_index, ipv4_set);
 678   else if (unformat (input, "%d", &tmp))
 679     *result = tmp;
 680   else
 681     return 0;
 682   return 1;
 683 }
 684
 685 static clib_error_t *
 686 geneve_add_del_tunnel_command_fn (vlib_main_t * vm,
 687                                   unformat_input_t * input,
 688                                   vlib_cli_command_t * cmd)
 689 {
 690   unformat_input_t _line_input, *line_input = &_line_input;
 691   ip46_address_t local, remote;
 692   u8 is_add = 1;
 693   u8 local_set = 0;
 694   u8 remote_set = 0;
 695   u8 grp_set = 0;
 696   u8 ipv4_set = 0;
 697   u8 ipv6_set = 0;
 698   u32 encap_fib_index = 0;
 699   u32 mcast_sw_if_index = ~0;
 700   u32 decap_next_index = GENEVE_INPUT_NEXT_L2_INPUT;
 701   u32 vni = 0;
 702   u32 tmp;
 703   int rv;
 704   vnet_geneve_add_del_tunnel_args_t _a, *a = &_a;
 705   u32 tunnel_sw_if_index;
 706   clib_error_t *error = NULL;
 707
 708   /* Cant "universally zero init" (={0}) due to GCC bug 53119 */
 709   memset (&local, 0, sizeof local);
 710   memset (&remote, 0, sizeof remote);
 711
 712   /* Get a line of input. */
 713   if (!unformat_user (input, unformat_line_input, line_input))
 714     return 0;
 715
 716   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 717     {
 718       if (unformat (line_input, "del"))
 719         {
 720           is_add = 0;
 721         }
 722       else if (unformat (line_input, "local %U",
 723                          unformat_ip4_address, &local.ip4))
 724         {
 725           local_set = 1;
 726           ipv4_set = 1;
 727         }
 728       else if (unformat (line_input, "remote %U",
 729                          unformat_ip4_address, &remote.ip4))
 730         {
 731           remote_set = 1;
 732           ipv4_set = 1;
 733         }
 734       else if (unformat (line_input, "local %U",
 735                          unformat_ip6_address, &local.ip6))
 736         {
 737           local_set = 1;
 738           ipv6_set = 1;
 739         }
 740       else if (unformat (line_input, "remote %U",
 741                          unformat_ip6_address, &remote.ip6))
 742         {
 743           remote_set = 1;
 744           ipv6_set = 1;
 745         }
 746       else if (unformat (line_input, "group %U %U",
 747                          unformat_ip4_address, &remote.ip4,
 748                          unformat_vnet_sw_interface,
 749                          vnet_get_main (), &mcast_sw_if_index))
 750         {
 751           grp_set = remote_set = 1;
 752           ipv4_set = 1;
 753         }
 754       else if (unformat (line_input, "group %U %U",
 755                          unformat_ip6_address, &remote.ip6,
 756                          unformat_vnet_sw_interface,
 757                          vnet_get_main (), &mcast_sw_if_index))
 758         {
 759           grp_set = remote_set = 1;
 760           ipv6_set = 1;
 761         }
 762       else if (unformat (line_input, "encap-vrf-id %d", &tmp))
 763         {
 764           encap_fib_index = fib_table_find (fib_ip_proto (ipv6_set), tmp);
 765           if (encap_fib_index == ~0)
 766             {
 767               error =
 768                 clib_error_return (0, "nonexistent encap-vrf-id %d", tmp);
 769               goto done;
 770             }
 771         }
 772       else if (unformat (line_input, "decap-next %U", unformat_decap_next,
 773                          &decap_next_index, ipv4_set))
 774         ;
 775       else if (unformat (line_input, "vni %d", &vni))
 776         {
 777           if (vni >> 24)
 778             {
 779               error = clib_error_return (0, "vni %d out of range", vni);
 780               goto done;
 781             }
 782         }
 783       else
 784         {
 785           error = clib_error_return (0, "parse error: '%U'",
 786                                      format_unformat_error, line_input);
 787           goto done;
 788         }
 789     }
 790
 791   if (local_set == 0)
 792     {
 793       error = clib_error_return (0, "tunnel local address not specified");
 794       goto done;
 795     }
 796
 797   if (remote_set == 0)
 798     {
 799       error = clib_error_return (0, "tunnel remote address not specified");
 800       goto done;
 801     }
 802
 803   if (grp_set && !ip46_address_is_multicast (&remote))
 804     {
 805       error = clib_error_return (0, "tunnel group address not multicast");
 806       goto done;
 807     }
 808
 809   if (grp_set == 0 && ip46_address_is_multicast (&remote))
 810     {
 811       error = clib_error_return (0, "remote address must be unicast");
 812       goto done;
 813     }
 814
 815   if (grp_set && mcast_sw_if_index == ~0)
 816     {
 817       error = clib_error_return (0, "tunnel nonexistent multicast device");
 818       goto done;
 819     }
 820
 821   if (ipv4_set && ipv6_set)
 822     {
 823       error = clib_error_return (0, "both IPv4 and IPv6 addresses specified");
 824       goto done;
 825     }
 826
 827   if (ip46_address_cmp (&local, &remote) == 0)
 828     {
 829       error =
 830         clib_error_return (0, "local and remote addresses are identical");
 831       goto done;
 832     }
 833
 834   if (decap_next_index == ~0)
 835     {
 836       error = clib_error_return (0, "next node not found");
 837       goto done;
 838     }
 839
 840   if (vni == 0)
 841     {
 842       error = clib_error_return (0, "vni not specified");
 843       goto done;
 844     }
 845
 846   memset (a, 0, sizeof (*a));
 847
 848   a->is_add = is_add;
 849   a->is_ip6 = ipv6_set;
 850
 851 #define _(x) a->x = x;
 852   foreach_copy_field;
 853 #undef _
 854
 855   rv = vnet_geneve_add_del_tunnel (a, &tunnel_sw_if_index);
 856
 857   switch (rv)
 858     {
 859     case 0:
 860       if (is_add)
 861         vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name,
 862                          vnet_get_main (), tunnel_sw_if_index);
 863       break;
 864
 865     case VNET_API_ERROR_TUNNEL_EXIST:
 866       error = clib_error_return (0, "tunnel already exists...");
 867       goto done;
 868
 869     case VNET_API_ERROR_NO_SUCH_ENTRY:
 870       error = clib_error_return (0, "tunnel does not exist...");
 871       goto done;
 872
 873     default:
 874       error = clib_error_return
 875         (0, "vnet_geneve_add_del_tunnel returned %d", rv);
 876       goto done;
 877     }
 878
 879 done:
 880   unformat_free (line_input);
 881
 882   return error;
 883 }
 884
 885 /*?
 886  * Add or delete a GENEVE Tunnel.
 887  *
 888  * GENEVE provides the features needed to allow L2 bridge domains (BDs)
 889  * to span multiple servers. This is done by building an L2 overlay on
 890  * top of an L3 network underlay using GENEVE tunnels.
 891  *
 892  * This makes it possible for servers to be co-located in the same data
 893  * center or be separated geographically as long as they are reachable
 894  * through the underlay L3 network.
 895  *
 896  * You can refer to this kind of L2 overlay bridge domain as a GENEVE
 897  * segment.
 898  *
 899  * @cliexpar
 900  * Example of how to create a GENEVE Tunnel:
 901  * @cliexcmd{create geneve tunnel local 10.0.3.1 remote 10.0.3.3 vni 13 encap-vrf-id 7}
 902  * Example of how to delete a GENEVE Tunnel:
 903  * @cliexcmd{create geneve tunnel local 10.0.3.1 remote 10.0.3.3 vni 13 del}
 904  ?*/
 905 /* *INDENT-OFF* */
 906 VLIB_CLI_COMMAND (create_geneve_tunnel_command, static) = {
 907   .path = "create geneve tunnel",
 908   .short_help =
 909   "create geneve tunnel local <local-vtep-addr>"
 910   " {remote <remote-vtep-addr>|group <mcast-vtep-addr> <intf-name>} vni <nn>"
 911   " [encap-vrf-id <nn>] [decap-next [l2|node <name>]] [del]",
 912   .function = geneve_add_del_tunnel_command_fn,
 913 };
 914 /* *INDENT-ON* */
 915
 916 static clib_error_t *
 917 show_geneve_tunnel_command_fn (vlib_main_t * vm,
 918                                unformat_input_t * input,
 919                                vlib_cli_command_t * cmd)
 920 {
 921   geneve_main_t *vxm = &geneve_main;
 922   geneve_tunnel_t *t;
 923
 924   if (pool_elts (vxm->tunnels) == 0)
 925     vlib_cli_output (vm, "No geneve tunnels configured...");
 926
 927   pool_foreach (t, vxm->tunnels, (
 928                                    {
 929                                    vlib_cli_output (vm, "%U",
 930                                                     format_geneve_tunnel, t);
 931                                    }
 932                 ));
 933
 934   return 0;
 935 }
 936
 937 /*?
 938  * Display all the GENEVE Tunnel entries.
 939  *
 940  * @cliexpar
 941  * Example of how to display the GENEVE Tunnel entries:
 942  * @cliexstart{show geneve tunnel}
 943  * [0] local 10.0.3.1 remote 10.0.3.3 vni 13 encap_fib_index 0 sw_if_index 5 decap_next l2
 944  * @cliexend
 945  ?*/
 946 /* *INDENT-OFF* */
 947 VLIB_CLI_COMMAND (show_geneve_tunnel_command, static) = {
 948     .path = "show geneve tunnel",
 949     .short_help = "show geneve tunnel",
 950     .function = show_geneve_tunnel_command_fn,
 951 };
 952 /* *INDENT-ON* */
 953
 954
 955 void
 956 vnet_int_geneve_bypass_mode (u32 sw_if_index, u8 is_ip6, u8 is_enable)
 957 {
 958   if (is_ip6)
 959     vnet_feature_enable_disable ("ip6-unicast", "ip6-geneve-bypass",
 960                                  sw_if_index, is_enable, 0, 0);
 961   else
 962     vnet_feature_enable_disable ("ip4-unicast", "ip4-geneve-bypass",
 963                                  sw_if_index, is_enable, 0, 0);
 964 }
 965
 966
 967 static clib_error_t *
 968 set_ip_geneve_bypass (u32 is_ip6,
 969                       unformat_input_t * input, vlib_cli_command_t * cmd)
 970 {
 971   unformat_input_t _line_input, *line_input = &_line_input;
 972   vnet_main_t *vnm = vnet_get_main ();
 973   clib_error_t *error = 0;
 974   u32 sw_if_index, is_enable;
 975
 976   sw_if_index = ~0;
 977   is_enable = 1;
 978
 979   if (!unformat_user (input, unformat_line_input, line_input))
 980     return 0;
 981
 982   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 983     {
 984       if (unformat_user
 985           (line_input, unformat_vnet_sw_interface, vnm, &sw_if_index))
 986         ;
 987       else if (unformat (line_input, "del"))
 988         is_enable = 0;
 989       else
 990         {
 991           error = unformat_parse_error (line_input);
 992           goto done;
 993         }
 994     }
 995
 996   if (~0 == sw_if_index)
 997     {
 998       error = clib_error_return (0, "unknown interface `%U'",
 999                                  format_unformat_error, line_input);
1000       goto done;
1001     }
1002
1003   vnet_int_geneve_bypass_mode (sw_if_index, is_ip6, is_enable);
1004
1005 done:
1006   unformat_free (line_input);
1007
1008   return error;
1009 }
1010
1011 static clib_error_t *
1012 set_ip4_geneve_bypass (vlib_main_t * vm,
1013                        unformat_input_t * input, vlib_cli_command_t * cmd)
1014 {
1015   return set_ip_geneve_bypass (0, input, cmd);
1016 }
1017
1018 /*?
1019  * This command adds the 'ip4-geneve-bypass' graph node for a given interface.
1020  * By adding the IPv4 geneve-bypass graph node to an interface, the node checks
1021  *  for and validate input geneve packet and bypass ip4-lookup, ip4-local,
1022  * ip4-udp-lookup nodes to speedup geneve packet forwarding. This node will
1023  * cause extra overhead to for non-geneve packets which is kept at a minimum.
1024  *
1025  * @cliexpar
1026  * @parblock
1027  * Example of graph node before ip4-geneve-bypass is enabled:
1028  * @cliexstart{show vlib graph ip4-geneve-bypass}
1029  *            Name                      Next                    Previous
1030  * ip4-geneve-bypass                error-drop [0]
1031  *                                geneve4-input [1]
1032  *                                 ip4-lookup [2]
1033  * @cliexend
1034  *
1035  * Example of how to enable ip4-geneve-bypass on an interface:
1036  * @cliexcmd{set interface ip geneve-bypass GigabitEthernet2/0/0}
1037  *
1038  * Example of graph node after ip4-geneve-bypass is enabled:
1039  * @cliexstart{show vlib graph ip4-geneve-bypass}
1040  *            Name                      Next                    Previous
1041  * ip4-geneve-bypass                error-drop [0]               ip4-input
1042  *                                geneve4-input [1]        ip4-input-no-checksum
1043  *                                 ip4-lookup [2]
1044  * @cliexend
1045  *
1046  * Example of how to display the feature enabed on an interface:
1047  * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1048  * IP feature paths configured on GigabitEthernet2/0/0...
1049  * ...
1050  * ipv4 unicast:
1051  *   ip4-geneve-bypass
1052  *   ip4-lookup
1053  * ...
1054  * @cliexend
1055  *
1056  * Example of how to disable ip4-geneve-bypass on an interface:
1057  * @cliexcmd{set interface ip geneve-bypass GigabitEthernet2/0/0 del}
1058  * @endparblock
1059 ?*/
1060 /* *INDENT-OFF* */
1061 VLIB_CLI_COMMAND (set_interface_ip_geneve_bypass_command, static) = {
1062   .path = "set interface ip geneve-bypass",
1063   .function = set_ip4_geneve_bypass,
1064   .short_help = "set interface ip geneve-bypass <interface> [del]",
1065 };
1066 /* *INDENT-ON* */
1067
1068 static clib_error_t *
1069 set_ip6_geneve_bypass (vlib_main_t * vm,
1070                        unformat_input_t * input, vlib_cli_command_t * cmd)
1071 {
1072   return set_ip_geneve_bypass (1, input, cmd);
1073 }
1074
1075 /*?
1076  * This command adds the 'ip6-geneve-bypass' graph node for a given interface.
1077  * By adding the IPv6 geneve-bypass graph node to an interface, the node checks
1078  *  for and validate input geneve packet and bypass ip6-lookup, ip6-local,
1079  * ip6-udp-lookup nodes to speedup geneve packet forwarding. This node will
1080  * cause extra overhead to for non-geneve packets which is kept at a minimum.
1081  *
1082  * @cliexpar
1083  * @parblock
1084  * Example of graph node before ip6-geneve-bypass is enabled:
1085  * @cliexstart{show vlib graph ip6-geneve-bypass}
1086  *            Name                      Next                    Previous
1087  * ip6-geneve-bypass                error-drop [0]
1088  *                                geneve6-input [1]
1089  *                                 ip6-lookup [2]
1090  * @cliexend
1091  *
1092  * Example of how to enable ip6-geneve-bypass on an interface:
1093  * @cliexcmd{set interface ip6 geneve-bypass GigabitEthernet2/0/0}
1094  *
1095  * Example of graph node after ip6-geneve-bypass is enabled:
1096  * @cliexstart{show vlib graph ip6-geneve-bypass}
1097  *            Name                      Next                    Previous
1098  * ip6-geneve-bypass                error-drop [0]               ip6-input
1099  *                                geneve6-input [1]        ip4-input-no-checksum
1100  *                                 ip6-lookup [2]
1101  * @cliexend
1102  *
1103  * Example of how to display the feature enabed on an interface:
1104  * @cliexstart{show ip interface features GigabitEthernet2/0/0}
1105  * IP feature paths configured on GigabitEthernet2/0/0...
1106  * ...
1107  * ipv6 unicast:
1108  *   ip6-geneve-bypass
1109  *   ip6-lookup
1110  * ...
1111  * @cliexend
1112  *
1113  * Example of how to disable ip6-geneve-bypass on an interface:
1114  * @cliexcmd{set interface ip6 geneve-bypass GigabitEthernet2/0/0 del}
1115  * @endparblock
1116 ?*/
1117 /* *INDENT-OFF* */
1118 VLIB_CLI_COMMAND (set_interface_ip6_geneve_bypass_command, static) = {
1119   .path = "set interface ip6 geneve-bypass",
1120   .function = set_ip6_geneve_bypass,
1121   .short_help = "set interface ip geneve-bypass <interface> [del]",
1122 };
1123 /* *INDENT-ON* */
1124
1125 clib_error_t *
1126 geneve_init (vlib_main_t * vm)
1127 {
1128   geneve_main_t *vxm = &geneve_main;
1129
1130   vxm->vnet_main = vnet_get_main ();
1131   vxm->vlib_main = vm;
1132
1133   /* initialize the ip6 hash */
1134   vxm->geneve6_tunnel_by_key = hash_create_mem (0,
1135                                                 sizeof (geneve6_tunnel_key_t),
1136                                                 sizeof (uword));
1137   vxm->vtep6 = hash_create_mem (0, sizeof (ip6_address_t), sizeof (uword));
1138   vxm->mcast_shared = hash_create_mem (0,
1139                                        sizeof (ip46_address_t),
1140                                        sizeof (mcast_shared_t));
1141
1142   udp_register_dst_port (vm, UDP_DST_PORT_geneve,
1143                          geneve4_input_node.index, /* is_ip4 */ 1);
1144   udp_register_dst_port (vm, UDP_DST_PORT_geneve6,
1145                          geneve6_input_node.index, /* is_ip4 */ 0);
1146
1147   fib_node_register_type (FIB_NODE_TYPE_GENEVE_TUNNEL, &geneve_vft);
1148
1149   return 0;
1150 }
1151
1152 VLIB_INIT_FUNCTION (geneve_init);
1153
1154 /*
1155  * fd.io coding-style-patch-verification: ON
1156  *
1157  * Local Variables:
1158  * eval: (c-set-style "gnu")
1159  * End:
1160  */