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


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