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


6237d673efca6b1abd5c778949c8863be6fc72ef
[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 goto error;
1830 }
1831 memcpy(filter_copy, filter, filter_size);
1832
1833 filter_expression_copy =
1834 strdup(filter_expression);
1835 if (!filter_expression) {
1836 ret = LTTNG_ERR_NOMEM;
1837 }
1838
1839 if (!filter_expression_copy || !filter_copy) {
1840 free(filter_expression_copy);
1841 free(filter_copy);
1842 goto error;
1843 }
1844 }
1845
1846 ret = cmd_enable_event_internal(session, &tmp_dom,
1847 (char *) default_chan_name,
1848 &uevent, filter_expression_copy,
1849 filter_copy, NULL, wpipe);
1850 }
1851
1852 if (ret != LTTNG_OK && ret != LTTNG_ERR_UST_EVENT_ENABLED) {
1853 goto error;
1854 }
1855
1856 /* The wild card * means that everything should be enabled. */
1857 if (strncmp(event->name, "*", 1) == 0 && strlen(event->name) == 1) {
1858 ret = event_agent_enable_all(usess, agt, event, filter,
1859 filter_expression);
1860 } else {
1861 ret = event_agent_enable(usess, agt, event, filter,
1862 filter_expression);
1863 }
1864 filter = NULL;
1865 filter_expression = NULL;
1866 if (ret != LTTNG_OK) {
1867 goto error;
1868 }
1869
1870 break;
1871 }
1872 default:
1873 ret = LTTNG_ERR_UND;
1874 goto error;
1875 }
1876
1877 ret = LTTNG_OK;
1878
1879 error:
1880 free(filter_expression);
1881 free(filter);
1882 free(exclusion);
1883 rcu_read_unlock();
1884 return ret;
1885 }
1886
1887 /*
1888 * Command LTTNG_ENABLE_EVENT processed by the client thread.
1889 * We own filter, exclusion, and filter_expression.
1890 */
1891 int cmd_enable_event(struct ltt_session *session, struct lttng_domain *domain,
1892 char *channel_name, struct lttng_event *event,
1893 char *filter_expression,
1894 struct lttng_filter_bytecode *filter,
1895 struct lttng_event_exclusion *exclusion,
1896 int wpipe)
1897 {
1898 return _cmd_enable_event(session, domain, channel_name, event,
1899 filter_expression, filter, exclusion, wpipe, false);
1900 }
1901
1902 /*
1903 * Enable an event which is internal to LTTng. An internal should
1904 * never be made visible to clients and are immune to checks such as
1905 * reserved names.
1906 */
1907 static int cmd_enable_event_internal(struct ltt_session *session,
1908 struct lttng_domain *domain,
1909 char *channel_name, struct lttng_event *event,
1910 char *filter_expression,
1911 struct lttng_filter_bytecode *filter,
1912 struct lttng_event_exclusion *exclusion,
1913 int wpipe)
1914 {
1915 return _cmd_enable_event(session, domain, channel_name, event,
1916 filter_expression, filter, exclusion, wpipe, true);
1917 }
1918
1919 /*
1920 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
1921 */
1922 ssize_t cmd_list_tracepoints(enum lttng_domain_type domain,
1923 struct lttng_event **events)
1924 {
1925 int ret;
1926 ssize_t nb_events = 0;
1927
1928 switch (domain) {
1929 case LTTNG_DOMAIN_KERNEL:
1930 nb_events = kernel_list_events(kernel_tracer_fd, events);
1931 if (nb_events < 0) {
1932 ret = LTTNG_ERR_KERN_LIST_FAIL;
1933 goto error;
1934 }
1935 break;
1936 case LTTNG_DOMAIN_UST:
1937 nb_events = ust_app_list_events(events);
1938 if (nb_events < 0) {
1939 ret = LTTNG_ERR_UST_LIST_FAIL;
1940 goto error;
1941 }
1942 break;
1943 case LTTNG_DOMAIN_LOG4J:
1944 case LTTNG_DOMAIN_JUL:
1945 case LTTNG_DOMAIN_PYTHON:
1946 nb_events = agent_list_events(events, domain);
1947 if (nb_events < 0) {
1948 ret = LTTNG_ERR_UST_LIST_FAIL;
1949 goto error;
1950 }
1951 break;
1952 default:
1953 ret = LTTNG_ERR_UND;
1954 goto error;
1955 }
1956
1957 return nb_events;
1958
1959 error:
1960 /* Return negative value to differentiate return code */
1961 return -ret;
1962 }
1963
1964 /*
1965 * Command LTTNG_LIST_TRACEPOINT_FIELDS processed by the client thread.
1966 */
1967 ssize_t cmd_list_tracepoint_fields(enum lttng_domain_type domain,
1968 struct lttng_event_field **fields)
1969 {
1970 int ret;
1971 ssize_t nb_fields = 0;
1972
1973 switch (domain) {
1974 case LTTNG_DOMAIN_UST:
1975 nb_fields = ust_app_list_event_fields(fields);
1976 if (nb_fields < 0) {
1977 ret = LTTNG_ERR_UST_LIST_FAIL;
1978 goto error;
1979 }
1980 break;
1981 case LTTNG_DOMAIN_KERNEL:
1982 default: /* fall-through */
1983 ret = LTTNG_ERR_UND;
1984 goto error;
1985 }
1986
1987 return nb_fields;
1988
1989 error:
1990 /* Return negative value to differentiate return code */
1991 return -ret;
1992 }
1993
1994 ssize_t cmd_list_syscalls(struct lttng_event **events)
1995 {
1996 return syscall_table_list(events);
1997 }
1998
1999 /*
2000 * Command LTTNG_LIST_TRACKER_PIDS processed by the client thread.
2001 *
2002 * Called with session lock held.
2003 */
2004 ssize_t cmd_list_tracker_pids(struct ltt_session *session,
2005 enum lttng_domain_type domain, int32_t **pids)
2006 {
2007 int ret;
2008 ssize_t nr_pids = 0;
2009
2010 switch (domain) {
2011 case LTTNG_DOMAIN_KERNEL:
2012 {
2013 struct ltt_kernel_session *ksess;
2014
2015 ksess = session->kernel_session;
2016 nr_pids = kernel_list_tracker_pids(ksess, pids);
2017 if (nr_pids < 0) {
2018 ret = LTTNG_ERR_KERN_LIST_FAIL;
2019 goto error;
2020 }
2021 break;
2022 }
2023 case LTTNG_DOMAIN_UST:
2024 {
2025 struct ltt_ust_session *usess;
2026
2027 usess = session->ust_session;
2028 nr_pids = trace_ust_list_tracker_pids(usess, pids);
2029 if (nr_pids < 0) {
2030 ret = LTTNG_ERR_UST_LIST_FAIL;
2031 goto error;
2032 }
2033 break;
2034 }
2035 case LTTNG_DOMAIN_LOG4J:
2036 case LTTNG_DOMAIN_JUL:
2037 case LTTNG_DOMAIN_PYTHON:
2038 default:
2039 ret = LTTNG_ERR_UND;
2040 goto error;
2041 }
2042
2043 return nr_pids;
2044
2045 error:
2046 /* Return negative value to differentiate return code */
2047 return -ret;
2048 }
2049
2050 /*
2051 * Command LTTNG_START_TRACE processed by the client thread.
2052 *
2053 * Called with session mutex held.
2054 */
2055 int cmd_start_trace(struct ltt_session *session)
2056 {
2057 int ret;
2058 unsigned long nb_chan = 0;
2059 struct ltt_kernel_session *ksession;
2060 struct ltt_ust_session *usess;
2061
2062 assert(session);
2063
2064 /* Ease our life a bit ;) */
2065 ksession = session->kernel_session;
2066 usess = session->ust_session;
2067
2068 /* Is the session already started? */
2069 if (session->active) {
2070 ret = LTTNG_ERR_TRACE_ALREADY_STARTED;
2071 goto error;
2072 }
2073
2074 /*
2075 * Starting a session without channel is useless since after that it's not
2076 * possible to enable channel thus inform the client.
2077 */
2078 if (usess && usess->domain_global.channels) {
2079 nb_chan += lttng_ht_get_count(usess->domain_global.channels);
2080 }
2081 if (ksession) {
2082 nb_chan += ksession->channel_count;
2083 }
2084 if (!nb_chan) {
2085 ret = LTTNG_ERR_NO_CHANNEL;
2086 goto error;
2087 }
2088
2089 /* Kernel tracing */
2090 if (ksession != NULL) {
2091 ret = start_kernel_session(ksession, kernel_tracer_fd);
2092 if (ret != LTTNG_OK) {
2093 goto error;
2094 }
2095 }
2096
2097 /* Flag session that trace should start automatically */
2098 if (usess) {
2099 /*
2100 * Even though the start trace might fail, flag this session active so
2101 * other application coming in are started by default.
2102 */
2103 usess->active = 1;
2104
2105 ret = ust_app_start_trace_all(usess);
2106 if (ret < 0) {
2107 ret = LTTNG_ERR_UST_START_FAIL;
2108 goto error;
2109 }
2110 }
2111
2112 /* Flag this after a successful start. */
2113 session->has_been_started = 1;
2114 session->active = 1;
2115
2116 ret = LTTNG_OK;
2117
2118 error:
2119 return ret;
2120 }
2121
2122 /*
2123 * Command LTTNG_STOP_TRACE processed by the client thread.
2124 */
2125 int cmd_stop_trace(struct ltt_session *session)
2126 {
2127 int ret;
2128 struct ltt_kernel_channel *kchan;
2129 struct ltt_kernel_session *ksession;
2130 struct ltt_ust_session *usess;
2131
2132 assert(session);
2133
2134 /* Short cut */
2135 ksession = session->kernel_session;
2136 usess = session->ust_session;
2137
2138 /* Session is not active. Skip everythong and inform the client. */
2139 if (!session->active) {
2140 ret = LTTNG_ERR_TRACE_ALREADY_STOPPED;
2141 goto error;
2142 }
2143
2144 /* Kernel tracer */
2145 if (ksession && ksession->active) {
2146 DBG("Stop kernel tracing");
2147
2148 /* Flush metadata if exist */
2149 if (ksession->metadata_stream_fd >= 0) {
2150 ret = kernel_metadata_flush_buffer(ksession->metadata_stream_fd);
2151 if (ret < 0) {
2152 ERR("Kernel metadata flush failed");
2153 }
2154 }
2155
2156 /* Flush all buffers before stopping */
2157 cds_list_for_each_entry(kchan, &ksession->channel_list.head, list) {
2158 ret = kernel_flush_buffer(kchan);
2159 if (ret < 0) {
2160 ERR("Kernel flush buffer error");
2161 }
2162 }
2163
2164 ret = kernel_stop_session(ksession);
2165 if (ret < 0) {
2166 ret = LTTNG_ERR_KERN_STOP_FAIL;
2167 goto error;
2168 }
2169
2170 kernel_wait_quiescent(kernel_tracer_fd);
2171
2172 ksession->active = 0;
2173 }
2174
2175 if (usess && usess->active) {
2176 /*
2177 * Even though the stop trace might fail, flag this session inactive so
2178 * other application coming in are not started by default.
2179 */
2180 usess->active = 0;
2181
2182 ret = ust_app_stop_trace_all(usess);
2183 if (ret < 0) {
2184 ret = LTTNG_ERR_UST_STOP_FAIL;
2185 goto error;
2186 }
2187 }
2188
2189 /* Flag inactive after a successful stop. */
2190 session->active = 0;
2191 ret = LTTNG_OK;
2192
2193 error:
2194 return ret;
2195 }
2196
2197 /*
2198 * Command LTTNG_SET_CONSUMER_URI processed by the client thread.
2199 */
2200 int cmd_set_consumer_uri(struct ltt_session *session, size_t nb_uri,
2201 struct lttng_uri *uris)
2202 {
2203 int ret, i;
2204 struct ltt_kernel_session *ksess = session->kernel_session;
2205 struct ltt_ust_session *usess = session->ust_session;
2206
2207 assert(session);
2208 assert(uris);
2209 assert(nb_uri > 0);
2210
2211 /* Can't set consumer URI if the session is active. */
2212 if (session->active) {
2213 ret = LTTNG_ERR_TRACE_ALREADY_STARTED;
2214 goto error;
2215 }
2216
2217 /* Set the "global" consumer URIs */
2218 for (i = 0; i < nb_uri; i++) {
2219 ret = add_uri_to_consumer(session->consumer,
2220 &uris[i], 0, session->name);
2221 if (ret != LTTNG_OK) {
2222 goto error;
2223 }
2224 }
2225
2226 /* Set UST session URIs */
2227 if (session->ust_session) {
2228 for (i = 0; i < nb_uri; i++) {
2229 ret = add_uri_to_consumer(
2230 session->ust_session->consumer,
2231 &uris[i], LTTNG_DOMAIN_UST,
2232 session->name);
2233 if (ret != LTTNG_OK) {
2234 goto error;
2235 }
2236 }
2237 }
2238
2239 /* Set kernel session URIs */
2240 if (session->kernel_session) {
2241 for (i = 0; i < nb_uri; i++) {
2242 ret = add_uri_to_consumer(
2243 session->kernel_session->consumer,
2244 &uris[i], LTTNG_DOMAIN_KERNEL,
2245 session->name);
2246 if (ret != LTTNG_OK) {
2247 goto error;
2248 }
2249 }
2250 }
2251
2252 /*
2253 * Make sure to set the session in output mode after we set URI since a
2254 * session can be created without URL (thus flagged in no output mode).
2255 */
2256 session->output_traces = 1;
2257 if (ksess) {
2258 ksess->output_traces = 1;
2259 }
2260
2261 if (usess) {
2262 usess->output_traces = 1;
2263 }
2264
2265 /* All good! */
2266 ret = LTTNG_OK;
2267
2268 error:
2269 return ret;
2270 }
2271
2272 /*
2273 * Command LTTNG_CREATE_SESSION processed by the client thread.
2274 */
2275 int cmd_create_session_uri(char *name, struct lttng_uri *uris,
2276 size_t nb_uri, lttng_sock_cred *creds, unsigned int live_timer)
2277 {
2278 int ret;
2279 struct ltt_session *session;
2280
2281 assert(name);
2282 assert(creds);
2283
2284 /*
2285 * Verify if the session already exist
2286 *
2287 * XXX: There is no need for the session lock list here since the caller
2288 * (process_client_msg) is holding it. We might want to change that so a
2289 * single command does not lock the entire session list.
2290 */
2291 session = session_find_by_name(name);
2292 if (session != NULL) {
2293 ret = LTTNG_ERR_EXIST_SESS;
2294 goto find_error;
2295 }
2296
2297 /* Create tracing session in the registry */
2298 ret = session_create(name, LTTNG_SOCK_GET_UID_CRED(creds),
2299 LTTNG_SOCK_GET_GID_CRED(creds));
2300 if (ret != LTTNG_OK) {
2301 goto session_error;
2302 }
2303
2304 /*
2305 * Get the newly created session pointer back
2306 *
2307 * XXX: There is no need for the session lock list here since the caller
2308 * (process_client_msg) is holding it. We might want to change that so a
2309 * single command does not lock the entire session list.
2310 */
2311 session = session_find_by_name(name);
2312 assert(session);
2313
2314 session->live_timer = live_timer;
2315 /* Create default consumer output for the session not yet created. */
2316 session->consumer = consumer_create_output(CONSUMER_DST_LOCAL);
2317 if (session->consumer == NULL) {
2318 ret = LTTNG_ERR_FATAL;
2319 goto consumer_error;
2320 }
2321
2322 if (uris) {
2323 ret = cmd_set_consumer_uri(session, nb_uri, uris);
2324 if (ret != LTTNG_OK) {
2325 goto consumer_error;
2326 }
2327 session->output_traces = 1;
2328 } else {
2329 session->output_traces = 0;
2330 DBG2("Session %s created with no output", session->name);
2331 }
2332
2333 session->consumer->enabled = 1;
2334
2335 return LTTNG_OK;
2336
2337 consumer_error:
2338 session_destroy(session);
2339 session_error:
2340 find_error:
2341 return ret;
2342 }
2343
2344 /*
2345 * Command LTTNG_CREATE_SESSION_SNAPSHOT processed by the client thread.
2346 */
2347 int cmd_create_session_snapshot(char *name, struct lttng_uri *uris,
2348 size_t nb_uri, lttng_sock_cred *creds)
2349 {
2350 int ret;
2351 struct ltt_session *session;
2352 struct snapshot_output *new_output = NULL;
2353
2354 assert(name);
2355 assert(creds);
2356
2357 /*
2358 * Create session in no output mode with URIs set to NULL. The uris we've
2359 * received are for a default snapshot output if one.
2360 */
2361 ret = cmd_create_session_uri(name, NULL, 0, creds, -1);
2362 if (ret != LTTNG_OK) {
2363 goto error;
2364 }
2365
2366 /* Get the newly created session pointer back. This should NEVER fail. */
2367 session = session_find_by_name(name);
2368 assert(session);
2369
2370 /* Flag session for snapshot mode. */
2371 session->snapshot_mode = 1;
2372
2373 /* Skip snapshot output creation if no URI is given. */
2374 if (nb_uri == 0) {
2375 goto end;
2376 }
2377
2378 new_output = snapshot_output_alloc();
2379 if (!new_output) {
2380 ret = LTTNG_ERR_NOMEM;
2381 goto error_snapshot_alloc;
2382 }
2383
2384 ret = snapshot_output_init_with_uri(DEFAULT_SNAPSHOT_MAX_SIZE, NULL,
2385 uris, nb_uri, session->consumer, new_output, &session->snapshot);
2386 if (ret < 0) {
2387 if (ret == -ENOMEM) {
2388 ret = LTTNG_ERR_NOMEM;
2389 } else {
2390 ret = LTTNG_ERR_INVALID;
2391 }
2392 goto error_snapshot;
2393 }
2394
2395 rcu_read_lock();
2396 snapshot_add_output(&session->snapshot, new_output);
2397 rcu_read_unlock();
2398
2399 end:
2400 return LTTNG_OK;
2401
2402 error_snapshot:
2403 snapshot_output_destroy(new_output);
2404 error_snapshot_alloc:
2405 session_destroy(session);
2406 error:
2407 return ret;
2408 }
2409
2410 /*
2411 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2412 *
2413 * Called with session lock held.
2414 */
2415 int cmd_destroy_session(struct ltt_session *session, int wpipe)
2416 {
2417 int ret;
2418 struct ltt_ust_session *usess;
2419 struct ltt_kernel_session *ksess;
2420
2421 /* Safety net */
2422 assert(session);
2423
2424 usess = session->ust_session;
2425 ksess = session->kernel_session;
2426
2427 /* Clean kernel session teardown */
2428 kernel_destroy_session(ksess);
2429
2430 /* UST session teardown */
2431 if (usess) {
2432 /* Close any relayd session */
2433 consumer_output_send_destroy_relayd(usess->consumer);
2434
2435 /* Destroy every UST application related to this session. */
2436 ret = ust_app_destroy_trace_all(usess);
2437 if (ret) {
2438 ERR("Error in ust_app_destroy_trace_all");
2439 }
2440
2441 /* Clean up the rest. */
2442 trace_ust_destroy_session(usess);
2443 }
2444
2445 /*
2446 * Must notify the kernel thread here to update it's poll set in order to
2447 * remove the channel(s)' fd just destroyed.
2448 */
2449 ret = notify_thread_pipe(wpipe);
2450 if (ret < 0) {
2451 PERROR("write kernel poll pipe");
2452 }
2453
2454 ret = session_destroy(session);
2455
2456 return ret;
2457 }
2458
2459 /*
2460 * Command LTTNG_CALIBRATE processed by the client thread.
2461 */
2462 int cmd_calibrate(enum lttng_domain_type domain,
2463 struct lttng_calibrate *calibrate)
2464 {
2465 int ret;
2466
2467 switch (domain) {
2468 case LTTNG_DOMAIN_KERNEL:
2469 {
2470 struct lttng_kernel_calibrate kcalibrate;
2471
2472 switch (calibrate->type) {
2473 case LTTNG_CALIBRATE_FUNCTION:
2474 default:
2475 /* Default and only possible calibrate option. */
2476 kcalibrate.type = LTTNG_KERNEL_CALIBRATE_KRETPROBE;
2477 break;
2478 }
2479
2480 ret = kernel_calibrate(kernel_tracer_fd, &kcalibrate);
2481 if (ret < 0) {
2482 ret = LTTNG_ERR_KERN_ENABLE_FAIL;
2483 goto error;
2484 }
2485 break;
2486 }
2487 case LTTNG_DOMAIN_UST:
2488 {
2489 struct lttng_ust_calibrate ucalibrate;
2490
2491 switch (calibrate->type) {
2492 case LTTNG_CALIBRATE_FUNCTION:
2493 default:
2494 /* Default and only possible calibrate option. */
2495 ucalibrate.type = LTTNG_UST_CALIBRATE_TRACEPOINT;
2496 break;
2497 }
2498
2499 ret = ust_app_calibrate_glb(&ucalibrate);
2500 if (ret < 0) {
2501 ret = LTTNG_ERR_UST_CALIBRATE_FAIL;
2502 goto error;
2503 }
2504 break;
2505 }
2506 default:
2507 ret = LTTNG_ERR_UND;
2508 goto error;
2509 }
2510
2511 ret = LTTNG_OK;
2512
2513 error:
2514 return ret;
2515 }
2516
2517 /*
2518 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2519 */
2520 int cmd_register_consumer(struct ltt_session *session,
2521 enum lttng_domain_type domain, const char *sock_path,
2522 struct consumer_data *cdata)
2523 {
2524 int ret, sock;
2525 struct consumer_socket *socket = NULL;
2526
2527 assert(session);
2528 assert(cdata);
2529 assert(sock_path);
2530
2531 switch (domain) {
2532 case LTTNG_DOMAIN_KERNEL:
2533 {
2534 struct ltt_kernel_session *ksess = session->kernel_session;
2535
2536 assert(ksess);
2537
2538 /* Can't register a consumer if there is already one */
2539 if (ksess->consumer_fds_sent != 0) {
2540 ret = LTTNG_ERR_KERN_CONSUMER_FAIL;
2541 goto error;
2542 }
2543
2544 sock = lttcomm_connect_unix_sock(sock_path);
2545 if (sock < 0) {
2546 ret = LTTNG_ERR_CONNECT_FAIL;
2547 goto error;
2548 }
2549 cdata->cmd_sock = sock;
2550
2551 socket = consumer_allocate_socket(&cdata->cmd_sock);
2552 if (socket == NULL) {
2553 ret = close(sock);
2554 if (ret < 0) {
2555 PERROR("close register consumer");
2556 }
2557 cdata->cmd_sock = -1;
2558 ret = LTTNG_ERR_FATAL;
2559 goto error;
2560 }
2561
2562 socket->lock = zmalloc(sizeof(pthread_mutex_t));
2563 if (socket->lock == NULL) {
2564 PERROR("zmalloc pthread mutex");
2565 ret = LTTNG_ERR_FATAL;
2566 goto error;
2567 }
2568 pthread_mutex_init(socket->lock, NULL);
2569 socket->registered = 1;
2570
2571 rcu_read_lock();
2572 consumer_add_socket(socket, ksess->consumer);
2573 rcu_read_unlock();
2574
2575 pthread_mutex_lock(&cdata->pid_mutex);
2576 cdata->pid = -1;
2577 pthread_mutex_unlock(&cdata->pid_mutex);
2578
2579 break;
2580 }
2581 default:
2582 /* TODO: Userspace tracing */
2583 ret = LTTNG_ERR_UND;
2584 goto error;
2585 }
2586
2587 return LTTNG_OK;
2588
2589 error:
2590 if (socket) {
2591 consumer_destroy_socket(socket);
2592 }
2593 return ret;
2594 }
2595
2596 /*
2597 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2598 */
2599 ssize_t cmd_list_domains(struct ltt_session *session,
2600 struct lttng_domain **domains)
2601 {
2602 int ret, index = 0;
2603 ssize_t nb_dom = 0;
2604 struct agent *agt;
2605 struct lttng_ht_iter iter;
2606
2607 if (session->kernel_session != NULL) {
2608 DBG3("Listing domains found kernel domain");
2609 nb_dom++;
2610 }
2611
2612 if (session->ust_session != NULL) {
2613 DBG3("Listing domains found UST global domain");
2614 nb_dom++;
2615
2616 rcu_read_lock();
2617 cds_lfht_for_each_entry(session->ust_session->agents->ht, &iter.iter,
2618 agt, node.node) {
2619 if (agt->being_used) {
2620 nb_dom++;
2621 }
2622 }
2623 rcu_read_unlock();
2624 }
2625
2626 if (!nb_dom) {
2627 goto end;
2628 }
2629
2630 *domains = zmalloc(nb_dom * sizeof(struct lttng_domain));
2631 if (*domains == NULL) {
2632 ret = LTTNG_ERR_FATAL;
2633 goto error;
2634 }
2635
2636 if (session->kernel_session != NULL) {
2637 (*domains)[index].type = LTTNG_DOMAIN_KERNEL;
2638
2639 /* Kernel session buffer type is always GLOBAL */
2640 (*domains)[index].buf_type = LTTNG_BUFFER_GLOBAL;
2641
2642 index++;
2643 }
2644
2645 if (session->ust_session != NULL) {
2646 (*domains)[index].type = LTTNG_DOMAIN_UST;
2647 (*domains)[index].buf_type = session->ust_session->buffer_type;
2648 index++;
2649
2650 rcu_read_lock();
2651 cds_lfht_for_each_entry(session->ust_session->agents->ht, &iter.iter,
2652 agt, node.node) {
2653 if (agt->being_used) {
2654 (*domains)[index].type = agt->domain;
2655 (*domains)[index].buf_type = session->ust_session->buffer_type;
2656 index++;
2657 }
2658 }
2659 rcu_read_unlock();
2660 }
2661 end:
2662 return nb_dom;
2663
2664 error:
2665 /* Return negative value to differentiate return code */
2666 return -ret;
2667 }
2668
2669
2670 /*
2671 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2672 */
2673 ssize_t cmd_list_channels(enum lttng_domain_type domain,
2674 struct ltt_session *session, struct lttng_channel **channels)
2675 {
2676 int ret;
2677 ssize_t nb_chan = 0;
2678
2679 switch (domain) {
2680 case LTTNG_DOMAIN_KERNEL:
2681 if (session->kernel_session != NULL) {
2682 nb_chan = session->kernel_session->channel_count;
2683 }
2684 DBG3("Number of kernel channels %zd", nb_chan);
2685 if (nb_chan <= 0) {
2686 ret = LTTNG_ERR_KERN_CHAN_NOT_FOUND;
2687 }
2688 break;
2689 case LTTNG_DOMAIN_UST:
2690 if (session->ust_session != NULL) {
2691 rcu_read_lock();
2692 nb_chan = lttng_ht_get_count(
2693 session->ust_session->domain_global.channels);
2694 rcu_read_unlock();
2695 }
2696 DBG3("Number of UST global channels %zd", nb_chan);
2697 if (nb_chan < 0) {
2698 ret = LTTNG_ERR_UST_CHAN_NOT_FOUND;
2699 goto error;
2700 }
2701 break;
2702 default:
2703 ret = LTTNG_ERR_UND;
2704 goto error;
2705 }
2706
2707 if (nb_chan > 0) {
2708 *channels = zmalloc(nb_chan * sizeof(struct lttng_channel));
2709 if (*channels == NULL) {
2710 ret = LTTNG_ERR_FATAL;
2711 goto error;
2712 }
2713
2714 list_lttng_channels(domain, session, *channels);
2715 }
2716
2717 return nb_chan;
2718
2719 error:
2720 /* Return negative value to differentiate return code */
2721 return -ret;
2722 }
2723
2724 /*
2725 * Command LTTNG_LIST_EVENTS processed by the client thread.
2726 */
2727 ssize_t cmd_list_events(enum lttng_domain_type domain,
2728 struct ltt_session *session, char *channel_name,
2729 struct lttng_event **events)
2730 {
2731 int ret = 0;
2732 ssize_t nb_event = 0;
2733
2734 switch (domain) {
2735 case LTTNG_DOMAIN_KERNEL:
2736 if (session->kernel_session != NULL) {
2737 nb_event = list_lttng_kernel_events(channel_name,
2738 session->kernel_session, events);
2739 }
2740 break;
2741 case LTTNG_DOMAIN_UST:
2742 {
2743 if (session->ust_session != NULL) {
2744 nb_event = list_lttng_ust_global_events(channel_name,
2745 &session->ust_session->domain_global, events);
2746 }
2747 break;
2748 }
2749 case LTTNG_DOMAIN_LOG4J:
2750 case LTTNG_DOMAIN_JUL:
2751 case LTTNG_DOMAIN_PYTHON:
2752 if (session->ust_session) {
2753 struct lttng_ht_iter iter;
2754 struct agent *agt;
2755
2756 rcu_read_lock();
2757 cds_lfht_for_each_entry(session->ust_session->agents->ht,
2758 &iter.iter, agt, node.node) {
2759 nb_event = list_lttng_agent_events(agt, events);
2760 }
2761 rcu_read_unlock();
2762 }
2763 break;
2764 default:
2765 ret = LTTNG_ERR_UND;
2766 goto error;
2767 }
2768
2769 return nb_event;
2770
2771 error:
2772 /* Return negative value to differentiate return code */
2773 return -ret;
2774 }
2775
2776 /*
2777 * Using the session list, filled a lttng_session array to send back to the
2778 * client for session listing.
2779 *
2780 * The session list lock MUST be acquired before calling this function. Use
2781 * session_lock_list() and session_unlock_list().
2782 */
2783 void cmd_list_lttng_sessions(struct lttng_session *sessions, uid_t uid,
2784 gid_t gid)
2785 {
2786 int ret;
2787 unsigned int i = 0;
2788 struct ltt_session *session;
2789 struct ltt_session_list *list = session_get_list();
2790
2791 DBG("Getting all available session for UID %d GID %d",
2792 uid, gid);
2793 /*
2794 * Iterate over session list and append data after the control struct in
2795 * the buffer.
2796 */
2797 cds_list_for_each_entry(session, &list->head, list) {
2798 /*
2799 * Only list the sessions the user can control.
2800 */
2801 if (!session_access_ok(session, uid, gid)) {
2802 continue;
2803 }
2804
2805 struct ltt_kernel_session *ksess = session->kernel_session;
2806 struct ltt_ust_session *usess = session->ust_session;
2807
2808 if (session->consumer->type == CONSUMER_DST_NET ||
2809 (ksess && ksess->consumer->type == CONSUMER_DST_NET) ||
2810 (usess && usess->consumer->type == CONSUMER_DST_NET)) {
2811 ret = build_network_session_path(sessions[i].path,
2812 sizeof(sessions[i].path), session);
2813 } else {
2814 ret = snprintf(sessions[i].path, sizeof(sessions[i].path), "%s",
2815 session->consumer->dst.trace_path);
2816 }
2817 if (ret < 0) {
2818 PERROR("snprintf session path");
2819 continue;
2820 }
2821
2822 strncpy(sessions[i].name, session->name, NAME_MAX);
2823 sessions[i].name[NAME_MAX - 1] = '\0';
2824 sessions[i].enabled = session->active;
2825 sessions[i].snapshot_mode = session->snapshot_mode;
2826 sessions[i].live_timer_interval = session->live_timer;
2827 i++;
2828 }
2829 }
2830
2831 /*
2832 * Command LTTNG_DATA_PENDING returning 0 if the data is NOT pending meaning
2833 * ready for trace analysis (or any kind of reader) or else 1 for pending data.
2834 */
2835 int cmd_data_pending(struct ltt_session *session)
2836 {
2837 int ret;
2838 struct ltt_kernel_session *ksess = session->kernel_session;
2839 struct ltt_ust_session *usess = session->ust_session;
2840
2841 assert(session);
2842
2843 /* Session MUST be stopped to ask for data availability. */
2844 if (session->active) {
2845 ret = LTTNG_ERR_SESSION_STARTED;
2846 goto error;
2847 } else {
2848 /*
2849 * If stopped, just make sure we've started before else the above call
2850 * will always send that there is data pending.
2851 *
2852 * The consumer assumes that when the data pending command is received,
2853 * the trace has been started before or else no output data is written
2854 * by the streams which is a condition for data pending. So, this is
2855 * *VERY* important that we don't ask the consumer before a start
2856 * trace.
2857 */
2858 if (!session->has_been_started) {
2859 ret = 0;
2860 goto error;
2861 }
2862 }
2863
2864 if (ksess && ksess->consumer) {
2865 ret = consumer_is_data_pending(ksess->id, ksess->consumer);
2866 if (ret == 1) {
2867 /* Data is still being extracted for the kernel. */
2868 goto error;
2869 }
2870 }
2871
2872 if (usess && usess->consumer) {
2873 ret = consumer_is_data_pending(usess->id, usess->consumer);
2874 if (ret == 1) {
2875 /* Data is still being extracted for the kernel. */
2876 goto error;
2877 }
2878 }
2879
2880 /* Data is ready to be read by a viewer */
2881 ret = 0;
2882
2883 error:
2884 return ret;
2885 }
2886
2887 /*
2888 * Command LTTNG_SNAPSHOT_ADD_OUTPUT from the lttng ctl library.
2889 *
2890 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2891 */
2892 int cmd_snapshot_add_output(struct ltt_session *session,
2893 struct lttng_snapshot_output *output, uint32_t *id)
2894 {
2895 int ret;
2896 struct snapshot_output *new_output;
2897
2898 assert(session);
2899 assert(output);
2900
2901 DBG("Cmd snapshot add output for session %s", session->name);
2902
2903 /*
2904 * Permission denied to create an output if the session is not
2905 * set in no output mode.
2906 */
2907 if (session->output_traces) {
2908 ret = LTTNG_ERR_EPERM;
2909 goto error;
2910 }
2911
2912 /* Only one output is allowed until we have the "tee" feature. */
2913 if (session->snapshot.nb_output == 1) {
2914 ret = LTTNG_ERR_SNAPSHOT_OUTPUT_EXIST;
2915 goto error;
2916 }
2917
2918 new_output = snapshot_output_alloc();
2919 if (!new_output) {
2920 ret = LTTNG_ERR_NOMEM;
2921 goto error;
2922 }
2923
2924 ret = snapshot_output_init(output->max_size, output->name,
2925 output->ctrl_url, output->data_url, session->consumer, new_output,
2926 &session->snapshot);
2927 if (ret < 0) {
2928 if (ret == -ENOMEM) {
2929 ret = LTTNG_ERR_NOMEM;
2930 } else {
2931 ret = LTTNG_ERR_INVALID;
2932 }
2933 goto free_error;
2934 }
2935
2936 rcu_read_lock();
2937 snapshot_add_output(&session->snapshot, new_output);
2938 if (id) {
2939 *id = new_output->id;
2940 }
2941 rcu_read_unlock();
2942
2943 return LTTNG_OK;
2944
2945 free_error:
2946 snapshot_output_destroy(new_output);
2947 error:
2948 return ret;
2949 }
2950
2951 /*
2952 * Command LTTNG_SNAPSHOT_DEL_OUTPUT from lib lttng ctl.
2953 *
2954 * Return LTTNG_OK on success or else a LTTNG_ERR code.
2955 */
2956 int cmd_snapshot_del_output(struct ltt_session *session,
2957 struct lttng_snapshot_output *output)
2958 {
2959 int ret;
2960 struct snapshot_output *sout = NULL;
2961
2962 assert(session);
2963 assert(output);
2964
2965 rcu_read_lock();
2966
2967 /*
2968 * Permission denied to create an output if the session is not
2969 * set in no output mode.
2970 */
2971 if (session->output_traces) {
2972 ret = LTTNG_ERR_EPERM;
2973 goto error;
2974 }
2975
2976 if (output->id) {
2977 DBG("Cmd snapshot del output id %" PRIu32 " for session %s", output->id,
2978 session->name);
2979 sout = snapshot_find_output_by_id(output->id, &session->snapshot);
2980 } else if (*output->name != '\0') {
2981 DBG("Cmd snapshot del output name %s for session %s", output->name,
2982 session->name);
2983 sout = snapshot_find_output_by_name(output->name, &session->snapshot);
2984 }
2985 if (!sout) {
2986 ret = LTTNG_ERR_INVALID;
2987 goto error;
2988 }
2989
2990 snapshot_delete_output(&session->snapshot, sout);
2991 snapshot_output_destroy(sout);
2992 ret = LTTNG_OK;
2993
2994 error:
2995 rcu_read_unlock();
2996 return ret;
2997 }
2998
2999 /*
3000 * Command LTTNG_SNAPSHOT_LIST_OUTPUT from lib lttng ctl.
3001 *
3002 * If no output is available, outputs is untouched and 0 is returned.
3003 *
3004 * Return the size of the newly allocated outputs or a negative LTTNG_ERR code.
3005 */
3006 ssize_t cmd_snapshot_list_outputs(struct ltt_session *session,
3007 struct lttng_snapshot_output **outputs)
3008 {
3009 int ret, idx = 0;
3010 struct lttng_snapshot_output *list = NULL;
3011 struct lttng_ht_iter iter;
3012 struct snapshot_output *output;
3013
3014 assert(session);
3015 assert(outputs);
3016
3017 DBG("Cmd snapshot list outputs for session %s", session->name);
3018
3019 /*
3020 * Permission denied to create an output if the session is not
3021 * set in no output mode.
3022 */
3023 if (session->output_traces) {
3024 ret = -LTTNG_ERR_EPERM;
3025 goto error;
3026 }
3027
3028 if (session->snapshot.nb_output == 0) {
3029 ret = 0;
3030 goto error;
3031 }
3032
3033 list = zmalloc(session->snapshot.nb_output * sizeof(*list));
3034 if (!list) {
3035 ret = -LTTNG_ERR_NOMEM;
3036 goto error;
3037 }
3038
3039 /* Copy list from session to the new list object. */
3040 rcu_read_lock();
3041 cds_lfht_for_each_entry(session->snapshot.output_ht->ht, &iter.iter,
3042 output, node.node) {
3043 assert(output->consumer);
3044 list[idx].id = output->id;
3045 list[idx].max_size = output->max_size;
3046 strncpy(list[idx].name, output->name, sizeof(list[idx].name));
3047 if (output->consumer->type == CONSUMER_DST_LOCAL) {
3048 strncpy(list[idx].ctrl_url, output->consumer->dst.trace_path,
3049 sizeof(list[idx].ctrl_url));
3050 } else {
3051 /* Control URI. */
3052 ret = uri_to_str_url(&output->consumer->dst.net.control,
3053 list[idx].ctrl_url, sizeof(list[idx].ctrl_url));
3054 if (ret < 0) {
3055 ret = -LTTNG_ERR_NOMEM;
3056 goto error;
3057 }
3058
3059 /* Data URI. */
3060 ret = uri_to_str_url(&output->consumer->dst.net.data,
3061 list[idx].data_url, sizeof(list[idx].data_url));
3062 if (ret < 0) {
3063 ret = -LTTNG_ERR_NOMEM;
3064 goto error;
3065 }
3066 }
3067 idx++;
3068 }
3069
3070 *outputs = list;
3071 list = NULL;
3072 ret = session->snapshot.nb_output;
3073 error:
3074 free(list);
3075 rcu_read_unlock();
3076 return ret;
3077 }
3078
3079 /*
3080 * Send relayd sockets from snapshot output to consumer. Ignore request if the
3081 * snapshot output is *not* set with a remote destination.
3082 *
3083 * Return 0 on success or a LTTNG_ERR code.
3084 */
3085 static int set_relayd_for_snapshot(struct consumer_output *consumer,
3086 struct snapshot_output *snap_output, struct ltt_session *session)
3087 {
3088 int ret = LTTNG_OK;
3089 struct lttng_ht_iter iter;
3090 struct consumer_socket *socket;
3091
3092 assert(consumer);
3093 assert(snap_output);
3094 assert(session);
3095
3096 DBG2("Set relayd object from snapshot output");
3097
3098 /* Ignore if snapshot consumer output is not network. */
3099 if (snap_output->consumer->type != CONSUMER_DST_NET) {
3100 goto error;
3101 }
3102
3103 /*
3104 * For each consumer socket, create and send the relayd object of the
3105 * snapshot output.
3106 */
3107 rcu_read_lock();
3108 cds_lfht_for_each_entry(snap_output->consumer->socks->ht, &iter.iter,
3109 socket, node.node) {
3110 ret = send_consumer_relayd_sockets(0, session->id,
3111 snap_output->consumer, socket,
3112 session->name, session->hostname,
3113 session->live_timer);
3114 if (ret != LTTNG_OK) {
3115 rcu_read_unlock();
3116 goto error;
3117 }
3118 }
3119 rcu_read_unlock();
3120
3121 error:
3122 return ret;
3123 }
3124
3125 /*
3126 * Record a kernel snapshot.
3127 *
3128 * Return LTTNG_OK on success or a LTTNG_ERR code.
3129 */
3130 static int record_kernel_snapshot(struct ltt_kernel_session *ksess,
3131 struct snapshot_output *output, struct ltt_session *session,
3132 int wait, uint64_t nb_packets_per_stream)
3133 {
3134 int ret;
3135
3136 assert(ksess);
3137 assert(output);
3138 assert(session);
3139
3140 /* Get the datetime for the snapshot output directory. */
3141 ret = utils_get_current_time_str("%Y%m%d-%H%M%S", output->datetime,
3142 sizeof(output->datetime));
3143 if (!ret) {
3144 ret = LTTNG_ERR_INVALID;
3145 goto error;
3146 }
3147
3148 /*
3149 * Copy kernel session sockets so we can communicate with the right
3150 * consumer for the snapshot record command.
3151 */
3152 ret = consumer_copy_sockets(output->consumer, ksess->consumer);
3153 if (ret < 0) {
3154 ret = LTTNG_ERR_NOMEM;
3155 goto error;
3156 }
3157
3158 ret = set_relayd_for_snapshot(ksess->consumer, output, session);
3159 if (ret != LTTNG_OK) {
3160 goto error_snapshot;
3161 }
3162
3163 ret = kernel_snapshot_record(ksess, output, wait, nb_packets_per_stream);
3164 if (ret != LTTNG_OK) {
3165 goto error_snapshot;
3166 }
3167
3168 ret = LTTNG_OK;
3169 goto end;
3170
3171 error_snapshot:
3172 /* Clean up copied sockets so this output can use some other later on. */
3173 consumer_destroy_output_sockets(output->consumer);
3174 error:
3175 end:
3176 return ret;
3177 }
3178
3179 /*
3180 * Record a UST snapshot.
3181 *
3182 * Return 0 on success or a LTTNG_ERR error code.
3183 */
3184 static int record_ust_snapshot(struct ltt_ust_session *usess,
3185 struct snapshot_output *output, struct ltt_session *session,
3186 int wait, uint64_t nb_packets_per_stream)
3187 {
3188 int ret;
3189
3190 assert(usess);
3191 assert(output);
3192 assert(session);
3193
3194 /* Get the datetime for the snapshot output directory. */
3195 ret = utils_get_current_time_str("%Y%m%d-%H%M%S", output->datetime,
3196 sizeof(output->datetime));
3197 if (!ret) {
3198 ret = LTTNG_ERR_INVALID;
3199 goto error;
3200 }
3201
3202 /*
3203 * Copy UST session sockets so we can communicate with the right
3204 * consumer for the snapshot record command.
3205 */
3206 ret = consumer_copy_sockets(output->consumer, usess->consumer);
3207 if (ret < 0) {
3208 ret = LTTNG_ERR_NOMEM;
3209 goto error;
3210 }
3211
3212 ret = set_relayd_for_snapshot(usess->consumer, output, session);
3213 if (ret != LTTNG_OK) {
3214 goto error_snapshot;
3215 }
3216
3217 ret = ust_app_snapshot_record(usess, output, wait, nb_packets_per_stream);
3218 if (ret < 0) {
3219 switch (-ret) {
3220 case EINVAL:
3221 ret = LTTNG_ERR_INVALID;
3222 break;
3223 case ENODATA:
3224 ret = LTTNG_ERR_SNAPSHOT_NODATA;
3225 break;
3226 default:
3227 ret = LTTNG_ERR_SNAPSHOT_FAIL;
3228 break;
3229 }
3230 goto error_snapshot;
3231 }
3232
3233 ret = LTTNG_OK;
3234
3235 error_snapshot:
3236 /* Clean up copied sockets so this output can use some other later on. */
3237 consumer_destroy_output_sockets(output->consumer);
3238 error:
3239 return ret;
3240 }
3241
3242 static
3243 uint64_t get_session_size_one_more_packet_per_stream(struct ltt_session *session,
3244 uint64_t cur_nr_packets)
3245 {
3246 uint64_t tot_size = 0;
3247
3248 if (session->kernel_session) {
3249 struct ltt_kernel_channel *chan;
3250 struct ltt_kernel_session *ksess = session->kernel_session;
3251
3252 cds_list_for_each_entry(chan, &ksess->channel_list.head, list) {
3253 if (cur_nr_packets >= chan->channel->attr.num_subbuf) {
3254 /*
3255 * Don't take channel into account if we
3256 * already grab all its packets.
3257 */
3258 continue;
3259 }
3260 tot_size += chan->channel->attr.subbuf_size
3261 * chan->stream_count;
3262 }
3263 }
3264
3265 if (session->ust_session) {
3266 struct ltt_ust_session *usess = session->ust_session;
3267
3268 tot_size += ust_app_get_size_one_more_packet_per_stream(usess,
3269 cur_nr_packets);
3270 }
3271
3272 return tot_size;
3273 }
3274
3275 /*
3276 * Calculate the number of packets we can grab from each stream that
3277 * fits within the overall snapshot max size.
3278 *
3279 * Returns -1 on error, 0 means infinite number of packets, else > 0 is
3280 * the number of packets per stream.
3281 *
3282 * TODO: this approach is not perfect: we consider the worse case
3283 * (packet filling the sub-buffers) as an upper bound, but we could do
3284 * better if we do this calculation while we actually grab the packet
3285 * content: we would know how much padding we don't actually store into
3286 * the file.
3287 *
3288 * This algorithm is currently bounded by the number of packets per
3289 * stream.
3290 *
3291 * Since we call this algorithm before actually grabbing the data, it's
3292 * an approximation: for instance, applications could appear/disappear
3293 * in between this call and actually grabbing data.
3294 */
3295 static
3296 int64_t get_session_nb_packets_per_stream(struct ltt_session *session, uint64_t max_size)
3297 {
3298 int64_t size_left;
3299 uint64_t cur_nb_packets = 0;
3300
3301 if (!max_size) {
3302 return 0; /* Infinite */
3303 }
3304
3305 size_left = max_size;
3306 for (;;) {
3307 uint64_t one_more_packet_tot_size;
3308
3309 one_more_packet_tot_size = get_session_size_one_more_packet_per_stream(session,
3310 cur_nb_packets);
3311 if (!one_more_packet_tot_size) {
3312 /* We are already grabbing all packets. */
3313 break;
3314 }
3315 size_left -= one_more_packet_tot_size;
3316 if (size_left < 0) {
3317 break;
3318 }
3319 cur_nb_packets++;
3320 }
3321 if (!cur_nb_packets) {
3322 /* Not enough room to grab one packet of each stream, error. */
3323 return -1;
3324 }
3325 return cur_nb_packets;
3326 }
3327
3328 /*
3329 * Command LTTNG_SNAPSHOT_RECORD from lib lttng ctl.
3330 *
3331 * The wait parameter is ignored so this call always wait for the snapshot to
3332 * complete before returning.
3333 *
3334 * Return LTTNG_OK on success or else a LTTNG_ERR code.
3335 */
3336 int cmd_snapshot_record(struct ltt_session *session,
3337 struct lttng_snapshot_output *output, int wait)
3338 {
3339 int ret = LTTNG_OK;
3340 unsigned int use_tmp_output = 0;
3341 struct snapshot_output tmp_output;
3342 unsigned int snapshot_success = 0;
3343
3344 assert(session);
3345 assert(output);
3346
3347 DBG("Cmd snapshot record for session %s", session->name);
3348
3349 /*
3350 * Permission denied to create an output if the session is not
3351 * set in no output mode.
3352 */
3353 if (session->output_traces) {
3354 ret = LTTNG_ERR_EPERM;
3355 goto error;
3356 }
3357
3358 /* The session needs to be started at least once. */
3359 if (!session->has_been_started) {
3360 ret = LTTNG_ERR_START_SESSION_ONCE;
3361 goto error;
3362 }
3363
3364 /* Use temporary output for the session. */
3365 if (*output->ctrl_url != '\0') {
3366 ret = snapshot_output_init(output->max_size, output->name,
3367 output->ctrl_url, output->data_url, session->consumer,
3368 &tmp_output, NULL);
3369 if (ret < 0) {
3370 if (ret == -ENOMEM) {
3371 ret = LTTNG_ERR_NOMEM;
3372 } else {
3373 ret = LTTNG_ERR_INVALID;
3374 }
3375 goto error;
3376 }
3377 /* Use the global session count for the temporary snapshot. */
3378 tmp_output.nb_snapshot = session->snapshot.nb_snapshot;
3379 use_tmp_output = 1;
3380 }
3381
3382 if (session->kernel_session) {
3383 struct ltt_kernel_session *ksess = session->kernel_session;
3384
3385 if (use_tmp_output) {
3386 int64_t nb_packets_per_stream;
3387
3388 nb_packets_per_stream = get_session_nb_packets_per_stream(session,
3389 tmp_output.max_size);
3390 if (nb_packets_per_stream < 0) {
3391 ret = LTTNG_ERR_MAX_SIZE_INVALID;
3392 goto error;
3393 }
3394 ret = record_kernel_snapshot(ksess, &tmp_output, session,
3395 wait, nb_packets_per_stream);
3396 if (ret != LTTNG_OK) {
3397 goto error;
3398 }
3399 snapshot_success = 1;
3400 } else {
3401 struct snapshot_output *sout;
3402 struct lttng_ht_iter iter;
3403
3404 rcu_read_lock();
3405 cds_lfht_for_each_entry(session->snapshot.output_ht->ht,
3406 &iter.iter, sout, node.node) {
3407 int64_t nb_packets_per_stream;
3408
3409 /*
3410 * Make a local copy of the output and assign the possible
3411 * temporary value given by the caller.
3412 */
3413 memset(&tmp_output, 0, sizeof(tmp_output));
3414 memcpy(&tmp_output, sout, sizeof(tmp_output));
3415
3416 if (output->max_size != (uint64_t) -1ULL) {
3417 tmp_output.max_size = output->max_size;
3418 }
3419
3420 nb_packets_per_stream = get_session_nb_packets_per_stream(session,
3421 tmp_output.max_size);
3422 if (nb_packets_per_stream < 0) {
3423 ret = LTTNG_ERR_MAX_SIZE_INVALID;
3424 goto error;
3425 }
3426
3427 /* Use temporary name. */
3428 if (*output->name != '\0') {
3429 strncpy(tmp_output.name, output->name,
3430 sizeof(tmp_output.name));
3431 }
3432
3433 tmp_output.nb_snapshot = session->snapshot.nb_snapshot;
3434
3435 ret = record_kernel_snapshot(ksess, &tmp_output,
3436 session, wait, nb_packets_per_stream);
3437 if (ret != LTTNG_OK) {
3438 rcu_read_unlock();
3439 goto error;
3440 }
3441 snapshot_success = 1;
3442 }
3443 rcu_read_unlock();
3444 }
3445 }
3446
3447 if (session->ust_session) {
3448 struct ltt_ust_session *usess = session->ust_session;
3449
3450 if (use_tmp_output) {
3451 int64_t nb_packets_per_stream;
3452
3453 nb_packets_per_stream = get_session_nb_packets_per_stream(session,
3454 tmp_output.max_size);
3455 if (nb_packets_per_stream < 0) {
3456 ret = LTTNG_ERR_MAX_SIZE_INVALID;
3457 goto error;
3458 }
3459 ret = record_ust_snapshot(usess, &tmp_output, session,
3460 wait, nb_packets_per_stream);
3461 if (ret != LTTNG_OK) {
3462 goto error;
3463 }
3464 snapshot_success = 1;
3465 } else {
3466 struct snapshot_output *sout;
3467 struct lttng_ht_iter iter;
3468
3469 rcu_read_lock();
3470 cds_lfht_for_each_entry(session->snapshot.output_ht->ht,
3471 &iter.iter, sout, node.node) {
3472 int64_t nb_packets_per_stream;
3473
3474 /*
3475 * Make a local copy of the output and assign the possible
3476 * temporary value given by the caller.
3477 */
3478 memset(&tmp_output, 0, sizeof(tmp_output));
3479 memcpy(&tmp_output, sout, sizeof(tmp_output));
3480
3481 if (output->max_size != (uint64_t) -1ULL) {
3482 tmp_output.max_size = output->max_size;
3483 }
3484
3485 nb_packets_per_stream = get_session_nb_packets_per_stream(session,
3486 tmp_output.max_size);
3487 if (nb_packets_per_stream < 0) {
3488 ret = LTTNG_ERR_MAX_SIZE_INVALID;
3489 rcu_read_unlock();
3490 goto error;
3491 }
3492
3493 /* Use temporary name. */
3494 if (*output->name != '\0') {
3495 strncpy(tmp_output.name, output->name,
3496 sizeof(tmp_output.name));
3497 }
3498
3499 tmp_output.nb_snapshot = session->snapshot.nb_snapshot;
3500
3501 ret = record_ust_snapshot(usess, &tmp_output, session,
3502 wait, nb_packets_per_stream);
3503 if (ret != LTTNG_OK) {
3504 rcu_read_unlock();
3505 goto error;
3506 }
3507 snapshot_success = 1;
3508 }
3509 rcu_read_unlock();
3510 }
3511 }
3512
3513 if (snapshot_success) {
3514 session->snapshot.nb_snapshot++;
3515 } else {
3516 ret = LTTNG_ERR_SNAPSHOT_FAIL;
3517 }
3518
3519 error:
3520 return ret;
3521 }
3522
3523 /*
3524 * Command LTTNG_SET_SESSION_SHM_PATH processed by the client thread.
3525 */
3526 int cmd_set_session_shm_path(struct ltt_session *session,
3527 const char *shm_path)
3528 {
3529 /* Safety net */
3530 assert(session);
3531
3532 /*
3533 * Can only set shm path before session is started.
3534 */
3535 if (session->has_been_started) {
3536 return LTTNG_ERR_SESSION_STARTED;
3537 }
3538
3539 strncpy(session->shm_path, shm_path,
3540 sizeof(session->shm_path));
3541 session->shm_path[sizeof(session->shm_path) - 1] = '\0';
3542
3543 return 0;
3544 }
3545
3546 /*
3547 * Init command subsystem.
3548 */
3549 void cmd_init(void)
3550 {
3551 /*
3552 * Set network sequence index to 1 for streams to match a relayd
3553 * socket on the consumer side.
3554 */
3555 pthread_mutex_lock(&relayd_net_seq_idx_lock);
3556 relayd_net_seq_idx = 1;
3557 pthread_mutex_unlock(&relayd_net_seq_idx_lock);
3558
3559 DBG("Command subsystem initialized");
3560 }
LTTng 2.0 tools and control repository
This page took 0.141123 seconds and 3 git commands to generate.