2 * SPDX-License-Identifier: LGPL-2.1-only
4 * Copyright (C) 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
6 * LTTng UST application context provider.
12 #include <sys/types.h>
15 #include <common/ust-context-provider.h>
17 #include "context-internal.h"
18 #include "lttng-tracer-core.h"
19 #include "common/jhash.h"
20 #include "context-provider-internal.h"
21 #include "common/macros.h"
22 #include "common/tracer.h"
24 struct lttng_ust_registered_context_provider
{
25 const struct lttng_ust_context_provider
*provider
;
27 struct cds_hlist_node node
;
30 #define CONTEXT_PROVIDER_HT_BITS 12
31 #define CONTEXT_PROVIDER_HT_SIZE (1U << CONTEXT_PROVIDER_HT_BITS)
32 struct context_provider_ht
{
33 struct cds_hlist_head table
[CONTEXT_PROVIDER_HT_SIZE
];
36 static struct context_provider_ht context_provider_ht
;
38 static const struct lttng_ust_context_provider
*
39 lookup_provider_by_name(const char *name
)
41 struct cds_hlist_head
*head
;
42 struct cds_hlist_node
*node
;
43 struct lttng_ust_registered_context_provider
*reg_provider
;
48 /* Lookup using everything before first ':' as key. */
49 end
= strchr(name
, ':');
54 hash
= jhash(name
, len
, 0);
55 head
= &context_provider_ht
.table
[hash
& (CONTEXT_PROVIDER_HT_SIZE
- 1)];
56 cds_hlist_for_each_entry(reg_provider
, node
, head
, node
) {
57 if (!strncmp(reg_provider
->provider
->name
, name
, len
))
58 return reg_provider
->provider
;
63 struct lttng_ust_registered_context_provider
*lttng_ust_context_provider_register(struct lttng_ust_context_provider
*provider
)
65 struct lttng_ust_registered_context_provider
*reg_provider
= NULL
;
66 struct cds_hlist_head
*head
;
67 size_t name_len
= strlen(provider
->name
);
70 lttng_ust_alloc_tls();
72 /* Provider name starts with "$app.". */
73 if (strncmp("$app.", provider
->name
, strlen("$app.")) != 0)
75 /* Provider name cannot contain a colon character. */
76 if (strchr(provider
->name
, ':'))
80 if (lookup_provider_by_name(provider
->name
))
82 reg_provider
= zmalloc(sizeof(struct lttng_ust_registered_context_provider
));
85 reg_provider
->provider
= provider
;
86 hash
= jhash(provider
->name
, name_len
, 0);
87 head
= &context_provider_ht
.table
[hash
& (CONTEXT_PROVIDER_HT_SIZE
- 1)];
88 cds_hlist_add_head(®_provider
->node
, head
);
90 lttng_ust_context_set_session_provider(provider
->name
,
91 provider
->get_size
, provider
->record
,
94 lttng_ust_context_set_event_notifier_group_provider(provider
->name
,
95 provider
->get_size
, provider
->record
,
102 void lttng_ust_context_provider_unregister(struct lttng_ust_registered_context_provider
*reg_provider
)
104 lttng_ust_alloc_tls();
108 lttng_ust_context_set_session_provider(reg_provider
->provider
->name
,
109 lttng_ust_dummy_get_size
, lttng_ust_dummy_record
,
110 lttng_ust_dummy_get_value
);
112 lttng_ust_context_set_event_notifier_group_provider(reg_provider
->provider
->name
,
113 lttng_ust_dummy_get_size
, lttng_ust_dummy_record
,
114 lttng_ust_dummy_get_value
);
116 cds_hlist_del(®_provider
->node
);
123 void app_context_destroy(void *priv
)
125 struct lttng_ust_app_context
*app_ctx
= (struct lttng_ust_app_context
*) priv
;
127 free(app_ctx
->ctx_name
);
128 free(app_ctx
->event_field
);
132 const struct lttng_ust_type_common app_ctx_type
= {
133 .type
= lttng_ust_type_dynamic
,
137 * Called with ust mutex held.
138 * Add application context to array of context, even if the application
139 * context is not currently loaded by application. It will then use the
140 * dummy callbacks in that case.
141 * Always performed before tracing is started, since it modifies
142 * metadata describing the context.
144 int lttng_ust_add_app_context_to_ctx_rcu(const char *name
,
145 struct lttng_ust_ctx
**ctx
)
147 const struct lttng_ust_context_provider
*provider
;
148 struct lttng_ust_ctx_field new_field
= { 0 };
149 struct lttng_ust_event_field
*event_field
= NULL
;
150 struct lttng_ust_app_context
*app_ctx
= NULL
;
154 if (*ctx
&& lttng_find_context(*ctx
, name
))
156 event_field
= zmalloc(sizeof(struct lttng_ust_event_field
));
159 goto error_event_field_alloc
;
161 ctx_name
= strdup(name
);
164 goto error_field_name_alloc
;
166 app_ctx
= zmalloc(sizeof(struct lttng_ust_app_context
));
169 goto error_app_ctx_alloc
;
171 app_ctx
->struct_size
= sizeof(struct lttng_ust_app_context
);
172 app_ctx
->event_field
= event_field
;
173 app_ctx
->ctx_name
= ctx_name
;
175 event_field
->name
= ctx_name
;
176 event_field
->type
= &app_ctx_type
;
177 new_field
.event_field
= event_field
;
179 * If provider is not found, we add the context anyway, but
180 * it will provide a dummy context.
182 provider
= lookup_provider_by_name(name
);
184 new_field
.get_size
= provider
->get_size
;
185 new_field
.record
= provider
->record
;
186 new_field
.get_value
= provider
->get_value
;
188 new_field
.get_size
= lttng_ust_dummy_get_size
;
189 new_field
.record
= lttng_ust_dummy_record
;
190 new_field
.get_value
= lttng_ust_dummy_get_value
;
192 new_field
.priv
= app_ctx
;
193 new_field
.destroy
= app_context_destroy
;
195 * For application context, add it by expanding
198 ret
= lttng_ust_context_append_rcu(ctx
, &new_field
);
208 error_field_name_alloc
:
210 error_event_field_alloc
: