source: lib/format_dpdk.c @ 5cdb37d

develop
Last change on this file since 5cdb37d was 5cdb37d, checked in by GitHub <noreply@…>, 21 months ago

Merge pull request #101 from jacobvw/meta-api

Meta API

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