kernel/trace/trace_hwlat.c

   1 /*
   2  * trace_hwlatdetect.c - A simple Hardware Latency detector.
   3  *
   4  * Use this tracer to detect large system latencies induced by the behavior of
   5  * certain underlying system hardware or firmware, independent of Linux itself.
   6  * The code was developed originally to detect the presence of SMIs on Intel
   7  * and AMD systems, although there is no dependency upon x86 herein.
   8  *
   9  * The classical example usage of this tracer is in detecting the presence of
  10  * SMIs or System Management Interrupts on Intel and AMD systems. An SMI is a
  11  * somewhat special form of hardware interrupt spawned from earlier CPU debug
  12  * modes in which the (BIOS/EFI/etc.) firmware arranges for the South Bridge
  13  * LPC (or other device) to generate a special interrupt under certain
  14  * circumstances, for example, upon expiration of a special SMI timer device,
  15  * due to certain external thermal readings, on certain I/O address accesses,
  16  * and other situations. An SMI hits a special CPU pin, triggers a special
  17  * SMI mode (complete with special memory map), and the OS is unaware.
  18  *
  19  * Although certain hardware-inducing latencies are necessary (for example,
  20  * a modern system often requires an SMI handler for correct thermal control
  21  * and remote management) they can wreak havoc upon any OS-level performance
  22  * guarantees toward low-latency, especially when the OS is not even made
  23  * aware of the presence of these interrupts. For this reason, we need a
  24  * somewhat brute force mechanism to detect these interrupts. In this case,
  25  * we do it by hogging all of the CPU(s) for configurable timer intervals,
  26  * sampling the built-in CPU timer, looking for discontiguous readings.
  27  *
  28  * WARNING: This implementation necessarily introduces latencies. Therefore,
  29  *          you should NEVER use this tracer while running in a production
  30  *          environment requiring any kind of low-latency performance
  31  *          guarantee(s).
  32  *
  33  * Copyright (C) 2008-2009 Jon Masters, Red Hat, Inc. <jcm@redhat.com>
  34  * Copyright (C) 2013-2016 Steven Rostedt, Red Hat, Inc. <srostedt@redhat.com>
  35  *
  36  * Includes useful feedback from Clark Williams <clark@redhat.com>
  37  *
  38  * This file is licensed under the terms of the GNU General Public
  39  * License version 2. This program is licensed "as is" without any
  40  * warranty of any kind, whether express or implied.
  41  */
  42 #include <linux/kthread.h>
  43 #include <linux/tracefs.h>
  44 #include <linux/uaccess.h>
  45 #include <linux/cpumask.h>
  46 #include <linux/delay.h>
  47 #include <linux/sched/clock.h>
  48 #include "trace.h"
  49
  50 static struct trace_array       *hwlat_trace;
  51
  52 #define U64STR_SIZE             22                      /* 20 digits max */
  53
  54 #define BANNER                  "hwlat_detector: "
  55 #define DEFAULT_SAMPLE_WINDOW   1000000                 /* 1s */
  56 #define DEFAULT_SAMPLE_WIDTH    500000                  /* 0.5s */
  57 #define DEFAULT_LAT_THRESHOLD   10                      /* 10us */
  58
  59 /* sampling thread*/
  60 static struct task_struct *hwlat_kthread;
  61
  62 static struct dentry *hwlat_sample_width;       /* sample width us */
  63 static struct dentry *hwlat_sample_window;      /* sample window us */
  64
  65 /* Save the previous tracing_thresh value */
  66 static unsigned long save_tracing_thresh;
  67
  68 /* NMI timestamp counters */
  69 static u64 nmi_ts_start;
  70 static u64 nmi_total_ts;
  71 static int nmi_count;
  72 static int nmi_cpu;
  73
  74 /* Tells NMIs to call back to the hwlat tracer to record timestamps */
  75 bool trace_hwlat_callback_enabled;
  76
  77 /* If the user changed threshold, remember it */
  78 static u64 last_tracing_thresh = DEFAULT_LAT_THRESHOLD * NSEC_PER_USEC;
  79
  80 /* Individual latency samples are stored here when detected. */
  81 struct hwlat_sample {
  82         u64                     seqnum;         /* unique sequence */
  83         u64                     duration;       /* delta */
  84         u64                     outer_duration; /* delta (outer loop) */
  85         u64                     nmi_total_ts;   /* Total time spent in NMIs */
  86         struct timespec64       timestamp;      /* wall time */
  87         int                     nmi_count;      /* # NMIs during this sample */
  88 };
  89
  90 /* keep the global state somewhere. */
  91 static struct hwlat_data {
  92
  93         struct mutex lock;              /* protect changes */
  94
  95         u64     count;                  /* total since reset */
  96
  97         u64     sample_window;          /* total sampling window (on+off) */
  98         u64     sample_width;           /* active sampling portion of window */
  99
 100 } hwlat_data = {
 101         .sample_window          = DEFAULT_SAMPLE_WINDOW,
 102         .sample_width           = DEFAULT_SAMPLE_WIDTH,
 103 };
 104
 105 static void trace_hwlat_sample(struct hwlat_sample *sample)
 106 {
 107         struct trace_array *tr = hwlat_trace;
 108         struct trace_event_call *call = &event_hwlat;
 109         struct ring_buffer *buffer = tr->trace_buffer.buffer;
 110         struct ring_buffer_event *event;
 111         struct hwlat_entry *entry;
 112         unsigned long flags;
 113         int pc;
 114
 115         pc = preempt_count();
 116         local_save_flags(flags);
 117
 118         event = trace_buffer_lock_reserve(buffer, TRACE_HWLAT, sizeof(*entry),
 119                                           flags, pc);
 120         if (!event)
 121                 return;
 122         entry   = ring_buffer_event_data(event);
 123         entry->seqnum                   = sample->seqnum;
 124         entry->duration                 = sample->duration;
 125         entry->outer_duration           = sample->outer_duration;
 126         entry->timestamp                = sample->timestamp;
 127         entry->nmi_total_ts             = sample->nmi_total_ts;
 128         entry->nmi_count                = sample->nmi_count;
 129
 130         if (!call_filter_check_discard(call, entry, buffer, event))
 131                 trace_buffer_unlock_commit_nostack(buffer, event);
 132 }
 133
 134 /* Macros to encapsulate the time capturing infrastructure */
 135 #define time_type       u64
 136 #define time_get()      trace_clock_local()
 137 #define time_to_us(x)   div_u64(x, 1000)
 138 #define time_sub(a, b)  ((a) - (b))
 139 #define init_time(a, b) (a = b)
 140 #define time_u64(a)     a
 141
 142 void trace_hwlat_callback(bool enter)
 143 {
 144         if (smp_processor_id() != nmi_cpu)
 145                 return;
 146
 147         /*
 148          * Currently trace_clock_local() calls sched_clock() and the
 149          * generic version is not NMI safe.
 150          */
 151         if (!IS_ENABLED(CONFIG_GENERIC_SCHED_CLOCK)) {
 152                 if (enter)
 153                         nmi_ts_start = time_get();
 154                 else
 155                         nmi_total_ts += time_get() - nmi_ts_start;
 156         }
 157
 158         if (enter)
 159                 nmi_count++;
 160 }
 161
 162 /**
 163  * get_sample - sample the CPU TSC and look for likely hardware latencies
 164  *
 165  * Used to repeatedly capture the CPU TSC (or similar), looking for potential
 166  * hardware-induced latency. Called with interrupts disabled and with
 167  * hwlat_data.lock held.
 168  */
 169 static int get_sample(void)
 170 {
 171         struct trace_array *tr = hwlat_trace;
 172         time_type start, t1, t2, last_t2;
 173         s64 diff, total, last_total = 0;
 174         u64 sample = 0;
 175         u64 thresh = tracing_thresh;
 176         u64 outer_sample = 0;
 177         int ret = -1;
 178
 179         do_div(thresh, NSEC_PER_USEC); /* modifies interval value */
 180
 181         nmi_cpu = smp_processor_id();
 182         nmi_total_ts = 0;
 183         nmi_count = 0;
 184         /* Make sure NMIs see this first */
 185         barrier();
 186
 187         trace_hwlat_callback_enabled = true;
 188
 189         init_time(last_t2, 0);
 190         start = time_get(); /* start timestamp */
 191
 192         do {
 193
 194                 t1 = time_get();        /* we'll look for a discontinuity */
 195                 t2 = time_get();
 196
 197                 if (time_u64(last_t2)) {
 198                         /* Check the delta from outer loop (t2 to next t1) */
 199                         diff = time_to_us(time_sub(t1, last_t2));
 200                         /* This shouldn't happen */
 201                         if (diff < 0) {
 202                                 pr_err(BANNER "time running backwards\n");
 203                                 goto out;
 204                         }
 205                         if (diff > outer_sample)
 206                                 outer_sample = diff;
 207                 }
 208                 last_t2 = t2;
 209
 210                 total = time_to_us(time_sub(t2, start)); /* sample width */
 211
 212                 /* Check for possible overflows */
 213                 if (total < last_total) {
 214                         pr_err("Time total overflowed\n");
 215                         break;
 216                 }
 217                 last_total = total;
 218
 219                 /* This checks the inner loop (t1 to t2) */
 220                 diff = time_to_us(time_sub(t2, t1));     /* current diff */
 221
 222                 /* This shouldn't happen */
 223                 if (diff < 0) {
 224                         pr_err(BANNER "time running backwards\n");
 225                         goto out;
 226                 }
 227
 228                 if (diff > sample)
 229                         sample = diff; /* only want highest value */
 230
 231         } while (total <= hwlat_data.sample_width);
 232
 233         barrier(); /* finish the above in the view for NMIs */
 234         trace_hwlat_callback_enabled = false;
 235         barrier(); /* Make sure nmi_total_ts is no longer updated */
 236
 237         ret = 0;
 238
 239         /* If we exceed the threshold value, we have found a hardware latency */
 240         if (sample > thresh || outer_sample > thresh) {
 241                 struct hwlat_sample s;
 242
 243                 ret = 1;
 244
 245                 /* We read in microseconds */
 246                 if (nmi_total_ts)
 247                         do_div(nmi_total_ts, NSEC_PER_USEC);
 248
 249                 hwlat_data.count++;
 250                 s.seqnum = hwlat_data.count;
 251                 s.duration = sample;
 252                 s.outer_duration = outer_sample;
 253                 ktime_get_real_ts64(&s.timestamp);
 254                 s.nmi_total_ts = nmi_total_ts;
 255                 s.nmi_count = nmi_count;
 256                 trace_hwlat_sample(&s);
 257
 258                 /* Keep a running maximum ever recorded hardware latency */
 259                 if (sample > tr->max_latency)
 260                         tr->max_latency = sample;
 261                 if (outer_sample > tr->max_latency)
 262                         tr->max_latency = outer_sample;
 263         }
 264
 265 out:
 266         return ret;
 267 }
 268
 269 static struct cpumask save_cpumask;
 270 static bool disable_migrate;
 271
 272 static void move_to_next_cpu(void)
 273 {
 274         struct cpumask *current_mask = &save_cpumask;
 275         struct trace_array *tr = hwlat_trace;
 276         int next_cpu;
 277
 278         if (disable_migrate)
 279                 return;
 280         /*
 281          * If for some reason the user modifies the CPU affinity
 282          * of this thread, than stop migrating for the duration
 283          * of the current test.
 284          */
 285         if (!cpumask_equal(current_mask, &current->cpus_allowed))
 286                 goto disable;
 287
 288         get_online_cpus();
 289         cpumask_and(current_mask, cpu_online_mask, tr->tracing_cpumask);
 290         next_cpu = cpumask_next(smp_processor_id(), current_mask);
 291         put_online_cpus();
 292
 293         if (next_cpu >= nr_cpu_ids)
 294                 next_cpu = cpumask_first(current_mask);
 295
 296         if (next_cpu >= nr_cpu_ids) /* Shouldn't happen! */
 297                 goto disable;
 298
 299         cpumask_clear(current_mask);
 300         cpumask_set_cpu(next_cpu, current_mask);
 301
 302         sched_setaffinity(0, current_mask);
 303         return;
 304
 305  disable:
 306         disable_migrate = true;
 307 }
 308
 309 /*
 310  * kthread_fn - The CPU time sampling/hardware latency detection kernel thread
 311  *
 312  * Used to periodically sample the CPU TSC via a call to get_sample. We
 313  * disable interrupts, which does (intentionally) introduce latency since we
 314  * need to ensure nothing else might be running (and thus preempting).
 315  * Obviously this should never be used in production environments.
 316  *
 317  * Executes one loop interaction on each CPU in tracing_cpumask sysfs file.
 318  */
 319 static int kthread_fn(void *data)
 320 {
 321         u64 interval;
 322
 323         while (!kthread_should_stop()) {
 324
 325                 move_to_next_cpu();
 326
 327                 local_irq_disable();
 328                 get_sample();
 329                 local_irq_enable();
 330
 331                 mutex_lock(&hwlat_data.lock);
 332                 interval = hwlat_data.sample_window - hwlat_data.sample_width;
 333                 mutex_unlock(&hwlat_data.lock);
 334
 335                 do_div(interval, USEC_PER_MSEC); /* modifies interval value */
 336
 337                 /* Always sleep for at least 1ms */
 338                 if (interval < 1)
 339                         interval = 1;
 340
 341                 if (msleep_interruptible(interval))
 342                         break;
 343         }
 344
 345         return 0;
 346 }
 347
 348 /**
 349  * start_kthread - Kick off the hardware latency sampling/detector kthread
 350  *
 351  * This starts the kernel thread that will sit and sample the CPU timestamp
 352  * counter (TSC or similar) and look for potential hardware latencies.
 353  */
 354 static int start_kthread(struct trace_array *tr)
 355 {
 356         struct cpumask *current_mask = &save_cpumask;
 357         struct task_struct *kthread;
 358         int next_cpu;
 359
 360         /* Just pick the first CPU on first iteration */
 361         current_mask = &save_cpumask;
 362         get_online_cpus();
 363         cpumask_and(current_mask, cpu_online_mask, tr->tracing_cpumask);
 364         put_online_cpus();
 365         next_cpu = cpumask_first(current_mask);
 366
 367         kthread = kthread_create(kthread_fn, NULL, "hwlatd");
 368         if (IS_ERR(kthread)) {
 369                 pr_err(BANNER "could not start sampling thread\n");
 370                 return -ENOMEM;
 371         }
 372
 373         cpumask_clear(current_mask);
 374         cpumask_set_cpu(next_cpu, current_mask);
 375         sched_setaffinity(kthread->pid, current_mask);
 376
 377         hwlat_kthread = kthread;
 378         wake_up_process(kthread);
 379
 380         return 0;
 381 }
 382
 383 /**
 384  * stop_kthread - Inform the hardware latency samping/detector kthread to stop
 385  *
 386  * This kicks the running hardware latency sampling/detector kernel thread and
 387  * tells it to stop sampling now. Use this on unload and at system shutdown.
 388  */
 389 static void stop_kthread(void)
 390 {
 391         if (!hwlat_kthread)
 392                 return;
 393         kthread_stop(hwlat_kthread);
 394         hwlat_kthread = NULL;
 395 }
 396
 397 /*
 398  * hwlat_read - Wrapper read function for reading both window and width
 399  * @filp: The active open file structure
 400  * @ubuf: The userspace provided buffer to read value into
 401  * @cnt: The maximum number of bytes to read
 402  * @ppos: The current "file" position
 403  *
 404  * This function provides a generic read implementation for the global state
 405  * "hwlat_data" structure filesystem entries.
 406  */
 407 static ssize_t hwlat_read(struct file *filp, char __user *ubuf,
 408                           size_t cnt, loff_t *ppos)
 409 {
 410         char buf[U64STR_SIZE];
 411         u64 *entry = filp->private_data;
 412         u64 val;
 413         int len;
 414
 415         if (!entry)
 416                 return -EFAULT;
 417
 418         if (cnt > sizeof(buf))
 419                 cnt = sizeof(buf);
 420
 421         val = *entry;
 422
 423         len = snprintf(buf, sizeof(buf), "%llu\n", val);
 424
 425         return simple_read_from_buffer(ubuf, cnt, ppos, buf, len);
 426 }
 427
 428 /**
 429  * hwlat_width_write - Write function for "width" entry
 430  * @filp: The active open file structure
 431  * @ubuf: The user buffer that contains the value to write
 432  * @cnt: The maximum number of bytes to write to "file"
 433  * @ppos: The current position in @file
 434  *
 435  * This function provides a write implementation for the "width" interface
 436  * to the hardware latency detector. It can be used to configure
 437  * for how many us of the total window us we will actively sample for any
 438  * hardware-induced latency periods. Obviously, it is not possible to
 439  * sample constantly and have the system respond to a sample reader, or,
 440  * worse, without having the system appear to have gone out to lunch. It
 441  * is enforced that width is less that the total window size.
 442  */
 443 static ssize_t
 444 hwlat_width_write(struct file *filp, const char __user *ubuf,
 445                   size_t cnt, loff_t *ppos)
 446 {
 447         u64 val;
 448         int err;
 449
 450         err = kstrtoull_from_user(ubuf, cnt, 10, &val);
 451         if (err)
 452                 return err;
 453
 454         mutex_lock(&hwlat_data.lock);
 455         if (val < hwlat_data.sample_window)
 456                 hwlat_data.sample_width = val;
 457         else
 458                 err = -EINVAL;
 459         mutex_unlock(&hwlat_data.lock);
 460
 461         if (err)
 462                 return err;
 463
 464         return cnt;
 465 }
 466
 467 /**
 468  * hwlat_window_write - Write function for "window" entry
 469  * @filp: The active open file structure
 470  * @ubuf: The user buffer that contains the value to write
 471  * @cnt: The maximum number of bytes to write to "file"
 472  * @ppos: The current position in @file
 473  *
 474  * This function provides a write implementation for the "window" interface
 475  * to the hardware latency detetector. The window is the total time
 476  * in us that will be considered one sample period. Conceptually, windows
 477  * occur back-to-back and contain a sample width period during which
 478  * actual sampling occurs. Can be used to write a new total window size. It
 479  * is enfoced that any value written must be greater than the sample width
 480  * size, or an error results.
 481  */
 482 static ssize_t
 483 hwlat_window_write(struct file *filp, const char __user *ubuf,
 484                    size_t cnt, loff_t *ppos)
 485 {
 486         u64 val;
 487         int err;
 488
 489         err = kstrtoull_from_user(ubuf, cnt, 10, &val);
 490         if (err)
 491                 return err;
 492
 493         mutex_lock(&hwlat_data.lock);
 494         if (hwlat_data.sample_width < val)
 495                 hwlat_data.sample_window = val;
 496         else
 497                 err = -EINVAL;
 498         mutex_unlock(&hwlat_data.lock);
 499
 500         if (err)
 501                 return err;
 502
 503         return cnt;
 504 }
 505
 506 static const struct file_operations width_fops = {
 507         .open           = tracing_open_generic,
 508         .read           = hwlat_read,
 509         .write          = hwlat_width_write,
 510 };
 511
 512 static const struct file_operations window_fops = {
 513         .open           = tracing_open_generic,
 514         .read           = hwlat_read,
 515         .write          = hwlat_window_write,
 516 };
 517
 518 /**
 519  * init_tracefs - A function to initialize the tracefs interface files
 520  *
 521  * This function creates entries in tracefs for "hwlat_detector".
 522  * It creates the hwlat_detector directory in the tracing directory,
 523  * and within that directory is the count, width and window files to
 524  * change and view those values.
 525  */
 526 static int init_tracefs(void)
 527 {
 528         struct dentry *d_tracer;
 529         struct dentry *top_dir;
 530
 531         d_tracer = tracing_init_dentry();
 532         if (IS_ERR(d_tracer))
 533                 return -ENOMEM;
 534
 535         top_dir = tracefs_create_dir("hwlat_detector", d_tracer);
 536         if (!top_dir)
 537                 return -ENOMEM;
 538
 539         hwlat_sample_window = tracefs_create_file("window", 0640,
 540                                                   top_dir,
 541                                                   &hwlat_data.sample_window,
 542                                                   &window_fops);
 543         if (!hwlat_sample_window)
 544                 goto err;
 545
 546         hwlat_sample_width = tracefs_create_file("width", 0644,
 547                                                  top_dir,
 548                                                  &hwlat_data.sample_width,
 549                                                  &width_fops);
 550         if (!hwlat_sample_width)
 551                 goto err;
 552
 553         return 0;
 554
 555  err:
 556         tracefs_remove_recursive(top_dir);
 557         return -ENOMEM;
 558 }
 559
 560 static void hwlat_tracer_start(struct trace_array *tr)
 561 {
 562         int err;
 563
 564         err = start_kthread(tr);
 565         if (err)
 566                 pr_err(BANNER "Cannot start hwlat kthread\n");
 567 }
 568
 569 static void hwlat_tracer_stop(struct trace_array *tr)
 570 {
 571         stop_kthread();
 572 }
 573
 574 static bool hwlat_busy;
 575
 576 static int hwlat_tracer_init(struct trace_array *tr)
 577 {
 578         /* Only allow one instance to enable this */
 579         if (hwlat_busy)
 580                 return -EBUSY;
 581
 582         hwlat_trace = tr;
 583
 584         disable_migrate = false;
 585         hwlat_data.count = 0;
 586         tr->max_latency = 0;
 587         save_tracing_thresh = tracing_thresh;
 588
 589         /* tracing_thresh is in nsecs, we speak in usecs */
 590         if (!tracing_thresh)
 591                 tracing_thresh = last_tracing_thresh;
 592
 593         if (tracer_tracing_is_on(tr))
 594                 hwlat_tracer_start(tr);
 595
 596         hwlat_busy = true;
 597
 598         return 0;
 599 }
 600
 601 static void hwlat_tracer_reset(struct trace_array *tr)
 602 {
 603         stop_kthread();
 604
 605         /* the tracing threshold is static between runs */
 606         last_tracing_thresh = tracing_thresh;
 607
 608         tracing_thresh = save_tracing_thresh;
 609         hwlat_busy = false;
 610 }
 611
 612 static struct tracer hwlat_tracer __read_mostly =
 613 {
 614         .name           = "hwlat",
 615         .init           = hwlat_tracer_init,
 616         .reset          = hwlat_tracer_reset,
 617         .start          = hwlat_tracer_start,
 618         .stop           = hwlat_tracer_stop,
 619         .allow_instances = true,
 620 };
 621
 622 __init static int init_hwlat_tracer(void)
 623 {
 624         int ret;
 625
 626         mutex_init(&hwlat_data.lock);
 627
 628         ret = register_tracer(&hwlat_tracer);
 629         if (ret)
 630                 return ret;
 631
 632         init_tracefs();
 633
 634         return 0;
 635 }
 636 late_initcall(init_hwlat_tracer);