2 * Copyright (C) 2008-2014 Mathieu Desnoyers
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.
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.
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.
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.h>
28 #include <linux/static_key.h>
30 extern struct tracepoint * const __start___tracepoints_ptrs[];
31 extern struct tracepoint * const __stop___tracepoints_ptrs[];
33 /* Set to 1 to enable tracepoint debug output */
34 static const int tracepoint_debug;
38 * Tracepoint module list mutex protects the local module list.
40 static DEFINE_MUTEX(tracepoint_module_list_mutex);
42 /* Local list of struct tp_module */
43 static LIST_HEAD(tracepoint_module_list);
44 #endif /* CONFIG_MODULES */
47 * tracepoints_mutex protects the builtin and module tracepoints.
48 * tracepoints_mutex nests inside tracepoint_module_list_mutex.
50 static DEFINE_MUTEX(tracepoints_mutex);
54 * It is used to delay the free of multiple probes array until a quiescent
59 struct tracepoint_func probes[0];
62 static inline void *allocate_probes(int count)
64 struct tp_probes *p = kmalloc(count * sizeof(struct tracepoint_func)
65 + sizeof(struct tp_probes), GFP_KERNEL);
66 return p == NULL ? NULL : p->probes;
69 static void rcu_free_old_probes(struct rcu_head *head)
71 kfree(container_of(head, struct tp_probes, rcu));
74 static inline void release_probes(struct tracepoint_func *old)
77 struct tp_probes *tp_probes = container_of(old,
78 struct tp_probes, probes[0]);
79 call_rcu_sched(&tp_probes->rcu, rcu_free_old_probes);
83 static void debug_print_probes(struct tracepoint_func *funcs)
87 if (!tracepoint_debug || !funcs)
90 for (i = 0; funcs[i].func; i++)
91 printk(KERN_DEBUG "Probe %d : %p\n", i, funcs[i].func);
94 static struct tracepoint_func *func_add(struct tracepoint_func **funcs,
95 struct tracepoint_func *tp_func)
98 struct tracepoint_func *old, *new;
100 if (WARN_ON(!tp_func->func))
101 return ERR_PTR(-EINVAL);
103 debug_print_probes(*funcs);
106 /* (N -> N+1), (N != 0, 1) probes */
107 for (nr_probes = 0; old[nr_probes].func; nr_probes++)
108 if (old[nr_probes].func == tp_func->func &&
109 old[nr_probes].data == tp_func->data)
110 return ERR_PTR(-EEXIST);
112 /* + 2 : one for new probe, one for NULL func */
113 new = allocate_probes(nr_probes + 2);
115 return ERR_PTR(-ENOMEM);
117 memcpy(new, old, nr_probes * sizeof(struct tracepoint_func));
118 new[nr_probes] = *tp_func;
119 new[nr_probes + 1].func = NULL;
121 debug_print_probes(*funcs);
125 static void *func_remove(struct tracepoint_func **funcs,
126 struct tracepoint_func *tp_func)
128 int nr_probes = 0, nr_del = 0, i;
129 struct tracepoint_func *old, *new;
134 return ERR_PTR(-ENOENT);
136 debug_print_probes(*funcs);
137 /* (N -> M), (N > 1, M >= 0) probes */
139 for (nr_probes = 0; old[nr_probes].func; nr_probes++) {
140 if (old[nr_probes].func == tp_func->func &&
141 old[nr_probes].data == tp_func->data)
147 * If probe is NULL, then nr_probes = nr_del = 0, and then the
148 * entire entry will be removed.
150 if (nr_probes - nr_del == 0) {
151 /* N -> 0, (N > 1) */
153 debug_print_probes(*funcs);
157 /* N -> M, (N > 1, M > 0) */
159 new = allocate_probes(nr_probes - nr_del + 1);
161 return ERR_PTR(-ENOMEM);
162 for (i = 0; old[i].func; i++)
163 if (old[i].func != tp_func->func
164 || old[i].data != tp_func->data)
166 new[nr_probes - nr_del].func = NULL;
169 debug_print_probes(*funcs);
174 * Add the probe function to a tracepoint.
176 static int tracepoint_add_func(struct tracepoint *tp,
177 struct tracepoint_func *func)
179 struct tracepoint_func *old, *tp_funcs;
181 if (tp->regfunc && !static_key_enabled(&tp->key))
184 tp_funcs = tp->funcs;
185 old = func_add(&tp_funcs, func);
193 * rcu_assign_pointer has a smp_wmb() which makes sure that the new
194 * probe callbacks array is consistent before setting a pointer to it.
195 * This array is referenced by __DO_TRACE from
196 * include/linux/tracepoints.h. A matching smp_read_barrier_depends()
199 rcu_assign_pointer(tp->funcs, tp_funcs);
200 if (!static_key_enabled(&tp->key))
201 static_key_slow_inc(&tp->key);
206 * Remove a probe function from a tracepoint.
207 * Note: only waiting an RCU period after setting elem->call to the empty
208 * function insures that the original callback is not used anymore. This insured
209 * by preempt_disable around the call site.
211 static int tracepoint_remove_func(struct tracepoint *tp,
212 struct tracepoint_func *func)
214 struct tracepoint_func *old, *tp_funcs;
216 tp_funcs = tp->funcs;
217 old = func_remove(&tp_funcs, func);
225 /* Removed last function */
226 if (tp->unregfunc && static_key_enabled(&tp->key))
229 if (static_key_enabled(&tp->key))
230 static_key_slow_dec(&tp->key);
232 rcu_assign_pointer(tp->funcs, tp_funcs);
237 * tracepoint_probe_register - Connect a probe to a tracepoint
239 * @probe: probe handler
241 * Returns 0 if ok, error value on error.
242 * Note: if @tp is within a module, the caller is responsible for
243 * unregistering the probe before the module is gone. This can be
244 * performed either with a tracepoint module going notifier, or from
245 * within module exit functions.
247 int tracepoint_probe_register(struct tracepoint *tp, void *probe, void *data)
249 struct tracepoint_func tp_func;
252 mutex_lock(&tracepoints_mutex);
253 tp_func.func = probe;
255 ret = tracepoint_add_func(tp, &tp_func);
256 mutex_unlock(&tracepoints_mutex);
259 EXPORT_SYMBOL_GPL(tracepoint_probe_register);
262 * tracepoint_probe_unregister - Disconnect a probe from a tracepoint
264 * @probe: probe function pointer
266 * Returns 0 if ok, error value on error.
268 int tracepoint_probe_unregister(struct tracepoint *tp, void *probe, void *data)
270 struct tracepoint_func tp_func;
273 mutex_lock(&tracepoints_mutex);
274 tp_func.func = probe;
276 ret = tracepoint_remove_func(tp, &tp_func);
277 mutex_unlock(&tracepoints_mutex);
280 EXPORT_SYMBOL_GPL(tracepoint_probe_unregister);
282 #ifdef CONFIG_MODULES
283 bool trace_module_has_bad_taint(struct module *mod)
285 return mod->taints & ~((1 << TAINT_OOT_MODULE) | (1 << TAINT_CRAP));
288 static BLOCKING_NOTIFIER_HEAD(tracepoint_notify_list);
291 * register_tracepoint_notifier - register tracepoint coming/going notifier
292 * @nb: notifier block
294 * Notifiers registered with this function are called on module
295 * coming/going with the tracepoint_module_list_mutex held.
296 * The notifier block callback should expect a "struct tp_module" data
299 int register_tracepoint_module_notifier(struct notifier_block *nb)
301 struct tp_module *tp_mod;
304 mutex_lock(&tracepoint_module_list_mutex);
305 ret = blocking_notifier_chain_register(&tracepoint_notify_list, nb);
308 list_for_each_entry(tp_mod, &tracepoint_module_list, list)
309 (void) nb->notifier_call(nb, MODULE_STATE_COMING, tp_mod);
311 mutex_unlock(&tracepoint_module_list_mutex);
314 EXPORT_SYMBOL_GPL(register_tracepoint_module_notifier);
317 * unregister_tracepoint_notifier - unregister tracepoint coming/going notifier
318 * @nb: notifier block
320 * The notifier block callback should expect a "struct tp_module" data
323 int unregister_tracepoint_module_notifier(struct notifier_block *nb)
325 struct tp_module *tp_mod;
328 mutex_lock(&tracepoint_module_list_mutex);
329 ret = blocking_notifier_chain_unregister(&tracepoint_notify_list, nb);
332 list_for_each_entry(tp_mod, &tracepoint_module_list, list)
333 (void) nb->notifier_call(nb, MODULE_STATE_GOING, tp_mod);
335 mutex_unlock(&tracepoint_module_list_mutex);
339 EXPORT_SYMBOL_GPL(unregister_tracepoint_module_notifier);
342 * Ensure the tracer unregistered the module's probes before the module
343 * teardown is performed. Prevents leaks of probe and data pointers.
345 static void tp_module_going_check_quiescent(struct tracepoint * const *begin,
346 struct tracepoint * const *end)
348 struct tracepoint * const *iter;
352 for (iter = begin; iter < end; iter++)
353 WARN_ON_ONCE((*iter)->funcs);
356 static int tracepoint_module_coming(struct module *mod)
358 struct tp_module *tp_mod;
361 if (!mod->num_tracepoints)
365 * We skip modules that taint the kernel, especially those with different
366 * module headers (for forced load), to make sure we don't cause a crash.
367 * Staging and out-of-tree GPL modules are fine.
369 if (trace_module_has_bad_taint(mod))
371 mutex_lock(&tracepoint_module_list_mutex);
372 tp_mod = kmalloc(sizeof(struct tp_module), GFP_KERNEL);
377 tp_mod->num_tracepoints = mod->num_tracepoints;
378 tp_mod->tracepoints_ptrs = mod->tracepoints_ptrs;
379 list_add_tail(&tp_mod->list, &tracepoint_module_list);
380 blocking_notifier_call_chain(&tracepoint_notify_list,
381 MODULE_STATE_COMING, tp_mod);
383 mutex_unlock(&tracepoint_module_list_mutex);
387 static void tracepoint_module_going(struct module *mod)
389 struct tp_module *tp_mod;
391 if (!mod->num_tracepoints)
394 mutex_lock(&tracepoint_module_list_mutex);
395 list_for_each_entry(tp_mod, &tracepoint_module_list, list) {
396 if (tp_mod->tracepoints_ptrs == mod->tracepoints_ptrs) {
397 blocking_notifier_call_chain(&tracepoint_notify_list,
398 MODULE_STATE_GOING, tp_mod);
399 list_del(&tp_mod->list);
402 * Called the going notifier before checking for
405 tp_module_going_check_quiescent(mod->tracepoints_ptrs,
406 mod->tracepoints_ptrs + mod->num_tracepoints);
411 * In the case of modules that were tainted at "coming", we'll simply
412 * walk through the list without finding it. We cannot use the "tainted"
413 * flag on "going", in case a module taints the kernel only after being
416 mutex_unlock(&tracepoint_module_list_mutex);
419 static int tracepoint_module_notify(struct notifier_block *self,
420 unsigned long val, void *data)
422 struct module *mod = data;
426 case MODULE_STATE_COMING:
427 ret = tracepoint_module_coming(mod);
429 case MODULE_STATE_LIVE:
431 case MODULE_STATE_GOING:
432 tracepoint_module_going(mod);
434 case MODULE_STATE_UNFORMED:
440 static struct notifier_block tracepoint_module_nb = {
441 .notifier_call = tracepoint_module_notify,
445 static __init int init_tracepoints(void)
449 ret = register_module_notifier(&tracepoint_module_nb);
451 pr_warning("Failed to register tracepoint module enter notifier\n");
455 __initcall(init_tracepoints);
456 #endif /* CONFIG_MODULES */
458 static void for_each_tracepoint_range(struct tracepoint * const *begin,
459 struct tracepoint * const *end,
460 void (*fct)(struct tracepoint *tp, void *priv),
463 struct tracepoint * const *iter;
467 for (iter = begin; iter < end; iter++)
472 * for_each_kernel_tracepoint - iteration on all kernel tracepoints
474 * @priv: private data
476 void for_each_kernel_tracepoint(void (*fct)(struct tracepoint *tp, void *priv),
479 for_each_tracepoint_range(__start___tracepoints_ptrs,
480 __stop___tracepoints_ptrs, fct, priv);
482 EXPORT_SYMBOL_GPL(for_each_kernel_tracepoint);
484 #ifdef CONFIG_HAVE_SYSCALL_TRACEPOINTS
486 /* NB: reg/unreg are called while guarded with the tracepoints_mutex */
487 static int sys_tracepoint_refcount;
489 void syscall_regfunc(void)
492 struct task_struct *g, *t;
494 if (!sys_tracepoint_refcount) {
495 read_lock_irqsave(&tasklist_lock, flags);
496 do_each_thread(g, t) {
497 /* Skip kernel threads. */
499 set_tsk_thread_flag(t, TIF_SYSCALL_TRACEPOINT);
500 } while_each_thread(g, t);
501 read_unlock_irqrestore(&tasklist_lock, flags);
503 sys_tracepoint_refcount++;
506 void syscall_unregfunc(void)
509 struct task_struct *g, *t;
511 sys_tracepoint_refcount--;
512 if (!sys_tracepoint_refcount) {
513 read_lock_irqsave(&tasklist_lock, flags);
514 do_each_thread(g, t) {
515 clear_tsk_thread_flag(t, TIF_SYSCALL_TRACEPOINT);
516 } while_each_thread(g, t);
517 read_unlock_irqrestore(&tasklist_lock, flags);