diff options
author | Mohsin Kazmi <sykazmi@cisco.com> | 2022-12-14 13:10:29 +0000 |
---|---|---|
committer | Dave Wallace <dwallacelf@gmail.com> | 2022-12-21 18:33:51 +0000 |
commit | bca76580b17bbb6227f48b9ea4a5858802656962 (patch) | |
tree | ba8df625df7a4de1ea5fd970493d7cda74deedb7 /src/plugins/af_packet/cli.c | |
parent | bb98aac4223f506ec18109f9836daa6ef0d61180 (diff) |
af_packet: move to plugin
Type: improvement
Signed-off-by: Mohsin Kazmi <sykazmi@cisco.com>
Change-Id: I3ec857adb3a9e8a778072a202a4d23f4101e83b2
Diffstat (limited to 'src/plugins/af_packet/cli.c')
-rw-r--r-- | src/plugins/af_packet/cli.c | 295 |
1 files changed, 295 insertions, 0 deletions
diff --git a/src/plugins/af_packet/cli.c b/src/plugins/af_packet/cli.c new file mode 100644 index 00000000000..6a8377540d8 --- /dev/null +++ b/src/plugins/af_packet/cli.c @@ -0,0 +1,295 @@ +/* + *------------------------------------------------------------------ + * af_packet.c - linux kernel packet interface + * + * Copyright (c) 2016 Cisco and/or its affiliates. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + *------------------------------------------------------------------ + */ + +#include <fcntl.h> /* for open */ +#include <sys/ioctl.h> +#include <sys/socket.h> +#include <sys/stat.h> +#include <sys/types.h> +#include <sys/uio.h> /* for iovec */ +#include <netinet/in.h> + +#include <vlib/vlib.h> +#include <vlib/unix/unix.h> +#include <vnet/ip/ip.h> +#include <vnet/ethernet/ethernet.h> + +#include <af_packet/af_packet.h> + +/** + * @file + * @brief CLI for Host Interface Device Driver. + * + * This file contains the source code for CLI for the host interface. + */ + +static clib_error_t * +af_packet_create_command_fn (vlib_main_t * vm, unformat_input_t * input, + vlib_cli_command_t * cmd) +{ + unformat_input_t _line_input, *line_input = &_line_input; + af_packet_create_if_arg_t _arg, *arg = &_arg; + clib_error_t *error = NULL; + u8 hwaddr[6]; + int r; + + clib_memset (arg, 0, sizeof (*arg)); + + // Default mode + arg->mode = AF_PACKET_IF_MODE_ETHERNET; + + // Default number of rx/tx queue(s) + arg->num_rxqs = 1; + arg->num_txqs = 1; + + // Default flags + arg->flags = AF_PACKET_IF_FLAGS_QDISC_BYPASS | AF_PACKET_IF_FLAGS_CKSUM_GSO; + + /* Get a line of input. */ + if (!unformat_user (input, unformat_line_input, line_input)) + return 0; + + while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) + { + if (unformat (line_input, "name %s", &arg->host_if_name)) + ; + else if (unformat (line_input, "rx-size %u", &arg->rx_frame_size)) + ; + else if (unformat (line_input, "tx-size %u", &arg->tx_frame_size)) + ; + else if (unformat (line_input, "rx-per-block %u", + &arg->rx_frames_per_block)) + ; + else if (unformat (line_input, "tx-per-block %u", + &arg->tx_frames_per_block)) + ; + else if (unformat (line_input, "num-rx-queues %u", &arg->num_rxqs)) + ; + else if (unformat (line_input, "num-tx-queues %u", &arg->num_txqs)) + ; + else if (unformat (line_input, "qdisc-bypass-disable")) + arg->flags &= ~AF_PACKET_IF_FLAGS_QDISC_BYPASS; + else if (unformat (line_input, "cksum-gso-disable")) + arg->flags &= ~AF_PACKET_IF_FLAGS_CKSUM_GSO; + else if (unformat (line_input, "mode ip")) + arg->mode = AF_PACKET_IF_MODE_IP; + else if (unformat (line_input, "v2")) + arg->is_v2 = 1; + else if (unformat (line_input, "hw-addr %U", unformat_ethernet_address, + hwaddr)) + arg->hw_addr = hwaddr; + else + { + error = clib_error_return (0, "unknown input `%U'", + format_unformat_error, line_input); + goto done; + } + } + + if (arg->host_if_name == NULL) + { + error = clib_error_return (0, "missing host interface name"); + goto done; + } + + r = af_packet_create_if (arg); + + if (r == VNET_API_ERROR_SYSCALL_ERROR_1) + { + error = clib_error_return (0, "%s (errno %d)", strerror (errno), errno); + goto done; + } + + if (r == VNET_API_ERROR_INVALID_INTERFACE) + { + error = clib_error_return (0, "Invalid interface name"); + goto done; + } + + if (r == VNET_API_ERROR_SUBIF_ALREADY_EXISTS) + { + error = clib_error_return (0, "Interface already exists"); + goto done; + } + + vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main (), + arg->sw_if_index); + +done: + vec_free (arg->host_if_name); + unformat_free (line_input); + + return error; +} + +/*? + * Create a host interface that will attach to a linux AF_PACKET + * interface, one side of a veth pair. The veth pair must already + * exist. Once created, a new host interface will exist in VPP + * with the name '<em>host-<ifname></em>', where '<em><ifname></em>' + * is the name of the specified veth pair. Use the + * '<em>show interface</em>' command to display host interface details. + * + * This command has the following optional parameters: + * + * - <b>hw-addr <mac-addr></b> - Optional ethernet address, can be in either + * X:X:X:X:X:X unix or X.X.X cisco format. + * + * @cliexpar + * Example of how to create a host interface tied to one side of an + * existing linux veth pair named vpp1: + * @cliexstart{create host-interface name vpp1} + * host-vpp1 + * @cliexend + * Once the host interface is created, enable the interface using: + * @cliexcmd{set interface state host-vpp1 up} +?*/ +VLIB_CLI_COMMAND (af_packet_create_command, static) = { + .path = "create host-interface", + .short_help = "create host-interface [v2] name <ifname> [num-rx-queues <n>] " + "[num-tx-queues <n>] [hw-addr <mac-addr>] [mode ip] " + "[qdisc-bypass-disable] [cksum-gso-disable]", + .function = af_packet_create_command_fn, +}; + +static clib_error_t * +af_packet_delete_command_fn (vlib_main_t * vm, unformat_input_t * input, + vlib_cli_command_t * cmd) +{ + unformat_input_t _line_input, *line_input = &_line_input; + u8 *host_if_name = NULL; + clib_error_t *error = NULL; + + /* Get a line of input. */ + if (!unformat_user (input, unformat_line_input, line_input)) + return 0; + + while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) + { + if (unformat (line_input, "name %s", &host_if_name)) + ; + else + { + error = clib_error_return (0, "unknown input `%U'", + format_unformat_error, line_input); + goto done; + } + } + + if (host_if_name == NULL) + { + error = clib_error_return (0, "missing host interface name"); + goto done; + } + + af_packet_delete_if (host_if_name); + +done: + vec_free (host_if_name); + unformat_free (line_input); + + return error; +} + +/*? + * Delete a host interface. Use the linux interface name to identify + * the host interface to be deleted. In VPP, host interfaces are + * named as '<em>host-<ifname></em>', where '<em><ifname></em>' + * is the name of the linux interface. + * + * @cliexpar + * Example of how to delete a host interface named host-vpp1: + * @cliexcmd{delete host-interface name vpp1} +?*/ +VLIB_CLI_COMMAND (af_packet_delete_command, static) = { + .path = "delete host-interface", + .short_help = "delete host-interface name <ifname>", + .function = af_packet_delete_command_fn, +}; + +static clib_error_t * +af_packet_set_l4_cksum_offload_command_fn (vlib_main_t * vm, + unformat_input_t * input, + vlib_cli_command_t * cmd) +{ + unformat_input_t _line_input, *line_input = &_line_input; + u8 set = 0; + clib_error_t *error = NULL; + vnet_main_t *vnm = vnet_get_main (); + u32 sw_if_index; + + if (!unformat_user (input, unformat_line_input, line_input)) + return 0; + + while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT) + { + if (unformat (line_input, "%U", unformat_vnet_sw_interface, vnm, + &sw_if_index)) + ; + else if (unformat (line_input, "on")) + set = 1; + else if (unformat (line_input, "off")) + set = 0; + else + { + error = clib_error_return (0, "unknown input '%U'", + format_unformat_error, line_input); + goto done; + } + } + + if (af_packet_set_l4_cksum_offload (sw_if_index, set) < 0) + error = clib_error_return (0, "not an af_packet interface"); + +done: + unformat_free (line_input); + return error; +} + +/*? + * Set TCP/UDP offload checksum calculation. Use interface + * name to identify the interface to set TCP/UDP offload checksum + * calculation. + * + * @cliexpar + * Example of how to set TCP/UDP offload checksum calculation on host-vpp0: + * @cliexcmd{set host-interface l4-cksum-offload host-vpp0 off} + * @cliexcmd{set host-interface l4-cksum-offload host-vpp0 on} +?*/ +VLIB_CLI_COMMAND (af_packet_set_l4_cksum_offload_command, static) = { + .path = "set host-interface l4-cksum-offload", + .short_help = "set host-interface l4-cksum-offload <host-if-name> <on|off>", + .function = af_packet_set_l4_cksum_offload_command_fn, +}; + +clib_error_t * +af_packet_cli_init (vlib_main_t * vm) +{ + return 0; +} + +VLIB_INIT_FUNCTION (af_packet_cli_init); + +/* + * fd.io coding-style-patch-verification: ON + * + * Local Variables: + * eval: (c-set-style "gnu") + * End: + */ |