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


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