-
Notifications
You must be signed in to change notification settings - Fork 69
/
tracepoint.c
1090 lines (964 loc) · 31.5 KB
/
tracepoint.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* SPDX-License-Identifier: LGPL-2.1-only
*
* Copyright (C) 2008-2011 Mathieu Desnoyers
* Copyright (C) 2009 Pierre-Marc Fournier
*
* Ported to userspace by Pierre-Marc Fournier.
*/
#define _LGPL_SOURCE
#include <errno.h>
#include <stdint.h>
#include <stddef.h>
#include <stdio.h>
#include <dlfcn.h>
#include <urcu/arch.h>
#include <lttng/urcu/urcu-ust.h>
#include <urcu/hlist.h>
#include <urcu/uatomic.h>
#include <urcu/compiler.h>
#include <urcu/system.h>
#include <lttng/tracepoint.h>
#include <lttng/ust-abi.h> /* for LTTNG_UST_ABI_SYM_NAME_LEN */
#include <lttng/ust-common.h>
#include "common/logging.h"
#include "common/macros.h"
#include "lib/lttng-ust-tracepoint/tracepoint.h"
#include "common/tracepoint.h"
#include "common/jhash.h"
#include "common/err-ptr.h"
/* Test compiler support for weak symbols with hidden visibility. */
int lttng_ust_tracepoint_test_symbol1 __attribute__((weak, visibility("hidden")));
void *lttng_ust_tracepoint_test_symbol2 __attribute__((weak, visibility("hidden")));
struct {
char a[24];
} lttng_ust_tracepoint_test_symbol3 __attribute__((weak, visibility("hidden")));
/* Set to 1 to enable tracepoint debug output */
static const int tracepoint_debug;
static int initialized;
/*
* If tracepoint_destructors_state = 1, tracepoint destructors are
* enabled. They are disabled otherwise.
*/
static int tracepoint_destructors_state = 1;
static void (*new_tracepoint_cb)(struct lttng_ust_tracepoint *);
/*
* tracepoint_mutex nests inside UST mutex.
*
* Note about interaction with fork/clone: UST does not hold the
* tracepoint mutex across fork/clone because it is either:
* - nested within UST mutex, in which case holding the UST mutex across
* fork/clone suffice,
* - taken by a library constructor, which should never race with a
* fork/clone if the application is expected to continue running with
* the same memory layout (no following exec()).
*/
static pthread_mutex_t tracepoint_mutex = PTHREAD_MUTEX_INITIALIZER;
/*
* libraries that contain tracepoints (struct tracepoint_lib).
* Protected by tracepoint mutex.
*/
static CDS_LIST_HEAD(libs);
/*
* The tracepoint mutex protects the library tracepoints, the hash table, and
* the library list.
* All calls to the tracepoint API must be protected by the tracepoint mutex,
* excepts calls to lttng_ust_tracepoint_module_register and
* lttng_ust_tracepoint_module_unregister, which take the tracepoint mutex themselves.
*/
/*
* Tracepoint hash table, containing the active tracepoints.
* Protected by tracepoint mutex.
*/
#define TRACEPOINT_HASH_BITS 12
#define TRACEPOINT_TABLE_SIZE (1 << TRACEPOINT_HASH_BITS)
static struct cds_hlist_head tracepoint_table[TRACEPOINT_TABLE_SIZE];
static CDS_LIST_HEAD(old_probes);
static int need_update;
static CDS_LIST_HEAD(release_queue);
static int release_queue_need_update;
/*
* Note about RCU :
* It is used to to delay the free of multiple probes array until a quiescent
* state is reached.
* Tracepoint entries modifications are protected by the tracepoint mutex.
*/
struct tracepoint_entry {
struct cds_hlist_node hlist;
struct lttng_ust_tracepoint_probe *probes;
int refcount; /* Number of times armed. 0 if disarmed. */
int callsite_refcount; /* how many libs use this tracepoint */
char *signature;
char *provider_name;
char *event_name;
};
struct tp_probes {
union {
struct cds_list_head list;
/* Field below only used for call_rcu scheme */
/* struct rcu_head head; */
} u;
struct lttng_ust_tracepoint_probe probes[0];
};
/*
* Callsite hash table, containing the tracepoint call sites.
* Protected by tracepoint mutex.
*/
#define CALLSITE_HASH_BITS 12
#define CALLSITE_TABLE_SIZE (1 << CALLSITE_HASH_BITS)
static struct cds_hlist_head callsite_table[CALLSITE_TABLE_SIZE];
struct callsite_entry {
struct cds_hlist_node hlist; /* hash table node */
struct cds_list_head node; /* lib list of callsites node */
struct lttng_ust_tracepoint *tp;
bool tp_entry_callsite_ref; /* Has a tp_entry took a ref on this callsite */
};
lttng_ust_static_assert(LTTNG_UST_TRACEPOINT_NAME_LEN_MAX == LTTNG_UST_ABI_SYM_NAME_LEN,
"Tracepoint name max length mismatch between UST ABI and tracepoint API",
Tracepoint_name_max_length_mismatch);
static
bool lttng_ust_tp_validate_event_name(const struct lttng_ust_tracepoint *tp)
{
if (strlen(tp->provider_name) + 1 +
strlen(tp->event_name) >= LTTNG_UST_TRACEPOINT_NAME_LEN_MAX)
return false;
return true;
}
/* coverity[+alloc] */
static void *allocate_probes(int count)
{
struct tp_probes *p =
zmalloc(count * sizeof(struct lttng_ust_tracepoint_probe)
+ sizeof(struct tp_probes));
return p == NULL ? NULL : p->probes;
}
/* coverity[+free : arg-0] */
static void release_probes(void *old)
{
if (old) {
struct tp_probes *tp_probes = caa_container_of(old,
struct tp_probes, probes[0]);
lttng_ust_urcu_synchronize_rcu();
free(tp_probes);
}
}
static void debug_print_probes(struct tracepoint_entry *entry)
{
int i;
if (!tracepoint_debug || !entry->probes)
return;
for (i = 0; entry->probes[i].func; i++)
DBG("Probe %d : %p", i, entry->probes[i].func);
}
static void *
tracepoint_entry_add_probe(struct tracepoint_entry *entry,
void (*probe)(void), void *data)
{
int nr_probes = 0;
struct lttng_ust_tracepoint_probe *old, *new;
if (!probe) {
WARN_ON(1);
return ERR_PTR(-EINVAL);
}
debug_print_probes(entry);
old = entry->probes;
if (old) {
/* (N -> N+1), (N != 0, 1) probes */
for (nr_probes = 0; old[nr_probes].func; nr_probes++)
if (old[nr_probes].func == probe &&
old[nr_probes].data == data)
return ERR_PTR(-EEXIST);
}
/* + 2 : one for new probe, one for NULL func */
new = allocate_probes(nr_probes + 2);
if (new == NULL)
return ERR_PTR(-ENOMEM);
if (old)
memcpy(new, old,
nr_probes * sizeof(struct lttng_ust_tracepoint_probe));
new[nr_probes].func = probe;
new[nr_probes].data = data;
new[nr_probes + 1].func = NULL;
entry->refcount = nr_probes + 1;
entry->probes = new;
debug_print_probes(entry);
return old;
}
static void *
tracepoint_entry_remove_probe(struct tracepoint_entry *entry,
void (*probe)(void), void *data)
{
int nr_probes = 0, nr_del = 0, i;
struct lttng_ust_tracepoint_probe *old, *new;
old = entry->probes;
if (!old)
return ERR_PTR(-ENOENT);
debug_print_probes(entry);
/* (N -> M), (N > 1, M >= 0) probes */
if (probe) {
for (nr_probes = 0; old[nr_probes].func; nr_probes++) {
if (old[nr_probes].func == probe &&
old[nr_probes].data == data)
nr_del++;
}
}
if (nr_probes - nr_del == 0) {
/* N -> 0, (N > 1) */
entry->probes = NULL;
entry->refcount = 0;
debug_print_probes(entry);
return old;
} else {
int j = 0;
/* N -> M, (N > 1, M > 0) */
/* + 1 for NULL */
new = allocate_probes(nr_probes - nr_del + 1);
if (new == NULL)
return ERR_PTR(-ENOMEM);
for (i = 0; old[i].func; i++)
if (old[i].func != probe || old[i].data != data)
new[j++] = old[i];
new[nr_probes - nr_del].func = NULL;
entry->refcount = nr_probes - nr_del;
entry->probes = new;
}
debug_print_probes(entry);
return old;
}
/*
* Get tracepoint if the tracepoint is present in the tracepoint hash table.
* Must be called with tracepoint mutex held.
* Returns NULL if not present.
*/
static struct tracepoint_entry *get_tracepoint(const char *provider_name, const char *event_name)
{
struct cds_hlist_head *head;
struct cds_hlist_node *node;
struct tracepoint_entry *e;
uint32_t hash;
hash = jhash(provider_name, strlen(provider_name), 0) ^
jhash(event_name, strlen(event_name), 0);
head = &tracepoint_table[hash & (TRACEPOINT_TABLE_SIZE - 1)];
cds_hlist_for_each_entry(e, node, head, hlist) {
if (!strcmp(event_name, e->event_name) && !strcmp(provider_name, e->provider_name))
return e;
}
return NULL;
}
/*
* Add the tracepoint to the tracepoint hash table. Must be called with
* tracepoint mutex held.
*/
static struct tracepoint_entry *add_tracepoint(const char *provider_name, const char *event_name,
const char *signature)
{
struct cds_hlist_head *head;
struct cds_hlist_node *node;
struct tracepoint_entry *e;
size_t sig_len = strlen(signature);
size_t sig_off, provider_name_off, event_name_off;
size_t provider_name_len = strlen(provider_name);
size_t event_name_len = strlen(event_name);
uint32_t hash;
hash = jhash(provider_name, provider_name_len, 0) ^
jhash(event_name, event_name_len, 0);
head = &tracepoint_table[hash & (TRACEPOINT_TABLE_SIZE - 1)];
cds_hlist_for_each_entry(e, node, head, hlist) {
if (!strcmp(event_name, e->event_name) && !strcmp(provider_name, e->provider_name)) {
DBG("tracepoint \"%s:%s\" busy", provider_name, event_name);
return ERR_PTR(-EEXIST); /* Already there */
}
}
/*
* Using zmalloc here to allocate a variable length elements: name and
* signature. Could cause some memory fragmentation if overused.
*/
provider_name_off = sizeof(struct tracepoint_entry);
event_name_off = provider_name_off + provider_name_len + 1;
sig_off = event_name_off + event_name_len + 1;
e = zmalloc(sizeof(struct tracepoint_entry) + provider_name_len + 1 +
event_name_len + 1 + sig_len + 1);
if (!e)
return ERR_PTR(-ENOMEM);
e->provider_name = (char *) e + provider_name_off;
memcpy(e->provider_name, provider_name, provider_name_len + 1);
e->provider_name[provider_name_len] = '\0';
e->event_name = (char *) e + event_name_off;
memcpy(e->event_name, event_name, event_name_len + 1);
e->event_name[event_name_len] = '\0';
e->signature = (char *) e + sig_off;
memcpy(e->signature, signature, sig_len + 1);
e->signature[sig_len] = '\0';
e->probes = NULL;
e->refcount = 0;
e->callsite_refcount = 0;
cds_hlist_add_head(&e->hlist, head);
return e;
}
/*
* Remove the tracepoint from the tracepoint hash table. Must be called with
* tracepoint mutex held.
*/
static void remove_tracepoint(struct tracepoint_entry *e)
{
cds_hlist_del(&e->hlist);
free(e);
}
/*
* Sets the probe callback corresponding to one tracepoint.
*/
static void set_tracepoint(struct tracepoint_entry **entry,
struct lttng_ust_tracepoint *elem, int active)
{
WARN_ON(strcmp((*entry)->provider_name, elem->provider_name) != 0);
WARN_ON(strcmp((*entry)->event_name, elem->event_name) != 0);
/*
* Check that signatures match before connecting a probe to a
* tracepoint. Warn the user if they don't.
*/
if (strcmp(elem->signature, (*entry)->signature) != 0) {
static int warned = 0;
/* Only print once, don't flood console. */
if (!warned) {
WARN("Tracepoint signature mismatch, not enabling one or more tracepoints. Ensure that the tracepoint probes prototypes match the application.");
WARN("Tracepoint \"%s:%s\" signatures: call: \"%s\" vs probe: \"%s\".",
elem->provider_name, elem->event_name, elem->signature, (*entry)->signature);
warned = 1;
}
/* Don't accept connecting non-matching signatures. */
return;
}
/*
* rcu_assign_pointer has a cmm_smp_wmb() which makes sure that the new
* probe callbacks array is consistent before setting a pointer to it.
* This array is referenced by __DO_TRACE from
* include/linux/tracepoints.h. A matching cmm_smp_read_barrier_depends()
* is used.
*/
lttng_ust_rcu_assign_pointer(elem->probes, (*entry)->probes);
CMM_STORE_SHARED(elem->state, active);
}
/*
* Disable a tracepoint and its probe callback.
* Note: only waiting an RCU period after setting elem->call to the empty
* function insures that the original callback is not used anymore. This insured
* by preempt_disable around the call site.
*/
static void disable_tracepoint(struct lttng_ust_tracepoint *elem)
{
CMM_STORE_SHARED(elem->state, 0);
lttng_ust_rcu_assign_pointer(elem->probes, NULL);
}
/*
* Add the callsite to the callsite hash table. Must be called with
* tracepoint mutex held.
*/
static void add_callsite(struct tracepoint_lib * lib, struct lttng_ust_tracepoint *tp)
{
struct cds_hlist_head *head;
struct callsite_entry *e;
uint32_t hash;
struct tracepoint_entry *tp_entry;
if (!lttng_ust_tp_validate_event_name(tp)) {
WARN("Rejecting tracepoint name \"%s:%s\" which exceeds size limits of %u chars",
tp->provider_name, tp->event_name, LTTNG_UST_TRACEPOINT_NAME_LEN_MAX - 1);
return;
}
hash = jhash(tp->provider_name, strlen(tp->provider_name), 0) ^
jhash(tp->event_name, strlen(tp->event_name), 0);
head = &callsite_table[hash & (CALLSITE_TABLE_SIZE - 1)];
e = zmalloc(sizeof(struct callsite_entry));
if (!e) {
PERROR("Unable to add callsite for tracepoint \"%s:%s\"", tp->provider_name, tp->event_name);
return;
}
cds_hlist_add_head(&e->hlist, head);
e->tp = tp;
cds_list_add(&e->node, &lib->callsites);
tp_entry = get_tracepoint(tp->provider_name, tp->event_name);
if (!tp_entry)
return;
tp_entry->callsite_refcount++;
e->tp_entry_callsite_ref = true;
}
/*
* Remove the callsite from the callsite hash table and from lib
* callsite list. Must be called with tracepoint mutex held.
*/
static void remove_callsite(struct callsite_entry *e)
{
struct tracepoint_entry *tp_entry;
tp_entry = get_tracepoint(e->tp->provider_name, e->tp->event_name);
if (tp_entry) {
if (e->tp_entry_callsite_ref)
tp_entry->callsite_refcount--;
if (tp_entry->callsite_refcount == 0)
disable_tracepoint(e->tp);
}
cds_hlist_del(&e->hlist);
cds_list_del(&e->node);
free(e);
}
/*
* Enable/disable all callsites based on the state of a specific
* tracepoint entry.
* Must be called with tracepoint mutex held.
*/
static void tracepoint_sync_callsites(const char *provider_name, const char *event_name)
{
struct tracepoint_entry *tp_entry;
struct cds_hlist_head *head;
struct cds_hlist_node *node;
struct callsite_entry *e;
uint32_t hash;
tp_entry = get_tracepoint(provider_name, event_name);
hash = jhash(provider_name, strlen(provider_name), 0) ^
jhash(event_name, strlen(event_name), 0);
head = &callsite_table[hash & (CALLSITE_TABLE_SIZE - 1)];
cds_hlist_for_each_entry(e, node, head, hlist) {
struct lttng_ust_tracepoint *tp = e->tp;
if (strcmp(event_name, tp->event_name))
continue;
if (strcmp(provider_name, tp->provider_name))
continue;
if (tp_entry) {
if (!e->tp_entry_callsite_ref) {
tp_entry->callsite_refcount++;
e->tp_entry_callsite_ref = true;
}
set_tracepoint(&tp_entry, tp,
!!tp_entry->refcount);
} else {
disable_tracepoint(tp);
e->tp_entry_callsite_ref = false;
}
}
}
/**
* tracepoint_update_probe_range - Update a probe range
* @begin: beginning of the range
* @end: end of the range
*
* Updates the probe callback corresponding to a range of tracepoints.
*/
static
void tracepoint_update_probe_range(struct lttng_ust_tracepoint * const *begin,
struct lttng_ust_tracepoint * const *end)
{
struct lttng_ust_tracepoint * const *iter;
struct tracepoint_entry *mark_entry;
for (iter = begin; iter < end; iter++) {
if (!*iter)
continue; /* skip dummy */
if (!(*iter)->provider_name || !(*iter)->event_name) {
disable_tracepoint(*iter);
continue;
}
if (!lttng_ust_tp_validate_event_name(*iter)) {
WARN("Rejecting tracepoint name \"%s:%s\" which exceeds size limits of %u chars",
(*iter)->provider_name, (*iter)->event_name, LTTNG_UST_TRACEPOINT_NAME_LEN_MAX - 1);
disable_tracepoint(*iter);
continue;
}
mark_entry = get_tracepoint((*iter)->provider_name, (*iter)->event_name);
if (mark_entry) {
set_tracepoint(&mark_entry, *iter,
!!mark_entry->refcount);
} else {
disable_tracepoint(*iter);
}
}
}
static void lib_update_tracepoints(struct tracepoint_lib *lib)
{
tracepoint_update_probe_range(lib->tracepoints_start,
lib->tracepoints_start + lib->tracepoints_count);
}
static void lib_register_callsites(struct tracepoint_lib *lib)
{
struct lttng_ust_tracepoint * const *begin;
struct lttng_ust_tracepoint * const *end;
struct lttng_ust_tracepoint * const *iter;
begin = lib->tracepoints_start;
end = lib->tracepoints_start + lib->tracepoints_count;
for (iter = begin; iter < end; iter++) {
if (!*iter)
continue; /* skip dummy */
if (!(*iter)->provider_name || !(*iter)->event_name) {
continue;
}
add_callsite(lib, *iter);
}
}
static void lib_unregister_callsites(struct tracepoint_lib *lib)
{
struct callsite_entry *callsite, *tmp;
cds_list_for_each_entry_safe(callsite, tmp, &lib->callsites, node)
remove_callsite(callsite);
}
/*
* Update probes, removing the faulty probes.
*/
static void tracepoint_update_probes(void)
{
struct tracepoint_lib *lib;
/* tracepoints registered from libraries and executable. */
cds_list_for_each_entry(lib, &libs, list)
lib_update_tracepoints(lib);
}
static struct lttng_ust_tracepoint_probe *
tracepoint_add_probe(const char *provider_name, const char *event_name,
void (*probe)(void), void *data, const char *signature)
{
struct tracepoint_entry *entry;
struct lttng_ust_tracepoint_probe *old;
entry = get_tracepoint(provider_name, event_name);
if (entry) {
if (strcmp(entry->signature, signature) != 0) {
ERR("Tracepoint \"%s:%s\": tracepoint and probe signature do not match: \"%s\" vs \"%s\".",
provider_name, event_name, entry->signature, signature);
return ERR_PTR(-EINVAL);
}
} else {
entry = add_tracepoint(provider_name, event_name, signature);
if (IS_ERR(entry))
return (struct lttng_ust_tracepoint_probe *)entry;
}
old = tracepoint_entry_add_probe(entry, probe, data);
if (IS_ERR(old) && !entry->refcount)
remove_tracepoint(entry);
return old;
}
static void tracepoint_release_queue_add_old_probes(void *old)
{
release_queue_need_update = 1;
if (old) {
struct tp_probes *tp_probes = caa_container_of(old,
struct tp_probes, probes[0]);
cds_list_add(&tp_probes->u.list, &release_queue);
}
}
/*
* Use a symbol of the previous ABI to detect if liblttng-ust-tracepoint.so.0
* is loaded in the current process.
*/
#define LTTNG_UST_TRACEPOINT_SONAME_0_SYM "tracepoint_unregister_lib"
static
void lttng_ust_tracepoint_check_soname_0(void)
{
if (!dlsym(RTLD_DEFAULT, LTTNG_UST_TRACEPOINT_SONAME_0_SYM))
return;
CRIT("Incompatible library ABIs detected within the same process. "
"The process is likely linked against different major soname of LTTng-UST which is unsupported. "
"The detection was triggered by lookup of ABI 0 symbol \"%s\" in the Global Symbol Table\n",
LTTNG_UST_TRACEPOINT_SONAME_0_SYM);
}
/*
* Expose a canary symbol of the previous ABI to ensure we catch uses of a
* liblttng-ust-tracepoint.so.0 dlopen'd after .so.1 has been loaded. Use a
* different symbol than the detection code to ensure we don't detect ourself.
*/
int tracepoint_register_lib(void *arg0 __attribute__((unused)), int arg1 __attribute__((unused)));
int tracepoint_register_lib(void *arg0 __attribute__((unused)), int arg1 __attribute__((unused)))
{
CRIT("Incompatible library ABIs detected within the same process. "
"The process is likely linked against different major soname of LTTng-UST which is unsupported. "
"The detection was triggered by canary symbol \"%s\"\n", __func__);
return -1;
}
/**
* lttng_ust_tracepoint_provider_register - Connect a probe to a tracepoint
* @name: tracepoint provider name
* @name: tracepoint event name
* @probe: probe handler
*
* Returns 0 if ok, error value on error.
* The probe address must at least be aligned on the architecture pointer size.
* Called with the tracepoint mutex held.
*/
int lttng_ust_tracepoint_provider_register(const char *provider_name, const char *event_name,
void (*probe)(void), void *data, const char *signature)
{
void *old;
int ret = 0;
/*
* Check if we find a symbol of the previous ABI in the current process
* as different ABIs of liblttng-ust can't co-exist in a process. If we
* do so, emit a critical log message which will also abort if the
* LTTNG_UST_ABORT_ON_CRITICAL environment variable is set.
*/
lttng_ust_tracepoint_check_soname_0();
DBG("Registering probe to tracepoint \"%s:%s\"", provider_name, event_name);
pthread_mutex_lock(&tracepoint_mutex);
old = tracepoint_add_probe(provider_name, event_name, probe, data, signature);
if (IS_ERR(old)) {
ret = PTR_ERR(old);
goto end;
}
tracepoint_sync_callsites(provider_name, event_name);
release_probes(old);
end:
pthread_mutex_unlock(&tracepoint_mutex);
return ret;
}
/*
* Caller needs to invoke lttng_ust_tracepoint_probe_release_queue() after
* calling lttng_ust_tp_probe_register_queue_release() one or multiple
* times to ensure it does not leak memory.
*/
int lttng_ust_tp_probe_register_queue_release(const char *provider_name, const char *event_name,
void (*probe)(void), void *data, const char *signature)
{
void *old;
int ret = 0;
DBG("Registering probe to tracepoint \"%s:%s\". Queuing release.", provider_name, event_name);
pthread_mutex_lock(&tracepoint_mutex);
old = tracepoint_add_probe(provider_name, event_name, probe, data, signature);
if (IS_ERR(old)) {
ret = PTR_ERR(old);
goto end;
}
tracepoint_sync_callsites(provider_name, event_name);
tracepoint_release_queue_add_old_probes(old);
end:
pthread_mutex_unlock(&tracepoint_mutex);
return ret;
}
static void *tracepoint_remove_probe(const char *provider_name, const char *event_name,
void (*probe)(void), void *data)
{
struct tracepoint_entry *entry;
void *old;
entry = get_tracepoint(provider_name, event_name);
if (!entry)
return ERR_PTR(-ENOENT);
old = tracepoint_entry_remove_probe(entry, probe, data);
if (IS_ERR(old))
return old;
if (!entry->refcount)
remove_tracepoint(entry);
return old;
}
/**
* tracepoint_probe_unregister - Disconnect a probe from a tracepoint
* @provider_name: tracepoint provider name
* @event_name: tracepoint event name
* @probe: probe function pointer
* @probe: probe data pointer
*/
int lttng_ust_tracepoint_provider_unregister(const char *provider_name, const char *event_name,
void (*probe)(void), void *data)
{
void *old;
int ret = 0;
DBG("Un-registering probe \"%s:%s\" from tracepoint %p", provider_name, event_name, probe);
pthread_mutex_lock(&tracepoint_mutex);
old = tracepoint_remove_probe(provider_name, event_name, probe, data);
if (IS_ERR(old)) {
ret = PTR_ERR(old);
goto end;
}
tracepoint_sync_callsites(provider_name, event_name);
release_probes(old);
end:
pthread_mutex_unlock(&tracepoint_mutex);
return ret;
}
/*
* Caller needs to invoke lttng_ust_tracepoint_probe_release_queue() after
* calling lttng_ust_tp_probe_unregister_queue_release() one or multiple
* times to ensure it does not leak memory.
*/
int lttng_ust_tp_probe_unregister_queue_release(const char *provider_name, const char *event_name,
void (*probe)(void), void *data)
{
void *old;
int ret = 0;
DBG("Un-registering probe from tracepoint \"%s:%s\". Queuing release.", provider_name, event_name);
pthread_mutex_lock(&tracepoint_mutex);
old = tracepoint_remove_probe(provider_name, event_name, probe, data);
if (IS_ERR(old)) {
ret = PTR_ERR(old);
goto end;
}
tracepoint_sync_callsites(provider_name, event_name);
tracepoint_release_queue_add_old_probes(old);
end:
pthread_mutex_unlock(&tracepoint_mutex);
return ret;
}
void lttng_ust_tp_probe_prune_release_queue(void)
{
CDS_LIST_HEAD(release_probes);
struct tp_probes *pos, *next;
DBG("Release queue of unregistered tracepoint probes.");
pthread_mutex_lock(&tracepoint_mutex);
if (!release_queue_need_update)
goto end;
if (!cds_list_empty(&release_queue))
cds_list_replace_init(&release_queue, &release_probes);
release_queue_need_update = 0;
/* Wait for grace period between all sync_callsites and free. */
lttng_ust_urcu_synchronize_rcu();
cds_list_for_each_entry_safe(pos, next, &release_probes, u.list) {
cds_list_del(&pos->u.list);
free(pos);
}
end:
pthread_mutex_unlock(&tracepoint_mutex);
}
static void tracepoint_add_old_probes(void *old)
{
need_update = 1;
if (old) {
struct tp_probes *tp_probes = caa_container_of(old,
struct tp_probes, probes[0]);
cds_list_add(&tp_probes->u.list, &old_probes);
}
}
/**
* tracepoint_probe_register_noupdate - register a probe but not connect
* @name: tracepoint name
* @probe: probe handler
*
* caller must call tracepoint_probe_update_all()
*/
int tracepoint_probe_register_noupdate(const char *provider_name, const char *event_name,
void (*probe)(void), void *data, const char *signature)
{
void *old;
int ret = 0;
pthread_mutex_lock(&tracepoint_mutex);
old = tracepoint_add_probe(provider_name, event_name, probe, data, signature);
if (IS_ERR(old)) {
ret = PTR_ERR(old);
goto end;
}
tracepoint_add_old_probes(old);
end:
pthread_mutex_unlock(&tracepoint_mutex);
return ret;
}
/**
* tracepoint_probe_unregister_noupdate - remove a probe but not disconnect
* @name: tracepoint name
* @probe: probe function pointer
*
* caller must call tracepoint_probe_update_all()
* Called with the tracepoint mutex held.
*/
int tracepoint_probe_unregister_noupdate(const char *provider_name, const char *event_name,
void (*probe)(void), void *data)
{
void *old;
int ret = 0;
DBG("Un-registering probe from tracepoint \"%s:%s\"", provider_name, event_name);
pthread_mutex_lock(&tracepoint_mutex);
old = tracepoint_remove_probe(provider_name, event_name, probe, data);
if (IS_ERR(old)) {
ret = PTR_ERR(old);
goto end;
}
tracepoint_add_old_probes(old);
end:
pthread_mutex_unlock(&tracepoint_mutex);
return ret;
}
/**
* tracepoint_probe_update_all - update tracepoints
*/
void tracepoint_probe_update_all(void)
{
CDS_LIST_HEAD(release_probes);
struct tp_probes *pos, *next;
pthread_mutex_lock(&tracepoint_mutex);
if (!need_update) {
goto end;
}
if (!cds_list_empty(&old_probes))
cds_list_replace_init(&old_probes, &release_probes);
need_update = 0;
tracepoint_update_probes();
/* Wait for grace period between update_probes and free. */
lttng_ust_urcu_synchronize_rcu();
cds_list_for_each_entry_safe(pos, next, &release_probes, u.list) {
cds_list_del(&pos->u.list);
free(pos);
}
end:
pthread_mutex_unlock(&tracepoint_mutex);
}
static void new_tracepoints(struct lttng_ust_tracepoint * const *start,
struct lttng_ust_tracepoint * const *end)
{
if (new_tracepoint_cb) {
struct lttng_ust_tracepoint * const *t;
for (t = start; t < end; t++) {
if (*t)
new_tracepoint_cb(*t);
}
}
}
/*
* tracepoint_{un,}register_lib is meant to be looked up by instrumented
* applications through dlsym(). If found, those can register their
* tracepoints, else those tracepoints will not be available for
* tracing. The number at the end of those symbols acts as a major
* version for tracepoints.
*
* Older instrumented applications should still work with newer
* liblttng-ust, but it is fine that instrumented applications compiled
* against recent liblttng-ust headers require a recent liblttng-ust
* runtime for those tracepoints to be taken into account.
*/
int lttng_ust_tracepoint_module_register(struct lttng_ust_tracepoint * const *tracepoints_start,
int tracepoints_count);
int lttng_ust_tracepoint_module_register(struct lttng_ust_tracepoint * const *tracepoints_start,
int tracepoints_count)
{
struct tracepoint_lib *pl, *iter;
lttng_ust_tp_init();
pl = (struct tracepoint_lib *) zmalloc(sizeof(struct tracepoint_lib));
if (!pl) {
PERROR("Unable to register tracepoint lib");
return -1;
}
pl->tracepoints_start = tracepoints_start;
pl->tracepoints_count = tracepoints_count;
CDS_INIT_LIST_HEAD(&pl->callsites);
pthread_mutex_lock(&tracepoint_mutex);
/*
* We sort the libs by struct lib pointer address.
*/
cds_list_for_each_entry_reverse(iter, &libs, list) {
BUG_ON(iter == pl); /* Should never be in the list twice */
if (iter < pl) {
/* We belong to the location right after iter. */
cds_list_add(&pl->list, &iter->list);
goto lib_added;
}
}
/* We should be added at the head of the list */
cds_list_add(&pl->list, &libs);
lib_added:
new_tracepoints(tracepoints_start, tracepoints_start + tracepoints_count);
lib_register_callsites(pl);
lib_update_tracepoints(pl);
pthread_mutex_unlock(&tracepoint_mutex);
DBG("just registered a tracepoints section from %p and having %d tracepoints",
tracepoints_start, tracepoints_count);
if (lttng_ust_logging_debug_enabled()) {
int i;
for (i = 0; i < tracepoints_count; i++) {
if (!lttng_ust_tp_validate_event_name(tracepoints_start[i]))
continue;
DBG("registered tracepoint: \"%s:%s\"",
tracepoints_start[i]->provider_name,
tracepoints_start[i]->event_name);
}
}
return 0;
}
int lttng_ust_tracepoint_module_unregister(struct lttng_ust_tracepoint * const *tracepoints_start);
int lttng_ust_tracepoint_module_unregister(struct lttng_ust_tracepoint * const *tracepoints_start)
{
struct tracepoint_lib *lib;
pthread_mutex_lock(&tracepoint_mutex);
cds_list_for_each_entry(lib, &libs, list) {
if (lib->tracepoints_start != tracepoints_start)
continue;
cds_list_del(&lib->list);
/*
* Unregistering a callsite also decreases the
* callsite reference count of the corresponding
* tracepoint, and disables the tracepoint if
* the reference count drops to zero.
*/
lib_unregister_callsites(lib);
DBG("just unregistered a tracepoints section from %p",
lib->tracepoints_start);
free(lib);
break;
}
pthread_mutex_unlock(&tracepoint_mutex);