1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2016-2018 Intel Corporation
5 #include <rte_memcpy.h>
7 #include <rte_ethdev.h>
10 #include <rte_memzone.h>
11 #include <rte_errno.h>
12 #include <rte_string_fns.h>
13 #include <rte_pcapng.h>
15 #include "rte_pdump.h"
17 RTE_LOG_REGISTER_DEFAULT(pdump_logtype, NOTICE);
19 /* Macro for printing using RTE_LOG */
20 #define PDUMP_LOG(level, fmt, args...) \
21 rte_log(RTE_LOG_ ## level, pdump_logtype, "%s(): " fmt, \
24 /* Used for the multi-process communication */
25 #define PDUMP_MP "mp_pdump"
27 enum pdump_operation {
32 /* Internal version number in request */
34 V1 = 1, /* no filtering or snap */
38 struct pdump_request {
42 char device[RTE_DEV_NAME_MAX_LEN];
44 struct rte_ring *ring;
45 struct rte_mempool *mp;
47 const struct rte_bpf_prm *prm;
51 struct pdump_response {
57 static struct pdump_rxtx_cbs {
58 struct rte_ring *ring;
59 struct rte_mempool *mp;
60 const struct rte_eth_rxtx_callback *cb;
61 const struct rte_bpf *filter;
62 enum pdump_version ver;
64 } rx_cbs[RTE_MAX_ETHPORTS][RTE_MAX_QUEUES_PER_PORT],
65 tx_cbs[RTE_MAX_ETHPORTS][RTE_MAX_QUEUES_PER_PORT];
69 * The packet capture statistics keep track of packets
70 * accepted, filtered and dropped. These are per-queue
71 * and in memory between primary and secondary processes.
73 static const char MZ_RTE_PDUMP_STATS[] = "rte_pdump_stats";
75 struct rte_pdump_stats rx[RTE_MAX_ETHPORTS][RTE_MAX_QUEUES_PER_PORT];
76 struct rte_pdump_stats tx[RTE_MAX_ETHPORTS][RTE_MAX_QUEUES_PER_PORT];
79 /* Create a clone of mbuf to be placed into ring. */
81 pdump_copy(uint16_t port_id, uint16_t queue,
82 enum rte_pcapng_direction direction,
83 struct rte_mbuf **pkts, uint16_t nb_pkts,
84 const struct pdump_rxtx_cbs *cbs,
85 struct rte_pdump_stats *stats)
90 struct rte_mbuf *dup_bufs[nb_pkts];
92 struct rte_ring *ring;
93 struct rte_mempool *mp;
95 uint64_t rcs[nb_pkts];
98 rte_bpf_exec_burst(cbs->filter, (void **)pkts, rcs, nb_pkts);
100 ts = rte_get_tsc_cycles();
103 for (i = 0; i < nb_pkts; i++) {
105 * This uses same BPF return value convention as socket filter
106 * and pcap_offline_filter.
107 * if program returns zero
108 * then packet doesn't match the filter (will be ignored).
110 if (cbs->filter && rcs[i] == 0) {
111 __atomic_fetch_add(&stats->filtered,
112 1, __ATOMIC_RELAXED);
117 * If using pcapng then want to wrap packets
118 * otherwise a simple copy.
121 p = rte_pcapng_copy(port_id, queue,
122 pkts[i], mp, cbs->snaplen,
125 p = rte_pktmbuf_copy(pkts[i], mp, 0, cbs->snaplen);
127 if (unlikely(p == NULL))
128 __atomic_fetch_add(&stats->nombuf, 1, __ATOMIC_RELAXED);
130 dup_bufs[d_pkts++] = p;
133 __atomic_fetch_add(&stats->accepted, d_pkts, __ATOMIC_RELAXED);
135 ring_enq = rte_ring_enqueue_burst(ring, (void *)dup_bufs, d_pkts, NULL);
136 if (unlikely(ring_enq < d_pkts)) {
137 unsigned int drops = d_pkts - ring_enq;
139 __atomic_fetch_add(&stats->ringfull, drops, __ATOMIC_RELAXED);
140 rte_pktmbuf_free_bulk(&dup_bufs[ring_enq], drops);
145 pdump_rx(uint16_t port, uint16_t queue,
146 struct rte_mbuf **pkts, uint16_t nb_pkts,
147 uint16_t max_pkts __rte_unused, void *user_params)
149 const struct pdump_rxtx_cbs *cbs = user_params;
150 struct rte_pdump_stats *stats = &pdump_stats->rx[port][queue];
152 pdump_copy(port, queue, RTE_PCAPNG_DIRECTION_IN,
153 pkts, nb_pkts, cbs, stats);
158 pdump_tx(uint16_t port, uint16_t queue,
159 struct rte_mbuf **pkts, uint16_t nb_pkts, void *user_params)
161 const struct pdump_rxtx_cbs *cbs = user_params;
162 struct rte_pdump_stats *stats = &pdump_stats->tx[port][queue];
164 pdump_copy(port, queue, RTE_PCAPNG_DIRECTION_OUT,
165 pkts, nb_pkts, cbs, stats);
170 pdump_register_rx_callbacks(enum pdump_version ver,
171 uint16_t end_q, uint16_t port, uint16_t queue,
172 struct rte_ring *ring, struct rte_mempool *mp,
173 struct rte_bpf *filter,
174 uint16_t operation, uint32_t snaplen)
178 qid = (queue == RTE_PDUMP_ALL_QUEUES) ? 0 : queue;
179 for (; qid < end_q; qid++) {
180 struct pdump_rxtx_cbs *cbs = &rx_cbs[port][qid];
182 if (operation == ENABLE) {
185 "rx callback for port=%d queue=%d, already exists\n",
192 cbs->snaplen = snaplen;
193 cbs->filter = filter;
195 cbs->cb = rte_eth_add_first_rx_callback(port, qid,
197 if (cbs->cb == NULL) {
199 "failed to add rx callback, errno=%d\n",
203 } else if (operation == DISABLE) {
206 if (cbs->cb == NULL) {
208 "no existing rx callback for port=%d queue=%d\n",
212 ret = rte_eth_remove_rx_callback(port, qid, cbs->cb);
215 "failed to remove rx callback, errno=%d\n",
227 pdump_register_tx_callbacks(enum pdump_version ver,
228 uint16_t end_q, uint16_t port, uint16_t queue,
229 struct rte_ring *ring, struct rte_mempool *mp,
230 struct rte_bpf *filter,
231 uint16_t operation, uint32_t snaplen)
236 qid = (queue == RTE_PDUMP_ALL_QUEUES) ? 0 : queue;
237 for (; qid < end_q; qid++) {
238 struct pdump_rxtx_cbs *cbs = &tx_cbs[port][qid];
240 if (operation == ENABLE) {
243 "tx callback for port=%d queue=%d, already exists\n",
250 cbs->snaplen = snaplen;
251 cbs->filter = filter;
253 cbs->cb = rte_eth_add_tx_callback(port, qid, pdump_tx,
255 if (cbs->cb == NULL) {
257 "failed to add tx callback, errno=%d\n",
261 } else if (operation == DISABLE) {
264 if (cbs->cb == NULL) {
266 "no existing tx callback for port=%d queue=%d\n",
270 ret = rte_eth_remove_tx_callback(port, qid, cbs->cb);
273 "failed to remove tx callback, errno=%d\n",
285 set_pdump_rxtx_cbs(const struct pdump_request *p)
287 uint16_t nb_rx_q = 0, nb_tx_q = 0, end_q, queue;
290 struct rte_bpf *filter = NULL;
293 struct rte_ring *ring;
294 struct rte_mempool *mp;
296 /* Check for possible DPDK version mismatch */
297 if (!(p->ver == V1 || p->ver == V2)) {
299 "incorrect client version %u\n", p->ver);
304 if (p->prm->prog_arg.type != RTE_BPF_ARG_PTR_MBUF) {
306 "invalid BPF program type: %u\n",
307 p->prm->prog_arg.type);
311 filter = rte_bpf_load(p->prm);
312 if (filter == NULL) {
313 PDUMP_LOG(ERR, "cannot load BPF filter: %s\n",
314 rte_strerror(rte_errno));
325 ret = rte_eth_dev_get_port_by_name(p->device, &port);
328 "failed to get port id for device id=%s\n",
333 /* validation if packet capture is for all queues */
334 if (queue == RTE_PDUMP_ALL_QUEUES) {
335 struct rte_eth_dev_info dev_info;
337 ret = rte_eth_dev_info_get(port, &dev_info);
340 "Error during getting device (port %u) info: %s\n",
341 port, strerror(-ret));
345 nb_rx_q = dev_info.nb_rx_queues;
346 nb_tx_q = dev_info.nb_tx_queues;
347 if (nb_rx_q == 0 && flags & RTE_PDUMP_FLAG_RX) {
349 "number of rx queues cannot be 0\n");
352 if (nb_tx_q == 0 && flags & RTE_PDUMP_FLAG_TX) {
354 "number of tx queues cannot be 0\n");
357 if ((nb_tx_q == 0 || nb_rx_q == 0) &&
358 flags == RTE_PDUMP_FLAG_RXTX) {
360 "both tx&rx queues must be non zero\n");
365 /* register RX callback */
366 if (flags & RTE_PDUMP_FLAG_RX) {
367 end_q = (queue == RTE_PDUMP_ALL_QUEUES) ? nb_rx_q : queue + 1;
368 ret = pdump_register_rx_callbacks(p->ver, end_q, port, queue,
370 operation, p->snaplen);
375 /* register TX callback */
376 if (flags & RTE_PDUMP_FLAG_TX) {
377 end_q = (queue == RTE_PDUMP_ALL_QUEUES) ? nb_tx_q : queue + 1;
378 ret = pdump_register_tx_callbacks(p->ver, end_q, port, queue,
380 operation, p->snaplen);
389 pdump_server(const struct rte_mp_msg *mp_msg, const void *peer)
391 struct rte_mp_msg mp_resp;
392 const struct pdump_request *cli_req;
393 struct pdump_response *resp = (struct pdump_response *)&mp_resp.param;
395 /* recv client requests */
396 if (mp_msg->len_param != sizeof(*cli_req)) {
397 PDUMP_LOG(ERR, "failed to recv from client\n");
398 resp->err_value = -EINVAL;
400 cli_req = (const struct pdump_request *)mp_msg->param;
401 resp->ver = cli_req->ver;
402 resp->res_op = cli_req->op;
403 resp->err_value = set_pdump_rxtx_cbs(cli_req);
406 rte_strscpy(mp_resp.name, PDUMP_MP, RTE_MP_MAX_NAME_LEN);
407 mp_resp.len_param = sizeof(*resp);
409 if (rte_mp_reply(&mp_resp, peer) < 0) {
410 PDUMP_LOG(ERR, "failed to send to client:%s\n",
411 strerror(rte_errno));
421 const struct rte_memzone *mz;
424 mz = rte_memzone_reserve(MZ_RTE_PDUMP_STATS, sizeof(*pdump_stats),
427 PDUMP_LOG(ERR, "cannot allocate pdump statistics\n");
431 pdump_stats = mz->addr;
433 ret = rte_mp_action_register(PDUMP_MP, pdump_server);
434 if (ret && rte_errno != ENOTSUP)
440 rte_pdump_uninit(void)
442 rte_mp_action_unregister(PDUMP_MP);
448 pdump_validate_ring_mp(struct rte_ring *ring, struct rte_mempool *mp)
450 if (ring == NULL || mp == NULL) {
451 PDUMP_LOG(ERR, "NULL ring or mempool\n");
455 if (mp->flags & RTE_MEMPOOL_F_SP_PUT ||
456 mp->flags & RTE_MEMPOOL_F_SC_GET) {
458 "mempool with SP or SC set not valid for pdump,"
459 "must have MP and MC set\n");
463 if (rte_ring_is_prod_single(ring) || rte_ring_is_cons_single(ring)) {
465 "ring with SP or SC set is not valid for pdump,"
466 "must have MP and MC set\n");
475 pdump_validate_flags(uint32_t flags)
477 if ((flags & RTE_PDUMP_FLAG_RXTX) == 0) {
479 "invalid flags, should be either rx/tx/rxtx\n");
484 /* mask off the flags we know about */
485 if (flags & ~(RTE_PDUMP_FLAG_RXTX | RTE_PDUMP_FLAG_PCAPNG)) {
487 "unknown flags: %#x\n", flags);
496 pdump_validate_port(uint16_t port, char *name)
500 if (port >= RTE_MAX_ETHPORTS) {
501 PDUMP_LOG(ERR, "Invalid port id %u\n", port);
506 ret = rte_eth_dev_get_name_by_port(port, name);
508 PDUMP_LOG(ERR, "port %u to name mapping failed\n",
518 pdump_prepare_client_request(const char *device, uint16_t queue,
519 uint32_t flags, uint32_t snaplen,
521 struct rte_ring *ring,
522 struct rte_mempool *mp,
523 const struct rte_bpf_prm *prm)
526 struct rte_mp_msg mp_req, *mp_rep;
527 struct rte_mp_reply mp_reply;
528 struct timespec ts = {.tv_sec = 5, .tv_nsec = 0};
529 struct pdump_request *req = (struct pdump_request *)mp_req.param;
530 struct pdump_response *resp;
532 memset(req, 0, sizeof(*req));
534 req->ver = (flags & RTE_PDUMP_FLAG_PCAPNG) ? V2 : V1;
535 req->flags = flags & RTE_PDUMP_FLAG_RXTX;
538 rte_strscpy(req->device, device, sizeof(req->device));
540 if ((operation & ENABLE) != 0) {
544 req->snaplen = snaplen;
547 rte_strscpy(mp_req.name, PDUMP_MP, RTE_MP_MAX_NAME_LEN);
548 mp_req.len_param = sizeof(*req);
550 if (rte_mp_request_sync(&mp_req, &mp_reply, &ts) == 0) {
551 mp_rep = &mp_reply.msgs[0];
552 resp = (struct pdump_response *)mp_rep->param;
553 rte_errno = resp->err_value;
554 if (!resp->err_value)
561 "client request for pdump enable/disable failed\n");
566 * There are two versions of this function, because although original API
567 * left place holder for future filter, it never checked the value.
568 * Therefore the API can't depend on application passing a non
572 pdump_enable(uint16_t port, uint16_t queue,
573 uint32_t flags, uint32_t snaplen,
574 struct rte_ring *ring, struct rte_mempool *mp,
575 const struct rte_bpf_prm *prm)
578 char name[RTE_DEV_NAME_MAX_LEN];
580 ret = pdump_validate_port(port, name);
583 ret = pdump_validate_ring_mp(ring, mp);
586 ret = pdump_validate_flags(flags);
591 snaplen = UINT32_MAX;
593 return pdump_prepare_client_request(name, queue, flags, snaplen,
594 ENABLE, ring, mp, prm);
598 rte_pdump_enable(uint16_t port, uint16_t queue, uint32_t flags,
599 struct rte_ring *ring,
600 struct rte_mempool *mp,
601 void *filter __rte_unused)
603 return pdump_enable(port, queue, flags, 0,
608 rte_pdump_enable_bpf(uint16_t port, uint16_t queue,
609 uint32_t flags, uint32_t snaplen,
610 struct rte_ring *ring,
611 struct rte_mempool *mp,
612 const struct rte_bpf_prm *prm)
614 return pdump_enable(port, queue, flags, snaplen,
619 pdump_enable_by_deviceid(const char *device_id, uint16_t queue,
620 uint32_t flags, uint32_t snaplen,
621 struct rte_ring *ring,
622 struct rte_mempool *mp,
623 const struct rte_bpf_prm *prm)
627 ret = pdump_validate_ring_mp(ring, mp);
630 ret = pdump_validate_flags(flags);
634 return pdump_prepare_client_request(device_id, queue, flags, snaplen,
635 ENABLE, ring, mp, prm);
639 rte_pdump_enable_by_deviceid(char *device_id, uint16_t queue,
641 struct rte_ring *ring,
642 struct rte_mempool *mp,
643 void *filter __rte_unused)
645 return pdump_enable_by_deviceid(device_id, queue, flags, 0,
650 rte_pdump_enable_bpf_by_deviceid(const char *device_id, uint16_t queue,
651 uint32_t flags, uint32_t snaplen,
652 struct rte_ring *ring,
653 struct rte_mempool *mp,
654 const struct rte_bpf_prm *prm)
656 return pdump_enable_by_deviceid(device_id, queue, flags, snaplen,
661 rte_pdump_disable(uint16_t port, uint16_t queue, uint32_t flags)
664 char name[RTE_DEV_NAME_MAX_LEN];
666 ret = pdump_validate_port(port, name);
669 ret = pdump_validate_flags(flags);
673 ret = pdump_prepare_client_request(name, queue, flags, 0,
674 DISABLE, NULL, NULL, NULL);
680 rte_pdump_disable_by_deviceid(char *device_id, uint16_t queue,
685 ret = pdump_validate_flags(flags);
689 ret = pdump_prepare_client_request(device_id, queue, flags, 0,
690 DISABLE, NULL, NULL, NULL);
696 pdump_sum_stats(uint16_t port, uint16_t nq,
697 struct rte_pdump_stats stats[RTE_MAX_ETHPORTS][RTE_MAX_QUEUES_PER_PORT],
698 struct rte_pdump_stats *total)
700 uint64_t *sum = (uint64_t *)total;
705 for (qid = 0; qid < nq; qid++) {
706 const uint64_t *perq = (const uint64_t *)&stats[port][qid];
708 for (i = 0; i < sizeof(*total) / sizeof(uint64_t); i++) {
709 val = __atomic_load_n(&perq[i], __ATOMIC_RELAXED);
716 rte_pdump_stats(uint16_t port, struct rte_pdump_stats *stats)
718 struct rte_eth_dev_info dev_info;
719 const struct rte_memzone *mz;
722 memset(stats, 0, sizeof(*stats));
723 ret = rte_eth_dev_info_get(port, &dev_info);
726 "Error during getting device (port %u) info: %s\n",
727 port, strerror(-ret));
731 if (pdump_stats == NULL) {
732 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
733 /* rte_pdump_init was not called */
734 PDUMP_LOG(ERR, "pdump stats not initialized\n");
739 /* secondary process looks up the memzone */
740 mz = rte_memzone_lookup(MZ_RTE_PDUMP_STATS);
742 /* rte_pdump_init was not called in primary process?? */
743 PDUMP_LOG(ERR, "can not find pdump stats\n");
747 pdump_stats = mz->addr;
750 pdump_sum_stats(port, dev_info.nb_rx_queues, pdump_stats->rx, stats);
751 pdump_sum_stats(port, dev_info.nb_tx_queues, pdump_stats->tx, stats);