timerlat_top.c

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