dumpcap,pdump handle cleanup signals
cover dumpcap,pdump handle cleanup signals
The dumpcap and pdump commands need to handle more signals.
Stephen Hemminger (2):
app/dumpcap: handle SIGTERM and SIGHUP
app/pdump: handle SIGTERM and SIGHUP
app/dumpcap/main.c | 14 ++++++++++++-- app/pdump/main.c | 21 +++++++++++++++------ 2 files changed, 27 insertions(+), 8 deletions(-)
Signature · 1 line
2.43.0
PATCH 1/2 app/dumpcap: handle SIGTERM and SIGHUP
If application is killed (SIGTERM), or the console session ends (SIGHUP) or the write to the output file fails (SIGPIPE) then do cleanup before exiting.
This also makes DPDK dumpcap behave more like Wireshark dumpcap.
--- app/dumpcap/main.c | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-)
app/dumpcap/main.c +12 -2
@@ -939,6 +939,11 @@ int main(int argc, char **argv) {struct rte_ring *r;struct rte_mempool *mp; +struct sigaction action = { + .sa_flags =SA_RESTART , + .sa_handler = signal_handler, + }; +struct sigaction origaction;dumpcap_out_t out;char *p;
@@ -964,8 +969,13 @@ int main(int argc, char **argv)compile_filters (); -signal (SIGINT , signal_handler); -signal (SIGPIPE ,SIG_IGN ); +sigemptyset (&action.sa_mask); +sigaction (SIGTERM , &action,NULL ); +sigaction (SIGINT , &action,NULL ); +sigaction (SIGPIPE , &action,NULL ); +sigaction (SIGHUP ,NULL , &origaction); +if (origaction.sa_handler ==SIG_DFL ) +sigaction (SIGHUP , &action,NULL );enable_primary_monitor ();
Signature · 1 line
2.43.0
PATCH 2/2 app/pdump: handle SIGTERM and SIGHUP
In reply to Stephen HemmingerLike dumpcap, the pdump process should cleanup if process terminates due to being killed or hangup.
--- app/pdump/main.c | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-)
app/pdump/main.c +15 -6
@@ -571,11 +571,9 @@ disable_primary_monitor(void) }static void -signal_handler (int sig_num) +signal_handler(int sig_num __rte_unused) { -if (sig_num ==SIGINT ) { - quit_signal =1 ; - } + quit_signal =1 ; } static inline int
@@ -975,6 +973,11 @@ enable_primary_monitor(void)int main (int argc,char **argv) { +struct sigaction action = { + .sa_flags =SA_RESTART , + .sa_handler = signal_handler, + }; +struct sigaction origaction;int diag;int ret;int i;
@@ -983,8 +986,14 @@ main(int argc, char **argv)char mp_flag[] ="--proc-type=secondary" ;char *argp[argc +2 ]; -/* catch ctrl-c so we can print on exit */ -signal (SIGINT , signal_handler); +/* catch ctrl-c so we can cleanup on exit */ +sigemptyset (&action.sa_mask); +sigaction (SIGTERM , &action,NULL ); +sigaction (SIGINT , &action,NULL ); +sigaction (SIGPIPE , &action,NULL ); +sigaction (SIGHUP ,NULL , &origaction); +if (origaction.sa_handler ==SIG_DFL ) +sigaction (SIGHUP , &action,NULL ); argp[0 ] = argv[0 ]; argp[1 ] = n_flag;
Signature · 1 line
2.43.0
RE: [PATCH 2/2] app/pdump: handle SIGTERM and SIGHUP
app/pdump/main.c main(int argc, char **argv) · line 994
Quoted 5 lines
-----Original Message-----
From: Stephen Hemminger <[email protected]>app/pdump/main.c +1
-0+sigaction (SIGHUP ,NULL , &origaction);
Why do we need this ? Can't be this direct sigaction(SIGHUP, &action, NULL) without a below if code? Can you please explain how this works.
app/pdump/main.c main(int argc, char **argv) · line 996
Quoted 3 lines
app/pdump/main.c +2
-0+if (origaction.sa_handler ==SIG_DFL ) +sigaction (SIGHUP , &action,NULL );
Other changes looks ok to me.
Regards,
Reshma
Re: [PATCH 2/2] app/pdump: handle SIGTERM and SIGHUP
Quoted 11 lines · Reshma
app/pdump/main.c main(int argc, char **argv) · line 994
Quoted 3 lines
-----Original Message-----
From: Stephen Hemminger <[email protected]>app/pdump/main.c +1
-0+sigaction (SIGHUP ,NULL , &origaction);Why do we need this ? Can't be this direct
sigaction(SIGHUP, &action, NULL)without a below if code? Can you please explain how this works.app/pdump/main.c main(int argc, char **argv) · line 996
Quoted 3 lines
app/pdump/main.c +2
-0+if (origaction.sa_handler ==SIG_DFL ) +sigaction (SIGHUP , &action,NULL );
If sighup is being ignored already (for example being run by nohup) then the program should keep ignoring SIGHUP.
This is the method used in tshark and dumpcap utilities in wireshark and it made sense.
v2 cover Fix pdump and dumpcap leaks on SIGTERM
In reply to Stephen HemmingerFix bug where dumpcap and pdump programs would leave resources if killed with SIGTERM (or if file gets full).
v2 - rebase and rewording
Stephen Hemminger (2):
app/dumpcap: handle SIGTERM and SIGHUP
app/pdump: handle SIGTERM and SIGHUP
app/dumpcap/main.c | 14 ++++++++++++-- app/pdump/main.c | 21 +++++++++++++++------ 2 files changed, 27 insertions(+), 8 deletions(-)
Signature · 1 line
2.43.0
PATCH v2 1/2 app/dumpcap: handle SIGTERM and SIGHUP
If the dumpcap is killed it does not cleanup which leaves the ring buffer and the memory pool behind.
Until resource are exhausted devices will continue to fill the ring.
Fix by having the application handle SIGTERM, SIGHUP, and SIGPIPE. These are the same signals handled in same way by the wireshark dumpcap application.
--- app/dumpcap/main.c | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-)
app/dumpcap/main.c +12 -2
@@ -936,6 +936,11 @@ int main(int argc, char **argv) {struct rte_ring *r;struct rte_mempool *mp; +struct sigaction action = { + .sa_flags =SA_RESTART , + .sa_handler = signal_handler, + }; +struct sigaction origaction;dumpcap_out_t out;char *p;
@@ -961,8 +966,13 @@ int main(int argc, char **argv)compile_filters (); -signal (SIGINT , signal_handler); -signal (SIGPIPE ,SIG_IGN ); +sigemptyset (&action.sa_mask); +sigaction (SIGTERM , &action,NULL ); +sigaction (SIGINT , &action,NULL ); +sigaction (SIGPIPE , &action,NULL ); +sigaction (SIGHUP ,NULL , &origaction); +if (origaction.sa_handler ==SIG_DFL ) +sigaction (SIGHUP , &action,NULL );enable_primary_monitor ();
Signature · 1 line
2.43.0
PATCH v2 2/2 app/pdump: handle SIGTERM and SIGHUP
In reply to Stephen HemmingerThe pdump application will leak ring and memory pool if killed by SIGTERM. Like dumpcap, the pdump process should cleanup if process terminates due to being killed or hangup.
--- app/pdump/main.c | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-)
app/pdump/main.c +15 -6
@@ -571,11 +571,9 @@ disable_primary_monitor(void) }static void -signal_handler (int sig_num) +signal_handler(int sig_num __rte_unused) { -if (sig_num ==SIGINT ) { - quit_signal =1 ; - } + quit_signal =1 ; } static inline int
@@ -975,6 +973,11 @@ enable_primary_monitor(void)int main (int argc,char **argv) { +struct sigaction action = { + .sa_flags =SA_RESTART , + .sa_handler = signal_handler, + }; +struct sigaction origaction;int diag;int ret;int i;
@@ -983,8 +986,14 @@ main(int argc, char **argv)char mp_flag[] ="--proc-type=secondary" ;char *argp[argc +2 ]; -/* catch ctrl-c so we can print on exit */ -signal (SIGINT , signal_handler); +/* catch ctrl-c so we can cleanup on exit */ +sigemptyset (&action.sa_mask); +sigaction (SIGTERM , &action,NULL ); +sigaction (SIGINT , &action,NULL ); +sigaction (SIGPIPE , &action,NULL ); +sigaction (SIGHUP ,NULL , &origaction); +if (origaction.sa_handler ==SIG_DFL ) +sigaction (SIGHUP , &action,NULL ); argp[0 ] = argv[0 ]; argp[1 ] = n_flag;
Signature · 1 line
2.43.0
v3 cover dumpcap and pdump patches for 24.07
In reply to Stephen HemmingerFix bug where dumpcap and pdump programs would leave resources if killed with SIGTERM (or if file gets full).
Fix bug where dumpcap would always run on CPU 0 only.
v3 - combine and rebase these patches
Stephen Hemminger (3):
app/dumpcap: handle SIGTERM and SIGHUP
app/pdump: handle SIGTERM and SIGHUP
dumpcap: add lcores option
app/dumpcap/main.c | 45 +++++++++++++++++++++++++++++++++++++++++++-- app/pdump/main.c | 21 +++++++++++++++------ 2 files changed, 58 insertions(+), 8 deletions(-)
Signature · 1 line
2.43.0
PATCH v3 1/3 app/dumpcap: handle SIGTERM and SIGHUP
If the dumpcap is killed it does not cleanup which leaves the ring buffer and the memory pool behind.
Until resource are exhausted devices will continue to fill the ring.
Fix by having the application handle SIGTERM, SIGHUP, and SIGPIPE. These are the same signals handled in same way by the wireshark dumpcap application.
--- app/dumpcap/main.c | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-)
app/dumpcap/main.c +12 -2
@@ -936,6 +936,11 @@ int main(int argc, char **argv) {struct rte_ring *r;struct rte_mempool *mp; +struct sigaction action = { + .sa_flags =SA_RESTART , + .sa_handler = signal_handler, + }; +struct sigaction origaction;dumpcap_out_t out;char *p;
@@ -961,8 +966,13 @@ int main(int argc, char **argv)compile_filters (); -signal (SIGINT , signal_handler); -signal (SIGPIPE ,SIG_IGN ); +sigemptyset (&action.sa_mask); +sigaction (SIGTERM , &action,NULL ); +sigaction (SIGINT , &action,NULL ); +sigaction (SIGPIPE , &action,NULL ); +sigaction (SIGHUP ,NULL , &origaction); +if (origaction.sa_handler ==SIG_DFL ) +sigaction (SIGHUP , &action,NULL );enable_primary_monitor ();
Signature · 1 line
2.43.0
PATCH v3 2/3 app/pdump: handle SIGTERM and SIGHUP
In reply to Stephen HemmingerThe pdump application will leak ring and memory pool if killed by SIGTERM. Like dumpcap, the pdump process should cleanup if process terminates due to being killed or hangup.
--- app/pdump/main.c | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-)
app/pdump/main.c +15 -6
@@ -571,11 +571,9 @@ disable_primary_monitor(void) }static void -signal_handler (int sig_num) +signal_handler(int sig_num __rte_unused) { -if (sig_num ==SIGINT ) { - quit_signal =1 ; - } + quit_signal =1 ; } static inline int
@@ -975,6 +973,11 @@ enable_primary_monitor(void)int main (int argc,char **argv) { +struct sigaction action = { + .sa_flags =SA_RESTART , + .sa_handler = signal_handler, + }; +struct sigaction origaction;int diag;int ret;int i;
@@ -983,8 +986,14 @@ main(int argc, char **argv)char mp_flag[] ="--proc-type=secondary" ;char *argp[argc +2 ]; -/* catch ctrl-c so we can print on exit */ -signal (SIGINT , signal_handler); +/* catch ctrl-c so we can cleanup on exit */ +sigemptyset (&action.sa_mask); +sigaction (SIGTERM , &action,NULL ); +sigaction (SIGINT , &action,NULL ); +sigaction (SIGPIPE , &action,NULL ); +sigaction (SIGHUP ,NULL , &origaction); +if (origaction.sa_handler ==SIG_DFL ) +sigaction (SIGHUP , &action,NULL ); argp[0 ] = argv[0 ]; argp[1 ] = n_flag;
Signature · 1 line
2.43.0
PATCH v3 3/3 dumpcap: add lcores option
In reply to Stephen HemmingerThe dumpcap application is reading from ring and writing to the kernel. By default the EAL init will cause the main thread to bound to the first lcore (cpu 0). Add a command line option to select the lcore to use; or if no lcores are specified then just be a normal process and let the CPU scheduler handle it. Letting scheduler is likely to work well for process doint I/O with kernel.
--- app/dumpcap/main.c | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+)
app/dumpcap/main.c +31 -0
@@ -38,6 +38,7 @@#include <rte_pdump.h> #include <rte_ring.h> #include <rte_string_fns.h> +#include <rte_thread.h> #include <rte_time.h> #include <rte_version.h>
@@ -60,6 +61,7 @@ static const char *tmp_dir = "/tmp";static unsigned int ring_size =2048 ;static const char *capture_comment;static const char *file_prefix; +static const char *lcore_arg;static bool dump_bpf;static bool show_interfaces;static bool print_stats;
@@ -143,6 +145,7 @@ static void usage(void)" (default: /tmp)\n" "\n" "Miscellaneous:\n" +" --lcore=<core> cpu core to run on (default: any)\n" " --file-prefix=<prefix> prefix to use for multi-process\n" " -q don't report packet capture counts\n" " -v, --version print version information and exit\n"
@@ -343,6 +346,7 @@ static void parse_opts(int argc, char **argv) { "ifdescr", required_argument, NULL, 0 }, { "ifname", required_argument, NULL, 0 }, { "interface", required_argument, NULL, 'i' }, + { "lcore", required_argument, NULL, 0 }, { "list-interfaces", no_argument, NULL, 'D' }, { "no-promiscuous-mode", no_argument, NULL, 'p' }, { "output-file", required_argument, NULL, 'w' },
@@ -369,6 +373,8 @@ static void parse_opts(int argc, char **argv)if (!strcmp (longopt,"capture-comment" )) { capture_comment = optarg; + }else if (!strcmp (longopt,"lcore" )) { + lcore_arg = optarg; }else if (!strcmp (longopt,"file-prefix" )) { file_prefix = optarg; }else if (!strcmp (longopt,"temp-dir" )) {
@@ -608,12 +614,16 @@ static void dpdk_init(void) "--log-level", "notice" };int eal_argc =RTE_DIM (args); +rte_cpuset_t cpuset = { };char **eal_argv;unsigned int i;if (file_prefix !=NULL ) eal_argc +=2 ; +if (lcore_arg !=NULL ) + eal_argc +=2 ; +/* DPDK API requires mutable versions of command line arguments. */ eal_argv =calloc (eal_argc +1 ,sizeof (char *));if (eal_argv ==NULL )
@@ -623,6 +633,11 @@ static void dpdk_init(void)for (i =1 ; i <RTE_DIM (args); i++) eal_argv[i] =strdup (args[i]); +if (lcore_arg !=NULL ) { + eal_argv[i++] =strdup ("--lcores" ); + eal_argv[i++] =strdup (lcore_arg); + } +if (file_prefix !=NULL ) { eal_argv[i++] =strdup ("--file-prefix" ); eal_argv[i++] =strdup (file_prefix);
@@ -633,8 +648,24 @@ static void dpdk_init(void)rte_panic ("No memory\n" ); } +/* +* Need to get the original cpuset, before EAL init changes +* the affinity of this thread (main lcore). +*/ +if (lcore_arg ==NULL && +rte_thread_get_affinity_by_id (rte_thread_self (), &cpuset) !=0 ) +rte_panic ("rte_thread_getaffinity failed\n" ); +if (rte_eal_init (eal_argc, eal_argv) <0 )rte_exit (EXIT_FAILURE ,"EAL init failed: is primary process running?\n" ); + +/* +* If no lcore argument was specified, then run this program as a normal process +* which can be scheduled on any non-isolated CPU. +*/ +if (lcore_arg ==NULL && +rte_thread_set_affinity_by_id (rte_thread_self (), &cpuset) !=0 ) +rte_exit (EXIT_FAILURE ,"Can not restore original cpu affinity\n" ); }/* Create packet ring shared between callbacks and process */
Signature · 1 line
2.43.0
Thomas Monjalon
AppliedRe: [PATCH v3 0/3] dumpcap and pdump patches for 24.07
In reply to Stephen Hemminger03/07/2024 17:45, Stephen Hemminger:
Quoted 4 lines
Stephen Hemminger (3):
app/dumpcap: handle SIGTERM and SIGHUP
app/pdump: handle SIGTERM and SIGHUP
dumpcap: add lcores option
Applied, thanks.
Note: I did few edits for space aligned arguments and "CPU" uppercase.