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