src/plugins/af_xdp/input.c

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2018 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *------------------------------------------------------------------
  16  */
  17
  18 #include <poll.h>
  19 #include <vlib/vlib.h>
  20 #include <vlib/unix/unix.h>
  21 #include <vlib/pci/pci.h>
  22 #include <vnet/ethernet/ethernet.h>
  23 #include <vnet/devices/devices.h>
  24 #include <vnet/interface/rx_queue_funcs.h>
  25 #include "af_xdp.h"
  26
  27 #define foreach_af_xdp_input_error \
  28   _(POLL_REQUIRED, "poll required") \
  29   _(POLL_FAILURES, "poll failures")
  30
  31 typedef enum
  32 {
  33 #define _(f,s) AF_XDP_INPUT_ERROR_##f,
  34   foreach_af_xdp_input_error
  35 #undef _
  36     AF_XDP_INPUT_N_ERROR,
  37 } af_xdp_input_error_t;
  38
  39 static __clib_unused char *af_xdp_input_error_strings[] = {
  40 #define _(n,s) s,
  41   foreach_af_xdp_input_error
  42 #undef _
  43 };
  44
  45 static_always_inline void
  46 af_xdp_device_input_trace (vlib_main_t * vm, vlib_node_runtime_t * node,
  47                            u32 n_left, const u32 * bi, u32 next_index,
  48                            u32 hw_if_index)
  49 {
  50   u32 n_trace = vlib_get_trace_count (vm, node);
  51
  52   if (PREDICT_TRUE (0 == n_trace))
  53     return;
  54
  55   while (n_trace && n_left)
  56     {
  57       vlib_buffer_t *b = vlib_get_buffer (vm, bi[0]);
  58       if (PREDICT_TRUE
  59           (vlib_trace_buffer (vm, node, next_index, b, /* follow_chain */ 0)))
  60         {
  61           af_xdp_input_trace_t *tr =
  62             vlib_add_trace (vm, node, b, sizeof (*tr));
  63           tr->next_index = next_index;
  64           tr->hw_if_index = hw_if_index;
  65           n_trace--;
  66         }
  67       n_left--;
  68       bi++;
  69     }
  70
  71   vlib_set_trace_count (vm, node, n_trace);
  72 }
  73
  74 static_always_inline void
  75 af_xdp_device_input_refill_db (vlib_main_t * vm,
  76                                const vlib_node_runtime_t * node,
  77                                af_xdp_device_t * ad, af_xdp_rxq_t * rxq,
  78                                const u32 n_alloc)
  79 {
  80   int ret;
  81
  82   xsk_ring_prod__submit (&rxq->fq, n_alloc);
  83
  84   if (!xsk_ring_prod__needs_wakeup (&rxq->fq))
  85     return;
  86
  87   vlib_error_count (vm, node->node_index, AF_XDP_INPUT_ERROR_POLL_REQUIRED,
  88                     1);
  89
  90   struct pollfd fd = {.fd = rxq->xsk_fd,.events = POLLIN };
  91   ret = poll (&fd, 1, 0);
  92   if (PREDICT_TRUE (ret >= 0))
  93     return;
  94
  95   /* something bad is happening */
  96   vlib_error_count (vm, node->node_index, AF_XDP_INPUT_ERROR_POLL_FAILURES,
  97                     1);
  98   af_xdp_device_error (ad, "poll() failed");
  99 }
 100
 101 static_always_inline void
 102 af_xdp_device_input_refill (vlib_main_t * vm,
 103                             const vlib_node_runtime_t * node,
 104                             af_xdp_device_t * ad, af_xdp_rxq_t * rxq,
 105                             const int copy)
 106 {
 107   __u64 *fill;
 108   const u32 size = rxq->fq.size;
 109   const u32 mask = size - 1;
 110   u32 bis[VLIB_FRAME_SIZE], *bi = bis;
 111   u32 n_alloc, n, n_wrap;
 112   u32 idx = 0;
 113
 114   ASSERT (mask == rxq->fq.mask);
 115
 116   /* do not enqueue more packet than ring space */
 117   n_alloc = xsk_prod_nb_free (&rxq->fq, 16);
 118   /* do not bother to allocate if too small */
 119   if (n_alloc < 16)
 120     return;
 121
 122   n_alloc = clib_min (n_alloc, ARRAY_LEN (bis));
 123   n_alloc = vlib_buffer_alloc_from_pool (vm, bis, n_alloc, ad->pool);
 124   n = xsk_ring_prod__reserve (&rxq->fq, n_alloc, &idx);
 125   ASSERT (n == n_alloc);
 126
 127   fill = xsk_ring_prod__fill_addr (&rxq->fq, idx);
 128   n = clib_min (n_alloc, size - (idx & mask));
 129   n_wrap = n_alloc - n;
 130
 131   /*
 132    * Note about headroom: for some reasons, there seem to be a discrepency
 133    * between 0-copy and copy mode:
 134    *   - 0-copy: XDP_PACKET_HEADROOM will be added to the user headroom
 135    *   - copy: nothing is added to the user headroom
 136    * We privileged 0-copy and set headroom to 0. As XDP_PACKET_HEADROOM ==
 137    * sizeof(vlib_buffer_t), data will correctly point to vlib_buffer_t->data.
 138    * In copy mode, we have to add sizeof(vlib_buffer_t) to desc offset during
 139    * refill.
 140    */
 141   STATIC_ASSERT (sizeof (vlib_buffer_t) == XDP_PACKET_HEADROOM, "wrong size");
 142 #define bi2addr(bi) \
 143   (((bi) << CLIB_LOG2_CACHE_LINE_BYTES) + (copy ? sizeof(vlib_buffer_t) : 0))
 144
 145 wrap_around:
 146
 147   while (n >= 8)
 148     {
 149 #ifdef CLIB_HAVE_VEC256
 150       u64x4 b0 = u64x4_from_u32x4 (*(u32x4u *) (bi + 0));
 151       u64x4 b1 = u64x4_from_u32x4 (*(u32x4u *) (bi + 4));
 152       *(u64x4u *) (fill + 0) = bi2addr (b0);
 153       *(u64x4u *) (fill + 4) = bi2addr (b1);
 154 #else
 155       fill[0] = bi2addr (bi[0]);
 156       fill[1] = bi2addr (bi[1]);
 157       fill[2] = bi2addr (bi[2]);
 158       fill[3] = bi2addr (bi[3]);
 159       fill[4] = bi2addr (bi[4]);
 160       fill[5] = bi2addr (bi[5]);
 161       fill[6] = bi2addr (bi[6]);
 162       fill[7] = bi2addr (bi[7]);
 163 #endif
 164       fill += 8;
 165       bi += 8;
 166       n -= 8;
 167     }
 168
 169   while (n >= 1)
 170     {
 171       fill[0] = bi2addr (bi[0]);
 172       fill += 1;
 173       bi += 1;
 174       n -= 1;
 175     }
 176
 177   if (n_wrap)
 178     {
 179       fill = xsk_ring_prod__fill_addr (&rxq->fq, 0);
 180       n = n_wrap;
 181       n_wrap = 0;
 182       goto wrap_around;
 183     }
 184
 185   af_xdp_device_input_refill_db (vm, node, ad, rxq, n_alloc);
 186 }
 187
 188 static_always_inline void
 189 af_xdp_device_input_ethernet (vlib_main_t * vm, vlib_node_runtime_t * node,
 190                               const u32 next_index, const u32 sw_if_index,
 191                               const u32 hw_if_index)
 192 {
 193   vlib_next_frame_t *nf;
 194   vlib_frame_t *f;
 195   ethernet_input_frame_t *ef;
 196
 197   if (PREDICT_FALSE (VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT != next_index))
 198     return;
 199
 200   nf =
 201     vlib_node_runtime_get_next_frame (vm, node,
 202                                       VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT);
 203   f = vlib_get_frame (vm, nf->frame);
 204   f->flags = ETH_INPUT_FRAME_F_SINGLE_SW_IF_IDX;
 205
 206   ef = vlib_frame_scalar_args (f);
 207   ef->sw_if_index = sw_if_index;
 208   ef->hw_if_index = hw_if_index;
 209 }
 210
 211 static_always_inline u32
 212 af_xdp_device_input_bufs (vlib_main_t * vm, const af_xdp_device_t * ad,
 213                           af_xdp_rxq_t * rxq, u32 * bis, const u32 n_rx,
 214                           vlib_buffer_t * bt, u32 idx, const int copy)
 215 {
 216   vlib_buffer_t *bufs[VLIB_FRAME_SIZE], **b = bufs;
 217   u16 lens[VLIB_FRAME_SIZE], *len = lens;
 218   const u32 mask = rxq->rx.mask;
 219   u32 n = n_rx, *bi = bis, bytes = 0;
 220
 221 #define addr2bi(addr) \
 222   (((addr) - (copy ? sizeof(vlib_buffer_t) : 0)) >> CLIB_LOG2_CACHE_LINE_BYTES)
 223
 224   while (n >= 1)
 225     {
 226       const struct xdp_desc *desc = xsk_ring_cons__rx_desc (&rxq->rx, idx);
 227       bi[0] = addr2bi (xsk_umem__extract_addr (desc->addr));
 228       ASSERT (vlib_buffer_is_known (vm, bi[0]) ==
 229               VLIB_BUFFER_KNOWN_ALLOCATED);
 230       len[0] = desc->len;
 231       idx = (idx + 1) & mask;
 232       bi += 1;
 233       len += 1;
 234       n -= 1;
 235     }
 236
 237   vlib_get_buffers (vm, bis, bufs, n_rx);
 238
 239   n = n_rx;
 240   len = lens;
 241
 242   while (n >= 8)
 243     {
 244       vlib_prefetch_buffer_header (b[4], LOAD);
 245       vlib_buffer_copy_template (b[0], bt);
 246       bytes += b[0]->current_length = len[0];
 247
 248       vlib_prefetch_buffer_header (b[5], LOAD);
 249       vlib_buffer_copy_template (b[1], bt);
 250       bytes += b[1]->current_length = len[1];
 251
 252       vlib_prefetch_buffer_header (b[6], LOAD);
 253       vlib_buffer_copy_template (b[2], bt);
 254       bytes += b[2]->current_length = len[2];
 255
 256       vlib_prefetch_buffer_header (b[7], LOAD);
 257       vlib_buffer_copy_template (b[3], bt);
 258       bytes += b[3]->current_length = len[3];
 259
 260       b += 4;
 261       len += 4;
 262       n -= 4;
 263     }
 264
 265   while (n >= 1)
 266     {
 267       vlib_buffer_copy_template (b[0], bt);
 268       bytes += b[0]->current_length = len[0];
 269       b += 1;
 270       len += 1;
 271       n -= 1;
 272     }
 273
 274   xsk_ring_cons__release (&rxq->rx, n_rx);
 275   return bytes;
 276 }
 277
 278 static_always_inline uword
 279 af_xdp_device_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
 280                             vlib_frame_t * frame, af_xdp_device_t * ad,
 281                             u16 qid, const int copy)
 282 {
 283   vnet_main_t *vnm = vnet_get_main ();
 284   af_xdp_rxq_t *rxq = vec_elt_at_index (ad->rxqs, qid);
 285   vlib_buffer_t bt;
 286   u32 next_index, *to_next, n_left_to_next;
 287   u32 n_rx_packets, n_rx_bytes;
 288   u32 idx;
 289
 290   n_rx_packets = xsk_ring_cons__peek (&rxq->rx, VLIB_FRAME_SIZE, &idx);
 291
 292   if (PREDICT_FALSE (0 == n_rx_packets))
 293     goto refill;
 294
 295   vlib_buffer_copy_template (&bt, ad->buffer_template);
 296   next_index = ad->per_interface_next_index;
 297   if (PREDICT_FALSE (vnet_device_input_have_features (ad->sw_if_index)))
 298     vnet_feature_start_device_input_x1 (ad->sw_if_index, &next_index, &bt);
 299
 300   vlib_get_new_next_frame (vm, node, next_index, to_next, n_left_to_next);
 301
 302   n_rx_bytes =
 303     af_xdp_device_input_bufs (vm, ad, rxq, to_next, n_rx_packets, &bt, idx,
 304                               copy);
 305   af_xdp_device_input_ethernet (vm, node, next_index, ad->sw_if_index,
 306                                 ad->hw_if_index);
 307
 308   vlib_put_next_frame (vm, node, next_index, n_left_to_next - n_rx_packets);
 309
 310   af_xdp_device_input_trace (vm, node, n_rx_packets, to_next, next_index,
 311                              ad->hw_if_index);
 312
 313   vlib_increment_combined_counter
 314     (vnm->interface_main.combined_sw_if_counters +
 315      VNET_INTERFACE_COUNTER_RX, vm->thread_index,
 316      ad->hw_if_index, n_rx_packets, n_rx_bytes);
 317
 318 refill:
 319   af_xdp_device_input_refill (vm, node, ad, rxq, copy);
 320
 321   return n_rx_packets;
 322 }
 323
 324 VLIB_NODE_FN (af_xdp_input_node) (vlib_main_t * vm,
 325                                   vlib_node_runtime_t * node,
 326                                   vlib_frame_t * frame)
 327 {
 328   u32 n_rx = 0;
 329   af_xdp_main_t *am = &af_xdp_main;
 330   vnet_hw_if_rxq_poll_vector_t *p,
 331     *pv = vnet_hw_if_get_rxq_poll_vector (vm, node);
 332
 333   vec_foreach (p, pv)
 334     {
 335       af_xdp_device_t *ad = vec_elt_at_index (am->devices, p->dev_instance);
 336       if ((ad->flags & AF_XDP_DEVICE_F_ADMIN_UP) == 0)
 337         continue;
 338       if (PREDICT_TRUE (ad->flags & AF_XDP_DEVICE_F_ZEROCOPY))
 339         n_rx += af_xdp_device_input_inline (vm, node, frame, ad, p->queue_id,
 340                                             /* copy */ 0);
 341       else
 342         n_rx += af_xdp_device_input_inline (vm, node, frame, ad, p->queue_id,
 343                                             /* copy */ 1);
 344     }
 345
 346   return n_rx;
 347 }
 348
 349 /* *INDENT-OFF* */
 350 VLIB_REGISTER_NODE (af_xdp_input_node) = {
 351   .name = "af_xdp-input",
 352   .sibling_of = "device-input",
 353   .format_trace = format_af_xdp_input_trace,
 354   .type = VLIB_NODE_TYPE_INPUT,
 355   .state = VLIB_NODE_STATE_DISABLED,
 356   .n_errors = AF_XDP_INPUT_N_ERROR,
 357   .error_strings = af_xdp_input_error_strings,
 358   .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
 359 };
 360 /* *INDENT-ON* */
 361
 362 /*
 363  * fd.io coding-style-patch-verification: ON
 364  *
 365  * Local Variables:
 366  * eval: (c-set-style "gnu")
 367  * End:
 368  */