src/vnet/devices/virtio/virtio_api.c

   1 /*
   2  *------------------------------------------------------------------
   3  * virtio_api.c - vnet virtio pci device driver API support
   4  *
   5  * Copyright (c) 2018 Cisco and/or its affiliates.
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at:
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *------------------------------------------------------------------
  18  */
  19
  20 #include <vnet/vnet.h>
  21 #include <vlibmemory/api.h>
  22
  23 #include <vnet/interface.h>
  24 #include <vnet/api_errno.h>
  25 #include <vnet/devices/virtio/virtio.h>
  26 #include <vnet/devices/virtio/pci.h>
  27 #include <vlib/pci/pci_types_api.h>
  28
  29 #include <vnet/format_fns.h>
  30 #include <vnet/devices/virtio/virtio.api_enum.h>
  31 #include <vnet/devices/virtio/virtio.api_types.h>
  32
  33 #define REPLY_MSG_ID_BASE virtio_main.msg_id_base
  34 #include <vlibapi/api_helper_macros.h>
  35
  36 /* It will be deprecated in 21.01 */
  37 static void
  38 vl_api_virtio_pci_create_t_handler (vl_api_virtio_pci_create_t * mp)
  39 {
  40   vlib_main_t *vm = vlib_get_main ();
  41   vl_api_virtio_pci_create_reply_t *rmp;
  42   vl_api_registration_t *reg;
  43   virtio_pci_create_if_args_t _a, *ap = &_a;
  44
  45   clib_memset (ap, 0, sizeof (*ap));
  46
  47   pci_address_decode (&mp->pci_addr, (vlib_pci_addr_t *) & ap->addr);
  48   if (!mp->use_random_mac)
  49     {
  50       clib_memcpy (ap->mac_addr, mp->mac_address, 6);
  51       ap->mac_addr_set = 1;
  52     }
  53   ap->sw_if_index = (u32) ~ 0;
  54   if (mp->gso_enabled)
  55     ap->gso_enabled = 1;
  56   else
  57     ap->gso_enabled = 0;
  58   if (mp->checksum_offload_enabled)
  59     ap->checksum_offload_enabled = 1;
  60   else
  61     ap->checksum_offload_enabled = 0;
  62
  63   ap->features = clib_net_to_host_u64 (mp->features);
  64
  65   virtio_pci_create_if (vm, ap);
  66
  67   reg = vl_api_client_index_to_registration (mp->client_index);
  68   if (!reg)
  69     return;;
  70
  71   rmp = vl_msg_api_alloc (sizeof (*rmp));
  72   rmp->_vl_msg_id = htons (REPLY_MSG_ID_BASE + VL_API_VIRTIO_PCI_CREATE_REPLY);
  73   rmp->context = mp->context;
  74   rmp->retval = htonl (ap->rv);
  75   rmp->sw_if_index = htonl (ap->sw_if_index);
  76
  77   vl_api_send_msg (reg, (u8 *) rmp);
  78 }
  79
  80 static void
  81 vl_api_virtio_pci_create_v2_t_handler (vl_api_virtio_pci_create_v2_t * mp)
  82 {
  83   vlib_main_t *vm = vlib_get_main ();
  84   vl_api_virtio_pci_create_v2_reply_t *rmp;
  85   vl_api_registration_t *reg;
  86   virtio_pci_create_if_args_t _a, *ap = &_a;
  87
  88   clib_memset (ap, 0, sizeof (*ap));
  89
  90   pci_address_decode (&mp->pci_addr, (vlib_pci_addr_t *) & ap->addr);
  91   if (!mp->use_random_mac)
  92     {
  93       clib_memcpy (ap->mac_addr, mp->mac_address, 6);
  94       ap->mac_addr_set = 1;
  95     }
  96   ap->sw_if_index = (u32) ~ 0;
  97
  98   STATIC_ASSERT (((int) VIRTIO_API_FLAG_GSO == (int) VIRTIO_FLAG_GSO),
  99                  "virtio gso api flag mismatch");
 100   STATIC_ASSERT (((int) VIRTIO_API_FLAG_CSUM_OFFLOAD ==
 101                   (int) VIRTIO_FLAG_CSUM_OFFLOAD),
 102                  "virtio checksum offload api flag mismatch");
 103   STATIC_ASSERT (((int) VIRTIO_API_FLAG_GRO_COALESCE ==
 104                   (int) VIRTIO_FLAG_GRO_COALESCE),
 105                  "virtio gro coalesce api flag mismatch");
 106   STATIC_ASSERT (((int) VIRTIO_API_FLAG_PACKED == (int) VIRTIO_FLAG_PACKED),
 107                  "virtio packed api flag mismatch");
 108   STATIC_ASSERT (((int) VIRTIO_API_FLAG_IN_ORDER ==
 109                   (int) VIRTIO_FLAG_IN_ORDER),
 110                  "virtio in-order api flag mismatch");
 111   STATIC_ASSERT (((int) VIRTIO_API_FLAG_BUFFERING ==
 112                   (int) VIRTIO_FLAG_BUFFERING),
 113                  "virtio buffering api flag mismatch");
 114
 115   ap->virtio_flags = clib_net_to_host_u32 (mp->virtio_flags);
 116   ap->features = clib_net_to_host_u64 (mp->features);
 117
 118   if (ap->virtio_flags & VIRTIO_API_FLAG_GSO)
 119     ap->gso_enabled = 1;
 120   else
 121     ap->gso_enabled = 0;
 122   if (ap->virtio_flags & VIRTIO_API_FLAG_CSUM_OFFLOAD)
 123     ap->checksum_offload_enabled = 1;
 124   else
 125     ap->checksum_offload_enabled = 0;
 126
 127   virtio_pci_create_if (vm, ap);
 128
 129   reg = vl_api_client_index_to_registration (mp->client_index);
 130   if (!reg)
 131     return;;
 132
 133   rmp = vl_msg_api_alloc (sizeof (*rmp));
 134   rmp->_vl_msg_id =
 135     htons (REPLY_MSG_ID_BASE + VL_API_VIRTIO_PCI_CREATE_V2_REPLY);
 136   rmp->context = mp->context;
 137   rmp->retval = htonl (ap->rv);
 138   rmp->sw_if_index = htonl (ap->sw_if_index);
 139
 140   vl_api_send_msg (reg, (u8 *) rmp);
 141 }
 142
 143 static void
 144 vl_api_virtio_pci_delete_t_handler (vl_api_virtio_pci_delete_t * mp)
 145 {
 146   vnet_main_t *vnm = vnet_get_main ();
 147   vlib_main_t *vm = vlib_get_main ();
 148   virtio_main_t *vim = &virtio_main;
 149   int rv = 0;
 150   vnet_hw_interface_t *hw;
 151   virtio_if_t *vif;
 152   vl_api_virtio_pci_delete_reply_t *rmp;
 153   vl_api_registration_t *reg;
 154
 155   hw =
 156     vnet_get_sup_hw_interface_api_visible_or_null (vnm,
 157                                                    htonl (mp->sw_if_index));
 158   if (hw == NULL || virtio_device_class.index != hw->dev_class_index)
 159     {
 160       rv = VNET_API_ERROR_INVALID_SW_IF_INDEX;
 161       goto reply;
 162     }
 163
 164   vif = pool_elt_at_index (vim->interfaces, hw->dev_instance);
 165
 166   rv = virtio_pci_delete_if (vm, vif);
 167
 168 reply:
 169   reg = vl_api_client_index_to_registration (mp->client_index);
 170   if (!reg)
 171     return;
 172
 173   rmp = vl_msg_api_alloc (sizeof (*rmp));
 174   rmp->_vl_msg_id = htons (REPLY_MSG_ID_BASE + VL_API_VIRTIO_PCI_DELETE_REPLY);
 175   rmp->context = mp->context;
 176   rmp->retval = htonl (rv);
 177
 178   vl_api_send_msg (reg, (u8 *) rmp);
 179 }
 180
 181 static void
 182 virtio_pci_send_sw_interface_details (vpe_api_main_t * am,
 183                                       vl_api_registration_t * reg,
 184                                       virtio_if_t * vif, u32 context)
 185 {
 186   vl_api_sw_interface_virtio_pci_details_t *mp;
 187   mp = vl_msg_api_alloc (sizeof (*mp));
 188
 189   clib_memset (mp, 0, sizeof (*mp));
 190
 191   mp->_vl_msg_id =
 192     htons (REPLY_MSG_ID_BASE + VL_API_SW_INTERFACE_VIRTIO_PCI_DETAILS);
 193   pci_address_encode ((vlib_pci_addr_t *) & vif->pci_addr.as_u32,
 194                       &mp->pci_addr);
 195   mp->sw_if_index = htonl (vif->sw_if_index);
 196   vnet_virtio_vring_t *vring = vec_elt_at_index (vif->rxq_vrings, 0);
 197   mp->rx_ring_sz = htons (vring->queue_size);
 198   vring = vec_elt_at_index (vif->txq_vrings, 0);
 199   mp->tx_ring_sz = htons (vring->queue_size);
 200   clib_memcpy (mp->mac_addr, vif->mac_addr, 6);
 201   mp->features = clib_host_to_net_u64 (vif->features);
 202
 203   mp->context = context;
 204   vl_api_send_msg (reg, (u8 *) mp);
 205 }
 206
 207 static void
 208   vl_api_sw_interface_virtio_pci_dump_t_handler
 209   (vl_api_sw_interface_virtio_pci_dump_t * mp)
 210 {
 211   vpe_api_main_t *am = &vpe_api_main;
 212   vl_api_registration_t *reg;
 213   virtio_main_t *vmx = &virtio_main;
 214   virtio_if_t *vif;
 215
 216   reg = vl_api_client_index_to_registration (mp->client_index);
 217   if (!reg)
 218     return;
 219
 220   pool_foreach (vif, vmx->interfaces)
 221   {
 222     if (vif->type == VIRTIO_IF_TYPE_PCI)
 223       {
 224         virtio_pci_send_sw_interface_details (am, reg, vif, mp->context);
 225       }
 226   }
 227 }
 228
 229 #include <vnet/devices/virtio/virtio.api.c>
 230
 231 static clib_error_t *
 232 virtio_pci_api_hookup (vlib_main_t * vm)
 233 {
 234   /*
 235    * Set up the (msg_name, crc, message-id) table
 236    */
 237   REPLY_MSG_ID_BASE = setup_message_id_table ();
 238
 239   return 0;
 240 }
 241
 242 VLIB_API_INIT_FUNCTION (virtio_pci_api_hookup);
 243
 244 /*
 245  * fd.io coding-style-patch-verification: ON
 246  *
 247  * Local Variables:
 248  * eval: (c-set-style "gnu")
 249  * End:
 250  */