Commit a957cbc0 authored by Daniel Bristot de Oliveira's avatar Daniel Bristot de Oliveira Committed by Steven Rostedt (Google)
Browse files

rtla: Add -C cgroup support 

The -C option sets a cgroup to the tracer's threads. If the -C option is
passed without arguments, the tracer's thread will inherit rtla's
cgroup. Otherwise, the threads will be placed on the cgroup passed
to the option.

Link: https://lkml.kernel.org/r/cb051477331d292f17c08bf1d66f0e0384bbe5a5.1686066600.git.bristot@kernel.org



Cc: William White <chwhite@redhat.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Tested-by: default avatarJuri Lelli <juri.lelli@redhat.com>
Signed-off-by: default avatarDaniel Bristot de Oliveira <bristot@kernel.org>
Signed-off-by: default avatarSteven Rostedt (Google) <rostedt@goodmis.org>
parent 9561de3a

Documentation/tools/rtla/common_options.rst

+4 −0
Original line number Diff line number Diff line
@@ -42,6 +42,10 @@ 
        - *f:prio* - use SCHED_FIFO with *prio*;

        - *d:runtime[us|ms|s]:period[us|ms|s]* - use SCHED_DEADLINE with *runtime* and *period* in nanoseconds.



**-C**, **--cgroup**\[*=cgroup*]



        Set a *cgroup* to the tracer's threads. If the **-C** option is passed without arguments, the tracer's thread will inherit **rtla**'s *cgroup*. Otherwise, the threads will be placed on the *cgroup* passed to the option.



**-h**, **--help**



        Print help menu.

tools/tracing/rtla/src/osnoise_hist.c

+24 −2
Original line number Diff line number Diff line
@@ -19,6 +19,7 @@ struct osnoise_hist_params { 
	char			*cpus;

	char			*monitored_cpus;

	char			*trace_output;

	char			*cgroup_name;

	unsigned long long	runtime;

	unsigned long long	period;

	long long		threshold;
@@ -28,6 +29,7 @@ struct osnoise_hist_params { 
	int			duration;

	int			set_sched;

	int			output_divisor;

	int			cgroup;

	struct sched_attr	sched_param;

	struct trace_events	*events;
@@ -433,7 +435,7 @@ static void osnoise_hist_usage(char *usage) 
		"  usage: rtla osnoise hist [-h] [-D] [-d s] [-a us] [-p us] [-r us] [-s us] [-S us] \\",

		"	  [-T us] [-t[=file]] [-e sys[:event]] [--filter <filter>] [--trigger <trigger>] \\",

		"	  [-c cpu-list] [-P priority] [-b N] [-E N] [--no-header] [--no-summary] [--no-index] \\",

		"	  [--with-zeros]",

		"	  [--with-zeros] [-C[=cgroup_name]]",

		"",

		"	  -h/--help: print this menu",

		"	  -a/--auto: set automatic trace mode, stopping the session if argument in us sample is hit",
@@ -443,6 +445,7 @@ static void osnoise_hist_usage(char *usage) 
		"	  -S/--stop-total us: stop trace if the total sample is higher than the argument in us",

		"	  -T/--threshold us: the minimum delta to be considered a noise",

		"	  -c/--cpus cpu-list: list of cpus to run osnoise threads",

		"	  -C/--cgroup[=cgroup_name]: set cgroup, if no cgroup_name is passed, the rtla's cgroup will be inherited",

		"	  -d/--duration time[s|m|h|d]: duration of the session",

		"	  -D/--debug: print debug info",

		"	  -t/--trace[=file]: save the stopped trace to [file|osnoise_trace.txt]",
@@ -501,6 +504,7 @@ static struct osnoise_hist_params 
			{"bucket-size",		required_argument,	0, 'b'},

			{"entries",		required_argument,	0, 'E'},

			{"cpus",		required_argument,	0, 'c'},

			{"cgroup",		optional_argument,	0, 'C'},

			{"debug",		no_argument,		0, 'D'},

			{"duration",		required_argument,	0, 'd'},

			{"help",		no_argument,		0, 'h'},
@@ -524,7 +528,7 @@ static struct osnoise_hist_params 
		/* getopt_long stores the option index here. */

		int option_index = 0;



		c = getopt_long(argc, argv, "a:c:b:d:e:E:Dhp:P:r:s:S:t::T:01234:5:",

		c = getopt_long(argc, argv, "a:c:C::b:d:e:E:Dhp:P:r:s:S:t::T:01234:5:",

				 long_options, &option_index);



		/* detect the end of the options. */
@@ -554,6 +558,16 @@ static struct osnoise_hist_params 
				osnoise_hist_usage("\nInvalid -c cpu list\n");

			params->cpus = optarg;

			break;

		case 'C':

			params->cgroup = 1;

			if (!optarg) {

				/* will inherit this cgroup */

				params->cgroup_name = NULL;

			} else if (*optarg == '=') {

				/* skip the = */

				params->cgroup_name = ++optarg;

			}

			break;

		case 'D':

			config_debug = 1;

			break;
@@ -816,6 +830,14 @@ int osnoise_hist_main(int argc, char *argv[]) 
		}

	}



	if (params->cgroup) {

		retval = set_comm_cgroup("timerlat/", params->cgroup_name);

		if (!retval) {

			err_msg("Failed to move threads to cgroup\n");

			goto out_free;

		}

	}



	trace_instance_start(trace);



	if (params->trace_output) {

tools/tracing/rtla/src/osnoise_top.c

+24 −2
Original line number Diff line number Diff line
@@ -26,6 +26,7 @@ struct osnoise_top_params { 
	char			*cpus;

	char			*monitored_cpus;

	char			*trace_output;

	char			*cgroup_name;

	unsigned long long	runtime;

	unsigned long long	period;

	long long		threshold;
@@ -35,6 +36,7 @@ struct osnoise_top_params { 
	int			duration;

	int			quiet;

	int			set_sched;

	int			cgroup;

	struct sched_attr	sched_param;

	struct trace_events	*events;

	enum osnoise_mode	mode;
@@ -276,7 +278,7 @@ static void osnoise_top_usage(struct osnoise_top_params *params, char *usage) 
	static const char * const msg[] = {

		" [-h] [-q] [-D] [-d s] [-a us] [-p us] [-r us] [-s us] [-S us] \\",

		"	  [-T us] [-t[=file]] [-e sys[:event]] [--filter <filter>] [--trigger <trigger>] \\",

		"	  [-c cpu-list] [-P priority]",

		"	  [-c cpu-list] [-P priority] [-C[=cgroup_name]]",

		"",

		"	  -h/--help: print this menu",

		"	  -a/--auto: set automatic trace mode, stopping the session if argument in us sample is hit",
@@ -286,6 +288,7 @@ static void osnoise_top_usage(struct osnoise_top_params *params, char *usage) 
		"	  -S/--stop-total us: stop trace if the total sample is higher than the argument in us",

		"	  -T/--threshold us: the minimum delta to be considered a noise",

		"	  -c/--cpus cpu-list: list of cpus to run osnoise threads",

		"	  -C/--cgroup[=cgroup_name]: set cgroup, if no cgroup_name is passed, the rtla's cgroup will be inherited",

		"	  -d/--duration time[s|m|h|d]: duration of the session",

		"	  -D/--debug: print debug info",

		"	  -t/--trace[=file]: save the stopped trace to [file|osnoise_trace.txt]",
@@ -347,6 +350,7 @@ struct osnoise_top_params *osnoise_top_parse_args(int argc, char **argv) 
		static struct option long_options[] = {

			{"auto",		required_argument,	0, 'a'},

			{"cpus",		required_argument,	0, 'c'},

			{"cgroup",		optional_argument,	0, 'C'},

			{"debug",		no_argument,		0, 'D'},

			{"duration",		required_argument,	0, 'd'},

			{"event",		required_argument,	0, 'e'},
@@ -367,7 +371,7 @@ struct osnoise_top_params *osnoise_top_parse_args(int argc, char **argv) 
		/* getopt_long stores the option index here. */

		int option_index = 0;



		c = getopt_long(argc, argv, "a:c:d:De:hp:P:qr:s:S:t::T:0:1:",

		c = getopt_long(argc, argv, "a:c:C::d:De:hp:P:qr:s:S:t::T:0:1:",

				 long_options, &option_index);



		/* Detect the end of the options. */
@@ -392,6 +396,16 @@ struct osnoise_top_params *osnoise_top_parse_args(int argc, char **argv) 
				osnoise_top_usage(params, "\nInvalid -c cpu list\n");

			params->cpus = optarg;

			break;

		case 'C':

			params->cgroup = 1;

			if (!optarg) {

				/* will inherit this cgroup */

				params->cgroup_name = NULL;

			} else if (*optarg == '=') {

				/* skip the = */

				params->cgroup_name = ++optarg;

			}

			break;

		case 'D':

			config_debug = 1;

			break;
@@ -643,6 +657,14 @@ int osnoise_top_main(int argc, char **argv) 
		}

	}



	if (params->cgroup) {

		retval = set_comm_cgroup("osnoise/", params->cgroup_name);

		if (!retval) {

			err_msg("Failed to move threads to cgroup\n");

			goto out_free;

		}

	}



	trace_instance_start(trace);



	if (params->trace_output) {

tools/tracing/rtla/src/timerlat_hist.c

+24 −3
Original line number Diff line number Diff line
@@ -19,6 +19,7 @@ struct timerlat_hist_params { 
	char			*cpus;

	char			*monitored_cpus;

	char			*trace_output;

	char			*cgroup_name;

	unsigned long long	runtime;

	long long		stop_us;

	long long		stop_total_us;
@@ -29,9 +30,9 @@ struct timerlat_hist_params { 
	int			duration;

	int			set_sched;

	int			dma_latency;

	int			cgroup;

	struct sched_attr	sched_param;

	struct trace_events	*events;



	char			no_irq;

	char			no_thread;

	char			no_header;
@@ -433,7 +434,7 @@ static void timerlat_hist_usage(char *usage) 
		"  usage: [rtla] timerlat hist [-h] [-q] [-d s] [-D] [-n] [-a us] [-p us] [-i us] [-T us] [-s us] \\",

		"         [-t[=file]] [-e sys[:event]] [--filter <filter>] [--trigger <trigger>] [-c cpu-list] \\",

		"	  [-P priority] [-E N] [-b N] [--no-irq] [--no-thread] [--no-header] [--no-summary] \\",

		"	  [--no-index] [--with-zeros] [--dma-latency us]",

		"	  [--no-index] [--with-zeros] [--dma-latency us] [-C[=cgroup_name]]",

		"",

		"	  -h/--help: print this menu",

		"	  -a/--auto: set automatic trace mode, stopping the session if argument in us latency is hit",
@@ -442,6 +443,7 @@ static void timerlat_hist_usage(char *usage) 
		"	  -T/--thread us: stop trace if the thread latency is higher than the argument in us",

		"	  -s/--stack us: save the stack trace at the IRQ if a thread latency is higher than the argument in us",

		"	  -c/--cpus cpus: run the tracer only on the given cpus",

		"	  -C/--cgroup[=cgroup_name]: set cgroup, if no cgroup_name is passed, the rtla's cgroup will be inherited",

		"	  -d/--duration time[m|h|d]: duration of the session in seconds",

		"	  -D/--debug: print debug info",

		"	  -t/--trace[=file]: save the stopped trace to [file|timerlat_trace.txt]",
@@ -506,6 +508,7 @@ static struct timerlat_hist_params 
		static struct option long_options[] = {

			{"auto",		required_argument,	0, 'a'},

			{"cpus",		required_argument,	0, 'c'},

			{"cgroup",		optional_argument,	0, 'C'},

			{"bucket-size",		required_argument,	0, 'b'},

			{"debug",		no_argument,		0, 'D'},

			{"entries",		required_argument,	0, 'E'},
@@ -534,7 +537,7 @@ static struct timerlat_hist_params 
		/* getopt_long stores the option index here. */

		int option_index = 0;



		c = getopt_long(argc, argv, "a:c:b:d:e:E:Dhi:np:P:s:t::T:0123456:7:8:",

		c = getopt_long(argc, argv, "a:c:C::b:d:e:E:Dhi:np:P:s:t::T:0123456:7:8:",

				 long_options, &option_index);



		/* detect the end of the options. */
@@ -561,6 +564,16 @@ static struct timerlat_hist_params 
				timerlat_hist_usage("\nInvalid -c cpu list\n");

			params->cpus = optarg;

			break;

		case 'C':

			params->cgroup = 1;

			if (!optarg) {

				/* will inherit this cgroup */

				params->cgroup_name = NULL;

			} else if (*optarg == '=') {

				/* skip the = */

				params->cgroup_name = ++optarg;

			}

			break;

		case 'b':

			params->bucket_size = get_llong_from_str(optarg);

			if ((params->bucket_size == 0) || (params->bucket_size >= 1000000))
@@ -840,6 +853,14 @@ int timerlat_hist_main(int argc, char *argv[]) 
		}

	}



	if (params->cgroup) {

		retval = set_comm_cgroup("timerlat/", params->cgroup_name);

		if (!retval) {

			err_msg("Failed to move threads to cgroup\n");

			goto out_free;

		}

	}



	if (params->dma_latency >= 0) {

		dma_latency_fd = set_cpu_dma_latency(params->dma_latency);

		if (dma_latency_fd < 0) {

tools/tracing/rtla/src/timerlat_top.c

+24 −2
Original line number Diff line number Diff line
@@ -21,6 +21,7 @@ struct timerlat_top_params { 
	char			*cpus;

	char			*monitored_cpus;

	char			*trace_output;

	char			*cgroup_name;

	unsigned long long	runtime;

	long long		stop_us;

	long long		stop_total_us;
@@ -35,6 +36,7 @@ struct timerlat_top_params { 
	int			no_aa;

	int			aa_only;

	int			dump_tasks;

	int			cgroup;

	struct sched_attr	sched_param;

	struct trace_events	*events;

};
@@ -285,7 +287,7 @@ static void timerlat_top_usage(char *usage) 
		"",

		"  usage: rtla timerlat [top] [-h] [-q] [-a us] [-d s] [-D] [-n] [-p us] [-i us] [-T us] [-s us] \\",

		"	  [[-t[=file]] [-e sys[:event]] [--filter <filter>] [--trigger <trigger>] [-c cpu-list] \\",

		"	  [-P priority] [--dma-latency us] [--aa-only us]",

		"	  [-P priority] [--dma-latency us] [--aa-only us] [-C[=cgroup_name]]",

		"",

		"	  -h/--help: print this menu",

		"	  -a/--auto: set automatic trace mode, stopping the session if argument in us latency is hit",
@@ -295,6 +297,7 @@ static void timerlat_top_usage(char *usage) 
		"	  -T/--thread us: stop trace if the thread latency is higher than the argument in us",

		"	  -s/--stack us: save the stack trace at the IRQ if a thread latency is higher than the argument in us",

		"	  -c/--cpus cpus: run the tracer only on the given cpus",

		"	  -C/--cgroup[=cgroup_name]: set cgroup, if no cgroup_name is passed, the rtla's cgroup will be inherited",

		"	  -d/--duration time[m|h|d]: duration of the session in seconds",

		"	  -D/--debug: print debug info",

		"	     --dump-tasks: prints the task running on all CPUs if stop conditions are met (depends on !--no-aa)",
@@ -352,6 +355,7 @@ static struct timerlat_top_params 
		static struct option long_options[] = {

			{"auto",		required_argument,	0, 'a'},

			{"cpus",		required_argument,	0, 'c'},

			{"cgroup",		optional_argument,	0, 'C'},

			{"debug",		no_argument,		0, 'D'},

			{"duration",		required_argument,	0, 'd'},

			{"event",		required_argument,	0, 'e'},
@@ -376,7 +380,7 @@ static struct timerlat_top_params 
		/* getopt_long stores the option index here. */

		int option_index = 0;



		c = getopt_long(argc, argv, "a:c:d:De:hi:np:P:qs:t::T:0:1:2:345:",

		c = getopt_long(argc, argv, "a:c:C::d:De:hi:np:P:qs:t::T:0:1:2:345:",

				 long_options, &option_index);



		/* detect the end of the options. */
@@ -417,6 +421,16 @@ static struct timerlat_top_params 
				timerlat_top_usage("\nInvalid -c cpu list\n");

			params->cpus = optarg;

			break;

		case 'C':

			params->cgroup = 1;

			if (!optarg) {

				/* will inherit this cgroup */

				params->cgroup_name = NULL;

			} else if (*optarg == '=') {

				/* skip the = */

				params->cgroup_name = ++optarg;

			}

			break;

		case 'D':

			config_debug = 1;

			break;
@@ -694,6 +708,14 @@ int timerlat_top_main(int argc, char *argv[]) 
		}

	}



	if (params->cgroup) {

		retval = set_comm_cgroup("timerlat/", params->cgroup_name);

		if (!retval) {

			err_msg("Failed to move threads to cgroup\n");

			goto out_free;

		}

	}



	if (params->dma_latency >= 0) {

		dma_latency_fd = set_cpu_dma_latency(params->dma_latency);

		if (dma_latency_fd < 0) {