source: lib/format_dpdk.c @ 2193905

develop
Last change on this file since 2193905 was 2193905, checked in by Jacob Van Walraven <jcv9@…>, 2 years ago

Apply changes required for pull request #81

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