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