src/vnet/devices/af_packet/device.c

   1 /*
   2  *------------------------------------------------------------------
   3  * af_packet.c - linux kernel packet interface
   4  *
   5  * Copyright (c) 2016 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 <linux/if_packet.h>
  21 #include <sys/socket.h>
  22 #include <sys/ioctl.h>
  23 #include <net/if.h>
  24 #include <net/if_arp.h>
  25
  26 #include <vlib/vlib.h>
  27 #include <vlib/unix/unix.h>
  28 #include <vnet/ip/ip.h>
  29 #include <vnet/ethernet/ethernet.h>
  30
  31 #include <vnet/devices/af_packet/af_packet.h>
  32
  33 #define foreach_af_packet_tx_func_error               \
  34 _(FRAME_NOT_READY, "tx frame not ready")              \
  35 _(TXRING_EAGAIN,   "tx sendto temporary failure")     \
  36 _(TXRING_FATAL,    "tx sendto fatal failure")         \
  37 _(TXRING_OVERRUN,  "tx ring overrun")
  38
  39 typedef enum
  40 {
  41 #define _(f,s) AF_PACKET_TX_ERROR_##f,
  42   foreach_af_packet_tx_func_error
  43 #undef _
  44     AF_PACKET_TX_N_ERROR,
  45 } af_packet_tx_func_error_t;
  46
  47 static char *af_packet_tx_func_error_strings[] = {
  48 #define _(n,s) s,
  49   foreach_af_packet_tx_func_error
  50 #undef _
  51 };
  52
  53
  54 u8 *
  55 format_af_packet_device_name (u8 * s, va_list * args)
  56 {
  57   u32 i = va_arg (*args, u32);
  58   af_packet_main_t *apm = &af_packet_main;
  59   af_packet_if_t *apif = pool_elt_at_index (apm->interfaces, i);
  60
  61   s = format (s, "host-%s", apif->host_if_name);
  62   return s;
  63 }
  64
  65 static u8 *
  66 format_af_packet_device (u8 * s, va_list * args)
  67 {
  68   s = format (s, "Linux PACKET socket interface");
  69   return s;
  70 }
  71
  72 static u8 *
  73 format_af_packet_tx_trace (u8 * s, va_list * args)
  74 {
  75   s = format (s, "Unimplemented...");
  76   return s;
  77 }
  78
  79 static uword
  80 af_packet_interface_tx (vlib_main_t * vm,
  81                         vlib_node_runtime_t * node, vlib_frame_t * frame)
  82 {
  83   af_packet_main_t *apm = &af_packet_main;
  84   u32 *buffers = vlib_frame_vector_args (frame);
  85   u32 n_left = frame->n_vectors;
  86   u32 n_sent = 0;
  87   vnet_interface_output_runtime_t *rd = (void *) node->runtime_data;
  88   af_packet_if_t *apif =
  89     pool_elt_at_index (apm->interfaces, rd->dev_instance);
  90   clib_spinlock_lock_if_init (&apif->lockp);
  91   int block = 0;
  92   u32 block_size = apif->tx_req->tp_block_size;
  93   u32 frame_size = apif->tx_req->tp_frame_size;
  94   u32 frame_num = apif->tx_req->tp_frame_nr;
  95   u8 *block_start = apif->tx_ring + block * block_size;
  96   u32 tx_frame = apif->next_tx_frame;
  97   struct tpacket2_hdr *tph;
  98   u32 frame_not_ready = 0;
  99
 100   while (n_left > 0)
 101     {
 102       u32 len;
 103       u32 offset = 0;
 104       vlib_buffer_t *b0;
 105       n_left--;
 106       u32 bi = buffers[0];
 107       buffers++;
 108
 109       tph = (struct tpacket2_hdr *) (block_start + tx_frame * frame_size);
 110
 111       if (PREDICT_FALSE
 112           (tph->tp_status & (TP_STATUS_SEND_REQUEST | TP_STATUS_SENDING)))
 113         {
 114           frame_not_ready++;
 115           goto next;
 116         }
 117
 118       do
 119         {
 120           b0 = vlib_get_buffer (vm, bi);
 121           len = b0->current_length;
 122           clib_memcpy_fast ((u8 *) tph +
 123                             TPACKET_ALIGN (sizeof (struct tpacket2_hdr)) +
 124                             offset, vlib_buffer_get_current (b0), len);
 125           offset += len;
 126         }
 127       while ((bi =
 128               (b0->flags & VLIB_BUFFER_NEXT_PRESENT) ? b0->next_buffer : 0));
 129
 130       tph->tp_len = tph->tp_snaplen = offset;
 131       tph->tp_status = TP_STATUS_SEND_REQUEST;
 132       n_sent++;
 133     next:
 134       tx_frame = (tx_frame + 1) % frame_num;
 135
 136       /* check if we've exhausted the ring */
 137       if (PREDICT_FALSE (frame_not_ready + n_sent == frame_num))
 138         break;
 139     }
 140
 141   CLIB_MEMORY_BARRIER ();
 142
 143   if (PREDICT_TRUE (n_sent))
 144     {
 145       apif->next_tx_frame = tx_frame;
 146
 147       if (PREDICT_FALSE (sendto (apif->fd, NULL, 0,
 148                                  MSG_DONTWAIT, NULL, 0) == -1))
 149         {
 150           /* Uh-oh, drop & move on, but count whether it was fatal or not.
 151            * Note that we have no reliable way to properly determine the
 152            * disposition of the packets we just enqueued for delivery.
 153            */
 154           vlib_error_count (vm, node->node_index,
 155                             unix_error_is_fatal (errno) ?
 156                             AF_PACKET_TX_ERROR_TXRING_FATAL :
 157                             AF_PACKET_TX_ERROR_TXRING_EAGAIN, n_sent);
 158         }
 159     }
 160
 161   clib_spinlock_unlock_if_init (&apif->lockp);
 162
 163   if (PREDICT_FALSE (frame_not_ready))
 164     vlib_error_count (vm, node->node_index,
 165                       AF_PACKET_TX_ERROR_FRAME_NOT_READY, frame_not_ready);
 166
 167   if (PREDICT_FALSE (frame_not_ready + n_sent == frame_num))
 168     vlib_error_count (vm, node->node_index, AF_PACKET_TX_ERROR_TXRING_OVERRUN,
 169                       n_left);
 170
 171   vlib_buffer_free (vm, vlib_frame_vector_args (frame), frame->n_vectors);
 172   return frame->n_vectors;
 173 }
 174
 175 static void
 176 af_packet_set_interface_next_node (vnet_main_t * vnm, u32 hw_if_index,
 177                                    u32 node_index)
 178 {
 179   af_packet_main_t *apm = &af_packet_main;
 180   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
 181   af_packet_if_t *apif =
 182     pool_elt_at_index (apm->interfaces, hw->dev_instance);
 183
 184   /* Shut off redirection */
 185   if (node_index == ~0)
 186     {
 187       apif->per_interface_next_index = node_index;
 188       return;
 189     }
 190
 191   apif->per_interface_next_index =
 192     vlib_node_add_next (vlib_get_main (), af_packet_input_node.index,
 193                         node_index);
 194 }
 195
 196 static void
 197 af_packet_clear_hw_interface_counters (u32 instance)
 198 {
 199   /* Nothing for now */
 200 }
 201
 202 static clib_error_t *
 203 af_packet_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
 204                                    u32 flags)
 205 {
 206   af_packet_main_t *apm = &af_packet_main;
 207   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
 208   af_packet_if_t *apif =
 209     pool_elt_at_index (apm->interfaces, hw->dev_instance);
 210   u32 hw_flags;
 211   int rv, fd = socket (AF_UNIX, SOCK_DGRAM, 0);
 212   struct ifreq ifr;
 213
 214   if (0 > fd)
 215     {
 216       vlib_log_warn (apm->log_class, "af_packet_%s could not open socket",
 217                      apif->host_if_name);
 218       return 0;
 219     }
 220
 221   /* if interface is a bridge ignore */
 222   if (apif->host_if_index < 0)
 223     goto error;                 /* no error */
 224
 225   /* use host_if_index in case host name has changed */
 226   ifr.ifr_ifindex = apif->host_if_index;
 227   if ((rv = ioctl (fd, SIOCGIFNAME, &ifr)) < 0)
 228     {
 229       vlib_log_warn (apm->log_class,
 230                      "af_packet_%s ioctl could not retrieve eth name",
 231                      apif->host_if_name);
 232       goto error;
 233     }
 234
 235   apif->is_admin_up = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
 236
 237   if ((rv = ioctl (fd, SIOCGIFFLAGS, &ifr)) < 0)
 238     {
 239       vlib_log_warn (apm->log_class, "af_packet_%s error: %d",
 240                      apif->is_admin_up ? "up" : "down", rv);
 241       goto error;
 242     }
 243
 244   if (apif->is_admin_up)
 245     {
 246       hw_flags = VNET_HW_INTERFACE_FLAG_LINK_UP;
 247       ifr.ifr_flags |= IFF_UP;
 248     }
 249   else
 250     {
 251       hw_flags = 0;
 252       ifr.ifr_flags &= ~IFF_UP;
 253     }
 254
 255   if ((rv = ioctl (fd, SIOCSIFFLAGS, &ifr)) < 0)
 256     {
 257       vlib_log_warn (apm->log_class, "af_packet_%s error: %d",
 258                      apif->is_admin_up ? "up" : "down", rv);
 259       goto error;
 260     }
 261
 262   vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
 263
 264 error:
 265   if (0 <= fd)
 266     close (fd);
 267
 268   return 0;                     /* no error */
 269 }
 270
 271 static clib_error_t *
 272 af_packet_subif_add_del_function (vnet_main_t * vnm,
 273                                   u32 hw_if_index,
 274                                   struct vnet_sw_interface_t *st, int is_add)
 275 {
 276   /* Nothing for now */
 277   return 0;
 278 }
 279
 280 static clib_error_t *af_packet_set_mac_address_function
 281   (struct vnet_hw_interface_t *hi, const u8 * old_address, const u8 * address)
 282 {
 283   af_packet_main_t *apm = &af_packet_main;
 284   af_packet_if_t *apif =
 285     pool_elt_at_index (apm->interfaces, hi->dev_instance);
 286   int rv, fd = socket (AF_UNIX, SOCK_DGRAM, 0);
 287   struct ifreq ifr;
 288
 289   if (0 > fd)
 290     {
 291       vlib_log_warn (apm->log_class, "af_packet_%s could not open socket",
 292                      apif->host_if_name);
 293       return 0;
 294     }
 295
 296   /* if interface is a bridge ignore */
 297   if (apif->host_if_index < 0)
 298     goto error;                 /* no error */
 299
 300   /* use host_if_index in case host name has changed */
 301   ifr.ifr_ifindex = apif->host_if_index;
 302   if ((rv = ioctl (fd, SIOCGIFNAME, &ifr)) < 0)
 303     {
 304       vlib_log_warn
 305         (apm->log_class,
 306          "af_packet_%s ioctl could not retrieve eth name, error: %d",
 307          apif->host_if_name, rv);
 308       goto error;
 309     }
 310
 311   clib_memcpy (ifr.ifr_hwaddr.sa_data, address, 6);
 312   ifr.ifr_hwaddr.sa_family = ARPHRD_ETHER;
 313
 314   if ((rv = ioctl (fd, SIOCSIFHWADDR, &ifr)) < 0)
 315     {
 316       vlib_log_warn (apm->log_class,
 317                      "af_packet_%s ioctl could not set mac, error: %d",
 318                      apif->host_if_name, rv);
 319       goto error;
 320     }
 321
 322 error:
 323
 324   if (0 <= fd)
 325     close (fd);
 326
 327   return 0;                     /* no error */
 328 }
 329
 330 /* *INDENT-OFF* */
 331 VNET_DEVICE_CLASS (af_packet_device_class) = {
 332   .name = "af-packet",
 333   .tx_function = af_packet_interface_tx,
 334   .format_device_name = format_af_packet_device_name,
 335   .format_device = format_af_packet_device,
 336   .format_tx_trace = format_af_packet_tx_trace,
 337   .tx_function_n_errors = AF_PACKET_TX_N_ERROR,
 338   .tx_function_error_strings = af_packet_tx_func_error_strings,
 339   .rx_redirect_to_node = af_packet_set_interface_next_node,
 340   .clear_counters = af_packet_clear_hw_interface_counters,
 341   .admin_up_down_function = af_packet_interface_admin_up_down,
 342   .subif_add_del_function = af_packet_subif_add_del_function,
 343   .mac_addr_change_function = af_packet_set_mac_address_function,
 344 };
 345
 346 VLIB_DEVICE_TX_FUNCTION_MULTIARCH (af_packet_device_class,
 347                                    af_packet_interface_tx)
 348 /* *INDENT-ON* */
 349
 350 /*
 351  * fd.io coding-style-patch-verification: ON
 352  *
 353  * Local Variables:
 354  * eval: (c-set-style "gnu")
 355  * End:
 356  */