kernel/trace/trace_stack.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Copyright (C) 2008 Steven Rostedt <srostedt@redhat.com>
   4  *
   5  */
   6 #include <linux/sched/task_stack.h>
   7 #include <linux/stacktrace.h>
   8 #include <linux/kallsyms.h>
   9 #include <linux/seq_file.h>
  10 #include <linux/spinlock.h>
  11 #include <linux/uaccess.h>
  12 #include <linux/ftrace.h>
  13 #include <linux/module.h>
  14 #include <linux/sysctl.h>
  15 #include <linux/init.h>
  16
  17 #include <asm/setup.h>
  18
  19 #include "trace.h"
  20
  21 static unsigned long stack_dump_trace[STACK_TRACE_ENTRIES+1] =
  22          { [0 ... (STACK_TRACE_ENTRIES)] = ULONG_MAX };
  23 unsigned stack_trace_index[STACK_TRACE_ENTRIES];
  24
  25 /*
  26  * Reserve one entry for the passed in ip. This will allow
  27  * us to remove most or all of the stack size overhead
  28  * added by the stack tracer itself.
  29  */
  30 struct stack_trace stack_trace_max = {
  31         .max_entries            = STACK_TRACE_ENTRIES - 1,
  32         .entries                = &stack_dump_trace[0],
  33 };
  34
  35 unsigned long stack_trace_max_size;
  36 arch_spinlock_t stack_trace_max_lock =
  37         (arch_spinlock_t)__ARCH_SPIN_LOCK_UNLOCKED;
  38
  39 DEFINE_PER_CPU(int, disable_stack_tracer);
  40 static DEFINE_MUTEX(stack_sysctl_mutex);
  41
  42 int stack_tracer_enabled;
  43 static int last_stack_tracer_enabled;
  44
  45 void stack_trace_print(void)
  46 {
  47         long i;
  48         int size;
  49
  50         pr_emerg("        Depth    Size   Location    (%d entries)\n"
  51                            "        -----    ----   --------\n",
  52                            stack_trace_max.nr_entries);
  53
  54         for (i = 0; i < stack_trace_max.nr_entries; i++) {
  55                 if (stack_dump_trace[i] == ULONG_MAX)
  56                         break;
  57                 if (i+1 == stack_trace_max.nr_entries ||
  58                                 stack_dump_trace[i+1] == ULONG_MAX)
  59                         size = stack_trace_index[i];
  60                 else
  61                         size = stack_trace_index[i] - stack_trace_index[i+1];
  62
  63                 pr_emerg("%3ld) %8d   %5d   %pS\n", i, stack_trace_index[i],
  64                                 size, (void *)stack_dump_trace[i]);
  65         }
  66 }
  67
  68 /*
  69  * When arch-specific code overrides this function, the following
  70  * data should be filled up, assuming stack_trace_max_lock is held to
  71  * prevent concurrent updates.
  72  *     stack_trace_index[]
  73  *     stack_trace_max
  74  *     stack_trace_max_size
  75  */
  76 void __weak
  77 check_stack(unsigned long ip, unsigned long *stack)
  78 {
  79         unsigned long this_size, flags; unsigned long *p, *top, *start;
  80         static int tracer_frame;
  81         int frame_size = ACCESS_ONCE(tracer_frame);
  82         int i, x;
  83
  84         this_size = ((unsigned long)stack) & (THREAD_SIZE-1);
  85         this_size = THREAD_SIZE - this_size;
  86         /* Remove the frame of the tracer */
  87         this_size -= frame_size;
  88
  89         if (this_size <= stack_trace_max_size)
  90                 return;
  91
  92         /* we do not handle interrupt stacks yet */
  93         if (!object_is_on_stack(stack))
  94                 return;
  95
  96         /* Can't do this from NMI context (can cause deadlocks) */
  97         if (in_nmi())
  98                 return;
  99
 100         local_irq_save(flags);
 101         arch_spin_lock(&stack_trace_max_lock);
 102
 103         /* In case another CPU set the tracer_frame on us */
 104         if (unlikely(!frame_size))
 105                 this_size -= tracer_frame;
 106
 107         /* a race could have already updated it */
 108         if (this_size <= stack_trace_max_size)
 109                 goto out;
 110
 111         stack_trace_max_size = this_size;
 112
 113         stack_trace_max.nr_entries = 0;
 114         stack_trace_max.skip = 3;
 115
 116         save_stack_trace(&stack_trace_max);
 117
 118         /* Skip over the overhead of the stack tracer itself */
 119         for (i = 0; i < stack_trace_max.nr_entries; i++) {
 120                 if (stack_dump_trace[i] == ip)
 121                         break;
 122         }
 123
 124         /*
 125          * Some archs may not have the passed in ip in the dump.
 126          * If that happens, we need to show everything.
 127          */
 128         if (i == stack_trace_max.nr_entries)
 129                 i = 0;
 130
 131         /*
 132          * Now find where in the stack these are.
 133          */
 134         x = 0;
 135         start = stack;
 136         top = (unsigned long *)
 137                 (((unsigned long)start & ~(THREAD_SIZE-1)) + THREAD_SIZE);
 138
 139         /*
 140          * Loop through all the entries. One of the entries may
 141          * for some reason be missed on the stack, so we may
 142          * have to account for them. If they are all there, this
 143          * loop will only happen once. This code only takes place
 144          * on a new max, so it is far from a fast path.
 145          */
 146         while (i < stack_trace_max.nr_entries) {
 147                 int found = 0;
 148
 149                 stack_trace_index[x] = this_size;
 150                 p = start;
 151
 152                 for (; p < top && i < stack_trace_max.nr_entries; p++) {
 153                         if (stack_dump_trace[i] == ULONG_MAX)
 154                                 break;
 155                         /*
 156                          * The READ_ONCE_NOCHECK is used to let KASAN know that
 157                          * this is not a stack-out-of-bounds error.
 158                          */
 159                         if ((READ_ONCE_NOCHECK(*p)) == stack_dump_trace[i]) {
 160                                 stack_dump_trace[x] = stack_dump_trace[i++];
 161                                 this_size = stack_trace_index[x++] =
 162                                         (top - p) * sizeof(unsigned long);
 163                                 found = 1;
 164                                 /* Start the search from here */
 165                                 start = p + 1;
 166                                 /*
 167                                  * We do not want to show the overhead
 168                                  * of the stack tracer stack in the
 169                                  * max stack. If we haven't figured
 170                                  * out what that is, then figure it out
 171                                  * now.
 172                                  */
 173                                 if (unlikely(!tracer_frame)) {
 174                                         tracer_frame = (p - stack) *
 175                                                 sizeof(unsigned long);
 176                                         stack_trace_max_size -= tracer_frame;
 177                                 }
 178                         }
 179                 }
 180
 181                 if (!found)
 182                         i++;
 183         }
 184
 185         stack_trace_max.nr_entries = x;
 186         for (; x < i; x++)
 187                 stack_dump_trace[x] = ULONG_MAX;
 188
 189         if (task_stack_end_corrupted(current)) {
 190                 stack_trace_print();
 191                 BUG();
 192         }
 193
 194  out:
 195         arch_spin_unlock(&stack_trace_max_lock);
 196         local_irq_restore(flags);
 197 }
 198
 199 /* Some archs may not define MCOUNT_INSN_SIZE */
 200 #ifndef MCOUNT_INSN_SIZE
 201 # define MCOUNT_INSN_SIZE 0
 202 #endif
 203
 204 static void
 205 stack_trace_call(unsigned long ip, unsigned long parent_ip,
 206                  struct ftrace_ops *op, struct pt_regs *pt_regs)
 207 {
 208         unsigned long stack;
 209
 210         preempt_disable_notrace();
 211
 212         /* no atomic needed, we only modify this variable by this cpu */
 213         __this_cpu_inc(disable_stack_tracer);
 214         if (__this_cpu_read(disable_stack_tracer) != 1)
 215                 goto out;
 216
 217         ip += MCOUNT_INSN_SIZE;
 218
 219         check_stack(ip, &stack);
 220
 221  out:
 222         __this_cpu_dec(disable_stack_tracer);
 223         /* prevent recursion in schedule */
 224         preempt_enable_notrace();
 225 }
 226
 227 static struct ftrace_ops trace_ops __read_mostly =
 228 {
 229         .func = stack_trace_call,
 230         .flags = FTRACE_OPS_FL_RECURSION_SAFE,
 231 };
 232
 233 static ssize_t
 234 stack_max_size_read(struct file *filp, char __user *ubuf,
 235                     size_t count, loff_t *ppos)
 236 {
 237         unsigned long *ptr = filp->private_data;
 238         char buf[64];
 239         int r;
 240
 241         r = snprintf(buf, sizeof(buf), "%ld\n", *ptr);
 242         if (r > sizeof(buf))
 243                 r = sizeof(buf);
 244         return simple_read_from_buffer(ubuf, count, ppos, buf, r);
 245 }
 246
 247 static ssize_t
 248 stack_max_size_write(struct file *filp, const char __user *ubuf,
 249                      size_t count, loff_t *ppos)
 250 {
 251         long *ptr = filp->private_data;
 252         unsigned long val, flags;
 253         int ret;
 254
 255         ret = kstrtoul_from_user(ubuf, count, 10, &val);
 256         if (ret)
 257                 return ret;
 258
 259         local_irq_save(flags);
 260
 261         /*
 262          * In case we trace inside arch_spin_lock() or after (NMI),
 263          * we will cause circular lock, so we also need to increase
 264          * the percpu disable_stack_tracer here.
 265          */
 266         __this_cpu_inc(disable_stack_tracer);
 267
 268         arch_spin_lock(&stack_trace_max_lock);
 269         *ptr = val;
 270         arch_spin_unlock(&stack_trace_max_lock);
 271
 272         __this_cpu_dec(disable_stack_tracer);
 273         local_irq_restore(flags);
 274
 275         return count;
 276 }
 277
 278 static const struct file_operations stack_max_size_fops = {
 279         .open           = tracing_open_generic,
 280         .read           = stack_max_size_read,
 281         .write          = stack_max_size_write,
 282         .llseek         = default_llseek,
 283 };
 284
 285 static void *
 286 __next(struct seq_file *m, loff_t *pos)
 287 {
 288         long n = *pos - 1;
 289
 290         if (n > stack_trace_max.nr_entries || stack_dump_trace[n] == ULONG_MAX)
 291                 return NULL;
 292
 293         m->private = (void *)n;
 294         return &m->private;
 295 }
 296
 297 static void *
 298 t_next(struct seq_file *m, void *v, loff_t *pos)
 299 {
 300         (*pos)++;
 301         return __next(m, pos);
 302 }
 303
 304 static void *t_start(struct seq_file *m, loff_t *pos)
 305 {
 306         local_irq_disable();
 307
 308         __this_cpu_inc(disable_stack_tracer);
 309
 310         arch_spin_lock(&stack_trace_max_lock);
 311
 312         if (*pos == 0)
 313                 return SEQ_START_TOKEN;
 314
 315         return __next(m, pos);
 316 }
 317
 318 static void t_stop(struct seq_file *m, void *p)
 319 {
 320         arch_spin_unlock(&stack_trace_max_lock);
 321
 322         __this_cpu_dec(disable_stack_tracer);
 323
 324         local_irq_enable();
 325 }
 326
 327 static void trace_lookup_stack(struct seq_file *m, long i)
 328 {
 329         unsigned long addr = stack_dump_trace[i];
 330
 331         seq_printf(m, "%pS\n", (void *)addr);
 332 }
 333
 334 static void print_disabled(struct seq_file *m)
 335 {
 336         seq_puts(m, "#\n"
 337                  "#  Stack tracer disabled\n"
 338                  "#\n"
 339                  "# To enable the stack tracer, either add 'stacktrace' to the\n"
 340                  "# kernel command line\n"
 341                  "# or 'echo 1 > /proc/sys/kernel/stack_tracer_enabled'\n"
 342                  "#\n");
 343 }
 344
 345 static int t_show(struct seq_file *m, void *v)
 346 {
 347         long i;
 348         int size;
 349
 350         if (v == SEQ_START_TOKEN) {
 351                 seq_printf(m, "        Depth    Size   Location"
 352                            "    (%d entries)\n"
 353                            "        -----    ----   --------\n",
 354                            stack_trace_max.nr_entries);
 355
 356                 if (!stack_tracer_enabled && !stack_trace_max_size)
 357                         print_disabled(m);
 358
 359                 return 0;
 360         }
 361
 362         i = *(long *)v;
 363
 364         if (i >= stack_trace_max.nr_entries ||
 365             stack_dump_trace[i] == ULONG_MAX)
 366                 return 0;
 367
 368         if (i+1 == stack_trace_max.nr_entries ||
 369             stack_dump_trace[i+1] == ULONG_MAX)
 370                 size = stack_trace_index[i];
 371         else
 372                 size = stack_trace_index[i] - stack_trace_index[i+1];
 373
 374         seq_printf(m, "%3ld) %8d   %5d   ", i, stack_trace_index[i], size);
 375
 376         trace_lookup_stack(m, i);
 377
 378         return 0;
 379 }
 380
 381 static const struct seq_operations stack_trace_seq_ops = {
 382         .start          = t_start,
 383         .next           = t_next,
 384         .stop           = t_stop,
 385         .show           = t_show,
 386 };
 387
 388 static int stack_trace_open(struct inode *inode, struct file *file)
 389 {
 390         return seq_open(file, &stack_trace_seq_ops);
 391 }
 392
 393 static const struct file_operations stack_trace_fops = {
 394         .open           = stack_trace_open,
 395         .read           = seq_read,
 396         .llseek         = seq_lseek,
 397         .release        = seq_release,
 398 };
 399
 400 #ifdef CONFIG_DYNAMIC_FTRACE
 401
 402 static int
 403 stack_trace_filter_open(struct inode *inode, struct file *file)
 404 {
 405         struct ftrace_ops *ops = inode->i_private;
 406
 407         return ftrace_regex_open(ops, FTRACE_ITER_FILTER,
 408                                  inode, file);
 409 }
 410
 411 static const struct file_operations stack_trace_filter_fops = {
 412         .open = stack_trace_filter_open,
 413         .read = seq_read,
 414         .write = ftrace_filter_write,
 415         .llseek = tracing_lseek,
 416         .release = ftrace_regex_release,
 417 };
 418
 419 #endif /* CONFIG_DYNAMIC_FTRACE */
 420
 421 int
 422 stack_trace_sysctl(struct ctl_table *table, int write,
 423                    void __user *buffer, size_t *lenp,
 424                    loff_t *ppos)
 425 {
 426         int ret;
 427
 428         mutex_lock(&stack_sysctl_mutex);
 429
 430         ret = proc_dointvec(table, write, buffer, lenp, ppos);
 431
 432         if (ret || !write ||
 433             (last_stack_tracer_enabled == !!stack_tracer_enabled))
 434                 goto out;
 435
 436         last_stack_tracer_enabled = !!stack_tracer_enabled;
 437
 438         if (stack_tracer_enabled)
 439                 register_ftrace_function(&trace_ops);
 440         else
 441                 unregister_ftrace_function(&trace_ops);
 442
 443  out:
 444         mutex_unlock(&stack_sysctl_mutex);
 445         return ret;
 446 }
 447
 448 static char stack_trace_filter_buf[COMMAND_LINE_SIZE+1] __initdata;
 449
 450 static __init int enable_stacktrace(char *str)
 451 {
 452         if (strncmp(str, "_filter=", 8) == 0)
 453                 strncpy(stack_trace_filter_buf, str+8, COMMAND_LINE_SIZE);
 454
 455         stack_tracer_enabled = 1;
 456         last_stack_tracer_enabled = 1;
 457         return 1;
 458 }
 459 __setup("stacktrace", enable_stacktrace);
 460
 461 static __init int stack_trace_init(void)
 462 {
 463         struct dentry *d_tracer;
 464
 465         d_tracer = tracing_init_dentry();
 466         if (IS_ERR(d_tracer))
 467                 return 0;
 468
 469         trace_create_file("stack_max_size", 0644, d_tracer,
 470                         &stack_trace_max_size, &stack_max_size_fops);
 471
 472         trace_create_file("stack_trace", 0444, d_tracer,
 473                         NULL, &stack_trace_fops);
 474
 475 #ifdef CONFIG_DYNAMIC_FTRACE
 476         trace_create_file("stack_trace_filter", 0444, d_tracer,
 477                           &trace_ops, &stack_trace_filter_fops);
 478 #endif
 479
 480         if (stack_trace_filter_buf[0])
 481                 ftrace_set_early_filter(&trace_ops, stack_trace_filter_buf, 1);
 482
 483         if (stack_tracer_enabled)
 484                 register_ftrace_function(&trace_ops);
 485
 486         return 0;
 487 }
 488
 489 device_initcall(stack_trace_init);