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