1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2016 Intel Corporation
5 #include <sys/socket.h>
14 #include <rte_memcpy.h>
16 #include <rte_ethdev.h>
17 #include <rte_lcore.h>
19 #include <rte_errno.h>
21 #include "rte_pdump.h"
23 #define SOCKET_PATH_VAR_RUN "/var/run"
24 #define SOCKET_PATH_HOME "HOME"
25 #define DPDK_DIR "/.dpdk"
26 #define SOCKET_DIR "/pdump_sockets"
27 #define SERVER_SOCKET "%s/pdump_server_socket"
28 #define CLIENT_SOCKET "%s/pdump_client_socket_%d_%u"
29 #define DEVICE_ID_SIZE 64
30 /* Macros for printing using RTE_LOG */
31 #define RTE_LOGTYPE_PDUMP RTE_LOGTYPE_USER1
33 enum pdump_operation {
42 static pthread_t pdump_thread;
43 static int pdump_socket_fd;
44 static char server_socket_dir[PATH_MAX];
45 static char client_socket_dir[PATH_MAX];
47 struct pdump_request {
53 char device[DEVICE_ID_SIZE];
55 struct rte_ring *ring;
56 struct rte_mempool *mp;
60 char device[DEVICE_ID_SIZE];
62 struct rte_ring *ring;
63 struct rte_mempool *mp;
69 struct pdump_response {
75 static struct pdump_rxtx_cbs {
76 struct rte_ring *ring;
77 struct rte_mempool *mp;
78 struct rte_eth_rxtx_callback *cb;
80 } rx_cbs[RTE_MAX_ETHPORTS][RTE_MAX_QUEUES_PER_PORT],
81 tx_cbs[RTE_MAX_ETHPORTS][RTE_MAX_QUEUES_PER_PORT];
84 pdump_pktmbuf_copy_data(struct rte_mbuf *seg, const struct rte_mbuf *m)
86 if (rte_pktmbuf_tailroom(seg) < m->data_len) {
88 "User mempool: insufficient data_len of mbuf\n");
93 seg->vlan_tci = m->vlan_tci;
95 seg->tx_offload = m->tx_offload;
96 seg->ol_flags = m->ol_flags;
97 seg->packet_type = m->packet_type;
98 seg->vlan_tci_outer = m->vlan_tci_outer;
99 seg->data_len = m->data_len;
100 seg->pkt_len = seg->data_len;
101 rte_memcpy(rte_pktmbuf_mtod(seg, void *),
102 rte_pktmbuf_mtod(m, void *),
103 rte_pktmbuf_data_len(seg));
108 static inline struct rte_mbuf *
109 pdump_pktmbuf_copy(struct rte_mbuf *m, struct rte_mempool *mp)
111 struct rte_mbuf *m_dup, *seg, **prev;
115 m_dup = rte_pktmbuf_alloc(mp);
116 if (unlikely(m_dup == NULL))
126 if (pdump_pktmbuf_copy_data(seg, m) < 0) {
128 rte_pktmbuf_free_seg(seg);
129 rte_pktmbuf_free(m_dup);
134 } while ((m = m->next) != NULL &&
135 (seg = rte_pktmbuf_alloc(mp)) != NULL);
138 m_dup->nb_segs = nseg;
139 m_dup->pkt_len = pktlen;
141 /* Allocation of new indirect segment failed */
142 if (unlikely(seg == NULL)) {
143 rte_pktmbuf_free(m_dup);
147 __rte_mbuf_sanity_check(m_dup, 1);
152 pdump_copy(struct rte_mbuf **pkts, uint16_t nb_pkts, void *user_params)
157 struct rte_mbuf *dup_bufs[nb_pkts];
158 struct pdump_rxtx_cbs *cbs;
159 struct rte_ring *ring;
160 struct rte_mempool *mp;
166 for (i = 0; i < nb_pkts; i++) {
167 p = pdump_pktmbuf_copy(pkts[i], mp);
169 dup_bufs[d_pkts++] = p;
172 ring_enq = rte_ring_enqueue_burst(ring, (void *)dup_bufs, d_pkts, NULL);
173 if (unlikely(ring_enq < d_pkts)) {
174 RTE_LOG(DEBUG, PDUMP,
175 "only %d of packets enqueued to ring\n", ring_enq);
177 rte_pktmbuf_free(dup_bufs[ring_enq]);
178 } while (++ring_enq < d_pkts);
183 pdump_rx(uint16_t port __rte_unused, uint16_t qidx __rte_unused,
184 struct rte_mbuf **pkts, uint16_t nb_pkts,
185 uint16_t max_pkts __rte_unused,
188 pdump_copy(pkts, nb_pkts, user_params);
193 pdump_tx(uint16_t port __rte_unused, uint16_t qidx __rte_unused,
194 struct rte_mbuf **pkts, uint16_t nb_pkts, void *user_params)
196 pdump_copy(pkts, nb_pkts, user_params);
201 pdump_register_rx_callbacks(uint16_t end_q, uint16_t port, uint16_t queue,
202 struct rte_ring *ring, struct rte_mempool *mp,
206 struct pdump_rxtx_cbs *cbs = NULL;
208 qid = (queue == RTE_PDUMP_ALL_QUEUES) ? 0 : queue;
209 for (; qid < end_q; qid++) {
210 cbs = &rx_cbs[port][qid];
211 if (cbs && operation == ENABLE) {
214 "failed to add rx callback for port=%d "
215 "and queue=%d, callback already exists\n",
221 cbs->cb = rte_eth_add_first_rx_callback(port, qid,
223 if (cbs->cb == NULL) {
225 "failed to add rx callback, errno=%d\n",
230 if (cbs && operation == DISABLE) {
233 if (cbs->cb == NULL) {
235 "failed to delete non existing rx "
236 "callback for port=%d and queue=%d\n",
240 ret = rte_eth_remove_rx_callback(port, qid, cbs->cb);
243 "failed to remove rx callback, errno=%d\n",
255 pdump_register_tx_callbacks(uint16_t end_q, uint16_t port, uint16_t queue,
256 struct rte_ring *ring, struct rte_mempool *mp,
261 struct pdump_rxtx_cbs *cbs = NULL;
263 qid = (queue == RTE_PDUMP_ALL_QUEUES) ? 0 : queue;
264 for (; qid < end_q; qid++) {
265 cbs = &tx_cbs[port][qid];
266 if (cbs && operation == ENABLE) {
269 "failed to add tx callback for port=%d "
270 "and queue=%d, callback already exists\n",
276 cbs->cb = rte_eth_add_tx_callback(port, qid, pdump_tx,
278 if (cbs->cb == NULL) {
280 "failed to add tx callback, errno=%d\n",
285 if (cbs && operation == DISABLE) {
288 if (cbs->cb == NULL) {
290 "failed to delete non existing tx "
291 "callback for port=%d and queue=%d\n",
295 ret = rte_eth_remove_tx_callback(port, qid, cbs->cb);
298 "failed to remove tx callback, errno=%d\n",
310 set_pdump_rxtx_cbs(struct pdump_request *p)
312 uint16_t nb_rx_q = 0, nb_tx_q = 0, end_q, queue;
317 struct rte_ring *ring;
318 struct rte_mempool *mp;
322 if (operation == ENABLE) {
323 ret = rte_eth_dev_get_port_by_name(p->data.en_v1.device,
327 "failed to get port id for device id=%s\n",
328 p->data.en_v1.device);
331 queue = p->data.en_v1.queue;
332 ring = p->data.en_v1.ring;
333 mp = p->data.en_v1.mp;
335 ret = rte_eth_dev_get_port_by_name(p->data.dis_v1.device,
339 "failed to get port id for device id=%s\n",
340 p->data.dis_v1.device);
343 queue = p->data.dis_v1.queue;
344 ring = p->data.dis_v1.ring;
345 mp = p->data.dis_v1.mp;
348 /* validation if packet capture is for all queues */
349 if (queue == RTE_PDUMP_ALL_QUEUES) {
350 struct rte_eth_dev_info dev_info;
352 rte_eth_dev_info_get(port, &dev_info);
353 nb_rx_q = dev_info.nb_rx_queues;
354 nb_tx_q = dev_info.nb_tx_queues;
355 if (nb_rx_q == 0 && flags & RTE_PDUMP_FLAG_RX) {
357 "number of rx queues cannot be 0\n");
360 if (nb_tx_q == 0 && flags & RTE_PDUMP_FLAG_TX) {
362 "number of tx queues cannot be 0\n");
365 if ((nb_tx_q == 0 || nb_rx_q == 0) &&
366 flags == RTE_PDUMP_FLAG_RXTX) {
368 "both tx&rx queues must be non zero\n");
373 /* register RX callback */
374 if (flags & RTE_PDUMP_FLAG_RX) {
375 end_q = (queue == RTE_PDUMP_ALL_QUEUES) ? nb_rx_q : queue + 1;
376 ret = pdump_register_rx_callbacks(end_q, port, queue, ring, mp,
382 /* register TX callback */
383 if (flags & RTE_PDUMP_FLAG_TX) {
384 end_q = (queue == RTE_PDUMP_ALL_QUEUES) ? nb_tx_q : queue + 1;
385 ret = pdump_register_tx_callbacks(end_q, port, queue, ring, mp,
394 /* get socket path (/var/run if root, $HOME otherwise) */
396 pdump_get_socket_path(char *buffer, int bufsz, enum rte_pdump_socktype type)
398 char dpdk_dir[PATH_MAX] = {0};
399 char dir[PATH_MAX] = {0};
400 char *dir_home = NULL;
403 if (type == RTE_PDUMP_SOCKET_SERVER && server_socket_dir[0] != 0)
404 snprintf(dir, sizeof(dir), "%s", server_socket_dir);
405 else if (type == RTE_PDUMP_SOCKET_CLIENT && client_socket_dir[0] != 0)
406 snprintf(dir, sizeof(dir), "%s", client_socket_dir);
409 dir_home = getenv(SOCKET_PATH_HOME);
412 "Failed to get environment variable"
413 " value for %s, %s:%d\n",
414 SOCKET_PATH_HOME, __func__, __LINE__);
417 snprintf(dpdk_dir, sizeof(dpdk_dir), "%s%s",
420 snprintf(dpdk_dir, sizeof(dpdk_dir), "%s%s",
421 SOCKET_PATH_VAR_RUN, DPDK_DIR);
423 mkdir(dpdk_dir, 0700);
424 snprintf(dir, sizeof(dir), "%s%s",
425 dpdk_dir, SOCKET_DIR);
428 ret = mkdir(dir, 0700);
429 /* if user passed socket path is invalid, return immediately */
430 if (ret < 0 && errno != EEXIST) {
432 "Failed to create dir:%s:%s\n", dir,
438 if (type == RTE_PDUMP_SOCKET_SERVER)
439 snprintf(buffer, bufsz, SERVER_SOCKET, dir);
441 snprintf(buffer, bufsz, CLIENT_SOCKET, dir, getpid(),
448 pdump_create_server_socket(void)
451 struct sockaddr_un addr;
454 ret = pdump_get_socket_path(addr.sun_path, sizeof(addr.sun_path),
455 RTE_PDUMP_SOCKET_SERVER);
458 "Failed to get server socket path: %s:%d\n",
462 addr.sun_family = AF_UNIX;
464 /* remove if file already exists */
465 unlink(addr.sun_path);
467 /* set up a server socket */
468 socket_fd = socket(AF_UNIX, SOCK_DGRAM, 0);
471 "Failed to create server socket: %s, %s:%d\n",
472 strerror(errno), __func__, __LINE__);
476 addr_len = sizeof(struct sockaddr_un);
477 ret = bind(socket_fd, (struct sockaddr *) &addr, addr_len);
480 "Failed to bind to server socket: %s, %s:%d\n",
481 strerror(errno), __func__, __LINE__);
486 /* save the socket in local configuration */
487 pdump_socket_fd = socket_fd;
492 static __attribute__((noreturn)) void *
493 pdump_thread_main(__rte_unused void *arg)
495 struct sockaddr_un cli_addr;
497 struct pdump_request cli_req;
498 struct pdump_response resp;
502 /* host thread, never break out */
504 /* recv client requests */
505 cli_len = sizeof(cli_addr);
506 n = recvfrom(pdump_socket_fd, &cli_req,
507 sizeof(struct pdump_request), 0,
508 (struct sockaddr *)&cli_addr, &cli_len);
511 "failed to recv from client:%s, %s:%d\n",
512 strerror(errno), __func__, __LINE__);
516 ret = set_pdump_rxtx_cbs(&cli_req);
518 resp.ver = cli_req.ver;
519 resp.res_op = cli_req.op;
520 resp.err_value = ret;
521 n = sendto(pdump_socket_fd, &resp,
522 sizeof(struct pdump_response),
523 0, (struct sockaddr *)&cli_addr, cli_len);
526 "failed to send to client:%s, %s:%d\n",
527 strerror(errno), __func__, __LINE__);
533 rte_pdump_init(const char *path)
536 char thread_name[RTE_MAX_THREAD_NAME_LEN];
538 ret = rte_pdump_set_socket_dir(path, RTE_PDUMP_SOCKET_SERVER);
542 ret = pdump_create_server_socket();
545 "Failed to create server socket:%s:%d\n",
550 /* create the host thread to wait/handle pdump requests */
551 ret = pthread_create(&pdump_thread, NULL, pdump_thread_main, NULL);
554 "Failed to create the pdump thread:%s, %s:%d\n",
555 strerror(errno), __func__, __LINE__);
558 /* Set thread_name for aid in debugging. */
559 snprintf(thread_name, RTE_MAX_THREAD_NAME_LEN, "pdump-thread");
560 ret = rte_thread_setname(pdump_thread, thread_name);
562 RTE_LOG(DEBUG, PDUMP,
563 "Failed to set thread name for pdump handling\n");
570 rte_pdump_uninit(void)
574 ret = pthread_cancel(pdump_thread);
577 "Failed to cancel the pdump thread:%s, %s:%d\n",
578 strerror(errno), __func__, __LINE__);
582 ret = close(pdump_socket_fd);
585 "Failed to close server socket: %s, %s:%d\n",
586 strerror(errno), __func__, __LINE__);
590 struct sockaddr_un addr;
592 ret = pdump_get_socket_path(addr.sun_path, sizeof(addr.sun_path),
593 RTE_PDUMP_SOCKET_SERVER);
596 "Failed to get server socket path: %s:%d\n",
600 ret = unlink(addr.sun_path);
603 "Failed to remove server socket addr: %s, %s:%d\n",
604 strerror(errno), __func__, __LINE__);
612 pdump_create_client_socket(struct pdump_request *p)
617 struct pdump_response server_resp;
618 struct sockaddr_un addr, serv_addr, from;
619 socklen_t addr_len, serv_len;
623 socket_fd = socket(AF_UNIX, SOCK_DGRAM, 0);
626 "client socket(): %s:pid(%d):tid(%u), %s:%d\n",
627 strerror(errno), pid, rte_sys_gettid(),
633 ret = pdump_get_socket_path(addr.sun_path, sizeof(addr.sun_path),
634 RTE_PDUMP_SOCKET_CLIENT);
637 "Failed to get client socket path: %s:%d\n",
642 addr.sun_family = AF_UNIX;
643 addr_len = sizeof(struct sockaddr_un);
646 ret = bind(socket_fd, (struct sockaddr *) &addr, addr_len);
649 "client bind(): %s, %s:%d\n",
650 strerror(errno), __func__, __LINE__);
655 serv_len = sizeof(struct sockaddr_un);
656 memset(&serv_addr, 0, sizeof(serv_addr));
657 ret = pdump_get_socket_path(serv_addr.sun_path,
658 sizeof(serv_addr.sun_path),
659 RTE_PDUMP_SOCKET_SERVER);
662 "Failed to get server socket path: %s:%d\n",
667 serv_addr.sun_family = AF_UNIX;
669 n = sendto(socket_fd, p, sizeof(struct pdump_request), 0,
670 (struct sockaddr *)&serv_addr, serv_len);
673 "failed to send to server:%s, %s:%d\n",
674 strerror(errno), __func__, __LINE__);
680 n = recvfrom(socket_fd, &server_resp,
681 sizeof(struct pdump_response), 0,
682 (struct sockaddr *)&from, &serv_len);
685 "failed to recv from server:%s, %s:%d\n",
686 strerror(errno), __func__, __LINE__);
691 ret = server_resp.err_value;
696 unlink(addr.sun_path);
701 pdump_validate_ring_mp(struct rte_ring *ring, struct rte_mempool *mp)
703 if (ring == NULL || mp == NULL) {
704 RTE_LOG(ERR, PDUMP, "NULL ring or mempool are passed %s:%d\n",
709 if (mp->flags & MEMPOOL_F_SP_PUT || mp->flags & MEMPOOL_F_SC_GET) {
710 RTE_LOG(ERR, PDUMP, "mempool with either SP or SC settings"
711 " is not valid for pdump, should have MP and MC settings\n");
715 if (ring->prod.single || ring->cons.single) {
716 RTE_LOG(ERR, PDUMP, "ring with either SP or SC settings"
717 " is not valid for pdump, should have MP and MC settings\n");
726 pdump_validate_flags(uint32_t flags)
728 if (flags != RTE_PDUMP_FLAG_RX && flags != RTE_PDUMP_FLAG_TX &&
729 flags != RTE_PDUMP_FLAG_RXTX) {
731 "invalid flags, should be either rx/tx/rxtx\n");
740 pdump_validate_port(uint16_t port, char *name)
744 if (port >= RTE_MAX_ETHPORTS) {
745 RTE_LOG(ERR, PDUMP, "Invalid port id %u, %s:%d\n", port,
751 ret = rte_eth_dev_get_name_by_port(port, name);
754 "port id to name mapping failed for port id=%u, %s:%d\n",
755 port, __func__, __LINE__);
764 pdump_prepare_client_request(char *device, uint16_t queue,
767 struct rte_ring *ring,
768 struct rte_mempool *mp,
772 struct pdump_request req = {.ver = 1,};
776 if ((operation & ENABLE) != 0) {
777 snprintf(req.data.en_v1.device, sizeof(req.data.en_v1.device),
779 req.data.en_v1.queue = queue;
780 req.data.en_v1.ring = ring;
781 req.data.en_v1.mp = mp;
782 req.data.en_v1.filter = filter;
784 snprintf(req.data.dis_v1.device, sizeof(req.data.dis_v1.device),
786 req.data.dis_v1.queue = queue;
787 req.data.dis_v1.ring = NULL;
788 req.data.dis_v1.mp = NULL;
789 req.data.dis_v1.filter = NULL;
792 ret = pdump_create_client_socket(&req);
795 "client request for pdump enable/disable failed\n");
804 rte_pdump_enable(uint16_t port, uint16_t queue, uint32_t flags,
805 struct rte_ring *ring,
806 struct rte_mempool *mp,
811 char name[DEVICE_ID_SIZE];
813 ret = pdump_validate_port(port, name);
816 ret = pdump_validate_ring_mp(ring, mp);
819 ret = pdump_validate_flags(flags);
823 ret = pdump_prepare_client_request(name, queue, flags,
824 ENABLE, ring, mp, filter);
830 rte_pdump_enable_by_deviceid(char *device_id, uint16_t queue,
832 struct rte_ring *ring,
833 struct rte_mempool *mp,
838 ret = pdump_validate_ring_mp(ring, mp);
841 ret = pdump_validate_flags(flags);
845 ret = pdump_prepare_client_request(device_id, queue, flags,
846 ENABLE, ring, mp, filter);
852 rte_pdump_disable(uint16_t port, uint16_t queue, uint32_t flags)
855 char name[DEVICE_ID_SIZE];
857 ret = pdump_validate_port(port, name);
860 ret = pdump_validate_flags(flags);
864 ret = pdump_prepare_client_request(name, queue, flags,
865 DISABLE, NULL, NULL, NULL);
871 rte_pdump_disable_by_deviceid(char *device_id, uint16_t queue,
876 ret = pdump_validate_flags(flags);
880 ret = pdump_prepare_client_request(device_id, queue, flags,
881 DISABLE, NULL, NULL, NULL);
887 rte_pdump_set_socket_dir(const char *path, enum rte_pdump_socktype type)
892 if (type == RTE_PDUMP_SOCKET_SERVER) {
893 count = sizeof(server_socket_dir);
894 ret = snprintf(server_socket_dir, count, "%s", path);
896 count = sizeof(client_socket_dir);
897 ret = snprintf(client_socket_dir, count, "%s", path);
900 if (ret < 0 || ret >= count) {
902 "Invalid socket path:%s:%d\n",
904 if (type == RTE_PDUMP_SOCKET_SERVER)
905 server_socket_dir[0] = 0;
907 client_socket_dir[0] = 0;