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