src/plugins/avf/output.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 <vlib/vlib.h>
  19 #include <vlib/unix/unix.h>
  20 #include <vlib/pci/pci.h>
  21 #include <vppinfra/ring.h>
  22
  23 #include <vnet/ethernet/ethernet.h>
  24 #include <vnet/ip/ip4_packet.h>
  25 #include <vnet/ip/ip6_packet.h>
  26 #include <vnet/udp/udp_packet.h>
  27 #include <vnet/tcp/tcp_packet.h>
  28
  29 #include <vnet/devices/devices.h>
  30
  31 #include <avf/avf.h>
  32
  33 static_always_inline u8
  34 avf_tx_desc_get_dtyp (avf_tx_desc_t * d)
  35 {
  36   return d->qword[1] & 0x0f;
  37 }
  38
  39 struct avf_ip4_psh
  40 {
  41   u32 src;
  42   u32 dst;
  43   u8 zero;
  44   u8 proto;
  45   u16 l4len;
  46 };
  47
  48 struct avf_ip6_psh
  49 {
  50   ip6_address_t src;
  51   ip6_address_t dst;
  52   u32 l4len;
  53   u32 proto;
  54 };
  55
  56 static_always_inline u64
  57 avf_tx_prepare_cksum (vlib_buffer_t * b, u8 is_tso)
  58 {
  59   u64 flags = 0;
  60   if (!is_tso && !(b->flags & ((VNET_BUFFER_F_OFFLOAD_IP_CKSUM |
  61                                 VNET_BUFFER_F_OFFLOAD_TCP_CKSUM |
  62                                 VNET_BUFFER_F_OFFLOAD_UDP_CKSUM))))
  63     return 0;
  64   u32 is_tcp = is_tso || b->flags & VNET_BUFFER_F_OFFLOAD_TCP_CKSUM;
  65   u32 is_udp = !is_tso && b->flags & VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
  66   u32 is_ip4 = b->flags & VNET_BUFFER_F_IS_IP4;
  67   u32 is_ip6 = b->flags & VNET_BUFFER_F_IS_IP6;
  68   ASSERT (!is_tcp || !is_udp);
  69   ASSERT (is_ip4 || is_ip6);
  70   i16 l2_hdr_offset = vnet_buffer (b)->l2_hdr_offset;
  71   i16 l3_hdr_offset = vnet_buffer (b)->l3_hdr_offset;
  72   i16 l4_hdr_offset = vnet_buffer (b)->l4_hdr_offset;
  73   u16 l2_len = l3_hdr_offset - l2_hdr_offset;
  74   u16 l3_len = l4_hdr_offset - l3_hdr_offset;
  75   ip4_header_t *ip4 = (void *) (b->data + l3_hdr_offset);
  76   ip6_header_t *ip6 = (void *) (b->data + l3_hdr_offset);
  77   tcp_header_t *tcp = (void *) (b->data + l4_hdr_offset);
  78   udp_header_t *udp = (void *) (b->data + l4_hdr_offset);
  79   u16 l4_len =
  80     is_tcp ? tcp_header_bytes (tcp) : is_udp ? sizeof (udp_header_t) : 0;
  81   u16 sum = 0;
  82
  83   flags |= AVF_TXD_OFFSET_MACLEN (l2_len) |
  84     AVF_TXD_OFFSET_IPLEN (l3_len) | AVF_TXD_OFFSET_L4LEN (l4_len);
  85   flags |= is_ip4 ? AVF_TXD_CMD_IIPT_IPV4 : AVF_TXD_CMD_IIPT_IPV6;
  86   flags |= is_tcp ? AVF_TXD_CMD_L4T_TCP : is_udp ? AVF_TXD_CMD_L4T_UDP : 0;
  87
  88   if (is_ip4)
  89     ip4->checksum = 0;
  90
  91   if (is_tso)
  92     {
  93       if (is_ip4)
  94         ip4->length = 0;
  95       else
  96         ip6->payload_length = 0;
  97     }
  98
  99   if (is_tcp || is_udp)
 100     {
 101       if (is_ip4)
 102         {
 103           struct avf_ip4_psh psh = { 0 };
 104           psh.src = ip4->src_address.as_u32;
 105           psh.dst = ip4->dst_address.as_u32;
 106           psh.proto = ip4->protocol;
 107           psh.l4len =
 108             is_tso ? 0 :
 109             clib_host_to_net_u16 (clib_net_to_host_u16 (ip4->length) -
 110                                   (l4_hdr_offset - l3_hdr_offset));
 111           sum = ~ip_csum (&psh, sizeof (psh));
 112         }
 113       else
 114         {
 115           struct avf_ip6_psh psh = { 0 };
 116           psh.src = ip6->src_address;
 117           psh.dst = ip6->dst_address;
 118           psh.proto = clib_host_to_net_u32 ((u32) ip6->protocol);
 119           psh.l4len = is_tso ? 0 : ip6->payload_length;
 120           sum = ~ip_csum (&psh, sizeof (psh));
 121         }
 122     }
 123   /* ip_csum does a byte swap for some reason... */
 124   sum = clib_net_to_host_u16 (sum);
 125   if (is_tcp)
 126     tcp->checksum = sum;
 127   else if (is_udp)
 128     udp->checksum = sum;
 129   return flags;
 130 }
 131
 132 static_always_inline int
 133 avf_tx_fill_ctx_desc (vlib_main_t * vm, avf_txq_t * txq, avf_tx_desc_t * d,
 134                       vlib_buffer_t * b)
 135 {
 136   vlib_buffer_t *ctx_ph = vlib_get_buffer (vm, txq->ctx_desc_placeholder_bi);
 137   if (PREDICT_FALSE (ctx_ph->ref_count == 255))
 138     {
 139       /* We need a new placeholder buffer */
 140       u32 new_bi;
 141       u8 bpi = vlib_buffer_pool_get_default_for_numa (vm, vm->numa_node);
 142       if (PREDICT_TRUE
 143           (vlib_buffer_alloc_from_pool (vm, &new_bi, 1, bpi) == 1))
 144         {
 145           /* Remove our own reference on the current placeholder buffer */
 146           ctx_ph->ref_count--;
 147           /* Replace with the new placeholder buffer */
 148           txq->ctx_desc_placeholder_bi = new_bi;
 149           ctx_ph = vlib_get_buffer (vm, new_bi);
 150         }
 151       else
 152         /* Impossible to enqueue a ctx descriptor, fail */
 153         return 1;
 154     }
 155
 156   /* Acquire a reference on the placeholder buffer */
 157   ctx_ph->ref_count++;
 158
 159   u16 l234hdr_sz =
 160     vnet_buffer (b)->l4_hdr_offset -
 161     vnet_buffer (b)->l2_hdr_offset + vnet_buffer2 (b)->gso_l4_hdr_sz;
 162   u16 tlen = vlib_buffer_length_in_chain (vm, b) - l234hdr_sz;
 163   d[0].qword[0] = 0;
 164   d[0].qword[1] = AVF_TXD_DTYP_CTX | AVF_TXD_CTX_CMD_TSO
 165     | AVF_TXD_CTX_SEG_MSS (vnet_buffer2 (b)->gso_size) |
 166     AVF_TXD_CTX_SEG_TLEN (tlen);
 167   return 0;
 168 }
 169
 170
 171 static_always_inline u16
 172 avf_tx_enqueue (vlib_main_t * vm, vlib_node_runtime_t * node, avf_txq_t * txq,
 173                 u32 * buffers, u32 n_packets, int use_va_dma)
 174 {
 175   u16 next = txq->next;
 176   u64 bits = AVF_TXD_CMD_EOP | AVF_TXD_CMD_RSV;
 177   const u32 offload_mask = VNET_BUFFER_F_OFFLOAD_IP_CKSUM |
 178     VNET_BUFFER_F_OFFLOAD_TCP_CKSUM | VNET_BUFFER_F_OFFLOAD_UDP_CKSUM |
 179     VNET_BUFFER_F_GSO;
 180   u64 one_by_one_offload_flags = 0;
 181   int is_tso;
 182   u16 n_desc = 0;
 183   u16 *slot, n_desc_left, n_packets_left = n_packets;
 184   u16 mask = txq->size - 1;
 185   vlib_buffer_t *b[4];
 186   avf_tx_desc_t *d = txq->descs + next;
 187   u16 n_desc_needed;
 188   vlib_buffer_t *b0;
 189
 190   /* avoid ring wrap */
 191   n_desc_left = txq->size - clib_max (txq->next, txq->n_enqueued + 8);
 192
 193   if (n_desc_left == 0)
 194     return 0;
 195
 196   /* Fast path, no ring wrap */
 197   while (n_packets_left && n_desc_left)
 198     {
 199       u32 or_flags;
 200       if (n_packets_left < 8 || n_desc_left < 4)
 201         goto one_by_one;
 202
 203       vlib_prefetch_buffer_with_index (vm, buffers[4], LOAD);
 204       vlib_prefetch_buffer_with_index (vm, buffers[5], LOAD);
 205       vlib_prefetch_buffer_with_index (vm, buffers[6], LOAD);
 206       vlib_prefetch_buffer_with_index (vm, buffers[7], LOAD);
 207
 208       b[0] = vlib_get_buffer (vm, buffers[0]);
 209       b[1] = vlib_get_buffer (vm, buffers[1]);
 210       b[2] = vlib_get_buffer (vm, buffers[2]);
 211       b[3] = vlib_get_buffer (vm, buffers[3]);
 212
 213       or_flags = b[0]->flags | b[1]->flags | b[2]->flags | b[3]->flags;
 214
 215       if (or_flags & (VLIB_BUFFER_NEXT_PRESENT | offload_mask))
 216         goto one_by_one;
 217
 218       vlib_buffer_copy_indices (txq->bufs + next, buffers, 4);
 219
 220       if (use_va_dma)
 221         {
 222           d[0].qword[0] = vlib_buffer_get_current_va (b[0]);
 223           d[1].qword[0] = vlib_buffer_get_current_va (b[1]);
 224           d[2].qword[0] = vlib_buffer_get_current_va (b[2]);
 225           d[3].qword[0] = vlib_buffer_get_current_va (b[3]);
 226         }
 227       else
 228         {
 229           d[0].qword[0] = vlib_buffer_get_current_pa (vm, b[0]);
 230           d[1].qword[0] = vlib_buffer_get_current_pa (vm, b[1]);
 231           d[2].qword[0] = vlib_buffer_get_current_pa (vm, b[2]);
 232           d[3].qword[0] = vlib_buffer_get_current_pa (vm, b[3]);
 233         }
 234
 235       d[0].qword[1] = ((u64) b[0]->current_length) << 34 | bits;
 236       d[1].qword[1] = ((u64) b[1]->current_length) << 34 | bits;
 237       d[2].qword[1] = ((u64) b[2]->current_length) << 34 | bits;
 238       d[3].qword[1] = ((u64) b[3]->current_length) << 34 | bits;
 239
 240       next += 4;
 241       n_desc += 4;
 242       buffers += 4;
 243       n_packets_left -= 4;
 244       n_desc_left -= 4;
 245       d += 4;
 246       continue;
 247
 248     one_by_one:
 249       one_by_one_offload_flags = 0;
 250       txq->bufs[next] = buffers[0];
 251       b[0] = vlib_get_buffer (vm, buffers[0]);
 252       is_tso = ! !(b[0]->flags & VNET_BUFFER_F_GSO);
 253       if (PREDICT_FALSE (is_tso || b[0]->flags & offload_mask))
 254         one_by_one_offload_flags |= avf_tx_prepare_cksum (b[0], is_tso);
 255
 256       /* Deal with chain buffer if present */
 257       if (is_tso || b[0]->flags & VLIB_BUFFER_NEXT_PRESENT)
 258         {
 259           n_desc_needed = 1 + is_tso;
 260           b0 = b[0];
 261
 262           /* Wish there were a buffer count for chain buffer */
 263           while (b0->flags & VLIB_BUFFER_NEXT_PRESENT)
 264             {
 265               b0 = vlib_get_buffer (vm, b0->next_buffer);
 266               n_desc_needed++;
 267             }
 268
 269           /* spec says data descriptor is limited to 8 segments */
 270           if (PREDICT_FALSE (!is_tso && n_desc_needed > 8))
 271             {
 272               vlib_buffer_free_one (vm, buffers[0]);
 273               vlib_error_count (vm, node->node_index,
 274                                 AVF_TX_ERROR_SEGMENT_SIZE_EXCEEDED, 1);
 275               n_packets_left -= 1;
 276               buffers += 1;
 277               continue;
 278             }
 279
 280           if (PREDICT_FALSE (n_desc_left < n_desc_needed))
 281             /*
 282              * Slow path may be able to to deal with this since it can handle
 283              * ring wrap
 284              */
 285             break;
 286
 287           /* Enqueue a context descriptor if needed */
 288           if (PREDICT_FALSE (is_tso))
 289             {
 290               if (avf_tx_fill_ctx_desc (vm, txq, d, b[0]))
 291                 /* Failure to acquire ref on ctx placeholder */
 292                 break;
 293               txq->bufs[next + 1] = txq->bufs[next];
 294               txq->bufs[next] = txq->ctx_desc_placeholder_bi;
 295               next += 1;
 296               n_desc += 1;
 297               n_desc_left -= 1;
 298               d += 1;
 299             }
 300           while (b[0]->flags & VLIB_BUFFER_NEXT_PRESENT)
 301             {
 302               if (use_va_dma)
 303                 d[0].qword[0] = vlib_buffer_get_current_va (b[0]);
 304               else
 305                 d[0].qword[0] = vlib_buffer_get_current_pa (vm, b[0]);
 306
 307               d[0].qword[1] = (((u64) b[0]->current_length) << 34) |
 308                 AVF_TXD_CMD_RSV | one_by_one_offload_flags;
 309
 310               next += 1;
 311               n_desc += 1;
 312               n_desc_left -= 1;
 313               d += 1;
 314
 315               txq->bufs[next] = b[0]->next_buffer;
 316               b[0] = vlib_get_buffer (vm, b[0]->next_buffer);
 317             }
 318         }
 319
 320       if (use_va_dma)
 321         d[0].qword[0] = vlib_buffer_get_current_va (b[0]);
 322       else
 323         d[0].qword[0] = vlib_buffer_get_current_pa (vm, b[0]);
 324
 325       d[0].qword[1] =
 326         (((u64) b[0]->current_length) << 34) | bits |
 327         one_by_one_offload_flags;
 328
 329       next += 1;
 330       n_desc += 1;
 331       buffers += 1;
 332       n_packets_left -= 1;
 333       n_desc_left -= 1;
 334       d += 1;
 335     }
 336
 337   /* Slow path to support ring wrap */
 338   if (PREDICT_FALSE (n_packets_left))
 339     {
 340       txq->n_enqueued += n_desc;
 341
 342       n_desc = 0;
 343       d = txq->descs + (next & mask);
 344
 345       /* +8 to be consistent with fast path */
 346       n_desc_left = txq->size - (txq->n_enqueued + 8);
 347
 348       while (n_packets_left && n_desc_left)
 349         {
 350
 351           txq->bufs[next & mask] = buffers[0];
 352           b[0] = vlib_get_buffer (vm, buffers[0]);
 353
 354           one_by_one_offload_flags = 0;
 355           is_tso = ! !(b[0]->flags & VNET_BUFFER_F_GSO);
 356           if (PREDICT_FALSE (is_tso || b[0]->flags & offload_mask))
 357             one_by_one_offload_flags |= avf_tx_prepare_cksum (b[0], is_tso);
 358
 359           /* Deal with chain buffer if present */
 360           if (is_tso || b[0]->flags & VLIB_BUFFER_NEXT_PRESENT)
 361             {
 362               n_desc_needed = 1 + is_tso;
 363               b0 = b[0];
 364
 365               while (b0->flags & VLIB_BUFFER_NEXT_PRESENT)
 366                 {
 367                   b0 = vlib_get_buffer (vm, b0->next_buffer);
 368                   n_desc_needed++;
 369                 }
 370
 371               /* Spec says data descriptor is limited to 8 segments */
 372               if (PREDICT_FALSE (!is_tso && n_desc_needed > 8))
 373                 {
 374                   vlib_buffer_free_one (vm, buffers[0]);
 375                   vlib_error_count (vm, node->node_index,
 376                                     AVF_TX_ERROR_SEGMENT_SIZE_EXCEEDED, 1);
 377                   n_packets_left -= 1;
 378                   buffers += 1;
 379                   continue;
 380                 }
 381
 382               if (PREDICT_FALSE (n_desc_left < n_desc_needed))
 383                 break;
 384
 385               /* Enqueue a context descriptor if needed */
 386               if (PREDICT_FALSE (is_tso))
 387                 {
 388                   if (avf_tx_fill_ctx_desc (vm, txq, d, b[0]))
 389                     /* Failure to acquire ref on ctx placeholder */
 390                     break;
 391
 392                   txq->bufs[(next + 1) & mask] = txq->bufs[next & mask];
 393                   txq->bufs[next & mask] = txq->ctx_desc_placeholder_bi;
 394                   next += 1;
 395                   n_desc += 1;
 396                   n_desc_left -= 1;
 397                   d = txq->descs + (next & mask);
 398                 }
 399               while (b[0]->flags & VLIB_BUFFER_NEXT_PRESENT)
 400                 {
 401                   if (use_va_dma)
 402                     d[0].qword[0] = vlib_buffer_get_current_va (b[0]);
 403                   else
 404                     d[0].qword[0] = vlib_buffer_get_current_pa (vm, b[0]);
 405
 406                   d[0].qword[1] = (((u64) b[0]->current_length) << 34) |
 407                     AVF_TXD_CMD_RSV | one_by_one_offload_flags;
 408
 409                   next += 1;
 410                   n_desc += 1;
 411                   n_desc_left -= 1;
 412                   d = txq->descs + (next & mask);
 413
 414                   txq->bufs[next & mask] = b[0]->next_buffer;
 415                   b[0] = vlib_get_buffer (vm, b[0]->next_buffer);
 416                 }
 417             }
 418
 419           if (use_va_dma)
 420             d[0].qword[0] = vlib_buffer_get_current_va (b[0]);
 421           else
 422             d[0].qword[0] = vlib_buffer_get_current_pa (vm, b[0]);
 423
 424           d[0].qword[1] =
 425             (((u64) b[0]->current_length) << 34) | bits |
 426             one_by_one_offload_flags;
 427
 428           next += 1;
 429           n_desc += 1;
 430           buffers += 1;
 431           n_packets_left -= 1;
 432           n_desc_left -= 1;
 433           d = txq->descs + (next & mask);
 434         }
 435     }
 436
 437   if ((slot = clib_ring_enq (txq->rs_slots)))
 438     {
 439       u16 rs_slot = slot[0] = (next - 1) & mask;
 440       d = txq->descs + rs_slot;
 441       d[0].qword[1] |= AVF_TXD_CMD_RS;
 442     }
 443
 444   txq->next = next & mask;
 445   clib_atomic_store_rel_n (txq->qtx_tail, txq->next);
 446   txq->n_enqueued += n_desc;
 447   return n_packets - n_packets_left;
 448 }
 449
 450 VNET_DEVICE_CLASS_TX_FN (avf_device_class) (vlib_main_t * vm,
 451                                             vlib_node_runtime_t * node,
 452                                             vlib_frame_t * frame)
 453 {
 454   vnet_interface_output_runtime_t *rd = (void *) node->runtime_data;
 455   avf_device_t *ad = avf_get_device (rd->dev_instance);
 456   u32 thread_index = vm->thread_index;
 457   u8 qid = thread_index;
 458   avf_txq_t *txq = vec_elt_at_index (ad->txqs, qid % ad->num_queue_pairs);
 459   u32 *buffers = vlib_frame_vector_args (frame);
 460   u16 n_enq, n_left;
 461   u16 n_retry = 2;
 462
 463   clib_spinlock_lock_if_init (&txq->lock);
 464
 465   n_left = frame->n_vectors;
 466
 467 retry:
 468   /* release consumed bufs */
 469   if (txq->n_enqueued)
 470     {
 471       i32 complete_slot = -1;
 472       while (1)
 473         {
 474           u16 *slot = clib_ring_get_first (txq->rs_slots);
 475
 476           if (slot == 0)
 477             break;
 478
 479           if (avf_tx_desc_get_dtyp (txq->descs + slot[0]) != 0x0F)
 480             break;
 481
 482           complete_slot = slot[0];
 483
 484           clib_ring_deq (txq->rs_slots);
 485         }
 486
 487       if (complete_slot >= 0)
 488         {
 489           u16 first, mask, n_free;
 490           mask = txq->size - 1;
 491           first = (txq->next - txq->n_enqueued) & mask;
 492           n_free = (complete_slot + 1 - first) & mask;
 493
 494           txq->n_enqueued -= n_free;
 495           vlib_buffer_free_from_ring_no_next (vm, txq->bufs, first, txq->size,
 496                                               n_free);
 497         }
 498     }
 499
 500   if (ad->flags & AVF_DEVICE_F_VA_DMA)
 501     n_enq = avf_tx_enqueue (vm, node, txq, buffers, n_left, 1);
 502   else
 503     n_enq = avf_tx_enqueue (vm, node, txq, buffers, n_left, 0);
 504
 505   n_left -= n_enq;
 506
 507   if (n_left)
 508     {
 509       buffers += n_enq;
 510
 511       if (n_retry--)
 512         goto retry;
 513
 514       vlib_buffer_free (vm, buffers, n_left);
 515       vlib_error_count (vm, node->node_index,
 516                         AVF_TX_ERROR_NO_FREE_SLOTS, n_left);
 517     }
 518
 519   clib_spinlock_unlock_if_init (&txq->lock);
 520
 521   return frame->n_vectors - n_left;
 522 }
 523
 524 /*
 525  * fd.io coding-style-patch-verification: ON
 526  *
 527  * Local Variables:
 528  * eval: (c-set-style "gnu")
 529  * End:
 530  */