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