From 6bcac917bfa5121aca2f387b906ec6a9b4e4c533 Mon Sep 17 00:00:00 2001 From: Fred Klassen Date: Mon, 4 Sep 2023 14:06:57 -0700 Subject: [PATCH] Feature #822 - add --xdp option, cleanup, document --- INSTALL | 303 ---------------------------------------- docs/INSTALL | 28 ++++ src/common/sendpacket.c | 63 +++++---- src/tcpreplay_api.c | 9 ++ src/tcpreplay_api.h | 4 + src/tcpreplay_opts.def | 14 ++ 6 files changed, 93 insertions(+), 328 deletions(-) delete mode 100644 INSTALL diff --git a/INSTALL b/INSTALL deleted file mode 100644 index ae077a6a3..000000000 --- a/INSTALL +++ /dev/null @@ -1,303 +0,0 @@ -Installation Instructions -************************* - -Copyright (C) 1994, 1995, 1996, 1999, 2000, 2001, 2002, 2004, 2005, -2006, 2014 Free Software Foundation, Inc. - -This file is free documentation; the Free Software Foundation gives -unlimited permission to copy, distribute and modify it. - - -Advanced Installation -===================== -Visit http://tcpreplay.appneta.com/wiki/installation.html - - -Basic Installation -================== - - ./configure - make - sudo make install - -Briefly, the shell commands `./configure; make; make install' should -configure, build, and install this package. The following -more-detailed instructions are generic; see the `README' file for -instructions specific to this package. - - The `configure' shell script attempts to guess correct values for -various system-dependent variables used during compilation. It uses -those values to create a `Makefile' in each directory of the package. -It may also create one or more `.h' files containing system-dependent -definitions. Finally, it creates a shell script `config.status' that -you can run in the future to recreate the current configuration, and a -file `config.log' containing compiler output (useful mainly for -debugging `configure'). - - It can also use an optional file (typically called `config.cache' -and enabled with `--cache-file=config.cache' or simply `-C') that saves -the results of its tests to speed up reconfiguring. Caching is -disabled by default to prevent problems with accidental use of stale -cache files. - - If you need to do unusual things to compile the package, please try -to figure out how `configure' could check whether to do them, and mail -diffs or instructions to the address given in the `README' so they can -be considered for the next release. If you are using the cache, and at -some point `config.cache' contains results you don't want to keep, you -may remove or edit it. - - The file `configure.ac' (or `configure.in') is used to create -`configure' by a program called `autoconf'. You need `configure.ac' if -you want to change it or regenerate `configure' using a newer version -of `autoconf'. - -The simplest way to compile this package is: - - 1. `cd' to the directory containing the package's source code and type - `./configure' to configure the package for your system. - - Running `configure' might take a while. While running, it prints - some messages telling which features it is checking for. - - 2. Type `make' to compile the package. - - 3. Optionally, type `make check' to run any self-tests that come with - the package. - - 4. Type `make install' to install the programs and any data files and - documentation. - - 5. You can remove the program binaries and object files from the - source code directory by typing `make clean'. To also remove the - files that `configure' created (so you can compile the package for - a different kind of computer), type `make distclean'. There is - also a `make maintainer-clean' target, but that is intended mainly - for the package's developers. If you use it, you may have to get - all sorts of other programs in order to regenerate files that came - with the distribution. - - -How to make Tcpreplay go fast -============================= - -1) netmap - ------ -This feature will detect netmap capable network drivers on Linux and -BSD systems. If detected, the network driver is bypassed for the -execution duration of tcpreplay and tcpreplay-edit, and network buffers -will be written to directly. This will allow you to achieve full 10GigE -line rates on commodity 10GigE network adapters, similar to rates -achieved by commercial network traffic generators. - -Note that bypassing the network driver will disrupt other applications -connected through the test interface. Use caution when testing on the -same interface you ssh'ed into. - -Ensure that you have supported NICs installed. Most Intel and nForce -(nVidia) adapters will work. Some virtual adapters are supported. - -FreeBSD 10 and higher already contains netmap capabilities and should -be detected automatically by "configure". But first you must enable -netmap on the system by adding 'device netmap' to your kernel config -and rebuilding the kernel. When complete, /dev/netmap will be -available. - -For Linux, download latest netmap sources from http://info.iet.unipi.it/~luigi/netmap/ -or run 'git clone https://code.google.com/p/netmap/'. You will also need to have -kernel sources installed so the build system can patch the sources and build -netmap-enabled drivers. If kernel sources are in /a/b/c/linux-A.B.C/ , then you -should do: - - cd netmap/LINUX - make KSRC=/a/b/c/linux-A.B.C/ # builds the kernel modules - make KSRC=/a/b/c/linux-A.B.C/ apps # builds sample applications - -You can omit KSRC if your kernel sources are in a standard place. - -Once you load the netmap.lin.ko module on your Linux machine, /dev/netmap -will be available. You will also need to replace your existing network drivers -(beyond the scope of this document). - -Building netmap-aware Tcpreplay suite is relatively straight forward. For -FreeBSD, build normally. For Linux, if you extracted netmap into /usr/src/ you -can also build normally. Otherwise you will have to specify the netmap source -directory, for example: - - ./configure --with-netmap=/home/fklassen/git/netmap - make - sudo make install - - -Compilers and Options -===================== - -Some systems require unusual options for compilation or linking that the -`configure' script does not know about. Run `./configure --help' for -details on some of the pertinent environment variables. - - You can give `configure' initial values for configuration parameters -by setting variables in the command line or in the environment. Here -is an example: - - ./configure CC=c99 CFLAGS=-g LIBS=-lposix - - *Note Defining Variables::, for more details. - - -Compiling For Multiple Architectures -==================================== - -You can compile the package for more than one kind of computer at the -same time, by placing the object files for each architecture in their -own directory. To do this, you can use GNU `make'. `cd' to the -directory where you want the object files and executables to go and run -the `configure' script. `configure' automatically checks for the -source code in the directory that `configure' is in and in `..'. - - With a non-GNU `make', it is safer to compile the package for one -architecture at a time in the source code directory. After you have -installed the package for one architecture, use `make distclean' before -reconfiguring for another architecture. - - -Installation Names -================== - -By default, `make install' installs the package's commands under -`/usr/local/bin', include files under `/usr/local/include', etc. You -can specify an installation prefix other than `/usr/local' by giving -`configure' the option `--prefix=PREFIX'. - - You can specify separate installation prefixes for -architecture-specific files and architecture-independent files. If you -pass the option `--exec-prefix=PREFIX' to `configure', the package uses -PREFIX as the prefix for installing programs and libraries. -Documentation and other data files still use the regular prefix. - - In addition, if you use an unusual directory layout you can give -options like `--bindir=DIR' to specify different values for particular -kinds of files. Run `configure --help' for a list of the directories -you can set and what kinds of files go in them. - - If the package supports it, you can cause programs to be installed -with an extra prefix or suffix on their names by giving `configure' the -option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. - - -Optional Features -================= - -Some packages pay attention to `--enable-FEATURE' options to -`configure', where FEATURE indicates an optional part of the package. -They may also pay attention to `--with-PACKAGE' options, where PACKAGE -is something like `gnu-as' or `x' (for the X Window System). The -`README' should mention any `--enable-' and `--with-' options that the -package recognizes. - - For packages that use the X Window System, `configure' can usually -find the X include and library files automatically, but if it doesn't, -you can use the `configure' options `--x-includes=DIR' and -`--x-libraries=DIR' to specify their locations. - - -Specifying the System Type -========================== - -There may be some features `configure' cannot figure out automatically, -but needs to determine by the type of machine the package will run on. -Usually, assuming the package is built to be run on the _same_ -architectures, `configure' can figure that out, but if it prints a -message saying it cannot guess the machine type, give it the -`--build=TYPE' option. TYPE can either be a short name for the system -type, such as `sun4', or a canonical name which has the form: - - CPU-COMPANY-SYSTEM - -where SYSTEM can have one of these forms: - - OS KERNEL-OS - - See the file `config.sub' for the possible values of each field. If -`config.sub' isn't included in this package, then this package doesn't -need to know the machine type. - - If you are _building_ compiler tools for cross-compiling, you should -use the option `--target=TYPE' to select the type of system they will -produce code for. - - If you want to _use_ a cross compiler, that generates code for a -platform different from the build platform, you should specify the -"host" platform (i.e., that on which the generated programs will -eventually be run) with `--host=TYPE'. - - -Sharing Defaults -================ - -If you want to set default values for `configure' scripts to share, you -can create a site shell script called `config.site' that gives default -values for variables like `CC', `cache_file', and `prefix'. -`configure' looks for `PREFIX/share/config.site' if it exists, then -`PREFIX/etc/config.site' if it exists. Or, you can set the -`CONFIG_SITE' environment variable to the location of the site script. -A warning: not all `configure' scripts look for a site script. - - -Defining Variables -================== - -Variables not defined in a site shell script can be set in the -environment passed to `configure'. However, some packages may run -configure again during the build, and the customized values of these -variables may be lost. In order to avoid this problem, you should set -them in the `configure' command line, using `VAR=value'. For example: - - ./configure CC=/usr/local2/bin/gcc - -causes the specified `gcc' to be used as the C compiler (unless it is -overridden in the site shell script). - -Unfortunately, this technique does not work for `CONFIG_SHELL' due to -an Autoconf bug. Until the bug is fixed you can use this workaround: - - CONFIG_SHELL=/bin/bash /bin/bash ./configure CONFIG_SHELL=/bin/bash - - -`configure' Invocation -====================== - -`configure' recognizes the following options to control how it operates. - -`--help' -`-h' - Print a summary of the options to `configure', and exit. - -`--version' -`-V' - Print the version of Autoconf used to generate the `configure' - script, and exit. - -`--cache-file=FILE' - Enable the cache: use and save the results of the tests in FILE, - traditionally `config.cache'. FILE defaults to `/dev/null' to - disable caching. - -`--config-cache' -`-C' - Alias for `--cache-file=config.cache'. - -`--quiet' -`--silent' -`-q' - Do not print messages saying which checks are being made. To - suppress all normal output, redirect it to `/dev/null' (any error - messages will still be shown). - -`--srcdir=DIR' - Look for the package's source code in directory DIR. Usually - `configure' can determine that directory automatically. - -`configure' also accepts some other, not widely useful, options. Run -`configure --help' for more details. - diff --git a/docs/INSTALL b/docs/INSTALL index ae077a6a3..1a74f66a0 100644 --- a/docs/INSTALL +++ b/docs/INSTALL @@ -128,6 +128,34 @@ directory, for example: make sudo make install +2) AF_XDF + ------ + +This feature will detect AF_XDP capable network drivers on Linux. If detected, +the `--xdp` option becomes available, allowing eBPF enabled adapters to be +written to directly. + +This feature requires `libxdp-dev` and `libbpf-dev` packages to be installed. +For example: + + $ ./configure | tail + Linux/BSD netmap: no + Tuntap device support: yes + LIBXDP for AF_XDP socket: yes + $ make + $ sudo make install + $ tcpreplay -i eth0 --xdp test/test.pcap + +If you want to compile a version that only uses AF_XDP, use the `--enable-force-libxdp` +configure option, e.g. + + $ ./configure --enable-force-libxdp | tail + Linux/BSD netmap: no + Tuntap device support: yes + LIBXDP for AF_XDP socket: yes + $ make + $ sudo make install + $ tcpreplay -i eth0 test/test.pcap Compilers and Options ===================== diff --git a/src/common/sendpacket.c b/src/common/sendpacket.c index 3fae5c888..6b060aad9 100644 --- a/src/common/sendpacket.c +++ b/src/common/sendpacket.c @@ -572,16 +572,21 @@ sendpacket_open(const char *device, sp = (sendpacket_t *)sendpacket_open_netmap(device, errbuf, arg); else #endif +#ifdef HAVE_LIBXDP + if (sendpacket_type == SP_TYPE_LIBXDP) + sp = sendpacket_open_xsk(device, errbuf); + else +#endif #if defined HAVE_PF_PACKET sp = sendpacket_open_pf(device, errbuf); #elif defined HAVE_BPF - sp = sendpacket_open_bpf(device, errbuf); + sp = sendpacket_open_bpf(device, errbuf); #elif defined HAVE_LIBDNET - sp = sendpacket_open_libdnet(device, errbuf); + sp = sendpacket_open_libdnet(device, errbuf); #elif (defined HAVE_PCAP_INJECT || defined HAVE_PCAP_SENDPACKET) - sp = sendpacket_open_pcap(device, errbuf); + sp = sendpacket_open_pcap(device, errbuf); #elif defined HAVE_LIBXDP - sp = sendpacket_open_xsk(device, errbuf); + sp = sendpacket_open_xsk(device, errbuf); #else #error "No defined packet injection method for sendpacket_open()" #endif @@ -693,8 +698,10 @@ sendpacket_close(sendpacket_t *sp) #endif break; case SP_TYPE_LIBXDP: -#if defined HAVE_LIBXDP +#ifdef HAVE_LIBXDP close(sp->handle.fd); + safe_free(sp->xsk_info); + safe_free(sp->umem_info); #endif break; case SP_TYPE_NONE: @@ -1253,30 +1260,36 @@ sendpacket_get_dlt(sendpacket_t *sp) { int dlt = DLT_EN10MB; - if (sp->handle_type == SP_TYPE_KHIAL || sp->handle_type == SP_TYPE_NETMAP || sp->handle_type == SP_TYPE_TUNTAP) { - /* always EN10MB */ - } else { -#if defined HAVE_BPF - int rcode; + switch (sp->handle_type) { + case SP_TYPE_KHIAL: + case SP_TYPE_NETMAP: + case SP_TYPE_TUNTAP: + case SP_TYPE_LIBXDP: + /* always EN10MB */ + return dlt; + default: + ; + } - if ((rcode = ioctl(sp->handle.fd, BIOCGDLT, &dlt)) < 0) { - warnx("Unable to get DLT value for BPF device (%s): %s", sp->device, strerror(errno)); - return (-1); - } +#if defined HAVE_BPF + if ((ioctl(sp->handle.fd, BIOCGDLT, &dlt)) < 0) { + warnx("Unable to get DLT value for BPF device (%s): %s", sp->device, strerror(errno)); + return (-1); + } #elif defined HAVE_PF_PACKET || defined HAVE_LIBDNET - /* use libpcap to get dlt */ - pcap_t *pcap; - char errbuf[PCAP_ERRBUF_SIZE]; - if ((pcap = pcap_open_live(sp->device, 65535, 0, 0, errbuf)) == NULL) { - warnx("Unable to get DLT value for %s: %s", sp->device, errbuf); - return (-1); - } - dlt = pcap_datalink(pcap); - pcap_close(pcap); + /* use libpcap to get dlt */ + pcap_t *pcap; + char errbuf[PCAP_ERRBUF_SIZE]; + if ((pcap = pcap_open_live(sp->device, 65535, 0, 0, errbuf)) == NULL) { + warnx("Unable to get DLT value for %s: %s", sp->device, errbuf); + return (-1); + } + dlt = pcap_datalink(pcap); + pcap_close(pcap); #elif defined HAVE_PCAP_SENDPACKET || defined HAVE_PCAP_INJECT - dlt = pcap_datalink(sp->handle.pcap); + dlt = pcap_datalink(sp->handle.pcap); #endif - } + return dlt; } diff --git a/src/tcpreplay_api.c b/src/tcpreplay_api.c index 3c14286b5..2b992e004 100644 --- a/src/tcpreplay_api.c +++ b/src/tcpreplay_api.c @@ -265,6 +265,15 @@ tcpreplay_post_args(tcpreplay_t *ctx, int argc) #endif } + if (HAVE_OPT(XDP)) { +#ifdef HAVE_LIBXDP + options->xdp = 1; + ctx->sp_type = SP_TYPE_LIBXDP; +#else + err(-1, "--xdp feature was not compiled in. See INSTALL."); +#endif + } + if (HAVE_OPT(UNIQUE_IP)) options->unique_ip = 1; diff --git a/src/tcpreplay_api.h b/src/tcpreplay_api.h index aa46e311a..1510443ae 100644 --- a/src/tcpreplay_api.h +++ b/src/tcpreplay_api.h @@ -148,6 +148,10 @@ typedef struct tcpreplay_opt_s { int netmap_delay; #endif +#ifdef HAVE_LIBXDP + int xdp; +#endif + /* print flow statistic */ bool flow_stats; int flow_expiry; diff --git a/src/tcpreplay_opts.def b/src/tcpreplay_opts.def index e4a45ead8..e05c7b32f 100644 --- a/src/tcpreplay_opts.def +++ b/src/tcpreplay_opts.def @@ -528,6 +528,20 @@ are fully up before netmap transmit. Requires netmap option. Default is 10 secon EOText; }; +flag = { + ifdef = HAVE_LIBXDP; + name = xdp; + descrip = "Write packets directly to AF_XDP enabled network adapter"; + doc = <<- EOText +This feature will detect AF_XDP capable network drivers on Linux systems +that have 'libxdp-dev' and 'libbpf-dev' installed. If detected, the network +stack is bypassed and packets are sent directly to an eBPF enabled driver directly. +This will allow you to achieve full line rates on commodity network adapters, similar to rates +achieved by commercial network traffic generators. +EOText; +}; + + flag = { name = no-flow-stats; descrip = "Suppress printing and tracking flow count, rates and expirations";