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 22 struct 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 43 struct 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 */ 51 static void timerlat_free_top(struct timerlat_top_data *data) 52 { 53 free(data->cpu_data); 54 free(data); 55 } 56 57 static 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 */ 66 static 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 91 cleanup: 92 timerlat_free_top(data); 93 return NULL; 94 } 95 96 static void 97 timerlat_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 105 static void 106 timerlat_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 */ 130 static void 131 timerlat_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 */ 166 static int 167 timerlat_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 */ 190 static 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 */ 260 static 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 301 static const char *no_value = " -"; 302 303 /* 304 * timerlat_top_print - prints the output of a given CPU 305 */ 306 static 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 */ 364 static void 365 timerlat_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 */ 431 static 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 */ 440 static void 441 timerlat_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, ¶ms->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 */ 477 static void timerlat_top_usage(void) 478 { 479 static const char *const msg_start[] = { 480 "[-q] [-a us] [-d s] [-D] [-n] [-p us] [-i us] [-T us] [-s us] \\", 481 " [[-t [file]] [-e sys[:event]] [--filter <filter>] [--trigger <trigger>] [-c cpu-list] [-H cpu-list]\\", 482 " [-P priority] [--dma-latency us] [--aa-only us] [-C [cgroup_name]] [-u|-k] [--warm-up s] [--deepest-idle-state n]", 483 NULL, 484 }; 485 486 static const char *const msg_opts[] = { 487 " -a/--auto: set automatic trace mode, stopping the session if argument in us latency is hit", 488 " --aa-only us: stop if <us> latency is hit, only printing the auto analysis (reduces CPU usage)", 489 " -p/--period us: timerlat period in us", 490 " -i/--irq us: stop trace if the irq latency is higher than the argument in us", 491 " -T/--thread us: stop trace if the thread latency is higher than the argument in us", 492 " -s/--stack us: save the stack trace at the IRQ if a thread latency is higher than the argument in us", 493 " -c/--cpus cpus: run the tracer only on the given cpus", 494 " -H/--house-keeping cpus: run rtla control threads only on the given cpus", 495 " -C/--cgroup [cgroup_name]: set cgroup, if no cgroup_name is passed, the rtla's cgroup will be inherited", 496 " -d/--duration time[s|m|h|d]: duration of the session", 497 " -D/--debug: print debug info", 498 " --dump-tasks: prints the task running on all CPUs if stop conditions are met (depends on !--no-aa)", 499 " -t/--trace [file]: save the stopped trace to [file|timerlat_trace.txt]", 500 " -e/--event <sys:event>: enable the <sys:event> in the trace instance, multiple -e are allowed", 501 " --filter <command>: enable a trace event filter to the previous -e event", 502 " --trigger <command>: enable a trace event trigger to the previous -e event", 503 " -n/--nano: display data in nanoseconds", 504 " --no-aa: disable auto-analysis, reducing rtla timerlat cpu usage", 505 " -q/--quiet print only a summary at the end", 506 " --dma-latency us: set /dev/cpu_dma_latency latency <us> to reduce exit from idle latency", 507 " -P/--priority o:prio|r:prio|f:prio|d:runtime:period : set scheduling parameters", 508 " o:prio - use SCHED_OTHER with prio", 509 " r:prio - use SCHED_RR with prio", 510 " f:prio - use SCHED_FIFO with prio", 511 " d:runtime[us|ms|s]:period[us|ms|s] - use SCHED_DEADLINE with runtime and period", 512 " in nanoseconds", 513 " -u/--user-threads: use rtla user-space threads instead of kernel-space timerlat threads", 514 " -k/--kernel-threads: use timerlat kernel-space threads instead of rtla user-space threads", 515 " -U/--user-load: enable timerlat for user-defined user-space workload", 516 " --warm-up s: let the workload run for s seconds before collecting data", 517 " --trace-buffer-size kB: set the per-cpu trace buffer size in kB", 518 " --deepest-idle-state n: only go down to idle state n on cpus used by timerlat to reduce exit from idle latency", 519 " --on-threshold <action>: define action to be executed at latency threshold, multiple are allowed", 520 " --on-end: define action to be executed at measurement end, multiple are allowed", 521 " --bpf-action <program>: load and execute BPF program when latency threshold is exceeded", 522 NULL, 523 }; 524 525 common_usage("timerlat", "top", "a per-cpu summary of the timer latency", 526 msg_start, msg_opts); 527 } 528 529 /* 530 * timerlat_top_parse_args - allocs, parse and fill the cmd line parameters 531 */ 532 static struct common_params 533 *timerlat_top_parse_args(int argc, char **argv) 534 { 535 struct timerlat_params *params; 536 struct trace_events *tevent; 537 long long auto_thresh; 538 int retval; 539 int c; 540 char *trace_output = NULL; 541 542 params = calloc(1, sizeof(*params)); 543 if (!params) 544 exit(1); 545 546 actions_init(¶ms->common.threshold_actions); 547 actions_init(¶ms->common.end_actions); 548 549 /* disabled by default */ 550 params->dma_latency = -1; 551 552 /* disabled by default */ 553 params->deepest_idle_state = -2; 554 555 /* display data in microseconds */ 556 params->common.output_divisor = 1000; 557 558 /* default to BPF mode */ 559 params->mode = TRACING_MODE_BPF; 560 561 while (1) { 562 static struct option long_options[] = { 563 {"auto", required_argument, 0, 'a'}, 564 {"debug", no_argument, 0, 'D'}, 565 {"duration", required_argument, 0, 'd'}, 566 {"event", required_argument, 0, 'e'}, 567 {"help", no_argument, 0, 'h'}, 568 {"house-keeping", required_argument, 0, 'H'}, 569 {"irq", required_argument, 0, 'i'}, 570 {"nano", no_argument, 0, 'n'}, 571 {"period", required_argument, 0, 'p'}, 572 {"priority", required_argument, 0, 'P'}, 573 {"quiet", no_argument, 0, 'q'}, 574 {"stack", required_argument, 0, 's'}, 575 {"thread", required_argument, 0, 'T'}, 576 {"trace", optional_argument, 0, 't'}, 577 {"user-threads", no_argument, 0, 'u'}, 578 {"kernel-threads", no_argument, 0, 'k'}, 579 {"user-load", no_argument, 0, 'U'}, 580 {"trigger", required_argument, 0, '0'}, 581 {"filter", required_argument, 0, '1'}, 582 {"dma-latency", required_argument, 0, '2'}, 583 {"no-aa", no_argument, 0, '3'}, 584 {"dump-tasks", no_argument, 0, '4'}, 585 {"aa-only", required_argument, 0, '5'}, 586 {"warm-up", required_argument, 0, '6'}, 587 {"trace-buffer-size", required_argument, 0, '7'}, 588 {"deepest-idle-state", required_argument, 0, '8'}, 589 {"on-threshold", required_argument, 0, '9'}, 590 {"on-end", required_argument, 0, '\1'}, 591 {"bpf-action", required_argument, 0, '\2'}, 592 {0, 0, 0, 0} 593 }; 594 595 if (common_parse_options(argc, argv, ¶ms->common)) 596 continue; 597 598 c = getopt_long(argc, argv, "a:d:De:hH:i:knp:P:qs:t::T:uU0:1:2:345:6:7:", 599 long_options, NULL); 600 601 /* detect the end of the options. */ 602 if (c == -1) 603 break; 604 605 switch (c) { 606 case 'a': 607 auto_thresh = get_llong_from_str(optarg); 608 609 /* set thread stop to auto_thresh */ 610 params->common.stop_total_us = auto_thresh; 611 params->common.stop_us = auto_thresh; 612 613 /* get stack trace */ 614 params->print_stack = auto_thresh; 615 616 /* set trace */ 617 if (!trace_output) 618 trace_output = "timerlat_trace.txt"; 619 620 break; 621 case '5': 622 /* it is here because it is similar to -a */ 623 auto_thresh = get_llong_from_str(optarg); 624 625 /* set thread stop to auto_thresh */ 626 params->common.stop_total_us = auto_thresh; 627 params->common.stop_us = auto_thresh; 628 629 /* get stack trace */ 630 params->print_stack = auto_thresh; 631 632 /* set aa_only to avoid parsing the trace */ 633 params->common.aa_only = 1; 634 break; 635 case 'D': 636 config_debug = 1; 637 break; 638 case 'd': 639 params->common.duration = parse_seconds_duration(optarg); 640 if (!params->common.duration) 641 fatal("Invalid -d duration"); 642 break; 643 case 'e': 644 tevent = trace_event_alloc(optarg); 645 if (!tevent) 646 fatal("Error alloc trace event"); 647 648 if (params->common.events) 649 tevent->next = params->common.events; 650 params->common.events = tevent; 651 break; 652 case 'h': 653 case '?': 654 timerlat_top_usage(); 655 break; 656 case 'H': 657 params->common.hk_cpus = 1; 658 retval = parse_cpu_set(optarg, ¶ms->common.hk_cpu_set); 659 if (retval) 660 fatal("Error parsing house keeping CPUs"); 661 break; 662 case 'i': 663 params->common.stop_us = get_llong_from_str(optarg); 664 break; 665 case 'k': 666 params->common.kernel_workload = true; 667 break; 668 case 'n': 669 params->common.output_divisor = 1; 670 break; 671 case 'p': 672 params->timerlat_period_us = get_llong_from_str(optarg); 673 if (params->timerlat_period_us > 1000000) 674 fatal("Period longer than 1 s"); 675 break; 676 case 'P': 677 retval = parse_prio(optarg, ¶ms->common.sched_param); 678 if (retval == -1) 679 fatal("Invalid -P priority"); 680 params->common.set_sched = 1; 681 break; 682 case 'q': 683 params->common.quiet = 1; 684 break; 685 case 's': 686 params->print_stack = get_llong_from_str(optarg); 687 break; 688 case 'T': 689 params->common.stop_total_us = get_llong_from_str(optarg); 690 break; 691 case 't': 692 trace_output = parse_optional_arg(argc, argv); 693 if (!trace_output) 694 trace_output = "timerlat_trace.txt"; 695 break; 696 case 'u': 697 params->common.user_workload = true; 698 /* fallback: -u implies -U */ 699 case 'U': 700 params->common.user_data = true; 701 break; 702 case '0': /* trigger */ 703 if (params->common.events) { 704 retval = trace_event_add_trigger(params->common.events, optarg); 705 if (retval) 706 fatal("Error adding trigger %s", optarg); 707 } else { 708 fatal("--trigger requires a previous -e"); 709 } 710 break; 711 case '1': /* filter */ 712 if (params->common.events) { 713 retval = trace_event_add_filter(params->common.events, optarg); 714 if (retval) 715 fatal("Error adding filter %s", optarg); 716 } else { 717 fatal("--filter requires a previous -e"); 718 } 719 break; 720 case '2': /* dma-latency */ 721 params->dma_latency = get_llong_from_str(optarg); 722 if (params->dma_latency < 0 || params->dma_latency > 10000) 723 fatal("--dma-latency needs to be >= 0 and < 10000"); 724 break; 725 case '3': /* no-aa */ 726 params->no_aa = 1; 727 break; 728 case '4': 729 params->dump_tasks = 1; 730 break; 731 case '6': 732 params->common.warmup = get_llong_from_str(optarg); 733 break; 734 case '7': 735 params->common.buffer_size = get_llong_from_str(optarg); 736 break; 737 case '8': 738 params->deepest_idle_state = get_llong_from_str(optarg); 739 break; 740 case '9': 741 retval = actions_parse(¶ms->common.threshold_actions, optarg, 742 "timerlat_trace.txt"); 743 if (retval) 744 fatal("Invalid action %s", optarg); 745 break; 746 case '\1': 747 retval = actions_parse(¶ms->common.end_actions, optarg, 748 "timerlat_trace.txt"); 749 if (retval) 750 fatal("Invalid action %s", optarg); 751 break; 752 case '\2': 753 params->bpf_action_program = optarg; 754 break; 755 default: 756 fatal("Invalid option"); 757 } 758 } 759 760 if (trace_output) 761 actions_add_trace_output(¶ms->common.threshold_actions, trace_output); 762 763 if (geteuid()) 764 fatal("rtla needs root permission"); 765 766 /* 767 * Auto analysis only happens if stop tracing, thus: 768 */ 769 if (!params->common.stop_us && !params->common.stop_total_us) 770 params->no_aa = 1; 771 772 if (params->no_aa && params->common.aa_only) 773 fatal("--no-aa and --aa-only are mutually exclusive!"); 774 775 if (params->common.kernel_workload && params->common.user_workload) 776 fatal("--kernel-threads and --user-threads are mutually exclusive!"); 777 778 /* 779 * If auto-analysis or trace output is enabled, switch from BPF mode to 780 * mixed mode 781 */ 782 if (params->mode == TRACING_MODE_BPF && 783 (params->common.threshold_actions.present[ACTION_TRACE_OUTPUT] || 784 params->common.end_actions.present[ACTION_TRACE_OUTPUT] || 785 !params->no_aa)) 786 params->mode = TRACING_MODE_MIXED; 787 788 return ¶ms->common; 789 } 790 791 /* 792 * timerlat_top_apply_config - apply the top configs to the initialized tool 793 */ 794 static int 795 timerlat_top_apply_config(struct osnoise_tool *top) 796 { 797 struct timerlat_params *params = to_timerlat_params(top->params); 798 int retval; 799 800 retval = timerlat_apply_config(top, params); 801 if (retval) 802 goto out_err; 803 804 if (isatty(STDOUT_FILENO) && !params->common.quiet) 805 params->common.pretty_output = 1; 806 807 return 0; 808 809 out_err: 810 return -1; 811 } 812 813 /* 814 * timerlat_init_top - initialize a timerlat top tool with parameters 815 */ 816 static struct osnoise_tool 817 *timerlat_init_top(struct common_params *params) 818 { 819 struct osnoise_tool *top; 820 int nr_cpus; 821 822 nr_cpus = sysconf(_SC_NPROCESSORS_CONF); 823 824 top = osnoise_init_tool("timerlat_top"); 825 if (!top) 826 return NULL; 827 828 top->data = timerlat_alloc_top(nr_cpus); 829 if (!top->data) 830 goto out_err; 831 832 tep_register_event_handler(top->trace.tep, -1, "ftrace", "timerlat", 833 timerlat_top_handler, top); 834 835 return top; 836 837 out_err: 838 osnoise_destroy_tool(top); 839 return NULL; 840 } 841 842 /* 843 * timerlat_top_bpf_main_loop - main loop to process events (BPF variant) 844 */ 845 static int 846 timerlat_top_bpf_main_loop(struct osnoise_tool *tool) 847 { 848 struct timerlat_params *params = to_timerlat_params(tool->params); 849 int retval, wait_retval; 850 851 if (params->common.aa_only) { 852 /* Auto-analysis only, just wait for stop tracing */ 853 timerlat_bpf_wait(-1); 854 return 0; 855 } 856 857 /* Pull and display data in a loop */ 858 while (!stop_tracing) { 859 wait_retval = timerlat_bpf_wait(params->common.quiet ? -1 : 860 params->common.sleep_time); 861 862 retval = timerlat_top_bpf_pull_data(tool); 863 if (retval) { 864 err_msg("Error pulling BPF data\n"); 865 return retval; 866 } 867 868 if (!params->common.quiet) 869 timerlat_print_stats(tool); 870 871 if (wait_retval != 0) { 872 /* Stopping requested by tracer */ 873 actions_perform(¶ms->common.threshold_actions); 874 875 if (!params->common.threshold_actions.continue_flag) 876 /* continue flag not set, break */ 877 break; 878 879 /* continue action reached, re-enable tracing */ 880 if (tool->record) 881 trace_instance_start(&tool->record->trace); 882 if (tool->aa) 883 trace_instance_start(&tool->aa->trace); 884 timerlat_bpf_restart_tracing(); 885 } 886 887 /* is there still any user-threads ? */ 888 if (params->common.user_workload) { 889 if (params->common.user.stopped_running) { 890 debug_msg("timerlat user space threads stopped!\n"); 891 break; 892 } 893 } 894 } 895 896 return 0; 897 } 898 899 static int timerlat_top_main_loop(struct osnoise_tool *tool) 900 { 901 struct timerlat_params *params = to_timerlat_params(tool->params); 902 int retval; 903 904 if (params->mode == TRACING_MODE_TRACEFS) { 905 retval = top_main_loop(tool); 906 } else { 907 retval = timerlat_top_bpf_main_loop(tool); 908 timerlat_bpf_detach(); 909 } 910 911 return retval; 912 } 913 914 struct tool_ops timerlat_top_ops = { 915 .tracer = "timerlat", 916 .comm_prefix = "timerlat/", 917 .parse_args = timerlat_top_parse_args, 918 .init_tool = timerlat_init_top, 919 .apply_config = timerlat_top_apply_config, 920 .enable = timerlat_enable, 921 .main = timerlat_top_main_loop, 922 .print_stats = timerlat_print_stats, 923 .analyze = timerlat_analyze, 924 .free = timerlat_free_top_tool, 925 }; 926