ec5cdbd7bddc8176fe19c6cd0dc7b7b01275e865
[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
313   if (b->flags & VNET_BUFFER_F_IS_IP4)
314     {
315       ip4_header_t *ip4;
316       hdr->flags = VIRTIO_NET_HDR_F_NEEDS_CSUM;
317       hdr->csum_start = vnet_buffer (b)->l4_hdr_offset; // 0x22;
318
319       /*
320        * virtio devices do not support IP4 checksum offload. So driver takes
321        * care of it while doing tx.
322        */
323       ip4 = (ip4_header_t *) (b->data + vnet_buffer (b)->l3_hdr_offset);
324       if (oflags & VNET_BUFFER_OFFLOAD_F_IP_CKSUM)
325         ip4->checksum = ip4_header_checksum (ip4);
326
327       /*
328        * virtio devices assume the l4 header is set to the checksum of the
329        * l3 pseudo-header, so we compute it before tx-ing
330        */
331       if (oflags & VNET_BUFFER_OFFLOAD_F_TCP_CKSUM)
332         {
333           tcp_header_t *tcp =
334             (tcp_header_t *) (b->data + vnet_buffer (b)->l4_hdr_offset);
335           tcp->checksum = ip4_pseudo_header_cksum (ip4);
336           hdr->csum_offset = STRUCT_OFFSET_OF (tcp_header_t, checksum);
337         }
338       else if (oflags & VNET_BUFFER_OFFLOAD_F_UDP_CKSUM)
339         {
340           udp_header_t *udp =
341             (udp_header_t *) (b->data + vnet_buffer (b)->l4_hdr_offset);
342           udp->checksum = ip4_pseudo_header_cksum (ip4);
343           hdr->csum_offset = STRUCT_OFFSET_OF (udp_header_t, checksum);
344         }
345     }
346   else if (b->flags & VNET_BUFFER_F_IS_IP6)
347     {
348       ip6_header_t *ip6;
349       hdr->flags = VIRTIO_NET_HDR_F_NEEDS_CSUM;
350       hdr->csum_start = vnet_buffer (b)->l4_hdr_offset; // 0x36;
351       ip6 = (ip6_header_t *) (b->data + vnet_buffer (b)->l3_hdr_offset);
352
353       /*
354        * virtio devices assume the l4 header is set to the checksum of the
355        * l3 pseudo-header, so we compute it before tx-ing
356        */
357       if (oflags & VNET_BUFFER_OFFLOAD_F_TCP_CKSUM)
358         {
359           tcp_header_t *tcp =
360             (tcp_header_t *) (b->data + vnet_buffer (b)->l4_hdr_offset);
361           tcp->checksum = ip6_pseudo_header_cksum (ip6);
362           hdr->csum_offset = STRUCT_OFFSET_OF (tcp_header_t, checksum);
363         }
364       else if (oflags & VNET_BUFFER_OFFLOAD_F_UDP_CKSUM)
365         {
366           udp_header_t *udp =
367             (udp_header_t *) (b->data + vnet_buffer (b)->l4_hdr_offset);
368           udp->checksum = ip6_pseudo_header_cksum (ip6);
369           hdr->csum_offset = STRUCT_OFFSET_OF (udp_header_t, checksum);
370         }
371     }
372 }
373
374 static void
375 set_gso_offsets (vlib_buffer_t *b, vnet_virtio_net_hdr_v1_t *hdr,
376                  const int is_l2)
377 {
378   vnet_buffer_oflags_t oflags = vnet_buffer (b)->oflags;
379
380   if (b->flags & VNET_BUFFER_F_IS_IP4)
381     {
382       ip4_header_t *ip4;
383       hdr->gso_type = VIRTIO_NET_HDR_GSO_TCPV4;
384       hdr->gso_size = vnet_buffer2 (b)->gso_size;
385       hdr->hdr_len = vnet_buffer (b)->l4_hdr_offset -
386                      vnet_buffer (b)->l2_hdr_offset +
387                      vnet_buffer2 (b)->gso_l4_hdr_sz;
388       hdr->flags = VIRTIO_NET_HDR_F_NEEDS_CSUM;
389       hdr->csum_start = vnet_buffer (b)->l4_hdr_offset; // 0x22;
390       hdr->csum_offset = STRUCT_OFFSET_OF (tcp_header_t, checksum);
391       ip4 = (ip4_header_t *) (b->data + vnet_buffer (b)->l3_hdr_offset);
392       /*
393        * virtio devices do not support IP4 checksum offload. So driver takes care
394        * of it while doing tx.
395        */
396       if (oflags & VNET_BUFFER_OFFLOAD_F_IP_CKSUM)
397         ip4->checksum = ip4_header_checksum (ip4);
398     }
399   else if (b->flags & VNET_BUFFER_F_IS_IP6)
400     {
401       hdr->gso_type = VIRTIO_NET_HDR_GSO_TCPV6;
402       hdr->gso_size = vnet_buffer2 (b)->gso_size;
403       hdr->hdr_len = vnet_buffer (b)->l4_hdr_offset -
404                      vnet_buffer (b)->l2_hdr_offset +
405                      vnet_buffer2 (b)->gso_l4_hdr_sz;
406       hdr->flags = VIRTIO_NET_HDR_F_NEEDS_CSUM;
407       hdr->csum_start = vnet_buffer (b)->l4_hdr_offset; // 0x36;
408       hdr->csum_offset = STRUCT_OFFSET_OF (tcp_header_t, checksum);
409     }
410 }
411
412 static u16
413 add_buffer_to_slot (vlib_main_t *vm, vlib_node_runtime_t *node,
414                     virtio_if_t *vif, vnet_virtio_vring_t *vring, u32 bi,
415                     u16 free_desc_count, u16 avail, u16 next, u16 mask,
416                     int hdr_sz, int do_gso, int csum_offload, int is_pci,
417                     int is_tun, int is_indirect, int is_any_layout)
418 {
419   u16 n_added = 0;
420   vnet_virtio_vring_desc_t *d;
421   int is_l2 = !is_tun;
422   d = &vring->desc[next];
423   vlib_buffer_t *b = vlib_get_buffer (vm, bi);
424   vnet_virtio_net_hdr_v1_t *hdr = vlib_buffer_get_current (b) - hdr_sz;
425   u32 drop_inline = ~0;
426
427   clib_memset_u8 (hdr, 0, hdr_sz);
428
429   vring->total_packets++;
430   if (b->flags & VNET_BUFFER_F_GSO)
431     {
432       if (do_gso)
433         set_gso_offsets (b, hdr, is_l2);
434       else
435         {
436           drop_inline = VIRTIO_TX_ERROR_GSO_PACKET_DROP;
437           goto done;
438         }
439     }
440   else if (b->flags & VNET_BUFFER_F_OFFLOAD)
441     {
442       if (csum_offload)
443         set_checksum_offsets (b, hdr, is_l2);
444       else
445         {
446           drop_inline = VIRTIO_TX_ERROR_CSUM_OFFLOAD_PACKET_DROP;
447           goto done;
448         }
449     }
450
451   if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
452     {
453       virtio_tx_trace (vm, node, b, bi, is_tun);
454     }
455
456   if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) == 0))
457     {
458       d->addr = ((is_pci) ? vlib_buffer_get_current_pa (vm, b) :
459                  pointer_to_uword (vlib_buffer_get_current (b))) - hdr_sz;
460       d->len = b->current_length + hdr_sz;
461       d->flags = 0;
462     }
463   else if (is_indirect)
464     {
465       /*
466        * We are using single vlib_buffer_t for indirect descriptor(s)
467        * chain. Single descriptor is 16 bytes and vlib_buffer_t
468        * has 2048 bytes space. So maximum long chain can have 128
469        * (=2048/16) indirect descriptors.
470        * It can easily support 65535 bytes of Jumbo frames with
471        * each data buffer size of 512 bytes minimum.
472        */
473       u32 indirect_buffer = 0;
474       if (PREDICT_FALSE (vlib_buffer_alloc (vm, &indirect_buffer, 1) == 0))
475         {
476           drop_inline = VIRTIO_TX_ERROR_INDIRECT_DESC_ALLOC_FAILED;
477           goto done;
478         }
479
480       vlib_buffer_t *indirect_desc = vlib_get_buffer (vm, indirect_buffer);
481       indirect_desc->current_data = 0;
482       indirect_desc->flags |= VLIB_BUFFER_NEXT_PRESENT;
483       indirect_desc->next_buffer = bi;
484       bi = indirect_buffer;
485
486       vnet_virtio_vring_desc_t *id =
487         (vnet_virtio_vring_desc_t *) vlib_buffer_get_current (indirect_desc);
488       u32 count = 1;
489       if (is_pci)
490         {
491           d->addr = vlib_physmem_get_pa (vm, id);
492           id->addr = vlib_buffer_get_current_pa (vm, b) - hdr_sz;
493
494           /*
495            * If VIRTIO_F_ANY_LAYOUT is not negotiated, then virtio_net_hdr
496            * should be presented in separate descriptor and data will start
497            * from next descriptor.
498            */
499           if (is_any_layout)
500             id->len = b->current_length + hdr_sz;
501           else
502             {
503               id->len = hdr_sz;
504               id->flags = VRING_DESC_F_NEXT;
505               id->next = count;
506               count++;
507               id++;
508               id->addr = vlib_buffer_get_current_pa (vm, b);
509               id->len = b->current_length;
510             }
511           while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
512             {
513               id->flags = VRING_DESC_F_NEXT;
514               id->next = count;
515               count++;
516               id++;
517               b = vlib_get_buffer (vm, b->next_buffer);
518               id->addr = vlib_buffer_get_current_pa (vm, b);
519               id->len = b->current_length;
520               if (PREDICT_FALSE (count == VIRTIO_TX_MAX_CHAIN_LEN))
521                 {
522                   if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
523                     vlib_error_count (vm, node->node_index,
524                                       VIRTIO_TX_ERROR_TRUNC_PACKET, 1);
525                   break;
526                 }
527             }
528         }
529       else                      /* VIRTIO_IF_TYPE_[TAP | TUN] */
530         {
531           d->addr = pointer_to_uword (id);
532           /* first buffer in chain */
533           id->addr = pointer_to_uword (vlib_buffer_get_current (b)) - hdr_sz;
534           id->len = b->current_length + hdr_sz;
535
536           while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
537             {
538               id->flags = VRING_DESC_F_NEXT;
539               id->next = count;
540               count++;
541               id++;
542               b = vlib_get_buffer (vm, b->next_buffer);
543               id->addr = pointer_to_uword (vlib_buffer_get_current (b));
544               id->len = b->current_length;
545               if (PREDICT_FALSE (count == VIRTIO_TX_MAX_CHAIN_LEN))
546                 {
547                   if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
548                     vlib_error_count (vm, node->node_index,
549                                       VIRTIO_TX_ERROR_TRUNC_PACKET, 1);
550                   break;
551                 }
552             }
553         }
554       id->flags = 0;
555       id->next = 0;
556       d->len = count * sizeof (vnet_virtio_vring_desc_t);
557       d->flags = VRING_DESC_F_INDIRECT;
558     }
559   else if (is_pci)
560     {
561       u16 count = next;
562       vlib_buffer_t *b_temp = b;
563       u16 n_buffers_in_chain = 1;
564
565       /*
566        * Check the length of the chain for the required number of
567        * descriptors. Return from here, retry to get more descriptors,
568        * if chain length is greater than available descriptors.
569        */
570       while (b_temp->flags & VLIB_BUFFER_NEXT_PRESENT)
571         {
572           n_buffers_in_chain++;
573           b_temp = vlib_get_buffer (vm, b_temp->next_buffer);
574         }
575
576       if (n_buffers_in_chain > free_desc_count)
577         return n_buffers_in_chain;
578
579       d->addr = vlib_buffer_get_current_pa (vm, b) - hdr_sz;
580       d->len = b->current_length + hdr_sz;
581
582       while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
583         {
584           d->flags = VRING_DESC_F_NEXT;
585           vring->buffers[count] = bi;
586           b->flags &=
587             ~(VLIB_BUFFER_NEXT_PRESENT | VLIB_BUFFER_TOTAL_LENGTH_VALID);
588           bi = b->next_buffer;
589           b->next_buffer = 0;
590           n_added++;
591           count = (count + 1) & mask;
592           d->next = count;
593           d = &vring->desc[count];
594           b = vlib_get_buffer (vm, bi);
595           d->addr = vlib_buffer_get_current_pa (vm, b);
596           d->len = b->current_length;
597         }
598       d->flags = 0;
599       vring->buffers[count] = bi;
600       vring->avail->ring[avail & mask] = next;
601       n_added++;
602       return n_added;
603     }
604   else
605     {
606       ASSERT (0);
607     }
608   vring->buffers[next] = bi;
609   vring->avail->ring[avail & mask] = next;
610   n_added++;
611
612 done:
613   if (drop_inline != ~0)
614     virtio_interface_drop_inline (vm, vif, node->node_index, &bi, 1,
615                                   drop_inline);
616
617   return n_added;
618 }
619
620 static u16
621 add_buffer_to_slot_packed (vlib_main_t *vm, vlib_node_runtime_t *node,
622                            virtio_if_t *vif, vnet_virtio_vring_t *vring,
623                            u32 bi, u16 next, int hdr_sz, int do_gso,
624                            int csum_offload, int is_pci, int is_tun,
625                            int is_indirect, int is_any_layout)
626 {
627   u16 n_added = 0, flags = 0;
628   int is_l2 = !is_tun;
629   vnet_virtio_vring_packed_desc_t *d = &vring->packed_desc[next];
630   vlib_buffer_t *b = vlib_get_buffer (vm, bi);
631   vnet_virtio_net_hdr_v1_t *hdr = vlib_buffer_get_current (b) - hdr_sz;
632   u32 drop_inline = ~0;
633
634   clib_memset (hdr, 0, hdr_sz);
635
636   vring->total_packets++;
637
638   if (b->flags & VNET_BUFFER_F_GSO)
639     {
640       if (do_gso)
641         set_gso_offsets (b, hdr, is_l2);
642       else
643         {
644           drop_inline = VIRTIO_TX_ERROR_GSO_PACKET_DROP;
645           goto done;
646         }
647     }
648   else if (b->flags & VNET_BUFFER_F_OFFLOAD)
649     {
650       if (csum_offload)
651         set_checksum_offsets (b, hdr, is_l2);
652       else
653         {
654           drop_inline = VIRTIO_TX_ERROR_CSUM_OFFLOAD_PACKET_DROP;
655           goto done;
656         }
657     }
658   if (PREDICT_FALSE (b->flags & VLIB_BUFFER_IS_TRACED))
659     {
660       virtio_tx_trace (vm, node, b, bi, is_tun);
661     }
662
663   if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) == 0))
664     {
665       d->addr =
666         ((is_pci) ? vlib_buffer_get_current_pa (vm,
667                                                 b) :
668          pointer_to_uword (vlib_buffer_get_current (b))) - hdr_sz;
669       d->len = b->current_length + hdr_sz;
670     }
671   else if (is_indirect)
672     {
673       /*
674        * We are using single vlib_buffer_t for indirect descriptor(s)
675        * chain. Single descriptor is 16 bytes and vlib_buffer_t
676        * has 2048 bytes space. So maximum long chain can have 128
677        * (=2048/16) indirect descriptors.
678        * It can easily support 65535 bytes of Jumbo frames with
679        * each data buffer size of 512 bytes minimum.
680        */
681       u32 indirect_buffer = 0;
682       if (PREDICT_FALSE (vlib_buffer_alloc (vm, &indirect_buffer, 1) == 0))
683         {
684           drop_inline = VIRTIO_TX_ERROR_INDIRECT_DESC_ALLOC_FAILED;
685           goto done;
686         }
687
688       vlib_buffer_t *indirect_desc = vlib_get_buffer (vm, indirect_buffer);
689       indirect_desc->current_data = 0;
690       indirect_desc->flags |= VLIB_BUFFER_NEXT_PRESENT;
691       indirect_desc->next_buffer = bi;
692       bi = indirect_buffer;
693
694       vnet_virtio_vring_packed_desc_t *id =
695         (vnet_virtio_vring_packed_desc_t *) vlib_buffer_get_current (
696           indirect_desc);
697       u32 count = 1;
698       if (is_pci)
699         {
700           d->addr = vlib_physmem_get_pa (vm, id);
701           id->addr = vlib_buffer_get_current_pa (vm, b) - hdr_sz;
702
703           /*
704            * If VIRTIO_F_ANY_LAYOUT is not negotiated, then virtio_net_hdr
705            * should be presented in separate descriptor and data will start
706            * from next descriptor.
707            */
708           if (is_any_layout)
709             id->len = b->current_length + hdr_sz;
710           else
711             {
712               id->len = hdr_sz;
713               id->flags = 0;
714               id->id = 0;
715               count++;
716               id++;
717               id->addr = vlib_buffer_get_current_pa (vm, b);
718               id->len = b->current_length;
719             }
720           while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
721             {
722               id->flags = 0;
723               id->id = 0;
724               count++;
725               id++;
726               b = vlib_get_buffer (vm, b->next_buffer);
727               id->addr = vlib_buffer_get_current_pa (vm, b);
728               id->len = b->current_length;
729               if (PREDICT_FALSE (count == VIRTIO_TX_MAX_CHAIN_LEN))
730                 {
731                   if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
732                     vlib_error_count (vm, node->node_index,
733                                       VIRTIO_TX_ERROR_TRUNC_PACKET, 1);
734                   break;
735                 }
736             }
737         }
738       id->flags = 0;
739       id->id = 0;
740       d->len = count * sizeof (vnet_virtio_vring_packed_desc_t);
741       flags = VRING_DESC_F_INDIRECT;
742     }
743   else
744     {
745       ASSERT (0);
746     }
747   if (vring->avail_wrap_counter)
748     {
749       flags |= VRING_DESC_F_AVAIL;
750       flags &= ~VRING_DESC_F_USED;
751     }
752   else
753     {
754       flags &= ~VRING_DESC_F_AVAIL;
755       flags |= VRING_DESC_F_USED;
756     }
757
758   d->id = next;
759   d->flags = flags;
760   vring->buffers[next] = bi;
761   n_added++;
762
763 done:
764   if (drop_inline != ~0)
765     virtio_interface_drop_inline (vm, vif, node->node_index, &bi, 1,
766                                   drop_inline);
767
768   return n_added;
769 }
770
771 static uword
772 virtio_interface_tx_packed_gso_inline (
773   vlib_main_t *vm, vlib_node_runtime_t *node, virtio_if_t *vif,
774   virtio_if_type_t type, vnet_virtio_vring_t *vring, u32 *buffers, u16 n_left,
775   const int do_gso, const int csum_offload)
776 {
777   int is_pci = (type == VIRTIO_IF_TYPE_PCI);
778   int is_tun = (type == VIRTIO_IF_TYPE_TUN);
779   int is_indirect =
780     ((vif->features & VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC)) != 0);
781   int is_any_layout =
782     ((vif->features & VIRTIO_FEATURE (VIRTIO_F_ANY_LAYOUT)) != 0);
783   const int hdr_sz = vif->virtio_net_hdr_sz;
784   u16 sz = vring->queue_size;
785   u16 used, next, n_buffers = 0, n_buffers_left = 0;
786   u16 n_vectors = n_left;
787
788
789   used = vring->desc_in_use;
790   next = vring->desc_next;
791
792   if (vif->packet_buffering)
793     {
794       n_buffers = n_buffers_left = virtio_vring_n_buffers (vring->buffering);
795
796       while (n_buffers_left && used < sz)
797         {
798           u16 n_added = 0;
799
800           u32 bi = virtio_vring_buffering_read_from_front (vring->buffering);
801           if (bi == ~0)
802             break;
803           n_added = add_buffer_to_slot_packed (
804             vm, node, vif, vring, bi, next, hdr_sz, do_gso, csum_offload,
805             is_pci, is_tun, is_indirect, is_any_layout);
806           n_buffers_left--;
807           if (PREDICT_FALSE (n_added == 0))
808             continue;
809
810           used++;
811           next++;
812           if (next >= sz)
813             {
814               next = 0;
815               vring->avail_wrap_counter ^= 1;
816             }
817         }
818       virtio_txq_clear_scheduled (vring);
819     }
820
821   while (n_left && used < sz)
822     {
823       u16 n_added = 0;
824
825       n_added = add_buffer_to_slot_packed (
826         vm, node, vif, vring, buffers[0], next, hdr_sz, do_gso, csum_offload,
827         is_pci, is_tun, is_indirect, is_any_layout);
828       buffers++;
829       n_left--;
830       if (PREDICT_FALSE (n_added == 0))
831         continue;
832
833       used++;
834       next++;
835       if (next >= sz)
836         {
837           next = 0;
838           vring->avail_wrap_counter ^= 1;
839         }
840     }
841
842   if (n_left != n_vectors || n_buffers != n_buffers_left)
843     {
844       CLIB_MEMORY_STORE_BARRIER ();
845       vring->desc_next = next;
846       vring->desc_in_use = used;
847       CLIB_MEMORY_BARRIER ();
848       if (vring->device_event->flags != VRING_EVENT_F_DISABLE)
849         virtio_kick (vm, vring, vif);
850     }
851
852   return n_left;
853 }
854
855 static void
856 virtio_find_free_desc (vnet_virtio_vring_t *vring, u16 size, u16 mask, u16 req,
857                        u16 next, u32 *first_free_desc_index,
858                        u16 *free_desc_count)
859 {
860   u16 start = 0;
861   /* next is used as hint: from where to start looking */
862   for (u16 i = 0; i < size; i++, next++)
863     {
864       if (vring->buffers[next & mask] == ~0)
865         {
866           if (*first_free_desc_index == ~0)
867             {
868               *first_free_desc_index = (next & mask);
869               start = i;
870               (*free_desc_count)++;
871               req--;
872               if (req == 0)
873                 break;
874             }
875           else
876             {
877               if (start + *free_desc_count == i)
878                 {
879                   (*free_desc_count)++;
880                   req--;
881                   if (req == 0)
882                     break;
883                 }
884               else
885                 break;
886             }
887         }
888     }
889 }
890
891 static u16
892 virtio_interface_tx_split_gso_inline (vlib_main_t *vm,
893                                       vlib_node_runtime_t *node,
894                                       virtio_if_t *vif, virtio_if_type_t type,
895                                       vnet_virtio_vring_t *vring, u32 *buffers,
896                                       u16 n_left, int do_gso, int csum_offload)
897 {
898   u16 used, next, avail, n_buffers = 0, n_buffers_left = 0;
899   int is_pci = (type == VIRTIO_IF_TYPE_PCI);
900   int is_tun = (type == VIRTIO_IF_TYPE_TUN);
901   int is_indirect =
902     ((vif->features & VIRTIO_FEATURE (VIRTIO_RING_F_INDIRECT_DESC)) != 0);
903   int is_any_layout =
904     ((vif->features & VIRTIO_FEATURE (VIRTIO_F_ANY_LAYOUT)) != 0);
905   u16 sz = vring->queue_size;
906   int hdr_sz = vif->virtio_net_hdr_sz;
907   u16 mask = sz - 1;
908   u16 n_vectors = n_left;
909
910   used = vring->desc_in_use;
911   next = vring->desc_next;
912   avail = vring->avail->idx;
913
914   u16 free_desc_count = 0;
915
916   if (PREDICT_FALSE (vring->flags & VRING_TX_OUT_OF_ORDER))
917     {
918       u32 first_free_desc_index = ~0;
919
920       virtio_find_free_desc (vring, sz, mask, n_left, next,
921                              &first_free_desc_index, &free_desc_count);
922
923       if (free_desc_count)
924         next = first_free_desc_index;
925     }
926   else
927     free_desc_count = sz - used;
928
929   if (vif->packet_buffering)
930     {
931       n_buffers = n_buffers_left = virtio_vring_n_buffers (vring->buffering);
932
933       while (n_buffers_left && free_desc_count)
934         {
935           u16 n_added = 0;
936
937           u32 bi = virtio_vring_buffering_read_from_front (vring->buffering);
938           if (bi == ~0)
939             break;
940
941           n_added = add_buffer_to_slot (vm, node, vif, vring, bi,
942                                         free_desc_count, avail, next, mask,
943                                         hdr_sz, do_gso, csum_offload, is_pci,
944                                         is_tun, is_indirect, is_any_layout);
945           if (PREDICT_FALSE (n_added == 0))
946             {
947               n_buffers_left--;
948               continue;
949             }
950           else if (PREDICT_FALSE (n_added > free_desc_count))
951             break;
952
953           avail++;
954           next = (next + n_added) & mask;
955           used += n_added;
956           n_buffers_left--;
957           free_desc_count -= n_added;
958         }
959       virtio_txq_clear_scheduled (vring);
960     }
961
962   while (n_left && free_desc_count)
963     {
964       u16 n_added = 0;
965
966       n_added =
967         add_buffer_to_slot (vm, node, vif, vring, buffers[0], free_desc_count,
968                             avail, next, mask, hdr_sz, do_gso, csum_offload,
969                             is_pci, is_tun, is_indirect, is_any_layout);
970
971       if (PREDICT_FALSE (n_added == 0))
972         {
973           buffers++;
974           n_left--;
975           continue;
976         }
977       else if (PREDICT_FALSE (n_added > free_desc_count))
978         break;
979
980       avail++;
981       next = (next + n_added) & mask;
982       used += n_added;
983       buffers++;
984       n_left--;
985       free_desc_count -= n_added;
986     }
987
988   if (n_left != n_vectors || n_buffers != n_buffers_left)
989     {
990       clib_atomic_store_seq_cst (&vring->avail->idx, avail);
991       vring->desc_next = next;
992       vring->desc_in_use = used;
993       if ((clib_atomic_load_seq_cst (&vring->used->flags) &
994            VRING_USED_F_NO_NOTIFY) == 0)
995         virtio_kick (vm, vring, vif);
996     }
997
998   return n_left;
999 }
1000
1001 static u16
1002 virtio_interface_tx_gso_inline (vlib_main_t *vm, vlib_node_runtime_t *node,
1003                                 virtio_if_t *vif, virtio_if_type_t type,
1004                                 vnet_virtio_vring_t *vring, u32 *buffers,
1005                                 u16 n_left, int packed, int do_gso,
1006                                 int csum_offload)
1007 {
1008   if (packed)
1009     return virtio_interface_tx_packed_gso_inline (vm, node, vif, type, vring,
1010                                                   buffers, n_left,
1011                                                   do_gso, csum_offload);
1012   else
1013     return virtio_interface_tx_split_gso_inline (vm, node, vif, type, vring,
1014                                                  buffers, n_left,
1015                                                  do_gso, csum_offload);
1016 }
1017
1018 static u16
1019 virtio_interface_tx_inline (vlib_main_t *vm, vlib_node_runtime_t *node,
1020                             virtio_if_t *vif, vnet_virtio_vring_t *vring,
1021                             virtio_if_type_t type, u32 *buffers, u16 n_left,
1022                             int packed)
1023 {
1024   vnet_main_t *vnm = vnet_get_main ();
1025   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, vif->hw_if_index);
1026
1027   if (hw->caps & VNET_HW_IF_CAP_TCP_GSO)
1028     return virtio_interface_tx_gso_inline (vm, node, vif, type, vring,
1029                                            buffers, n_left, packed,
1030                                            1 /* do_gso */ ,
1031                                            1 /* checksum offload */ );
1032   else if (hw->caps & VNET_HW_IF_CAP_L4_TX_CKSUM)
1033     return virtio_interface_tx_gso_inline (vm, node, vif, type, vring,
1034                                            buffers, n_left, packed,
1035                                            0 /* no do_gso */ ,
1036                                            1 /* checksum offload */ );
1037   else
1038     return virtio_interface_tx_gso_inline (vm, node, vif, type, vring,
1039                                            buffers, n_left, packed,
1040                                            0 /* no do_gso */ ,
1041                                            0 /* no checksum offload */ );
1042 }
1043
1044 VNET_DEVICE_CLASS_TX_FN (virtio_device_class) (vlib_main_t * vm,
1045                                                vlib_node_runtime_t * node,
1046                                                vlib_frame_t * frame)
1047 {
1048   virtio_main_t *nm = &virtio_main;
1049   vnet_interface_output_runtime_t *rund = (void *) node->runtime_data;
1050   virtio_if_t *vif = pool_elt_at_index (nm->interfaces, rund->dev_instance);
1051   vnet_hw_if_tx_frame_t *tf = vlib_frame_scalar_args (frame);
1052   u16 qid = tf->queue_id;
1053   vnet_virtio_vring_t *vring = vec_elt_at_index (vif->txq_vrings, qid);
1054   u16 n_left = frame->n_vectors;
1055   u32 *buffers = vlib_frame_vector_args (frame);
1056   u32 to[GRO_TO_VECTOR_SIZE (n_left)];
1057   int packed = vif->is_packed;
1058   u16 n_vectors = frame->n_vectors;
1059
1060   if (tf->shared_queue)
1061     clib_spinlock_lock (&vring->lockp);
1062
1063   if (vif->packet_coalesce)
1064     {
1065       n_vectors = n_left =
1066         vnet_gro_inline (vm, vring->flow_table, buffers, n_left, to);
1067       buffers = to;
1068       virtio_txq_clear_scheduled (vring);
1069     }
1070
1071   u16 retry_count = 2;
1072
1073 retry:
1074   /* free consumed buffers */
1075   virtio_free_used_device_desc (vm, vring, node->node_index, packed);
1076
1077   if (vif->type == VIRTIO_IF_TYPE_TAP)
1078     n_left = virtio_interface_tx_inline (vm, node, vif, vring,
1079                                          VIRTIO_IF_TYPE_TAP,
1080                                          &buffers[n_vectors - n_left],
1081                                          n_left, packed);
1082   else if (vif->type == VIRTIO_IF_TYPE_PCI)
1083     n_left = virtio_interface_tx_inline (vm, node, vif, vring,
1084                                          VIRTIO_IF_TYPE_PCI,
1085                                          &buffers[n_vectors - n_left],
1086                                          n_left, packed);
1087   else if (vif->type == VIRTIO_IF_TYPE_TUN)
1088     n_left = virtio_interface_tx_inline (vm, node, vif, vring,
1089                                          VIRTIO_IF_TYPE_TUN,
1090                                          &buffers[n_vectors - n_left],
1091                                          n_left, packed);
1092   else
1093     ASSERT (0);
1094
1095   if (n_left && retry_count--)
1096     goto retry;
1097
1098   if (vif->packet_buffering && n_left)
1099     {
1100       u16 n_buffered = virtio_vring_buffering_store_packets (vring->buffering,
1101                                                              &buffers
1102                                                              [n_vectors
1103                                                               - n_left],
1104                                                              n_left);
1105       n_left -= n_buffered;
1106     }
1107   if (n_left)
1108     virtio_interface_drop_inline (vm, vif, node->node_index,
1109                                   &buffers[n_vectors - n_left], n_left,
1110                                   VIRTIO_TX_ERROR_NO_FREE_SLOTS);
1111
1112   if (tf->shared_queue)
1113     clib_spinlock_unlock (&vring->lockp);
1114
1115   return frame->n_vectors - n_left;
1116 }
1117
1118 static void
1119 virtio_set_interface_next_node (vnet_main_t * vnm, u32 hw_if_index,
1120                                 u32 node_index)
1121 {
1122   virtio_main_t *apm = &virtio_main;
1123   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
1124   virtio_if_t *vif = pool_elt_at_index (apm->interfaces, hw->dev_instance);
1125
1126   /* Shut off redirection */
1127   if (node_index == ~0)
1128     {
1129       vif->per_interface_next_index = node_index;
1130       return;
1131     }
1132
1133   vif->per_interface_next_index =
1134     vlib_node_add_next (vlib_get_main (), virtio_input_node.index,
1135                         node_index);
1136 }
1137
1138 static void
1139 virtio_clear_hw_interface_counters (u32 instance)
1140 {
1141   /* Nothing for now */
1142 }
1143
1144 static void
1145 virtio_set_rx_interrupt (virtio_if_t *vif, vnet_virtio_vring_t *vring)
1146 {
1147   if (vif->is_packed)
1148     vring->driver_event->flags &= ~VRING_EVENT_F_DISABLE;
1149   else
1150     vring->avail->flags &= ~VRING_AVAIL_F_NO_INTERRUPT;
1151 }
1152
1153 static void
1154 virtio_set_rx_polling (virtio_if_t *vif, vnet_virtio_vring_t *vring)
1155 {
1156   if (vif->is_packed)
1157     vring->driver_event->flags |= VRING_EVENT_F_DISABLE;
1158   else
1159     vring->avail->flags |= VRING_AVAIL_F_NO_INTERRUPT;
1160 }
1161
1162 static clib_error_t *
1163 virtio_interface_rx_mode_change (vnet_main_t * vnm, u32 hw_if_index, u32 qid,
1164                                  vnet_hw_if_rx_mode mode)
1165 {
1166   virtio_main_t *mm = &virtio_main;
1167   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
1168   virtio_if_t *vif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
1169   vnet_virtio_vring_t *rx_vring = vec_elt_at_index (vif->rxq_vrings, qid);
1170
1171   if (vif->type == VIRTIO_IF_TYPE_PCI && !(vif->support_int_mode))
1172     {
1173       virtio_set_rx_polling (vif, rx_vring);
1174       return clib_error_return (0, "interrupt mode is not supported");
1175     }
1176
1177   if (mode == VNET_HW_IF_RX_MODE_POLLING)
1178       virtio_set_rx_polling (vif, rx_vring);
1179   else
1180       virtio_set_rx_interrupt (vif, rx_vring);
1181
1182   rx_vring->mode = mode;
1183
1184   return 0;
1185 }
1186
1187 static clib_error_t *
1188 virtio_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
1189 {
1190   virtio_main_t *mm = &virtio_main;
1191   vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
1192   virtio_if_t *vif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
1193
1194   if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
1195     {
1196       vif->flags |= VIRTIO_IF_FLAG_ADMIN_UP;
1197       vnet_hw_interface_set_flags (vnm, vif->hw_if_index,
1198                                    VNET_HW_INTERFACE_FLAG_LINK_UP);
1199     }
1200   else
1201     {
1202       vif->flags &= ~VIRTIO_IF_FLAG_ADMIN_UP;
1203       vnet_hw_interface_set_flags (vnm, vif->hw_if_index, 0);
1204     }
1205   return 0;
1206 }
1207
1208 static clib_error_t *
1209 virtio_subif_add_del_function (vnet_main_t * vnm,
1210                                u32 hw_if_index,
1211                                struct vnet_sw_interface_t *st, int is_add)
1212 {
1213   /* Nothing for now */
1214   return 0;
1215 }
1216
1217 /* *INDENT-OFF* */
1218 VNET_DEVICE_CLASS (virtio_device_class) = {
1219   .name = "virtio",
1220   .format_device_name = format_virtio_device_name,
1221   .format_device = format_virtio_device,
1222   .format_tx_trace = format_virtio_tx_trace,
1223   .tx_function_n_errors = VIRTIO_TX_N_ERROR,
1224   .tx_function_error_strings = virtio_tx_func_error_strings,
1225   .rx_redirect_to_node = virtio_set_interface_next_node,
1226   .clear_counters = virtio_clear_hw_interface_counters,
1227   .admin_up_down_function = virtio_interface_admin_up_down,
1228   .subif_add_del_function = virtio_subif_add_del_function,
1229   .rx_mode_change_function = virtio_interface_rx_mode_change,
1230 };
1231
1232 /* *INDENT-ON* */
1233
1234 /*
1235  * fd.io coding-style-patch-verification: ON
1236  *
1237  * Local Variables:
1238  * eval: (c-set-style "gnu")
1239  * End:
1240  */