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