projects / lttng-tools.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Fix: illegal memory access in list_lttng_channels
[lttng-tools.git] / src / bin / lttng-sessiond / cmd.c
1 /*
2 * Copyright (C) 2012 - David Goulet <dgoulet@efficios.com>
3 *
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License, version 2 only, as
6 * published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
11 * more details.
12 *
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 51
15 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
16 */
17
18 #define _GNU_SOURCE
19 #define _LGPL_SOURCE
20 #include <assert.h>
21 #include <string.h>
22 #include <inttypes.h>
23 #include <urcu/list.h>
24 #include <urcu/uatomic.h>
25
26 #include <common/defaults.h>
27 #include <common/common.h>
28 #include <common/sessiond-comm/sessiond-comm.h>
29 #include <common/relayd/relayd.h>
30 #include <common/utils.h>
31
32 #include "channel.h"
33 #include "consumer.h"
34 #include "event.h"
35 #include "health-sessiond.h"
36 #include "kernel.h"
37 #include "kernel-consumer.h"
38 #include "lttng-sessiond.h"
39 #include "utils.h"
40 #include "syscall.h"
41
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 /*
1072 * The ringbuffer (both in user space and kernel) behave badly in overwrite
1073 * mode and with less than 2 subbuf so block it right away and send back an
1074 * invalid attribute error.
1075 */
1076 if (attr->attr.overwrite && attr->attr.num_subbuf < 2) {
1077 ret = LTTNG_ERR_INVALID;
1078 goto error;
1079 }
1080
1081 switch (domain->type) {
1082 case LTTNG_DOMAIN_KERNEL:
1083 {
1084 struct ltt_kernel_channel *kchan;
1085
1086 kchan = trace_kernel_get_channel_by_name(attr->name,
1087 session->kernel_session);
1088 if (kchan == NULL) {
1089 ret = channel_kernel_create(session->kernel_session, attr, wpipe);
1090 if (attr->name[0] != '\0') {
1091 session->kernel_session->has_non_default_channel = 1;
1092 }
1093 } else {
1094 ret = channel_kernel_enable(session->kernel_session, kchan);
1095 }
1096
1097 if (ret != LTTNG_OK) {
1098 goto error;
1099 }
1100
1101 kernel_wait_quiescent(kernel_tracer_fd);
1102 break;
1103 }
1104 case LTTNG_DOMAIN_UST:
1105 case LTTNG_DOMAIN_JUL:
1106 case LTTNG_DOMAIN_LOG4J:
1107 case LTTNG_DOMAIN_PYTHON:
1108 {
1109 struct ltt_ust_channel *uchan;
1110
1111 /*
1112 * FIXME
1113 *
1114 * Current agent implementation limitations force us to allow
1115 * only one channel at once in "agent" subdomains. Each
1116 * subdomain has a default channel name which must be strictly
1117 * adhered to.
1118 */
1119 if (domain->type == LTTNG_DOMAIN_JUL) {
1120 if (strncmp(attr->name, DEFAULT_JUL_CHANNEL_NAME,
1121 LTTNG_SYMBOL_NAME_LEN)) {
1122 ret = LTTNG_ERR_INVALID_CHANNEL_NAME;
1123 goto error;
1124 }
1125 } else if (domain->type == LTTNG_DOMAIN_LOG4J) {
1126 if (strncmp(attr->name, DEFAULT_LOG4J_CHANNEL_NAME,
1127 LTTNG_SYMBOL_NAME_LEN)) {
1128 ret = LTTNG_ERR_INVALID_CHANNEL_NAME;
1129 goto error;
1130 }
1131 } else if (domain->type == LTTNG_DOMAIN_PYTHON) {
1132 if (strncmp(attr->name, DEFAULT_PYTHON_CHANNEL_NAME,
1133 LTTNG_SYMBOL_NAME_LEN)) {
1134 ret = LTTNG_ERR_INVALID_CHANNEL_NAME;
1135 goto error;
1136 }
1137 }
1138
1139 chan_ht = usess->domain_global.channels;
1140
1141 uchan = trace_ust_find_channel_by_name(chan_ht, attr->name);
1142 if (uchan == NULL) {
1143 ret = channel_ust_create(usess, attr, domain->buf_type);
1144 if (attr->name[0] != '\0') {
1145 usess->has_non_default_channel = 1;
1146 }
1147 } else {
1148 ret = channel_ust_enable(usess, uchan);
1149 }
1150 break;
1151 }
1152 default:
1153 ret = LTTNG_ERR_UNKNOWN_DOMAIN;
1154 goto error;
1155 }
1156
1157 error:
1158 rcu_read_unlock();
1159 end:
1160 return ret;
1161 }
1162
1163 /*
1164 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1165 */
1166 int cmd_disable_event(struct ltt_session *session, int domain,
1167 char *channel_name,
1168 struct lttng_event *event)
1169 {
1170 int ret;
1171 char *event_name;
1172
1173 DBG("Disable event command for event \'%s\'", event->name);
1174
1175 event_name = event->name;
1176 if (validate_event_name(event_name)) {
1177 ret = LTTNG_ERR_INVALID_EVENT_NAME;
1178 goto error;
1179 }
1180
1181 /* Error out on unhandled search criteria */
1182 if (event->loglevel_type || event->loglevel != -1 || event->enabled
1183 || event->pid || event->filter || event->exclusion) {
1184 ret = LTTNG_ERR_UNK;
1185 goto error;
1186 }
1187
1188 rcu_read_lock();
1189
1190 switch (domain) {
1191 case LTTNG_DOMAIN_KERNEL:
1192 {
1193 struct ltt_kernel_channel *kchan;
1194 struct ltt_kernel_session *ksess;
1195
1196 ksess = session->kernel_session;
1197
1198 /*
1199 * If a non-default channel has been created in the
1200 * session, explicitely require that -c chan_name needs
1201 * to be provided.
1202 */
1203 if (ksess->has_non_default_channel && channel_name[0] == '\0') {
1204 ret = LTTNG_ERR_NEED_CHANNEL_NAME;
1205 goto error_unlock;
1206 }
1207
1208 kchan = trace_kernel_get_channel_by_name(channel_name, ksess);
1209 if (kchan == NULL) {
1210 ret = LTTNG_ERR_KERN_CHAN_NOT_FOUND;
1211 goto error_unlock;
1212 }
1213
1214 switch (event->type) {
1215 case LTTNG_EVENT_ALL:
1216 case LTTNG_EVENT_TRACEPOINT:
1217 case LTTNG_EVENT_SYSCALL:
1218 case LTTNG_EVENT_PROBE:
1219 case LTTNG_EVENT_FUNCTION:
1220 case LTTNG_EVENT_FUNCTION_ENTRY:/* fall-through */
1221 if (event_name[0] == '\0') {
1222 ret = event_kernel_disable_event(kchan,
1223 NULL, event->type);
1224 } else {
1225 ret = event_kernel_disable_event(kchan,
1226 event_name, event->type);
1227 }
1228 if (ret != LTTNG_OK) {
1229 goto error_unlock;
1230 }
1231 break;
1232 default:
1233 ret = LTTNG_ERR_UNK;
1234 goto error_unlock;
1235 }
1236
1237 kernel_wait_quiescent(kernel_tracer_fd);
1238 break;
1239 }
1240 case LTTNG_DOMAIN_UST:
1241 {
1242 struct ltt_ust_channel *uchan;
1243 struct ltt_ust_session *usess;
1244
1245 usess = session->ust_session;
1246
1247 if (validate_ust_event_name(event_name)) {
1248 ret = LTTNG_ERR_INVALID_EVENT_NAME;
1249 goto error_unlock;
1250 }
1251
1252 /*
1253 * If a non-default channel has been created in the
1254 * session, explicitly require that -c chan_name needs
1255 * to be provided.
1256 */
1257 if (usess->has_non_default_channel && channel_name[0] == '\0') {
1258 ret = LTTNG_ERR_NEED_CHANNEL_NAME;
1259 goto error_unlock;
1260 }
1261
1262 uchan = trace_ust_find_channel_by_name(usess->domain_global.channels,
1263 channel_name);
1264 if (uchan == NULL) {
1265 ret = LTTNG_ERR_UST_CHAN_NOT_FOUND;
1266 goto error_unlock;
1267 }
1268
1269 switch (event->type) {
1270 case LTTNG_EVENT_ALL:
1271 /*
1272 * An empty event name means that everything
1273 * should be disabled.
1274 */
1275 if (event->name[0] == '\0') {
1276 ret = event_ust_disable_all_tracepoints(usess, uchan);
1277 } else {
1278 ret = event_ust_disable_tracepoint(usess, uchan,
1279 event_name);
1280 }
1281 if (ret != LTTNG_OK) {
1282 goto error_unlock;
1283 }
1284 break;
1285 default:
1286 ret = LTTNG_ERR_UNK;
1287 goto error_unlock;
1288 }
1289
1290 DBG3("Disable UST event %s in channel %s completed", event_name,
1291 channel_name);
1292 break;
1293 }
1294 case LTTNG_DOMAIN_LOG4J:
1295 case LTTNG_DOMAIN_JUL:
1296 case LTTNG_DOMAIN_PYTHON:
1297 {
1298 struct agent *agt;
1299 struct ltt_ust_session *usess = session->ust_session;
1300
1301 assert(usess);
1302
1303 switch (event->type) {
1304 case LTTNG_EVENT_ALL:
1305 break;
1306 default:
1307 ret = LTTNG_ERR_UNK;
1308 goto error_unlock;
1309 }
1310
1311 agt = trace_ust_find_agent(usess, domain);
1312 if (!agt) {
1313 ret = -LTTNG_ERR_UST_EVENT_NOT_FOUND;
1314 goto error_unlock;
1315 }
1316 /*
1317 * An empty event name means that everything
1318 * should be disabled.
1319 */
1320 if (event->name[0] == '\0') {
1321 ret = event_agent_disable_all(usess, agt);
1322 } else {
1323 ret = event_agent_disable(usess, agt, event_name);
1324 }
1325 if (ret != LTTNG_OK) {
1326 goto error_unlock;
1327 }
1328
1329 break;
1330 }
1331 default:
1332 ret = LTTNG_ERR_UND;
1333 goto error_unlock;
1334 }
1335
1336 ret = LTTNG_OK;
1337
1338 error_unlock:
1339 rcu_read_unlock();
1340 error:
1341 return ret;
1342 }
1343
1344 /*
1345 * Command LTTNG_ADD_CONTEXT processed by the client thread.
1346 */
1347 int cmd_add_context(struct ltt_session *session, int domain,
1348 char *channel_name, struct lttng_event_context *ctx, int kwpipe)
1349 {
1350 int ret, chan_kern_created = 0, chan_ust_created = 0;
1351
1352 switch (domain) {
1353 case LTTNG_DOMAIN_KERNEL:
1354 assert(session->kernel_session);
1355
1356 if (session->kernel_session->channel_count == 0) {
1357 /* Create default channel */
1358 ret = channel_kernel_create(session->kernel_session, NULL, kwpipe);
1359 if (ret != LTTNG_OK) {
1360 goto error;
1361 }
1362 chan_kern_created = 1;
1363 }
1364 /* Add kernel context to kernel tracer */
1365 ret = context_kernel_add(session->kernel_session, ctx, channel_name);
1366 if (ret != LTTNG_OK) {
1367 goto error;
1368 }
1369 break;
1370 case LTTNG_DOMAIN_UST:
1371 {
1372 struct ltt_ust_session *usess = session->ust_session;
1373 unsigned int chan_count;
1374
1375 assert(usess);
1376
1377 chan_count = lttng_ht_get_count(usess->domain_global.channels);
1378 if (chan_count == 0) {
1379 struct lttng_channel *attr;
1380 /* Create default channel */
1381 attr = channel_new_default_attr(domain, usess->buffer_type);
1382 if (attr == NULL) {
1383 ret = LTTNG_ERR_FATAL;
1384 goto error;
1385 }
1386
1387 ret = channel_ust_create(usess, attr, usess->buffer_type);
1388 if (ret != LTTNG_OK) {
1389 free(attr);
1390 goto error;
1391 }
1392 free(attr);
1393 chan_ust_created = 1;
1394 }
1395
1396 ret = context_ust_add(usess, domain, ctx, channel_name);
1397 if (ret != LTTNG_OK) {
1398 goto error;
1399 }
1400 break;
1401 }
1402 default:
1403 ret = LTTNG_ERR_UND;
1404 goto error;
1405 }
1406
1407 return LTTNG_OK;
1408
1409 error:
1410 if (chan_kern_created) {
1411 struct ltt_kernel_channel *kchan =
1412 trace_kernel_get_channel_by_name(DEFAULT_CHANNEL_NAME,
1413 session->kernel_session);
1414 /* Created previously, this should NOT fail. */
1415 assert(kchan);
1416 kernel_destroy_channel(kchan);
1417 }
1418
1419 if (chan_ust_created) {
1420 struct ltt_ust_channel *uchan =
1421 trace_ust_find_channel_by_name(
1422 session->ust_session->domain_global.channels,
1423 DEFAULT_CHANNEL_NAME);
1424 /* Created previously, this should NOT fail. */
1425 assert(uchan);
1426 /* Remove from the channel list of the session. */
1427 trace_ust_delete_channel(session->ust_session->domain_global.channels,
1428 uchan);
1429 trace_ust_destroy_channel(uchan);
1430 }
1431 return ret;
1432 }
1433
1434 static int validate_event_name(const char *name)
1435 {
1436 int ret = 0;
1437 const char *c = name;
1438 const char *event_name_end = c + LTTNG_SYMBOL_NAME_LEN;
1439
1440 /*
1441 * Make sure that unescaped wildcards are only used as the last
1442 * character of the event name.
1443 */
1444 while (c < event_name_end) {
1445 switch (*c) {
1446 case '\0':
1447 goto end;
1448 case '\\':
1449 c++;
1450 break;
1451 case '*':
1452 if ((c + 1) < event_name_end && *(c + 1)) {
1453 /* Wildcard is not the last character */
1454 ret = LTTNG_ERR_INVALID_EVENT_NAME;
1455 goto end;
1456 }
1457 default:
1458 break;
1459 }
1460 c++;
1461 }
1462 end:
1463 return ret;
1464 }
1465
1466 static inline bool name_starts_with(const char *name, const char *prefix)
1467 {
1468 const size_t max_cmp_len = min(strlen(prefix), LTTNG_SYMBOL_NAME_LEN);
1469
1470 return !strncmp(name, prefix, max_cmp_len);
1471 }
1472
1473 /* Perform userspace-specific event name validation */
1474 static int validate_ust_event_name(const char *name)
1475 {
1476 int ret = 0;
1477
1478 if (!name) {
1479 ret = -1;
1480 goto end;
1481 }
1482
1483 /*
1484 * Check name against all internal UST event component namespaces used
1485 * by the agents.
1486 */
1487 if (name_starts_with(name, DEFAULT_JUL_EVENT_COMPONENT) ||
1488 name_starts_with(name, DEFAULT_LOG4J_EVENT_COMPONENT) ||
1489 name_starts_with(name, DEFAULT_PYTHON_EVENT_COMPONENT)) {
1490 ret = -1;
1491 }
1492
1493 end:
1494 return ret;
1495 }
1496
1497 /*
1498 * Internal version of cmd_enable_event() with a supplemental
1499 * "internal_event" flag which is used to enable internal events which should
1500 * be hidden from clients. Such events are used in the agent implementation to
1501 * enable the events through which all "agent" events are funeled.
1502 */
1503 static int _cmd_enable_event(struct ltt_session *session,
1504 struct lttng_domain *domain,
1505 char *channel_name, struct lttng_event *event,
1506 char *filter_expression,
1507 struct lttng_filter_bytecode *filter,
1508 struct lttng_event_exclusion *exclusion,
1509 int wpipe, bool internal_event)
1510 {
1511 int ret, channel_created = 0;
1512 struct lttng_channel *attr;
1513
1514 assert(session);
1515 assert(event);
1516 assert(channel_name);
1517
1518 DBG("Enable event command for event \'%s\'", event->name);
1519
1520 rcu_read_lock();
1521
1522 ret = validate_event_name(event->name);
1523 if (ret) {
1524 goto error;
1525 }
1526
1527 switch (domain->type) {
1528 case LTTNG_DOMAIN_KERNEL:
1529 {
1530 struct ltt_kernel_channel *kchan;
1531
1532 /*
1533 * If a non-default channel has been created in the
1534 * session, explicitely require that -c chan_name needs
1535 * to be provided.
1536 */
1537 if (session->kernel_session->has_non_default_channel
1538 && channel_name[0] == '\0') {
1539 ret = LTTNG_ERR_NEED_CHANNEL_NAME;
1540 goto error;
1541 }
1542
1543 kchan = trace_kernel_get_channel_by_name(channel_name,
1544 session->kernel_session);
1545 if (kchan == NULL) {
1546 attr = channel_new_default_attr(LTTNG_DOMAIN_KERNEL,
1547 LTTNG_BUFFER_GLOBAL);
1548 if (attr == NULL) {
1549 ret = LTTNG_ERR_FATAL;
1550 goto error;
1551 }
1552 if (lttng_strncpy(attr->name, channel_name,
1553 sizeof(attr->name))) {
1554 ret = LTTNG_ERR_INVALID;
1555 free(attr);
1556 goto error;
1557 }
1558
1559 ret = cmd_enable_channel(session, domain, attr, wpipe);
1560 if (ret != LTTNG_OK) {
1561 free(attr);
1562 goto error;
1563 }
1564 free(attr);
1565
1566 channel_created = 1;
1567 }
1568
1569 /* Get the newly created kernel channel pointer */
1570 kchan = trace_kernel_get_channel_by_name(channel_name,
1571 session->kernel_session);
1572 if (kchan == NULL) {
1573 /* This sould not happen... */
1574 ret = LTTNG_ERR_FATAL;
1575 goto error;
1576 }
1577
1578 switch (event->type) {
1579 case LTTNG_EVENT_ALL:
1580 {
1581 char *filter_expression_a = NULL;
1582 struct lttng_filter_bytecode *filter_a = NULL;
1583
1584 /*
1585 * We need to duplicate filter_expression and filter,
1586 * because ownership is passed to first enable
1587 * event.
1588 */
1589 if (filter_expression) {
1590 filter_expression_a = strdup(filter_expression);
1591 if (!filter_expression_a) {
1592 ret = LTTNG_ERR_FATAL;
1593 goto error;
1594 }
1595 }
1596 if (filter) {
1597 filter_a = zmalloc(sizeof(*filter_a) + filter->len);
1598 if (!filter_a) {
1599 free(filter_expression_a);
1600 ret = LTTNG_ERR_FATAL;
1601 goto error;
1602 }
1603 memcpy(filter_a, filter, sizeof(*filter_a) + filter->len);
1604 }
1605 event->type = LTTNG_EVENT_TRACEPOINT; /* Hack */
1606 ret = event_kernel_enable_event(kchan, event,
1607 filter_expression, filter);
1608 /* We have passed ownership */
1609 filter_expression = NULL;
1610 filter = NULL;
1611 if (ret != LTTNG_OK) {
1612 if (channel_created) {
1613 /* Let's not leak a useless channel. */
1614 kernel_destroy_channel(kchan);
1615 }
1616 free(filter_expression_a);
1617 free(filter_a);
1618 goto error;
1619 }
1620 event->type = LTTNG_EVENT_SYSCALL; /* Hack */
1621 ret = event_kernel_enable_event(kchan, event,
1622 filter_expression_a, filter_a);
1623 /* We have passed ownership */
1624 filter_expression_a = NULL;
1625 filter_a = NULL;
1626 if (ret != LTTNG_OK) {
1627 goto error;
1628 }
1629 break;
1630 }
1631 case LTTNG_EVENT_PROBE:
1632 case LTTNG_EVENT_FUNCTION:
1633 case LTTNG_EVENT_FUNCTION_ENTRY:
1634 case LTTNG_EVENT_TRACEPOINT:
1635 ret = event_kernel_enable_event(kchan, event,
1636 filter_expression, filter);
1637 /* We have passed ownership */
1638 filter_expression = NULL;
1639 filter = NULL;
1640 if (ret != LTTNG_OK) {
1641 if (channel_created) {
1642 /* Let's not leak a useless channel. */
1643 kernel_destroy_channel(kchan);
1644 }
1645 goto error;
1646 }
1647 break;
1648 case LTTNG_EVENT_SYSCALL:
1649 ret = event_kernel_enable_event(kchan, event,
1650 filter_expression, filter);
1651 /* We have passed ownership */
1652 filter_expression = NULL;
1653 filter = NULL;
1654 if (ret != LTTNG_OK) {
1655 goto error;
1656 }
1657 break;
1658 default:
1659 ret = LTTNG_ERR_UNK;
1660 goto error;
1661 }
1662
1663 kernel_wait_quiescent(kernel_tracer_fd);
1664 break;
1665 }
1666 case LTTNG_DOMAIN_UST:
1667 {
1668 struct ltt_ust_channel *uchan;
1669 struct ltt_ust_session *usess = session->ust_session;
1670
1671 assert(usess);
1672
1673 /*
1674 * If a non-default channel has been created in the
1675 * session, explicitely require that -c chan_name needs
1676 * to be provided.
1677 */
1678 if (usess->has_non_default_channel && channel_name[0] == '\0') {
1679 ret = LTTNG_ERR_NEED_CHANNEL_NAME;
1680 goto error;
1681 }
1682
1683 /* Get channel from global UST domain */
1684 uchan = trace_ust_find_channel_by_name(usess->domain_global.channels,
1685 channel_name);
1686 if (uchan == NULL) {
1687 /* Create default channel */
1688 attr = channel_new_default_attr(LTTNG_DOMAIN_UST,
1689 usess->buffer_type);
1690 if (attr == NULL) {
1691 ret = LTTNG_ERR_FATAL;
1692 goto error;
1693 }
1694 if (lttng_strncpy(attr->name, channel_name,
1695 sizeof(attr->name))) {
1696 ret = LTTNG_ERR_INVALID;
1697 free(attr);
1698 goto error;
1699 }
1700
1701 ret = cmd_enable_channel(session, domain, attr, wpipe);
1702 if (ret != LTTNG_OK) {
1703 free(attr);
1704 goto error;
1705 }
1706 free(attr);
1707
1708 /* Get the newly created channel reference back */
1709 uchan = trace_ust_find_channel_by_name(
1710 usess->domain_global.channels, channel_name);
1711 assert(uchan);
1712 }
1713
1714 if (uchan->domain != LTTNG_DOMAIN_UST && !internal_event) {
1715 /*
1716 * Don't allow users to add UST events to channels which
1717 * are assigned to a userspace subdomain (JUL, Log4J,
1718 * Python, etc.).
1719 */
1720 ret = LTTNG_ERR_INVALID_CHANNEL_DOMAIN;
1721 goto error;
1722 }
1723
1724 if (!internal_event) {
1725 /*
1726 * Ensure the event name is not reserved for internal
1727 * use.
1728 */
1729 ret = validate_ust_event_name(event->name);
1730 if (ret) {
1731 WARN("Userspace event name %s failed validation.",
1732 event->name ?
1733 event->name : "NULL");
1734 ret = LTTNG_ERR_INVALID_EVENT_NAME;
1735 goto error;
1736 }
1737 }
1738
1739 /* At this point, the session and channel exist on the tracer */
1740 ret = event_ust_enable_tracepoint(usess, uchan, event,
1741 filter_expression, filter, exclusion,
1742 internal_event);
1743 /* We have passed ownership */
1744 filter_expression = NULL;
1745 filter = NULL;
1746 exclusion = NULL;
1747 if (ret == LTTNG_ERR_UST_EVENT_ENABLED) {
1748 goto already_enabled;
1749 } else if (ret != LTTNG_OK) {
1750 goto error;
1751 }
1752 break;
1753 }
1754 case LTTNG_DOMAIN_LOG4J:
1755 case LTTNG_DOMAIN_JUL:
1756 case LTTNG_DOMAIN_PYTHON:
1757 {
1758 const char *default_event_name, *default_chan_name;
1759 struct agent *agt;
1760 struct lttng_event uevent;
1761 struct lttng_domain tmp_dom;
1762 struct ltt_ust_session *usess = session->ust_session;
1763
1764 assert(usess);
1765
1766 agt = trace_ust_find_agent(usess, domain->type);
1767 if (!agt) {
1768 agt = agent_create(domain->type);
1769 if (!agt) {
1770 ret = LTTNG_ERR_NOMEM;
1771 goto error;
1772 }
1773 agent_add(agt, usess->agents);
1774 }
1775
1776 /* Create the default tracepoint. */
1777 memset(&uevent, 0, sizeof(uevent));
1778 uevent.type = LTTNG_EVENT_TRACEPOINT;
1779 uevent.loglevel_type = LTTNG_EVENT_LOGLEVEL_ALL;
1780 default_event_name = event_get_default_agent_ust_name(
1781 domain->type);
1782 if (!default_event_name) {
1783 ret = LTTNG_ERR_FATAL;
1784 goto error;
1785 }
1786 strncpy(uevent.name, default_event_name, sizeof(uevent.name));
1787 uevent.name[sizeof(uevent.name) - 1] = '\0';
1788
1789 /*
1790 * The domain type is changed because we are about to enable the
1791 * default channel and event for the JUL domain that are hardcoded.
1792 * This happens in the UST domain.
1793 */
1794 memcpy(&tmp_dom, domain, sizeof(tmp_dom));
1795 tmp_dom.type = LTTNG_DOMAIN_UST;
1796
1797 switch (domain->type) {
1798 case LTTNG_DOMAIN_LOG4J:
1799 default_chan_name = DEFAULT_LOG4J_CHANNEL_NAME;
1800 break;
1801 case LTTNG_DOMAIN_JUL:
1802 default_chan_name = DEFAULT_JUL_CHANNEL_NAME;
1803 break;
1804 case LTTNG_DOMAIN_PYTHON:
1805 default_chan_name = DEFAULT_PYTHON_CHANNEL_NAME;
1806 break;
1807 default:
1808 /* The switch/case we are in should avoid this else big problem */
1809 assert(0);
1810 }
1811
1812 {
1813 char *filter_expression_copy = NULL;
1814 struct lttng_filter_bytecode *filter_copy = NULL;
1815
1816 if (filter) {
1817 const size_t filter_size = sizeof(
1818 struct lttng_filter_bytecode)
1819 + filter->len;
1820
1821 filter_copy = zmalloc(filter_size);
1822 if (!filter_copy) {
1823 ret = LTTNG_ERR_NOMEM;
1824 goto error;
1825 }
1826 memcpy(filter_copy, filter, filter_size);
1827
1828 filter_expression_copy =
1829 strdup(filter_expression);
1830 if (!filter_expression) {
1831 ret = LTTNG_ERR_NOMEM;
1832 }
1833
1834 if (!filter_expression_copy || !filter_copy) {
1835 free(filter_expression_copy);
1836 free(filter_copy);
1837 goto error;
1838 }
1839 }
1840
1841 ret = cmd_enable_event_internal(session, &tmp_dom,
1842 (char *) default_chan_name,
1843 &uevent, filter_expression_copy,
1844 filter_copy, NULL, wpipe);
1845 }
1846
1847 if (ret == LTTNG_ERR_UST_EVENT_ENABLED) {
1848 goto already_enabled;
1849 } else if (ret != LTTNG_OK) {
1850 goto error;
1851 }
1852
1853 /* The wild card * means that everything should be enabled. */
1854 if (strncmp(event->name, "*", 1) == 0 && strlen(event->name) == 1) {
1855 ret = event_agent_enable_all(usess, agt, event, filter,
1856 filter_expression);
1857 } else {
1858 ret = event_agent_enable(usess, agt, event, filter,
1859 filter_expression);
1860 }
1861 filter = NULL;
1862 filter_expression = NULL;
1863 if (ret != LTTNG_OK) {
1864 goto error;
1865 }
1866
1867 break;
1868 }
1869 default:
1870 ret = LTTNG_ERR_UND;
1871 goto error;
1872 }
1873
1874 ret = LTTNG_OK;
1875
1876 already_enabled:
1877 error:
1878 free(filter_expression);
1879 free(filter);
1880 free(exclusion);
1881 rcu_read_unlock();
1882 return ret;
1883 }
1884
1885 /*
1886 * Command LTTNG_ENABLE_EVENT processed by the client thread.
1887 * We own filter, exclusion, and filter_expression.
1888 */
1889 int cmd_enable_event(struct ltt_session *session, struct lttng_domain *domain,
1890 char *channel_name, struct lttng_event *event,
1891 char *filter_expression,
1892 struct lttng_filter_bytecode *filter,
1893 struct lttng_event_exclusion *exclusion,
1894 int wpipe)
1895 {
1896 return _cmd_enable_event(session, domain, channel_name, event,
1897 filter_expression, filter, exclusion, wpipe, false);
1898 }
1899
1900 /*
1901 * Enable an event which is internal to LTTng. An internal should
1902 * never be made visible to clients and are immune to checks such as
1903 * reserved names.
1904 */
1905 static int cmd_enable_event_internal(struct ltt_session *session,
1906 struct lttng_domain *domain,
1907 char *channel_name, struct lttng_event *event,
1908 char *filter_expression,
1909 struct lttng_filter_bytecode *filter,
1910 struct lttng_event_exclusion *exclusion,
1911 int wpipe)
1912 {
1913 return _cmd_enable_event(session, domain, channel_name, event,
1914 filter_expression, filter, exclusion, wpipe, true);
1915 }
1916
1917 /*
1918 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
1919 */
1920 ssize_t cmd_list_tracepoints(int domain, struct lttng_event **events)
1921 {
1922 int ret;
1923 ssize_t nb_events = 0;
1924
1925 switch (domain) {
1926 case LTTNG_DOMAIN_KERNEL:
1927 nb_events = kernel_list_events(kernel_tracer_fd, events);
1928 if (nb_events < 0) {
1929 ret = LTTNG_ERR_KERN_LIST_FAIL;
1930 goto error;
1931 }
1932 break;
1933 case LTTNG_DOMAIN_UST:
1934 nb_events = ust_app_list_events(events);
1935 if (nb_events < 0) {
1936 ret = LTTNG_ERR_UST_LIST_FAIL;
1937 goto error;
1938 }
1939 break;
1940 case LTTNG_DOMAIN_LOG4J:
1941 case LTTNG_DOMAIN_JUL:
1942 case LTTNG_DOMAIN_PYTHON:
1943 nb_events = agent_list_events(events, domain);
1944 if (nb_events < 0) {
1945 ret = LTTNG_ERR_UST_LIST_FAIL;
1946 goto error;
1947 }
1948 break;
1949 default:
1950 ret = LTTNG_ERR_UND;
1951 goto error;
1952 }
1953
1954 return nb_events;
1955
1956 error:
1957 /* Return negative value to differentiate return code */
1958 return -ret;
1959 }
1960
1961 /*
1962 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
1963 */
1964 ssize_t cmd_list_tracepoint_fields(int domain,
1965 struct lttng_event_field **fields)
1966 {
1967 int ret;
1968 ssize_t nb_fields = 0;
1969
1970 switch (domain) {
1971 case LTTNG_DOMAIN_UST:
1972 nb_fields = ust_app_list_event_fields(fields);
1973 if (nb_fields < 0) {
1974 ret = LTTNG_ERR_UST_LIST_FAIL;
1975 goto error;
1976 }
1977 break;
1978 case LTTNG_DOMAIN_KERNEL:
1979 default: /* fall-through */
1980 ret = LTTNG_ERR_UND;
1981 goto error;
1982 }
1983
1984 return nb_fields;
1985
1986 error:
1987 /* Return negative value to differentiate return code */
1988 return -ret;
1989 }
1990
1991 ssize_t cmd_list_syscalls(struct lttng_event **events)
1992 {
1993 return syscall_table_list(events);
1994 }
1995
1996 /*
1997 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
1998 *
1999 * Called with session lock held.
2000 */
2001 ssize_t cmd_list_tracker_pids(struct ltt_session *session,
2002 int domain, int32_t **pids)
2003 {
2004 int ret;
2005 ssize_t nr_pids = 0;
2006
2007 switch (domain) {
2008 case LTTNG_DOMAIN_KERNEL:
2009 {
2010 struct ltt_kernel_session *ksess;
2011
2012 ksess = session->kernel_session;
2013 nr_pids = kernel_list_tracker_pids(ksess, pids);
2014 if (nr_pids < 0) {
2015 ret = LTTNG_ERR_KERN_LIST_FAIL;
2016 goto error;
2017 }
2018 break;
2019 }
2020 case LTTNG_DOMAIN_UST:
2021 {
2022 struct ltt_ust_session *usess;
2023
2024 usess = session->ust_session;
2025 nr_pids = trace_ust_list_tracker_pids(usess, pids);
2026 if (nr_pids < 0) {
2027 ret = LTTNG_ERR_UST_LIST_FAIL;
2028 goto error;
2029 }
2030 break;
2031 }
2032 case LTTNG_DOMAIN_LOG4J:
2033 case LTTNG_DOMAIN_JUL:
2034 case LTTNG_DOMAIN_PYTHON:
2035 default:
2036 ret = LTTNG_ERR_UND;
2037 goto error;
2038 }
2039
2040 return nr_pids;
2041
2042 error:
2043 /* Return negative value to differentiate return code */
2044 return -ret;
2045 }
2046
2047 /*
2048 * Command LTTNG_START_TRACE processed by the client thread.
2049 *
2050 * Called with session mutex held.
2051 */
2052 int cmd_start_trace(struct ltt_session *session)
2053 {
2054 int ret;
2055 unsigned long nb_chan = 0;
2056 struct ltt_kernel_session *ksession;
2057 struct ltt_ust_session *usess;
2058
2059 assert(session);
2060
2061 /* Ease our life a bit ;) */
2062 ksession = session->kernel_session;
2063 usess = session->ust_session;
2064
2065 /* Is the session already started? */
2066 if (session->active) {
2067 ret = LTTNG_ERR_TRACE_ALREADY_STARTED;
2068 goto error;
2069 }
2070
2071 /*
2072 * Starting a session without channel is useless since after that it's not
2073 * possible to enable channel thus inform the client.
2074 */
2075 if (usess && usess->domain_global.channels) {
2076 rcu_read_lock();
2077 nb_chan += lttng_ht_get_count(usess->domain_global.channels);
2078 rcu_read_unlock();
2079 }
2080 if (ksession) {
2081 nb_chan += ksession->channel_count;
2082 }
2083 if (!nb_chan) {
2084 ret = LTTNG_ERR_NO_CHANNEL;
2085 goto error;
2086 }
2087
2088 /* Kernel tracing */
2089 if (ksession != NULL) {
2090 ret = start_kernel_session(ksession, kernel_tracer_fd);
2091 if (ret != LTTNG_OK) {
2092 goto error;
2093 }
2094 }
2095
2096 /* Flag session that trace should start automatically */
2097 if (usess) {
2098 /*
2099 * Even though the start trace might fail, flag this session active so
2100 * other application coming in are started by default.
2101 */
2102 usess->active = 1;
2103
2104 ret = ust_app_start_trace_all(usess);
2105 if (ret < 0) {
2106 ret = LTTNG_ERR_UST_START_FAIL;
2107 goto error;
2108 }
2109 }
2110
2111 /* Flag this after a successful start. */
2112 session->has_been_started = 1;
2113 session->active = 1;
2114
2115 ret = LTTNG_OK;
2116
2117 error:
2118 return ret;
2119 }
2120
2121 /*
2122 * Command LTTNG_STOP_TRACE processed by the client thread.
2123 */
2124 int cmd_stop_trace(struct ltt_session *session)
2125 {
2126 int ret;
2127 struct ltt_kernel_channel *kchan;
2128 struct ltt_kernel_session *ksession;
2129 struct ltt_ust_session *usess;
2130
2131 assert(session);
2132
2133 /* Short cut */
2134 ksession = session->kernel_session;
2135 usess = session->ust_session;
2136
2137 /* Session is not active. Skip everythong and inform the client. */
2138 if (!session->active) {
2139 ret = LTTNG_ERR_TRACE_ALREADY_STOPPED;
2140 goto error;
2141 }
2142
2143 /* Kernel tracer */
2144 if (ksession && ksession->active) {
2145 DBG("Stop kernel tracing");
2146
2147 /* Flush metadata if exist */
2148 if (ksession->metadata_stream_fd >= 0) {
2149 ret = kernel_metadata_flush_buffer(ksession->metadata_stream_fd);
2150 if (ret < 0) {
2151 ERR("Kernel metadata flush failed");
2152 }
2153 }
2154
2155 /* Flush all buffers before stopping */
2156 cds_list_for_each_entry(kchan, &ksession->channel_list.head, list) {
2157 ret = kernel_flush_buffer(kchan);
2158 if (ret < 0) {
2159 ERR("Kernel flush buffer error");
2160 }
2161 }
2162
2163 ret = kernel_stop_session(ksession);
2164 if (ret < 0) {
2165 ret = LTTNG_ERR_KERN_STOP_FAIL;
2166 goto error;
2167 }
2168
2169 kernel_wait_quiescent(kernel_tracer_fd);
2170
2171 ksession->active = 0;
2172 }
2173
2174 if (usess && usess->active) {
2175 /*
2176 * Even though the stop trace might fail, flag this session inactive so
2177 * other application coming in are not started by default.
2178 */
2179 usess->active = 0;
2180
2181 ret = ust_app_stop_trace_all(usess);
2182 if (ret < 0) {
2183 ret = LTTNG_ERR_UST_STOP_FAIL;
2184 goto error;
2185 }
2186 }
2187
2188 /* Flag inactive after a successful stop. */
2189 session->active = 0;
2190 ret = LTTNG_OK;
2191
2192 error:
2193 return ret;
2194 }
2195
2196 /*
2197 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2198 */
2199 int cmd_set_consumer_uri(struct ltt_session *session, size_t nb_uri,
2200 struct lttng_uri *uris)
2201 {
2202 int ret, i;
2203 struct ltt_kernel_session *ksess = session->kernel_session;
2204 struct ltt_ust_session *usess = session->ust_session;
2205
2206 assert(session);
2207 assert(uris);
2208 assert(nb_uri > 0);
2209
2210 /* Can't set consumer URI if the session is active. */
2211 if (session->active) {
2212 ret = LTTNG_ERR_TRACE_ALREADY_STARTED;
2213 goto error;
2214 }
2215
2216 /* Set the "global" consumer URIs */
2217 for (i = 0; i < nb_uri; i++) {
2218 ret = add_uri_to_consumer(session->consumer,
2219 &uris[i], 0, session->name);
2220 if (ret != LTTNG_OK) {
2221 goto error;
2222 }
2223 }
2224
2225 /* Set UST session URIs */
2226 if (session->ust_session) {
2227 for (i = 0; i < nb_uri; i++) {
2228 ret = add_uri_to_consumer(
2229 session->ust_session->consumer,
2230 &uris[i], LTTNG_DOMAIN_UST,
2231 session->name);
2232 if (ret != LTTNG_OK) {
2233 goto error;
2234 }
2235 }
2236 }
2237
2238 /* Set kernel session URIs */
2239 if (session->kernel_session) {
2240 for (i = 0; i < nb_uri; i++) {
2241 ret = add_uri_to_consumer(
2242 session->kernel_session->consumer,
2243 &uris[i], LTTNG_DOMAIN_KERNEL,
2244 session->name);
2245 if (ret != LTTNG_OK) {
2246 goto error;
2247 }
2248 }
2249 }
2250
2251 /*
2252 * Make sure to set the session in output mode after we set URI since a
2253 * session can be created without URL (thus flagged in no output mode).
2254 */
2255 session->output_traces = 1;
2256 if (ksess) {
2257 ksess->output_traces = 1;
2258 }
2259
2260 if (usess) {
2261 usess->output_traces = 1;
2262 }
2263
2264 /* All good! */
2265 ret = LTTNG_OK;
2266
2267 error:
2268 return ret;
2269 }
2270
2271 /*
2272 * Command LTTNG_CREATE_SESSION processed by the client thread.
2273 */
2274 int cmd_create_session_uri(char *name, struct lttng_uri *uris,
2275 size_t nb_uri, lttng_sock_cred *creds, unsigned int live_timer)
2276 {
2277 int ret;
2278 struct ltt_session *session;
2279
2280 assert(name);
2281 assert(creds);
2282
2283 /*
2284 * Verify if the session already exist
2285 *
2286 * XXX: There is no need for the session lock list here since the caller
2287 * (process_client_msg) is holding it. We might want to change that so a
2288 * single command does not lock the entire session list.
2289 */
2290 session = session_find_by_name(name);
2291 if (session != NULL) {
2292 ret = LTTNG_ERR_EXIST_SESS;
2293 goto find_error;
2294 }
2295
2296 /* Create tracing session in the registry */
2297 ret = session_create(name, LTTNG_SOCK_GET_UID_CRED(creds),
2298 LTTNG_SOCK_GET_GID_CRED(creds));
2299 if (ret != LTTNG_OK) {
2300 goto session_error;
2301 }
2302
2303 /*
2304 * Get the newly created session pointer back
2305 *
2306 * XXX: There is no need for the session lock list here since the caller
2307 * (process_client_msg) is holding it. We might want to change that so a
2308 * single command does not lock the entire session list.
2309 */
2310 session = session_find_by_name(name);
2311 assert(session);
2312
2313 session->live_timer = live_timer;
2314 /* Create default consumer output for the session not yet created. */
2315 session->consumer = consumer_create_output(CONSUMER_DST_LOCAL);
2316 if (session->consumer == NULL) {
2317 ret = LTTNG_ERR_FATAL;
2318 goto consumer_error;
2319 }
2320
2321 if (uris) {
2322 ret = cmd_set_consumer_uri(session, nb_uri, uris);
2323 if (ret != LTTNG_OK) {
2324 goto consumer_error;
2325 }
2326 session->output_traces = 1;
2327 } else {
2328 session->output_traces = 0;
2329 DBG2("Session %s created with no output", session->name);
2330 }
2331
2332 session->consumer->enabled = 1;
2333
2334 return LTTNG_OK;
2335
2336 consumer_error:
2337 session_destroy(session);
2338 session_error:
2339 find_error:
2340 return ret;
2341 }
2342
2343 /*
2344 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2345 */
2346 int cmd_create_session_snapshot(char *name, struct lttng_uri *uris,
2347 size_t nb_uri, lttng_sock_cred *creds)
2348 {
2349 int ret;
2350 struct ltt_session *session;
2351 struct snapshot_output *new_output = NULL;
2352
2353 assert(name);
2354 assert(creds);
2355
2356 /*
2357 * Create session in no output mode with URIs set to NULL. The uris we've
2358 * received are for a default snapshot output if one.
2359 */
2360 ret = cmd_create_session_uri(name, NULL, 0, creds, 0);
2361 if (ret != LTTNG_OK) {
2362 goto error;
2363 }
2364
2365 /* Get the newly created session pointer back. This should NEVER fail. */
2366 session = session_find_by_name(name);
2367 assert(session);
2368
2369 /* Flag session for snapshot mode. */
2370 session->snapshot_mode = 1;
2371
2372 /* Skip snapshot output creation if no URI is given. */
2373 if (nb_uri == 0) {
2374 goto end;
2375 }
2376
2377 new_output = snapshot_output_alloc();
2378 if (!new_output) {
2379 ret = LTTNG_ERR_NOMEM;
2380 goto error_snapshot_alloc;
2381 }
2382
2383 ret = snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE, NULL,
2384 uris, nb_uri, session->consumer, new_output, &session->snapshot);
2385 if (ret < 0) {
2386 if (ret == -ENOMEM) {
2387 ret = LTTNG_ERR_NOMEM;
2388 } else {
2389 ret = LTTNG_ERR_INVALID;
2390 }
2391 goto error_snapshot;
2392 }
2393
2394 rcu_read_lock();
2395 snapshot_add_output(&session->snapshot, new_output);
2396 rcu_read_unlock();
2397
2398 end:
2399 return LTTNG_OK;
2400
2401 error_snapshot:
2402 snapshot_output_destroy(new_output);
2403 error_snapshot_alloc:
2404 session_destroy(session);
2405 error:
2406 return ret;
2407 }
2408
2409 /*
2410 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2411 *
2412 * Called with session lock held.
2413 */
2414 int cmd_destroy_session(struct ltt_session *session, int wpipe)
2415 {
2416 int ret;
2417 struct ltt_ust_session *usess;
2418 struct ltt_kernel_session *ksess;
2419
2420 /* Safety net */
2421 assert(session);
2422
2423 usess = session->ust_session;
2424 ksess = session->kernel_session;
2425
2426 /* Clean kernel session teardown */
2427 kernel_destroy_session(ksess);
2428
2429 /* UST session teardown */
2430 if (usess) {
2431 /* Close any relayd session */
2432 consumer_output_send_destroy_relayd(usess->consumer);
2433
2434 /* Destroy every UST application related to this session. */
2435 ret = ust_app_destroy_trace_all(usess);
2436 if (ret) {
2437 ERR("Error in ust_app_destroy_trace_all");
2438 }
2439
2440 /* Clean up the rest. */
2441 trace_ust_destroy_session(usess);
2442 }
2443
2444 /*
2445 * Must notify the kernel thread here to update it's poll set in order to
2446 * remove the channel(s)' fd just destroyed.
2447 */
2448 ret = notify_thread_pipe(wpipe);
2449 if (ret < 0) {
2450 PERROR("write kernel poll pipe");
2451 }
2452
2453 ret = session_destroy(session);
2454
2455 return ret;
2456 }
2457
2458 /*
2459 * Command LTTNG_CALIBRATE processed by the client thread.
2460 */
2461 int cmd_calibrate(int domain, struct lttng_calibrate *calibrate)
2462 {
2463 int ret;
2464
2465 switch (domain) {
2466 case LTTNG_DOMAIN_KERNEL:
2467 {
2468 struct lttng_kernel_calibrate kcalibrate;
2469
2470 switch (calibrate->type) {
2471 case LTTNG_CALIBRATE_FUNCTION:
2472 default:
2473 /* Default and only possible calibrate option. */
2474 kcalibrate.type = LTTNG_KERNEL_CALIBRATE_KRETPROBE;
2475 break;
2476 }
2477
2478 ret = kernel_calibrate(kernel_tracer_fd, &kcalibrate);
2479 if (ret < 0) {
2480 ret = LTTNG_ERR_KERN_ENABLE_FAIL;
2481 goto error;
2482 }
2483 break;
2484 }
2485 case LTTNG_DOMAIN_UST:
2486 {
2487 struct lttng_ust_calibrate ucalibrate;
2488
2489 switch (calibrate->type) {
2490 case LTTNG_CALIBRATE_FUNCTION:
2491 default:
2492 /* Default and only possible calibrate option. */
2493 ucalibrate.type = LTTNG_UST_CALIBRATE_TRACEPOINT;
2494 break;
2495 }
2496
2497 ret = ust_app_calibrate_glb(&ucalibrate);
2498 if (ret < 0) {
2499 ret = LTTNG_ERR_UST_CALIBRATE_FAIL;
2500 goto error;
2501 }
2502 break;
2503 }
2504 default:
2505 ret = LTTNG_ERR_UND;
2506 goto error;
2507 }
2508
2509 ret = LTTNG_OK;
2510
2511 error:
2512 return ret;
2513 }
2514
2515 /*
2516 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2517 */
2518 int cmd_register_consumer(struct ltt_session *session, int domain,
2519 const char *sock_path, struct consumer_data *cdata)
2520 {
2521 int ret, sock;
2522 struct consumer_socket *socket = NULL;
2523
2524 assert(session);
2525 assert(cdata);
2526 assert(sock_path);
2527
2528 switch (domain) {
2529 case LTTNG_DOMAIN_KERNEL:
2530 {
2531 struct ltt_kernel_session *ksess = session->kernel_session;
2532
2533 assert(ksess);
2534
2535 /* Can't register a consumer if there is already one */
2536 if (ksess->consumer_fds_sent != 0) {
2537 ret = LTTNG_ERR_KERN_CONSUMER_FAIL;
2538 goto error;
2539 }
2540
2541 sock = lttcomm_connect_unix_sock(sock_path);
2542 if (sock < 0) {
2543 ret = LTTNG_ERR_CONNECT_FAIL;
2544 goto error;
2545 }
2546 cdata->cmd_sock = sock;
2547
2548 socket = consumer_allocate_socket(&cdata->cmd_sock);
2549 if (socket == NULL) {
2550 ret = close(sock);
2551 if (ret < 0) {
2552 PERROR("close register consumer");
2553 }
2554 cdata->cmd_sock = -1;
2555 ret = LTTNG_ERR_FATAL;
2556 goto error;
2557 }
2558
2559 socket->lock = zmalloc(sizeof(pthread_mutex_t));
2560 if (socket->lock == NULL) {
2561 PERROR("zmalloc pthread mutex");
2562 ret = LTTNG_ERR_FATAL;
2563 goto error;
2564 }
2565 pthread_mutex_init(socket->lock, NULL);
2566 socket->registered = 1;
2567
2568 rcu_read_lock();
2569 consumer_add_socket(socket, ksess->consumer);
2570 rcu_read_unlock();
2571
2572 pthread_mutex_lock(&cdata->pid_mutex);
2573 cdata->pid = -1;
2574 pthread_mutex_unlock(&cdata->pid_mutex);
2575
2576 break;
2577 }
2578 default:
2579 /* TODO: Userspace tracing */
2580 ret = LTTNG_ERR_UND;
2581 goto error;
2582 }
2583
2584 return LTTNG_OK;
2585
2586 error:
2587 if (socket) {
2588 consumer_destroy_socket(socket);
2589 }
2590 return ret;
2591 }
2592
2593 /*
2594 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2595 */
2596 ssize_t cmd_list_domains(struct ltt_session *session,
2597 struct lttng_domain **domains)
2598 {
2599 int ret, index = 0;
2600 ssize_t nb_dom = 0;
2601 struct agent *agt;
2602 struct lttng_ht_iter iter;
2603
2604 if (session->kernel_session != NULL) {
2605 DBG3("Listing domains found kernel domain");
2606 nb_dom++;
2607 }
2608
2609 if (session->ust_session != NULL) {
2610 DBG3("Listing domains found UST global domain");
2611 nb_dom++;
2612
2613 rcu_read_lock();
2614 cds_lfht_for_each_entry(session->ust_session->agents->ht, &iter.iter,
2615 agt, node.node) {
2616 if (agt->being_used) {
2617 nb_dom++;
2618 }
2619 }
2620 rcu_read_unlock();
2621 }
2622
2623 if (!nb_dom) {
2624 goto end;
2625 }
2626
2627 *domains = zmalloc(nb_dom * sizeof(struct lttng_domain));
2628 if (*domains == NULL) {
2629 ret = LTTNG_ERR_FATAL;
2630 goto error;
2631 }
2632
2633 if (session->kernel_session != NULL) {
2634 (*domains)[index].type = LTTNG_DOMAIN_KERNEL;
2635
2636 /* Kernel session buffer type is always GLOBAL */
2637 (*domains)[index].buf_type = LTTNG_BUFFER_GLOBAL;
2638
2639 index++;
2640 }
2641
2642 if (session->ust_session != NULL) {
2643 (*domains)[index].type = LTTNG_DOMAIN_UST;
2644 (*domains)[index].buf_type = session->ust_session->buffer_type;
2645 index++;
2646
2647 rcu_read_lock();
2648 cds_lfht_for_each_entry(session->ust_session->agents->ht, &iter.iter,
2649 agt, node.node) {
2650 if (agt->being_used) {
2651 (*domains)[index].type = agt->domain;
2652 (*domains)[index].buf_type = session->ust_session->buffer_type;
2653 index++;
2654 }
2655 }
2656 rcu_read_unlock();
2657 }
2658 end:
2659 return nb_dom;
2660
2661 error:
2662 /* Return negative value to differentiate return code */
2663 return -ret;
2664 }
2665
2666
2667 /*
2668 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2669 */
2670 ssize_t cmd_list_channels(int domain, struct ltt_session *session,
2671 struct lttng_channel **channels)
2672 {
2673 int ret;
2674 ssize_t nb_chan = 0;
2675
2676 switch (domain) {
2677 case LTTNG_DOMAIN_KERNEL:
2678 if (session->kernel_session != NULL) {
2679 nb_chan = session->kernel_session->channel_count;
2680 }
2681 DBG3("Number of kernel channels %zd", nb_chan);
2682 if (nb_chan <= 0) {
2683 ret = LTTNG_ERR_KERN_CHAN_NOT_FOUND;
2684 }
2685 break;
2686 case LTTNG_DOMAIN_UST:
2687 if (session->ust_session != NULL) {
2688 rcu_read_lock();
2689 nb_chan = lttng_ht_get_count(
2690 session->ust_session->domain_global.channels);
2691 rcu_read_unlock();
2692 }
2693 DBG3("Number of UST global channels %zd", nb_chan);
2694 if (nb_chan < 0) {
2695 ret = LTTNG_ERR_UST_CHAN_NOT_FOUND;
2696 goto error;
2697 }
2698 break;
2699 default:
2700 ret = LTTNG_ERR_UND;
2701 goto error;
2702 }
2703
2704 if (nb_chan > 0) {
2705 *channels = zmalloc(nb_chan * sizeof(struct lttng_channel));
2706 if (*channels == NULL) {
2707 ret = LTTNG_ERR_FATAL;
2708 goto error;
2709 }
2710
2711 list_lttng_channels(domain, session, *channels);
2712 }
2713
2714 return nb_chan;
2715
2716 error:
2717 /* Return negative value to differentiate return code */
2718 return -ret;
2719 }
2720
2721 /*
2722 * Command LTTNG_LIST_EVENTS processed by the client thread.
2723 */
2724 ssize_t cmd_list_events(int domain, struct ltt_session *session,
2725 char *channel_name, struct lttng_event **events)
2726 {
2727 int ret = 0;
2728 ssize_t nb_event = 0;
2729
2730 switch (domain) {
2731 case LTTNG_DOMAIN_KERNEL:
2732 if (session->kernel_session != NULL) {
2733 nb_event = list_lttng_kernel_events(channel_name,
2734 session->kernel_session, events);
2735 }
2736 break;
2737 case LTTNG_DOMAIN_UST:
2738 {
2739 if (session->ust_session != NULL) {
2740 nb_event = list_lttng_ust_global_events(channel_name,
2741 &session->ust_session->domain_global, events);
2742 }
2743 break;
2744 }
2745 case LTTNG_DOMAIN_LOG4J:
2746 case LTTNG_DOMAIN_JUL:
2747 case LTTNG_DOMAIN_PYTHON:
2748 if (session->ust_session) {
2749 struct lttng_ht_iter iter;
2750 struct agent *agt;
2751
2752 rcu_read_lock();
2753 cds_lfht_for_each_entry(session->ust_session->agents->ht,
2754 &iter.iter, agt, node.node) {
2755 if (agt->domain == domain) {
2756 nb_event = list_lttng_agent_events(
2757 agt, events);
2758 break;
2759 }
2760 }
2761 rcu_read_unlock();
2762 }
2763 break;
2764 default:
2765 ret = LTTNG_ERR_UND;
2766 goto error;
2767 }
2768
2769 return nb_event;
2770
2771 error:
2772 /* Return negative value to differentiate return code */
2773 return -ret;
2774 }
2775
2776 /*
2777 * Using the session list, filled a lttng_session array to send back to the
2778 * client for session listing.
2779 *
2780 * The session list lock MUST be acquired before calling this function. Use
2781 * session_lock_list() and session_unlock_list().
2782 */
2783 void cmd_list_lttng_sessions(struct lttng_session *sessions, uid_t uid,
2784 gid_t gid)
2785 {
2786 int ret;
2787 unsigned int i = 0;
2788 struct ltt_session *session;
2789 struct ltt_session_list *list = session_get_list();
2790
2791 DBG("Getting all available session for UID %d GID %d",
2792 uid, gid);
2793 /*
2794 * Iterate over session list and append data after the control struct in
2795 * the buffer.
2796 */
2797 cds_list_for_each_entry(session, &list->head, list) {
2798 /*
2799 * Only list the sessions the user can control.
2800 */
2801 if (!session_access_ok(session, uid, gid)) {
2802 continue;
2803 }
2804
2805 struct ltt_kernel_session *ksess = session->kernel_session;
2806 struct ltt_ust_session *usess = session->ust_session;
2807
2808 if (session->consumer->type == CONSUMER_DST_NET ||
2809 (ksess && ksess->consumer->type == CONSUMER_DST_NET) ||
2810 (usess && usess->consumer->type == CONSUMER_DST_NET)) {
2811 ret = build_network_session_path(sessions[i].path,
2812 sizeof(sessions[i].path), session);
2813 } else {
2814 ret = snprintf(sessions[i].path, sizeof(sessions[i].path), "%s",
2815 session->consumer->dst.trace_path);
2816 }
2817 if (ret < 0) {
2818 PERROR("snprintf session path");
2819 continue;
2820 }
2821
2822 strncpy(sessions[i].name, session->name, NAME_MAX);
2823 sessions[i].name[NAME_MAX - 1] = '\0';
2824 sessions[i].enabled = session->active;
2825 sessions[i].snapshot_mode = session->snapshot_mode;
2826 sessions[i].live_timer_interval = session->live_timer;
2827 i++;
2828 }
2829 }
2830
2831 /*
2832 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
2833 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
2834 */
2835 int cmd_data_pending(struct ltt_session *session)
2836 {
2837 int ret;
2838 struct ltt_kernel_session *ksess = session->kernel_session;
2839 struct ltt_ust_session *usess = session->ust_session;
2840
2841 assert(session);
2842
2843 /* Session MUST be stopped to ask for data availability. */
2844 if (session->active) {
2845 ret = LTTNG_ERR_SESSION_STARTED;
2846 goto error;
2847 } else {
2848 /*
2849 * If stopped, just make sure we've started before else the above call
2850 * will always send that there is data pending.
2851 *
2852 * The consumer assumes that when the data pending command is received,
2853 * the trace has been started before or else no output data is written
2854 * by the streams which is a condition for data pending. So, this is
2855 * *VERY* important that we don't ask the consumer before a start
2856 * trace.
2857 */
2858 if (!session->has_been_started) {
2859 ret = 0;
2860 goto error;
2861 }
2862 }
2863
2864 if (ksess && ksess->consumer) {
2865 ret = consumer_is_data_pending(ksess->id, ksess->consumer);
2866 if (ret == 1) {
2867 /* Data is still being extracted for the kernel. */
2868 goto error;
2869 }
2870 }
2871
2872 if (usess && usess->consumer) {
2873 ret = consumer_is_data_pending(usess->id, usess->consumer);
2874 if (ret == 1) {
2875 /* Data is still being extracted for the kernel. */
2876 goto error;
2877 }
2878 }
2879
2880 /* Data is ready to be read by a viewer */
2881 ret = 0;
2882
2883 error:
2884 return ret;
2885 }
2886
2887 /*
2888 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
2889 *
2890 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2891 */
2892 int cmd_snapshot_add_output(struct ltt_session *session,
2893 struct lttng_snapshot_output *output, uint32_t *id)
2894 {
2895 int ret;
2896 struct snapshot_output *new_output;
2897
2898 assert(session);
2899 assert(output);
2900
2901 DBG("Cmd snapshot add output for session %s", session->name);
2902
2903 /*
2904 * Permission denied to create an output if the session is not
2905 * set in no output mode.
2906 */
2907 if (session->output_traces) {
2908 ret = LTTNG_ERR_EPERM;
2909 goto error;
2910 }
2911
2912 /* Only one output is allowed until we have the "tee" feature. */
2913 if (session->snapshot.nb_output == 1) {
2914 ret = LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST;
2915 goto error;
2916 }
2917
2918 new_output = snapshot_output_alloc();
2919 if (!new_output) {
2920 ret = LTTNG_ERR_NOMEM;
2921 goto error;
2922 }
2923
2924 ret = snapshot_output_init(output->max_size, output->name,
2925 output->ctrl_url, output->data_url, session->consumer, new_output,
2926 &session->snapshot);
2927 if (ret < 0) {
2928 if (ret == -ENOMEM) {
2929 ret = LTTNG_ERR_NOMEM;
2930 } else {
2931 ret = LTTNG_ERR_INVALID;
2932 }
2933 goto free_error;
2934 }
2935
2936 rcu_read_lock();
2937 snapshot_add_output(&session->snapshot, new_output);
2938 if (id) {
2939 *id = new_output->id;
2940 }
2941 rcu_read_unlock();
2942
2943 return LTTNG_OK;
2944
2945 free_error:
2946 snapshot_output_destroy(new_output);
2947 error:
2948 return ret;
2949 }
2950
2951 /*
2952 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
2953 *
2954 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2955 */
2956 int cmd_snapshot_del_output(struct ltt_session *session,
2957 struct lttng_snapshot_output *output)
2958 {
2959 int ret;
2960 struct snapshot_output *sout = NULL;
2961
2962 assert(session);
2963 assert(output);
2964
2965 rcu_read_lock();
2966
2967 /*
2968 * Permission denied to create an output if the session is not
2969 * set in no output mode.
2970 */
2971 if (session->output_traces) {
2972 ret = LTTNG_ERR_EPERM;
2973 goto error;
2974 }
2975
2976 if (output->id) {
2977 DBG("Cmd snapshot del output id %" PRIu32 " for session %s", output->id,
2978 session->name);
2979 sout = snapshot_find_output_by_id(output->id, &session->snapshot);
2980 } else if (*output->name != '\0') {
2981 DBG("Cmd snapshot del output name %s for session %s", output->name,
2982 session->name);
2983 sout = snapshot_find_output_by_name(output->name, &session->snapshot);
2984 }
2985 if (!sout) {
2986 ret = LTTNG_ERR_INVALID;
2987 goto error;
2988 }
2989
2990 snapshot_delete_output(&session->snapshot, sout);
2991 snapshot_output_destroy(sout);
2992 ret = LTTNG_OK;
2993
2994 error:
2995 rcu_read_unlock();
2996 return ret;
2997 }
2998
2999 /*
3000 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
3001 *
3002 * If no output is available, outputs is untouched and 0 is returned.
3003 *
3004 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
3005 */
3006 ssize_t cmd_snapshot_list_outputs(struct ltt_session *session,
3007 struct lttng_snapshot_output **outputs)
3008 {
3009 int ret, idx = 0;
3010 struct lttng_snapshot_output *list = NULL;
3011 struct lttng_ht_iter iter;
3012 struct snapshot_output *output;
3013
3014 assert(session);
3015 assert(outputs);
3016
3017 DBG("Cmd snapshot list outputs for session %s", session->name);
3018
3019 /*
3020 * Permission denied to create an output if the session is not
3021 * set in no output mode.
3022 */
3023 if (session->output_traces) {
3024 ret = -LTTNG_ERR_EPERM;
3025 goto error;
3026 }
3027
3028 if (session->snapshot.nb_output == 0) {
3029 ret = 0;
3030 goto error;
3031 }
3032
3033 list = zmalloc(session->snapshot.nb_output * sizeof(*list));
3034 if (!list) {
3035 ret = -LTTNG_ERR_NOMEM;
3036 goto error;
3037 }
3038
3039 /* Copy list from session to the new list object. */
3040 rcu_read_lock();
3041 cds_lfht_for_each_entry(session->snapshot.output_ht->ht, &iter.iter,
3042 output, node.node) {
3043 assert(output->consumer);
3044 list[idx].id = output->id;
3045 list[idx].max_size = output->max_size;
3046 if (lttng_strncpy(list[idx].name, output->name,
3047 sizeof(list[idx].name))) {
3048 ret = -LTTNG_ERR_INVALID;
3049 goto error;
3050 }
3051 if (output->consumer->type == CONSUMER_DST_LOCAL) {
3052 if (lttng_strncpy(list[idx].ctrl_url,
3053 output->consumer->dst.trace_path,
3054 sizeof(list[idx].ctrl_url))) {
3055 ret = -LTTNG_ERR_INVALID;
3056 goto error;
3057 }
3058 } else {
3059 /* Control URI. */
3060 ret = uri_to_str_url(&output->consumer->dst.net.control,
3061 list[idx].ctrl_url, sizeof(list[idx].ctrl_url));
3062 if (ret < 0) {
3063 ret = -LTTNG_ERR_NOMEM;
3064 goto error;
3065 }
3066
3067 /* Data URI. */
3068 ret = uri_to_str_url(&output->consumer->dst.net.data,
3069 list[idx].data_url, sizeof(list[idx].data_url));
3070 if (ret < 0) {
3071 ret = -LTTNG_ERR_NOMEM;
3072 goto error;
3073 }
3074 }
3075 idx++;
3076 }
3077
3078 *outputs = list;
3079 list = NULL;
3080 ret = session->snapshot.nb_output;
3081 error:
3082 free(list);
3083 rcu_read_unlock();
3084 return ret;
3085 }
3086
3087 /*
3088 * Send relayd sockets from snapshot output to consumer. Ignore request if the
3089 * snapshot output is *not* set with a remote destination.
3090 *
3091 * Return 0 on success or a LTTNG_ERR code.
3092 */
3093 static int set_relayd_for_snapshot(struct consumer_output *consumer,
3094 struct snapshot_output *snap_output, struct ltt_session *session)
3095 {
3096 int ret = LTTNG_OK;
3097 struct lttng_ht_iter iter;
3098 struct consumer_socket *socket;
3099
3100 assert(consumer);
3101 assert(snap_output);
3102 assert(session);
3103
3104 DBG2("Set relayd object from snapshot output");
3105
3106 /* Ignore if snapshot consumer output is not network. */
3107 if (snap_output->consumer->type != CONSUMER_DST_NET) {
3108 goto error;
3109 }
3110
3111 /*
3112 * For each consumer socket, create and send the relayd object of the
3113 * snapshot output.
3114 */
3115 rcu_read_lock();
3116 cds_lfht_for_each_entry(snap_output->consumer->socks->ht, &iter.iter,
3117 socket, node.node) {
3118 ret = send_consumer_relayd_sockets(0, session->id,
3119 snap_output->consumer, socket,
3120 session->name, session->hostname,
3121 session->live_timer);
3122 if (ret != LTTNG_OK) {
3123 rcu_read_unlock();
3124 goto error;
3125 }
3126 }
3127 rcu_read_unlock();
3128
3129 error:
3130 return ret;
3131 }
3132
3133 /*
3134 * Record a kernel snapshot.
3135 *
3136 * Return LTTNG_OK on success or a LTTNG_ERR code.
3137 */
3138 static int record_kernel_snapshot(struct ltt_kernel_session *ksess,
3139 struct snapshot_output *output, struct ltt_session *session,
3140 int wait, uint64_t nb_packets_per_stream)
3141 {
3142 int ret;
3143
3144 assert(ksess);
3145 assert(output);
3146 assert(session);
3147
3148
3149 /*
3150 * Copy kernel session sockets so we can communicate with the right
3151 * consumer for the snapshot record command.
3152 */
3153 ret = consumer_copy_sockets(output->consumer, ksess->consumer);
3154 if (ret < 0) {
3155 ret = LTTNG_ERR_NOMEM;
3156 goto error;
3157 }
3158
3159 ret = set_relayd_for_snapshot(ksess->consumer, output, session);
3160 if (ret != LTTNG_OK) {
3161 goto error_snapshot;
3162 }
3163
3164 ret = kernel_snapshot_record(ksess, output, wait, nb_packets_per_stream);
3165 if (ret != LTTNG_OK) {
3166 goto error_snapshot;
3167 }
3168
3169 ret = LTTNG_OK;
3170 goto end;
3171
3172 error_snapshot:
3173 /* Clean up copied sockets so this output can use some other later on. */
3174 consumer_destroy_output_sockets(output->consumer);
3175 error:
3176 end:
3177 return ret;
3178 }
3179
3180 /*
3181 * Record a UST snapshot.
3182 *
3183 * Return 0 on success or a LTTNG_ERR error code.
3184 */
3185 static int record_ust_snapshot(struct ltt_ust_session *usess,
3186 struct snapshot_output *output, struct ltt_session *session,
3187 int wait, uint64_t nb_packets_per_stream)
3188 {
3189 int ret;
3190
3191 assert(usess);
3192 assert(output);
3193 assert(session);
3194
3195 /*
3196 * Copy UST session sockets so we can communicate with the right
3197 * consumer for the snapshot record command.
3198 */
3199 ret = consumer_copy_sockets(output->consumer, usess->consumer);
3200 if (ret < 0) {
3201 ret = LTTNG_ERR_NOMEM;
3202 goto error;
3203 }
3204
3205 ret = set_relayd_for_snapshot(usess->consumer, output, session);
3206 if (ret != LTTNG_OK) {
3207 goto error_snapshot;
3208 }
3209
3210 ret = ust_app_snapshot_record(usess, output, wait, nb_packets_per_stream);
3211 if (ret < 0) {
3212 switch (-ret) {
3213 case EINVAL:
3214 ret = LTTNG_ERR_INVALID;
3215 break;
3216 default:
3217 ret = LTTNG_ERR_SNAPSHOT_FAIL;
3218 break;
3219 }
3220 goto error_snapshot;
3221 }
3222
3223 ret = LTTNG_OK;
3224
3225 error_snapshot:
3226 /* Clean up copied sockets so this output can use some other later on. */
3227 consumer_destroy_output_sockets(output->consumer);
3228 error:
3229 return ret;
3230 }
3231
3232 static
3233 uint64_t get_session_size_one_more_packet_per_stream(struct ltt_session *session,
3234 uint64_t cur_nr_packets)
3235 {
3236 uint64_t tot_size = 0;
3237
3238 if (session->kernel_session) {
3239 struct ltt_kernel_channel *chan;
3240 struct ltt_kernel_session *ksess = session->kernel_session;
3241
3242 cds_list_for_each_entry(chan, &ksess->channel_list.head, list) {
3243 if (cur_nr_packets >= chan->channel->attr.num_subbuf) {
3244 /*
3245 * Don't take channel into account if we
3246 * already grab all its packets.
3247 */
3248 continue;
3249 }
3250 tot_size += chan->channel->attr.subbuf_size
3251 * chan->stream_count;
3252 }
3253 }
3254
3255 if (session->ust_session) {
3256 struct ltt_ust_session *usess = session->ust_session;
3257
3258 tot_size += ust_app_get_size_one_more_packet_per_stream(usess,
3259 cur_nr_packets);
3260 }
3261
3262 return tot_size;
3263 }
3264
3265 /*
3266 * Calculate the number of packets we can grab from each stream that
3267 * fits within the overall snapshot max size.
3268 *
3269 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
3270 * the number of packets per stream.
3271 *
3272 * TODO: this approach is not perfect: we consider the worse case
3273 * (packet filling the sub-buffers) as an upper bound, but we could do
3274 * better if we do this calculation while we actually grab the packet
3275 * content: we would know how much padding we don't actually store into
3276 * the file.
3277 *
3278 * This algorithm is currently bounded by the number of packets per
3279 * stream.
3280 *
3281 * Since we call this algorithm before actually grabbing the data, it's
3282 * an approximation: for instance, applications could appear/disappear
3283 * in between this call and actually grabbing data.
3284 */
3285 static
3286 int64_t get_session_nb_packets_per_stream(struct ltt_session *session, uint64_t max_size)
3287 {
3288 int64_t size_left;
3289 uint64_t cur_nb_packets = 0;
3290
3291 if (!max_size) {
3292 return 0; /* Infinite */
3293 }
3294
3295 size_left = max_size;
3296 for (;;) {
3297 uint64_t one_more_packet_tot_size;
3298
3299 one_more_packet_tot_size = get_session_size_one_more_packet_per_stream(session,
3300 cur_nb_packets);
3301 if (!one_more_packet_tot_size) {
3302 /* We are already grabbing all packets. */
3303 break;
3304 }
3305 size_left -= one_more_packet_tot_size;
3306 if (size_left < 0) {
3307 break;
3308 }
3309 cur_nb_packets++;
3310 }
3311 if (!cur_nb_packets) {
3312 /* Not enough room to grab one packet of each stream, error. */
3313 return -1;
3314 }
3315 return cur_nb_packets;
3316 }
3317
3318 /*
3319 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3320 *
3321 * The wait parameter is ignored so this call always wait for the snapshot to
3322 * complete before returning.
3323 *
3324 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3325 */
3326 int cmd_snapshot_record(struct ltt_session *session,
3327 struct lttng_snapshot_output *output, int wait)
3328 {
3329 int ret = LTTNG_OK;
3330 unsigned int use_tmp_output = 0;
3331 struct snapshot_output tmp_output;
3332 unsigned int snapshot_success = 0;
3333 char datetime[16];
3334
3335 assert(session);
3336 assert(output);
3337
3338 DBG("Cmd snapshot record for session %s", session->name);
3339
3340 /* Get the datetime for the snapshot output directory. */
3341 ret = utils_get_current_time_str("%Y%m%d-%H%M%S", datetime,
3342 sizeof(datetime));
3343 if (!ret) {
3344 ret = LTTNG_ERR_INVALID;
3345 goto error;
3346 }
3347
3348 /*
3349 * Permission denied to create an output if the session is not
3350 * set in no output mode.
3351 */
3352 if (session->output_traces) {
3353 ret = LTTNG_ERR_EPERM;
3354 goto error;
3355 }
3356
3357 /* The session needs to be started at least once. */
3358 if (!session->has_been_started) {
3359 ret = LTTNG_ERR_START_SESSION_ONCE;
3360 goto error;
3361 }
3362
3363 /* Use temporary output for the session. */
3364 if (*output->ctrl_url != '\0') {
3365 ret = snapshot_output_init(output->max_size, output->name,
3366 output->ctrl_url, output->data_url, session->consumer,
3367 &tmp_output, NULL);
3368 if (ret < 0) {
3369 if (ret == -ENOMEM) {
3370 ret = LTTNG_ERR_NOMEM;
3371 } else {
3372 ret = LTTNG_ERR_INVALID;
3373 }
3374 goto error;
3375 }
3376 /* Use the global session count for the temporary snapshot. */
3377 tmp_output.nb_snapshot = session->snapshot.nb_snapshot;
3378
3379 /* Use the global datetime */
3380 memcpy(tmp_output.datetime, datetime, sizeof(datetime));
3381 use_tmp_output = 1;
3382 }
3383
3384 if (use_tmp_output) {
3385 int64_t nb_packets_per_stream;
3386
3387 nb_packets_per_stream = get_session_nb_packets_per_stream(session,
3388 tmp_output.max_size);
3389 if (nb_packets_per_stream < 0) {
3390 ret = LTTNG_ERR_MAX_SIZE_INVALID;
3391 goto error;
3392 }
3393
3394 if (session->kernel_session) {
3395 ret = record_kernel_snapshot(session->kernel_session,
3396 &tmp_output, session,
3397 wait, nb_packets_per_stream);
3398 if (ret != LTTNG_OK) {
3399 goto error;
3400 }
3401 }
3402
3403 if (session->ust_session) {
3404 ret = record_ust_snapshot(session->ust_session,
3405 &tmp_output, session,
3406 wait, nb_packets_per_stream);
3407 if (ret != LTTNG_OK) {
3408 goto error;
3409 }
3410 }
3411
3412 snapshot_success = 1;
3413 } else {
3414 struct snapshot_output *sout;
3415 struct lttng_ht_iter iter;
3416
3417 rcu_read_lock();
3418 cds_lfht_for_each_entry(session->snapshot.output_ht->ht,
3419 &iter.iter, sout, node.node) {
3420 int64_t nb_packets_per_stream;
3421
3422 /*
3423 * Make a local copy of the output and assign the possible
3424 * temporary value given by the caller.
3425 */
3426 memset(&tmp_output, 0, sizeof(tmp_output));
3427 memcpy(&tmp_output, sout, sizeof(tmp_output));
3428
3429 if (output->max_size != (uint64_t) -1ULL) {
3430 tmp_output.max_size = output->max_size;
3431 }
3432
3433 nb_packets_per_stream = get_session_nb_packets_per_stream(session,
3434 tmp_output.max_size);
3435 if (nb_packets_per_stream < 0) {
3436 ret = LTTNG_ERR_MAX_SIZE_INVALID;
3437 rcu_read_unlock();
3438 goto error;
3439 }
3440
3441 /* Use temporary name. */
3442 if (*output->name != '\0') {
3443 if (lttng_strncpy(tmp_output.name, output->name,
3444 sizeof(tmp_output.name))) {
3445 ret = LTTNG_ERR_INVALID;
3446 rcu_read_unlock();
3447 goto error;
3448 }
3449 }
3450
3451 tmp_output.nb_snapshot = session->snapshot.nb_snapshot;
3452 memcpy(tmp_output.datetime, datetime, sizeof(datetime));
3453
3454 if (session->kernel_session) {
3455 ret = record_kernel_snapshot(session->kernel_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
3464 if (session->ust_session) {
3465 ret = record_ust_snapshot(session->ust_session,
3466 &tmp_output, session,
3467 wait, nb_packets_per_stream);
3468 if (ret != LTTNG_OK) {
3469 rcu_read_unlock();
3470 goto error;
3471 }
3472 }
3473 snapshot_success = 1;
3474 }
3475 rcu_read_unlock();
3476 }
3477
3478 if (snapshot_success) {
3479 session->snapshot.nb_snapshot++;
3480 } else {
3481 ret = LTTNG_ERR_SNAPSHOT_FAIL;
3482 }
3483
3484 error:
3485 return ret;
3486 }
3487
3488 /*
3489 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
3490 */
3491 int cmd_set_session_shm_path(struct ltt_session *session,
3492 const char *shm_path)
3493 {
3494 /* Safety net */
3495 assert(session);
3496
3497 /*
3498 * Can only set shm path before session is started.
3499 */
3500 if (session->has_been_started) {
3501 return LTTNG_ERR_SESSION_STARTED;
3502 }
3503
3504 strncpy(session->shm_path, shm_path,
3505 sizeof(session->shm_path));
3506 session->shm_path[sizeof(session->shm_path) - 1] = '\0';
3507
3508 return 0;
3509 }
3510
3511 /*
3512 * Init command subsystem.
3513 */
3514 void cmd_init(void)
3515 {
3516 /*
3517 * Set network sequence index to 1 for streams to match a relayd
3518 * socket on the consumer side.
3519 */
3520 pthread_mutex_lock(&relayd_net_seq_idx_lock);
3521 relayd_net_seq_idx = 1;
3522 pthread_mutex_unlock(&relayd_net_seq_idx_lock);
3523
3524 DBG("Command subsystem initialized");
3525 }
LTTng 2.0 tools and control repository
This page took 0.107907 seconds and 4 git commands to generate.