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