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