source: lib/format_dpdk.c @ 8efa986

cachetimestampsdevelopdpdk-ndagetsiliverc-4.0.3rc-4.0.4ringdecrementfixringperformance
Last change on this file since 8efa986 was 8efa986, checked in by Shane Alcock <salcock@…>, 4 years ago

Ensure dpdk snap length is rounded up to next power of 2

Otherwise, we run the risk of the mbufs being too small for our
anticipated packets.

Changed dpdk_get_framing_length and dpdk_get_stats to be accessible
via format_dpdk.h

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