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