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/ip/ip4_packet.h>
32 #include <vnet/ip/ip6_packet.h>
33 #include <vnet/udp/udp_packet.h>
34 #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 struct virtio_net_hdr_v1 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 (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 struct vring_desc *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 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_MEMORY_STORE_BARRIER ();
139 vring->avail->idx = avail;
140 vring->desc_next = next;
141 vring->desc_in_use = used;
143 if ((vring->used->flags & VIRTIO_RING_FLAG_MASK_INT) == 0)
145 virtio_kick (vm, vring, vif);
150 static_always_inline void
151 virtio_needs_csum (vlib_buffer_t * b0, struct virtio_net_hdr_v1 *hdr,
152 u8 * l4_proto, u8 * l4_hdr_sz, virtio_if_type_t type)
154 if (hdr->flags & VIRTIO_NET_HDR_F_NEEDS_CSUM)
156 u16 ethertype = 0, l2hdr_sz = 0;
158 if (type == VIRTIO_IF_TYPE_TUN)
160 switch (b0->data[0] & 0xf0)
163 ethertype = ETHERNET_TYPE_IP4;
166 ethertype = ETHERNET_TYPE_IP6;
172 ethernet_header_t *eh =
173 (ethernet_header_t *) vlib_buffer_get_current (b0);
174 ethertype = clib_net_to_host_u16 (eh->type);
175 l2hdr_sz = sizeof (ethernet_header_t);
177 if (ethernet_frame_is_tagged (ethertype))
179 ethernet_vlan_header_t *vlan =
180 (ethernet_vlan_header_t *) (eh + 1);
182 ethertype = clib_net_to_host_u16 (vlan->type);
183 l2hdr_sz += sizeof (*vlan);
184 if (ethertype == ETHERNET_TYPE_VLAN)
187 ethertype = clib_net_to_host_u16 (vlan->type);
188 l2hdr_sz += sizeof (*vlan);
193 vnet_buffer (b0)->l2_hdr_offset = 0;
194 vnet_buffer (b0)->l3_hdr_offset = l2hdr_sz;
196 if (PREDICT_TRUE (ethertype == ETHERNET_TYPE_IP4))
199 (ip4_header_t *) (vlib_buffer_get_current (b0) + l2hdr_sz);
200 vnet_buffer (b0)->l4_hdr_offset = l2hdr_sz + ip4_header_bytes (ip4);
201 *l4_proto = ip4->protocol;
203 (VNET_BUFFER_F_IS_IP4 | VNET_BUFFER_F_OFFLOAD_IP_CKSUM);
205 (VNET_BUFFER_F_L2_HDR_OFFSET_VALID
206 | VNET_BUFFER_F_L3_HDR_OFFSET_VALID |
207 VNET_BUFFER_F_L4_HDR_OFFSET_VALID);
209 else if (PREDICT_TRUE (ethertype == ETHERNET_TYPE_IP6))
212 (ip6_header_t *) (vlib_buffer_get_current (b0) + l2hdr_sz);
213 vnet_buffer (b0)->l4_hdr_offset = l2hdr_sz + sizeof (ip6_header_t);
214 /* FIXME IPv6 EH traversal */
215 *l4_proto = ip6->protocol;
216 b0->flags |= (VNET_BUFFER_F_IS_IP6 |
217 VNET_BUFFER_F_L2_HDR_OFFSET_VALID
218 | VNET_BUFFER_F_L3_HDR_OFFSET_VALID |
219 VNET_BUFFER_F_L4_HDR_OFFSET_VALID);
221 if (*l4_proto == IP_PROTOCOL_TCP)
223 b0->flags |= VNET_BUFFER_F_OFFLOAD_TCP_CKSUM;
224 tcp_header_t *tcp = (tcp_header_t *) (vlib_buffer_get_current (b0) +
226 (b0)->l4_hdr_offset);
227 *l4_hdr_sz = tcp_header_bytes (tcp);
229 else if (*l4_proto == IP_PROTOCOL_UDP)
231 b0->flags |= VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
232 udp_header_t *udp = (udp_header_t *) (vlib_buffer_get_current (b0) +
234 (b0)->l4_hdr_offset);
235 *l4_hdr_sz = sizeof (*udp);
240 static_always_inline void
241 fill_gso_buffer_flags (vlib_buffer_t * b0, struct virtio_net_hdr_v1 *hdr,
242 u8 l4_proto, u8 l4_hdr_sz)
244 if (hdr->gso_type == VIRTIO_NET_HDR_GSO_TCPV4)
246 ASSERT (hdr->flags & VIRTIO_NET_HDR_F_NEEDS_CSUM);
247 vnet_buffer2 (b0)->gso_size = hdr->gso_size;
248 vnet_buffer2 (b0)->gso_l4_hdr_sz = l4_hdr_sz;
249 b0->flags |= VNET_BUFFER_F_GSO | VNET_BUFFER_F_IS_IP4;
251 if (hdr->gso_type == VIRTIO_NET_HDR_GSO_TCPV6)
253 ASSERT (hdr->flags & VIRTIO_NET_HDR_F_NEEDS_CSUM);
254 vnet_buffer2 (b0)->gso_size = hdr->gso_size;
255 vnet_buffer2 (b0)->gso_l4_hdr_sz = l4_hdr_sz;
256 b0->flags |= VNET_BUFFER_F_GSO | VNET_BUFFER_F_IS_IP6;
260 static_always_inline uword
261 virtio_device_input_gso_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
262 vlib_frame_t * frame, virtio_if_t * vif,
263 u16 qid, virtio_if_type_t type,
264 int gso_enabled, int checksum_offload_enabled)
266 vnet_main_t *vnm = vnet_get_main ();
267 u32 thread_index = vm->thread_index;
268 uword n_trace = vlib_get_trace_count (vm, node);
269 virtio_vring_t *vring = vec_elt_at_index (vif->rxq_vrings, qid);
270 u32 next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
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;
279 if ((vring->used->flags & VIRTIO_RING_FLAG_MASK_INT) == 0 &&
280 vring->last_kick_avail_idx != vring->avail->idx)
281 virtio_kick (vm, vring, vif);
286 if (type == VIRTIO_IF_TYPE_TUN)
287 next_index = VNET_DEVICE_INPUT_NEXT_IP4_INPUT;
292 u32 next0 = next_index;
294 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
296 while (n_left && n_left_to_next)
298 u8 l4_proto = 0, l4_hdr_sz = 0;
300 struct vring_used_elem *e = &vring->used->ring[last & mask];
301 struct virtio_net_hdr_v1 *hdr;
303 u16 len = e->len - hdr_sz;
304 u32 bi0 = vring->buffers[slot];
305 vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
306 hdr = vlib_buffer_get_current (b0);
307 if (hdr_sz == sizeof (struct virtio_net_hdr_v1))
308 num_buffers = hdr->num_buffers;
310 b0->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID;
311 b0->current_data = 0;
312 b0->current_length = len;
314 if (checksum_offload_enabled)
315 virtio_needs_csum (b0, hdr, &l4_proto, &l4_hdr_sz, type);
318 fill_gso_buffer_flags (b0, hdr, l4_proto, l4_hdr_sz);
320 vnet_buffer (b0)->sw_if_index[VLIB_RX] = vif->sw_if_index;
321 vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32) ~ 0;
323 /* if multisegment packet */
324 if (PREDICT_FALSE (num_buffers > 1))
326 vlib_buffer_t *pb, *cb;
328 b0->total_length_not_including_first_buffer = 0;
329 while (num_buffers > 1)
332 e = &vring->used->ring[last & mask];
333 u32 cbi = vring->buffers[e->id];
334 cb = vlib_get_buffer (vm, cbi);
337 cb->current_length = e->len;
339 /* previous buffer */
340 pb->next_buffer = cbi;
341 pb->flags |= VLIB_BUFFER_NEXT_PRESENT;
344 b0->total_length_not_including_first_buffer += e->len;
347 vring->desc_in_use--;
351 len += b0->total_length_not_including_first_buffer;
354 if (type == VIRTIO_IF_TYPE_TUN)
356 switch (b0->data[0] & 0xf0)
359 next0 = VNET_DEVICE_INPUT_NEXT_IP4_INPUT;
362 next0 = VNET_DEVICE_INPUT_NEXT_IP6_INPUT;
365 next0 = VNET_DEVICE_INPUT_NEXT_DROP;
370 if (PREDICT_FALSE (vif->per_interface_next_index != ~0))
371 next0 = vif->per_interface_next_index;
373 if (type != VIRTIO_IF_TYPE_TUN)
375 /* only for l2, redirect if feature path enabled */
376 vnet_feature_start_device_input_x1 (vif->sw_if_index, &next0,
381 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
383 if (PREDICT_FALSE (n_trace > 0))
385 virtio_input_trace_t *tr;
386 vlib_trace_buffer (vm, node, next0, b0,
387 /* follow_chain */ 1);
388 vlib_set_trace_count (vm, node, --n_trace);
389 tr = vlib_add_trace (vm, node, b0, sizeof (*tr));
390 tr->next_index = next0;
391 tr->hw_if_index = vif->hw_if_index;
393 clib_memcpy_fast (&tr->hdr, hdr, hdr_sz);
398 vring->desc_in_use--;
405 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
406 n_left_to_next, bi0, next0);
412 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
414 vring->last_used_idx = last;
416 vlib_increment_combined_counter (vnm->interface_main.combined_sw_if_counters
417 + VNET_INTERFACE_COUNTER_RX, thread_index,
418 vif->sw_if_index, n_rx_packets,
422 virtio_refill_vring (vm, vif, type, vring, hdr_sz, node->node_index);
427 static_always_inline uword
428 virtio_device_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
429 vlib_frame_t * frame, virtio_if_t * vif, u16 qid,
430 virtio_if_type_t type)
433 if (vif->gso_enabled)
434 return virtio_device_input_gso_inline (vm, node, frame, vif,
436 else if (vif->csum_offload_enabled)
437 return virtio_device_input_gso_inline (vm, node, frame, vif,
440 return virtio_device_input_gso_inline (vm, node, frame, vif,
445 VLIB_NODE_FN (virtio_input_node) (vlib_main_t * vm,
446 vlib_node_runtime_t * node,
447 vlib_frame_t * frame)
450 virtio_main_t *nm = &virtio_main;
451 vnet_device_input_runtime_t *rt = (void *) node->runtime_data;
452 vnet_device_and_queue_t *dq;
454 foreach_device_and_queue (dq, rt->devices_and_queues)
457 vif = vec_elt_at_index (nm->interfaces, dq->dev_instance);
458 if (vif->flags & VIRTIO_IF_FLAG_ADMIN_UP)
460 if (vif->type == VIRTIO_IF_TYPE_TAP)
461 n_rx += virtio_device_input_inline (vm, node, frame, vif,
464 else if (vif->type == VIRTIO_IF_TYPE_PCI)
465 n_rx += virtio_device_input_inline (vm, node, frame, vif,
468 else if (vif->type == VIRTIO_IF_TYPE_TUN)
469 n_rx += virtio_device_input_inline (vm, node, frame, vif,
479 VLIB_REGISTER_NODE (virtio_input_node) = {
480 .name = "virtio-input",
481 .sibling_of = "device-input",
482 .format_trace = format_virtio_input_trace,
483 .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
484 .type = VLIB_NODE_TYPE_INPUT,
485 .state = VLIB_NODE_STATE_INTERRUPT,
486 .n_errors = VIRTIO_INPUT_N_ERROR,
487 .error_strings = virtio_input_error_strings,
492 * fd.io coding-style-patch-verification: ON
495 * eval: (c-set-style "gnu")