kernel/tracepoint.c

   1 /*
   2  * Copyright (C) 2008-2014 Mathieu Desnoyers
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17  */
  18 #include <linux/module.h>
  19 #include <linux/mutex.h>
  20 #include <linux/types.h>
  21 #include <linux/jhash.h>
  22 #include <linux/list.h>
  23 #include <linux/rcupdate.h>
  24 #include <linux/tracepoint.h>
  25 #include <linux/err.h>
  26 #include <linux/slab.h>
  27 #include <linux/sched/signal.h>
  28 #include <linux/sched/task.h>
  29 #include <linux/static_key.h>
  30
  31 extern struct tracepoint * const __start___tracepoints_ptrs[];
  32 extern struct tracepoint * const __stop___tracepoints_ptrs[];
  33
  34 DEFINE_SRCU(tracepoint_srcu);
  35 EXPORT_SYMBOL_GPL(tracepoint_srcu);
  36
  37 /* Set to 1 to enable tracepoint debug output */
  38 static const int tracepoint_debug;
  39
  40 #ifdef CONFIG_MODULES
  41 /*
  42  * Tracepoint module list mutex protects the local module list.
  43  */
  44 static DEFINE_MUTEX(tracepoint_module_list_mutex);
  45
  46 /* Local list of struct tp_module */
  47 static LIST_HEAD(tracepoint_module_list);
  48 #endif /* CONFIG_MODULES */
  49
  50 /*
  51  * tracepoints_mutex protects the builtin and module tracepoints.
  52  * tracepoints_mutex nests inside tracepoint_module_list_mutex.
  53  */
  54 static DEFINE_MUTEX(tracepoints_mutex);
  55
  56 static struct rcu_head *early_probes;
  57 static bool ok_to_free_tracepoints;
  58
  59 /*
  60  * Note about RCU :
  61  * It is used to delay the free of multiple probes array until a quiescent
  62  * state is reached.
  63  */
  64 struct tp_probes {
  65         struct rcu_head rcu;
  66         struct tracepoint_func probes[0];
  67 };
  68
  69 static inline void *allocate_probes(int count)
  70 {
  71         struct tp_probes *p  = kmalloc(count * sizeof(struct tracepoint_func)
  72                         + sizeof(struct tp_probes), GFP_KERNEL);
  73         return p == NULL ? NULL : p->probes;
  74 }
  75
  76 static void srcu_free_old_probes(struct rcu_head *head)
  77 {
  78         kfree(container_of(head, struct tp_probes, rcu));
  79 }
  80
  81 static void rcu_free_old_probes(struct rcu_head *head)
  82 {
  83         call_srcu(&tracepoint_srcu, head, srcu_free_old_probes);
  84 }
  85
  86 static __init int release_early_probes(void)
  87 {
  88         struct rcu_head *tmp;
  89
  90         ok_to_free_tracepoints = true;
  91
  92         while (early_probes) {
  93                 tmp = early_probes;
  94                 early_probes = tmp->next;
  95                 call_rcu_sched(tmp, rcu_free_old_probes);
  96         }
  97
  98         return 0;
  99 }
 100
 101 /* SRCU is initialized at core_initcall */
 102 postcore_initcall(release_early_probes);
 103
 104 static inline void release_probes(struct tracepoint_func *old)
 105 {
 106         if (old) {
 107                 struct tp_probes *tp_probes = container_of(old,
 108                         struct tp_probes, probes[0]);
 109
 110                 /*
 111                  * We can't free probes if SRCU is not initialized yet.
 112                  * Postpone the freeing till after SRCU is initialized.
 113                  */
 114                 if (unlikely(!ok_to_free_tracepoints)) {
 115                         tp_probes->rcu.next = early_probes;
 116                         early_probes = &tp_probes->rcu;
 117                         return;
 118                 }
 119
 120                 /*
 121                  * Tracepoint probes are protected by both sched RCU and SRCU,
 122                  * by calling the SRCU callback in the sched RCU callback we
 123                  * cover both cases. So let us chain the SRCU and sched RCU
 124                  * callbacks to wait for both grace periods.
 125                  */
 126                 call_rcu_sched(&tp_probes->rcu, rcu_free_old_probes);
 127         }
 128 }
 129
 130 static void debug_print_probes(struct tracepoint_func *funcs)
 131 {
 132         int i;
 133
 134         if (!tracepoint_debug || !funcs)
 135                 return;
 136
 137         for (i = 0; funcs[i].func; i++)
 138                 printk(KERN_DEBUG "Probe %d : %p\n", i, funcs[i].func);
 139 }
 140
 141 static struct tracepoint_func *
 142 func_add(struct tracepoint_func **funcs, struct tracepoint_func *tp_func,
 143          int prio)
 144 {
 145         struct tracepoint_func *old, *new;
 146         int nr_probes = 0;
 147         int pos = -1;
 148
 149         if (WARN_ON(!tp_func->func))
 150                 return ERR_PTR(-EINVAL);
 151
 152         debug_print_probes(*funcs);
 153         old = *funcs;
 154         if (old) {
 155                 /* (N -> N+1), (N != 0, 1) probes */
 156                 for (nr_probes = 0; old[nr_probes].func; nr_probes++) {
 157                         /* Insert before probes of lower priority */
 158                         if (pos < 0 && old[nr_probes].prio < prio)
 159                                 pos = nr_probes;
 160                         if (old[nr_probes].func == tp_func->func &&
 161                             old[nr_probes].data == tp_func->data)
 162                                 return ERR_PTR(-EEXIST);
 163                 }
 164         }
 165         /* + 2 : one for new probe, one for NULL func */
 166         new = allocate_probes(nr_probes + 2);
 167         if (new == NULL)
 168                 return ERR_PTR(-ENOMEM);
 169         if (old) {
 170                 if (pos < 0) {
 171                         pos = nr_probes;
 172                         memcpy(new, old, nr_probes * sizeof(struct tracepoint_func));
 173                 } else {
 174                         /* Copy higher priority probes ahead of the new probe */
 175                         memcpy(new, old, pos * sizeof(struct tracepoint_func));
 176                         /* Copy the rest after it. */
 177                         memcpy(new + pos + 1, old + pos,
 178                                (nr_probes - pos) * sizeof(struct tracepoint_func));
 179                 }
 180         } else
 181                 pos = 0;
 182         new[pos] = *tp_func;
 183         new[nr_probes + 1].func = NULL;
 184         *funcs = new;
 185         debug_print_probes(*funcs);
 186         return old;
 187 }
 188
 189 static void *func_remove(struct tracepoint_func **funcs,
 190                 struct tracepoint_func *tp_func)
 191 {
 192         int nr_probes = 0, nr_del = 0, i;
 193         struct tracepoint_func *old, *new;
 194
 195         old = *funcs;
 196
 197         if (!old)
 198                 return ERR_PTR(-ENOENT);
 199
 200         debug_print_probes(*funcs);
 201         /* (N -> M), (N > 1, M >= 0) probes */
 202         if (tp_func->func) {
 203                 for (nr_probes = 0; old[nr_probes].func; nr_probes++) {
 204                         if (old[nr_probes].func == tp_func->func &&
 205                              old[nr_probes].data == tp_func->data)
 206                                 nr_del++;
 207                 }
 208         }
 209
 210         /*
 211          * If probe is NULL, then nr_probes = nr_del = 0, and then the
 212          * entire entry will be removed.
 213          */
 214         if (nr_probes - nr_del == 0) {
 215                 /* N -> 0, (N > 1) */
 216                 *funcs = NULL;
 217                 debug_print_probes(*funcs);
 218                 return old;
 219         } else {
 220                 int j = 0;
 221                 /* N -> M, (N > 1, M > 0) */
 222                 /* + 1 for NULL */
 223                 new = allocate_probes(nr_probes - nr_del + 1);
 224                 if (new == NULL)
 225                         return ERR_PTR(-ENOMEM);
 226                 for (i = 0; old[i].func; i++)
 227                         if (old[i].func != tp_func->func
 228                                         || old[i].data != tp_func->data)
 229                                 new[j++] = old[i];
 230                 new[nr_probes - nr_del].func = NULL;
 231                 *funcs = new;
 232         }
 233         debug_print_probes(*funcs);
 234         return old;
 235 }
 236
 237 /*
 238  * Add the probe function to a tracepoint.
 239  */
 240 static int tracepoint_add_func(struct tracepoint *tp,
 241                                struct tracepoint_func *func, int prio)
 242 {
 243         struct tracepoint_func *old, *tp_funcs;
 244         int ret;
 245
 246         if (tp->regfunc && !static_key_enabled(&tp->key)) {
 247                 ret = tp->regfunc();
 248                 if (ret < 0)
 249                         return ret;
 250         }
 251
 252         tp_funcs = rcu_dereference_protected(tp->funcs,
 253                         lockdep_is_held(&tracepoints_mutex));
 254         old = func_add(&tp_funcs, func, prio);
 255         if (IS_ERR(old)) {
 256                 WARN_ON_ONCE(PTR_ERR(old) != -ENOMEM);
 257                 return PTR_ERR(old);
 258         }
 259
 260         /*
 261          * rcu_assign_pointer has as smp_store_release() which makes sure
 262          * that the new probe callbacks array is consistent before setting
 263          * a pointer to it.  This array is referenced by __DO_TRACE from
 264          * include/linux/tracepoint.h using rcu_dereference_sched().
 265          */
 266         rcu_assign_pointer(tp->funcs, tp_funcs);
 267         if (!static_key_enabled(&tp->key))
 268                 static_key_slow_inc(&tp->key);
 269         release_probes(old);
 270         return 0;
 271 }
 272
 273 /*
 274  * Remove a probe function from a tracepoint.
 275  * Note: only waiting an RCU period after setting elem->call to the empty
 276  * function insures that the original callback is not used anymore. This insured
 277  * by preempt_disable around the call site.
 278  */
 279 static int tracepoint_remove_func(struct tracepoint *tp,
 280                 struct tracepoint_func *func)
 281 {
 282         struct tracepoint_func *old, *tp_funcs;
 283
 284         tp_funcs = rcu_dereference_protected(tp->funcs,
 285                         lockdep_is_held(&tracepoints_mutex));
 286         old = func_remove(&tp_funcs, func);
 287         if (IS_ERR(old)) {
 288                 WARN_ON_ONCE(PTR_ERR(old) != -ENOMEM);
 289                 return PTR_ERR(old);
 290         }
 291
 292         if (!tp_funcs) {
 293                 /* Removed last function */
 294                 if (tp->unregfunc && static_key_enabled(&tp->key))
 295                         tp->unregfunc();
 296
 297                 if (static_key_enabled(&tp->key))
 298                         static_key_slow_dec(&tp->key);
 299         }
 300         rcu_assign_pointer(tp->funcs, tp_funcs);
 301         release_probes(old);
 302         return 0;
 303 }
 304
 305 /**
 306  * tracepoint_probe_register_prio -  Connect a probe to a tracepoint with priority
 307  * @tp: tracepoint
 308  * @probe: probe handler
 309  * @data: tracepoint data
 310  * @prio: priority of this function over other registered functions
 311  *
 312  * Returns 0 if ok, error value on error.
 313  * Note: if @tp is within a module, the caller is responsible for
 314  * unregistering the probe before the module is gone. This can be
 315  * performed either with a tracepoint module going notifier, or from
 316  * within module exit functions.
 317  */
 318 int tracepoint_probe_register_prio(struct tracepoint *tp, void *probe,
 319                                    void *data, int prio)
 320 {
 321         struct tracepoint_func tp_func;
 322         int ret;
 323
 324         mutex_lock(&tracepoints_mutex);
 325         tp_func.func = probe;
 326         tp_func.data = data;
 327         tp_func.prio = prio;
 328         ret = tracepoint_add_func(tp, &tp_func, prio);
 329         mutex_unlock(&tracepoints_mutex);
 330         return ret;
 331 }
 332 EXPORT_SYMBOL_GPL(tracepoint_probe_register_prio);
 333
 334 /**
 335  * tracepoint_probe_register -  Connect a probe to a tracepoint
 336  * @tp: tracepoint
 337  * @probe: probe handler
 338  * @data: tracepoint data
 339  *
 340  * Returns 0 if ok, error value on error.
 341  * Note: if @tp is within a module, the caller is responsible for
 342  * unregistering the probe before the module is gone. This can be
 343  * performed either with a tracepoint module going notifier, or from
 344  * within module exit functions.
 345  */
 346 int tracepoint_probe_register(struct tracepoint *tp, void *probe, void *data)
 347 {
 348         return tracepoint_probe_register_prio(tp, probe, data, TRACEPOINT_DEFAULT_PRIO);
 349 }
 350 EXPORT_SYMBOL_GPL(tracepoint_probe_register);
 351
 352 /**
 353  * tracepoint_probe_unregister -  Disconnect a probe from a tracepoint
 354  * @tp: tracepoint
 355  * @probe: probe function pointer
 356  * @data: tracepoint data
 357  *
 358  * Returns 0 if ok, error value on error.
 359  */
 360 int tracepoint_probe_unregister(struct tracepoint *tp, void *probe, void *data)
 361 {
 362         struct tracepoint_func tp_func;
 363         int ret;
 364
 365         mutex_lock(&tracepoints_mutex);
 366         tp_func.func = probe;
 367         tp_func.data = data;
 368         ret = tracepoint_remove_func(tp, &tp_func);
 369         mutex_unlock(&tracepoints_mutex);
 370         return ret;
 371 }
 372 EXPORT_SYMBOL_GPL(tracepoint_probe_unregister);
 373
 374 #ifdef CONFIG_MODULES
 375 bool trace_module_has_bad_taint(struct module *mod)
 376 {
 377         return mod->taints & ~((1 << TAINT_OOT_MODULE) | (1 << TAINT_CRAP) |
 378                                (1 << TAINT_UNSIGNED_MODULE));
 379 }
 380
 381 static BLOCKING_NOTIFIER_HEAD(tracepoint_notify_list);
 382
 383 /**
 384  * register_tracepoint_notifier - register tracepoint coming/going notifier
 385  * @nb: notifier block
 386  *
 387  * Notifiers registered with this function are called on module
 388  * coming/going with the tracepoint_module_list_mutex held.
 389  * The notifier block callback should expect a "struct tp_module" data
 390  * pointer.
 391  */
 392 int register_tracepoint_module_notifier(struct notifier_block *nb)
 393 {
 394         struct tp_module *tp_mod;
 395         int ret;
 396
 397         mutex_lock(&tracepoint_module_list_mutex);
 398         ret = blocking_notifier_chain_register(&tracepoint_notify_list, nb);
 399         if (ret)
 400                 goto end;
 401         list_for_each_entry(tp_mod, &tracepoint_module_list, list)
 402                 (void) nb->notifier_call(nb, MODULE_STATE_COMING, tp_mod);
 403 end:
 404         mutex_unlock(&tracepoint_module_list_mutex);
 405         return ret;
 406 }
 407 EXPORT_SYMBOL_GPL(register_tracepoint_module_notifier);
 408
 409 /**
 410  * unregister_tracepoint_notifier - unregister tracepoint coming/going notifier
 411  * @nb: notifier block
 412  *
 413  * The notifier block callback should expect a "struct tp_module" data
 414  * pointer.
 415  */
 416 int unregister_tracepoint_module_notifier(struct notifier_block *nb)
 417 {
 418         struct tp_module *tp_mod;
 419         int ret;
 420
 421         mutex_lock(&tracepoint_module_list_mutex);
 422         ret = blocking_notifier_chain_unregister(&tracepoint_notify_list, nb);
 423         if (ret)
 424                 goto end;
 425         list_for_each_entry(tp_mod, &tracepoint_module_list, list)
 426                 (void) nb->notifier_call(nb, MODULE_STATE_GOING, tp_mod);
 427 end:
 428         mutex_unlock(&tracepoint_module_list_mutex);
 429         return ret;
 430
 431 }
 432 EXPORT_SYMBOL_GPL(unregister_tracepoint_module_notifier);
 433
 434 /*
 435  * Ensure the tracer unregistered the module's probes before the module
 436  * teardown is performed. Prevents leaks of probe and data pointers.
 437  */
 438 static void tp_module_going_check_quiescent(struct tracepoint * const *begin,
 439                 struct tracepoint * const *end)
 440 {
 441         struct tracepoint * const *iter;
 442
 443         if (!begin)
 444                 return;
 445         for (iter = begin; iter < end; iter++)
 446                 WARN_ON_ONCE((*iter)->funcs);
 447 }
 448
 449 static int tracepoint_module_coming(struct module *mod)
 450 {
 451         struct tp_module *tp_mod;
 452         int ret = 0;
 453
 454         if (!mod->num_tracepoints)
 455                 return 0;
 456
 457         /*
 458          * We skip modules that taint the kernel, especially those with different
 459          * module headers (for forced load), to make sure we don't cause a crash.
 460          * Staging, out-of-tree, and unsigned GPL modules are fine.
 461          */
 462         if (trace_module_has_bad_taint(mod))
 463                 return 0;
 464         mutex_lock(&tracepoint_module_list_mutex);
 465         tp_mod = kmalloc(sizeof(struct tp_module), GFP_KERNEL);
 466         if (!tp_mod) {
 467                 ret = -ENOMEM;
 468                 goto end;
 469         }
 470         tp_mod->mod = mod;
 471         list_add_tail(&tp_mod->list, &tracepoint_module_list);
 472         blocking_notifier_call_chain(&tracepoint_notify_list,
 473                         MODULE_STATE_COMING, tp_mod);
 474 end:
 475         mutex_unlock(&tracepoint_module_list_mutex);
 476         return ret;
 477 }
 478
 479 static void tracepoint_module_going(struct module *mod)
 480 {
 481         struct tp_module *tp_mod;
 482
 483         if (!mod->num_tracepoints)
 484                 return;
 485
 486         mutex_lock(&tracepoint_module_list_mutex);
 487         list_for_each_entry(tp_mod, &tracepoint_module_list, list) {
 488                 if (tp_mod->mod == mod) {
 489                         blocking_notifier_call_chain(&tracepoint_notify_list,
 490                                         MODULE_STATE_GOING, tp_mod);
 491                         list_del(&tp_mod->list);
 492                         kfree(tp_mod);
 493                         /*
 494                          * Called the going notifier before checking for
 495                          * quiescence.
 496                          */
 497                         tp_module_going_check_quiescent(mod->tracepoints_ptrs,
 498                                 mod->tracepoints_ptrs + mod->num_tracepoints);
 499                         break;
 500                 }
 501         }
 502         /*
 503          * In the case of modules that were tainted at "coming", we'll simply
 504          * walk through the list without finding it. We cannot use the "tainted"
 505          * flag on "going", in case a module taints the kernel only after being
 506          * loaded.
 507          */
 508         mutex_unlock(&tracepoint_module_list_mutex);
 509 }
 510
 511 static int tracepoint_module_notify(struct notifier_block *self,
 512                 unsigned long val, void *data)
 513 {
 514         struct module *mod = data;
 515         int ret = 0;
 516
 517         switch (val) {
 518         case MODULE_STATE_COMING:
 519                 ret = tracepoint_module_coming(mod);
 520                 break;
 521         case MODULE_STATE_LIVE:
 522                 break;
 523         case MODULE_STATE_GOING:
 524                 tracepoint_module_going(mod);
 525                 break;
 526         case MODULE_STATE_UNFORMED:
 527                 break;
 528         }
 529         return ret;
 530 }
 531
 532 static struct notifier_block tracepoint_module_nb = {
 533         .notifier_call = tracepoint_module_notify,
 534         .priority = 0,
 535 };
 536
 537 static __init int init_tracepoints(void)
 538 {
 539         int ret;
 540
 541         ret = register_module_notifier(&tracepoint_module_nb);
 542         if (ret)
 543                 pr_warn("Failed to register tracepoint module enter notifier\n");
 544
 545         return ret;
 546 }
 547 __initcall(init_tracepoints);
 548 #endif /* CONFIG_MODULES */
 549
 550 static void for_each_tracepoint_range(struct tracepoint * const *begin,
 551                 struct tracepoint * const *end,
 552                 void (*fct)(struct tracepoint *tp, void *priv),
 553                 void *priv)
 554 {
 555         struct tracepoint * const *iter;
 556
 557         if (!begin)
 558                 return;
 559         for (iter = begin; iter < end; iter++)
 560                 fct(*iter, priv);
 561 }
 562
 563 /**
 564  * for_each_kernel_tracepoint - iteration on all kernel tracepoints
 565  * @fct: callback
 566  * @priv: private data
 567  */
 568 void for_each_kernel_tracepoint(void (*fct)(struct tracepoint *tp, void *priv),
 569                 void *priv)
 570 {
 571         for_each_tracepoint_range(__start___tracepoints_ptrs,
 572                 __stop___tracepoints_ptrs, fct, priv);
 573 }
 574 EXPORT_SYMBOL_GPL(for_each_kernel_tracepoint);
 575
 576 #ifdef CONFIG_HAVE_SYSCALL_TRACEPOINTS
 577
 578 /* NB: reg/unreg are called while guarded with the tracepoints_mutex */
 579 static int sys_tracepoint_refcount;
 580
 581 int syscall_regfunc(void)
 582 {
 583         struct task_struct *p, *t;
 584
 585         if (!sys_tracepoint_refcount) {
 586                 read_lock(&tasklist_lock);
 587                 for_each_process_thread(p, t) {
 588                         set_tsk_thread_flag(t, TIF_SYSCALL_TRACEPOINT);
 589                 }
 590                 read_unlock(&tasklist_lock);
 591         }
 592         sys_tracepoint_refcount++;
 593
 594         return 0;
 595 }
 596
 597 void syscall_unregfunc(void)
 598 {
 599         struct task_struct *p, *t;
 600
 601         sys_tracepoint_refcount--;
 602         if (!sys_tracepoint_refcount) {
 603                 read_lock(&tasklist_lock);
 604                 for_each_process_thread(p, t) {
 605                         clear_tsk_thread_flag(t, TIF_SYSCALL_TRACEPOINT);
 606                 }
 607                 read_unlock(&tasklist_lock);
 608         }
 609 }
 610 #endif