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