doc/guides/nics/tap.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2016 Intel Corporation.
   3
   4 Tap Poll Mode Driver
   5 ====================
   6
   7 The ``rte_eth_tap.c`` PMD creates a device using TAP interfaces on the
   8 local host. The PMD allows for DPDK and the host to communicate using a raw
   9 device interface on the host and in the DPDK application.
  10
  11 The device created is a TAP device, which sends/receives packet in a raw
  12 format with a L2 header. The usage for a TAP PMD is for connectivity to the
  13 local host using a TAP interface. When the TAP PMD is initialized it will
  14 create a number of tap devices in the host accessed via ``ifconfig -a`` or
  15 ``ip`` command. The commands can be used to assign and query the virtual like
  16 device.
  17
  18 These TAP interfaces can be used with Wireshark or tcpdump or Pktgen-DPDK
  19 along with being able to be used as a network connection to the DPDK
  20 application. The method enable one or more interfaces is to use the
  21 ``--vdev=net_tap0`` option on the DPDK application command line. Each
  22 ``--vdev=net_tap1`` option given will create an interface named dtap0, dtap1,
  23 and so on.
  24
  25 The interface name can be changed by adding the ``iface=foo0``, for example::
  26
  27    --vdev=net_tap0,iface=foo0 --vdev=net_tap1,iface=foo1, ...
  28
  29 Normally the PMD will generate a random MAC address, but when testing or with
  30 a static configuration the developer may need a fixed MAC address style.
  31 Using the option ``mac=fixed`` you can create a fixed known MAC address::
  32
  33    --vdev=net_tap0,mac=fixed
  34
  35 The MAC address will have a fixed value with the last octet incrementing by one
  36 for each interface string containing ``mac=fixed``. The MAC address is formatted
  37 as 00:'d':'t':'a':'p':[00-FF]. Convert the characters to hex and you get the
  38 actual MAC address: ``00:64:74:61:70:[00-FF]``.
  39
  40 It is possible to specify a remote netdevice to capture packets from by adding
  41 ``remote=foo1``, for example::
  42
  43    --vdev=net_tap,iface=tap0,remote=foo1
  44
  45 If a ``remote`` is set, the tap MAC address will be set to match the remote one
  46 just after netdevice creation. Using TC rules, traffic from the remote netdevice
  47 will be redirected to the tap. If the tap is in promiscuous mode, then all
  48 packets will be redirected. In allmulti mode, all multicast packets will be
  49 redirected.
  50
  51 Using the remote feature is especially useful for capturing traffic from a
  52 netdevice that has no support in the DPDK. It is possible to add explicit
  53 rte_flow rules on the tap PMD to capture specific traffic (see next section for
  54 examples).
  55
  56 After the DPDK application is started you can send and receive packets on the
  57 interface using the standard rx_burst/tx_burst APIs in DPDK. From the host
  58 point of view you can use any host tool like tcpdump, Wireshark, ping, Pktgen
  59 and others to communicate with the DPDK application. The DPDK application may
  60 not understand network protocols like IPv4/6, UDP or TCP unless the
  61 application has been written to understand these protocols.
  62
  63 If you need the interface as a real network interface meaning running and has
  64 a valid IP address then you can do this with the following commands::
  65
  66    sudo ip link set dtap0 up; sudo ip addr add 192.168.0.250/24 dev dtap0
  67    sudo ip link set dtap1 up; sudo ip addr add 192.168.1.250/24 dev dtap1
  68
  69 Please change the IP addresses as you see fit.
  70
  71 If routing is enabled on the host you can also communicate with the DPDK App
  72 over the internet via a standard socket layer application as long as you
  73 account for the protocol handing in the application.
  74
  75 If you have a Network Stack in your DPDK application or something like it you
  76 can utilize that stack to handle the network protocols. Plus you would be able
  77 to address the interface using an IP address assigned to the internal
  78 interface.
  79
  80 Flow API support
  81 ----------------
  82
  83 The tap PMD supports major flow API pattern items and actions, when running on
  84 linux kernels above 4.2 ("Flower" classifier required).
  85 The kernel support can be checked with this command::
  86
  87    zcat /proc/config.gz | ( grep 'CLS_FLOWER=' || echo 'not supported' ) |
  88    tee -a /dev/stderr | grep -q '=m' &&
  89    lsmod | ( grep cls_flower || echo 'try modprobe cls_flower' )
  90
  91 Supported items:
  92
  93 - eth: src and dst (with variable masks), and eth_type (0xffff mask).
  94 - vlan: vid, pcp, tpid, but not eid. (requires kernel 4.9)
  95 - ipv4/6: src and dst (with variable masks), and ip_proto (0xffff mask).
  96 - udp/tcp: src and dst port (0xffff) mask.
  97
  98 Supported actions:
  99
 100 - DROP
 101 - QUEUE
 102 - PASSTHRU
 103 - RSS (requires kernel 4.9)
 104
 105 It is generally not possible to provide a "last" item. However, if the "last"
 106 item, once masked, is identical to the masked spec, then it is supported.
 107
 108 Only IPv4/6 and MAC addresses can use a variable mask. All other items need a
 109 full mask (exact match).
 110
 111 As rules are translated to TC, it is possible to show them with something like::
 112
 113    tc -s filter show dev tap1 parent 1:
 114
 115 Examples of testpmd flow rules
 116 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 117
 118 Drop packets for destination IP 192.168.0.1::
 119
 120    testpmd> flow create 0 priority 1 ingress pattern eth / ipv4 dst is 1.1.1.1 \
 121             / end actions drop / end
 122
 123 Ensure packets from a given MAC address are received on a queue 2::
 124
 125    testpmd> flow create 0 priority 2 ingress pattern eth src is 06:05:04:03:02:01 \
 126             / end actions queue index 2 / end
 127
 128 Drop UDP packets in vlan 3::
 129
 130    testpmd> flow create 0 priority 3 ingress pattern eth / vlan vid is 3 / \
 131             ipv4 proto is 17 / end actions drop / end
 132
 133 Distribute IPv4 TCP packets using RSS to a given MAC address over queues 0-3::
 134
 135    testpmd> flow create 0 priority 4 ingress pattern eth dst is 0a:0b:0c:0d:0e:0f \
 136             / ipv4 / tcp / end actions rss queues 0 1 2 3 end / end
 137
 138 Example
 139 -------
 140
 141 The following is a simple example of using the TAP PMD with the Pktgen
 142 packet generator. It requires that the ``socat`` utility is installed on the
 143 test system.
 144
 145 Build DPDK, then pull down Pktgen and build pktgen using the DPDK SDK/Target
 146 used to build the dpdk you pulled down.
 147
 148 Run pktgen from the pktgen directory in a terminal with a commandline like the
 149 following::
 150
 151     sudo ./app/app/x86_64-native-linuxapp-gcc/app/pktgen -l 1-5 -n 4        \
 152      --proc-type auto --log-level 8 --socket-mem 512,512 --file-prefix pg   \
 153      --vdev=net_tap0 --vdev=net_tap1 -b 05:00.0 -b 05:00.1                  \
 154      -b 04:00.0 -b 04:00.1 -b 04:00.2 -b 04:00.3                            \
 155      -b 81:00.0 -b 81:00.1 -b 81:00.2 -b 81:00.3                            \
 156      -b 82:00.0 -b 83:00.0 -- -T -P -m [2:3].0 -m [4:5].1                   \
 157      -f themes/black-yellow.theme
 158
 159 .. Note:
 160
 161    Change the ``-b`` options to blacklist all of your physical ports. The
 162    following command line is all one line.
 163
 164    Also, ``-f themes/black-yellow.theme`` is optional if the default colors
 165    work on your system configuration. See the Pktgen docs for more
 166    information.
 167
 168 Verify with ``ifconfig -a`` command in a different xterm window, should have a
 169 ``dtap0`` and ``dtap1`` interfaces created.
 170
 171 Next set the links for the two interfaces to up via the commands below::
 172
 173     sudo ip link set dtap0 up; sudo ip addr add 192.168.0.250/24 dev dtap0
 174     sudo ip link set dtap1 up; sudo ip addr add 192.168.1.250/24 dev dtap1
 175
 176 Then use socat to create a loopback for the two interfaces::
 177
 178     sudo socat interface:dtap0 interface:dtap1
 179
 180 Then on the Pktgen command line interface you can start sending packets using
 181 the commands ``start 0`` and ``start 1`` or you can start both at the same
 182 time with ``start all``. The command ``str`` is an alias for ``start all`` and
 183 ``stp`` is an alias for ``stop all``.
 184
 185 While running you should see the 64 byte counters increasing to verify the
 186 traffic is being looped back. You can use ``set all size XXX`` to change the
 187 size of the packets after you stop the traffic. Use pktgen ``help``
 188 command to see a list of all commands. You can also use the ``-f`` option to
 189 load commands at startup in command line or Lua script in pktgen.
 190
 191 RSS specifics
 192 -------------
 193 Packet distribution in TAP is done by the kernel which has a default
 194 distribution. This feature is adding RSS distribution based on eBPF code.
 195 The default eBPF code calculates RSS hash based on Toeplitz algorithm for
 196 a fixed RSS key. It is calculated on fixed packet offsets. For IPv4 and IPv6 it
 197 is calculated over src/dst addresses (8 or 32 bytes for IPv4 or IPv6
 198 respectively) and src/dst TCP/UDP ports (4 bytes).
 199
 200 The RSS algorithm is written in file ``tap_bpf_program.c`` which
 201 does not take part in TAP PMD compilation. Instead this file is compiled
 202 in advance to eBPF object file. The eBPF object file is then parsed and
 203 translated into eBPF byte code in the format of C arrays of eBPF
 204 instructions. The C array of eBPF instructions is part of TAP PMD tree and
 205 is taking part in TAP PMD compilation. At run time the C arrays are uploaded to
 206 the kernel via BPF system calls and the RSS hash is calculated by the
 207 kernel.
 208
 209 It is possible to support different RSS hash algorithms by updating file
 210 ``tap_bpf_program.c``  In order to add a new RSS hash algorithm follow these
 211 steps:
 212
 213 1. Write the new RSS implementation in file ``tap_bpf_program.c``
 214
 215 BPF programs which are uploaded to the kernel correspond to
 216 C functions under different ELF sections.
 217
 218 2. Install ``LLVM`` library and ``clang`` compiler versions 3.7 and above
 219
 220 3. Compile ``tap_bpf_program.c`` via ``LLVM`` into an object file::
 221
 222     clang -O2 -emit-llvm -c tap_bpf_program.c -o - | llc -march=bpf \
 223     -filetype=obj -o <tap_bpf_program.o>
 224
 225
 226 4. Use a tool that receives two parameters: an eBPF object file and a section
 227 name, and prints out the section as a C array of eBPF instructions.
 228 Embed the C array in your TAP PMD tree.
 229
 230 The C arrays are uploaded to the kernel using BPF system calls.
 231
 232 ``tc`` (traffic control) is a well known user space utility program used to
 233 configure the Linux kernel packet scheduler. It is usually packaged as
 234 part of the ``iproute2`` package.
 235 Since commit 11c39b5e9 ("tc: add eBPF support to f_bpf") ``tc`` can be used
 236 to uploads eBPF code to the kernel and can be patched in order to print the
 237 C arrays of eBPF instructions just before calling the BPF system call.
 238 Please refer to ``iproute2`` package file ``lib/bpf.c`` function
 239 ``bpf_prog_load()``.
 240
 241 An example utility for eBPF instruction generation in the format of C arrays will
 242 be added in next releases
 243
 244 Systems supporting flow API
 245 ---------------------------
 246
 247 - "tc flower" classifier requires linux kernel above 4.2
 248 - eBPF/RSS requires linux kernel above 4.9
 249
 250 +--------------------+-----------------------+
 251 | RH7.3              | No flow rule support  |
 252 +--------------------+-----------------------+
 253 | RH7.4              | No RSS action support |
 254 +--------------------+-----------------------+
 255 | RH7.5              | No RSS action support |
 256 +--------------------+-----------------------+
 257 | SLES 15,           | No limitation         |
 258 | kernel 4.12        |                       |
 259 +--------------------+-----------------------+
 260 | Azure Ubuntu 16.04,| No limitation         |
 261 | kernel 4.13        |                       |
 262 +--------------------+-----------------------+
 263