src/vnet/devices/netmap/cli.c

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2016 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *------------------------------------------------------------------
  16  */
  17 #include <stdint.h>
  18 #include <net/if.h>
  19 #include <sys/ioctl.h>
  20
  21 #include <vlib/vlib.h>
  22 #include <vlib/unix/unix.h>
  23 #include <vnet/ethernet/ethernet.h>
  24
  25 #include <vnet/devices/netmap/net_netmap.h>
  26 #include <vnet/devices/netmap/netmap.h>
  27
  28 static clib_error_t *
  29 netmap_create_command_fn (vlib_main_t * vm, unformat_input_t * input,
  30                           vlib_cli_command_t * cmd)
  31 {
  32   unformat_input_t _line_input, *line_input = &_line_input;
  33   u8 *host_if_name = NULL;
  34   u8 hwaddr[6];
  35   u8 *hw_addr_ptr = 0;
  36   int r;
  37   u8 is_pipe = 0;
  38   u8 is_master = 0;
  39   u32 sw_if_index = ~0;
  40
  41   /* Get a line of input. */
  42   if (!unformat_user (input, unformat_line_input, line_input))
  43     return 0;
  44
  45   while (unformat_check_input (line_input) != UNFORMAT_END_OF_INPUT)
  46     {
  47       if (unformat (line_input, "name %s", &host_if_name))
  48         ;
  49       else
  50         if (unformat
  51             (line_input, "hw-addr %U", unformat_ethernet_address, hwaddr))
  52         hw_addr_ptr = hwaddr;
  53       else if (unformat (line_input, "pipe"))
  54         is_pipe = 1;
  55       else if (unformat (line_input, "master"))
  56         is_master = 1;
  57       else if (unformat (line_input, "slave"))
  58         is_master = 0;
  59       else
  60         return clib_error_return (0, "unknown input `%U'",
  61                                   format_unformat_error, input);
  62     }
  63   unformat_free (line_input);
  64
  65   if (host_if_name == NULL)
  66     return clib_error_return (0, "missing host interface name");
  67
  68   r =
  69     netmap_create_if (vm, host_if_name, hw_addr_ptr, is_pipe, is_master,
  70                       &sw_if_index);
  71
  72   if (r == VNET_API_ERROR_SYSCALL_ERROR_1)
  73     return clib_error_return (0, "%s (errno %d)", strerror (errno), errno);
  74
  75   if (r == VNET_API_ERROR_INVALID_INTERFACE)
  76     return clib_error_return (0, "Invalid interface name");
  77
  78   if (r == VNET_API_ERROR_SUBIF_ALREADY_EXISTS)
  79     return clib_error_return (0, "Interface already exists");
  80
  81   vlib_cli_output (vm, "%U\n", format_vnet_sw_if_index_name, vnet_get_main (),
  82                    sw_if_index);
  83   return 0;
  84 }
  85
  86 /*?
  87  * '<em>netmap</em>' is a framework for very fast packet I/O from userspace.
  88  * '<em>VALE</em>' is an equally fast in-kernel software switch using the
  89  * netmap API. '<em>netmap</em>' includes '<em>netmap pipes</em>', a shared
  90  * memory packet transport channel. Together, they provide a high speed
  91  * user-space interface that allows VPP to patch into a linux namespace, a
  92  * linux container, or a physical NIC without the use of DPDK. Netmap/VALE
  93  * generates the '<em>netmap.ko</em>' kernel module that needs to be loaded
  94  * before netmap interfaces can be created.
  95  * - https://github.com/luigirizzo/netmap - Netmap/VALE repo.
  96  * - https://github.com/vpp-dev/netmap - VPP development package for Netmap/VALE,
  97  * which is a snapshot of the Netmap/VALE repo with minor changes to work
  98  * with containers and modified kernel drivers to work with NICs.
  99  *
 100  * Create a netmap interface that will attach to a linux interface.
 101  * The interface must already exist. Once created, a new netmap interface
 102  * will exist in VPP with the name '<em>netmap-<ifname></em>', where
 103  * '<em><ifname></em>' takes one of two forms:
 104  * - <b>ifname</b> - Linux interface to bind too.
 105  * - <b>valeXXX:YYY</b> -
 106  *   - Where '<em>valeXXX</em>' is an arbitrary name for a VALE
 107  *     interface that must start with '<em>vale</em>' and is less
 108  *     than 16 characters.
 109  *   - Where '<em>YYY</em>' is an existing linux namespace.
 110  *
 111  * This command has the following optional parameters:
 112  *
 113  * - <b>hw-addr <mac-addr></b> - Optional ethernet address, can be in either
 114  * X:X:X:X:X:X unix or X.X.X cisco format.
 115  *
 116  * - <b>pipe</b> - Optional flag to indicate that a '<em>netmap pipe</em>'
 117  * instance should be created.
 118  *
 119  * - <b>master | slave</b> - Optional flag to indicate whether VPP should
 120  * be the master or slave of the '<em>netmap pipe</em>'. Only considered
 121  * if '<em>pipe</em>' is entered. Defaults to '<em>slave</em>' if not entered.
 122  *
 123  * @cliexpar
 124  * Example of how to create a netmap interface tied to the linux
 125  * namespace '<em>vpp1</em>':
 126  * @cliexstart{create netmap name vale00:vpp1 hw-addr 02:FE:3F:34:15:9B pipe master}
 127  * netmap-vale00:vpp1
 128  * @cliexend
 129  * Once the netmap interface is created, enable the interface using:
 130  * @cliexcmd{set interface state netmap-vale00:vpp1 up}
 131 ?*/
 132 /* *INDENT-OFF* */
 133 VLIB_CLI_COMMAND (netmap_create_command, static) = {
 134   .path = "create netmap",
 135   .short_help = "create netmap name <ifname>|valeXXX:YYY "
 136     "[hw-addr <mac-addr>] [pipe] [master|slave]",
 137   .function = netmap_create_command_fn,
 138 };
 139 /* *INDENT-ON* */
 140
 141 static clib_error_t *
 142 netmap_delete_command_fn (vlib_main_t * vm, unformat_input_t * input,
 143                           vlib_cli_command_t * cmd)
 144 {
 145   unformat_input_t _line_input, *line_input = &_line_input;
 146   u8 *host_if_name = 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         return clib_error_return (0, "unknown input `%U'",
 158                                   format_unformat_error, input);
 159     }
 160   unformat_free (line_input);
 161
 162   if (host_if_name == NULL)
 163     return clib_error_return (0, "missing host interface name");
 164
 165   netmap_delete_if (vm, host_if_name);
 166
 167   return 0;
 168 }
 169
 170 /*?
 171  * Delete a netmap interface. Use the '<em><ifname></em>' to identify
 172  * the netmap interface to be deleted. In VPP, netmap interfaces are
 173  * named as '<em>netmap-<ifname></em>', where '<em><ifname></em>'
 174  * takes one of two forms:
 175  * - <b>ifname</b> - Linux interface to bind too.
 176  * - <b>valeXXX:YYY</b> -
 177  *   - Where '<em>valeXXX</em>' is an arbitrary name for a VALE
 178  *     interface that must start with '<em>vale</em>' and is less
 179  *     than 16 characters.
 180  *   - Where '<em>YYY</em>' is an existing linux namespace.
 181  *
 182  * @cliexpar
 183  * Example of how to delete a netmap interface named '<em>netmap-vale00:vpp1</em>':
 184  * @cliexcmd{delete netmap name vale00:vpp1}
 185 ?*/
 186 /* *INDENT-OFF* */
 187 VLIB_CLI_COMMAND (netmap_delete_command, static) = {
 188   .path = "delete netmap",
 189   .short_help = "delete netmap name <ifname>|valeXXX:YYY",
 190   .function = netmap_delete_command_fn,
 191 };
 192 /* *INDENT-ON* */
 193
 194 clib_error_t *
 195 netmap_cli_init (vlib_main_t * vm)
 196 {
 197   return 0;
 198 }
 199
 200 VLIB_INIT_FUNCTION (netmap_cli_init);
 201
 202 /*
 203  * fd.io coding-style-patch-verification: ON
 204  *
 205  * Local Variables:
 206  * eval: (c-set-style "gnu")
 207  * End:
 208  */