path: root/vnet/vnet/lisp-gpe/lisp_gpe.c

/*
 * Copyright (c) 2016 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/**
 * @file
 * @brief Common utility functions for IPv4, IPv6 and L2 LISP-GPE tunnels.
 *
 */

#include <vnet/lisp-gpe/lisp_gpe.h>
#include <vppinfra/math.h>

/** LISP-GPE global state */
lisp_gpe_main_t lisp_gpe_main;

/**
 * @brief Compute IP-UDP-GPE sub-tunnel encap/rewrite header.
 *
 * @param[in]   t       Parent of the sub-tunnel.
 * @param[in]   st      Sub-tunnel.
 * @param[in]   lp      Local and remote locators used in the encap header.
 *
 * @return 0 on success.
 */
static int
lisp_gpe_rewrite (lisp_gpe_tunnel_t * t, lisp_gpe_sub_tunnel_t * st,
		  locator_pair_t * lp)
{
  u8 *rw = 0;
  lisp_gpe_header_t *lisp0;
  int len;

  if (ip_addr_version (&lp->lcl_loc) == IP4)
    {
      ip4_header_t *ip0;
      ip4_udp_lisp_gpe_header_t *h0;
      len = sizeof (*h0);

      vec_validate_aligned (rw, len - 1, CLIB_CACHE_LINE_BYTES);

      h0 = (ip4_udp_lisp_gpe_header_t *) rw;

      /* Fixed portion of the (outer) ip4 header */
      ip0 = &h0->ip4;
      ip0->ip_version_and_header_length = 0x45;
      ip0->ttl = 254;
      ip0->protocol = IP_PROTOCOL_UDP;

      /* we fix up the ip4 header length and checksum after-the-fact */
      ip_address_copy_addr (&ip0->src_address, &lp->lcl_loc);
      ip_address_copy_addr (&ip0->dst_address, &lp->rmt_loc);
      ip0->checksum = ip4_header_checksum (ip0);

      /* UDP header, randomize src port on something, maybe? */
      h0->udp.src_port = clib_host_to_net_u16 (4341);
      h0->udp.dst_port = clib_host_to_net_u16 (UDP_DST_PORT_lisp_gpe);

      /* LISP-gpe header */
      lisp0 = &h0->lisp;
    }
  else
    {
      ip6_header_t *ip0;
      ip6_udp_lisp_gpe_header_t *h0;
      len = sizeof (*h0);

      vec_validate_aligned (rw, len - 1, CLIB_CACHE_LINE_BYTES);

      h0 = (ip6_udp_lisp_gpe_header_t *) rw;

      /* Fixed portion of the (outer) ip6 header */
      ip0 = &h0->ip6;
      ip0->ip_version_traffic_class_and_flow_label =
	clib_host_to_net_u32 (0x6 << 28);
      ip0->hop_limit = 254;
      ip0->protocol = IP_PROTOCOL_UDP;

      /* we fix up the ip6 header length after-the-fact */
      ip_address_copy_addr (&ip0->src_address, &lp->lcl_loc);
      ip_address_copy_addr (&ip0->dst_address, &lp->rmt_loc);

      /* UDP header, randomize src port on something, maybe? */
      h0->udp.src_port = clib_host_to_net_u16 (4341);
      h0->udp.dst_port = clib_host_to_net_u16 (UDP_DST_PORT_lisp_gpe);

      /* LISP-gpe header */
      lisp0 = &h0->lisp;
    }

  lisp0->flags = t->flags;
  lisp0->ver_res = t->ver_res;
  lisp0->res = t->res;
  lisp0->next_protocol = t->next_protocol;
  lisp0->iid = clib_host_to_net_u32 (t->vni);

  st->is_ip4 = ip_addr_version (&lp->lcl_loc) == IP4;
  st->rewrite = rw;
  return 0;
}

static int
weight_cmp (normalized_sub_tunnel_weights_t * a,
	    normalized_sub_tunnel_weights_t * b)
{
  int cmp = a->weight - b->weight;
  return (cmp == 0
	  ? a->sub_tunnel_index - b->sub_tunnel_index : (cmp > 0 ? -1 : 1));
}

/**
 * @brief Computes sub-tunnel load balancing vector.
 *
 * Algorithm is identical to that used for building unequal-cost multipath
 * adjacencies. Saves normalized sub-tunnel weights and builds load-balancing
 * vector consisting of list of sub-tunnel indexes replicated according to
 * weight.
 *
 * @param[in]   t       Tunnel for which load balancing vector is computed.
 */
static void
compute_sub_tunnels_balancing_vector (lisp_gpe_tunnel_t * t)
{
  uword n_sts, i, n_nsts, n_nsts_left;
  f64 sum_weight, norm, error, tolerance;
  normalized_sub_tunnel_weights_t *nsts = 0, *stp;
  lisp_gpe_sub_tunnel_t *sts = t->sub_tunnels;
  u32 *st_lbv = 0;

  /* Accept 1% error */
  tolerance = .01;

  n_sts = vec_len (sts);
  vec_validate (nsts, 2 * n_sts - 1);

  sum_weight = 0;
  for (i = 0; i < n_sts; i++)
    {
      /* Find total weight to normalize weights. */
      sum_weight += sts[i].weight;

      /* build normalized sub tunnels vector */
      nsts[i].weight = sts[i].weight;
      nsts[i].sub_tunnel_index = i;
    }

  n_nsts = n_sts;
  if (n_sts == 1)
    {
      nsts[0].weight = 1;
      _vec_len (nsts) = 1;
      goto build_lbv;
    }

  /* Sort sub-tunnels by weight */
  qsort (nsts, n_nsts, sizeof (u32), (void *) weight_cmp);

  /* Save copies of all next hop weights to avoid being overwritten in loop below. */
  for (i = 0; i < n_nsts; i++)
    nsts[n_nsts + i].weight = nsts[i].weight;

  /* Try larger and larger power of 2 sized blocks until we
     find one where traffic flows to within 1% of specified weights. */
  for (n_nsts = max_pow2 (n_sts);; n_nsts *= 2)
    {
      error = 0;

      norm = n_nsts / sum_weight;
      n_nsts_left = n_nsts;
      for (i = 0; i < n_sts; i++)
	{
	  f64 nf = nsts[n_sts + i].weight * norm;
	  word n = flt_round_nearest (nf);

	  n = n > n_nsts_left ? n_nsts_left : n;
	  n_nsts_left -= n;
	  error += fabs (nf - n);
	  nsts[i].weight = n;
	}

      nsts[0].weight += n_nsts_left;

      /* Less than 5% average error per adjacency with this size adjacency block? */
      if (error <= tolerance * n_nsts)
	{
	  /* Truncate any next hops with zero weight. */
	  _vec_len (nsts) = i;
	  break;
	}
    }

build_lbv:

  /* build load balancing vector */
  vec_foreach (stp, nsts)
  {
    for (i = 0; i < stp[0].weight; i++)
      vec_add1 (st_lbv, stp[0].sub_tunnel_index);
  }

  t->sub_tunnels_lbv = st_lbv;
  t->sub_tunnels_lbv_count = n_nsts;
  t->norm_sub_tunnel_weights = nsts;
}

/** Create sub-tunnels and load-balancing vector for all locator pairs
 * associated to a tunnel.*/
static void
create_sub_tunnels (lisp_gpe_main_t * lgm, lisp_gpe_tunnel_t * t)
{
  lisp_gpe_sub_tunnel_t st;
  locator_pair_t *lp = 0;
  int i;

  /* create sub-tunnels for all locator pairs */
  for (i = 0; i < vec_len (t->locator_pairs); i++)
    {
      lp = &t->locator_pairs[i];
      st.locator_pair_index = i;
      st.parent_index = t - lgm->tunnels;
      st.weight = lp->weight;

      /* compute rewrite for sub-tunnel */
      lisp_gpe_rewrite (t, &st, lp);
      vec_add1 (t->sub_tunnels, st);
    }

  /* normalize weights and compute sub-tunnel load balancing vector */
  compute_sub_tunnels_balancing_vector (t);
}

#define foreach_copy_field                      \
_(encap_fib_index)                              \
_(decap_fib_index)                              \
_(decap_next_index)                             \
_(vni)                                          \
_(action)

/**
 * @brief Create/delete IP encapsulated tunnel.
 *
 * Builds GPE tunnel for L2 or L3 packets and populates tunnel pool
 * @ref lisp_gpe_tunnel_by_key in @ref lisp_gpe_main_t.
 *
 * @param[in]   a               Tunnel parameters.
 * @param[in]   is_l2           Flag indicating if encapsulated content is l2.
 * @param[out]  tun_index_res   Tunnel index.
 *
 * @return 0 on success.
 */
static int
add_del_ip_tunnel (vnet_lisp_gpe_add_del_fwd_entry_args_t * a, u8 is_l2,
		   u32 * tun_index_res)
{
  lisp_gpe_main_t *lgm = &lisp_gpe_main;
  lisp_gpe_tunnel_t *t = 0;
  lisp_gpe_tunnel_key_t key;
  lisp_gpe_sub_tunnel_t *stp = 0;
  uword *p;

  /* prepare tunnel key */
  memset (&key, 0, sizeof (key));

  /* fill in the key's remote eid */
  if (!is_l2)
    ip_prefix_copy (&key.rmt.ippref, &gid_address_ippref (&a->rmt_eid));
  else
    mac_copy (&key.rmt.mac, &gid_address_mac (&a->rmt_eid));

  key.vni = clib_host_to_net_u32 (a->vni);

  p = mhash_get (&lgm->lisp_gpe_tunnel_by_key, &key);

  if (a->is_add)
    {
      /* adding a tunnel: tunnel must not already exist */
      if (p)
	return VNET_API_ERROR_INVALID_VALUE;

      if (a->decap_next_index >= LISP_GPE_INPUT_N_NEXT)
	return VNET_API_ERROR_INVALID_DECAP_NEXT;

      pool_get_aligned (lgm->tunnels, t, CLIB_CACHE_LINE_BYTES);
      memset (t, 0, sizeof (*t));

      /* copy from arg structure */
#define _(x) t->x = a->x;
      foreach_copy_field;
#undef _

      t->locator_pairs = vec_dup (a->locator_pairs);

      /* if vni is non-default */
      if (a->vni)
	t->flags = LISP_GPE_FLAGS_I;

      /* work in lisp-gpe not legacy mode */
      t->flags |= LISP_GPE_FLAGS_P;

      /* next proto */
      if (!is_l2)
	t->next_protocol = ip_prefix_version (&key.rmt.ippref) == IP4 ?
	  LISP_GPE_NEXT_PROTO_IP4 : LISP_GPE_NEXT_PROTO_IP6;
      else
	t->next_protocol = LISP_GPE_NEXT_PROTO_ETHERNET;

      /* build sub-tunnels for lowest priority locator-pairs */
      if (!a->is_negative)
	create_sub_tunnels (lgm, t);

      mhash_set (&lgm->lisp_gpe_tunnel_by_key, &key, t - lgm->tunnels, 0);

      /* return tunnel index */
      if (tun_index_res)
	tun_index_res[0] = t - lgm->tunnels;
    }
  else
    {
      /* deleting a tunnel: tunnel must exist */
      if (!p)
	{
	  clib_warning ("Tunnel for eid %U doesn't exist!",
			format_gid_address, &a->rmt_eid);
	  return VNET_API_ERROR_NO_SUCH_ENTRY;
	}

      t = pool_elt_at_index (lgm->tunnels, p[0]);

      mhash_unset (&lgm->lisp_gpe_tunnel_by_key, &key, 0);

      vec_foreach (stp, t->sub_tunnels)
      {
	vec_free (stp->rewrite);
      }
      vec_free (t->sub_tunnels);
      vec_free (t->sub_tunnels_lbv);
      vec_free (t->locator_pairs);
      pool_put (lgm->tunnels, t);
    }

  return 0;
}

/**
 * @brief Build IP adjacency for LISP Source/Dest FIB.
 *
 * Because LISP forwarding does not follow typical IP forwarding path, the
 * adjacency's fields are overloaded (i.e., hijacked) to carry LISP specific
 * data concerning the lisp-gpe interface the packets hitting the adjacency
 * should be sent to and the tunnel that should be used.
 *
 * @param[in]   lgm             Reference to @ref lisp_gpe_main_t.
 * @param[out]  adj             Adjacency to be populated.
 * @param[in]   table_id        VRF for adjacency.
 * @param[in]   vni             Virtual Network identifier (tenant id).
 * @param[in]   tun_index       Tunnel index.
 * @param[in]   n_sub_tun       Number of sub-tunnels.
 * @param[in]   is_negative     Flag to indicate if the adjacency is for a
 *                              negative mapping.
 * @param[in]   action          Action to be taken for negative mapping.
 * @param[in]   ip_ver          IP version for the adjacency.
 *
 * @return 0 on success.
 */
static int
build_ip_adjacency (lisp_gpe_main_t * lgm, ip_adjacency_t * adj, u32 table_id,
		    u32 vni, u32 tun_index, u32 n_sub_tun, u8 is_negative,
		    u8 action, u8 ip_ver)
{
  uword *lookup_next_index, *lgpe_sw_if_index, *lnip;

  memset (adj, 0, sizeof (adj[0]));
  adj->n_adj = 1;
  /* fill in lookup_next_index with a 'legal' value to avoid problems */
  adj->lookup_next_index = (ip_ver == IP4) ?
    lgm->ip4_lookup_next_lgpe_ip4_lookup :
    lgm->ip6_lookup_next_lgpe_ip6_lookup;

  /* positive mapping */
  if (!is_negative)
    {
      /* send packets that hit this adj to lisp-gpe interface output node in
       * requested vrf. */
      lnip = (ip_ver == IP4) ?
	lgm->lgpe_ip4_lookup_next_index_by_table_id :
	lgm->lgpe_ip6_lookup_next_index_by_table_id;
      lookup_next_index = hash_get (lnip, table_id);
      lgpe_sw_if_index = hash_get (lgm->l3_ifaces.sw_if_index_by_vni, vni);

      /* the assumption is that the interface must've been created before
       * programming the dp */
      ASSERT (lookup_next_index != 0 && lgpe_sw_if_index != 0);

      /* hijack explicit fib index to store lisp interface node index,
       * if_address_index for the tunnel index and saved lookup next index
       * for the number of sub tunnels */
      adj->explicit_fib_index = lookup_next_index[0];
      adj->if_address_index = tun_index;
      adj->rewrite_header.sw_if_index = lgpe_sw_if_index[0];
      adj->saved_lookup_next_index = n_sub_tun;
    }
  /* negative mapping */
  else
    {
      adj->rewrite_header.sw_if_index = ~0;
      adj->rewrite_header.next_index = ~0;
      adj->if_address_index = tun_index;

      switch (action)
	{
	case LISP_NO_ACTION:
	  /* TODO update timers? */
	case LISP_FORWARD_NATIVE:
	  /* TODO check if route/next-hop for eid exists in fib and add
	   * more specific for the eid with the next-hop found */
	case LISP_SEND_MAP_REQUEST:
	  /* insert tunnel that always sends map-request */
	  adj->explicit_fib_index = (ip_ver == IP4) ?
	    LGPE_IP4_LOOKUP_NEXT_LISP_CP_LOOKUP :
	    LGPE_IP6_LOOKUP_NEXT_LISP_CP_LOOKUP;
	  break;
	case LISP_DROP:
	  /* for drop fwd entries, just add route, no need to add encap tunnel */
	  adj->explicit_fib_index = (ip_ver == IP4 ?
				     LGPE_IP4_LOOKUP_NEXT_DROP :
				     LGPE_IP6_LOOKUP_NEXT_DROP);
	  break;
	default:
	  return -1;
	}
    }
  return 0;
}

/**
 * @brief Add/Delete LISP IP forwarding entry.
 *
 * Coordinates the creation/removal of forwarding entries for IP LISP overlay:
 * creates lisp-gpe tunnel, builds tunnel customized forwarding entry and
 * injects new route in Source/Dest FIB.
 *
 * @param[in]   lgm     Reference to @ref lisp_gpe_main_t.
 * @param[in]   a       Parameters for building the forwarding entry.
 *
 * @return 0 on success.
 */
static int
add_del_ip_fwd_entry (lisp_gpe_main_t * lgm,
		      vnet_lisp_gpe_add_del_fwd_entry_args_t * a)
{
  ip_adjacency_t adj, *adjp;
  lisp_gpe_tunnel_t *t;
  u32 rv, tun_index = ~0, n_sub_tuns = 0;
  ip_prefix_t *rmt_pref, *lcl_pref;
  u8 ip_ver;

  rmt_pref = &gid_address_ippref (&a->rmt_eid);
  lcl_pref = &gid_address_ippref (&a->lcl_eid);
  ip_ver = ip_prefix_version (rmt_pref);

  /* add/del tunnel to tunnels pool and prepares rewrite */
  if (0 != a->locator_pairs)
    {
      rv = add_del_ip_tunnel (a, 0 /* is_l2 */ , &tun_index);
      if (rv)
	{
	  clib_warning ("failed to build tunnel!");
	  return rv;
	}
      if (a->is_add)
	{
	  t = pool_elt_at_index (lgm->tunnels, tun_index);
	  n_sub_tuns = t->sub_tunnels_lbv_count;
	}
    }

  /* setup adjacency for eid */
  rv = build_ip_adjacency (lgm, &adj, a->table_id, a->vni, tun_index,
			   n_sub_tuns, a->is_negative, a->action, ip_ver);

  /* add/delete route for eid */
  rv |= ip_sd_fib_add_del_route (lgm, rmt_pref, lcl_pref, a->table_id, &adj,
				 a->is_add);

  if (rv)
    {
      clib_warning ("failed to insert route for tunnel!");
      return rv;
    }

  /* check that everything worked */
  if (CLIB_DEBUG && a->is_add)
    {
      u32 adj_index;
      adj_index = ip_sd_fib_get_route (lgm, rmt_pref, lcl_pref, a->table_id);
      ASSERT (adj_index != 0);

      adjp = ip_get_adjacency ((ip_ver == IP4) ? lgm->lm4 : lgm->lm6,
			       adj_index);

      ASSERT (adjp != 0 && adjp->if_address_index == tun_index);
    }

  return rv;
}

static void
make_mac_fib_key (BVT (clib_bihash_kv) * kv, u16 bd_index, u8 src_mac[6],
		  u8 dst_mac[6])
{
  kv->key[0] = (((u64) bd_index) << 48) | mac_to_u64 (dst_mac);
  kv->key[1] = mac_to_u64 (src_mac);
  kv->key[2] = 0;
}

/**
 * @brief Lookup L2 SD FIB entry
 *
 * Does a vni + dest + source lookup in the L2 LISP FIB. If the lookup fails
 * it tries a second time with source set to 0 (i.e., a simple dest lookup).
 *
 * @param[in]   lgm             Reference to @ref lisp_gpe_main_t.
 * @param[in]   bd_index        Bridge domain index.
 * @param[in]   src_mac         Source mac address.
 * @param[in]   dst_mac         Destination mac address.
 *
 * @return index of mapping matching the lookup key.
 */
u32
lisp_l2_fib_lookup (lisp_gpe_main_t * lgm, u16 bd_index, u8 src_mac[6],
		    u8 dst_mac[6])
{
  int rv;
  BVT (clib_bihash_kv) kv, value;

  make_mac_fib_key (&kv, bd_index, src_mac, dst_mac);
  rv = BV (clib_bihash_search_inline_2) (&lgm->l2_fib, &kv, &value);

  /* no match, try with src 0, catch all for dst */
  if (rv != 0)
    {
      kv.key[1] = 0;
      rv = BV (clib_bihash_search_inline_2) (&lgm->l2_fib, &kv, &value);
      if (rv == 0)
	return value.value;
    }

  return ~0;
}

/**
 * @brief Add/del L2 SD FIB entry
 *
 * Inserts value in L2 FIB keyed by vni + dest + source. If entry is
 * overwritten the associated value is returned.
 *
 * @param[in]   lgm             Reference to @ref lisp_gpe_main_t.
 * @param[in]   bd_index        Bridge domain index.
 * @param[in]   src_mac         Source mac address.
 * @param[in]   dst_mac         Destination mac address.
 * @param[in]   val             Value to add.
 * @param[in]   is_add          Add/del flag.
 *
 * @return ~0 or value of overwritten entry.
 */
u32
lisp_l2_fib_add_del_entry (lisp_gpe_main_t * lgm, u16 bd_index, u8 src_mac[6],
			   u8 dst_mac[6], u32 val, u8 is_add)
{
  BVT (clib_bihash_kv) kv, value;
  u32 old_val = ~0;

  make_mac_fib_key (&kv, bd_index, src_mac, dst_mac);

  if (BV (clib_bihash_search) (&lgm->l2_fib, &kv, &value) == 0)
    old_val = value.value;

  if (!is_add)
    BV (clib_bihash_add_del) (&lgm->l2_fib, &kv, 0 /* is_add */ );
  else
    {
      kv.value = val;
      BV (clib_bihash_add_del) (&lgm->l2_fib, &kv, 1 /* is_add */ );
    }
  return old_val;
}

static void
l2_fib_init (lisp_gpe_main_t * lgm)
{
  BV (clib_bihash_init) (&lgm->l2_fib, "l2 fib",
			 1 << max_log2 (L2_FIB_DEFAULT_HASH_NUM_BUCKETS),
			 L2_FIB_DEFAULT_HASH_MEMORY_SIZE);
}

/**
 * @brief Add/Delete LISP L2 forwarding entry.
 *
 * Coordinates the creation/removal of forwarding entries for L2 LISP overlay:
 * creates lisp-gpe tunnel and injects new entry in Source/Dest L2 FIB.
 *
 * @param[in]   lgm     Reference to @ref lisp_gpe_main_t.
 * @param[in]   a       Parameters for building the forwarding entry.
 *
 * @return 0 on success.
 */
static int
add_del_l2_fwd_entry (lisp_gpe_main_t * lgm,
		      vnet_lisp_gpe_add_del_fwd_entry_args_t * a)
{
  int rv;
  u32 tun_index;
  bd_main_t *bdm = &bd_main;
  uword *bd_indexp;

  /* create tunnel */
  rv = add_del_ip_tunnel (a, 1 /* is_l2 */ , &tun_index);
  if (rv)
    return rv;

  bd_indexp = hash_get (bdm->bd_index_by_bd_id, a->bd_id);
  if (!bd_indexp)
    {
      clib_warning ("bridge domain %d doesn't exist", a->bd_id);
      return -1;
    }

  /* add entry to l2 lisp fib */
  lisp_l2_fib_add_del_entry (lgm, bd_indexp[0], gid_address_mac (&a->lcl_eid),
			     gid_address_mac (&a->rmt_eid), tun_index,
			     a->is_add);
  return 0;
}

/**
 * @brief Forwarding entry create/remove dispatcher.
 *
 * Calls l2 or l3 forwarding entry add/del function based on input data.
 *
 * @param[in]   a       Forwarding entry parameters.
 * @param[out]  hw_if_indexp    NOT USED
 *
 * @return 0 on success.
 */
int
vnet_lisp_gpe_add_del_fwd_entry (vnet_lisp_gpe_add_del_fwd_entry_args_t * a,
				 u32 * hw_if_indexp)
{
  lisp_gpe_main_t *lgm = &lisp_gpe_main;
  u8 type;

  if (vnet_lisp_gpe_enable_disable_status () == 0)
    {
      clib_warning ("LISP is disabled!");
      return VNET_API_ERROR_LISP_DISABLED;
    }

  type = gid_address_type (&a->rmt_eid);
  switch (type)
    {
    case GID_ADDR_IP_PREFIX:
      return add_del_ip_fwd_entry (lgm, a);
    case GID_ADDR_MAC:
      return add_del_l2_fwd_entry (lgm, a);
    default:
      clib_warning ("Forwarding entries for type %d not supported!", type);
      return -1;
    }
}

/** CLI command to add/del forwarding entry. */
static clib_error_t *
lisp_gpe_add_del_fwd_entry_command_fn (vlib_main_t * vm,
				       unformat_input_t * input,
				       vlib_cli_command_t * cmd)
{
  unformat_input_t _line_input, *line_input = &_line_input;
  u8 is_add = 1;
  ip_address_t lloc, rloc;
  clib_error_t *error = 0;
  gid_address_t _reid, *reid = &_reid, _leid, *leid = &_leid;
  u8 reid_set = 0, leid_set = 0, is_negative = 0, vrf_set = 0, vni_set = 0;
  u32 vni, vrf, action = ~0, p, w;
  locator_pair_t pair, *pairs = 0;
  int rv;

  /* Get a line of input. */
  if (!unformat_user (input, unformat_line_input, line_input))
    return 0;

  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
    {
      if (unformat (line_input, "del"))
	is_add = 0;
      else if (unformat (line_input, "add"))
	is_add = 1;
      else if (unformat (line_input, "leid %U", unformat_gid_address, leid))
	{
	  leid_set = 1;
	}
      else if (unformat (line_input, "reid %U", unformat_gid_address, reid))
	{
	  reid_set = 1;
	}
      else if (unformat (line_input, "vni %u", &vni))
	{
	  gid_address_vni (leid) = vni;
	  gid_address_vni (reid) = vni;
	  vni_set = 1;
	}
      else if (unformat (line_input, "vrf %u", &vrf))
	{
	  vrf_set = 1;
	}
      else if (unformat (line_input, "negative action %U",
			 unformat_negative_mapping_action, &action))
	{
	  is_negative = 1;
	}
      else if (unformat (line_input, "loc-pair %U %U p %d w %d",
			 unformat_ip_address, &lloc,
			 unformat_ip_address, &rloc, &p, &w))
	{
	  pair.lcl_loc = lloc;
	  pair.rmt_loc = rloc;
	  pair.priority = p;
	  pair.weight = w;
	  vec_add1 (pairs, pair);
	}
      else
	{
	  error = unformat_parse_error (line_input);
	  goto done;
	}
    }
  unformat_free (line_input);

  if (!vni_set || !vrf_set)
    {
      error = clib_error_return (0, "vni and vrf must be set!");
      goto done;
    }

  if (!reid_set)
    {
      error = clib_error_return (0, "remote eid must be set!");
      goto done;
    }

  if (is_negative)
    {
      if (~0 == action)
	{
	  error = clib_error_return (0, "no action set for negative tunnel!");
	  goto done;
	}
    }
  else
    {
      if (vec_len (pairs) == 0)
	{
	  error = clib_error_return (0, "expected ip4/ip6 locators.");
	  goto done;
	}
    }

  if (!leid_set)
    {
      /* if leid not set, make sure it's the same AFI like reid */
      gid_address_type (leid) = gid_address_type (reid);
      if (GID_ADDR_IP_PREFIX == gid_address_type (reid))
	gid_address_ip_version (leid) = gid_address_ip_version (reid);
    }

  /* add fwd entry */
  vnet_lisp_gpe_add_del_fwd_entry_args_t _a, *a = &_a;
  memset (a, 0, sizeof (a[0]));

  a->is_add = is_add;
  a->vni = vni;
  a->table_id = vrf;
  gid_address_copy (&a->lcl_eid, leid);
  gid_address_copy (&a->rmt_eid, reid);
  a->locator_pairs = pairs;

  rv = vnet_lisp_gpe_add_del_fwd_entry (a, 0);
  if (0 != rv)
    {
      error = clib_error_return (0, "failed to %s gpe tunnel!",
				 is_add ? "add" : "delete");
    }

done:
  vec_free (pairs);
  return error;
}

/* *INDENT-OFF* */
VLIB_CLI_COMMAND (lisp_gpe_add_del_fwd_entry_command, static) = {
  .path = "lisp gpe tunnel",
  .short_help = "lisp gpe tunnel add/del vni <vni> vrf <vrf> [leid <leid>]"
      "reid <reid> [loc-pair <lloc> <rloc> p <priority> w <weight>] "
      "[negative action <action>]",
  .function = lisp_gpe_add_del_fwd_entry_command_fn,
};
/* *INDENT-ON* */

/** Format LISP-GPE next indexes. */
static u8 *
format_decap_next (u8 * s, va_list * args)
{
  u32 next_index = va_arg (*args, u32);

  switch (next_index)
    {
    case LISP_GPE_INPUT_NEXT_DROP:
      return format (s, "drop");
    case LISP_GPE_INPUT_NEXT_IP4_INPUT:
      return format (s, "ip4");
    case LISP_GPE_INPUT_NEXT_IP6_INPUT:
      return format (s, "ip6");
    default:
      return format (s, "unknown %d", next_index);
    }
  return s;
}

/** Format LISP-GPE tunnel. */
u8 *
format_lisp_gpe_tunnel (u8 * s, va_list * args)
{
  lisp_gpe_tunnel_t *t = va_arg (*args, lisp_gpe_tunnel_t *);
  lisp_gpe_main_t *lgm = vnet_lisp_gpe_get_main ();
  locator_pair_t *lp = 0;
  normalized_sub_tunnel_weights_t *nstw;

  s =
    format (s, "tunnel %d vni %d (0x%x)\n", t - lgm->tunnels, t->vni, t->vni);
  s =
    format (s, " fibs: encap %d, decap %d decap next %U\n",
	    t->encap_fib_index, t->decap_fib_index, format_decap_next,
	    t->decap_next_index);
  s = format (s, " lisp ver %d ", (t->ver_res >> 6));

#define _(n,v) if (t->flags & v) s = format (s, "%s-bit ", #n);
  foreach_lisp_gpe_flag_bit;
#undef _

  s = format (s, "next_protocol %d ver_res %x res %x\n",
	      t->next_protocol, t->ver_res, t->res);

  s = format (s, " locator-pairs:\n");
  vec_foreach (lp, t->locator_pairs)
  {
    s = format (s, "  local: %U remote: %U weight %d\n",
		format_ip_address, &lp->lcl_loc, format_ip_address,
		&lp->rmt_loc, lp->weight);
  }

  s = format (s, " active sub-tunnels:\n");
  vec_foreach (nstw, t->norm_sub_tunnel_weights)
  {
    lp = vec_elt_at_index (t->locator_pairs, nstw->sub_tunnel_index);
    s = format (s, "  local: %U remote: %U weight %d\n", format_ip_address,
		&lp->lcl_loc, format_ip_address, &lp->rmt_loc, nstw->weight);
  }
  return s;
}

/** CLI command to show LISP-GPE tunnels. */
static clib_error_t *
show_lisp_gpe_tunnel_command_fn (vlib_main_t * vm,
				 unformat_input_t * input,
				 vlib_cli_command_t * cmd)
{
  lisp_gpe_main_t *lgm = &lisp_gpe_main;
  lisp_gpe_tunnel_t *t;

  if (pool_elts (lgm->tunnels) == 0)
    vlib_cli_output (vm, "No lisp-gpe tunnels configured...");

  /* *INDENT-OFF* */
  pool_foreach (t, lgm->tunnels,
  ({
    vlib_cli_output (vm, "%U", format_lisp_gpe_tunnel, t);
  }));
  /* *INDENT-ON* */

  return 0;
}

/* *INDENT-OFF* */
VLIB_CLI_COMMAND (show_lisp_gpe_tunnel_command, static) =
{
  .path = "show lisp gpe tunnel",
  .function = show_lisp_gpe_tunnel_command_fn,
};
/* *INDENT-ON* */

/** Check if LISP-GPE is enabled. */
u8
vnet_lisp_gpe_enable_disable_status (void)
{
  lisp_gpe_main_t *lgm = &lisp_gpe_main;

  return lgm->is_en;
}

/** Enable/disable LISP-GPE. */
clib_error_t *
vnet_lisp_gpe_enable_disable (vnet_lisp_gpe_enable_disable_args_t * a)
{
  lisp_gpe_main_t *lgm = &lisp_gpe_main;
  vnet_main_t *vnm = lgm->vnet_main;

  if (a->is_en)
    {
      /* add lgpe_ip4_lookup as possible next_node for ip4 lookup */
      if (lgm->ip4_lookup_next_lgpe_ip4_lookup == ~0)
	{
	  lgm->ip4_lookup_next_lgpe_ip4_lookup =
	    vlib_node_add_next (vnm->vlib_main, ip4_lookup_node.index,
				lgpe_ip4_lookup_node.index);
	}
      /* add lgpe_ip6_lookup as possible next_node for ip6 lookup */
      if (lgm->ip6_lookup_next_lgpe_ip6_lookup == ~0)
	{
	  lgm->ip6_lookup_next_lgpe_ip6_lookup =
	    vlib_node_add_next (vnm->vlib_main, ip6_lookup_node.index,
				lgpe_ip6_lookup_node.index);
	}
      else
	{
	  /* ask cp to re-add ifaces and defaults */
	}

      lgm->is_en = 1;
    }
  else
    {
      CLIB_UNUSED (uword * val);
      hash_pair_t *p;
      u32 *dp_tables = 0, *dp_table;
      lisp_gpe_tunnel_key_t *tunnels = 0, *tunnel;
      vnet_lisp_gpe_add_del_fwd_entry_args_t _at, *at = &_at;
      vnet_lisp_gpe_add_del_iface_args_t _ai, *ai = &_ai;

      /* remove all tunnels */

      /* *INDENT-OFF* */
      mhash_foreach(tunnel, val, &lgm->lisp_gpe_tunnel_by_key, ({
        vec_add1(tunnels, tunnel[0]);
      }));
      /* *INDENT-ON* */

      vec_foreach (tunnel, tunnels)
      {
	memset (at, 0, sizeof (at[0]));
	at->is_add = 0;
	if (tunnel->rmt.type == GID_ADDR_IP_PREFIX)
	  {
	    gid_address_type (&at->rmt_eid) = GID_ADDR_IP_PREFIX;
	    ip_prefix_copy (&gid_address_ippref (&at->rmt_eid),
			    &tunnel->rmt.ippref);
	  }
	else
	  {
	    gid_address_type (&at->rmt_eid) = GID_ADDR_MAC;
	    mac_copy (&gid_address_mac (&at->rmt_eid), &tunnel->rmt.mac);
	  }
	vnet_lisp_gpe_add_del_fwd_entry (at, 0);
      }
      vec_free (tunnels);

      /* disable all l3 ifaces */

      /* *INDENT-OFF* */
      hash_foreach_pair(p, lgm->l3_ifaces.hw_if_index_by_dp_table, ({
        vec_add1(dp_tables, p->key);
      }));
      /* *INDENT-ON* */

      vec_foreach (dp_table, dp_tables)
      {
	ai->is_add = 0;
	ai->table_id = dp_table[0];
	ai->is_l2 = 0;

	/* disables interface and removes defaults */
	vnet_lisp_gpe_add_del_iface (ai, 0);
      }

      /* disable all l2 ifaces */
      _vec_len (dp_tables) = 0;

      /* *INDENT-OFF* */
      hash_foreach_pair(p, lgm->l2_ifaces.hw_if_index_by_dp_table, ({
        vec_add1(dp_tables, p->key);
      }));
      /* *INDENT-ON* */

      vec_foreach (dp_table, dp_tables)
      {
	ai->is_add = 0;
	ai->bd_id = dp_table[0];
	ai->is_l2 = 1;

	/* disables interface and removes defaults */
	vnet_lisp_gpe_add_del_iface (ai, 0);
      }

      vec_free (dp_tables);
      lgm->is_en = 0;
    }

  return 0;
}

/** CLI command to enable/disable LISP-GPE. */
static clib_error_t *
lisp_gpe_enable_disable_command_fn (vlib_main_t * vm,
				    unformat_input_t * input,
				    vlib_cli_command_t * cmd)
{
  unformat_input_t _line_input, *line_input = &_line_input;
  u8 is_en = 1;
  vnet_lisp_gpe_enable_disable_args_t _a, *a = &_a;

  /* Get a line of input. */
  if (!unformat_user (input, unformat_line_input, line_input))
    return 0;

  while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
    {
      if (unformat (line_input, "enable"))
	is_en = 1;
      else if (unformat (line_input, "disable"))
	is_en = 0;
      else
	{
	  return clib_error_return (0, "parse error: '%U'",
				    format_unformat_error, line_input);
	}
    }
  a->is_en = is_en;
  return vnet_lisp_gpe_enable_disable (a);
}

/* *INDENT-OFF* */
VLIB_CLI_COMMAND (enable_disable_lisp_gpe_command, static) = {
  .path = "lisp gpe",
  .short_help = "lisp gpe [enable|disable]",
  .function = lisp_gpe_enable_disable_command_fn,
};
/* *INDENT-ON* */

/** CLI command to show LISP-GPE interfaces. */
static clib_error_t *
lisp_show_iface_command_fn (vlib_main_t * vm,
			    unformat_input_t * input,
			    vlib_cli_command_t * cmd)
{
  lisp_gpe_main_t *lgm = &lisp_gpe_main;
  hash_pair_t *p;

  vlib_cli_output (vm, "%=10s%=12s", "vrf", "hw_if_index");

  /* *INDENT-OFF* */
  hash_foreach_pair (p, lgm->l3_ifaces.hw_if_index_by_dp_table, ({
    vlib_cli_output (vm, "%=10d%=10d", p->key, p->value[0]);
  }));
  /* *INDENT-ON* */

  if (0 != lgm->l2_ifaces.hw_if_index_by_dp_table)
    {
      vlib_cli_output (vm, "%=10s%=12s", "bd_id", "hw_if_index");
      /* *INDENT-OFF* */
      hash_foreach_pair (p, lgm->l2_ifaces.hw_if_index_by_dp_table, ({
        vlib_cli_output (vm, "%=10d%=10d", p->key, p->value[0]);
      }));
      /* *INDENT-ON* */
    }
  return 0;
}

/* *INDENT-OFF* */
VLIB_CLI_COMMAND (lisp_show_iface_command) = {
    .path = "show lisp gpe interface",
    .short_help = "show lisp gpe interface",
    .function = lisp_show_iface_command_fn,
};
/* *INDENT-ON* */

/** Format LISP-GPE status. */
u8 *
format_vnet_lisp_gpe_status (u8 * s, va_list * args)
{
  lisp_gpe_main_t *lgm = &lisp_gpe_main;
  return format (s, "%s", lgm->is_en ? "enabled" : "disabled");
}

/** LISP-GPE init function. */
clib_error_t *
lisp_gpe_init (vlib_main_t * vm)
{
  lisp_gpe_main_t *lgm = &lisp_gpe_main;
  clib_error_t *error = 0;

  if ((error = vlib_call_init_function (vm, ip_main_init)))
    return error;

  if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
    return error;

  lgm->vnet_main = vnet_get_main ();
  lgm->vlib_main = vm;
  lgm->im4 = &ip4_main;
  lgm->im6 = &ip6_main;
  lgm->lm4 = &ip4_main.lookup_main;
  lgm->lm6 = &ip6_main.lookup_main;
  lgm->ip4_lookup_next_lgpe_ip4_lookup = ~0;
  lgm->ip6_lookup_next_lgpe_ip6_lookup = ~0;

  mhash_init (&lgm->lisp_gpe_tunnel_by_key, sizeof (uword),
	      sizeof (lisp_gpe_tunnel_key_t));

  l2_fib_init (lgm);

  udp_register_dst_port (vm, UDP_DST_PORT_lisp_gpe,
			 lisp_gpe_ip4_input_node.index, 1 /* is_ip4 */ );
  udp_register_dst_port (vm, UDP_DST_PORT_lisp_gpe6,
			 lisp_gpe_ip6_input_node.index, 0 /* is_ip4 */ );
  return 0;
}

VLIB_INIT_FUNCTION (lisp_gpe_init);

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "gnu")
 * End:
 */