Use common functions for module loading and unloading
[lttng-tools.git] / src / bin / lttng-sessiond / trace-ust.c
1 /*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
16 */
17
18 #define _GNU_SOURCE
19 #include <stdio.h>
20 #include <stdlib.h>
21 #include <string.h>
22 #include <unistd.h>
23 #include <inttypes.h>
24
25 #include <common/common.h>
26 #include <common/defaults.h>
27
28 #include "buffer-registry.h"
29 #include "trace-ust.h"
30 #include "utils.h"
31
32 /*
33 * Match function for the events hash table lookup.
34 *
35 * Matches by name only. Used by the disable command.
36 */
37 int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node,
38 const void *_key)
39 {
40 struct ltt_ust_event *event;
41 const char *name;
42
43 assert(node);
44 assert(_key);
45
46 event = caa_container_of(node, struct ltt_ust_event, node.node);
47 name = _key;
48
49 /* Event name */
50 if (strncmp(event->attr.name, name, sizeof(event->attr.name)) != 0) {
51 goto no_match;
52 }
53
54 /* Match */
55 return 1;
56
57 no_match:
58 return 0;
59 }
60
61 /*
62 * Match function for the hash table lookup.
63 *
64 * It matches an ust event based on three attributes which are the event name,
65 * the filter bytecode and the loglevel.
66 */
67 int trace_ust_ht_match_event(struct cds_lfht_node *node, const void *_key)
68 {
69 struct ltt_ust_event *event;
70 const struct ltt_ust_ht_key *key;
71
72 assert(node);
73 assert(_key);
74
75 event = caa_container_of(node, struct ltt_ust_event, node.node);
76 key = _key;
77
78 /* Match the 4 elements of the key: name, filter, loglevel, exclusions. */
79
80 /* Event name */
81 if (strncmp(event->attr.name, key->name, sizeof(event->attr.name)) != 0) {
82 goto no_match;
83 }
84
85 /* Event loglevel. */
86 if (event->attr.loglevel != key->loglevel) {
87 if (event->attr.loglevel_type == LTTNG_UST_LOGLEVEL_ALL
88 && key->loglevel == 0 && event->attr.loglevel == -1) {
89 /*
90 * Match is accepted. This is because on event creation, the
91 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
92 * -1 are accepted for this loglevel type since 0 is the one set by
93 * the API when receiving an enable event.
94 */
95 } else {
96 goto no_match;
97 }
98 }
99
100 /* Only one of the filters is NULL, fail. */
101 if ((key->filter && !event->filter) || (!key->filter && event->filter)) {
102 goto no_match;
103 }
104
105 if (key->filter && event->filter) {
106 /* Both filters exists, check length followed by the bytecode. */
107 if (event->filter->len != key->filter->len ||
108 memcmp(event->filter->data, key->filter->data,
109 event->filter->len) != 0) {
110 goto no_match;
111 }
112 }
113
114 /* If only one of the exclusions is NULL, fail. */
115 if ((key->exclusion && !event->exclusion) || (!key->exclusion && event->exclusion)) {
116 goto no_match;
117 }
118
119 if (key->exclusion && event->exclusion) {
120 /* Both exclusions exist; check count followed by names. */
121 if (event->exclusion->count != key->exclusion->count ||
122 memcmp(event->exclusion->names, key->exclusion->names,
123 event->exclusion->count * LTTNG_SYMBOL_NAME_LEN) != 0) {
124 goto no_match;
125 }
126 }
127 /* Match. */
128 return 1;
129
130 no_match:
131 return 0;
132 }
133
134 /*
135 * Find the channel in the hashtable and return channel pointer. RCU read side
136 * lock MUST be acquired before calling this.
137 */
138 struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht,
139 char *name)
140 {
141 struct lttng_ht_node_str *node;
142 struct lttng_ht_iter iter;
143
144 /*
145 * If we receive an empty string for channel name, it means the
146 * default channel name is requested.
147 */
148 if (name[0] == '\0')
149 name = DEFAULT_CHANNEL_NAME;
150
151 lttng_ht_lookup(ht, (void *)name, &iter);
152 node = lttng_ht_iter_get_node_str(&iter);
153 if (node == NULL) {
154 goto error;
155 }
156
157 DBG2("Trace UST channel %s found by name", name);
158
159 return caa_container_of(node, struct ltt_ust_channel, node);
160
161 error:
162 DBG2("Trace UST channel %s not found by name", name);
163 return NULL;
164 }
165
166 /*
167 * Find the event in the hashtable and return event pointer. RCU read side lock
168 * MUST be acquired before calling this.
169 */
170 struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht,
171 char *name, struct lttng_filter_bytecode *filter, int loglevel,
172 struct lttng_event_exclusion *exclusion)
173 {
174 struct lttng_ht_node_str *node;
175 struct lttng_ht_iter iter;
176 struct ltt_ust_ht_key key;
177
178 assert(name);
179 assert(ht);
180
181 key.name = name;
182 key.filter = filter;
183 key.loglevel = loglevel;
184 key.exclusion = exclusion;
185
186 cds_lfht_lookup(ht->ht, ht->hash_fct((void *) name, lttng_ht_seed),
187 trace_ust_ht_match_event, &key, &iter.iter);
188 node = lttng_ht_iter_get_node_str(&iter);
189 if (node == NULL) {
190 goto error;
191 }
192
193 DBG2("Trace UST event %s found", key.name);
194
195 return caa_container_of(node, struct ltt_ust_event, node);
196
197 error:
198 DBG2("Trace UST event %s NOT found", key.name);
199 return NULL;
200 }
201
202 /*
203 * Allocate and initialize a ust session data structure.
204 *
205 * Return pointer to structure or NULL.
206 */
207 struct ltt_ust_session *trace_ust_create_session(uint64_t session_id)
208 {
209 int ret;
210 struct ltt_ust_session *lus;
211
212 /* Allocate a new ltt ust session */
213 lus = zmalloc(sizeof(struct ltt_ust_session));
214 if (lus == NULL) {
215 PERROR("create ust session zmalloc");
216 goto error;
217 }
218
219 /* Init data structure */
220 lus->id = session_id;
221 lus->active = 0;
222
223 /* Set default metadata channel attribute. */
224 lus->metadata_attr.overwrite = DEFAULT_CHANNEL_OVERWRITE;
225 lus->metadata_attr.subbuf_size = default_get_metadata_subbuf_size();
226 lus->metadata_attr.num_subbuf = DEFAULT_METADATA_SUBBUF_NUM;
227 lus->metadata_attr.switch_timer_interval = DEFAULT_METADATA_SWITCH_TIMER;
228 lus->metadata_attr.read_timer_interval = DEFAULT_METADATA_READ_TIMER;
229 lus->metadata_attr.output = LTTNG_UST_MMAP;
230
231 /*
232 * Default buffer type. This can be changed through an enable channel
233 * requesting a different type. Note that this can only be changed once
234 * during the session lifetime which is at the first enable channel and
235 * only before start. The flag buffer_type_changed indicates the status.
236 */
237 lus->buffer_type = LTTNG_BUFFER_PER_UID;
238 /* Once set to 1, the buffer_type is immutable for the session. */
239 lus->buffer_type_changed = 0;
240 /* Init it in case it get used after allocation. */
241 CDS_INIT_LIST_HEAD(&lus->buffer_reg_uid_list);
242
243 /* Alloc UST global domain channels' HT */
244 lus->domain_global.channels = lttng_ht_new(0, LTTNG_HT_TYPE_STRING);
245 ret = jul_init_domain(&lus->domain_jul);
246 if (ret < 0) {
247 goto error_consumer;
248 }
249
250 lus->consumer = consumer_create_output(CONSUMER_DST_LOCAL);
251 if (lus->consumer == NULL) {
252 goto error_consumer;
253 }
254
255 /*
256 * The tmp_consumer stays NULL until a set_consumer_uri command is
257 * executed. At this point, the consumer should be nullify until an
258 * enable_consumer command. This assignment is symbolic since we've zmalloc
259 * the struct.
260 */
261 lus->tmp_consumer = NULL;
262
263 DBG2("UST trace session create successful");
264
265 return lus;
266
267 error_consumer:
268 ht_cleanup_push(lus->domain_global.channels);
269 jul_destroy_domain(&lus->domain_jul);
270 free(lus);
271 error:
272 return NULL;
273 }
274
275 /*
276 * Allocate and initialize a ust channel data structure.
277 *
278 * Return pointer to structure or NULL.
279 */
280 struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *chan)
281 {
282 struct ltt_ust_channel *luc;
283
284 assert(chan);
285
286 luc = zmalloc(sizeof(struct ltt_ust_channel));
287 if (luc == NULL) {
288 PERROR("ltt_ust_channel zmalloc");
289 goto error;
290 }
291
292 /* Copy UST channel attributes */
293 luc->attr.overwrite = chan->attr.overwrite;
294 luc->attr.subbuf_size = chan->attr.subbuf_size;
295 luc->attr.num_subbuf = chan->attr.num_subbuf;
296 luc->attr.switch_timer_interval = chan->attr.switch_timer_interval;
297 luc->attr.read_timer_interval = chan->attr.read_timer_interval;
298 luc->attr.output = (enum lttng_ust_output) chan->attr.output;
299
300 /* Translate to UST output enum */
301 switch (luc->attr.output) {
302 default:
303 luc->attr.output = LTTNG_UST_MMAP;
304 break;
305 }
306
307 /*
308 * If we receive an empty string for channel name, it means the
309 * default channel name is requested.
310 */
311 if (chan->name[0] == '\0') {
312 strncpy(luc->name, DEFAULT_CHANNEL_NAME, sizeof(luc->name));
313 } else {
314 /* Copy channel name */
315 strncpy(luc->name, chan->name, sizeof(luc->name));
316 }
317 luc->name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
318
319 /* Init node */
320 lttng_ht_node_init_str(&luc->node, luc->name);
321 CDS_INIT_LIST_HEAD(&luc->ctx_list);
322
323 /* Alloc hash tables */
324 luc->events = lttng_ht_new(0, LTTNG_HT_TYPE_STRING);
325 luc->ctx = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
326
327 /* On-disk circular buffer parameters */
328 luc->tracefile_size = chan->attr.tracefile_size;
329 luc->tracefile_count = chan->attr.tracefile_count;
330
331 DBG2("Trace UST channel %s created", luc->name);
332
333 error:
334 return luc;
335 }
336
337 /*
338 * Allocate and initialize a ust event. Set name and event type.
339 *
340 * Return pointer to structure or NULL.
341 */
342 struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev,
343 char *filter_expression,
344 struct lttng_filter_bytecode *filter,
345 struct lttng_event_exclusion *exclusion)
346 {
347 struct ltt_ust_event *lue;
348
349 assert(ev);
350
351 lue = zmalloc(sizeof(struct ltt_ust_event));
352 if (lue == NULL) {
353 PERROR("ust event zmalloc");
354 goto error;
355 }
356
357 switch (ev->type) {
358 case LTTNG_EVENT_PROBE:
359 lue->attr.instrumentation = LTTNG_UST_PROBE;
360 break;
361 case LTTNG_EVENT_FUNCTION:
362 lue->attr.instrumentation = LTTNG_UST_FUNCTION;
363 break;
364 case LTTNG_EVENT_FUNCTION_ENTRY:
365 lue->attr.instrumentation = LTTNG_UST_FUNCTION;
366 break;
367 case LTTNG_EVENT_TRACEPOINT:
368 lue->attr.instrumentation = LTTNG_UST_TRACEPOINT;
369 break;
370 default:
371 ERR("Unknown ust instrumentation type (%d)", ev->type);
372 goto error_free_event;
373 }
374
375 /* Copy event name */
376 strncpy(lue->attr.name, ev->name, LTTNG_UST_SYM_NAME_LEN);
377 lue->attr.name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
378
379 switch (ev->loglevel_type) {
380 case LTTNG_EVENT_LOGLEVEL_ALL:
381 lue->attr.loglevel_type = LTTNG_UST_LOGLEVEL_ALL;
382 lue->attr.loglevel = -1; /* Force to -1 */
383 break;
384 case LTTNG_EVENT_LOGLEVEL_RANGE:
385 lue->attr.loglevel_type = LTTNG_UST_LOGLEVEL_RANGE;
386 lue->attr.loglevel = ev->loglevel;
387 break;
388 case LTTNG_EVENT_LOGLEVEL_SINGLE:
389 lue->attr.loglevel_type = LTTNG_UST_LOGLEVEL_SINGLE;
390 lue->attr.loglevel = ev->loglevel;
391 break;
392 default:
393 ERR("Unknown ust loglevel type (%d)", ev->loglevel_type);
394 goto error_free_event;
395 }
396
397 /* Same layout. */
398 lue->filter_expression = filter_expression;
399 lue->filter = (struct lttng_ust_filter_bytecode *) filter;
400 lue->exclusion = (struct lttng_event_exclusion *) exclusion;
401
402 /* Init node */
403 lttng_ht_node_init_str(&lue->node, lue->attr.name);
404
405 DBG2("Trace UST event %s, loglevel (%d,%d) created",
406 lue->attr.name, lue->attr.loglevel_type,
407 lue->attr.loglevel);
408
409 return lue;
410
411 error_free_event:
412 free(lue);
413 error:
414 return NULL;
415 }
416
417 static
418 int trace_ust_context_type_event_to_ust(enum lttng_event_context_type type)
419 {
420 int utype;
421
422 switch (type) {
423 case LTTNG_EVENT_CONTEXT_VTID:
424 utype = LTTNG_UST_CONTEXT_VTID;
425 break;
426 case LTTNG_EVENT_CONTEXT_VPID:
427 utype = LTTNG_UST_CONTEXT_VPID;
428 break;
429 case LTTNG_EVENT_CONTEXT_PTHREAD_ID:
430 utype = LTTNG_UST_CONTEXT_PTHREAD_ID;
431 break;
432 case LTTNG_EVENT_CONTEXT_PROCNAME:
433 utype = LTTNG_UST_CONTEXT_PROCNAME;
434 break;
435 case LTTNG_EVENT_CONTEXT_IP:
436 utype = LTTNG_UST_CONTEXT_IP;
437 break;
438 case LTTNG_EVENT_CONTEXT_PERF_THREAD_COUNTER:
439 utype = LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER;
440 break;
441 default:
442 ERR("Invalid UST context");
443 utype = -1;
444 break;
445 }
446 return utype;
447 }
448
449 /*
450 * Return 1 if contexts match, 0 otherwise.
451 */
452 int trace_ust_match_context(struct ltt_ust_context *uctx,
453 struct lttng_event_context *ctx)
454 {
455 int utype;
456
457 utype = trace_ust_context_type_event_to_ust(ctx->ctx);
458 if (utype < 0) {
459 return 0;
460 }
461 if (uctx->ctx.ctx != utype) {
462 return 0;
463 }
464 switch (utype) {
465 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER:
466 if (uctx->ctx.u.perf_counter.type
467 != ctx->u.perf_counter.type) {
468 return 0;
469 }
470 if (uctx->ctx.u.perf_counter.config
471 != ctx->u.perf_counter.config) {
472 return 0;
473 }
474 if (strncmp(uctx->ctx.u.perf_counter.name,
475 ctx->u.perf_counter.name,
476 LTTNG_UST_SYM_NAME_LEN)) {
477 return 0;
478 }
479 break;
480 default:
481 break;
482
483 }
484 return 1;
485 }
486
487 /*
488 * Allocate and initialize an UST context.
489 *
490 * Return pointer to structure or NULL.
491 */
492 struct ltt_ust_context *trace_ust_create_context(
493 struct lttng_event_context *ctx)
494 {
495 struct ltt_ust_context *uctx;
496 int utype;
497
498 assert(ctx);
499
500 utype = trace_ust_context_type_event_to_ust(ctx->ctx);
501 if (utype < 0) {
502 return NULL;
503 }
504
505 uctx = zmalloc(sizeof(struct ltt_ust_context));
506 if (uctx == NULL) {
507 PERROR("zmalloc ltt_ust_context");
508 goto error;
509 }
510
511 uctx->ctx.ctx = (enum lttng_ust_context_type) utype;
512 switch (utype) {
513 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER:
514 uctx->ctx.u.perf_counter.type = ctx->u.perf_counter.type;
515 uctx->ctx.u.perf_counter.config = ctx->u.perf_counter.config;
516 strncpy(uctx->ctx.u.perf_counter.name, ctx->u.perf_counter.name,
517 LTTNG_UST_SYM_NAME_LEN);
518 uctx->ctx.u.perf_counter.name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
519 break;
520 default:
521 break;
522 }
523 lttng_ht_node_init_ulong(&uctx->node, (unsigned long) uctx->ctx.ctx);
524
525 return uctx;
526
527 error:
528 return NULL;
529 }
530
531 /*
532 * RCU safe free context structure.
533 */
534 static void destroy_context_rcu(struct rcu_head *head)
535 {
536 struct lttng_ht_node_ulong *node =
537 caa_container_of(head, struct lttng_ht_node_ulong, head);
538 struct ltt_ust_context *ctx =
539 caa_container_of(node, struct ltt_ust_context, node);
540
541 free(ctx);
542 }
543
544 /*
545 * Cleanup UST context hash table.
546 */
547 static void destroy_contexts(struct lttng_ht *ht)
548 {
549 int ret;
550 struct lttng_ht_node_ulong *node;
551 struct lttng_ht_iter iter;
552 struct ltt_ust_context *ctx;
553
554 assert(ht);
555
556 rcu_read_lock();
557 cds_lfht_for_each_entry(ht->ht, &iter.iter, node, node) {
558 /* Remove from ordered list. */
559 ctx = caa_container_of(node, struct ltt_ust_context, node);
560 cds_list_del(&ctx->list);
561 /* Remove from channel's hash table. */
562 ret = lttng_ht_del(ht, &iter);
563 if (!ret) {
564 call_rcu(&node->head, destroy_context_rcu);
565 }
566 }
567 rcu_read_unlock();
568
569 ht_cleanup_push(ht);
570 }
571
572 /*
573 * Cleanup ust event structure.
574 */
575 void trace_ust_destroy_event(struct ltt_ust_event *event)
576 {
577 assert(event);
578
579 DBG2("Trace destroy UST event %s", event->attr.name);
580 free(event->filter_expression);
581 free(event->filter);
582 free(event->exclusion);
583 free(event);
584 }
585
586 /*
587 * URCU intermediate call to complete destroy event.
588 */
589 static void destroy_event_rcu(struct rcu_head *head)
590 {
591 struct lttng_ht_node_str *node =
592 caa_container_of(head, struct lttng_ht_node_str, head);
593 struct ltt_ust_event *event =
594 caa_container_of(node, struct ltt_ust_event, node);
595
596 trace_ust_destroy_event(event);
597 }
598
599 /*
600 * Cleanup UST events hashtable.
601 */
602 static void destroy_events(struct lttng_ht *events)
603 {
604 int ret;
605 struct lttng_ht_node_str *node;
606 struct lttng_ht_iter iter;
607
608 assert(events);
609
610 rcu_read_lock();
611 cds_lfht_for_each_entry(events->ht, &iter.iter, node, node) {
612 ret = lttng_ht_del(events, &iter);
613 assert(!ret);
614 call_rcu(&node->head, destroy_event_rcu);
615 }
616 rcu_read_unlock();
617
618 ht_cleanup_push(events);
619 }
620
621 /*
622 * Cleanup ust channel structure.
623 *
624 * Should _NOT_ be called with RCU read lock held.
625 */
626 static void _trace_ust_destroy_channel(struct ltt_ust_channel *channel)
627 {
628 assert(channel);
629
630 DBG2("Trace destroy UST channel %s", channel->name);
631
632 /* Destroying all events of the channel */
633 destroy_events(channel->events);
634 /* Destroying all context of the channel */
635 destroy_contexts(channel->ctx);
636
637 free(channel);
638 }
639
640 /*
641 * URCU intermediate call to complete destroy channel.
642 */
643 static void destroy_channel_rcu(struct rcu_head *head)
644 {
645 struct lttng_ht_node_str *node =
646 caa_container_of(head, struct lttng_ht_node_str, head);
647 struct ltt_ust_channel *channel =
648 caa_container_of(node, struct ltt_ust_channel, node);
649
650 _trace_ust_destroy_channel(channel);
651 }
652
653 void trace_ust_destroy_channel(struct ltt_ust_channel *channel)
654 {
655 call_rcu(&channel->node.head, destroy_channel_rcu);
656 }
657
658 /*
659 * Remove an UST channel from a channel HT.
660 */
661 void trace_ust_delete_channel(struct lttng_ht *ht,
662 struct ltt_ust_channel *channel)
663 {
664 int ret;
665 struct lttng_ht_iter iter;
666
667 assert(ht);
668 assert(channel);
669
670 iter.iter.node = &channel->node.node;
671 ret = lttng_ht_del(ht, &iter);
672 assert(!ret);
673 }
674
675 /*
676 * Iterate over a hash table containing channels and cleanup safely.
677 */
678 static void destroy_channels(struct lttng_ht *channels)
679 {
680 int ret;
681 struct lttng_ht_node_str *node;
682 struct lttng_ht_iter iter;
683
684 assert(channels);
685
686 rcu_read_lock();
687
688 cds_lfht_for_each_entry(channels->ht, &iter.iter, node, node) {
689 ret = lttng_ht_del(channels, &iter);
690 assert(!ret);
691 call_rcu(&node->head, destroy_channel_rcu);
692 }
693 rcu_read_unlock();
694
695 ht_cleanup_push(channels);
696 }
697
698 /*
699 * Cleanup UST global domain.
700 */
701 static void destroy_domain_global(struct ltt_ust_domain_global *dom)
702 {
703 assert(dom);
704
705 destroy_channels(dom->channels);
706 }
707
708 /*
709 * Cleanup ust session structure
710 *
711 * Should *NOT* be called with RCU read-side lock held.
712 */
713 void trace_ust_destroy_session(struct ltt_ust_session *session)
714 {
715 struct buffer_reg_uid *reg, *sreg;
716
717 assert(session);
718
719 DBG2("Trace UST destroy session %" PRIu64, session->id);
720
721 /* Cleaning up UST domain */
722 destroy_domain_global(&session->domain_global);
723 jul_destroy_domain(&session->domain_jul);
724
725 /* Cleanup UID buffer registry object(s). */
726 cds_list_for_each_entry_safe(reg, sreg, &session->buffer_reg_uid_list,
727 lnode) {
728 cds_list_del(&reg->lnode);
729 buffer_reg_uid_remove(reg);
730 buffer_reg_uid_destroy(reg, session->consumer);
731 }
732
733 consumer_destroy_output(session->consumer);
734 consumer_destroy_output(session->tmp_consumer);
735
736 free(session);
737 }
This page took 0.05294 seconds and 5 git commands to generate.