Linux Audio

Check our new training course

Loading...
v6.2
  1// SPDX-License-Identifier: GPL-2.0
  2/*
  3 * Copyright (C) 2021 Red Hat Inc, Daniel Bristot de Oliveira <bristot@kernel.org>
  4 */
  5
 
  6#include <getopt.h>
  7#include <stdlib.h>
  8#include <string.h>
  9#include <signal.h>
 10#include <unistd.h>
 11#include <stdio.h>
 12#include <time.h>
 
 
 
 13
 14#include "utils.h"
 15#include "osnoise.h"
 16#include "timerlat.h"
 
 
 17
 18struct timerlat_top_params {
 19	char			*cpus;
 20	char			*monitored_cpus;
 21	char			*trace_output;
 
 22	unsigned long long	runtime;
 23	long long		stop_us;
 24	long long		stop_total_us;
 25	long long		timerlat_period_us;
 26	long long		print_stack;
 27	int			sleep_time;
 28	int			output_divisor;
 29	int			duration;
 30	int			quiet;
 31	int			set_sched;
 32	int			dma_latency;
 
 
 
 
 
 
 
 
 33	struct sched_attr	sched_param;
 34	struct trace_events	*events;
 35};
 36
 37struct timerlat_top_cpu {
 38	int			irq_count;
 39	int			thread_count;
 
 40
 41	unsigned long long	cur_irq;
 42	unsigned long long	min_irq;
 43	unsigned long long	sum_irq;
 44	unsigned long long	max_irq;
 45
 46	unsigned long long	cur_thread;
 47	unsigned long long	min_thread;
 48	unsigned long long	sum_thread;
 49	unsigned long long	max_thread;
 
 
 
 
 
 50};
 51
 52struct timerlat_top_data {
 53	struct timerlat_top_cpu	*cpu_data;
 54	int			nr_cpus;
 55};
 56
 57/*
 58 * timerlat_free_top - free runtime data
 59 */
 60static void
 61timerlat_free_top(struct timerlat_top_data *data)
 62{
 63	free(data->cpu_data);
 64	free(data);
 65}
 66
 67/*
 68 * timerlat_alloc_histogram - alloc runtime data
 69 */
 70static struct timerlat_top_data *timerlat_alloc_top(int nr_cpus)
 71{
 72	struct timerlat_top_data *data;
 73	int cpu;
 74
 75	data = calloc(1, sizeof(*data));
 76	if (!data)
 77		return NULL;
 78
 79	data->nr_cpus = nr_cpus;
 80
 81	/* one set of histograms per CPU */
 82	data->cpu_data = calloc(1, sizeof(*data->cpu_data) * nr_cpus);
 83	if (!data->cpu_data)
 84		goto cleanup;
 85
 86	/* set the min to max */
 87	for (cpu = 0; cpu < nr_cpus; cpu++) {
 88		data->cpu_data[cpu].min_irq = ~0;
 89		data->cpu_data[cpu].min_thread = ~0;
 
 90	}
 91
 92	return data;
 93
 94cleanup:
 95	timerlat_free_top(data);
 96	return NULL;
 97}
 98
 99/*
100 * timerlat_hist_update - record a new timerlat occurent on cpu, updating data
101 */
102static void
103timerlat_top_update(struct osnoise_tool *tool, int cpu,
104		    unsigned long long thread,
105		    unsigned long long latency)
106{
107	struct timerlat_top_data *data = tool->data;
108	struct timerlat_top_cpu *cpu_data = &data->cpu_data[cpu];
109
110	if (!thread) {
111		cpu_data->irq_count++;
112		cpu_data->cur_irq = latency;
113		update_min(&cpu_data->min_irq, &latency);
114		update_sum(&cpu_data->sum_irq, &latency);
115		update_max(&cpu_data->max_irq, &latency);
116	} else {
117		cpu_data->thread_count++;
118		cpu_data->cur_thread = latency;
119		update_min(&cpu_data->min_thread, &latency);
120		update_sum(&cpu_data->sum_thread, &latency);
121		update_max(&cpu_data->max_thread, &latency);
 
 
 
 
 
 
122	}
123}
124
125/*
126 * timerlat_top_handler - this is the handler for timerlat tracer events
127 */
128static int
129timerlat_top_handler(struct trace_seq *s, struct tep_record *record,
130		     struct tep_event *event, void *context)
131{
132	struct trace_instance *trace = context;
 
133	unsigned long long latency, thread;
134	struct osnoise_tool *top;
135	int cpu = record->cpu;
136
137	top = container_of(trace, struct osnoise_tool, trace);
 
138
139	tep_get_field_val(s, event, "context", record, &thread, 1);
140	tep_get_field_val(s, event, "timer_latency", record, &latency, 1);
 
141
142	timerlat_top_update(top, cpu, thread, latency);
 
143
144	return 0;
145}
146
147/*
148 * timerlat_top_header - print the header of the tool output
149 */
150static void timerlat_top_header(struct osnoise_tool *top)
151{
152	struct timerlat_top_params *params = top->params;
153	struct trace_seq *s = top->trace.seq;
154	char duration[26];
155
156	get_duration(top->start_time, duration, sizeof(duration));
157
158	trace_seq_printf(s, "\033[2;37;40m");
159	trace_seq_printf(s, "                                     Timer Latency                                              ");
 
 
160	trace_seq_printf(s, "\033[0;0;0m");
161	trace_seq_printf(s, "\n");
162
163	trace_seq_printf(s, "%-6s   |          IRQ Timer Latency (%s)        |         Thread Timer Latency (%s)\n", duration,
164			params->output_divisor == 1 ? "ns" : "us",
165			params->output_divisor == 1 ? "ns" : "us");
166
 
 
 
 
 
 
167	trace_seq_printf(s, "\033[2;30;47m");
168	trace_seq_printf(s, "CPU COUNT      |      cur       min       avg       max |      cur       min       avg       max");
 
 
169	trace_seq_printf(s, "\033[0;0;0m");
170	trace_seq_printf(s, "\n");
171}
172
173/*
174 * timerlat_top_print - prints the output of a given CPU
175 */
176static void timerlat_top_print(struct osnoise_tool *top, int cpu)
177{
178
179	struct timerlat_top_params *params = top->params;
180	struct timerlat_top_data *data = top->data;
181	struct timerlat_top_cpu *cpu_data = &data->cpu_data[cpu];
182	int divisor = params->output_divisor;
183	struct trace_seq *s = top->trace.seq;
184
185	if (divisor == 0)
186		return;
187
188	/*
189	 * Skip if no data is available: is this cpu offline?
190	 */
191	if (!cpu_data->irq_count && !cpu_data->thread_count)
192		return;
193
194	/*
195	 * Unless trace is being lost, IRQ counter is always the max.
196	 */
197	trace_seq_printf(s, "%3d #%-9d |", cpu, cpu_data->irq_count);
198
199	if (!cpu_data->irq_count) {
200		trace_seq_printf(s, "        - ");
201		trace_seq_printf(s, "        - ");
202		trace_seq_printf(s, "        - ");
203		trace_seq_printf(s, "        - |");
204	} else {
205		trace_seq_printf(s, "%9llu ", cpu_data->cur_irq / params->output_divisor);
206		trace_seq_printf(s, "%9llu ", cpu_data->min_irq / params->output_divisor);
207		trace_seq_printf(s, "%9llu ", (cpu_data->sum_irq / cpu_data->irq_count) / divisor);
208		trace_seq_printf(s, "%9llu |", cpu_data->max_irq / divisor);
209	}
210
211	if (!cpu_data->thread_count) {
212		trace_seq_printf(s, "        - ");
213		trace_seq_printf(s, "        - ");
214		trace_seq_printf(s, "        - ");
215		trace_seq_printf(s, "        -\n");
216	} else {
217		trace_seq_printf(s, "%9llu ", cpu_data->cur_thread / divisor);
218		trace_seq_printf(s, "%9llu ", cpu_data->min_thread / divisor);
219		trace_seq_printf(s, "%9llu ",
220				(cpu_data->sum_thread / cpu_data->thread_count) / divisor);
221		trace_seq_printf(s, "%9llu\n", cpu_data->max_thread / divisor);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
222	}
223}
224
225/*
226 * clear_terminal - clears the output terminal
227 */
228static void clear_terminal(struct trace_seq *seq)
229{
230	if (!config_debug)
231		trace_seq_printf(seq, "\033c");
232}
233
234/*
235 * timerlat_print_stats - print data for all cpus
236 */
237static void
238timerlat_print_stats(struct timerlat_top_params *params, struct osnoise_tool *top)
239{
240	struct trace_instance *trace = &top->trace;
241	static int nr_cpus = -1;
242	int i;
243
 
 
 
244	if (nr_cpus == -1)
245		nr_cpus = sysconf(_SC_NPROCESSORS_CONF);
246
247	if (!params->quiet)
248		clear_terminal(trace->seq);
249
250	timerlat_top_header(top);
251
252	for (i = 0; i < nr_cpus; i++) {
253		if (params->cpus && !params->monitored_cpus[i])
254			continue;
255		timerlat_top_print(top, i);
256	}
257
258	trace_seq_do_printf(trace->seq);
259	trace_seq_reset(trace->seq);
260}
261
262/*
263 * timerlat_top_usage - prints timerlat top usage message
264 */
265static void timerlat_top_usage(char *usage)
266{
267	int i;
268
269	static const char *const msg[] = {
270		"",
271		"  usage: rtla timerlat [top] [-h] [-q] [-a us] [-d s] [-D] [-n] [-p us] [-i us] [-T us] [-s us] \\",
272		"	  [[-t[=file]] [-e sys[:event]] [--filter <filter>] [--trigger <trigger>] [-c cpu-list] \\",
273		"	  [-P priority] [--dma-latency us]",
274		"",
275		"	  -h/--help: print this menu",
276		"	  -a/--auto: set automatic trace mode, stopping the session if argument in us latency is hit",
 
277		"	  -p/--period us: timerlat period in us",
278		"	  -i/--irq us: stop trace if the irq latency is higher than the argument in us",
279		"	  -T/--thread us: stop trace if the thread latency is higher than the argument in us",
280		"	  -s/--stack us: save the stack trace at the IRQ if a thread latency is higher than the argument in us",
281		"	  -c/--cpus cpus: run the tracer only on the given cpus",
 
 
282		"	  -d/--duration time[m|h|d]: duration of the session in seconds",
283		"	  -D/--debug: print debug info",
 
284		"	  -t/--trace[=file]: save the stopped trace to [file|timerlat_trace.txt]",
285		"	  -e/--event <sys:event>: enable the <sys:event> in the trace instance, multiple -e are allowed",
286		"	     --filter <command>: enable a trace event filter to the previous -e event",
287		"	     --trigger <command>: enable a trace event trigger to the previous -e event",
288		"	  -n/--nano: display data in nanoseconds",
 
289		"	  -q/--quiet print only a summary at the end",
290		"	     --dma-latency us: set /dev/cpu_dma_latency latency <us> to reduce exit from idle latency",
291		"	  -P/--priority o:prio|r:prio|f:prio|d:runtime:period : set scheduling parameters",
292		"		o:prio - use SCHED_OTHER with prio",
293		"		r:prio - use SCHED_RR with prio",
294		"		f:prio - use SCHED_FIFO with prio",
295		"		d:runtime[us|ms|s]:period[us|ms|s] - use SCHED_DEADLINE with runtime and period",
296		"						       in nanoseconds",
 
 
297		NULL,
298	};
299
300	if (usage)
301		fprintf(stderr, "%s\n", usage);
302
303	fprintf(stderr, "rtla timerlat top: a per-cpu summary of the timer latency (version %s)\n",
304			VERSION);
305
306	for (i = 0; msg[i]; i++)
307		fprintf(stderr, "%s\n", msg[i]);
308	exit(1);
 
 
 
 
309}
310
311/*
312 * timerlat_top_parse_args - allocs, parse and fill the cmd line parameters
313 */
314static struct timerlat_top_params
315*timerlat_top_parse_args(int argc, char **argv)
316{
317	struct timerlat_top_params *params;
318	struct trace_events *tevent;
319	long long auto_thresh;
320	int retval;
321	int c;
322
323	params = calloc(1, sizeof(*params));
324	if (!params)
325		exit(1);
326
327	/* disabled by default */
328	params->dma_latency = -1;
329
330	/* display data in microseconds */
331	params->output_divisor = 1000;
332
333	while (1) {
334		static struct option long_options[] = {
335			{"auto",		required_argument,	0, 'a'},
336			{"cpus",		required_argument,	0, 'c'},
 
337			{"debug",		no_argument,		0, 'D'},
338			{"duration",		required_argument,	0, 'd'},
339			{"event",		required_argument,	0, 'e'},
340			{"help",		no_argument,		0, 'h'},
 
341			{"irq",			required_argument,	0, 'i'},
342			{"nano",		no_argument,		0, 'n'},
343			{"period",		required_argument,	0, 'p'},
344			{"priority",		required_argument,	0, 'P'},
345			{"quiet",		no_argument,		0, 'q'},
346			{"stack",		required_argument,	0, 's'},
347			{"thread",		required_argument,	0, 'T'},
348			{"trace",		optional_argument,	0, 't'},
 
 
349			{"trigger",		required_argument,	0, '0'},
350			{"filter",		required_argument,	0, '1'},
351			{"dma-latency",		required_argument,	0, '2'},
 
 
 
352			{0, 0, 0, 0}
353		};
354
355		/* getopt_long stores the option index here. */
356		int option_index = 0;
357
358		c = getopt_long(argc, argv, "a:c:d:De:hi:np:P:qs:t::T:0:1:2:",
359				 long_options, &option_index);
360
361		/* detect the end of the options. */
362		if (c == -1)
363			break;
364
365		switch (c) {
366		case 'a':
367			auto_thresh = get_llong_from_str(optarg);
368
369			/* set thread stop to auto_thresh */
370			params->stop_total_us = auto_thresh;
 
371
372			/* get stack trace */
373			params->print_stack = auto_thresh;
374
375			/* set trace */
376			params->trace_output = "timerlat_trace.txt";
 
 
 
 
 
 
 
 
 
 
 
377
 
 
378			break;
379		case 'c':
380			retval = parse_cpu_list(optarg, &params->monitored_cpus);
381			if (retval)
382				timerlat_top_usage("\nInvalid -c cpu list\n");
383			params->cpus = optarg;
384			break;
 
 
 
 
 
 
 
 
 
 
385		case 'D':
386			config_debug = 1;
387			break;
388		case 'd':
389			params->duration = parse_seconds_duration(optarg);
390			if (!params->duration)
391				timerlat_top_usage("Invalid -D duration\n");
392			break;
393		case 'e':
394			tevent = trace_event_alloc(optarg);
395			if (!tevent) {
396				err_msg("Error alloc trace event");
397				exit(EXIT_FAILURE);
398			}
399
400			if (params->events)
401				tevent->next = params->events;
402			params->events = tevent;
403			break;
404		case 'h':
405		case '?':
406			timerlat_top_usage(NULL);
407			break;
 
 
 
 
 
 
 
 
408		case 'i':
409			params->stop_us = get_llong_from_str(optarg);
410			break;
411		case 'n':
412			params->output_divisor = 1;
413			break;
414		case 'p':
415			params->timerlat_period_us = get_llong_from_str(optarg);
416			if (params->timerlat_period_us > 1000000)
417				timerlat_top_usage("Period longer than 1 s\n");
418			break;
419		case 'P':
420			retval = parse_prio(optarg, &params->sched_param);
421			if (retval == -1)
422				timerlat_top_usage("Invalid -P priority");
423			params->set_sched = 1;
424			break;
425		case 'q':
426			params->quiet = 1;
427			break;
428		case 's':
429			params->print_stack = get_llong_from_str(optarg);
430			break;
431		case 'T':
432			params->stop_total_us = get_llong_from_str(optarg);
433			break;
434		case 't':
435			if (optarg)
436				/* skip = */
437				params->trace_output = &optarg[1];
438			else
439				params->trace_output = "timerlat_trace.txt";
 
 
 
 
 
 
 
440			break;
441		case '0': /* trigger */
442			if (params->events) {
443				retval = trace_event_add_trigger(params->events, optarg);
444				if (retval) {
445					err_msg("Error adding trigger %s\n", optarg);
446					exit(EXIT_FAILURE);
447				}
448			} else {
449				timerlat_top_usage("--trigger requires a previous -e\n");
450			}
451			break;
452		case '1': /* filter */
453			if (params->events) {
454				retval = trace_event_add_filter(params->events, optarg);
455				if (retval) {
456					err_msg("Error adding filter %s\n", optarg);
457					exit(EXIT_FAILURE);
458				}
459			} else {
460				timerlat_top_usage("--filter requires a previous -e\n");
461			}
462			break;
463		case '2': /* dma-latency */
464			params->dma_latency = get_llong_from_str(optarg);
465			if (params->dma_latency < 0 || params->dma_latency > 10000) {
466				err_msg("--dma-latency needs to be >= 0 and < 10000");
467				exit(EXIT_FAILURE);
468			}
469			break;
 
 
 
 
 
 
470		default:
471			timerlat_top_usage("Invalid option");
472		}
473	}
474
475	if (geteuid()) {
476		err_msg("rtla needs root permission\n");
477		exit(EXIT_FAILURE);
478	}
479
 
 
 
 
 
 
 
 
 
480	return params;
481}
482
483/*
484 * timerlat_top_apply_config - apply the top configs to the initialized tool
485 */
486static int
487timerlat_top_apply_config(struct osnoise_tool *top, struct timerlat_top_params *params)
488{
489	int retval;
 
490
491	if (!params->sleep_time)
492		params->sleep_time = 1;
493
494	if (params->cpus) {
495		retval = osnoise_set_cpus(top->context, params->cpus);
496		if (retval) {
497			err_msg("Failed to apply CPUs config\n");
498			goto out_err;
499		}
 
 
 
500	}
501
502	if (params->stop_us) {
503		retval = osnoise_set_stop_us(top->context, params->stop_us);
504		if (retval) {
505			err_msg("Failed to set stop us\n");
506			goto out_err;
507		}
508	}
509
510	if (params->stop_total_us) {
511		retval = osnoise_set_stop_total_us(top->context, params->stop_total_us);
512		if (retval) {
513			err_msg("Failed to set stop total us\n");
514			goto out_err;
515		}
516	}
517
518
519	if (params->timerlat_period_us) {
520		retval = osnoise_set_timerlat_period_us(top->context, params->timerlat_period_us);
521		if (retval) {
522			err_msg("Failed to set timerlat period\n");
523			goto out_err;
524		}
525	}
526
527
528	if (params->print_stack) {
529		retval = osnoise_set_print_stack(top->context, params->print_stack);
530		if (retval) {
531			err_msg("Failed to set print stack\n");
532			goto out_err;
533		}
534	}
535
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
536	return 0;
537
538out_err:
539	return -1;
540}
541
542/*
543 * timerlat_init_top - initialize a timerlat top tool with parameters
544 */
545static struct osnoise_tool
546*timerlat_init_top(struct timerlat_top_params *params)
547{
548	struct osnoise_tool *top;
549	int nr_cpus;
550
551	nr_cpus = sysconf(_SC_NPROCESSORS_CONF);
552
553	top = osnoise_init_tool("timerlat_top");
554	if (!top)
555		return NULL;
556
557	top->data = timerlat_alloc_top(nr_cpus);
558	if (!top->data)
559		goto out_err;
560
561	top->params = params;
562
563	tep_register_event_handler(top->trace.tep, -1, "ftrace", "timerlat",
564				   timerlat_top_handler, top);
565
566	return top;
567
568out_err:
569	osnoise_destroy_tool(top);
570	return NULL;
571}
572
573static int stop_tracing;
574static void stop_top(int sig)
575{
576	stop_tracing = 1;
577}
578
579/*
580 * timerlat_top_set_signals - handles the signal to stop the tool
581 */
582static void
583timerlat_top_set_signals(struct timerlat_top_params *params)
584{
585	signal(SIGINT, stop_top);
586	if (params->duration) {
587		signal(SIGALRM, stop_top);
588		alarm(params->duration);
589	}
590}
591
592int timerlat_top_main(int argc, char *argv[])
593{
594	struct timerlat_top_params *params;
595	struct osnoise_tool *record = NULL;
 
596	struct osnoise_tool *top = NULL;
 
597	struct trace_instance *trace;
598	int dma_latency_fd = -1;
 
599	int return_value = 1;
 
600	int retval;
601
602	params = timerlat_top_parse_args(argc, argv);
603	if (!params)
604		exit(1);
605
606	top = timerlat_init_top(params);
607	if (!top) {
608		err_msg("Could not init osnoise top\n");
609		goto out_exit;
610	}
611
612	retval = timerlat_top_apply_config(top, params);
613	if (retval) {
614		err_msg("Could not apply config\n");
615		goto out_free;
616	}
617
618	trace = &top->trace;
619
620	retval = enable_timerlat(trace);
621	if (retval) {
622		err_msg("Failed to enable timerlat tracer\n");
623		goto out_free;
624	}
625
626	if (params->set_sched) {
627		retval = set_comm_sched_attr("timerlat/", &params->sched_param);
628		if (retval) {
629			err_msg("Failed to set sched parameters\n");
630			goto out_free;
631		}
632	}
633
 
 
 
 
 
 
 
 
634	if (params->dma_latency >= 0) {
635		dma_latency_fd = set_cpu_dma_latency(params->dma_latency);
636		if (dma_latency_fd < 0) {
637			err_msg("Could not set /dev/cpu_dma_latency.\n");
638			goto out_free;
639		}
640	}
641
642	trace_instance_start(trace);
643
644	if (params->trace_output) {
645		record = osnoise_init_trace_tool("timerlat");
646		if (!record) {
647			err_msg("Failed to enable the trace instance\n");
648			goto out_free;
649		}
650
651		if (params->events) {
652			retval = trace_events_enable(&record->trace, params->events);
653			if (retval)
654				goto out_top;
655		}
 
656
657		trace_instance_start(&record->trace);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
658	}
659
 
 
 
 
 
 
 
 
 
 
 
 
 
660	top->start_time = time(NULL);
661	timerlat_top_set_signals(params);
662
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
663	while (!stop_tracing) {
664		sleep(params->sleep_time);
665
 
 
 
666		retval = tracefs_iterate_raw_events(trace->tep,
667						    trace->inst,
668						    NULL,
669						    0,
670						    collect_registered_events,
671						    trace);
672		if (retval < 0) {
673			err_msg("Error iterating on events\n");
674			goto out_top;
675		}
676
677		if (!params->quiet)
678			timerlat_print_stats(params, top);
679
680		if (trace_is_off(&top->trace, &record->trace))
681			break;
682
 
 
 
 
 
 
 
 
 
 
 
 
683	}
684
685	timerlat_print_stats(params, top);
686
687	return_value = 0;
688
689	if (trace_is_off(&top->trace, &record->trace)) {
690		printf("rtla timerlat hit stop tracing\n");
 
 
 
 
691		if (params->trace_output) {
692			printf("  Saving trace to %s\n", params->trace_output);
693			save_trace_to_file(record->trace.inst, params->trace_output);
694		}
 
 
 
 
 
 
 
 
 
 
695	}
696
697out_top:
 
698	if (dma_latency_fd >= 0)
699		close(dma_latency_fd);
700	trace_events_destroy(&record->trace, params->events);
701	params->events = NULL;
702out_free:
703	timerlat_free_top(top->data);
 
 
704	osnoise_destroy_tool(record);
705	osnoise_destroy_tool(top);
706	free(params);
707out_exit:
708	exit(return_value);
709}
v6.9.4
  1// SPDX-License-Identifier: GPL-2.0
  2/*
  3 * Copyright (C) 2021 Red Hat Inc, Daniel Bristot de Oliveira <bristot@kernel.org>
  4 */
  5
  6#define _GNU_SOURCE
  7#include <getopt.h>
  8#include <stdlib.h>
  9#include <string.h>
 10#include <signal.h>
 11#include <unistd.h>
 12#include <stdio.h>
 13#include <time.h>
 14#include <errno.h>
 15#include <sched.h>
 16#include <pthread.h>
 17
 18#include "utils.h"
 19#include "osnoise.h"
 20#include "timerlat.h"
 21#include "timerlat_aa.h"
 22#include "timerlat_u.h"
 23
 24struct timerlat_top_params {
 25	char			*cpus;
 26	cpu_set_t		monitored_cpus;
 27	char			*trace_output;
 28	char			*cgroup_name;
 29	unsigned long long	runtime;
 30	long long		stop_us;
 31	long long		stop_total_us;
 32	long long		timerlat_period_us;
 33	long long		print_stack;
 34	int			sleep_time;
 35	int			output_divisor;
 36	int			duration;
 37	int			quiet;
 38	int			set_sched;
 39	int			dma_latency;
 40	int			no_aa;
 41	int			aa_only;
 42	int			dump_tasks;
 43	int			cgroup;
 44	int			hk_cpus;
 45	int			user_top;
 46	int			user_workload;
 47	cpu_set_t		hk_cpu_set;
 48	struct sched_attr	sched_param;
 49	struct trace_events	*events;
 50};
 51
 52struct timerlat_top_cpu {
 53	int			irq_count;
 54	int			thread_count;
 55	int			user_count;
 56
 57	unsigned long long	cur_irq;
 58	unsigned long long	min_irq;
 59	unsigned long long	sum_irq;
 60	unsigned long long	max_irq;
 61
 62	unsigned long long	cur_thread;
 63	unsigned long long	min_thread;
 64	unsigned long long	sum_thread;
 65	unsigned long long	max_thread;
 66
 67	unsigned long long	cur_user;
 68	unsigned long long	min_user;
 69	unsigned long long	sum_user;
 70	unsigned long long	max_user;
 71};
 72
 73struct timerlat_top_data {
 74	struct timerlat_top_cpu	*cpu_data;
 75	int			nr_cpus;
 76};
 77
 78/*
 79 * timerlat_free_top - free runtime data
 80 */
 81static void
 82timerlat_free_top(struct timerlat_top_data *data)
 83{
 84	free(data->cpu_data);
 85	free(data);
 86}
 87
 88/*
 89 * timerlat_alloc_histogram - alloc runtime data
 90 */
 91static struct timerlat_top_data *timerlat_alloc_top(int nr_cpus)
 92{
 93	struct timerlat_top_data *data;
 94	int cpu;
 95
 96	data = calloc(1, sizeof(*data));
 97	if (!data)
 98		return NULL;
 99
100	data->nr_cpus = nr_cpus;
101
102	/* one set of histograms per CPU */
103	data->cpu_data = calloc(1, sizeof(*data->cpu_data) * nr_cpus);
104	if (!data->cpu_data)
105		goto cleanup;
106
107	/* set the min to max */
108	for (cpu = 0; cpu < nr_cpus; cpu++) {
109		data->cpu_data[cpu].min_irq = ~0;
110		data->cpu_data[cpu].min_thread = ~0;
111		data->cpu_data[cpu].min_user = ~0;
112	}
113
114	return data;
115
116cleanup:
117	timerlat_free_top(data);
118	return NULL;
119}
120
121/*
122 * timerlat_hist_update - record a new timerlat occurent on cpu, updating data
123 */
124static void
125timerlat_top_update(struct osnoise_tool *tool, int cpu,
126		    unsigned long long thread,
127		    unsigned long long latency)
128{
129	struct timerlat_top_data *data = tool->data;
130	struct timerlat_top_cpu *cpu_data = &data->cpu_data[cpu];
131
132	if (!thread) {
133		cpu_data->irq_count++;
134		cpu_data->cur_irq = latency;
135		update_min(&cpu_data->min_irq, &latency);
136		update_sum(&cpu_data->sum_irq, &latency);
137		update_max(&cpu_data->max_irq, &latency);
138	} else if (thread == 1) {
139		cpu_data->thread_count++;
140		cpu_data->cur_thread = latency;
141		update_min(&cpu_data->min_thread, &latency);
142		update_sum(&cpu_data->sum_thread, &latency);
143		update_max(&cpu_data->max_thread, &latency);
144	} else {
145		cpu_data->user_count++;
146		cpu_data->cur_user = latency;
147		update_min(&cpu_data->min_user, &latency);
148		update_sum(&cpu_data->sum_user, &latency);
149		update_max(&cpu_data->max_user, &latency);
150	}
151}
152
153/*
154 * timerlat_top_handler - this is the handler for timerlat tracer events
155 */
156static int
157timerlat_top_handler(struct trace_seq *s, struct tep_record *record,
158		     struct tep_event *event, void *context)
159{
160	struct trace_instance *trace = context;
161	struct timerlat_top_params *params;
162	unsigned long long latency, thread;
163	struct osnoise_tool *top;
164	int cpu = record->cpu;
165
166	top = container_of(trace, struct osnoise_tool, trace);
167	params = top->params;
168
169	if (!params->aa_only) {
170		tep_get_field_val(s, event, "context", record, &thread, 1);
171		tep_get_field_val(s, event, "timer_latency", record, &latency, 1);
172
173		timerlat_top_update(top, cpu, thread, latency);
174	}
175
176	return 0;
177}
178
179/*
180 * timerlat_top_header - print the header of the tool output
181 */
182static void timerlat_top_header(struct osnoise_tool *top)
183{
184	struct timerlat_top_params *params = top->params;
185	struct trace_seq *s = top->trace.seq;
186	char duration[26];
187
188	get_duration(top->start_time, duration, sizeof(duration));
189
190	trace_seq_printf(s, "\033[2;37;40m");
191	trace_seq_printf(s, "                                     Timer Latency                                              ");
192	if (params->user_top)
193		trace_seq_printf(s, "                                         ");
194	trace_seq_printf(s, "\033[0;0;0m");
195	trace_seq_printf(s, "\n");
196
197	trace_seq_printf(s, "%-6s   |          IRQ Timer Latency (%s)        |         Thread Timer Latency (%s)", duration,
198			params->output_divisor == 1 ? "ns" : "us",
199			params->output_divisor == 1 ? "ns" : "us");
200
201	if (params->user_top) {
202		trace_seq_printf(s, "      |    Ret user Timer Latency (%s)",
203				params->output_divisor == 1 ? "ns" : "us");
204	}
205
206	trace_seq_printf(s, "\n");
207	trace_seq_printf(s, "\033[2;30;47m");
208	trace_seq_printf(s, "CPU COUNT      |      cur       min       avg       max |      cur       min       avg       max");
209	if (params->user_top)
210		trace_seq_printf(s, " |      cur       min       avg       max");
211	trace_seq_printf(s, "\033[0;0;0m");
212	trace_seq_printf(s, "\n");
213}
214
215/*
216 * timerlat_top_print - prints the output of a given CPU
217 */
218static void timerlat_top_print(struct osnoise_tool *top, int cpu)
219{
220
221	struct timerlat_top_params *params = top->params;
222	struct timerlat_top_data *data = top->data;
223	struct timerlat_top_cpu *cpu_data = &data->cpu_data[cpu];
224	int divisor = params->output_divisor;
225	struct trace_seq *s = top->trace.seq;
226
227	if (divisor == 0)
228		return;
229
230	/*
231	 * Skip if no data is available: is this cpu offline?
232	 */
233	if (!cpu_data->irq_count && !cpu_data->thread_count)
234		return;
235
236	/*
237	 * Unless trace is being lost, IRQ counter is always the max.
238	 */
239	trace_seq_printf(s, "%3d #%-9d |", cpu, cpu_data->irq_count);
240
241	if (!cpu_data->irq_count) {
242		trace_seq_printf(s, "        - ");
243		trace_seq_printf(s, "        - ");
244		trace_seq_printf(s, "        - ");
245		trace_seq_printf(s, "        - |");
246	} else {
247		trace_seq_printf(s, "%9llu ", cpu_data->cur_irq / params->output_divisor);
248		trace_seq_printf(s, "%9llu ", cpu_data->min_irq / params->output_divisor);
249		trace_seq_printf(s, "%9llu ", (cpu_data->sum_irq / cpu_data->irq_count) / divisor);
250		trace_seq_printf(s, "%9llu |", cpu_data->max_irq / divisor);
251	}
252
253	if (!cpu_data->thread_count) {
254		trace_seq_printf(s, "        - ");
255		trace_seq_printf(s, "        - ");
256		trace_seq_printf(s, "        - ");
257		trace_seq_printf(s, "        -\n");
258	} else {
259		trace_seq_printf(s, "%9llu ", cpu_data->cur_thread / divisor);
260		trace_seq_printf(s, "%9llu ", cpu_data->min_thread / divisor);
261		trace_seq_printf(s, "%9llu ",
262				(cpu_data->sum_thread / cpu_data->thread_count) / divisor);
263		trace_seq_printf(s, "%9llu", cpu_data->max_thread / divisor);
264	}
265
266	if (!params->user_top) {
267		trace_seq_printf(s, "\n");
268		return;
269	}
270
271	trace_seq_printf(s, " |");
272
273	if (!cpu_data->user_count) {
274		trace_seq_printf(s, "        - ");
275		trace_seq_printf(s, "        - ");
276		trace_seq_printf(s, "        - ");
277		trace_seq_printf(s, "        -\n");
278	} else {
279		trace_seq_printf(s, "%9llu ", cpu_data->cur_user / divisor);
280		trace_seq_printf(s, "%9llu ", cpu_data->min_user / divisor);
281		trace_seq_printf(s, "%9llu ",
282				(cpu_data->sum_user / cpu_data->user_count) / divisor);
283		trace_seq_printf(s, "%9llu\n", cpu_data->max_user / divisor);
284	}
285}
286
287/*
288 * clear_terminal - clears the output terminal
289 */
290static void clear_terminal(struct trace_seq *seq)
291{
292	if (!config_debug)
293		trace_seq_printf(seq, "\033c");
294}
295
296/*
297 * timerlat_print_stats - print data for all cpus
298 */
299static void
300timerlat_print_stats(struct timerlat_top_params *params, struct osnoise_tool *top)
301{
302	struct trace_instance *trace = &top->trace;
303	static int nr_cpus = -1;
304	int i;
305
306	if (params->aa_only)
307		return;
308
309	if (nr_cpus == -1)
310		nr_cpus = sysconf(_SC_NPROCESSORS_CONF);
311
312	if (!params->quiet)
313		clear_terminal(trace->seq);
314
315	timerlat_top_header(top);
316
317	for (i = 0; i < nr_cpus; i++) {
318		if (params->cpus && !CPU_ISSET(i, &params->monitored_cpus))
319			continue;
320		timerlat_top_print(top, i);
321	}
322
323	trace_seq_do_printf(trace->seq);
324	trace_seq_reset(trace->seq);
325}
326
327/*
328 * timerlat_top_usage - prints timerlat top usage message
329 */
330static void timerlat_top_usage(char *usage)
331{
332	int i;
333
334	static const char *const msg[] = {
335		"",
336		"  usage: rtla timerlat [top] [-h] [-q] [-a us] [-d s] [-D] [-n] [-p us] [-i us] [-T us] [-s us] \\",
337		"	  [[-t[=file]] [-e sys[:event]] [--filter <filter>] [--trigger <trigger>] [-c cpu-list] [-H cpu-list]\\",
338		"	  [-P priority] [--dma-latency us] [--aa-only us] [-C[=cgroup_name]] [-u]",
339		"",
340		"	  -h/--help: print this menu",
341		"	  -a/--auto: set automatic trace mode, stopping the session if argument in us latency is hit",
342		"	     --aa-only us: stop if <us> latency is hit, only printing the auto analysis (reduces CPU usage)",
343		"	  -p/--period us: timerlat period in us",
344		"	  -i/--irq us: stop trace if the irq latency is higher than the argument in us",
345		"	  -T/--thread us: stop trace if the thread latency is higher than the argument in us",
346		"	  -s/--stack us: save the stack trace at the IRQ if a thread latency is higher than the argument in us",
347		"	  -c/--cpus cpus: run the tracer only on the given cpus",
348		"	  -H/--house-keeping cpus: run rtla control threads only on the given cpus",
349		"	  -C/--cgroup[=cgroup_name]: set cgroup, if no cgroup_name is passed, the rtla's cgroup will be inherited",
350		"	  -d/--duration time[m|h|d]: duration of the session in seconds",
351		"	  -D/--debug: print debug info",
352		"	     --dump-tasks: prints the task running on all CPUs if stop conditions are met (depends on !--no-aa)",
353		"	  -t/--trace[=file]: save the stopped trace to [file|timerlat_trace.txt]",
354		"	  -e/--event <sys:event>: enable the <sys:event> in the trace instance, multiple -e are allowed",
355		"	     --filter <command>: enable a trace event filter to the previous -e event",
356		"	     --trigger <command>: enable a trace event trigger to the previous -e event",
357		"	  -n/--nano: display data in nanoseconds",
358		"	     --no-aa: disable auto-analysis, reducing rtla timerlat cpu usage",
359		"	  -q/--quiet print only a summary at the end",
360		"	     --dma-latency us: set /dev/cpu_dma_latency latency <us> to reduce exit from idle latency",
361		"	  -P/--priority o:prio|r:prio|f:prio|d:runtime:period : set scheduling parameters",
362		"		o:prio - use SCHED_OTHER with prio",
363		"		r:prio - use SCHED_RR with prio",
364		"		f:prio - use SCHED_FIFO with prio",
365		"		d:runtime[us|ms|s]:period[us|ms|s] - use SCHED_DEADLINE with runtime and period",
366		"						       in nanoseconds",
367		"	  -u/--user-threads: use rtla user-space threads instead of in-kernel timerlat threads",
368		"	  -U/--user-load: enable timerlat for user-defined user-space workload",
369		NULL,
370	};
371
372	if (usage)
373		fprintf(stderr, "%s\n", usage);
374
375	fprintf(stderr, "rtla timerlat top: a per-cpu summary of the timer latency (version %s)\n",
376			VERSION);
377
378	for (i = 0; msg[i]; i++)
379		fprintf(stderr, "%s\n", msg[i]);
380
381	if (usage)
382		exit(EXIT_FAILURE);
383
384	exit(EXIT_SUCCESS);
385}
386
387/*
388 * timerlat_top_parse_args - allocs, parse and fill the cmd line parameters
389 */
390static struct timerlat_top_params
391*timerlat_top_parse_args(int argc, char **argv)
392{
393	struct timerlat_top_params *params;
394	struct trace_events *tevent;
395	long long auto_thresh;
396	int retval;
397	int c;
398
399	params = calloc(1, sizeof(*params));
400	if (!params)
401		exit(1);
402
403	/* disabled by default */
404	params->dma_latency = -1;
405
406	/* display data in microseconds */
407	params->output_divisor = 1000;
408
409	while (1) {
410		static struct option long_options[] = {
411			{"auto",		required_argument,	0, 'a'},
412			{"cpus",		required_argument,	0, 'c'},
413			{"cgroup",		optional_argument,	0, 'C'},
414			{"debug",		no_argument,		0, 'D'},
415			{"duration",		required_argument,	0, 'd'},
416			{"event",		required_argument,	0, 'e'},
417			{"help",		no_argument,		0, 'h'},
418			{"house-keeping",	required_argument,	0, 'H'},
419			{"irq",			required_argument,	0, 'i'},
420			{"nano",		no_argument,		0, 'n'},
421			{"period",		required_argument,	0, 'p'},
422			{"priority",		required_argument,	0, 'P'},
423			{"quiet",		no_argument,		0, 'q'},
424			{"stack",		required_argument,	0, 's'},
425			{"thread",		required_argument,	0, 'T'},
426			{"trace",		optional_argument,	0, 't'},
427			{"user-threads",	no_argument,		0, 'u'},
428			{"user-load",		no_argument,		0, 'U'},
429			{"trigger",		required_argument,	0, '0'},
430			{"filter",		required_argument,	0, '1'},
431			{"dma-latency",		required_argument,	0, '2'},
432			{"no-aa",		no_argument,		0, '3'},
433			{"dump-tasks",		no_argument,		0, '4'},
434			{"aa-only",		required_argument,	0, '5'},
435			{0, 0, 0, 0}
436		};
437
438		/* getopt_long stores the option index here. */
439		int option_index = 0;
440
441		c = getopt_long(argc, argv, "a:c:C::d:De:hH:i:np:P:qs:t::T:uU0:1:2:345:",
442				 long_options, &option_index);
443
444		/* detect the end of the options. */
445		if (c == -1)
446			break;
447
448		switch (c) {
449		case 'a':
450			auto_thresh = get_llong_from_str(optarg);
451
452			/* set thread stop to auto_thresh */
453			params->stop_total_us = auto_thresh;
454			params->stop_us = auto_thresh;
455
456			/* get stack trace */
457			params->print_stack = auto_thresh;
458
459			/* set trace */
460			params->trace_output = "timerlat_trace.txt";
461			break;
462		case '5':
463			/* it is here because it is similar to -a */
464			auto_thresh = get_llong_from_str(optarg);
465
466			/* set thread stop to auto_thresh */
467			params->stop_total_us = auto_thresh;
468			params->stop_us = auto_thresh;
469
470			/* get stack trace */
471			params->print_stack = auto_thresh;
472
473			/* set aa_only to avoid parsing the trace */
474			params->aa_only = 1;
475			break;
476		case 'c':
477			retval = parse_cpu_set(optarg, &params->monitored_cpus);
478			if (retval)
479				timerlat_top_usage("\nInvalid -c cpu list\n");
480			params->cpus = optarg;
481			break;
482		case 'C':
483			params->cgroup = 1;
484			if (!optarg) {
485				/* will inherit this cgroup */
486				params->cgroup_name = NULL;
487			} else if (*optarg == '=') {
488				/* skip the = */
489				params->cgroup_name = ++optarg;
490			}
491			break;
492		case 'D':
493			config_debug = 1;
494			break;
495		case 'd':
496			params->duration = parse_seconds_duration(optarg);
497			if (!params->duration)
498				timerlat_top_usage("Invalid -D duration\n");
499			break;
500		case 'e':
501			tevent = trace_event_alloc(optarg);
502			if (!tevent) {
503				err_msg("Error alloc trace event");
504				exit(EXIT_FAILURE);
505			}
506
507			if (params->events)
508				tevent->next = params->events;
509			params->events = tevent;
510			break;
511		case 'h':
512		case '?':
513			timerlat_top_usage(NULL);
514			break;
515		case 'H':
516			params->hk_cpus = 1;
517			retval = parse_cpu_set(optarg, &params->hk_cpu_set);
518			if (retval) {
519				err_msg("Error parsing house keeping CPUs\n");
520				exit(EXIT_FAILURE);
521			}
522			break;
523		case 'i':
524			params->stop_us = get_llong_from_str(optarg);
525			break;
526		case 'n':
527			params->output_divisor = 1;
528			break;
529		case 'p':
530			params->timerlat_period_us = get_llong_from_str(optarg);
531			if (params->timerlat_period_us > 1000000)
532				timerlat_top_usage("Period longer than 1 s\n");
533			break;
534		case 'P':
535			retval = parse_prio(optarg, &params->sched_param);
536			if (retval == -1)
537				timerlat_top_usage("Invalid -P priority");
538			params->set_sched = 1;
539			break;
540		case 'q':
541			params->quiet = 1;
542			break;
543		case 's':
544			params->print_stack = get_llong_from_str(optarg);
545			break;
546		case 'T':
547			params->stop_total_us = get_llong_from_str(optarg);
548			break;
549		case 't':
550			if (optarg)
551				/* skip = */
552				params->trace_output = &optarg[1];
553			else
554				params->trace_output = "timerlat_trace.txt";
555
556			break;
557		case 'u':
558			params->user_workload = true;
559			/* fallback: -u implies -U */
560		case 'U':
561			params->user_top = true;
562			break;
563		case '0': /* trigger */
564			if (params->events) {
565				retval = trace_event_add_trigger(params->events, optarg);
566				if (retval) {
567					err_msg("Error adding trigger %s\n", optarg);
568					exit(EXIT_FAILURE);
569				}
570			} else {
571				timerlat_top_usage("--trigger requires a previous -e\n");
572			}
573			break;
574		case '1': /* filter */
575			if (params->events) {
576				retval = trace_event_add_filter(params->events, optarg);
577				if (retval) {
578					err_msg("Error adding filter %s\n", optarg);
579					exit(EXIT_FAILURE);
580				}
581			} else {
582				timerlat_top_usage("--filter requires a previous -e\n");
583			}
584			break;
585		case '2': /* dma-latency */
586			params->dma_latency = get_llong_from_str(optarg);
587			if (params->dma_latency < 0 || params->dma_latency > 10000) {
588				err_msg("--dma-latency needs to be >= 0 and < 10000");
589				exit(EXIT_FAILURE);
590			}
591			break;
592		case '3': /* no-aa */
593			params->no_aa = 1;
594			break;
595		case '4':
596			params->dump_tasks = 1;
597			break;
598		default:
599			timerlat_top_usage("Invalid option");
600		}
601	}
602
603	if (geteuid()) {
604		err_msg("rtla needs root permission\n");
605		exit(EXIT_FAILURE);
606	}
607
608	/*
609	 * Auto analysis only happens if stop tracing, thus:
610	 */
611	if (!params->stop_us && !params->stop_total_us)
612		params->no_aa = 1;
613
614	if (params->no_aa && params->aa_only)
615		timerlat_top_usage("--no-aa and --aa-only are mutually exclusive!");
616
617	return params;
618}
619
620/*
621 * timerlat_top_apply_config - apply the top configs to the initialized tool
622 */
623static int
624timerlat_top_apply_config(struct osnoise_tool *top, struct timerlat_top_params *params)
625{
626	int retval;
627	int i;
628
629	if (!params->sleep_time)
630		params->sleep_time = 1;
631
632	if (params->cpus) {
633		retval = osnoise_set_cpus(top->context, params->cpus);
634		if (retval) {
635			err_msg("Failed to apply CPUs config\n");
636			goto out_err;
637		}
638	} else {
639		for (i = 0; i < sysconf(_SC_NPROCESSORS_CONF); i++)
640			CPU_SET(i, &params->monitored_cpus);
641	}
642
643	if (params->stop_us) {
644		retval = osnoise_set_stop_us(top->context, params->stop_us);
645		if (retval) {
646			err_msg("Failed to set stop us\n");
647			goto out_err;
648		}
649	}
650
651	if (params->stop_total_us) {
652		retval = osnoise_set_stop_total_us(top->context, params->stop_total_us);
653		if (retval) {
654			err_msg("Failed to set stop total us\n");
655			goto out_err;
656		}
657	}
658
659
660	if (params->timerlat_period_us) {
661		retval = osnoise_set_timerlat_period_us(top->context, params->timerlat_period_us);
662		if (retval) {
663			err_msg("Failed to set timerlat period\n");
664			goto out_err;
665		}
666	}
667
668
669	if (params->print_stack) {
670		retval = osnoise_set_print_stack(top->context, params->print_stack);
671		if (retval) {
672			err_msg("Failed to set print stack\n");
673			goto out_err;
674		}
675	}
676
677	if (params->hk_cpus) {
678		retval = sched_setaffinity(getpid(), sizeof(params->hk_cpu_set),
679					   &params->hk_cpu_set);
680		if (retval == -1) {
681			err_msg("Failed to set rtla to the house keeping CPUs\n");
682			goto out_err;
683		}
684	} else if (params->cpus) {
685		/*
686		 * Even if the user do not set a house-keeping CPU, try to
687		 * move rtla to a CPU set different to the one where the user
688		 * set the workload to run.
689		 *
690		 * No need to check results as this is an automatic attempt.
691		 */
692		auto_house_keeping(&params->monitored_cpus);
693	}
694
695	if (params->user_top) {
696		retval = osnoise_set_workload(top->context, 0);
697		if (retval) {
698			err_msg("Failed to set OSNOISE_WORKLOAD option\n");
699			goto out_err;
700		}
701	}
702
703	return 0;
704
705out_err:
706	return -1;
707}
708
709/*
710 * timerlat_init_top - initialize a timerlat top tool with parameters
711 */
712static struct osnoise_tool
713*timerlat_init_top(struct timerlat_top_params *params)
714{
715	struct osnoise_tool *top;
716	int nr_cpus;
717
718	nr_cpus = sysconf(_SC_NPROCESSORS_CONF);
719
720	top = osnoise_init_tool("timerlat_top");
721	if (!top)
722		return NULL;
723
724	top->data = timerlat_alloc_top(nr_cpus);
725	if (!top->data)
726		goto out_err;
727
728	top->params = params;
729
730	tep_register_event_handler(top->trace.tep, -1, "ftrace", "timerlat",
731				   timerlat_top_handler, top);
732
733	return top;
734
735out_err:
736	osnoise_destroy_tool(top);
737	return NULL;
738}
739
740static int stop_tracing;
741static void stop_top(int sig)
742{
743	stop_tracing = 1;
744}
745
746/*
747 * timerlat_top_set_signals - handles the signal to stop the tool
748 */
749static void
750timerlat_top_set_signals(struct timerlat_top_params *params)
751{
752	signal(SIGINT, stop_top);
753	if (params->duration) {
754		signal(SIGALRM, stop_top);
755		alarm(params->duration);
756	}
757}
758
759int timerlat_top_main(int argc, char *argv[])
760{
761	struct timerlat_top_params *params;
762	struct osnoise_tool *record = NULL;
763	struct timerlat_u_params params_u;
764	struct osnoise_tool *top = NULL;
765	struct osnoise_tool *aa = NULL;
766	struct trace_instance *trace;
767	int dma_latency_fd = -1;
768	pthread_t timerlat_u;
769	int return_value = 1;
770	char *max_lat;
771	int retval;
772
773	params = timerlat_top_parse_args(argc, argv);
774	if (!params)
775		exit(1);
776
777	top = timerlat_init_top(params);
778	if (!top) {
779		err_msg("Could not init osnoise top\n");
780		goto out_exit;
781	}
782
783	retval = timerlat_top_apply_config(top, params);
784	if (retval) {
785		err_msg("Could not apply config\n");
786		goto out_free;
787	}
788
789	trace = &top->trace;
790
791	retval = enable_timerlat(trace);
792	if (retval) {
793		err_msg("Failed to enable timerlat tracer\n");
794		goto out_free;
795	}
796
797	if (params->set_sched) {
798		retval = set_comm_sched_attr("timerlat/", &params->sched_param);
799		if (retval) {
800			err_msg("Failed to set sched parameters\n");
801			goto out_free;
802		}
803	}
804
805	if (params->cgroup && !params->user_top) {
806		retval = set_comm_cgroup("timerlat/", params->cgroup_name);
807		if (!retval) {
808			err_msg("Failed to move threads to cgroup\n");
809			goto out_free;
810		}
811	}
812
813	if (params->dma_latency >= 0) {
814		dma_latency_fd = set_cpu_dma_latency(params->dma_latency);
815		if (dma_latency_fd < 0) {
816			err_msg("Could not set /dev/cpu_dma_latency.\n");
817			goto out_free;
818		}
819	}
820
 
 
821	if (params->trace_output) {
822		record = osnoise_init_trace_tool("timerlat");
823		if (!record) {
824			err_msg("Failed to enable the trace instance\n");
825			goto out_free;
826		}
827
828		if (params->events) {
829			retval = trace_events_enable(&record->trace, params->events);
830			if (retval)
831				goto out_top;
832		}
833	}
834
835	if (!params->no_aa) {
836		if (params->aa_only) {
837			/* as top is not used for display, use it for aa */
838			aa = top;
839		} else  {
840			/* otherwise, a new instance is needed */
841			aa = osnoise_init_tool("timerlat_aa");
842			if (!aa)
843				goto out_top;
844		}
845
846		retval = timerlat_aa_init(aa, params->dump_tasks);
847		if (retval) {
848			err_msg("Failed to enable the auto analysis instance\n");
849			goto out_top;
850		}
851
852		/* if it is re-using the main instance, there is no need to start it */
853		if (aa != top) {
854			retval = enable_timerlat(&aa->trace);
855			if (retval) {
856				err_msg("Failed to enable timerlat tracer\n");
857				goto out_top;
858			}
859		}
860	}
861
862	/*
863	 * Start the tracers here, after having set all instances.
864	 *
865	 * Let the trace instance start first for the case of hitting a stop
866	 * tracing while enabling other instances. The trace instance is the
867	 * one with most valuable information.
868	 */
869	if (params->trace_output)
870		trace_instance_start(&record->trace);
871	if (!params->no_aa && aa != top)
872		trace_instance_start(&aa->trace);
873	trace_instance_start(trace);
874
875	top->start_time = time(NULL);
876	timerlat_top_set_signals(params);
877
878	if (params->user_workload) {
879		/* rtla asked to stop */
880		params_u.should_run = 1;
881		/* all threads left */
882		params_u.stopped_running = 0;
883
884		params_u.set = &params->monitored_cpus;
885		if (params->set_sched)
886			params_u.sched_param = &params->sched_param;
887		else
888			params_u.sched_param = NULL;
889
890		params_u.cgroup_name = params->cgroup_name;
891
892		retval = pthread_create(&timerlat_u, NULL, timerlat_u_dispatcher, &params_u);
893		if (retval)
894			err_msg("Error creating timerlat user-space threads\n");
895	}
896
897	while (!stop_tracing) {
898		sleep(params->sleep_time);
899
900		if (params->aa_only && !trace_is_off(&top->trace, &record->trace))
901			continue;
902
903		retval = tracefs_iterate_raw_events(trace->tep,
904						    trace->inst,
905						    NULL,
906						    0,
907						    collect_registered_events,
908						    trace);
909		if (retval < 0) {
910			err_msg("Error iterating on events\n");
911			goto out_top;
912		}
913
914		if (!params->quiet)
915			timerlat_print_stats(params, top);
916
917		if (trace_is_off(&top->trace, &record->trace))
918			break;
919
920		/* is there still any user-threads ? */
921		if (params->user_workload) {
922			if (params_u.stopped_running) {
923				debug_msg("timerlat user space threads stopped!\n");
924				break;
925			}
926		}
927	}
928
929	if (params->user_workload && !params_u.stopped_running) {
930		params_u.should_run = 0;
931		sleep(1);
932	}
933
934	timerlat_print_stats(params, top);
935
936	return_value = 0;
937
938	if (trace_is_off(&top->trace, &record->trace)) {
939		printf("rtla timerlat hit stop tracing\n");
940
941		if (!params->no_aa)
942			timerlat_auto_analysis(params->stop_us, params->stop_total_us);
943
944		if (params->trace_output) {
945			printf("  Saving trace to %s\n", params->trace_output);
946			save_trace_to_file(record->trace.inst, params->trace_output);
947		}
948	} else if (params->aa_only) {
949		/*
950		 * If the trace did not stop with --aa-only, at least print the
951		 * max known latency.
952		 */
953		max_lat = tracefs_instance_file_read(trace->inst, "tracing_max_latency", NULL);
954		if (max_lat) {
955			printf("  Max latency was %s\n", max_lat);
956			free(max_lat);
957		}
958	}
959
960out_top:
961	timerlat_aa_destroy();
962	if (dma_latency_fd >= 0)
963		close(dma_latency_fd);
964	trace_events_destroy(&record->trace, params->events);
965	params->events = NULL;
966out_free:
967	timerlat_free_top(top->data);
968	if (aa && aa != top)
969		osnoise_destroy_tool(aa);
970	osnoise_destroy_tool(record);
971	osnoise_destroy_tool(top);
972	free(params);
973out_exit:
974	exit(return_value);
975}