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


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