path: root/src/vnet/devices/virtio/vhost_user_api.c

/*
 *------------------------------------------------------------------
 * vhost-user_api.c - vhost-user api
 *
 * 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.
 *------------------------------------------------------------------
 */

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

#include <vnet/interface.h>
#include <vnet/api_errno.h>
#include <vnet/devices/virtio/vhost_user.h>
#include <vnet/ethernet/ethernet.h>
#include <vnet/ethernet/ethernet_types_api.h>
#include <vnet/devices/virtio/virtio_types_api.h>

#include <vnet/vnet_msg_enum.h>

#define vl_typedefs		/* define message structures */
#include <vnet/vnet_all_api_h.h>
#undef vl_typedefs

#define vl_endianfun		/* define message structures */
#include <vnet/vnet_all_api_h.h>
#undef vl_endianfun

/* instantiate all the print functions we know about */
#define vl_print(handle, ...) vlib_cli_output (handle, __VA_ARGS__)
#define vl_printfun
#include <vnet/vnet_all_api_h.h>
#undef vl_printfun

#include <vlibapi/api_helper_macros.h>

#define foreach_vpe_api_msg                                             \
_(CREATE_VHOST_USER_IF, create_vhost_user_if)                           \
_(MODIFY_VHOST_USER_IF, modify_vhost_user_if)                           \
_(CREATE_VHOST_USER_IF_V2, create_vhost_user_if_v2)                     \
_(MODIFY_VHOST_USER_IF_V2, modify_vhost_user_if_v2)                     \
_(DELETE_VHOST_USER_IF, delete_vhost_user_if)                           \
_(SW_INTERFACE_VHOST_USER_DUMP, sw_interface_vhost_user_dump)

static void
vl_api_create_vhost_user_if_t_handler (vl_api_create_vhost_user_if_t * mp)
{
  int rv = 0;
  vl_api_create_vhost_user_if_reply_t *rmp;
  vnet_main_t *vnm = vnet_get_main ();
  vlib_main_t *vm = vlib_get_main ();
  u64 disabled_features = (u64) (0ULL);
  vhost_user_create_if_args_t args = { 0 };

  args.sw_if_index = (u32) ~ 0;
  args.feature_mask = (u64) ~ (0ULL);
  if (mp->disable_mrg_rxbuf)
    disabled_features = VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF);

  if (mp->disable_indirect_desc)
    disabled_features |= VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC);

  /*
   * GSO and PACKED are not supported by feature mask via binary API. We
   * disable GSO and PACKED feature in the feature mask. They may be enabled
   * explicitly via enable_gso and enable_packed argument
   */
  disabled_features |= FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS |
    VIRTIO_FEATURE (VIRTIO_F_RING_PACKED);

  /* EVENT_IDX is disabled by default */
  disabled_features |= VIRTIO_FEATURE (VIRTIO_RING_F_EVENT_IDX);
  args.feature_mask &= ~disabled_features;

  if (mp->use_custom_mac)
    mac_address_decode (mp->mac_address, (mac_address_t *) args.hwaddr);

  args.is_server = mp->is_server;
  args.sock_filename = (char *) mp->sock_filename;
  args.renumber = mp->renumber;
  args.custom_dev_instance = ntohl (mp->custom_dev_instance);
  args.enable_gso = mp->enable_gso;
  args.enable_packed = mp->enable_packed;
  rv = vhost_user_create_if (vnm, vm, &args);

  /* Remember an interface tag for the new interface */
  if (rv == 0)
    {
      /* If a tag was supplied... */
      if (mp->tag[0])
	{
	  /* Make sure it's a proper C-string */
	  mp->tag[ARRAY_LEN (mp->tag) - 1] = 0;
	  u8 *tag = format (0, "%s%c", mp->tag, 0);
	  vnet_set_sw_interface_tag (vnm, tag, args.sw_if_index);
	}
    }

  /* *INDENT-OFF* */
  REPLY_MACRO2(VL_API_CREATE_VHOST_USER_IF_REPLY,
  ({
    rmp->sw_if_index = ntohl (args.sw_if_index);
  }));
  /* *INDENT-ON* */
}

static void
vl_api_modify_vhost_user_if_t_handler (vl_api_modify_vhost_user_if_t * mp)
{
  int rv = 0;
  vl_api_modify_vhost_user_if_reply_t *rmp;
  u64 disabled_features = (u64) (0ULL);
  vhost_user_create_if_args_t args = { 0 };
  vnet_main_t *vnm = vnet_get_main ();
  vlib_main_t *vm = vlib_get_main ();

  args.feature_mask = (u64) ~ (0ULL);
  /*
   * GSO and PACKED are not supported by feature mask via binary API. We
   * disable GSO and PACKED feature in the feature mask. They may be enabled
   * explicitly via enable_gso and enable_packed argument
   */
  disabled_features |= FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS |
    VIRTIO_FEATURE (VIRTIO_F_RING_PACKED);

  /* EVENT_IDX is disabled by default */
  disabled_features |= VIRTIO_FEATURE (VIRTIO_RING_F_EVENT_IDX);
  args.feature_mask &= ~disabled_features;

  args.sw_if_index = ntohl (mp->sw_if_index);
  args.sock_filename = (char *) mp->sock_filename;
  args.is_server = mp->is_server;
  args.renumber = mp->renumber;
  args.custom_dev_instance = ntohl (mp->custom_dev_instance);
  args.enable_gso = mp->enable_gso;
  args.enable_packed = mp->enable_packed;
  rv = vhost_user_modify_if (vnm, vm, &args);

  REPLY_MACRO (VL_API_MODIFY_VHOST_USER_IF_REPLY);
}

static void
vl_api_create_vhost_user_if_v2_t_handler (vl_api_create_vhost_user_if_v2_t *
					  mp)
{
  int rv = 0;
  vl_api_create_vhost_user_if_v2_reply_t *rmp;
  vnet_main_t *vnm = vnet_get_main ();
  vlib_main_t *vm = vlib_get_main ();
  u64 disabled_features = (u64) (0ULL);
  vhost_user_create_if_args_t args = { 0 };

  args.sw_if_index = (u32) ~ 0;
  args.feature_mask = (u64) ~ (0ULL);
  if (mp->disable_mrg_rxbuf)
    disabled_features = VIRTIO_FEATURE (VIRTIO_NET_F_MRG_RXBUF);

  if (mp->disable_indirect_desc)
    disabled_features |= VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC);

  /*
   * GSO and PACKED are not supported by feature mask via binary API. We
   * disable GSO and PACKED feature in the feature mask. They may be enabled
   * explicitly via enable_gso and enable_packed argument
   */
  disabled_features |= FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS |
    VIRTIO_FEATURE (VIRTIO_F_RING_PACKED);

  /* EVENT_IDX is disabled by default */
  disabled_features |= VIRTIO_FEATURE (VIRTIO_RING_F_EVENT_IDX);
  args.feature_mask &= ~disabled_features;

  if (mp->use_custom_mac)
    mac_address_decode (mp->mac_address, (mac_address_t *) args.hwaddr);

  args.is_server = mp->is_server;
  args.sock_filename = (char *) mp->sock_filename;
  args.renumber = mp->renumber;
  args.custom_dev_instance = ntohl (mp->custom_dev_instance);
  args.enable_gso = mp->enable_gso;
  args.enable_packed = mp->enable_packed;
  args.enable_event_idx = mp->enable_event_idx;
  rv = vhost_user_create_if (vnm, vm, &args);

  /* Remember an interface tag for the new interface */
  if (rv == 0)
    {
      /* If a tag was supplied... */
      if (mp->tag[0])
	{
	  /* Make sure it's a proper C-string */
	  mp->tag[ARRAY_LEN (mp->tag) - 1] = 0;
	  u8 *tag = format (0, "%s%c", mp->tag, 0);
	  vnet_set_sw_interface_tag (vnm, tag, args.sw_if_index);
	}
    }

  /* *INDENT-OFF* */
  REPLY_MACRO2(VL_API_CREATE_VHOST_USER_IF_V2_REPLY,
  ({
    rmp->sw_if_index = ntohl (args.sw_if_index);
  }));
  /* *INDENT-ON* */
}

static void
vl_api_modify_vhost_user_if_v2_t_handler (vl_api_modify_vhost_user_if_v2_t *
					  mp)
{
  int rv = 0;
  vl_api_modify_vhost_user_if_v2_reply_t *rmp;
  u64 disabled_features = (u64) (0ULL);
  vhost_user_create_if_args_t args = { 0 };
  vnet_main_t *vnm = vnet_get_main ();
  vlib_main_t *vm = vlib_get_main ();

  args.feature_mask = (u64) ~ (0ULL);
  /*
   * GSO and PACKED are not supported by feature mask via binary API. We
   * disable GSO and PACKED feature in the feature mask. They may be enabled
   * explicitly via enable_gso and enable_packed argument
   */
  disabled_features |= FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS |
    VIRTIO_FEATURE (VIRTIO_F_RING_PACKED);

  /* EVENT_IDX is disabled by default */
  disabled_features |= VIRTIO_FEATURE (VIRTIO_RING_F_EVENT_IDX);
  args.feature_mask &= ~disabled_features;

  args.sw_if_index = ntohl (mp->sw_if_index);
  args.sock_filename = (char *) mp->sock_filename;
  args.is_server = mp->is_server;
  args.renumber = mp->renumber;
  args.custom_dev_instance = ntohl (mp->custom_dev_instance);
  args.enable_gso = mp->enable_gso;
  args.enable_packed = mp->enable_packed;
  args.enable_event_idx = mp->enable_event_idx;
  rv = vhost_user_modify_if (vnm, vm, &args);

  REPLY_MACRO (VL_API_MODIFY_VHOST_USER_IF_V2_REPLY);
}

static void
vl_api_delete_vhost_user_if_t_handler (vl_api_delete_vhost_user_if_t * mp)
{
  int rv = 0;
  vl_api_delete_vhost_user_if_reply_t *rmp;
  u32 sw_if_index = ntohl (mp->sw_if_index);
  vl_api_registration_t *reg;

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

  rv = vhost_user_delete_if (vnm, vm, sw_if_index);

  REPLY_MACRO (VL_API_DELETE_VHOST_USER_IF_REPLY);
  if (!rv)
    {
      reg = vl_api_client_index_to_registration (mp->client_index);
      if (!reg)
	return;

      vnet_clear_sw_interface_tag (vnm, sw_if_index);
    }
}

static void
send_sw_interface_vhost_user_details (vpe_api_main_t * am,
				      vl_api_registration_t * reg,
				      vhost_user_intf_details_t * vui,
				      u32 context)
{
  vl_api_sw_interface_vhost_user_details_t *mp;

  mp = vl_msg_api_alloc (sizeof (*mp));
  clib_memset (mp, 0, sizeof (*mp));
  mp->_vl_msg_id = ntohs (VL_API_SW_INTERFACE_VHOST_USER_DETAILS);
  mp->sw_if_index = ntohl (vui->sw_if_index);
  mp->virtio_net_hdr_sz = ntohl (vui->virtio_net_hdr_sz);
  virtio_features_encode (vui->features, (u32 *) & mp->features_first_32,
			  (u32 *) & mp->features_last_32);
  mp->is_server = vui->is_server;
  mp->num_regions = ntohl (vui->num_regions);
  mp->sock_errno = ntohl (vui->sock_errno);
  mp->context = context;

  strncpy ((char *) mp->sock_filename,
	   (char *) vui->sock_filename, ARRAY_LEN (mp->sock_filename) - 1);
  strncpy ((char *) mp->interface_name,
	   (char *) vui->if_name, ARRAY_LEN (mp->interface_name) - 1);

  vl_api_send_msg (reg, (u8 *) mp);
}

static void
  vl_api_sw_interface_vhost_user_dump_t_handler
  (vl_api_sw_interface_vhost_user_dump_t * mp)
{
  int rv = 0;
  vpe_api_main_t *am = &vpe_api_main;
  vnet_main_t *vnm = vnet_get_main ();
  vlib_main_t *vm = vlib_get_main ();
  vhost_user_intf_details_t *ifaces = NULL;
  vhost_user_intf_details_t *vuid = NULL;
  vl_api_registration_t *reg;
  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 (filter_sw_if_index != ~0)
    VALIDATE_SW_IF_INDEX (mp);

  rv = vhost_user_dump_ifs (vnm, vm, &ifaces);
  if (rv)
    return;

  vec_foreach (vuid, ifaces)
  {
    if ((filter_sw_if_index == ~0) ||
	(vuid->sw_if_index == filter_sw_if_index))
      send_sw_interface_vhost_user_details (am, reg, vuid, mp->context);
  }
  BAD_SW_IF_INDEX_LABEL;
  vec_free (ifaces);
}

/*
 * vhost-user_api_hookup
 * Add vpe's API message handlers to the table.
 * vlib has already mapped shared memory and
 * added the client registration handlers.
 * See .../vlib-api/vlibmemory/memclnt_vlib.c:memclnt_process()
 */
#define vl_msg_name_crc_list
#include <vnet/vnet_all_api_h.h>
#undef vl_msg_name_crc_list

static void
setup_message_id_table (api_main_t * am)
{
#define _(id,n,crc) vl_msg_api_add_msg_name_crc (am, #n "_" #crc, id);
  foreach_vl_msg_name_crc_vhost_user;
#undef _
}

static clib_error_t *
vhost_user_api_hookup (vlib_main_t * vm)
{
  api_main_t *am = vlibapi_get_main ();

#define _(N,n)                                                  \
    vl_msg_api_set_handlers(VL_API_##N, #n,                     \
                           vl_api_##n##_t_handler,              \
                           vl_noop_handler,                     \
                           vl_api_##n##_t_endian,               \
                           vl_api_##n##_t_print,                \
                           sizeof(vl_api_##n##_t), 1);
  foreach_vpe_api_msg;
#undef _

  /* Mark CREATE_VHOST_USER_IF as mp safe */
  am->is_mp_safe[VL_API_CREATE_VHOST_USER_IF] = 1;
  am->is_mp_safe[VL_API_CREATE_VHOST_USER_IF_V2] = 1;

  /*
   * Set up the (msg_name, crc, message-id) table
   */
  setup_message_id_table (am);

  return 0;
}

VLIB_API_INIT_FUNCTION (vhost_user_api_hookup);

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