src/vnet/devices/af_packet/cli.c

   1 /*
   2  *------------------------------------------------------------------
   3  * af_packet.c - linux kernel packet interface
   4  *
   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:
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  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  *------------------------------------------------------------------
  18  */
  19
  20 #include <fcntl.h>              /* for open */
  21 #include <sys/ioctl.h>
  22 #include <sys/socket.h>
  23 #include <sys/stat.h>
  24 #include <sys/types.h>
  25 #include <sys/uio.h>            /* for iovec */
  26 #include <netinet/in.h>
  27
  28 #include <vlib/vlib.h>
  29 #include <vlib/unix/unix.h>
  30 #include <vnet/ip/ip.h>
  31 #include <vnet/ethernet/ethernet.h>
  32
  33 #include <vnet/devices/af_packet/af_packet.h>
  34
  35 /**
  36  * @file
  37  * @brief CLI for Host Interface Device Driver.
  38  *
  39  * This file contains the source code for CLI for the host interface.
  40  */
  41
  42 static clib_error_t *
  43 af_packet_create_command_fn (vlib_main_t * vm, unformat_input_t * input,
  44                              vlib_cli_command_t * cmd)
  45 {
  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;
  49   u8 hwaddr[6];
  50   int r;
  51
  52   clib_memset (arg, 0, sizeof (*arg));
  53
  54   // Default mode
  55   arg->mode = AF_PACKET_IF_MODE_ETHERNET;
  56
  57   // Default number of rx/tx queue(s)
  58   arg->num_rxqs = 1;
  59   arg->num_txqs = 1;
  60
  61   // Default flags
  62   arg->flags = AF_PACKET_IF_FLAGS_QDISC_BYPASS;
  63
  64   /* Get a line of input. */
  65   if (!unformat_user (input, unformat_line_input, line_input))
  66     return 0;
  67
  68   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
  69     {
  70       if (unformat (line_input, "name %s", &arg->host_if_name))
  71         ;
  72       else if (unformat (line_input, "rx-size %u", &arg->rx_frame_size))
  73         ;
  74       else if (unformat (line_input, "tx-size %u", &arg->tx_frame_size))
  75         ;
  76       else if (unformat (line_input, "rx-per-block %u",
  77                          &arg->rx_frames_per_block))
  78         ;
  79       else if (unformat (line_input, "tx-per-block %u",
  80                          &arg->tx_frames_per_block))
  81         ;
  82       else if (unformat (line_input, "num-rx-queues %u", &arg->num_rxqs))
  83         ;
  84       else if (unformat (line_input, "num-tx-queues %u", &arg->num_txqs))
  85         ;
  86       else if (unformat (line_input, "qdisc-bypass-disable"))
  87         arg->flags &= ~AF_PACKET_IF_FLAGS_QDISC_BYPASS;
  88       else if (unformat (line_input, "mode ip"))
  89         arg->mode = AF_PACKET_IF_MODE_IP;
  90       else if (unformat (line_input, "hw-addr %U", unformat_ethernet_address,
  91                          hwaddr))
  92         arg->hw_addr = hwaddr;
  93       else
  94         {
  95           error = clib_error_return (0, "unknown input `%U'",
  96                                      format_unformat_error, line_input);
  97           goto done;
  98         }
  99     }
 100
 101   if (arg->host_if_name == NULL)
 102     {
 103       error = clib_error_return (0, "missing host interface name");
 104       goto done;
 105     }
 106
 107   r = af_packet_create_if (arg);
 108
 109   if (r == VNET_API_ERROR_SYSCALL_ERROR_1)
 110     {
 111       error = clib_error_return (0, "%s (errno %d)", strerror (errno), errno);
 112       goto done;
 113     }
 114
 115   if (r == VNET_API_ERROR_INVALID_INTERFACE)
 116     {
 117       error = clib_error_return (0, "Invalid interface name");
 118       goto done;
 119     }
 120
 121   if (r == VNET_API_ERROR_SUBIF_ALREADY_EXISTS)
 122     {
 123       error = clib_error_return (0, "Interface already exists");
 124       goto done;
 125     }
 126
 127   vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main (),
 128                    arg->sw_if_index);
 129
 130 done:
 131   vec_free (arg->host_if_name);
 132   unformat_free (line_input);
 133
 134   return error;
 135 }
 136
 137 /*?
 138  * Create a host interface that will attach to a linux AF_PACKET
 139  * interface, one side of a veth pair. The veth pair must already
 140  * exist. Once created, a new host interface will exist in VPP
 141  * with the name '<em>host-<ifname></em>', where '<em><ifname></em>'
 142  * is the name of the specified veth pair. Use the
 143  * '<em>show interface</em>' command to display host interface details.
 144  *
 145  * This command has the following optional parameters:
 146  *
 147  * - <b>hw-addr <mac-addr></b> - Optional ethernet address, can be in either
 148  * X:X:X:X:X:X unix or X.X.X cisco format.
 149  *
 150  * @cliexpar
 151  * Example of how to create a host interface tied to one side of an
 152  * existing linux veth pair named vpp1:
 153  * @cliexstart{create host-interface name vpp1}
 154  * host-vpp1
 155  * @cliexend
 156  * Once the host interface is created, enable the interface using:
 157  * @cliexcmd{set interface state host-vpp1 up}
 158 ?*/
 159 VLIB_CLI_COMMAND (af_packet_create_command, static) = {
 160   .path = "create host-interface",
 161   .short_help = "create host-interface name <ifname> [num-rx-queues <n>] "
 162                 "[num-tx-queues <n>] [hw-addr <mac-addr>] [mode ip] "
 163                 "[qdisc-bypass-disable]",
 164   .function = af_packet_create_command_fn,
 165 };
 166
 167 static clib_error_t *
 168 af_packet_delete_command_fn (vlib_main_t * vm, unformat_input_t * input,
 169                              vlib_cli_command_t * cmd)
 170 {
 171   unformat_input_t _line_input, *line_input = &_line_input;
 172   u8 *host_if_name = NULL;
 173   clib_error_t *error = NULL;
 174
 175   /* Get a line of input. */
 176   if (!unformat_user (input, unformat_line_input, line_input))
 177     return 0;
 178
 179   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 180     {
 181       if (unformat (line_input, "name %s", &host_if_name))
 182         ;
 183       else
 184         {
 185           error = clib_error_return (0, "unknown input `%U'",
 186                                      format_unformat_error, line_input);
 187           goto done;
 188         }
 189     }
 190
 191   if (host_if_name == NULL)
 192     {
 193       error = clib_error_return (0, "missing host interface name");
 194       goto done;
 195     }
 196
 197   af_packet_delete_if (host_if_name);
 198
 199 done:
 200   vec_free (host_if_name);
 201   unformat_free (line_input);
 202
 203   return error;
 204 }
 205
 206 /*?
 207  * Delete a host interface. Use the linux interface name to identify
 208  * the host interface to be deleted. In VPP, host interfaces are
 209  * named as '<em>host-<ifname></em>', where '<em><ifname></em>'
 210  * is the name of the linux interface.
 211  *
 212  * @cliexpar
 213  * Example of how to delete a host interface named host-vpp1:
 214  * @cliexcmd{delete host-interface name vpp1}
 215 ?*/
 216 VLIB_CLI_COMMAND (af_packet_delete_command, static) = {
 217   .path = "delete host-interface",
 218   .short_help = "delete host-interface name <ifname>",
 219   .function = af_packet_delete_command_fn,
 220 };
 221
 222 static clib_error_t *
 223 af_packet_set_l4_cksum_offload_command_fn (vlib_main_t * vm,
 224                                            unformat_input_t * input,
 225                                            vlib_cli_command_t * cmd)
 226 {
 227   unformat_input_t _line_input, *line_input = &_line_input;
 228   u8 set = 0;
 229   clib_error_t *error = NULL;
 230   vnet_main_t *vnm = vnet_get_main ();
 231   u32 sw_if_index;
 232
 233   if (!unformat_user (input, unformat_line_input, line_input))
 234     return 0;
 235
 236   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
 237     {
 238       if (unformat (line_input, "%U", unformat_vnet_sw_interface, vnm,
 239                     &sw_if_index))
 240         ;
 241       else if (unformat (line_input, "on"))
 242         set = 1;
 243       else if (unformat (line_input, "off"))
 244         set = 0;
 245       else
 246         {
 247           error = clib_error_return (0, "unknown input '%U'",
 248                                      format_unformat_error, line_input);
 249           goto done;
 250         }
 251     }
 252
 253   if (af_packet_set_l4_cksum_offload (sw_if_index, set) < 0)
 254     error = clib_error_return (0, "not an af_packet interface");
 255
 256 done:
 257   unformat_free (line_input);
 258   return error;
 259 }
 260
 261 /*?
 262  * Set TCP/UDP offload checksum calculation. Use interface
 263  * name to identify the interface to set TCP/UDP offload checksum
 264  * calculation.
 265  *
 266  * @cliexpar
 267  * Example of how to set TCP/UDP offload checksum calculation on host-vpp0:
 268  * @cliexcmd{set host-interface l4-cksum-offload host-vpp0 off}
 269  * @cliexcmd{set host-interface l4-cksum-offload host-vpp0 on}
 270 ?*/
 271 VLIB_CLI_COMMAND (af_packet_set_l4_cksum_offload_command, static) = {
 272   .path = "set host-interface l4-cksum-offload",
 273   .short_help = "set host-interface l4-cksum-offload <host-if-name> <on|off>",
 274   .function = af_packet_set_l4_cksum_offload_command_fn,
 275 };
 276
 277 clib_error_t *
 278 af_packet_cli_init (vlib_main_t * vm)
 279 {
 280   return 0;
 281 }
 282
 283 VLIB_INIT_FUNCTION (af_packet_cli_init);
 284
 285 /*
 286  * fd.io coding-style-patch-verification: ON
 287  *
 288  * Local Variables:
 289  * eval: (c-set-style "gnu")
 290  * End:
 291  */