1 // SPDX-License-Identifier: GPL-2.0
49 	int			*samples;  member
67  * osnoise_free_histogram - free runtime data
75 	for (cpu = 0; cpu < data->nr_cpus; cpu++) {  in osnoise_free_histogram()
76 		if (data->hist[cpu].samples)  in osnoise_free_histogram()
77 			free(data->hist[cpu].samples);  in osnoise_free_histogram()
81 	if (data->hist)  in osnoise_free_histogram()
82 		free(data->hist);  in osnoise_free_histogram()
88  * osnoise_alloc_histogram - alloc runtime data
100 	data->entries = entries;  in osnoise_alloc_histogram()
101 	data->bucket_size = bucket_size;  in osnoise_alloc_histogram()
102 	data->nr_cpus = nr_cpus;  in osnoise_alloc_histogram()
104 	data->hist = calloc(1, sizeof(*data->hist) * nr_cpus);  in osnoise_alloc_histogram()
105 	if (!data->hist)  in osnoise_alloc_histogram()
109 		data->hist[cpu].samples = calloc(1, sizeof(*data->hist->samples) * (entries + 1));  in osnoise_alloc_histogram()
110 		if (!data->hist[cpu].samples)  in osnoise_alloc_histogram()
116 		data->hist[cpu].min_sample = ~0;  in osnoise_alloc_histogram()
128 	struct osnoise_hist_params *params = tool->params;  in osnoise_hist_update_multiple()
129 	struct osnoise_hist_data *data = tool->data;  in osnoise_hist_update_multiple()
131 	int entries = data->entries;  in osnoise_hist_update_multiple()
135 	if (params->output_divisor)  in osnoise_hist_update_multiple()
136 		duration = duration / params->output_divisor;  in osnoise_hist_update_multiple()
138 	bucket = duration / data->bucket_size;  in osnoise_hist_update_multiple()
142 	hist = data->hist[cpu].samples;  in osnoise_hist_update_multiple()
143 	data->hist[cpu].count += count;  in osnoise_hist_update_multiple()
144 	update_min(&data->hist[cpu].min_sample, &duration);  in osnoise_hist_update_multiple()
145 	update_sum(&data->hist[cpu].sum_sample, &total_duration);  in osnoise_hist_update_multiple()
146 	update_max(&data->hist[cpu].max_sample, &duration);  in osnoise_hist_update_multiple()
155  * osnoise_destroy_trace_hist - disable events used to collect histogram
159 	struct osnoise_hist_data *data = tool->data;  in osnoise_destroy_trace_hist()
161 	tracefs_hist_pause(tool->trace.inst, data->trace_hist);  in osnoise_destroy_trace_hist()
162 	tracefs_hist_destroy(tool->trace.inst, data->trace_hist);  in osnoise_destroy_trace_hist()
166  * osnoise_init_trace_hist - enable events used to collect histogram
170 	struct osnoise_hist_params *params = tool->params;  in osnoise_init_trace_hist()
171 	struct osnoise_hist_data *data = tool->data;  in osnoise_init_trace_hist()
179 	bucket_size = params->output_divisor * params->bucket_size;  in osnoise_init_trace_hist()
182 	data->trace_hist = tracefs_hist_alloc(tool->trace.tep, "osnoise", "sample_threshold",  in osnoise_init_trace_hist()
184 	if (!data->trace_hist)  in osnoise_init_trace_hist()
187 	retval = tracefs_hist_add_key(data->trace_hist, "cpu", 0);  in osnoise_init_trace_hist()
191 	retval = tracefs_hist_start(tool->trace.inst, data->trace_hist);  in osnoise_init_trace_hist()
203  * osnoise_read_trace_hist - parse histogram file and file osnoise histogram
207 	struct osnoise_hist_data *data = tool->data;  in osnoise_read_trace_hist()
211 	tracefs_hist_pause(tool->trace.inst, data->trace_hist);  in osnoise_read_trace_hist()
213 	content = tracefs_event_file_read(tool->trace.inst, "osnoise",  in osnoise_read_trace_hist()
226 		if (duration == -1)  in osnoise_read_trace_hist()
234 		if (cpu == -1)  in osnoise_read_trace_hist()
242 		if (counter == -1)  in osnoise_read_trace_hist()
251  * osnoise_hist_header - print the header of the tracer to the output
255 	struct osnoise_hist_params *params = tool->params;  in osnoise_hist_header()
256 	struct osnoise_hist_data *data = tool->data;  in osnoise_hist_header()
257 	struct trace_seq *s = tool->trace.seq;  in osnoise_hist_header()
261 	if (params->no_header)  in osnoise_hist_header()
264 	get_duration(tool->start_time, duration, sizeof(duration));  in osnoise_hist_header()
267 			params->output_divisor == 1 ? "nanoseconds" : "microseconds",  in osnoise_hist_header()
268 			params->output_divisor == 1 ? "ns" : "us");  in osnoise_hist_header()
272 	if (!params->no_index)  in osnoise_hist_header()
275 	for (cpu = 0; cpu < data->nr_cpus; cpu++) {  in osnoise_hist_header()
276 		if (params->cpus && !CPU_ISSET(cpu, &params->monitored_cpus))  in osnoise_hist_header()
279 		if (!data->hist[cpu].count)  in osnoise_hist_header()
282 		trace_seq_printf(s, "   CPU-%03d", cpu);  in osnoise_hist_header()
291  * osnoise_print_summary - print the summary of the hist data to the output
300 	if (params->no_summary)  in osnoise_print_summary()
303 	if (!params->no_index)  in osnoise_print_summary()
304 		trace_seq_printf(trace->seq, "count:");  in osnoise_print_summary()
306 	for (cpu = 0; cpu < data->nr_cpus; cpu++) {  in osnoise_print_summary()
307 		if (params->cpus && !CPU_ISSET(cpu, &params->monitored_cpus))  in osnoise_print_summary()
310 		if (!data->hist[cpu].count)  in osnoise_print_summary()
313 		trace_seq_printf(trace->seq, "%9d ", data->hist[cpu].count);  in osnoise_print_summary()
315 	trace_seq_printf(trace->seq, "\n");  in osnoise_print_summary()
317 	if (!params->no_index)  in osnoise_print_summary()
318 		trace_seq_printf(trace->seq, "min:  ");  in osnoise_print_summary()
320 	for (cpu = 0; cpu < data->nr_cpus; cpu++) {  in osnoise_print_summary()
321 		if (params->cpus && !CPU_ISSET(cpu, &params->monitored_cpus))  in osnoise_print_summary()
324 		if (!data->hist[cpu].count)  in osnoise_print_summary()
327 		trace_seq_printf(trace->seq, "%9llu ",	data->hist[cpu].min_sample);  in osnoise_print_summary()
330 	trace_seq_printf(trace->seq, "\n");  in osnoise_print_summary()
332 	if (!params->no_index)  in osnoise_print_summary()
333 		trace_seq_printf(trace->seq, "avg:  ");  in osnoise_print_summary()
335 	for (cpu = 0; cpu < data->nr_cpus; cpu++) {  in osnoise_print_summary()
336 		if (params->cpus && !CPU_ISSET(cpu, &params->monitored_cpus))  in osnoise_print_summary()
339 		if (!data->hist[cpu].count)  in osnoise_print_summary()
342 		if (data->hist[cpu].count)  in osnoise_print_summary()
343 			trace_seq_printf(trace->seq, "%9.2f ",  in osnoise_print_summary()
344 				((double) data->hist[cpu].sum_sample) / data->hist[cpu].count);  in osnoise_print_summary()
346 			trace_seq_printf(trace->seq, "        - ");  in osnoise_print_summary()
348 	trace_seq_printf(trace->seq, "\n");  in osnoise_print_summary()
350 	if (!params->no_index)  in osnoise_print_summary()
351 		trace_seq_printf(trace->seq, "max:  ");  in osnoise_print_summary()
353 	for (cpu = 0; cpu < data->nr_cpus; cpu++) {  in osnoise_print_summary()
354 		if (params->cpus && !CPU_ISSET(cpu, &params->monitored_cpus))  in osnoise_print_summary()
357 		if (!data->hist[cpu].count)  in osnoise_print_summary()
360 		trace_seq_printf(trace->seq, "%9llu ", data->hist[cpu].max_sample);  in osnoise_print_summary()
363 	trace_seq_printf(trace->seq, "\n");  in osnoise_print_summary()
364 	trace_seq_do_printf(trace->seq);  in osnoise_print_summary()
365 	trace_seq_reset(trace->seq);  in osnoise_print_summary()
369  * osnoise_print_stats - print data for all CPUs
374 	struct osnoise_hist_data *data = tool->data;  in osnoise_print_stats()
375 	struct trace_instance *trace = &tool->trace;  in osnoise_print_stats()
381 	for (bucket = 0; bucket < data->entries; bucket++) {  in osnoise_print_stats()
384 		if (!params->no_index)  in osnoise_print_stats()
385 			trace_seq_printf(trace->seq, "%-6d",  in osnoise_print_stats()
386 					 bucket * data->bucket_size);  in osnoise_print_stats()
388 		for (cpu = 0; cpu < data->nr_cpus; cpu++) {  in osnoise_print_stats()
389 			if (params->cpus && !CPU_ISSET(cpu, &params->monitored_cpus))  in osnoise_print_stats()
392 			if (!data->hist[cpu].count)  in osnoise_print_stats()
395 			total += data->hist[cpu].samples[bucket];  in osnoise_print_stats()
396 			trace_seq_printf(trace->seq, "%9d ", data->hist[cpu].samples[bucket]);  in osnoise_print_stats()
399 		if (total == 0 && !params->with_zeros) {  in osnoise_print_stats()
400 			trace_seq_reset(trace->seq);  in osnoise_print_stats()
404 		trace_seq_printf(trace->seq, "\n");  in osnoise_print_stats()
405 		trace_seq_do_printf(trace->seq);  in osnoise_print_stats()
406 		trace_seq_reset(trace->seq);  in osnoise_print_stats()
409 	if (!params->no_index)  in osnoise_print_stats()
410 		trace_seq_printf(trace->seq, "over: ");  in osnoise_print_stats()
412 	for (cpu = 0; cpu < data->nr_cpus; cpu++) {  in osnoise_print_stats()
413 		if (params->cpus && !CPU_ISSET(cpu, &params->monitored_cpus))  in osnoise_print_stats()
416 		if (!data->hist[cpu].count)  in osnoise_print_stats()
419 		trace_seq_printf(trace->seq, "%9d ",  in osnoise_print_stats()
420 				 data->hist[cpu].samples[data->entries]);  in osnoise_print_stats()
422 	trace_seq_printf(trace->seq, "\n");  in osnoise_print_stats()
423 	trace_seq_do_printf(trace->seq);  in osnoise_print_stats()
424 	trace_seq_reset(trace->seq);  in osnoise_print_stats()
430  * osnoise_hist_usage - prints osnoise hist usage message
438 		"  usage: rtla osnoise hist [-h] [-D] [-d s] [-a us] [-p us] [-r us] [-s us] [-S us] \\",  in osnoise_hist_usage()
439 		"	  [-T us] [-t[=file]] [-e sys[:event]] [--filter <filter>] [--trigger <trigger>] \\",  in osnoise_hist_usage()
440 		"	  [-c cpu-list] [-H cpu-list] [-P priority] [-b N] [-E N] [--no-header] [--no-summary] \\",  in osnoise_hist_usage()
441 		"	  [--no-index] [--with-zeros] [-C[=cgroup_name]]",  in osnoise_hist_usage()
443 		"	  -h/--help: print this menu",  in osnoise_hist_usage()
444 		"	  -a/--auto: set automatic trace mode, stopping the session if argument in us sample is hit",  in osnoise_hist_usage()
445 		"	  -p/--period us: osnoise period in us",  in osnoise_hist_usage()
446 		"	  -r/--runtime us: osnoise runtime in us",  in osnoise_hist_usage()
447 		"	  -s/--stop us: stop trace if a single sample is higher than the argument in us",  in osnoise_hist_usage()
448 		"	  -S/--stop-total us: stop trace if the total sample is higher than the argument in us",  in osnoise_hist_usage()
449 		"	  -T/--threshold us: the minimum delta to be considered a noise",  in osnoise_hist_usage()
450 		"	  -c/--cpus cpu-list: list of cpus to run osnoise threads",  in osnoise_hist_usage()
451 		"	  -H/--house-keeping cpus: run rtla control threads only on the given cpus",  in osnoise_hist_usage()
452 …"	  -C/--cgroup[=cgroup_name]: set cgroup, if no cgroup_name is passed, the rtla's cgroup will be …  in osnoise_hist_usage()
453 		"	  -d/--duration time[s|m|h|d]: duration of the session",  in osnoise_hist_usage()
454 		"	  -D/--debug: print debug info",  in osnoise_hist_usage()
455 		"	  -t/--trace[=file]: save the stopped trace to [file|osnoise_trace.txt]",  in osnoise_hist_usage()
456 …"	  -e/--event <sys:event>: enable the <sys:event> in the trace instance, multiple -e are allowed",  in osnoise_hist_usage()
457 		"	     --filter <filter>: enable a trace event filter to the previous -e event",  in osnoise_hist_usage()
458 		"	     --trigger <trigger>: enable a trace event trigger to the previous -e event",  in osnoise_hist_usage()
459 		"	  -b/--bucket-size N: set the histogram bucket size (default 1)",  in osnoise_hist_usage()
460 		"	  -E/--entries N: set the number of entries of the histogram (default 256)",  in osnoise_hist_usage()
461 		"	     --no-header: do not print header",  in osnoise_hist_usage()
462 		"	     --no-summary: do not print summary",  in osnoise_hist_usage()
463 		"	     --no-index: do not print index",  in osnoise_hist_usage()
464 		"	     --with-zeros: print zero only entries",  in osnoise_hist_usage()
465 		"	  -P/--priority o:prio|r:prio|f:prio|d:runtime:period: set scheduling parameters",  in osnoise_hist_usage()
466 		"		o:prio - use SCHED_OTHER with prio",  in osnoise_hist_usage()
467 		"		r:prio - use SCHED_RR with prio",  in osnoise_hist_usage()
468 		"		f:prio - use SCHED_FIFO with prio",  in osnoise_hist_usage()
469 		"		d:runtime[us|ms|s]:period[us|ms|s] - use SCHED_DEADLINE with runtime and period",  in osnoise_hist_usage()
477 	fprintf(stderr, "rtla osnoise hist: a per-cpu histogram of the OS noise (version %s)\n",  in osnoise_hist_usage()
490  * osnoise_hist_parse_args - allocs, parse and fill the cmd line parameters
505 	params->output_divisor = 1000;  in osnoise_hist_parse_args()
506 	params->bucket_size = 1;  in osnoise_hist_parse_args()
507 	params->entries = 256;  in osnoise_hist_parse_args()
512 			{"bucket-size",		required_argument,	0, 'b'},  in osnoise_hist_parse_args()
518 			{"house-keeping",	required_argument,		0, 'H'},  in osnoise_hist_parse_args()
524 			{"stop-total",		required_argument,	0, 'S'},  in osnoise_hist_parse_args()
528 			{"no-header",		no_argument,		0, '0'},  in osnoise_hist_parse_args()
529 			{"no-summary",		no_argument,		0, '1'},  in osnoise_hist_parse_args()
530 			{"no-index",		no_argument,		0, '2'},  in osnoise_hist_parse_args()
531 			{"with-zeros",		no_argument,		0, '3'},  in osnoise_hist_parse_args()
544 		if (c == -1)  in osnoise_hist_parse_args()
550 			params->stop_us = get_llong_from_str(optarg);  in osnoise_hist_parse_args()
553 			params->threshold = 1;  in osnoise_hist_parse_args()
556 			params->trace_output = "osnoise_trace.txt";  in osnoise_hist_parse_args()
560 			params->bucket_size = get_llong_from_str(optarg);  in osnoise_hist_parse_args()
561 			if ((params->bucket_size == 0) || (params->bucket_size >= 1000000))  in osnoise_hist_parse_args()
565 			retval = parse_cpu_set(optarg, &params->monitored_cpus);  in osnoise_hist_parse_args()
567 				osnoise_hist_usage("\nInvalid -c cpu list\n");  in osnoise_hist_parse_args()
568 			params->cpus = optarg;  in osnoise_hist_parse_args()
571 			params->cgroup = 1;  in osnoise_hist_parse_args()
574 				params->cgroup_name = NULL;  in osnoise_hist_parse_args()
577 				params->cgroup_name = ++optarg;  in osnoise_hist_parse_args()
584 			params->duration = parse_seconds_duration(optarg);  in osnoise_hist_parse_args()
585 			if (!params->duration)  in osnoise_hist_parse_args()
586 				osnoise_hist_usage("Invalid -D duration\n");  in osnoise_hist_parse_args()
595 			if (params->events)  in osnoise_hist_parse_args()
596 				tevent->next = params->events;  in osnoise_hist_parse_args()
598 			params->events = tevent;  in osnoise_hist_parse_args()
601 			params->entries = get_llong_from_str(optarg);  in osnoise_hist_parse_args()
602 			if ((params->entries < 10) || (params->entries > 9999999))  in osnoise_hist_parse_args()
610 			params->hk_cpus = 1;  in osnoise_hist_parse_args()
611 			retval = parse_cpu_set(optarg, &params->hk_cpu_set);  in osnoise_hist_parse_args()
618 			params->period = get_llong_from_str(optarg);  in osnoise_hist_parse_args()
619 			if (params->period > 10000000)  in osnoise_hist_parse_args()
623 			retval = parse_prio(optarg, &params->sched_param);  in osnoise_hist_parse_args()
624 			if (retval == -1)  in osnoise_hist_parse_args()
625 				osnoise_hist_usage("Invalid -P priority");  in osnoise_hist_parse_args()
626 			params->set_sched = 1;  in osnoise_hist_parse_args()
629 			params->runtime = get_llong_from_str(optarg);  in osnoise_hist_parse_args()
630 			if (params->runtime < 100)  in osnoise_hist_parse_args()
634 			params->stop_us = get_llong_from_str(optarg);  in osnoise_hist_parse_args()
637 			params->stop_total_us = get_llong_from_str(optarg);  in osnoise_hist_parse_args()
640 			params->threshold = get_llong_from_str(optarg);  in osnoise_hist_parse_args()
645 				params->trace_output = &optarg[1];  in osnoise_hist_parse_args()
647 				params->trace_output = "osnoise_trace.txt";  in osnoise_hist_parse_args()
650 			params->no_header = 1;  in osnoise_hist_parse_args()
653 			params->no_summary = 1;  in osnoise_hist_parse_args()
656 			params->no_index = 1;  in osnoise_hist_parse_args()
659 			params->with_zeros = 1;  in osnoise_hist_parse_args()
662 			if (params->events) {  in osnoise_hist_parse_args()
663 				retval = trace_event_add_trigger(params->events, optarg);  in osnoise_hist_parse_args()
669 				osnoise_hist_usage("--trigger requires a previous -e\n");  in osnoise_hist_parse_args()
673 			if (params->events) {  in osnoise_hist_parse_args()
674 				retval = trace_event_add_filter(params->events, optarg);  in osnoise_hist_parse_args()
680 				osnoise_hist_usage("--filter requires a previous -e\n");  in osnoise_hist_parse_args()
693 	if (params->no_index && !params->with_zeros)  in osnoise_hist_parse_args()
694 		osnoise_hist_usage("no-index set and with-zeros not set - it does not make sense");  in osnoise_hist_parse_args()
700  * osnoise_hist_apply_config - apply the hist configs to the initialized tool
707 	if (!params->sleep_time)  in osnoise_hist_apply_config()
708 		params->sleep_time = 1;  in osnoise_hist_apply_config()
710 	if (params->cpus) {  in osnoise_hist_apply_config()
711 		retval = osnoise_set_cpus(tool->context, params->cpus);  in osnoise_hist_apply_config()
718 	if (params->runtime || params->period) {  in osnoise_hist_apply_config()
719 		retval = osnoise_set_runtime_period(tool->context,  in osnoise_hist_apply_config()
720 						    params->runtime,  in osnoise_hist_apply_config()
721 						    params->period);  in osnoise_hist_apply_config()
728 	if (params->stop_us) {  in osnoise_hist_apply_config()
729 		retval = osnoise_set_stop_us(tool->context, params->stop_us);  in osnoise_hist_apply_config()
736 	if (params->stop_total_us) {  in osnoise_hist_apply_config()
737 		retval = osnoise_set_stop_total_us(tool->context, params->stop_total_us);  in osnoise_hist_apply_config()
744 	if (params->threshold) {  in osnoise_hist_apply_config()
745 		retval = osnoise_set_tracing_thresh(tool->context, params->threshold);  in osnoise_hist_apply_config()
752 	if (params->hk_cpus) {  in osnoise_hist_apply_config()
753 		retval = sched_setaffinity(getpid(), sizeof(params->hk_cpu_set),  in osnoise_hist_apply_config()
754 					   &params->hk_cpu_set);  in osnoise_hist_apply_config()
755 		if (retval == -1) {  in osnoise_hist_apply_config()
759 	} else if (params->cpus) {  in osnoise_hist_apply_config()
761 		 * Even if the user do not set a house-keeping CPU, try to  in osnoise_hist_apply_config()
767 		auto_house_keeping(&params->monitored_cpus);  in osnoise_hist_apply_config()
773 	return -1;  in osnoise_hist_apply_config()
777  * osnoise_init_hist - initialize a osnoise hist tool with parameters
791 	tool->data = osnoise_alloc_histogram(nr_cpus, params->entries, params->bucket_size);  in osnoise_init_hist()
792 	if (!tool->data)  in osnoise_init_hist()
795 	tool->params = params;  in osnoise_init_hist()
811  * osnoise_hist_set_signals - handles the signal to stop the tool
817 	if (params->duration) {  in osnoise_hist_set_signals()
819 		alarm(params->duration);  in osnoise_hist_set_signals()
848 	trace = &tool->trace;  in osnoise_hist_main()
860 	if (params->set_sched) {  in osnoise_hist_main()
861 		retval = set_comm_sched_attr("osnoise/", &params->sched_param);  in osnoise_hist_main()
868 	if (params->cgroup) {  in osnoise_hist_main()
869 		retval = set_comm_cgroup("timerlat/", params->cgroup_name);  in osnoise_hist_main()
876 	if (params->trace_output) {  in osnoise_hist_main()
883 		if (params->events) {  in osnoise_hist_main()
884 			retval = trace_events_enable(&record->trace, params->events);  in osnoise_hist_main()
898 	if (params->trace_output)  in osnoise_hist_main()
899 		trace_instance_start(&record->trace);  in osnoise_hist_main()
902 	tool->start_time = time(NULL);  in osnoise_hist_main()
906 		sleep(params->sleep_time);  in osnoise_hist_main()
908 		retval = tracefs_iterate_raw_events(trace->tep,  in osnoise_hist_main()
909 						    trace->inst,  in osnoise_hist_main()
919 		if (trace_is_off(&tool->trace, &record->trace))  in osnoise_hist_main()
929 	if (trace_is_off(&tool->trace, &record->trace)) {  in osnoise_hist_main()
931 		if (params->trace_output) {  in osnoise_hist_main()
932 			printf("  Saving trace to %s\n", params->trace_output);  in osnoise_hist_main()
933 			save_trace_to_file(record->trace.inst, params->trace_output);  in osnoise_hist_main()
938 	trace_events_destroy(&record->trace, params->events);  in osnoise_hist_main()
939 	params->events = NULL;  in osnoise_hist_main()
941 	osnoise_free_histogram(tool->data);  in osnoise_hist_main()