source: lib/format_dpdk.c @ fce4572

develop
Last change on this file since fce4572 was fce4572, checked in by Shane Alcock <salcock@…>, 22 months ago

Add more failure cases to "can_write" functions for some formats.

Specifically:

  • Avoid writing metadata packets to DPDK, ring and int
  • Make sure all formats avoid writing "content invalid" packets.
  • Add comments to remind us that erf meta <-> pcapng meta conversion might be worth adding at some point.
  • Add comment to remind us that erf meta should be writable via a DAG card (I think).
  • Property mode set to 100644
File size: 73.4 KB
Line 
1/*
2 *
3 * Copyright (c) 2007-2016 The University of Waikato, Hamilton, New Zealand.
4 * All rights reserved.
5 *
6 * This file is part of libtrace.
7 *
8 * This code has been developed by the University of Waikato WAND
9 * research group. For further information please see http://www.wand.net.nz/
10 *
11 * libtrace is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License as published by
13 * the Free Software Foundation; either version 3 of the License, or
14 * (at your option) any later version.
15 *
16 * libtrace is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 * GNU Lesser General Public License for more details.
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
23 *
24 *
25 *
26 * Kit capture format.
27 *
28 * Intel Data Plane Development Kit is a LIVE capture format.
29 *
30 * This format also supports writing which will write packets out to the
31 * network as a form of packet replay. This should not be confused with the
32 * RT protocol which is intended to transfer captured packet records between
33 * RT-speaking programs.
34 */
35
36#define _GNU_SOURCE
37
38#include "config.h"
39#include "libtrace.h"
40#include "libtrace_int.h"
41#include "format_helper.h"
42#include "libtrace_arphrd.h"
43#include "hash_toeplitz.h"
44#include "format_dpdk.h"
45
46#ifdef HAVE_INTTYPES_H
47#  include <inttypes.h>
48#else
49# error "Can't find inttypes.h"
50#endif
51
52#include <stdlib.h>
53#include <unistd.h>
54#include <endian.h>
55#include <string.h>
56#include <math.h>
57
58#ifdef HAVE_LIBNUMA
59#include <numa.h>
60#endif
61
62#define MBUF(x) ((struct rte_mbuf *) x)
63/* Get the original placement of the packet data */
64#define MBUF_PKTDATA(x) ((char *) x + sizeof(struct rte_mbuf) + RTE_PKTMBUF_HEADROOM)
65#define FORMAT(x) ((struct dpdk_format_data_t*)(x->format_data))
66#define PERPKT_FORMAT(x) ((struct dpdk_per_lcore_t*)(x->format_data))
67
68#define FORMAT_DATA_HEAD(x) FORMAT(x)->per_stream->head
69#define FORMAT_DATA_FIRST(x) ((dpdk_per_stream_t *)FORMAT_DATA_HEAD(x)->data)
70
71#define TV_TO_NS(tv) ((uint64_t) tv.tv_sec*1000000000ull + \
72                        (uint64_t) tv.tv_usec*1000ull)
73#define TS_TO_NS(ts) ((uint64_t) ts.tv_sec*1000000000ull + \
74                        (uint64_t) ts.tv_nsec)
75
76#if RTE_PKTMBUF_HEADROOM != 128
77#warning "RTE_PKT_MBUF_HEADROOM is not set to the default value of 128 - " \
78         "any libtrace instance processing these packet must be have the" \
79         "same RTE_PKTMBUF_HEADROOM set"
80#endif
81
82
83static pthread_mutex_t dpdk_lock = PTHREAD_MUTEX_INITIALIZER;
84/* Memory pools Per NUMA node */
85static struct rte_mempool * mem_pools[4][RTE_MAX_LCORE] = {{0}};
86
87/* Used by both input and output however some fields are not used
88 * for output */
89struct dpdk_format_data_t {
90        int8_t promisc; /* promiscuous mode - RX only */
91        uint8_t paused; /* See paused_state */
92        portid_t port; /* Always 0 we only whitelist a single port - Shared TX & RX */
93        portid_t nb_ports; /* Total number of usable ports on system should be 1 */
94        uint16_t link_speed; /* Link speed 10,100,1000,10000 etc. */
95        int snaplen; /* The snap length for the capture - RX only */
96        /* We always have to setup both rx and tx queues even if we don't want them */
97        int nb_rx_buf; /* The number of packet buffers in the rx ring */
98        int nb_tx_buf; /* The number of packet buffers in the tx ring */
99        int nic_numa_node; /* The NUMA node that the NIC is attached to */
100        struct rte_mempool * pktmbuf_pool; /* Our packet memory pool */
101#if DPDK_USE_BLACKLIST
102        struct rte_pci_addr blacklist[BLACK_LIST_SIZE]; /* Holds our device blacklist */
103        unsigned int nb_blacklist; /* Number of blacklist items in are valid */
104#endif
105        char mempool_name[MEMPOOL_NAME_LEN]; /* The name of the mempool that we are using */
106        enum hasher_types hasher_type;
107        uint8_t *rss_key;
108        /* To improve single-threaded performance we always batch reading
109         * packets, in a burst, otherwise the parallel library does this for us */
110        struct rte_mbuf* burst_pkts[BURST_SIZE];
111        int burst_size; /* The total number read in the burst */
112        int burst_offset; /* The offset we are into the burst */
113
114        /* Our parallel streams */
115        libtrace_list_t *per_stream;
116};
117
118enum dpdk_addt_hdr_flags {
119        INCLUDES_CHECKSUM = 0x1,
120        INCLUDES_HW_TIMESTAMP = 0x2, /* Used with 82580 driver */
121};
122
123/**
124 * A structure placed in front of the packet where we can store
125 * additional information about the given packet.
126 * +--------------------------+
127 * |       rte_mbuf (pkt)     | sizeof(rte_mbuf)
128 * +--------------------------+
129 * |       dpdk_addt_hdr      | sizeof(dpdk_addt_hdr)
130 * +--------------------------+
131 * |           padding        | RTE_PKTMBUF_HEADROOM-sizeof(dpdk_addt_hdr)
132 * +--------------------------+
133 * *   hw_timestamp_82580     * 16 bytes Optional
134 * +--------------------------+
135 * |       Packet data        | Variable Size
136 * |                          |
137 */
138struct dpdk_addt_hdr {
139        uint64_t timestamp;
140        uint8_t flags;
141        uint8_t direction;
142        uint8_t reserved1;
143        uint8_t reserved2;
144        uint32_t cap_len; /* The size to say the capture is */
145};
146
147static bool dpdk_can_write(libtrace_packet_t *packet) {
148        libtrace_linktype_t ltype = trace_get_link_type(packet);
149
150        if (ltype == TRACE_TYPE_CONTENT_INVALID) {
151                return false;
152        }
153        if (ltype == TRACE_TYPE_NONDATA || ltype == TRACE_TYPE_ERF_META ||
154                        ltype == TRACE_TYPE_PCAPNG_META) {
155                return false;
156        }
157        return true;
158}
159
160/**
161 * We want to blacklist all devices except those on the whitelist
162 * (I say list, but yes it is only the one).
163 *
164 * The default behaviour of rte_pci_probe() will map every possible device
165 * to its DPDK driver. The DPDK driver will take the ethernet device
166 * out of the kernel (i.e. no longer /dev/ethx) and cannot be used.
167 *
168 * So blacklist all devices except the one that we wish to use so that
169 * the others can still be used as standard ethernet ports.
170 *
171 * @return 0 if successful, otherwise -1 on error.
172 */
173#if DPDK_USE_BLACKLIST
174static int blacklist_devices(struct dpdk_format_data_t *format_data, struct rte_pci_addr *whitelist)
175{
176        struct rte_pci_device *dev = NULL;
177        format_data->nb_blacklist = 0;
178
179        memset(format_data->blacklist, 0, sizeof (format_data->blacklist));
180
181        TAILQ_FOREACH(dev, &device_list, next) {
182        if (whitelist != NULL && whitelist->domain == dev->addr.domain
183            && whitelist->bus == dev->addr.bus
184            && whitelist->devid == dev->addr.devid
185            && whitelist->function == dev->addr.function)
186            continue;
187                if (format_data->nb_blacklist >= sizeof (format_data->blacklist)
188                                / sizeof (format_data->blacklist[0])) {
189                        fprintf(stderr, "Warning: too many devices to blacklist consider"
190                                        " increasing BLACK_LIST_SIZE");
191                        break;
192                }
193                format_data->blacklist[format_data->nb_blacklist] = dev->addr;
194                ++format_data->nb_blacklist;
195        }
196
197        rte_eal_pci_set_blacklist(format_data->blacklist, format_data->nb_blacklist);
198        return 0;
199}
200#else /* DPDK_USE_BLACKLIST */
201#include <rte_devargs.h>
202static int whitelist_device(struct dpdk_format_data_t *format_data UNUSED, struct rte_pci_addr *whitelist)
203{
204        char pci_str[20] = {0};
205        snprintf(pci_str, sizeof(pci_str), PCI_PRI_FMT,
206                 whitelist->domain,
207                 whitelist->bus,
208                 whitelist->devid,
209                 whitelist->function);
210        if (rte_eal_devargs_add(RTE_DEVTYPE_WHITELISTED_PCI, pci_str) < 0) {
211                return -1;
212        }
213        return 0;
214}
215#endif
216
217/**
218 * Parse the URI format as a pci address
219 * Fills in addr, note core is optional and is unchanged if
220 * a value for it is not provided.
221 *
222 * i.e. ./libtrace dpdk:0:1:0.0 -> 0:1:0.0
223 * or ./libtrace dpdk:0:1:0.1-2 -> 0:1:0.1 (Using CPU core #2)
224 */
225static int parse_pciaddr(char * str, struct rte_pci_addr * addr, long * core) {
226        int matches;
227
228        if (!str) {
229                fprintf(stderr, "NULL str passed into parse_pciaddr()\n");
230                return -1;
231        }
232#if RTE_VERSION >= RTE_VERSION_NUM(17, 8, 0, 1)
233        matches = sscanf(str, "%8"SCNx32":%2"SCNx8":%2"SCNx8".%2"SCNx8"-%ld",
234                         &addr->domain, &addr->bus, &addr->devid,
235                         &addr->function, core);
236#else
237        matches = sscanf(str, "%4"SCNx16":%2"SCNx8":%2"SCNx8".%2"SCNx8"-%ld",
238                         &addr->domain, &addr->bus, &addr->devid,
239                         &addr->function, core);
240#endif
241        if (matches >= 4) {
242                return 0;
243        } else {
244                return -1;
245        }
246}
247
248/**
249 * Convert a pci address to the numa node it is
250 * connected to.
251 *
252 * This checks /sys/bus/pci/devices/XXXX:XX:XX.X/numa_node
253 * so we can call it before DPDK
254 *
255 * @return -1 if unknown otherwise a number 0 or higher of the numa node
256 */
257static int pci_to_numa(struct rte_pci_addr * dev_addr) {
258        char path[50] = {0};
259        FILE *file;
260
261        /* Read from the system */
262        snprintf(path, sizeof(path), "/sys/bus/pci/devices/"PCI_PRI_FMT"/numa_node",
263                 dev_addr->domain,
264                 dev_addr->bus,
265                 dev_addr->devid,
266                 dev_addr->function);
267
268        if((file = fopen(path, "r")) != NULL) {
269                int numa_node = -1;
270                fscanf(file, "%d", &numa_node);
271                fclose(file);
272                return numa_node;
273        }
274        return -1;
275}
276
277#if DEBUG
278/* For debugging */
279static inline void dump_configuration()
280{
281        struct rte_config * global_config;
282        long nb_cpu = sysconf(_SC_NPROCESSORS_ONLN);
283
284        if (nb_cpu <= 0) {
285                perror("sysconf(_SC_NPROCESSORS_ONLN) failed."
286                       " Falling back to the first core.");
287                nb_cpu = 1; /* fallback to just 1 core */
288        }
289        if (nb_cpu > RTE_MAX_LCORE)
290                nb_cpu = RTE_MAX_LCORE;
291
292        global_config = rte_eal_get_configuration();
293
294        if (global_config != NULL) {
295                int i;
296                fprintf(stderr, "Intel DPDK setup\n"
297                        "---Version      : %s\n"
298                        "---Master LCore : %"PRIu32"\n"
299                        "---LCore Count  : %"PRIu32"\n",
300                        rte_version(),
301                        global_config->master_lcore, global_config->lcore_count);
302
303                for (i = 0 ; i < nb_cpu; i++) {
304                        fprintf(stderr, "   ---Core %d : %s\n", i,
305                                global_config->lcore_role[i] == ROLE_RTE ? "on" : "off");
306                }
307
308                const char * proc_type;
309                switch (global_config->process_type) {
310                case RTE_PROC_AUTO:
311                        proc_type = "auto";
312                        break;
313                case RTE_PROC_PRIMARY:
314                        proc_type = "primary";
315                        break;
316                case RTE_PROC_SECONDARY:
317                        proc_type = "secondary";
318                        break;
319                case RTE_PROC_INVALID:
320                        proc_type = "invalid";
321                        break;
322                default:
323                        proc_type = "something worse than invalid!!";
324                }
325                fprintf(stderr, "---Process Type : %s\n", proc_type);
326        }
327
328}
329#endif
330
331/**
332 * Expects to be called from the master lcore and moves it to the given dpdk id
333 * @param core (zero indexed) If core is on the physical system affinity is bound otherwise
334 *               affinity is set to all cores. Must be less than RTE_MAX_LCORE
335 *               and not already in use.
336 * @return 0 is successful otherwise -1 on error.
337 */
338static inline int dpdk_move_master_lcore(libtrace_t *libtrace, size_t core) {
339        struct rte_config *cfg = rte_eal_get_configuration();
340        cpu_set_t cpuset;
341        int i;
342
343        if (core >= RTE_MAX_LCORE) {
344                fprintf(stderr, "Core must be a value less than the number of cores "
345                        "in dpdk_move_master_lcore()\n");
346                return -1;
347        }
348        if (rte_get_master_lcore() != rte_lcore_id()) {
349                fprintf(stderr, "Master core not equal to core id in dpdk_move_master_lcore()\n");
350                return -1;
351        }
352
353        if (core == rte_lcore_id())
354                return 0;
355
356        /* Make sure we are not overwriting someone else */
357        if (rte_lcore_is_enabled(core)) {
358                fprintf(stderr, "Cannot override another core in dpdk_move_master_lcore()\n");
359                return -1;
360        }
361
362        /* Move the core */
363        cfg->lcore_role[rte_lcore_id()] = ROLE_OFF;
364        cfg->lcore_role[core] = ROLE_RTE;
365        lcore_config[core].thread_id = lcore_config[rte_lcore_id()].thread_id;
366        rte_eal_get_configuration()->master_lcore = core;
367        RTE_PER_LCORE(_lcore_id) = core;
368
369        /* Now change the affinity, either mapped to a single core or all accepted */
370        CPU_ZERO(&cpuset);
371
372        if (lcore_config[core].detected) {
373                CPU_SET(core, &cpuset);
374        } else {
375                for (i = 0; i < RTE_MAX_LCORE; ++i) {
376                        if (lcore_config[i].detected)
377                                CPU_SET(i, &cpuset);
378                }
379        }
380
381        i = pthread_setaffinity_np(pthread_self(), sizeof(cpuset), &cpuset);
382        if (i != 0) {
383                trace_set_err(libtrace, errno, "pthread_setaffinity_np failed\n");
384                return -1;
385        }
386        return 0;
387}
388
389/**
390 * XXX This is very bad XXX
391 * But we have to do something to allow getopts nesting
392 * Luckly normally the format is last so it doesn't matter
393 * DPDK only supports modern systems so hopefully this
394 * will continue to work
395 */
396struct saved_getopts {
397        char *optarg;
398        int optind;
399        int opterr;
400        int optopt;
401};
402
403static void save_getopts(struct saved_getopts *opts) {
404        opts->optarg = optarg;
405        opts->optind = optind;
406        opts->opterr = opterr;
407        opts->optopt = optopt;
408}
409
410static void restore_getopts(struct saved_getopts *opts) {
411        optarg = opts->optarg;
412        optind = opts->optind;
413        opterr = opts->opterr;
414        optopt = opts->optopt;
415}
416
417static inline int dpdk_init_environment(char * uridata, struct dpdk_format_data_t * format_data,
418                                        char * err, int errlen) {
419        int ret; /* Returned error codes */
420        struct rte_pci_addr use_addr; /* The only address that we don't blacklist */
421        char cpu_number[10] = {0}; /* The CPU mask we want to bind to */
422        char mem_map[20] = {0}; /* The memory name */
423        long nb_cpu; /* The number of CPUs in the system */
424        long my_cpu; /* The CPU number we want to bind to */
425        int i;
426        struct rte_config *cfg = rte_eal_get_configuration();
427        struct saved_getopts save_opts;
428
429        /* This initialises the Environment Abstraction Layer (EAL)
430         * If we had slave workers these are put into WAITING state
431         *
432         * Basically binds this thread to a fixed core, which we choose as
433         * the last core on the machine (assuming fewer interrupts mapped here).
434         * "-c" controls the cpu mask 0x1=1st core 0x2=2nd 0x4=3rd and so on
435         * "-n" the number of memory channels into the CPU (hardware specific)
436         *      - Most likely to be half the number of ram slots in your machine.
437         *        We could count ram slots by "dmidecode -t 17 | grep -c 'Size:'"
438         * Controls where in memory packets are stored such that they are spread
439         * across the channels. We just use 1 to be safe.
440         *
441         * Using unique file prefixes mean separate memory is used, unlinking
442         * the two processes. However be careful we still cannot access a
443         * port that already in use.
444         */
445        char* argv[] = {"libtrace",
446                        "-c", cpu_number,
447                        "-n", "1",
448                        "--proc-type", "auto",
449                        "--file-prefix", mem_map,
450                        "-m", "512",
451#if DPDK_USE_LOG_LEVEL
452#       if DEBUG
453                        "--log-level", "8", /* RTE_LOG_DEBUG */
454#       else
455                        "--log-level", "5", /* RTE_LOG_WARNING */
456#       endif
457#endif
458                        NULL};
459        int argc = sizeof(argv) / sizeof(argv[0]) - 1;
460
461#if DEBUG
462        rte_log_set_global_level(RTE_LOG_DEBUG);
463#else
464        rte_log_set_global_level(RTE_LOG_WARNING);
465#endif
466
467        /* Get the number of cpu cores in the system and use the last core
468         * on the correct numa node */
469        nb_cpu = sysconf(_SC_NPROCESSORS_ONLN);
470        if (nb_cpu <= 0) {
471                perror("sysconf(_SC_NPROCESSORS_ONLN) failed."
472                       " Falling back to the first core.");
473                nb_cpu = 1; /* fallback to the first core */
474        }
475        if (nb_cpu > RTE_MAX_LCORE)
476                nb_cpu = RTE_MAX_LCORE;
477
478        my_cpu = -1;
479        /* This allows the user to specify the core - we would try to do this
480         * automatically but it's hard to tell that this is secondary
481         * before running rte_eal_init(...). Currently we are limited to 1
482         * instance per core due to the way memory is allocated. */
483        if (parse_pciaddr(uridata, &use_addr, &my_cpu) != 0) {
484                snprintf(err, errlen, "Failed to parse URI");
485                return -1;
486        }
487
488#ifdef HAVE_LIBNUMA
489        format_data->nic_numa_node = pci_to_numa(&use_addr);
490        if (my_cpu < 0) {
491#if DEBUG
492                /* If we can assign to a core on the same numa node */
493                fprintf(stderr, "Using pci card on numa_node%d\n", format_data->nic_numa_node);
494#endif
495                if(format_data->nic_numa_node >= 0) {
496                        int max_node_cpu = -1;
497                        struct bitmask *mask = numa_allocate_cpumask();
498                        if (!mask) {
499                                fprintf(stderr, "Unable to allocate cpu mask in dpdk_init_environment()\n");
500                                return -1;
501                        }
502                        numa_node_to_cpus(format_data->nic_numa_node, mask);
503                        for (i = 0 ; i < nb_cpu; ++i) {
504                                if (numa_bitmask_isbitset(mask,i))
505                                        max_node_cpu = i+1;
506                        }
507                        my_cpu = max_node_cpu;
508                }
509        }
510#endif
511        if (my_cpu < 0) {
512                my_cpu = nb_cpu;
513        }
514
515
516        snprintf(format_data->mempool_name, MEMPOOL_NAME_LEN,
517                 "libtrace_pool_%"PRIu32, (uint32_t) nb_cpu);
518
519        if (!(my_cpu > 0 && my_cpu <= nb_cpu)) {
520                snprintf(err, errlen,
521                         "Intel DPDK - User defined a bad CPU number %"PRIu32" must be"
522                         " between 1 and %"PRIu32, (uint32_t) my_cpu, (uint32_t) nb_cpu);
523                return -1;
524        }
525
526        /* Make our mask with all cores turned on this is so that DPDK
527         * gets all CPU info in older versions */
528        snprintf(cpu_number, sizeof(cpu_number), "%x", ~(UINT32_MAX<<MIN(31, nb_cpu)));
529        //snprintf(cpu_number, sizeof(cpu_number), "%x", 0x1 << (my_cpu - 1));
530
531#if !DPDK_USE_BLACKLIST
532        /* Black list all ports besides the one that we want to use */
533        if ((ret = whitelist_device(format_data, &use_addr)) < 0) {
534                snprintf(err, errlen, "Intel DPDK - Whitelisting PCI device failed,"
535                         " are you sure the address is correct?: %s", strerror(-ret));
536                return -1;
537        }
538#endif
539
540        /* Give the memory map a unique name */
541        snprintf(mem_map, sizeof(mem_map), "libtrace-%d", (int) getpid());
542        /* rte_eal_init it makes a call to getopt so we need to reset the
543         * global optind variable of getopt otherwise this fails */
544        save_getopts(&save_opts);
545        optind = 1;
546        if ((ret = rte_eal_init(argc, argv)) < 0) {
547                snprintf(err, errlen,
548                         "Intel DPDK - Initialisation of EAL failed: %s", strerror(-ret));
549                return -1;
550        }
551        restore_getopts(&save_opts);
552        // These are still running but will never do anything with DPDK v1.7 we
553        // should remove this XXX in the future
554        for(i = 0; i < RTE_MAX_LCORE; ++i) {
555                if (rte_lcore_is_enabled(i) && i != (int) rte_get_master_lcore()) {
556                        cfg->lcore_role[i] = ROLE_OFF;
557                        cfg->lcore_count--;
558                }
559        }
560        // Only the master should be running
561        if (cfg->lcore_count != 1) {
562                fprintf(stderr, "Expected only the master core to be running in dpdk_init_environment()\n");
563                return -1;
564        }
565
566        // TODO XXX TODO
567        dpdk_move_master_lcore(NULL, my_cpu-1);
568
569#if DEBUG
570        dump_configuration();
571#endif
572
573#if DPDK_USE_PMD_INIT
574        /* This registers all available NICs with Intel DPDK
575         * These are not loaded until rte_eal_pci_probe() is called.
576         */
577        if ((ret = rte_pmd_init_all()) < 0) {
578                snprintf(err, errlen,
579                         "Intel DPDK - rte_pmd_init_all failed: %s", strerror(-ret));
580                return -1;
581        }
582#endif
583
584#if DPDK_USE_BLACKLIST
585        /* Blacklist all ports besides the one that we want to use */
586        if ((ret = blacklist_devices(format_data, &use_addr)) < 0) {
587                snprintf(err, errlen, "Intel DPDK - Whitelisting PCI device failed,"
588                         " are you sure the address is correct?: %s", strerror(-ret));
589                return -1;
590        }
591#endif
592
593#if DPDK_USE_PCI_PROBE
594        /* This loads DPDK drivers against all ports that are not blacklisted */
595        if ((ret = rte_eal_pci_probe()) < 0) {
596                snprintf(err, errlen,
597                         "Intel DPDK - rte_eal_pci_probe failed: %s", strerror(-ret));
598                return -1;
599        }
600#endif
601
602        format_data->nb_ports = rte_eth_dev_count();
603
604        if (format_data->nb_ports != 1) {
605                snprintf(err, errlen,
606                         "Intel DPDK - rte_eth_dev_count returned %d but it should be 1",
607                         format_data->nb_ports);
608                return -1;
609        }
610
611        return 0;
612}
613
614int dpdk_init_input (libtrace_t *libtrace) {
615        dpdk_per_stream_t stream = DPDK_EMPTY_STREAM;
616        char err[500];
617        err[0] = 0;
618
619        libtrace->format_data = (struct dpdk_format_data_t *)
620                                malloc(sizeof(struct dpdk_format_data_t));
621
622        if (!libtrace->format_data) {
623                trace_set_err(libtrace, TRACE_ERR_INIT_FAILED, "Unable to allocate memory for "
624                        "format data inside dpdk_init_input()");
625                return 1;
626        }
627
628        FORMAT(libtrace)->port = 0; /* Always assume 1 port loaded */
629        FORMAT(libtrace)->nb_ports = 0;
630        FORMAT(libtrace)->snaplen = 0; /* Use default */
631        FORMAT(libtrace)->nb_rx_buf = NB_RX_MBUF;
632        FORMAT(libtrace)->nb_tx_buf = MIN_NB_BUF;
633        FORMAT(libtrace)->nic_numa_node = -1;
634        FORMAT(libtrace)->promisc = -1;
635        FORMAT(libtrace)->pktmbuf_pool = NULL;
636#if DPDK_USE_BLACKLIST
637        FORMAT(libtrace)->nb_blacklist = 0;
638#endif
639        FORMAT(libtrace)->paused = DPDK_NEVER_STARTED;
640        FORMAT(libtrace)->mempool_name[0] = 0;
641        memset(FORMAT(libtrace)->burst_pkts, 0,
642               sizeof(FORMAT(libtrace)->burst_pkts[0]) * BURST_SIZE);
643        FORMAT(libtrace)->burst_size = 0;
644        FORMAT(libtrace)->burst_offset = 0;
645        FORMAT(libtrace)->hasher_type = HASHER_BALANCE;
646        FORMAT(libtrace)->rss_key = NULL;
647
648        /* Make our first stream */
649        FORMAT(libtrace)->per_stream = libtrace_list_init(sizeof(struct dpdk_per_stream_t));
650        libtrace_list_push_back(FORMAT(libtrace)->per_stream, &stream);
651
652        if (dpdk_init_environment(libtrace->uridata, FORMAT(libtrace), err, sizeof(err)) != 0) {
653                trace_set_err(libtrace, TRACE_ERR_INIT_FAILED, "%s", err);
654                free(libtrace->format_data);
655                libtrace->format_data = NULL;
656                return -1;
657        }
658        return 0;
659}
660
661static int dpdk_init_output(libtrace_out_t *libtrace)
662{
663        dpdk_per_stream_t stream = DPDK_EMPTY_STREAM;
664        char err[500];
665        err[0] = 0;
666
667        libtrace->format_data = (struct dpdk_format_data_t *)
668                                malloc(sizeof(struct dpdk_format_data_t));
669
670        if (!libtrace->format_data) {
671                trace_set_err_out(libtrace, TRACE_ERR_INIT_FAILED, "Unable to allocate memory for "
672                        "format data inside dpdk_init_output()");
673                return -1;
674        }
675        FORMAT(libtrace)->port = 0; /* Always assume 1 port loaded */
676        FORMAT(libtrace)->nb_ports = 0;
677        FORMAT(libtrace)->snaplen = 0; /* Use default */
678        FORMAT(libtrace)->nb_rx_buf = MIN_NB_BUF;
679        FORMAT(libtrace)->nb_tx_buf = NB_TX_MBUF;
680        FORMAT(libtrace)->nic_numa_node = -1;
681        FORMAT(libtrace)->promisc = -1;
682        FORMAT(libtrace)->pktmbuf_pool = NULL;
683#if DPDK_USE_BLACKLIST
684        FORMAT(libtrace)->nb_blacklist = 0;
685#endif
686        FORMAT(libtrace)->paused = DPDK_NEVER_STARTED;
687        FORMAT(libtrace)->mempool_name[0] = 0;
688        memset(FORMAT(libtrace)->burst_pkts, 0, sizeof(FORMAT(libtrace)->burst_pkts[0]) * BURST_SIZE);
689        FORMAT(libtrace)->burst_size = 0;
690        FORMAT(libtrace)->burst_offset = 0;
691
692        FORMAT(libtrace)->per_stream = libtrace_list_init(sizeof(struct dpdk_per_stream_t));
693        libtrace_list_push_back(FORMAT(libtrace)->per_stream, &stream);
694
695        if (dpdk_init_environment(libtrace->uridata, FORMAT(libtrace), err, sizeof(err)) != 0) {
696                trace_set_err_out(libtrace, TRACE_ERR_INIT_FAILED, "%s", err);
697                free(libtrace->format_data);
698                libtrace->format_data = NULL;
699                return -1;
700        }
701        return 0;
702}
703
704/**
705 * Note here snaplen excludes the MAC checksum. Packets over
706 * the requested snaplen will be dropped. (Excluding MAC checksum)
707 *
708 * I.e the maximum size of a standard ethernet packet is 1518 (Including MAC checksum)
709 * So to allow packets upto 1518 this would be set to 1514 and if GET_MAC_CRC_CHECKSUM
710 * is set the maximum size of the returned packet would be 1518 otherwise
711 * 1514 would be the largest size possibly returned.
712 *
713 */
714int dpdk_config_input (libtrace_t *libtrace,
715                              trace_option_t option,
716                              void *data) {
717        switch (option) {
718        case TRACE_OPTION_SNAPLEN:
719                /* Only support changing snaplen before a call to start is
720                 * made */
721                if (FORMAT(libtrace)->paused == DPDK_NEVER_STARTED)
722                        FORMAT(libtrace)->snaplen=*(int*)data;
723                else
724                        return -1;
725                return 0;
726        case TRACE_OPTION_PROMISC:
727                FORMAT(libtrace)->promisc=*(int*)data;
728                return 0;
729        case TRACE_OPTION_HASHER:
730                switch (*((enum hasher_types *) data))
731                {
732                case HASHER_BALANCE:
733                case HASHER_UNIDIRECTIONAL:
734                case HASHER_BIDIRECTIONAL:
735                        FORMAT(libtrace)->hasher_type = *(enum hasher_types*)data;
736                        if (FORMAT(libtrace)->rss_key)
737                                free(FORMAT(libtrace)->rss_key);
738                        FORMAT(libtrace)->rss_key = NULL;
739                        return 0;
740                case HASHER_CUSTOM:
741                        // Let libtrace do this
742                        return -1;
743                }
744                break;
745        case TRACE_OPTION_FILTER:
746                /* TODO filtering */
747        case TRACE_OPTION_META_FREQ:
748        case TRACE_OPTION_EVENT_REALTIME:
749        case TRACE_OPTION_REPLAY_SPEEDUP:
750        case TRACE_OPTION_CONSTANT_ERF_FRAMING:
751                break;
752        /* Avoid default: so that future options will cause a warning
753         * here to remind us to implement it, or flag it as
754         * unimplementable
755         */
756        }
757
758        /* Don't set an error - trace_config will try to deal with the
759         * option and will set an error if it fails */
760        return -1;
761}
762
763/* Can set jumbo frames/ or limit the size of a frame by setting both
764 * max_rx_pkt_len and jumbo_frame. This can be limited to less than
765 *
766 */
767static struct rte_eth_conf port_conf = {
768        .rxmode = {
769                .mq_mode = ETH_RSS,
770                .split_hdr_size = 0,
771                .header_split   = 0, /**< Header Split disabled */
772                .hw_ip_checksum = 0, /**< IP checksum offload disabled */
773                .hw_vlan_filter = 0, /**< VLAN filtering disabled */
774                .jumbo_frame    = 0, /**< Jumbo Frame Support disabled */
775                .max_rx_pkt_len = 0, /**< Max frame Size if Jumbo enabled */
776#if GET_MAC_CRC_CHECKSUM
777/* So it appears that if hw_strip_crc is turned off the driver will still
778 * take this off. See line 955ish in lib/librte_pmd_e1000/igb_rxtx.c.
779 * So if .hw_strip_crc=0 a valid CRC exists 4 bytes after the end of the
780 * So lets just add it back on when we receive the packet.
781 */
782                .hw_strip_crc   = 0, /**< CRC stripped by hardware */
783#else
784/* By default strip the MAC checksum because it's a bit of a hack to
785 * actually read these. And don't want to rely on disabling this to actualy
786 * always cut off the checksum in the future
787 */
788                .hw_strip_crc   = 1, /**< CRC stripped by hardware */
789#endif
790        },
791        .txmode = {
792                .mq_mode = ETH_DCB_NONE,
793        },
794        .rx_adv_conf = {
795                .rss_conf = {
796                        .rss_hf = RX_RSS_FLAGS,
797                },
798        },
799        .intr_conf = {
800                .lsc = 1
801        }
802};
803
804static const struct rte_eth_rxconf rx_conf = {
805        .rx_thresh = {
806                .pthresh = 8,/* RX_PTHRESH prefetch */
807                .hthresh = 8,/* RX_HTHRESH host */
808                .wthresh = 4,/* RX_WTHRESH writeback */
809        },
810        .rx_free_thresh = 0,
811        .rx_drop_en = 0, /* Drop packets oldest packets if out of space */
812};
813
814static const struct rte_eth_txconf tx_conf = {
815        .tx_thresh = {
816                /*
817                 * TX_PTHRESH prefetch
818                 * Set on the NIC, if the number of unprocessed descriptors to queued on
819                 * the card fall below this try grab at least hthresh more unprocessed
820                 * descriptors.
821                 */
822                .pthresh = 36,
823
824                /* TX_HTHRESH host
825                 * Set on the NIC, the batch size to prefetch unprocessed tx descriptors.
826                 */
827                .hthresh = 0,
828
829                /* TX_WTHRESH writeback
830                 * Set on the NIC, the number of sent descriptors before writing back
831                 * status to confirm the transmission. This is done more efficiently as
832                 * a bulk DMA-transfer rather than writing one at a time.
833                 * Similar to tx_free_thresh however this is applied to the NIC, where
834                 * as tx_free_thresh is when DPDK will check these. This is extended
835                 * upon by tx_rs_thresh (10Gbit cards) which doesn't write all
836                 * descriptors rather only every n'th item, reducing DMA memory bandwidth.
837                 */
838                .wthresh = 4,
839        },
840
841        /* Used internally by DPDK rather than passed to the NIC. The number of
842         * packet descriptors to send before checking for any responses written
843         * back (to confirm the transmission). Default = 32 if set to 0)
844         */
845        .tx_free_thresh = 0,
846
847        /* This is the Report Status threshold, used by 10Gbit cards,
848         * This signals the card to only write back status (such as
849         * transmission successful) after this minimum number of transmit
850         * descriptors are seen. The default is 32 (if set to 0) however if set
851         * to greater than 1 TX wthresh must be set to zero, because this is kindof
852         * a replacement. See the dpdk programmers guide for more restrictions.
853         */
854        .tx_rs_thresh = 1,
855};
856
857/**
858 * A callback for a link state change (LSC).
859 *
860 * Packets may be received before this notification. In fact the DPDK IGXBE
861 * driver likes to put a delay upto 5sec before sending this.
862 *
863 * We use this to ensure the link speed is correct for our timestamp
864 * calculations. Because packets might be received before the link up we still
865 * update this when the packet is received.
866 *
867 * @param port The DPDK port
868 * @param event The TYPE of event (expected to be RTE_ETH_EVENT_INTR_LSC)
869 * @param cb_arg The dpdk_format_data_t structure associated with the format
870 */
871#if RTE_VERSION >= RTE_VERSION_NUM(17, 8, 0, 1)
872static int dpdk_lsc_callback(portid_t port, enum rte_eth_event_type event,
873                              void *cb_arg, void *retparam UNUSED) {
874#else
875static void dpdk_lsc_callback(portid_t port, enum rte_eth_event_type event,
876                              void *cb_arg) {
877#endif
878        struct dpdk_format_data_t * format_data = cb_arg;
879        struct rte_eth_link link_info;
880        if (event != RTE_ETH_EVENT_INTR_LSC) {
881                fprintf(stderr, "Received unexpected event in dpdk_lsc_callback()\n");
882                #if RTE_VERSION >= RTE_VERSION_NUM(17, 8, 0, 1)
883                return -1;
884                #else
885                return;
886                #endif
887        }
888        if (port != format_data->port) {
889                fprintf(stderr, "Port does not match port in format data in dpdk_lsc_callback()\n");
890                return -1;
891        }
892
893        rte_eth_link_get_nowait(port, &link_info);
894
895        if (link_info.link_status)
896                format_data->link_speed = link_info.link_speed;
897        else
898                format_data->link_speed = 0;
899
900#if DEBUG
901        fprintf(stderr, "LSC - link status is %s %s speed=%d\n",
902                link_info.link_status ? "up" : "down",
903                (link_info.link_duplex == ETH_LINK_FULL_DUPLEX) ?
904                                          "full-duplex" : "half-duplex",
905                (int) link_info.link_speed);
906#endif
907
908        /* Turns out DPDK drivers might not come back up if the link speed
909         * changes. So we reset the autoneg procedure. This is very unsafe
910         * we have have threads reading packets and we stop the port. */
911#if 0
912        if (!link_info.link_status) {
913                int ret;
914                rte_eth_dev_stop(port);
915                ret = rte_eth_dev_start(port);
916                if (ret < 0) {
917                        fprintf(stderr, "Resetting the DPDK port failed : %s\n",
918                                strerror(-ret));
919                }
920        }
921#endif
922#if RTE_VERSION >= RTE_VERSION_NUM(17, 8, 0, 1)
923        return 0;
924#endif
925}
926
927/** Reserve a DPDK lcore ID for a thread globally.
928 *
929 * @param real If true allocate a real lcore, otherwise allocate a core which
930 * does not exist on the local machine.
931 * @param socket the prefered NUMA socket - only used if a real core is requested
932 * @return a valid core, which can later be used with dpdk_register_lcore() or a
933 * -1 if have run out of cores.
934 *
935 * If any thread is reading or freeing packets we need to register it here
936 * due to TLS caches in the memory pools.
937 */
938static int dpdk_reserve_lcore(bool real, int socket) {
939        int new_id = -1;
940        int i;
941        struct rte_config *cfg = rte_eal_get_configuration();
942        (void) socket;
943
944        pthread_mutex_lock(&dpdk_lock);
945        /* If 'reading packets' fill in cores from 0 up and bind affinity
946         * otherwise start from the MAX core (which is also the master) and work backwards
947         * in this case physical cores on the system will not exist so we don't bind
948         * these to any particular physical core */
949        if (real) {
950#ifdef HAVE_LIBNUMA
951                for (i = 0; i < RTE_MAX_LCORE; ++i) {
952                        if (!rte_lcore_is_enabled(i) && numa_node_of_cpu(i) == socket) {
953                                new_id = i;
954                                if (!lcore_config[i].detected)
955                                        new_id = -1;
956                                break;
957                        }
958                }
959#endif
960                /* Retry without the the numa restriction */
961                if (new_id == -1) {
962                        for (i = 0; i < RTE_MAX_LCORE; ++i) {
963                                if (!rte_lcore_is_enabled(i)) {
964                                        new_id = i;
965                                        if (!lcore_config[i].detected)
966                                                fprintf(stderr, "Warning the"
967                                                        " number of 'reading' "
968                                                        "threads exceed cores\n");
969                                        break;
970                                }
971                        }
972                }
973        } else {
974                for (i = RTE_MAX_LCORE-1; i >= 0; --i) {
975                        if (!rte_lcore_is_enabled(i)) {
976                                new_id = i;
977                                break;
978                        }
979                }
980        }
981
982        if (new_id != -1) {
983                /* Enable the core in global DPDK structs */
984                cfg->lcore_role[new_id] = ROLE_RTE;
985                cfg->lcore_count++;
986        }
987
988        pthread_mutex_unlock(&dpdk_lock);
989        return new_id;
990}
991
992/** Register a thread as a lcore
993 * @param libtrace any error is set against libtrace on exit
994 * @param real If this is a true lcore we will bind its affinty to the
995 * requested core.
996 * @param lcore The lcore as retrieved from dpdk_reserve_lcore()
997 * @return 0, if successful otherwise -1 if an error occured (details are stored
998 * in libtrace)
999 *
1000 * @note This must be called from the thread being registered.
1001 */
1002static int dpdk_register_lcore(libtrace_t *libtrace, bool real, int lcore) {
1003        int ret;
1004        RTE_PER_LCORE(_lcore_id) = lcore;
1005
1006        /* Set affinity bind to corresponding core */
1007        if (real) {
1008                cpu_set_t cpuset;
1009                CPU_ZERO(&cpuset);
1010                CPU_SET(rte_lcore_id(), &cpuset);
1011                ret = pthread_setaffinity_np(pthread_self(), sizeof(cpuset), &cpuset);
1012                if (ret != 0) {
1013                        trace_set_err(libtrace, errno, "Warning "
1014                                      "pthread_setaffinity_np failed");
1015                        return -1;
1016                }
1017        }
1018
1019        return 0;
1020}
1021
1022/** Allocates a new dpdk packet buffer memory pool.
1023 *
1024 * @param n The number of threads
1025 * @param pkt_size The packet size we need ot store
1026 * @param socket_id The NUMA socket id
1027 * @param A new mempool, if NULL query the DPDK library for the error code
1028 * see rte_mempool_create() documentation.
1029 *
1030 * This allocates a new pool or recycles an existing memory pool.
1031 * Call dpdk_free_memory() to free the memory.
1032 * We cannot delete memory so instead we store the pools, allowing them to be
1033 * re-used.
1034 */
1035static struct rte_mempool *dpdk_alloc_memory(unsigned n,
1036                                             unsigned pkt_size,
1037                                             int socket_id) {
1038        struct rte_mempool *ret;
1039        size_t j,k;
1040        char name[MEMPOOL_NAME_LEN];
1041
1042        /* Add on packet size overheads */
1043        pkt_size += sizeof(struct rte_mbuf) + RTE_PKTMBUF_HEADROOM;
1044
1045        pthread_mutex_lock(&dpdk_lock);
1046
1047        if (socket_id == SOCKET_ID_ANY || socket_id > 4) {
1048                /* Best guess go for zero */
1049                socket_id = 0;
1050        }
1051
1052        /* Find a valid pool */
1053        for (j = 0; j < RTE_MAX_LCORE && mem_pools[socket_id][j]; ++j) {
1054                if (mem_pools[socket_id][j]->size >= n &&
1055                    mem_pools[socket_id][j]->elt_size >= pkt_size) {
1056                        break;
1057                }
1058        }
1059
1060        /* Find the end (+1) of the list */
1061        for (k = j; k < RTE_MAX_LCORE && mem_pools[socket_id][k]; ++k) {}
1062
1063        if (mem_pools[socket_id][j]) {
1064                ret = mem_pools[socket_id][j];
1065                mem_pools[socket_id][j] = mem_pools[socket_id][k-1];
1066                mem_pools[socket_id][k-1] = NULL;
1067                mem_pools[socket_id][j] = NULL;
1068        } else {
1069                static uint32_t test = 10;
1070                test++;
1071                snprintf(name, MEMPOOL_NAME_LEN,
1072                         "libtrace_pool_%"PRIu32, test);
1073
1074                ret = rte_mempool_create(name, n, pkt_size,
1075                                         128, sizeof(struct rte_pktmbuf_pool_private),
1076                                         rte_pktmbuf_pool_init, NULL,
1077                                         rte_pktmbuf_init, NULL,
1078                                         socket_id, 0);
1079        }
1080
1081        pthread_mutex_unlock(&dpdk_lock);
1082        return ret;
1083}
1084
1085/** Stores the memory against the DPDK library.
1086 *
1087 * @param mempool The mempool to free
1088 * @param socket_id The NUMA socket this mempool was allocated upon.
1089 *
1090 * Because we cannot free a memory pool, we verify it's full (i.e. unused) and
1091 * store the memory shared globally against the format.
1092 */
1093static void dpdk_free_memory(struct rte_mempool *mempool, int socket_id) {
1094        size_t i;
1095        pthread_mutex_lock(&dpdk_lock);
1096
1097        /* We should have all entries back in the mempool */
1098        rte_mempool_audit(mempool);
1099        if (!rte_mempool_full(mempool)) {
1100                fprintf(stderr, "DPDK memory pool not empty %d of %d, please "
1101                        "free all packets before finishing a trace\n",
1102                        rte_mempool_avail_count(mempool), mempool->size);
1103        }
1104
1105        /* Find the end (+1) of the list */
1106        for (i = 0; i < RTE_MAX_LCORE && mem_pools[socket_id][i]; ++i) {}
1107
1108        if (i >= RTE_MAX_LCORE) {
1109                fprintf(stderr, "Too many memory pools, dropping this one\n");
1110        } else {
1111                mem_pools[socket_id][i] = mempool;
1112        }
1113
1114        pthread_mutex_unlock(&dpdk_lock);
1115}
1116
1117/* Attach memory to the port and start (or restart) the port/s.
1118 */
1119static int dpdk_start_streams(struct dpdk_format_data_t *format_data,
1120                              char *err, int errlen, uint16_t rx_queues) {
1121        int ret, i;
1122        struct rte_eth_link link_info; /* Wait for link */
1123        dpdk_per_stream_t empty_stream = DPDK_EMPTY_STREAM;
1124
1125        /* Already started */
1126        if (format_data->paused == DPDK_RUNNING)
1127                return 0;
1128
1129        /* First time started we need to alloc our memory, doing this here
1130         * rather than in environment setup because we don't have snaplen then */
1131        if (format_data->paused == DPDK_NEVER_STARTED) {
1132                if (format_data->snaplen == 0) {
1133                        format_data->snaplen = RX_MBUF_SIZE;
1134                        port_conf.rxmode.jumbo_frame = 0;
1135                        port_conf.rxmode.max_rx_pkt_len = 0;
1136                } else {
1137                        double expn;
1138
1139                        /* Use jumbo frames */
1140                        port_conf.rxmode.jumbo_frame = 1;
1141                        port_conf.rxmode.max_rx_pkt_len = format_data->snaplen;
1142
1143                        /* Use less buffers if we're supporting jumbo frames
1144                         * otherwise we won't be able to allocate memory.
1145                         */
1146                        if (format_data->snaplen > 1500) {
1147                                format_data->nb_rx_buf /= 2;
1148                        }
1149
1150                        /* snaplen should be rounded up to next power of two
1151                         * to ensure enough memory is allocated for each
1152                         * mbuf :(
1153                         */
1154                        expn = ceil(log2((double)(format_data->snaplen)));
1155                        format_data->snaplen = pow(2, (int)expn);
1156                }
1157
1158#if GET_MAC_CRC_CHECKSUM
1159                /* This is additional overhead so make sure we allow space for this */
1160                format_data->snaplen += ETHER_CRC_LEN;
1161#endif
1162#if HAS_HW_TIMESTAMPS_82580
1163                format_data->snaplen += sizeof(struct hw_timestamp_82580);
1164#endif
1165
1166                /* Create the mbuf pool, which is the place packets are allocated
1167                 * from - There is no free function (I cannot see one).
1168                 * NOTE: RX queue requires nb_packets + 1 otherwise it fails to
1169                 * allocate however that extra 1 packet is not used.
1170                 * (I assume <= vs < error some where in DPDK code)
1171                 * TX requires nb_tx_buffers + 1 in the case the queue is full
1172                 * so that will fill the new buffer and wait until slots in the
1173                 * ring become available.
1174                 */
1175#if DEBUG
1176                fprintf(stderr, "Creating mempool named %s\n", format_data->mempool_name);
1177#endif
1178                format_data->pktmbuf_pool = dpdk_alloc_memory(format_data->nb_tx_buf*2,
1179                                                              format_data->snaplen,
1180                                                              format_data->nic_numa_node);
1181
1182                if (format_data->pktmbuf_pool == NULL) {
1183                        snprintf(err, errlen, "Intel DPDK - Initialisation of mbuf "
1184                                 "pool failed: %s", strerror(rte_errno));
1185                        return -1;
1186                }
1187        }
1188
1189        /* Generate the hash key, based on the device */
1190        uint8_t rss_size = 52; // 52 for i40e, 40 for others, use the largest by default
1191        // In new versions DPDK we can query the size
1192#if RTE_VERSION >= RTE_VERSION_NUM(2, 1, 0, 0)
1193        struct rte_eth_dev_info dev_info;
1194        rte_eth_dev_info_get(format_data->port, &dev_info);
1195        rss_size = dev_info.hash_key_size;
1196#endif
1197        if (rss_size != 0) {
1198                format_data->rss_key = malloc(rss_size);
1199                if (format_data->hasher_type == HASHER_BIDIRECTIONAL) {
1200                        toeplitz_ncreate_bikey(format_data->rss_key, rss_size);
1201                } else {
1202                        toeplitz_ncreate_unikey(format_data->rss_key, rss_size);
1203                }
1204                port_conf.rx_adv_conf.rss_conf.rss_key = format_data->rss_key;
1205#if RTE_VERSION >= RTE_VERSION_NUM(1, 7, 0, 1)
1206                port_conf.rx_adv_conf.rss_conf.rss_key_len = rss_size;
1207#endif
1208        } else {
1209                fprintf(stderr, "DPDK couldn't configure RSS hashing!");
1210        }
1211
1212        /* ----------- Now do the setup for the port mapping ------------ */
1213        /* Order of calls must be
1214         * rte_eth_dev_configure()
1215         * rte_eth_tx_queue_setup()
1216         * rte_eth_rx_queue_setup()
1217         * rte_eth_dev_start()
1218         * other rte_eth calls
1219         */
1220
1221        /* This must be called first before another *eth* function
1222         * 1+ rx, 1 tx queues, port_conf sets checksum stripping etc */
1223        ret = rte_eth_dev_configure(format_data->port, rx_queues, 1, &port_conf);
1224        if (ret < 0) {
1225                snprintf(err, errlen, "Intel DPDK - Cannot configure device port"
1226                         " %"PRIu8" : %s", format_data->port,
1227                         strerror(-ret));
1228                return -1;
1229        }
1230#if DEBUG
1231        fprintf(stderr, "Doing dev configure\n");
1232#endif
1233        /* Initialise the TX queue a minimum value if using this port for
1234         * receiving. Otherwise a larger size if writing packets.
1235         */
1236        ret = rte_eth_tx_queue_setup(format_data->port,
1237                                     0 /* queue XXX */,
1238                                     format_data->nb_tx_buf,
1239                                     SOCKET_ID_ANY,
1240                                     DPDK_USE_NULL_QUEUE_CONFIG ? NULL : &tx_conf);
1241        if (ret < 0) {
1242                snprintf(err, errlen, "Intel DPDK - Cannot configure TX queue"
1243                         " on port %d : %s", (int)format_data->port,
1244                         strerror(-ret));
1245                return -1;
1246        }
1247
1248        /* Attach memory to our RX queues */
1249        for (i=0; i < rx_queues; i++) {
1250                dpdk_per_stream_t *stream;
1251#if DEBUG
1252                fprintf(stderr, "Configuring queue %d\n", i);
1253#endif
1254
1255                /* Add storage for the stream */
1256                if (libtrace_list_get_size(format_data->per_stream) <= (size_t) i)
1257                        libtrace_list_push_back(format_data->per_stream, &empty_stream);
1258                stream = libtrace_list_get_index(format_data->per_stream, i)->data;
1259                stream->queue_id = i;
1260
1261                if (stream->lcore == -1)
1262                        stream->lcore = dpdk_reserve_lcore(true, format_data->nic_numa_node);
1263
1264                if (stream->lcore == -1) {
1265                        snprintf(err, errlen, "Intel DPDK - Failed to reserve a lcore"
1266                                 ". Too many threads?");
1267                        return -1;
1268                }
1269
1270                if (stream->mempool == NULL) {
1271                        stream->mempool = dpdk_alloc_memory(
1272                                                  format_data->nb_rx_buf*2,
1273                                                  format_data->snaplen,
1274                                                  rte_lcore_to_socket_id(stream->lcore));
1275
1276                        if (stream->mempool == NULL) {
1277                                snprintf(err, errlen, "Intel DPDK - Initialisation of mbuf "
1278                                         "pool failed: %s", strerror(rte_errno));
1279                                return -1;
1280                        }
1281                }
1282
1283                /* Initialise the RX queue with some packets from memory */
1284                ret = rte_eth_rx_queue_setup(format_data->port,
1285                                             stream->queue_id,
1286                                             format_data->nb_rx_buf,
1287                                             format_data->nic_numa_node,
1288                                             DPDK_USE_NULL_QUEUE_CONFIG ? NULL: &rx_conf,
1289                                             stream->mempool);
1290                if (ret < 0) {
1291                        snprintf(err, errlen, "Intel DPDK - Cannot configure"
1292                                 " RX queue on port %d : %s",
1293                                 (int)format_data->port,
1294                                 strerror(-ret));
1295                        return -1;
1296                }
1297        }
1298
1299#if DEBUG
1300        fprintf(stderr, "Doing start device\n");
1301#endif
1302        rte_eth_stats_reset(format_data->port);
1303        /* Start device */
1304        ret = rte_eth_dev_start(format_data->port);
1305        if (ret < 0) {
1306                snprintf(err, errlen, "Intel DPDK - rte_eth_dev_start failed : %s",
1307                         strerror(-ret));
1308                return -1;
1309        }
1310
1311        /* Default promiscuous to on */
1312        if (format_data->promisc == -1)
1313                format_data->promisc = 1;
1314
1315        if (format_data->promisc == 1)
1316                rte_eth_promiscuous_enable(format_data->port);
1317        else
1318                rte_eth_promiscuous_disable(format_data->port);
1319
1320        /* We have now successfully started/unpased */
1321        format_data->paused = DPDK_RUNNING;
1322
1323
1324        /* Register a callback for link state changes */
1325        ret = rte_eth_dev_callback_register(format_data->port,
1326                                            RTE_ETH_EVENT_INTR_LSC,
1327                                            dpdk_lsc_callback,
1328                                            format_data);
1329#if DEBUG
1330        if (ret)
1331                fprintf(stderr, "rte_eth_dev_callback_register failed %d : %s\n",
1332                        ret, strerror(-ret));
1333#endif
1334
1335        /* Get the current link status */
1336        rte_eth_link_get_nowait(format_data->port, &link_info);
1337        format_data->link_speed = link_info.link_speed;
1338#if DEBUG
1339        fprintf(stderr, "Link status is %d %d %d\n", (int) link_info.link_status,
1340                (int) link_info.link_duplex, (int) link_info.link_speed);
1341#endif
1342
1343        return 0;
1344}
1345
1346int dpdk_start_input (libtrace_t *libtrace) {
1347        char err[500];
1348        err[0] = 0;
1349
1350        /* Make sure we don't reserve an extra thread for this */
1351        FORMAT_DATA_FIRST(libtrace)->queue_id = rte_lcore_id();
1352
1353        if (dpdk_start_streams(FORMAT(libtrace), err, sizeof(err), 1) != 0) {
1354                trace_set_err(libtrace, TRACE_ERR_INIT_FAILED, "%s", err);
1355                free(libtrace->format_data);
1356                libtrace->format_data = NULL;
1357                return -1;
1358        }
1359        return 0;
1360}
1361
1362static inline size_t dpdk_get_max_rx_queues (portid_t port_id) {
1363        struct rte_eth_dev_info dev_info;
1364        rte_eth_dev_info_get(port_id, &dev_info);
1365        return dev_info.max_rx_queues;
1366}
1367
1368static inline size_t dpdk_processor_count () {
1369        long nb_cpu = sysconf(_SC_NPROCESSORS_ONLN);
1370        if (nb_cpu <= 0)
1371                return 1;
1372        else
1373                return (size_t) nb_cpu;
1374}
1375
1376int dpdk_pstart_input (libtrace_t *libtrace) {
1377        char err[500];
1378        int i=0, phys_cores=0;
1379        int tot = libtrace->perpkt_thread_count;
1380        libtrace_list_node_t *n;
1381        err[0] = 0;
1382
1383        if (rte_lcore_id() != rte_get_master_lcore())
1384                fprintf(stderr, "Warning dpdk_pstart_input should be called"
1385                        " from the master DPDK thread!\n");
1386
1387        /* If the master is not on the last thread we move it there */
1388        if (rte_get_master_lcore() != RTE_MAX_LCORE - 1) {
1389                if (dpdk_move_master_lcore(libtrace, RTE_MAX_LCORE - 1) != 0)
1390                        return -1;
1391        }
1392
1393        /* Don't exceed the number of cores in the system/detected by dpdk
1394         * We don't have to force this but performance wont be good if we don't */
1395        for (i = 0; i < RTE_MAX_LCORE; ++i) {
1396                if (lcore_config[i].detected) {
1397                        if (rte_lcore_is_enabled(i)) {
1398#if DEBUG
1399                                fprintf(stderr, "Found core %d already in use!\n", i);
1400#endif
1401                        } else {
1402                                phys_cores++;
1403                        }
1404                }
1405        }
1406        /* If we are restarting we have already allocated some threads as such
1407         * we add these back to the count for this calculation */
1408        for (n = FORMAT_DATA_HEAD(libtrace); n; n = n->next) {
1409                dpdk_per_stream_t * stream = n->data;
1410                if (stream->lcore != -1)
1411                        phys_cores++;
1412        }
1413
1414        tot = MIN(libtrace->perpkt_thread_count,
1415                  dpdk_get_max_rx_queues(FORMAT(libtrace)->port));
1416        tot = MIN(tot, phys_cores);
1417
1418#if DEBUG
1419        fprintf(stderr, "Running pstart DPDK tot=%d req=%d phys=%d\n", tot,
1420                libtrace->perpkt_thread_count, phys_cores);
1421#endif
1422
1423        if (dpdk_start_streams(FORMAT(libtrace), err, sizeof(err), tot) != 0) {
1424                trace_set_err(libtrace, TRACE_ERR_INIT_FAILED, "%s", err);
1425                free(libtrace->format_data);
1426                libtrace->format_data = NULL;
1427                return -1;
1428        }
1429
1430        /* Make sure we only start the number that we should */
1431        libtrace->perpkt_thread_count = tot;
1432        return 0;
1433}
1434
1435/**
1436 * Register a thread with the DPDK system,
1437 * When we start DPDK in parallel libtrace we move the 'main thread' to the
1438 * MAXIMUM CPU core slot (32) and remove any affinity restrictions DPDK
1439 * gives it.
1440 *
1441 * We then allow a mapper thread to be started on every real core as DPDK would,
1442 * we also bind these to the corresponding CPU cores.
1443 *
1444 * @param libtrace A pointer to the trace
1445 * @param reading True if the thread will be used to read packets, i.e. will
1446 *                call pread_packet(), false if thread used to process packet
1447 *                in any other manner including statistics functions.
1448 */
1449int dpdk_pregister_thread(libtrace_t *libtrace, libtrace_thread_t *t, bool reading)
1450{
1451#if DEBUG
1452        char name[99];
1453        name[0] = 0;
1454#if defined(HAVE_PTHREAD_SETNAME_NP) && defined(__linux__)
1455        pthread_getname_np(pthread_self(),
1456                           name, sizeof(name));
1457#endif
1458#endif
1459        if (reading) {
1460                dpdk_per_stream_t *stream;
1461                /* Attach our thread */
1462                if(t->type == THREAD_PERPKT) {
1463                        t->format_data = libtrace_list_get_index(FORMAT(libtrace)->per_stream, t->perpkt_num)->data;
1464                        if (t->format_data == NULL) {
1465                                trace_set_err(libtrace, TRACE_ERR_INIT_FAILED,
1466                                              "Too many threads registered");
1467                                return -1;
1468                        }
1469                } else {
1470                        t->format_data = FORMAT_DATA_FIRST(libtrace);
1471                }
1472                stream = t->format_data;
1473#if DEBUG
1474                fprintf(stderr, "%s new id memory:%s cpu-core:%d\n", name, stream->mempool->name, rte_lcore_id());
1475#endif
1476                return dpdk_register_lcore(libtrace, true, stream->lcore);
1477        } else {
1478                int lcore = dpdk_reserve_lcore(reading, 0);
1479                if (lcore == -1) {
1480                        trace_set_err(libtrace, TRACE_ERR_INIT_FAILED, "Too many threads"
1481                                      " for DPDK");
1482                        return -1;
1483                }
1484#if DEBUG
1485                fprintf(stderr, "%s new id cpu-core:%d\n", name, rte_lcore_id());
1486#endif
1487                return dpdk_register_lcore(libtrace, false, lcore);
1488        }
1489
1490        return 0;
1491}
1492
1493/**
1494 * Unregister a thread with the DPDK system.
1495 *
1496 * Only previously registered threads should be calling this just before
1497 * they are destroyed.
1498 */
1499void dpdk_punregister_thread(libtrace_t *libtrace UNUSED, libtrace_thread_t *t UNUSED)
1500{
1501        struct rte_config *cfg = rte_eal_get_configuration();
1502
1503        if (rte_lcore_id() >= RTE_MAX_LCORE) {
1504                fprintf(stderr, "Expected core id less than or equal to RTE_MAX_LCORE in "
1505                        "dpdk_punregister_thread()\n");
1506                return;
1507        }
1508        pthread_mutex_lock(&dpdk_lock);
1509        /* Skip if master */
1510        if (rte_lcore_id() == rte_get_master_lcore()) {
1511                fprintf(stderr, "INFO: we are skipping unregistering the master lcore\n");
1512                pthread_mutex_unlock(&dpdk_lock);
1513                return;
1514        }
1515
1516        /* Disable this core in global DPDK structs */
1517        cfg->lcore_role[rte_lcore_id()] = ROLE_OFF;
1518        cfg->lcore_count--;
1519        RTE_PER_LCORE(_lcore_id) = -1; // Might make the world burn if used again
1520        if (cfg->lcore_count < 1) {
1521                fprintf(stderr, "You cannot unregister the master lcore in dpdk_punregister_thread()\n");
1522                return;
1523        }
1524        pthread_mutex_unlock(&dpdk_lock);
1525        return;
1526}
1527
1528static int dpdk_start_output(libtrace_out_t *libtrace)
1529{
1530        char err[500];
1531        err[0] = 0;
1532
1533        if (dpdk_start_streams(FORMAT(libtrace), err, sizeof(err), 1) != 0) {
1534                trace_set_err_out(libtrace, TRACE_ERR_INIT_FAILED, "%s", err);
1535                free(libtrace->format_data);
1536                libtrace->format_data = NULL;
1537                return -1;
1538        }
1539        return 0;
1540}
1541
1542int dpdk_pause_input(libtrace_t * libtrace) {
1543        libtrace_list_node_t *tmp = FORMAT_DATA_HEAD(libtrace);
1544        /* This stops the device, but can be restarted using rte_eth_dev_start() */
1545        if (FORMAT(libtrace)->paused == DPDK_RUNNING) {
1546#if DEBUG
1547                fprintf(stderr, "Pausing DPDK port\n");
1548#endif
1549                rte_eth_dev_stop(FORMAT(libtrace)->port);
1550                FORMAT(libtrace)->paused = DPDK_PAUSED;
1551                /* Empty the queue of packets */
1552                for (; FORMAT(libtrace)->burst_offset < FORMAT(libtrace)->burst_size; ++FORMAT(libtrace)->burst_offset) {
1553                        rte_pktmbuf_free(FORMAT(libtrace)->burst_pkts[FORMAT(libtrace)->burst_offset]);
1554                }
1555                FORMAT(libtrace)->burst_offset = 0;
1556                FORMAT(libtrace)->burst_size = 0;
1557
1558                for (; tmp != NULL; tmp = tmp->next) {
1559                        dpdk_per_stream_t *stream = tmp->data;
1560                        stream->ts_last_sys = 0;
1561#if HAS_HW_TIMESTAMPS_82580
1562                        stream->ts_first_sys = 0;
1563#endif
1564                }
1565
1566        }
1567        return 0;
1568}
1569
1570static int dpdk_write_packet(libtrace_out_t *trace,
1571                             libtrace_packet_t *packet){
1572
1573        /* Check dpdk can write this type of packet */
1574        if (!dpdk_can_write(packet)) {
1575                return 0;
1576        }
1577
1578        struct rte_mbuf* m_buff[1];
1579
1580        int wirelen = trace_get_wire_length(packet);
1581        int caplen = trace_get_capture_length(packet);
1582
1583        /* Check for a checksum and remove it */
1584        if (trace_get_link_type(packet) == TRACE_TYPE_ETH &&
1585            wirelen == caplen)
1586                caplen -= ETHER_CRC_LEN;
1587
1588        m_buff[0] = rte_pktmbuf_alloc(FORMAT(trace)->pktmbuf_pool);
1589        if (m_buff[0] == NULL) {
1590                trace_set_err_out(trace, errno, "Cannot get an empty packet buffer");
1591                return -1;
1592        } else {
1593                int ret;
1594                memcpy(rte_pktmbuf_append(m_buff[0], caplen), packet->payload, caplen);
1595                do {
1596                        ret = rte_eth_tx_burst(FORMAT(trace)->port, 0 /*queue TODO*/, m_buff, 1);
1597                } while (ret != 1);
1598        }
1599
1600        return 0;
1601}
1602
1603int dpdk_fin_input(libtrace_t * libtrace) {
1604        libtrace_list_node_t * n;
1605        /* Free our memory structures */
1606        if (libtrace->format_data != NULL) {
1607
1608                if (FORMAT(libtrace)->port != 0xFF)
1609                        rte_eth_dev_callback_unregister(FORMAT(libtrace)->port,
1610                                                        RTE_ETH_EVENT_INTR_LSC,
1611                                                        dpdk_lsc_callback,
1612                                                        FORMAT(libtrace));
1613                /* Close the device completely, device cannot be restarted */
1614                rte_eth_dev_close(FORMAT(libtrace)->port);
1615
1616                dpdk_free_memory(FORMAT(libtrace)->pktmbuf_pool,
1617                                 FORMAT(libtrace)->nic_numa_node);
1618
1619                for (n = FORMAT(libtrace)->per_stream->head; n ; n = n->next) {
1620                        dpdk_per_stream_t * stream = n->data;
1621                        if (stream->mempool)
1622                                dpdk_free_memory(stream->mempool,
1623                                                 rte_lcore_to_socket_id(stream->lcore));
1624                }
1625
1626                libtrace_list_deinit(FORMAT(libtrace)->per_stream);
1627                /* filter here if we used it */
1628                if (FORMAT(libtrace)->rss_key)
1629                        free(FORMAT(libtrace)->rss_key);
1630                free(libtrace->format_data);
1631        }
1632
1633        return 0;
1634}
1635
1636
1637static int dpdk_fin_output(libtrace_out_t * libtrace) {
1638        /* Free our memory structures */
1639        if (libtrace->format_data != NULL) {
1640                /* Close the device completely, device cannot be restarted */
1641                if (FORMAT(libtrace)->port != 0xFF)
1642                        rte_eth_dev_close(FORMAT(libtrace)->port);
1643                libtrace_list_deinit(FORMAT(libtrace)->per_stream);
1644                /* filter here if we used it */
1645                free(libtrace->format_data);
1646        }
1647
1648        return 0;
1649}
1650
1651/**
1652 * Get the start of the additional header that we added to a packet.
1653 */
1654static inline struct dpdk_addt_hdr * get_addt_hdr (const libtrace_packet_t *packet) {
1655        if (!packet) {
1656                fprintf(stderr, "NULL packet passed into dpdk_addt_hdr()\n");
1657                return NULL;
1658        }
1659        if (!packet->buffer) {
1660                fprintf(stderr, "NULL packet buffer passed into dpdk_addt_hdr()\n");
1661                return NULL;
1662        }
1663        /* Our header sits straight after the mbuf header */
1664        return (struct dpdk_addt_hdr *) ((struct rte_mbuf*) packet->buffer + 1);
1665}
1666
1667static int dpdk_get_capture_length (const libtrace_packet_t *packet) {
1668        struct dpdk_addt_hdr * hdr = get_addt_hdr(packet);
1669        return hdr->cap_len;
1670}
1671
1672static size_t dpdk_set_capture_length(libtrace_packet_t *packet, size_t size) {
1673        struct dpdk_addt_hdr * hdr = get_addt_hdr(packet);
1674        if (size > hdr->cap_len) {
1675                /* Cannot make a packet bigger */
1676                return trace_get_capture_length(packet);
1677        }
1678
1679        /* Reset the cached capture length first*/
1680        packet->cached.capture_length = -1;
1681        hdr->cap_len = (uint32_t) size;
1682        return trace_get_capture_length(packet);
1683}
1684
1685static int dpdk_get_wire_length (const libtrace_packet_t *packet) {
1686        struct dpdk_addt_hdr * hdr = get_addt_hdr(packet);
1687        int org_cap_size; /* The original capture size */
1688        if (hdr->flags & INCLUDES_HW_TIMESTAMP) {
1689                org_cap_size = (int) rte_pktmbuf_pkt_len(MBUF(packet->buffer)) -
1690                               sizeof(struct hw_timestamp_82580);
1691        } else {
1692                org_cap_size = (int) rte_pktmbuf_pkt_len(MBUF(packet->buffer));
1693        }
1694        if (hdr->flags & INCLUDES_CHECKSUM) {
1695                return org_cap_size;
1696        } else {
1697                /* DPDK packets are always TRACE_TYPE_ETH packets */
1698                return org_cap_size + ETHER_CRC_LEN;
1699        }
1700}
1701
1702int dpdk_get_framing_length (const libtrace_packet_t *packet) {
1703        struct dpdk_addt_hdr * hdr = get_addt_hdr(packet);
1704        if (hdr->flags & INCLUDES_HW_TIMESTAMP)
1705                return sizeof(struct rte_mbuf) + RTE_PKTMBUF_HEADROOM +
1706                                sizeof(struct hw_timestamp_82580);
1707        else
1708                return sizeof(struct rte_mbuf) + RTE_PKTMBUF_HEADROOM;
1709}
1710
1711int dpdk_prepare_packet(libtrace_t *libtrace UNUSED,
1712                               libtrace_packet_t *packet, void *buffer,
1713                               libtrace_rt_types_t rt_type, uint32_t flags) {
1714        if (!packet) {
1715                fprintf(stderr, "NULL packet passed into dpdk_prepare_packet()\n");
1716                return TRACE_ERR_NULL_PACKET;
1717        }
1718        if (packet->buffer != buffer &&
1719            packet->buf_control == TRACE_CTRL_PACKET) {
1720                free(packet->buffer);
1721        }
1722
1723        if ((flags & TRACE_PREP_OWN_BUFFER) == TRACE_PREP_OWN_BUFFER)
1724                packet->buf_control = TRACE_CTRL_PACKET;
1725        else
1726                packet->buf_control = TRACE_CTRL_EXTERNAL;
1727
1728        packet->buffer = buffer;
1729        packet->header = buffer;
1730
1731        /* Don't use pktmbuf_mtod will fail if the packet is a copy */
1732        packet->payload = (char *)buffer + dpdk_get_framing_length(packet);
1733        packet->type = rt_type;
1734        return 0;
1735}
1736
1737/**
1738 * Given a packet size and a link speed, computes the
1739 * time to transmit in nanoseconds.
1740 *
1741 * @param format_data The dpdk format data from which we get the link speed
1742 *        and if unset updates it in a thread safe manner
1743 * @param pkt_size The size of the packet in bytes
1744 * @return The wire time in nanoseconds
1745 */
1746static inline uint32_t calculate_wire_time(struct dpdk_format_data_t* format_data, uint32_t pkt_size) {
1747        uint32_t wire_time;
1748        /* 20 extra bytes of interframe gap and preamble */
1749# if GET_MAC_CRC_CHECKSUM
1750        wire_time = ((pkt_size + 20) * 8000);
1751# else
1752        wire_time = ((pkt_size + 20 + ETHER_CRC_LEN) * 8000);
1753# endif
1754
1755        /* Division is really slow and introduces a pipeline stall
1756         * The compiler will optimise this into magical multiplication and shifting
1757         * See http://ridiculousfish.com/blog/posts/labor-of-division-episode-i.html
1758         */
1759retry_calc_wiretime:
1760        switch (format_data->link_speed) {
1761        case ETH_SPEED_NUM_40G:
1762                wire_time /=  ETH_SPEED_NUM_40G;
1763                break;
1764        case ETH_SPEED_NUM_20G:
1765                wire_time /= ETH_SPEED_NUM_20G;
1766                break;
1767        case ETH_SPEED_NUM_10G:
1768                wire_time /= ETH_SPEED_NUM_10G;
1769                break;
1770        case ETH_SPEED_NUM_1G:
1771                wire_time /= ETH_SPEED_NUM_1G;
1772                break;
1773        case 0:
1774                {
1775                /* Maybe the link was down originally, but now it should be up */
1776                struct rte_eth_link link = {0};
1777                rte_eth_link_get_nowait(format_data->port, &link);
1778                if (link.link_status && link.link_speed) {
1779                        format_data->link_speed = link.link_speed;
1780#ifdef DEBUG
1781                        fprintf(stderr, "Link has come up updated speed=%d\n", (int) link.link_speed);
1782#endif
1783                        goto retry_calc_wiretime;
1784                }
1785                /* We don't know the link speed, make sure numbers are counting up */
1786                wire_time = 1;
1787                break;
1788                }
1789        default:
1790                wire_time /= format_data->link_speed;
1791        }
1792        return wire_time;
1793}
1794
1795/**
1796 * Does any extra preperation to all captured packets
1797 * This includes adding our extra header to it with the timestamp,
1798 * and any snapping
1799 *
1800 * @param format_data The DPDK format data
1801 * @param plc The DPDK per lcore format data
1802 * @param pkts An array of size nb_pkts of DPDK packets
1803 */
1804static inline void dpdk_ready_pkts(libtrace_t *libtrace,
1805                                   struct dpdk_per_stream_t *plc,
1806                                   struct rte_mbuf **pkts,
1807                                   size_t nb_pkts) {
1808        struct dpdk_format_data_t *format_data = FORMAT(libtrace);
1809        struct dpdk_addt_hdr *hdr;
1810        size_t i;
1811        uint64_t cur_sys_time_ns;
1812#if HAS_HW_TIMESTAMPS_82580
1813        struct hw_timestamp_82580 *hw_ts;
1814        uint64_t estimated_wraps;
1815#else
1816
1817#endif
1818
1819#if USE_CLOCK_GETTIME
1820        struct timespec cur_sys_time = {0};
1821        /* This looks terrible and I feel bad doing it. But it's OK
1822         * on new kernels, because this is a fast vsyscall */
1823        clock_gettime(CLOCK_REALTIME, &cur_sys_time);
1824        cur_sys_time_ns = TS_TO_NS(cur_sys_time);
1825#else
1826        struct timeval cur_sys_time = {0};
1827        /* Also a fast vsyscall */
1828        gettimeofday(&cur_sys_time, NULL);
1829        cur_sys_time_ns = TV_TO_NS(cur_sys_time);
1830#endif
1831
1832        /* The system clock is not perfect so when running
1833         * at linerate we could timestamp a packet in the past.
1834         * To avoid this we munge the timestamp to appear 1ns
1835         * after the previous packet. We should eventually catch up
1836         * to system time since a 64byte packet on a 10G link takes 67ns.
1837         *
1838         * Note with parallel readers timestamping packets
1839         * with duplicate stamps or out of order is unavoidable without
1840         * hardware timestamping from the NIC.
1841         */
1842#if !HAS_HW_TIMESTAMPS_82580
1843        if (plc->ts_last_sys >= cur_sys_time_ns) {
1844                cur_sys_time_ns = plc->ts_last_sys + 1;
1845        }
1846#endif
1847
1848        ct_assert(RTE_PKTMBUF_HEADROOM >= sizeof(struct dpdk_addt_hdr));
1849        for (i = 0 ; i < nb_pkts ; ++i) {
1850
1851                /* We put our header straight after the dpdk header */
1852                hdr = (struct dpdk_addt_hdr *) (pkts[i] + 1);
1853                memset(hdr, 0, sizeof(struct dpdk_addt_hdr));
1854
1855#if GET_MAC_CRC_CHECKSUM
1856                /* Add back in the CRC sum */
1857                rte_pktmbuf_pkt_len(pkt) += ETHER_CRC_LEN;
1858                rte_pktmbuf_data_len(pkt) += ETHER_CRC_LEN;
1859                hdr->flags |= INCLUDES_CHECKSUM;
1860#endif
1861
1862                hdr->cap_len = rte_pktmbuf_pkt_len(pkts[i]);
1863
1864#if HAS_HW_TIMESTAMPS_82580
1865                /* The timestamp is sitting before our packet and is included in pkt_len */
1866                hdr->flags |= INCLUDES_HW_TIMESTAMP;
1867                hdr->cap_len -= sizeof(struct hw_timestamp_82580);
1868                hw_ts = (struct hw_timestamp_82580 *) MBUF_PKTDATA(pkts[i]);
1869
1870                /* Taken from igb_ptp.c part of Intel Linux drivers (Good example code)
1871                 *
1872                 *        +----------+---+   +--------------+
1873                 *  82580 |    24    | 8 |   |      32      |
1874                 *        +----------+---+   +--------------+
1875                 *          reserved  \______ 40 bits _____/
1876                 *
1877                 * The 40 bit 82580 SYSTIM overflows every
1878                 *   2^40 * 10^-9 /  60  = 18.3 minutes.
1879                 *
1880                 * NOTE picture is in Big Endian order, in memory it's acutally in Little
1881                 * Endian (for the full 64 bits) i.e. picture is mirrored
1882                 */
1883
1884                /* Despite what the documentation says this is in Little
1885                 * Endian byteorder. Mask the reserved section out.
1886                 */
1887                hdr->timestamp = le64toh(hw_ts->timestamp) &
1888                        ~(((~0ull)>>TS_NBITS_82580)<<TS_NBITS_82580);
1889
1890                if (unlikely(plc->ts_first_sys == 0)) {
1891                        plc->ts_first_sys = cur_sys_time_ns - hdr->timestamp;
1892                        plc->ts_last_sys = plc->ts_first_sys;
1893                }
1894
1895                /* This will have serious problems if packets aren't read quickly
1896                 * that is within a couple of seconds because our clock cycles every
1897                 * 18 seconds */
1898                estimated_wraps = (cur_sys_time_ns - plc->ts_last_sys)
1899                                  / (1ull<<TS_NBITS_82580);
1900
1901                /* Estimated_wraps gives the number of times the counter should have
1902                 * wrapped (however depending on value last time it could have wrapped
1903                 * twice more (if hw clock is close to its max value) or once less (allowing
1904                 * for a bit of variance between hw and sys clock). But if the clock
1905                 * shouldn't have wrapped once then don't allow it to go backwards in time */
1906                if (unlikely(estimated_wraps >= 2)) {
1907                        /* 2 or more wrap arounds add all but the very last wrap */
1908                        plc->wrap_count += estimated_wraps - 1;
1909                }
1910
1911                /* Set the timestamp to the lowest possible value we're considering */
1912                hdr->timestamp += plc->ts_first_sys +
1913                                  plc->wrap_count * (1ull<<TS_NBITS_82580);
1914
1915                /* In most runs only the first if() will need evaluating - i.e our
1916                 * estimate is correct. */
1917                if (unlikely(!WITHIN_VARIANCE(cur_sys_time_ns,
1918                                              hdr->timestamp, MAXSKEW_82580))) {
1919                        /* Failed to match estimated_wraps-1 (or estimated_wraps in ==0 case) */
1920                        plc->wrap_count++;
1921                        hdr->timestamp += (1ull<<TS_NBITS_82580);
1922                        if (!WITHIN_VARIANCE(cur_sys_time_ns,
1923                                             hdr->timestamp, MAXSKEW_82580)) {
1924                                /* Failed to match estimated_wraps */
1925                                plc->wrap_count++;
1926                                hdr->timestamp += (1ull<<TS_NBITS_82580);
1927                                if (!WITHIN_VARIANCE(cur_sys_time_ns,
1928                                                     hdr->timestamp, MAXSKEW_82580)) {
1929                                        if (estimated_wraps == 0) {
1930                                                /* 0 case Failed to match estimated_wraps+2 */
1931                                                printf("WARNING - Hardware Timestamp failed to"
1932                                                       " match using systemtime!\n");
1933                                                hdr->timestamp = cur_sys_time_ns;
1934                                        } else {
1935                                                /* Failed to match estimated_wraps+1 */
1936                                                plc->wrap_count++;
1937                                                hdr->timestamp += (1ull<<TS_NBITS_82580);
1938                                                if (!WITHIN_VARIANCE(cur_sys_time_ns,
1939                                                                     hdr->timestamp, MAXSKEW_82580)) {
1940                                                        /* Failed to match estimated_wraps+2 */
1941                                                        printf("WARNING - Hardware Timestamp failed to"
1942                                                               " match using systemtime!!\n");
1943                                                }
1944                                        }
1945                                }
1946                        }
1947                }
1948#else
1949
1950                hdr->timestamp = cur_sys_time_ns;
1951                /* Offset the next packet by the wire time of previous */
1952                calculate_wire_time(format_data, hdr->cap_len);
1953
1954#endif
1955        }
1956
1957        plc->ts_last_sys = cur_sys_time_ns;
1958        return;
1959}
1960
1961
1962static void dpdk_fin_packet(libtrace_packet_t *packet)
1963{
1964        if ( packet->buf_control == TRACE_CTRL_EXTERNAL ) {
1965                rte_pktmbuf_free(packet->buffer);
1966                packet->buffer = NULL;
1967        }
1968}
1969
1970/** Reads at least one packet or returns an error
1971 */
1972int dpdk_read_packet_stream (libtrace_t *libtrace,
1973                                           dpdk_per_stream_t *stream,
1974                                           libtrace_message_queue_t *mesg,
1975                                           struct rte_mbuf* pkts_burst[],
1976                                           size_t nb_packets) {
1977        size_t nb_rx; /* Number of rx packets we've recevied */
1978        while (1) {
1979                /* Poll for a batch of packets */
1980                nb_rx = rte_eth_rx_burst(FORMAT(libtrace)->port,
1981                                         stream->queue_id, pkts_burst, nb_packets);
1982                if (nb_rx > 0) {
1983                        /* Got some packets - otherwise we keep spining */
1984                        dpdk_ready_pkts(libtrace, stream, pkts_burst, nb_rx);
1985                        //fprintf(stderr, "Doing P READ PACKET port=%d q=%d\n", (int) FORMAT(libtrace)->port, (int) get_thread_table_num(libtrace));
1986                        return nb_rx;
1987                }
1988                /* Check the message queue this could be less than 0 */
1989                if (mesg && libtrace_message_queue_count(mesg) > 0)
1990                        return READ_MESSAGE;
1991                if ((nb_rx=is_halted(libtrace)) != (size_t) -1)
1992                        return nb_rx;
1993                /* Wait a while, polling on memory degrades performance
1994                 * This relieves the pressure on memory allowing the NIC to DMA */
1995                rte_delay_us(10);
1996        }
1997
1998        /* We'll never get here - but if we did it would be bad */
1999        return READ_ERROR;
2000}
2001
2002static int dpdk_pread_packets (libtrace_t *libtrace,
2003                                    libtrace_thread_t *t,
2004                                    libtrace_packet_t **packets,
2005                                    size_t nb_packets) {
2006        int nb_rx; /* Number of rx packets we've recevied */
2007        struct rte_mbuf* pkts_burst[nb_packets]; /* Array of pointer(s) */
2008        int i;
2009        dpdk_per_stream_t *stream = t->format_data;
2010        struct dpdk_addt_hdr * hdr;
2011
2012        nb_rx = dpdk_read_packet_stream (libtrace, stream, &t->messages,
2013                                         pkts_burst, nb_packets);
2014
2015        if (nb_rx > 0) {
2016                for (i = 0; i < nb_rx; ++i) {
2017                        if (packets[i]->buffer != NULL) {
2018                                /* The packet should always be finished */
2019                                if (packets[i]->buf_control != TRACE_CTRL_PACKET) {
2020                                        trace_set_err(libtrace, TRACE_ERR_BAD_PACKET, "Expected packet buffer "
2021                                                "to be empty in dpdk_pread_packets()\n");
2022                                        return -1;
2023                                }
2024                                free(packets[i]->buffer);
2025                        }
2026                        packets[i]->buf_control = TRACE_CTRL_EXTERNAL;
2027                        packets[i]->type = TRACE_RT_DATA_DPDK;
2028                        packets[i]->buffer = pkts_burst[i];
2029                        packets[i]->trace = libtrace;
2030                        packets[i]->error = 1;
2031                        hdr = (struct dpdk_addt_hdr *) 
2032                                        ((struct rte_mbuf*) pkts_burst[i] + 1);
2033                        packets[i]->order = hdr->timestamp;
2034                        dpdk_prepare_packet(libtrace, packets[i], packets[i]->buffer, packets[i]->type, 0);
2035                }
2036        }
2037
2038        return nb_rx;
2039}
2040
2041int dpdk_read_packet (libtrace_t *libtrace, libtrace_packet_t *packet) {
2042        int nb_rx; /* Number of rx packets we've received */
2043        dpdk_per_stream_t *stream = FORMAT_DATA_FIRST(libtrace);
2044
2045        /* Free the last packet buffer */
2046        if (packet->buffer != NULL) {
2047                /* The packet should always be finished */
2048                if (packet->buf_control != TRACE_CTRL_PACKET) {
2049                        trace_set_err(libtrace, TRACE_ERR_BAD_PACKET, "Expected packet buffer to be "
2050                                "empty in dpdk_read_packet()\n");
2051                        return -1;
2052                }
2053                free(packet->buffer);
2054                packet->buffer = NULL;
2055        }
2056
2057        packet->buf_control = TRACE_CTRL_EXTERNAL;
2058        packet->type = TRACE_RT_DATA_DPDK;
2059
2060        /* Check if we already have some packets buffered */
2061        if (FORMAT(libtrace)->burst_size != FORMAT(libtrace)->burst_offset) {
2062                packet->buffer = FORMAT(libtrace)->burst_pkts[FORMAT(libtrace)->burst_offset++];
2063                packet->trace = libtrace;
2064                dpdk_prepare_packet(libtrace, packet, packet->buffer, packet->type, 0);
2065                return 1; // TODO should be bytes read, which essentially useless anyway
2066        }
2067
2068        nb_rx = dpdk_read_packet_stream (libtrace, stream, NULL,
2069                                         FORMAT(libtrace)->burst_pkts, BURST_SIZE);
2070
2071        if (nb_rx > 0) {
2072                FORMAT(libtrace)->burst_size = nb_rx;
2073                FORMAT(libtrace)->burst_offset = 1;
2074                packet->buffer = FORMAT(libtrace)->burst_pkts[0];
2075                packet->trace = libtrace;
2076                dpdk_prepare_packet(libtrace, packet, packet->buffer, packet->type, 0);
2077                return 1;
2078        }
2079        return nb_rx;
2080}
2081
2082static struct timeval dpdk_get_timeval (const libtrace_packet_t *packet) {
2083        struct timeval tv;
2084        struct dpdk_addt_hdr * hdr = get_addt_hdr(packet);
2085
2086        tv.tv_sec = hdr->timestamp / (uint64_t) 1000000000;
2087        tv.tv_usec = (hdr->timestamp % (uint64_t) 1000000000) / 1000;
2088        return tv;
2089}
2090
2091static struct timespec dpdk_get_timespec (const libtrace_packet_t *packet) {
2092        struct timespec ts;
2093        struct dpdk_addt_hdr * hdr = get_addt_hdr(packet);
2094
2095        ts.tv_sec = hdr->timestamp / (uint64_t) 1000000000;
2096        ts.tv_nsec = hdr->timestamp % (uint64_t) 1000000000;
2097        return ts;
2098}
2099
2100static libtrace_linktype_t dpdk_get_link_type (const libtrace_packet_t *packet UNUSED) {
2101        return TRACE_TYPE_ETH; /* Always ethernet until proven otherwise */
2102}
2103
2104static libtrace_direction_t dpdk_get_direction (const libtrace_packet_t *packet) {
2105        struct dpdk_addt_hdr * hdr = get_addt_hdr(packet);
2106        return (libtrace_direction_t) hdr->direction;
2107}
2108
2109static libtrace_direction_t dpdk_set_direction(libtrace_packet_t *packet, libtrace_direction_t direction) {
2110        struct dpdk_addt_hdr * hdr = get_addt_hdr(packet);
2111        hdr->direction = (uint8_t) direction;
2112        return (libtrace_direction_t) hdr->direction;
2113}
2114
2115void dpdk_get_stats(libtrace_t *trace, libtrace_stat_t *stats) {
2116        struct rte_eth_stats dev_stats = {0};
2117
2118        if (trace->format_data == NULL || FORMAT(trace)->port == 0xFF)
2119                return;
2120
2121        /* Grab the current stats */
2122        rte_eth_stats_get(FORMAT(trace)->port, &dev_stats);
2123
2124        stats->captured_valid = true;
2125        stats->captured = dev_stats.ipackets;
2126
2127        stats->dropped_valid = true;
2128        stats->dropped = dev_stats.imissed;
2129
2130#if RTE_VERSION >= RTE_VERSION_NUM(16, 4, 0, 2)
2131        /* DPDK commit 86057c fixes ensures missed does not get counted as
2132         * errors */
2133        stats->errors_valid = true;
2134        stats->errors = dev_stats.ierrors;
2135#else
2136        /* DPDK errors includes drops */
2137        stats->errors_valid = true;
2138        stats->errors = dev_stats.ierrors - dev_stats.imissed;
2139#endif
2140        stats->received_valid = true;
2141        stats->received = dev_stats.ipackets + dev_stats.imissed;
2142
2143}
2144
2145/* Attempts to read a packet in a non-blocking fashion. If one is not
2146 * available a SLEEP event is returned. We do not have the ability to
2147 * create a select()able file descriptor in DPDK.
2148 */
2149libtrace_eventobj_t dpdk_trace_event(libtrace_t *trace,
2150                                            libtrace_packet_t *packet) {
2151        libtrace_eventobj_t event = {0,0,0.0,0};
2152        size_t nb_rx; /* Number of received packets we've read */
2153
2154        do {
2155
2156                /* No packets waiting in our buffer? Try and read some more */
2157                if (FORMAT(trace)->burst_size == FORMAT(trace)->burst_offset) {
2158                        nb_rx = rte_eth_rx_burst(FORMAT(trace)->port,
2159                                                 FORMAT_DATA_FIRST(trace)->queue_id,
2160                                                 FORMAT(trace)->burst_pkts, BURST_SIZE);
2161                        if (nb_rx > 0) {
2162                                dpdk_ready_pkts(trace, FORMAT_DATA_FIRST(trace),
2163                                                FORMAT(trace)->burst_pkts, nb_rx);
2164                                FORMAT(trace)->burst_size = nb_rx;
2165                                FORMAT(trace)->burst_offset = 0;
2166                        }
2167                }
2168
2169                /* Now do we have packets waiting? */
2170                if (FORMAT(trace)->burst_size != FORMAT(trace)->burst_offset) {
2171                        /* Free the last packet buffer */
2172                        if (packet->buffer != NULL) {
2173                                /* The packet should always be finished */
2174                                if (packet->buf_control != TRACE_CTRL_PACKET) {
2175                                        trace_set_err(trace, TRACE_ERR_BAD_PACKET, "Expected packet "
2176                                                "buffer to be empty in dpdk_trace_event()\n");
2177                                        event.type = TRACE_EVENT_TERMINATE;
2178                                        return event;
2179                                }
2180                                free(packet->buffer);
2181                                packet->buffer = NULL;
2182                        }
2183
2184                        packet->buf_control = TRACE_CTRL_EXTERNAL;
2185                        packet->type = TRACE_RT_DATA_DPDK;
2186                        event.type = TRACE_EVENT_PACKET;
2187                        packet->buffer = FORMAT(trace)->burst_pkts[
2188                                             FORMAT(trace)->burst_offset++];
2189                        dpdk_prepare_packet(trace, packet, packet->buffer, packet->type, 0);
2190                        event.size = 1; // TODO should be bytes read, which essentially useless anyway
2191
2192                        /* XXX - Check this passes the filter trace_read_packet normally
2193                         * does this for us but this wont */
2194                        if (trace->filter) {
2195                                if (!trace_apply_filter(trace->filter, packet)) {
2196                                        /* Failed the filter so we loop for another packet */
2197                                        trace->filtered_packets ++;
2198                                        continue;
2199                                }
2200                        }
2201                        trace->accepted_packets ++;
2202                } else {
2203                        /* We only want to sleep for a very short time - we are non-blocking */
2204                        event.type = TRACE_EVENT_SLEEP;
2205                        event.seconds = 0.0001;
2206                        event.size = 0;
2207                }
2208
2209                /* If we get here we have our event */
2210                break;
2211        } while (1);
2212
2213        return event;
2214}
2215
2216static void dpdk_help(void) {
2217        printf("dpdk format module: %s (%d) \n", rte_version(), RTE_VERSION);
2218        printf("Supported input URIs:\n");
2219        printf("\tdpdk:<domain:bus:devid.func>-<coreid>\n");
2220        printf("\tThe -<coreid> is optional \n");
2221        printf("\t e.g. dpdk:0000:01:00.1\n");
2222        printf("\t e.g. dpdk:0000:01:00.1-2 (Use the second CPU core)\n\n");
2223        printf("\t By default the last CPU core is used if not otherwise specified.\n");
2224        printf("\t Only a single libtrace instance of dpdk can use the same CPU core.\n");
2225        printf("\t Support for multiple simultaneous instances of dpdk format is currently limited.\n");
2226        printf("\n");
2227        printf("Supported output URIs:\n");
2228        printf("\tSame format as the input URI.\n");
2229        printf("\t e.g. dpdk:0000:01:00.1\n");
2230        printf("\t e.g. dpdk:0000:01:00.1-2 (Use the second CPU core)\n");
2231        printf("\n");
2232}
2233
2234static struct libtrace_format_t dpdk = {
2235        "dpdk",
2236        "$Id$",
2237        TRACE_FORMAT_DPDK,
2238        NULL,                               /* probe filename */
2239        NULL,                               /* probe magic */
2240        dpdk_init_input,                    /* init_input */
2241        dpdk_config_input,                  /* config_input */
2242        dpdk_start_input,                   /* start_input */
2243        dpdk_pause_input,                   /* pause_input */
2244        dpdk_init_output,                   /* init_output */
2245        NULL,                               /* config_output */
2246        dpdk_start_output,                  /* start_ouput */
2247        dpdk_fin_input,                     /* fin_input */
2248        dpdk_fin_output,                    /* fin_output */
2249        dpdk_read_packet,                   /* read_packet */
2250        dpdk_prepare_packet,                /* prepare_packet */
2251        dpdk_fin_packet,                    /* fin_packet */
2252        dpdk_write_packet,                  /* write_packet */
2253        NULL,                               /* flush_output */
2254        dpdk_get_link_type,                 /* get_link_type */
2255        dpdk_get_direction,                 /* get_direction */
2256        dpdk_set_direction,                 /* set_direction */
2257        NULL,                               /* get_erf_timestamp */
2258        dpdk_get_timeval,                   /* get_timeval */
2259        dpdk_get_timespec,                  /* get_timespec */
2260        NULL,                               /* get_seconds */
2261        NULL,                               /* seek_erf */
2262        NULL,                               /* seek_timeval */
2263        NULL,                               /* seek_seconds */
2264        dpdk_get_capture_length,            /* get_capture_length */
2265        dpdk_get_wire_length,               /* get_wire_length */
2266        dpdk_get_framing_length,            /* get_framing_length */
2267        dpdk_set_capture_length,            /* set_capture_length */
2268        NULL,                               /* get_received_packets */
2269        NULL,                               /* get_filtered_packets */
2270        NULL,                               /* get_dropped_packets */
2271        dpdk_get_stats,                     /* get_statistics */
2272        NULL,                               /* get_fd */
2273        dpdk_trace_event,                   /* trace_event */
2274        dpdk_help,                          /* help */
2275        NULL,                               /* next pointer */
2276        {true, 8},                          /* Live, NICs typically have 8 threads */
2277        dpdk_pstart_input,                  /* pstart_input */
2278        dpdk_pread_packets,                 /* pread_packets */
2279        dpdk_pause_input,                   /* ppause */
2280        dpdk_fin_input,                     /* p_fin */
2281        dpdk_pregister_thread,              /* pregister_thread */
2282        dpdk_punregister_thread,            /* punregister_thread */
2283        NULL                                /* get thread stats */
2284};
2285
2286void dpdk_constructor(void) {
2287        register_format(&dpdk);
2288}
Note: See TracBrowser for help on using the repository browser.