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