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 *------------------------------------------------------------------
19 #include <sys/ioctl.h>
22 #include <vlib/vlib.h>
23 #include <vlib/unix/unix.h>
24 #include <vnet/ethernet/ethernet.h>
26 #include <memif/memif.h>
27 #include <memif/private.h>
30 memif_create_command_fn (vlib_main_t * vm, unformat_input_t * input,
31 vlib_cli_command_t * cmd)
33 unformat_input_t _line_input, *line_input = &_line_input;
35 u32 ring_size = MEMIF_DEFAULT_RING_SIZE;
36 memif_create_if_args_t args = { 0 };
37 args.buffer_size = MEMIF_DEFAULT_BUFFER_SIZE;
38 u32 rx_queues = MEMIF_DEFAULT_RX_QUEUES;
39 u32 tx_queues = MEMIF_DEFAULT_TX_QUEUES;
41 /* Get a line of input. */
42 if (!unformat_user (input, unformat_line_input, line_input))
45 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
47 if (unformat (line_input, "id %u", &args.id))
49 else if (unformat (line_input, "socket %s", &args.socket_filename))
51 else if (unformat (line_input, "secret %s", &args.secret))
53 else if (unformat (line_input, "ring-size %u", &ring_size))
55 else if (unformat (line_input, "rx-queues %u", &rx_queues))
57 else if (unformat (line_input, "tx-queues %u", &tx_queues))
59 else if (unformat (line_input, "buffer-size %u", &args.buffer_size))
61 else if (unformat (line_input, "master"))
63 else if (unformat (line_input, "slave"))
65 else if (unformat (line_input, "mode ip"))
66 args.mode = MEMIF_INTERFACE_MODE_IP;
67 else if (unformat (line_input, "hw-addr %U",
68 unformat_ethernet_address, args.hw_addr))
71 return clib_error_return (0, "unknown input `%U'",
72 format_unformat_error, input);
74 unformat_free (line_input);
76 if (!is_pow2 (ring_size))
77 return clib_error_return (0, "ring size must be power of 2");
79 if (ring_size > 32768)
80 return clib_error_return (0, "maximum ring size is 32768");
82 args.log2_ring_size = min_log2 (ring_size);
84 if (rx_queues > 255 || rx_queues < 1)
85 return clib_error_return (0, "rx queue must be between 1 - 255");
86 if (tx_queues > 255 || tx_queues < 1)
87 return clib_error_return (0, "tx queue must be between 1 - 255");
89 args.rx_queues = rx_queues;
90 args.tx_queues = tx_queues;
92 r = memif_create_if (vm, &args);
94 vec_free (args.socket_filename);
95 vec_free (args.secret);
97 if (r <= VNET_API_ERROR_SYSCALL_ERROR_1
98 && r >= VNET_API_ERROR_SYSCALL_ERROR_10)
99 return clib_error_return (0, "%s (errno %d)", strerror (errno), errno);
101 if (r == VNET_API_ERROR_INVALID_INTERFACE)
102 return clib_error_return (0, "Invalid interface name");
104 if (r == VNET_API_ERROR_SUBIF_ALREADY_EXISTS)
105 return clib_error_return (0, "Interface with same id already exists");
111 VLIB_CLI_COMMAND (memif_create_command, static) = {
112 .path = "create memif",
113 .short_help = "create memif [id <id>] [socket <path>] "
114 "[ring-size <size>] [buffer-size <size>] [hw-addr <mac-address>] "
115 "<master|slave> [rx-queues <number>] [tx-queues <number>] "
116 "[mode ip] [secret <string>]",
117 .function = memif_create_command_fn,
121 static clib_error_t *
122 memif_delete_command_fn (vlib_main_t * vm, unformat_input_t * input,
123 vlib_cli_command_t * cmd)
125 unformat_input_t _line_input, *line_input = &_line_input;
126 u32 sw_if_index = ~0;
127 vnet_hw_interface_t *hw;
128 memif_main_t *mm = &memif_main;
130 vnet_main_t *vnm = vnet_get_main ();
132 /* Get a line of input. */
133 if (!unformat_user (input, unformat_line_input, line_input))
136 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
138 if (unformat (line_input, "sw_if_index %d", &sw_if_index))
140 else if (unformat (line_input, "%U", unformat_vnet_sw_interface,
144 return clib_error_return (0, "unknown input `%U'",
145 format_unformat_error, input);
147 unformat_free (line_input);
149 if (sw_if_index == ~0)
150 return clib_error_return (0,
151 "please specify interface name or sw_if_index");
153 hw = vnet_get_sup_hw_interface (vnm, sw_if_index);
154 if (hw == NULL || memif_device_class.index != hw->dev_class_index)
155 return clib_error_return (0, "not a memif interface");
157 mif = pool_elt_at_index (mm->interfaces, hw->dev_instance);
158 memif_delete_if (vm, mif);
164 VLIB_CLI_COMMAND (memif_delete_command, static) = {
165 .path = "delete memif",
166 .short_help = "delete memif {<interface> | sw_if_index <sw_idx>}",
167 .function = memif_delete_command_fn,
172 format_memif_if_flags (u8 * s, va_list * args)
174 u32 flags = va_arg (*args, u32);
175 #define _(a,b,c) if ( flags & (1 << a)) s = format (s, " %s", c);
176 foreach_memif_if_flag
182 format_memif_if_mode (u8 * s, va_list * args)
184 memif_if_t *mif = va_arg (*args, memif_if_t *);
185 if (mif->mode == MEMIF_INTERFACE_MODE_ETHERNET)
186 return format (s, "ethernet");
187 if (mif->mode == MEMIF_INTERFACE_MODE_IP)
188 return format (s, "ip");
189 if (mif->mode == MEMIF_INTERFACE_MODE_PUNT_INJECT)
190 return format (s, "punt-inject");
191 return format (s, "unknown mode (%u)", mif->mode);;
195 format_memif_queue (u8 * s, va_list * args)
197 memif_if_t *mif = va_arg (*args, memif_if_t *);
198 memif_queue_t *mq = va_arg (*args, memif_queue_t *);
199 uword i = va_arg (*args, uword);
200 u32 indent = format_get_indent (s);
202 s = format (s, "%U%s ring %u:\n",
203 format_white_space, indent,
204 (mif->flags & MEMIF_IF_FLAG_IS_SLAVE) ?
205 "slave-to-master" : "master-to-slave", i);
206 s = format (s, "%Uregion %u offset %u ring-size %u int-fd %d\n",
207 format_white_space, indent + 4,
208 mq->region, mq->offset, (1 << mq->log2_ring_size), mq->int_fd);
211 s = format (s, "%Uhead %u tail %u flags 0x%04x interrupts %u\n",
212 format_white_space, indent + 4,
213 mq->ring->head, mq->ring->tail, mq->ring->flags,
220 format_memif_descriptor (u8 * s, va_list * args)
222 memif_if_t *mif = va_arg (*args, memif_if_t *);
223 memif_queue_t *mq = va_arg (*args, memif_queue_t *);
224 u32 indent = format_get_indent (s);
229 ring_size = 1 << mq->log2_ring_size;
233 s = format (s, "%Udescriptor table:\n", format_white_space, indent);
236 "%Uid flags buf len desc len address offset user address\n",
237 format_white_space, indent);
240 "%U===== ===== ======= ======== ================== ====== ==================\n",
241 format_white_space, indent);
242 for (slot = 0; slot < ring_size; slot++)
244 s = format (s, "%U%-5d %-5d %-7d %-7d 0x%016lx %-6d 0x%016lx\n",
245 format_white_space, indent, slot,
246 ring->desc[slot].flags, ring->desc[slot].buffer_length,
247 ring->desc[slot].length,
248 mif->regions[ring->desc[slot].region].shm,
249 ring->desc[slot].offset, memif_get_buffer (mif, ring,
252 s = format (s, "\n");
258 static clib_error_t *
259 memif_show_command_fn (vlib_main_t * vm, unformat_input_t * input,
260 vlib_cli_command_t * cmd)
262 memif_main_t *mm = &memif_main;
264 vnet_main_t *vnm = vnet_get_main ();
268 clib_error_t *error = 0;
269 u32 hw_if_index, *hw_if_indices = 0;
271 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
274 (input, "%U", unformat_vnet_hw_interface, vnm, &hw_if_index))
275 vec_add1 (hw_if_indices, hw_if_index);
276 else if (unformat (input, "descriptors"))
280 error = clib_error_return (0, "unknown input `%U'",
281 format_unformat_error, input);
286 if (vec_len (hw_if_indices) == 0)
289 pool_foreach (mif, mm->interfaces,
290 vec_add1 (hw_if_indices, mif->hw_if_index);
295 for (hw_if_index = 0; hw_if_index < vec_len (hw_if_indices); hw_if_index++)
297 vnet_hw_interface_t *hi =
298 vnet_get_hw_interface (vnm, hw_if_indices[hw_if_index]);
299 mif = pool_elt_at_index (mm->interfaces, hi->dev_instance);
300 memif_socket_file_t *msf = vec_elt_at_index (mm->socket_files,
301 mif->socket_file_index);
302 vlib_cli_output (vm, "interface %U", format_vnet_sw_if_index_name,
303 vnm, mif->sw_if_index);
304 if (mif->remote_name)
305 vlib_cli_output (vm, " remote-name \"%s\"", mif->remote_name);
306 if (mif->remote_if_name)
307 vlib_cli_output (vm, " remote-interface \"%s\"",
308 mif->remote_if_name);
309 vlib_cli_output (vm, " id %d mode %U file %s", mif->id,
310 format_memif_if_mode, mif, msf->filename);
311 vlib_cli_output (vm, " flags%U", format_memif_if_flags, mif->flags);
312 vlib_cli_output (vm, " listener-fd %d conn-fd %d",
313 msf->sock ? msf->sock->fd : 0,
314 mif->sock ? mif->sock->fd : 0);
316 " num-s2m-rings %u num-m2s-rings %u buffer-size %u",
317 mif->run.num_s2m_rings, mif->run.num_m2s_rings,
318 mif->run.buffer_size);
320 if (mif->local_disc_string)
321 vlib_cli_output (vm, " local-disc-reason \"%s\"",
322 mif->local_disc_string);
323 if (mif->remote_disc_string)
324 vlib_cli_output (vm, " remote-disc-reason \"%s\"",
325 mif->remote_disc_string);
327 vec_foreach_index (i, mif->tx_queues)
329 mq = vec_elt_at_index (mif->tx_queues, i);
330 vlib_cli_output (vm, " %U", format_memif_queue, mif, mq, i);
332 vlib_cli_output (vm, " %U", format_memif_descriptor, mif, mq);
334 vec_foreach_index (i, mif->rx_queues)
336 mq = vec_elt_at_index (mif->rx_queues, i);
337 vlib_cli_output (vm, " %U", format_memif_queue, mif, mq, i);
339 vlib_cli_output (vm, " %U", format_memif_descriptor, mif, mq);
343 vec_free (hw_if_indices);
348 VLIB_CLI_COMMAND (memif_show_command, static) = {
349 .path = "show memif",
350 .short_help = "show memif {<interface>] [descriptors]",
351 .function = memif_show_command_fn,
356 memif_cli_init (vlib_main_t * vm)
361 VLIB_INIT_FUNCTION (memif_cli_init);
364 * fd.io coding-style-patch-verification: ON
367 * eval: (c-set-style "gnu")