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


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