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/devices/devices.h>
30 #include <vnet/feature/feature.h>
31 #include <vnet/gso/gro_func.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>
38 #define foreach_virtio_input_error \
39 _(BUFFER_ALLOC, "buffer alloc error") \
44 #define _(f,s) VIRTIO_INPUT_ERROR_##f,
45 foreach_virtio_input_error
48 } virtio_input_error_t;
50 static char *virtio_input_error_strings[] = {
52 foreach_virtio_input_error
62 virtio_net_hdr_v1_t hdr;
63 } virtio_input_trace_t;
66 format_virtio_input_trace (u8 * s, va_list * args)
68 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
69 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
70 virtio_input_trace_t *t = va_arg (*args, virtio_input_trace_t *);
71 u32 indent = format_get_indent (s);
73 s = format (s, "virtio: hw_if_index %d next-index %d vring %u len %u",
74 t->hw_if_index, t->next_index, t->ring, t->len);
75 s = format (s, "\n%Uhdr: flags 0x%02x gso_type 0x%02x hdr_len %u "
76 "gso_size %u csum_start %u csum_offset %u num_buffers %u",
77 format_white_space, indent + 2,
78 t->hdr.flags, t->hdr.gso_type, t->hdr.hdr_len, t->hdr.gso_size,
79 t->hdr.csum_start, t->hdr.csum_offset, t->hdr.num_buffers);
83 static_always_inline void
84 virtio_refill_vring (vlib_main_t * vm, virtio_if_t * vif,
85 virtio_if_type_t type, virtio_vring_t * vring,
86 const int hdr_sz, u32 node_index)
88 u16 used, next, avail, n_slots, n_refill;
93 used = vring->desc_in_use;
95 if (sz - used < sz / 8)
98 /* deliver free buffers in chunks of 64 */
99 n_refill = clib_min (sz - used, 64);
101 next = vring->desc_next;
102 avail = vring->avail->idx;
104 vlib_buffer_alloc_to_ring_from_pool (vm, vring->buffers, next,
105 vring->size, n_refill,
106 vring->buffer_pool_index);
108 if (PREDICT_FALSE (n_slots != n_refill))
110 vlib_error_count (vm, node_index,
111 VIRTIO_INPUT_ERROR_BUFFER_ALLOC, n_refill - n_slots);
118 vring_desc_t *d = &vring->desc[next];;
119 vlib_buffer_t *b = vlib_get_buffer (vm, vring->buffers[next]);
121 * current_data may not be initialized with 0 and may contain
122 * previous offset. Here we want to make sure, it should be 0
125 b->current_data = -hdr_sz;
126 memset (vlib_buffer_get_current (b), 0, hdr_sz);
128 ((type == VIRTIO_IF_TYPE_PCI) ? vlib_buffer_get_current_pa (vm,
130 pointer_to_uword (vlib_buffer_get_current (b)));
131 d->len = vlib_buffer_get_default_data_size (vm) + hdr_sz;
132 d->flags = VRING_DESC_F_WRITE;
133 vring->avail->ring[avail & mask] = next;
135 next = (next + 1) & mask;
139 CLIB_MEMORY_STORE_BARRIER ();
140 vring->avail->idx = avail;
141 vring->desc_next = next;
142 vring->desc_in_use = used;
144 if ((vring->used->flags & VRING_USED_F_NO_NOTIFY) == 0)
146 virtio_kick (vm, vring, vif);
151 static_always_inline void
152 virtio_needs_csum (vlib_buffer_t * b0, virtio_net_hdr_v1_t * hdr,
153 u8 * l4_proto, u8 * l4_hdr_sz, virtio_if_type_t type)
155 if (hdr->flags & VIRTIO_NET_HDR_F_NEEDS_CSUM)
157 u16 ethertype = 0, l2hdr_sz = 0;
159 if (type == VIRTIO_IF_TYPE_TUN)
161 switch (b0->data[0] & 0xf0)
164 ethertype = ETHERNET_TYPE_IP4;
167 ethertype = ETHERNET_TYPE_IP6;
173 ethernet_header_t *eh =
174 (ethernet_header_t *) vlib_buffer_get_current (b0);
175 ethertype = clib_net_to_host_u16 (eh->type);
176 l2hdr_sz = sizeof (ethernet_header_t);
178 if (ethernet_frame_is_tagged (ethertype))
180 ethernet_vlan_header_t *vlan =
181 (ethernet_vlan_header_t *) (eh + 1);
183 ethertype = clib_net_to_host_u16 (vlan->type);
184 l2hdr_sz += sizeof (*vlan);
185 if (ethertype == ETHERNET_TYPE_VLAN)
188 ethertype = clib_net_to_host_u16 (vlan->type);
189 l2hdr_sz += sizeof (*vlan);
194 vnet_buffer (b0)->l2_hdr_offset = 0;
195 vnet_buffer (b0)->l3_hdr_offset = l2hdr_sz;
197 if (PREDICT_TRUE (ethertype == ETHERNET_TYPE_IP4))
200 (ip4_header_t *) (vlib_buffer_get_current (b0) + l2hdr_sz);
201 vnet_buffer (b0)->l4_hdr_offset = l2hdr_sz + ip4_header_bytes (ip4);
202 *l4_proto = ip4->protocol;
204 (VNET_BUFFER_F_IS_IP4 | VNET_BUFFER_F_OFFLOAD_IP_CKSUM);
206 (VNET_BUFFER_F_L2_HDR_OFFSET_VALID
207 | VNET_BUFFER_F_L3_HDR_OFFSET_VALID |
208 VNET_BUFFER_F_L4_HDR_OFFSET_VALID);
210 else if (PREDICT_TRUE (ethertype == ETHERNET_TYPE_IP6))
213 (ip6_header_t *) (vlib_buffer_get_current (b0) + l2hdr_sz);
214 vnet_buffer (b0)->l4_hdr_offset = l2hdr_sz + sizeof (ip6_header_t);
215 /* FIXME IPv6 EH traversal */
216 *l4_proto = ip6->protocol;
217 b0->flags |= (VNET_BUFFER_F_IS_IP6 |
218 VNET_BUFFER_F_L2_HDR_OFFSET_VALID
219 | VNET_BUFFER_F_L3_HDR_OFFSET_VALID |
220 VNET_BUFFER_F_L4_HDR_OFFSET_VALID);
222 if (*l4_proto == IP_PROTOCOL_TCP)
224 b0->flags |= VNET_BUFFER_F_OFFLOAD_TCP_CKSUM;
225 tcp_header_t *tcp = (tcp_header_t *) (vlib_buffer_get_current (b0) +
227 (b0)->l4_hdr_offset);
228 *l4_hdr_sz = tcp_header_bytes (tcp);
230 else if (*l4_proto == IP_PROTOCOL_UDP)
232 b0->flags |= VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
233 udp_header_t *udp = (udp_header_t *) (vlib_buffer_get_current (b0) +
235 (b0)->l4_hdr_offset);
236 *l4_hdr_sz = sizeof (*udp);
241 static_always_inline void
242 fill_gso_buffer_flags (vlib_buffer_t * b0, virtio_net_hdr_v1_t * hdr,
243 u8 l4_proto, u8 l4_hdr_sz)
245 if (hdr->gso_type == VIRTIO_NET_HDR_GSO_TCPV4)
247 ASSERT (hdr->flags & VIRTIO_NET_HDR_F_NEEDS_CSUM);
248 vnet_buffer2 (b0)->gso_size = hdr->gso_size;
249 vnet_buffer2 (b0)->gso_l4_hdr_sz = l4_hdr_sz;
250 b0->flags |= VNET_BUFFER_F_GSO | VNET_BUFFER_F_IS_IP4;
252 if (hdr->gso_type == VIRTIO_NET_HDR_GSO_TCPV6)
254 ASSERT (hdr->flags & VIRTIO_NET_HDR_F_NEEDS_CSUM);
255 vnet_buffer2 (b0)->gso_size = hdr->gso_size;
256 vnet_buffer2 (b0)->gso_l4_hdr_sz = l4_hdr_sz;
257 b0->flags |= VNET_BUFFER_F_GSO | VNET_BUFFER_F_IS_IP6;
261 static_always_inline uword
262 virtio_device_input_gso_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
263 vlib_frame_t * frame, virtio_if_t * vif,
264 virtio_vring_t * vring, virtio_if_type_t type,
265 int gso_enabled, int checksum_offload_enabled)
267 vnet_main_t *vnm = vnet_get_main ();
268 u32 thread_index = vm->thread_index;
269 uword n_trace = vlib_get_trace_count (vm, node);
271 const int hdr_sz = vif->virtio_net_hdr_sz;
273 u32 n_rx_packets = 0;
275 u16 mask = vring->size - 1;
276 u16 last = vring->last_used_idx;
277 u16 n_left = vring->used->idx - last;
283 if (type == VIRTIO_IF_TYPE_TUN)
285 next_index = VNET_DEVICE_INPUT_NEXT_IP4_INPUT;
289 next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
290 if (PREDICT_FALSE (vif->per_interface_next_index != ~0))
291 next_index = vif->per_interface_next_index;
293 /* only for l2, redirect if feature path enabled */
294 vnet_feature_start_device_input_x1 (vif->sw_if_index, &next_index, &bt);
300 u32 next0 = next_index;
302 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
304 while (n_left && n_left_to_next)
306 u8 l4_proto = 0, l4_hdr_sz = 0;
308 vring_used_elem_t *e = &vring->used->ring[last & mask];
309 virtio_net_hdr_v1_t *hdr;
311 u16 len = e->len - hdr_sz;
312 u32 bi0 = vring->buffers[slot];
313 vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
314 hdr = vlib_buffer_get_current (b0);
315 if (hdr_sz == sizeof (virtio_net_hdr_v1_t))
316 num_buffers = hdr->num_buffers;
318 b0->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID;
319 b0->current_data = 0;
320 b0->current_length = len;
322 if (checksum_offload_enabled)
323 virtio_needs_csum (b0, hdr, &l4_proto, &l4_hdr_sz, type);
326 fill_gso_buffer_flags (b0, hdr, l4_proto, l4_hdr_sz);
328 vnet_buffer (b0)->sw_if_index[VLIB_RX] = vif->sw_if_index;
329 vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32) ~ 0;
331 /* if multisegment packet */
332 if (PREDICT_FALSE (num_buffers > 1))
334 vlib_buffer_t *pb, *cb;
336 b0->total_length_not_including_first_buffer = 0;
337 while (num_buffers > 1)
340 e = &vring->used->ring[last & mask];
341 u32 cbi = vring->buffers[e->id];
342 cb = vlib_get_buffer (vm, cbi);
345 cb->current_length = e->len;
347 /* previous buffer */
348 pb->next_buffer = cbi;
349 pb->flags |= VLIB_BUFFER_NEXT_PRESENT;
352 b0->total_length_not_including_first_buffer += e->len;
355 vring->desc_in_use--;
359 len += b0->total_length_not_including_first_buffer;
362 if (type == VIRTIO_IF_TYPE_TUN)
364 switch (b0->data[0] & 0xf0)
367 next0 = VNET_DEVICE_INPUT_NEXT_IP4_INPUT;
370 next0 = VNET_DEVICE_INPUT_NEXT_IP6_INPUT;
373 next0 = VNET_DEVICE_INPUT_NEXT_DROP;
377 if (PREDICT_FALSE (vif->per_interface_next_index != ~0))
378 next0 = vif->per_interface_next_index;
382 /* copy feature arc data from template */
383 b0->current_config_index = bt.current_config_index;
384 vnet_buffer (b0)->feature_arc_index =
385 vnet_buffer (&bt)->feature_arc_index;
389 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
391 if (PREDICT_FALSE (n_trace > 0 && vlib_trace_buffer (vm, node, next0, b0, /* follow_chain */
394 virtio_input_trace_t *tr;
395 vlib_set_trace_count (vm, node, --n_trace);
396 tr = vlib_add_trace (vm, node, b0, sizeof (*tr));
397 tr->next_index = next0;
398 tr->hw_if_index = vif->hw_if_index;
400 clib_memcpy_fast (&tr->hdr, hdr, hdr_sz);
405 vring->desc_in_use--;
411 /* only tun interfaces may have different next index */
412 if (type == VIRTIO_IF_TYPE_TUN)
413 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
414 n_left_to_next, bi0, next0);
420 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
422 vring->last_used_idx = last;
424 vlib_increment_combined_counter (vnm->interface_main.combined_sw_if_counters
425 + VNET_INTERFACE_COUNTER_RX, thread_index,
426 vif->sw_if_index, n_rx_packets,
432 static_always_inline uword
433 virtio_device_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
434 vlib_frame_t * frame, virtio_if_t * vif, u16 qid,
435 virtio_if_type_t type)
437 virtio_vring_t *vring = vec_elt_at_index (vif->rxq_vrings, qid);
438 const int hdr_sz = vif->virtio_net_hdr_sz;
439 u16 txq_id = vm->thread_index % vif->num_txqs;
440 virtio_vring_t *txq_vring = vec_elt_at_index (vif->txq_vrings, txq_id);
443 if (clib_spinlock_trylock_if_init (&txq_vring->lockp))
445 if (vif->packet_coalesce)
446 vnet_gro_flow_table_schedule_node_on_dispatcher
447 (vm, txq_vring->flow_table);
448 else if (vif->packet_buffering)
449 virtio_vring_buffering_schedule_node_on_dispatcher
450 (vm, txq_vring->buffering);
451 clib_spinlock_unlock_if_init (&txq_vring->lockp);
454 if ((vring->used->flags & VRING_USED_F_NO_NOTIFY) == 0 &&
455 vring->last_kick_avail_idx != vring->avail->idx)
456 virtio_kick (vm, vring, vif);
458 if (vif->gso_enabled)
459 rv = virtio_device_input_gso_inline (vm, node, frame, vif, vring, type,
461 else if (vif->csum_offload_enabled)
462 rv = virtio_device_input_gso_inline (vm, node, frame, vif, vring, type,
465 rv = virtio_device_input_gso_inline (vm, node, frame, vif, vring, type,
468 virtio_refill_vring (vm, vif, type, vring, hdr_sz, node->node_index);
472 VLIB_NODE_FN (virtio_input_node) (vlib_main_t * vm,
473 vlib_node_runtime_t * node,
474 vlib_frame_t * frame)
477 virtio_main_t *nm = &virtio_main;
478 vnet_device_input_runtime_t *rt = (void *) node->runtime_data;
479 vnet_device_and_queue_t *dq;
481 foreach_device_and_queue (dq, rt->devices_and_queues)
484 vif = vec_elt_at_index (nm->interfaces, dq->dev_instance);
485 if (vif->flags & VIRTIO_IF_FLAG_ADMIN_UP)
487 if (vif->type == VIRTIO_IF_TYPE_TAP)
488 n_rx += virtio_device_input_inline (vm, node, frame, vif,
491 else if (vif->type == VIRTIO_IF_TYPE_PCI)
492 n_rx += virtio_device_input_inline (vm, node, frame, vif,
495 else if (vif->type == VIRTIO_IF_TYPE_TUN)
496 n_rx += virtio_device_input_inline (vm, node, frame, vif,
506 VLIB_REGISTER_NODE (virtio_input_node) = {
507 .name = "virtio-input",
508 .sibling_of = "device-input",
509 .format_trace = format_virtio_input_trace,
510 .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
511 .type = VLIB_NODE_TYPE_INPUT,
512 .state = VLIB_NODE_STATE_INTERRUPT,
513 .n_errors = VIRTIO_INPUT_N_ERROR,
514 .error_strings = virtio_input_error_strings,
519 * fd.io coding-style-patch-verification: ON
522 * eval: (c-set-style "gnu")