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