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