2 * Copyright (C) 2008-2011 Mathieu Desnoyers
3 * Copyright (C) 2009 Pierre-Marc Fournier
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation;
8 * version 2.1 of the License.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19 * Ported to userspace by Pierre-Marc Fournier.
28 #include <urcu/arch.h>
30 #include <urcu/hlist.h>
31 #include <urcu/uatomic.h>
32 #include <urcu/compiler.h>
34 #include <lttng/tracepoint.h>
35 #include <lttng/ust-abi.h> /* for LTTNG_UST_SYM_NAME_LEN */
37 #include <usterr-signal-safe.h>
40 #include "tracepoint-internal.h"
41 #include "lttng-tracer-core.h"
45 /* Set to 1 to enable tracepoint debug output */
46 static const int tracepoint_debug
;
47 static int initialized
;
48 static void (*new_tracepoint_cb
)(struct tracepoint
*);
51 * tracepoint_mutex nests inside UST mutex.
53 * Note about interaction with fork/clone: UST does not hold the
54 * tracepoint mutex across fork/clone because it is either:
55 * - nested within UST mutex, in which case holding the UST mutex across
57 * - taken by a library constructor, which should never race with a
58 * fork/clone if the application is expected to continue running with
59 * the same memory layout (no following exec()).
61 static pthread_mutex_t tracepoint_mutex
= PTHREAD_MUTEX_INITIALIZER
;
64 * libraries that contain tracepoints (struct tracepoint_lib).
65 * Protected by tracepoint mutex.
67 static CDS_LIST_HEAD(libs
);
70 * The tracepoint mutex protects the library tracepoints, the hash table, and
72 * All calls to the tracepoint API must be protected by the tracepoint mutex,
73 * excepts calls to tracepoint_register_lib and
74 * tracepoint_unregister_lib, which take the tracepoint mutex themselves.
78 * Tracepoint hash table, containing the active tracepoints.
79 * Protected by tracepoint mutex.
81 #define TRACEPOINT_HASH_BITS 12
82 #define TRACEPOINT_TABLE_SIZE (1 << TRACEPOINT_HASH_BITS)
83 static struct cds_hlist_head tracepoint_table
[TRACEPOINT_TABLE_SIZE
];
85 static CDS_LIST_HEAD(old_probes
);
86 static int need_update
;
90 * It is used to to delay the free of multiple probes array until a quiescent
92 * Tracepoint entries modifications are protected by the tracepoint mutex.
94 struct tracepoint_entry
{
95 struct cds_hlist_node hlist
;
96 struct tracepoint_probe
*probes
;
97 int refcount
; /* Number of times armed. 0 if disarmed. */
98 const char *signature
;
104 struct cds_list_head list
;
105 /* Field below only used for call_rcu scheme */
106 /* struct rcu_head head; */
108 struct tracepoint_probe probes
[0];
111 static void *allocate_probes(int count
)
113 struct tp_probes
*p
= zmalloc(count
* sizeof(struct tracepoint_probe
)
114 + sizeof(struct tp_probes
));
115 return p
== NULL
? NULL
: p
->probes
;
118 static void release_probes(void *old
)
121 struct tp_probes
*tp_probes
= caa_container_of(old
,
122 struct tp_probes
, probes
[0]);
128 static void debug_print_probes(struct tracepoint_entry
*entry
)
132 if (!tracepoint_debug
|| !entry
->probes
)
135 for (i
= 0; entry
->probes
[i
].func
; i
++)
136 DBG("Probe %d : %p", i
, entry
->probes
[i
].func
);
140 tracepoint_entry_add_probe(struct tracepoint_entry
*entry
,
141 void (*probe
)(void), void *data
)
144 struct tracepoint_probe
*old
, *new;
148 debug_print_probes(entry
);
151 /* (N -> N+1), (N != 0, 1) probes */
152 for (nr_probes
= 0; old
[nr_probes
].func
; nr_probes
++)
153 if (old
[nr_probes
].func
== probe
&&
154 old
[nr_probes
].data
== data
)
155 return ERR_PTR(-EEXIST
);
157 /* + 2 : one for new probe, one for NULL func */
158 new = allocate_probes(nr_probes
+ 2);
160 return ERR_PTR(-ENOMEM
);
162 memcpy(new, old
, nr_probes
* sizeof(struct tracepoint_probe
));
163 new[nr_probes
].func
= probe
;
164 new[nr_probes
].data
= data
;
165 new[nr_probes
+ 1].func
= NULL
;
166 entry
->refcount
= nr_probes
+ 1;
168 debug_print_probes(entry
);
173 tracepoint_entry_remove_probe(struct tracepoint_entry
*entry
,
174 void (*probe
)(void), void *data
)
176 int nr_probes
= 0, nr_del
= 0, i
;
177 struct tracepoint_probe
*old
, *new;
182 return ERR_PTR(-ENOENT
);
184 debug_print_probes(entry
);
185 /* (N -> M), (N > 1, M >= 0) probes */
186 for (nr_probes
= 0; old
[nr_probes
].func
; nr_probes
++) {
188 (old
[nr_probes
].func
== probe
&&
189 old
[nr_probes
].data
== data
))
193 if (nr_probes
- nr_del
== 0) {
194 /* N -> 0, (N > 1) */
195 entry
->probes
= NULL
;
197 debug_print_probes(entry
);
201 /* N -> M, (N > 1, M > 0) */
203 new = allocate_probes(nr_probes
- nr_del
+ 1);
205 return ERR_PTR(-ENOMEM
);
206 for (i
= 0; old
[i
].func
; i
++)
208 (old
[i
].func
!= probe
|| old
[i
].data
!= data
))
210 new[nr_probes
- nr_del
].func
= NULL
;
211 entry
->refcount
= nr_probes
- nr_del
;
214 debug_print_probes(entry
);
219 * Get tracepoint if the tracepoint is present in the tracepoint hash table.
220 * Must be called with tracepoint mutex held.
221 * Returns NULL if not present.
223 static struct tracepoint_entry
*get_tracepoint(const char *name
)
225 struct cds_hlist_head
*head
;
226 struct cds_hlist_node
*node
;
227 struct tracepoint_entry
*e
;
228 size_t name_len
= strlen(name
);
231 if (name_len
> LTTNG_UST_SYM_NAME_LEN
- 1) {
232 WARN("Truncating tracepoint name %s which exceeds size limits of %u chars", name
, LTTNG_UST_SYM_NAME_LEN
- 1);
233 name_len
= LTTNG_UST_SYM_NAME_LEN
- 1;
235 hash
= jhash(name
, name_len
, 0);
236 head
= &tracepoint_table
[hash
& (TRACEPOINT_TABLE_SIZE
- 1)];
237 cds_hlist_for_each_entry(e
, node
, head
, hlist
) {
238 if (!strncmp(name
, e
->name
, LTTNG_UST_SYM_NAME_LEN
- 1))
245 * Add the tracepoint to the tracepoint hash table. Must be called with
246 * tracepoint mutex held.
248 static struct tracepoint_entry
*add_tracepoint(const char *name
,
249 const char *signature
)
251 struct cds_hlist_head
*head
;
252 struct cds_hlist_node
*node
;
253 struct tracepoint_entry
*e
;
254 size_t name_len
= strlen(name
);
257 if (name_len
> LTTNG_UST_SYM_NAME_LEN
- 1) {
258 WARN("Truncating tracepoint name %s which exceeds size limits of %u chars", name
, LTTNG_UST_SYM_NAME_LEN
- 1);
259 name_len
= LTTNG_UST_SYM_NAME_LEN
- 1;
261 hash
= jhash(name
, name_len
, 0);
262 head
= &tracepoint_table
[hash
& (TRACEPOINT_TABLE_SIZE
- 1)];
263 cds_hlist_for_each_entry(e
, node
, head
, hlist
) {
264 if (!strncmp(name
, e
->name
, LTTNG_UST_SYM_NAME_LEN
- 1)) {
265 DBG("tracepoint %s busy", name
);
266 return ERR_PTR(-EEXIST
); /* Already there */
270 * Using zmalloc here to allocate a variable length element. Could
271 * cause some memory fragmentation if overused.
273 e
= zmalloc(sizeof(struct tracepoint_entry
) + name_len
+ 1);
275 return ERR_PTR(-ENOMEM
);
276 memcpy(&e
->name
[0], name
, name_len
+ 1);
277 e
->name
[name_len
] = '\0';
280 e
->signature
= signature
;
281 cds_hlist_add_head(&e
->hlist
, head
);
286 * Remove the tracepoint from the tracepoint hash table. Must be called with
287 * tracepoint mutex held.
289 static void remove_tracepoint(struct tracepoint_entry
*e
)
291 cds_hlist_del(&e
->hlist
);
296 * Sets the probe callback corresponding to one tracepoint.
298 static void set_tracepoint(struct tracepoint_entry
**entry
,
299 struct tracepoint
*elem
, int active
)
301 WARN_ON(strncmp((*entry
)->name
, elem
->name
, LTTNG_UST_SYM_NAME_LEN
- 1) != 0);
303 * Check that signatures match before connecting a probe to a
304 * tracepoint. Warn the user if they don't.
306 if (strcmp(elem
->signature
, (*entry
)->signature
) != 0) {
307 static int warned
= 0;
309 /* Only print once, don't flood console. */
311 WARN("Tracepoint signature mismatch, not enabling one or more tracepoints. Ensure that the tracepoint probes prototypes match the application.");
312 WARN("Tracepoint \"%s\" signatures: call: \"%s\" vs probe: \"%s\".",
313 elem
->name
, elem
->signature
, (*entry
)->signature
);
316 /* Don't accept connecting non-matching signatures. */
321 * rcu_assign_pointer has a cmm_smp_wmb() which makes sure that the new
322 * probe callbacks array is consistent before setting a pointer to it.
323 * This array is referenced by __DO_TRACE from
324 * include/linux/tracepoints.h. A matching cmm_smp_read_barrier_depends()
327 rcu_assign_pointer(elem
->probes
, (*entry
)->probes
);
328 elem
->state
= active
;
332 * Disable a tracepoint and its probe callback.
333 * Note: only waiting an RCU period after setting elem->call to the empty
334 * function insures that the original callback is not used anymore. This insured
335 * by preempt_disable around the call site.
337 static void disable_tracepoint(struct tracepoint
*elem
)
340 rcu_assign_pointer(elem
->probes
, NULL
);
344 * tracepoint_update_probe_range - Update a probe range
345 * @begin: beginning of the range
346 * @end: end of the range
348 * Updates the probe callback corresponding to a range of tracepoints.
351 void tracepoint_update_probe_range(struct tracepoint
* const *begin
,
352 struct tracepoint
* const *end
)
354 struct tracepoint
* const *iter
;
355 struct tracepoint_entry
*mark_entry
;
357 for (iter
= begin
; iter
< end
; iter
++) {
359 continue; /* skip dummy */
360 if (!(*iter
)->name
) {
361 disable_tracepoint(*iter
);
364 mark_entry
= get_tracepoint((*iter
)->name
);
366 set_tracepoint(&mark_entry
, *iter
,
367 !!mark_entry
->refcount
);
369 disable_tracepoint(*iter
);
374 static void lib_update_tracepoints(void)
376 struct tracepoint_lib
*lib
;
378 cds_list_for_each_entry(lib
, &libs
, list
) {
379 tracepoint_update_probe_range(lib
->tracepoints_start
,
380 lib
->tracepoints_start
+ lib
->tracepoints_count
);
385 * Update probes, removing the faulty probes.
387 static void tracepoint_update_probes(void)
389 /* tracepoints registered from libraries and executable. */
390 lib_update_tracepoints();
393 static struct tracepoint_probe
*
394 tracepoint_add_probe(const char *name
, void (*probe
)(void), void *data
,
395 const char *signature
)
397 struct tracepoint_entry
*entry
;
398 struct tracepoint_probe
*old
;
400 entry
= get_tracepoint(name
);
402 entry
= add_tracepoint(name
, signature
);
404 return (struct tracepoint_probe
*)entry
;
406 old
= tracepoint_entry_add_probe(entry
, probe
, data
);
407 if (IS_ERR(old
) && !entry
->refcount
)
408 remove_tracepoint(entry
);
413 * __tracepoint_probe_register - Connect a probe to a tracepoint
414 * @name: tracepoint name
415 * @probe: probe handler
417 * Returns 0 if ok, error value on error.
418 * The probe address must at least be aligned on the architecture pointer size.
419 * Called with the tracepoint mutex held.
421 int __tracepoint_probe_register(const char *name
, void (*probe
)(void),
422 void *data
, const char *signature
)
427 DBG("Registering probe to tracepoint %s", name
);
429 pthread_mutex_lock(&tracepoint_mutex
);
430 old
= tracepoint_add_probe(name
, probe
, data
, signature
);
436 tracepoint_update_probes(); /* may update entry */
439 pthread_mutex_unlock(&tracepoint_mutex
);
443 static void *tracepoint_remove_probe(const char *name
, void (*probe
)(void),
446 struct tracepoint_entry
*entry
;
449 entry
= get_tracepoint(name
);
451 return ERR_PTR(-ENOENT
);
452 old
= tracepoint_entry_remove_probe(entry
, probe
, data
);
455 if (!entry
->refcount
)
456 remove_tracepoint(entry
);
461 * tracepoint_probe_unregister - Disconnect a probe from a tracepoint
462 * @name: tracepoint name
463 * @probe: probe function pointer
464 * @probe: probe data pointer
466 int __tracepoint_probe_unregister(const char *name
, void (*probe
)(void),
472 DBG("Un-registering probe from tracepoint %s", name
);
474 pthread_mutex_lock(&tracepoint_mutex
);
475 old
= tracepoint_remove_probe(name
, probe
, data
);
480 tracepoint_update_probes(); /* may update entry */
483 pthread_mutex_unlock(&tracepoint_mutex
);
487 static void tracepoint_add_old_probes(void *old
)
491 struct tp_probes
*tp_probes
= caa_container_of(old
,
492 struct tp_probes
, probes
[0]);
493 cds_list_add(&tp_probes
->u
.list
, &old_probes
);
498 * tracepoint_probe_register_noupdate - register a probe but not connect
499 * @name: tracepoint name
500 * @probe: probe handler
502 * caller must call tracepoint_probe_update_all()
504 int tracepoint_probe_register_noupdate(const char *name
, void (*probe
)(void),
505 void *data
, const char *signature
)
510 pthread_mutex_lock(&tracepoint_mutex
);
511 old
= tracepoint_add_probe(name
, probe
, data
, signature
);
516 tracepoint_add_old_probes(old
);
518 pthread_mutex_unlock(&tracepoint_mutex
);
523 * tracepoint_probe_unregister_noupdate - remove a probe but not disconnect
524 * @name: tracepoint name
525 * @probe: probe function pointer
527 * caller must call tracepoint_probe_update_all()
528 * Called with the tracepoint mutex held.
530 int tracepoint_probe_unregister_noupdate(const char *name
, void (*probe
)(void),
536 DBG("Un-registering probe from tracepoint %s", name
);
538 pthread_mutex_lock(&tracepoint_mutex
);
539 old
= tracepoint_remove_probe(name
, probe
, data
);
544 tracepoint_add_old_probes(old
);
546 pthread_mutex_unlock(&tracepoint_mutex
);
551 * tracepoint_probe_update_all - update tracepoints
553 void tracepoint_probe_update_all(void)
555 CDS_LIST_HEAD(release_probes
);
556 struct tp_probes
*pos
, *next
;
558 pthread_mutex_lock(&tracepoint_mutex
);
562 if (!cds_list_empty(&old_probes
))
563 cds_list_replace_init(&old_probes
, &release_probes
);
566 tracepoint_update_probes();
567 cds_list_for_each_entry_safe(pos
, next
, &release_probes
, u
.list
) {
568 cds_list_del(&pos
->u
.list
);
573 pthread_mutex_unlock(&tracepoint_mutex
);
576 void tracepoint_set_new_tracepoint_cb(void (*cb
)(struct tracepoint
*))
578 new_tracepoint_cb
= cb
;
581 static void new_tracepoints(struct tracepoint
* const *start
, struct tracepoint
* const *end
)
583 if (new_tracepoint_cb
) {
584 struct tracepoint
* const *t
;
586 for (t
= start
; t
< end
; t
++) {
588 new_tracepoint_cb(*t
);
594 void lib_disable_tracepoints(struct tracepoint
* const *begin
,
595 struct tracepoint
* const *end
)
597 struct tracepoint
* const *iter
;
599 for (iter
= begin
; iter
< end
; iter
++) {
601 continue; /* skip dummy */
602 disable_tracepoint(*iter
);
607 int tracepoint_register_lib(struct tracepoint
* const *tracepoints_start
,
608 int tracepoints_count
)
610 struct tracepoint_lib
*pl
, *iter
;
614 pl
= (struct tracepoint_lib
*) zmalloc(sizeof(struct tracepoint_lib
));
616 pl
->tracepoints_start
= tracepoints_start
;
617 pl
->tracepoints_count
= tracepoints_count
;
619 pthread_mutex_lock(&tracepoint_mutex
);
621 * We sort the libs by struct lib pointer address.
623 cds_list_for_each_entry_reverse(iter
, &libs
, list
) {
624 BUG_ON(iter
== pl
); /* Should never be in the list twice */
626 /* We belong to the location right after iter. */
627 cds_list_add(&pl
->list
, &iter
->list
);
631 /* We should be added at the head of the list */
632 cds_list_add(&pl
->list
, &libs
);
634 new_tracepoints(tracepoints_start
, tracepoints_start
+ tracepoints_count
);
636 /* TODO: update just the loaded lib */
637 lib_update_tracepoints();
638 pthread_mutex_unlock(&tracepoint_mutex
);
640 DBG("just registered a tracepoints section from %p and having %d tracepoints",
641 tracepoints_start
, tracepoints_count
);
645 for (i
= 0; i
< tracepoints_count
; i
++) {
646 DBG("registered tracepoint: %s", tracepoints_start
[i
]->name
);
653 int tracepoint_unregister_lib(struct tracepoint
* const *tracepoints_start
)
655 struct tracepoint_lib
*lib
;
656 int tracepoints_count
;
658 pthread_mutex_lock(&tracepoint_mutex
);
659 cds_list_for_each_entry(lib
, &libs
, list
) {
660 if (lib
->tracepoints_start
== tracepoints_start
) {
661 struct tracepoint_lib
*lib2free
= lib
;
663 cds_list_del(&lib
->list
);
664 tracepoints_count
= lib
->tracepoints_count
;
672 * Force tracepoint disarm for all tracepoints of this lib.
673 * This takes care of destructor of library that would leave a
674 * LD_PRELOAD wrapper override function enabled for tracing, but
675 * the session teardown would not be able to reach the
676 * tracepoint anymore to disable it.
678 lib_disable_tracepoints(tracepoints_start
,
679 tracepoints_start
+ tracepoints_count
);
680 DBG("just unregistered a tracepoints section from %p",
683 pthread_mutex_unlock(&tracepoint_mutex
);
687 void init_tracepoint(void)
689 if (uatomic_xchg(&initialized
, 1) == 1)
694 void exit_tracepoint(void)
700 * Create the wrapper symbols.
702 #undef tp_rcu_read_lock_bp
703 #undef tp_rcu_read_unlock_bp
704 #undef tp_rcu_dereference_bp
706 void tp_rcu_read_lock_bp(void)
711 void tp_rcu_read_unlock_bp(void)
713 rcu_read_unlock_bp();
716 void *tp_rcu_dereference_sym_bp(void *p
)
718 return rcu_dereference_bp(p
);