kernel/tracepoint.c

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