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