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) {
157 rte_pktmbuf_free(m_dup
);
162 } while ((m
= m
->next
) != NULL
&&
163 (seg
= rte_pktmbuf_alloc(mp
)) != NULL
);
166 m_dup
->nb_segs
= nseg
;
167 m_dup
->pkt_len
= pktlen
;
169 /* Allocation of new indirect segment failed */
170 if (unlikely(seg
== NULL
)) {
171 rte_pktmbuf_free(m_dup
);
175 __rte_mbuf_sanity_check(m_dup
, 1);
180 pdump_copy(struct rte_mbuf
**pkts
, uint16_t nb_pkts
, void *user_params
)
185 struct rte_mbuf
*dup_bufs
[nb_pkts
];
186 struct pdump_rxtx_cbs
*cbs
;
187 struct rte_ring
*ring
;
188 struct rte_mempool
*mp
;
194 for (i
= 0; i
< nb_pkts
; i
++) {
195 p
= pdump_pktmbuf_copy(pkts
[i
], mp
);
197 dup_bufs
[d_pkts
++] = p
;
200 ring_enq
= rte_ring_enqueue_burst(ring
, (void *)dup_bufs
, d_pkts
);
201 if (unlikely(ring_enq
< d_pkts
)) {
202 RTE_LOG(DEBUG
, PDUMP
,
203 "only %d of packets enqueued to ring\n", ring_enq
);
205 rte_pktmbuf_free(dup_bufs
[ring_enq
]);
206 } while (++ring_enq
< d_pkts
);
211 pdump_rx(uint8_t port __rte_unused
, uint16_t qidx __rte_unused
,
212 struct rte_mbuf
**pkts
, uint16_t nb_pkts
,
213 uint16_t max_pkts __rte_unused
,
216 pdump_copy(pkts
, nb_pkts
, user_params
);
221 pdump_tx(uint8_t port __rte_unused
, uint16_t qidx __rte_unused
,
222 struct rte_mbuf
**pkts
, uint16_t nb_pkts
, void *user_params
)
224 pdump_copy(pkts
, nb_pkts
, user_params
);
229 pdump_regitser_rx_callbacks(uint16_t end_q
, uint8_t port
, uint16_t queue
,
230 struct rte_ring
*ring
, struct rte_mempool
*mp
,
234 struct pdump_rxtx_cbs
*cbs
= NULL
;
236 qid
= (queue
== RTE_PDUMP_ALL_QUEUES
) ? 0 : queue
;
237 for (; qid
< end_q
; qid
++) {
238 cbs
= &rx_cbs
[port
][qid
];
239 if (cbs
&& operation
== ENABLE
) {
242 "failed to add rx callback for port=%d "
243 "and queue=%d, callback already exists\n",
249 cbs
->cb
= rte_eth_add_first_rx_callback(port
, qid
,
251 if (cbs
->cb
== NULL
) {
253 "failed to add rx callback, errno=%d\n",
258 if (cbs
&& operation
== DISABLE
) {
261 if (cbs
->cb
== NULL
) {
263 "failed to delete non existing rx "
264 "callback for port=%d and queue=%d\n",
268 ret
= rte_eth_remove_rx_callback(port
, qid
, cbs
->cb
);
271 "failed to remove rx callback, errno=%d\n",
283 pdump_regitser_tx_callbacks(uint16_t end_q
, uint8_t port
, uint16_t queue
,
284 struct rte_ring
*ring
, struct rte_mempool
*mp
,
289 struct pdump_rxtx_cbs
*cbs
= NULL
;
291 qid
= (queue
== RTE_PDUMP_ALL_QUEUES
) ? 0 : queue
;
292 for (; qid
< end_q
; qid
++) {
293 cbs
= &tx_cbs
[port
][qid
];
294 if (cbs
&& operation
== ENABLE
) {
297 "failed to add tx callback for port=%d "
298 "and queue=%d, callback already exists\n",
304 cbs
->cb
= rte_eth_add_tx_callback(port
, qid
, pdump_tx
,
306 if (cbs
->cb
== NULL
) {
308 "failed to add tx callback, errno=%d\n",
313 if (cbs
&& operation
== DISABLE
) {
316 if (cbs
->cb
== NULL
) {
318 "failed to delete non existing tx "
319 "callback for port=%d and queue=%d\n",
323 ret
= rte_eth_remove_tx_callback(port
, qid
, cbs
->cb
);
326 "failed to remove tx callback, errno=%d\n",
338 set_pdump_rxtx_cbs(struct pdump_request
*p
)
340 uint16_t nb_rx_q
, nb_tx_q
= 0, end_q
, queue
;
345 struct rte_ring
*ring
;
346 struct rte_mempool
*mp
;
350 if (operation
== ENABLE
) {
351 ret
= rte_eth_dev_get_port_by_name(p
->data
.en_v1
.device
,
355 "failed to get potid for device id=%s\n",
356 p
->data
.en_v1
.device
);
359 queue
= p
->data
.en_v1
.queue
;
360 ring
= p
->data
.en_v1
.ring
;
361 mp
= p
->data
.en_v1
.mp
;
363 ret
= rte_eth_dev_get_port_by_name(p
->data
.dis_v1
.device
,
367 "failed to get potid for device id=%s\n",
368 p
->data
.dis_v1
.device
);
371 queue
= p
->data
.dis_v1
.queue
;
372 ring
= p
->data
.dis_v1
.ring
;
373 mp
= p
->data
.dis_v1
.mp
;
376 /* validation if packet capture is for all queues */
377 if (queue
== RTE_PDUMP_ALL_QUEUES
) {
378 struct rte_eth_dev_info dev_info
;
380 rte_eth_dev_info_get(port
, &dev_info
);
381 nb_rx_q
= dev_info
.nb_rx_queues
;
382 nb_tx_q
= dev_info
.nb_tx_queues
;
383 if (nb_rx_q
== 0 && flags
& RTE_PDUMP_FLAG_RX
) {
385 "number of rx queues cannot be 0\n");
388 if (nb_tx_q
== 0 && flags
& RTE_PDUMP_FLAG_TX
) {
390 "number of tx queues cannot be 0\n");
393 if ((nb_tx_q
== 0 || nb_rx_q
== 0) &&
394 flags
== RTE_PDUMP_FLAG_RXTX
) {
396 "both tx&rx queues must be non zero\n");
401 /* register RX callback */
402 if (flags
& RTE_PDUMP_FLAG_RX
) {
403 end_q
= (queue
== RTE_PDUMP_ALL_QUEUES
) ? nb_rx_q
: queue
+ 1;
404 ret
= pdump_regitser_rx_callbacks(end_q
, port
, queue
, ring
, mp
,
410 /* register TX callback */
411 if (flags
& RTE_PDUMP_FLAG_TX
) {
412 end_q
= (queue
== RTE_PDUMP_ALL_QUEUES
) ? nb_tx_q
: queue
+ 1;
413 ret
= pdump_regitser_tx_callbacks(end_q
, port
, queue
, ring
, mp
,
422 /* get socket path (/var/run if root, $HOME otherwise) */
424 pdump_get_socket_path(char *buffer
, int bufsz
, enum rte_pdump_socktype type
)
426 char dpdk_dir
[PATH_MAX
] = {0};
427 char dir
[PATH_MAX
] = {0};
428 char *dir_home
= NULL
;
431 if (type
== RTE_PDUMP_SOCKET_SERVER
&& server_socket_dir
[0] != 0)
432 snprintf(dir
, sizeof(dir
), "%s", server_socket_dir
);
433 else if (type
== RTE_PDUMP_SOCKET_CLIENT
&& client_socket_dir
[0] != 0)
434 snprintf(dir
, sizeof(dir
), "%s", client_socket_dir
);
437 dir_home
= getenv(SOCKET_PATH_HOME
);
440 "Failed to get environment variable"
441 " value for %s, %s:%d\n",
442 SOCKET_PATH_HOME
, __func__
, __LINE__
);
445 snprintf(dpdk_dir
, sizeof(dpdk_dir
), "%s%s",
448 snprintf(dpdk_dir
, sizeof(dpdk_dir
), "%s%s",
449 SOCKET_PATH_VAR_RUN
, DPDK_DIR
);
451 mkdir(dpdk_dir
, 0700);
452 snprintf(dir
, sizeof(dir
), "%s%s",
453 dpdk_dir
, SOCKET_DIR
);
456 ret
= mkdir(dir
, 0700);
457 /* if user passed socket path is invalid, return immediately */
458 if (ret
< 0 && errno
!= EEXIST
) {
460 "Failed to create dir:%s:%s\n", dir
,
466 if (type
== RTE_PDUMP_SOCKET_SERVER
)
467 snprintf(buffer
, bufsz
, SERVER_SOCKET
, dir
);
469 snprintf(buffer
, bufsz
, CLIENT_SOCKET
, dir
, getpid(),
476 pdump_create_server_socket(void)
479 struct sockaddr_un addr
;
482 ret
= pdump_get_socket_path(addr
.sun_path
, sizeof(addr
.sun_path
),
483 RTE_PDUMP_SOCKET_SERVER
);
486 "Failed to get server socket path: %s:%d\n",
490 addr
.sun_family
= AF_UNIX
;
492 /* remove if file already exists */
493 unlink(addr
.sun_path
);
495 /* set up a server socket */
496 socket_fd
= socket(AF_UNIX
, SOCK_DGRAM
, 0);
499 "Failed to create server socket: %s, %s:%d\n",
500 strerror(errno
), __func__
, __LINE__
);
504 addr_len
= sizeof(struct sockaddr_un
);
505 ret
= bind(socket_fd
, (struct sockaddr
*) &addr
, addr_len
);
508 "Failed to bind to server socket: %s, %s:%d\n",
509 strerror(errno
), __func__
, __LINE__
);
514 /* save the socket in local configuration */
515 pdump_socket_fd
= socket_fd
;
520 static __attribute__((noreturn
)) void *
521 pdump_thread_main(__rte_unused
void *arg
)
523 struct sockaddr_un cli_addr
;
525 struct pdump_request cli_req
;
526 struct pdump_response resp
;
530 /* host thread, never break out */
532 /* recv client requests */
533 cli_len
= sizeof(cli_addr
);
534 n
= recvfrom(pdump_socket_fd
, &cli_req
,
535 sizeof(struct pdump_request
), 0,
536 (struct sockaddr
*)&cli_addr
, &cli_len
);
539 "failed to recv from client:%s, %s:%d\n",
540 strerror(errno
), __func__
, __LINE__
);
544 ret
= set_pdump_rxtx_cbs(&cli_req
);
546 resp
.ver
= cli_req
.ver
;
547 resp
.res_op
= cli_req
.op
;
548 resp
.err_value
= ret
;
549 n
= sendto(pdump_socket_fd
, &resp
,
550 sizeof(struct pdump_response
),
551 0, (struct sockaddr
*)&cli_addr
, cli_len
);
554 "failed to send to client:%s, %s:%d\n",
555 strerror(errno
), __func__
, __LINE__
);
561 rte_pdump_init(const char *path
)
564 char thread_name
[RTE_MAX_THREAD_NAME_LEN
];
566 ret
= rte_pdump_set_socket_dir(path
, RTE_PDUMP_SOCKET_SERVER
);
570 ret
= pdump_create_server_socket();
573 "Failed to create server socket:%s:%d\n",
578 /* create the host thread to wait/handle pdump requests */
579 ret
= pthread_create(&pdump_thread
, NULL
, pdump_thread_main
, NULL
);
582 "Failed to create the pdump thread:%s, %s:%d\n",
583 strerror(errno
), __func__
, __LINE__
);
586 /* Set thread_name for aid in debugging. */
587 snprintf(thread_name
, RTE_MAX_THREAD_NAME_LEN
, "pdump-thread");
588 ret
= rte_thread_setname(pdump_thread
, thread_name
);
590 RTE_LOG(DEBUG
, PDUMP
,
591 "Failed to set thread name for pdump handling\n");
598 rte_pdump_uninit(void)
602 ret
= pthread_cancel(pdump_thread
);
605 "Failed to cancel the pdump thread:%s, %s:%d\n",
606 strerror(errno
), __func__
, __LINE__
);
610 ret
= close(pdump_socket_fd
);
613 "Failed to close server socket: %s, %s:%d\n",
614 strerror(errno
), __func__
, __LINE__
);
618 struct sockaddr_un addr
;
620 ret
= pdump_get_socket_path(addr
.sun_path
, sizeof(addr
.sun_path
),
621 RTE_PDUMP_SOCKET_SERVER
);
624 "Failed to get server socket path: %s:%d\n",
628 ret
= unlink(addr
.sun_path
);
631 "Failed to remove server socket addr: %s, %s:%d\n",
632 strerror(errno
), __func__
, __LINE__
);
640 pdump_create_client_socket(struct pdump_request
*p
)
645 struct pdump_response server_resp
;
646 struct sockaddr_un addr
, serv_addr
, from
;
647 socklen_t addr_len
, serv_len
;
651 socket_fd
= socket(AF_UNIX
, SOCK_DGRAM
, 0);
654 "client socket(): %s:pid(%d):tid(%u), %s:%d\n",
655 strerror(errno
), pid
, rte_sys_gettid(),
661 ret
= pdump_get_socket_path(addr
.sun_path
, sizeof(addr
.sun_path
),
662 RTE_PDUMP_SOCKET_CLIENT
);
665 "Failed to get client socket path: %s:%d\n",
670 addr
.sun_family
= AF_UNIX
;
671 addr_len
= sizeof(struct sockaddr_un
);
674 ret
= bind(socket_fd
, (struct sockaddr
*) &addr
, addr_len
);
677 "client bind(): %s, %s:%d\n",
678 strerror(errno
), __func__
, __LINE__
);
683 serv_len
= sizeof(struct sockaddr_un
);
684 memset(&serv_addr
, 0, sizeof(serv_addr
));
685 ret
= pdump_get_socket_path(serv_addr
.sun_path
,
686 sizeof(serv_addr
.sun_path
),
687 RTE_PDUMP_SOCKET_SERVER
);
690 "Failed to get server socket path: %s:%d\n",
695 serv_addr
.sun_family
= AF_UNIX
;
697 n
= sendto(socket_fd
, p
, sizeof(struct pdump_request
), 0,
698 (struct sockaddr
*)&serv_addr
, serv_len
);
701 "failed to send to server:%s, %s:%d\n",
702 strerror(errno
), __func__
, __LINE__
);
708 n
= recvfrom(socket_fd
, &server_resp
,
709 sizeof(struct pdump_response
), 0,
710 (struct sockaddr
*)&from
, &serv_len
);
713 "failed to recv from server:%s, %s:%d\n",
714 strerror(errno
), __func__
, __LINE__
);
719 ret
= server_resp
.err_value
;
724 unlink(addr
.sun_path
);
729 pdump_validate_ring_mp(struct rte_ring
*ring
, struct rte_mempool
*mp
)
731 if (ring
== NULL
|| mp
== NULL
) {
732 RTE_LOG(ERR
, PDUMP
, "NULL ring or mempool are passed %s:%d\n",
737 if (mp
->flags
& MEMPOOL_F_SP_PUT
|| mp
->flags
& MEMPOOL_F_SC_GET
) {
738 RTE_LOG(ERR
, PDUMP
, "mempool with either SP or SC settings"
739 " is not valid for pdump, should have MP and MC settings\n");
743 if (ring
->prod
.sp_enqueue
|| ring
->cons
.sc_dequeue
) {
744 RTE_LOG(ERR
, PDUMP
, "ring with either SP or SC settings"
745 " is not valid for pdump, should have MP and MC settings\n");
754 pdump_validate_flags(uint32_t flags
)
756 if (flags
!= RTE_PDUMP_FLAG_RX
&& flags
!= RTE_PDUMP_FLAG_TX
&&
757 flags
!= RTE_PDUMP_FLAG_RXTX
) {
759 "invalid flags, should be either rx/tx/rxtx\n");
768 pdump_validate_port(uint8_t port
, char *name
)
772 if (port
>= RTE_MAX_ETHPORTS
) {
773 RTE_LOG(ERR
, PDUMP
, "Invalid port id %u, %s:%d\n", port
,
779 ret
= rte_eth_dev_get_name_by_port(port
, name
);
782 "port id to name mapping failed for port id=%u, %s:%d\n",
783 port
, __func__
, __LINE__
);
792 pdump_prepare_client_request(char *device
, uint16_t queue
,
795 struct rte_ring
*ring
,
796 struct rte_mempool
*mp
,
800 struct pdump_request req
= {.ver
= 1,};
804 if ((operation
& ENABLE
) != 0) {
805 snprintf(req
.data
.en_v1
.device
, sizeof(req
.data
.en_v1
.device
),
807 req
.data
.en_v1
.queue
= queue
;
808 req
.data
.en_v1
.ring
= ring
;
809 req
.data
.en_v1
.mp
= mp
;
810 req
.data
.en_v1
.filter
= filter
;
812 snprintf(req
.data
.dis_v1
.device
, sizeof(req
.data
.dis_v1
.device
),
814 req
.data
.dis_v1
.queue
= queue
;
815 req
.data
.dis_v1
.ring
= NULL
;
816 req
.data
.dis_v1
.mp
= NULL
;
817 req
.data
.dis_v1
.filter
= NULL
;
820 ret
= pdump_create_client_socket(&req
);
823 "client request for pdump enable/disable failed\n");
832 rte_pdump_enable(uint8_t port
, uint16_t queue
, uint32_t flags
,
833 struct rte_ring
*ring
,
834 struct rte_mempool
*mp
,
839 char name
[DEVICE_ID_SIZE
];
841 ret
= pdump_validate_port(port
, name
);
844 ret
= pdump_validate_ring_mp(ring
, mp
);
847 ret
= pdump_validate_flags(flags
);
851 ret
= pdump_prepare_client_request(name
, queue
, flags
,
852 ENABLE
, ring
, mp
, filter
);
858 rte_pdump_enable_by_deviceid(char *device_id
, uint16_t queue
,
860 struct rte_ring
*ring
,
861 struct rte_mempool
*mp
,
866 ret
= pdump_validate_ring_mp(ring
, mp
);
869 ret
= pdump_validate_flags(flags
);
873 ret
= pdump_prepare_client_request(device_id
, queue
, flags
,
874 ENABLE
, ring
, mp
, filter
);
880 rte_pdump_disable(uint8_t port
, uint16_t queue
, uint32_t flags
)
883 char name
[DEVICE_ID_SIZE
];
885 ret
= pdump_validate_port(port
, name
);
888 ret
= pdump_validate_flags(flags
);
892 ret
= pdump_prepare_client_request(name
, queue
, flags
,
893 DISABLE
, NULL
, NULL
, NULL
);
899 rte_pdump_disable_by_deviceid(char *device_id
, uint16_t queue
,
904 ret
= pdump_validate_flags(flags
);
908 ret
= pdump_prepare_client_request(device_id
, queue
, flags
,
909 DISABLE
, NULL
, NULL
, NULL
);
915 rte_pdump_set_socket_dir(const char *path
, enum rte_pdump_socktype type
)
920 if (type
== RTE_PDUMP_SOCKET_SERVER
) {
921 count
= sizeof(server_socket_dir
);
922 ret
= snprintf(server_socket_dir
, count
, "%s", path
);
924 count
= sizeof(client_socket_dir
);
925 ret
= snprintf(client_socket_dir
, count
, "%s", path
);
928 if (ret
< 0 || ret
>= count
) {
930 "Invalid socket path:%s:%d\n",
932 if (type
== RTE_PDUMP_SOCKET_SERVER
)
933 server_socket_dir
[0] = 0;
935 client_socket_dir
[0] = 0;