2 *------------------------------------------------------------------
3 * af_packet.c - linux kernel packet interface
5 * Copyright (c) 2016 Cisco and/or its affiliates.
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at:
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *------------------------------------------------------------------
20 #include <fcntl.h> /* for open */
21 #include <sys/ioctl.h>
22 #include <sys/socket.h>
24 #include <sys/types.h>
25 #include <sys/uio.h> /* for iovec */
26 #include <netinet/in.h>
28 #include <vlib/vlib.h>
29 #include <vlib/unix/unix.h>
30 #include <vnet/ip/ip.h>
31 #include <vnet/ethernet/ethernet.h>
33 #include <vnet/devices/af_packet/af_packet.h>
37 * @brief CLI for Host Interface Device Driver.
39 * This file contains the source code for CLI for the host interface.
43 af_packet_create_command_fn (vlib_main_t * vm, unformat_input_t * input,
44 vlib_cli_command_t * cmd)
46 unformat_input_t _line_input, *line_input = &_line_input;
47 af_packet_create_if_arg_t _arg, *arg = &_arg;
48 clib_error_t *error = NULL;
52 clib_memset (arg, 0, sizeof (*arg));
55 arg->mode = AF_PACKET_IF_MODE_ETHERNET;
57 // Default number of rx/tx queue(s)
62 arg->flags = AF_PACKET_IF_FLAGS_QDISC_BYPASS | AF_PACKET_IF_FLAGS_CKSUM_GSO;
64 /* Get a line of input. */
65 if (!unformat_user (input, unformat_line_input, line_input))
68 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
70 if (unformat (line_input, "name %s", &arg->host_if_name))
72 else if (unformat (line_input, "rx-size %u", &arg->rx_frame_size))
74 else if (unformat (line_input, "tx-size %u", &arg->tx_frame_size))
76 else if (unformat (line_input, "rx-per-block %u",
77 &arg->rx_frames_per_block))
79 else if (unformat (line_input, "tx-per-block %u",
80 &arg->tx_frames_per_block))
82 else if (unformat (line_input, "num-rx-queues %u", &arg->num_rxqs))
84 else if (unformat (line_input, "num-tx-queues %u", &arg->num_txqs))
86 else if (unformat (line_input, "qdisc-bypass-disable"))
87 arg->flags &= ~AF_PACKET_IF_FLAGS_QDISC_BYPASS;
88 else if (unformat (line_input, "cksum-gso-disable"))
89 arg->flags &= ~AF_PACKET_IF_FLAGS_CKSUM_GSO;
90 else if (unformat (line_input, "mode ip"))
91 arg->mode = AF_PACKET_IF_MODE_IP;
92 else if (unformat (line_input, "hw-addr %U", unformat_ethernet_address,
94 arg->hw_addr = hwaddr;
97 error = clib_error_return (0, "unknown input `%U'",
98 format_unformat_error, line_input);
103 if (arg->host_if_name == NULL)
105 error = clib_error_return (0, "missing host interface name");
109 r = af_packet_create_if (arg);
111 if (r == VNET_API_ERROR_SYSCALL_ERROR_1)
113 error = clib_error_return (0, "%s (errno %d)", strerror (errno), errno);
117 if (r == VNET_API_ERROR_INVALID_INTERFACE)
119 error = clib_error_return (0, "Invalid interface name");
123 if (r == VNET_API_ERROR_SUBIF_ALREADY_EXISTS)
125 error = clib_error_return (0, "Interface already exists");
129 vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main (),
133 vec_free (arg->host_if_name);
134 unformat_free (line_input);
140 * Create a host interface that will attach to a linux AF_PACKET
141 * interface, one side of a veth pair. The veth pair must already
142 * exist. Once created, a new host interface will exist in VPP
143 * with the name '<em>host-<ifname></em>', where '<em><ifname></em>'
144 * is the name of the specified veth pair. Use the
145 * '<em>show interface</em>' command to display host interface details.
147 * This command has the following optional parameters:
149 * - <b>hw-addr <mac-addr></b> - Optional ethernet address, can be in either
150 * X:X:X:X:X:X unix or X.X.X cisco format.
153 * Example of how to create a host interface tied to one side of an
154 * existing linux veth pair named vpp1:
155 * @cliexstart{create host-interface name vpp1}
158 * Once the host interface is created, enable the interface using:
159 * @cliexcmd{set interface state host-vpp1 up}
161 VLIB_CLI_COMMAND (af_packet_create_command, static) = {
162 .path = "create host-interface",
163 .short_help = "create host-interface name <ifname> [num-rx-queues <n>] "
164 "[num-tx-queues <n>] [hw-addr <mac-addr>] [mode ip] "
165 "[qdisc-bypass-disable] [cksum-gso-disable]",
166 .function = af_packet_create_command_fn,
169 static clib_error_t *
170 af_packet_delete_command_fn (vlib_main_t * vm, unformat_input_t * input,
171 vlib_cli_command_t * cmd)
173 unformat_input_t _line_input, *line_input = &_line_input;
174 u8 *host_if_name = NULL;
175 clib_error_t *error = NULL;
177 /* Get a line of input. */
178 if (!unformat_user (input, unformat_line_input, line_input))
181 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
183 if (unformat (line_input, "name %s", &host_if_name))
187 error = clib_error_return (0, "unknown input `%U'",
188 format_unformat_error, line_input);
193 if (host_if_name == NULL)
195 error = clib_error_return (0, "missing host interface name");
199 af_packet_delete_if (host_if_name);
202 vec_free (host_if_name);
203 unformat_free (line_input);
209 * Delete a host interface. Use the linux interface name to identify
210 * the host interface to be deleted. In VPP, host interfaces are
211 * named as '<em>host-<ifname></em>', where '<em><ifname></em>'
212 * is the name of the linux interface.
215 * Example of how to delete a host interface named host-vpp1:
216 * @cliexcmd{delete host-interface name vpp1}
218 VLIB_CLI_COMMAND (af_packet_delete_command, static) = {
219 .path = "delete host-interface",
220 .short_help = "delete host-interface name <ifname>",
221 .function = af_packet_delete_command_fn,
224 static clib_error_t *
225 af_packet_set_l4_cksum_offload_command_fn (vlib_main_t * vm,
226 unformat_input_t * input,
227 vlib_cli_command_t * cmd)
229 unformat_input_t _line_input, *line_input = &_line_input;
231 clib_error_t *error = NULL;
232 vnet_main_t *vnm = vnet_get_main ();
235 if (!unformat_user (input, unformat_line_input, line_input))
238 while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
240 if (unformat (line_input, "%U", unformat_vnet_sw_interface, vnm,
243 else if (unformat (line_input, "on"))
245 else if (unformat (line_input, "off"))
249 error = clib_error_return (0, "unknown input '%U'",
250 format_unformat_error, line_input);
255 if (af_packet_set_l4_cksum_offload (sw_if_index, set) < 0)
256 error = clib_error_return (0, "not an af_packet interface");
259 unformat_free (line_input);
264 * Set TCP/UDP offload checksum calculation. Use interface
265 * name to identify the interface to set TCP/UDP offload checksum
269 * Example of how to set TCP/UDP offload checksum calculation on host-vpp0:
270 * @cliexcmd{set host-interface l4-cksum-offload host-vpp0 off}
271 * @cliexcmd{set host-interface l4-cksum-offload host-vpp0 on}
273 VLIB_CLI_COMMAND (af_packet_set_l4_cksum_offload_command, static) = {
274 .path = "set host-interface l4-cksum-offload",
275 .short_help = "set host-interface l4-cksum-offload <host-if-name> <on|off>",
276 .function = af_packet_set_l4_cksum_offload_command_fn,
280 af_packet_cli_init (vlib_main_t * vm)
285 VLIB_INIT_FUNCTION (af_packet_cli_init);
288 * fd.io coding-style-patch-verification: ON
291 * eval: (c-set-style "gnu")