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 #ifndef CLIB_MARCH_VARIANT
  55 u8 *
  56 format_af_packet_device_name (u8 * s, va_list * args)
  57 {
  58   u32 i = va_arg (*args, u32);
  59   af_packet_main_t *apm = &af_packet_main;
  60   af_packet_if_t *apif = pool_elt_at_index (apm->interfaces, i);
  61
  62   s = format (s, "host-%s", apif->host_if_name);
  63   return s;
  64 }
  65 #endif /* CLIB_MARCH_VARIANT */
  66
  67 static u8 *
  68 format_af_packet_device (u8 * s, va_list * args)
  69 {
  70   u32 dev_instance = va_arg (*args, u32);
  71   u32 indent = format_get_indent (s);
  72   int __clib_unused verbose = va_arg (*args, int);
  73
  74   af_packet_main_t *apm = &af_packet_main;
  75   af_packet_if_t *apif = pool_elt_at_index (apm->interfaces, dev_instance);
  76   clib_spinlock_lock_if_init (&apif->lockp);
  77   u32 tx_block_sz = apif->tx_req->tp_block_size;
  78   u32 tx_frame_sz = apif->tx_req->tp_frame_size;
  79   u32 tx_frame_nr = apif->tx_req->tp_frame_nr;
  80   u32 tx_block_nr = apif->tx_req->tp_block_nr;
  81   u32 rx_block_size = apif->rx_req->tp_block_size;
  82   u32 rx_frame_size = apif->rx_req->tp_frame_size;
  83   u32 rx_frame_nr = apif->rx_req->tp_frame_nr;
  84   u32 rx_block_nr = apif->rx_req->tp_block_nr;
  85   int block = 0;
  86   u8 *tx_block_start = apif->tx_ring + block * tx_block_sz;
  87   u32 tx_frame = apif->next_tx_frame;
  88   struct tpacket2_hdr *tph;
  89
  90   s = format (s, "Linux PACKET socket interface\n");
  91   s = format (s, "%UTX block size:%d nr:%d  TX frame size:%d nr:%d\n",
  92               format_white_space, indent, tx_block_sz, tx_block_nr,
  93               tx_frame_sz, tx_frame_nr);
  94   s = format (s, "%URX block size:%d nr:%d  RX frame size:%d nr:%d\n",
  95               format_white_space, indent, rx_block_size, rx_block_nr,
  96               rx_frame_size, rx_frame_nr);
  97   s = format (s, "%Unext frame:%d\n", format_white_space, indent,
  98               apif->next_tx_frame);
  99
 100   int n_send_req = 0, n_avail = 0, n_sending = 0, n_tot = 0, n_wrong = 0;
 101   do
 102     {
 103       tph = (struct tpacket2_hdr *) (tx_block_start + tx_frame * tx_frame_sz);
 104       tx_frame = (tx_frame + 1) % tx_frame_nr;
 105       if (tph->tp_status == 0)
 106         n_avail++;
 107       else if (tph->tp_status & TP_STATUS_SEND_REQUEST)
 108         n_send_req++;
 109       else if (tph->tp_status & TP_STATUS_SENDING)
 110         n_sending++;
 111       else
 112         n_wrong++;
 113       n_tot++;
 114     }
 115   while (tx_frame != apif->next_tx_frame);
 116   s = format (s, "%Uavailable:%d request:%d sending:%d wrong:%d total:%d\n",
 117               format_white_space, indent, n_avail, n_send_req, n_sending,
 118               n_wrong, n_tot);
 119
 120   clib_spinlock_unlock_if_init (&apif->lockp);
 121   return s;
 122 }
 123
 124 static u8 *
 125 format_af_packet_tx_trace (u8 * s, va_list * args)
 126 {
 127   s = format (s, "Unimplemented...");
 128   return s;
 129 }
 130
 131 VNET_DEVICE_CLASS_TX_FN (af_packet_device_class) (vlib_main_t * vm,
 132                                                   vlib_node_runtime_t * node,
 133                                                   vlib_frame_t * frame)
 134 {
 135   af_packet_main_t *apm = &af_packet_main;
 136   u32 *buffers = vlib_frame_vector_args (frame);
 137   u32 n_left = frame->n_vectors;
 138   u32 n_sent = 0;
 139   vnet_interface_output_runtime_t *rd = (void *) node->runtime_data;
 140   af_packet_if_t *apif =
 141     pool_elt_at_index (apm->interfaces, rd->dev_instance);
 142   clib_spinlock_lock_if_init (&apif->lockp);
 143   int block = 0;
 144   u32 block_size = apif->tx_req->tp_block_size;
 145   u32 frame_size = apif->tx_req->tp_frame_size;
 146   u32 frame_num = apif->tx_req->tp_frame_nr;
 147   u8 *block_start = apif->tx_ring + block * block_size;
 148   u32 tx_frame = apif->next_tx_frame;
 149   struct tpacket2_hdr *tph;
 150   u32 frame_not_ready = 0;
 151
 152   while (n_left)
 153     {
 154       u32 len;
 155       u32 offset = 0;
 156       vlib_buffer_t *b0;
 157       n_left--;
 158       u32 bi = buffers[0];
 159       buffers++;
 160
 161       tph = (struct tpacket2_hdr *) (block_start + tx_frame * frame_size);
 162       if (PREDICT_FALSE (tph->tp_status &
 163                          (TP_STATUS_SEND_REQUEST | TP_STATUS_SENDING)))
 164         {
 165           frame_not_ready++;
 166           goto next;
 167         }
 168
 169       do
 170         {
 171           b0 = vlib_get_buffer (vm, bi);
 172           len = b0->current_length;
 173           clib_memcpy_fast ((u8 *) tph +
 174                             TPACKET_ALIGN (sizeof (struct tpacket2_hdr)) +
 175                             offset, vlib_buffer_get_current (b0), len);
 176           offset += len;
 177         }
 178       while ((bi =
 179               (b0->flags & VLIB_BUFFER_NEXT_PRESENT) ? b0->next_buffer : 0));
 180
 181       tph->tp_len = tph->tp_snaplen = offset;
 182       tph->tp_status = TP_STATUS_SEND_REQUEST;
 183       n_sent++;
 184
 185       tx_frame = (tx_frame + 1) % frame_num;
 186
 187     next:
 188       /* check if we've exhausted the ring */
 189       if (PREDICT_FALSE (frame_not_ready + n_sent == frame_num))
 190         break;
 191     }
 192
 193   CLIB_MEMORY_BARRIER ();
 194
 195   if (PREDICT_TRUE (n_sent))
 196     {
 197       apif->next_tx_frame = tx_frame;
 198
 199       if (PREDICT_FALSE (sendto (apif->fd, NULL, 0, MSG_DONTWAIT, NULL, 0) ==
 200                          -1))
 201         {
 202           /* Uh-oh, drop & move on, but count whether it was fatal or not.
 203            * Note that we have no reliable way to properly determine the
 204            * disposition of the packets we just enqueued for delivery.
 205            */
 206           vlib_error_count (vm, node->node_index,
 207                             unix_error_is_fatal (errno) ?
 208                               AF_PACKET_TX_ERROR_TXRING_FATAL :
 209                               AF_PACKET_TX_ERROR_TXRING_EAGAIN,
 210                             n_sent);
 211         }
 212     }
 213
 214   clib_spinlock_unlock_if_init (&apif->lockp);
 215
 216   if (PREDICT_FALSE (frame_not_ready))
 217     vlib_error_count (vm, node->node_index,
 218                       AF_PACKET_TX_ERROR_FRAME_NOT_READY, frame_not_ready);
 219
 220   if (PREDICT_FALSE (frame_not_ready + n_sent == frame_num))
 221     vlib_error_count (vm, node->node_index, AF_PACKET_TX_ERROR_TXRING_OVERRUN,
 222                       n_left);
 223
 224   vlib_buffer_free (vm, vlib_frame_vector_args (frame), frame->n_vectors);
 225   return frame->n_vectors;
 226 }
 227
 228 static void
 229 af_packet_set_interface_next_node (vnet_main_t * vnm, u32 hw_if_index,
 230                                    u32 node_index)
 231 {
 232   af_packet_main_t *apm = &af_packet_main;
 233   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
 234   af_packet_if_t *apif =
 235     pool_elt_at_index (apm->interfaces, hw->dev_instance);
 236
 237   /* Shut off redirection */
 238   if (node_index == ~0)
 239     {
 240       apif->per_interface_next_index = node_index;
 241       return;
 242     }
 243
 244   apif->per_interface_next_index =
 245     vlib_node_add_next (vlib_get_main (), af_packet_input_node.index,
 246                         node_index);
 247 }
 248
 249 static void
 250 af_packet_clear_hw_interface_counters (u32 instance)
 251 {
 252   /* Nothing for now */
 253 }
 254
 255 static clib_error_t *
 256 af_packet_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
 257                                    u32 flags)
 258 {
 259   af_packet_main_t *apm = &af_packet_main;
 260   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
 261   af_packet_if_t *apif =
 262     pool_elt_at_index (apm->interfaces, hw->dev_instance);
 263   u32 hw_flags;
 264   int rv, fd = socket (AF_UNIX, SOCK_DGRAM, 0);
 265   struct ifreq ifr;
 266
 267   if (0 > fd)
 268     {
 269       vlib_log_warn (apm->log_class, "af_packet_%s could not open socket",
 270                      apif->host_if_name);
 271       return 0;
 272     }
 273
 274   /* if interface is a bridge ignore */
 275   if (apif->host_if_index < 0)
 276     goto error;                 /* no error */
 277
 278   /* use host_if_index in case host name has changed */
 279   ifr.ifr_ifindex = apif->host_if_index;
 280   if ((rv = ioctl (fd, SIOCGIFNAME, &ifr)) < 0)
 281     {
 282       vlib_log_warn (apm->log_class,
 283                      "af_packet_%s ioctl could not retrieve eth name",
 284                      apif->host_if_name);
 285       goto error;
 286     }
 287
 288   apif->is_admin_up = (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP) != 0;
 289
 290   if ((rv = ioctl (fd, SIOCGIFFLAGS, &ifr)) < 0)
 291     {
 292       vlib_log_warn (apm->log_class, "af_packet_%s error: %d",
 293                      apif->is_admin_up ? "up" : "down", rv);
 294       goto error;
 295     }
 296
 297   if (apif->is_admin_up)
 298     {
 299       hw_flags = VNET_HW_INTERFACE_FLAG_LINK_UP;
 300       ifr.ifr_flags |= IFF_UP;
 301     }
 302   else
 303     {
 304       hw_flags = 0;
 305       ifr.ifr_flags &= ~IFF_UP;
 306     }
 307
 308   if ((rv = ioctl (fd, SIOCSIFFLAGS, &ifr)) < 0)
 309     {
 310       vlib_log_warn (apm->log_class, "af_packet_%s error: %d",
 311                      apif->is_admin_up ? "up" : "down", rv);
 312       goto error;
 313     }
 314
 315   vnet_hw_interface_set_flags (vnm, hw_if_index, hw_flags);
 316
 317 error:
 318   if (0 <= fd)
 319     close (fd);
 320
 321   return 0;                     /* no error */
 322 }
 323
 324 static clib_error_t *
 325 af_packet_subif_add_del_function (vnet_main_t * vnm,
 326                                   u32 hw_if_index,
 327                                   struct vnet_sw_interface_t *st, int is_add)
 328 {
 329   /* Nothing for now */
 330   return 0;
 331 }
 332
 333 static clib_error_t *af_packet_set_mac_address_function
 334   (struct vnet_hw_interface_t *hi, const u8 * old_address, const u8 * address)
 335 {
 336   af_packet_main_t *apm = &af_packet_main;
 337   af_packet_if_t *apif =
 338     pool_elt_at_index (apm->interfaces, hi->dev_instance);
 339   int rv, fd = socket (AF_UNIX, SOCK_DGRAM, 0);
 340   struct ifreq ifr;
 341
 342   if (0 > fd)
 343     {
 344       vlib_log_warn (apm->log_class, "af_packet_%s could not open socket",
 345                      apif->host_if_name);
 346       return 0;
 347     }
 348
 349   /* if interface is a bridge ignore */
 350   if (apif->host_if_index < 0)
 351     goto error;                 /* no error */
 352
 353   /* use host_if_index in case host name has changed */
 354   ifr.ifr_ifindex = apif->host_if_index;
 355   if ((rv = ioctl (fd, SIOCGIFNAME, &ifr)) < 0)
 356     {
 357       vlib_log_warn
 358         (apm->log_class,
 359          "af_packet_%s ioctl could not retrieve eth name, error: %d",
 360          apif->host_if_name, rv);
 361       goto error;
 362     }
 363
 364   clib_memcpy (ifr.ifr_hwaddr.sa_data, address, 6);
 365   ifr.ifr_hwaddr.sa_family = ARPHRD_ETHER;
 366
 367   if ((rv = ioctl (fd, SIOCSIFHWADDR, &ifr)) < 0)
 368     {
 369       vlib_log_warn (apm->log_class,
 370                      "af_packet_%s ioctl could not set mac, error: %d",
 371                      apif->host_if_name, rv);
 372       goto error;
 373     }
 374
 375 error:
 376
 377   if (0 <= fd)
 378     close (fd);
 379
 380   return 0;                     /* no error */
 381 }
 382
 383 VNET_DEVICE_CLASS (af_packet_device_class) = {
 384   .name = "af-packet",
 385   .format_device_name = format_af_packet_device_name,
 386   .format_device = format_af_packet_device,
 387   .format_tx_trace = format_af_packet_tx_trace,
 388   .tx_function_n_errors = AF_PACKET_TX_N_ERROR,
 389   .tx_function_error_strings = af_packet_tx_func_error_strings,
 390   .rx_redirect_to_node = af_packet_set_interface_next_node,
 391   .clear_counters = af_packet_clear_hw_interface_counters,
 392   .admin_up_down_function = af_packet_interface_admin_up_down,
 393   .subif_add_del_function = af_packet_subif_add_del_function,
 394   .mac_addr_change_function = af_packet_set_mac_address_function,
 395 };
 396
 397 /*
 398  * fd.io coding-style-patch-verification: ON
 399  *
 400  * Local Variables:
 401  * eval: (c-set-style "gnu")
 402  * End:
 403  */