4 * Copyright(c) 2016 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * * Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in
15 * the documentation and/or other materials provided with the
17 * * Neither the name of Intel Corporation nor the names of its
18 * contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #include <sys/socket.h>
38 #include <sys/types.h>
43 #include <rte_memcpy.h>
45 #include <rte_ethdev.h>
46 #include <rte_lcore.h>
48 #include <rte_errno.h>
51 #include "rte_pdump.h"
53 #define SOCKET_PATH_VAR_RUN "/var/run"
54 #define SOCKET_PATH_HOME "HOME"
55 #define DPDK_DIR "/.dpdk"
56 #define SOCKET_DIR "/pdump_sockets"
57 #define SERVER_SOCKET "%s/pdump_server_socket"
58 #define CLIENT_SOCKET "%s/pdump_client_socket_%d_%u"
59 #define DEVICE_ID_SIZE 64
60 /* Macros for printing using RTE_LOG */
61 #define RTE_LOGTYPE_PDUMP RTE_LOGTYPE_USER1
63 enum pdump_operation {
72 static pthread_t pdump_thread;
73 static int pdump_socket_fd;
74 static char server_socket_dir[PATH_MAX];
75 static char client_socket_dir[PATH_MAX];
77 struct pdump_request {
83 char device[DEVICE_ID_SIZE];
85 struct rte_ring *ring;
86 struct rte_mempool *mp;
90 char device[DEVICE_ID_SIZE];
92 struct rte_ring *ring;
93 struct rte_mempool *mp;
99 struct pdump_response {
105 static struct pdump_rxtx_cbs {
106 struct rte_ring *ring;
107 struct rte_mempool *mp;
108 struct rte_eth_rxtx_callback *cb;
110 } rx_cbs[RTE_MAX_ETHPORTS][RTE_MAX_QUEUES_PER_PORT],
111 tx_cbs[RTE_MAX_ETHPORTS][RTE_MAX_QUEUES_PER_PORT];
114 pdump_pktmbuf_copy_data(struct rte_mbuf *seg, const struct rte_mbuf *m)
116 if (rte_pktmbuf_tailroom(seg) < m->data_len) {
118 "User mempool: insufficient data_len of mbuf\n");
123 seg->vlan_tci = m->vlan_tci;
125 seg->tx_offload = m->tx_offload;
126 seg->ol_flags = m->ol_flags;
127 seg->packet_type = m->packet_type;
128 seg->vlan_tci_outer = m->vlan_tci_outer;
129 seg->data_len = m->data_len;
130 seg->pkt_len = seg->data_len;
131 rte_memcpy(rte_pktmbuf_mtod(seg, void *),
132 rte_pktmbuf_mtod(m, void *),
133 rte_pktmbuf_data_len(seg));
138 static inline struct rte_mbuf *
139 pdump_pktmbuf_copy(struct rte_mbuf *m, struct rte_mempool *mp)
141 struct rte_mbuf *m_dup, *seg, **prev;
145 m_dup = rte_pktmbuf_alloc(mp);
146 if (unlikely(m_dup == NULL))
156 if (pdump_pktmbuf_copy_data(seg, m) < 0) {
158 rte_pktmbuf_free_seg(seg);
159 rte_pktmbuf_free(m_dup);
164 } while ((m = m->next) != NULL &&
165 (seg = rte_pktmbuf_alloc(mp)) != NULL);
168 m_dup->nb_segs = nseg;
169 m_dup->pkt_len = pktlen;
171 /* Allocation of new indirect segment failed */
172 if (unlikely(seg == NULL)) {
173 rte_pktmbuf_free(m_dup);
177 __rte_mbuf_sanity_check(m_dup, 1);
182 pdump_copy(struct rte_mbuf **pkts, uint16_t nb_pkts, void *user_params)
187 struct rte_mbuf *dup_bufs[nb_pkts];
188 struct pdump_rxtx_cbs *cbs;
189 struct rte_ring *ring;
190 struct rte_mempool *mp;
196 for (i = 0; i < nb_pkts; i++) {
197 p = pdump_pktmbuf_copy(pkts[i], mp);
199 dup_bufs[d_pkts++] = p;
202 ring_enq = rte_ring_enqueue_burst(ring, (void *)dup_bufs, d_pkts);
203 if (unlikely(ring_enq < d_pkts)) {
204 RTE_LOG(DEBUG, PDUMP,
205 "only %d of packets enqueued to ring\n", ring_enq);
207 rte_pktmbuf_free(dup_bufs[ring_enq]);
208 } while (++ring_enq < d_pkts);
213 pdump_rx(uint8_t port __rte_unused, uint16_t qidx __rte_unused,
214 struct rte_mbuf **pkts, uint16_t nb_pkts,
215 uint16_t max_pkts __rte_unused,
218 pdump_copy(pkts, nb_pkts, user_params);
223 pdump_tx(uint8_t port __rte_unused, uint16_t qidx __rte_unused,
224 struct rte_mbuf **pkts, uint16_t nb_pkts, void *user_params)
226 pdump_copy(pkts, nb_pkts, user_params);
231 pdump_regitser_rx_callbacks(uint16_t end_q, uint8_t port, uint16_t queue,
232 struct rte_ring *ring, struct rte_mempool *mp,
236 struct pdump_rxtx_cbs *cbs = NULL;
238 qid = (queue == RTE_PDUMP_ALL_QUEUES) ? 0 : queue;
239 for (; qid < end_q; qid++) {
240 cbs = &rx_cbs[port][qid];
241 if (cbs && operation == ENABLE) {
244 "failed to add rx callback for port=%d "
245 "and queue=%d, callback already exists\n",
251 cbs->cb = rte_eth_add_first_rx_callback(port, qid,
253 if (cbs->cb == NULL) {
255 "failed to add rx callback, errno=%d\n",
260 if (cbs && operation == DISABLE) {
263 if (cbs->cb == NULL) {
265 "failed to delete non existing rx "
266 "callback for port=%d and queue=%d\n",
270 ret = rte_eth_remove_rx_callback(port, qid, cbs->cb);
273 "failed to remove rx callback, errno=%d\n",
285 pdump_regitser_tx_callbacks(uint16_t end_q, uint8_t port, uint16_t queue,
286 struct rte_ring *ring, struct rte_mempool *mp,
291 struct pdump_rxtx_cbs *cbs = NULL;
293 qid = (queue == RTE_PDUMP_ALL_QUEUES) ? 0 : queue;
294 for (; qid < end_q; qid++) {
295 cbs = &tx_cbs[port][qid];
296 if (cbs && operation == ENABLE) {
299 "failed to add tx callback for port=%d "
300 "and queue=%d, callback already exists\n",
306 cbs->cb = rte_eth_add_tx_callback(port, qid, pdump_tx,
308 if (cbs->cb == NULL) {
310 "failed to add tx callback, errno=%d\n",
315 if (cbs && operation == DISABLE) {
318 if (cbs->cb == NULL) {
320 "failed to delete non existing tx "
321 "callback for port=%d and queue=%d\n",
325 ret = rte_eth_remove_tx_callback(port, qid, cbs->cb);
328 "failed to remove tx callback, errno=%d\n",
340 set_pdump_rxtx_cbs(struct pdump_request *p)
342 uint16_t nb_rx_q, nb_tx_q = 0, end_q, queue;
347 struct rte_ring *ring;
348 struct rte_mempool *mp;
352 if (operation == ENABLE) {
353 ret = rte_eth_dev_get_port_by_name(p->data.en_v1.device,
357 "failed to get potid for device id=%s\n",
358 p->data.en_v1.device);
361 queue = p->data.en_v1.queue;
362 ring = p->data.en_v1.ring;
363 mp = p->data.en_v1.mp;
365 ret = rte_eth_dev_get_port_by_name(p->data.dis_v1.device,
369 "failed to get potid for device id=%s\n",
370 p->data.dis_v1.device);
373 queue = p->data.dis_v1.queue;
374 ring = p->data.dis_v1.ring;
375 mp = p->data.dis_v1.mp;
378 /* validation if packet capture is for all queues */
379 if (queue == RTE_PDUMP_ALL_QUEUES) {
380 struct rte_eth_dev_info dev_info;
382 rte_eth_dev_info_get(port, &dev_info);
383 nb_rx_q = dev_info.nb_rx_queues;
384 nb_tx_q = dev_info.nb_tx_queues;
385 if (nb_rx_q == 0 && flags & RTE_PDUMP_FLAG_RX) {
387 "number of rx queues cannot be 0\n");
390 if (nb_tx_q == 0 && flags & RTE_PDUMP_FLAG_TX) {
392 "number of tx queues cannot be 0\n");
395 if ((nb_tx_q == 0 || nb_rx_q == 0) &&
396 flags == RTE_PDUMP_FLAG_RXTX) {
398 "both tx&rx queues must be non zero\n");
403 /* register RX callback */
404 if (flags & RTE_PDUMP_FLAG_RX) {
405 end_q = (queue == RTE_PDUMP_ALL_QUEUES) ? nb_rx_q : queue + 1;
406 ret = pdump_regitser_rx_callbacks(end_q, port, queue, ring, mp,
412 /* register TX callback */
413 if (flags & RTE_PDUMP_FLAG_TX) {
414 end_q = (queue == RTE_PDUMP_ALL_QUEUES) ? nb_tx_q : queue + 1;
415 ret = pdump_regitser_tx_callbacks(end_q, port, queue, ring, mp,
424 /* get socket path (/var/run if root, $HOME otherwise) */
426 pdump_get_socket_path(char *buffer, int bufsz, enum rte_pdump_socktype type)
428 char dpdk_dir[PATH_MAX] = {0};
429 char dir[PATH_MAX] = {0};
430 char *dir_home = NULL;
433 if (type == RTE_PDUMP_SOCKET_SERVER && server_socket_dir[0] != 0)
434 snprintf(dir, sizeof(dir), "%s", server_socket_dir);
435 else if (type == RTE_PDUMP_SOCKET_CLIENT && client_socket_dir[0] != 0)
436 snprintf(dir, sizeof(dir), "%s", client_socket_dir);
439 dir_home = getenv(SOCKET_PATH_HOME);
442 "Failed to get environment variable"
443 " value for %s, %s:%d\n",
444 SOCKET_PATH_HOME, __func__, __LINE__);
447 snprintf(dpdk_dir, sizeof(dpdk_dir), "%s%s",
450 snprintf(dpdk_dir, sizeof(dpdk_dir), "%s%s",
451 SOCKET_PATH_VAR_RUN, DPDK_DIR);
453 mkdir(dpdk_dir, 0700);
454 snprintf(dir, sizeof(dir), "%s%s",
455 dpdk_dir, SOCKET_DIR);
458 ret = mkdir(dir, 0700);
459 /* if user passed socket path is invalid, return immediately */
460 if (ret < 0 && errno != EEXIST) {
462 "Failed to create dir:%s:%s\n", dir,
468 if (type == RTE_PDUMP_SOCKET_SERVER)
469 snprintf(buffer, bufsz, SERVER_SOCKET, dir);
471 snprintf(buffer, bufsz, CLIENT_SOCKET, dir, getpid(),
478 pdump_create_server_socket(void)
481 struct sockaddr_un addr;
484 ret = pdump_get_socket_path(addr.sun_path, sizeof(addr.sun_path),
485 RTE_PDUMP_SOCKET_SERVER);
488 "Failed to get server socket path: %s:%d\n",
492 addr.sun_family = AF_UNIX;
494 /* remove if file already exists */
495 unlink(addr.sun_path);
497 /* set up a server socket */
498 socket_fd = socket(AF_UNIX, SOCK_DGRAM, 0);
501 "Failed to create server socket: %s, %s:%d\n",
502 strerror(errno), __func__, __LINE__);
506 addr_len = sizeof(struct sockaddr_un);
507 ret = bind(socket_fd, (struct sockaddr *) &addr, addr_len);
510 "Failed to bind to server socket: %s, %s:%d\n",
511 strerror(errno), __func__, __LINE__);
516 /* save the socket in local configuration */
517 pdump_socket_fd = socket_fd;
522 static __attribute__((noreturn)) void *
523 pdump_thread_main(__rte_unused void *arg)
525 struct sockaddr_un cli_addr;
527 struct pdump_request cli_req;
528 struct pdump_response resp;
532 /* host thread, never break out */
534 /* recv client requests */
535 cli_len = sizeof(cli_addr);
536 n = recvfrom(pdump_socket_fd, &cli_req,
537 sizeof(struct pdump_request), 0,
538 (struct sockaddr *)&cli_addr, &cli_len);
541 "failed to recv from client:%s, %s:%d\n",
542 strerror(errno), __func__, __LINE__);
546 ret = set_pdump_rxtx_cbs(&cli_req);
548 resp.ver = cli_req.ver;
549 resp.res_op = cli_req.op;
550 resp.err_value = ret;
551 n = sendto(pdump_socket_fd, &resp,
552 sizeof(struct pdump_response),
553 0, (struct sockaddr *)&cli_addr, cli_len);
556 "failed to send to client:%s, %s:%d\n",
557 strerror(errno), __func__, __LINE__);
563 rte_pdump_init(const char *path)
566 char thread_name[RTE_MAX_THREAD_NAME_LEN];
568 ret = rte_pdump_set_socket_dir(path, RTE_PDUMP_SOCKET_SERVER);
572 ret = pdump_create_server_socket();
575 "Failed to create server socket:%s:%d\n",
580 /* create the host thread to wait/handle pdump requests */
581 ret = pthread_create(&pdump_thread, NULL, pdump_thread_main, NULL);
584 "Failed to create the pdump thread:%s, %s:%d\n",
585 strerror(errno), __func__, __LINE__);
588 /* Set thread_name for aid in debugging. */
589 snprintf(thread_name, RTE_MAX_THREAD_NAME_LEN, "pdump-thread");
590 ret = rte_thread_setname(pdump_thread, thread_name);
592 RTE_LOG(DEBUG, PDUMP,
593 "Failed to set thread name for pdump handling\n");
600 rte_pdump_uninit(void)
604 ret = pthread_cancel(pdump_thread);
607 "Failed to cancel the pdump thread:%s, %s:%d\n",
608 strerror(errno), __func__, __LINE__);
612 ret = close(pdump_socket_fd);
615 "Failed to close server socket: %s, %s:%d\n",
616 strerror(errno), __func__, __LINE__);
620 struct sockaddr_un addr;
622 ret = pdump_get_socket_path(addr.sun_path, sizeof(addr.sun_path),
623 RTE_PDUMP_SOCKET_SERVER);
626 "Failed to get server socket path: %s:%d\n",
630 ret = unlink(addr.sun_path);
633 "Failed to remove server socket addr: %s, %s:%d\n",
634 strerror(errno), __func__, __LINE__);
642 pdump_create_client_socket(struct pdump_request *p)
647 struct pdump_response server_resp;
648 struct sockaddr_un addr, serv_addr, from;
649 socklen_t addr_len, serv_len;
653 socket_fd = socket(AF_UNIX, SOCK_DGRAM, 0);
656 "client socket(): %s:pid(%d):tid(%u), %s:%d\n",
657 strerror(errno), pid, rte_sys_gettid(),
663 ret = pdump_get_socket_path(addr.sun_path, sizeof(addr.sun_path),
664 RTE_PDUMP_SOCKET_CLIENT);
667 "Failed to get client socket path: %s:%d\n",
672 addr.sun_family = AF_UNIX;
673 addr_len = sizeof(struct sockaddr_un);
676 ret = bind(socket_fd, (struct sockaddr *) &addr, addr_len);
679 "client bind(): %s, %s:%d\n",
680 strerror(errno), __func__, __LINE__);
685 serv_len = sizeof(struct sockaddr_un);
686 memset(&serv_addr, 0, sizeof(serv_addr));
687 ret = pdump_get_socket_path(serv_addr.sun_path,
688 sizeof(serv_addr.sun_path),
689 RTE_PDUMP_SOCKET_SERVER);
692 "Failed to get server socket path: %s:%d\n",
697 serv_addr.sun_family = AF_UNIX;
699 n = sendto(socket_fd, p, sizeof(struct pdump_request), 0,
700 (struct sockaddr *)&serv_addr, serv_len);
703 "failed to send to server:%s, %s:%d\n",
704 strerror(errno), __func__, __LINE__);
710 n = recvfrom(socket_fd, &server_resp,
711 sizeof(struct pdump_response), 0,
712 (struct sockaddr *)&from, &serv_len);
715 "failed to recv from server:%s, %s:%d\n",
716 strerror(errno), __func__, __LINE__);
721 ret = server_resp.err_value;
726 unlink(addr.sun_path);
731 pdump_validate_ring_mp(struct rte_ring *ring, struct rte_mempool *mp)
733 if (ring == NULL || mp == NULL) {
734 RTE_LOG(ERR, PDUMP, "NULL ring or mempool are passed %s:%d\n",
739 if (mp->flags & MEMPOOL_F_SP_PUT || mp->flags & MEMPOOL_F_SC_GET) {
740 RTE_LOG(ERR, PDUMP, "mempool with either SP or SC settings"
741 " is not valid for pdump, should have MP and MC settings\n");
745 if (ring->prod.sp_enqueue || ring->cons.sc_dequeue) {
746 RTE_LOG(ERR, PDUMP, "ring with either SP or SC settings"
747 " is not valid for pdump, should have MP and MC settings\n");
756 pdump_validate_flags(uint32_t flags)
758 if (flags != RTE_PDUMP_FLAG_RX && flags != RTE_PDUMP_FLAG_TX &&
759 flags != RTE_PDUMP_FLAG_RXTX) {
761 "invalid flags, should be either rx/tx/rxtx\n");
770 pdump_validate_port(uint8_t port, char *name)
774 if (port >= RTE_MAX_ETHPORTS) {
775 RTE_LOG(ERR, PDUMP, "Invalid port id %u, %s:%d\n", port,
781 ret = rte_eth_dev_get_name_by_port(port, name);
784 "port id to name mapping failed for port id=%u, %s:%d\n",
785 port, __func__, __LINE__);
794 pdump_prepare_client_request(char *device, uint16_t queue,
797 struct rte_ring *ring,
798 struct rte_mempool *mp,
802 struct pdump_request req = {.ver = 1,};
806 if ((operation & ENABLE) != 0) {
807 snprintf(req.data.en_v1.device, sizeof(req.data.en_v1.device),
809 req.data.en_v1.queue = queue;
810 req.data.en_v1.ring = ring;
811 req.data.en_v1.mp = mp;
812 req.data.en_v1.filter = filter;
814 snprintf(req.data.dis_v1.device, sizeof(req.data.dis_v1.device),
816 req.data.dis_v1.queue = queue;
817 req.data.dis_v1.ring = NULL;
818 req.data.dis_v1.mp = NULL;
819 req.data.dis_v1.filter = NULL;
822 ret = pdump_create_client_socket(&req);
825 "client request for pdump enable/disable failed\n");
834 rte_pdump_enable(uint8_t port, uint16_t queue, uint32_t flags,
835 struct rte_ring *ring,
836 struct rte_mempool *mp,
841 char name[DEVICE_ID_SIZE];
843 ret = pdump_validate_port(port, name);
846 ret = pdump_validate_ring_mp(ring, mp);
849 ret = pdump_validate_flags(flags);
853 ret = pdump_prepare_client_request(name, queue, flags,
854 ENABLE, ring, mp, filter);
860 rte_pdump_enable_by_deviceid(char *device_id, uint16_t queue,
862 struct rte_ring *ring,
863 struct rte_mempool *mp,
868 ret = pdump_validate_ring_mp(ring, mp);
871 ret = pdump_validate_flags(flags);
875 ret = pdump_prepare_client_request(device_id, queue, flags,
876 ENABLE, ring, mp, filter);
882 rte_pdump_disable(uint8_t port, uint16_t queue, uint32_t flags)
885 char name[DEVICE_ID_SIZE];
887 ret = pdump_validate_port(port, name);
890 ret = pdump_validate_flags(flags);
894 ret = pdump_prepare_client_request(name, queue, flags,
895 DISABLE, NULL, NULL, NULL);
901 rte_pdump_disable_by_deviceid(char *device_id, uint16_t queue,
906 ret = pdump_validate_flags(flags);
910 ret = pdump_prepare_client_request(device_id, queue, flags,
911 DISABLE, NULL, NULL, NULL);
917 rte_pdump_set_socket_dir(const char *path, enum rte_pdump_socktype type)
922 if (type == RTE_PDUMP_SOCKET_SERVER) {
923 count = sizeof(server_socket_dir);
924 ret = snprintf(server_socket_dir, count, "%s", path);
926 count = sizeof(client_socket_dir);
927 ret = snprintf(client_socket_dir, count, "%s", path);
930 if (ret < 0 || ret >= count) {
932 "Invalid socket path:%s:%d\n",
934 if (type == RTE_PDUMP_SOCKET_SERVER)
935 server_socket_dir[0] = 0;
937 client_socket_dir[0] = 0;