Debian Codegraph @

tools/tracing/rtla/src/osnoise_top.c

raw
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3 * Copyright (C) 2021 Red Hat Inc, Daniel Bristot de Oliveira <[email protected]>
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
15 #include "osnoise.h"
16
17 struct osnoise_top_cpu {
18 unsigned long long sum_runtime;
19 unsigned long long sum_noise;
20 unsigned long long max_noise;
21 unsigned long long max_sample;
22
23 unsigned long long hw_count;
24 unsigned long long nmi_count;
25 unsigned long long irq_count;
26 unsigned long long softirq_count;
27 unsigned long long thread_count;
28
29 int sum_cycles;
30 };
31
32 struct osnoise_top_data {
33 struct osnoise_top_cpu *cpu_data;
34 int nr_cpus;
35 };
36
37 /*
38 * osnoise_free_top - free runtime data
39 */
40 static void osnoise_free_top(struct osnoise_top_data *data)
41 {
42 free(data->cpu_data);
43 free(data);
44 }
45
46 static void osnoise_free_top_tool(struct osnoise_tool *tool)
47 {
48 osnoise_free_top(tool->data);
49 }
50
51 /*
52 * osnoise_alloc_histogram - alloc runtime data
53 */
54 static struct osnoise_top_data *osnoise_alloc_top(int nr_cpus)
55 {
56 struct osnoise_top_data *data;
57
58 data = calloc(1, sizeof(*data));
59 if (!data)
60 return NULL;
61
62 data->nr_cpus = nr_cpus;
63
64 /* one set of histograms per CPU */
65 data->cpu_data = calloc(1, sizeof(*data->cpu_data) * nr_cpus);
66 if (!data->cpu_data)
67 goto cleanup;
68
69 return data;
70
71 cleanup:
72 osnoise_free_top(data);
73 return NULL;
74 }
75
76 /*
77 * osnoise_top_handler - this is the handler for osnoise tracer events
78 */
79 static int
80 osnoise_top_handler(struct trace_seq *s, struct tep_record *record,
81 struct tep_event *event, void *context)
82 {
83 struct trace_instance *trace = context;
84 struct osnoise_tool *tool;
85 unsigned long long val;
86 struct osnoise_top_cpu *cpu_data;
87 struct osnoise_top_data *data;
88 int cpu = record->cpu;
89
90 tool = container_of(trace, struct osnoise_tool, trace);
91
92 data = tool->data;
93 cpu_data = &data->cpu_data[cpu];
94
95 cpu_data->sum_cycles++;
96
97 tep_get_field_val(s, event, "runtime", record, &val, 1);
98 update_sum(&cpu_data->sum_runtime, &val);
99
100 tep_get_field_val(s, event, "noise", record, &val, 1);
101 update_max(&cpu_data->max_noise, &val);
102 update_sum(&cpu_data->sum_noise, &val);
103
104 tep_get_field_val(s, event, "max_sample", record, &val, 1);
105 update_max(&cpu_data->max_sample, &val);
106
107 tep_get_field_val(s, event, "hw_count", record, &val, 1);
108 update_sum(&cpu_data->hw_count, &val);
109
110 tep_get_field_val(s, event, "nmi_count", record, &val, 1);
111 update_sum(&cpu_data->nmi_count, &val);
112
113 tep_get_field_val(s, event, "irq_count", record, &val, 1);
114 update_sum(&cpu_data->irq_count, &val);
115
116 tep_get_field_val(s, event, "softirq_count", record, &val, 1);
117 update_sum(&cpu_data->softirq_count, &val);
118
119 tep_get_field_val(s, event, "thread_count", record, &val, 1);
120 update_sum(&cpu_data->thread_count, &val);
121
122 return 0;
123 }
124
125 /*
126 * osnoise_top_header - print the header of the tool output
127 */
128 static void osnoise_top_header(struct osnoise_tool *top)
129 {
130 struct osnoise_params *params = to_osnoise_params(top->params);
131 struct trace_seq *s = top->trace.seq;
132 bool pretty = params->common.pretty_output;
133 char duration[26];
134
135 get_duration(top->start_time, duration, sizeof(duration));
136
137 if (pretty)
138 trace_seq_printf(s, "\033[2;37;40m");
139
140 trace_seq_printf(s, " ");
141
142 if (params->mode == MODE_OSNOISE) {
143 trace_seq_printf(s, "Operating System Noise");
144 trace_seq_printf(s, " ");
145 } else if (params->mode == MODE_HWNOISE) {
146 trace_seq_printf(s, "Hardware-related Noise");
147 }
148
149 trace_seq_printf(s, " ");
150
151 if (pretty)
152 trace_seq_printf(s, "\033[0;0;0m");
153 trace_seq_printf(s, "\n");
154
155 trace_seq_printf(s, "duration: %9s | time is in us\n", duration);
156
157 if (pretty)
158 trace_seq_printf(s, "\033[2;30;47m");
159
160 trace_seq_printf(s, "CPU Period Runtime ");
161 trace_seq_printf(s, " Noise ");
162 trace_seq_printf(s, " %% CPU Aval ");
163 trace_seq_printf(s, " Max Noise Max Single ");
164 trace_seq_printf(s, " HW NMI");
165
166 if (params->mode == MODE_HWNOISE)
167 goto eol;
168
169 trace_seq_printf(s, " IRQ Softirq Thread");
170
171 eol:
172 if (pretty)
173 trace_seq_printf(s, "\033[0;0;0m");
174 trace_seq_printf(s, "\n");
175 }
176
177 /*
178 * clear_terminal - clears the output terminal
179 */
180 static void clear_terminal(struct trace_seq *seq)
181 {
182 if (!config_debug)
183 trace_seq_printf(seq, "\033c");
184 }
185
186 /*
187 * osnoise_top_print - prints the output of a given CPU
188 */
189 static void osnoise_top_print(struct osnoise_tool *tool, int cpu)
190 {
191 struct osnoise_params *params = to_osnoise_params(tool->params);
192 struct trace_seq *s = tool->trace.seq;
193 struct osnoise_top_cpu *cpu_data;
194 struct osnoise_top_data *data;
195 int percentage;
196 int decimal;
197
198 data = tool->data;
199 cpu_data = &data->cpu_data[cpu];
200
201 if (!cpu_data->sum_runtime)
202 return;
203
204 percentage = ((cpu_data->sum_runtime - cpu_data->sum_noise) * 10000000)
205 / cpu_data->sum_runtime;
206 decimal = percentage % 100000;
207 percentage = percentage / 100000;
208
209 trace_seq_printf(s, "%3d #%-6d %12llu ", cpu, cpu_data->sum_cycles, cpu_data->sum_runtime);
210 trace_seq_printf(s, "%12llu ", cpu_data->sum_noise);
211 trace_seq_printf(s, " %3d.%05d", percentage, decimal);
212 trace_seq_printf(s, "%12llu %12llu", cpu_data->max_noise, cpu_data->max_sample);
213
214 trace_seq_printf(s, "%12llu ", cpu_data->hw_count);
215 trace_seq_printf(s, "%12llu ", cpu_data->nmi_count);
216
217 if (params->mode == MODE_HWNOISE) {
218 trace_seq_printf(s, "\n");
219 return;
220 }
221
222 trace_seq_printf(s, "%12llu ", cpu_data->irq_count);
223 trace_seq_printf(s, "%12llu ", cpu_data->softirq_count);
224 trace_seq_printf(s, "%12llu\n", cpu_data->thread_count);
225 }
226
227 /*
228 * osnoise_print_stats - print data for all cpus
229 */
230 static void
231 osnoise_print_stats(struct osnoise_tool *top)
232 {
233 struct osnoise_params *params = to_osnoise_params(top->params);
234 struct trace_instance *trace = &top->trace;
235 static int nr_cpus = -1;
236 int i;
237
238 if (nr_cpus == -1)
239 nr_cpus = sysconf(_SC_NPROCESSORS_CONF);
240
241 if (!params->common.quiet)
242 clear_terminal(trace->seq);
243
244 osnoise_top_header(top);
245
246 for_each_monitored_cpu(i, nr_cpus, &params->common) {
247 osnoise_top_print(top, i);
248 }
249
250 trace_seq_do_printf(trace->seq);
251 trace_seq_reset(trace->seq);
252 osnoise_report_missed_events(top);
253 }
254
255 /*
256 * osnoise_top_usage - prints osnoise top usage message
257 */
258 static void osnoise_top_usage(struct osnoise_params *params)
259 {
260 const char *tool, *mode, *desc;
261
262 static const char * const msg_start[] = {
263 "[-q] [-D] [-d s] [-a us] [-p us] [-r us] [-s us] [-S us] \\",
264 " [-T us] [-t [file]] [-e sys[:event]] [--filter <filter>] [--trigger <trigger>] \\",
265 " [-c cpu-list] [-H cpu-list] [-P priority] [-C [cgroup_name]] [--warm-up s]",
266 NULL,
267 };
268
269 static const char * const msg_opts[] = {
270 " -a/--auto: set automatic trace mode, stopping the session if argument in us sample is hit",
271 " -p/--period us: osnoise period in us",
272 " -r/--runtime us: osnoise runtime in us",
273 " -s/--stop us: stop trace if a single sample is higher than the argument in us",
274 " -S/--stop-total us: stop trace if the total sample is higher than the argument in us",
275 " -T/--threshold us: the minimum delta to be considered a noise",
276 " -c/--cpus cpu-list: list of cpus to run osnoise threads",
277 " -H/--house-keeping cpus: run rtla control threads only on the given cpus",
278 " -C/--cgroup [cgroup_name]: set cgroup, if no cgroup_name is passed, the rtla's cgroup will be inherited",
279 " -d/--duration time[s|m|h|d]: duration of the session",
280 " -D/--debug: print debug info",
281 " -t/--trace [file]: save the stopped trace to [file|osnoise_trace.txt]",
282 " -e/--event <sys:event>: enable the <sys:event> in the trace instance, multiple -e are allowed",
283 " --filter <filter>: enable a trace event filter to the previous -e event",
284 " --trigger <trigger>: enable a trace event trigger to the previous -e event",
285 " -q/--quiet print only a summary at the end",
286 " -P/--priority o:prio|r:prio|f:prio|d:runtime:period : set scheduling parameters",
287 " o:prio - use SCHED_OTHER with prio",
288 " r:prio - use SCHED_RR with prio",
289 " f:prio - use SCHED_FIFO with prio",
290 " d:runtime[us|ms|s]:period[us|ms|s] - use SCHED_DEADLINE with runtime and period",
291 " in nanoseconds",
292 " --warm-up s: let the workload run for s seconds before collecting data",
293 " --trace-buffer-size kB: set the per-cpu trace buffer size in kB",
294 " --on-threshold <action>: define action to be executed at stop-total threshold, multiple are allowed",
295 " --on-end: define action to be executed at measurement end, multiple are allowed",
296 NULL,
297 };
298
299 if (params->mode == MODE_OSNOISE) {
300 tool = "osnoise";
301 mode = "top";
302 desc = "a per-cpu summary of the OS noise";
303 } else {
304 tool = "hwnoise";
305 mode = "";
306 desc = "a summary of hardware-related noise";
307 }
308
309 common_usage(tool, mode, desc, msg_start, msg_opts);
310 }
311
312 /*
313 * osnoise_top_parse_args - allocs, parse and fill the cmd line parameters
314 */
315 struct common_params *osnoise_top_parse_args(int argc, char **argv)
316 {
317 struct osnoise_params *params;
318 int retval;
319 int c;
320 char *trace_output = NULL;
321
322 params = calloc(1, sizeof(*params));
323 if (!params)
324 exit(1);
325
326 actions_init(&params->common.threshold_actions);
327 actions_init(&params->common.end_actions);
328
329 if (strcmp(argv[0], "hwnoise") == 0) {
330 params->mode = MODE_HWNOISE;
331 /*
332 * Reduce CPU usage for 75% to avoid killing the system.
333 */
334 params->runtime = 750000;
335 params->period = 1000000;
336 }
337
338 while (1) {
339 static struct option long_options[] = {
340 {"auto", required_argument, 0, 'a'},
341 {"help", no_argument, 0, 'h'},
342 {"period", required_argument, 0, 'p'},
343 {"quiet", no_argument, 0, 'q'},
344 {"runtime", required_argument, 0, 'r'},
345 {"stop", required_argument, 0, 's'},
346 {"stop-total", required_argument, 0, 'S'},
347 {"threshold", required_argument, 0, 'T'},
348 {"trace", optional_argument, 0, 't'},
349 {"trigger", required_argument, 0, '0'},
350 {"filter", required_argument, 0, '1'},
351 {"warm-up", required_argument, 0, '2'},
352 {"trace-buffer-size", required_argument, 0, '3'},
353 {"on-threshold", required_argument, 0, '4'},
354 {"on-end", required_argument, 0, '5'},
355 {0, 0, 0, 0}
356 };
357
358 if (common_parse_options(argc, argv, &params->common))
359 continue;
360
361 c = getopt_auto(argc, argv, long_options);
362
363 /* Detect the end of the options. */
364 if (c == -1)
365 break;
366
367 switch (c) {
368 case 'a':
369 /* set sample stop to auto_thresh */
370 params->common.stop_us = get_llong_from_str(optarg);
371
372 /* set sample threshold to 1 */
373 params->threshold = 1;
374
375 /* set trace */
376 if (!trace_output)
377 trace_output = "osnoise_trace.txt";
378
379 break;
380 case 'h':
381 case '?':
382 osnoise_top_usage(params);
383 break;
384 case 'p':
385 params->period = get_llong_from_str(optarg);
386 if (params->period > 10000000)
387 fatal("Period longer than 10 s");
388 break;
389 case 'q':
390 params->common.quiet = 1;
391 break;
392 case 'r':
393 params->runtime = get_llong_from_str(optarg);
394 if (params->runtime < 100)
395 fatal("Runtime shorter than 100 us");
396 break;
397 case 's':
398 params->common.stop_us = get_llong_from_str(optarg);
399 break;
400 case 'S':
401 params->common.stop_total_us = get_llong_from_str(optarg);
402 break;
403 case 't':
404 trace_output = parse_optional_arg(argc, argv);
405 if (!trace_output)
406 trace_output = "osnoise_trace.txt";
407 break;
408 case 'T':
409 params->threshold = get_llong_from_str(optarg);
410 break;
411 case '0': /* trigger */
412 if (params->common.events) {
413 retval = trace_event_add_trigger(params->common.events, optarg);
414 if (retval)
415 fatal("Error adding trigger %s", optarg);
416 } else {
417 fatal("--trigger requires a previous -e");
418 }
419 break;
420 case '1': /* filter */
421 if (params->common.events) {
422 retval = trace_event_add_filter(params->common.events, optarg);
423 if (retval)
424 fatal("Error adding filter %s", optarg);
425 } else {
426 fatal("--filter requires a previous -e");
427 }
428 break;
429 case '2':
430 params->common.warmup = get_llong_from_str(optarg);
431 break;
432 case '3':
433 params->common.buffer_size = get_llong_from_str(optarg);
434 break;
435 case '4':
436 retval = actions_parse(&params->common.threshold_actions, optarg,
437 "osnoise_trace.txt");
438 if (retval)
439 fatal("Invalid action %s", optarg);
440 break;
441 case '5':
442 retval = actions_parse(&params->common.end_actions, optarg,
443 "osnoise_trace.txt");
444 if (retval)
445 fatal("Invalid action %s", optarg);
446 break;
447 default:
448 fatal("Invalid option");
449 }
450 }
451
452 if (trace_output)
453 actions_add_trace_output(&params->common.threshold_actions, trace_output);
454
455 if (geteuid())
456 fatal("osnoise needs root permission");
457
458 return &params->common;
459 }
460
461 /*
462 * osnoise_top_apply_config - apply the top configs to the initialized tool
463 */
464 static int
465 osnoise_top_apply_config(struct osnoise_tool *tool)
466 {
467 struct osnoise_params *params = to_osnoise_params(tool->params);
468 int retval;
469
470 retval = osnoise_apply_config(tool, params);
471 if (retval)
472 goto out_err;
473
474 if (params->mode == MODE_HWNOISE) {
475 retval = osnoise_set_irq_disable(tool->context, 1);
476 if (retval) {
477 err_msg("Failed to set OSNOISE_IRQ_DISABLE option\n");
478 goto out_err;
479 }
480 }
481
482 if (isatty(STDOUT_FILENO) && !params->common.quiet)
483 params->common.pretty_output = 1;
484
485 return 0;
486
487 out_err:
488 return -1;
489 }
490
491 /*
492 * osnoise_init_top - initialize a osnoise top tool with parameters
493 */
494 struct osnoise_tool *osnoise_init_top(struct common_params *params)
495 {
496 struct osnoise_tool *tool;
497 int nr_cpus;
498
499 nr_cpus = sysconf(_SC_NPROCESSORS_CONF);
500
501 tool = osnoise_init_tool("osnoise_top");
502 if (!tool)
503 return NULL;
504
505 tool->data = osnoise_alloc_top(nr_cpus);
506 if (!tool->data) {
507 osnoise_destroy_tool(tool);
508 return NULL;
509 }
510
511 tep_register_event_handler(tool->trace.tep, -1, "ftrace", "osnoise",
512 osnoise_top_handler, NULL);
513
514 return tool;
515 }
516
517 struct tool_ops osnoise_top_ops = {
518 .tracer = "osnoise",
519 .comm_prefix = "osnoise/",
520 .parse_args = osnoise_top_parse_args,
521 .init_tool = osnoise_init_top,
522 .apply_config = osnoise_top_apply_config,
523 .enable = osnoise_enable,
524 .main = top_main_loop,
525 .print_stats = osnoise_print_stats,
526 .free = osnoise_free_top_tool,
527 };