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