projects / lttng-tools.git / blob
? search:


386e5649c2c0560dde9314d06d1723fa62fd5729
[lttng-tools.git] / src / bin / lttng-sessiond / cmd.c
1 /*
2 * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
3 * Copyright (C) 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License, version 2 only, as
7 * published by the Free Software Foundation.
8 *
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12 * more details.
13 *
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 51
16 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17 */
18
19 #define _LGPL_SOURCE
20 #include <assert.h>
21 #include <inttypes.h>
22 #include <urcu/list.h>
23 #include <urcu/uatomic.h>
24
25 #include <common/defaults.h>
26 #include <common/common.h>
27 #include <common/sessiond-comm/sessiond-comm.h>
28 #include <common/relayd/relayd.h>
29 #include <common/utils.h>
30 #include <common/compat/string.h>
31 #include <common/kernel-ctl/kernel-ctl.h>
32 #include <common/dynamic-buffer.h>
33 #include <common/buffer-view.h>
34 #include <lttng/trigger/trigger-internal.h>
35 #include <lttng/condition/condition.h>
36 #include <lttng/action/action.h>
37 #include <lttng/channel.h>
38 #include <lttng/channel-internal.h>
39 #include <common/string-utils/string-utils.h>
40
41 #include "channel.h"
42 #include "consumer.h"
43 #include "event.h"
44 #include "health-sessiond.h"
45 #include "kernel.h"
46 #include "kernel-consumer.h"
47 #include "lttng-sessiond.h"
48 #include "utils.h"
49 #include "syscall.h"
50 #include "agent.h"
51 #include "buffer-registry.h"
52 #include "notification-thread.h"
53 #include "notification-thread-commands.h"
54 #include "rotation-thread.h"
55
56 #include "cmd.h"
57
58 /*
59 * Used to keep a unique index for each relayd socket created where this value
60 * is associated with streams on the consumer so it can match the right relayd
61 * to send to. It must be accessed with the relayd_net_seq_idx_lock
62 * held.
63 */
64 static pthread_mutex_t relayd_net_seq_idx_lock = PTHREAD_MUTEX_INITIALIZER;
65 static uint64_t relayd_net_seq_idx;
66
67 static int validate_ust_event_name(const char *);
68 static int cmd_enable_event_internal(struct ltt_session *session,
69 struct lttng_domain *domain,
70 char *channel_name, struct lttng_event *event,
71 char *filter_expression,
72 struct lttng_filter_bytecode *filter,
73 struct lttng_event_exclusion *exclusion,
74 int wpipe);
75
76 /*
77 * Create a session path used by list_lttng_sessions for the case that the
78 * session consumer is on the network.
79 */
80 static int build_network_session_path(char *dst, size_t size,
81 struct ltt_session *session)
82 {
83 int ret, kdata_port, udata_port;
84 struct lttng_uri *kuri = NULL, *uuri = NULL, *uri = NULL;
85 char tmp_uurl[PATH_MAX], tmp_urls[PATH_MAX];
86
87 assert(session);
88 assert(dst);
89
90 memset(tmp_urls, 0, sizeof(tmp_urls));
91 memset(tmp_uurl, 0, sizeof(tmp_uurl));
92
93 kdata_port = udata_port = DEFAULT_NETWORK_DATA_PORT;
94
95 if (session->kernel_session && session->kernel_session->consumer) {
96 kuri = &session->kernel_session->consumer->dst.net.control;
97 kdata_port = session->kernel_session->consumer->dst.net.data.port;
98 }
99
100 if (session->ust_session && session->ust_session->consumer) {
101 uuri = &session->ust_session->consumer->dst.net.control;
102 udata_port = session->ust_session->consumer->dst.net.data.port;
103 }
104
105 if (uuri == NULL && kuri == NULL) {
106 uri = &session->consumer->dst.net.control;
107 kdata_port = session->consumer->dst.net.data.port;
108 } else if (kuri && uuri) {
109 ret = uri_compare(kuri, uuri);
110 if (ret) {
111 /* Not Equal */
112 uri = kuri;
113 /* Build uuri URL string */
114 ret = uri_to_str_url(uuri, tmp_uurl, sizeof(tmp_uurl));
115 if (ret < 0) {
116 goto error;
117 }
118 } else {
119 uri = kuri;
120 }
121 } else if (kuri && uuri == NULL) {
122 uri = kuri;
123 } else if (uuri && kuri == NULL) {
124 uri = uuri;
125 }
126
127 ret = uri_to_str_url(uri, tmp_urls, sizeof(tmp_urls));
128 if (ret < 0) {
129 goto error;
130 }
131
132 /*
133 * Do we have a UST url set. If yes, this means we have both kernel and UST
134 * to print.
135 */
136 if (*tmp_uurl != '\0') {
137 ret = snprintf(dst, size, "[K]: %s [data: %d] -- [U]: %s [data: %d]",
138 tmp_urls, kdata_port, tmp_uurl, udata_port);
139 } else {
140 int dport;
141 if (kuri || (!kuri && !uuri)) {
142 dport = kdata_port;
143 } else {
144 /* No kernel URI, use the UST port. */
145 dport = udata_port;
146 }
147 ret = snprintf(dst, size, "%s [data: %d]", tmp_urls, dport);
148 }
149
150 error:
151 return ret;
152 }
153
154 /*
155 * Get run-time attributes if the session has been started (discarded events,
156 * lost packets).
157 */
158 static int get_kernel_runtime_stats(struct ltt_session *session,
159 struct ltt_kernel_channel *kchan, uint64_t *discarded_events,
160 uint64_t *lost_packets)
161 {
162 int ret;
163
164 if (!session->has_been_started) {
165 ret = 0;
166 *discarded_events = 0;
167 *lost_packets = 0;
168 goto end;
169 }
170
171 ret = consumer_get_discarded_events(session->id, kchan->fd,
172 session->kernel_session->consumer,
173 discarded_events);
174 if (ret < 0) {
175 goto end;
176 }
177
178 ret = consumer_get_lost_packets(session->id, kchan->fd,
179 session->kernel_session->consumer,
180 lost_packets);
181 if (ret < 0) {
182 goto end;
183 }
184
185 end:
186 return ret;
187 }
188
189 /*
190 * Get run-time attributes if the session has been started (discarded events,
191 * lost packets).
192 */
193 static int get_ust_runtime_stats(struct ltt_session *session,
194 struct ltt_ust_channel *uchan, uint64_t *discarded_events,
195 uint64_t *lost_packets)
196 {
197 int ret;
198 struct ltt_ust_session *usess;
199
200 if (!discarded_events || !lost_packets) {
201 ret = -1;
202 goto end;
203 }
204
205 usess = session->ust_session;
206 assert(discarded_events);
207 assert(lost_packets);
208
209 if (!usess || !session->has_been_started) {
210 *discarded_events = 0;
211 *lost_packets = 0;
212 ret = 0;
213 goto end;
214 }
215
216 if (usess->buffer_type == LTTNG_BUFFER_PER_UID) {
217 ret = ust_app_uid_get_channel_runtime_stats(usess->id,
218 &usess->buffer_reg_uid_list,
219 usess->consumer, uchan->id,
220 uchan->attr.overwrite,
221 discarded_events,
222 lost_packets);
223 } else if (usess->buffer_type == LTTNG_BUFFER_PER_PID) {
224 ret = ust_app_pid_get_channel_runtime_stats(usess,
225 uchan, usess->consumer,
226 uchan->attr.overwrite,
227 discarded_events,
228 lost_packets);
229 if (ret < 0) {
230 goto end;
231 }
232 *discarded_events += uchan->per_pid_closed_app_discarded;
233 *lost_packets += uchan->per_pid_closed_app_lost;
234 } else {
235 ERR("Unsupported buffer type");
236 assert(0);
237 ret = -1;
238 goto end;
239 }
240
241 end:
242 return ret;
243 }
244
245 /*
246 * Fill lttng_channel array of all channels.
247 */
248 static ssize_t list_lttng_channels(enum lttng_domain_type domain,
249 struct ltt_session *session, struct lttng_channel *channels,
250 struct lttng_channel_extended *chan_exts)
251 {
252 int i = 0, ret = 0;
253 struct ltt_kernel_channel *kchan;
254
255 DBG("Listing channels for session %s", session->name);
256
257 switch (domain) {
258 case LTTNG_DOMAIN_KERNEL:
259 /* Kernel channels */
260 if (session->kernel_session != NULL) {
261 cds_list_for_each_entry(kchan,
262 &session->kernel_session->channel_list.head, list) {
263 uint64_t discarded_events, lost_packets;
264 struct lttng_channel_extended *extended;
265
266 extended = (struct lttng_channel_extended *)
267 kchan->channel->attr.extended.ptr;
268
269 ret = get_kernel_runtime_stats(session, kchan,
270 &discarded_events, &lost_packets);
271 if (ret < 0) {
272 goto end;
273 }
274 /* Copy lttng_channel struct to array */
275 memcpy(&channels[i], kchan->channel, sizeof(struct lttng_channel));
276 channels[i].enabled = kchan->enabled;
277 chan_exts[i].discarded_events =
278 discarded_events;
279 chan_exts[i].lost_packets = lost_packets;
280 chan_exts[i].monitor_timer_interval =
281 extended->monitor_timer_interval;
282 chan_exts[i].blocking_timeout = 0;
283 i++;
284 }
285 }
286 break;
287 case LTTNG_DOMAIN_UST:
288 {
289 struct lttng_ht_iter iter;
290 struct ltt_ust_channel *uchan;
291
292 rcu_read_lock();
293 cds_lfht_for_each_entry(session->ust_session->domain_global.channels->ht,
294 &iter.iter, uchan, node.node) {
295 uint64_t discarded_events = 0, lost_packets = 0;
296
297 if (lttng_strncpy(channels[i].name, uchan->name,
298 LTTNG_SYMBOL_NAME_LEN)) {
299 break;
300 }
301 channels[i].attr.overwrite = uchan->attr.overwrite;
302 channels[i].attr.subbuf_size = uchan->attr.subbuf_size;
303 channels[i].attr.num_subbuf = uchan->attr.num_subbuf;
304 channels[i].attr.switch_timer_interval =
305 uchan->attr.switch_timer_interval;
306 channels[i].attr.read_timer_interval =
307 uchan->attr.read_timer_interval;
308 channels[i].enabled = uchan->enabled;
309 channels[i].attr.tracefile_size = uchan->tracefile_size;
310 channels[i].attr.tracefile_count = uchan->tracefile_count;
311
312 /*
313 * Map enum lttng_ust_output to enum lttng_event_output.
314 */
315 switch (uchan->attr.output) {
316 case LTTNG_UST_MMAP:
317 channels[i].attr.output = LTTNG_EVENT_MMAP;
318 break;
319 default:
320 /*
321 * LTTNG_UST_MMAP is the only supported UST
322 * output mode.
323 */
324 assert(0);
325 break;
326 }
327
328 chan_exts[i].monitor_timer_interval =
329 uchan->monitor_timer_interval;
330 chan_exts[i].blocking_timeout =
331 uchan->attr.u.s.blocking_timeout;
332
333 ret = get_ust_runtime_stats(session, uchan,
334 &discarded_events, &lost_packets);
335 if (ret < 0) {
336 break;
337 }
338 chan_exts[i].discarded_events = discarded_events;
339 chan_exts[i].lost_packets = lost_packets;
340 i++;
341 }
342 rcu_read_unlock();
343 break;
344 }
345 default:
346 break;
347 }
348
349 end:
350 if (ret < 0) {
351 return -LTTNG_ERR_FATAL;
352 } else {
353 return LTTNG_OK;
354 }
355 }
356
357 static void increment_extended_len(const char *filter_expression,
358 struct lttng_event_exclusion *exclusion, size_t *extended_len)
359 {
360 *extended_len += sizeof(struct lttcomm_event_extended_header);
361
362 if (filter_expression) {
363 *extended_len += strlen(filter_expression) + 1;
364 }
365
366 if (exclusion) {
367 *extended_len += exclusion->count * LTTNG_SYMBOL_NAME_LEN;
368 }
369 }
370
371 static void append_extended_info(const char *filter_expression,
372 struct lttng_event_exclusion *exclusion, void **extended_at)
373 {
374 struct lttcomm_event_extended_header extended_header;
375 size_t filter_len = 0;
376 size_t nb_exclusions = 0;
377
378 if (filter_expression) {
379 filter_len = strlen(filter_expression) + 1;
380 }
381
382 if (exclusion) {
383 nb_exclusions = exclusion->count;
384 }
385
386 /* Set header fields */
387 extended_header.filter_len = filter_len;
388 extended_header.nb_exclusions = nb_exclusions;
389
390 /* Copy header */
391 memcpy(*extended_at, &extended_header, sizeof(extended_header));
392 *extended_at += sizeof(extended_header);
393
394 /* Copy filter string */
395 if (filter_expression) {
396 memcpy(*extended_at, filter_expression, filter_len);
397 *extended_at += filter_len;
398 }
399
400 /* Copy exclusion names */
401 if (exclusion) {
402 size_t len = nb_exclusions * LTTNG_SYMBOL_NAME_LEN;
403
404 memcpy(*extended_at, &exclusion->names, len);
405 *extended_at += len;
406 }
407 }
408
409 /*
410 * Create a list of agent domain events.
411 *
412 * Return number of events in list on success or else a negative value.
413 */
414 static int list_lttng_agent_events(struct agent *agt,
415 struct lttng_event **events, size_t *total_size)
416 {
417 int i = 0, ret = 0;
418 unsigned int nb_event = 0;
419 struct agent_event *event;
420 struct lttng_event *tmp_events;
421 struct lttng_ht_iter iter;
422 size_t extended_len = 0;
423 void *extended_at;
424
425 assert(agt);
426 assert(events);
427
428 DBG3("Listing agent events");
429
430 rcu_read_lock();
431 nb_event = lttng_ht_get_count(agt->events);
432 rcu_read_unlock();
433 if (nb_event == 0) {
434 ret = nb_event;
435 *total_size = 0;
436 goto error;
437 }
438
439 /* Compute required extended infos size */
440 extended_len = nb_event * sizeof(struct lttcomm_event_extended_header);
441
442 /*
443 * This is only valid because the commands which add events are
444 * processed in the same thread as the listing.
445 */
446 rcu_read_lock();
447 cds_lfht_for_each_entry(agt->events->ht, &iter.iter, event, node.node) {
448 increment_extended_len(event->filter_expression, NULL,
449 &extended_len);
450 }
451 rcu_read_unlock();
452
453 *total_size = nb_event * sizeof(*tmp_events) + extended_len;
454 tmp_events = zmalloc(*total_size);
455 if (!tmp_events) {
456 PERROR("zmalloc agent events session");
457 ret = -LTTNG_ERR_FATAL;
458 goto error;
459 }
460
461 extended_at = ((uint8_t *) tmp_events) +
462 nb_event * sizeof(struct lttng_event);
463
464 rcu_read_lock();
465 cds_lfht_for_each_entry(agt->events->ht, &iter.iter, event, node.node) {
466 strncpy(tmp_events[i].name, event->name, sizeof(tmp_events[i].name));
467 tmp_events[i].name[sizeof(tmp_events[i].name) - 1] = '\0';
468 tmp_events[i].enabled = event->enabled;
469 tmp_events[i].loglevel = event->loglevel_value;
470 tmp_events[i].loglevel_type = event->loglevel_type;
471 i++;
472
473 /* Append extended info */
474 append_extended_info(event->filter_expression, NULL,
475 &extended_at);
476 }
477 rcu_read_unlock();
478
479 *events = tmp_events;
480 ret = nb_event;
481
482 error:
483 assert(nb_event == i);
484 return ret;
485 }
486
487 /*
488 * Create a list of ust global domain events.
489 */
490 static int list_lttng_ust_global_events(char *channel_name,
491 struct ltt_ust_domain_global *ust_global,
492 struct lttng_event **events, size_t *total_size)
493 {
494 int i = 0, ret = 0;
495 unsigned int nb_event = 0;
496 struct lttng_ht_iter iter;
497 struct lttng_ht_node_str *node;
498 struct ltt_ust_channel *uchan;
499 struct ltt_ust_event *uevent;
500 struct lttng_event *tmp;
501 size_t extended_len = 0;
502 void *extended_at;
503
504 DBG("Listing UST global events for channel %s", channel_name);
505
506 rcu_read_lock();
507
508 lttng_ht_lookup(ust_global->channels, (void *)channel_name, &iter);
509 node = lttng_ht_iter_get_node_str(&iter);
510 if (node == NULL) {
511 ret = LTTNG_ERR_UST_CHAN_NOT_FOUND;
512 goto end;
513 }
514
515 uchan = caa_container_of(&node->node, struct ltt_ust_channel, node.node);
516
517 nb_event = lttng_ht_get_count(uchan->events);
518 if (nb_event == 0) {
519 ret = nb_event;
520 *total_size = 0;
521 goto end;
522 }
523
524 DBG3("Listing UST global %d events", nb_event);
525
526 /* Compute required extended infos size */
527 cds_lfht_for_each_entry(uchan->events->ht, &iter.iter, uevent, node.node) {
528 if (uevent->internal) {
529 nb_event--;
530 continue;
531 }
532
533 increment_extended_len(uevent->filter_expression,
534 uevent->exclusion, &extended_len);
535 }
536 if (nb_event == 0) {
537 /* All events are internal, skip. */
538 ret = 0;
539 *total_size = 0;
540 goto end;
541 }
542
543 *total_size = nb_event * sizeof(struct lttng_event) + extended_len;
544 tmp = zmalloc(*total_size);
545 if (tmp == NULL) {
546 ret = -LTTNG_ERR_FATAL;
547 goto end;
548 }
549
550 extended_at = ((uint8_t *) tmp) + nb_event * sizeof(struct lttng_event);
551
552 cds_lfht_for_each_entry(uchan->events->ht, &iter.iter, uevent, node.node) {
553 if (uevent->internal) {
554 /* This event should remain hidden from clients */
555 continue;
556 }
557 strncpy(tmp[i].name, uevent->attr.name, LTTNG_SYMBOL_NAME_LEN);
558 tmp[i].name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
559 tmp[i].enabled = uevent->enabled;
560
561 switch (uevent->attr.instrumentation) {
562 case LTTNG_UST_TRACEPOINT:
563 tmp[i].type = LTTNG_EVENT_TRACEPOINT;
564 break;
565 case LTTNG_UST_PROBE:
566 tmp[i].type = LTTNG_EVENT_PROBE;
567 break;
568 case LTTNG_UST_FUNCTION:
569 tmp[i].type = LTTNG_EVENT_FUNCTION;
570 break;
571 }
572
573 tmp[i].loglevel = uevent->attr.loglevel;
574 switch (uevent->attr.loglevel_type) {
575 case LTTNG_UST_LOGLEVEL_ALL:
576 tmp[i].loglevel_type = LTTNG_EVENT_LOGLEVEL_ALL;
577 break;
578 case LTTNG_UST_LOGLEVEL_RANGE:
579 tmp[i].loglevel_type = LTTNG_EVENT_LOGLEVEL_RANGE;
580 break;
581 case LTTNG_UST_LOGLEVEL_SINGLE:
582 tmp[i].loglevel_type = LTTNG_EVENT_LOGLEVEL_SINGLE;
583 break;
584 }
585 if (uevent->filter) {
586 tmp[i].filter = 1;
587 }
588 if (uevent->exclusion) {
589 tmp[i].exclusion = 1;
590 }
591 i++;
592
593 /* Append extended info */
594 append_extended_info(uevent->filter_expression,
595 uevent->exclusion, &extended_at);
596 }
597
598 ret = nb_event;
599 *events = tmp;
600 end:
601 rcu_read_unlock();
602 return ret;
603 }
604
605 /*
606 * Fill lttng_event array of all kernel events in the channel.
607 */
608 static int list_lttng_kernel_events(char *channel_name,
609 struct ltt_kernel_session *kernel_session,
610 struct lttng_event **events, size_t *total_size)
611 {
612 int i = 0, ret;
613 unsigned int nb_event;
614 struct ltt_kernel_event *event;
615 struct ltt_kernel_channel *kchan;
616 size_t extended_len = 0;
617 void *extended_at;
618
619 kchan = trace_kernel_get_channel_by_name(channel_name, kernel_session);
620 if (kchan == NULL) {
621 ret = LTTNG_ERR_KERN_CHAN_NOT_FOUND;
622 goto error;
623 }
624
625 nb_event = kchan->event_count;
626
627 DBG("Listing events for channel %s", kchan->channel->name);
628
629 if (nb_event == 0) {
630 *total_size = 0;
631 *events = NULL;
632 goto end;
633 }
634
635 /* Compute required extended infos size */
636 cds_list_for_each_entry(event, &kchan->events_list.head, list) {
637 increment_extended_len(event->filter_expression, NULL,
638 &extended_len);
639 }
640
641 *total_size = nb_event * sizeof(struct lttng_event) + extended_len;
642 *events = zmalloc(*total_size);
643 if (*events == NULL) {
644 ret = LTTNG_ERR_FATAL;
645 goto error;
646 }
647
648 extended_at = ((void *) *events) +
649 nb_event * sizeof(struct lttng_event);
650
651 /* Kernel channels */
652 cds_list_for_each_entry(event, &kchan->events_list.head , list) {
653 strncpy((*events)[i].name, event->event->name, LTTNG_SYMBOL_NAME_LEN);
654 (*events)[i].name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
655 (*events)[i].enabled = event->enabled;
656 (*events)[i].filter =
657 (unsigned char) !!event->filter_expression;
658
659 switch (event->event->instrumentation) {
660 case LTTNG_KERNEL_TRACEPOINT:
661 (*events)[i].type = LTTNG_EVENT_TRACEPOINT;
662 break;
663 case LTTNG_KERNEL_KRETPROBE:
664 (*events)[i].type = LTTNG_EVENT_FUNCTION;
665 memcpy(&(*events)[i].attr.probe, &event->event->u.kprobe,
666 sizeof(struct lttng_kernel_kprobe));
667 break;
668 case LTTNG_KERNEL_KPROBE:
669 (*events)[i].type = LTTNG_EVENT_PROBE;
670 memcpy(&(*events)[i].attr.probe, &event->event->u.kprobe,
671 sizeof(struct lttng_kernel_kprobe));
672 break;
673 case LTTNG_KERNEL_FUNCTION:
674 (*events)[i].type = LTTNG_EVENT_FUNCTION;
675 memcpy(&((*events)[i].attr.ftrace), &event->event->u.ftrace,
676 sizeof(struct lttng_kernel_function));
677 break;
678 case LTTNG_KERNEL_NOOP:
679 (*events)[i].type = LTTNG_EVENT_NOOP;
680 break;
681 case LTTNG_KERNEL_SYSCALL:
682 (*events)[i].type = LTTNG_EVENT_SYSCALL;
683 break;
684 case LTTNG_KERNEL_ALL:
685 assert(0);
686 break;
687 }
688 i++;
689
690 /* Append extended info */
691 append_extended_info(event->filter_expression, NULL,
692 &extended_at);
693 }
694
695 end:
696 return nb_event;
697
698 error:
699 /* Negate the error code to differentiate the size from an error */
700 return -ret;
701 }
702
703 /*
704 * Add URI so the consumer output object. Set the correct path depending on the
705 * domain adding the default trace directory.
706 */
707 static int add_uri_to_consumer(struct consumer_output *consumer,
708 struct lttng_uri *uri, enum lttng_domain_type domain,
709 const char *session_name)
710 {
711 int ret = LTTNG_OK;
712 const char *default_trace_dir;
713
714 assert(uri);
715
716 if (consumer == NULL) {
717 DBG("No consumer detected. Don't add URI. Stopping.");
718 ret = LTTNG_ERR_NO_CONSUMER;
719 goto error;
720 }
721
722 switch (domain) {
723 case LTTNG_DOMAIN_KERNEL:
724 default_trace_dir = DEFAULT_KERNEL_TRACE_DIR;
725 break;
726 case LTTNG_DOMAIN_UST:
727 default_trace_dir = DEFAULT_UST_TRACE_DIR;
728 break;
729 default:
730 /*
731 * This case is possible is we try to add the URI to the global tracing
732 * session consumer object which in this case there is no subdir.
733 */
734 default_trace_dir = "";
735 }
736
737 switch (uri->dtype) {
738 case LTTNG_DST_IPV4:
739 case LTTNG_DST_IPV6:
740 DBG2("Setting network URI to consumer");
741
742 if (consumer->type == CONSUMER_DST_NET) {
743 if ((uri->stype == LTTNG_STREAM_CONTROL &&
744 consumer->dst.net.control_isset) ||
745 (uri->stype == LTTNG_STREAM_DATA &&
746 consumer->dst.net.data_isset)) {
747 ret = LTTNG_ERR_URL_EXIST;
748 goto error;
749 }
750 } else {
751 memset(&consumer->dst.net, 0, sizeof(consumer->dst.net));
752 }
753
754 consumer->type = CONSUMER_DST_NET;
755
756 /* Set URI into consumer output object */
757 ret = consumer_set_network_uri(consumer, uri);
758 if (ret < 0) {
759 ret = -ret;
760 goto error;
761 } else if (ret == 1) {
762 /*
763 * URI was the same in the consumer so we do not append the subdir
764 * again so to not duplicate output dir.
765 */
766 ret = LTTNG_OK;
767 goto error;
768 }
769
770 if (uri->stype == LTTNG_STREAM_CONTROL && strlen(uri->subdir) == 0) {
771 ret = consumer_set_subdir(consumer, session_name);
772 if (ret < 0) {
773 ret = LTTNG_ERR_FATAL;
774 goto error;
775 }
776 }
777
778 if (uri->stype == LTTNG_STREAM_CONTROL) {
779 /* On a new subdir, reappend the default trace dir. */
780 strncat(consumer->subdir, default_trace_dir,
781 sizeof(consumer->subdir) - strlen(consumer->subdir) - 1);
782 DBG3("Append domain trace name to subdir %s", consumer->subdir);
783 }
784
785 break;
786 case LTTNG_DST_PATH:
787 DBG2("Setting trace directory path from URI to %s", uri->dst.path);
788 memset(consumer->dst.session_root_path, 0,
789 sizeof(consumer->dst.session_root_path));
790 /* Explicit length checks for strcpy and strcat. */
791 if (strlen(uri->dst.path) + strlen(default_trace_dir)
792 >= sizeof(consumer->dst.session_root_path)) {
793 ret = LTTNG_ERR_FATAL;
794 goto error;
795 }
796 strcpy(consumer->dst.session_root_path, uri->dst.path);
797 /* Append default trace dir */
798 strcat(consumer->dst.session_root_path, default_trace_dir);
799 /* Flag consumer as local. */
800 consumer->type = CONSUMER_DST_LOCAL;
801 break;
802 }
803
804 ret = LTTNG_OK;
805
806 error:
807 return ret;
808 }
809
810 /*
811 * Init tracing by creating trace directory and sending fds kernel consumer.
812 */
813 static int init_kernel_tracing(struct ltt_kernel_session *session)
814 {
815 int ret = 0;
816 struct lttng_ht_iter iter;
817 struct consumer_socket *socket;
818
819 assert(session);
820
821 rcu_read_lock();
822
823 if (session->consumer_fds_sent == 0 && session->consumer != NULL) {
824 cds_lfht_for_each_entry(session->consumer->socks->ht, &iter.iter,
825 socket, node.node) {
826 pthread_mutex_lock(socket->lock);
827 ret = kernel_consumer_send_session(socket, session);
828 pthread_mutex_unlock(socket->lock);
829 if (ret < 0) {
830 ret = LTTNG_ERR_KERN_CONSUMER_FAIL;
831 goto error;
832 }
833 }
834 }
835
836 error:
837 rcu_read_unlock();
838 return ret;
839 }
840
841 /*
842 * Create a socket to the relayd using the URI.
843 *
844 * On success, the relayd_sock pointer is set to the created socket.
845 * Else, it's stays untouched and a lttcomm error code is returned.
846 */
847 static int create_connect_relayd(struct lttng_uri *uri,
848 struct lttcomm_relayd_sock **relayd_sock,
849 struct consumer_output *consumer)
850 {
851 int ret;
852 struct lttcomm_relayd_sock *rsock;
853
854 rsock = lttcomm_alloc_relayd_sock(uri, RELAYD_VERSION_COMM_MAJOR,
855 RELAYD_VERSION_COMM_MINOR);
856 if (!rsock) {
857 ret = LTTNG_ERR_FATAL;
858 goto error;
859 }
860
861 /*
862 * Connect to relayd so we can proceed with a session creation. This call
863 * can possibly block for an arbitrary amount of time to set the health
864 * state to be in poll execution.
865 */
866 health_poll_entry();
867 ret = relayd_connect(rsock);
868 health_poll_exit();
869 if (ret < 0) {
870 ERR("Unable to reach lttng-relayd");
871 ret = LTTNG_ERR_RELAYD_CONNECT_FAIL;
872 goto free_sock;
873 }
874
875 /* Create socket for control stream. */
876 if (uri->stype == LTTNG_STREAM_CONTROL) {
877 DBG3("Creating relayd stream socket from URI");
878
879 /* Check relayd version */
880 ret = relayd_version_check(rsock);
881 if (ret < 0) {
882 ret = LTTNG_ERR_RELAYD_VERSION_FAIL;
883 goto close_sock;
884 }
885 consumer->relay_major_version = rsock->major;
886 consumer->relay_minor_version = rsock->minor;
887 } else if (uri->stype == LTTNG_STREAM_DATA) {
888 DBG3("Creating relayd data socket from URI");
889 } else {
890 /* Command is not valid */
891 ERR("Relayd invalid stream type: %d", uri->stype);
892 ret = LTTNG_ERR_INVALID;
893 goto close_sock;
894 }
895
896 *relayd_sock = rsock;
897
898 return LTTNG_OK;
899
900 close_sock:
901 /* The returned value is not useful since we are on an error path. */
902 (void) relayd_close(rsock);
903 free_sock:
904 free(rsock);
905 error:
906 return ret;
907 }
908
909 /*
910 * Connect to the relayd using URI and send the socket to the right consumer.
911 */
912 static int send_consumer_relayd_socket(enum lttng_domain_type domain,
913 unsigned int session_id, struct lttng_uri *relayd_uri,
914 struct consumer_output *consumer,
915 struct consumer_socket *consumer_sock,
916 char *session_name, char *hostname, int session_live_timer)
917 {
918 int ret;
919 struct lttcomm_relayd_sock *rsock = NULL;
920
921 /* Connect to relayd and make version check if uri is the control. */
922 ret = create_connect_relayd(relayd_uri, &rsock, consumer);
923 if (ret != LTTNG_OK) {
924 goto error;
925 }
926 assert(rsock);
927
928 /* Set the network sequence index if not set. */
929 if (consumer->net_seq_index == (uint64_t) -1ULL) {
930 pthread_mutex_lock(&relayd_net_seq_idx_lock);
931 /*
932 * Increment net_seq_idx because we are about to transfer the
933 * new relayd socket to the consumer.
934 * Assign unique key so the consumer can match streams.
935 */
936 consumer->net_seq_index = ++relayd_net_seq_idx;
937 pthread_mutex_unlock(&relayd_net_seq_idx_lock);
938 }
939
940 /* Send relayd socket to consumer. */
941 ret = consumer_send_relayd_socket(consumer_sock, rsock, consumer,
942 relayd_uri->stype, session_id,
943 session_name, hostname, session_live_timer);
944 if (ret < 0) {
945 ret = LTTNG_ERR_ENABLE_CONSUMER_FAIL;
946 goto close_sock;
947 }
948
949 /* Flag that the corresponding socket was sent. */
950 if (relayd_uri->stype == LTTNG_STREAM_CONTROL) {
951 consumer_sock->control_sock_sent = 1;
952 } else if (relayd_uri->stype == LTTNG_STREAM_DATA) {
953 consumer_sock->data_sock_sent = 1;
954 }
955
956 ret = LTTNG_OK;
957
958 /*
959 * Close socket which was dup on the consumer side. The session daemon does
960 * NOT keep track of the relayd socket(s) once transfer to the consumer.
961 */
962
963 close_sock:
964 (void) relayd_close(rsock);
965 free(rsock);
966
967 error:
968 if (ret != LTTNG_OK) {
969 /*
970 * The consumer output for this session should not be used anymore
971 * since the relayd connection failed thus making any tracing or/and
972 * streaming not usable.
973 */
974 consumer->enabled = 0;
975 }
976 return ret;
977 }
978
979 /*
980 * Send both relayd sockets to a specific consumer and domain. This is a
981 * helper function to facilitate sending the information to the consumer for a
982 * session.
983 */
984 static int send_consumer_relayd_sockets(enum lttng_domain_type domain,
985 unsigned int session_id, struct consumer_output *consumer,
986 struct consumer_socket *sock, char *session_name,
987 char *hostname, int session_live_timer)
988 {
989 int ret = LTTNG_OK;
990
991 assert(consumer);
992 assert(sock);
993
994 /* Sending control relayd socket. */
995 if (!sock->control_sock_sent) {
996 ret = send_consumer_relayd_socket(domain, session_id,
997 &consumer->dst.net.control, consumer, sock,
998 session_name, hostname, session_live_timer);
999 if (ret != LTTNG_OK) {
1000 goto error;
1001 }
1002 }
1003
1004 /* Sending data relayd socket. */
1005 if (!sock->data_sock_sent) {
1006 ret = send_consumer_relayd_socket(domain, session_id,
1007 &consumer->dst.net.data, consumer, sock,
1008 session_name, hostname, session_live_timer);
1009 if (ret != LTTNG_OK) {
1010 goto error;
1011 }
1012 }
1013
1014 error:
1015 return ret;
1016 }
1017
1018 /*
1019 * Setup relayd connections for a tracing session. First creates the socket to
1020 * the relayd and send them to the right domain consumer. Consumer type MUST be
1021 * network.
1022 */
1023 int cmd_setup_relayd(struct ltt_session *session)
1024 {
1025 int ret = LTTNG_OK;
1026 struct ltt_ust_session *usess;
1027 struct ltt_kernel_session *ksess;
1028 struct consumer_socket *socket;
1029 struct lttng_ht_iter iter;
1030
1031 assert(session);
1032
1033 usess = session->ust_session;
1034 ksess = session->kernel_session;
1035
1036 DBG("Setting relayd for session %s", session->name);
1037
1038 rcu_read_lock();
1039
1040 if (usess && usess->consumer && usess->consumer->type == CONSUMER_DST_NET
1041 && usess->consumer->enabled) {
1042 /* For each consumer socket, send relayd sockets */
1043 cds_lfht_for_each_entry(usess->consumer->socks->ht, &iter.iter,
1044 socket, node.node) {
1045 pthread_mutex_lock(socket->lock);
1046 ret = send_consumer_relayd_sockets(LTTNG_DOMAIN_UST, session->id,
1047 usess->consumer, socket,
1048 session->name, session->hostname,
1049 session->live_timer);
1050 pthread_mutex_unlock(socket->lock);
1051 if (ret != LTTNG_OK) {
1052 goto error;
1053 }
1054 /* Session is now ready for network streaming. */
1055 session->net_handle = 1;
1056 }
1057 session->consumer->relay_major_version =
1058 usess->consumer->relay_major_version;
1059 session->consumer->relay_minor_version =
1060 usess->consumer->relay_minor_version;
1061 }
1062
1063 if (ksess && ksess->consumer && ksess->consumer->type == CONSUMER_DST_NET
1064 && ksess->consumer->enabled) {
1065 cds_lfht_for_each_entry(ksess->consumer->socks->ht, &iter.iter,
1066 socket, node.node) {
1067 pthread_mutex_lock(socket->lock);
1068 ret = send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL, session->id,
1069 ksess->consumer, socket,
1070 session->name, session->hostname,
1071 session->live_timer);
1072 pthread_mutex_unlock(socket->lock);
1073 if (ret != LTTNG_OK) {
1074 goto error;
1075 }
1076 /* Session is now ready for network streaming. */
1077 session->net_handle = 1;
1078 }
1079 session->consumer->relay_major_version =
1080 ksess->consumer->relay_major_version;
1081 session->consumer->relay_minor_version =
1082 ksess->consumer->relay_minor_version;
1083 }
1084
1085 error:
1086 rcu_read_unlock();
1087 return ret;
1088 }
1089
1090 /*
1091 * Start a kernel session by opening all necessary streams.
1092 */
1093 static int start_kernel_session(struct ltt_kernel_session *ksess, int wpipe)
1094 {
1095 int ret;
1096 struct ltt_kernel_channel *kchan;
1097
1098 /* Open kernel metadata */
1099 if (ksess->metadata == NULL && ksess->output_traces) {
1100 ret = kernel_open_metadata(ksess);
1101 if (ret < 0) {
1102 ret = LTTNG_ERR_KERN_META_FAIL;
1103 goto error;
1104 }
1105 }
1106
1107 /* Open kernel metadata stream */
1108 if (ksess->metadata && ksess->metadata_stream_fd < 0) {
1109 ret = kernel_open_metadata_stream(ksess);
1110 if (ret < 0) {
1111 ERR("Kernel create metadata stream failed");
1112 ret = LTTNG_ERR_KERN_STREAM_FAIL;
1113 goto error;
1114 }
1115 }
1116
1117 /* For each channel */
1118 cds_list_for_each_entry(kchan, &ksess->channel_list.head, list) {
1119 if (kchan->stream_count == 0) {
1120 ret = kernel_open_channel_stream(kchan);
1121 if (ret < 0) {
1122 ret = LTTNG_ERR_KERN_STREAM_FAIL;
1123 goto error;
1124 }
1125 /* Update the stream global counter */
1126 ksess->stream_count_global += ret;
1127 }
1128 }
1129
1130 /* Setup kernel consumer socket and send fds to it */
1131 ret = init_kernel_tracing(ksess);
1132 if (ret != 0) {
1133 ret = LTTNG_ERR_KERN_START_FAIL;
1134 goto error;
1135 }
1136
1137 /* This start the kernel tracing */
1138 ret = kernel_start_session(ksess);
1139 if (ret < 0) {
1140 ret = LTTNG_ERR_KERN_START_FAIL;
1141 goto error;
1142 }
1143
1144 /* Quiescent wait after starting trace */
1145 kernel_wait_quiescent(kernel_tracer_fd);
1146
1147 ksess->active = 1;
1148
1149 ret = LTTNG_OK;
1150
1151 error:
1152 return ret;
1153 }
1154
1155 /*
1156 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1157 */
1158 int cmd_disable_channel(struct ltt_session *session,
1159 enum lttng_domain_type domain, char *channel_name)
1160 {
1161 int ret;
1162 struct ltt_ust_session *usess;
1163
1164 usess = session->ust_session;
1165
1166 rcu_read_lock();
1167
1168 switch (domain) {
1169 case LTTNG_DOMAIN_KERNEL:
1170 {
1171 ret = channel_kernel_disable(session->kernel_session,
1172 channel_name);
1173 if (ret != LTTNG_OK) {
1174 goto error;
1175 }
1176
1177 kernel_wait_quiescent(kernel_tracer_fd);
1178 break;
1179 }
1180 case LTTNG_DOMAIN_UST:
1181 {
1182 struct ltt_ust_channel *uchan;
1183 struct lttng_ht *chan_ht;
1184
1185 chan_ht = usess->domain_global.channels;
1186
1187 uchan = trace_ust_find_channel_by_name(chan_ht, channel_name);
1188 if (uchan == NULL) {
1189 ret = LTTNG_ERR_UST_CHAN_NOT_FOUND;
1190 goto error;
1191 }
1192
1193 ret = channel_ust_disable(usess, uchan);
1194 if (ret != LTTNG_OK) {
1195 goto error;
1196 }
1197 break;
1198 }
1199 default:
1200 ret = LTTNG_ERR_UNKNOWN_DOMAIN;
1201 goto error;
1202 }
1203
1204 ret = LTTNG_OK;
1205
1206 error:
1207 rcu_read_unlock();
1208 return ret;
1209 }
1210
1211 /*
1212 * Command LTTNG_TRACK_PID processed by the client thread.
1213 *
1214 * Called with session lock held.
1215 */
1216 int cmd_track_pid(struct ltt_session *session, enum lttng_domain_type domain,
1217 int pid)
1218 {
1219 int ret;
1220
1221 rcu_read_lock();
1222
1223 switch (domain) {
1224 case LTTNG_DOMAIN_KERNEL:
1225 {
1226 struct ltt_kernel_session *ksess;
1227
1228 ksess = session->kernel_session;
1229
1230 ret = kernel_track_pid(ksess, pid);
1231 if (ret != LTTNG_OK) {
1232 goto error;
1233 }
1234
1235 kernel_wait_quiescent(kernel_tracer_fd);
1236 break;
1237 }
1238 case LTTNG_DOMAIN_UST:
1239 {
1240 struct ltt_ust_session *usess;
1241
1242 usess = session->ust_session;
1243
1244 ret = trace_ust_track_pid(usess, pid);
1245 if (ret != LTTNG_OK) {
1246 goto error;
1247 }
1248 break;
1249 }
1250 default:
1251 ret = LTTNG_ERR_UNKNOWN_DOMAIN;
1252 goto error;
1253 }
1254
1255 ret = LTTNG_OK;
1256
1257 error:
1258 rcu_read_unlock();
1259 return ret;
1260 }
1261
1262 /*
1263 * Command LTTNG_UNTRACK_PID processed by the client thread.
1264 *
1265 * Called with session lock held.
1266 */
1267 int cmd_untrack_pid(struct ltt_session *session, enum lttng_domain_type domain,
1268 int pid)
1269 {
1270 int ret;
1271
1272 rcu_read_lock();
1273
1274 switch (domain) {
1275 case LTTNG_DOMAIN_KERNEL:
1276 {
1277 struct ltt_kernel_session *ksess;
1278
1279 ksess = session->kernel_session;
1280
1281 ret = kernel_untrack_pid(ksess, pid);
1282 if (ret != LTTNG_OK) {
1283 goto error;
1284 }
1285
1286 kernel_wait_quiescent(kernel_tracer_fd);
1287 break;
1288 }
1289 case LTTNG_DOMAIN_UST:
1290 {
1291 struct ltt_ust_session *usess;
1292
1293 usess = session->ust_session;
1294
1295 ret = trace_ust_untrack_pid(usess, pid);
1296 if (ret != LTTNG_OK) {
1297 goto error;
1298 }
1299 break;
1300 }
1301 default:
1302 ret = LTTNG_ERR_UNKNOWN_DOMAIN;
1303 goto error;
1304 }
1305
1306 ret = LTTNG_OK;
1307
1308 error:
1309 rcu_read_unlock();
1310 return ret;
1311 }
1312
1313 /*
1314 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1315 *
1316 * The wpipe arguments is used as a notifier for the kernel thread.
1317 */
1318 int cmd_enable_channel(struct ltt_session *session,
1319 struct lttng_domain *domain, struct lttng_channel *attr, int wpipe)
1320 {
1321 int ret;
1322 struct ltt_ust_session *usess = session->ust_session;
1323 struct lttng_ht *chan_ht;
1324 size_t len;
1325
1326 assert(session);
1327 assert(attr);
1328 assert(domain);
1329
1330 len = lttng_strnlen(attr->name, sizeof(attr->name));
1331
1332 /* Validate channel name */
1333 if (attr->name[0] == '.' ||
1334 memchr(attr->name, '/', len) != NULL) {
1335 ret = LTTNG_ERR_INVALID_CHANNEL_NAME;
1336 goto end;
1337 }
1338
1339 DBG("Enabling channel %s for session %s", attr->name, session->name);
1340
1341 rcu_read_lock();
1342
1343 /*
1344 * Don't try to enable a channel if the session has been started at
1345 * some point in time before. The tracer does not allow it.
1346 */
1347 if (session->has_been_started) {
1348 ret = LTTNG_ERR_TRACE_ALREADY_STARTED;
1349 goto error;
1350 }
1351
1352 /*
1353 * If the session is a live session, remove the switch timer, the
1354 * live timer does the same thing but sends also synchronisation
1355 * beacons for inactive streams.
1356 */
1357 if (session->live_timer > 0) {
1358 attr->attr.live_timer_interval = session->live_timer;
1359 attr->attr.switch_timer_interval = 0;
1360 }
1361
1362 /* Check for feature support */
1363 switch (domain->type) {
1364 case LTTNG_DOMAIN_KERNEL:
1365 {
1366 if (kernel_supports_ring_buffer_snapshot_sample_positions(kernel_tracer_fd) != 1) {
1367 /* Sampling position of buffer is not supported */
1368 WARN("Kernel tracer does not support buffer monitoring. "
1369 "Setting the monitor interval timer to 0 "
1370 "(disabled) for channel '%s' of session '%s'",
1371 attr-> name, session->name);
1372 lttng_channel_set_monitor_timer_interval(attr, 0);
1373 }
1374 break;
1375 }
1376 case LTTNG_DOMAIN_UST:
1377 case LTTNG_DOMAIN_JUL:
1378 case LTTNG_DOMAIN_LOG4J:
1379 case LTTNG_DOMAIN_PYTHON:
1380 break;
1381 default:
1382 ret = LTTNG_ERR_UNKNOWN_DOMAIN;
1383 goto error;
1384 }
1385
1386 switch (domain->type) {
1387 case LTTNG_DOMAIN_KERNEL:
1388 {
1389 struct ltt_kernel_channel *kchan;
1390
1391 kchan = trace_kernel_get_channel_by_name(attr->name,
1392 session->kernel_session);
1393 if (kchan == NULL) {
1394 ret = channel_kernel_create(session->kernel_session, attr, wpipe);
1395 if (attr->name[0] != '\0') {
1396 session->kernel_session->has_non_default_channel = 1;
1397 }
1398 } else {
1399 ret = channel_kernel_enable(session->kernel_session, kchan);
1400 }
1401
1402 if (ret != LTTNG_OK) {
1403 goto error;
1404 }
1405
1406 kernel_wait_quiescent(kernel_tracer_fd);
1407 break;
1408 }
1409 case LTTNG_DOMAIN_UST:
1410 case LTTNG_DOMAIN_JUL:
1411 case LTTNG_DOMAIN_LOG4J:
1412 case LTTNG_DOMAIN_PYTHON:
1413 {
1414 struct ltt_ust_channel *uchan;
1415
1416 /*
1417 * FIXME
1418 *
1419 * Current agent implementation limitations force us to allow
1420 * only one channel at once in "agent" subdomains. Each
1421 * subdomain has a default channel name which must be strictly
1422 * adhered to.
1423 */
1424 if (domain->type == LTTNG_DOMAIN_JUL) {
1425 if (strncmp(attr->name, DEFAULT_JUL_CHANNEL_NAME,
1426 LTTNG_SYMBOL_NAME_LEN)) {
1427 ret = LTTNG_ERR_INVALID_CHANNEL_NAME;
1428 goto error;
1429 }
1430 } else if (domain->type == LTTNG_DOMAIN_LOG4J) {
1431 if (strncmp(attr->name, DEFAULT_LOG4J_CHANNEL_NAME,
1432 LTTNG_SYMBOL_NAME_LEN)) {
1433 ret = LTTNG_ERR_INVALID_CHANNEL_NAME;
1434 goto error;
1435 }
1436 } else if (domain->type == LTTNG_DOMAIN_PYTHON) {
1437 if (strncmp(attr->name, DEFAULT_PYTHON_CHANNEL_NAME,
1438 LTTNG_SYMBOL_NAME_LEN)) {
1439 ret = LTTNG_ERR_INVALID_CHANNEL_NAME;
1440 goto error;
1441 }
1442 }
1443
1444 chan_ht = usess->domain_global.channels;
1445
1446 uchan = trace_ust_find_channel_by_name(chan_ht, attr->name);
1447 if (uchan == NULL) {
1448 ret = channel_ust_create(usess, attr, domain->buf_type);
1449 if (attr->name[0] != '\0') {
1450 usess->has_non_default_channel = 1;
1451 }
1452 } else {
1453 ret = channel_ust_enable(usess, uchan);
1454 }
1455 break;
1456 }
1457 default:
1458 ret = LTTNG_ERR_UNKNOWN_DOMAIN;
1459 goto error;
1460 }
1461
1462 error:
1463 rcu_read_unlock();
1464 end:
1465 return ret;
1466 }
1467
1468 /*
1469 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1470 */
1471 int cmd_disable_event(struct ltt_session *session,
1472 enum lttng_domain_type domain, char *channel_name,
1473 struct lttng_event *event)
1474 {
1475 int ret;
1476 char *event_name;
1477
1478 DBG("Disable event command for event \'%s\'", event->name);
1479
1480 event_name = event->name;
1481
1482 /* Error out on unhandled search criteria */
1483 if (event->loglevel_type || event->loglevel != -1 || event->enabled
1484 || event->pid || event->filter || event->exclusion) {
1485 ret = LTTNG_ERR_UNK;
1486 goto error;
1487 }
1488
1489 rcu_read_lock();
1490
1491 switch (domain) {
1492 case LTTNG_DOMAIN_KERNEL:
1493 {
1494 struct ltt_kernel_channel *kchan;
1495 struct ltt_kernel_session *ksess;
1496
1497 ksess = session->kernel_session;
1498
1499 /*
1500 * If a non-default channel has been created in the
1501 * session, explicitely require that -c chan_name needs
1502 * to be provided.
1503 */
1504 if (ksess->has_non_default_channel && channel_name[0] == '\0') {
1505 ret = LTTNG_ERR_NEED_CHANNEL_NAME;
1506 goto error_unlock;
1507 }
1508
1509 kchan = trace_kernel_get_channel_by_name(channel_name, ksess);
1510 if (kchan == NULL) {
1511 ret = LTTNG_ERR_KERN_CHAN_NOT_FOUND;
1512 goto error_unlock;
1513 }
1514
1515 switch (event->type) {
1516 case LTTNG_EVENT_ALL:
1517 case LTTNG_EVENT_TRACEPOINT:
1518 case LTTNG_EVENT_SYSCALL:
1519 case LTTNG_EVENT_PROBE:
1520 case LTTNG_EVENT_FUNCTION:
1521 case LTTNG_EVENT_FUNCTION_ENTRY:/* fall-through */
1522 if (event_name[0] == '\0') {
1523 ret = event_kernel_disable_event(kchan,
1524 NULL, event->type);
1525 } else {
1526 ret = event_kernel_disable_event(kchan,
1527 event_name, event->type);
1528 }
1529 if (ret != LTTNG_OK) {
1530 goto error_unlock;
1531 }
1532 break;
1533 default:
1534 ret = LTTNG_ERR_UNK;
1535 goto error_unlock;
1536 }
1537
1538 kernel_wait_quiescent(kernel_tracer_fd);
1539 break;
1540 }
1541 case LTTNG_DOMAIN_UST:
1542 {
1543 struct ltt_ust_channel *uchan;
1544 struct ltt_ust_session *usess;
1545
1546 usess = session->ust_session;
1547
1548 if (validate_ust_event_name(event_name)) {
1549 ret = LTTNG_ERR_INVALID_EVENT_NAME;
1550 goto error_unlock;
1551 }
1552
1553 /*
1554 * If a non-default channel has been created in the
1555 * session, explicitly require that -c chan_name needs
1556 * to be provided.
1557 */
1558 if (usess->has_non_default_channel && channel_name[0] == '\0') {
1559 ret = LTTNG_ERR_NEED_CHANNEL_NAME;
1560 goto error_unlock;
1561 }
1562
1563 uchan = trace_ust_find_channel_by_name(usess->domain_global.channels,
1564 channel_name);
1565 if (uchan == NULL) {
1566 ret = LTTNG_ERR_UST_CHAN_NOT_FOUND;
1567 goto error_unlock;
1568 }
1569
1570 switch (event->type) {
1571 case LTTNG_EVENT_ALL:
1572 /*
1573 * An empty event name means that everything
1574 * should be disabled.
1575 */
1576 if (event->name[0] == '\0') {
1577 ret = event_ust_disable_all_tracepoints(usess, uchan);
1578 } else {
1579 ret = event_ust_disable_tracepoint(usess, uchan,
1580 event_name);
1581 }
1582 if (ret != LTTNG_OK) {
1583 goto error_unlock;
1584 }
1585 break;
1586 default:
1587 ret = LTTNG_ERR_UNK;
1588 goto error_unlock;
1589 }
1590
1591 DBG3("Disable UST event %s in channel %s completed", event_name,
1592 channel_name);
1593 break;
1594 }
1595 case LTTNG_DOMAIN_LOG4J:
1596 case LTTNG_DOMAIN_JUL:
1597 case LTTNG_DOMAIN_PYTHON:
1598 {
1599 struct agent *agt;
1600 struct ltt_ust_session *usess = session->ust_session;
1601
1602 assert(usess);
1603
1604 switch (event->type) {
1605 case LTTNG_EVENT_ALL:
1606 break;
1607 default:
1608 ret = LTTNG_ERR_UNK;
1609 goto error_unlock;
1610 }
1611
1612 agt = trace_ust_find_agent(usess, domain);
1613 if (!agt) {
1614 ret = -LTTNG_ERR_UST_EVENT_NOT_FOUND;
1615 goto error_unlock;
1616 }
1617 /*
1618 * An empty event name means that everything
1619 * should be disabled.
1620 */
1621 if (event->name[0] == '\0') {
1622 ret = event_agent_disable_all(usess, agt);
1623 } else {
1624 ret = event_agent_disable(usess, agt, event_name);
1625 }
1626 if (ret != LTTNG_OK) {
1627 goto error_unlock;
1628 }
1629
1630 break;
1631 }
1632 default:
1633 ret = LTTNG_ERR_UND;
1634 goto error_unlock;
1635 }
1636
1637 ret = LTTNG_OK;
1638
1639 error_unlock:
1640 rcu_read_unlock();
1641 error:
1642 return ret;
1643 }
1644
1645 /*
1646 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1647 */
1648 int cmd_add_context(struct ltt_session *session, enum lttng_domain_type domain,
1649 char *channel_name, struct lttng_event_context *ctx, int kwpipe)
1650 {
1651 int ret, chan_kern_created = 0, chan_ust_created = 0;
1652 char *app_ctx_provider_name = NULL, *app_ctx_name = NULL;
1653
1654 if (ctx->ctx == LTTNG_EVENT_CONTEXT_APP_CONTEXT) {
1655 app_ctx_provider_name = ctx->u.app_ctx.provider_name;
1656 app_ctx_name = ctx->u.app_ctx.ctx_name;
1657 }
1658
1659 switch (domain) {
1660 case LTTNG_DOMAIN_KERNEL:
1661 assert(session->kernel_session);
1662
1663 if (session->kernel_session->channel_count == 0) {
1664 /* Create default channel */
1665 ret = channel_kernel_create(session->kernel_session, NULL, kwpipe);
1666 if (ret != LTTNG_OK) {
1667 goto error;
1668 }
1669 chan_kern_created = 1;
1670 }
1671 /* Add kernel context to kernel tracer */
1672 ret = context_kernel_add(session->kernel_session, ctx, channel_name);
1673 if (ret != LTTNG_OK) {
1674 goto error;
1675 }
1676 break;
1677 case LTTNG_DOMAIN_JUL:
1678 case LTTNG_DOMAIN_LOG4J:
1679 {
1680 /*
1681 * Validate channel name.
1682 * If no channel name is given and the domain is JUL or LOG4J,
1683 * set it to the appropriate domain-specific channel name. If
1684 * a name is provided but does not match the expexted channel
1685 * name, return an error.
1686 */
1687 if (domain == LTTNG_DOMAIN_JUL && *channel_name &&
1688 strcmp(channel_name,
1689 DEFAULT_JUL_CHANNEL_NAME)) {
1690 ret = LTTNG_ERR_UST_CHAN_NOT_FOUND;
1691 goto error;
1692 } else if (domain == LTTNG_DOMAIN_LOG4J && *channel_name &&
1693 strcmp(channel_name,
1694 DEFAULT_LOG4J_CHANNEL_NAME)) {
1695 ret = LTTNG_ERR_UST_CHAN_NOT_FOUND;
1696 goto error;
1697 }
1698 /* break is _not_ missing here. */
1699 }
1700 case LTTNG_DOMAIN_UST:
1701 {
1702 struct ltt_ust_session *usess = session->ust_session;
1703 unsigned int chan_count;
1704
1705 assert(usess);
1706
1707 chan_count = lttng_ht_get_count(usess->domain_global.channels);
1708 if (chan_count == 0) {
1709 struct lttng_channel *attr;
1710 /* Create default channel */
1711 attr = channel_new_default_attr(domain, usess->buffer_type);
1712 if (attr == NULL) {
1713 ret = LTTNG_ERR_FATAL;
1714 goto error;
1715 }
1716
1717 ret = channel_ust_create(usess, attr, usess->buffer_type);
1718 if (ret != LTTNG_OK) {
1719 free(attr);
1720 goto error;
1721 }
1722 channel_attr_destroy(attr);
1723 chan_ust_created = 1;
1724 }
1725
1726 ret = context_ust_add(usess, domain, ctx, channel_name);
1727 free(app_ctx_provider_name);
1728 free(app_ctx_name);
1729 app_ctx_name = NULL;
1730 app_ctx_provider_name = NULL;
1731 if (ret != LTTNG_OK) {
1732 goto error;
1733 }
1734 break;
1735 }
1736 default:
1737 ret = LTTNG_ERR_UND;
1738 goto error;
1739 }
1740
1741 ret = LTTNG_OK;
1742 goto end;
1743
1744 error:
1745 if (chan_kern_created) {
1746 struct ltt_kernel_channel *kchan =
1747 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME,
1748 session->kernel_session);
1749 /* Created previously, this should NOT fail. */
1750 assert(kchan);
1751 kernel_destroy_channel(kchan);
1752 }
1753
1754 if (chan_ust_created) {
1755 struct ltt_ust_channel *uchan =
1756 trace_ust_find_channel_by_name(
1757 session->ust_session->domain_global.channels,
1758 DEFAULT_CHANNEL_NAME);
1759 /* Created previously, this should NOT fail. */
1760 assert(uchan);
1761 /* Remove from the channel list of the session. */
1762 trace_ust_delete_channel(session->ust_session->domain_global.channels,
1763 uchan);
1764 trace_ust_destroy_channel(uchan);
1765 }
1766 end:
1767 free(app_ctx_provider_name);
1768 free(app_ctx_name);
1769 return ret;
1770 }
1771
1772 static inline bool name_starts_with(const char *name, const char *prefix)
1773 {
1774 const size_t max_cmp_len = min(strlen(prefix), LTTNG_SYMBOL_NAME_LEN);
1775
1776 return !strncmp(name, prefix, max_cmp_len);
1777 }
1778
1779 /* Perform userspace-specific event name validation */
1780 static int validate_ust_event_name(const char *name)
1781 {
1782 int ret = 0;
1783
1784 if (!name) {
1785 ret = -1;
1786 goto end;
1787 }
1788
1789 /*
1790 * Check name against all internal UST event component namespaces used
1791 * by the agents.
1792 */
1793 if (name_starts_with(name, DEFAULT_JUL_EVENT_COMPONENT) ||
1794 name_starts_with(name, DEFAULT_LOG4J_EVENT_COMPONENT) ||
1795 name_starts_with(name, DEFAULT_PYTHON_EVENT_COMPONENT)) {
1796 ret = -1;
1797 }
1798
1799 end:
1800 return ret;
1801 }
1802
1803 /*
1804 * Internal version of cmd_enable_event() with a supplemental
1805 * "internal_event" flag which is used to enable internal events which should
1806 * be hidden from clients. Such events are used in the agent implementation to
1807 * enable the events through which all "agent" events are funeled.
1808 */
1809 static int _cmd_enable_event(struct ltt_session *session,
1810 struct lttng_domain *domain,
1811 char *channel_name, struct lttng_event *event,
1812 char *filter_expression,
1813 struct lttng_filter_bytecode *filter,
1814 struct lttng_event_exclusion *exclusion,
1815 int wpipe, bool internal_event)
1816 {
1817 int ret = 0, channel_created = 0;
1818 struct lttng_channel *attr = NULL;
1819
1820 assert(session);
1821 assert(event);
1822 assert(channel_name);
1823
1824 /* If we have a filter, we must have its filter expression */
1825 assert(!(!!filter_expression ^ !!filter));
1826
1827 /* Normalize event name as a globbing pattern */
1828 strutils_normalize_star_glob_pattern(event->name);
1829
1830 /* Normalize exclusion names as globbing patterns */
1831 if (exclusion) {
1832 size_t i;
1833
1834 for (i = 0; i < exclusion->count; i++) {
1835 char *name = LTTNG_EVENT_EXCLUSION_NAME_AT(exclusion, i);
1836
1837 strutils_normalize_star_glob_pattern(name);
1838 }
1839 }
1840
1841 DBG("Enable event command for event \'%s\'", event->name);
1842
1843 rcu_read_lock();
1844
1845 switch (domain->type) {
1846 case LTTNG_DOMAIN_KERNEL:
1847 {
1848 struct ltt_kernel_channel *kchan;
1849
1850 /*
1851 * If a non-default channel has been created in the
1852 * session, explicitely require that -c chan_name needs
1853 * to be provided.
1854 */
1855 if (session->kernel_session->has_non_default_channel
1856 && channel_name[0] == '\0') {
1857 ret = LTTNG_ERR_NEED_CHANNEL_NAME;
1858 goto error;
1859 }
1860
1861 kchan = trace_kernel_get_channel_by_name(channel_name,
1862 session->kernel_session);
1863 if (kchan == NULL) {
1864 attr = channel_new_default_attr(LTTNG_DOMAIN_KERNEL,
1865 LTTNG_BUFFER_GLOBAL);
1866 if (attr == NULL) {
1867 ret = LTTNG_ERR_FATAL;
1868 goto error;
1869 }
1870 if (lttng_strncpy(attr->name, channel_name,
1871 sizeof(attr->name))) {
1872 ret = LTTNG_ERR_INVALID;
1873 goto error;
1874 }
1875
1876 ret = cmd_enable_channel(session, domain, attr, wpipe);
1877 if (ret != LTTNG_OK) {
1878 goto error;
1879 }
1880 channel_created = 1;
1881 }
1882
1883 /* Get the newly created kernel channel pointer */
1884 kchan = trace_kernel_get_channel_by_name(channel_name,
1885 session->kernel_session);
1886 if (kchan == NULL) {
1887 /* This sould not happen... */
1888 ret = LTTNG_ERR_FATAL;
1889 goto error;
1890 }
1891
1892 switch (event->type) {
1893 case LTTNG_EVENT_ALL:
1894 {
1895 char *filter_expression_a = NULL;
1896 struct lttng_filter_bytecode *filter_a = NULL;
1897
1898 /*
1899 * We need to duplicate filter_expression and filter,
1900 * because ownership is passed to first enable
1901 * event.
1902 */
1903 if (filter_expression) {
1904 filter_expression_a = strdup(filter_expression);
1905 if (!filter_expression_a) {
1906 ret = LTTNG_ERR_FATAL;
1907 goto error;
1908 }
1909 }
1910 if (filter) {
1911 filter_a = zmalloc(sizeof(*filter_a) + filter->len);
1912 if (!filter_a) {
1913 free(filter_expression_a);
1914 ret = LTTNG_ERR_FATAL;
1915 goto error;
1916 }
1917 memcpy(filter_a, filter, sizeof(*filter_a) + filter->len);
1918 }
1919 event->type = LTTNG_EVENT_TRACEPOINT; /* Hack */
1920 ret = event_kernel_enable_event(kchan, event,
1921 filter_expression, filter);
1922 /* We have passed ownership */
1923 filter_expression = NULL;
1924 filter = NULL;
1925 if (ret != LTTNG_OK) {
1926 if (channel_created) {
1927 /* Let's not leak a useless channel. */
1928 kernel_destroy_channel(kchan);
1929 }
1930 free(filter_expression_a);
1931 free(filter_a);
1932 goto error;
1933 }
1934 event->type = LTTNG_EVENT_SYSCALL; /* Hack */
1935 ret = event_kernel_enable_event(kchan, event,
1936 filter_expression_a, filter_a);
1937 /* We have passed ownership */
1938 filter_expression_a = NULL;
1939 filter_a = NULL;
1940 if (ret != LTTNG_OK) {
1941 goto error;
1942 }
1943 break;
1944 }
1945 case LTTNG_EVENT_PROBE:
1946 case LTTNG_EVENT_FUNCTION:
1947 case LTTNG_EVENT_FUNCTION_ENTRY:
1948 case LTTNG_EVENT_TRACEPOINT:
1949 ret = event_kernel_enable_event(kchan, event,
1950 filter_expression, filter);
1951 /* We have passed ownership */
1952 filter_expression = NULL;
1953 filter = NULL;
1954 if (ret != LTTNG_OK) {
1955 if (channel_created) {
1956 /* Let's not leak a useless channel. */
1957 kernel_destroy_channel(kchan);
1958 }
1959 goto error;
1960 }
1961 break;
1962 case LTTNG_EVENT_SYSCALL:
1963 ret = event_kernel_enable_event(kchan, event,
1964 filter_expression, filter);
1965 /* We have passed ownership */
1966 filter_expression = NULL;
1967 filter = NULL;
1968 if (ret != LTTNG_OK) {
1969 goto error;
1970 }
1971 break;
1972 default:
1973 ret = LTTNG_ERR_UNK;
1974 goto error;
1975 }
1976
1977 kernel_wait_quiescent(kernel_tracer_fd);
1978 break;
1979 }
1980 case LTTNG_DOMAIN_UST:
1981 {
1982 struct ltt_ust_channel *uchan;
1983 struct ltt_ust_session *usess = session->ust_session;
1984
1985 assert(usess);
1986
1987 /*
1988 * If a non-default channel has been created in the
1989 * session, explicitely require that -c chan_name needs
1990 * to be provided.
1991 */
1992 if (usess->has_non_default_channel && channel_name[0] == '\0') {
1993 ret = LTTNG_ERR_NEED_CHANNEL_NAME;
1994 goto error;
1995 }
1996
1997 /* Get channel from global UST domain */
1998 uchan = trace_ust_find_channel_by_name(usess->domain_global.channels,
1999 channel_name);
2000 if (uchan == NULL) {
2001 /* Create default channel */
2002 attr = channel_new_default_attr(LTTNG_DOMAIN_UST,
2003 usess->buffer_type);
2004 if (attr == NULL) {
2005 ret = LTTNG_ERR_FATAL;
2006 goto error;
2007 }
2008 if (lttng_strncpy(attr->name, channel_name,
2009 sizeof(attr->name))) {
2010 ret = LTTNG_ERR_INVALID;
2011 goto error;
2012 }
2013
2014 ret = cmd_enable_channel(session, domain, attr, wpipe);
2015 if (ret != LTTNG_OK) {
2016 goto error;
2017 }
2018
2019 /* Get the newly created channel reference back */
2020 uchan = trace_ust_find_channel_by_name(
2021 usess->domain_global.channels, channel_name);
2022 assert(uchan);
2023 }
2024
2025 if (uchan->domain != LTTNG_DOMAIN_UST && !internal_event) {
2026 /*
2027 * Don't allow users to add UST events to channels which
2028 * are assigned to a userspace subdomain (JUL, Log4J,
2029 * Python, etc.).
2030 */
2031 ret = LTTNG_ERR_INVALID_CHANNEL_DOMAIN;
2032 goto error;
2033 }
2034
2035 if (!internal_event) {
2036 /*
2037 * Ensure the event name is not reserved for internal
2038 * use.
2039 */
2040 ret = validate_ust_event_name(event->name);
2041 if (ret) {
2042 WARN("Userspace event name %s failed validation.",
2043 event->name ?
2044 event->name : "NULL");
2045 ret = LTTNG_ERR_INVALID_EVENT_NAME;
2046 goto error;
2047 }
2048 }
2049
2050 /* At this point, the session and channel exist on the tracer */
2051 ret = event_ust_enable_tracepoint(usess, uchan, event,
2052 filter_expression, filter, exclusion,
2053 internal_event);
2054 /* We have passed ownership */
2055 filter_expression = NULL;
2056 filter = NULL;
2057 exclusion = NULL;
2058 if (ret == LTTNG_ERR_UST_EVENT_ENABLED) {
2059 goto already_enabled;
2060 } else if (ret != LTTNG_OK) {
2061 goto error;
2062 }
2063 break;
2064 }
2065 case LTTNG_DOMAIN_LOG4J:
2066 case LTTNG_DOMAIN_JUL:
2067 case LTTNG_DOMAIN_PYTHON:
2068 {
2069 const char *default_event_name, *default_chan_name;
2070 struct agent *agt;
2071 struct lttng_event uevent;
2072 struct lttng_domain tmp_dom;
2073 struct ltt_ust_session *usess = session->ust_session;
2074
2075 assert(usess);
2076
2077 agt = trace_ust_find_agent(usess, domain->type);
2078 if (!agt) {
2079 agt = agent_create(domain->type);
2080 if (!agt) {
2081 ret = LTTNG_ERR_NOMEM;
2082 goto error;
2083 }
2084 agent_add(agt, usess->agents);
2085 }
2086
2087 /* Create the default tracepoint. */
2088 memset(&uevent, 0, sizeof(uevent));
2089 uevent.type = LTTNG_EVENT_TRACEPOINT;
2090 uevent.loglevel_type = LTTNG_EVENT_LOGLEVEL_ALL;
2091 default_event_name = event_get_default_agent_ust_name(
2092 domain->type);
2093 if (!default_event_name) {
2094 ret = LTTNG_ERR_FATAL;
2095 goto error;
2096 }
2097 strncpy(uevent.name, default_event_name, sizeof(uevent.name));
2098 uevent.name[sizeof(uevent.name) - 1] = '\0';
2099
2100 /*
2101 * The domain type is changed because we are about to enable the
2102 * default channel and event for the JUL domain that are hardcoded.
2103 * This happens in the UST domain.
2104 */
2105 memcpy(&tmp_dom, domain, sizeof(tmp_dom));
2106 tmp_dom.type = LTTNG_DOMAIN_UST;
2107
2108 switch (domain->type) {
2109 case LTTNG_DOMAIN_LOG4J:
2110 default_chan_name = DEFAULT_LOG4J_CHANNEL_NAME;
2111 break;
2112 case LTTNG_DOMAIN_JUL:
2113 default_chan_name = DEFAULT_JUL_CHANNEL_NAME;
2114 break;
2115 case LTTNG_DOMAIN_PYTHON:
2116 default_chan_name = DEFAULT_PYTHON_CHANNEL_NAME;
2117 break;
2118 default:
2119 /* The switch/case we are in makes this impossible */
2120 assert(0);
2121 }
2122
2123 {
2124 char *filter_expression_copy = NULL;
2125 struct lttng_filter_bytecode *filter_copy = NULL;
2126
2127 if (filter) {
2128 const size_t filter_size = sizeof(
2129 struct lttng_filter_bytecode)
2130 + filter->len;
2131
2132 filter_copy = zmalloc(filter_size);
2133 if (!filter_copy) {
2134 ret = LTTNG_ERR_NOMEM;
2135 goto error;
2136 }
2137 memcpy(filter_copy, filter, filter_size);
2138
2139 filter_expression_copy =
2140 strdup(filter_expression);
2141 if (!filter_expression) {
2142 ret = LTTNG_ERR_NOMEM;
2143 }
2144
2145 if (!filter_expression_copy || !filter_copy) {
2146 free(filter_expression_copy);
2147 free(filter_copy);
2148 goto error;
2149 }
2150 }
2151
2152 ret = cmd_enable_event_internal(session, &tmp_dom,
2153 (char *) default_chan_name,
2154 &uevent, filter_expression_copy,
2155 filter_copy, NULL, wpipe);
2156 }
2157
2158 if (ret == LTTNG_ERR_UST_EVENT_ENABLED) {
2159 goto already_enabled;
2160 } else if (ret != LTTNG_OK) {
2161 goto error;
2162 }
2163
2164 /* The wild card * means that everything should be enabled. */
2165 if (strncmp(event->name, "*", 1) == 0 && strlen(event->name) == 1) {
2166 ret = event_agent_enable_all(usess, agt, event, filter,
2167 filter_expression);
2168 } else {
2169 ret = event_agent_enable(usess, agt, event, filter,
2170 filter_expression);
2171 }
2172 filter = NULL;
2173 filter_expression = NULL;
2174 if (ret != LTTNG_OK) {
2175 goto error;
2176 }
2177
2178 break;
2179 }
2180 default:
2181 ret = LTTNG_ERR_UND;
2182 goto error;
2183 }
2184
2185 ret = LTTNG_OK;
2186
2187 already_enabled:
2188 error:
2189 free(filter_expression);
2190 free(filter);
2191 free(exclusion);
2192 channel_attr_destroy(attr);
2193 rcu_read_unlock();
2194 return ret;
2195 }
2196
2197 /*
2198 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2199 * We own filter, exclusion, and filter_expression.
2200 */
2201 int cmd_enable_event(struct ltt_session *session, struct lttng_domain *domain,
2202 char *channel_name, struct lttng_event *event,
2203 char *filter_expression,
2204 struct lttng_filter_bytecode *filter,
2205 struct lttng_event_exclusion *exclusion,
2206 int wpipe)
2207 {
2208 return _cmd_enable_event(session, domain, channel_name, event,
2209 filter_expression, filter, exclusion, wpipe, false);
2210 }
2211
2212 /*
2213 * Enable an event which is internal to LTTng. An internal should
2214 * never be made visible to clients and are immune to checks such as
2215 * reserved names.
2216 */
2217 static int cmd_enable_event_internal(struct ltt_session *session,
2218 struct lttng_domain *domain,
2219 char *channel_name, struct lttng_event *event,
2220 char *filter_expression,
2221 struct lttng_filter_bytecode *filter,
2222 struct lttng_event_exclusion *exclusion,
2223 int wpipe)
2224 {
2225 return _cmd_enable_event(session, domain, channel_name, event,
2226 filter_expression, filter, exclusion, wpipe, true);
2227 }
2228
2229 /*
2230 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2231 */
2232 ssize_t cmd_list_tracepoints(enum lttng_domain_type domain,
2233 struct lttng_event **events)
2234 {
2235 int ret;
2236 ssize_t nb_events = 0;
2237
2238 switch (domain) {
2239 case LTTNG_DOMAIN_KERNEL:
2240 nb_events = kernel_list_events(kernel_tracer_fd, events);
2241 if (nb_events < 0) {
2242 ret = LTTNG_ERR_KERN_LIST_FAIL;
2243 goto error;
2244 }
2245 break;
2246 case LTTNG_DOMAIN_UST:
2247 nb_events = ust_app_list_events(events);
2248 if (nb_events < 0) {
2249 ret = LTTNG_ERR_UST_LIST_FAIL;
2250 goto error;
2251 }
2252 break;
2253 case LTTNG_DOMAIN_LOG4J:
2254 case LTTNG_DOMAIN_JUL:
2255 case LTTNG_DOMAIN_PYTHON:
2256 nb_events = agent_list_events(events, domain);
2257 if (nb_events < 0) {
2258 ret = LTTNG_ERR_UST_LIST_FAIL;
2259 goto error;
2260 }
2261 break;
2262 default:
2263 ret = LTTNG_ERR_UND;
2264 goto error;
2265 }
2266
2267 return nb_events;
2268
2269 error:
2270 /* Return negative value to differentiate return code */
2271 return -ret;
2272 }
2273
2274 /*
2275 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
2276 */
2277 ssize_t cmd_list_tracepoint_fields(enum lttng_domain_type domain,
2278 struct lttng_event_field **fields)
2279 {
2280 int ret;
2281 ssize_t nb_fields = 0;
2282
2283 switch (domain) {
2284 case LTTNG_DOMAIN_UST:
2285 nb_fields = ust_app_list_event_fields(fields);
2286 if (nb_fields < 0) {
2287 ret = LTTNG_ERR_UST_LIST_FAIL;
2288 goto error;
2289 }
2290 break;
2291 case LTTNG_DOMAIN_KERNEL:
2292 default: /* fall-through */
2293 ret = LTTNG_ERR_UND;
2294 goto error;
2295 }
2296
2297 return nb_fields;
2298
2299 error:
2300 /* Return negative value to differentiate return code */
2301 return -ret;
2302 }
2303
2304 ssize_t cmd_list_syscalls(struct lttng_event **events)
2305 {
2306 return syscall_table_list(events);
2307 }
2308
2309 /*
2310 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
2311 *
2312 * Called with session lock held.
2313 */
2314 ssize_t cmd_list_tracker_pids(struct ltt_session *session,
2315 enum lttng_domain_type domain, int32_t **pids)
2316 {
2317 int ret;
2318 ssize_t nr_pids = 0;
2319
2320 switch (domain) {
2321 case LTTNG_DOMAIN_KERNEL:
2322 {
2323 struct ltt_kernel_session *ksess;
2324
2325 ksess = session->kernel_session;
2326 nr_pids = kernel_list_tracker_pids(ksess, pids);
2327 if (nr_pids < 0) {
2328 ret = LTTNG_ERR_KERN_LIST_FAIL;
2329 goto error;
2330 }
2331 break;
2332 }
2333 case LTTNG_DOMAIN_UST:
2334 {
2335 struct ltt_ust_session *usess;
2336
2337 usess = session->ust_session;
2338 nr_pids = trace_ust_list_tracker_pids(usess, pids);
2339 if (nr_pids < 0) {
2340 ret = LTTNG_ERR_UST_LIST_FAIL;
2341 goto error;
2342 }
2343 break;
2344 }
2345 case LTTNG_DOMAIN_LOG4J:
2346 case LTTNG_DOMAIN_JUL:
2347 case LTTNG_DOMAIN_PYTHON:
2348 default:
2349 ret = LTTNG_ERR_UND;
2350 goto error;
2351 }
2352
2353 return nr_pids;
2354
2355 error:
2356 /* Return negative value to differentiate return code */
2357 return -ret;
2358 }
2359
2360 /*
2361 * Command LTTNG_START_TRACE processed by the client thread.
2362 *
2363 * Called with session mutex held.
2364 */
2365 int cmd_start_trace(struct ltt_session *session)
2366 {
2367 int ret;
2368 unsigned long nb_chan = 0;
2369 struct ltt_kernel_session *ksession;
2370 struct ltt_ust_session *usess;
2371
2372 assert(session);
2373
2374 /* Ease our life a bit ;) */
2375 ksession = session->kernel_session;
2376 usess = session->ust_session;
2377
2378 /* Is the session already started? */
2379 if (session->active) {
2380 ret = LTTNG_ERR_TRACE_ALREADY_STARTED;
2381 goto error;
2382 }
2383
2384 /*
2385 * Starting a session without channel is useless since after that it's not
2386 * possible to enable channel thus inform the client.
2387 */
2388 if (usess && usess->domain_global.channels) {
2389 nb_chan += lttng_ht_get_count(usess->domain_global.channels);
2390 }
2391 if (ksession) {
2392 nb_chan += ksession->channel_count;
2393 }
2394 if (!nb_chan) {
2395 ret = LTTNG_ERR_NO_CHANNEL;
2396 goto error;
2397 }
2398
2399 /*
2400 * Record the timestamp of the first time the session is started for
2401 * an eventual session rotation call.
2402 */
2403 if (!session->has_been_started) {
2404 session->session_start_ts = time(NULL);
2405 if (session->session_start_ts == (time_t) -1) {
2406 PERROR("Get start time");
2407 ret = LTTNG_ERR_FATAL;
2408 goto error;
2409 }
2410 }
2411
2412 /* Kernel tracing */
2413 if (ksession != NULL) {
2414 ret = start_kernel_session(ksession, kernel_tracer_fd);
2415 if (ret != LTTNG_OK) {
2416 goto error;
2417 }
2418 }
2419
2420 /* Flag session that trace should start automatically */
2421 if (usess) {
2422 /*
2423 * Even though the start trace might fail, flag this session active so
2424 * other application coming in are started by default.
2425 */
2426 usess->active = 1;
2427
2428 ret = ust_app_start_trace_all(usess);
2429 if (ret < 0) {
2430 ret = LTTNG_ERR_UST_START_FAIL;
2431 goto error;
2432 }
2433 }
2434
2435 /* Flag this after a successful start. */
2436 session->has_been_started = 1;
2437 session->active = 1;
2438
2439 ret = LTTNG_OK;
2440
2441 error:
2442 return ret;
2443 }
2444
2445 /*
2446 * Command LTTNG_STOP_TRACE processed by the client thread.
2447 */
2448 int cmd_stop_trace(struct ltt_session *session)
2449 {
2450 int ret;
2451 struct ltt_kernel_channel *kchan;
2452 struct ltt_kernel_session *ksession;
2453 struct ltt_ust_session *usess;
2454
2455 assert(session);
2456
2457 /* Short cut */
2458 ksession = session->kernel_session;
2459 usess = session->ust_session;
2460
2461 /* Session is not active. Skip everythong and inform the client. */
2462 if (!session->active) {
2463 ret = LTTNG_ERR_TRACE_ALREADY_STOPPED;
2464 goto error;
2465 }
2466
2467 /* Kernel tracer */
2468 if (ksession && ksession->active) {
2469 DBG("Stop kernel tracing");
2470
2471 ret = kernel_stop_session(ksession);
2472 if (ret < 0) {
2473 ret = LTTNG_ERR_KERN_STOP_FAIL;
2474 goto error;
2475 }
2476
2477 kernel_wait_quiescent(kernel_tracer_fd);
2478
2479 /* Flush metadata after stopping (if exists) */
2480 if (ksession->metadata_stream_fd >= 0) {
2481 ret = kernel_metadata_flush_buffer(ksession->metadata_stream_fd);
2482 if (ret < 0) {
2483 ERR("Kernel metadata flush failed");
2484 }
2485 }
2486
2487 /* Flush all buffers after stopping */
2488 cds_list_for_each_entry(kchan, &ksession->channel_list.head, list) {
2489 ret = kernel_flush_buffer(kchan);
2490 if (ret < 0) {
2491 ERR("Kernel flush buffer error");
2492 }
2493 }
2494
2495 ksession->active = 0;
2496 }
2497
2498 if (usess && usess->active) {
2499 /*
2500 * Even though the stop trace might fail, flag this session inactive so
2501 * other application coming in are not started by default.
2502 */
2503 usess->active = 0;
2504
2505 ret = ust_app_stop_trace_all(usess);
2506 if (ret < 0) {
2507 ret = LTTNG_ERR_UST_STOP_FAIL;
2508 goto error;
2509 }
2510 }
2511
2512 session->session_last_stop_ts = time(NULL);
2513
2514 /* Flag inactive after a successful stop. */
2515 session->active = 0;
2516 ret = LTTNG_OK;
2517
2518 error:
2519 return ret;
2520 }
2521
2522 /*
2523 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2524 */
2525 int cmd_set_consumer_uri(struct ltt_session *session, size_t nb_uri,
2526 struct lttng_uri *uris)
2527 {
2528 int ret, i;
2529 struct ltt_kernel_session *ksess = session->kernel_session;
2530 struct ltt_ust_session *usess = session->ust_session;
2531
2532 assert(session);
2533 assert(uris);
2534 assert(nb_uri > 0);
2535
2536 /* Can't set consumer URI if the session is active. */
2537 if (session->active) {
2538 ret = LTTNG_ERR_TRACE_ALREADY_STARTED;
2539 goto error;
2540 }
2541
2542 /* Set the "global" consumer URIs */
2543 for (i = 0; i < nb_uri; i++) {
2544 ret = add_uri_to_consumer(session->consumer,
2545 &uris[i], 0, session->name);
2546 if (ret != LTTNG_OK) {
2547 goto error;
2548 }
2549 }
2550
2551 /* Set UST session URIs */
2552 if (session->ust_session) {
2553 for (i = 0; i < nb_uri; i++) {
2554 ret = add_uri_to_consumer(
2555 session->ust_session->consumer,
2556 &uris[i], LTTNG_DOMAIN_UST,
2557 session->name);
2558 if (ret != LTTNG_OK) {
2559 goto error;
2560 }
2561 }
2562 }
2563
2564 /* Set kernel session URIs */
2565 if (session->kernel_session) {
2566 for (i = 0; i < nb_uri; i++) {
2567 ret = add_uri_to_consumer(
2568 session->kernel_session->consumer,
2569 &uris[i], LTTNG_DOMAIN_KERNEL,
2570 session->name);
2571 if (ret != LTTNG_OK) {
2572 goto error;
2573 }
2574 }
2575 }
2576
2577 /*
2578 * Make sure to set the session in output mode after we set URI since a
2579 * session can be created without URL (thus flagged in no output mode).
2580 */
2581 session->output_traces = 1;
2582 if (ksess) {
2583 ksess->output_traces = 1;
2584 }
2585
2586 if (usess) {
2587 usess->output_traces = 1;
2588 }
2589
2590 /* All good! */
2591 ret = LTTNG_OK;
2592
2593 error:
2594 return ret;
2595 }
2596
2597 /*
2598 * Command LTTNG_CREATE_SESSION processed by the client thread.
2599 */
2600 int cmd_create_session_uri(char *name, struct lttng_uri *uris,
2601 size_t nb_uri, lttng_sock_cred *creds, unsigned int live_timer)
2602 {
2603 int ret;
2604 struct ltt_session *session;
2605
2606 assert(name);
2607 assert(creds);
2608
2609 /*
2610 * Verify if the session already exist
2611 *
2612 * XXX: There is no need for the session lock list here since the caller
2613 * (process_client_msg) is holding it. We might want to change that so a
2614 * single command does not lock the entire session list.
2615 */
2616 session = session_find_by_name(name);
2617 if (session != NULL) {
2618 ret = LTTNG_ERR_EXIST_SESS;
2619 goto find_error;
2620 }
2621
2622 /* Create tracing session in the registry */
2623 ret = session_create(name, LTTNG_SOCK_GET_UID_CRED(creds),
2624 LTTNG_SOCK_GET_GID_CRED(creds));
2625 if (ret != LTTNG_OK) {
2626 goto session_error;
2627 }
2628
2629 /*
2630 * Get the newly created session pointer back
2631 *
2632 * XXX: There is no need for the session lock list here since the caller
2633 * (process_client_msg) is holding it. We might want to change that so a
2634 * single command does not lock the entire session list.
2635 */
2636 session = session_find_by_name(name);
2637 assert(session);
2638
2639 session->live_timer = live_timer;
2640 /* Create default consumer output for the session not yet created. */
2641 session->consumer = consumer_create_output(CONSUMER_DST_LOCAL);
2642 if (session->consumer == NULL) {
2643 ret = LTTNG_ERR_FATAL;
2644 goto consumer_error;
2645 }
2646
2647 if (uris) {
2648 ret = cmd_set_consumer_uri(session, nb_uri, uris);
2649 if (ret != LTTNG_OK) {
2650 goto consumer_error;
2651 }
2652 session->output_traces = 1;
2653 } else {
2654 session->output_traces = 0;
2655 DBG2("Session %s created with no output", session->name);
2656 }
2657
2658 session->consumer->enabled = 1;
2659
2660 return LTTNG_OK;
2661
2662 consumer_error:
2663 session_destroy(session);
2664 session_error:
2665 find_error:
2666 return ret;
2667 }
2668
2669 /*
2670 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2671 */
2672 int cmd_create_session_snapshot(char *name, struct lttng_uri *uris,
2673 size_t nb_uri, lttng_sock_cred *creds)
2674 {
2675 int ret;
2676 struct ltt_session *session;
2677 struct snapshot_output *new_output = NULL;
2678
2679 assert(name);
2680 assert(creds);
2681
2682 /*
2683 * Create session in no output mode with URIs set to NULL. The uris we've
2684 * received are for a default snapshot output if one.
2685 */
2686 ret = cmd_create_session_uri(name, NULL, 0, creds, 0);
2687 if (ret != LTTNG_OK) {
2688 goto error;
2689 }
2690
2691 /* Get the newly created session pointer back. This should NEVER fail. */
2692 session = session_find_by_name(name);
2693 assert(session);
2694
2695 /* Flag session for snapshot mode. */
2696 session->snapshot_mode = 1;
2697
2698 /* Skip snapshot output creation if no URI is given. */
2699 if (nb_uri == 0) {
2700 goto end;
2701 }
2702
2703 new_output = snapshot_output_alloc();
2704 if (!new_output) {
2705 ret = LTTNG_ERR_NOMEM;
2706 goto error_snapshot_alloc;
2707 }
2708
2709 ret = snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE, NULL,
2710 uris, nb_uri, session->consumer, new_output, &session->snapshot);
2711 if (ret < 0) {
2712 if (ret == -ENOMEM) {
2713 ret = LTTNG_ERR_NOMEM;
2714 } else {
2715 ret = LTTNG_ERR_INVALID;
2716 }
2717 goto error_snapshot;
2718 }
2719
2720 rcu_read_lock();
2721 snapshot_add_output(&session->snapshot, new_output);
2722 rcu_read_unlock();
2723
2724 end:
2725 return LTTNG_OK;
2726
2727 error_snapshot:
2728 snapshot_output_destroy(new_output);
2729 error_snapshot_alloc:
2730 session_destroy(session);
2731 error:
2732 return ret;
2733 }
2734
2735 /*
2736 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2737 *
2738 * Called with session lock held.
2739 */
2740 int cmd_destroy_session(struct ltt_session *session, int wpipe)
2741 {
2742 int ret;
2743 struct ltt_ust_session *usess;
2744 struct ltt_kernel_session *ksess;
2745
2746 /* Safety net */
2747 assert(session);
2748
2749 usess = session->ust_session;
2750 ksess = session->kernel_session;
2751
2752 /* Clean kernel session teardown */
2753 kernel_destroy_session(ksess);
2754
2755 /* UST session teardown */
2756 if (usess) {
2757 /* Close any relayd session */
2758 consumer_output_send_destroy_relayd(usess->consumer);
2759
2760 /* Destroy every UST application related to this session. */
2761 ret = ust_app_destroy_trace_all(usess);
2762 if (ret) {
2763 ERR("Error in ust_app_destroy_trace_all");
2764 }
2765
2766 /* Clean up the rest. */
2767 trace_ust_destroy_session(usess);
2768 }
2769
2770 if (session->rotate_count > 0) {
2771 session->rotate_count++;
2772 /*
2773 * The currently active tracing path is now the folder we
2774 * want to rename.
2775 */
2776 snprintf(session->rotation_chunk.current_rotate_path,
2777 PATH_MAX, "%s",
2778 session->rotation_chunk.active_tracing_path);
2779 ret = rename_complete_chunk(session,
2780 session->session_last_stop_ts);
2781 if (ret < 0) {
2782 ERR("Renaming session on destroy");
2783 }
2784 }
2785
2786 /*
2787 * Must notify the kernel thread here to update it's poll set in order to
2788 * remove the channel(s)' fd just destroyed.
2789 */
2790 ret = notify_thread_pipe(wpipe);
2791 if (ret < 0) {
2792 PERROR("write kernel poll pipe");
2793 }
2794
2795 ret = session_destroy(session);
2796
2797 return ret;
2798 }
2799
2800 /*
2801 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2802 */
2803 int cmd_register_consumer(struct ltt_session *session,
2804 enum lttng_domain_type domain, const char *sock_path,
2805 struct consumer_data *cdata)
2806 {
2807 int ret, sock;
2808 struct consumer_socket *socket = NULL;
2809
2810 assert(session);
2811 assert(cdata);
2812 assert(sock_path);
2813
2814 switch (domain) {
2815 case LTTNG_DOMAIN_KERNEL:
2816 {
2817 struct ltt_kernel_session *ksess = session->kernel_session;
2818
2819 assert(ksess);
2820
2821 /* Can't register a consumer if there is already one */
2822 if (ksess->consumer_fds_sent != 0) {
2823 ret = LTTNG_ERR_KERN_CONSUMER_FAIL;
2824 goto error;
2825 }
2826
2827 sock = lttcomm_connect_unix_sock(sock_path);
2828 if (sock < 0) {
2829 ret = LTTNG_ERR_CONNECT_FAIL;
2830 goto error;
2831 }
2832 cdata->cmd_sock = sock;
2833
2834 socket = consumer_allocate_socket(&cdata->cmd_sock);
2835 if (socket == NULL) {
2836 ret = close(sock);
2837 if (ret < 0) {
2838 PERROR("close register consumer");
2839 }
2840 cdata->cmd_sock = -1;
2841 ret = LTTNG_ERR_FATAL;
2842 goto error;
2843 }
2844
2845 socket->lock = zmalloc(sizeof(pthread_mutex_t));
2846 if (socket->lock == NULL) {
2847 PERROR("zmalloc pthread mutex");
2848 ret = LTTNG_ERR_FATAL;
2849 goto error;
2850 }
2851 pthread_mutex_init(socket->lock, NULL);
2852 socket->registered = 1;
2853
2854 rcu_read_lock();
2855 consumer_add_socket(socket, ksess->consumer);
2856 rcu_read_unlock();
2857
2858 pthread_mutex_lock(&cdata->pid_mutex);
2859 cdata->pid = -1;
2860 pthread_mutex_unlock(&cdata->pid_mutex);
2861
2862 break;
2863 }
2864 default:
2865 /* TODO: Userspace tracing */
2866 ret = LTTNG_ERR_UND;
2867 goto error;
2868 }
2869
2870 return LTTNG_OK;
2871
2872 error:
2873 if (socket) {
2874 consumer_destroy_socket(socket);
2875 }
2876 return ret;
2877 }
2878
2879 /*
2880 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2881 */
2882 ssize_t cmd_list_domains(struct ltt_session *session,
2883 struct lttng_domain **domains)
2884 {
2885 int ret, index = 0;
2886 ssize_t nb_dom = 0;
2887 struct agent *agt;
2888 struct lttng_ht_iter iter;
2889
2890 if (session->kernel_session != NULL) {
2891 DBG3("Listing domains found kernel domain");
2892 nb_dom++;
2893 }
2894
2895 if (session->ust_session != NULL) {
2896 DBG3("Listing domains found UST global domain");
2897 nb_dom++;
2898
2899 rcu_read_lock();
2900 cds_lfht_for_each_entry(session->ust_session->agents->ht, &iter.iter,
2901 agt, node.node) {
2902 if (agt->being_used) {
2903 nb_dom++;
2904 }
2905 }
2906 rcu_read_unlock();
2907 }
2908
2909 if (!nb_dom) {
2910 goto end;
2911 }
2912
2913 *domains = zmalloc(nb_dom * sizeof(struct lttng_domain));
2914 if (*domains == NULL) {
2915 ret = LTTNG_ERR_FATAL;
2916 goto error;
2917 }
2918
2919 if (session->kernel_session != NULL) {
2920 (*domains)[index].type = LTTNG_DOMAIN_KERNEL;
2921
2922 /* Kernel session buffer type is always GLOBAL */
2923 (*domains)[index].buf_type = LTTNG_BUFFER_GLOBAL;
2924
2925 index++;
2926 }
2927
2928 if (session->ust_session != NULL) {
2929 (*domains)[index].type = LTTNG_DOMAIN_UST;
2930 (*domains)[index].buf_type = session->ust_session->buffer_type;
2931 index++;
2932
2933 rcu_read_lock();
2934 cds_lfht_for_each_entry(session->ust_session->agents->ht, &iter.iter,
2935 agt, node.node) {
2936 if (agt->being_used) {
2937 (*domains)[index].type = agt->domain;
2938 (*domains)[index].buf_type = session->ust_session->buffer_type;
2939 index++;
2940 }
2941 }
2942 rcu_read_unlock();
2943 }
2944 end:
2945 return nb_dom;
2946
2947 error:
2948 /* Return negative value to differentiate return code */
2949 return -ret;
2950 }
2951
2952
2953 /*
2954 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2955 */
2956 ssize_t cmd_list_channels(enum lttng_domain_type domain,
2957 struct ltt_session *session, struct lttng_channel **channels)
2958 {
2959 ssize_t nb_chan = 0, payload_size = 0, ret;
2960
2961 switch (domain) {
2962 case LTTNG_DOMAIN_KERNEL:
2963 if (session->kernel_session != NULL) {
2964 nb_chan = session->kernel_session->channel_count;
2965 }
2966 DBG3("Number of kernel channels %zd", nb_chan);
2967 if (nb_chan <= 0) {
2968 ret = -LTTNG_ERR_KERN_CHAN_NOT_FOUND;
2969 goto end;
2970 }
2971 break;
2972 case LTTNG_DOMAIN_UST:
2973 if (session->ust_session != NULL) {
2974 rcu_read_lock();
2975 nb_chan = lttng_ht_get_count(
2976 session->ust_session->domain_global.channels);
2977 rcu_read_unlock();
2978 }
2979 DBG3("Number of UST global channels %zd", nb_chan);
2980 if (nb_chan < 0) {
2981 ret = -LTTNG_ERR_UST_CHAN_NOT_FOUND;
2982 goto end;
2983 }
2984 break;
2985 default:
2986 ret = -LTTNG_ERR_UND;
2987 goto end;
2988 }
2989
2990 if (nb_chan > 0) {
2991 const size_t channel_size = sizeof(struct lttng_channel) +
2992 sizeof(struct lttng_channel_extended);
2993 struct lttng_channel_extended *channel_exts;
2994
2995 payload_size = nb_chan * channel_size;
2996 *channels = zmalloc(payload_size);
2997 if (*channels == NULL) {
2998 ret = -LTTNG_ERR_FATAL;
2999 goto end;
3000 }
3001
3002 channel_exts = ((void *) *channels) +
3003 (nb_chan * sizeof(struct lttng_channel));
3004 ret = list_lttng_channels(domain, session, *channels, channel_exts);
3005 if (ret != LTTNG_OK) {
3006 free(*channels);
3007 *channels = NULL;
3008 goto end;
3009 }
3010 } else {
3011 *channels = NULL;
3012 }
3013
3014 ret = payload_size;
3015 end:
3016 return ret;
3017 }
3018
3019 /*
3020 * Command LTTNG_LIST_EVENTS processed by the client thread.
3021 */
3022 ssize_t cmd_list_events(enum lttng_domain_type domain,
3023 struct ltt_session *session, char *channel_name,
3024 struct lttng_event **events, size_t *total_size)
3025 {
3026 int ret = 0;
3027 ssize_t nb_event = 0;
3028
3029 switch (domain) {
3030 case LTTNG_DOMAIN_KERNEL:
3031 if (session->kernel_session != NULL) {
3032 nb_event = list_lttng_kernel_events(channel_name,
3033 session->kernel_session, events,
3034 total_size);
3035 }
3036 break;
3037 case LTTNG_DOMAIN_UST:
3038 {
3039 if (session->ust_session != NULL) {
3040 nb_event = list_lttng_ust_global_events(channel_name,
3041 &session->ust_session->domain_global, events,
3042 total_size);
3043 }
3044 break;
3045 }
3046 case LTTNG_DOMAIN_LOG4J:
3047 case LTTNG_DOMAIN_JUL:
3048 case LTTNG_DOMAIN_PYTHON:
3049 if (session->ust_session) {
3050 struct lttng_ht_iter iter;
3051 struct agent *agt;
3052
3053 rcu_read_lock();
3054 cds_lfht_for_each_entry(session->ust_session->agents->ht,
3055 &iter.iter, agt, node.node) {
3056 if (agt->domain == domain) {
3057 nb_event = list_lttng_agent_events(
3058 agt, events,
3059 total_size);
3060 break;
3061 }
3062 }
3063 rcu_read_unlock();
3064 }
3065 break;
3066 default:
3067 ret = LTTNG_ERR_UND;
3068 goto error;
3069 }
3070
3071 return nb_event;
3072
3073 error:
3074 /* Return negative value to differentiate return code */
3075 return -ret;
3076 }
3077
3078 /*
3079 * Using the session list, filled a lttng_session array to send back to the
3080 * client for session listing.
3081 *
3082 * The session list lock MUST be acquired before calling this function. Use
3083 * session_lock_list() and session_unlock_list().
3084 */
3085 void cmd_list_lttng_sessions(struct lttng_session *sessions, uid_t uid,
3086 gid_t gid)
3087 {
3088 int ret;
3089 unsigned int i = 0;
3090 struct ltt_session *session;
3091 struct ltt_session_list *list = session_get_list();
3092
3093 DBG("Getting all available session for UID %d GID %d",
3094 uid, gid);
3095 /*
3096 * Iterate over session list and append data after the control struct in
3097 * the buffer.
3098 */
3099 cds_list_for_each_entry(session, &list->head, list) {
3100 /*
3101 * Only list the sessions the user can control.
3102 */
3103 if (!session_access_ok(session, uid, gid)) {
3104 continue;
3105 }
3106
3107 struct ltt_kernel_session *ksess = session->kernel_session;
3108 struct ltt_ust_session *usess = session->ust_session;
3109
3110 if (session->consumer->type == CONSUMER_DST_NET ||
3111 (ksess && ksess->consumer->type == CONSUMER_DST_NET) ||
3112 (usess && usess->consumer->type == CONSUMER_DST_NET)) {
3113 ret = build_network_session_path(sessions[i].path,
3114 sizeof(sessions[i].path), session);
3115 } else {
3116 ret = snprintf(sessions[i].path, sizeof(sessions[i].path), "%s",
3117 session->consumer->dst.session_root_path);
3118 }
3119 if (ret < 0) {
3120 PERROR("snprintf session path");
3121 continue;
3122 }
3123
3124 strncpy(sessions[i].name, session->name, NAME_MAX);
3125 sessions[i].name[NAME_MAX - 1] = '\0';
3126 sessions[i].enabled = session->active;
3127 sessions[i].snapshot_mode = session->snapshot_mode;
3128 sessions[i].live_timer_interval = session->live_timer;
3129 i++;
3130 }
3131 }
3132
3133 /*
3134 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
3135 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
3136 */
3137 int cmd_data_pending(struct ltt_session *session)
3138 {
3139 int ret;
3140 struct ltt_kernel_session *ksess = session->kernel_session;
3141 struct ltt_ust_session *usess = session->ust_session;
3142
3143 assert(session);
3144
3145 /* Session MUST be stopped to ask for data availability. */
3146 if (session->active) {
3147 ret = LTTNG_ERR_SESSION_STARTED;
3148 goto error;
3149 } else {
3150 /*
3151 * If stopped, just make sure we've started before else the above call
3152 * will always send that there is data pending.
3153 *
3154 * The consumer assumes that when the data pending command is received,
3155 * the trace has been started before or else no output data is written
3156 * by the streams which is a condition for data pending. So, this is
3157 * *VERY* important that we don't ask the consumer before a start
3158 * trace.
3159 */
3160 if (!session->has_been_started) {
3161 ret = 0;
3162 goto error;
3163 }
3164 }
3165
3166 if (ksess && ksess->consumer) {
3167 ret = consumer_is_data_pending(ksess->id, ksess->consumer);
3168 if (ret == 1) {
3169 /* Data is still being extracted for the kernel. */
3170 goto error;
3171 }
3172 }
3173
3174 if (usess && usess->consumer) {
3175 ret = consumer_is_data_pending(usess->id, usess->consumer);
3176 if (ret == 1) {
3177 /* Data is still being extracted for the kernel. */
3178 goto error;
3179 }
3180 }
3181
3182 /* Data is ready to be read by a viewer */
3183 ret = 0;
3184
3185 error:
3186 return ret;
3187 }
3188
3189 /*
3190 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
3191 *
3192 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3193 */
3194 int cmd_snapshot_add_output(struct ltt_session *session,
3195 struct lttng_snapshot_output *output, uint32_t *id)
3196 {
3197 int ret;
3198 struct snapshot_output *new_output;
3199
3200 assert(session);
3201 assert(output);
3202
3203 DBG("Cmd snapshot add output for session %s", session->name);
3204
3205 /*
3206 * Can't create an output if the session is not set in no-output mode.
3207 */
3208 if (session->output_traces) {
3209 ret = LTTNG_ERR_NOT_SNAPSHOT_SESSION;
3210 goto error;
3211 }
3212
3213 /* Only one output is allowed until we have the "tee" feature. */
3214 if (session->snapshot.nb_output == 1) {
3215 ret = LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST;
3216 goto error;
3217 }
3218
3219 new_output = snapshot_output_alloc();
3220 if (!new_output) {
3221 ret = LTTNG_ERR_NOMEM;
3222 goto error;
3223 }
3224
3225 ret = snapshot_output_init(output->max_size, output->name,
3226 output->ctrl_url, output->data_url, session->consumer, new_output,
3227 &session->snapshot);
3228 if (ret < 0) {
3229 if (ret == -ENOMEM) {
3230 ret = LTTNG_ERR_NOMEM;
3231 } else {
3232 ret = LTTNG_ERR_INVALID;
3233 }
3234 goto free_error;
3235 }
3236
3237 rcu_read_lock();
3238 snapshot_add_output(&session->snapshot, new_output);
3239 if (id) {
3240 *id = new_output->id;
3241 }
3242 rcu_read_unlock();
3243
3244 return LTTNG_OK;
3245
3246 free_error:
3247 snapshot_output_destroy(new_output);
3248 error:
3249 return ret;
3250 }
3251
3252 /*
3253 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
3254 *
3255 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3256 */
3257 int cmd_snapshot_del_output(struct ltt_session *session,
3258 struct lttng_snapshot_output *output)
3259 {
3260 int ret;
3261 struct snapshot_output *sout = NULL;
3262
3263 assert(session);
3264 assert(output);
3265
3266 rcu_read_lock();
3267
3268 /*
3269 * Permission denied to create an output if the session is not
3270 * set in no output mode.
3271 */
3272 if (session->output_traces) {
3273 ret = LTTNG_ERR_NOT_SNAPSHOT_SESSION;
3274 goto error;
3275 }
3276
3277 if (output->id) {
3278 DBG("Cmd snapshot del output id %" PRIu32 " for session %s", output->id,
3279 session->name);
3280 sout = snapshot_find_output_by_id(output->id, &session->snapshot);
3281 } else if (*output->name != '\0') {
3282 DBG("Cmd snapshot del output name %s for session %s", output->name,
3283 session->name);
3284 sout = snapshot_find_output_by_name(output->name, &session->snapshot);
3285 }
3286 if (!sout) {
3287 ret = LTTNG_ERR_INVALID;
3288 goto error;
3289 }
3290
3291 snapshot_delete_output(&session->snapshot, sout);
3292 snapshot_output_destroy(sout);
3293 ret = LTTNG_OK;
3294
3295 error:
3296 rcu_read_unlock();
3297 return ret;
3298 }
3299
3300 /*
3301 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
3302 *
3303 * If no output is available, outputs is untouched and 0 is returned.
3304 *
3305 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
3306 */
3307 ssize_t cmd_snapshot_list_outputs(struct ltt_session *session,
3308 struct lttng_snapshot_output **outputs)
3309 {
3310 int ret, idx = 0;
3311 struct lttng_snapshot_output *list = NULL;
3312 struct lttng_ht_iter iter;
3313 struct snapshot_output *output;
3314
3315 assert(session);
3316 assert(outputs);
3317
3318 DBG("Cmd snapshot list outputs for session %s", session->name);
3319
3320 /*
3321 * Permission denied to create an output if the session is not
3322 * set in no output mode.
3323 */
3324 if (session->output_traces) {
3325 ret = -LTTNG_ERR_NOT_SNAPSHOT_SESSION;
3326 goto end;
3327 }
3328
3329 if (session->snapshot.nb_output == 0) {
3330 ret = 0;
3331 goto end;
3332 }
3333
3334 list = zmalloc(session->snapshot.nb_output * sizeof(*list));
3335 if (!list) {
3336 ret = -LTTNG_ERR_NOMEM;
3337 goto end;
3338 }
3339
3340 /* Copy list from session to the new list object. */
3341 rcu_read_lock();
3342 cds_lfht_for_each_entry(session->snapshot.output_ht->ht, &iter.iter,
3343 output, node.node) {
3344 assert(output->consumer);
3345 list[idx].id = output->id;
3346 list[idx].max_size = output->max_size;
3347 if (lttng_strncpy(list[idx].name, output->name,
3348 sizeof(list[idx].name))) {
3349 ret = -LTTNG_ERR_INVALID;
3350 goto error;
3351 }
3352 if (output->consumer->type == CONSUMER_DST_LOCAL) {
3353 if (lttng_strncpy(list[idx].ctrl_url,
3354 output->consumer->dst.session_root_path,
3355 sizeof(list[idx].ctrl_url))) {
3356 ret = -LTTNG_ERR_INVALID;
3357 goto error;
3358 }
3359 } else {
3360 /* Control URI. */
3361 ret = uri_to_str_url(&output->consumer->dst.net.control,
3362 list[idx].ctrl_url, sizeof(list[idx].ctrl_url));
3363 if (ret < 0) {
3364 ret = -LTTNG_ERR_NOMEM;
3365 goto error;
3366 }
3367
3368 /* Data URI. */
3369 ret = uri_to_str_url(&output->consumer->dst.net.data,
3370 list[idx].data_url, sizeof(list[idx].data_url));
3371 if (ret < 0) {
3372 ret = -LTTNG_ERR_NOMEM;
3373 goto error;
3374 }
3375 }
3376 idx++;
3377 }
3378
3379 *outputs = list;
3380 list = NULL;
3381 ret = session->snapshot.nb_output;
3382 error:
3383 rcu_read_unlock();
3384 free(list);
3385 end:
3386 return ret;
3387 }
3388
3389 /*
3390 * Check if we can regenerate the metadata for this session.
3391 * Only kernel, UST per-uid and non-live sessions are supported.
3392 *
3393 * Return 0 if the metadata can be generated, a LTTNG_ERR code otherwise.
3394 */
3395 static
3396 int check_regenerate_metadata_support(struct ltt_session *session)
3397 {
3398 int ret;
3399
3400 assert(session);
3401
3402 if (session->live_timer != 0) {
3403 ret = LTTNG_ERR_LIVE_SESSION;
3404 goto end;
3405 }
3406 if (!session->active) {
3407 ret = LTTNG_ERR_SESSION_NOT_STARTED;
3408 goto end;
3409 }
3410 if (session->ust_session) {
3411 switch (session->ust_session->buffer_type) {
3412 case LTTNG_BUFFER_PER_UID:
3413 break;
3414 case LTTNG_BUFFER_PER_PID:
3415 ret = LTTNG_ERR_PER_PID_SESSION;
3416 goto end;
3417 default:
3418 assert(0);
3419 ret = LTTNG_ERR_UNK;
3420 goto end;
3421 }
3422 }
3423 if (session->consumer->type == CONSUMER_DST_NET &&
3424 session->consumer->relay_minor_version < 8) {
3425 ret = LTTNG_ERR_RELAYD_VERSION_FAIL;
3426 goto end;
3427 }
3428 ret = 0;
3429
3430 end:
3431 return ret;
3432 }
3433
3434 static
3435 int clear_metadata_file(int fd)
3436 {
3437 int ret;
3438
3439 ret = lseek(fd, 0, SEEK_SET);
3440 if (ret < 0) {
3441 PERROR("lseek");
3442 goto end;
3443 }
3444
3445 ret = ftruncate(fd, 0);
3446 if (ret < 0) {
3447 PERROR("ftruncate");
3448 goto end;
3449 }
3450
3451 end:
3452 return ret;
3453 }
3454
3455 static
3456 int ust_regenerate_metadata(struct ltt_ust_session *usess)
3457 {
3458 int ret = 0;
3459 struct buffer_reg_uid *uid_reg = NULL;
3460 struct buffer_reg_session *session_reg = NULL;
3461
3462 rcu_read_lock();
3463 cds_list_for_each_entry(uid_reg, &usess->buffer_reg_uid_list, lnode) {
3464 struct ust_registry_session *registry;
3465 struct ust_registry_channel *chan;
3466 struct lttng_ht_iter iter_chan;
3467
3468 session_reg = uid_reg->registry;
3469 registry = session_reg->reg.ust;
3470
3471 pthread_mutex_lock(&registry->lock);
3472 registry->metadata_len_sent = 0;
3473 memset(registry->metadata, 0, registry->metadata_alloc_len);
3474 registry->metadata_len = 0;
3475 registry->metadata_version++;
3476 if (registry->metadata_fd > 0) {
3477 /* Clear the metadata file's content. */
3478 ret = clear_metadata_file(registry->metadata_fd);
3479 if (ret) {
3480 pthread_mutex_unlock(&registry->lock);
3481 goto end;
3482 }
3483 }
3484
3485 ret = ust_metadata_session_statedump(registry, NULL,
3486 registry->major, registry->minor);
3487 if (ret) {
3488 pthread_mutex_unlock(&registry->lock);
3489 ERR("Failed to generate session metadata (err = %d)",
3490 ret);
3491 goto end;
3492 }
3493 cds_lfht_for_each_entry(registry->channels->ht, &iter_chan.iter,
3494 chan, node.node) {
3495 struct ust_registry_event *event;
3496 struct lttng_ht_iter iter_event;
3497
3498 ret = ust_metadata_channel_statedump(registry, chan);
3499 if (ret) {
3500 pthread_mutex_unlock(&registry->lock);
3501 ERR("Failed to generate channel metadata "
3502 "(err = %d)", ret);
3503 goto end;
3504 }
3505 cds_lfht_for_each_entry(chan->ht->ht, &iter_event.iter,
3506 event, node.node) {
3507 ret = ust_metadata_event_statedump(registry,
3508 chan, event);
3509 if (ret) {
3510 pthread_mutex_unlock(&registry->lock);
3511 ERR("Failed to generate event metadata "
3512 "(err = %d)", ret);
3513 goto end;
3514 }
3515 }
3516 }
3517 pthread_mutex_unlock(&registry->lock);
3518 }
3519
3520 end:
3521 rcu_read_unlock();
3522 return ret;
3523 }
3524
3525 /*
3526 * Command LTTNG_REGENERATE_METADATA from the lttng-ctl library.
3527 *
3528 * Ask the consumer to truncate the existing metadata file(s) and
3529 * then regenerate the metadata. Live and per-pid sessions are not
3530 * supported and return an error.
3531 *
3532 * Return 0 on success or else a LTTNG_ERR code.
3533 */
3534 int cmd_regenerate_metadata(struct ltt_session *session)
3535 {
3536 int ret;
3537
3538 assert(session);
3539
3540 ret = check_regenerate_metadata_support(session);
3541 if (ret) {
3542 goto end;
3543 }
3544
3545 if (session->kernel_session) {
3546 ret = kernctl_session_regenerate_metadata(
3547 session->kernel_session->fd);
3548 if (ret < 0) {
3549 ERR("Failed to regenerate the kernel metadata");
3550 goto end;
3551 }
3552 }
3553
3554 if (session->ust_session) {
3555 ret = ust_regenerate_metadata(session->ust_session);
3556 if (ret < 0) {
3557 ERR("Failed to regenerate the UST metadata");
3558 goto end;
3559 }
3560 }
3561 DBG("Cmd metadata regenerate for session %s", session->name);
3562 ret = LTTNG_OK;
3563
3564 end:
3565 return ret;
3566 }
3567
3568 /*
3569 * Command LTTNG_REGENERATE_STATEDUMP from the lttng-ctl library.
3570 *
3571 * Ask the tracer to regenerate a new statedump.
3572 *
3573 * Return 0 on success or else a LTTNG_ERR code.
3574 */
3575 int cmd_regenerate_statedump(struct ltt_session *session)
3576 {
3577 int ret;
3578
3579 assert(session);
3580
3581 if (!session->active) {
3582 ret = LTTNG_ERR_SESSION_NOT_STARTED;
3583 goto end;
3584 }
3585
3586 if (session->kernel_session) {
3587 ret = kernctl_session_regenerate_statedump(
3588 session->kernel_session->fd);
3589 /*
3590 * Currently, the statedump in kernel can only fail if out
3591 * of memory.
3592 */
3593 if (ret < 0) {
3594 if (ret == -ENOMEM) {
3595 ret = LTTNG_ERR_REGEN_STATEDUMP_NOMEM;
3596 } else {
3597 ret = LTTNG_ERR_REGEN_STATEDUMP_FAIL;
3598 }
3599 ERR("Failed to regenerate the kernel statedump");
3600 goto end;
3601 }
3602 }
3603
3604 if (session->ust_session) {
3605 ret = ust_app_regenerate_statedump_all(session->ust_session);
3606 /*
3607 * Currently, the statedump in UST always returns 0.
3608 */
3609 if (ret < 0) {
3610 ret = LTTNG_ERR_REGEN_STATEDUMP_FAIL;
3611 ERR("Failed to regenerate the UST statedump");
3612 goto end;
3613 }
3614 }
3615 DBG("Cmd regenerate statedump for session %s", session->name);
3616 ret = LTTNG_OK;
3617
3618 end:
3619 return ret;
3620 }
3621
3622 int cmd_register_trigger(struct command_ctx *cmd_ctx, int sock,
3623 struct notification_thread_handle *notification_thread)
3624 {
3625 int ret;
3626 size_t trigger_len;
3627 ssize_t sock_recv_len;
3628 struct lttng_trigger *trigger = NULL;
3629 struct lttng_buffer_view view;
3630 struct lttng_dynamic_buffer trigger_buffer;
3631
3632 lttng_dynamic_buffer_init(&trigger_buffer);
3633 trigger_len = (size_t) cmd_ctx->lsm->u.trigger.length;
3634 ret = lttng_dynamic_buffer_set_size(&trigger_buffer, trigger_len);
3635 if (ret) {
3636 ret = LTTNG_ERR_NOMEM;
3637 goto end;
3638 }
3639
3640 sock_recv_len = lttcomm_recv_unix_sock(sock, trigger_buffer.data,
3641 trigger_len);
3642 if (sock_recv_len < 0 || sock_recv_len != trigger_len) {
3643 ERR("Failed to receive \"register trigger\" command payload");
3644 /* TODO: should this be a new error enum ? */
3645 ret = LTTNG_ERR_INVALID_TRIGGER;
3646 goto end;
3647 }
3648
3649 view = lttng_buffer_view_from_dynamic_buffer(&trigger_buffer, 0, -1);
3650 if (lttng_trigger_create_from_buffer(&view, &trigger) !=
3651 trigger_len) {
3652 ERR("Invalid trigger payload received in \"register trigger\" command");
3653 ret = LTTNG_ERR_INVALID_TRIGGER;
3654 goto end;
3655 }
3656
3657 ret = notification_thread_command_register_trigger(notification_thread,
3658 trigger);
3659 /* Ownership of trigger was transferred. */
3660 trigger = NULL;
3661 end:
3662 lttng_trigger_destroy(trigger);
3663 lttng_dynamic_buffer_reset(&trigger_buffer);
3664 return ret;
3665 }
3666
3667 int cmd_unregister_trigger(struct command_ctx *cmd_ctx, int sock,
3668 struct notification_thread_handle *notification_thread)
3669 {
3670 int ret;
3671 size_t trigger_len;
3672 ssize_t sock_recv_len;
3673 struct lttng_trigger *trigger = NULL;
3674 struct lttng_buffer_view view;
3675 struct lttng_dynamic_buffer trigger_buffer;
3676
3677 lttng_dynamic_buffer_init(&trigger_buffer);
3678 trigger_len = (size_t) cmd_ctx->lsm->u.trigger.length;
3679 ret = lttng_dynamic_buffer_set_size(&trigger_buffer, trigger_len);
3680 if (ret) {
3681 ret = LTTNG_ERR_NOMEM;
3682 goto end;
3683 }
3684
3685 sock_recv_len = lttcomm_recv_unix_sock(sock, trigger_buffer.data,
3686 trigger_len);
3687 if (sock_recv_len < 0 || sock_recv_len != trigger_len) {
3688 ERR("Failed to receive \"unregister trigger\" command payload");
3689 /* TODO: should this be a new error enum ? */
3690 ret = LTTNG_ERR_INVALID_TRIGGER;
3691 goto end;
3692 }
3693
3694 view = lttng_buffer_view_from_dynamic_buffer(&trigger_buffer, 0, -1);
3695 if (lttng_trigger_create_from_buffer(&view, &trigger) !=
3696 trigger_len) {
3697 ERR("Invalid trigger payload received in \"unregister trigger\" command");
3698 ret = LTTNG_ERR_INVALID_TRIGGER;
3699 goto end;
3700 }
3701
3702 ret = notification_thread_command_unregister_trigger(notification_thread,
3703 trigger);
3704 end:
3705 lttng_trigger_destroy(trigger);
3706 lttng_dynamic_buffer_reset(&trigger_buffer);
3707 return ret;
3708 }
3709
3710 /*
3711 * Send relayd sockets from snapshot output to consumer. Ignore request if the
3712 * snapshot output is *not* set with a remote destination.
3713 *
3714 * Return 0 on success or a LTTNG_ERR code.
3715 */
3716 static int set_relayd_for_snapshot(struct consumer_output *consumer,
3717 struct snapshot_output *snap_output, struct ltt_session *session)
3718 {
3719 int ret = LTTNG_OK;
3720 struct lttng_ht_iter iter;
3721 struct consumer_socket *socket;
3722
3723 assert(consumer);
3724 assert(snap_output);
3725 assert(session);
3726
3727 DBG2("Set relayd object from snapshot output");
3728
3729 /* Ignore if snapshot consumer output is not network. */
3730 if (snap_output->consumer->type != CONSUMER_DST_NET) {
3731 goto error;
3732 }
3733
3734 /*
3735 * For each consumer socket, create and send the relayd object of the
3736 * snapshot output.
3737 */
3738 rcu_read_lock();
3739 cds_lfht_for_each_entry(snap_output->consumer->socks->ht, &iter.iter,
3740 socket, node.node) {
3741 ret = send_consumer_relayd_sockets(0, session->id,
3742 snap_output->consumer, socket,
3743 session->name, session->hostname,
3744 session->live_timer);
3745 if (ret != LTTNG_OK) {
3746 rcu_read_unlock();
3747 goto error;
3748 }
3749 }
3750 rcu_read_unlock();
3751
3752 error:
3753 return ret;
3754 }
3755
3756 /*
3757 * Record a kernel snapshot.
3758 *
3759 * Return LTTNG_OK on success or a LTTNG_ERR code.
3760 */
3761 static int record_kernel_snapshot(struct ltt_kernel_session *ksess,
3762 struct snapshot_output *output, struct ltt_session *session,
3763 int wait, uint64_t nb_packets_per_stream)
3764 {
3765 int ret;
3766
3767 assert(ksess);
3768 assert(output);
3769 assert(session);
3770
3771
3772 /*
3773 * Copy kernel session sockets so we can communicate with the right
3774 * consumer for the snapshot record command.
3775 */
3776 ret = consumer_copy_sockets(output->consumer, ksess->consumer);
3777 if (ret < 0) {
3778 ret = LTTNG_ERR_NOMEM;
3779 goto error;
3780 }
3781
3782 ret = set_relayd_for_snapshot(ksess->consumer, output, session);
3783 if (ret != LTTNG_OK) {
3784 goto error_snapshot;
3785 }
3786
3787 ret = kernel_snapshot_record(ksess, output, wait, nb_packets_per_stream);
3788 if (ret != LTTNG_OK) {
3789 goto error_snapshot;
3790 }
3791
3792 ret = LTTNG_OK;
3793 goto end;
3794
3795 error_snapshot:
3796 /* Clean up copied sockets so this output can use some other later on. */
3797 consumer_destroy_output_sockets(output->consumer);
3798 error:
3799 end:
3800 return ret;
3801 }
3802
3803 /*
3804 * Record a UST snapshot.
3805 *
3806 * Return 0 on success or a LTTNG_ERR error code.
3807 */
3808 static int record_ust_snapshot(struct ltt_ust_session *usess,
3809 struct snapshot_output *output, struct ltt_session *session,
3810 int wait, uint64_t nb_packets_per_stream)
3811 {
3812 int ret;
3813
3814 assert(usess);
3815 assert(output);
3816 assert(session);
3817
3818 /*
3819 * Copy UST session sockets so we can communicate with the right
3820 * consumer for the snapshot record command.
3821 */
3822 ret = consumer_copy_sockets(output->consumer, usess->consumer);
3823 if (ret < 0) {
3824 ret = LTTNG_ERR_NOMEM;
3825 goto error;
3826 }
3827
3828 ret = set_relayd_for_snapshot(usess->consumer, output, session);
3829 if (ret != LTTNG_OK) {
3830 goto error_snapshot;
3831 }
3832
3833 ret = ust_app_snapshot_record(usess, output, wait, nb_packets_per_stream);
3834 if (ret < 0) {
3835 switch (-ret) {
3836 case EINVAL:
3837 ret = LTTNG_ERR_INVALID;
3838 break;
3839 default:
3840 ret = LTTNG_ERR_SNAPSHOT_FAIL;
3841 break;
3842 }
3843 goto error_snapshot;
3844 }
3845
3846 ret = LTTNG_OK;
3847
3848 error_snapshot:
3849 /* Clean up copied sockets so this output can use some other later on. */
3850 consumer_destroy_output_sockets(output->consumer);
3851 error:
3852 return ret;
3853 }
3854
3855 static
3856 uint64_t get_session_size_one_more_packet_per_stream(struct ltt_session *session,
3857 uint64_t cur_nr_packets)
3858 {
3859 uint64_t tot_size = 0;
3860
3861 if (session->kernel_session) {
3862 struct ltt_kernel_channel *chan;
3863 struct ltt_kernel_session *ksess = session->kernel_session;
3864
3865 cds_list_for_each_entry(chan, &ksess->channel_list.head, list) {
3866 if (cur_nr_packets >= chan->channel->attr.num_subbuf) {
3867 /*
3868 * Don't take channel into account if we
3869 * already grab all its packets.
3870 */
3871 continue;
3872 }
3873 tot_size += chan->channel->attr.subbuf_size
3874 * chan->stream_count;
3875 }
3876 }
3877
3878 if (session->ust_session) {
3879 struct ltt_ust_session *usess = session->ust_session;
3880
3881 tot_size += ust_app_get_size_one_more_packet_per_stream(usess,
3882 cur_nr_packets);
3883 }
3884
3885 return tot_size;
3886 }
3887
3888 /*
3889 * Calculate the number of packets we can grab from each stream that
3890 * fits within the overall snapshot max size.
3891 *
3892 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
3893 * the number of packets per stream.
3894 *
3895 * TODO: this approach is not perfect: we consider the worse case
3896 * (packet filling the sub-buffers) as an upper bound, but we could do
3897 * better if we do this calculation while we actually grab the packet
3898 * content: we would know how much padding we don't actually store into
3899 * the file.
3900 *
3901 * This algorithm is currently bounded by the number of packets per
3902 * stream.
3903 *
3904 * Since we call this algorithm before actually grabbing the data, it's
3905 * an approximation: for instance, applications could appear/disappear
3906 * in between this call and actually grabbing data.
3907 */
3908 static
3909 int64_t get_session_nb_packets_per_stream(struct ltt_session *session, uint64_t max_size)
3910 {
3911 int64_t size_left;
3912 uint64_t cur_nb_packets = 0;
3913
3914 if (!max_size) {
3915 return 0; /* Infinite */
3916 }
3917
3918 size_left = max_size;
3919 for (;;) {
3920 uint64_t one_more_packet_tot_size;
3921
3922 one_more_packet_tot_size = get_session_size_one_more_packet_per_stream(session,
3923 cur_nb_packets);
3924 if (!one_more_packet_tot_size) {
3925 /* We are already grabbing all packets. */
3926 break;
3927 }
3928 size_left -= one_more_packet_tot_size;
3929 if (size_left < 0) {
3930 break;
3931 }
3932 cur_nb_packets++;
3933 }
3934 if (!cur_nb_packets) {
3935 /* Not enough room to grab one packet of each stream, error. */
3936 return -1;
3937 }
3938 return cur_nb_packets;
3939 }
3940
3941 /*
3942 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3943 *
3944 * The wait parameter is ignored so this call always wait for the snapshot to
3945 * complete before returning.
3946 *
3947 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3948 */
3949 int cmd_snapshot_record(struct ltt_session *session,
3950 struct lttng_snapshot_output *output, int wait)
3951 {
3952 int ret = LTTNG_OK;
3953 unsigned int use_tmp_output = 0;
3954 struct snapshot_output tmp_output;
3955 unsigned int snapshot_success = 0;
3956 char datetime[16];
3957
3958 assert(session);
3959 assert(output);
3960
3961 DBG("Cmd snapshot record for session %s", session->name);
3962
3963 /* Get the datetime for the snapshot output directory. */
3964 ret = utils_get_current_time_str("%Y%m%d-%H%M%S", datetime,
3965 sizeof(datetime));
3966 if (!ret) {
3967 ret = LTTNG_ERR_INVALID;
3968 goto error;
3969 }
3970
3971 /*
3972 * Permission denied to create an output if the session is not
3973 * set in no output mode.
3974 */
3975 if (session->output_traces) {
3976 ret = LTTNG_ERR_NOT_SNAPSHOT_SESSION;
3977 goto error;
3978 }
3979
3980 /* The session needs to be started at least once. */
3981 if (!session->has_been_started) {
3982 ret = LTTNG_ERR_START_SESSION_ONCE;
3983 goto error;
3984 }
3985
3986 /* Use temporary output for the session. */
3987 if (*output->ctrl_url != '\0') {
3988 ret = snapshot_output_init(output->max_size, output->name,
3989 output->ctrl_url, output->data_url, session->consumer,
3990 &tmp_output, NULL);
3991 if (ret < 0) {
3992 if (ret == -ENOMEM) {
3993 ret = LTTNG_ERR_NOMEM;
3994 } else {
3995 ret = LTTNG_ERR_INVALID;
3996 }
3997 goto error;
3998 }
3999 /* Use the global session count for the temporary snapshot. */
4000 tmp_output.nb_snapshot = session->snapshot.nb_snapshot;
4001
4002 /* Use the global datetime */
4003 memcpy(tmp_output.datetime, datetime, sizeof(datetime));
4004 use_tmp_output = 1;
4005 }
4006
4007 if (use_tmp_output) {
4008 int64_t nb_packets_per_stream;
4009
4010 nb_packets_per_stream = get_session_nb_packets_per_stream(session,
4011 tmp_output.max_size);
4012 if (nb_packets_per_stream < 0) {
4013 ret = LTTNG_ERR_MAX_SIZE_INVALID;
4014 goto error;
4015 }
4016
4017 if (session->kernel_session) {
4018 ret = record_kernel_snapshot(session->kernel_session,
4019 &tmp_output, session,
4020 wait, nb_packets_per_stream);
4021 if (ret != LTTNG_OK) {
4022 goto error;
4023 }
4024 }
4025
4026 if (session->ust_session) {
4027 ret = record_ust_snapshot(session->ust_session,
4028 &tmp_output, session,
4029 wait, nb_packets_per_stream);
4030 if (ret != LTTNG_OK) {
4031 goto error;
4032 }
4033 }
4034
4035 snapshot_success = 1;
4036 } else {
4037 struct snapshot_output *sout;
4038 struct lttng_ht_iter iter;
4039
4040 rcu_read_lock();
4041 cds_lfht_for_each_entry(session->snapshot.output_ht->ht,
4042 &iter.iter, sout, node.node) {
4043 int64_t nb_packets_per_stream;
4044
4045 /*
4046 * Make a local copy of the output and assign the possible
4047 * temporary value given by the caller.
4048 */
4049 memset(&tmp_output, 0, sizeof(tmp_output));
4050 memcpy(&tmp_output, sout, sizeof(tmp_output));
4051
4052 if (output->max_size != (uint64_t) -1ULL) {
4053 tmp_output.max_size = output->max_size;
4054 }
4055
4056 nb_packets_per_stream = get_session_nb_packets_per_stream(session,
4057 tmp_output.max_size);
4058 if (nb_packets_per_stream < 0) {
4059 ret = LTTNG_ERR_MAX_SIZE_INVALID;
4060 rcu_read_unlock();
4061 goto error;
4062 }
4063
4064 /* Use temporary name. */
4065 if (*output->name != '\0') {
4066 if (lttng_strncpy(tmp_output.name, output->name,
4067 sizeof(tmp_output.name))) {
4068 ret = LTTNG_ERR_INVALID;
4069 rcu_read_unlock();
4070 goto error;
4071 }
4072 }
4073
4074 tmp_output.nb_snapshot = session->snapshot.nb_snapshot;
4075 memcpy(tmp_output.datetime, datetime, sizeof(datetime));
4076
4077 if (session->kernel_session) {
4078 ret = record_kernel_snapshot(session->kernel_session,
4079 &tmp_output, session,
4080 wait, nb_packets_per_stream);
4081 if (ret != LTTNG_OK) {
4082 rcu_read_unlock();
4083 goto error;
4084 }
4085 }
4086
4087 if (session->ust_session) {
4088 ret = record_ust_snapshot(session->ust_session,
4089 &tmp_output, session,
4090 wait, nb_packets_per_stream);
4091 if (ret != LTTNG_OK) {
4092 rcu_read_unlock();
4093 goto error;
4094 }
4095 }
4096 snapshot_success = 1;
4097 }
4098 rcu_read_unlock();
4099 }
4100
4101 if (snapshot_success) {
4102 session->snapshot.nb_snapshot++;
4103 } else {
4104 ret = LTTNG_ERR_SNAPSHOT_FAIL;
4105 }
4106
4107 error:
4108 return ret;
4109 }
4110
4111 /*
4112 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
4113 */
4114 int cmd_set_session_shm_path(struct ltt_session *session,
4115 const char *shm_path)
4116 {
4117 /* Safety net */
4118 assert(session);
4119
4120 /*
4121 * Can only set shm path before session is started.
4122 */
4123 if (session->has_been_started) {
4124 return LTTNG_ERR_SESSION_STARTED;
4125 }
4126
4127 strncpy(session->shm_path, shm_path,
4128 sizeof(session->shm_path));
4129 session->shm_path[sizeof(session->shm_path) - 1] = '\0';
4130
4131 return 0;
4132 }
4133
4134 static
4135 int rename_first_chunk(struct consumer_output *consumer, char *datetime)
4136 {
4137 int ret;
4138 char *tmppath = NULL, *tmppath2 = NULL;
4139
4140 tmppath = zmalloc(PATH_MAX * sizeof(char));
4141 if (!tmppath) {
4142 ret = -LTTNG_ERR_NOMEM;
4143 goto error;
4144 }
4145 tmppath2 = zmalloc(PATH_MAX * sizeof(char));
4146 if (!tmppath2) {
4147 ret = -LTTNG_ERR_NOMEM;
4148 goto error;
4149 }
4150
4151 /* Current domain path: <session>/kernel */
4152 snprintf(tmppath, PATH_MAX, "%s/%s",
4153 consumer->dst.session_root_path, consumer->subdir);
4154 /* New domain path: <session>/<start-date>-/kernel */
4155 snprintf(tmppath2, PATH_MAX, "%s/%s-/%s",
4156 consumer->dst.session_root_path, datetime,
4157 consumer->subdir);
4158 /*
4159 * Move the per-domain folder inside the first rotation
4160 * folder.
4161 */
4162 ret = rename(tmppath, tmppath2);
4163 if (ret < 0) {
4164 PERROR("Rename first trace directory");
4165 ret = -LTTNG_ERR_ROTATE_NO_DATA;
4166 goto error;
4167 }
4168
4169 ret = 0;
4170
4171 error:
4172 free(tmppath);
4173 free(tmppath2);
4174
4175 return ret;
4176 }
4177
4178 /*
4179 * Command LTTNG_ROTATE_SESSION from the lttng-ctl library.
4180 *
4181 * Ask the consumer to rotate the session output directory.
4182 *
4183 * Return 0 on success or else a LTTNG_ERR code.
4184 */
4185 int cmd_rotate_session(struct ltt_session *session,
4186 struct lttng_rotate_session_return **rotate_return)
4187 {
4188 int ret;
4189 struct tm *timeinfo;
4190 char datetime[16];
4191 time_t now;
4192
4193 assert(session);
4194
4195 *rotate_return = zmalloc(sizeof(struct lttng_rotate_session_return));
4196 if (!*rotate_return) {
4197 ret = -ENOMEM;
4198 goto end;
4199 }
4200
4201 if (session->live_timer || session->snapshot_mode ||
4202 !session->output_traces) {
4203 ret = -LTTNG_ERR_ROTATE_NOT_AVAILABLE;
4204 goto error;
4205 }
4206
4207 if (session->rotate_pending) {
4208 ret = -LTTNG_ERR_ROTATE_PENDING;
4209 goto error;
4210 }
4211
4212 /* Special case for the first rotation. */
4213 if (session->rotate_count == 0) {
4214 timeinfo = localtime(&session->session_start_ts);
4215 strftime(datetime, sizeof(datetime), "%Y%m%d-%H%M%S", timeinfo);
4216 if (session->kernel_session) {
4217 snprintf(session->rotation_chunk.current_rotate_path,
4218 PATH_MAX, "%s/%s-",
4219 session->kernel_session->consumer->dst.session_root_path,
4220 datetime);
4221 } else if (session->ust_session) {
4222 snprintf(session->rotation_chunk.current_rotate_path,
4223 PATH_MAX, "%s/%s-",
4224 session->ust_session->consumer->dst.session_root_path,
4225 datetime);
4226 } else {
4227 assert(0);
4228 }
4229
4230 /*
4231 * Create the first rotation folder to move the existing
4232 * kernel/ust folders into.
4233 */
4234 ret = run_as_mkdir_recursive(session->rotation_chunk.current_rotate_path,
4235 S_IRWXU | S_IRWXG, session->uid, session->gid);
4236 if (ret < 0) {
4237 if (errno != EEXIST) {
4238 ERR("Trace directory creation error");
4239 ret = -LTTNG_ERR_ROTATE_NOT_AVAILABLE;
4240 goto error;
4241 }
4242 }
4243 if (session->kernel_session) {
4244 ret = rename_first_chunk(session->kernel_session->consumer,
4245 datetime);
4246 if (ret < 0) {
4247 goto error;
4248 }
4249 }
4250 if (session->ust_session) {
4251 ret = rename_first_chunk(session->ust_session->consumer,
4252 datetime);
4253 if (ret < 0) {
4254 goto error;
4255 }
4256 }
4257 } else {
4258 /*
4259 * The currently active tracing path is now the folder we
4260 * want to rotate.
4261 */
4262 snprintf(session->rotation_chunk.current_rotate_path,
4263 PATH_MAX, "%s",
4264 session->rotation_chunk.active_tracing_path);
4265 }
4266
4267 session->rotate_count++;
4268 session->rotate_pending = 1;
4269
4270 /*
4271 * Create the path name for the next chunk.
4272 */
4273 now = time(NULL);
4274 if (now == (time_t) -1) {
4275 ret = -LTTNG_ERR_ROTATE_NOT_AVAILABLE;
4276 goto error;
4277 }
4278
4279 timeinfo = localtime(&now);
4280 strftime(datetime, sizeof(datetime), "%Y%m%d-%H%M%S", timeinfo);
4281 if (session->kernel_session) {
4282 /* The active path for the next rotation/destroy. */
4283 snprintf(session->rotation_chunk.active_tracing_path,
4284 PATH_MAX, "%s/%s-",
4285 session->kernel_session->consumer->dst.session_root_path,
4286 datetime);
4287 /* The sub-directory for the consumer. */
4288 snprintf(session->kernel_session->consumer->chunk_path,
4289 PATH_MAX, "/%s-/%s/", datetime,
4290 session->kernel_session->consumer->subdir);
4291 ret = kernel_rotate_session(session);
4292 if (ret != LTTNG_OK) {
4293 goto error;
4294 }
4295 }
4296 if (session->ust_session) {
4297 snprintf(session->rotation_chunk.active_tracing_path,
4298 PATH_MAX, "%s/%s-",
4299 session->ust_session->consumer->dst.session_root_path,
4300 datetime);
4301 snprintf(session->ust_session->consumer->chunk_path,
4302 PATH_MAX, "/%s-/", datetime);
4303 ret = ust_app_rotate_session(session);
4304 if (ret != LTTNG_OK) {
4305 goto error;
4306 }
4307 }
4308
4309 (*rotate_return)->rotate_id = session->rotate_count;
4310 (*rotate_return)->status = LTTNG_ROTATE_STARTED;
4311
4312 DBG("Cmd rotate session %s, rotate_id %" PRIu64, session->name,
4313 session->rotate_count);
4314 ret = LTTNG_OK;
4315
4316 goto end;
4317
4318 error:
4319 (*rotate_return)->status = LTTNG_ROTATE_ERROR;
4320 end:
4321 return ret;
4322 }
4323
4324 /*
4325 * Command LTTNG_ROTATE_PENDING from the lttng-ctl library.
4326 *
4327 * Check if the session has finished its rotation.
4328 *
4329 * Return 0 on success or else a LTTNG_ERR code.
4330 */
4331 int cmd_rotate_pending(struct ltt_session *session,
4332 struct lttng_rotate_pending_return **pending_return,
4333 uint64_t rotate_id)
4334 {
4335 int ret;
4336
4337 assert(session);
4338
4339 DBG("Cmd rotate pending session %s, rotate_id %" PRIu64, session->name,
4340 session->rotate_count);
4341
4342 *pending_return = zmalloc(sizeof(struct lttng_rotate_pending_return));
4343 if (!*pending_return) {
4344 ret = -ENOMEM;
4345 goto end;
4346 }
4347
4348 if (session->rotate_count != rotate_id) {
4349 (*pending_return)->status = LTTNG_ROTATE_EXPIRED;
4350 ret = LTTNG_OK;
4351 goto end;
4352 }
4353
4354 if (session->rotate_pending) {
4355 DBG("Session %s, rotate_id %" PRIu64 " still pending",
4356 session->name, session->rotate_count);
4357 (*pending_return)->status = LTTNG_ROTATE_STARTED;
4358 } else {
4359 DBG("Session %s, rotate_id %" PRIu64 " finished",
4360 session->name, session->rotate_count);
4361 (*pending_return)->status = LTTNG_ROTATE_COMPLETED;
4362 snprintf((*pending_return)->output_path, PATH_MAX, "%s",
4363 session->rotation_chunk.current_rotate_path);
4364 }
4365
4366 ret = LTTNG_OK;
4367
4368 goto end;
4369
4370 error:
4371 (*pending_return)->status = LTTNG_ROTATE_ERROR;
4372 end:
4373 return ret;
4374 }
4375
4376 /*
4377 * Init command subsystem.
4378 */
4379 void cmd_init(void)
4380 {
4381 /*
4382 * Set network sequence index to 1 for streams to match a relayd
4383 * socket on the consumer side.
4384 */
4385 pthread_mutex_lock(&relayd_net_seq_idx_lock);
4386 relayd_net_seq_idx = 1;
4387 pthread_mutex_unlock(&relayd_net_seq_idx_lock);
4388
4389 DBG("Command subsystem initialized");
4390 }
LTTng tools - Deliverables
This page took 0.114785 seconds and 4 git commands to generate.