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 *------------------------------------------------------------------
21 #include <sys/ioctl.h>
24 #include <vlib/vlib.h>
25 #include <vlib/unix/unix.h>
26 #include <vnet/ethernet/ethernet.h>
28 #include <memif/memif.h>
29 #include <memif/private.h>
31 #define foreach_memif_tx_func_error \
32 _(NO_FREE_SLOTS, "no free tx slots") \
33 _(TRUNC_PACKET, "packet > buffer size -- truncated in tx ring") \
34 _(PENDING_MSGS, "pending msgs in tx ring")
38 #define _(f,s) MEMIF_TX_ERROR_##f,
39 foreach_memif_tx_func_error
42 } memif_tx_func_error_t;
44 static char *memif_tx_func_error_strings[] = {
46 foreach_memif_tx_func_error
51 format_memif_device_name (u8 * s, va_list * args)
53 u32 i = va_arg (*args, u32);
55 s = format (s, "memif%u", i);
60 format_memif_device (u8 * s, va_list * args)
62 u32 dev_instance = va_arg (*args, u32);
63 int verbose = va_arg (*args, int);
64 uword indent = format_get_indent (s);
66 s = format (s, "MEMIF interface");
69 s = format (s, "\n%U instance %u", format_white_space, indent + 2,
76 format_memif_tx_trace (u8 * s, va_list * args)
78 s = format (s, "Unimplemented...");
82 static_always_inline void
83 memif_prefetch_buffer_and_data (vlib_main_t * vm, u32 bi)
85 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
86 vlib_prefetch_buffer_header (b, LOAD);
87 CLIB_PREFETCH (b->data, CLIB_CACHE_LINE_BYTES, LOAD);
91 * @brief Copy buffer to tx ring
95 * @param * mif (in) pointer to memif interface
96 * @param bi (in) vlib buffer index
97 * @param * ring (in) pointer to memif ring
98 * @param * head (in/out) ring head
99 * @param mask (in) ring size - 1
101 static_always_inline void
102 memif_copy_buffer_to_tx_ring (vlib_main_t * vm, vlib_node_runtime_t * node,
103 memif_if_t * mif, u32 bi, memif_ring_t * ring,
104 u16 * head, u16 mask)
110 mb0 = memif_get_buffer (mif, ring, *head);
111 ring->desc[*head].flags = 0;
114 b0 = vlib_get_buffer (vm, bi);
115 len = b0->current_length;
116 if (PREDICT_FALSE (ring->desc[*head].buffer_length < (total + len)))
118 if (PREDICT_TRUE (total))
120 ring->desc[*head].length = total;
122 ring->desc[*head].flags |= MEMIF_DESC_FLAG_NEXT;
123 *head = (*head + 1) & mask;
124 mb0 = memif_get_buffer (mif, ring, *head);
125 ring->desc[*head].flags = 0;
128 if (PREDICT_TRUE (ring->desc[*head].buffer_length >= (total + len)))
130 clib_memcpy (mb0 + total, vlib_buffer_get_current (b0),
131 CLIB_CACHE_LINE_BYTES);
132 if (len > CLIB_CACHE_LINE_BYTES)
133 clib_memcpy (mb0 + CLIB_CACHE_LINE_BYTES + total,
134 vlib_buffer_get_current (b0) + CLIB_CACHE_LINE_BYTES,
135 len - CLIB_CACHE_LINE_BYTES);
140 vlib_error_count (vm, node->node_index, MEMIF_TX_ERROR_TRUNC_PACKET,
145 while ((bi = (b0->flags & VLIB_BUFFER_NEXT_PRESENT) ? b0->next_buffer : 0));
147 if (PREDICT_TRUE (total))
149 ring->desc[*head].length = total;
150 *head = (*head + 1) & mask;
154 static_always_inline uword
155 memif_interface_tx_inline (vlib_main_t * vm, vlib_node_runtime_t * node,
156 vlib_frame_t * frame, memif_if_t * mif,
157 memif_ring_type_t type)
161 u32 *buffers = vlib_frame_args (frame);
162 u32 n_left = frame->n_vectors;
166 u32 thread_index = vlib_get_thread_index ();
167 u8 tx_queues = vec_len (mif->tx_queues);
170 if (tx_queues < vec_len (vlib_mains))
172 qid = thread_index % tx_queues;
173 clib_spinlock_lock_if_init (&mif->lockp);
179 mq = vec_elt_at_index (mif->tx_queues, qid);
181 ring_size = 1 << mq->log2_ring_size;
182 mask = ring_size - 1;
184 /* free consumed buffers */
190 free_slots = tail - head;
192 free_slots = ring_size - head + tail;
194 while (n_left > 5 && free_slots > 1)
196 if (PREDICT_TRUE (head + 5 < ring_size))
198 CLIB_PREFETCH (memif_get_buffer (mif, ring, head + 2),
199 CLIB_CACHE_LINE_BYTES, STORE);
200 CLIB_PREFETCH (memif_get_buffer (mif, ring, head + 3),
201 CLIB_CACHE_LINE_BYTES, STORE);
202 CLIB_PREFETCH (&ring->desc[head + 4], CLIB_CACHE_LINE_BYTES, STORE);
203 CLIB_PREFETCH (&ring->desc[head + 5], CLIB_CACHE_LINE_BYTES, STORE);
207 CLIB_PREFETCH (memif_get_buffer (mif, ring, (head + 2) % mask),
208 CLIB_CACHE_LINE_BYTES, STORE);
209 CLIB_PREFETCH (memif_get_buffer (mif, ring, (head + 3) % mask),
210 CLIB_CACHE_LINE_BYTES, STORE);
211 CLIB_PREFETCH (&ring->desc[(head + 4) % mask],
212 CLIB_CACHE_LINE_BYTES, STORE);
213 CLIB_PREFETCH (&ring->desc[(head + 5) % mask],
214 CLIB_CACHE_LINE_BYTES, STORE);
217 memif_prefetch_buffer_and_data (vm, buffers[2]);
218 memif_prefetch_buffer_and_data (vm, buffers[3]);
220 memif_copy_buffer_to_tx_ring (vm, node, mif, buffers[0], ring, &head,
222 memif_copy_buffer_to_tx_ring (vm, node, mif, buffers[1], ring, &head,
230 while (n_left && free_slots)
232 memif_copy_buffer_to_tx_ring (vm, node, mif, buffers[0], ring, &head,
239 CLIB_MEMORY_STORE_BARRIER ();
242 clib_spinlock_unlock_if_init (&mif->lockp);
246 vlib_error_count (vm, node->node_index, MEMIF_TX_ERROR_NO_FREE_SLOTS,
248 vlib_buffer_free (vm, buffers, n_left);
251 vlib_buffer_free (vm, vlib_frame_args (frame), frame->n_vectors);
252 if ((ring->flags & MEMIF_RING_FLAG_MASK_INT) == 0 && mq->int_fd > -1)
255 CLIB_UNUSED (int r) = write (mq->int_fd, &b, sizeof (b));
259 return frame->n_vectors;
263 memif_interface_tx (vlib_main_t * vm,
264 vlib_node_runtime_t * node, vlib_frame_t * frame)
266 memif_main_t *nm = &memif_main;
267 vnet_interface_output_runtime_t *rund = (void *) node->runtime_data;
268 memif_if_t *mif = pool_elt_at_index (nm->interfaces, rund->dev_instance);
270 if (mif->flags & MEMIF_IF_FLAG_IS_SLAVE)
271 return memif_interface_tx_inline (vm, node, frame, mif, MEMIF_RING_S2M);
273 return memif_interface_tx_inline (vm, node, frame, mif, MEMIF_RING_M2S);
277 memif_set_interface_next_node (vnet_main_t * vnm, u32 hw_if_index,
280 memif_main_t *apm = &memif_main;
281 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
282 memif_if_t *mif = pool_elt_at_index (apm->interfaces, hw->dev_instance);
284 /* Shut off redirection */
285 if (node_index == ~0)
287 mif->per_interface_next_index = node_index;
291 mif->per_interface_next_index =
292 vlib_node_add_next (vlib_get_main (), memif_input_node.index, node_index);
296 memif_clear_hw_interface_counters (u32 instance)
298 /* Nothing for now */
301 static clib_error_t *
302 memif_interface_rx_mode_change (vnet_main_t * vnm, u32 hw_if_index, u32 qid,
303 vnet_hw_interface_rx_mode mode)
305 memif_main_t *mm = &memif_main;
306 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
307 memif_if_t *mif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
308 memif_queue_t *mq = vec_elt_at_index (mif->rx_queues, qid);
310 if (mode == VNET_HW_INTERFACE_RX_MODE_POLLING)
311 mq->ring->flags |= MEMIF_RING_FLAG_MASK_INT;
313 mq->ring->flags &= ~MEMIF_RING_FLAG_MASK_INT;
318 static clib_error_t *
319 memif_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index, u32 flags)
321 memif_main_t *mm = &memif_main;
322 vnet_hw_interface_t *hw = vnet_get_hw_interface (vnm, hw_if_index);
323 memif_if_t *mif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
324 static clib_error_t *error = 0;
326 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
327 mif->flags |= MEMIF_IF_FLAG_ADMIN_UP;
329 mif->flags &= ~MEMIF_IF_FLAG_ADMIN_UP;
334 static clib_error_t *
335 memif_subif_add_del_function (vnet_main_t * vnm,
337 struct vnet_sw_interface_t *st, int is_add)
339 /* Nothing for now */
344 VNET_DEVICE_CLASS (memif_device_class) = {
346 .tx_function = memif_interface_tx,
347 .format_device_name = format_memif_device_name,
348 .format_device = format_memif_device,
349 .format_tx_trace = format_memif_tx_trace,
350 .tx_function_n_errors = MEMIF_TX_N_ERROR,
351 .tx_function_error_strings = memif_tx_func_error_strings,
352 .rx_redirect_to_node = memif_set_interface_next_node,
353 .clear_counters = memif_clear_hw_interface_counters,
354 .admin_up_down_function = memif_interface_admin_up_down,
355 .subif_add_del_function = memif_subif_add_del_function,
356 .rx_mode_change_function = memif_interface_rx_mode_change,
359 VLIB_DEVICE_TX_FUNCTION_MULTIARCH(memif_device_class,
364 * fd.io coding-style-patch-verification: ON
367 * eval: (c-set-style "gnu")