c0fc3a0253fe7c630b5abd5ed0db86a3c1272d9c
[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 {
173 struct lttng_ht_node_str *node;
174 struct lttng_ht_iter iter;
175 struct ltt_ust_ht_key key;
176
177 assert(name);
178 assert(ht);
179
180 key.name = name;
181 key.filter = filter;
182 key.loglevel = loglevel;
183
184 cds_lfht_lookup(ht->ht, ht->hash_fct((void *) name, lttng_ht_seed),
185 trace_ust_ht_match_event, &key, &iter.iter);
186 node = lttng_ht_iter_get_node_str(&iter);
187 if (node == NULL) {
188 goto error;
189 }
190
191 DBG2("Trace UST event %s found", key.name);
192
193 return caa_container_of(node, struct ltt_ust_event, node);
194
195 error:
196 DBG2("Trace UST event %s NOT found", key.name);
197 return NULL;
198 }
199
200 /*
201 * Allocate and initialize a ust session data structure.
202 *
203 * Return pointer to structure or NULL.
204 */
205 struct ltt_ust_session *trace_ust_create_session(uint64_t session_id)
206 {
207 int ret;
208 struct ltt_ust_session *lus;
209
210 /* Allocate a new ltt ust session */
211 lus = zmalloc(sizeof(struct ltt_ust_session));
212 if (lus == NULL) {
213 PERROR("create ust session zmalloc");
214 goto error;
215 }
216
217 /* Init data structure */
218 lus->id = session_id;
219 lus->start_trace = 0;
220
221 /*
222 * Default buffer type. This can be changed through an enable channel
223 * requesting a different type. Note that this can only be changed once
224 * during the session lifetime which is at the first enable channel and
225 * only before start. The flag buffer_type_changed indicates the status.
226 */
227 lus->buffer_type = LTTNG_BUFFER_PER_UID;
228 /* Once set to 1, the buffer_type is immutable for the session. */
229 lus->buffer_type_changed = 0;
230 /* Init it in case it get used after allocation. */
231 CDS_INIT_LIST_HEAD(&lus->buffer_reg_uid_list);
232
233 /* Alloc UST global domain channels' HT */
234 lus->domain_global.channels = lttng_ht_new(0, LTTNG_HT_TYPE_STRING);
235 ret = jul_init_domain(&lus->domain_jul);
236 if (ret < 0) {
237 goto error_consumer;
238 }
239
240 lus->consumer = consumer_create_output(CONSUMER_DST_LOCAL);
241 if (lus->consumer == NULL) {
242 goto error_consumer;
243 }
244
245 /*
246 * The tmp_consumer stays NULL until a set_consumer_uri command is
247 * executed. At this point, the consumer should be nullify until an
248 * enable_consumer command. This assignment is symbolic since we've zmalloc
249 * the struct.
250 */
251 lus->tmp_consumer = NULL;
252
253 DBG2("UST trace session create successful");
254
255 return lus;
256
257 error_consumer:
258 ht_cleanup_push(lus->domain_global.channels);
259 jul_destroy_domain(&lus->domain_jul);
260 free(lus);
261 error:
262 return NULL;
263 }
264
265 /*
266 * Allocate and initialize a ust channel data structure.
267 *
268 * Return pointer to structure or NULL.
269 */
270 struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *chan)
271 {
272 struct ltt_ust_channel *luc;
273
274 assert(chan);
275
276 luc = zmalloc(sizeof(struct ltt_ust_channel));
277 if (luc == NULL) {
278 PERROR("ltt_ust_channel zmalloc");
279 goto error;
280 }
281
282 /* Copy UST channel attributes */
283 luc->attr.overwrite = chan->attr.overwrite;
284 luc->attr.subbuf_size = chan->attr.subbuf_size;
285 luc->attr.num_subbuf = chan->attr.num_subbuf;
286 luc->attr.switch_timer_interval = chan->attr.switch_timer_interval;
287 luc->attr.read_timer_interval = chan->attr.read_timer_interval;
288 luc->attr.output = (enum lttng_ust_output) chan->attr.output;
289
290 /* Translate to UST output enum */
291 switch (luc->attr.output) {
292 default:
293 luc->attr.output = LTTNG_UST_MMAP;
294 break;
295 }
296
297 /*
298 * If we receive an empty string for channel name, it means the
299 * default channel name is requested.
300 */
301 if (chan->name[0] == '\0') {
302 strncpy(luc->name, DEFAULT_CHANNEL_NAME, sizeof(luc->name));
303 } else {
304 /* Copy channel name */
305 strncpy(luc->name, chan->name, sizeof(luc->name));
306 }
307 luc->name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
308
309 /* Init node */
310 lttng_ht_node_init_str(&luc->node, luc->name);
311 CDS_INIT_LIST_HEAD(&luc->ctx_list);
312
313 /* Alloc hash tables */
314 luc->events = lttng_ht_new(0, LTTNG_HT_TYPE_STRING);
315 luc->ctx = lttng_ht_new(0, LTTNG_HT_TYPE_ULONG);
316
317 /* On-disk circular buffer parameters */
318 luc->tracefile_size = chan->attr.tracefile_size;
319 luc->tracefile_count = chan->attr.tracefile_count;
320
321 DBG2("Trace UST channel %s created", luc->name);
322
323 error:
324 return luc;
325 }
326
327 /*
328 * Allocate and initialize a ust event. Set name and event type.
329 *
330 * Return pointer to structure or NULL.
331 */
332 struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev,
333 struct lttng_filter_bytecode *filter)
334 {
335 struct ltt_ust_event *lue;
336
337 assert(ev);
338
339 lue = zmalloc(sizeof(struct ltt_ust_event));
340 if (lue == NULL) {
341 PERROR("ust event zmalloc");
342 goto error;
343 }
344
345 switch (ev->type) {
346 case LTTNG_EVENT_PROBE:
347 lue->attr.instrumentation = LTTNG_UST_PROBE;
348 break;
349 case LTTNG_EVENT_FUNCTION:
350 lue->attr.instrumentation = LTTNG_UST_FUNCTION;
351 break;
352 case LTTNG_EVENT_FUNCTION_ENTRY:
353 lue->attr.instrumentation = LTTNG_UST_FUNCTION;
354 break;
355 case LTTNG_EVENT_TRACEPOINT:
356 lue->attr.instrumentation = LTTNG_UST_TRACEPOINT;
357 break;
358 default:
359 ERR("Unknown ust instrumentation type (%d)", ev->type);
360 goto error_free_event;
361 }
362
363 /* Copy event name */
364 strncpy(lue->attr.name, ev->name, LTTNG_UST_SYM_NAME_LEN);
365 lue->attr.name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
366
367 switch (ev->loglevel_type) {
368 case LTTNG_EVENT_LOGLEVEL_ALL:
369 lue->attr.loglevel_type = LTTNG_UST_LOGLEVEL_ALL;
370 lue->attr.loglevel = -1; /* Force to -1 */
371 break;
372 case LTTNG_EVENT_LOGLEVEL_RANGE:
373 lue->attr.loglevel_type = LTTNG_UST_LOGLEVEL_RANGE;
374 lue->attr.loglevel = ev->loglevel;
375 break;
376 case LTTNG_EVENT_LOGLEVEL_SINGLE:
377 lue->attr.loglevel_type = LTTNG_UST_LOGLEVEL_SINGLE;
378 lue->attr.loglevel = ev->loglevel;
379 break;
380 default:
381 ERR("Unknown ust loglevel type (%d)", ev->loglevel_type);
382 goto error_free_event;
383 }
384
385 /* Same layout. */
386 lue->filter = (struct lttng_ust_filter_bytecode *) filter;
387
388 /* Init node */
389 lttng_ht_node_init_str(&lue->node, lue->attr.name);
390
391 DBG2("Trace UST event %s, loglevel (%d,%d) created",
392 lue->attr.name, lue->attr.loglevel_type,
393 lue->attr.loglevel);
394
395 return lue;
396
397 error_free_event:
398 free(lue);
399 error:
400 return NULL;
401 }
402
403 /*
404 * Allocate and initialize a ust metadata.
405 *
406 * Return pointer to structure or NULL.
407 */
408 struct ltt_ust_metadata *trace_ust_create_metadata(char *path)
409 {
410 int ret;
411 struct ltt_ust_metadata *lum;
412
413 assert(path);
414
415 lum = zmalloc(sizeof(struct ltt_ust_metadata));
416 if (lum == NULL) {
417 PERROR("ust metadata zmalloc");
418 goto error;
419 }
420
421 /* Set default attributes */
422 lum->attr.overwrite = DEFAULT_CHANNEL_OVERWRITE;
423 lum->attr.subbuf_size = default_get_metadata_subbuf_size();
424 lum->attr.num_subbuf = DEFAULT_METADATA_SUBBUF_NUM;
425 lum->attr.switch_timer_interval = DEFAULT_METADATA_SWITCH_TIMER;
426 lum->attr.read_timer_interval = DEFAULT_METADATA_READ_TIMER;
427 lum->attr.output = LTTNG_UST_MMAP;
428
429 lum->handle = -1;
430 /* Set metadata trace path */
431 ret = snprintf(lum->pathname, PATH_MAX, "%s/" DEFAULT_METADATA_NAME, path);
432 if (ret < 0) {
433 PERROR("asprintf ust metadata");
434 goto error_free_metadata;
435 }
436
437 return lum;
438
439 error_free_metadata:
440 free(lum);
441 error:
442 return NULL;
443 }
444
445 /*
446 * Allocate and initialize an UST context.
447 *
448 * Return pointer to structure or NULL.
449 */
450 struct ltt_ust_context *trace_ust_create_context(
451 struct lttng_event_context *ctx)
452 {
453 struct ltt_ust_context *uctx;
454 enum lttng_ust_context_type utype;
455
456 assert(ctx);
457
458 switch (ctx->ctx) {
459 case LTTNG_EVENT_CONTEXT_VTID:
460 utype = LTTNG_UST_CONTEXT_VTID;
461 break;
462 case LTTNG_EVENT_CONTEXT_VPID:
463 utype = LTTNG_UST_CONTEXT_VPID;
464 break;
465 case LTTNG_EVENT_CONTEXT_PTHREAD_ID:
466 utype = LTTNG_UST_CONTEXT_PTHREAD_ID;
467 break;
468 case LTTNG_EVENT_CONTEXT_PROCNAME:
469 utype = LTTNG_UST_CONTEXT_PROCNAME;
470 break;
471 case LTTNG_EVENT_CONTEXT_IP:
472 utype = LTTNG_UST_CONTEXT_IP;
473 break;
474 default:
475 ERR("Invalid UST context");
476 return NULL;
477 }
478
479 uctx = zmalloc(sizeof(struct ltt_ust_context));
480 if (uctx == NULL) {
481 PERROR("zmalloc ltt_ust_context");
482 goto error;
483 }
484
485 uctx->ctx.ctx = utype;
486 lttng_ht_node_init_ulong(&uctx->node, (unsigned long) uctx->ctx.ctx);
487 CDS_INIT_LIST_HEAD(&uctx->list);
488
489 return uctx;
490
491 error:
492 return NULL;
493 }
494
495 /*
496 * RCU safe free context structure.
497 */
498 static void destroy_context_rcu(struct rcu_head *head)
499 {
500 struct lttng_ht_node_ulong *node =
501 caa_container_of(head, struct lttng_ht_node_ulong, head);
502 struct ltt_ust_context *ctx =
503 caa_container_of(node, struct ltt_ust_context, node);
504
505 free(ctx);
506 }
507
508 /*
509 * Cleanup UST context hash table.
510 */
511 static void destroy_contexts(struct lttng_ht *ht)
512 {
513 int ret;
514 struct lttng_ht_node_ulong *node;
515 struct lttng_ht_iter iter;
516 struct ltt_ust_context *ctx;
517
518 assert(ht);
519
520 rcu_read_lock();
521 cds_lfht_for_each_entry(ht->ht, &iter.iter, node, node) {
522 /* Remove from ordered list. */
523 ctx = caa_container_of(node, struct ltt_ust_context, node);
524 cds_list_del(&ctx->list);
525 /* Remove from channel's hash table. */
526 ret = lttng_ht_del(ht, &iter);
527 if (!ret) {
528 call_rcu(&node->head, destroy_context_rcu);
529 }
530 }
531 rcu_read_unlock();
532
533 ht_cleanup_push(ht);
534 }
535
536 /*
537 * Cleanup ust event structure.
538 */
539 void trace_ust_destroy_event(struct ltt_ust_event *event)
540 {
541 assert(event);
542
543 DBG2("Trace destroy UST event %s", event->attr.name);
544 free(event->filter);
545 free(event);
546 }
547
548 /*
549 * URCU intermediate call to complete destroy event.
550 */
551 static void destroy_event_rcu(struct rcu_head *head)
552 {
553 struct lttng_ht_node_str *node =
554 caa_container_of(head, struct lttng_ht_node_str, head);
555 struct ltt_ust_event *event =
556 caa_container_of(node, struct ltt_ust_event, node);
557
558 trace_ust_destroy_event(event);
559 }
560
561 /*
562 * Cleanup UST events hashtable.
563 */
564 static void destroy_events(struct lttng_ht *events)
565 {
566 int ret;
567 struct lttng_ht_node_str *node;
568 struct lttng_ht_iter iter;
569
570 assert(events);
571
572 rcu_read_lock();
573 cds_lfht_for_each_entry(events->ht, &iter.iter, node, node) {
574 ret = lttng_ht_del(events, &iter);
575 assert(!ret);
576 call_rcu(&node->head, destroy_event_rcu);
577 }
578 rcu_read_unlock();
579
580 ht_cleanup_push(events);
581 }
582
583 /*
584 * Cleanup ust channel structure.
585 *
586 * Should _NOT_ be called with RCU read lock held.
587 */
588 static void _trace_ust_destroy_channel(struct ltt_ust_channel *channel)
589 {
590 assert(channel);
591
592 DBG2("Trace destroy UST channel %s", channel->name);
593
594 /* Destroying all events of the channel */
595 destroy_events(channel->events);
596 /* Destroying all context of the channel */
597 destroy_contexts(channel->ctx);
598
599 free(channel);
600 }
601
602 /*
603 * URCU intermediate call to complete destroy channel.
604 */
605 static void destroy_channel_rcu(struct rcu_head *head)
606 {
607 struct lttng_ht_node_str *node =
608 caa_container_of(head, struct lttng_ht_node_str, head);
609 struct ltt_ust_channel *channel =
610 caa_container_of(node, struct ltt_ust_channel, node);
611
612 _trace_ust_destroy_channel(channel);
613 }
614
615 void trace_ust_destroy_channel(struct ltt_ust_channel *channel)
616 {
617 call_rcu(&channel->node.head, destroy_channel_rcu);
618 }
619
620 /*
621 * Remove an UST channel from a channel HT.
622 */
623 void trace_ust_delete_channel(struct lttng_ht *ht,
624 struct ltt_ust_channel *channel)
625 {
626 int ret;
627 struct lttng_ht_iter iter;
628
629 assert(ht);
630 assert(channel);
631
632 iter.iter.node = &channel->node.node;
633 ret = lttng_ht_del(ht, &iter);
634 assert(!ret);
635 }
636
637 /*
638 * Cleanup ust metadata structure.
639 */
640 void trace_ust_destroy_metadata(struct ltt_ust_metadata *metadata)
641 {
642 assert(metadata);
643
644 if (!metadata->handle) {
645 return;
646 }
647 DBG2("Trace UST destroy metadata %d", metadata->handle);
648 free(metadata);
649 }
650
651 /*
652 * Iterate over a hash table containing channels and cleanup safely.
653 */
654 static void destroy_channels(struct lttng_ht *channels)
655 {
656 int ret;
657 struct lttng_ht_node_str *node;
658 struct lttng_ht_iter iter;
659
660 assert(channels);
661
662 rcu_read_lock();
663
664 cds_lfht_for_each_entry(channels->ht, &iter.iter, node, node) {
665 ret = lttng_ht_del(channels, &iter);
666 assert(!ret);
667 call_rcu(&node->head, destroy_channel_rcu);
668 }
669 rcu_read_unlock();
670
671 ht_cleanup_push(channels);
672 }
673
674 /*
675 * Cleanup UST global domain.
676 */
677 static void destroy_domain_global(struct ltt_ust_domain_global *dom)
678 {
679 assert(dom);
680
681 destroy_channels(dom->channels);
682 }
683
684 /*
685 * Cleanup ust session structure
686 *
687 * Should *NOT* be called with RCU read-side lock held.
688 */
689 void trace_ust_destroy_session(struct ltt_ust_session *session)
690 {
691 struct buffer_reg_uid *reg, *sreg;
692
693 assert(session);
694
695 DBG2("Trace UST destroy session %" PRIu64, session->id);
696
697 /* Cleaning up UST domain */
698 destroy_domain_global(&session->domain_global);
699 jul_destroy_domain(&session->domain_jul);
700
701 /* Cleanup UID buffer registry object(s). */
702 cds_list_for_each_entry_safe(reg, sreg, &session->buffer_reg_uid_list,
703 lnode) {
704 cds_list_del(&reg->lnode);
705 buffer_reg_uid_remove(reg);
706 buffer_reg_uid_destroy(reg, session->consumer);
707 }
708
709 consumer_destroy_output(session->consumer);
710 consumer_destroy_output(session->tmp_consumer);
711
712 free(session);
713 }
This page took 0.068359 seconds and 3 git commands to generate.