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>
21 #include <vlib/vlib.h>
22 #include <vlib/unix/unix.h>
23 #include <vnet/ethernet/ethernet.h>
25 #include <vnet/devices/netmap/net_netmap.h>
26 #include <vnet/devices/netmap/netmap.h>
29 netmap_create_command_fn (vlib_main_t * vm, unformat_input_t * input,
30 vlib_cli_command_t * cmd)
32 unformat_input_t _line_input, *line_input = &_line_input;
33 u8 *host_if_name = NULL;
40 clib_error_t *error = NULL;
42 /* Get a line of input. */
43 if (!unformat_user (input, unformat_line_input, line_input))
46 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
48 if (unformat (line_input, "name %s", &host_if_name))
52 (line_input, "hw-addr %U", unformat_ethernet_address, hwaddr))
54 else if (unformat (line_input, "pipe"))
56 else if (unformat (line_input, "master"))
58 else if (unformat (line_input, "slave"))
62 error = clib_error_return (0, "unknown input `%U'",
63 format_unformat_error, line_input);
68 if (host_if_name == NULL)
70 error = clib_error_return (0, "missing host interface name");
75 netmap_create_if (vm, host_if_name, hw_addr_ptr, is_pipe, is_master,
78 if (r == VNET_API_ERROR_SYSCALL_ERROR_1)
80 error = clib_error_return (0, "%s (errno %d)", strerror (errno), errno);
84 if (r == VNET_API_ERROR_INVALID_INTERFACE)
86 error = clib_error_return (0, "Invalid interface name");
90 if (r == VNET_API_ERROR_SUBIF_ALREADY_EXISTS)
92 error = clib_error_return (0, "Interface already exists");
96 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main (),
100 unformat_free (line_input);
106 * '<em>netmap</em>' is a framework for very fast packet I/O from userspace.
107 * '<em>VALE</em>' is an equally fast in-kernel software switch using the
108 * netmap API. '<em>netmap</em>' includes '<em>netmap pipes</em>', a shared
109 * memory packet transport channel. Together, they provide a high speed
110 * user-space interface that allows VPP to patch into a linux namespace, a
111 * linux container, or a physical NIC without the use of DPDK. Netmap/VALE
112 * generates the '<em>netmap.ko</em>' kernel module that needs to be loaded
113 * before netmap interfaces can be created.
114 * - https://github.com/luigirizzo/netmap - Netmap/VALE repo.
115 * - https://github.com/vpp-dev/netmap - VPP development package for Netmap/VALE,
116 * which is a snapshot of the Netmap/VALE repo with minor changes to work
117 * with containers and modified kernel drivers to work with NICs.
119 * Create a netmap interface that will attach to a linux interface.
120 * The interface must already exist. Once created, a new netmap interface
121 * will exist in VPP with the name '<em>netmap-<ifname></em>', where
122 * '<em><ifname></em>' takes one of two forms:
123 * - <b>ifname</b> - Linux interface to bind too.
124 * - <b>valeXXX:YYY</b> -
125 * - Where '<em>valeXXX</em>' is an arbitrary name for a VALE
126 * interface that must start with '<em>vale</em>' and is less
127 * than 16 characters.
128 * - Where '<em>YYY</em>' is an existing linux namespace.
130 * This command has the following optional parameters:
132 * - <b>hw-addr <mac-addr></b> - Optional ethernet address, can be in either
133 * X:X:X:X:X:X unix or X.X.X cisco format.
135 * - <b>pipe</b> - Optional flag to indicate that a '<em>netmap pipe</em>'
136 * instance should be created.
138 * - <b>master | slave</b> - Optional flag to indicate whether VPP should
139 * be the master or slave of the '<em>netmap pipe</em>'. Only considered
140 * if '<em>pipe</em>' is entered. Defaults to '<em>slave</em>' if not entered.
143 * Example of how to create a netmap interface tied to the linux
144 * namespace '<em>vpp1</em>':
145 * @cliexstart{create netmap name vale00:vpp1 hw-addr 02:FE:3F:34:15:9B pipe master}
148 * Once the netmap interface is created, enable the interface using:
149 * @cliexcmd{set interface state netmap-vale00:vpp1 up}
152 VLIB_CLI_COMMAND (netmap_create_command, static) = {
153 .path = "create netmap",
154 .short_help = "create netmap name <ifname>|valeXXX:YYY "
155 "[hw-addr <mac-addr>] [pipe] [master|slave]",
156 .function = netmap_create_command_fn,
160 static clib_error_t *
161 netmap_delete_command_fn (vlib_main_t * vm, unformat_input_t * input,
162 vlib_cli_command_t * cmd)
164 unformat_input_t _line_input, *line_input = &_line_input;
165 u8 *host_if_name = NULL;
166 clib_error_t *error = NULL;
168 /* Get a line of input. */
169 if (!unformat_user (input, unformat_line_input, line_input))
172 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
174 if (unformat (line_input, "name %s", &host_if_name))
178 error = clib_error_return (0, "unknown input `%U'",
179 format_unformat_error, line_input);
184 if (host_if_name == NULL)
186 error = clib_error_return (0, "missing host interface name");
190 netmap_delete_if (vm, host_if_name);
193 unformat_free (line_input);
199 * Delete a netmap interface. Use the '<em><ifname></em>' to identify
200 * the netmap interface to be deleted. In VPP, netmap interfaces are
201 * named as '<em>netmap-<ifname></em>', where '<em><ifname></em>'
202 * takes one of two forms:
203 * - <b>ifname</b> - Linux interface to bind too.
204 * - <b>valeXXX:YYY</b> -
205 * - Where '<em>valeXXX</em>' is an arbitrary name for a VALE
206 * interface that must start with '<em>vale</em>' and is less
207 * than 16 characters.
208 * - Where '<em>YYY</em>' is an existing linux namespace.
211 * Example of how to delete a netmap interface named '<em>netmap-vale00:vpp1</em>':
212 * @cliexcmd{delete netmap name vale00:vpp1}
215 VLIB_CLI_COMMAND (netmap_delete_command, static) = {
216 .path = "delete netmap",
217 .short_help = "delete netmap name <ifname>|valeXXX:YYY",
218 .function = netmap_delete_command_fn,
223 netmap_cli_init (vlib_main_t * vm)
228 VLIB_INIT_FUNCTION (netmap_cli_init);
231 * fd.io coding-style-patch-verification: ON
234 * eval: (c-set-style "gnu")