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