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