2 * Copyright (C) 2008 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/jump_label.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
;
37 * Tracepoints mutex protects the builtin and module tracepoints and the hash
38 * table, as well as the local module list.
40 static DEFINE_MUTEX(tracepoints_mutex
);
43 /* Local list of struct module */
44 static LIST_HEAD(tracepoint_module_list
);
45 #endif /* CONFIG_MODULES */
48 * Tracepoint hash table, containing the active tracepoints.
49 * Protected by tracepoints_mutex.
51 #define TRACEPOINT_HASH_BITS 6
52 #define TRACEPOINT_TABLE_SIZE (1 << TRACEPOINT_HASH_BITS)
53 static struct hlist_head tracepoint_table
[TRACEPOINT_TABLE_SIZE
];
57 * It is used to delay the free of multiple probes array until a quiescent
59 * Tracepoint entries modifications are protected by the tracepoints_mutex.
61 struct tracepoint_entry
{
62 struct hlist_node hlist
;
63 struct tracepoint_func
*funcs
;
64 int refcount
; /* Number of times armed. 0 if disarmed. */
71 struct list_head list
;
73 struct tracepoint_func probes
[0];
76 static inline void *allocate_probes(int count
)
78 struct tp_probes
*p
= kmalloc(count
* sizeof(struct tracepoint_func
)
79 + sizeof(struct tp_probes
), GFP_KERNEL
);
80 return p
== NULL
? NULL
: p
->probes
;
83 static void rcu_free_old_probes(struct rcu_head
*head
)
85 kfree(container_of(head
, struct tp_probes
, u
.rcu
));
88 static inline void release_probes(struct tracepoint_func
*old
)
91 struct tp_probes
*tp_probes
= container_of(old
,
92 struct tp_probes
, probes
[0]);
93 call_rcu_sched(&tp_probes
->u
.rcu
, rcu_free_old_probes
);
97 static void debug_print_probes(struct tracepoint_entry
*entry
)
101 if (!tracepoint_debug
|| !entry
->funcs
)
104 for (i
= 0; entry
->funcs
[i
].func
; i
++)
105 printk(KERN_DEBUG
"Probe %d : %p\n", i
, entry
->funcs
[i
].func
);
108 static struct tracepoint_func
*
109 tracepoint_entry_add_probe(struct tracepoint_entry
*entry
,
110 void *probe
, void *data
)
113 struct tracepoint_func
*old
, *new;
117 debug_print_probes(entry
);
120 /* (N -> N+1), (N != 0, 1) probes */
121 for (nr_probes
= 0; old
[nr_probes
].func
; nr_probes
++)
122 if (old
[nr_probes
].func
== probe
&&
123 old
[nr_probes
].data
== data
)
124 return ERR_PTR(-EEXIST
);
126 /* + 2 : one for new probe, one for NULL func */
127 new = allocate_probes(nr_probes
+ 2);
129 return ERR_PTR(-ENOMEM
);
131 memcpy(new, old
, nr_probes
* sizeof(struct tracepoint_func
));
132 new[nr_probes
].func
= probe
;
133 new[nr_probes
].data
= data
;
134 new[nr_probes
+ 1].func
= NULL
;
135 entry
->refcount
= nr_probes
+ 1;
137 debug_print_probes(entry
);
142 tracepoint_entry_remove_probe(struct tracepoint_entry
*entry
,
143 void *probe
, void *data
)
145 int nr_probes
= 0, nr_del
= 0, i
;
146 struct tracepoint_func
*old
, *new;
151 return ERR_PTR(-ENOENT
);
153 debug_print_probes(entry
);
154 /* (N -> M), (N > 1, M >= 0) probes */
155 for (nr_probes
= 0; old
[nr_probes
].func
; nr_probes
++) {
157 (old
[nr_probes
].func
== probe
&&
158 old
[nr_probes
].data
== data
))
162 if (nr_probes
- nr_del
== 0) {
163 /* N -> 0, (N > 1) */
166 debug_print_probes(entry
);
170 /* N -> M, (N > 1, M > 0) */
172 new = allocate_probes(nr_probes
- nr_del
+ 1);
174 return ERR_PTR(-ENOMEM
);
175 for (i
= 0; old
[i
].func
; i
++)
177 (old
[i
].func
!= probe
|| old
[i
].data
!= data
))
179 new[nr_probes
- nr_del
].func
= NULL
;
180 entry
->refcount
= nr_probes
- nr_del
;
183 debug_print_probes(entry
);
188 * Get tracepoint if the tracepoint is present in the tracepoint hash table.
189 * Must be called with tracepoints_mutex held.
190 * Returns NULL if not present.
192 static struct tracepoint_entry
*get_tracepoint(const char *name
)
194 struct hlist_head
*head
;
195 struct hlist_node
*node
;
196 struct tracepoint_entry
*e
;
197 u32 hash
= jhash(name
, strlen(name
), 0);
199 head
= &tracepoint_table
[hash
& (TRACEPOINT_TABLE_SIZE
- 1)];
200 hlist_for_each_entry(e
, node
, head
, hlist
) {
201 if (!strcmp(name
, e
->name
))
208 * Add the tracepoint to the tracepoint hash table. Must be called with
209 * tracepoints_mutex held.
211 static struct tracepoint_entry
*add_tracepoint(const char *name
)
213 struct hlist_head
*head
;
214 struct hlist_node
*node
;
215 struct tracepoint_entry
*e
;
216 size_t name_len
= strlen(name
) + 1;
217 u32 hash
= jhash(name
, name_len
-1, 0);
219 head
= &tracepoint_table
[hash
& (TRACEPOINT_TABLE_SIZE
- 1)];
220 hlist_for_each_entry(e
, node
, head
, hlist
) {
221 if (!strcmp(name
, e
->name
)) {
223 "tracepoint %s busy\n", name
);
224 return ERR_PTR(-EEXIST
); /* Already there */
228 * Using kmalloc here to allocate a variable length element. Could
229 * cause some memory fragmentation if overused.
231 e
= kmalloc(sizeof(struct tracepoint_entry
) + name_len
, GFP_KERNEL
);
233 return ERR_PTR(-ENOMEM
);
234 memcpy(&e
->name
[0], name
, name_len
);
237 hlist_add_head(&e
->hlist
, head
);
242 * Remove the tracepoint from the tracepoint hash table. Must be called with
245 static inline void remove_tracepoint(struct tracepoint_entry
*e
)
247 hlist_del(&e
->hlist
);
252 * Sets the probe callback corresponding to one tracepoint.
254 static void set_tracepoint(struct tracepoint_entry
**entry
,
255 struct tracepoint
*elem
, int active
)
257 WARN_ON(strcmp((*entry
)->name
, elem
->name
) != 0);
259 if (elem
->regfunc
&& !jump_label_enabled(&elem
->key
) && active
)
261 else if (elem
->unregfunc
&& jump_label_enabled(&elem
->key
) && !active
)
265 * rcu_assign_pointer has a smp_wmb() which makes sure that the new
266 * probe callbacks array is consistent before setting a pointer to it.
267 * This array is referenced by __DO_TRACE from
268 * include/linux/tracepoints.h. A matching smp_read_barrier_depends()
271 rcu_assign_pointer(elem
->funcs
, (*entry
)->funcs
);
272 if (active
&& !jump_label_enabled(&elem
->key
))
273 jump_label_inc(&elem
->key
);
274 else if (!active
&& jump_label_enabled(&elem
->key
))
275 jump_label_dec(&elem
->key
);
279 * Disable a tracepoint and its probe callback.
280 * Note: only waiting an RCU period after setting elem->call to the empty
281 * function insures that the original callback is not used anymore. This insured
282 * by preempt_disable around the call site.
284 static void disable_tracepoint(struct tracepoint
*elem
)
286 if (elem
->unregfunc
&& jump_label_enabled(&elem
->key
))
289 if (jump_label_enabled(&elem
->key
))
290 jump_label_dec(&elem
->key
);
291 rcu_assign_pointer(elem
->funcs
, NULL
);
295 * tracepoint_update_probe_range - Update a probe range
296 * @begin: beginning of the range
297 * @end: end of the range
299 * Updates the probe callback corresponding to a range of tracepoints.
300 * Called with tracepoints_mutex held.
302 static void tracepoint_update_probe_range(struct tracepoint
* const *begin
,
303 struct tracepoint
* const *end
)
305 struct tracepoint
* const *iter
;
306 struct tracepoint_entry
*mark_entry
;
311 for (iter
= begin
; iter
< end
; iter
++) {
312 mark_entry
= get_tracepoint((*iter
)->name
);
314 set_tracepoint(&mark_entry
, *iter
,
315 !!mark_entry
->refcount
);
317 disable_tracepoint(*iter
);
322 #ifdef CONFIG_MODULES
323 void module_update_tracepoints(void)
325 struct tp_module
*tp_mod
;
327 list_for_each_entry(tp_mod
, &tracepoint_module_list
, list
)
328 tracepoint_update_probe_range(tp_mod
->tracepoints_ptrs
,
329 tp_mod
->tracepoints_ptrs
+ tp_mod
->num_tracepoints
);
331 #else /* CONFIG_MODULES */
332 void module_update_tracepoints(void)
335 #endif /* CONFIG_MODULES */
339 * Update probes, removing the faulty probes.
340 * Called with tracepoints_mutex held.
342 static void tracepoint_update_probes(void)
344 /* Core kernel tracepoints */
345 tracepoint_update_probe_range(__start___tracepoints_ptrs
,
346 __stop___tracepoints_ptrs
);
347 /* tracepoints in modules. */
348 module_update_tracepoints();
351 static struct tracepoint_func
*
352 tracepoint_add_probe(const char *name
, void *probe
, void *data
)
354 struct tracepoint_entry
*entry
;
355 struct tracepoint_func
*old
;
357 entry
= get_tracepoint(name
);
359 entry
= add_tracepoint(name
);
361 return (struct tracepoint_func
*)entry
;
363 old
= tracepoint_entry_add_probe(entry
, probe
, data
);
364 if (IS_ERR(old
) && !entry
->refcount
)
365 remove_tracepoint(entry
);
370 * tracepoint_probe_register - Connect a probe to a tracepoint
371 * @name: tracepoint name
372 * @probe: probe handler
374 * Returns 0 if ok, error value on error.
375 * The probe address must at least be aligned on the architecture pointer size.
377 int tracepoint_probe_register(const char *name
, void *probe
, void *data
)
379 struct tracepoint_func
*old
;
381 mutex_lock(&tracepoints_mutex
);
382 old
= tracepoint_add_probe(name
, probe
, data
);
384 mutex_unlock(&tracepoints_mutex
);
387 tracepoint_update_probes(); /* may update entry */
388 mutex_unlock(&tracepoints_mutex
);
392 EXPORT_SYMBOL_GPL(tracepoint_probe_register
);
394 static struct tracepoint_func
*
395 tracepoint_remove_probe(const char *name
, void *probe
, void *data
)
397 struct tracepoint_entry
*entry
;
398 struct tracepoint_func
*old
;
400 entry
= get_tracepoint(name
);
402 return ERR_PTR(-ENOENT
);
403 old
= tracepoint_entry_remove_probe(entry
, probe
, data
);
406 if (!entry
->refcount
)
407 remove_tracepoint(entry
);
412 * tracepoint_probe_unregister - Disconnect a probe from a tracepoint
413 * @name: tracepoint name
414 * @probe: probe function pointer
416 * We do not need to call a synchronize_sched to make sure the probes have
417 * finished running before doing a module unload, because the module unload
418 * itself uses stop_machine(), which insures that every preempt disabled section
421 int tracepoint_probe_unregister(const char *name
, void *probe
, void *data
)
423 struct tracepoint_func
*old
;
425 mutex_lock(&tracepoints_mutex
);
426 old
= tracepoint_remove_probe(name
, probe
, data
);
428 mutex_unlock(&tracepoints_mutex
);
431 tracepoint_update_probes(); /* may update entry */
432 mutex_unlock(&tracepoints_mutex
);
436 EXPORT_SYMBOL_GPL(tracepoint_probe_unregister
);
438 static LIST_HEAD(old_probes
);
439 static int need_update
;
441 static void tracepoint_add_old_probes(void *old
)
445 struct tp_probes
*tp_probes
= container_of(old
,
446 struct tp_probes
, probes
[0]);
447 list_add(&tp_probes
->u
.list
, &old_probes
);
452 * tracepoint_probe_register_noupdate - register a probe but not connect
453 * @name: tracepoint name
454 * @probe: probe handler
456 * caller must call tracepoint_probe_update_all()
458 int tracepoint_probe_register_noupdate(const char *name
, void *probe
,
461 struct tracepoint_func
*old
;
463 mutex_lock(&tracepoints_mutex
);
464 old
= tracepoint_add_probe(name
, probe
, data
);
466 mutex_unlock(&tracepoints_mutex
);
469 tracepoint_add_old_probes(old
);
470 mutex_unlock(&tracepoints_mutex
);
473 EXPORT_SYMBOL_GPL(tracepoint_probe_register_noupdate
);
476 * tracepoint_probe_unregister_noupdate - remove a probe but not disconnect
477 * @name: tracepoint name
478 * @probe: probe function pointer
480 * caller must call tracepoint_probe_update_all()
482 int tracepoint_probe_unregister_noupdate(const char *name
, void *probe
,
485 struct tracepoint_func
*old
;
487 mutex_lock(&tracepoints_mutex
);
488 old
= tracepoint_remove_probe(name
, probe
, data
);
490 mutex_unlock(&tracepoints_mutex
);
493 tracepoint_add_old_probes(old
);
494 mutex_unlock(&tracepoints_mutex
);
497 EXPORT_SYMBOL_GPL(tracepoint_probe_unregister_noupdate
);
500 * tracepoint_probe_update_all - update tracepoints
502 void tracepoint_probe_update_all(void)
504 LIST_HEAD(release_probes
);
505 struct tp_probes
*pos
, *next
;
507 mutex_lock(&tracepoints_mutex
);
509 mutex_unlock(&tracepoints_mutex
);
512 if (!list_empty(&old_probes
))
513 list_replace_init(&old_probes
, &release_probes
);
515 tracepoint_update_probes();
516 mutex_unlock(&tracepoints_mutex
);
517 list_for_each_entry_safe(pos
, next
, &release_probes
, u
.list
) {
518 list_del(&pos
->u
.list
);
519 call_rcu_sched(&pos
->u
.rcu
, rcu_free_old_probes
);
522 EXPORT_SYMBOL_GPL(tracepoint_probe_update_all
);
525 * tracepoint_get_iter_range - Get a next tracepoint iterator given a range.
526 * @tracepoint: current tracepoints (in), next tracepoint (out)
527 * @begin: beginning of the range
528 * @end: end of the range
530 * Returns whether a next tracepoint has been found (1) or not (0).
531 * Will return the first tracepoint in the range if the input tracepoint is
534 static int tracepoint_get_iter_range(struct tracepoint
* const **tracepoint
,
535 struct tracepoint
* const *begin
, struct tracepoint
* const *end
)
537 if (!*tracepoint
&& begin
!= end
) {
541 if (*tracepoint
>= begin
&& *tracepoint
< end
)
546 #ifdef CONFIG_MODULES
547 static void tracepoint_get_iter(struct tracepoint_iter
*iter
)
550 struct tp_module
*iter_mod
;
552 /* Core kernel tracepoints */
554 found
= tracepoint_get_iter_range(&iter
->tracepoint
,
555 __start___tracepoints_ptrs
,
556 __stop___tracepoints_ptrs
);
560 /* Tracepoints in modules */
561 mutex_lock(&tracepoints_mutex
);
562 list_for_each_entry(iter_mod
, &tracepoint_module_list
, list
) {
566 if (iter_mod
< iter
->module
)
568 else if (iter_mod
> iter
->module
)
569 iter
->tracepoint
= NULL
;
570 found
= tracepoint_get_iter_range(&iter
->tracepoint
,
571 iter_mod
->tracepoints_ptrs
,
572 iter_mod
->tracepoints_ptrs
573 + iter_mod
->num_tracepoints
);
575 iter
->module
= iter_mod
;
579 mutex_unlock(&tracepoints_mutex
);
582 tracepoint_iter_reset(iter
);
584 #else /* CONFIG_MODULES */
585 static void tracepoint_get_iter(struct tracepoint_iter
*iter
)
589 /* Core kernel tracepoints */
590 found
= tracepoint_get_iter_range(&iter
->tracepoint
,
591 __start___tracepoints_ptrs
,
592 __stop___tracepoints_ptrs
);
594 tracepoint_iter_reset(iter
);
596 #endif /* CONFIG_MODULES */
598 void tracepoint_iter_start(struct tracepoint_iter
*iter
)
600 tracepoint_get_iter(iter
);
602 EXPORT_SYMBOL_GPL(tracepoint_iter_start
);
604 void tracepoint_iter_next(struct tracepoint_iter
*iter
)
608 * iter->tracepoint may be invalid because we blindly incremented it.
609 * Make sure it is valid by marshalling on the tracepoints, getting the
610 * tracepoints from following modules if necessary.
612 tracepoint_get_iter(iter
);
614 EXPORT_SYMBOL_GPL(tracepoint_iter_next
);
616 void tracepoint_iter_stop(struct tracepoint_iter
*iter
)
619 EXPORT_SYMBOL_GPL(tracepoint_iter_stop
);
621 void tracepoint_iter_reset(struct tracepoint_iter
*iter
)
623 #ifdef CONFIG_MODULES
625 #endif /* CONFIG_MODULES */
626 iter
->tracepoint
= NULL
;
628 EXPORT_SYMBOL_GPL(tracepoint_iter_reset
);
630 #ifdef CONFIG_MODULES
631 static int tracepoint_module_coming(struct module
*mod
)
633 struct tp_module
*tp_mod
, *iter
;
637 * We skip modules that tain the kernel, especially those with different
638 * module header (for forced load), to make sure we don't cause a crash.
642 mutex_lock(&tracepoints_mutex
);
643 tp_mod
= kmalloc(sizeof(struct tp_module
), GFP_KERNEL
);
648 tp_mod
->num_tracepoints
= mod
->num_tracepoints
;
649 tp_mod
->tracepoints_ptrs
= mod
->tracepoints_ptrs
;
652 * tracepoint_module_list is kept sorted by struct module pointer
653 * address for iteration on tracepoints from a seq_file that can release
654 * the mutex between calls.
656 list_for_each_entry_reverse(iter
, &tracepoint_module_list
, list
) {
657 BUG_ON(iter
== tp_mod
); /* Should never be in the list twice */
659 /* We belong to the location right after iter. */
660 list_add(&tp_mod
->list
, &iter
->list
);
664 /* We belong to the beginning of the list */
665 list_add(&tp_mod
->list
, &tracepoint_module_list
);
667 tracepoint_update_probe_range(mod
->tracepoints_ptrs
,
668 mod
->tracepoints_ptrs
+ mod
->num_tracepoints
);
670 mutex_unlock(&tracepoints_mutex
);
674 static int tracepoint_module_going(struct module
*mod
)
676 struct tp_module
*pos
;
678 mutex_lock(&tracepoints_mutex
);
679 tracepoint_update_probe_range(mod
->tracepoints_ptrs
,
680 mod
->tracepoints_ptrs
+ mod
->num_tracepoints
);
681 list_for_each_entry(pos
, &tracepoint_module_list
, list
) {
682 if (pos
->tracepoints_ptrs
== mod
->tracepoints_ptrs
) {
683 list_del(&pos
->list
);
689 * In the case of modules that were tainted at "coming", we'll simply
690 * walk through the list without finding it. We cannot use the "tainted"
691 * flag on "going", in case a module taints the kernel only after being
694 mutex_unlock(&tracepoints_mutex
);
698 int tracepoint_module_notify(struct notifier_block
*self
,
699 unsigned long val
, void *data
)
701 struct module
*mod
= data
;
705 case MODULE_STATE_COMING
:
706 ret
= tracepoint_module_coming(mod
);
708 case MODULE_STATE_LIVE
:
710 case MODULE_STATE_GOING
:
711 ret
= tracepoint_module_going(mod
);
717 struct notifier_block tracepoint_module_nb
= {
718 .notifier_call
= tracepoint_module_notify
,
722 static int init_tracepoints(void)
724 return register_module_notifier(&tracepoint_module_nb
);
726 __initcall(init_tracepoints
);
727 #endif /* CONFIG_MODULES */
729 #ifdef CONFIG_HAVE_SYSCALL_TRACEPOINTS
731 /* NB: reg/unreg are called while guarded with the tracepoints_mutex */
732 static int sys_tracepoint_refcount
;
734 void syscall_regfunc(void)
737 struct task_struct
*g
, *t
;
739 if (!sys_tracepoint_refcount
) {
740 read_lock_irqsave(&tasklist_lock
, flags
);
741 do_each_thread(g
, t
) {
742 /* Skip kernel threads. */
744 set_tsk_thread_flag(t
, TIF_SYSCALL_TRACEPOINT
);
745 } while_each_thread(g
, t
);
746 read_unlock_irqrestore(&tasklist_lock
, flags
);
748 sys_tracepoint_refcount
++;
751 void syscall_unregfunc(void)
754 struct task_struct
*g
, *t
;
756 sys_tracepoint_refcount
--;
757 if (!sys_tracepoint_refcount
) {
758 read_lock_irqsave(&tasklist_lock
, flags
);
759 do_each_thread(g
, t
) {
760 clear_tsk_thread_flag(t
, TIF_SYSCALL_TRACEPOINT
);
761 } while_each_thread(g
, t
);
762 read_unlock_irqrestore(&tasklist_lock
, flags
);