projects / lttng-tools.git / blob
? search:


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