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