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