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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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 *------------------------------------------------------------------
18 #include <sys/types.h>
22 #include <linux/if_tun.h>
23 #include <sys/ioctl.h>
24 #include <sys/eventfd.h>
26 #include <vlib/vlib.h>
27 #include <vlib/unix/unix.h>
28 #include <vnet/ethernet/ethernet.h>
29 #include <vnet/feature/feature.h>
30 #include <vnet/gso/gro_func.h>
31 #include <vnet/interface/rx_queue_funcs.h>
32 #include <vnet/ip/ip4_packet.h>
33 #include <vnet/ip/ip6_packet.h>
34 #include <vnet/udp/udp_packet.h>
35 #include <vnet/devices/virtio/virtio.h>
37 #define foreach_virtio_input_error \
38 _(BUFFER_ALLOC, "buffer alloc error") \
43 #define _(f,s) VIRTIO_INPUT_ERROR_##f,
44 foreach_virtio_input_error
47 } virtio_input_error_t;
49 static char *virtio_input_error_strings[] = {
51 foreach_virtio_input_error
61 virtio_net_hdr_v1_t hdr;
62 } virtio_input_trace_t;
65 format_virtio_input_trace (u8 * s, va_list * args)
67 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
68 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
69 virtio_input_trace_t *t = va_arg (*args, virtio_input_trace_t *);
70 u32 indent = format_get_indent (s);
72 s = format (s, "virtio: hw_if_index %d next-index %d vring %u len %u",
73 t->hw_if_index, t->next_index, t->ring, t->len);
74 s = format (s, "\n%Uhdr: flags 0x%02x gso_type 0x%02x hdr_len %u "
75 "gso_size %u csum_start %u csum_offset %u num_buffers %u",
76 format_white_space, indent + 2,
77 t->hdr.flags, t->hdr.gso_type, t->hdr.hdr_len, t->hdr.gso_size,
78 t->hdr.csum_start, t->hdr.csum_offset, t->hdr.num_buffers);
82 static_always_inline void
83 virtio_refill_vring_split (vlib_main_t * vm, virtio_if_t * vif,
84 virtio_if_type_t type, virtio_vring_t * vring,
85 const int hdr_sz, u32 node_index)
87 u16 used, next, avail, n_slots, n_refill;
92 used = vring->desc_in_use;
94 if (sz - used < sz / 8)
97 /* deliver free buffers in chunks of 64 */
98 n_refill = clib_min (sz - used, 64);
100 next = vring->desc_next;
101 avail = vring->avail->idx;
103 vlib_buffer_alloc_to_ring_from_pool (vm, vring->buffers, next,
104 vring->size, n_refill,
105 vring->buffer_pool_index);
107 if (PREDICT_FALSE (n_slots != n_refill))
109 vlib_error_count (vm, node_index,
110 VIRTIO_INPUT_ERROR_BUFFER_ALLOC, n_refill - n_slots);
117 vring_desc_t *d = &vring->desc[next];;
118 vlib_buffer_t *b = vlib_get_buffer (vm, vring->buffers[next]);
120 * current_data may not be initialized with 0 and may contain
121 * previous offset. Here we want to make sure, it should be 0
124 b->current_data = -hdr_sz;
125 clib_memset (vlib_buffer_get_current (b), 0, hdr_sz);
127 ((type == VIRTIO_IF_TYPE_PCI) ? vlib_buffer_get_current_pa (vm,
129 pointer_to_uword (vlib_buffer_get_current (b)));
130 d->len = vlib_buffer_get_default_data_size (vm) + hdr_sz;
131 d->flags = VRING_DESC_F_WRITE;
132 vring->avail->ring[avail & mask] = next;
134 next = (next + 1) & mask;
138 clib_atomic_store_seq_cst (&vring->avail->idx, avail);
139 vring->desc_next = next;
140 vring->desc_in_use = used;
141 if ((clib_atomic_load_seq_cst (&vring->used->flags) &
142 VRING_USED_F_NO_NOTIFY) == 0)
144 virtio_kick (vm, vring, vif);
149 static_always_inline void
150 virtio_refill_vring_packed (vlib_main_t * vm, virtio_if_t * vif,
151 virtio_if_type_t type, virtio_vring_t * vring,
152 const int hdr_sz, u32 node_index)
154 u16 used, next, n_slots, n_refill, flags = 0, first_desc_flags;
155 u16 sz = vring->size;
158 used = vring->desc_in_use;
163 /* deliver free buffers in chunks of 64 */
164 n_refill = clib_min (sz - used, 64);
166 next = vring->desc_next;
167 first_desc_flags = vring->packed_desc[next].flags;
169 vlib_buffer_alloc_to_ring_from_pool (vm, vring->buffers, next,
171 vring->buffer_pool_index);
173 if (PREDICT_FALSE (n_slots != n_refill))
175 vlib_error_count (vm, node_index,
176 VIRTIO_INPUT_ERROR_BUFFER_ALLOC, n_refill - n_slots);
183 vring_packed_desc_t *d = &vring->packed_desc[next];
184 vlib_buffer_t *b = vlib_get_buffer (vm, vring->buffers[next]);
186 * current_data may not be initialized with 0 and may contain
187 * previous offset. Here we want to make sure, it should be 0
190 b->current_data = -hdr_sz;
191 clib_memset (vlib_buffer_get_current (b), 0, hdr_sz);
193 ((type == VIRTIO_IF_TYPE_PCI) ? vlib_buffer_get_current_pa (vm,
195 pointer_to_uword (vlib_buffer_get_current (b)));
196 d->len = vlib_buffer_get_default_data_size (vm) + hdr_sz;
198 if (vring->avail_wrap_counter)
199 flags = (VRING_DESC_F_AVAIL | VRING_DESC_F_WRITE);
201 flags = (VRING_DESC_F_USED | VRING_DESC_F_WRITE);
204 if (vring->desc_next == next)
205 first_desc_flags = flags;
213 vring->avail_wrap_counter ^= 1;
218 CLIB_MEMORY_STORE_BARRIER ();
219 vring->packed_desc[vring->desc_next].flags = first_desc_flags;
220 vring->desc_next = next;
221 vring->desc_in_use = used;
222 CLIB_MEMORY_BARRIER ();
223 if (vring->device_event->flags != VRING_EVENT_F_DISABLE)
225 virtio_kick (vm, vring, vif);
231 static_always_inline void
232 virtio_needs_csum (vlib_buffer_t * b0, virtio_net_hdr_v1_t * hdr,
233 u8 * l4_proto, u8 * l4_hdr_sz, virtio_if_type_t type)
235 if (hdr->flags & VIRTIO_NET_HDR_F_NEEDS_CSUM)
237 u16 ethertype = 0, l2hdr_sz = 0;
240 if (type == VIRTIO_IF_TYPE_TUN)
242 switch (b0->data[0] & 0xf0)
245 ethertype = ETHERNET_TYPE_IP4;
248 ethertype = ETHERNET_TYPE_IP6;
254 ethernet_header_t *eh =
255 (ethernet_header_t *) vlib_buffer_get_current (b0);
256 ethertype = clib_net_to_host_u16 (eh->type);
257 l2hdr_sz = sizeof (ethernet_header_t);
259 if (ethernet_frame_is_tagged (ethertype))
261 ethernet_vlan_header_t *vlan =
262 (ethernet_vlan_header_t *) (eh + 1);
264 ethertype = clib_net_to_host_u16 (vlan->type);
265 l2hdr_sz += sizeof (*vlan);
266 if (ethertype == ETHERNET_TYPE_VLAN)
269 ethertype = clib_net_to_host_u16 (vlan->type);
270 l2hdr_sz += sizeof (*vlan);
275 vnet_buffer (b0)->l2_hdr_offset = 0;
276 vnet_buffer (b0)->l3_hdr_offset = l2hdr_sz;
278 if (PREDICT_TRUE (ethertype == ETHERNET_TYPE_IP4))
281 (ip4_header_t *) (vlib_buffer_get_current (b0) + l2hdr_sz);
282 vnet_buffer (b0)->l4_hdr_offset = l2hdr_sz + ip4_header_bytes (ip4);
283 *l4_proto = ip4->protocol;
284 oflags |= VNET_BUFFER_OFFLOAD_F_IP_CKSUM;
286 (VNET_BUFFER_F_IS_IP4 | VNET_BUFFER_F_L2_HDR_OFFSET_VALID |
287 VNET_BUFFER_F_L3_HDR_OFFSET_VALID |
288 VNET_BUFFER_F_L4_HDR_OFFSET_VALID);
290 else if (PREDICT_TRUE (ethertype == ETHERNET_TYPE_IP6))
293 (ip6_header_t *) (vlib_buffer_get_current (b0) + l2hdr_sz);
294 vnet_buffer (b0)->l4_hdr_offset = l2hdr_sz + sizeof (ip6_header_t);
295 /* FIXME IPv6 EH traversal */
296 *l4_proto = ip6->protocol;
297 b0->flags |= (VNET_BUFFER_F_IS_IP6 |
298 VNET_BUFFER_F_L2_HDR_OFFSET_VALID
299 | VNET_BUFFER_F_L3_HDR_OFFSET_VALID |
300 VNET_BUFFER_F_L4_HDR_OFFSET_VALID);
302 if (*l4_proto == IP_PROTOCOL_TCP)
304 oflags |= VNET_BUFFER_OFFLOAD_F_TCP_CKSUM;
305 tcp_header_t *tcp = (tcp_header_t *) (vlib_buffer_get_current (b0) +
307 (b0)->l4_hdr_offset);
308 *l4_hdr_sz = tcp_header_bytes (tcp);
310 else if (*l4_proto == IP_PROTOCOL_UDP)
312 oflags |= VNET_BUFFER_OFFLOAD_F_UDP_CKSUM;
313 udp_header_t *udp = (udp_header_t *) (vlib_buffer_get_current (b0) +
315 (b0)->l4_hdr_offset);
316 *l4_hdr_sz = sizeof (*udp);
319 vnet_buffer_offload_flags_set (b0, oflags);
323 static_always_inline void
324 fill_gso_buffer_flags (vlib_buffer_t * b0, virtio_net_hdr_v1_t * hdr,
325 u8 l4_proto, u8 l4_hdr_sz)
327 if (hdr->gso_type == VIRTIO_NET_HDR_GSO_TCPV4)
329 ASSERT (hdr->flags & VIRTIO_NET_HDR_F_NEEDS_CSUM);
330 vnet_buffer2 (b0)->gso_size = hdr->gso_size;
331 vnet_buffer2 (b0)->gso_l4_hdr_sz = l4_hdr_sz;
332 b0->flags |= VNET_BUFFER_F_GSO | VNET_BUFFER_F_IS_IP4;
334 if (hdr->gso_type == VIRTIO_NET_HDR_GSO_TCPV6)
336 ASSERT (hdr->flags & VIRTIO_NET_HDR_F_NEEDS_CSUM);
337 vnet_buffer2 (b0)->gso_size = hdr->gso_size;
338 vnet_buffer2 (b0)->gso_l4_hdr_sz = l4_hdr_sz;
339 b0->flags |= VNET_BUFFER_F_GSO | VNET_BUFFER_F_IS_IP6;
343 static_always_inline u16
344 virtio_n_left_to_process (virtio_vring_t * vring, const int packed)
347 return vring->desc_in_use;
349 return vring->used->idx - vring->last_used_idx;
352 static_always_inline u16
353 virtio_get_slot_id (virtio_vring_t * vring, const int packed, u16 last,
357 return vring->packed_desc[last].id;
359 return vring->used->ring[last & mask].id;
362 static_always_inline u16
363 virtio_get_len (virtio_vring_t * vring, const int packed, const int hdr_sz,
367 return vring->packed_desc[last].len - hdr_sz;
369 return vring->used->ring[last & mask].len - hdr_sz;
372 #define increment_last(last, packed, vring) \
375 if (packed && last >= vring->size) \
378 vring->used_wrap_counter ^= 1; \
382 static_always_inline uword
383 virtio_device_input_gso_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
384 vlib_frame_t * frame, virtio_if_t * vif,
385 virtio_vring_t * vring, virtio_if_type_t type,
386 int gso_enabled, int checksum_offload_enabled,
389 vnet_main_t *vnm = vnet_get_main ();
390 u32 thread_index = vm->thread_index;
391 uword n_trace = vlib_get_trace_count (vm, node);
393 const int hdr_sz = vif->virtio_net_hdr_sz;
395 u32 n_rx_packets = 0;
397 u16 mask = vring->size - 1;
398 u16 last = vring->last_used_idx;
399 u16 n_left = virtio_n_left_to_process (vring, packed);
405 if (type == VIRTIO_IF_TYPE_TUN)
407 next_index = VNET_DEVICE_INPUT_NEXT_IP4_INPUT;
411 next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
412 if (PREDICT_FALSE (vif->per_interface_next_index != ~0))
413 next_index = vif->per_interface_next_index;
415 /* only for l2, redirect if feature path enabled */
416 vnet_feature_start_device_input_x1 (vif->sw_if_index, &next_index, &bt);
422 u32 next0 = next_index;
424 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
426 while (n_left && n_left_to_next)
430 vring_packed_desc_t *d = &vring->packed_desc[last];
431 u16 flags = d->flags;
432 if ((flags & VRING_DESC_F_AVAIL) !=
433 (vring->used_wrap_counter << 7)
434 || (flags & VRING_DESC_F_USED) !=
435 (vring->used_wrap_counter << 15))
441 u8 l4_proto = 0, l4_hdr_sz = 0;
443 virtio_net_hdr_v1_t *hdr;
444 u16 slot = virtio_get_slot_id (vring, packed, last, mask);
445 u16 len = virtio_get_len (vring, packed, hdr_sz, last, mask);
446 u32 bi0 = vring->buffers[slot];
447 vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
448 hdr = vlib_buffer_get_current (b0);
449 if (hdr_sz == sizeof (virtio_net_hdr_v1_t))
450 num_buffers = hdr->num_buffers;
452 b0->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID;
453 b0->current_data = 0;
454 b0->current_length = len;
456 if (checksum_offload_enabled)
457 virtio_needs_csum (b0, hdr, &l4_proto, &l4_hdr_sz, type);
460 fill_gso_buffer_flags (b0, hdr, l4_proto, l4_hdr_sz);
462 vnet_buffer (b0)->sw_if_index[VLIB_RX] = vif->sw_if_index;
463 vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32) ~ 0;
465 /* if multisegment packet */
466 if (PREDICT_FALSE (num_buffers > 1))
468 vlib_buffer_t *pb, *cb;
470 b0->total_length_not_including_first_buffer = 0;
471 while (num_buffers > 1)
473 increment_last (last, packed, vring);
474 u16 cslot = virtio_get_slot_id (vring, packed, last, mask);
475 /* hdr size is 0 after 1st packet in chain buffers */
476 u16 clen = virtio_get_len (vring, packed, 0, last, mask);
477 u32 cbi = vring->buffers[cslot];
478 cb = vlib_get_buffer (vm, cbi);
481 cb->current_length = clen;
483 /* previous buffer */
484 pb->next_buffer = cbi;
485 pb->flags |= VLIB_BUFFER_NEXT_PRESENT;
488 b0->total_length_not_including_first_buffer += clen;
491 vring->desc_in_use--;
495 len += b0->total_length_not_including_first_buffer;
498 if (type == VIRTIO_IF_TYPE_TUN)
500 switch (b0->data[0] & 0xf0)
503 next0 = VNET_DEVICE_INPUT_NEXT_IP4_INPUT;
506 next0 = VNET_DEVICE_INPUT_NEXT_IP6_INPUT;
509 next0 = VNET_DEVICE_INPUT_NEXT_DROP;
513 if (PREDICT_FALSE (vif->per_interface_next_index != ~0))
514 next0 = vif->per_interface_next_index;
518 /* copy feature arc data from template */
519 b0->current_config_index = bt.current_config_index;
520 vnet_buffer (b0)->feature_arc_index =
521 vnet_buffer (&bt)->feature_arc_index;
525 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
527 if (PREDICT_FALSE (n_trace > 0 && vlib_trace_buffer (vm, node, next0, b0, /* follow_chain */
530 virtio_input_trace_t *tr;
531 vlib_set_trace_count (vm, node, --n_trace);
532 tr = vlib_add_trace (vm, node, b0, sizeof (*tr));
533 tr->next_index = next0;
534 tr->hw_if_index = vif->hw_if_index;
536 clib_memcpy_fast (&tr->hdr, hdr, hdr_sz);
541 vring->desc_in_use--;
545 increment_last (last, packed, vring);
547 /* only tun interfaces may have different next index */
548 if (type == VIRTIO_IF_TYPE_TUN)
549 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
550 n_left_to_next, bi0, next0);
556 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
558 vring->last_used_idx = last;
560 vlib_increment_combined_counter (vnm->interface_main.combined_sw_if_counters
561 + VNET_INTERFACE_COUNTER_RX, thread_index,
562 vif->sw_if_index, n_rx_packets,
568 static_always_inline uword
569 virtio_device_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
570 vlib_frame_t * frame, virtio_if_t * vif, u16 qid,
571 virtio_if_type_t type)
573 virtio_vring_t *vring = vec_elt_at_index (vif->rxq_vrings, qid);
574 const int hdr_sz = vif->virtio_net_hdr_sz;
575 u16 txq_id = vm->thread_index % vif->num_txqs;
576 virtio_vring_t *txq_vring = vec_elt_at_index (vif->txq_vrings, txq_id);
579 if (clib_spinlock_trylock_if_init (&txq_vring->lockp))
581 if (vif->packet_coalesce)
582 vnet_gro_flow_table_schedule_node_on_dispatcher
583 (vm, txq_vring->flow_table);
584 else if (vif->packet_buffering)
585 virtio_vring_buffering_schedule_node_on_dispatcher
586 (vm, txq_vring->buffering);
587 clib_spinlock_unlock_if_init (&txq_vring->lockp);
592 if (vif->gso_enabled)
594 virtio_device_input_gso_inline (vm, node, frame, vif, vring, type,
596 else if (vif->csum_offload_enabled)
598 virtio_device_input_gso_inline (vm, node, frame, vif, vring, type,
602 virtio_device_input_gso_inline (vm, node, frame, vif, vring, type,
605 virtio_refill_vring_packed (vm, vif, type, vring, hdr_sz,
610 if (vif->gso_enabled)
612 virtio_device_input_gso_inline (vm, node, frame, vif, vring, type,
614 else if (vif->csum_offload_enabled)
616 virtio_device_input_gso_inline (vm, node, frame, vif, vring, type,
620 virtio_device_input_gso_inline (vm, node, frame, vif, vring, type,
623 virtio_refill_vring_split (vm, vif, type, vring, hdr_sz,
629 VLIB_NODE_FN (virtio_input_node) (vlib_main_t * vm,
630 vlib_node_runtime_t * node,
631 vlib_frame_t * frame)
634 virtio_main_t *vim = &virtio_main;
635 vnet_hw_if_rxq_poll_vector_t *p,
636 *pv = vnet_hw_if_get_rxq_poll_vector (vm, node);
641 vif = vec_elt_at_index (vim->interfaces, p->dev_instance);
642 if (vif->flags & VIRTIO_IF_FLAG_ADMIN_UP)
644 if (vif->type == VIRTIO_IF_TYPE_TAP)
645 n_rx += virtio_device_input_inline (
646 vm, node, frame, vif, p->queue_id, VIRTIO_IF_TYPE_TAP);
647 else if (vif->type == VIRTIO_IF_TYPE_PCI)
648 n_rx += virtio_device_input_inline (
649 vm, node, frame, vif, p->queue_id, VIRTIO_IF_TYPE_PCI);
650 else if (vif->type == VIRTIO_IF_TYPE_TUN)
651 n_rx += virtio_device_input_inline (
652 vm, node, frame, vif, p->queue_id, VIRTIO_IF_TYPE_TUN);
660 VLIB_REGISTER_NODE (virtio_input_node) = {
661 .name = "virtio-input",
662 .sibling_of = "device-input",
663 .format_trace = format_virtio_input_trace,
664 .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
665 .type = VLIB_NODE_TYPE_INPUT,
666 .state = VLIB_NODE_STATE_INTERRUPT,
667 .n_errors = VIRTIO_INPUT_N_ERROR,
668 .error_strings = virtio_input_error_strings,
673 * fd.io coding-style-patch-verification: ON
676 * eval: (c-set-style "gnu")