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 \
42 #define _(f,s) VIRTIO_INPUT_ERROR_##f,
43 foreach_virtio_input_error
46 } virtio_input_error_t;
48 static char *virtio_input_error_strings[] = {
50 foreach_virtio_input_error
60 struct virtio_net_hdr_v1 hdr;
61 } virtio_input_trace_t;
64 format_virtio_input_trace (u8 * s, va_list * args)
66 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
67 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
68 virtio_input_trace_t *t = va_arg (*args, virtio_input_trace_t *);
69 u32 indent = format_get_indent (s);
71 s = format (s, "virtio: hw_if_index %d next-index %d vring %u len %u",
72 t->hw_if_index, t->next_index, t->ring, t->len);
73 s = format (s, "\n%Uhdr: flags 0x%02x gso_type 0x%02x hdr_len %u "
74 "gso_size %u csum_start %u csum_offset %u num_buffers %u",
75 format_white_space, indent + 2,
76 t->hdr.flags, t->hdr.gso_type, t->hdr.hdr_len, t->hdr.gso_size,
77 t->hdr.csum_start, t->hdr.csum_offset, t->hdr.num_buffers);
81 static_always_inline void
82 virtio_refill_vring (vlib_main_t * vm, virtio_if_t * vif,
83 virtio_vring_t * vring, const int hdr_sz)
85 u16 used, next, avail, n_slots;
90 used = vring->desc_in_use;
92 if (sz - used < sz / 8)
95 /* deliver free buffers in chunks of 64 */
96 n_slots = clib_min (sz - used, 64);
98 next = vring->desc_next;
99 avail = vring->avail->idx;
101 vlib_buffer_alloc_to_ring_from_pool (vm, vring->buffers, next,
102 vring->size, n_slots,
103 vring->buffer_pool_index);
110 struct vring_desc *d = &vring->desc[next];;
111 vlib_buffer_t *b = vlib_get_buffer (vm, vring->buffers[next]);
113 * current_data may not be initialized with 0 and may contain
114 * previous offset. Here we want to make sure, it should be 0
118 b->current_data -= hdr_sz;
119 memset (vlib_buffer_get_current (b), 0, hdr_sz);
121 ((vif->type == VIRTIO_IF_TYPE_PCI) ? vlib_buffer_get_current_pa (vm,
123 pointer_to_uword (vlib_buffer_get_current (b)));
124 d->len = vlib_buffer_get_default_data_size (vm) + hdr_sz;
125 d->flags = VRING_DESC_F_WRITE;
126 vring->avail->ring[avail & mask] = next;
128 next = (next + 1) & mask;
132 CLIB_MEMORY_STORE_BARRIER ();
133 vring->avail->idx = avail;
134 vring->desc_next = next;
135 vring->desc_in_use = used;
137 if ((vring->used->flags & VIRTIO_RING_FLAG_MASK_INT) == 0)
139 virtio_kick (vm, vring, vif);
144 static_always_inline void
145 virtio_needs_csum (vlib_buffer_t * b0, struct virtio_net_hdr_v1 *hdr,
146 u8 * l4_proto, u8 * l4_hdr_sz, virtio_if_type_t type)
148 if (hdr->flags & VIRTIO_NET_HDR_F_NEEDS_CSUM)
151 u16 ethertype = 0, l2hdr_sz = 0;
152 if (type != VIRTIO_IF_TYPE_TUN)
154 ethernet_header_t *eh =
155 (ethernet_header_t *) vlib_buffer_get_current (b0);
156 ethertype = clib_net_to_host_u16 (eh->type);
157 l2hdr_sz = sizeof (ethernet_header_t);
159 if (ethernet_frame_is_tagged (ethertype))
161 ethernet_vlan_header_t *vlan =
162 (ethernet_vlan_header_t *) (eh + 1);
164 ethertype = clib_net_to_host_u16 (vlan->type);
165 l2hdr_sz += sizeof (*vlan);
166 if (ethertype == ETHERNET_TYPE_VLAN)
169 ethertype = clib_net_to_host_u16 (vlan->type);
170 l2hdr_sz += sizeof (*vlan);
176 switch (b0->data[0] & 0xf0)
179 ethertype = ETHERNET_TYPE_IP4;
182 ethertype = ETHERNET_TYPE_IP6;
187 vnet_buffer (b0)->l2_hdr_offset = 0;
188 vnet_buffer (b0)->l3_hdr_offset = l2hdr_sz;
189 if (PREDICT_TRUE (ethertype == ETHERNET_TYPE_IP4))
192 (ip4_header_t *) (vlib_buffer_get_current (b0) + l2hdr_sz);
193 vnet_buffer (b0)->l4_hdr_offset = l2hdr_sz + ip4_header_bytes (ip4);
194 *l4_proto = ip4->protocol;
196 (VNET_BUFFER_F_IS_IP4 | VNET_BUFFER_F_OFFLOAD_IP_CKSUM);
198 (VNET_BUFFER_F_L2_HDR_OFFSET_VALID
199 | VNET_BUFFER_F_L3_HDR_OFFSET_VALID |
200 VNET_BUFFER_F_L4_HDR_OFFSET_VALID);
202 else if (PREDICT_TRUE (ethertype == ETHERNET_TYPE_IP6))
205 (ip6_header_t *) (vlib_buffer_get_current (b0) + l2hdr_sz);
206 vnet_buffer (b0)->l4_hdr_offset = l2hdr_sz + sizeof (ip6_header_t);
207 /* FIXME IPv6 EH traversal */
208 *l4_proto = ip6->protocol;
209 b0->flags |= (VNET_BUFFER_F_IS_IP6 |
210 VNET_BUFFER_F_L2_HDR_OFFSET_VALID
211 | VNET_BUFFER_F_L3_HDR_OFFSET_VALID |
212 VNET_BUFFER_F_L4_HDR_OFFSET_VALID);
214 if (*l4_proto == IP_PROTOCOL_TCP)
216 b0->flags |= VNET_BUFFER_F_OFFLOAD_TCP_CKSUM;
217 tcp_header_t *tcp = (tcp_header_t *) (vlib_buffer_get_current (b0) +
219 (b0)->l4_hdr_offset);
220 *l4_hdr_sz = tcp_header_bytes (tcp);
222 else if (*l4_proto == IP_PROTOCOL_UDP)
224 b0->flags |= VNET_BUFFER_F_OFFLOAD_UDP_CKSUM;
225 udp_header_t *udp = (udp_header_t *) (vlib_buffer_get_current (b0) +
227 (b0)->l4_hdr_offset);
228 *l4_hdr_sz = sizeof (*udp);
234 static_always_inline void
235 fill_gso_buffer_flags (vlib_buffer_t * b0, struct virtio_net_hdr_v1 *hdr,
236 u8 l4_proto, u8 l4_hdr_sz)
238 if (hdr->gso_type == VIRTIO_NET_HDR_GSO_TCPV4)
240 ASSERT (hdr->flags & VIRTIO_NET_HDR_F_NEEDS_CSUM);
241 vnet_buffer2 (b0)->gso_size = hdr->gso_size;
242 vnet_buffer2 (b0)->gso_l4_hdr_sz = l4_hdr_sz;
243 b0->flags |= VNET_BUFFER_F_GSO | VNET_BUFFER_F_IS_IP4;
245 if (hdr->gso_type == VIRTIO_NET_HDR_GSO_TCPV6)
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_IP6;
254 static_always_inline uword
255 virtio_device_input_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
256 vlib_frame_t * frame, virtio_if_t * vif, u16 qid,
257 int gso_enabled, int checksum_offload_enabled)
259 vnet_main_t *vnm = vnet_get_main ();
260 u32 thread_index = vm->thread_index;
261 uword n_trace = vlib_get_trace_count (vm, node);
262 virtio_vring_t *vring = vec_elt_at_index (vif->rxq_vrings, qid);
263 u32 next_index = VNET_DEVICE_INPUT_NEXT_ETHERNET_INPUT;
264 const int hdr_sz = vif->virtio_net_hdr_sz;
266 u32 n_rx_packets = 0;
268 u16 mask = vring->size - 1;
269 u16 last = vring->last_used_idx;
270 u16 n_left = vring->used->idx - last;
272 if ((vring->used->flags & VIRTIO_RING_FLAG_MASK_INT) == 0 &&
273 vring->last_kick_avail_idx != vring->avail->idx)
274 virtio_kick (vm, vring, vif);
282 u32 next0 = next_index;
283 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
285 while (n_left && n_left_to_next)
287 u8 l4_proto = 0, l4_hdr_sz = 0;
289 struct vring_used_elem *e = &vring->used->ring[last & mask];
290 struct virtio_net_hdr_v1 *hdr;
292 u16 len = e->len - hdr_sz;
293 u32 bi0 = vring->buffers[slot];
294 vlib_buffer_t *b0 = vlib_get_buffer (vm, bi0);
295 hdr = vlib_buffer_get_current (b0);
296 if (hdr_sz == sizeof (struct virtio_net_hdr_v1))
297 num_buffers = hdr->num_buffers;
299 b0->current_data += hdr_sz;
300 b0->current_length = len;
301 b0->total_length_not_including_first_buffer = 0;
302 b0->flags = VLIB_BUFFER_TOTAL_LENGTH_VALID;
304 if (checksum_offload_enabled)
305 virtio_needs_csum (b0, hdr, &l4_proto, &l4_hdr_sz, vif->type);
308 fill_gso_buffer_flags (b0, hdr, l4_proto, l4_hdr_sz);
310 vnet_buffer (b0)->sw_if_index[VLIB_RX] = vif->sw_if_index;
311 vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32) ~ 0;
313 /* if multisegment packet */
314 if (PREDICT_FALSE (num_buffers > 1))
316 vlib_buffer_t *pb, *cb;
318 while (num_buffers > 1)
321 e = &vring->used->ring[last & mask];
322 u32 cbi = vring->buffers[e->id];
323 cb = vlib_get_buffer (vm, cbi);
326 cb->current_length = e->len;
328 /* previous buffer */
329 pb->next_buffer = cbi;
330 pb->flags |= VLIB_BUFFER_NEXT_PRESENT;
333 b0->total_length_not_including_first_buffer += e->len;
336 vring->desc_in_use--;
341 if (PREDICT_FALSE (vif->type == VIRTIO_IF_TYPE_TUN))
343 switch (b0->data[0] & 0xf0)
346 next0 = VNET_DEVICE_INPUT_NEXT_IP4_INPUT;
349 next0 = VNET_DEVICE_INPUT_NEXT_IP6_INPUT;
352 next0 = VNET_DEVICE_INPUT_NEXT_DROP;
358 if (PREDICT_FALSE (vif->per_interface_next_index != ~0))
359 next0 = vif->per_interface_next_index;
361 /* redirect if feature path enabled */
362 vnet_feature_start_device_input_x1 (vif->sw_if_index, &next0, b0);
365 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
367 if (PREDICT_FALSE (n_trace > 0))
369 virtio_input_trace_t *tr;
370 vlib_trace_buffer (vm, node, next0, b0,
371 /* follow_chain */ 1);
372 vlib_set_trace_count (vm, node, --n_trace);
373 tr = vlib_add_trace (vm, node, b0, sizeof (*tr));
374 tr->next_index = next0;
375 tr->hw_if_index = vif->hw_if_index;
376 tr->len = len + b0->total_length_not_including_first_buffer;
377 clib_memcpy_fast (&tr->hdr, hdr, hdr_sz);
382 vring->desc_in_use--;
389 vlib_validate_buffer_enqueue_x1 (vm, node, next_index, to_next,
390 n_left_to_next, bi0, next0);
394 n_rx_bytes += (len + b0->total_length_not_including_first_buffer);
396 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
398 vring->last_used_idx = last;
400 vlib_increment_combined_counter (vnm->interface_main.combined_sw_if_counters
401 + VNET_INTERFACE_COUNTER_RX, thread_index,
402 vif->sw_if_index, n_rx_packets,
406 virtio_refill_vring (vm, vif, vring, hdr_sz);
411 VLIB_NODE_FN (virtio_input_node) (vlib_main_t * vm,
412 vlib_node_runtime_t * node,
413 vlib_frame_t * frame)
416 virtio_main_t *nm = &virtio_main;
417 vnet_device_input_runtime_t *rt = (void *) node->runtime_data;
418 vnet_device_and_queue_t *dq;
420 foreach_device_and_queue (dq, rt->devices_and_queues)
423 vif = vec_elt_at_index (nm->interfaces, dq->dev_instance);
424 if (vif->flags & VIRTIO_IF_FLAG_ADMIN_UP)
426 if (vif->gso_enabled)
427 n_rx += virtio_device_input_inline (vm, node, frame, vif,
429 else if (vif->csum_offload_enabled)
430 n_rx += virtio_device_input_inline (vm, node, frame, vif,
433 n_rx += virtio_device_input_inline (vm, node, frame, vif,
442 VLIB_REGISTER_NODE (virtio_input_node) = {
443 .name = "virtio-input",
444 .sibling_of = "device-input",
445 .format_trace = format_virtio_input_trace,
446 .flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
447 .type = VLIB_NODE_TYPE_INPUT,
448 .state = VLIB_NODE_STATE_INTERRUPT,
449 .n_errors = VIRTIO_INPUT_N_ERROR,
450 .error_strings = virtio_input_error_strings,
455 * fd.io coding-style-patch-verification: ON
458 * eval: (c-set-style "gnu")