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