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