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


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