2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License as published by the Free
6 * Software Foundation; only version 2 of the License.
8 * This program is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
15 * Place - Suite 330, Boston, MA 02111-1307, USA.
24 #include <common/common.h>
25 #include <common/defaults.h>
27 #include "trace-ust.h"
30 * Find the channel in the hashtable.
32 struct ltt_ust_channel
*trace_ust_find_channel_by_name(struct lttng_ht
*ht
,
35 struct lttng_ht_node_str
*node
;
36 struct lttng_ht_iter iter
;
39 lttng_ht_lookup(ht
, (void *)name
, &iter
);
40 node
= lttng_ht_iter_get_node_str(&iter
);
47 DBG2("Trace UST channel %s found by name", name
);
49 return caa_container_of(node
, struct ltt_ust_channel
, node
);
52 DBG2("Trace UST channel %s not found by name", name
);
57 * Find the event in the hashtable.
59 struct ltt_ust_event
*trace_ust_find_event_by_name(struct lttng_ht
*ht
,
62 struct lttng_ht_node_str
*node
;
63 struct lttng_ht_iter iter
;
66 lttng_ht_lookup(ht
, (void *) name
, &iter
);
67 node
= lttng_ht_iter_get_node_str(&iter
);
74 DBG2("Trace UST event found by name %s", name
);
76 return caa_container_of(node
, struct ltt_ust_event
, node
);
79 DBG2("Trace UST event NOT found by name %s", name
);
84 * Allocate and initialize a ust session data structure.
86 * Return pointer to structure or NULL.
88 struct ltt_ust_session
*trace_ust_create_session(char *path
, int session_id
,
89 struct lttng_domain
*domain
)
92 struct ltt_ust_session
*lus
;
94 /* Allocate a new ltt ust session */
95 lus
= zmalloc(sizeof(struct ltt_ust_session
));
97 PERROR("create ust session zmalloc");
101 /* Init data structure */
102 lus
->id
= session_id
;
103 lus
->start_trace
= 0;
105 /* Alloc UST domain hash tables */
106 lus
->domain_pid
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
107 lus
->domain_exec
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
109 /* Alloc UST global domain channels' HT */
110 lus
->domain_global
.channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
112 /* Set session path */
113 ret
= snprintf(lus
->pathname
, PATH_MAX
, "%s/ust", path
);
115 PERROR("snprintf kernel traces path");
116 goto error_free_session
;
119 DBG2("UST trace session create successful");
130 * Allocate and initialize a ust channel data structure.
132 * Return pointer to structure or NULL.
134 struct ltt_ust_channel
*trace_ust_create_channel(struct lttng_channel
*chan
,
138 struct ltt_ust_channel
*luc
;
140 luc
= zmalloc(sizeof(struct ltt_ust_channel
));
142 PERROR("ltt_ust_channel zmalloc");
146 /* Copy UST channel attributes */
147 luc
->attr
.overwrite
= chan
->attr
.overwrite
;
148 luc
->attr
.subbuf_size
= chan
->attr
.subbuf_size
;
149 luc
->attr
.num_subbuf
= chan
->attr
.num_subbuf
;
150 luc
->attr
.switch_timer_interval
= chan
->attr
.switch_timer_interval
;
151 luc
->attr
.read_timer_interval
= chan
->attr
.read_timer_interval
;
152 luc
->attr
.output
= chan
->attr
.output
;
154 /* Translate to UST output enum */
155 switch (luc
->attr
.output
) {
157 luc
->attr
.output
= LTTNG_UST_MMAP
;
161 /* Copy channel name */
162 strncpy(luc
->name
, chan
->name
, sizeof(luc
->name
));
163 luc
->name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
166 lttng_ht_node_init_str(&luc
->node
, luc
->name
);
167 /* Alloc hash tables */
168 luc
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
169 luc
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
171 /* Set trace output path */
172 ret
= snprintf(luc
->pathname
, PATH_MAX
, "%s", path
);
174 PERROR("asprintf ust create channel");
175 goto error_free_channel
;
178 DBG2("Trace UST channel %s created", luc
->name
);
189 * Allocate and initialize a ust event. Set name and event type.
191 * Return pointer to structure or NULL.
193 struct ltt_ust_event
*trace_ust_create_event(struct lttng_event
*ev
)
195 struct ltt_ust_event
*lue
;
197 lue
= zmalloc(sizeof(struct ltt_ust_event
));
199 PERROR("ust event zmalloc");
204 case LTTNG_EVENT_PROBE
:
205 lue
->attr
.instrumentation
= LTTNG_UST_PROBE
;
207 case LTTNG_EVENT_FUNCTION
:
208 lue
->attr
.instrumentation
= LTTNG_UST_FUNCTION
;
210 case LTTNG_EVENT_FUNCTION_ENTRY
:
211 lue
->attr
.instrumentation
= LTTNG_UST_FUNCTION
;
213 case LTTNG_EVENT_TRACEPOINT
:
214 lue
->attr
.instrumentation
= LTTNG_UST_TRACEPOINT
;
217 ERR("Unknown ust instrumentation type (%d)", ev
->type
);
218 goto error_free_event
;
221 /* Copy event name */
222 strncpy(lue
->attr
.name
, ev
->name
, LTTNG_UST_SYM_NAME_LEN
);
223 lue
->attr
.name
[LTTNG_UST_SYM_NAME_LEN
- 1] = '\0';
225 switch (ev
->loglevel_type
) {
226 case LTTNG_EVENT_LOGLEVEL_ALL
:
227 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
228 lue
->attr
.loglevel
= -1; /* Force to -1 */
230 case LTTNG_EVENT_LOGLEVEL_RANGE
:
231 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_RANGE
;
232 lue
->attr
.loglevel
= ev
->loglevel
;
234 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
235 lue
->attr
.loglevel_type
= LTTNG_UST_LOGLEVEL_SINGLE
;
236 lue
->attr
.loglevel
= ev
->loglevel
;
239 ERR("Unknown ust loglevel type (%d)", ev
->loglevel_type
);
240 goto error_free_event
;
245 lttng_ht_node_init_str(&lue
->node
, lue
->attr
.name
);
246 /* Alloc context hash tables */
247 lue
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
249 DBG2("Trace UST event %s, loglevel (%d,%d) created",
250 lue
->attr
.name
, lue
->attr
.loglevel_type
,
262 * Allocate and initialize a ust metadata.
264 * Return pointer to structure or NULL.
266 struct ltt_ust_metadata
*trace_ust_create_metadata(char *path
)
269 struct ltt_ust_metadata
*lum
;
271 lum
= zmalloc(sizeof(struct ltt_ust_metadata
));
273 PERROR("ust metadata zmalloc");
277 /* Set default attributes */
278 lum
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
279 lum
->attr
.subbuf_size
= DEFAULT_METADATA_SUBBUF_SIZE
;
280 lum
->attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
281 lum
->attr
.switch_timer_interval
= DEFAULT_CHANNEL_SWITCH_TIMER
;
282 lum
->attr
.read_timer_interval
= DEFAULT_CHANNEL_READ_TIMER
;
283 lum
->attr
.output
= LTTNG_UST_MMAP
;
286 /* Set metadata trace path */
287 ret
= snprintf(lum
->pathname
, PATH_MAX
, "%s/metadata", path
);
289 PERROR("asprintf ust metadata");
290 goto error_free_metadata
;
302 * Allocate and initialize an UST context.
304 * Return pointer to structure or NULL.
306 struct ltt_ust_context
*trace_ust_create_context(
307 struct lttng_event_context
*ctx
)
309 struct ltt_ust_context
*uctx
;
310 enum lttng_ust_context_type utype
;
313 case LTTNG_EVENT_CONTEXT_VTID
:
314 utype
= LTTNG_UST_CONTEXT_VTID
;
316 case LTTNG_EVENT_CONTEXT_VPID
:
317 utype
= LTTNG_UST_CONTEXT_VPID
;
319 case LTTNG_EVENT_CONTEXT_PTHREAD_ID
:
320 utype
= LTTNG_UST_CONTEXT_PTHREAD_ID
;
322 case LTTNG_EVENT_CONTEXT_PROCNAME
:
323 utype
= LTTNG_UST_CONTEXT_PROCNAME
;
326 ERR("Invalid UST context");
330 uctx
= zmalloc(sizeof(struct ltt_ust_context
));
332 PERROR("zmalloc ltt_ust_context");
336 uctx
->ctx
.ctx
= utype
;
337 lttng_ht_node_init_ulong(&uctx
->node
, (unsigned long) uctx
->ctx
.ctx
);
346 * RCU safe free context structure.
348 static void destroy_context_rcu(struct rcu_head
*head
)
350 struct lttng_ht_node_ulong
*node
=
351 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
352 struct ltt_ust_context
*ctx
=
353 caa_container_of(node
, struct ltt_ust_context
, node
);
359 * Cleanup UST context hash table.
361 static void destroy_contexts(struct lttng_ht
*ht
)
364 struct lttng_ht_node_ulong
*node
;
365 struct lttng_ht_iter iter
;
367 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, node
, node
) {
368 ret
= lttng_ht_del(ht
, &iter
);
370 call_rcu(&node
->head
, destroy_context_rcu
);
374 lttng_ht_destroy(ht
);
378 * Cleanup ust event structure.
380 void trace_ust_destroy_event(struct ltt_ust_event
*event
)
382 DBG2("Trace destroy UST event %s", event
->attr
.name
);
383 destroy_contexts(event
->ctx
);
389 * URCU intermediate call to complete destroy event.
391 static void destroy_event_rcu(struct rcu_head
*head
)
393 struct lttng_ht_node_str
*node
=
394 caa_container_of(head
, struct lttng_ht_node_str
, head
);
395 struct ltt_ust_event
*event
=
396 caa_container_of(node
, struct ltt_ust_event
, node
);
398 trace_ust_destroy_event(event
);
402 * Cleanup UST events hashtable.
404 static void destroy_events(struct lttng_ht
*events
)
407 struct lttng_ht_node_str
*node
;
408 struct lttng_ht_iter iter
;
410 cds_lfht_for_each_entry(events
->ht
, &iter
.iter
, node
, node
) {
411 ret
= lttng_ht_del(events
, &iter
);
413 call_rcu(&node
->head
, destroy_event_rcu
);
416 lttng_ht_destroy(events
);
420 * Cleanup ust channel structure.
422 void trace_ust_destroy_channel(struct ltt_ust_channel
*channel
)
424 DBG2("Trace destroy UST channel %s", channel
->name
);
428 /* Destroying all events of the channel */
429 destroy_events(channel
->events
);
430 /* Destroying all context of the channel */
431 destroy_contexts(channel
->ctx
);
439 * URCU intermediate call to complete destroy channel.
441 static void destroy_channel_rcu(struct rcu_head
*head
)
443 struct lttng_ht_node_str
*node
=
444 caa_container_of(head
, struct lttng_ht_node_str
, head
);
445 struct ltt_ust_channel
*channel
=
446 caa_container_of(node
, struct ltt_ust_channel
, node
);
448 trace_ust_destroy_channel(channel
);
452 * Cleanup ust metadata structure.
454 void trace_ust_destroy_metadata(struct ltt_ust_metadata
*metadata
)
456 DBG2("Trace UST destroy metadata %d", metadata
->handle
);
462 * Iterate over a hash table containing channels and cleanup safely.
464 static void destroy_channels(struct lttng_ht
*channels
)
467 struct lttng_ht_node_str
*node
;
468 struct lttng_ht_iter iter
;
472 cds_lfht_for_each_entry(channels
->ht
, &iter
.iter
, node
, node
) {
473 ret
= lttng_ht_del(channels
, &iter
);
475 call_rcu(&node
->head
, destroy_channel_rcu
);
478 lttng_ht_destroy(channels
);
484 * Cleanup UST pid domain.
486 static void destroy_domain_pid(struct lttng_ht
*ht
)
489 struct lttng_ht_iter iter
;
490 struct ltt_ust_domain_pid
*dpid
;
492 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, dpid
, node
.node
) {
493 ret
= lttng_ht_del(ht
, &iter
);
495 destroy_channels(dpid
->channels
);
498 lttng_ht_destroy(ht
);
502 * Cleanup UST exec name domain.
504 static void destroy_domain_exec(struct lttng_ht
*ht
)
507 struct lttng_ht_iter iter
;
508 struct ltt_ust_domain_exec
*dexec
;
510 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, dexec
, node
.node
) {
511 ret
= lttng_ht_del(ht
, &iter
);
513 destroy_channels(dexec
->channels
);
516 lttng_ht_destroy(ht
);
520 * Cleanup UST global domain.
522 static void destroy_domain_global(struct ltt_ust_domain_global
*dom
)
524 destroy_channels(dom
->channels
);
528 * Cleanup ust session structure
530 void trace_ust_destroy_session(struct ltt_ust_session
*session
)
532 /* Extra protection */
533 if (session
== NULL
) {
539 DBG2("Trace UST destroy session %d", session
->id
);
541 /* Cleaning up UST domain */
542 destroy_domain_global(&session
->domain_global
);
543 destroy_domain_pid(session
->domain_pid
);
544 destroy_domain_exec(session
->domain_exec
);