source: lib/format_dpdk.c @ 3b94ef2

cachetimestampsdeveloprc-4.0.4ringdecrementfixringperformance
Last change on this file since 3b94ef2 was 3b94ef2, checked in by Shane Alcock <salcock@…>, 2 years ago

Fix missing config option in dpdk_config()

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