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 <vlib/vlib.h>
23 #include <vlib/unix/unix.h>
24 #include <vnet/ethernet/ethernet.h>
25 #include <vnet/ip/ip4_packet.h>
26 #include <vnet/ip/ip6_packet.h>
27 #include <vnet/devices/virtio/virtio.h>
29 #define foreach_virtio_tx_func_error \
30 _(NO_FREE_SLOTS, "no free tx slots") \
31 _(TRUNC_PACKET, "packet > buffer size -- truncated in tx ring") \
32 _(PENDING_MSGS, "pending msgs in tx ring") \
33 _(NO_TX_QUEUES, "no tx queues")
37 #define _(f,s) VIRTIO_TX_ERROR_##f,
38 foreach_virtio_tx_func_error
41 } virtio_tx_func_error_t;
43 static char *virtio_tx_func_error_strings[] = {
45 foreach_virtio_tx_func_error
50 format_virtio_device_name (u8 * s, va_list * args)
52 u32 dev_instance = va_arg (*args, u32);
53 virtio_main_t *mm = &virtio_main;
54 virtio_if_t *vif = pool_elt_at_index (mm->interfaces, dev_instance);
56 if (vif->type == VIRTIO_IF_TYPE_TAP)
57 s = format (s, "tap%u", vif->id);
58 else if (vif->type == VIRTIO_IF_TYPE_PCI)
59 s = format (s, "virtio-%x/%x/%x/%x", vif->pci_addr.domain,
60 vif->pci_addr.bus, vif->pci_addr.slot,
61 vif->pci_addr.function);
63 s = format (s, "virtio-%lu", vif->dev_instance);
69 format_virtio_device (u8 * s, va_list * args)
71 u32 dev_instance = va_arg (*args, u32);
72 int verbose = va_arg (*args, int);
73 u32 indent = format_get_indent (s);
75 s = format (s, "VIRTIO interface");
78 s = format (s, "\n%U instance %u", format_white_space, indent + 2,
85 format_virtio_tx_trace (u8 * s, va_list * args)
87 s = format (s, "Unimplemented...");
92 virtio_free_used_desc (vlib_main_t * vm, virtio_vring_t * vring)
94 u16 used = vring->desc_in_use;
97 u16 last = vring->last_used_idx;
98 u16 n_left = vring->used->idx - last;
105 struct vring_used_elem *e = &vring->used->ring[last & mask];
108 vlib_buffer_free (vm, &vring->buffers[slot], 1);
113 vring->desc_in_use = used;
114 vring->last_used_idx = last;
117 static_always_inline u16
118 add_buffer_to_slot (vlib_main_t * vm, virtio_if_t * vif,
119 virtio_vring_t * vring, u32 bi, u16 avail, u16 next,
123 int hdr_sz = vif->virtio_net_hdr_sz;
124 struct vring_desc *d;
125 d = &vring->desc[next];
126 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
127 struct virtio_net_hdr_v1 *hdr = vlib_buffer_get_current (b) - hdr_sz;
129 clib_memset (hdr, 0, hdr_sz);
131 if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) == 0))
134 ((vif->type == VIRTIO_IF_TYPE_PCI) ? vlib_buffer_get_current_pa (vm,
136 pointer_to_uword (vlib_buffer_get_current (b))) - hdr_sz;
137 d->len = b->current_length + hdr_sz;
143 * We are using single vlib_buffer_t for indirect descriptor(s)
144 * chain. Single descriptor is 16 bytes and vlib_buffer_t
145 * has 2048 bytes space. So maximum long chain can have 128
146 * (=2048/16) indirect descriptors.
147 * It can easily support 65535 bytes of Jumbo frames with
148 * each data buffer size of 512 bytes minimum.
150 vlib_buffer_t *indirect_desc =
151 vlib_get_buffer (vm, vring->indirect_buffers[next]);
152 indirect_desc->current_data = 0;
154 struct vring_desc *id =
155 (struct vring_desc *) vlib_buffer_get_current (indirect_desc);
157 if (vif->type == VIRTIO_IF_TYPE_PCI)
159 d->addr = vlib_physmem_get_pa (vm, id);
160 id->addr = vlib_buffer_get_current_pa (vm, b) - hdr_sz;
163 * If VIRTIO_F_ANY_LAYOUT is not negotiated, then virtio_net_hdr
164 * should be presented in separate descriptor and data will start
165 * from next descriptor.
168 (vif->features & VIRTIO_FEATURE (VIRTIO_F_ANY_LAYOUT)))
169 id->len = b->current_length + hdr_sz;
173 id->flags = VRING_DESC_F_NEXT;
177 id->addr = vlib_buffer_get_current_pa (vm, b);
178 id->len = b->current_length;
180 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
182 id->flags = VRING_DESC_F_NEXT;
186 b = vlib_get_buffer (vm, b->next_buffer);
187 id->addr = vlib_buffer_get_current_pa (vm, b);
188 id->len = b->current_length;
191 else /* VIRTIO_IF_TYPE_TAP */
193 d->addr = pointer_to_uword (id);
194 /* first buffer in chain */
195 id->addr = pointer_to_uword (vlib_buffer_get_current (b)) - hdr_sz;
196 id->len = b->current_length + hdr_sz;
198 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
200 id->flags = VRING_DESC_F_NEXT;
204 b = vlib_get_buffer (vm, b->next_buffer);
205 id->addr = pointer_to_uword (vlib_buffer_get_current (b));
206 id->len = b->current_length;
211 d->len = count * sizeof (struct vring_desc);
212 d->flags = VRING_DESC_F_INDIRECT;
214 vring->buffers[next] = bi;
215 vring->avail->ring[avail & mask] = next;
220 static_always_inline uword
221 virtio_interface_tx_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
222 vlib_frame_t * frame, virtio_if_t * vif)
225 u16 n_left = frame->n_vectors;
226 virtio_vring_t *vring = vec_elt_at_index (vif->vrings, (qid << 1) + 1);
227 u16 used, next, avail;
228 u16 sz = vring->size;
230 u32 *buffers = vlib_frame_vector_args (frame);
232 clib_spinlock_lock_if_init (&vif->lockp);
234 if ((vring->used->flags & VIRTIO_RING_FLAG_MASK_INT) == 0 &&
235 (vring->last_kick_avail_idx != vring->avail->idx))
236 virtio_kick (vm, vring, vif);
238 /* free consumed buffers */
239 virtio_free_used_desc (vm, vring);
241 used = vring->desc_in_use;
242 next = vring->desc_next;
243 avail = vring->avail->idx;
245 while (n_left && used < sz)
249 add_buffer_to_slot (vm, vif, vring, buffers[0], avail, next, mask);
253 next = (next + n_added) & mask;
259 if (n_left != frame->n_vectors)
261 CLIB_MEMORY_STORE_BARRIER ();
262 vring->avail->idx = avail;
263 vring->desc_next = next;
264 vring->desc_in_use = used;
265 if ((vring->used->flags & VIRTIO_RING_FLAG_MASK_INT) == 0)
266 virtio_kick (vm, vring, vif);
271 vlib_error_count (vm, node->node_index, VIRTIO_TX_ERROR_NO_FREE_SLOTS,
273 vlib_buffer_free (vm, buffers, n_left);
276 clib_spinlock_unlock_if_init (&vif->lockp);
278 return frame->n_vectors - n_left;
282 virtio_interface_tx (vlib_main_t * vm,
283 vlib_node_runtime_t * node, vlib_frame_t * frame)
285 virtio_main_t *nm = &virtio_main;
286 vnet_interface_output_runtime_t *rund = (void *) node->runtime_data;
287 virtio_if_t *vif = pool_elt_at_index (nm->interfaces, rund->dev_instance);
289 return virtio_interface_tx_inline (vm, node, frame, vif);
293 virtio_set_interface_next_node (vnet_main_t * vnm, u32 hw_if_index,
296 virtio_main_t *apm = &virtio_main;
297 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
298 virtio_if_t *vif = pool_elt_at_index (apm->interfaces, hw->dev_instance);
300 /* Shut off redirection */
301 if (node_index == ~0)
303 vif->per_interface_next_index = node_index;
307 vif->per_interface_next_index =
308 vlib_node_add_next (vlib_get_main (), virtio_input_node.index,
313 virtio_clear_hw_interface_counters (u32 instance)
315 /* Nothing for now */
318 static clib_error_t *
319 virtio_interface_rx_mode_change (vnet_main_t * vnm, u32 hw_if_index, u32 qid,
320 vnet_hw_interface_rx_mode mode)
322 virtio_main_t *mm = &virtio_main;
323 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
324 virtio_if_t *vif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
325 virtio_vring_t *vring = vec_elt_at_index (vif->vrings, qid);
327 if (vif->type == VIRTIO_IF_TYPE_PCI && !(vif->support_int_mode))
329 vring->avail->flags |= VIRTIO_RING_FLAG_MASK_INT;
330 return clib_error_return (0, "interrupt mode is not supported");
333 if (mode == VNET_HW_INTERFACE_RX_MODE_POLLING)
334 vring->avail->flags |= VIRTIO_RING_FLAG_MASK_INT;
336 vring->avail->flags &= ~VIRTIO_RING_FLAG_MASK_INT;
341 static clib_error_t *
342 virtio_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
344 virtio_main_t *mm = &virtio_main;
345 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
346 virtio_if_t *vif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
348 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
349 vif->flags |= VIRTIO_IF_FLAG_ADMIN_UP;
351 vif->flags &= ~VIRTIO_IF_FLAG_ADMIN_UP;
356 static clib_error_t *
357 virtio_subif_add_del_function (vnet_main_t * vnm,
359 struct vnet_sw_interface_t *st, int is_add)
361 /* Nothing for now */
366 VNET_DEVICE_CLASS (virtio_device_class) = {
368 .tx_function = virtio_interface_tx,
369 .format_device_name = format_virtio_device_name,
370 .format_device = format_virtio_device,
371 .format_tx_trace = format_virtio_tx_trace,
372 .tx_function_n_errors = VIRTIO_TX_N_ERROR,
373 .tx_function_error_strings = virtio_tx_func_error_strings,
374 .rx_redirect_to_node = virtio_set_interface_next_node,
375 .clear_counters = virtio_clear_hw_interface_counters,
376 .admin_up_down_function = virtio_interface_admin_up_down,
377 .subif_add_del_function = virtio_subif_add_del_function,
378 .rx_mode_change_function = virtio_interface_rx_mode_change,
381 VLIB_DEVICE_TX_FUNCTION_MULTIARCH(virtio_device_class,
386 * fd.io coding-style-patch-verification: ON
389 * eval: (c-set-style "gnu")