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