src/vnet/devices/tap/tapv2_api.c

/*
 *------------------------------------------------------------------
 * tap_api.c - vnet tap device driver API support
 *
 * Copyright (c) 2017 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.
 *------------------------------------------------------------------
 */

#include <vnet/vnet.h>
#include <vlibmemory/api.h>

#include <vnet/interface.h>
#include <vnet/api_errno.h>
#include <vnet/ethernet/ethernet.h>
#include <vnet/ip/ip.h>
#include <vnet/ethernet/ethernet_types_api.h>
#include <vnet/ip/ip_types_api.h>
#include <vnet/devices/tap/tap.h>

#include <vnet/format_fns.h>
#include <vnet/devices/tap/tapv2.api_enum.h>
#include <vnet/devices/tap/tapv2.api_types.h>

#define REPLY_MSG_ID_BASE tap_main.msg_id_base
#include <vlibapi/api_helper_macros.h>

static void
vl_api_tap_create_v3_t_handler (vl_api_tap_create_v3_t *mp)
{
  vl_api_registration_t *reg;
  int rv;

  reg = vl_api_client_index_to_registration (mp->client_index);
  if (!reg)
    return;

  vnet_main_t *vnm = vnet_get_main ();
  vlib_main_t *vm = vlib_get_main ();
  vl_api_tap_create_v3_reply_t *rmp;

  tap_create_if_args_t _a, *ap = &_a;

  clib_memset (ap, 0, sizeof (*ap));

  ap->id = mp->id;
  if (!mp->use_random_mac)
    {
      mac_address_decode (mp->mac_address, &ap->mac_addr);
      ap->mac_addr_set = 1;
    }
  ap->rx_ring_sz = mp->rx_ring_sz;
  ap->tx_ring_sz = mp->tx_ring_sz;
  ap->sw_if_index = (u32) ~0;
  ap->num_rx_queues = clib_max (1, mp->num_rx_queues);
  ap->num_tx_queues = mp->num_tx_queues;

  if (mp->host_if_name_set)
    ap->host_if_name = format (0, "%s%c", mp->host_if_name, 0);

  if (mp->host_mac_addr_set)
    {
      mac_address_decode (mp->host_mac_addr, &ap->host_mac_addr);
    }

  if (mp->host_namespace_set)
    ap->host_namespace = format (0, "%s%c", mp->host_namespace, 0);

  if (mp->host_bridge_set)
    ap->host_bridge = format (0, "%s%c", mp->host_bridge, 0);

  if (mp->host_ip4_prefix_set)
    {
      ip4_address_decode (mp->host_ip4_prefix.address, &ap->host_ip4_addr);
      ap->host_ip4_prefix_len = mp->host_ip4_prefix.len;
    }

  if (mp->host_ip6_prefix_set)
    {
      ip6_address_decode (mp->host_ip6_prefix.address, &ap->host_ip6_addr);
      ap->host_ip6_prefix_len = mp->host_ip6_prefix.len;
    }

  if (mp->host_ip4_gw_set)
    {
      ip4_address_decode (mp->host_ip4_gw, &ap->host_ip4_gw);
      ap->host_ip4_gw_set = 1;
    }

  if (mp->host_ip6_gw_set)
    {
      ip6_address_decode (mp->host_ip6_gw, &ap->host_ip6_gw);
      ap->host_ip6_gw_set = 1;
    }

  if (mp->host_mtu_set)
    {
      ap->host_mtu_size = mp->host_mtu_size;
      ap->host_mtu_set = 1;
    }

  ap->tap_flags = mp->tap_flags;

  tap_create_if (vm, ap);

  /* If a tag was supplied... */
  if (vl_api_string_len (&mp->tag))
    {
      u8 *tag = vl_api_from_api_to_new_vec (mp, &mp->tag);
      vnet_set_sw_interface_tag (vnm, tag, ap->sw_if_index);
    }

  vec_free (ap->host_if_name);
  vec_free (ap->host_namespace);
  vec_free (ap->host_bridge);

  rv = ap->rv;
  REPLY_MACRO2_END (VL_API_TAP_CREATE_V3_REPLY,
		    ({ rmp->sw_if_index = ap->sw_if_index; }));
}

static void
vl_api_tap_create_v2_t_handler (vl_api_tap_create_v2_t * mp)
{
  vl_api_registration_t *reg;
  reg = vl_api_client_index_to_registration (mp->client_index);
  if (!reg)
    return;

  vnet_main_t *vnm = vnet_get_main ();
  vlib_main_t *vm = vlib_get_main ();
  vl_api_tap_create_v2_reply_t *rmp;

  tap_create_if_args_t _a, *ap = &_a;

  clib_memset (ap, 0, sizeof (*ap));

  ap->id = ntohl (mp->id);
  if (!mp->use_random_mac)
    {
      mac_address_decode (mp->mac_address, &ap->mac_addr);
      ap->mac_addr_set = 1;
    }
  ap->rx_ring_sz = ntohs (mp->rx_ring_sz);
  ap->tx_ring_sz = ntohs (mp->tx_ring_sz);
  ap->sw_if_index = (u32) ~ 0;
  ap->num_rx_queues = 1;
  ap->num_tx_queues = 1;

  if (mp->num_rx_queues > 1)
    ap->num_rx_queues = mp->num_rx_queues;

  if (mp->host_if_name_set)
    ap->host_if_name = format (0, "%s%c", mp->host_if_name, 0);

  if (mp->host_mac_addr_set)
    {
      mac_address_decode (mp->host_mac_addr, &ap->host_mac_addr);
    }

  if (mp->host_namespace_set)
    ap->host_namespace = format (0, "%s%c", mp->host_namespace, 0);

  if (mp->host_bridge_set)
    ap->host_bridge = format (0, "%s%c", mp->host_bridge, 0);

  if (mp->host_ip4_prefix_set)
    {
      ip4_address_decode (mp->host_ip4_prefix.address, &ap->host_ip4_addr);
      ap->host_ip4_prefix_len = mp->host_ip4_prefix.len;
    }

  if (mp->host_ip6_prefix_set)
    {
      ip6_address_decode (mp->host_ip6_prefix.address, &ap->host_ip6_addr);
      ap->host_ip6_prefix_len = mp->host_ip6_prefix.len;
    }

  if (mp->host_ip4_gw_set)
    {
      ip4_address_decode (mp->host_ip4_gw, &ap->host_ip4_gw);
      ap->host_ip4_gw_set = 1;
    }

  if (mp->host_ip6_gw_set)
    {
      ip6_address_decode (mp->host_ip6_gw, &ap->host_ip6_gw);
      ap->host_ip6_gw_set = 1;
    }

  if (mp->host_mtu_set)
    {
      ap->host_mtu_size = ntohl (mp->host_mtu_size);
      ap->host_mtu_set = 1;
    }

  STATIC_ASSERT (((int) TAP_API_FLAG_GSO == (int) TAP_FLAG_GSO),
		 "tap gso api flag mismatch");
  STATIC_ASSERT (((int) TAP_API_FLAG_CSUM_OFFLOAD ==
		  (int) TAP_FLAG_CSUM_OFFLOAD),
		 "tap checksum offload api flag mismatch");
  STATIC_ASSERT (((int) TAP_API_FLAG_PERSIST == (int) TAP_FLAG_PERSIST),
		 "tap persist api flag mismatch");
  STATIC_ASSERT (((int) TAP_API_FLAG_ATTACH == (int) TAP_FLAG_ATTACH),
		 "tap attach api flag mismatch");
  STATIC_ASSERT (((int) TAP_API_FLAG_TUN == (int) TAP_FLAG_TUN),
		 "tap tun api flag mismatch");
  STATIC_ASSERT (((int) TAP_API_FLAG_GRO_COALESCE ==
		  (int) TAP_FLAG_GRO_COALESCE),
		 "tap gro coalesce api flag mismatch");
  STATIC_ASSERT (((int) TAP_API_FLAG_PACKED == (int) TAP_FLAG_PACKED),
		 "tap packed api flag mismatch");
  STATIC_ASSERT (((int) TAP_API_FLAG_IN_ORDER ==
		  (int) TAP_FLAG_IN_ORDER), "tap in-order api flag mismatch");

  ap->tap_flags = ntohl (mp->tap_flags);

  tap_create_if (vm, ap);


  /* If a tag was supplied... */
  if (vl_api_string_len (&mp->tag))
    {
      u8 *tag = vl_api_from_api_to_new_vec (mp, &mp->tag);
      vnet_set_sw_interface_tag (vnm, tag, ap->sw_if_index);
    }

  rmp = vl_msg_api_alloc (sizeof (*rmp));
  rmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_TAP_CREATE_V2_REPLY);
  rmp->context = mp->context;
  rmp->retval = ntohl (ap->rv);
  rmp->sw_if_index = ntohl (ap->sw_if_index);

  vl_api_send_msg (reg, (u8 *) rmp);

  vec_free (ap->host_if_name);
  vec_free (ap->host_namespace);
  vec_free (ap->host_bridge);

}

static void
vl_api_tap_delete_v2_t_handler (vl_api_tap_delete_v2_t * mp)
{
  vl_api_registration_t *reg;
  reg = vl_api_client_index_to_registration (mp->client_index);
  if (!reg)
    return;

  vnet_main_t *vnm = vnet_get_main ();
  vlib_main_t *vm = vlib_get_main ();
  int rv;
  vl_api_tap_delete_v2_reply_t *rmp;

  u32 sw_if_index = ntohl (mp->sw_if_index);

  rv = tap_delete_if (vm, sw_if_index);

  rmp = vl_msg_api_alloc (sizeof (*rmp));
  rmp->_vl_msg_id = ntohs (REPLY_MSG_ID_BASE + VL_API_TAP_DELETE_V2_REPLY);
  rmp->context = mp->context;
  rmp->retval = ntohl (rv);

  vl_api_send_msg (reg, (u8 *) rmp);

  if (!rv)
    vnet_clear_sw_interface_tag (vnm, sw_if_index);
}

static void
tap_send_sw_interface_details (vpe_api_main_t * am,
			       vl_api_registration_t * reg,
			       tap_interface_details_t * tap_if, u32 context)
{
  vl_api_sw_interface_tap_v2_details_t *mp;
  mp = vl_msg_api_alloc (sizeof (*mp));
  clib_memset (mp, 0, sizeof (*mp));
  mp->_vl_msg_id =
    htons (REPLY_MSG_ID_BASE + VL_API_SW_INTERFACE_TAP_V2_DETAILS);
  mp->id = htonl (tap_if->id);
  mp->sw_if_index = htonl (tap_if->sw_if_index);
  mp->tap_flags = htonl (tap_if->tap_flags);
  clib_memcpy (mp->dev_name, tap_if->dev_name,
	       MIN (ARRAY_LEN (mp->dev_name) - 1,
		    strlen ((const char *) tap_if->dev_name)));
  mp->rx_ring_sz = htons (tap_if->rx_ring_sz);
  mp->tx_ring_sz = htons (tap_if->tx_ring_sz);
  mac_address_encode (&tap_if->host_mac_addr, mp->host_mac_addr);
  clib_memcpy (mp->host_if_name, tap_if->host_if_name,
	       MIN (ARRAY_LEN (mp->host_if_name) - 1,
		    strlen ((const char *) tap_if->host_if_name)));
  clib_memcpy (mp->host_namespace, tap_if->host_namespace,
	       MIN (ARRAY_LEN (mp->host_namespace) - 1,
		    strlen ((const char *) tap_if->host_namespace)));
  clib_memcpy (mp->host_bridge, tap_if->host_bridge,
	       MIN (ARRAY_LEN (mp->host_bridge) - 1,
		    strlen ((const char *) tap_if->host_bridge)));
  mp->host_mtu_size = htonl (tap_if->host_mtu_size);
  mac_address_encode (&tap_if->host_mac_addr, mp->host_mac_addr);

  if (tap_if->host_ip4_prefix_len)
    ip4_address_encode (&tap_if->host_ip4_addr, mp->host_ip4_prefix.address);
  mp->host_ip4_prefix.len = tap_if->host_ip4_prefix_len;
  if (tap_if->host_ip6_prefix_len)
    ip6_address_encode (&tap_if->host_ip6_addr, mp->host_ip6_prefix.address);
  mp->host_ip6_prefix.len = tap_if->host_ip6_prefix_len;

  mp->context = context;
  vl_api_send_msg (reg, (u8 *) mp);
}

static void
vl_api_sw_interface_tap_v2_dump_t_handler (vl_api_sw_interface_tap_v2_dump_t *
					   mp)
{
  int rv;
  vpe_api_main_t *am = &vpe_api_main;
  vl_api_registration_t *reg;
  tap_interface_details_t *tapifs = NULL;
  tap_interface_details_t *tap_if = NULL;
  u32 filter_sw_if_index;

  reg = vl_api_client_index_to_registration (mp->client_index);
  if (!reg)
    return;

  filter_sw_if_index = htonl (mp->sw_if_index);
  if (mp->sw_if_index != ~0)
    VALIDATE_SW_IF_INDEX (mp);

  rv = tap_dump_ifs (&tapifs);
  if (rv)
    return;

  vec_foreach (tap_if, tapifs)
  {
    if ((filter_sw_if_index == ~0)
	|| (tap_if->sw_if_index == filter_sw_if_index))
      tap_send_sw_interface_details (am, reg, tap_if, mp->context);
  }
  BAD_SW_IF_INDEX_LABEL;
  vec_free (tapifs);
}

#include <vnet/devices/tap/tapv2.api.c>
static clib_error_t *
tapv2_api_hookup (vlib_main_t * vm)
{
  /*
   * Set up the (msg_name, crc, message-id) table
   */
  REPLY_MSG_ID_BASE = setup_message_id_table ();

  return 0;
}

VLIB_API_INIT_FUNCTION (tapv2_api_hookup);

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