virtio: fix the tx side hdr offset
[vpp.git] / src / vnet / devices / virtio / device.c
1 /*
2  *------------------------------------------------------------------
3  * Copyright (c) 2016 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 <sys/types.h>
19 #include <sys/stat.h>
20 #include <fcntl.h>
21
22 #include <vlib/vlib.h>
23 #include <vlib/unix/unix.h>
24 #include <vnet/vnet.h>
25 #include <vnet/ethernet/ethernet.h>
26 #include <vnet/gso/gro_func.h>
27 #include <vnet/gso/hdr_offset_parser.h>
28 #include <vnet/ip/ip4_packet.h>
29 #include <vnet/ip/ip6_packet.h>
30 #include <vnet/ip/ip_psh_cksum.h>
31 #include <vnet/tcp/tcp_packet.h>
32 #include <vnet/udp/udp_packet.h>
33 #include <vnet/devices/virtio/virtio.h>
34
35 #define VIRTIO_TX_MAX_CHAIN_LEN 127
36
37 #define foreach_virtio_tx_func_error           \
38 _(NO_FREE_SLOTS, "no free tx slots")           \
39 _(TRUNC_PACKET, "packet > buffer size -- truncated in tx ring") \
40 _(PENDING_MSGS, "pending msgs in tx ring") \
41 _(INDIRECT_DESC_ALLOC_FAILED, "indirect descriptor allocation failed - packet drop") \
42 _(OUT_OF_ORDER, "out-of-order buffers in used ring") \
43 _(GSO_PACKET_DROP, "gso disabled on itf  -- gso packet drop") \
44 _(CSUM_OFFLOAD_PACKET_DROP, "checksum offload disabled on itf -- csum offload packet drop")
45
46 typedef enum
47 {
48 #define _(f,s) VIRTIO_TX_ERROR_##f,
49   foreach_virtio_tx_func_error
50 #undef _
51     VIRTIO_TX_N_ERROR,
52 } virtio_tx_func_error_t;
53
54 static char *virtio_tx_func_error_strings[] = {
55 #define _(n,s) s,
56   foreach_virtio_tx_func_error
57 #undef _
58 };
59
60 static u8 *
61 format_virtio_device (u8 * s, va_list * args)
62 {
63   u32 dev_instance = va_arg (*args, u32);
64   int verbose = va_arg (*args, int);
65   u32 indent = format_get_indent (s);
66   virtio_main_t *vim = &virtio_main;
67   virtio_if_t *vif = vec_elt_at_index (vim->interfaces, dev_instance);
68   vnet_virtio_vring_t *vring = 0;
69
70   s = format (s, "VIRTIO interface");
71   if (verbose)
72     {
73       s = format (s, "\n%U instance %u", format_white_space, indent + 2,
74                   dev_instance);
75       s = format (s, "\n%U RX QUEUE : Total Packets", format_white_space,
76                   indent + 4);
77       vec_foreach (vring, vif->rxq_vrings)
78         {
79           s = format (s, "\n%U %8u : %llu", format_white_space, indent + 4,
80                       RX_QUEUE_ACCESS (vring->queue_id), vring->total_packets);
81         }
82       s = format (s, "\n%U TX QUEUE : Total Packets", format_white_space,
83                   indent + 4);
84       vec_foreach (vring, vif->txq_vrings)
85         {
86           s = format (s, "\n%U %8u : %llu", format_white_space, indent + 4,
87                       TX_QUEUE_ACCESS (vring->queue_id), vring->total_packets);
88         }
89     }
90
91   return s;
92 }
93
94 typedef struct
95 {
96   u32 buffer_index;
97   u32 sw_if_index;
98   generic_header_offset_t gho;
99   vlib_buffer_t buffer;
100 } virtio_tx_trace_t;
101
102 static u8 *
103 format_virtio_tx_trace (u8 * s, va_list * va)
104 {
105   CLIB_UNUSED (vlib_main_t * vm) = va_arg (*va, vlib_main_t *);
106   CLIB_UNUSED (vlib_node_t * node) = va_arg (*va, vlib_node_t *);
107   virtio_tx_trace_t *t = va_arg (*va, virtio_tx_trace_t *);
108   u32 indent = format_get_indent (s);
109
110   s = format (s, "%Ubuffer 0x%x: %U\n", format_white_space, indent,
111               t->buffer_index, format_vnet_buffer_no_chain, &t->buffer);
112   s =
113     format (s, "%U%U\n", format_white_space, indent,
114             format_generic_header_offset, &t->gho);
115   s =
116     format (s, "%U%U", format_white_space, indent,
117             format_ethernet_header_with_length, t->buffer.pre_data,
118             sizeof (t->buffer.pre_data));
119   return s;
120 }
121
122 static void
123 virtio_tx_trace (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_buffer_t *b0,
124                  u32 bi, int is_tun)
125 {
126   virtio_tx_trace_t *t;
127   t = vlib_add_trace (vm, node, b0, sizeof (t[0]));
128   t->sw_if_index = vnet_buffer (b0)->sw_if_index[VLIB_TX];
129   t->buffer_index = bi;
130   clib_memset (&t->gho, 0, sizeof (t->gho));
131   if (is_tun)
132     {
133       int is_ip4 = 0, is_ip6 = 0;
134
135       switch (((u8 *) vlib_buffer_get_current (b0))[0] & 0xf0)
136         {
137         case 0x40:
138           is_ip4 = 1;
139           break;
140         case 0x60:
141           is_ip6 = 1;
142           break;
143         default:
144           break;
145         }
146       vnet_generic_header_offset_parser (b0, &t->gho, 0, is_ip4, is_ip6);
147     }
148   else
149     vnet_generic_header_offset_parser (b0, &t->gho, 1,
150                                        b0->flags &
151                                        VNET_BUFFER_F_IS_IP4,
152                                        b0->flags & VNET_BUFFER_F_IS_IP6);
153
154   clib_memcpy_fast (&t->buffer, b0, sizeof (*b0) - sizeof (b0->pre_data));
155   clib_memcpy_fast (t->buffer.pre_data, vlib_buffer_get_current (b0),
156                     sizeof (t->buffer.pre_data));
157 }
158
159 static void
160 virtio_interface_drop_inline (vlib_main_t *vm, virtio_if_t *vif,
161                               uword node_index, u32 *buffers, u16 n,
162                               virtio_tx_func_error_t error)
163 {
164   vlib_error_count (vm, node_index, error, n);
165   vlib_increment_simple_counter (vnet_main.interface_main.sw_if_counters +
166                                    VNET_INTERFACE_COUNTER_DROP,
167                                  vm->thread_index, vif->sw_if_index, n);
168   vlib_buffer_free (vm, buffers, n);
169 }
170
171 static void
172 virtio_memset_ring_u32 (u32 *ring, u32 start, u32 ring_size, u32 n_buffers)
173 {
174   ASSERT (n_buffers <= ring_size);
175
176   if (PREDICT_TRUE (start + n_buffers <= ring_size))
177     {
178       clib_memset_u32 (ring + start, ~0, n_buffers);
179     }
180   else
181     {
182       clib_memset_u32 (ring + start, ~0, ring_size - start);
183       clib_memset_u32 (ring, ~0, n_buffers - (ring_size - start));
184     }
185 }
186
187 static void
188 virtio_free_used_device_desc_split (vlib_main_t *vm,
189                                     vnet_virtio_vring_t *vring,
190                                     uword node_index)
191 {
192   u16 used = vring->desc_in_use;
193   u16 sz = vring->queue_size;
194   u16 mask = sz - 1;
195   u16 last = vring->last_used_idx;
196   u16 n_left = vring->used->idx - last;
197   u16 out_of_order_count = 0;
198
199   if (n_left == 0)
200     return;
201
202   while (n_left)
203     {
204       vnet_virtio_vring_used_elem_t *e = &vring->used->ring[last & mask];
205       u16 slot, n_buffers;
206       slot = n_buffers = e->id;
207
208       while (e->id == (n_buffers & mask))
209         {
210           n_left--;
211           last++;
212           n_buffers++;
213           vnet_virtio_vring_desc_t *d = &vring->desc[e->id];
214           u16 next;
215           while (d->flags & VRING_DESC_F_NEXT)
216             {
217               n_buffers++;
218               next = d->next;
219               d = &vring->desc[next];
220             }
221           if (n_left == 0)
222             break;
223           e = &vring->used->ring[last & mask];
224         }
225       vlib_buffer_free_from_ring (vm, vring->buffers, slot,
226                                   sz, (n_buffers - slot));
227       virtio_memset_ring_u32 (vring->buffers, slot, sz, (n_buffers - slot));
228       used -= (n_buffers - slot);
229
230       if (n_left > 0)
231         {
232           vlib_buffer_free (vm, &vring->buffers[e->id], 1);
233           vring->buffers[e->id] = ~0;
234           used--;
235           last++;
236           n_left--;
237           out_of_order_count++;
238           vring->flags |= VRING_TX_OUT_OF_ORDER;
239         }
240     }
241
242   /*
243    * Some vhost-backends give buffers back in out-of-order fashion in used ring.
244    * It impacts the overall virtio-performance.
245    */
246   if (out_of_order_count)
247     vlib_error_count (vm, node_index, VIRTIO_TX_ERROR_OUT_OF_ORDER,
248                       out_of_order_count);
249
250   vring->desc_in_use = used;
251   vring->last_used_idx = last;
252 }
253
254 static void
255 virtio_free_used_device_desc_packed (vlib_main_t *vm,
256                                      vnet_virtio_vring_t *vring,
257                                      uword node_index)
258 {
259   vnet_virtio_vring_packed_desc_t *d;
260   u16 sz = vring->queue_size;
261   u16 last = vring->last_used_idx;
262   u16 n_buffers = 0, start;
263   u16 flags;
264
265   if (vring->desc_in_use == 0)
266     return;
267
268   d = &vring->packed_desc[last];
269   flags = d->flags;
270   start = d->id;
271
272   while ((flags & VRING_DESC_F_AVAIL) == (vring->used_wrap_counter << 7) &&
273          (flags & VRING_DESC_F_USED) == (vring->used_wrap_counter << 15))
274     {
275       last++;
276       n_buffers++;
277
278       if (last >= sz)
279         {
280           last = 0;
281           vring->used_wrap_counter ^= 1;
282         }
283       d = &vring->packed_desc[last];
284       flags = d->flags;
285     }
286
287   if (n_buffers)
288     {
289       vlib_buffer_free_from_ring (vm, vring->buffers, start, sz, n_buffers);
290       virtio_memset_ring_u32 (vring->buffers, start, sz, n_buffers);
291       vring->desc_in_use -= n_buffers;
292       vring->last_used_idx = last;
293     }
294 }
295
296 static void
297 virtio_free_used_device_desc (vlib_main_t *vm, vnet_virtio_vring_t *vring,
298                               uword node_index, int packed)
299 {
300   if (packed)
301     virtio_free_used_device_desc_packed (vm, vring, node_index);
302   else
303     virtio_free_used_device_desc_split (vm, vring, node_index);
304
305 }
306
307 static void
308 set_checksum_offsets (vlib_buffer_t *b, vnet_virtio_net_hdr_v1_t *hdr,
309                       const int is_l2)
310 {
311   vnet_buffer_oflags_t oflags = vnet_buffer (b)->oflags;
312   i16 l4_hdr_offset =
313     vnet_buffer (b)->l4_hdr_offset - vnet_buffer (b)->l2_hdr_offset;
314   if (b->flags & VNET_BUFFER_F_IS_IP4)
315     {
316       ip4_header_t *ip4;
317       hdr->flags = VIRTIO_NET_HDR_F_NEEDS_CSUM;
318       hdr->csum_start = l4_hdr_offset; // 0x22;
319
320       /*
321        * virtio devices do not support IP4 checksum offload. So driver takes
322        * care of it while doing tx.
323        */
324       ip4 = (ip4_header_t *) (b->data + vnet_buffer (b)->l3_hdr_offset);
325       if (oflags & VNET_BUFFER_OFFLOAD_F_IP_CKSUM)
326         ip4->checksum = ip4_header_checksum (ip4);
327
328       /*
329        * virtio devices assume the l4 header is set to the checksum of the
330        * l3 pseudo-header, so we compute it before tx-ing
331        */
332       if (oflags & VNET_BUFFER_OFFLOAD_F_TCP_CKSUM)
333         {
334           tcp_header_t *tcp =
335             (tcp_header_t *) (b->data + vnet_buffer (b)->l4_hdr_offset);
336           tcp->checksum = ip4_pseudo_header_cksum (ip4);
337           hdr->csum_offset = STRUCT_OFFSET_OF (tcp_header_t, checksum);
338         }
339       else if (oflags & VNET_BUFFER_OFFLOAD_F_UDP_CKSUM)
340         {
341           udp_header_t *udp =
342             (udp_header_t *) (b->data + vnet_buffer (b)->l4_hdr_offset);
343           udp->checksum = ip4_pseudo_header_cksum (ip4);
344           hdr->csum_offset = STRUCT_OFFSET_OF (udp_header_t, checksum);
345         }
346     }
347   else if (b->flags & VNET_BUFFER_F_IS_IP6)
348     {
349       ip6_header_t *ip6;
350       hdr->flags = VIRTIO_NET_HDR_F_NEEDS_CSUM;
351       hdr->csum_start = l4_hdr_offset; // 0x36;
352       ip6 = (ip6_header_t *) (b->data + vnet_buffer (b)->l3_hdr_offset);
353
354       /*
355        * virtio devices assume the l4 header is set to the checksum of the
356        * l3 pseudo-header, so we compute it before tx-ing
357        */
358       if (oflags & VNET_BUFFER_OFFLOAD_F_TCP_CKSUM)
359         {
360           tcp_header_t *tcp =
361             (tcp_header_t *) (b->data + vnet_buffer (b)->l4_hdr_offset);
362           tcp->checksum = ip6_pseudo_header_cksum (ip6);
363           hdr->csum_offset = STRUCT_OFFSET_OF (tcp_header_t, checksum);
364         }
365       else if (oflags & VNET_BUFFER_OFFLOAD_F_UDP_CKSUM)
366         {
367           udp_header_t *udp =
368             (udp_header_t *) (b->data + vnet_buffer (b)->l4_hdr_offset);
369           udp->checksum = ip6_pseudo_header_cksum (ip6);
370           hdr->csum_offset = STRUCT_OFFSET_OF (udp_header_t, checksum);
371         }
372     }
373 }
374
375 static void
376 set_gso_offsets (vlib_buffer_t *b, vnet_virtio_net_hdr_v1_t *hdr,
377                  const int is_l2)
378 {
379   vnet_buffer_oflags_t oflags = vnet_buffer (b)->oflags;
380   i16 l4_hdr_offset =
381     vnet_buffer (b)->l4_hdr_offset - vnet_buffer (b)->l2_hdr_offset;
382
383   if (b->flags & VNET_BUFFER_F_IS_IP4)
384     {
385       ip4_header_t *ip4;
386       hdr->gso_type = VIRTIO_NET_HDR_GSO_TCPV4;
387       hdr->gso_size = vnet_buffer2 (b)->gso_size;
388       hdr->hdr_len = l4_hdr_offset + vnet_buffer2 (b)->gso_l4_hdr_sz;
389       hdr->flags = VIRTIO_NET_HDR_F_NEEDS_CSUM;
390       hdr->csum_start = l4_hdr_offset; // 0x22;
391       hdr->csum_offset = STRUCT_OFFSET_OF (tcp_header_t, checksum);
392       ip4 = (ip4_header_t *) (b->data + vnet_buffer (b)->l3_hdr_offset);
393       /*
394        * virtio devices do not support IP4 checksum offload. So driver takes care
395        * of it while doing tx.
396        */
397       if (oflags & VNET_BUFFER_OFFLOAD_F_IP_CKSUM)
398         ip4->checksum = ip4_header_checksum (ip4);
399     }
400   else if (b->flags & VNET_BUFFER_F_IS_IP6)
401     {
402       hdr->gso_type = VIRTIO_NET_HDR_GSO_TCPV6;
403       hdr->gso_size = vnet_buffer2 (b)->gso_size;
404       hdr->hdr_len = l4_hdr_offset + vnet_buffer2 (b)->gso_l4_hdr_sz;
405       hdr->flags = VIRTIO_NET_HDR_F_NEEDS_CSUM;
406       hdr->csum_start = l4_hdr_offset; // 0x36;
407       hdr->csum_offset = STRUCT_OFFSET_OF (tcp_header_t, checksum);
408     }
409 }
410
411 static u16
412 add_buffer_to_slot (vlib_main_t *vm, vlib_node_runtime_t *node,
413                     virtio_if_t *vif, vnet_virtio_vring_t *vring, u32 bi,
414                     u16 free_desc_count, u16 avail, u16 next, u16 mask,
415                     int hdr_sz, int do_gso, int csum_offload, int is_pci,
416                     int is_tun, int is_indirect, int is_any_layout)
417 {
418   u16 n_added = 0;
419   vnet_virtio_vring_desc_t *d;
420   int is_l2 = !is_tun;
421   d = &vring->desc[next];
422   vlib_buffer_t *b = vlib_get_buffer (vm, bi);
423   vnet_virtio_net_hdr_v1_t *hdr = vlib_buffer_get_current (b) - hdr_sz;
424   u32 drop_inline = ~0;
425
426   clib_memset_u8 (hdr, 0, hdr_sz);
427
428   vring->total_packets++;
429   if (b->flags & VNET_BUFFER_F_GSO)
430     {
431       if (do_gso)
432         set_gso_offsets (b, hdr, is_l2);
433       else
434         {
435           drop_inline = VIRTIO_TX_ERROR_GSO_PACKET_DROP;
436           goto done;
437         }
438     }
439   else if (b->flags & VNET_BUFFER_F_OFFLOAD)
440     {
441       if (csum_offload)
442         set_checksum_offsets (b, hdr, is_l2);
443       else
444         {
445           drop_inline = VIRTIO_TX_ERROR_CSUM_OFFLOAD_PACKET_DROP;
446           goto done;
447         }
448     }
449
450   if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
451     {
452       virtio_tx_trace (vm, node, b, bi, is_tun);
453     }
454
455   if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) == 0))
456     {
457       d->addr = ((is_pci) ? vlib_buffer_get_current_pa (vm, b) :
458                  pointer_to_uword (vlib_buffer_get_current (b))) - hdr_sz;
459       d->len = b->current_length + hdr_sz;
460       d->flags = 0;
461     }
462   else if (is_indirect)
463     {
464       /*
465        * We are using single vlib_buffer_t for indirect descriptor(s)
466        * chain. Single descriptor is 16 bytes and vlib_buffer_t
467        * has 2048 bytes space. So maximum long chain can have 128
468        * (=2048/16) indirect descriptors.
469        * It can easily support 65535 bytes of Jumbo frames with
470        * each data buffer size of 512 bytes minimum.
471        */
472       u32 indirect_buffer = 0;
473       if (PREDICT_FALSE (vlib_buffer_alloc (vm, &indirect_buffer, 1) == 0))
474         {
475           drop_inline = VIRTIO_TX_ERROR_INDIRECT_DESC_ALLOC_FAILED;
476           goto done;
477         }
478
479       vlib_buffer_t *indirect_desc = vlib_get_buffer (vm, indirect_buffer);
480       indirect_desc->current_data = 0;
481       indirect_desc->flags |= VLIB_BUFFER_NEXT_PRESENT;
482       indirect_desc->next_buffer = bi;
483       bi = indirect_buffer;
484
485       vnet_virtio_vring_desc_t *id =
486         (vnet_virtio_vring_desc_t *) vlib_buffer_get_current (indirect_desc);
487       u32 count = 1;
488       if (is_pci)
489         {
490           d->addr = vlib_physmem_get_pa (vm, id);
491           id->addr = vlib_buffer_get_current_pa (vm, b) - hdr_sz;
492
493           /*
494            * If VIRTIO_F_ANY_LAYOUT is not negotiated, then virtio_net_hdr
495            * should be presented in separate descriptor and data will start
496            * from next descriptor.
497            */
498           if (is_any_layout)
499             id->len = b->current_length + hdr_sz;
500           else
501             {
502               id->len = hdr_sz;
503               id->flags = VRING_DESC_F_NEXT;
504               id->next = count;
505               count++;
506               id++;
507               id->addr = vlib_buffer_get_current_pa (vm, b);
508               id->len = b->current_length;
509             }
510           while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
511             {
512               id->flags = VRING_DESC_F_NEXT;
513               id->next = count;
514               count++;
515               id++;
516               b = vlib_get_buffer (vm, b->next_buffer);
517               id->addr = vlib_buffer_get_current_pa (vm, b);
518               id->len = b->current_length;
519               if (PREDICT_FALSE (count == VIRTIO_TX_MAX_CHAIN_LEN))
520                 {
521                   if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
522                     vlib_error_count (vm, node->node_index,
523                                       VIRTIO_TX_ERROR_TRUNC_PACKET, 1);
524                   break;
525                 }
526             }
527         }
528       else                      /* VIRTIO_IF_TYPE_[TAP | TUN] */
529         {
530           d->addr = pointer_to_uword (id);
531           /* first buffer in chain */
532           id->addr = pointer_to_uword (vlib_buffer_get_current (b)) - hdr_sz;
533           id->len = b->current_length + hdr_sz;
534
535           while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
536             {
537               id->flags = VRING_DESC_F_NEXT;
538               id->next = count;
539               count++;
540               id++;
541               b = vlib_get_buffer (vm, b->next_buffer);
542               id->addr = pointer_to_uword (vlib_buffer_get_current (b));
543               id->len = b->current_length;
544               if (PREDICT_FALSE (count == VIRTIO_TX_MAX_CHAIN_LEN))
545                 {
546                   if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
547                     vlib_error_count (vm, node->node_index,
548                                       VIRTIO_TX_ERROR_TRUNC_PACKET, 1);
549                   break;
550                 }
551             }
552         }
553       id->flags = 0;
554       id->next = 0;
555       d->len = count * sizeof (vnet_virtio_vring_desc_t);
556       d->flags = VRING_DESC_F_INDIRECT;
557     }
558   else if (is_pci)
559     {
560       u16 count = next;
561       vlib_buffer_t *b_temp = b;
562       u16 n_buffers_in_chain = 1;
563
564       /*
565        * Check the length of the chain for the required number of
566        * descriptors. Return from here, retry to get more descriptors,
567        * if chain length is greater than available descriptors.
568        */
569       while (b_temp->flags & VLIB_BUFFER_NEXT_PRESENT)
570         {
571           n_buffers_in_chain++;
572           b_temp = vlib_get_buffer (vm, b_temp->next_buffer);
573         }
574
575       if (n_buffers_in_chain > free_desc_count)
576         return n_buffers_in_chain;
577
578       d->addr = vlib_buffer_get_current_pa (vm, b) - hdr_sz;
579       d->len = b->current_length + hdr_sz;
580
581       while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
582         {
583           d->flags = VRING_DESC_F_NEXT;
584           vring->buffers[count] = bi;
585           b->flags &=
586             ~(VLIB_BUFFER_NEXT_PRESENT | VLIB_BUFFER_TOTAL_LENGTH_VALID);
587           bi = b->next_buffer;
588           b->next_buffer = 0;
589           n_added++;
590           count = (count + 1) & mask;
591           d->next = count;
592           d = &vring->desc[count];
593           b = vlib_get_buffer (vm, bi);
594           d->addr = vlib_buffer_get_current_pa (vm, b);
595           d->len = b->current_length;
596         }
597       d->flags = 0;
598       vring->buffers[count] = bi;
599       vring->avail->ring[avail & mask] = next;
600       n_added++;
601       return n_added;
602     }
603   else
604     {
605       ASSERT (0);
606     }
607   vring->buffers[next] = bi;
608   vring->avail->ring[avail & mask] = next;
609   n_added++;
610
611 done:
612   if (drop_inline != ~0)
613     virtio_interface_drop_inline (vm, vif, node->node_index, &bi, 1,
614                                   drop_inline);
615
616   return n_added;
617 }
618
619 static u16
620 add_buffer_to_slot_packed (vlib_main_t *vm, vlib_node_runtime_t *node,
621                            virtio_if_t *vif, vnet_virtio_vring_t *vring,
622                            u32 bi, u16 next, int hdr_sz, int do_gso,
623                            int csum_offload, int is_pci, int is_tun,
624                            int is_indirect, int is_any_layout)
625 {
626   u16 n_added = 0, flags = 0;
627   int is_l2 = !is_tun;
628   vnet_virtio_vring_packed_desc_t *d = &vring->packed_desc[next];
629   vlib_buffer_t *b = vlib_get_buffer (vm, bi);
630   vnet_virtio_net_hdr_v1_t *hdr = vlib_buffer_get_current (b) - hdr_sz;
631   u32 drop_inline = ~0;
632
633   clib_memset (hdr, 0, hdr_sz);
634
635   vring->total_packets++;
636
637   if (b->flags & VNET_BUFFER_F_GSO)
638     {
639       if (do_gso)
640         set_gso_offsets (b, hdr, is_l2);
641       else
642         {
643           drop_inline = VIRTIO_TX_ERROR_GSO_PACKET_DROP;
644           goto done;
645         }
646     }
647   else if (b->flags & VNET_BUFFER_F_OFFLOAD)
648     {
649       if (csum_offload)
650         set_checksum_offsets (b, hdr, is_l2);
651       else
652         {
653           drop_inline = VIRTIO_TX_ERROR_CSUM_OFFLOAD_PACKET_DROP;
654           goto done;
655         }
656     }
657   if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
658     {
659       virtio_tx_trace (vm, node, b, bi, is_tun);
660     }
661
662   if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) == 0))
663     {
664       d->addr =
665         ((is_pci) ? vlib_buffer_get_current_pa (vm,
666                                                 b) :
667          pointer_to_uword (vlib_buffer_get_current (b))) - hdr_sz;
668       d->len = b->current_length + hdr_sz;
669     }
670   else if (is_indirect)
671     {
672       /*
673        * We are using single vlib_buffer_t for indirect descriptor(s)
674        * chain. Single descriptor is 16 bytes and vlib_buffer_t
675        * has 2048 bytes space. So maximum long chain can have 128
676        * (=2048/16) indirect descriptors.
677        * It can easily support 65535 bytes of Jumbo frames with
678        * each data buffer size of 512 bytes minimum.
679        */
680       u32 indirect_buffer = 0;
681       if (PREDICT_FALSE (vlib_buffer_alloc (vm, &indirect_buffer, 1) == 0))
682         {
683           drop_inline = VIRTIO_TX_ERROR_INDIRECT_DESC_ALLOC_FAILED;
684           goto done;
685         }
686
687       vlib_buffer_t *indirect_desc = vlib_get_buffer (vm, indirect_buffer);
688       indirect_desc->current_data = 0;
689       indirect_desc->flags |= VLIB_BUFFER_NEXT_PRESENT;
690       indirect_desc->next_buffer = bi;
691       bi = indirect_buffer;
692
693       vnet_virtio_vring_packed_desc_t *id =
694         (vnet_virtio_vring_packed_desc_t *) vlib_buffer_get_current (
695           indirect_desc);
696       u32 count = 1;
697       if (is_pci)
698         {
699           d->addr = vlib_physmem_get_pa (vm, id);
700           id->addr = vlib_buffer_get_current_pa (vm, b) - hdr_sz;
701
702           /*
703            * If VIRTIO_F_ANY_LAYOUT is not negotiated, then virtio_net_hdr
704            * should be presented in separate descriptor and data will start
705            * from next descriptor.
706            */
707           if (is_any_layout)
708             id->len = b->current_length + hdr_sz;
709           else
710             {
711               id->len = hdr_sz;
712               id->flags = 0;
713               id->id = 0;
714               count++;
715               id++;
716               id->addr = vlib_buffer_get_current_pa (vm, b);
717               id->len = b->current_length;
718             }
719           while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
720             {
721               id->flags = 0;
722               id->id = 0;
723               count++;
724               id++;
725               b = vlib_get_buffer (vm, b->next_buffer);
726               id->addr = vlib_buffer_get_current_pa (vm, b);
727               id->len = b->current_length;
728               if (PREDICT_FALSE (count == VIRTIO_TX_MAX_CHAIN_LEN))
729                 {
730                   if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
731                     vlib_error_count (vm, node->node_index,
732                                       VIRTIO_TX_ERROR_TRUNC_PACKET, 1);
733                   break;
734                 }
735             }
736         }
737       id->flags = 0;
738       id->id = 0;
739       d->len = count * sizeof (vnet_virtio_vring_packed_desc_t);
740       flags = VRING_DESC_F_INDIRECT;
741     }
742   else
743     {
744       ASSERT (0);
745     }
746   if (vring->avail_wrap_counter)
747     {
748       flags |= VRING_DESC_F_AVAIL;
749       flags &= ~VRING_DESC_F_USED;
750     }
751   else
752     {
753       flags &= ~VRING_DESC_F_AVAIL;
754       flags |= VRING_DESC_F_USED;
755     }
756
757   d->id = next;
758   d->flags = flags;
759   vring->buffers[next] = bi;
760   n_added++;
761
762 done:
763   if (drop_inline != ~0)
764     virtio_interface_drop_inline (vm, vif, node->node_index, &bi, 1,
765                                   drop_inline);
766
767   return n_added;
768 }
769
770 static uword
771 virtio_interface_tx_packed_gso_inline (
772   vlib_main_t *vm, vlib_node_runtime_t *node, virtio_if_t *vif,
773   virtio_if_type_t type, vnet_virtio_vring_t *vring, u32 *buffers, u16 n_left,
774   const int do_gso, const int csum_offload)
775 {
776   int is_pci = (type == VIRTIO_IF_TYPE_PCI);
777   int is_tun = (type == VIRTIO_IF_TYPE_TUN);
778   int is_indirect =
779     ((vif->features & VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC)) != 0);
780   int is_any_layout =
781     ((vif->features & VIRTIO_FEATURE (VIRTIO_F_ANY_LAYOUT)) != 0);
782   const int hdr_sz = vif->virtio_net_hdr_sz;
783   u16 sz = vring->queue_size;
784   u16 used, next, n_buffers = 0, n_buffers_left = 0;
785   u16 n_vectors = n_left;
786
787
788   used = vring->desc_in_use;
789   next = vring->desc_next;
790
791   if (vif->packet_buffering)
792     {
793       n_buffers = n_buffers_left = virtio_vring_n_buffers (vring->buffering);
794
795       while (n_buffers_left && used < sz)
796         {
797           u16 n_added = 0;
798
799           u32 bi = virtio_vring_buffering_read_from_front (vring->buffering);
800           if (bi == ~0)
801             break;
802           n_added = add_buffer_to_slot_packed (
803             vm, node, vif, vring, bi, next, hdr_sz, do_gso, csum_offload,
804             is_pci, is_tun, is_indirect, is_any_layout);
805           n_buffers_left--;
806           if (PREDICT_FALSE (n_added == 0))
807             continue;
808
809           used++;
810           next++;
811           if (next >= sz)
812             {
813               next = 0;
814               vring->avail_wrap_counter ^= 1;
815             }
816         }
817       virtio_txq_clear_scheduled (vring);
818     }
819
820   while (n_left && used < sz)
821     {
822       u16 n_added = 0;
823
824       n_added = add_buffer_to_slot_packed (
825         vm, node, vif, vring, buffers[0], next, hdr_sz, do_gso, csum_offload,
826         is_pci, is_tun, is_indirect, is_any_layout);
827       buffers++;
828       n_left--;
829       if (PREDICT_FALSE (n_added == 0))
830         continue;
831
832       used++;
833       next++;
834       if (next >= sz)
835         {
836           next = 0;
837           vring->avail_wrap_counter ^= 1;
838         }
839     }
840
841   if (n_left != n_vectors || n_buffers != n_buffers_left)
842     {
843       CLIB_MEMORY_STORE_BARRIER ();
844       vring->desc_next = next;
845       vring->desc_in_use = used;
846       CLIB_MEMORY_BARRIER ();
847       if (vring->device_event->flags != VRING_EVENT_F_DISABLE)
848         virtio_kick (vm, vring, vif);
849     }
850
851   return n_left;
852 }
853
854 static void
855 virtio_find_free_desc (vnet_virtio_vring_t *vring, u16 size, u16 mask, u16 req,
856                        u16 next, u32 *first_free_desc_index,
857                        u16 *free_desc_count)
858 {
859   u16 start = 0;
860   /* next is used as hint: from where to start looking */
861   for (u16 i = 0; i < size; i++, next++)
862     {
863       if (vring->buffers[next & mask] == ~0)
864         {
865           if (*first_free_desc_index == ~0)
866             {
867               *first_free_desc_index = (next & mask);
868               start = i;
869               (*free_desc_count)++;
870               req--;
871               if (req == 0)
872                 break;
873             }
874           else
875             {
876               if (start + *free_desc_count == i)
877                 {
878                   (*free_desc_count)++;
879                   req--;
880                   if (req == 0)
881                     break;
882                 }
883               else
884                 break;
885             }
886         }
887     }
888 }
889
890 static u16
891 virtio_interface_tx_split_gso_inline (vlib_main_t *vm,
892                                       vlib_node_runtime_t *node,
893                                       virtio_if_t *vif, virtio_if_type_t type,
894                                       vnet_virtio_vring_t *vring, u32 *buffers,
895                                       u16 n_left, int do_gso, int csum_offload)
896 {
897   u16 used, next, avail, n_buffers = 0, n_buffers_left = 0;
898   int is_pci = (type == VIRTIO_IF_TYPE_PCI);
899   int is_tun = (type == VIRTIO_IF_TYPE_TUN);
900   int is_indirect =
901     ((vif->features & VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC)) != 0);
902   int is_any_layout =
903     ((vif->features & VIRTIO_FEATURE (VIRTIO_F_ANY_LAYOUT)) != 0);
904   u16 sz = vring->queue_size;
905   int hdr_sz = vif->virtio_net_hdr_sz;
906   u16 mask = sz - 1;
907   u16 n_vectors = n_left;
908
909   used = vring->desc_in_use;
910   next = vring->desc_next;
911   avail = vring->avail->idx;
912
913   u16 free_desc_count = 0;
914
915   if (PREDICT_FALSE (vring->flags & VRING_TX_OUT_OF_ORDER))
916     {
917       u32 first_free_desc_index = ~0;
918
919       virtio_find_free_desc (vring, sz, mask, n_left, next,
920                              &first_free_desc_index, &free_desc_count);
921
922       if (free_desc_count)
923         next = first_free_desc_index;
924     }
925   else
926     free_desc_count = sz - used;
927
928   if (vif->packet_buffering)
929     {
930       n_buffers = n_buffers_left = virtio_vring_n_buffers (vring->buffering);
931
932       while (n_buffers_left && free_desc_count)
933         {
934           u16 n_added = 0;
935
936           u32 bi = virtio_vring_buffering_read_from_front (vring->buffering);
937           if (bi == ~0)
938             break;
939
940           n_added = add_buffer_to_slot (vm, node, vif, vring, bi,
941                                         free_desc_count, avail, next, mask,
942                                         hdr_sz, do_gso, csum_offload, is_pci,
943                                         is_tun, is_indirect, is_any_layout);
944           if (PREDICT_FALSE (n_added == 0))
945             {
946               n_buffers_left--;
947               continue;
948             }
949           else if (PREDICT_FALSE (n_added > free_desc_count))
950             break;
951
952           avail++;
953           next = (next + n_added) & mask;
954           used += n_added;
955           n_buffers_left--;
956           free_desc_count -= n_added;
957         }
958       virtio_txq_clear_scheduled (vring);
959     }
960
961   while (n_left && free_desc_count)
962     {
963       u16 n_added = 0;
964
965       n_added =
966         add_buffer_to_slot (vm, node, vif, vring, buffers[0], free_desc_count,
967                             avail, next, mask, hdr_sz, do_gso, csum_offload,
968                             is_pci, is_tun, is_indirect, is_any_layout);
969
970       if (PREDICT_FALSE (n_added == 0))
971         {
972           buffers++;
973           n_left--;
974           continue;
975         }
976       else if (PREDICT_FALSE (n_added > free_desc_count))
977         break;
978
979       avail++;
980       next = (next + n_added) & mask;
981       used += n_added;
982       buffers++;
983       n_left--;
984       free_desc_count -= n_added;
985     }
986
987   if (n_left != n_vectors || n_buffers != n_buffers_left)
988     {
989       clib_atomic_store_seq_cst (&vring->avail->idx, avail);
990       vring->desc_next = next;
991       vring->desc_in_use = used;
992       if ((clib_atomic_load_seq_cst (&vring->used->flags) &
993            VRING_USED_F_NO_NOTIFY) == 0)
994         virtio_kick (vm, vring, vif);
995     }
996
997   return n_left;
998 }
999
1000 static u16
1001 virtio_interface_tx_gso_inline (vlib_main_t *vm, vlib_node_runtime_t *node,
1002                                 virtio_if_t *vif, virtio_if_type_t type,
1003                                 vnet_virtio_vring_t *vring, u32 *buffers,
1004                                 u16 n_left, int packed, int do_gso,
1005                                 int csum_offload)
1006 {
1007   if (packed)
1008     return virtio_interface_tx_packed_gso_inline (vm, node, vif, type, vring,
1009                                                   buffers, n_left,
1010                                                   do_gso, csum_offload);
1011   else
1012     return virtio_interface_tx_split_gso_inline (vm, node, vif, type, vring,
1013                                                  buffers, n_left,
1014                                                  do_gso, csum_offload);
1015 }
1016
1017 static u16
1018 virtio_interface_tx_inline (vlib_main_t *vm, vlib_node_runtime_t *node,
1019                             virtio_if_t *vif, vnet_virtio_vring_t *vring,
1020                             virtio_if_type_t type, u32 *buffers, u16 n_left,
1021                             int packed)
1022 {
1023   vnet_main_t *vnm = vnet_get_main ();
1024   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, vif->hw_if_index);
1025
1026   if (hw->caps & VNET_HW_IF_CAP_TCP_GSO)
1027     return virtio_interface_tx_gso_inline (vm, node, vif, type, vring,
1028                                            buffers, n_left, packed,
1029                                            1 /* do_gso */ ,
1030                                            1 /* checksum offload */ );
1031   else if (hw->caps & VNET_HW_IF_CAP_L4_TX_CKSUM)
1032     return virtio_interface_tx_gso_inline (vm, node, vif, type, vring,
1033                                            buffers, n_left, packed,
1034                                            0 /* no do_gso */ ,
1035                                            1 /* checksum offload */ );
1036   else
1037     return virtio_interface_tx_gso_inline (vm, node, vif, type, vring,
1038                                            buffers, n_left, packed,
1039                                            0 /* no do_gso */ ,
1040                                            0 /* no checksum offload */ );
1041 }
1042
1043 VNET_DEVICE_CLASS_TX_FN (virtio_device_class) (vlib_main_t * vm,
1044                                                vlib_node_runtime_t * node,
1045                                                vlib_frame_t * frame)
1046 {
1047   virtio_main_t *nm = &virtio_main;
1048   vnet_interface_output_runtime_t *rund = (void *) node->runtime_data;
1049   virtio_if_t *vif = pool_elt_at_index (nm->interfaces, rund->dev_instance);
1050   vnet_hw_if_tx_frame_t *tf = vlib_frame_scalar_args (frame);
1051   u16 qid = tf->queue_id;
1052   vnet_virtio_vring_t *vring = vec_elt_at_index (vif->txq_vrings, qid);
1053   u16 n_left = frame->n_vectors;
1054   u32 *buffers = vlib_frame_vector_args (frame);
1055   u32 to[GRO_TO_VECTOR_SIZE (n_left)];
1056   int packed = vif->is_packed;
1057   u16 n_vectors = frame->n_vectors;
1058
1059   if (tf->shared_queue)
1060     clib_spinlock_lock (&vring->lockp);
1061
1062   if (vif->packet_coalesce)
1063     {
1064       n_vectors = n_left =
1065         vnet_gro_inline (vm, vring->flow_table, buffers, n_left, to);
1066       buffers = to;
1067       virtio_txq_clear_scheduled (vring);
1068     }
1069
1070   u16 retry_count = 2;
1071
1072 retry:
1073   /* free consumed buffers */
1074   virtio_free_used_device_desc (vm, vring, node->node_index, packed);
1075
1076   if (vif->type == VIRTIO_IF_TYPE_TAP)
1077     n_left = virtio_interface_tx_inline (vm, node, vif, vring,
1078                                          VIRTIO_IF_TYPE_TAP,
1079                                          &buffers[n_vectors - n_left],
1080                                          n_left, packed);
1081   else if (vif->type == VIRTIO_IF_TYPE_PCI)
1082     n_left = virtio_interface_tx_inline (vm, node, vif, vring,
1083                                          VIRTIO_IF_TYPE_PCI,
1084                                          &buffers[n_vectors - n_left],
1085                                          n_left, packed);
1086   else if (vif->type == VIRTIO_IF_TYPE_TUN)
1087     n_left = virtio_interface_tx_inline (vm, node, vif, vring,
1088                                          VIRTIO_IF_TYPE_TUN,
1089                                          &buffers[n_vectors - n_left],
1090                                          n_left, packed);
1091   else
1092     ASSERT (0);
1093
1094   if (n_left && retry_count--)
1095     goto retry;
1096
1097   if (vif->packet_buffering && n_left)
1098     {
1099       u16 n_buffered = virtio_vring_buffering_store_packets (vring->buffering,
1100                                                              &buffers
1101                                                              [n_vectors
1102                                                               - n_left],
1103                                                              n_left);
1104       n_left -= n_buffered;
1105     }
1106   if (n_left)
1107     virtio_interface_drop_inline (vm, vif, node->node_index,
1108                                   &buffers[n_vectors - n_left], n_left,
1109                                   VIRTIO_TX_ERROR_NO_FREE_SLOTS);
1110
1111   if (tf->shared_queue)
1112     clib_spinlock_unlock (&vring->lockp);
1113
1114   return frame->n_vectors - n_left;
1115 }
1116
1117 static void
1118 virtio_set_interface_next_node (vnet_main_t * vnm, u32 hw_if_index,
1119                                 u32 node_index)
1120 {
1121   virtio_main_t *apm = &virtio_main;
1122   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
1123   virtio_if_t *vif = pool_elt_at_index (apm->interfaces, hw->dev_instance);
1124
1125   /* Shut off redirection */
1126   if (node_index == ~0)
1127     {
1128       vif->per_interface_next_index = node_index;
1129       return;
1130     }
1131
1132   vif->per_interface_next_index =
1133     vlib_node_add_next (vlib_get_main (), virtio_input_node.index,
1134                         node_index);
1135 }
1136
1137 static void
1138 virtio_clear_hw_interface_counters (u32 instance)
1139 {
1140   /* Nothing for now */
1141 }
1142
1143 static void
1144 virtio_set_rx_interrupt (virtio_if_t *vif, vnet_virtio_vring_t *vring)
1145 {
1146   if (vif->is_packed)
1147     vring->driver_event->flags &= ~VRING_EVENT_F_DISABLE;
1148   else
1149     vring->avail->flags &= ~VRING_AVAIL_F_NO_INTERRUPT;
1150 }
1151
1152 static void
1153 virtio_set_rx_polling (virtio_if_t *vif, vnet_virtio_vring_t *vring)
1154 {
1155   if (vif->is_packed)
1156     vring->driver_event->flags |= VRING_EVENT_F_DISABLE;
1157   else
1158     vring->avail->flags |= VRING_AVAIL_F_NO_INTERRUPT;
1159 }
1160
1161 static clib_error_t *
1162 virtio_interface_rx_mode_change (vnet_main_t * vnm, u32 hw_if_index, u32 qid,
1163                                  vnet_hw_if_rx_mode mode)
1164 {
1165   virtio_main_t *mm = &virtio_main;
1166   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
1167   virtio_if_t *vif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
1168   vnet_virtio_vring_t *rx_vring = vec_elt_at_index (vif->rxq_vrings, qid);
1169
1170   if (vif->type == VIRTIO_IF_TYPE_PCI && !(vif->support_int_mode))
1171     {
1172       virtio_set_rx_polling (vif, rx_vring);
1173       return clib_error_return (0, "interrupt mode is not supported");
1174     }
1175
1176   if (mode == VNET_HW_IF_RX_MODE_POLLING)
1177       virtio_set_rx_polling (vif, rx_vring);
1178   else
1179       virtio_set_rx_interrupt (vif, rx_vring);
1180
1181   rx_vring->mode = mode;
1182
1183   return 0;
1184 }
1185
1186 static clib_error_t *
1187 virtio_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
1188 {
1189   virtio_main_t *mm = &virtio_main;
1190   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
1191   virtio_if_t *vif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
1192
1193   if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
1194     {
1195       vif->flags |= VIRTIO_IF_FLAG_ADMIN_UP;
1196       vnet_hw_interface_set_flags (vnm, vif->hw_if_index,
1197                                    VNET_HW_INTERFACE_FLAG_LINK_UP);
1198     }
1199   else
1200     {
1201       vif->flags &= ~VIRTIO_IF_FLAG_ADMIN_UP;
1202       vnet_hw_interface_set_flags (vnm, vif->hw_if_index, 0);
1203     }
1204   return 0;
1205 }
1206
1207 static clib_error_t *
1208 virtio_subif_add_del_function (vnet_main_t * vnm,
1209                                u32 hw_if_index,
1210                                struct vnet_sw_interface_t *st, int is_add)
1211 {
1212   /* Nothing for now */
1213   return 0;
1214 }
1215
1216 /* *INDENT-OFF* */
1217 VNET_DEVICE_CLASS (virtio_device_class) = {
1218   .name = "virtio",
1219   .format_device_name = format_virtio_device_name,
1220   .format_device = format_virtio_device,
1221   .format_tx_trace = format_virtio_tx_trace,
1222   .tx_function_n_errors = VIRTIO_TX_N_ERROR,
1223   .tx_function_error_strings = virtio_tx_func_error_strings,
1224   .rx_redirect_to_node = virtio_set_interface_next_node,
1225   .clear_counters = virtio_clear_hw_interface_counters,
1226   .admin_up_down_function = virtio_interface_admin_up_down,
1227   .subif_add_del_function = virtio_subif_add_del_function,
1228   .rx_mode_change_function = virtio_interface_rx_mode_change,
1229 };
1230
1231 /* *INDENT-ON* */
1232
1233 /*
1234  * fd.io coding-style-patch-verification: ON
1235  *
1236  * Local Variables:
1237  * eval: (c-set-style "gnu")
1238  * End:
1239  */