kernel/latencytop.c

   1 /*
   2  * latencytop.c: Latency display infrastructure
   3  *
   4  * (C) Copyright 2008 Intel Corporation
   5  * Author: Arjan van de Ven <arjan@linux.intel.com>
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; version 2
  10  * of the License.
  11  */
  12
  13 /*
  14  * CONFIG_LATENCYTOP enables a kernel latency tracking infrastructure that is
  15  * used by the "latencytop" userspace tool. The latency that is tracked is not
  16  * the 'traditional' interrupt latency (which is primarily caused by something
  17  * else consuming CPU), but instead, it is the latency an application encounters
  18  * because the kernel sleeps on its behalf for various reasons.
  19  *
  20  * This code tracks 2 levels of statistics:
  21  * 1) System level latency
  22  * 2) Per process latency
  23  *
  24  * The latency is stored in fixed sized data structures in an accumulated form;
  25  * if the "same" latency cause is hit twice, this will be tracked as one entry
  26  * in the data structure. Both the count, total accumulated latency and maximum
  27  * latency are tracked in this data structure. When the fixed size structure is
  28  * full, no new causes are tracked until the buffer is flushed by writing to
  29  * the /proc file; the userspace tool does this on a regular basis.
  30  *
  31  * A latency cause is identified by a stringified backtrace at the point that
  32  * the scheduler gets invoked. The userland tool will use this string to
  33  * identify the cause of the latency in human readable form.
  34  *
  35  * The information is exported via /proc/latency_stats and /proc/<pid>/latency.
  36  * These files look like this:
  37  *
  38  * Latency Top version : v0.1
  39  * 70 59433 4897 i915_irq_wait drm_ioctl vfs_ioctl do_vfs_ioctl sys_ioctl
  40  * |    |    |    |
  41  * |    |    |    +----> the stringified backtrace
  42  * |    |    +---------> The maximum latency for this entry in microseconds
  43  * |    +--------------> The accumulated latency for this entry (microseconds)
  44  * +-------------------> The number of times this entry is hit
  45  *
  46  * (note: the average latency is the accumulated latency divided by the number
  47  * of times)
  48  */
  49
  50 #include <linux/kallsyms.h>
  51 #include <linux/seq_file.h>
  52 #include <linux/notifier.h>
  53 #include <linux/spinlock.h>
  54 #include <linux/proc_fs.h>
  55 #include <linux/latencytop.h>
  56 #include <linux/export.h>
  57 #include <linux/sched.h>
  58 #include <linux/sched/debug.h>
  59 #include <linux/list.h>
  60 #include <linux/stacktrace.h>
  61
  62 static DEFINE_RAW_SPINLOCK(latency_lock);
  63
  64 #define MAXLR 128
  65 static struct latency_record latency_record[MAXLR];
  66
  67 int latencytop_enabled;
  68
  69 void clear_all_latency_tracing(struct task_struct *p)
  70 {
  71         unsigned long flags;
  72
  73         if (!latencytop_enabled)
  74                 return;
  75
  76         raw_spin_lock_irqsave(&latency_lock, flags);
  77         memset(&p->latency_record, 0, sizeof(p->latency_record));
  78         p->latency_record_count = 0;
  79         raw_spin_unlock_irqrestore(&latency_lock, flags);
  80 }
  81
  82 static void clear_global_latency_tracing(void)
  83 {
  84         unsigned long flags;
  85
  86         raw_spin_lock_irqsave(&latency_lock, flags);
  87         memset(&latency_record, 0, sizeof(latency_record));
  88         raw_spin_unlock_irqrestore(&latency_lock, flags);
  89 }
  90
  91 static void __sched
  92 account_global_scheduler_latency(struct task_struct *tsk,
  93                                  struct latency_record *lat)
  94 {
  95         int firstnonnull = MAXLR + 1;
  96         int i;
  97
  98         if (!latencytop_enabled)
  99                 return;
 100
 101         /* skip kernel threads for now */
 102         if (!tsk->mm)
 103                 return;
 104
 105         for (i = 0; i < MAXLR; i++) {
 106                 int q, same = 1;
 107
 108                 /* Nothing stored: */
 109                 if (!latency_record[i].backtrace[0]) {
 110                         if (firstnonnull > i)
 111                                 firstnonnull = i;
 112                         continue;
 113                 }
 114                 for (q = 0; q < LT_BACKTRACEDEPTH; q++) {
 115                         unsigned long record = lat->backtrace[q];
 116
 117                         if (latency_record[i].backtrace[q] != record) {
 118                                 same = 0;
 119                                 break;
 120                         }
 121
 122                         /* 0 and ULONG_MAX entries mean end of backtrace: */
 123                         if (record == 0 || record == ULONG_MAX)
 124                                 break;
 125                 }
 126                 if (same) {
 127                         latency_record[i].count++;
 128                         latency_record[i].time += lat->time;
 129                         if (lat->time > latency_record[i].max)
 130                                 latency_record[i].max = lat->time;
 131                         return;
 132                 }
 133         }
 134
 135         i = firstnonnull;
 136         if (i >= MAXLR - 1)
 137                 return;
 138
 139         /* Allocted a new one: */
 140         memcpy(&latency_record[i], lat, sizeof(struct latency_record));
 141 }
 142
 143 /*
 144  * Iterator to store a backtrace into a latency record entry
 145  */
 146 static inline void store_stacktrace(struct task_struct *tsk,
 147                                         struct latency_record *lat)
 148 {
 149         struct stack_trace trace;
 150
 151         memset(&trace, 0, sizeof(trace));
 152         trace.max_entries = LT_BACKTRACEDEPTH;
 153         trace.entries = &lat->backtrace[0];
 154         save_stack_trace_tsk(tsk, &trace);
 155 }
 156
 157 /**
 158  * __account_scheduler_latency - record an occurred latency
 159  * @tsk - the task struct of the task hitting the latency
 160  * @usecs - the duration of the latency in microseconds
 161  * @inter - 1 if the sleep was interruptible, 0 if uninterruptible
 162  *
 163  * This function is the main entry point for recording latency entries
 164  * as called by the scheduler.
 165  *
 166  * This function has a few special cases to deal with normal 'non-latency'
 167  * sleeps: specifically, interruptible sleep longer than 5 msec is skipped
 168  * since this usually is caused by waiting for events via select() and co.
 169  *
 170  * Negative latencies (caused by time going backwards) are also explicitly
 171  * skipped.
 172  */
 173 void __sched
 174 __account_scheduler_latency(struct task_struct *tsk, int usecs, int inter)
 175 {
 176         unsigned long flags;
 177         int i, q;
 178         struct latency_record lat;
 179
 180         /* Long interruptible waits are generally user requested... */
 181         if (inter && usecs > 5000)
 182                 return;
 183
 184         /* Negative sleeps are time going backwards */
 185         /* Zero-time sleeps are non-interesting */
 186         if (usecs <= 0)
 187                 return;
 188
 189         memset(&lat, 0, sizeof(lat));
 190         lat.count = 1;
 191         lat.time = usecs;
 192         lat.max = usecs;
 193         store_stacktrace(tsk, &lat);
 194
 195         raw_spin_lock_irqsave(&latency_lock, flags);
 196
 197         account_global_scheduler_latency(tsk, &lat);
 198
 199         for (i = 0; i < tsk->latency_record_count; i++) {
 200                 struct latency_record *mylat;
 201                 int same = 1;
 202
 203                 mylat = &tsk->latency_record[i];
 204                 for (q = 0; q < LT_BACKTRACEDEPTH; q++) {
 205                         unsigned long record = lat.backtrace[q];
 206
 207                         if (mylat->backtrace[q] != record) {
 208                                 same = 0;
 209                                 break;
 210                         }
 211
 212                         /* 0 and ULONG_MAX entries mean end of backtrace: */
 213                         if (record == 0 || record == ULONG_MAX)
 214                                 break;
 215                 }
 216                 if (same) {
 217                         mylat->count++;
 218                         mylat->time += lat.time;
 219                         if (lat.time > mylat->max)
 220                                 mylat->max = lat.time;
 221                         goto out_unlock;
 222                 }
 223         }
 224
 225         /*
 226          * short term hack; if we're > 32 we stop; future we recycle:
 227          */
 228         if (tsk->latency_record_count >= LT_SAVECOUNT)
 229                 goto out_unlock;
 230
 231         /* Allocated a new one: */
 232         i = tsk->latency_record_count++;
 233         memcpy(&tsk->latency_record[i], &lat, sizeof(struct latency_record));
 234
 235 out_unlock:
 236         raw_spin_unlock_irqrestore(&latency_lock, flags);
 237 }
 238
 239 static int lstats_show(struct seq_file *m, void *v)
 240 {
 241         int i;
 242
 243         seq_puts(m, "Latency Top version : v0.1\n");
 244
 245         for (i = 0; i < MAXLR; i++) {
 246                 struct latency_record *lr = &latency_record[i];
 247
 248                 if (lr->backtrace[0]) {
 249                         int q;
 250                         seq_printf(m, "%i %lu %lu",
 251                                    lr->count, lr->time, lr->max);
 252                         for (q = 0; q < LT_BACKTRACEDEPTH; q++) {
 253                                 unsigned long bt = lr->backtrace[q];
 254                                 if (!bt)
 255                                         break;
 256                                 if (bt == ULONG_MAX)
 257                                         break;
 258                                 seq_printf(m, " %ps", (void *)bt);
 259                         }
 260                         seq_puts(m, "\n");
 261                 }
 262         }
 263         return 0;
 264 }
 265
 266 static ssize_t
 267 lstats_write(struct file *file, const char __user *buf, size_t count,
 268              loff_t *offs)
 269 {
 270         clear_global_latency_tracing();
 271
 272         return count;
 273 }
 274
 275 static int lstats_open(struct inode *inode, struct file *filp)
 276 {
 277         return single_open(filp, lstats_show, NULL);
 278 }
 279
 280 static const struct file_operations lstats_fops = {
 281         .open           = lstats_open,
 282         .read           = seq_read,
 283         .write          = lstats_write,
 284         .llseek         = seq_lseek,
 285         .release        = single_release,
 286 };
 287
 288 static int __init init_lstats_procfs(void)
 289 {
 290         proc_create("latency_stats", 0644, NULL, &lstats_fops);
 291         return 0;
 292 }
 293
 294 int sysctl_latencytop(struct ctl_table *table, int write,
 295                         void __user *buffer, size_t *lenp, loff_t *ppos)
 296 {
 297         int err;
 298
 299         err = proc_dointvec(table, write, buffer, lenp, ppos);
 300         if (latencytop_enabled)
 301                 force_schedstat_enabled();
 302
 303         return err;
 304 }
 305 device_initcall(init_lstats_procfs);