projects / lttng-tools.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Fix: Integer overflowed argument
[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 if (lttng_strncpy(channels[i].name, uchan->name,
281 LTTNG_SYMBOL_NAME_LEN)) {
282 break;
283 }
284 channels[i].attr.overwrite = uchan->attr.overwrite;
285 channels[i].attr.subbuf_size = uchan->attr.subbuf_size;
286 channels[i].attr.num_subbuf = uchan->attr.num_subbuf;
287 channels[i].attr.switch_timer_interval =
288 uchan->attr.switch_timer_interval;
289 channels[i].attr.read_timer_interval =
290 uchan->attr.read_timer_interval;
291 channels[i].enabled = uchan->enabled;
292 channels[i].attr.tracefile_size = uchan->tracefile_size;
293 channels[i].attr.tracefile_count = uchan->tracefile_count;
294
295 /*
296 * Map enum lttng_ust_output to enum lttng_event_output.
297 */
298 switch (uchan->attr.output) {
299 case LTTNG_UST_MMAP:
300 channels[i].attr.output = LTTNG_EVENT_MMAP;
301 break;
302 default:
303 /*
304 * LTTNG_UST_MMAP is the only supported UST
305 * output mode.
306 */
307 assert(0);
308 break;
309 }
310
311 ret = get_ust_runtime_stats(session, uchan,
312 &discarded_events, &lost_packets);
313 if (ret < 0) {
314 break;
315 }
316 chan_exts[i].discarded_events = discarded_events;
317 chan_exts[i].lost_packets = lost_packets;
318 i++;
319 }
320 rcu_read_unlock();
321 break;
322 }
323 default:
324 break;
325 }
326
327 end:
328 return;
329 }
330
331 static void increment_extended_len(const char *filter_expression,
332 struct lttng_event_exclusion *exclusion, size_t *extended_len)
333 {
334 *extended_len += sizeof(struct lttcomm_event_extended_header);
335
336 if (filter_expression) {
337 *extended_len += strlen(filter_expression) + 1;
338 }
339
340 if (exclusion) {
341 *extended_len += exclusion->count * LTTNG_SYMBOL_NAME_LEN;
342 }
343 }
344
345 static void append_extended_info(const char *filter_expression,
346 struct lttng_event_exclusion *exclusion, void **extended_at)
347 {
348 struct lttcomm_event_extended_header extended_header;
349 size_t filter_len = 0;
350 size_t nb_exclusions = 0;
351
352 if (filter_expression) {
353 filter_len = strlen(filter_expression) + 1;
354 }
355
356 if (exclusion) {
357 nb_exclusions = exclusion->count;
358 }
359
360 /* Set header fields */
361 extended_header.filter_len = filter_len;
362 extended_header.nb_exclusions = nb_exclusions;
363
364 /* Copy header */
365 memcpy(*extended_at, &extended_header, sizeof(extended_header));
366 *extended_at += sizeof(extended_header);
367
368 /* Copy filter string */
369 if (filter_expression) {
370 memcpy(*extended_at, filter_expression, filter_len);
371 *extended_at += filter_len;
372 }
373
374 /* Copy exclusion names */
375 if (exclusion) {
376 size_t len = nb_exclusions * LTTNG_SYMBOL_NAME_LEN;
377
378 memcpy(*extended_at, &exclusion->names, len);
379 *extended_at += len;
380 }
381 }
382
383 /*
384 * Create a list of agent domain events.
385 *
386 * Return number of events in list on success or else a negative value.
387 */
388 static int list_lttng_agent_events(struct agent *agt,
389 struct lttng_event **events, size_t *total_size)
390 {
391 int i = 0, ret = 0;
392 unsigned int nb_event = 0;
393 struct agent_event *event;
394 struct lttng_event *tmp_events;
395 struct lttng_ht_iter iter;
396 size_t extended_len = 0;
397 void *extended_at;
398
399 assert(agt);
400 assert(events);
401
402 DBG3("Listing agent events");
403
404 rcu_read_lock();
405 nb_event = lttng_ht_get_count(agt->events);
406 rcu_read_unlock();
407 if (nb_event == 0) {
408 ret = nb_event;
409 *total_size = 0;
410 goto error;
411 }
412
413 /* Compute required extended infos size */
414 extended_len = nb_event * sizeof(struct lttcomm_event_extended_header);
415
416 /*
417 * This is only valid because the commands which add events are
418 * processed in the same thread as the listing.
419 */
420 rcu_read_lock();
421 cds_lfht_for_each_entry(agt->events->ht, &iter.iter, event, node.node) {
422 increment_extended_len(event->filter_expression, NULL,
423 &extended_len);
424 }
425 rcu_read_unlock();
426
427 *total_size = nb_event * sizeof(*tmp_events) + extended_len;
428 tmp_events = zmalloc(*total_size);
429 if (!tmp_events) {
430 PERROR("zmalloc agent events session");
431 ret = -LTTNG_ERR_FATAL;
432 goto error;
433 }
434
435 extended_at = ((uint8_t *) tmp_events) +
436 nb_event * sizeof(struct lttng_event);
437
438 rcu_read_lock();
439 cds_lfht_for_each_entry(agt->events->ht, &iter.iter, event, node.node) {
440 strncpy(tmp_events[i].name, event->name, sizeof(tmp_events[i].name));
441 tmp_events[i].name[sizeof(tmp_events[i].name) - 1] = '\0';
442 tmp_events[i].enabled = event->enabled;
443 tmp_events[i].loglevel = event->loglevel_value;
444 tmp_events[i].loglevel_type = event->loglevel_type;
445 i++;
446
447 /* Append extended info */
448 append_extended_info(event->filter_expression, NULL,
449 &extended_at);
450 }
451 rcu_read_unlock();
452
453 *events = tmp_events;
454 ret = nb_event;
455
456 error:
457 assert(nb_event == i);
458 return ret;
459 }
460
461 /*
462 * Create a list of ust global domain events.
463 */
464 static int list_lttng_ust_global_events(char *channel_name,
465 struct ltt_ust_domain_global *ust_global,
466 struct lttng_event **events, size_t *total_size)
467 {
468 int i = 0, ret = 0;
469 unsigned int nb_event = 0;
470 struct lttng_ht_iter iter;
471 struct lttng_ht_node_str *node;
472 struct ltt_ust_channel *uchan;
473 struct ltt_ust_event *uevent;
474 struct lttng_event *tmp;
475 size_t extended_len = 0;
476 void *extended_at;
477
478 DBG("Listing UST global events for channel %s", channel_name);
479
480 rcu_read_lock();
481
482 lttng_ht_lookup(ust_global->channels, (void *)channel_name, &iter);
483 node = lttng_ht_iter_get_node_str(&iter);
484 if (node == NULL) {
485 ret = LTTNG_ERR_UST_CHAN_NOT_FOUND;
486 goto end;
487 }
488
489 uchan = caa_container_of(&node->node, struct ltt_ust_channel, node.node);
490
491 nb_event = lttng_ht_get_count(uchan->events);
492 if (nb_event == 0) {
493 ret = nb_event;
494 *total_size = 0;
495 goto end;
496 }
497
498 DBG3("Listing UST global %d events", nb_event);
499
500 /* Compute required extended infos size */
501 cds_lfht_for_each_entry(uchan->events->ht, &iter.iter, uevent, node.node) {
502 if (uevent->internal) {
503 nb_event--;
504 continue;
505 }
506
507 increment_extended_len(uevent->filter_expression,
508 uevent->exclusion, &extended_len);
509 }
510 if (nb_event == 0) {
511 /* All events are internal, skip. */
512 ret = 0;
513 *total_size = 0;
514 goto end;
515 }
516
517 *total_size = nb_event * sizeof(struct lttng_event) + extended_len;
518 tmp = zmalloc(*total_size);
519 if (tmp == NULL) {
520 ret = -LTTNG_ERR_FATAL;
521 goto end;
522 }
523
524 extended_at = ((uint8_t *) tmp) + nb_event * sizeof(struct lttng_event);
525
526 cds_lfht_for_each_entry(uchan->events->ht, &iter.iter, uevent, node.node) {
527 if (uevent->internal) {
528 /* This event should remain hidden from clients */
529 continue;
530 }
531 strncpy(tmp[i].name, uevent->attr.name, LTTNG_SYMBOL_NAME_LEN);
532 tmp[i].name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
533 tmp[i].enabled = uevent->enabled;
534
535 switch (uevent->attr.instrumentation) {
536 case LTTNG_UST_TRACEPOINT:
537 tmp[i].type = LTTNG_EVENT_TRACEPOINT;
538 break;
539 case LTTNG_UST_PROBE:
540 tmp[i].type = LTTNG_EVENT_PROBE;
541 break;
542 case LTTNG_UST_FUNCTION:
543 tmp[i].type = LTTNG_EVENT_FUNCTION;
544 break;
545 }
546
547 tmp[i].loglevel = uevent->attr.loglevel;
548 switch (uevent->attr.loglevel_type) {
549 case LTTNG_UST_LOGLEVEL_ALL:
550 tmp[i].loglevel_type = LTTNG_EVENT_LOGLEVEL_ALL;
551 break;
552 case LTTNG_UST_LOGLEVEL_RANGE:
553 tmp[i].loglevel_type = LTTNG_EVENT_LOGLEVEL_RANGE;
554 break;
555 case LTTNG_UST_LOGLEVEL_SINGLE:
556 tmp[i].loglevel_type = LTTNG_EVENT_LOGLEVEL_SINGLE;
557 break;
558 }
559 if (uevent->filter) {
560 tmp[i].filter = 1;
561 }
562 if (uevent->exclusion) {
563 tmp[i].exclusion = 1;
564 }
565 i++;
566
567 /* Append extended info */
568 append_extended_info(uevent->filter_expression,
569 uevent->exclusion, &extended_at);
570 }
571
572 ret = nb_event;
573 *events = tmp;
574 end:
575 rcu_read_unlock();
576 return ret;
577 }
578
579 /*
580 * Fill lttng_event array of all kernel events in the channel.
581 */
582 static int list_lttng_kernel_events(char *channel_name,
583 struct ltt_kernel_session *kernel_session,
584 struct lttng_event **events, size_t *total_size)
585 {
586 int i = 0, ret;
587 unsigned int nb_event;
588 struct ltt_kernel_event *event;
589 struct ltt_kernel_channel *kchan;
590 size_t extended_len = 0;
591 void *extended_at;
592
593 kchan = trace_kernel_get_channel_by_name(channel_name, kernel_session);
594 if (kchan == NULL) {
595 ret = LTTNG_ERR_KERN_CHAN_NOT_FOUND;
596 goto error;
597 }
598
599 nb_event = kchan->event_count;
600
601 DBG("Listing events for channel %s", kchan->channel->name);
602
603 if (nb_event == 0) {
604 *total_size = 0;
605 *events = NULL;
606 goto end;
607 }
608
609 /* Compute required extended infos size */
610 cds_list_for_each_entry(event, &kchan->events_list.head, list) {
611 increment_extended_len(event->filter_expression, NULL,
612 &extended_len);
613 }
614
615 *total_size = nb_event * sizeof(struct lttng_event) + extended_len;
616 *events = zmalloc(*total_size);
617 if (*events == NULL) {
618 ret = LTTNG_ERR_FATAL;
619 goto error;
620 }
621
622 extended_at = ((void *) *events) +
623 nb_event * sizeof(struct lttng_event);
624
625 /* Kernel channels */
626 cds_list_for_each_entry(event, &kchan->events_list.head , list) {
627 strncpy((*events)[i].name, event->event->name, LTTNG_SYMBOL_NAME_LEN);
628 (*events)[i].name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
629 (*events)[i].enabled = event->enabled;
630 (*events)[i].filter =
631 (unsigned char) !!event->filter_expression;
632
633 switch (event->event->instrumentation) {
634 case LTTNG_KERNEL_TRACEPOINT:
635 (*events)[i].type = LTTNG_EVENT_TRACEPOINT;
636 break;
637 case LTTNG_KERNEL_KRETPROBE:
638 (*events)[i].type = LTTNG_EVENT_FUNCTION;
639 memcpy(&(*events)[i].attr.probe, &event->event->u.kprobe,
640 sizeof(struct lttng_kernel_kprobe));
641 break;
642 case LTTNG_KERNEL_KPROBE:
643 (*events)[i].type = LTTNG_EVENT_PROBE;
644 memcpy(&(*events)[i].attr.probe, &event->event->u.kprobe,
645 sizeof(struct lttng_kernel_kprobe));
646 break;
647 case LTTNG_KERNEL_FUNCTION:
648 (*events)[i].type = LTTNG_EVENT_FUNCTION;
649 memcpy(&((*events)[i].attr.ftrace), &event->event->u.ftrace,
650 sizeof(struct lttng_kernel_function));
651 break;
652 case LTTNG_KERNEL_NOOP:
653 (*events)[i].type = LTTNG_EVENT_NOOP;
654 break;
655 case LTTNG_KERNEL_SYSCALL:
656 (*events)[i].type = LTTNG_EVENT_SYSCALL;
657 break;
658 case LTTNG_KERNEL_ALL:
659 assert(0);
660 break;
661 }
662 i++;
663
664 /* Append extended info */
665 append_extended_info(event->filter_expression, NULL,
666 &extended_at);
667 }
668
669 end:
670 return nb_event;
671
672 error:
673 /* Negate the error code to differentiate the size from an error */
674 return -ret;
675 }
676
677 /*
678 * Add URI so the consumer output object. Set the correct path depending on the
679 * domain adding the default trace directory.
680 */
681 static int add_uri_to_consumer(struct consumer_output *consumer,
682 struct lttng_uri *uri, enum lttng_domain_type domain,
683 const char *session_name)
684 {
685 int ret = LTTNG_OK;
686 const char *default_trace_dir;
687
688 assert(uri);
689
690 if (consumer == NULL) {
691 DBG("No consumer detected. Don't add URI. Stopping.");
692 ret = LTTNG_ERR_NO_CONSUMER;
693 goto error;
694 }
695
696 switch (domain) {
697 case LTTNG_DOMAIN_KERNEL:
698 default_trace_dir = DEFAULT_KERNEL_TRACE_DIR;
699 break;
700 case LTTNG_DOMAIN_UST:
701 default_trace_dir = DEFAULT_UST_TRACE_DIR;
702 break;
703 default:
704 /*
705 * This case is possible is we try to add the URI to the global tracing
706 * session consumer object which in this case there is no subdir.
707 */
708 default_trace_dir = "";
709 }
710
711 switch (uri->dtype) {
712 case LTTNG_DST_IPV4:
713 case LTTNG_DST_IPV6:
714 DBG2("Setting network URI to consumer");
715
716 if (consumer->type == CONSUMER_DST_NET) {
717 if ((uri->stype == LTTNG_STREAM_CONTROL &&
718 consumer->dst.net.control_isset) ||
719 (uri->stype == LTTNG_STREAM_DATA &&
720 consumer->dst.net.data_isset)) {
721 ret = LTTNG_ERR_URL_EXIST;
722 goto error;
723 }
724 } else {
725 memset(&consumer->dst.net, 0, sizeof(consumer->dst.net));
726 }
727
728 consumer->type = CONSUMER_DST_NET;
729
730 /* Set URI into consumer output object */
731 ret = consumer_set_network_uri(consumer, uri);
732 if (ret < 0) {
733 ret = -ret;
734 goto error;
735 } else if (ret == 1) {
736 /*
737 * URI was the same in the consumer so we do not append the subdir
738 * again so to not duplicate output dir.
739 */
740 ret = LTTNG_OK;
741 goto error;
742 }
743
744 if (uri->stype == LTTNG_STREAM_CONTROL && strlen(uri->subdir) == 0) {
745 ret = consumer_set_subdir(consumer, session_name);
746 if (ret < 0) {
747 ret = LTTNG_ERR_FATAL;
748 goto error;
749 }
750 }
751
752 if (uri->stype == LTTNG_STREAM_CONTROL) {
753 /* On a new subdir, reappend the default trace dir. */
754 strncat(consumer->subdir, default_trace_dir,
755 sizeof(consumer->subdir) - strlen(consumer->subdir) - 1);
756 DBG3("Append domain trace name to subdir %s", consumer->subdir);
757 }
758
759 break;
760 case LTTNG_DST_PATH:
761 DBG2("Setting trace directory path from URI to %s", uri->dst.path);
762 memset(consumer->dst.trace_path, 0,
763 sizeof(consumer->dst.trace_path));
764 /* Explicit length checks for strcpy and strcat. */
765 if (strlen(uri->dst.path) + strlen(default_trace_dir)
766 >= sizeof(consumer->dst.trace_path)) {
767 ret = LTTNG_ERR_FATAL;
768 goto error;
769 }
770 strcpy(consumer->dst.trace_path, uri->dst.path);
771 /* Append default trace dir */
772 strcat(consumer->dst.trace_path, default_trace_dir);
773 /* Flag consumer as local. */
774 consumer->type = CONSUMER_DST_LOCAL;
775 break;
776 }
777
778 ret = LTTNG_OK;
779
780 error:
781 return ret;
782 }
783
784 /*
785 * Init tracing by creating trace directory and sending fds kernel consumer.
786 */
787 static int init_kernel_tracing(struct ltt_kernel_session *session)
788 {
789 int ret = 0;
790 struct lttng_ht_iter iter;
791 struct consumer_socket *socket;
792
793 assert(session);
794
795 rcu_read_lock();
796
797 if (session->consumer_fds_sent == 0 && session->consumer != NULL) {
798 cds_lfht_for_each_entry(session->consumer->socks->ht, &iter.iter,
799 socket, node.node) {
800 pthread_mutex_lock(socket->lock);
801 ret = kernel_consumer_send_session(socket, session);
802 pthread_mutex_unlock(socket->lock);
803 if (ret < 0) {
804 ret = LTTNG_ERR_KERN_CONSUMER_FAIL;
805 goto error;
806 }
807 }
808 }
809
810 error:
811 rcu_read_unlock();
812 return ret;
813 }
814
815 /*
816 * Create a socket to the relayd using the URI.
817 *
818 * On success, the relayd_sock pointer is set to the created socket.
819 * Else, it's stays untouched and a lttcomm error code is returned.
820 */
821 static int create_connect_relayd(struct lttng_uri *uri,
822 struct lttcomm_relayd_sock **relayd_sock,
823 struct consumer_output *consumer)
824 {
825 int ret;
826 struct lttcomm_relayd_sock *rsock;
827
828 rsock = lttcomm_alloc_relayd_sock(uri, RELAYD_VERSION_COMM_MAJOR,
829 RELAYD_VERSION_COMM_MINOR);
830 if (!rsock) {
831 ret = LTTNG_ERR_FATAL;
832 goto error;
833 }
834
835 /*
836 * Connect to relayd so we can proceed with a session creation. This call
837 * can possibly block for an arbitrary amount of time to set the health
838 * state to be in poll execution.
839 */
840 health_poll_entry();
841 ret = relayd_connect(rsock);
842 health_poll_exit();
843 if (ret < 0) {
844 ERR("Unable to reach lttng-relayd");
845 ret = LTTNG_ERR_RELAYD_CONNECT_FAIL;
846 goto free_sock;
847 }
848
849 /* Create socket for control stream. */
850 if (uri->stype == LTTNG_STREAM_CONTROL) {
851 DBG3("Creating relayd stream socket from URI");
852
853 /* Check relayd version */
854 ret = relayd_version_check(rsock);
855 if (ret < 0) {
856 ret = LTTNG_ERR_RELAYD_VERSION_FAIL;
857 goto close_sock;
858 }
859 consumer->relay_major_version = rsock->major;
860 consumer->relay_minor_version = rsock->minor;
861 } else if (uri->stype == LTTNG_STREAM_DATA) {
862 DBG3("Creating relayd data socket from URI");
863 } else {
864 /* Command is not valid */
865 ERR("Relayd invalid stream type: %d", uri->stype);
866 ret = LTTNG_ERR_INVALID;
867 goto close_sock;
868 }
869
870 *relayd_sock = rsock;
871
872 return LTTNG_OK;
873
874 close_sock:
875 /* The returned value is not useful since we are on an error path. */
876 (void) relayd_close(rsock);
877 free_sock:
878 free(rsock);
879 error:
880 return ret;
881 }
882
883 /*
884 * Connect to the relayd using URI and send the socket to the right consumer.
885 */
886 static int send_consumer_relayd_socket(enum lttng_domain_type domain,
887 unsigned int session_id, struct lttng_uri *relayd_uri,
888 struct consumer_output *consumer,
889 struct consumer_socket *consumer_sock,
890 char *session_name, char *hostname, int session_live_timer)
891 {
892 int ret;
893 struct lttcomm_relayd_sock *rsock = NULL;
894
895 /* Connect to relayd and make version check if uri is the control. */
896 ret = create_connect_relayd(relayd_uri, &rsock, consumer);
897 if (ret != LTTNG_OK) {
898 goto error;
899 }
900 assert(rsock);
901
902 /* Set the network sequence index if not set. */
903 if (consumer->net_seq_index == (uint64_t) -1ULL) {
904 pthread_mutex_lock(&relayd_net_seq_idx_lock);
905 /*
906 * Increment net_seq_idx because we are about to transfer the
907 * new relayd socket to the consumer.
908 * Assign unique key so the consumer can match streams.
909 */
910 consumer->net_seq_index = ++relayd_net_seq_idx;
911 pthread_mutex_unlock(&relayd_net_seq_idx_lock);
912 }
913
914 /* Send relayd socket to consumer. */
915 ret = consumer_send_relayd_socket(consumer_sock, rsock, consumer,
916 relayd_uri->stype, session_id,
917 session_name, hostname, session_live_timer);
918 if (ret < 0) {
919 ret = LTTNG_ERR_ENABLE_CONSUMER_FAIL;
920 goto close_sock;
921 }
922
923 /* Flag that the corresponding socket was sent. */
924 if (relayd_uri->stype == LTTNG_STREAM_CONTROL) {
925 consumer_sock->control_sock_sent = 1;
926 } else if (relayd_uri->stype == LTTNG_STREAM_DATA) {
927 consumer_sock->data_sock_sent = 1;
928 }
929
930 ret = LTTNG_OK;
931
932 /*
933 * Close socket which was dup on the consumer side. The session daemon does
934 * NOT keep track of the relayd socket(s) once transfer to the consumer.
935 */
936
937 close_sock:
938 (void) relayd_close(rsock);
939 free(rsock);
940
941 error:
942 if (ret != LTTNG_OK) {
943 /*
944 * The consumer output for this session should not be used anymore
945 * since the relayd connection failed thus making any tracing or/and
946 * streaming not usable.
947 */
948 consumer->enabled = 0;
949 }
950 return ret;
951 }
952
953 /*
954 * Send both relayd sockets to a specific consumer and domain. This is a
955 * helper function to facilitate sending the information to the consumer for a
956 * session.
957 */
958 static int send_consumer_relayd_sockets(enum lttng_domain_type domain,
959 unsigned int session_id, struct consumer_output *consumer,
960 struct consumer_socket *sock, char *session_name,
961 char *hostname, int session_live_timer)
962 {
963 int ret = LTTNG_OK;
964
965 assert(consumer);
966 assert(sock);
967
968 /* Sending control relayd socket. */
969 if (!sock->control_sock_sent) {
970 ret = send_consumer_relayd_socket(domain, session_id,
971 &consumer->dst.net.control, consumer, sock,
972 session_name, hostname, session_live_timer);
973 if (ret != LTTNG_OK) {
974 goto error;
975 }
976 }
977
978 /* Sending data relayd socket. */
979 if (!sock->data_sock_sent) {
980 ret = send_consumer_relayd_socket(domain, session_id,
981 &consumer->dst.net.data, consumer, sock,
982 session_name, hostname, session_live_timer);
983 if (ret != LTTNG_OK) {
984 goto error;
985 }
986 }
987
988 error:
989 return ret;
990 }
991
992 /*
993 * Setup relayd connections for a tracing session. First creates the socket to
994 * the relayd and send them to the right domain consumer. Consumer type MUST be
995 * network.
996 */
997 int cmd_setup_relayd(struct ltt_session *session)
998 {
999 int ret = LTTNG_OK;
1000 struct ltt_ust_session *usess;
1001 struct ltt_kernel_session *ksess;
1002 struct consumer_socket *socket;
1003 struct lttng_ht_iter iter;
1004
1005 assert(session);
1006
1007 usess = session->ust_session;
1008 ksess = session->kernel_session;
1009
1010 DBG("Setting relayd for session %s", session->name);
1011
1012 rcu_read_lock();
1013
1014 if (usess && usess->consumer && usess->consumer->type == CONSUMER_DST_NET
1015 && usess->consumer->enabled) {
1016 /* For each consumer socket, send relayd sockets */
1017 cds_lfht_for_each_entry(usess->consumer->socks->ht, &iter.iter,
1018 socket, node.node) {
1019 pthread_mutex_lock(socket->lock);
1020 ret = send_consumer_relayd_sockets(LTTNG_DOMAIN_UST, session->id,
1021 usess->consumer, socket,
1022 session->name, session->hostname,
1023 session->live_timer);
1024 pthread_mutex_unlock(socket->lock);
1025 if (ret != LTTNG_OK) {
1026 goto error;
1027 }
1028 /* Session is now ready for network streaming. */
1029 session->net_handle = 1;
1030 }
1031 session->consumer->relay_major_version =
1032 usess->consumer->relay_major_version;
1033 session->consumer->relay_minor_version =
1034 usess->consumer->relay_minor_version;
1035 }
1036
1037 if (ksess && ksess->consumer && ksess->consumer->type == CONSUMER_DST_NET
1038 && ksess->consumer->enabled) {
1039 cds_lfht_for_each_entry(ksess->consumer->socks->ht, &iter.iter,
1040 socket, node.node) {
1041 pthread_mutex_lock(socket->lock);
1042 ret = send_consumer_relayd_sockets(LTTNG_DOMAIN_KERNEL, session->id,
1043 ksess->consumer, socket,
1044 session->name, session->hostname,
1045 session->live_timer);
1046 pthread_mutex_unlock(socket->lock);
1047 if (ret != LTTNG_OK) {
1048 goto error;
1049 }
1050 /* Session is now ready for network streaming. */
1051 session->net_handle = 1;
1052 }
1053 session->consumer->relay_major_version =
1054 ksess->consumer->relay_major_version;
1055 session->consumer->relay_minor_version =
1056 ksess->consumer->relay_minor_version;
1057 }
1058
1059 error:
1060 rcu_read_unlock();
1061 return ret;
1062 }
1063
1064 /*
1065 * Start a kernel session by opening all necessary streams.
1066 */
1067 static int start_kernel_session(struct ltt_kernel_session *ksess, int wpipe)
1068 {
1069 int ret;
1070 struct ltt_kernel_channel *kchan;
1071
1072 /* Open kernel metadata */
1073 if (ksess->metadata == NULL && ksess->output_traces) {
1074 ret = kernel_open_metadata(ksess);
1075 if (ret < 0) {
1076 ret = LTTNG_ERR_KERN_META_FAIL;
1077 goto error;
1078 }
1079 }
1080
1081 /* Open kernel metadata stream */
1082 if (ksess->metadata && ksess->metadata_stream_fd < 0) {
1083 ret = kernel_open_metadata_stream(ksess);
1084 if (ret < 0) {
1085 ERR("Kernel create metadata stream failed");
1086 ret = LTTNG_ERR_KERN_STREAM_FAIL;
1087 goto error;
1088 }
1089 }
1090
1091 /* For each channel */
1092 cds_list_for_each_entry(kchan, &ksess->channel_list.head, list) {
1093 if (kchan->stream_count == 0) {
1094 ret = kernel_open_channel_stream(kchan);
1095 if (ret < 0) {
1096 ret = LTTNG_ERR_KERN_STREAM_FAIL;
1097 goto error;
1098 }
1099 /* Update the stream global counter */
1100 ksess->stream_count_global += ret;
1101 }
1102 }
1103
1104 /* Setup kernel consumer socket and send fds to it */
1105 ret = init_kernel_tracing(ksess);
1106 if (ret != 0) {
1107 ret = LTTNG_ERR_KERN_START_FAIL;
1108 goto error;
1109 }
1110
1111 /* This start the kernel tracing */
1112 ret = kernel_start_session(ksess);
1113 if (ret < 0) {
1114 ret = LTTNG_ERR_KERN_START_FAIL;
1115 goto error;
1116 }
1117
1118 /* Quiescent wait after starting trace */
1119 kernel_wait_quiescent(kernel_tracer_fd);
1120
1121 ksess->active = 1;
1122
1123 ret = LTTNG_OK;
1124
1125 error:
1126 return ret;
1127 }
1128
1129 /*
1130 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1131 */
1132 int cmd_disable_channel(struct ltt_session *session,
1133 enum lttng_domain_type domain, char *channel_name)
1134 {
1135 int ret;
1136 struct ltt_ust_session *usess;
1137
1138 usess = session->ust_session;
1139
1140 rcu_read_lock();
1141
1142 switch (domain) {
1143 case LTTNG_DOMAIN_KERNEL:
1144 {
1145 ret = channel_kernel_disable(session->kernel_session,
1146 channel_name);
1147 if (ret != LTTNG_OK) {
1148 goto error;
1149 }
1150
1151 kernel_wait_quiescent(kernel_tracer_fd);
1152 break;
1153 }
1154 case LTTNG_DOMAIN_UST:
1155 {
1156 struct ltt_ust_channel *uchan;
1157 struct lttng_ht *chan_ht;
1158
1159 chan_ht = usess->domain_global.channels;
1160
1161 uchan = trace_ust_find_channel_by_name(chan_ht, channel_name);
1162 if (uchan == NULL) {
1163 ret = LTTNG_ERR_UST_CHAN_NOT_FOUND;
1164 goto error;
1165 }
1166
1167 ret = channel_ust_disable(usess, uchan);
1168 if (ret != LTTNG_OK) {
1169 goto error;
1170 }
1171 break;
1172 }
1173 default:
1174 ret = LTTNG_ERR_UNKNOWN_DOMAIN;
1175 goto error;
1176 }
1177
1178 ret = LTTNG_OK;
1179
1180 error:
1181 rcu_read_unlock();
1182 return ret;
1183 }
1184
1185 /*
1186 * Command LTTNG_TRACK_PID processed by the client thread.
1187 *
1188 * Called with session lock held.
1189 */
1190 int cmd_track_pid(struct ltt_session *session, enum lttng_domain_type domain,
1191 int pid)
1192 {
1193 int ret;
1194
1195 rcu_read_lock();
1196
1197 switch (domain) {
1198 case LTTNG_DOMAIN_KERNEL:
1199 {
1200 struct ltt_kernel_session *ksess;
1201
1202 ksess = session->kernel_session;
1203
1204 ret = kernel_track_pid(ksess, pid);
1205 if (ret != LTTNG_OK) {
1206 goto error;
1207 }
1208
1209 kernel_wait_quiescent(kernel_tracer_fd);
1210 break;
1211 }
1212 case LTTNG_DOMAIN_UST:
1213 {
1214 struct ltt_ust_session *usess;
1215
1216 usess = session->ust_session;
1217
1218 ret = trace_ust_track_pid(usess, pid);
1219 if (ret != LTTNG_OK) {
1220 goto error;
1221 }
1222 break;
1223 }
1224 default:
1225 ret = LTTNG_ERR_UNKNOWN_DOMAIN;
1226 goto error;
1227 }
1228
1229 ret = LTTNG_OK;
1230
1231 error:
1232 rcu_read_unlock();
1233 return ret;
1234 }
1235
1236 /*
1237 * Command LTTNG_UNTRACK_PID processed by the client thread.
1238 *
1239 * Called with session lock held.
1240 */
1241 int cmd_untrack_pid(struct ltt_session *session, enum lttng_domain_type domain,
1242 int pid)
1243 {
1244 int ret;
1245
1246 rcu_read_lock();
1247
1248 switch (domain) {
1249 case LTTNG_DOMAIN_KERNEL:
1250 {
1251 struct ltt_kernel_session *ksess;
1252
1253 ksess = session->kernel_session;
1254
1255 ret = kernel_untrack_pid(ksess, pid);
1256 if (ret != LTTNG_OK) {
1257 goto error;
1258 }
1259
1260 kernel_wait_quiescent(kernel_tracer_fd);
1261 break;
1262 }
1263 case LTTNG_DOMAIN_UST:
1264 {
1265 struct ltt_ust_session *usess;
1266
1267 usess = session->ust_session;
1268
1269 ret = trace_ust_untrack_pid(usess, pid);
1270 if (ret != LTTNG_OK) {
1271 goto error;
1272 }
1273 break;
1274 }
1275 default:
1276 ret = LTTNG_ERR_UNKNOWN_DOMAIN;
1277 goto error;
1278 }
1279
1280 ret = LTTNG_OK;
1281
1282 error:
1283 rcu_read_unlock();
1284 return ret;
1285 }
1286
1287 /*
1288 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1289 *
1290 * The wpipe arguments is used as a notifier for the kernel thread.
1291 */
1292 int cmd_enable_channel(struct ltt_session *session,
1293 struct lttng_domain *domain, struct lttng_channel *attr, int wpipe)
1294 {
1295 int ret;
1296 struct ltt_ust_session *usess = session->ust_session;
1297 struct lttng_ht *chan_ht;
1298 size_t len;
1299
1300 assert(session);
1301 assert(attr);
1302 assert(domain);
1303
1304 len = lttng_strnlen(attr->name, sizeof(attr->name));
1305
1306 /* Validate channel name */
1307 if (attr->name[0] == '.' ||
1308 memchr(attr->name, '/', len) != NULL) {
1309 ret = LTTNG_ERR_INVALID_CHANNEL_NAME;
1310 goto end;
1311 }
1312
1313 DBG("Enabling channel %s for session %s", attr->name, session->name);
1314
1315 rcu_read_lock();
1316
1317 /*
1318 * Don't try to enable a channel if the session has been started at
1319 * some point in time before. The tracer does not allow it.
1320 */
1321 if (session->has_been_started) {
1322 ret = LTTNG_ERR_TRACE_ALREADY_STARTED;
1323 goto error;
1324 }
1325
1326 /*
1327 * If the session is a live session, remove the switch timer, the
1328 * live timer does the same thing but sends also synchronisation
1329 * beacons for inactive streams.
1330 */
1331 if (session->live_timer > 0) {
1332 attr->attr.live_timer_interval = session->live_timer;
1333 attr->attr.switch_timer_interval = 0;
1334 }
1335
1336 /*
1337 * The ringbuffer (both in user space and kernel) behave badly in overwrite
1338 * mode and with less than 2 subbuf so block it right away and send back an
1339 * invalid attribute error.
1340 */
1341 if (attr->attr.overwrite && attr->attr.num_subbuf < 2) {
1342 ret = LTTNG_ERR_INVALID;
1343 goto error;
1344 }
1345
1346 switch (domain->type) {
1347 case LTTNG_DOMAIN_KERNEL:
1348 {
1349 struct ltt_kernel_channel *kchan;
1350
1351 kchan = trace_kernel_get_channel_by_name(attr->name,
1352 session->kernel_session);
1353 if (kchan == NULL) {
1354 ret = channel_kernel_create(session->kernel_session, attr, wpipe);
1355 if (attr->name[0] != '\0') {
1356 session->kernel_session->has_non_default_channel = 1;
1357 }
1358 } else {
1359 ret = channel_kernel_enable(session->kernel_session, kchan);
1360 }
1361
1362 if (ret != LTTNG_OK) {
1363 goto error;
1364 }
1365
1366 kernel_wait_quiescent(kernel_tracer_fd);
1367 break;
1368 }
1369 case LTTNG_DOMAIN_UST:
1370 case LTTNG_DOMAIN_JUL:
1371 case LTTNG_DOMAIN_LOG4J:
1372 case LTTNG_DOMAIN_PYTHON:
1373 {
1374 struct ltt_ust_channel *uchan;
1375
1376 /*
1377 * FIXME
1378 *
1379 * Current agent implementation limitations force us to allow
1380 * only one channel at once in "agent" subdomains. Each
1381 * subdomain has a default channel name which must be strictly
1382 * adhered to.
1383 */
1384 if (domain->type == LTTNG_DOMAIN_JUL) {
1385 if (strncmp(attr->name, DEFAULT_JUL_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_LOG4J) {
1391 if (strncmp(attr->name, DEFAULT_LOG4J_CHANNEL_NAME,
1392 LTTNG_SYMBOL_NAME_LEN)) {
1393 ret = LTTNG_ERR_INVALID_CHANNEL_NAME;
1394 goto error;
1395 }
1396 } else if (domain->type == LTTNG_DOMAIN_PYTHON) {
1397 if (strncmp(attr->name, DEFAULT_PYTHON_CHANNEL_NAME,
1398 LTTNG_SYMBOL_NAME_LEN)) {
1399 ret = LTTNG_ERR_INVALID_CHANNEL_NAME;
1400 goto error;
1401 }
1402 }
1403
1404 chan_ht = usess->domain_global.channels;
1405
1406 uchan = trace_ust_find_channel_by_name(chan_ht, attr->name);
1407 if (uchan == NULL) {
1408 ret = channel_ust_create(usess, attr, domain->buf_type);
1409 if (attr->name[0] != '\0') {
1410 usess->has_non_default_channel = 1;
1411 }
1412 } else {
1413 ret = channel_ust_enable(usess, uchan);
1414 }
1415 break;
1416 }
1417 default:
1418 ret = LTTNG_ERR_UNKNOWN_DOMAIN;
1419 goto error;
1420 }
1421
1422 error:
1423 rcu_read_unlock();
1424 end:
1425 return ret;
1426 }
1427
1428 /*
1429 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1430 */
1431 int cmd_disable_event(struct ltt_session *session,
1432 enum lttng_domain_type domain, char *channel_name,
1433 struct lttng_event *event)
1434 {
1435 int ret;
1436 char *event_name;
1437
1438 DBG("Disable event command for event \'%s\'", event->name);
1439
1440 event_name = event->name;
1441 if (validate_event_name(event_name)) {
1442 ret = LTTNG_ERR_INVALID_EVENT_NAME;
1443 goto error;
1444 }
1445
1446 /* Error out on unhandled search criteria */
1447 if (event->loglevel_type || event->loglevel != -1 || event->enabled
1448 || event->pid || event->filter || event->exclusion) {
1449 ret = LTTNG_ERR_UNK;
1450 goto error;
1451 }
1452
1453 rcu_read_lock();
1454
1455 switch (domain) {
1456 case LTTNG_DOMAIN_KERNEL:
1457 {
1458 struct ltt_kernel_channel *kchan;
1459 struct ltt_kernel_session *ksess;
1460
1461 ksess = session->kernel_session;
1462
1463 /*
1464 * If a non-default channel has been created in the
1465 * session, explicitely require that -c chan_name needs
1466 * to be provided.
1467 */
1468 if (ksess->has_non_default_channel && channel_name[0] == '\0') {
1469 ret = LTTNG_ERR_NEED_CHANNEL_NAME;
1470 goto error_unlock;
1471 }
1472
1473 kchan = trace_kernel_get_channel_by_name(channel_name, ksess);
1474 if (kchan == NULL) {
1475 ret = LTTNG_ERR_KERN_CHAN_NOT_FOUND;
1476 goto error_unlock;
1477 }
1478
1479 switch (event->type) {
1480 case LTTNG_EVENT_ALL:
1481 case LTTNG_EVENT_TRACEPOINT:
1482 case LTTNG_EVENT_SYSCALL:
1483 case LTTNG_EVENT_PROBE:
1484 case LTTNG_EVENT_FUNCTION:
1485 case LTTNG_EVENT_FUNCTION_ENTRY:/* fall-through */
1486 if (event_name[0] == '\0') {
1487 ret = event_kernel_disable_event(kchan,
1488 NULL, event->type);
1489 } else {
1490 ret = event_kernel_disable_event(kchan,
1491 event_name, event->type);
1492 }
1493 if (ret != LTTNG_OK) {
1494 goto error_unlock;
1495 }
1496 break;
1497 default:
1498 ret = LTTNG_ERR_UNK;
1499 goto error_unlock;
1500 }
1501
1502 kernel_wait_quiescent(kernel_tracer_fd);
1503 break;
1504 }
1505 case LTTNG_DOMAIN_UST:
1506 {
1507 struct ltt_ust_channel *uchan;
1508 struct ltt_ust_session *usess;
1509
1510 usess = session->ust_session;
1511
1512 if (validate_ust_event_name(event_name)) {
1513 ret = LTTNG_ERR_INVALID_EVENT_NAME;
1514 goto error_unlock;
1515 }
1516
1517 /*
1518 * If a non-default channel has been created in the
1519 * session, explicitly require that -c chan_name needs
1520 * to be provided.
1521 */
1522 if (usess->has_non_default_channel && channel_name[0] == '\0') {
1523 ret = LTTNG_ERR_NEED_CHANNEL_NAME;
1524 goto error_unlock;
1525 }
1526
1527 uchan = trace_ust_find_channel_by_name(usess->domain_global.channels,
1528 channel_name);
1529 if (uchan == NULL) {
1530 ret = LTTNG_ERR_UST_CHAN_NOT_FOUND;
1531 goto error_unlock;
1532 }
1533
1534 switch (event->type) {
1535 case LTTNG_EVENT_ALL:
1536 /*
1537 * An empty event name means that everything
1538 * should be disabled.
1539 */
1540 if (event->name[0] == '\0') {
1541 ret = event_ust_disable_all_tracepoints(usess, uchan);
1542 } else {
1543 ret = event_ust_disable_tracepoint(usess, uchan,
1544 event_name);
1545 }
1546 if (ret != LTTNG_OK) {
1547 goto error_unlock;
1548 }
1549 break;
1550 default:
1551 ret = LTTNG_ERR_UNK;
1552 goto error_unlock;
1553 }
1554
1555 DBG3("Disable UST event %s in channel %s completed", event_name,
1556 channel_name);
1557 break;
1558 }
1559 case LTTNG_DOMAIN_LOG4J:
1560 case LTTNG_DOMAIN_JUL:
1561 case LTTNG_DOMAIN_PYTHON:
1562 {
1563 struct agent *agt;
1564 struct ltt_ust_session *usess = session->ust_session;
1565
1566 assert(usess);
1567
1568 switch (event->type) {
1569 case LTTNG_EVENT_ALL:
1570 break;
1571 default:
1572 ret = LTTNG_ERR_UNK;
1573 goto error_unlock;
1574 }
1575
1576 agt = trace_ust_find_agent(usess, domain);
1577 if (!agt) {
1578 ret = -LTTNG_ERR_UST_EVENT_NOT_FOUND;
1579 goto error_unlock;
1580 }
1581 /*
1582 * An empty event name means that everything
1583 * should be disabled.
1584 */
1585 if (event->name[0] == '\0') {
1586 ret = event_agent_disable_all(usess, agt);
1587 } else {
1588 ret = event_agent_disable(usess, agt, event_name);
1589 }
1590 if (ret != LTTNG_OK) {
1591 goto error_unlock;
1592 }
1593
1594 break;
1595 }
1596 default:
1597 ret = LTTNG_ERR_UND;
1598 goto error_unlock;
1599 }
1600
1601 ret = LTTNG_OK;
1602
1603 error_unlock:
1604 rcu_read_unlock();
1605 error:
1606 return ret;
1607 }
1608
1609 /*
1610 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1611 */
1612 int cmd_add_context(struct ltt_session *session, enum lttng_domain_type domain,
1613 char *channel_name, struct lttng_event_context *ctx, int kwpipe)
1614 {
1615 int ret, chan_kern_created = 0, chan_ust_created = 0;
1616 char *app_ctx_provider_name = NULL, *app_ctx_name = NULL;
1617
1618 if (ctx->ctx == LTTNG_EVENT_CONTEXT_APP_CONTEXT) {
1619 app_ctx_provider_name = ctx->u.app_ctx.provider_name;
1620 app_ctx_name = ctx->u.app_ctx.ctx_name;
1621 }
1622
1623 switch (domain) {
1624 case LTTNG_DOMAIN_KERNEL:
1625 assert(session->kernel_session);
1626
1627 if (session->kernel_session->channel_count == 0) {
1628 /* Create default channel */
1629 ret = channel_kernel_create(session->kernel_session, NULL, kwpipe);
1630 if (ret != LTTNG_OK) {
1631 goto error;
1632 }
1633 chan_kern_created = 1;
1634 }
1635 /* Add kernel context to kernel tracer */
1636 ret = context_kernel_add(session->kernel_session, ctx, channel_name);
1637 if (ret != LTTNG_OK) {
1638 goto error;
1639 }
1640 break;
1641 case LTTNG_DOMAIN_JUL:
1642 case LTTNG_DOMAIN_LOG4J:
1643 {
1644 /*
1645 * Validate channel name.
1646 * If no channel name is given and the domain is JUL or LOG4J,
1647 * set it to the appropriate domain-specific channel name. If
1648 * a name is provided but does not match the expexted channel
1649 * name, return an error.
1650 */
1651 if (domain == LTTNG_DOMAIN_JUL && *channel_name &&
1652 strcmp(channel_name,
1653 DEFAULT_JUL_CHANNEL_NAME)) {
1654 ret = LTTNG_ERR_UST_CHAN_NOT_FOUND;
1655 goto error;
1656 } else if (domain == LTTNG_DOMAIN_LOG4J && *channel_name &&
1657 strcmp(channel_name,
1658 DEFAULT_LOG4J_CHANNEL_NAME)) {
1659 ret = LTTNG_ERR_UST_CHAN_NOT_FOUND;
1660 goto error;
1661 }
1662 /* break is _not_ missing here. */
1663 }
1664 case LTTNG_DOMAIN_UST:
1665 {
1666 struct ltt_ust_session *usess = session->ust_session;
1667 unsigned int chan_count;
1668
1669 assert(usess);
1670
1671 chan_count = lttng_ht_get_count(usess->domain_global.channels);
1672 if (chan_count == 0) {
1673 struct lttng_channel *attr;
1674 /* Create default channel */
1675 attr = channel_new_default_attr(domain, usess->buffer_type);
1676 if (attr == NULL) {
1677 ret = LTTNG_ERR_FATAL;
1678 goto error;
1679 }
1680
1681 ret = channel_ust_create(usess, attr, usess->buffer_type);
1682 if (ret != LTTNG_OK) {
1683 free(attr);
1684 goto error;
1685 }
1686 free(attr);
1687 chan_ust_created = 1;
1688 }
1689
1690 ret = context_ust_add(usess, domain, ctx, channel_name);
1691 free(app_ctx_provider_name);
1692 free(app_ctx_name);
1693 app_ctx_name = NULL;
1694 app_ctx_provider_name = NULL;
1695 if (ret != LTTNG_OK) {
1696 goto error;
1697 }
1698 break;
1699 }
1700 default:
1701 ret = LTTNG_ERR_UND;
1702 goto error;
1703 }
1704
1705 ret = LTTNG_OK;
1706 goto end;
1707
1708 error:
1709 if (chan_kern_created) {
1710 struct ltt_kernel_channel *kchan =
1711 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME,
1712 session->kernel_session);
1713 /* Created previously, this should NOT fail. */
1714 assert(kchan);
1715 kernel_destroy_channel(kchan);
1716 }
1717
1718 if (chan_ust_created) {
1719 struct ltt_ust_channel *uchan =
1720 trace_ust_find_channel_by_name(
1721 session->ust_session->domain_global.channels,
1722 DEFAULT_CHANNEL_NAME);
1723 /* Created previously, this should NOT fail. */
1724 assert(uchan);
1725 /* Remove from the channel list of the session. */
1726 trace_ust_delete_channel(session->ust_session->domain_global.channels,
1727 uchan);
1728 trace_ust_destroy_channel(uchan);
1729 }
1730 end:
1731 free(app_ctx_provider_name);
1732 free(app_ctx_name);
1733 return ret;
1734 }
1735
1736 static int validate_event_name(const char *name)
1737 {
1738 int ret = 0;
1739 const char *c = name;
1740 const char *event_name_end = c + LTTNG_SYMBOL_NAME_LEN;
1741 bool null_terminated = false;
1742
1743 /*
1744 * Make sure that unescaped wildcards are only used as the last
1745 * character of the event name.
1746 */
1747 while (c < event_name_end) {
1748 switch (*c) {
1749 case '\0':
1750 null_terminated = true;
1751 goto end;
1752 case '\\':
1753 c++;
1754 break;
1755 case '*':
1756 if ((c + 1) < event_name_end && *(c + 1)) {
1757 /* Wildcard is not the last character */
1758 ret = LTTNG_ERR_INVALID_EVENT_NAME;
1759 goto end;
1760 }
1761 default:
1762 break;
1763 }
1764 c++;
1765 }
1766 end:
1767 if (!ret && !null_terminated) {
1768 ret = LTTNG_ERR_INVALID_EVENT_NAME;
1769 }
1770 return ret;
1771 }
1772
1773 static inline bool name_starts_with(const char *name, const char *prefix)
1774 {
1775 const size_t max_cmp_len = min(strlen(prefix), LTTNG_SYMBOL_NAME_LEN);
1776
1777 return !strncmp(name, prefix, max_cmp_len);
1778 }
1779
1780 /* Perform userspace-specific event name validation */
1781 static int validate_ust_event_name(const char *name)
1782 {
1783 int ret = 0;
1784
1785 if (!name) {
1786 ret = -1;
1787 goto end;
1788 }
1789
1790 /*
1791 * Check name against all internal UST event component namespaces used
1792 * by the agents.
1793 */
1794 if (name_starts_with(name, DEFAULT_JUL_EVENT_COMPONENT) ||
1795 name_starts_with(name, DEFAULT_LOG4J_EVENT_COMPONENT) ||
1796 name_starts_with(name, DEFAULT_PYTHON_EVENT_COMPONENT)) {
1797 ret = -1;
1798 }
1799
1800 end:
1801 return ret;
1802 }
1803
1804 /*
1805 * Internal version of cmd_enable_event() with a supplemental
1806 * "internal_event" flag which is used to enable internal events which should
1807 * be hidden from clients. Such events are used in the agent implementation to
1808 * enable the events through which all "agent" events are funeled.
1809 */
1810 static int _cmd_enable_event(struct ltt_session *session,
1811 struct lttng_domain *domain,
1812 char *channel_name, struct lttng_event *event,
1813 char *filter_expression,
1814 struct lttng_filter_bytecode *filter,
1815 struct lttng_event_exclusion *exclusion,
1816 int wpipe, bool internal_event)
1817 {
1818 int ret, channel_created = 0;
1819 struct lttng_channel *attr = NULL;
1820
1821 assert(session);
1822 assert(event);
1823 assert(channel_name);
1824
1825 /* If we have a filter, we must have its filter expression */
1826 assert(!(!!filter_expression ^ !!filter));
1827
1828 DBG("Enable event command for event \'%s\'", event->name);
1829
1830 rcu_read_lock();
1831
1832 ret = validate_event_name(event->name);
1833 if (ret) {
1834 goto error;
1835 }
1836
1837 switch (domain->type) {
1838 case LTTNG_DOMAIN_KERNEL:
1839 {
1840 struct ltt_kernel_channel *kchan;
1841
1842 /*
1843 * If a non-default channel has been created in the
1844 * session, explicitely require that -c chan_name needs
1845 * to be provided.
1846 */
1847 if (session->kernel_session->has_non_default_channel
1848 && channel_name[0] == '\0') {
1849 ret = LTTNG_ERR_NEED_CHANNEL_NAME;
1850 goto error;
1851 }
1852
1853 kchan = trace_kernel_get_channel_by_name(channel_name,
1854 session->kernel_session);
1855 if (kchan == NULL) {
1856 attr = channel_new_default_attr(LTTNG_DOMAIN_KERNEL,
1857 LTTNG_BUFFER_GLOBAL);
1858 if (attr == NULL) {
1859 ret = LTTNG_ERR_FATAL;
1860 goto error;
1861 }
1862 if (lttng_strncpy(attr->name, channel_name,
1863 sizeof(attr->name))) {
1864 ret = LTTNG_ERR_INVALID;
1865 goto error;
1866 }
1867
1868 ret = cmd_enable_channel(session, domain, attr, wpipe);
1869 if (ret != LTTNG_OK) {
1870 goto error;
1871 }
1872 channel_created = 1;
1873 }
1874
1875 /* Get the newly created kernel channel pointer */
1876 kchan = trace_kernel_get_channel_by_name(channel_name,
1877 session->kernel_session);
1878 if (kchan == NULL) {
1879 /* This sould not happen... */
1880 ret = LTTNG_ERR_FATAL;
1881 goto error;
1882 }
1883
1884 switch (event->type) {
1885 case LTTNG_EVENT_ALL:
1886 {
1887 char *filter_expression_a = NULL;
1888 struct lttng_filter_bytecode *filter_a = NULL;
1889
1890 /*
1891 * We need to duplicate filter_expression and filter,
1892 * because ownership is passed to first enable
1893 * event.
1894 */
1895 if (filter_expression) {
1896 filter_expression_a = strdup(filter_expression);
1897 if (!filter_expression_a) {
1898 ret = LTTNG_ERR_FATAL;
1899 goto error;
1900 }
1901 }
1902 if (filter) {
1903 filter_a = zmalloc(sizeof(*filter_a) + filter->len);
1904 if (!filter_a) {
1905 free(filter_expression_a);
1906 ret = LTTNG_ERR_FATAL;
1907 goto error;
1908 }
1909 memcpy(filter_a, filter, sizeof(*filter_a) + filter->len);
1910 }
1911 event->type = LTTNG_EVENT_TRACEPOINT; /* Hack */
1912 ret = event_kernel_enable_event(kchan, event,
1913 filter_expression, filter);
1914 /* We have passed ownership */
1915 filter_expression = NULL;
1916 filter = NULL;
1917 if (ret != LTTNG_OK) {
1918 if (channel_created) {
1919 /* Let's not leak a useless channel. */
1920 kernel_destroy_channel(kchan);
1921 }
1922 free(filter_expression_a);
1923 free(filter_a);
1924 goto error;
1925 }
1926 event->type = LTTNG_EVENT_SYSCALL; /* Hack */
1927 ret = event_kernel_enable_event(kchan, event,
1928 filter_expression_a, filter_a);
1929 /* We have passed ownership */
1930 filter_expression_a = NULL;
1931 filter_a = NULL;
1932 if (ret != LTTNG_OK) {
1933 goto error;
1934 }
1935 break;
1936 }
1937 case LTTNG_EVENT_PROBE:
1938 case LTTNG_EVENT_FUNCTION:
1939 case LTTNG_EVENT_FUNCTION_ENTRY:
1940 case LTTNG_EVENT_TRACEPOINT:
1941 ret = event_kernel_enable_event(kchan, event,
1942 filter_expression, filter);
1943 /* We have passed ownership */
1944 filter_expression = NULL;
1945 filter = NULL;
1946 if (ret != LTTNG_OK) {
1947 if (channel_created) {
1948 /* Let's not leak a useless channel. */
1949 kernel_destroy_channel(kchan);
1950 }
1951 goto error;
1952 }
1953 break;
1954 case LTTNG_EVENT_SYSCALL:
1955 ret = event_kernel_enable_event(kchan, event,
1956 filter_expression, filter);
1957 /* We have passed ownership */
1958 filter_expression = NULL;
1959 filter = NULL;
1960 if (ret != LTTNG_OK) {
1961 goto error;
1962 }
1963 break;
1964 default:
1965 ret = LTTNG_ERR_UNK;
1966 goto error;
1967 }
1968
1969 kernel_wait_quiescent(kernel_tracer_fd);
1970 break;
1971 }
1972 case LTTNG_DOMAIN_UST:
1973 {
1974 struct ltt_ust_channel *uchan;
1975 struct ltt_ust_session *usess = session->ust_session;
1976
1977 assert(usess);
1978
1979 /*
1980 * If a non-default channel has been created in the
1981 * session, explicitely require that -c chan_name needs
1982 * to be provided.
1983 */
1984 if (usess->has_non_default_channel && channel_name[0] == '\0') {
1985 ret = LTTNG_ERR_NEED_CHANNEL_NAME;
1986 goto error;
1987 }
1988
1989 /* Get channel from global UST domain */
1990 uchan = trace_ust_find_channel_by_name(usess->domain_global.channels,
1991 channel_name);
1992 if (uchan == NULL) {
1993 /* Create default channel */
1994 attr = channel_new_default_attr(LTTNG_DOMAIN_UST,
1995 usess->buffer_type);
1996 if (attr == NULL) {
1997 ret = LTTNG_ERR_FATAL;
1998 goto error;
1999 }
2000 if (lttng_strncpy(attr->name, channel_name,
2001 sizeof(attr->name))) {
2002 ret = LTTNG_ERR_INVALID;
2003 goto error;
2004 }
2005
2006 ret = cmd_enable_channel(session, domain, attr, wpipe);
2007 if (ret != LTTNG_OK) {
2008 goto error;
2009 }
2010
2011 /* Get the newly created channel reference back */
2012 uchan = trace_ust_find_channel_by_name(
2013 usess->domain_global.channels, channel_name);
2014 assert(uchan);
2015 }
2016
2017 if (uchan->domain != LTTNG_DOMAIN_UST && !internal_event) {
2018 /*
2019 * Don't allow users to add UST events to channels which
2020 * are assigned to a userspace subdomain (JUL, Log4J,
2021 * Python, etc.).
2022 */
2023 ret = LTTNG_ERR_INVALID_CHANNEL_DOMAIN;
2024 goto error;
2025 }
2026
2027 if (!internal_event) {
2028 /*
2029 * Ensure the event name is not reserved for internal
2030 * use.
2031 */
2032 ret = validate_ust_event_name(event->name);
2033 if (ret) {
2034 WARN("Userspace event name %s failed validation.",
2035 event->name ?
2036 event->name : "NULL");
2037 ret = LTTNG_ERR_INVALID_EVENT_NAME;
2038 goto error;
2039 }
2040 }
2041
2042 /* At this point, the session and channel exist on the tracer */
2043 ret = event_ust_enable_tracepoint(usess, uchan, event,
2044 filter_expression, filter, exclusion,
2045 internal_event);
2046 /* We have passed ownership */
2047 filter_expression = NULL;
2048 filter = NULL;
2049 exclusion = NULL;
2050 if (ret == LTTNG_ERR_UST_EVENT_ENABLED) {
2051 goto already_enabled;
2052 } else if (ret != LTTNG_OK) {
2053 goto error;
2054 }
2055 break;
2056 }
2057 case LTTNG_DOMAIN_LOG4J:
2058 case LTTNG_DOMAIN_JUL:
2059 case LTTNG_DOMAIN_PYTHON:
2060 {
2061 const char *default_event_name, *default_chan_name;
2062 struct agent *agt;
2063 struct lttng_event uevent;
2064 struct lttng_domain tmp_dom;
2065 struct ltt_ust_session *usess = session->ust_session;
2066
2067 assert(usess);
2068
2069 agt = trace_ust_find_agent(usess, domain->type);
2070 if (!agt) {
2071 agt = agent_create(domain->type);
2072 if (!agt) {
2073 ret = LTTNG_ERR_NOMEM;
2074 goto error;
2075 }
2076 agent_add(agt, usess->agents);
2077 }
2078
2079 /* Create the default tracepoint. */
2080 memset(&uevent, 0, sizeof(uevent));
2081 uevent.type = LTTNG_EVENT_TRACEPOINT;
2082 uevent.loglevel_type = LTTNG_EVENT_LOGLEVEL_ALL;
2083 default_event_name = event_get_default_agent_ust_name(
2084 domain->type);
2085 if (!default_event_name) {
2086 ret = LTTNG_ERR_FATAL;
2087 goto error;
2088 }
2089 strncpy(uevent.name, default_event_name, sizeof(uevent.name));
2090 uevent.name[sizeof(uevent.name) - 1] = '\0';
2091
2092 /*
2093 * The domain type is changed because we are about to enable the
2094 * default channel and event for the JUL domain that are hardcoded.
2095 * This happens in the UST domain.
2096 */
2097 memcpy(&tmp_dom, domain, sizeof(tmp_dom));
2098 tmp_dom.type = LTTNG_DOMAIN_UST;
2099
2100 switch (domain->type) {
2101 case LTTNG_DOMAIN_LOG4J:
2102 default_chan_name = DEFAULT_LOG4J_CHANNEL_NAME;
2103 break;
2104 case LTTNG_DOMAIN_JUL:
2105 default_chan_name = DEFAULT_JUL_CHANNEL_NAME;
2106 break;
2107 case LTTNG_DOMAIN_PYTHON:
2108 default_chan_name = DEFAULT_PYTHON_CHANNEL_NAME;
2109 break;
2110 default:
2111 /* The switch/case we are in makes this impossible */
2112 assert(0);
2113 }
2114
2115 {
2116 char *filter_expression_copy = NULL;
2117 struct lttng_filter_bytecode *filter_copy = NULL;
2118
2119 if (filter) {
2120 const size_t filter_size = sizeof(
2121 struct lttng_filter_bytecode)
2122 + filter->len;
2123
2124 filter_copy = zmalloc(filter_size);
2125 if (!filter_copy) {
2126 ret = LTTNG_ERR_NOMEM;
2127 goto error;
2128 }
2129 memcpy(filter_copy, filter, filter_size);
2130
2131 filter_expression_copy =
2132 strdup(filter_expression);
2133 if (!filter_expression) {
2134 ret = LTTNG_ERR_NOMEM;
2135 }
2136
2137 if (!filter_expression_copy || !filter_copy) {
2138 free(filter_expression_copy);
2139 free(filter_copy);
2140 goto error;
2141 }
2142 }
2143
2144 ret = cmd_enable_event_internal(session, &tmp_dom,
2145 (char *) default_chan_name,
2146 &uevent, filter_expression_copy,
2147 filter_copy, NULL, wpipe);
2148 }
2149
2150 if (ret == LTTNG_ERR_UST_EVENT_ENABLED) {
2151 goto already_enabled;
2152 } else if (ret != LTTNG_OK) {
2153 goto error;
2154 }
2155
2156 /* The wild card * means that everything should be enabled. */
2157 if (strncmp(event->name, "*", 1) == 0 && strlen(event->name) == 1) {
2158 ret = event_agent_enable_all(usess, agt, event, filter,
2159 filter_expression);
2160 } else {
2161 ret = event_agent_enable(usess, agt, event, filter,
2162 filter_expression);
2163 }
2164 filter = NULL;
2165 filter_expression = NULL;
2166 if (ret != LTTNG_OK) {
2167 goto error;
2168 }
2169
2170 break;
2171 }
2172 default:
2173 ret = LTTNG_ERR_UND;
2174 goto error;
2175 }
2176
2177 ret = LTTNG_OK;
2178
2179 already_enabled:
2180 error:
2181 free(filter_expression);
2182 free(filter);
2183 free(exclusion);
2184 free(attr);
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 if (lttng_strncpy(list[idx].name, output->name,
3363 sizeof(list[idx].name))) {
3364 ret = -LTTNG_ERR_INVALID;
3365 goto error;
3366 }
3367 if (output->consumer->type == CONSUMER_DST_LOCAL) {
3368 if (lttng_strncpy(list[idx].ctrl_url,
3369 output->consumer->dst.trace_path,
3370 sizeof(list[idx].ctrl_url))) {
3371 ret = -LTTNG_ERR_INVALID;
3372 goto error;
3373 }
3374 } else {
3375 /* Control URI. */
3376 ret = uri_to_str_url(&output->consumer->dst.net.control,
3377 list[idx].ctrl_url, sizeof(list[idx].ctrl_url));
3378 if (ret < 0) {
3379 ret = -LTTNG_ERR_NOMEM;
3380 goto error;
3381 }
3382
3383 /* Data URI. */
3384 ret = uri_to_str_url(&output->consumer->dst.net.data,
3385 list[idx].data_url, sizeof(list[idx].data_url));
3386 if (ret < 0) {
3387 ret = -LTTNG_ERR_NOMEM;
3388 goto error;
3389 }
3390 }
3391 idx++;
3392 }
3393
3394 *outputs = list;
3395 list = NULL;
3396 ret = session->snapshot.nb_output;
3397 error:
3398 free(list);
3399 rcu_read_unlock();
3400 return ret;
3401 }
3402
3403 /*
3404 * Check if we can regenerate the metadata for this session.
3405 * Only kernel, UST per-uid and non-live sessions are supported.
3406 *
3407 * Return 0 if the metadata can be generated, a LTTNG_ERR code otherwise.
3408 */
3409 static
3410 int check_metadata_regenerate_support(struct ltt_session *session)
3411 {
3412 int ret;
3413
3414 assert(session);
3415
3416 if (session->live_timer != 0) {
3417 ret = LTTNG_ERR_LIVE_SESSION;
3418 goto end;
3419 }
3420 if (!session->active) {
3421 ret = LTTNG_ERR_SESSION_NOT_STARTED;
3422 goto end;
3423 }
3424 if (session->ust_session) {
3425 switch (session->ust_session->buffer_type) {
3426 case LTTNG_BUFFER_PER_UID:
3427 break;
3428 case LTTNG_BUFFER_PER_PID:
3429 ret = LTTNG_ERR_PER_PID_SESSION;
3430 goto end;
3431 default:
3432 assert(0);
3433 ret = LTTNG_ERR_UNK;
3434 goto end;
3435 }
3436 }
3437 if (session->consumer->type == CONSUMER_DST_NET &&
3438 session->consumer->relay_minor_version < 8) {
3439 ret = LTTNG_ERR_RELAYD_VERSION_FAIL;
3440 goto end;
3441 }
3442 ret = 0;
3443
3444 end:
3445 return ret;
3446 }
3447
3448 static
3449 int ust_metadata_regenerate(struct ltt_ust_session *usess)
3450 {
3451 int ret = 0;
3452 struct buffer_reg_uid *uid_reg = NULL;
3453 struct buffer_reg_session *session_reg = NULL;
3454
3455 rcu_read_lock();
3456 cds_list_for_each_entry(uid_reg, &usess->buffer_reg_uid_list, lnode) {
3457 struct ust_registry_session *registry;
3458 struct ust_registry_channel *chan;
3459 struct lttng_ht_iter iter_chan;
3460
3461 session_reg = uid_reg->registry;
3462 registry = session_reg->reg.ust;
3463
3464 pthread_mutex_lock(&registry->lock);
3465 registry->metadata_len_sent = 0;
3466 memset(registry->metadata, 0, registry->metadata_alloc_len);
3467 registry->metadata_len = 0;
3468 registry->metadata_version++;
3469 ret = ust_metadata_session_statedump(registry, NULL,
3470 registry->major, registry->minor);
3471 if (ret) {
3472 pthread_mutex_unlock(&registry->lock);
3473 ERR("Failed to generate session metadata (err = %d)",
3474 ret);
3475 goto end;
3476 }
3477 cds_lfht_for_each_entry(registry->channels->ht, &iter_chan.iter,
3478 chan, node.node) {
3479 struct ust_registry_event *event;
3480 struct lttng_ht_iter iter_event;
3481
3482 ret = ust_metadata_channel_statedump(registry, chan);
3483 if (ret) {
3484 pthread_mutex_unlock(&registry->lock);
3485 ERR("Failed to generate channel metadata "
3486 "(err = %d)", ret);
3487 goto end;
3488 }
3489 cds_lfht_for_each_entry(chan->ht->ht, &iter_event.iter,
3490 event, node.node) {
3491 ret = ust_metadata_event_statedump(registry,
3492 chan, event);
3493 if (ret) {
3494 pthread_mutex_unlock(&registry->lock);
3495 ERR("Failed to generate event metadata "
3496 "(err = %d)", ret);
3497 goto end;
3498 }
3499 }
3500 }
3501 pthread_mutex_unlock(&registry->lock);
3502 }
3503
3504 end:
3505 rcu_read_unlock();
3506 return ret;
3507 }
3508
3509 /*
3510 * Command LTTNG_METADATA_REGENERATE from the lttng-ctl library.
3511 *
3512 * Ask the consumer to truncate the existing metadata file(s) and
3513 * then regenerate the metadata. Live and per-pid sessions are not
3514 * supported and return an error.
3515 *
3516 * Return 0 on success or else a LTTNG_ERR code.
3517 */
3518 int cmd_metadata_regenerate(struct ltt_session *session)
3519 {
3520 int ret;
3521
3522 assert(session);
3523
3524 ret = check_metadata_regenerate_support(session);
3525 if (ret) {
3526 goto end;
3527 }
3528
3529 if (session->kernel_session) {
3530 ret = kernctl_session_metadata_regenerate(
3531 session->kernel_session->fd);
3532 if (ret < 0) {
3533 ERR("Failed to regenerate the kernel metadata");
3534 goto end;
3535 }
3536 }
3537
3538 if (session->ust_session) {
3539 ret = ust_metadata_regenerate(session->ust_session);
3540 if (ret < 0) {
3541 ERR("Failed to regenerate the UST metadata");
3542 goto end;
3543 }
3544 }
3545 DBG("Cmd metadata regenerate for session %s", session->name);
3546 ret = LTTNG_OK;
3547
3548 end:
3549 return ret;
3550 }
3551
3552
3553 /*
3554 * Send relayd sockets from snapshot output to consumer. Ignore request if the
3555 * snapshot output is *not* set with a remote destination.
3556 *
3557 * Return 0 on success or a LTTNG_ERR code.
3558 */
3559 static int set_relayd_for_snapshot(struct consumer_output *consumer,
3560 struct snapshot_output *snap_output, struct ltt_session *session)
3561 {
3562 int ret = LTTNG_OK;
3563 struct lttng_ht_iter iter;
3564 struct consumer_socket *socket;
3565
3566 assert(consumer);
3567 assert(snap_output);
3568 assert(session);
3569
3570 DBG2("Set relayd object from snapshot output");
3571
3572 /* Ignore if snapshot consumer output is not network. */
3573 if (snap_output->consumer->type != CONSUMER_DST_NET) {
3574 goto error;
3575 }
3576
3577 /*
3578 * For each consumer socket, create and send the relayd object of the
3579 * snapshot output.
3580 */
3581 rcu_read_lock();
3582 cds_lfht_for_each_entry(snap_output->consumer->socks->ht, &iter.iter,
3583 socket, node.node) {
3584 ret = send_consumer_relayd_sockets(0, session->id,
3585 snap_output->consumer, socket,
3586 session->name, session->hostname,
3587 session->live_timer);
3588 if (ret != LTTNG_OK) {
3589 rcu_read_unlock();
3590 goto error;
3591 }
3592 }
3593 rcu_read_unlock();
3594
3595 error:
3596 return ret;
3597 }
3598
3599 /*
3600 * Record a kernel snapshot.
3601 *
3602 * Return LTTNG_OK on success or a LTTNG_ERR code.
3603 */
3604 static int record_kernel_snapshot(struct ltt_kernel_session *ksess,
3605 struct snapshot_output *output, struct ltt_session *session,
3606 int wait, uint64_t nb_packets_per_stream)
3607 {
3608 int ret;
3609
3610 assert(ksess);
3611 assert(output);
3612 assert(session);
3613
3614
3615 /*
3616 * Copy kernel session sockets so we can communicate with the right
3617 * consumer for the snapshot record command.
3618 */
3619 ret = consumer_copy_sockets(output->consumer, ksess->consumer);
3620 if (ret < 0) {
3621 ret = LTTNG_ERR_NOMEM;
3622 goto error;
3623 }
3624
3625 ret = set_relayd_for_snapshot(ksess->consumer, output, session);
3626 if (ret != LTTNG_OK) {
3627 goto error_snapshot;
3628 }
3629
3630 ret = kernel_snapshot_record(ksess, output, wait, nb_packets_per_stream);
3631 if (ret != LTTNG_OK) {
3632 goto error_snapshot;
3633 }
3634
3635 ret = LTTNG_OK;
3636 goto end;
3637
3638 error_snapshot:
3639 /* Clean up copied sockets so this output can use some other later on. */
3640 consumer_destroy_output_sockets(output->consumer);
3641 error:
3642 end:
3643 return ret;
3644 }
3645
3646 /*
3647 * Record a UST snapshot.
3648 *
3649 * Return 0 on success or a LTTNG_ERR error code.
3650 */
3651 static int record_ust_snapshot(struct ltt_ust_session *usess,
3652 struct snapshot_output *output, struct ltt_session *session,
3653 int wait, uint64_t nb_packets_per_stream)
3654 {
3655 int ret;
3656
3657 assert(usess);
3658 assert(output);
3659 assert(session);
3660
3661 /*
3662 * Copy UST session sockets so we can communicate with the right
3663 * consumer for the snapshot record command.
3664 */
3665 ret = consumer_copy_sockets(output->consumer, usess->consumer);
3666 if (ret < 0) {
3667 ret = LTTNG_ERR_NOMEM;
3668 goto error;
3669 }
3670
3671 ret = set_relayd_for_snapshot(usess->consumer, output, session);
3672 if (ret != LTTNG_OK) {
3673 goto error_snapshot;
3674 }
3675
3676 ret = ust_app_snapshot_record(usess, output, wait, nb_packets_per_stream);
3677 if (ret < 0) {
3678 switch (-ret) {
3679 case EINVAL:
3680 ret = LTTNG_ERR_INVALID;
3681 break;
3682 default:
3683 ret = LTTNG_ERR_SNAPSHOT_FAIL;
3684 break;
3685 }
3686 goto error_snapshot;
3687 }
3688
3689 ret = LTTNG_OK;
3690
3691 error_snapshot:
3692 /* Clean up copied sockets so this output can use some other later on. */
3693 consumer_destroy_output_sockets(output->consumer);
3694 error:
3695 return ret;
3696 }
3697
3698 static
3699 uint64_t get_session_size_one_more_packet_per_stream(struct ltt_session *session,
3700 uint64_t cur_nr_packets)
3701 {
3702 uint64_t tot_size = 0;
3703
3704 if (session->kernel_session) {
3705 struct ltt_kernel_channel *chan;
3706 struct ltt_kernel_session *ksess = session->kernel_session;
3707
3708 cds_list_for_each_entry(chan, &ksess->channel_list.head, list) {
3709 if (cur_nr_packets >= chan->channel->attr.num_subbuf) {
3710 /*
3711 * Don't take channel into account if we
3712 * already grab all its packets.
3713 */
3714 continue;
3715 }
3716 tot_size += chan->channel->attr.subbuf_size
3717 * chan->stream_count;
3718 }
3719 }
3720
3721 if (session->ust_session) {
3722 struct ltt_ust_session *usess = session->ust_session;
3723
3724 tot_size += ust_app_get_size_one_more_packet_per_stream(usess,
3725 cur_nr_packets);
3726 }
3727
3728 return tot_size;
3729 }
3730
3731 /*
3732 * Calculate the number of packets we can grab from each stream that
3733 * fits within the overall snapshot max size.
3734 *
3735 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
3736 * the number of packets per stream.
3737 *
3738 * TODO: this approach is not perfect: we consider the worse case
3739 * (packet filling the sub-buffers) as an upper bound, but we could do
3740 * better if we do this calculation while we actually grab the packet
3741 * content: we would know how much padding we don't actually store into
3742 * the file.
3743 *
3744 * This algorithm is currently bounded by the number of packets per
3745 * stream.
3746 *
3747 * Since we call this algorithm before actually grabbing the data, it's
3748 * an approximation: for instance, applications could appear/disappear
3749 * in between this call and actually grabbing data.
3750 */
3751 static
3752 int64_t get_session_nb_packets_per_stream(struct ltt_session *session, uint64_t max_size)
3753 {
3754 int64_t size_left;
3755 uint64_t cur_nb_packets = 0;
3756
3757 if (!max_size) {
3758 return 0; /* Infinite */
3759 }
3760
3761 size_left = max_size;
3762 for (;;) {
3763 uint64_t one_more_packet_tot_size;
3764
3765 one_more_packet_tot_size = get_session_size_one_more_packet_per_stream(session,
3766 cur_nb_packets);
3767 if (!one_more_packet_tot_size) {
3768 /* We are already grabbing all packets. */
3769 break;
3770 }
3771 size_left -= one_more_packet_tot_size;
3772 if (size_left < 0) {
3773 break;
3774 }
3775 cur_nb_packets++;
3776 }
3777 if (!cur_nb_packets) {
3778 /* Not enough room to grab one packet of each stream, error. */
3779 return -1;
3780 }
3781 return cur_nb_packets;
3782 }
3783
3784 /*
3785 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3786 *
3787 * The wait parameter is ignored so this call always wait for the snapshot to
3788 * complete before returning.
3789 *
3790 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3791 */
3792 int cmd_snapshot_record(struct ltt_session *session,
3793 struct lttng_snapshot_output *output, int wait)
3794 {
3795 int ret = LTTNG_OK;
3796 unsigned int use_tmp_output = 0;
3797 struct snapshot_output tmp_output;
3798 unsigned int snapshot_success = 0;
3799 char datetime[16];
3800
3801 assert(session);
3802 assert(output);
3803
3804 DBG("Cmd snapshot record for session %s", session->name);
3805
3806 /* Get the datetime for the snapshot output directory. */
3807 ret = utils_get_current_time_str("%Y%m%d-%H%M%S", datetime,
3808 sizeof(datetime));
3809 if (!ret) {
3810 ret = LTTNG_ERR_INVALID;
3811 goto error;
3812 }
3813
3814 /*
3815 * Permission denied to create an output if the session is not
3816 * set in no output mode.
3817 */
3818 if (session->output_traces) {
3819 ret = LTTNG_ERR_EPERM;
3820 goto error;
3821 }
3822
3823 /* The session needs to be started at least once. */
3824 if (!session->has_been_started) {
3825 ret = LTTNG_ERR_START_SESSION_ONCE;
3826 goto error;
3827 }
3828
3829 /* Use temporary output for the session. */
3830 if (*output->ctrl_url != '\0') {
3831 ret = snapshot_output_init(output->max_size, output->name,
3832 output->ctrl_url, output->data_url, session->consumer,
3833 &tmp_output, NULL);
3834 if (ret < 0) {
3835 if (ret == -ENOMEM) {
3836 ret = LTTNG_ERR_NOMEM;
3837 } else {
3838 ret = LTTNG_ERR_INVALID;
3839 }
3840 goto error;
3841 }
3842 /* Use the global session count for the temporary snapshot. */
3843 tmp_output.nb_snapshot = session->snapshot.nb_snapshot;
3844
3845 /* Use the global datetime */
3846 memcpy(tmp_output.datetime, datetime, sizeof(datetime));
3847 use_tmp_output = 1;
3848 }
3849
3850 if (use_tmp_output) {
3851 int64_t nb_packets_per_stream;
3852
3853 nb_packets_per_stream = get_session_nb_packets_per_stream(session,
3854 tmp_output.max_size);
3855 if (nb_packets_per_stream < 0) {
3856 ret = LTTNG_ERR_MAX_SIZE_INVALID;
3857 goto error;
3858 }
3859
3860 if (session->kernel_session) {
3861 ret = record_kernel_snapshot(session->kernel_session,
3862 &tmp_output, session,
3863 wait, nb_packets_per_stream);
3864 if (ret != LTTNG_OK) {
3865 goto error;
3866 }
3867 }
3868
3869 if (session->ust_session) {
3870 ret = record_ust_snapshot(session->ust_session,
3871 &tmp_output, session,
3872 wait, nb_packets_per_stream);
3873 if (ret != LTTNG_OK) {
3874 goto error;
3875 }
3876 }
3877
3878 snapshot_success = 1;
3879 } else {
3880 struct snapshot_output *sout;
3881 struct lttng_ht_iter iter;
3882
3883 rcu_read_lock();
3884 cds_lfht_for_each_entry(session->snapshot.output_ht->ht,
3885 &iter.iter, sout, node.node) {
3886 int64_t nb_packets_per_stream;
3887
3888 /*
3889 * Make a local copy of the output and assign the possible
3890 * temporary value given by the caller.
3891 */
3892 memset(&tmp_output, 0, sizeof(tmp_output));
3893 memcpy(&tmp_output, sout, sizeof(tmp_output));
3894
3895 if (output->max_size != (uint64_t) -1ULL) {
3896 tmp_output.max_size = output->max_size;
3897 }
3898
3899 nb_packets_per_stream = get_session_nb_packets_per_stream(session,
3900 tmp_output.max_size);
3901 if (nb_packets_per_stream < 0) {
3902 ret = LTTNG_ERR_MAX_SIZE_INVALID;
3903 rcu_read_unlock();
3904 goto error;
3905 }
3906
3907 /* Use temporary name. */
3908 if (*output->name != '\0') {
3909 if (lttng_strncpy(tmp_output.name, output->name,
3910 sizeof(tmp_output.name))) {
3911 ret = LTTNG_ERR_INVALID;
3912 rcu_read_unlock();
3913 goto error;
3914 }
3915 }
3916
3917 tmp_output.nb_snapshot = session->snapshot.nb_snapshot;
3918 memcpy(tmp_output.datetime, datetime, sizeof(datetime));
3919
3920 if (session->kernel_session) {
3921 ret = record_kernel_snapshot(session->kernel_session,
3922 &tmp_output, session,
3923 wait, nb_packets_per_stream);
3924 if (ret != LTTNG_OK) {
3925 rcu_read_unlock();
3926 goto error;
3927 }
3928 }
3929
3930 if (session->ust_session) {
3931 ret = record_ust_snapshot(session->ust_session,
3932 &tmp_output, session,
3933 wait, nb_packets_per_stream);
3934 if (ret != LTTNG_OK) {
3935 rcu_read_unlock();
3936 goto error;
3937 }
3938 }
3939 snapshot_success = 1;
3940 }
3941 rcu_read_unlock();
3942 }
3943
3944 if (snapshot_success) {
3945 session->snapshot.nb_snapshot++;
3946 } else {
3947 ret = LTTNG_ERR_SNAPSHOT_FAIL;
3948 }
3949
3950 error:
3951 return ret;
3952 }
3953
3954 /*
3955 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
3956 */
3957 int cmd_set_session_shm_path(struct ltt_session *session,
3958 const char *shm_path)
3959 {
3960 /* Safety net */
3961 assert(session);
3962
3963 /*
3964 * Can only set shm path before session is started.
3965 */
3966 if (session->has_been_started) {
3967 return LTTNG_ERR_SESSION_STARTED;
3968 }
3969
3970 strncpy(session->shm_path, shm_path,
3971 sizeof(session->shm_path));
3972 session->shm_path[sizeof(session->shm_path) - 1] = '\0';
3973
3974 return 0;
3975 }
3976
3977 /*
3978 * Init command subsystem.
3979 */
3980 void cmd_init(void)
3981 {
3982 /*
3983 * Set network sequence index to 1 for streams to match a relayd
3984 * socket on the consumer side.
3985 */
3986 pthread_mutex_lock(&relayd_net_seq_idx_lock);
3987 relayd_net_seq_idx = 1;
3988 pthread_mutex_unlock(&relayd_net_seq_idx_lock);
3989
3990 DBG("Command subsystem initialized");
3991 }
LTTng 2.0 tools and control repository
This page took 0.168869 seconds and 4 git commands to generate.