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