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