Size-based rotation
[lttng-tools.git] / src / bin / lttng-sessiond / main.c
1 /*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * 2013 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 2 only,
8 * as published by the Free Software Foundation.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 */
19
20 #define _LGPL_SOURCE
21 #include <getopt.h>
22 #include <grp.h>
23 #include <limits.h>
24 #include <paths.h>
25 #include <pthread.h>
26 #include <signal.h>
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <string.h>
30 #include <inttypes.h>
31 #include <sys/mman.h>
32 #include <sys/mount.h>
33 #include <sys/resource.h>
34 #include <sys/socket.h>
35 #include <sys/stat.h>
36 #include <sys/types.h>
37 #include <sys/wait.h>
38 #include <urcu/uatomic.h>
39 #include <unistd.h>
40 #include <ctype.h>
41
42 #include <common/common.h>
43 #include <common/compat/socket.h>
44 #include <common/compat/getenv.h>
45 #include <common/defaults.h>
46 #include <common/kernel-consumer/kernel-consumer.h>
47 #include <common/futex.h>
48 #include <common/relayd/relayd.h>
49 #include <common/utils.h>
50 #include <common/daemonize.h>
51 #include <common/config/session-config.h>
52
53 #include "lttng-sessiond.h"
54 #include "buffer-registry.h"
55 #include "channel.h"
56 #include "cmd.h"
57 #include "consumer.h"
58 #include "context.h"
59 #include "event.h"
60 #include "kernel.h"
61 #include "kernel-consumer.h"
62 #include "modprobe.h"
63 #include "shm.h"
64 #include "ust-ctl.h"
65 #include "ust-consumer.h"
66 #include "utils.h"
67 #include "fd-limit.h"
68 #include "health-sessiond.h"
69 #include "testpoint.h"
70 #include "ust-thread.h"
71 #include "agent-thread.h"
72 #include "save.h"
73 #include "load-session-thread.h"
74 #include "notification-thread.h"
75 #include "notification-thread-commands.h"
76 #include "rotation-thread.h"
77 #include "syscall.h"
78 #include "agent.h"
79 #include "ht-cleanup.h"
80 #include "sessiond-config.h"
81 #include "sessiond-timer.h"
82
83 static const char *help_msg =
84 #ifdef LTTNG_EMBED_HELP
85 #include <lttng-sessiond.8.h>
86 #else
87 NULL
88 #endif
89 ;
90
91 const char *progname;
92 static pid_t ppid; /* Parent PID for --sig-parent option */
93 static pid_t child_ppid; /* Internal parent PID use with daemonize. */
94 static int lockfile_fd = -1;
95
96 /* Set to 1 when a SIGUSR1 signal is received. */
97 static int recv_child_signal;
98
99 static struct lttng_kernel_tracer_version kernel_tracer_version;
100 static struct lttng_kernel_tracer_abi_version kernel_tracer_abi_version;
101
102 /*
103 * Consumer daemon specific control data. Every value not initialized here is
104 * set to 0 by the static definition.
105 */
106 static struct consumer_data kconsumer_data = {
107 .type = LTTNG_CONSUMER_KERNEL,
108 .err_sock = -1,
109 .cmd_sock = -1,
110 .channel_monitor_pipe = -1,
111 .channel_rotate_pipe = -1,
112 .pid_mutex = PTHREAD_MUTEX_INITIALIZER,
113 .lock = PTHREAD_MUTEX_INITIALIZER,
114 .cond = PTHREAD_COND_INITIALIZER,
115 .cond_mutex = PTHREAD_MUTEX_INITIALIZER,
116 };
117 static struct consumer_data ustconsumer64_data = {
118 .type = LTTNG_CONSUMER64_UST,
119 .err_sock = -1,
120 .cmd_sock = -1,
121 .channel_monitor_pipe = -1,
122 .channel_rotate_pipe = -1,
123 .pid_mutex = PTHREAD_MUTEX_INITIALIZER,
124 .lock = PTHREAD_MUTEX_INITIALIZER,
125 .cond = PTHREAD_COND_INITIALIZER,
126 .cond_mutex = PTHREAD_MUTEX_INITIALIZER,
127 };
128 static struct consumer_data ustconsumer32_data = {
129 .type = LTTNG_CONSUMER32_UST,
130 .err_sock = -1,
131 .cmd_sock = -1,
132 .channel_monitor_pipe = -1,
133 .channel_rotate_pipe = -1,
134 .pid_mutex = PTHREAD_MUTEX_INITIALIZER,
135 .lock = PTHREAD_MUTEX_INITIALIZER,
136 .cond = PTHREAD_COND_INITIALIZER,
137 .cond_mutex = PTHREAD_MUTEX_INITIALIZER,
138 };
139
140 /* Command line options */
141 static const struct option long_options[] = {
142 { "client-sock", required_argument, 0, 'c' },
143 { "apps-sock", required_argument, 0, 'a' },
144 { "kconsumerd-cmd-sock", required_argument, 0, '\0' },
145 { "kconsumerd-err-sock", required_argument, 0, '\0' },
146 { "ustconsumerd32-cmd-sock", required_argument, 0, '\0' },
147 { "ustconsumerd32-err-sock", required_argument, 0, '\0' },
148 { "ustconsumerd64-cmd-sock", required_argument, 0, '\0' },
149 { "ustconsumerd64-err-sock", required_argument, 0, '\0' },
150 { "consumerd32-path", required_argument, 0, '\0' },
151 { "consumerd32-libdir", required_argument, 0, '\0' },
152 { "consumerd64-path", required_argument, 0, '\0' },
153 { "consumerd64-libdir", required_argument, 0, '\0' },
154 { "daemonize", no_argument, 0, 'd' },
155 { "background", no_argument, 0, 'b' },
156 { "sig-parent", no_argument, 0, 'S' },
157 { "help", no_argument, 0, 'h' },
158 { "group", required_argument, 0, 'g' },
159 { "version", no_argument, 0, 'V' },
160 { "quiet", no_argument, 0, 'q' },
161 { "verbose", no_argument, 0, 'v' },
162 { "verbose-consumer", no_argument, 0, '\0' },
163 { "no-kernel", no_argument, 0, '\0' },
164 { "pidfile", required_argument, 0, 'p' },
165 { "agent-tcp-port", required_argument, 0, '\0' },
166 { "config", required_argument, 0, 'f' },
167 { "load", required_argument, 0, 'l' },
168 { "kmod-probes", required_argument, 0, '\0' },
169 { "extra-kmod-probes", required_argument, 0, '\0' },
170 { NULL, 0, 0, 0 }
171 };
172
173 struct sessiond_config config;
174
175 /* Command line options to ignore from configuration file */
176 static const char *config_ignore_options[] = { "help", "version", "config" };
177
178 /* Shared between threads */
179 static int dispatch_thread_exit;
180
181 /* Sockets and FDs */
182 static int client_sock = -1;
183 static int apps_sock = -1;
184 int kernel_tracer_fd = -1;
185 static int kernel_poll_pipe[2] = { -1, -1 };
186
187 /*
188 * Quit pipe for all threads. This permits a single cancellation point
189 * for all threads when receiving an event on the pipe.
190 */
191 static int thread_quit_pipe[2] = { -1, -1 };
192
193 /*
194 * This pipe is used to inform the thread managing application communication
195 * that a command is queued and ready to be processed.
196 */
197 static int apps_cmd_pipe[2] = { -1, -1 };
198
199 int apps_cmd_notify_pipe[2] = { -1, -1 };
200
201 /* Pthread, Mutexes and Semaphores */
202 static pthread_t apps_thread;
203 static pthread_t apps_notify_thread;
204 static pthread_t reg_apps_thread;
205 static pthread_t client_thread;
206 static pthread_t kernel_thread;
207 static pthread_t dispatch_thread;
208 static pthread_t health_thread;
209 static pthread_t ht_cleanup_thread;
210 static pthread_t agent_reg_thread;
211 static pthread_t load_session_thread;
212 static pthread_t notification_thread;
213 static pthread_t rotation_thread;
214 static pthread_t timer_thread;
215
216 /*
217 * UST registration command queue. This queue is tied with a futex and uses a N
218 * wakers / 1 waiter implemented and detailed in futex.c/.h
219 *
220 * The thread_registration_apps and thread_dispatch_ust_registration uses this
221 * queue along with the wait/wake scheme. The thread_manage_apps receives down
222 * the line new application socket and monitors it for any I/O error or clean
223 * close that triggers an unregistration of the application.
224 */
225 static struct ust_cmd_queue ust_cmd_queue;
226
227 /*
228 * Pointer initialized before thread creation.
229 *
230 * This points to the tracing session list containing the session count and a
231 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
232 * MUST NOT be taken if you call a public function in session.c.
233 *
234 * The lock is nested inside the structure: session_list_ptr->lock. Please use
235 * session_lock_list and session_unlock_list for lock acquisition.
236 */
237 static struct ltt_session_list *session_list_ptr;
238
239 int ust_consumerd64_fd = -1;
240 int ust_consumerd32_fd = -1;
241
242 static const char *module_proc_lttng = "/proc/lttng";
243
244 /*
245 * Consumer daemon state which is changed when spawning it, killing it or in
246 * case of a fatal error.
247 */
248 enum consumerd_state {
249 CONSUMER_STARTED = 1,
250 CONSUMER_STOPPED = 2,
251 CONSUMER_ERROR = 3,
252 };
253
254 /*
255 * This consumer daemon state is used to validate if a client command will be
256 * able to reach the consumer. If not, the client is informed. For instance,
257 * doing a "lttng start" when the consumer state is set to ERROR will return an
258 * error to the client.
259 *
260 * The following example shows a possible race condition of this scheme:
261 *
262 * consumer thread error happens
263 * client cmd arrives
264 * client cmd checks state -> still OK
265 * consumer thread exit, sets error
266 * client cmd try to talk to consumer
267 * ...
268 *
269 * However, since the consumer is a different daemon, we have no way of making
270 * sure the command will reach it safely even with this state flag. This is why
271 * we consider that up to the state validation during command processing, the
272 * command is safe. After that, we can not guarantee the correctness of the
273 * client request vis-a-vis the consumer.
274 */
275 static enum consumerd_state ust_consumerd_state;
276 static enum consumerd_state kernel_consumerd_state;
277
278 /* Set in main() with the current page size. */
279 long page_size;
280
281 /* Application health monitoring */
282 struct health_app *health_sessiond;
283
284 /* Am I root or not. */
285 int is_root; /* Set to 1 if the daemon is running as root */
286
287 const char * const config_section_name = "sessiond";
288
289 /* Load session thread information to operate. */
290 struct load_session_thread_data *load_info;
291
292 /* Notification thread handle. */
293 struct notification_thread_handle *notification_thread_handle;
294
295 /* Rotation thread handle. */
296 struct rotation_thread_handle *rotation_thread_handle;
297
298 /* Global hash tables */
299 struct lttng_ht *agent_apps_ht_by_sock = NULL;
300
301 /*
302 * Whether sessiond is ready for commands/notification channel/health check
303 * requests.
304 * NR_LTTNG_SESSIOND_READY must match the number of calls to
305 * sessiond_notify_ready().
306 */
307 #define NR_LTTNG_SESSIOND_READY 5
308 int lttng_sessiond_ready = NR_LTTNG_SESSIOND_READY;
309
310 int sessiond_check_thread_quit_pipe(int fd, uint32_t events)
311 {
312 return (fd == thread_quit_pipe[0] && (events & LPOLLIN)) ? 1 : 0;
313 }
314
315 /* Notify parents that we are ready for cmd and health check */
316 LTTNG_HIDDEN
317 void sessiond_notify_ready(void)
318 {
319 if (uatomic_sub_return(&lttng_sessiond_ready, 1) == 0) {
320 /*
321 * Notify parent pid that we are ready to accept command
322 * for client side. This ppid is the one from the
323 * external process that spawned us.
324 */
325 if (config.sig_parent) {
326 kill(ppid, SIGUSR1);
327 }
328
329 /*
330 * Notify the parent of the fork() process that we are
331 * ready.
332 */
333 if (config.daemonize || config.background) {
334 kill(child_ppid, SIGUSR1);
335 }
336 }
337 }
338
339 static
340 int __sessiond_set_thread_pollset(struct lttng_poll_event *events, size_t size,
341 int *a_pipe)
342 {
343 int ret;
344
345 assert(events);
346
347 ret = lttng_poll_create(events, size, LTTNG_CLOEXEC);
348 if (ret < 0) {
349 goto error;
350 }
351
352 /* Add quit pipe */
353 ret = lttng_poll_add(events, a_pipe[0], LPOLLIN | LPOLLERR);
354 if (ret < 0) {
355 goto error;
356 }
357
358 return 0;
359
360 error:
361 return ret;
362 }
363
364 /*
365 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
366 */
367 int sessiond_set_thread_pollset(struct lttng_poll_event *events, size_t size)
368 {
369 return __sessiond_set_thread_pollset(events, size, thread_quit_pipe);
370 }
371
372 /*
373 * Init thread quit pipe.
374 *
375 * Return -1 on error or 0 if all pipes are created.
376 */
377 static int __init_thread_quit_pipe(int *a_pipe)
378 {
379 int ret, i;
380
381 ret = pipe(a_pipe);
382 if (ret < 0) {
383 PERROR("thread quit pipe");
384 goto error;
385 }
386
387 for (i = 0; i < 2; i++) {
388 ret = fcntl(a_pipe[i], F_SETFD, FD_CLOEXEC);
389 if (ret < 0) {
390 PERROR("fcntl");
391 goto error;
392 }
393 }
394
395 error:
396 return ret;
397 }
398
399 static int init_thread_quit_pipe(void)
400 {
401 return __init_thread_quit_pipe(thread_quit_pipe);
402 }
403
404 /*
405 * Stop all threads by closing the thread quit pipe.
406 */
407 static void stop_threads(void)
408 {
409 int ret;
410
411 /* Stopping all threads */
412 DBG("Terminating all threads");
413 ret = notify_thread_pipe(thread_quit_pipe[1]);
414 if (ret < 0) {
415 ERR("write error on thread quit pipe");
416 }
417
418 /* Dispatch thread */
419 CMM_STORE_SHARED(dispatch_thread_exit, 1);
420 futex_nto1_wake(&ust_cmd_queue.futex);
421 }
422
423 /*
424 * Close every consumer sockets.
425 */
426 static void close_consumer_sockets(void)
427 {
428 int ret;
429
430 if (kconsumer_data.err_sock >= 0) {
431 ret = close(kconsumer_data.err_sock);
432 if (ret < 0) {
433 PERROR("kernel consumer err_sock close");
434 }
435 }
436 if (ustconsumer32_data.err_sock >= 0) {
437 ret = close(ustconsumer32_data.err_sock);
438 if (ret < 0) {
439 PERROR("UST consumerd32 err_sock close");
440 }
441 }
442 if (ustconsumer64_data.err_sock >= 0) {
443 ret = close(ustconsumer64_data.err_sock);
444 if (ret < 0) {
445 PERROR("UST consumerd64 err_sock close");
446 }
447 }
448 if (kconsumer_data.cmd_sock >= 0) {
449 ret = close(kconsumer_data.cmd_sock);
450 if (ret < 0) {
451 PERROR("kernel consumer cmd_sock close");
452 }
453 }
454 if (ustconsumer32_data.cmd_sock >= 0) {
455 ret = close(ustconsumer32_data.cmd_sock);
456 if (ret < 0) {
457 PERROR("UST consumerd32 cmd_sock close");
458 }
459 }
460 if (ustconsumer64_data.cmd_sock >= 0) {
461 ret = close(ustconsumer64_data.cmd_sock);
462 if (ret < 0) {
463 PERROR("UST consumerd64 cmd_sock close");
464 }
465 }
466 if (kconsumer_data.channel_monitor_pipe >= 0) {
467 ret = close(kconsumer_data.channel_monitor_pipe);
468 if (ret < 0) {
469 PERROR("kernel consumer channel monitor pipe close");
470 }
471 }
472 if (ustconsumer32_data.channel_monitor_pipe >= 0) {
473 ret = close(ustconsumer32_data.channel_monitor_pipe);
474 if (ret < 0) {
475 PERROR("UST consumerd32 channel monitor pipe close");
476 }
477 }
478 if (ustconsumer64_data.channel_monitor_pipe >= 0) {
479 ret = close(ustconsumer64_data.channel_monitor_pipe);
480 if (ret < 0) {
481 PERROR("UST consumerd64 channel monitor pipe close");
482 }
483 }
484 if (kconsumer_data.channel_rotate_pipe >= 0) {
485 ret = close(kconsumer_data.channel_rotate_pipe);
486 if (ret < 0) {
487 PERROR("kernel consumer channel rotate pipe close");
488 }
489 }
490 if (ustconsumer32_data.channel_rotate_pipe >= 0) {
491 ret = close(ustconsumer32_data.channel_rotate_pipe);
492 if (ret < 0) {
493 PERROR("UST consumerd32 channel rotate pipe close");
494 }
495 }
496 if (ustconsumer64_data.channel_rotate_pipe >= 0) {
497 ret = close(ustconsumer64_data.channel_rotate_pipe);
498 if (ret < 0) {
499 PERROR("UST consumerd64 channel rotate pipe close");
500 }
501 }
502 }
503
504 /*
505 * Wait on consumer process termination.
506 *
507 * Need to be called with the consumer data lock held or from a context
508 * ensuring no concurrent access to data (e.g: cleanup).
509 */
510 static void wait_consumer(struct consumer_data *consumer_data)
511 {
512 pid_t ret;
513 int status;
514
515 if (consumer_data->pid <= 0) {
516 return;
517 }
518
519 DBG("Waiting for complete teardown of consumerd (PID: %d)",
520 consumer_data->pid);
521 ret = waitpid(consumer_data->pid, &status, 0);
522 if (ret == -1) {
523 PERROR("consumerd waitpid pid: %d", consumer_data->pid)
524 } else if (!WIFEXITED(status)) {
525 ERR("consumerd termination with error: %d",
526 WEXITSTATUS(ret));
527 }
528 consumer_data->pid = 0;
529 }
530
531 /*
532 * Cleanup the session daemon's data structures.
533 */
534 static void sessiond_cleanup(void)
535 {
536 int ret;
537 struct ltt_session *sess, *stmp;
538
539 DBG("Cleanup sessiond");
540
541 /*
542 * Close the thread quit pipe. It has already done its job,
543 * since we are now called.
544 */
545 utils_close_pipe(thread_quit_pipe);
546
547 /*
548 * If config.pid_file_path.value is undefined, the default file will be
549 * wiped when removing the rundir.
550 */
551 if (config.pid_file_path.value) {
552 ret = remove(config.pid_file_path.value);
553 if (ret < 0) {
554 PERROR("remove pidfile %s", config.pid_file_path.value);
555 }
556 }
557
558 DBG("Removing sessiond and consumerd content of directory %s",
559 config.rundir.value);
560
561 /* sessiond */
562 DBG("Removing %s", config.pid_file_path.value);
563 (void) unlink(config.pid_file_path.value);
564
565 DBG("Removing %s", config.agent_port_file_path.value);
566 (void) unlink(config.agent_port_file_path.value);
567
568 /* kconsumerd */
569 DBG("Removing %s", kconsumer_data.err_unix_sock_path);
570 (void) unlink(kconsumer_data.err_unix_sock_path);
571
572 DBG("Removing directory %s", config.kconsumerd_path.value);
573 (void) rmdir(config.kconsumerd_path.value);
574
575 /* ust consumerd 32 */
576 DBG("Removing %s", config.consumerd32_err_unix_sock_path.value);
577 (void) unlink(config.consumerd32_err_unix_sock_path.value);
578
579 DBG("Removing directory %s", config.consumerd32_path.value);
580 (void) rmdir(config.consumerd32_path.value);
581
582 /* ust consumerd 64 */
583 DBG("Removing %s", config.consumerd64_err_unix_sock_path.value);
584 (void) unlink(config.consumerd64_err_unix_sock_path.value);
585
586 DBG("Removing directory %s", config.consumerd64_path.value);
587 (void) rmdir(config.consumerd64_path.value);
588
589 DBG("Cleaning up all sessions");
590
591 /* Destroy session list mutex */
592 if (session_list_ptr != NULL) {
593 pthread_mutex_destroy(&session_list_ptr->lock);
594
595 /* Cleanup ALL session */
596 cds_list_for_each_entry_safe(sess, stmp,
597 &session_list_ptr->head, list) {
598 cmd_destroy_session(sess, kernel_poll_pipe[1],
599 notification_thread_handle);
600 }
601 }
602
603 wait_consumer(&kconsumer_data);
604 wait_consumer(&ustconsumer64_data);
605 wait_consumer(&ustconsumer32_data);
606
607 DBG("Cleaning up all agent apps");
608 agent_app_ht_clean();
609
610 DBG("Closing all UST sockets");
611 ust_app_clean_list();
612 buffer_reg_destroy_registries();
613
614 if (is_root && !config.no_kernel) {
615 DBG2("Closing kernel fd");
616 if (kernel_tracer_fd >= 0) {
617 ret = close(kernel_tracer_fd);
618 if (ret) {
619 PERROR("close");
620 }
621 }
622 DBG("Unloading kernel modules");
623 modprobe_remove_lttng_all();
624 free(syscall_table);
625 }
626
627 close_consumer_sockets();
628
629 if (load_info) {
630 load_session_destroy_data(load_info);
631 free(load_info);
632 }
633
634 /*
635 * Cleanup lock file by deleting it and finaly closing it which will
636 * release the file system lock.
637 */
638 if (lockfile_fd >= 0) {
639 ret = remove(config.lock_file_path.value);
640 if (ret < 0) {
641 PERROR("remove lock file");
642 }
643 ret = close(lockfile_fd);
644 if (ret < 0) {
645 PERROR("close lock file");
646 }
647 }
648
649 /*
650 * We do NOT rmdir rundir because there are other processes
651 * using it, for instance lttng-relayd, which can start in
652 * parallel with this teardown.
653 */
654 }
655
656 /*
657 * Cleanup the daemon's option data structures.
658 */
659 static void sessiond_cleanup_options(void)
660 {
661 DBG("Cleaning up options");
662
663 sessiond_config_fini(&config);
664
665 run_as_destroy_worker();
666 }
667
668 /*
669 * Send data on a unix socket using the liblttsessiondcomm API.
670 *
671 * Return lttcomm error code.
672 */
673 static int send_unix_sock(int sock, void *buf, size_t len)
674 {
675 /* Check valid length */
676 if (len == 0) {
677 return -1;
678 }
679
680 return lttcomm_send_unix_sock(sock, buf, len);
681 }
682
683 /*
684 * Free memory of a command context structure.
685 */
686 static void clean_command_ctx(struct command_ctx **cmd_ctx)
687 {
688 DBG("Clean command context structure");
689 if (*cmd_ctx) {
690 if ((*cmd_ctx)->llm) {
691 free((*cmd_ctx)->llm);
692 }
693 if ((*cmd_ctx)->lsm) {
694 free((*cmd_ctx)->lsm);
695 }
696 free(*cmd_ctx);
697 *cmd_ctx = NULL;
698 }
699 }
700
701 /*
702 * Notify UST applications using the shm mmap futex.
703 */
704 static int notify_ust_apps(int active)
705 {
706 char *wait_shm_mmap;
707
708 DBG("Notifying applications of session daemon state: %d", active);
709
710 /* See shm.c for this call implying mmap, shm and futex calls */
711 wait_shm_mmap = shm_ust_get_mmap(config.wait_shm_path.value, is_root);
712 if (wait_shm_mmap == NULL) {
713 goto error;
714 }
715
716 /* Wake waiting process */
717 futex_wait_update((int32_t *) wait_shm_mmap, active);
718
719 /* Apps notified successfully */
720 return 0;
721
722 error:
723 return -1;
724 }
725
726 /*
727 * Setup the outgoing data buffer for the response (llm) by allocating the
728 * right amount of memory and copying the original information from the lsm
729 * structure.
730 *
731 * Return 0 on success, negative value on error.
732 */
733 static int setup_lttng_msg(struct command_ctx *cmd_ctx,
734 const void *payload_buf, size_t payload_len,
735 const void *cmd_header_buf, size_t cmd_header_len)
736 {
737 int ret = 0;
738 const size_t header_len = sizeof(struct lttcomm_lttng_msg);
739 const size_t cmd_header_offset = header_len;
740 const size_t payload_offset = cmd_header_offset + cmd_header_len;
741 const size_t total_msg_size = header_len + cmd_header_len + payload_len;
742
743 cmd_ctx->llm = zmalloc(total_msg_size);
744
745 if (cmd_ctx->llm == NULL) {
746 PERROR("zmalloc");
747 ret = -ENOMEM;
748 goto end;
749 }
750
751 /* Copy common data */
752 cmd_ctx->llm->cmd_type = cmd_ctx->lsm->cmd_type;
753 cmd_ctx->llm->pid = cmd_ctx->lsm->domain.attr.pid;
754 cmd_ctx->llm->cmd_header_size = cmd_header_len;
755 cmd_ctx->llm->data_size = payload_len;
756 cmd_ctx->lttng_msg_size = total_msg_size;
757
758 /* Copy command header */
759 if (cmd_header_len) {
760 memcpy(((uint8_t *) cmd_ctx->llm) + cmd_header_offset, cmd_header_buf,
761 cmd_header_len);
762 }
763
764 /* Copy payload */
765 if (payload_len) {
766 memcpy(((uint8_t *) cmd_ctx->llm) + payload_offset, payload_buf,
767 payload_len);
768 }
769
770 end:
771 return ret;
772 }
773
774 /*
775 * Version of setup_lttng_msg() without command header.
776 */
777 static int setup_lttng_msg_no_cmd_header(struct command_ctx *cmd_ctx,
778 void *payload_buf, size_t payload_len)
779 {
780 return setup_lttng_msg(cmd_ctx, payload_buf, payload_len, NULL, 0);
781 }
782 /*
783 * Update the kernel poll set of all channel fd available over all tracing
784 * session. Add the wakeup pipe at the end of the set.
785 */
786 static int update_kernel_poll(struct lttng_poll_event *events)
787 {
788 int ret;
789 struct ltt_session *session;
790 struct ltt_kernel_channel *channel;
791
792 DBG("Updating kernel poll set");
793
794 session_lock_list();
795 cds_list_for_each_entry(session, &session_list_ptr->head, list) {
796 session_lock(session);
797 if (session->kernel_session == NULL) {
798 session_unlock(session);
799 continue;
800 }
801
802 cds_list_for_each_entry(channel,
803 &session->kernel_session->channel_list.head, list) {
804 /* Add channel fd to the kernel poll set */
805 ret = lttng_poll_add(events, channel->fd, LPOLLIN | LPOLLRDNORM);
806 if (ret < 0) {
807 session_unlock(session);
808 goto error;
809 }
810 DBG("Channel fd %d added to kernel set", channel->fd);
811 }
812 session_unlock(session);
813 }
814 session_unlock_list();
815
816 return 0;
817
818 error:
819 session_unlock_list();
820 return -1;
821 }
822
823 /*
824 * Find the channel fd from 'fd' over all tracing session. When found, check
825 * for new channel stream and send those stream fds to the kernel consumer.
826 *
827 * Useful for CPU hotplug feature.
828 */
829 static int update_kernel_stream(struct consumer_data *consumer_data, int fd)
830 {
831 int ret = 0;
832 struct ltt_session *session;
833 struct ltt_kernel_session *ksess;
834 struct ltt_kernel_channel *channel;
835
836 DBG("Updating kernel streams for channel fd %d", fd);
837
838 session_lock_list();
839 cds_list_for_each_entry(session, &session_list_ptr->head, list) {
840 session_lock(session);
841 if (session->kernel_session == NULL) {
842 session_unlock(session);
843 continue;
844 }
845 ksess = session->kernel_session;
846
847 cds_list_for_each_entry(channel,
848 &ksess->channel_list.head, list) {
849 struct lttng_ht_iter iter;
850 struct consumer_socket *socket;
851
852 if (channel->fd != fd) {
853 continue;
854 }
855 DBG("Channel found, updating kernel streams");
856 ret = kernel_open_channel_stream(channel);
857 if (ret < 0) {
858 goto error;
859 }
860 /* Update the stream global counter */
861 ksess->stream_count_global += ret;
862
863 /*
864 * Have we already sent fds to the consumer? If yes, it
865 * means that tracing is started so it is safe to send
866 * our updated stream fds.
867 */
868 if (ksess->consumer_fds_sent != 1
869 || ksess->consumer == NULL) {
870 ret = -1;
871 goto error;
872 }
873
874 rcu_read_lock();
875 cds_lfht_for_each_entry(ksess->consumer->socks->ht,
876 &iter.iter, socket, node.node) {
877 pthread_mutex_lock(socket->lock);
878 ret = kernel_consumer_send_channel_stream(socket,
879 channel, ksess,
880 session->output_traces ? 1 : 0);
881 pthread_mutex_unlock(socket->lock);
882 if (ret < 0) {
883 rcu_read_unlock();
884 goto error;
885 }
886 }
887 rcu_read_unlock();
888 }
889 session_unlock(session);
890 }
891 session_unlock_list();
892 return ret;
893
894 error:
895 session_unlock(session);
896 session_unlock_list();
897 return ret;
898 }
899
900 /*
901 * For each tracing session, update newly registered apps. The session list
902 * lock MUST be acquired before calling this.
903 */
904 static void update_ust_app(int app_sock)
905 {
906 struct ltt_session *sess, *stmp;
907
908 /* Consumer is in an ERROR state. Stop any application update. */
909 if (uatomic_read(&ust_consumerd_state) == CONSUMER_ERROR) {
910 /* Stop the update process since the consumer is dead. */
911 return;
912 }
913
914 /* For all tracing session(s) */
915 cds_list_for_each_entry_safe(sess, stmp, &session_list_ptr->head, list) {
916 struct ust_app *app;
917
918 session_lock(sess);
919 if (!sess->ust_session) {
920 goto unlock_session;
921 }
922
923 rcu_read_lock();
924 assert(app_sock >= 0);
925 app = ust_app_find_by_sock(app_sock);
926 if (app == NULL) {
927 /*
928 * Application can be unregistered before so
929 * this is possible hence simply stopping the
930 * update.
931 */
932 DBG3("UST app update failed to find app sock %d",
933 app_sock);
934 goto unlock_rcu;
935 }
936 ust_app_global_update(sess->ust_session, app);
937 unlock_rcu:
938 rcu_read_unlock();
939 unlock_session:
940 session_unlock(sess);
941 }
942 }
943
944 /*
945 * This thread manage event coming from the kernel.
946 *
947 * Features supported in this thread:
948 * -) CPU Hotplug
949 */
950 static void *thread_manage_kernel(void *data)
951 {
952 int ret, i, pollfd, update_poll_flag = 1, err = -1;
953 uint32_t revents, nb_fd;
954 char tmp;
955 struct lttng_poll_event events;
956
957 DBG("[thread] Thread manage kernel started");
958
959 health_register(health_sessiond, HEALTH_SESSIOND_TYPE_KERNEL);
960
961 /*
962 * This first step of the while is to clean this structure which could free
963 * non NULL pointers so initialize it before the loop.
964 */
965 lttng_poll_init(&events);
966
967 if (testpoint(sessiond_thread_manage_kernel)) {
968 goto error_testpoint;
969 }
970
971 health_code_update();
972
973 if (testpoint(sessiond_thread_manage_kernel_before_loop)) {
974 goto error_testpoint;
975 }
976
977 while (1) {
978 health_code_update();
979
980 if (update_poll_flag == 1) {
981 /* Clean events object. We are about to populate it again. */
982 lttng_poll_clean(&events);
983
984 ret = sessiond_set_thread_pollset(&events, 2);
985 if (ret < 0) {
986 goto error_poll_create;
987 }
988
989 ret = lttng_poll_add(&events, kernel_poll_pipe[0], LPOLLIN);
990 if (ret < 0) {
991 goto error;
992 }
993
994 /* This will add the available kernel channel if any. */
995 ret = update_kernel_poll(&events);
996 if (ret < 0) {
997 goto error;
998 }
999 update_poll_flag = 0;
1000 }
1001
1002 DBG("Thread kernel polling");
1003
1004 /* Poll infinite value of time */
1005 restart:
1006 health_poll_entry();
1007 ret = lttng_poll_wait(&events, -1);
1008 DBG("Thread kernel return from poll on %d fds",
1009 LTTNG_POLL_GETNB(&events));
1010 health_poll_exit();
1011 if (ret < 0) {
1012 /*
1013 * Restart interrupted system call.
1014 */
1015 if (errno == EINTR) {
1016 goto restart;
1017 }
1018 goto error;
1019 } else if (ret == 0) {
1020 /* Should not happen since timeout is infinite */
1021 ERR("Return value of poll is 0 with an infinite timeout.\n"
1022 "This should not have happened! Continuing...");
1023 continue;
1024 }
1025
1026 nb_fd = ret;
1027
1028 for (i = 0; i < nb_fd; i++) {
1029 /* Fetch once the poll data */
1030 revents = LTTNG_POLL_GETEV(&events, i);
1031 pollfd = LTTNG_POLL_GETFD(&events, i);
1032
1033 health_code_update();
1034
1035 if (!revents) {
1036 /* No activity for this FD (poll implementation). */
1037 continue;
1038 }
1039
1040 /* Thread quit pipe has been closed. Killing thread. */
1041 ret = sessiond_check_thread_quit_pipe(pollfd, revents);
1042 if (ret) {
1043 err = 0;
1044 goto exit;
1045 }
1046
1047 /* Check for data on kernel pipe */
1048 if (revents & LPOLLIN) {
1049 if (pollfd == kernel_poll_pipe[0]) {
1050 (void) lttng_read(kernel_poll_pipe[0],
1051 &tmp, 1);
1052 /*
1053 * Ret value is useless here, if this pipe gets any actions an
1054 * update is required anyway.
1055 */
1056 update_poll_flag = 1;
1057 continue;
1058 } else {
1059 /*
1060 * New CPU detected by the kernel. Adding kernel stream to
1061 * kernel session and updating the kernel consumer
1062 */
1063 ret = update_kernel_stream(&kconsumer_data, pollfd);
1064 if (ret < 0) {
1065 continue;
1066 }
1067 break;
1068 }
1069 } else if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
1070 update_poll_flag = 1;
1071 continue;
1072 } else {
1073 ERR("Unexpected poll events %u for sock %d", revents, pollfd);
1074 goto error;
1075 }
1076 }
1077 }
1078
1079 exit:
1080 error:
1081 lttng_poll_clean(&events);
1082 error_poll_create:
1083 error_testpoint:
1084 utils_close_pipe(kernel_poll_pipe);
1085 kernel_poll_pipe[0] = kernel_poll_pipe[1] = -1;
1086 if (err) {
1087 health_error();
1088 ERR("Health error occurred in %s", __func__);
1089 WARN("Kernel thread died unexpectedly. "
1090 "Kernel tracing can continue but CPU hotplug is disabled.");
1091 }
1092 health_unregister(health_sessiond);
1093 DBG("Kernel thread dying");
1094 return NULL;
1095 }
1096
1097 /*
1098 * Signal pthread condition of the consumer data that the thread.
1099 */
1100 static void signal_consumer_condition(struct consumer_data *data, int state)
1101 {
1102 pthread_mutex_lock(&data->cond_mutex);
1103
1104 /*
1105 * The state is set before signaling. It can be any value, it's the waiter
1106 * job to correctly interpret this condition variable associated to the
1107 * consumer pthread_cond.
1108 *
1109 * A value of 0 means that the corresponding thread of the consumer data
1110 * was not started. 1 indicates that the thread has started and is ready
1111 * for action. A negative value means that there was an error during the
1112 * thread bootstrap.
1113 */
1114 data->consumer_thread_is_ready = state;
1115 (void) pthread_cond_signal(&data->cond);
1116
1117 pthread_mutex_unlock(&data->cond_mutex);
1118 }
1119
1120 /*
1121 * This thread manage the consumer error sent back to the session daemon.
1122 */
1123 static void *thread_manage_consumer(void *data)
1124 {
1125 int sock = -1, i, ret, pollfd, err = -1, should_quit = 0;
1126 uint32_t revents, nb_fd;
1127 enum lttcomm_return_code code;
1128 struct lttng_poll_event events;
1129 struct consumer_data *consumer_data = data;
1130 struct consumer_socket *cmd_socket_wrapper = NULL;
1131
1132 DBG("[thread] Manage consumer started");
1133
1134 rcu_register_thread();
1135 rcu_thread_online();
1136
1137 health_register(health_sessiond, HEALTH_SESSIOND_TYPE_CONSUMER);
1138
1139 health_code_update();
1140
1141 /*
1142 * Pass 3 as size here for the thread quit pipe, consumerd_err_sock and the
1143 * metadata_sock. Nothing more will be added to this poll set.
1144 */
1145 ret = sessiond_set_thread_pollset(&events, 3);
1146 if (ret < 0) {
1147 goto error_poll;
1148 }
1149
1150 /*
1151 * The error socket here is already in a listening state which was done
1152 * just before spawning this thread to avoid a race between the consumer
1153 * daemon exec trying to connect and the listen() call.
1154 */
1155 ret = lttng_poll_add(&events, consumer_data->err_sock, LPOLLIN | LPOLLRDHUP);
1156 if (ret < 0) {
1157 goto error;
1158 }
1159
1160 health_code_update();
1161
1162 /* Infinite blocking call, waiting for transmission */
1163 restart:
1164 health_poll_entry();
1165
1166 if (testpoint(sessiond_thread_manage_consumer)) {
1167 goto error;
1168 }
1169
1170 ret = lttng_poll_wait(&events, -1);
1171 health_poll_exit();
1172 if (ret < 0) {
1173 /*
1174 * Restart interrupted system call.
1175 */
1176 if (errno == EINTR) {
1177 goto restart;
1178 }
1179 goto error;
1180 }
1181
1182 nb_fd = ret;
1183
1184 for (i = 0; i < nb_fd; i++) {
1185 /* Fetch once the poll data */
1186 revents = LTTNG_POLL_GETEV(&events, i);
1187 pollfd = LTTNG_POLL_GETFD(&events, i);
1188
1189 health_code_update();
1190
1191 if (!revents) {
1192 /* No activity for this FD (poll implementation). */
1193 continue;
1194 }
1195
1196 /* Thread quit pipe has been closed. Killing thread. */
1197 ret = sessiond_check_thread_quit_pipe(pollfd, revents);
1198 if (ret) {
1199 err = 0;
1200 goto exit;
1201 }
1202
1203 /* Event on the registration socket */
1204 if (pollfd == consumer_data->err_sock) {
1205 if (revents & LPOLLIN) {
1206 continue;
1207 } else if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
1208 ERR("consumer err socket poll error");
1209 goto error;
1210 } else {
1211 ERR("Unexpected poll events %u for sock %d", revents, pollfd);
1212 goto error;
1213 }
1214 }
1215 }
1216
1217 sock = lttcomm_accept_unix_sock(consumer_data->err_sock);
1218 if (sock < 0) {
1219 goto error;
1220 }
1221
1222 /*
1223 * Set the CLOEXEC flag. Return code is useless because either way, the
1224 * show must go on.
1225 */
1226 (void) utils_set_fd_cloexec(sock);
1227
1228 health_code_update();
1229
1230 DBG2("Receiving code from consumer err_sock");
1231
1232 /* Getting status code from kconsumerd */
1233 ret = lttcomm_recv_unix_sock(sock, &code,
1234 sizeof(enum lttcomm_return_code));
1235 if (ret <= 0) {
1236 goto error;
1237 }
1238
1239 health_code_update();
1240 if (code != LTTCOMM_CONSUMERD_COMMAND_SOCK_READY) {
1241 ERR("consumer error when waiting for SOCK_READY : %s",
1242 lttcomm_get_readable_code(-code));
1243 goto error;
1244 }
1245
1246 /* Connect both command and metadata sockets. */
1247 consumer_data->cmd_sock =
1248 lttcomm_connect_unix_sock(
1249 consumer_data->cmd_unix_sock_path);
1250 consumer_data->metadata_fd =
1251 lttcomm_connect_unix_sock(
1252 consumer_data->cmd_unix_sock_path);
1253 if (consumer_data->cmd_sock < 0 || consumer_data->metadata_fd < 0) {
1254 PERROR("consumer connect cmd socket");
1255 /* On error, signal condition and quit. */
1256 signal_consumer_condition(consumer_data, -1);
1257 goto error;
1258 }
1259
1260 consumer_data->metadata_sock.fd_ptr = &consumer_data->metadata_fd;
1261
1262 /* Create metadata socket lock. */
1263 consumer_data->metadata_sock.lock = zmalloc(sizeof(pthread_mutex_t));
1264 if (consumer_data->metadata_sock.lock == NULL) {
1265 PERROR("zmalloc pthread mutex");
1266 goto error;
1267 }
1268 pthread_mutex_init(consumer_data->metadata_sock.lock, NULL);
1269
1270 DBG("Consumer command socket ready (fd: %d", consumer_data->cmd_sock);
1271 DBG("Consumer metadata socket ready (fd: %d)",
1272 consumer_data->metadata_fd);
1273
1274 /*
1275 * Remove the consumerd error sock since we've established a connection.
1276 */
1277 ret = lttng_poll_del(&events, consumer_data->err_sock);
1278 if (ret < 0) {
1279 goto error;
1280 }
1281
1282 /* Add new accepted error socket. */
1283 ret = lttng_poll_add(&events, sock, LPOLLIN | LPOLLRDHUP);
1284 if (ret < 0) {
1285 goto error;
1286 }
1287
1288 /* Add metadata socket that is successfully connected. */
1289 ret = lttng_poll_add(&events, consumer_data->metadata_fd,
1290 LPOLLIN | LPOLLRDHUP);
1291 if (ret < 0) {
1292 goto error;
1293 }
1294
1295 health_code_update();
1296
1297 /*
1298 * Transfer the write-end of the channel monitoring and rotate pipe
1299 * to the consumer by issuing a SET_CHANNEL_MONITOR_PIPE and
1300 * SET_CHANNEL_ROTATE_PIPE commands.
1301 */
1302 cmd_socket_wrapper = consumer_allocate_socket(&consumer_data->cmd_sock);
1303 if (!cmd_socket_wrapper) {
1304 goto error;
1305 }
1306 cmd_socket_wrapper->lock = &consumer_data->lock;
1307
1308 ret = consumer_send_channel_monitor_pipe(cmd_socket_wrapper,
1309 consumer_data->channel_monitor_pipe);
1310 if (ret) {
1311 goto error;
1312 }
1313
1314 ret = consumer_send_channel_rotate_pipe(cmd_socket_wrapper,
1315 consumer_data->channel_rotate_pipe);
1316 if (ret) {
1317 goto error;
1318 }
1319
1320 /* Discard the socket wrapper as it is no longer needed. */
1321 consumer_destroy_socket(cmd_socket_wrapper);
1322 cmd_socket_wrapper = NULL;
1323
1324 /* The thread is completely initialized, signal that it is ready. */
1325 signal_consumer_condition(consumer_data, 1);
1326
1327 /* Infinite blocking call, waiting for transmission */
1328 restart_poll:
1329 while (1) {
1330 health_code_update();
1331
1332 /* Exit the thread because the thread quit pipe has been triggered. */
1333 if (should_quit) {
1334 /* Not a health error. */
1335 err = 0;
1336 goto exit;
1337 }
1338
1339 health_poll_entry();
1340 ret = lttng_poll_wait(&events, -1);
1341 health_poll_exit();
1342 if (ret < 0) {
1343 /*
1344 * Restart interrupted system call.
1345 */
1346 if (errno == EINTR) {
1347 goto restart_poll;
1348 }
1349 goto error;
1350 }
1351
1352 nb_fd = ret;
1353
1354 for (i = 0; i < nb_fd; i++) {
1355 /* Fetch once the poll data */
1356 revents = LTTNG_POLL_GETEV(&events, i);
1357 pollfd = LTTNG_POLL_GETFD(&events, i);
1358
1359 health_code_update();
1360
1361 if (!revents) {
1362 /* No activity for this FD (poll implementation). */
1363 continue;
1364 }
1365
1366 /*
1367 * Thread quit pipe has been triggered, flag that we should stop
1368 * but continue the current loop to handle potential data from
1369 * consumer.
1370 */
1371 should_quit = sessiond_check_thread_quit_pipe(pollfd, revents);
1372
1373 if (pollfd == sock) {
1374 /* Event on the consumerd socket */
1375 if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)
1376 && !(revents & LPOLLIN)) {
1377 ERR("consumer err socket second poll error");
1378 goto error;
1379 }
1380 health_code_update();
1381 /* Wait for any kconsumerd error */
1382 ret = lttcomm_recv_unix_sock(sock, &code,
1383 sizeof(enum lttcomm_return_code));
1384 if (ret <= 0) {
1385 ERR("consumer closed the command socket");
1386 goto error;
1387 }
1388
1389 ERR("consumer return code : %s",
1390 lttcomm_get_readable_code(-code));
1391
1392 goto exit;
1393 } else if (pollfd == consumer_data->metadata_fd) {
1394 if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)
1395 && !(revents & LPOLLIN)) {
1396 ERR("consumer err metadata socket second poll error");
1397 goto error;
1398 }
1399 /* UST metadata requests */
1400 ret = ust_consumer_metadata_request(
1401 &consumer_data->metadata_sock);
1402 if (ret < 0) {
1403 ERR("Handling metadata request");
1404 goto error;
1405 }
1406 }
1407 /* No need for an else branch all FDs are tested prior. */
1408 }
1409 health_code_update();
1410 }
1411
1412 exit:
1413 error:
1414 /*
1415 * We lock here because we are about to close the sockets and some other
1416 * thread might be using them so get exclusive access which will abort all
1417 * other consumer command by other threads.
1418 */
1419 pthread_mutex_lock(&consumer_data->lock);
1420
1421 /* Immediately set the consumerd state to stopped */
1422 if (consumer_data->type == LTTNG_CONSUMER_KERNEL) {
1423 uatomic_set(&kernel_consumerd_state, CONSUMER_ERROR);
1424 } else if (consumer_data->type == LTTNG_CONSUMER64_UST ||
1425 consumer_data->type == LTTNG_CONSUMER32_UST) {
1426 uatomic_set(&ust_consumerd_state, CONSUMER_ERROR);
1427 } else {
1428 /* Code flow error... */
1429 assert(0);
1430 }
1431
1432 if (consumer_data->err_sock >= 0) {
1433 ret = close(consumer_data->err_sock);
1434 if (ret) {
1435 PERROR("close");
1436 }
1437 consumer_data->err_sock = -1;
1438 }
1439 if (consumer_data->cmd_sock >= 0) {
1440 ret = close(consumer_data->cmd_sock);
1441 if (ret) {
1442 PERROR("close");
1443 }
1444 consumer_data->cmd_sock = -1;
1445 }
1446 if (consumer_data->metadata_sock.fd_ptr &&
1447 *consumer_data->metadata_sock.fd_ptr >= 0) {
1448 ret = close(*consumer_data->metadata_sock.fd_ptr);
1449 if (ret) {
1450 PERROR("close");
1451 }
1452 }
1453 if (sock >= 0) {
1454 ret = close(sock);
1455 if (ret) {
1456 PERROR("close");
1457 }
1458 }
1459
1460 unlink(consumer_data->err_unix_sock_path);
1461 unlink(consumer_data->cmd_unix_sock_path);
1462 pthread_mutex_unlock(&consumer_data->lock);
1463
1464 /* Cleanup metadata socket mutex. */
1465 if (consumer_data->metadata_sock.lock) {
1466 pthread_mutex_destroy(consumer_data->metadata_sock.lock);
1467 free(consumer_data->metadata_sock.lock);
1468 }
1469 lttng_poll_clean(&events);
1470
1471 if (cmd_socket_wrapper) {
1472 consumer_destroy_socket(cmd_socket_wrapper);
1473 }
1474 error_poll:
1475 if (err) {
1476 health_error();
1477 ERR("Health error occurred in %s", __func__);
1478 }
1479 health_unregister(health_sessiond);
1480 DBG("consumer thread cleanup completed");
1481
1482 rcu_thread_offline();
1483 rcu_unregister_thread();
1484
1485 return NULL;
1486 }
1487
1488 /*
1489 * This thread receives application command sockets (FDs) on the
1490 * apps_cmd_pipe and waits (polls) on them until they are closed
1491 * or an error occurs.
1492 *
1493 * At that point, it flushes the data (tracing and metadata) associated
1494 * with this application and tears down ust app sessions and other
1495 * associated data structures through ust_app_unregister().
1496 *
1497 * Note that this thread never sends commands to the applications
1498 * through the command sockets; it merely listens for hang-ups
1499 * and errors on those sockets and cleans-up as they occur.
1500 */
1501 static void *thread_manage_apps(void *data)
1502 {
1503 int i, ret, pollfd, err = -1;
1504 ssize_t size_ret;
1505 uint32_t revents, nb_fd;
1506 struct lttng_poll_event events;
1507
1508 DBG("[thread] Manage application started");
1509
1510 rcu_register_thread();
1511 rcu_thread_online();
1512
1513 health_register(health_sessiond, HEALTH_SESSIOND_TYPE_APP_MANAGE);
1514
1515 if (testpoint(sessiond_thread_manage_apps)) {
1516 goto error_testpoint;
1517 }
1518
1519 health_code_update();
1520
1521 ret = sessiond_set_thread_pollset(&events, 2);
1522 if (ret < 0) {
1523 goto error_poll_create;
1524 }
1525
1526 ret = lttng_poll_add(&events, apps_cmd_pipe[0], LPOLLIN | LPOLLRDHUP);
1527 if (ret < 0) {
1528 goto error;
1529 }
1530
1531 if (testpoint(sessiond_thread_manage_apps_before_loop)) {
1532 goto error;
1533 }
1534
1535 health_code_update();
1536
1537 while (1) {
1538 DBG("Apps thread polling");
1539
1540 /* Inifinite blocking call, waiting for transmission */
1541 restart:
1542 health_poll_entry();
1543 ret = lttng_poll_wait(&events, -1);
1544 DBG("Apps thread return from poll on %d fds",
1545 LTTNG_POLL_GETNB(&events));
1546 health_poll_exit();
1547 if (ret < 0) {
1548 /*
1549 * Restart interrupted system call.
1550 */
1551 if (errno == EINTR) {
1552 goto restart;
1553 }
1554 goto error;
1555 }
1556
1557 nb_fd = ret;
1558
1559 for (i = 0; i < nb_fd; i++) {
1560 /* Fetch once the poll data */
1561 revents = LTTNG_POLL_GETEV(&events, i);
1562 pollfd = LTTNG_POLL_GETFD(&events, i);
1563
1564 health_code_update();
1565
1566 if (!revents) {
1567 /* No activity for this FD (poll implementation). */
1568 continue;
1569 }
1570
1571 /* Thread quit pipe has been closed. Killing thread. */
1572 ret = sessiond_check_thread_quit_pipe(pollfd, revents);
1573 if (ret) {
1574 err = 0;
1575 goto exit;
1576 }
1577
1578 /* Inspect the apps cmd pipe */
1579 if (pollfd == apps_cmd_pipe[0]) {
1580 if (revents & LPOLLIN) {
1581 int sock;
1582
1583 /* Empty pipe */
1584 size_ret = lttng_read(apps_cmd_pipe[0], &sock, sizeof(sock));
1585 if (size_ret < sizeof(sock)) {
1586 PERROR("read apps cmd pipe");
1587 goto error;
1588 }
1589
1590 health_code_update();
1591
1592 /*
1593 * Since this is a command socket (write then read),
1594 * we only monitor the error events of the socket.
1595 */
1596 ret = lttng_poll_add(&events, sock,
1597 LPOLLERR | LPOLLHUP | LPOLLRDHUP);
1598 if (ret < 0) {
1599 goto error;
1600 }
1601
1602 DBG("Apps with sock %d added to poll set", sock);
1603 } else if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
1604 ERR("Apps command pipe error");
1605 goto error;
1606 } else {
1607 ERR("Unknown poll events %u for sock %d", revents, pollfd);
1608 goto error;
1609 }
1610 } else {
1611 /*
1612 * At this point, we know that a registered application made
1613 * the event at poll_wait.
1614 */
1615 if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
1616 /* Removing from the poll set */
1617 ret = lttng_poll_del(&events, pollfd);
1618 if (ret < 0) {
1619 goto error;
1620 }
1621
1622 /* Socket closed on remote end. */
1623 ust_app_unregister(pollfd);
1624 } else {
1625 ERR("Unexpected poll events %u for sock %d", revents, pollfd);
1626 goto error;
1627 }
1628 }
1629
1630 health_code_update();
1631 }
1632 }
1633
1634 exit:
1635 error:
1636 lttng_poll_clean(&events);
1637 error_poll_create:
1638 error_testpoint:
1639 utils_close_pipe(apps_cmd_pipe);
1640 apps_cmd_pipe[0] = apps_cmd_pipe[1] = -1;
1641
1642 /*
1643 * We don't clean the UST app hash table here since already registered
1644 * applications can still be controlled so let them be until the session
1645 * daemon dies or the applications stop.
1646 */
1647
1648 if (err) {
1649 health_error();
1650 ERR("Health error occurred in %s", __func__);
1651 }
1652 health_unregister(health_sessiond);
1653 DBG("Application communication apps thread cleanup complete");
1654 rcu_thread_offline();
1655 rcu_unregister_thread();
1656 return NULL;
1657 }
1658
1659 /*
1660 * Send a socket to a thread This is called from the dispatch UST registration
1661 * thread once all sockets are set for the application.
1662 *
1663 * The sock value can be invalid, we don't really care, the thread will handle
1664 * it and make the necessary cleanup if so.
1665 *
1666 * On success, return 0 else a negative value being the errno message of the
1667 * write().
1668 */
1669 static int send_socket_to_thread(int fd, int sock)
1670 {
1671 ssize_t ret;
1672
1673 /*
1674 * It's possible that the FD is set as invalid with -1 concurrently just
1675 * before calling this function being a shutdown state of the thread.
1676 */
1677 if (fd < 0) {
1678 ret = -EBADF;
1679 goto error;
1680 }
1681
1682 ret = lttng_write(fd, &sock, sizeof(sock));
1683 if (ret < sizeof(sock)) {
1684 PERROR("write apps pipe %d", fd);
1685 if (ret < 0) {
1686 ret = -errno;
1687 }
1688 goto error;
1689 }
1690
1691 /* All good. Don't send back the write positive ret value. */
1692 ret = 0;
1693 error:
1694 return (int) ret;
1695 }
1696
1697 /*
1698 * Sanitize the wait queue of the dispatch registration thread meaning removing
1699 * invalid nodes from it. This is to avoid memory leaks for the case the UST
1700 * notify socket is never received.
1701 */
1702 static void sanitize_wait_queue(struct ust_reg_wait_queue *wait_queue)
1703 {
1704 int ret, nb_fd = 0, i;
1705 unsigned int fd_added = 0;
1706 struct lttng_poll_event events;
1707 struct ust_reg_wait_node *wait_node = NULL, *tmp_wait_node;
1708
1709 assert(wait_queue);
1710
1711 lttng_poll_init(&events);
1712
1713 /* Just skip everything for an empty queue. */
1714 if (!wait_queue->count) {
1715 goto end;
1716 }
1717
1718 ret = lttng_poll_create(&events, wait_queue->count, LTTNG_CLOEXEC);
1719 if (ret < 0) {
1720 goto error_create;
1721 }
1722
1723 cds_list_for_each_entry_safe(wait_node, tmp_wait_node,
1724 &wait_queue->head, head) {
1725 assert(wait_node->app);
1726 ret = lttng_poll_add(&events, wait_node->app->sock,
1727 LPOLLHUP | LPOLLERR);
1728 if (ret < 0) {
1729 goto error;
1730 }
1731
1732 fd_added = 1;
1733 }
1734
1735 if (!fd_added) {
1736 goto end;
1737 }
1738
1739 /*
1740 * Poll but don't block so we can quickly identify the faulty events and
1741 * clean them afterwards from the wait queue.
1742 */
1743 ret = lttng_poll_wait(&events, 0);
1744 if (ret < 0) {
1745 goto error;
1746 }
1747 nb_fd = ret;
1748
1749 for (i = 0; i < nb_fd; i++) {
1750 /* Get faulty FD. */
1751 uint32_t revents = LTTNG_POLL_GETEV(&events, i);
1752 int pollfd = LTTNG_POLL_GETFD(&events, i);
1753
1754 if (!revents) {
1755 /* No activity for this FD (poll implementation). */
1756 continue;
1757 }
1758
1759 cds_list_for_each_entry_safe(wait_node, tmp_wait_node,
1760 &wait_queue->head, head) {
1761 if (pollfd == wait_node->app->sock &&
1762 (revents & (LPOLLHUP | LPOLLERR))) {
1763 cds_list_del(&wait_node->head);
1764 wait_queue->count--;
1765 ust_app_destroy(wait_node->app);
1766 free(wait_node);
1767 /*
1768 * Silence warning of use-after-free in
1769 * cds_list_for_each_entry_safe which uses
1770 * __typeof__(*wait_node).
1771 */
1772 wait_node = NULL;
1773 break;
1774 } else {
1775 ERR("Unexpected poll events %u for sock %d", revents, pollfd);
1776 goto error;
1777 }
1778 }
1779 }
1780
1781 if (nb_fd > 0) {
1782 DBG("Wait queue sanitized, %d node were cleaned up", nb_fd);
1783 }
1784
1785 end:
1786 lttng_poll_clean(&events);
1787 return;
1788
1789 error:
1790 lttng_poll_clean(&events);
1791 error_create:
1792 ERR("Unable to sanitize wait queue");
1793 return;
1794 }
1795
1796 /*
1797 * Dispatch request from the registration threads to the application
1798 * communication thread.
1799 */
1800 static void *thread_dispatch_ust_registration(void *data)
1801 {
1802 int ret, err = -1;
1803 struct cds_wfcq_node *node;
1804 struct ust_command *ust_cmd = NULL;
1805 struct ust_reg_wait_node *wait_node = NULL, *tmp_wait_node;
1806 struct ust_reg_wait_queue wait_queue = {
1807 .count = 0,
1808 };
1809
1810 rcu_register_thread();
1811
1812 health_register(health_sessiond, HEALTH_SESSIOND_TYPE_APP_REG_DISPATCH);
1813
1814 if (testpoint(sessiond_thread_app_reg_dispatch)) {
1815 goto error_testpoint;
1816 }
1817
1818 health_code_update();
1819
1820 CDS_INIT_LIST_HEAD(&wait_queue.head);
1821
1822 DBG("[thread] Dispatch UST command started");
1823
1824 for (;;) {
1825 health_code_update();
1826
1827 /* Atomically prepare the queue futex */
1828 futex_nto1_prepare(&ust_cmd_queue.futex);
1829
1830 if (CMM_LOAD_SHARED(dispatch_thread_exit)) {
1831 break;
1832 }
1833
1834 do {
1835 struct ust_app *app = NULL;
1836 ust_cmd = NULL;
1837
1838 /*
1839 * Make sure we don't have node(s) that have hung up before receiving
1840 * the notify socket. This is to clean the list in order to avoid
1841 * memory leaks from notify socket that are never seen.
1842 */
1843 sanitize_wait_queue(&wait_queue);
1844
1845 health_code_update();
1846 /* Dequeue command for registration */
1847 node = cds_wfcq_dequeue_blocking(&ust_cmd_queue.head, &ust_cmd_queue.tail);
1848 if (node == NULL) {
1849 DBG("Woken up but nothing in the UST command queue");
1850 /* Continue thread execution */
1851 break;
1852 }
1853
1854 ust_cmd = caa_container_of(node, struct ust_command, node);
1855
1856 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1857 " gid:%d sock:%d name:%s (version %d.%d)",
1858 ust_cmd->reg_msg.pid, ust_cmd->reg_msg.ppid,
1859 ust_cmd->reg_msg.uid, ust_cmd->reg_msg.gid,
1860 ust_cmd->sock, ust_cmd->reg_msg.name,
1861 ust_cmd->reg_msg.major, ust_cmd->reg_msg.minor);
1862
1863 if (ust_cmd->reg_msg.type == USTCTL_SOCKET_CMD) {
1864 wait_node = zmalloc(sizeof(*wait_node));
1865 if (!wait_node) {
1866 PERROR("zmalloc wait_node dispatch");
1867 ret = close(ust_cmd->sock);
1868 if (ret < 0) {
1869 PERROR("close ust sock dispatch %d", ust_cmd->sock);
1870 }
1871 lttng_fd_put(LTTNG_FD_APPS, 1);
1872 free(ust_cmd);
1873 goto error;
1874 }
1875 CDS_INIT_LIST_HEAD(&wait_node->head);
1876
1877 /* Create application object if socket is CMD. */
1878 wait_node->app = ust_app_create(&ust_cmd->reg_msg,
1879 ust_cmd->sock);
1880 if (!wait_node->app) {
1881 ret = close(ust_cmd->sock);
1882 if (ret < 0) {
1883 PERROR("close ust sock dispatch %d", ust_cmd->sock);
1884 }
1885 lttng_fd_put(LTTNG_FD_APPS, 1);
1886 free(wait_node);
1887 free(ust_cmd);
1888 continue;
1889 }
1890 /*
1891 * Add application to the wait queue so we can set the notify
1892 * socket before putting this object in the global ht.
1893 */
1894 cds_list_add(&wait_node->head, &wait_queue.head);
1895 wait_queue.count++;
1896
1897 free(ust_cmd);
1898 /*
1899 * We have to continue here since we don't have the notify
1900 * socket and the application MUST be added to the hash table
1901 * only at that moment.
1902 */
1903 continue;
1904 } else {
1905 /*
1906 * Look for the application in the local wait queue and set the
1907 * notify socket if found.
1908 */
1909 cds_list_for_each_entry_safe(wait_node, tmp_wait_node,
1910 &wait_queue.head, head) {
1911 health_code_update();
1912 if (wait_node->app->pid == ust_cmd->reg_msg.pid) {
1913 wait_node->app->notify_sock = ust_cmd->sock;
1914 cds_list_del(&wait_node->head);
1915 wait_queue.count--;
1916 app = wait_node->app;
1917 free(wait_node);
1918 DBG3("UST app notify socket %d is set", ust_cmd->sock);
1919 break;
1920 }
1921 }
1922
1923 /*
1924 * With no application at this stage the received socket is
1925 * basically useless so close it before we free the cmd data
1926 * structure for good.
1927 */
1928 if (!app) {
1929 ret = close(ust_cmd->sock);
1930 if (ret < 0) {
1931 PERROR("close ust sock dispatch %d", ust_cmd->sock);
1932 }
1933 lttng_fd_put(LTTNG_FD_APPS, 1);
1934 }
1935 free(ust_cmd);
1936 }
1937
1938 if (app) {
1939 /*
1940 * @session_lock_list
1941 *
1942 * Lock the global session list so from the register up to the
1943 * registration done message, no thread can see the application
1944 * and change its state.
1945 */
1946 session_lock_list();
1947 rcu_read_lock();
1948
1949 /*
1950 * Add application to the global hash table. This needs to be
1951 * done before the update to the UST registry can locate the
1952 * application.
1953 */
1954 ust_app_add(app);
1955
1956 /* Set app version. This call will print an error if needed. */
1957 (void) ust_app_version(app);
1958
1959 /* Send notify socket through the notify pipe. */
1960 ret = send_socket_to_thread(apps_cmd_notify_pipe[1],
1961 app->notify_sock);
1962 if (ret < 0) {
1963 rcu_read_unlock();
1964 session_unlock_list();
1965 /*
1966 * No notify thread, stop the UST tracing. However, this is
1967 * not an internal error of the this thread thus setting
1968 * the health error code to a normal exit.
1969 */
1970 err = 0;
1971 goto error;
1972 }
1973
1974 /*
1975 * Update newly registered application with the tracing
1976 * registry info already enabled information.
1977 */
1978 update_ust_app(app->sock);
1979
1980 /*
1981 * Don't care about return value. Let the manage apps threads
1982 * handle app unregistration upon socket close.
1983 */
1984 (void) ust_app_register_done(app);
1985
1986 /*
1987 * Even if the application socket has been closed, send the app
1988 * to the thread and unregistration will take place at that
1989 * place.
1990 */
1991 ret = send_socket_to_thread(apps_cmd_pipe[1], app->sock);
1992 if (ret < 0) {
1993 rcu_read_unlock();
1994 session_unlock_list();
1995 /*
1996 * No apps. thread, stop the UST tracing. However, this is
1997 * not an internal error of the this thread thus setting
1998 * the health error code to a normal exit.
1999 */
2000 err = 0;
2001 goto error;
2002 }
2003
2004 rcu_read_unlock();
2005 session_unlock_list();
2006 }
2007 } while (node != NULL);
2008
2009 health_poll_entry();
2010 /* Futex wait on queue. Blocking call on futex() */
2011 futex_nto1_wait(&ust_cmd_queue.futex);
2012 health_poll_exit();
2013 }
2014 /* Normal exit, no error */
2015 err = 0;
2016
2017 error:
2018 /* Clean up wait queue. */
2019 cds_list_for_each_entry_safe(wait_node, tmp_wait_node,
2020 &wait_queue.head, head) {
2021 cds_list_del(&wait_node->head);
2022 wait_queue.count--;
2023 free(wait_node);
2024 }
2025
2026 /* Empty command queue. */
2027 for (;;) {
2028 /* Dequeue command for registration */
2029 node = cds_wfcq_dequeue_blocking(&ust_cmd_queue.head, &ust_cmd_queue.tail);
2030 if (node == NULL) {
2031 break;
2032 }
2033 ust_cmd = caa_container_of(node, struct ust_command, node);
2034 ret = close(ust_cmd->sock);
2035 if (ret < 0) {
2036 PERROR("close ust sock exit dispatch %d", ust_cmd->sock);
2037 }
2038 lttng_fd_put(LTTNG_FD_APPS, 1);
2039 free(ust_cmd);
2040 }
2041
2042 error_testpoint:
2043 DBG("Dispatch thread dying");
2044 if (err) {
2045 health_error();
2046 ERR("Health error occurred in %s", __func__);
2047 }
2048 health_unregister(health_sessiond);
2049 rcu_unregister_thread();
2050 return NULL;
2051 }
2052
2053 /*
2054 * This thread manage application registration.
2055 */
2056 static void *thread_registration_apps(void *data)
2057 {
2058 int sock = -1, i, ret, pollfd, err = -1;
2059 uint32_t revents, nb_fd;
2060 struct lttng_poll_event events;
2061 /*
2062 * Get allocated in this thread, enqueued to a global queue, dequeued and
2063 * freed in the manage apps thread.
2064 */
2065 struct ust_command *ust_cmd = NULL;
2066
2067 DBG("[thread] Manage application registration started");
2068
2069 health_register(health_sessiond, HEALTH_SESSIOND_TYPE_APP_REG);
2070
2071 if (testpoint(sessiond_thread_registration_apps)) {
2072 goto error_testpoint;
2073 }
2074
2075 ret = lttcomm_listen_unix_sock(apps_sock);
2076 if (ret < 0) {
2077 goto error_listen;
2078 }
2079
2080 /*
2081 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
2082 * more will be added to this poll set.
2083 */
2084 ret = sessiond_set_thread_pollset(&events, 2);
2085 if (ret < 0) {
2086 goto error_create_poll;
2087 }
2088
2089 /* Add the application registration socket */
2090 ret = lttng_poll_add(&events, apps_sock, LPOLLIN | LPOLLRDHUP);
2091 if (ret < 0) {
2092 goto error_poll_add;
2093 }
2094
2095 /* Notify all applications to register */
2096 ret = notify_ust_apps(1);
2097 if (ret < 0) {
2098 ERR("Failed to notify applications or create the wait shared memory.\n"
2099 "Execution continues but there might be problem for already\n"
2100 "running applications that wishes to register.");
2101 }
2102
2103 while (1) {
2104 DBG("Accepting application registration");
2105
2106 /* Inifinite blocking call, waiting for transmission */
2107 restart:
2108 health_poll_entry();
2109 ret = lttng_poll_wait(&events, -1);
2110 health_poll_exit();
2111 if (ret < 0) {
2112 /*
2113 * Restart interrupted system call.
2114 */
2115 if (errno == EINTR) {
2116 goto restart;
2117 }
2118 goto error;
2119 }
2120
2121 nb_fd = ret;
2122
2123 for (i = 0; i < nb_fd; i++) {
2124 health_code_update();
2125
2126 /* Fetch once the poll data */
2127 revents = LTTNG_POLL_GETEV(&events, i);
2128 pollfd = LTTNG_POLL_GETFD(&events, i);
2129
2130 if (!revents) {
2131 /* No activity for this FD (poll implementation). */
2132 continue;
2133 }
2134
2135 /* Thread quit pipe has been closed. Killing thread. */
2136 ret = sessiond_check_thread_quit_pipe(pollfd, revents);
2137 if (ret) {
2138 err = 0;
2139 goto exit;
2140 }
2141
2142 /* Event on the registration socket */
2143 if (pollfd == apps_sock) {
2144 if (revents & LPOLLIN) {
2145 sock = lttcomm_accept_unix_sock(apps_sock);
2146 if (sock < 0) {
2147 goto error;
2148 }
2149
2150 /*
2151 * Set socket timeout for both receiving and ending.
2152 * app_socket_timeout is in seconds, whereas
2153 * lttcomm_setsockopt_rcv_timeout and
2154 * lttcomm_setsockopt_snd_timeout expect msec as
2155 * parameter.
2156 */
2157 if (config.app_socket_timeout >= 0) {
2158 (void) lttcomm_setsockopt_rcv_timeout(sock,
2159 config.app_socket_timeout * 1000);
2160 (void) lttcomm_setsockopt_snd_timeout(sock,
2161 config.app_socket_timeout * 1000);
2162 }
2163
2164 /*
2165 * Set the CLOEXEC flag. Return code is useless because
2166 * either way, the show must go on.
2167 */
2168 (void) utils_set_fd_cloexec(sock);
2169
2170 /* Create UST registration command for enqueuing */
2171 ust_cmd = zmalloc(sizeof(struct ust_command));
2172 if (ust_cmd == NULL) {
2173 PERROR("ust command zmalloc");
2174 ret = close(sock);
2175 if (ret) {
2176 PERROR("close");
2177 }
2178 goto error;
2179 }
2180
2181 /*
2182 * Using message-based transmissions to ensure we don't
2183 * have to deal with partially received messages.
2184 */
2185 ret = lttng_fd_get(LTTNG_FD_APPS, 1);
2186 if (ret < 0) {
2187 ERR("Exhausted file descriptors allowed for applications.");
2188 free(ust_cmd);
2189 ret = close(sock);
2190 if (ret) {
2191 PERROR("close");
2192 }
2193 sock = -1;
2194 continue;
2195 }
2196
2197 health_code_update();
2198 ret = ust_app_recv_registration(sock, &ust_cmd->reg_msg);
2199 if (ret < 0) {
2200 free(ust_cmd);
2201 /* Close socket of the application. */
2202 ret = close(sock);
2203 if (ret) {
2204 PERROR("close");
2205 }
2206 lttng_fd_put(LTTNG_FD_APPS, 1);
2207 sock = -1;
2208 continue;
2209 }
2210 health_code_update();
2211
2212 ust_cmd->sock = sock;
2213 sock = -1;
2214
2215 DBG("UST registration received with pid:%d ppid:%d uid:%d"
2216 " gid:%d sock:%d name:%s (version %d.%d)",
2217 ust_cmd->reg_msg.pid, ust_cmd->reg_msg.ppid,
2218 ust_cmd->reg_msg.uid, ust_cmd->reg_msg.gid,
2219 ust_cmd->sock, ust_cmd->reg_msg.name,
2220 ust_cmd->reg_msg.major, ust_cmd->reg_msg.minor);
2221
2222 /*
2223 * Lock free enqueue the registration request. The red pill
2224 * has been taken! This apps will be part of the *system*.
2225 */
2226 cds_wfcq_enqueue(&ust_cmd_queue.head, &ust_cmd_queue.tail, &ust_cmd->node);
2227
2228 /*
2229 * Wake the registration queue futex. Implicit memory
2230 * barrier with the exchange in cds_wfcq_enqueue.
2231 */
2232 futex_nto1_wake(&ust_cmd_queue.futex);
2233 } else if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
2234 ERR("Register apps socket poll error");
2235 goto error;
2236 } else {
2237 ERR("Unexpected poll events %u for sock %d", revents, pollfd);
2238 goto error;
2239 }
2240 }
2241 }
2242 }
2243
2244 exit:
2245 error:
2246 /* Notify that the registration thread is gone */
2247 notify_ust_apps(0);
2248
2249 if (apps_sock >= 0) {
2250 ret = close(apps_sock);
2251 if (ret) {
2252 PERROR("close");
2253 }
2254 }
2255 if (sock >= 0) {
2256 ret = close(sock);
2257 if (ret) {
2258 PERROR("close");
2259 }
2260 lttng_fd_put(LTTNG_FD_APPS, 1);
2261 }
2262 unlink(config.apps_unix_sock_path.value);
2263
2264 error_poll_add:
2265 lttng_poll_clean(&events);
2266 error_listen:
2267 error_create_poll:
2268 error_testpoint:
2269 DBG("UST Registration thread cleanup complete");
2270 if (err) {
2271 health_error();
2272 ERR("Health error occurred in %s", __func__);
2273 }
2274 health_unregister(health_sessiond);
2275
2276 return NULL;
2277 }
2278
2279 /*
2280 * Start the thread_manage_consumer. This must be done after a lttng-consumerd
2281 * exec or it will fails.
2282 */
2283 static int spawn_consumer_thread(struct consumer_data *consumer_data)
2284 {
2285 int ret, clock_ret;
2286 struct timespec timeout;
2287
2288 /*
2289 * Make sure we set the readiness flag to 0 because we are NOT ready.
2290 * This access to consumer_thread_is_ready does not need to be
2291 * protected by consumer_data.cond_mutex (yet) since the consumer
2292 * management thread has not been started at this point.
2293 */
2294 consumer_data->consumer_thread_is_ready = 0;
2295
2296 /* Setup pthread condition */
2297 ret = pthread_condattr_init(&consumer_data->condattr);
2298 if (ret) {
2299 errno = ret;
2300 PERROR("pthread_condattr_init consumer data");
2301 goto error;
2302 }
2303
2304 /*
2305 * Set the monotonic clock in order to make sure we DO NOT jump in time
2306 * between the clock_gettime() call and the timedwait call. See bug #324
2307 * for a more details and how we noticed it.
2308 */
2309 ret = pthread_condattr_setclock(&consumer_data->condattr, CLOCK_MONOTONIC);
2310 if (ret) {
2311 errno = ret;
2312 PERROR("pthread_condattr_setclock consumer data");
2313 goto error;
2314 }
2315
2316 ret = pthread_cond_init(&consumer_data->cond, &consumer_data->condattr);
2317 if (ret) {
2318 errno = ret;
2319 PERROR("pthread_cond_init consumer data");
2320 goto error;
2321 }
2322
2323 ret = pthread_create(&consumer_data->thread, default_pthread_attr(),
2324 thread_manage_consumer, consumer_data);
2325 if (ret) {
2326 errno = ret;
2327 PERROR("pthread_create consumer");
2328 ret = -1;
2329 goto error;
2330 }
2331
2332 /* We are about to wait on a pthread condition */
2333 pthread_mutex_lock(&consumer_data->cond_mutex);
2334
2335 /* Get time for sem_timedwait absolute timeout */
2336 clock_ret = lttng_clock_gettime(CLOCK_MONOTONIC, &timeout);
2337 /*
2338 * Set the timeout for the condition timed wait even if the clock gettime
2339 * call fails since we might loop on that call and we want to avoid to
2340 * increment the timeout too many times.
2341 */
2342 timeout.tv_sec += DEFAULT_SEM_WAIT_TIMEOUT;
2343
2344 /*
2345 * The following loop COULD be skipped in some conditions so this is why we
2346 * set ret to 0 in order to make sure at least one round of the loop is
2347 * done.
2348 */
2349 ret = 0;
2350
2351 /*
2352 * Loop until the condition is reached or when a timeout is reached. Note
2353 * that the pthread_cond_timedwait(P) man page specifies that EINTR can NOT
2354 * be returned but the pthread_cond(3), from the glibc-doc, says that it is
2355 * possible. This loop does not take any chances and works with both of
2356 * them.
2357 */
2358 while (!consumer_data->consumer_thread_is_ready && ret != ETIMEDOUT) {
2359 if (clock_ret < 0) {
2360 PERROR("clock_gettime spawn consumer");
2361 /* Infinite wait for the consumerd thread to be ready */
2362 ret = pthread_cond_wait(&consumer_data->cond,
2363 &consumer_data->cond_mutex);
2364 } else {
2365 ret = pthread_cond_timedwait(&consumer_data->cond,
2366 &consumer_data->cond_mutex, &timeout);
2367 }
2368 }
2369
2370 /* Release the pthread condition */
2371 pthread_mutex_unlock(&consumer_data->cond_mutex);
2372
2373 if (ret != 0) {
2374 errno = ret;
2375 if (ret == ETIMEDOUT) {
2376 int pth_ret;
2377
2378 /*
2379 * Call has timed out so we kill the kconsumerd_thread and return
2380 * an error.
2381 */
2382 ERR("Condition timed out. The consumer thread was never ready."
2383 " Killing it");
2384 pth_ret = pthread_cancel(consumer_data->thread);
2385 if (pth_ret < 0) {
2386 PERROR("pthread_cancel consumer thread");
2387 }
2388 } else {
2389 PERROR("pthread_cond_wait failed consumer thread");
2390 }
2391 /* Caller is expecting a negative value on failure. */
2392 ret = -1;
2393 goto error;
2394 }
2395
2396 pthread_mutex_lock(&consumer_data->pid_mutex);
2397 if (consumer_data->pid == 0) {
2398 ERR("Consumerd did not start");
2399 pthread_mutex_unlock(&consumer_data->pid_mutex);
2400 goto error;
2401 }
2402 pthread_mutex_unlock(&consumer_data->pid_mutex);
2403
2404 return 0;
2405
2406 error:
2407 return ret;
2408 }
2409
2410 /*
2411 * Join consumer thread
2412 */
2413 static int join_consumer_thread(struct consumer_data *consumer_data)
2414 {
2415 void *status;
2416
2417 /* Consumer pid must be a real one. */
2418 if (consumer_data->pid > 0) {
2419 int ret;
2420 ret = kill(consumer_data->pid, SIGTERM);
2421 if (ret) {
2422 PERROR("Error killing consumer daemon");
2423 return ret;
2424 }
2425 return pthread_join(consumer_data->thread, &status);
2426 } else {
2427 return 0;
2428 }
2429 }
2430
2431 /*
2432 * Fork and exec a consumer daemon (consumerd).
2433 *
2434 * Return pid if successful else -1.
2435 */
2436 static pid_t spawn_consumerd(struct consumer_data *consumer_data)
2437 {
2438 int ret;
2439 pid_t pid;
2440 const char *consumer_to_use;
2441 const char *verbosity;
2442 struct stat st;
2443
2444 DBG("Spawning consumerd");
2445
2446 pid = fork();
2447 if (pid == 0) {
2448 /*
2449 * Exec consumerd.
2450 */
2451 if (config.verbose_consumer) {
2452 verbosity = "--verbose";
2453 } else if (lttng_opt_quiet) {
2454 verbosity = "--quiet";
2455 } else {
2456 verbosity = "";
2457 }
2458
2459 switch (consumer_data->type) {
2460 case LTTNG_CONSUMER_KERNEL:
2461 /*
2462 * Find out which consumerd to execute. We will first try the
2463 * 64-bit path, then the sessiond's installation directory, and
2464 * fallback on the 32-bit one,
2465 */
2466 DBG3("Looking for a kernel consumer at these locations:");
2467 DBG3(" 1) %s", config.consumerd64_bin_path.value ? : "NULL");
2468 DBG3(" 2) %s/%s", INSTALL_BIN_PATH, DEFAULT_CONSUMERD_FILE);
2469 DBG3(" 3) %s", config.consumerd32_bin_path.value ? : "NULL");
2470 if (stat(config.consumerd64_bin_path.value, &st) == 0) {
2471 DBG3("Found location #1");
2472 consumer_to_use = config.consumerd64_bin_path.value;
2473 } else if (stat(INSTALL_BIN_PATH "/" DEFAULT_CONSUMERD_FILE, &st) == 0) {
2474 DBG3("Found location #2");
2475 consumer_to_use = INSTALL_BIN_PATH "/" DEFAULT_CONSUMERD_FILE;
2476 } else if (stat(config.consumerd32_bin_path.value, &st) == 0) {
2477 DBG3("Found location #3");
2478 consumer_to_use = config.consumerd32_bin_path.value;
2479 } else {
2480 DBG("Could not find any valid consumerd executable");
2481 ret = -EINVAL;
2482 goto error;
2483 }
2484 DBG("Using kernel consumer at: %s", consumer_to_use);
2485 (void) execl(consumer_to_use,
2486 "lttng-consumerd", verbosity, "-k",
2487 "--consumerd-cmd-sock", consumer_data->cmd_unix_sock_path,
2488 "--consumerd-err-sock", consumer_data->err_unix_sock_path,
2489 "--group", config.tracing_group_name.value,
2490 NULL);
2491 break;
2492 case LTTNG_CONSUMER64_UST:
2493 {
2494 if (config.consumerd64_lib_dir.value) {
2495 char *tmp;
2496 size_t tmplen;
2497 char *tmpnew;
2498
2499 tmp = lttng_secure_getenv("LD_LIBRARY_PATH");
2500 if (!tmp) {
2501 tmp = "";
2502 }
2503 tmplen = strlen(config.consumerd64_lib_dir.value) + 1 /* : */ + strlen(tmp);
2504 tmpnew = zmalloc(tmplen + 1 /* \0 */);
2505 if (!tmpnew) {
2506 ret = -ENOMEM;
2507 goto error;
2508 }
2509 strcat(tmpnew, config.consumerd64_lib_dir.value);
2510 if (tmp[0] != '\0') {
2511 strcat(tmpnew, ":");
2512 strcat(tmpnew, tmp);
2513 }
2514 ret = setenv("LD_LIBRARY_PATH", tmpnew, 1);
2515 free(tmpnew);
2516 if (ret) {
2517 ret = -errno;
2518 goto error;
2519 }
2520 }
2521 DBG("Using 64-bit UST consumer at: %s", config.consumerd64_bin_path.value);
2522 (void) execl(config.consumerd64_bin_path.value, "lttng-consumerd", verbosity, "-u",
2523 "--consumerd-cmd-sock", consumer_data->cmd_unix_sock_path,
2524 "--consumerd-err-sock", consumer_data->err_unix_sock_path,
2525 "--group", config.tracing_group_name.value,
2526 NULL);
2527 break;
2528 }
2529 case LTTNG_CONSUMER32_UST:
2530 {
2531 if (config.consumerd32_lib_dir.value) {
2532 char *tmp;
2533 size_t tmplen;
2534 char *tmpnew;
2535
2536 tmp = lttng_secure_getenv("LD_LIBRARY_PATH");
2537 if (!tmp) {
2538 tmp = "";
2539 }
2540 tmplen = strlen(config.consumerd32_lib_dir.value) + 1 /* : */ + strlen(tmp);
2541 tmpnew = zmalloc(tmplen + 1 /* \0 */);
2542 if (!tmpnew) {
2543 ret = -ENOMEM;
2544 goto error;
2545 }
2546 strcat(tmpnew, config.consumerd32_lib_dir.value);
2547 if (tmp[0] != '\0') {
2548 strcat(tmpnew, ":");
2549 strcat(tmpnew, tmp);
2550 }
2551 ret = setenv("LD_LIBRARY_PATH", tmpnew, 1);
2552 free(tmpnew);
2553 if (ret) {
2554 ret = -errno;
2555 goto error;
2556 }
2557 }
2558 DBG("Using 32-bit UST consumer at: %s", config.consumerd32_bin_path.value);
2559 (void) execl(config.consumerd32_bin_path.value, "lttng-consumerd", verbosity, "-u",
2560 "--consumerd-cmd-sock", consumer_data->cmd_unix_sock_path,
2561 "--consumerd-err-sock", consumer_data->err_unix_sock_path,
2562 "--group", config.tracing_group_name.value,
2563 NULL);
2564 break;
2565 }
2566 default:
2567 ERR("unknown consumer type");
2568 errno = 0;
2569 }
2570 if (errno != 0) {
2571 PERROR("Consumer execl()");
2572 }
2573 /* Reaching this point, we got a failure on our execl(). */
2574 exit(EXIT_FAILURE);
2575 } else if (pid > 0) {
2576 ret = pid;
2577 } else {
2578 PERROR("start consumer fork");
2579 ret = -errno;
2580 }
2581 error:
2582 return ret;
2583 }
2584
2585 /*
2586 * Spawn the consumerd daemon and session daemon thread.
2587 */
2588 static int start_consumerd(struct consumer_data *consumer_data)
2589 {
2590 int ret;
2591
2592 /*
2593 * Set the listen() state on the socket since there is a possible race
2594 * between the exec() of the consumer daemon and this call if place in the
2595 * consumer thread. See bug #366 for more details.
2596 */
2597 ret = lttcomm_listen_unix_sock(consumer_data->err_sock);
2598 if (ret < 0) {
2599 goto error;
2600 }
2601
2602 pthread_mutex_lock(&consumer_data->pid_mutex);
2603 if (consumer_data->pid != 0) {
2604 pthread_mutex_unlock(&consumer_data->pid_mutex);
2605 goto end;
2606 }
2607
2608 ret = spawn_consumerd(consumer_data);
2609 if (ret < 0) {
2610 ERR("Spawning consumerd failed");
2611 pthread_mutex_unlock(&consumer_data->pid_mutex);
2612 goto error;
2613 }
2614
2615 /* Setting up the consumer_data pid */
2616 consumer_data->pid = ret;
2617 DBG2("Consumer pid %d", consumer_data->pid);
2618 pthread_mutex_unlock(&consumer_data->pid_mutex);
2619
2620 DBG2("Spawning consumer control thread");
2621 ret = spawn_consumer_thread(consumer_data);
2622 if (ret < 0) {
2623 ERR("Fatal error spawning consumer control thread");
2624 goto error;
2625 }
2626
2627 end:
2628 return 0;
2629
2630 error:
2631 /* Cleanup already created sockets on error. */
2632 if (consumer_data->err_sock >= 0) {
2633 int err;
2634
2635 err = close(consumer_data->err_sock);
2636 if (err < 0) {
2637 PERROR("close consumer data error socket");
2638 }
2639 }
2640 return ret;
2641 }
2642
2643 /*
2644 * Setup necessary data for kernel tracer action.
2645 */
2646 static int init_kernel_tracer(void)
2647 {
2648 int ret;
2649
2650 /* Modprobe lttng kernel modules */
2651 ret = modprobe_lttng_control();
2652 if (ret < 0) {
2653 goto error;
2654 }
2655
2656 /* Open debugfs lttng */
2657 kernel_tracer_fd = open(module_proc_lttng, O_RDWR);
2658 if (kernel_tracer_fd < 0) {
2659 DBG("Failed to open %s", module_proc_lttng);
2660 goto error_open;
2661 }
2662
2663 /* Validate kernel version */
2664 ret = kernel_validate_version(kernel_tracer_fd, &kernel_tracer_version,
2665 &kernel_tracer_abi_version);
2666 if (ret < 0) {
2667 goto error_version;
2668 }
2669
2670 ret = modprobe_lttng_data();
2671 if (ret < 0) {
2672 goto error_modules;
2673 }
2674
2675 ret = kernel_supports_ring_buffer_snapshot_sample_positions(
2676 kernel_tracer_fd);
2677 if (ret < 0) {
2678 goto error_modules;
2679 }
2680
2681 if (ret < 1) {
2682 WARN("Kernel tracer does not support buffer monitoring. "
2683 "The monitoring timer of channels in the kernel domain "
2684 "will be set to 0 (disabled).");
2685 }
2686
2687 DBG("Kernel tracer fd %d", kernel_tracer_fd);
2688 return 0;
2689
2690 error_version:
2691 modprobe_remove_lttng_control();
2692 ret = close(kernel_tracer_fd);
2693 if (ret) {
2694 PERROR("close");
2695 }
2696 kernel_tracer_fd = -1;
2697 return LTTNG_ERR_KERN_VERSION;
2698
2699 error_modules:
2700 ret = close(kernel_tracer_fd);
2701 if (ret) {
2702 PERROR("close");
2703 }
2704
2705 error_open:
2706 modprobe_remove_lttng_control();
2707
2708 error:
2709 WARN("No kernel tracer available");
2710 kernel_tracer_fd = -1;
2711 if (!is_root) {
2712 return LTTNG_ERR_NEED_ROOT_SESSIOND;
2713 } else {
2714 return LTTNG_ERR_KERN_NA;
2715 }
2716 }
2717
2718
2719 /*
2720 * Copy consumer output from the tracing session to the domain session. The
2721 * function also applies the right modification on a per domain basis for the
2722 * trace files destination directory.
2723 *
2724 * Should *NOT* be called with RCU read-side lock held.
2725 */
2726 static int copy_session_consumer(int domain, struct ltt_session *session)
2727 {
2728 int ret;
2729 const char *dir_name;
2730 struct consumer_output *consumer;
2731
2732 assert(session);
2733 assert(session->consumer);
2734
2735 switch (domain) {
2736 case LTTNG_DOMAIN_KERNEL:
2737 DBG3("Copying tracing session consumer output in kernel session");
2738 /*
2739 * XXX: We should audit the session creation and what this function
2740 * does "extra" in order to avoid a destroy since this function is used
2741 * in the domain session creation (kernel and ust) only. Same for UST
2742 * domain.
2743 */
2744 if (session->kernel_session->consumer) {
2745 consumer_output_put(session->kernel_session->consumer);
2746 }
2747 session->kernel_session->consumer =
2748 consumer_copy_output(session->consumer);
2749 /* Ease our life a bit for the next part */
2750 consumer = session->kernel_session->consumer;
2751 dir_name = DEFAULT_KERNEL_TRACE_DIR;
2752 break;
2753 case LTTNG_DOMAIN_JUL:
2754 case LTTNG_DOMAIN_LOG4J:
2755 case LTTNG_DOMAIN_PYTHON:
2756 case LTTNG_DOMAIN_UST:
2757 DBG3("Copying tracing session consumer output in UST session");
2758 if (session->ust_session->consumer) {
2759 consumer_output_put(session->ust_session->consumer);
2760 }
2761 session->ust_session->consumer =
2762 consumer_copy_output(session->consumer);
2763 /* Ease our life a bit for the next part */
2764 consumer = session->ust_session->consumer;
2765 dir_name = DEFAULT_UST_TRACE_DIR;
2766 break;
2767 default:
2768 ret = LTTNG_ERR_UNKNOWN_DOMAIN;
2769 goto error;
2770 }
2771
2772 /* Append correct directory to subdir */
2773 strncat(consumer->subdir, dir_name,
2774 sizeof(consumer->subdir) - strlen(consumer->subdir) - 1);
2775 DBG3("Copy session consumer subdir %s", consumer->subdir);
2776
2777 ret = LTTNG_OK;
2778
2779 error:
2780 return ret;
2781 }
2782
2783 /*
2784 * Create an UST session and add it to the session ust list.
2785 *
2786 * Should *NOT* be called with RCU read-side lock held.
2787 */
2788 static int create_ust_session(struct ltt_session *session,
2789 struct lttng_domain *domain)
2790 {
2791 int ret;
2792 struct ltt_ust_session *lus = NULL;
2793
2794 assert(session);
2795 assert(domain);
2796 assert(session->consumer);
2797
2798 switch (domain->type) {
2799 case LTTNG_DOMAIN_JUL:
2800 case LTTNG_DOMAIN_LOG4J:
2801 case LTTNG_DOMAIN_PYTHON:
2802 case LTTNG_DOMAIN_UST:
2803 break;
2804 default:
2805 ERR("Unknown UST domain on create session %d", domain->type);
2806 ret = LTTNG_ERR_UNKNOWN_DOMAIN;
2807 goto error;
2808 }
2809
2810 DBG("Creating UST session");
2811
2812 lus = trace_ust_create_session(session->id);
2813 if (lus == NULL) {
2814 ret = LTTNG_ERR_UST_SESS_FAIL;
2815 goto error;
2816 }
2817
2818 lus->uid = session->uid;
2819 lus->gid = session->gid;
2820 lus->output_traces = session->output_traces;
2821 lus->snapshot_mode = session->snapshot_mode;
2822 lus->live_timer_interval = session->live_timer;
2823 session->ust_session = lus;
2824 if (session->shm_path[0]) {
2825 strncpy(lus->root_shm_path, session->shm_path,
2826 sizeof(lus->root_shm_path));
2827 lus->root_shm_path[sizeof(lus->root_shm_path) - 1] = '\0';
2828 strncpy(lus->shm_path, session->shm_path,
2829 sizeof(lus->shm_path));
2830 lus->shm_path[sizeof(lus->shm_path) - 1] = '\0';
2831 strncat(lus->shm_path, "/ust",
2832 sizeof(lus->shm_path) - strlen(lus->shm_path) - 1);
2833 }
2834 /* Copy session output to the newly created UST session */
2835 ret = copy_session_consumer(domain->type, session);
2836 if (ret != LTTNG_OK) {
2837 goto error;
2838 }
2839
2840 return LTTNG_OK;
2841
2842 error:
2843 free(lus);
2844 session->ust_session = NULL;
2845 return ret;
2846 }
2847
2848 /*
2849 * Create a kernel tracer session then create the default channel.
2850 */
2851 static int create_kernel_session(struct ltt_session *session)
2852 {
2853 int ret;
2854
2855 DBG("Creating kernel session");
2856
2857 ret = kernel_create_session(session, kernel_tracer_fd);
2858 if (ret < 0) {
2859 ret = LTTNG_ERR_KERN_SESS_FAIL;
2860 goto error;
2861 }
2862
2863 /* Code flow safety */
2864 assert(session->kernel_session);
2865
2866 /* Copy session output to the newly created Kernel session */
2867 ret = copy_session_consumer(LTTNG_DOMAIN_KERNEL, session);
2868 if (ret != LTTNG_OK) {
2869 goto error;
2870 }
2871
2872 session->kernel_session->uid = session->uid;
2873 session->kernel_session->gid = session->gid;
2874 session->kernel_session->output_traces = session->output_traces;
2875 session->kernel_session->snapshot_mode = session->snapshot_mode;
2876
2877 return LTTNG_OK;
2878
2879 error:
2880 trace_kernel_destroy_session(session->kernel_session);
2881 session->kernel_session = NULL;
2882 return ret;
2883 }
2884
2885 /*
2886 * Count number of session permitted by uid/gid.
2887 */
2888 static unsigned int lttng_sessions_count(uid_t uid, gid_t gid)
2889 {
2890 unsigned int i = 0;
2891 struct ltt_session *session;
2892
2893 DBG("Counting number of available session for UID %d GID %d",
2894 uid, gid);
2895 cds_list_for_each_entry(session, &session_list_ptr->head, list) {
2896 /*
2897 * Only list the sessions the user can control.
2898 */
2899 if (!session_access_ok(session, uid, gid)) {
2900 continue;
2901 }
2902 i++;
2903 }
2904 return i;
2905 }
2906
2907 /*
2908 * Check if the current kernel tracer supports the session rotation feature.
2909 * Return 1 if it does, 0 otherwise.
2910 */
2911 static int check_rotate_compatible(void)
2912 {
2913 int ret = 1;
2914
2915 if (kernel_tracer_version.major != 2 || kernel_tracer_version.minor < 11) {
2916 DBG("Kernel tracer version is not compatible with the rotation feature");
2917 ret = 0;
2918 }
2919
2920 return ret;
2921 }
2922
2923 /*
2924 * Process the command requested by the lttng client within the command
2925 * context structure. This function make sure that the return structure (llm)
2926 * is set and ready for transmission before returning.
2927 *
2928 * Return any error encountered or 0 for success.
2929 *
2930 * "sock" is only used for special-case var. len data.
2931 *
2932 * Should *NOT* be called with RCU read-side lock held.
2933 */
2934 static int process_client_msg(struct command_ctx *cmd_ctx, int sock,
2935 int *sock_error)
2936 {
2937 int ret = LTTNG_OK;
2938 int need_tracing_session = 1;
2939 int need_domain;
2940
2941 DBG("Processing client command %d", cmd_ctx->lsm->cmd_type);
2942
2943 assert(!rcu_read_ongoing());
2944
2945 *sock_error = 0;
2946
2947 switch (cmd_ctx->lsm->cmd_type) {
2948 case LTTNG_CREATE_SESSION:
2949 case LTTNG_CREATE_SESSION_SNAPSHOT:
2950 case LTTNG_CREATE_SESSION_LIVE:
2951 case LTTNG_DESTROY_SESSION:
2952 case LTTNG_LIST_SESSIONS:
2953 case LTTNG_LIST_DOMAINS:
2954 case LTTNG_START_TRACE:
2955 case LTTNG_STOP_TRACE:
2956 case LTTNG_DATA_PENDING:
2957 case LTTNG_SNAPSHOT_ADD_OUTPUT:
2958 case LTTNG_SNAPSHOT_DEL_OUTPUT:
2959 case LTTNG_SNAPSHOT_LIST_OUTPUT:
2960 case LTTNG_SNAPSHOT_RECORD:
2961 case LTTNG_SAVE_SESSION:
2962 case LTTNG_SET_SESSION_SHM_PATH:
2963 case LTTNG_REGENERATE_METADATA:
2964 case LTTNG_REGENERATE_STATEDUMP:
2965 case LTTNG_REGISTER_TRIGGER:
2966 case LTTNG_UNREGISTER_TRIGGER:
2967 case LTTNG_ROTATE_SESSION:
2968 case LTTNG_ROTATION_GET_INFO:
2969 case LTTNG_SESSION_GET_CURRENT_OUTPUT:
2970 case LTTNG_ROTATION_SET_SCHEDULE:
2971 case LTTNG_ROTATION_SCHEDULE_GET_TIMER_PERIOD:
2972 case LTTNG_ROTATION_SCHEDULE_GET_SIZE:
2973 need_domain = 0;
2974 break;
2975 default:
2976 need_domain = 1;
2977 }
2978
2979 if (config.no_kernel && need_domain
2980 && cmd_ctx->lsm->domain.type == LTTNG_DOMAIN_KERNEL) {
2981 if (!is_root) {
2982 ret = LTTNG_ERR_NEED_ROOT_SESSIOND;
2983 } else {
2984 ret = LTTNG_ERR_KERN_NA;
2985 }
2986 goto error;
2987 }
2988
2989 /* Deny register consumer if we already have a spawned consumer. */
2990 if (cmd_ctx->lsm->cmd_type == LTTNG_REGISTER_CONSUMER) {
2991 pthread_mutex_lock(&kconsumer_data.pid_mutex);
2992 if (kconsumer_data.pid > 0) {
2993 ret = LTTNG_ERR_KERN_CONSUMER_FAIL;
2994 pthread_mutex_unlock(&kconsumer_data.pid_mutex);
2995 goto error;
2996 }
2997 pthread_mutex_unlock(&kconsumer_data.pid_mutex);
2998 }
2999
3000 /*
3001 * Check for command that don't needs to allocate a returned payload. We do
3002 * this here so we don't have to make the call for no payload at each
3003 * command.
3004 */
3005 switch(cmd_ctx->lsm->cmd_type) {
3006 case LTTNG_LIST_SESSIONS:
3007 case LTTNG_LIST_TRACEPOINTS:
3008 case LTTNG_LIST_TRACEPOINT_FIELDS:
3009 case LTTNG_LIST_DOMAINS:
3010 case LTTNG_LIST_CHANNELS:
3011 case LTTNG_LIST_EVENTS:
3012 case LTTNG_LIST_SYSCALLS:
3013 case LTTNG_LIST_TRACKER_PIDS:
3014 case LTTNG_DATA_PENDING:
3015 case LTTNG_ROTATE_SESSION:
3016 case LTTNG_ROTATION_GET_INFO:
3017 case LTTNG_ROTATION_SCHEDULE_GET_TIMER_PERIOD:
3018 case LTTNG_ROTATION_SCHEDULE_GET_SIZE:
3019 break;
3020 default:
3021 /* Setup lttng message with no payload */
3022 ret = setup_lttng_msg_no_cmd_header(cmd_ctx, NULL, 0);
3023 if (ret < 0) {
3024 /* This label does not try to unlock the session */
3025 goto init_setup_error;
3026 }
3027 }
3028
3029 /* Commands that DO NOT need a session. */
3030 switch (cmd_ctx->lsm->cmd_type) {
3031 case LTTNG_CREATE_SESSION:
3032 case LTTNG_CREATE_SESSION_SNAPSHOT:
3033 case LTTNG_CREATE_SESSION_LIVE:
3034 case LTTNG_LIST_SESSIONS:
3035 case LTTNG_LIST_TRACEPOINTS:
3036 case LTTNG_LIST_SYSCALLS:
3037 case LTTNG_LIST_TRACEPOINT_FIELDS:
3038 case LTTNG_SAVE_SESSION:
3039 case LTTNG_REGISTER_TRIGGER:
3040 case LTTNG_UNREGISTER_TRIGGER:
3041 need_tracing_session = 0;
3042 break;
3043 default:
3044 DBG("Getting session %s by name", cmd_ctx->lsm->session.name);
3045 /*
3046 * We keep the session list lock across _all_ commands
3047 * for now, because the per-session lock does not
3048 * handle teardown properly.
3049 */
3050 session_lock_list();
3051 cmd_ctx->session = session_find_by_name(cmd_ctx->lsm->session.name);
3052 if (cmd_ctx->session == NULL) {
3053 ret = LTTNG_ERR_SESS_NOT_FOUND;
3054 goto error;
3055 } else {
3056 /* Acquire lock for the session */
3057 session_lock(cmd_ctx->session);
3058 }
3059 break;
3060 }
3061
3062 /*
3063 * Commands that need a valid session but should NOT create one if none
3064 * exists. Instead of creating one and destroying it when the command is
3065 * handled, process that right before so we save some round trip in useless
3066 * code path.
3067 */
3068 switch (cmd_ctx->lsm->cmd_type) {
3069 case LTTNG_DISABLE_CHANNEL:
3070 case LTTNG_DISABLE_EVENT:
3071 switch (cmd_ctx->lsm->domain.type) {
3072 case LTTNG_DOMAIN_KERNEL:
3073 if (!cmd_ctx->session->kernel_session) {
3074 ret = LTTNG_ERR_NO_CHANNEL;
3075 goto error;
3076 }
3077 break;
3078 case LTTNG_DOMAIN_JUL:
3079 case LTTNG_DOMAIN_LOG4J:
3080 case LTTNG_DOMAIN_PYTHON:
3081 case LTTNG_DOMAIN_UST:
3082 if (!cmd_ctx->session->ust_session) {
3083 ret = LTTNG_ERR_NO_CHANNEL;
3084 goto error;
3085 }
3086 break;
3087 default:
3088 ret = LTTNG_ERR_UNKNOWN_DOMAIN;
3089 goto error;
3090 }
3091 default:
3092 break;
3093 }
3094
3095 if (!need_domain) {
3096 goto skip_domain;
3097 }
3098
3099 /*
3100 * Check domain type for specific "pre-action".
3101 */
3102 switch (cmd_ctx->lsm->domain.type) {
3103 case LTTNG_DOMAIN_KERNEL:
3104 if (!is_root) {
3105 ret = LTTNG_ERR_NEED_ROOT_SESSIOND;
3106 goto error;
3107 }
3108
3109 /* Kernel tracer check */
3110 if (kernel_tracer_fd == -1) {
3111 /* Basically, load kernel tracer modules */
3112 ret = init_kernel_tracer();
3113 if (ret != 0) {
3114 goto error;
3115 }
3116 }
3117
3118 /* Consumer is in an ERROR state. Report back to client */
3119 if (uatomic_read(&kernel_consumerd_state) == CONSUMER_ERROR) {
3120 ret = LTTNG_ERR_NO_KERNCONSUMERD;
3121 goto error;
3122 }
3123
3124 /* Need a session for kernel command */
3125 if (need_tracing_session) {
3126 if (cmd_ctx->session->kernel_session == NULL) {
3127 ret = create_kernel_session(cmd_ctx->session);
3128 if (ret < 0) {
3129 ret = LTTNG_ERR_KERN_SESS_FAIL;
3130 goto error;
3131 }
3132 }
3133
3134 /* Start the kernel consumer daemon */
3135 pthread_mutex_lock(&kconsumer_data.pid_mutex);
3136 if (kconsumer_data.pid == 0 &&
3137 cmd_ctx->lsm->cmd_type != LTTNG_REGISTER_CONSUMER) {
3138 pthread_mutex_unlock(&kconsumer_data.pid_mutex);
3139 ret = start_consumerd(&kconsumer_data);
3140 if (ret < 0) {
3141 ret = LTTNG_ERR_KERN_CONSUMER_FAIL;
3142 goto error;
3143 }
3144 uatomic_set(&kernel_consumerd_state, CONSUMER_STARTED);
3145 } else {
3146 pthread_mutex_unlock(&kconsumer_data.pid_mutex);
3147 }
3148
3149 /*
3150 * The consumer was just spawned so we need to add the socket to
3151 * the consumer output of the session if exist.
3152 */
3153 ret = consumer_create_socket(&kconsumer_data,
3154 cmd_ctx->session->kernel_session->consumer);
3155 if (ret < 0) {
3156 goto error;
3157 }
3158 }
3159
3160 break;
3161 case LTTNG_DOMAIN_JUL:
3162 case LTTNG_DOMAIN_LOG4J:
3163 case LTTNG_DOMAIN_PYTHON:
3164 case LTTNG_DOMAIN_UST:
3165 {
3166 if (!ust_app_supported()) {
3167 ret = LTTNG_ERR_NO_UST;
3168 goto error;
3169 }
3170 /* Consumer is in an ERROR state. Report back to client */
3171 if (uatomic_read(&ust_consumerd_state) == CONSUMER_ERROR) {
3172 ret = LTTNG_ERR_NO_USTCONSUMERD;
3173 goto error;
3174 }
3175
3176 if (need_tracing_session) {
3177 /* Create UST session if none exist. */
3178 if (cmd_ctx->session->ust_session == NULL) {
3179 ret = create_ust_session(cmd_ctx->session,
3180 &cmd_ctx->lsm->domain);
3181 if (ret != LTTNG_OK) {
3182 goto error;
3183 }
3184 }
3185
3186 /* Start the UST consumer daemons */
3187 /* 64-bit */
3188 pthread_mutex_lock(&ustconsumer64_data.pid_mutex);
3189 if (config.consumerd64_bin_path.value &&
3190 ustconsumer64_data.pid == 0 &&
3191 cmd_ctx->lsm->cmd_type != LTTNG_REGISTER_CONSUMER) {
3192 pthread_mutex_unlock(&ustconsumer64_data.pid_mutex);
3193 ret = start_consumerd(&ustconsumer64_data);
3194 if (ret < 0) {
3195 ret = LTTNG_ERR_UST_CONSUMER64_FAIL;
3196 uatomic_set(&ust_consumerd64_fd, -EINVAL);
3197 goto error;
3198 }
3199
3200 uatomic_set(&ust_consumerd64_fd, ustconsumer64_data.cmd_sock);
3201 uatomic_set(&ust_consumerd_state, CONSUMER_STARTED);
3202 } else {
3203 pthread_mutex_unlock(&ustconsumer64_data.pid_mutex);
3204 }
3205
3206 /*
3207 * Setup socket for consumer 64 bit. No need for atomic access
3208 * since it was set above and can ONLY be set in this thread.
3209 */
3210 ret = consumer_create_socket(&ustconsumer64_data,
3211 cmd_ctx->session->ust_session->consumer);
3212 if (ret < 0) {
3213 goto error;
3214 }
3215
3216 /* 32-bit */
3217 pthread_mutex_lock(&ustconsumer32_data.pid_mutex);
3218 if (config.consumerd32_bin_path.value &&
3219 ustconsumer32_data.pid == 0 &&
3220 cmd_ctx->lsm->cmd_type != LTTNG_REGISTER_CONSUMER) {
3221 pthread_mutex_unlock(&ustconsumer32_data.pid_mutex);
3222 ret = start_consumerd(&ustconsumer32_data);
3223 if (ret < 0) {
3224 ret = LTTNG_ERR_UST_CONSUMER32_FAIL;
3225 uatomic_set(&ust_consumerd32_fd, -EINVAL);
3226 goto error;
3227 }
3228
3229 uatomic_set(&ust_consumerd32_fd, ustconsumer32_data.cmd_sock);
3230 uatomic_set(&ust_consumerd_state, CONSUMER_STARTED);
3231 } else {
3232 pthread_mutex_unlock(&ustconsumer32_data.pid_mutex);
3233 }
3234
3235 /*
3236 * Setup socket for consumer 64 bit. No need for atomic access
3237 * since it was set above and can ONLY be set in this thread.
3238 */
3239 ret = consumer_create_socket(&ustconsumer32_data,
3240 cmd_ctx->session->ust_session->consumer);
3241 if (ret < 0) {
3242 goto error;
3243 }
3244 }
3245 break;
3246 }
3247 default:
3248 break;
3249 }
3250 skip_domain:
3251
3252 /* Validate consumer daemon state when start/stop trace command */
3253 if (cmd_ctx->lsm->cmd_type == LTTNG_START_TRACE ||
3254 cmd_ctx->lsm->cmd_type == LTTNG_STOP_TRACE) {
3255 switch (cmd_ctx->lsm->domain.type) {
3256 case LTTNG_DOMAIN_NONE:
3257 break;
3258 case LTTNG_DOMAIN_JUL:
3259 case LTTNG_DOMAIN_LOG4J:
3260 case LTTNG_DOMAIN_PYTHON:
3261 case LTTNG_DOMAIN_UST:
3262 if (uatomic_read(&ust_consumerd_state) != CONSUMER_STARTED) {
3263 ret = LTTNG_ERR_NO_USTCONSUMERD;
3264 goto error;
3265 }
3266 break;
3267 case LTTNG_DOMAIN_KERNEL:
3268 if (uatomic_read(&kernel_consumerd_state) != CONSUMER_STARTED) {
3269 ret = LTTNG_ERR_NO_KERNCONSUMERD;
3270 goto error;
3271 }
3272 break;
3273 default:
3274 ret = LTTNG_ERR_UNKNOWN_DOMAIN;
3275 goto error;
3276 }
3277 }
3278
3279 /*
3280 * Check that the UID or GID match that of the tracing session.
3281 * The root user can interact with all sessions.
3282 */
3283 if (need_tracing_session) {
3284 if (!session_access_ok(cmd_ctx->session,
3285 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx->creds),
3286 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx->creds))) {
3287 ret = LTTNG_ERR_EPERM;
3288 goto error;
3289 }
3290 }
3291
3292 /*
3293 * Send relayd information to consumer as soon as we have a domain and a
3294 * session defined.
3295 */
3296 if (cmd_ctx->session && need_domain) {
3297 /*
3298 * Setup relayd if not done yet. If the relayd information was already
3299 * sent to the consumer, this call will gracefully return.
3300 */
3301 ret = cmd_setup_relayd(cmd_ctx->session);
3302 if (ret != LTTNG_OK) {
3303 goto error;
3304 }
3305 }
3306
3307 /* Process by command type */
3308 switch (cmd_ctx->lsm->cmd_type) {
3309 case LTTNG_ADD_CONTEXT:
3310 {
3311 /*
3312 * An LTTNG_ADD_CONTEXT command might have a supplementary
3313 * payload if the context being added is an application context.
3314 */
3315 if (cmd_ctx->lsm->u.context.ctx.ctx ==
3316 LTTNG_EVENT_CONTEXT_APP_CONTEXT) {
3317 char *provider_name = NULL, *context_name = NULL;
3318 size_t provider_name_len =
3319 cmd_ctx->lsm->u.context.provider_name_len;
3320 size_t context_name_len =
3321 cmd_ctx->lsm->u.context.context_name_len;
3322
3323 if (provider_name_len == 0 || context_name_len == 0) {
3324 /*
3325 * Application provider and context names MUST
3326 * be provided.
3327 */
3328 ret = -LTTNG_ERR_INVALID;
3329 goto error;
3330 }
3331
3332 provider_name = zmalloc(provider_name_len + 1);
3333 if (!provider_name) {
3334 ret = -LTTNG_ERR_NOMEM;
3335 goto error;
3336 }
3337 cmd_ctx->lsm->u.context.ctx.u.app_ctx.provider_name =
3338 provider_name;
3339
3340 context_name = zmalloc(context_name_len + 1);
3341 if (!context_name) {
3342 ret = -LTTNG_ERR_NOMEM;
3343 goto error_add_context;
3344 }
3345 cmd_ctx->lsm->u.context.ctx.u.app_ctx.ctx_name =
3346 context_name;
3347
3348 ret = lttcomm_recv_unix_sock(sock, provider_name,
3349 provider_name_len);
3350 if (ret < 0) {
3351 goto error_add_context;
3352 }
3353
3354 ret = lttcomm_recv_unix_sock(sock, context_name,
3355 context_name_len);
3356 if (ret < 0) {
3357 goto error_add_context;
3358 }
3359 }
3360
3361 /*
3362 * cmd_add_context assumes ownership of the provider and context
3363 * names.
3364 */
3365 ret = cmd_add_context(cmd_ctx->session,
3366 cmd_ctx->lsm->domain.type,
3367 cmd_ctx->lsm->u.context.channel_name,
3368 &cmd_ctx->lsm->u.context.ctx,
3369 kernel_poll_pipe[1]);
3370
3371 cmd_ctx->lsm->u.context.ctx.u.app_ctx.provider_name = NULL;
3372 cmd_ctx->lsm->u.context.ctx.u.app_ctx.ctx_name = NULL;
3373 error_add_context:
3374 free(cmd_ctx->lsm->u.context.ctx.u.app_ctx.provider_name);
3375 free(cmd_ctx->lsm->u.context.ctx.u.app_ctx.ctx_name);
3376 if (ret < 0) {
3377 goto error;
3378 }
3379 break;
3380 }
3381 case LTTNG_DISABLE_CHANNEL:
3382 {
3383 ret = cmd_disable_channel(cmd_ctx->session, cmd_ctx->lsm->domain.type,
3384 cmd_ctx->lsm->u.disable.channel_name);
3385 break;
3386 }
3387 case LTTNG_DISABLE_EVENT:
3388 {
3389
3390 /*
3391 * FIXME: handle filter; for now we just receive the filter's
3392 * bytecode along with the filter expression which are sent by
3393 * liblttng-ctl and discard them.
3394 *
3395 * This fixes an issue where the client may block while sending
3396 * the filter payload and encounter an error because the session
3397 * daemon closes the socket without ever handling this data.
3398 */
3399 size_t count = cmd_ctx->lsm->u.disable.expression_len +
3400 cmd_ctx->lsm->u.disable.bytecode_len;
3401
3402 if (count) {
3403 char data[LTTNG_FILTER_MAX_LEN];
3404
3405 DBG("Discarding disable event command payload of size %zu", count);
3406 while (count) {
3407 ret = lttcomm_recv_unix_sock(sock, data,
3408 count > sizeof(data) ? sizeof(data) : count);
3409 if (ret < 0) {
3410 goto error;
3411 }
3412
3413 count -= (size_t) ret;
3414 }
3415 }
3416 /* FIXME: passing packed structure to non-packed pointer */
3417 ret = cmd_disable_event(cmd_ctx->session, cmd_ctx->lsm->domain.type,
3418 cmd_ctx->lsm->u.disable.channel_name,
3419 &cmd_ctx->lsm->u.disable.event);
3420 break;
3421 }
3422 case LTTNG_ENABLE_CHANNEL:
3423 {
3424 cmd_ctx->lsm->u.channel.chan.attr.extended.ptr =
3425 (struct lttng_channel_extended *) &cmd_ctx->lsm->u.channel.extended;
3426 ret = cmd_enable_channel(cmd_ctx->session, &cmd_ctx->lsm->domain,
3427 &cmd_ctx->lsm->u.channel.chan,
3428 kernel_poll_pipe[1]);
3429 break;
3430 }
3431 case LTTNG_TRACK_PID:
3432 {
3433 ret = cmd_track_pid(cmd_ctx->session,
3434 cmd_ctx->lsm->domain.type,
3435 cmd_ctx->lsm->u.pid_tracker.pid);
3436 break;
3437 }
3438 case LTTNG_UNTRACK_PID:
3439 {
3440 ret = cmd_untrack_pid(cmd_ctx->session,
3441 cmd_ctx->lsm->domain.type,
3442 cmd_ctx->lsm->u.pid_tracker.pid);
3443 break;
3444 }
3445 case LTTNG_ENABLE_EVENT:
3446 {
3447 struct lttng_event_exclusion *exclusion = NULL;
3448 struct lttng_filter_bytecode *bytecode = NULL;
3449 char *filter_expression = NULL;
3450
3451 /* Handle exclusion events and receive it from the client. */
3452 if (cmd_ctx->lsm->u.enable.exclusion_count > 0) {
3453 size_t count = cmd_ctx->lsm->u.enable.exclusion_count;
3454
3455 exclusion = zmalloc(sizeof(struct lttng_event_exclusion) +
3456 (count * LTTNG_SYMBOL_NAME_LEN));
3457 if (!exclusion) {
3458 ret = LTTNG_ERR_EXCLUSION_NOMEM;
3459 goto error;
3460 }
3461
3462 DBG("Receiving var len exclusion event list from client ...");
3463 exclusion->count = count;
3464 ret = lttcomm_recv_unix_sock(sock, exclusion->names,
3465 count * LTTNG_SYMBOL_NAME_LEN);
3466 if (ret <= 0) {
3467 DBG("Nothing recv() from client var len data... continuing");
3468 *sock_error = 1;
3469 free(exclusion);
3470 ret = LTTNG_ERR_EXCLUSION_INVAL;
3471 goto error;
3472 }
3473 }
3474
3475 /* Get filter expression from client. */
3476 if (cmd_ctx->lsm->u.enable.expression_len > 0) {
3477 size_t expression_len =
3478 cmd_ctx->lsm->u.enable.expression_len;
3479
3480 if (expression_len > LTTNG_FILTER_MAX_LEN) {
3481 ret = LTTNG_ERR_FILTER_INVAL;
3482 free(exclusion);
3483 goto error;
3484 }
3485
3486 filter_expression = zmalloc(expression_len);
3487 if (!filter_expression) {
3488 free(exclusion);
3489 ret = LTTNG_ERR_FILTER_NOMEM;
3490 goto error;
3491 }
3492
3493 /* Receive var. len. data */
3494 DBG("Receiving var len filter's expression from client ...");
3495 ret = lttcomm_recv_unix_sock(sock, filter_expression,
3496 expression_len);
3497 if (ret <= 0) {
3498 DBG("Nothing recv() from client car len data... continuing");
3499 *sock_error = 1;
3500 free(filter_expression);
3501 free(exclusion);
3502 ret = LTTNG_ERR_FILTER_INVAL;
3503 goto error;
3504 }
3505 }
3506
3507 /* Handle filter and get bytecode from client. */
3508 if (cmd_ctx->lsm->u.enable.bytecode_len > 0) {
3509 size_t bytecode_len = cmd_ctx->lsm->u.enable.bytecode_len;
3510
3511 if (bytecode_len > LTTNG_FILTER_MAX_LEN) {
3512 ret = LTTNG_ERR_FILTER_INVAL;
3513 free(filter_expression);
3514 free(exclusion);
3515 goto error;
3516 }
3517
3518 bytecode = zmalloc(bytecode_len);
3519 if (!bytecode) {
3520 free(filter_expression);
3521 free(exclusion);
3522 ret = LTTNG_ERR_FILTER_NOMEM;
3523 goto error;
3524 }
3525
3526 /* Receive var. len. data */
3527 DBG("Receiving var len filter's bytecode from client ...");
3528 ret = lttcomm_recv_unix_sock(sock, bytecode, bytecode_len);
3529 if (ret <= 0) {
3530 DBG("Nothing recv() from client car len data... continuing");
3531 *sock_error = 1;
3532 free(filter_expression);
3533 free(bytecode);
3534 free(exclusion);
3535 ret = LTTNG_ERR_FILTER_INVAL;
3536 goto error;
3537 }
3538
3539 if ((bytecode->len + sizeof(*bytecode)) != bytecode_len) {
3540 free(filter_expression);
3541 free(bytecode);
3542 free(exclusion);
3543 ret = LTTNG_ERR_FILTER_INVAL;
3544 goto error;
3545 }
3546 }
3547
3548 ret = cmd_enable_event(cmd_ctx->session, &cmd_ctx->lsm->domain,
3549 cmd_ctx->lsm->u.enable.channel_name,
3550 &cmd_ctx->lsm->u.enable.event,
3551 filter_expression, bytecode, exclusion,
3552 kernel_poll_pipe[1]);
3553 break;
3554 }
3555 case LTTNG_LIST_TRACEPOINTS:
3556 {
3557 struct lttng_event *events;
3558 ssize_t nb_events;
3559
3560 session_lock_list();
3561 nb_events = cmd_list_tracepoints(cmd_ctx->lsm->domain.type, &events);
3562 session_unlock_list();
3563 if (nb_events < 0) {
3564 /* Return value is a negative lttng_error_code. */
3565 ret = -nb_events;
3566 goto error;
3567 }
3568
3569 /*
3570 * Setup lttng message with payload size set to the event list size in
3571 * bytes and then copy list into the llm payload.
3572 */
3573 ret = setup_lttng_msg_no_cmd_header(cmd_ctx, events,
3574 sizeof(struct lttng_event) * nb_events);
3575 free(events);
3576
3577 if (ret < 0) {
3578 goto setup_error;
3579 }
3580
3581 ret = LTTNG_OK;
3582 break;
3583 }
3584 case LTTNG_LIST_TRACEPOINT_FIELDS:
3585 {
3586 struct lttng_event_field *fields;
3587 ssize_t nb_fields;
3588
3589 session_lock_list();
3590 nb_fields = cmd_list_tracepoint_fields(cmd_ctx->lsm->domain.type,
3591 &fields);
3592 session_unlock_list();
3593 if (nb_fields < 0) {
3594 /* Return value is a negative lttng_error_code. */
3595 ret = -nb_fields;
3596 goto error;
3597 }
3598
3599 /*
3600 * Setup lttng message with payload size set to the event list size in
3601 * bytes and then copy list into the llm payload.
3602 */
3603 ret = setup_lttng_msg_no_cmd_header(cmd_ctx, fields,
3604 sizeof(struct lttng_event_field) * nb_fields);
3605 free(fields);
3606
3607 if (ret < 0) {
3608 goto setup_error;
3609 }
3610
3611 ret = LTTNG_OK;
3612 break;
3613 }
3614 case LTTNG_LIST_SYSCALLS:
3615 {
3616 struct lttng_event *events;
3617 ssize_t nb_events;
3618
3619 nb_events = cmd_list_syscalls(&events);
3620 if (nb_events < 0) {
3621 /* Return value is a negative lttng_error_code. */
3622 ret = -nb_events;
3623 goto error;
3624 }
3625
3626 /*
3627 * Setup lttng message with payload size set to the event list size in
3628 * bytes and then copy list into the llm payload.
3629 */
3630 ret = setup_lttng_msg_no_cmd_header(cmd_ctx, events,
3631 sizeof(struct lttng_event) * nb_events);
3632 free(events);
3633
3634 if (ret < 0) {
3635 goto setup_error;
3636 }
3637
3638 ret = LTTNG_OK;
3639 break;
3640 }
3641 case LTTNG_LIST_TRACKER_PIDS:
3642 {
3643 int32_t *pids = NULL;
3644 ssize_t nr_pids;
3645
3646 nr_pids = cmd_list_tracker_pids(cmd_ctx->session,
3647 cmd_ctx->lsm->domain.type, &pids);
3648 if (nr_pids < 0) {
3649 /* Return value is a negative lttng_error_code. */
3650 ret = -nr_pids;
3651 goto error;
3652 }
3653
3654 /*
3655 * Setup lttng message with payload size set to the event list size in
3656 * bytes and then copy list into the llm payload.
3657 */
3658 ret = setup_lttng_msg_no_cmd_header(cmd_ctx, pids,
3659 sizeof(int32_t) * nr_pids);
3660 free(pids);
3661
3662 if (ret < 0) {
3663 goto setup_error;
3664 }
3665
3666 ret = LTTNG_OK;
3667 break;
3668 }
3669 case LTTNG_SET_CONSUMER_URI:
3670 {
3671 size_t nb_uri, len;
3672 struct lttng_uri *uris;
3673
3674 nb_uri = cmd_ctx->lsm->u.uri.size;
3675 len = nb_uri * sizeof(struct lttng_uri);
3676
3677 if (nb_uri == 0) {
3678 ret = LTTNG_ERR_INVALID;
3679 goto error;
3680 }
3681
3682 uris = zmalloc(len);
3683 if (uris == NULL) {
3684 ret = LTTNG_ERR_FATAL;
3685 goto error;
3686 }
3687
3688 /* Receive variable len data */
3689 DBG("Receiving %zu URI(s) from client ...", nb_uri);
3690 ret = lttcomm_recv_unix_sock(sock, uris, len);
3691 if (ret <= 0) {
3692 DBG("No URIs received from client... continuing");
3693 *sock_error = 1;
3694 ret = LTTNG_ERR_SESSION_FAIL;
3695 free(uris);
3696 goto error;
3697 }
3698
3699 ret = cmd_set_consumer_uri(cmd_ctx->session, nb_uri, uris);
3700 free(uris);
3701 if (ret != LTTNG_OK) {
3702 goto error;
3703 }
3704
3705
3706 break;
3707 }
3708 case LTTNG_START_TRACE:
3709 {
3710 /*
3711 * On the first start, if we have a kernel session and we have
3712 * enabled time or size-based rotations, we have to make sure
3713 * the kernel tracer supports it.
3714 */
3715 if (!cmd_ctx->session->has_been_started && \
3716 cmd_ctx->session->kernel_session && \
3717 (cmd_ctx->session->rotate_timer_period || \
3718 cmd_ctx->session->rotate_size) && \
3719 !check_rotate_compatible()) {
3720 DBG("Kernel tracer version is not compatible with the rotation feature");
3721 ret = LTTNG_ERR_ROTATION_WRONG_VERSION;
3722 goto error;
3723 }
3724 ret = cmd_start_trace(cmd_ctx->session);
3725 break;
3726 }
3727 case LTTNG_STOP_TRACE:
3728 {
3729 ret = cmd_stop_trace(cmd_ctx->session);
3730 break;
3731 }
3732 case LTTNG_CREATE_SESSION:
3733 {
3734 size_t nb_uri, len;
3735 struct lttng_uri *uris = NULL;
3736
3737 nb_uri = cmd_ctx->lsm->u.uri.size;
3738 len = nb_uri * sizeof(struct lttng_uri);
3739
3740 if (nb_uri > 0) {
3741 uris = zmalloc(len);
3742 if (uris == NULL) {
3743 ret = LTTNG_ERR_FATAL;
3744 goto error;
3745 }
3746
3747 /* Receive variable len data */
3748 DBG("Waiting for %zu URIs from client ...", nb_uri);
3749 ret = lttcomm_recv_unix_sock(sock, uris, len);
3750 if (ret <= 0) {
3751 DBG("No URIs received from client... continuing");
3752 *sock_error = 1;
3753 ret = LTTNG_ERR_SESSION_FAIL;
3754 free(uris);
3755 goto error;
3756 }
3757
3758 if (nb_uri == 1 && uris[0].dtype != LTTNG_DST_PATH) {
3759 DBG("Creating session with ONE network URI is a bad call");
3760 ret = LTTNG_ERR_SESSION_FAIL;
3761 free(uris);
3762 goto error;
3763 }
3764 }
3765
3766 ret = cmd_create_session_uri(cmd_ctx->lsm->session.name, uris, nb_uri,
3767 &cmd_ctx->creds, 0);
3768
3769 free(uris);
3770
3771 break;
3772 }
3773 case LTTNG_DESTROY_SESSION:
3774 {
3775 ret = cmd_destroy_session(cmd_ctx->session, kernel_poll_pipe[1],
3776 notification_thread_handle);
3777
3778 /* Set session to NULL so we do not unlock it after free. */
3779 cmd_ctx->session = NULL;
3780 break;
3781 }
3782 case LTTNG_LIST_DOMAINS:
3783 {
3784 ssize_t nb_dom;
3785 struct lttng_domain *domains = NULL;
3786
3787 nb_dom = cmd_list_domains(cmd_ctx->session, &domains);
3788 if (nb_dom < 0) {
3789 /* Return value is a negative lttng_error_code. */
3790 ret = -nb_dom;
3791 goto error;
3792 }
3793
3794 ret = setup_lttng_msg_no_cmd_header(cmd_ctx, domains,
3795 nb_dom * sizeof(struct lttng_domain));
3796 free(domains);
3797
3798 if (ret < 0) {
3799 goto setup_error;
3800 }
3801
3802 ret = LTTNG_OK;
3803 break;
3804 }
3805 case LTTNG_LIST_CHANNELS:
3806 {
3807 ssize_t payload_size;
3808 struct lttng_channel *channels = NULL;
3809
3810 payload_size = cmd_list_channels(cmd_ctx->lsm->domain.type,
3811 cmd_ctx->session, &channels);
3812 if (payload_size < 0) {
3813 /* Return value is a negative lttng_error_code. */
3814 ret = -payload_size;
3815 goto error;
3816 }
3817
3818 ret = setup_lttng_msg_no_cmd_header(cmd_ctx, channels,
3819 payload_size);
3820 free(channels);
3821
3822 if (ret < 0) {
3823 goto setup_error;
3824 }
3825
3826 ret = LTTNG_OK;
3827 break;
3828 }
3829 case LTTNG_LIST_EVENTS:
3830 {
3831 ssize_t nb_event;
3832 struct lttng_event *events = NULL;
3833 struct lttcomm_event_command_header cmd_header;
3834 size_t total_size;
3835
3836 memset(&cmd_header, 0, sizeof(cmd_header));
3837 /* Extended infos are included at the end of events */
3838 nb_event = cmd_list_events(cmd_ctx->lsm->domain.type,
3839 cmd_ctx->session, cmd_ctx->lsm->u.list.channel_name,
3840 &events, &total_size);
3841
3842 if (nb_event < 0) {
3843 /* Return value is a negative lttng_error_code. */
3844 ret = -nb_event;
3845 goto error;
3846 }
3847
3848 cmd_header.nb_events = nb_event;
3849 ret = setup_lttng_msg(cmd_ctx, events, total_size,
3850 &cmd_header, sizeof(cmd_header));
3851 free(events);
3852
3853 if (ret < 0) {
3854 goto setup_error;
3855 }
3856
3857 ret = LTTNG_OK;
3858 break;
3859 }
3860 case LTTNG_LIST_SESSIONS:
3861 {
3862 unsigned int nr_sessions;
3863 void *sessions_payload;
3864 size_t payload_len;
3865
3866 session_lock_list();
3867 nr_sessions = lttng_sessions_count(
3868 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx->creds),
3869 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx->creds));
3870 payload_len = sizeof(struct lttng_session) * nr_sessions;
3871 sessions_payload = zmalloc(payload_len);
3872
3873 if (!sessions_payload) {
3874 session_unlock_list();
3875 ret = -ENOMEM;
3876 goto setup_error;
3877 }
3878
3879 cmd_list_lttng_sessions(sessions_payload,
3880 LTTNG_SOCK_GET_UID_CRED(&cmd_ctx->creds),
3881 LTTNG_SOCK_GET_GID_CRED(&cmd_ctx->creds));
3882 session_unlock_list();
3883
3884 ret = setup_lttng_msg_no_cmd_header(cmd_ctx, sessions_payload,
3885 payload_len);
3886 free(sessions_payload);
3887
3888 if (ret < 0) {
3889 goto setup_error;
3890 }
3891
3892 ret = LTTNG_OK;
3893 break;
3894 }
3895 case LTTNG_REGISTER_CONSUMER:
3896 {
3897 struct consumer_data *cdata;
3898
3899 switch (cmd_ctx->lsm->domain.type) {
3900 case LTTNG_DOMAIN_KERNEL:
3901 cdata = &kconsumer_data;
3902 break;
3903 default:
3904 ret = LTTNG_ERR_UND;
3905 goto error;
3906 }
3907
3908 ret = cmd_register_consumer(cmd_ctx->session, cmd_ctx->lsm->domain.type,
3909 cmd_ctx->lsm->u.reg.path, cdata);
3910 break;
3911 }
3912 case LTTNG_DATA_PENDING:
3913 {
3914 int pending_ret;
3915 uint8_t pending_ret_byte;
3916
3917 pending_ret = cmd_data_pending(cmd_ctx->session);
3918
3919 /*
3920 * FIXME
3921 *
3922 * This function may returns 0 or 1 to indicate whether or not
3923 * there is data pending. In case of error, it should return an
3924 * LTTNG_ERR code. However, some code paths may still return
3925 * a nondescript error code, which we handle by returning an
3926 * "unknown" error.
3927 */
3928 if (pending_ret == 0 || pending_ret == 1) {
3929 /*
3930 * ret will be set to LTTNG_OK at the end of
3931 * this function.
3932 */
3933 } else if (pending_ret < 0) {
3934 ret = LTTNG_ERR_UNK;
3935 goto setup_error;
3936 } else {
3937 ret = pending_ret;
3938 goto setup_error;
3939 }
3940
3941 pending_ret_byte = (uint8_t) pending_ret;
3942
3943 /* 1 byte to return whether or not data is pending */
3944 ret = setup_lttng_msg_no_cmd_header(cmd_ctx,
3945 &pending_ret_byte, 1);
3946
3947 if (ret < 0) {
3948 goto setup_error;
3949 }
3950
3951 ret = LTTNG_OK;
3952 break;
3953 }
3954 case LTTNG_SNAPSHOT_ADD_OUTPUT:
3955 {
3956 struct lttcomm_lttng_output_id reply;
3957
3958 ret = cmd_snapshot_add_output(cmd_ctx->session,
3959 &cmd_ctx->lsm->u.snapshot_output.output, &reply.id);
3960 if (ret != LTTNG_OK) {
3961 goto error;
3962 }
3963
3964 ret = setup_lttng_msg_no_cmd_header(cmd_ctx, &reply,
3965 sizeof(reply));
3966 if (ret < 0) {
3967 goto setup_error;
3968 }
3969
3970 /* Copy output list into message payload */
3971 ret = LTTNG_OK;
3972 break;
3973 }
3974 case LTTNG_SNAPSHOT_DEL_OUTPUT:
3975 {
3976 ret = cmd_snapshot_del_output(cmd_ctx->session,
3977 &cmd_ctx->lsm->u.snapshot_output.output);
3978 break;
3979 }
3980 case LTTNG_SNAPSHOT_LIST_OUTPUT:
3981 {
3982 ssize_t nb_output;
3983 struct lttng_snapshot_output *outputs = NULL;
3984
3985 nb_output = cmd_snapshot_list_outputs(cmd_ctx->session, &outputs);
3986 if (nb_output < 0) {
3987 ret = -nb_output;
3988 goto error;
3989 }
3990
3991 assert((nb_output > 0 && outputs) || nb_output == 0);
3992 ret = setup_lttng_msg_no_cmd_header(cmd_ctx, outputs,
3993 nb_output * sizeof(struct lttng_snapshot_output));
3994 free(outputs);
3995
3996 if (ret < 0) {
3997 goto setup_error;
3998 }
3999
4000 ret = LTTNG_OK;
4001 break;
4002 }
4003 case LTTNG_SNAPSHOT_RECORD:
4004 {
4005 ret = cmd_snapshot_record(cmd_ctx->session,
4006 &cmd_ctx->lsm->u.snapshot_record.output,
4007 cmd_ctx->lsm->u.snapshot_record.wait);
4008 break;
4009 }
4010 case LTTNG_CREATE_SESSION_SNAPSHOT:
4011 {
4012 size_t nb_uri, len;
4013 struct lttng_uri *uris = NULL;
4014
4015 nb_uri = cmd_ctx->lsm->u.uri.size;
4016 len = nb_uri * sizeof(struct lttng_uri);
4017
4018 if (nb_uri > 0) {
4019 uris = zmalloc(len);
4020 if (uris == NULL) {
4021 ret = LTTNG_ERR_FATAL;
4022 goto error;
4023 }
4024
4025 /* Receive variable len data */
4026 DBG("Waiting for %zu URIs from client ...", nb_uri);
4027 ret = lttcomm_recv_unix_sock(sock, uris, len);
4028 if (ret <= 0) {
4029 DBG("No URIs received from client... continuing");
4030 *sock_error = 1;
4031 ret = LTTNG_ERR_SESSION_FAIL;
4032 free(uris);
4033 goto error;
4034 }
4035
4036 if (nb_uri == 1 && uris[0].dtype != LTTNG_DST_PATH) {
4037 DBG("Creating session with ONE network URI is a bad call");
4038 ret = LTTNG_ERR_SESSION_FAIL;
4039 free(uris);
4040 goto error;
4041 }
4042 }
4043
4044 ret = cmd_create_session_snapshot(cmd_ctx->lsm->session.name, uris,
4045 nb_uri, &cmd_ctx->creds);
4046 free(uris);
4047 break;
4048 }
4049 case LTTNG_CREATE_SESSION_LIVE:
4050 {
4051 size_t nb_uri, len;
4052 struct lttng_uri *uris = NULL;
4053
4054 nb_uri = cmd_ctx->lsm->u.uri.size;
4055 len = nb_uri * sizeof(struct lttng_uri);
4056
4057 if (nb_uri > 0) {
4058 uris = zmalloc(len);
4059 if (uris == NULL) {
4060 ret = LTTNG_ERR_FATAL;
4061 goto error;
4062 }
4063
4064 /* Receive variable len data */
4065 DBG("Waiting for %zu URIs from client ...", nb_uri);
4066 ret = lttcomm_recv_unix_sock(sock, uris, len);
4067 if (ret <= 0) {
4068 DBG("No URIs received from client... continuing");
4069 *sock_error = 1;
4070 ret = LTTNG_ERR_SESSION_FAIL;
4071 free(uris);
4072 goto error;
4073 }
4074
4075 if (nb_uri == 1 && uris[0].dtype != LTTNG_DST_PATH) {
4076 DBG("Creating session with ONE network URI is a bad call");
4077 ret = LTTNG_ERR_SESSION_FAIL;
4078 free(uris);
4079 goto error;
4080 }
4081 }
4082
4083 ret = cmd_create_session_uri(cmd_ctx->lsm->session.name, uris,
4084 nb_uri, &cmd_ctx->creds, cmd_ctx->lsm->u.session_live.timer_interval);
4085 free(uris);
4086 break;
4087 }
4088 case LTTNG_SAVE_SESSION:
4089 {
4090 ret = cmd_save_sessions(&cmd_ctx->lsm->u.save_session.attr,
4091 &cmd_ctx->creds);
4092 break;
4093 }
4094 case LTTNG_SET_SESSION_SHM_PATH:
4095 {
4096 ret = cmd_set_session_shm_path(cmd_ctx->session,
4097 cmd_ctx->lsm->u.set_shm_path.shm_path);
4098 break;
4099 }
4100 case LTTNG_REGENERATE_METADATA:
4101 {
4102 ret = cmd_regenerate_metadata(cmd_ctx->session);
4103 break;
4104 }
4105 case LTTNG_REGENERATE_STATEDUMP:
4106 {
4107 ret = cmd_regenerate_statedump(cmd_ctx->session);
4108 break;
4109 }
4110 case LTTNG_REGISTER_TRIGGER:
4111 {
4112 ret = cmd_register_trigger(cmd_ctx, sock,
4113 notification_thread_handle);
4114 break;
4115 }
4116 case LTTNG_UNREGISTER_TRIGGER:
4117 {
4118 ret = cmd_unregister_trigger(cmd_ctx, sock,
4119 notification_thread_handle);
4120 break;
4121 }
4122 case LTTNG_ROTATE_SESSION:
4123 {
4124 struct lttng_rotate_session_return rotate_return;
4125
4126 DBG("Client rotate session \"%s\"", cmd_ctx->session->name);
4127
4128 memset(&rotate_return, 0, sizeof(rotate_return));
4129 if (cmd_ctx->session->kernel_session && !check_rotate_compatible()) {
4130 DBG("Kernel tracer version is not compatible with the rotation feature");
4131 ret = LTTNG_ERR_ROTATION_WRONG_VERSION;
4132 goto error;
4133 }
4134
4135 ret = cmd_rotate_session(cmd_ctx->session, &rotate_return);
4136 if (ret < 0) {
4137 ret = -ret;
4138 goto error;
4139 }
4140
4141 ret = setup_lttng_msg_no_cmd_header(cmd_ctx, &rotate_return,
4142 sizeof(rotate_return));
4143 if (ret < 0) {
4144 ret = -ret;
4145 goto error;
4146 }
4147
4148 ret = LTTNG_OK;
4149 break;
4150 }
4151 case LTTNG_ROTATION_GET_INFO:
4152 {
4153 struct lttng_rotation_get_info_return get_info_return;
4154
4155 memset(&get_info_return, 0, sizeof(get_info_return));
4156 ret = cmd_rotate_get_info(cmd_ctx->session, &get_info_return,
4157 cmd_ctx->lsm->u.get_rotation_info.rotation_id);
4158 if (ret < 0) {
4159 ret = -ret;
4160 goto error;
4161 }
4162
4163 ret = setup_lttng_msg_no_cmd_header(cmd_ctx, &get_info_return,
4164 sizeof(get_info_return));
4165 if (ret < 0) {
4166 ret = -ret;
4167 goto error;
4168 }
4169
4170 ret = LTTNG_OK;
4171 break;
4172 }
4173 case LTTNG_SESSION_GET_CURRENT_OUTPUT:
4174 {
4175 struct lttng_session_get_current_output_return output_return;
4176
4177 memset(&output_return, 0, sizeof(output_return));
4178 ret = cmd_session_get_current_output(cmd_ctx->session,
4179 &output_return);
4180 if (ret < 0) {
4181 ret = -ret;
4182 goto error;
4183 }
4184
4185 ret = setup_lttng_msg_no_cmd_header(cmd_ctx, &output_return,
4186 sizeof(output_return));
4187 if (ret < 0) {
4188 ret = -ret;
4189 goto error;
4190 }
4191
4192 ret = LTTNG_OK;
4193 break;
4194 }
4195 case LTTNG_ROTATION_SET_SCHEDULE:
4196 {
4197 if (cmd_ctx->session->kernel_session && !check_rotate_compatible()) {
4198 DBG("Kernel tracer version does not support session rotations");
4199 ret = LTTNG_ERR_ROTATION_WRONG_VERSION;
4200 goto error;
4201 }
4202
4203 ret = cmd_rotation_set_schedule(cmd_ctx->session,
4204 cmd_ctx->lsm->u.rotate_setup.timer_us,
4205 cmd_ctx->lsm->u.rotate_setup.size,
4206 notification_thread_handle);
4207 if (ret < 0) {
4208 ret = -ret;
4209 goto error;
4210 }
4211
4212 ret = LTTNG_OK;
4213 break;
4214 }
4215 case LTTNG_ROTATION_SCHEDULE_GET_TIMER_PERIOD:
4216 {
4217 struct lttng_rotation_schedule_get_timer_period *get_timer;
4218
4219 get_timer = zmalloc(sizeof(struct lttng_rotation_schedule_get_timer_period));
4220 if (!get_timer) {
4221 ret = ENOMEM;
4222 goto error;
4223 }
4224 get_timer->rotate_timer = cmd_ctx->session->rotate_timer_period;
4225
4226 ret = setup_lttng_msg_no_cmd_header(cmd_ctx, get_timer,
4227 sizeof(struct lttng_rotation_schedule_get_timer_period));
4228 free(get_timer);
4229 if (ret < 0) {
4230 ret = -ret;
4231 goto error;
4232 }
4233
4234 ret = LTTNG_OK;
4235 break;
4236 }
4237 case LTTNG_ROTATION_SCHEDULE_GET_SIZE:
4238 {
4239 struct lttng_rotation_schedule_get_size *get_size;
4240
4241 get_size = zmalloc(sizeof(struct lttng_rotation_schedule_get_size));
4242 if (!get_size) {
4243 ret = ENOMEM;
4244 goto error;
4245 }
4246 get_size->rotate_size = cmd_ctx->session->rotate_size;
4247
4248 ret = setup_lttng_msg_no_cmd_header(cmd_ctx, get_size,
4249 sizeof(struct lttng_rotation_schedule_get_size));
4250 free(get_size);
4251 if (ret < 0) {
4252 ret = -ret;
4253 goto error;
4254 }
4255
4256 ret = LTTNG_OK;
4257 break;
4258 }
4259 default:
4260 ret = LTTNG_ERR_UND;
4261 break;
4262 }
4263
4264 error:
4265 if (cmd_ctx->llm == NULL) {
4266 DBG("Missing llm structure. Allocating one.");
4267 if (setup_lttng_msg_no_cmd_header(cmd_ctx, NULL, 0) < 0) {
4268 goto setup_error;
4269 }
4270 }
4271 /* Set return code */
4272 cmd_ctx->llm->ret_code = ret;
4273 setup_error:
4274 if (cmd_ctx->session) {
4275 session_unlock(cmd_ctx->session);
4276 }
4277 if (need_tracing_session) {
4278 session_unlock_list();
4279 }
4280 init_setup_error:
4281 assert(!rcu_read_ongoing());
4282 return ret;
4283 }
4284
4285 /*
4286 * Thread managing health check socket.
4287 */
4288 static void *thread_manage_health(void *data)
4289 {
4290 int sock = -1, new_sock = -1, ret, i, pollfd, err = -1;
4291 uint32_t revents, nb_fd;
4292 struct lttng_poll_event events;
4293 struct health_comm_msg msg;
4294 struct health_comm_reply reply;
4295
4296 DBG("[thread] Manage health check started");
4297
4298 rcu_register_thread();
4299
4300 /* We might hit an error path before this is created. */
4301 lttng_poll_init(&events);
4302
4303 /* Create unix socket */
4304 sock = lttcomm_create_unix_sock(config.health_unix_sock_path.value);
4305 if (sock < 0) {
4306 ERR("Unable to create health check Unix socket");
4307 goto error;
4308 }
4309
4310 if (is_root) {
4311 /* lttng health client socket path permissions */
4312 ret = chown(config.health_unix_sock_path.value, 0,
4313 utils_get_group_id(config.tracing_group_name.value));
4314 if (ret < 0) {
4315 ERR("Unable to set group on %s", config.health_unix_sock_path.value);
4316 PERROR("chown");
4317 goto error;
4318 }
4319
4320 ret = chmod(config.health_unix_sock_path.value,
4321 S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP);
4322 if (ret < 0) {
4323 ERR("Unable to set permissions on %s", config.health_unix_sock_path.value);
4324 PERROR("chmod");
4325 goto error;
4326 }
4327 }
4328
4329 /*
4330 * Set the CLOEXEC flag. Return code is useless because either way, the
4331 * show must go on.
4332 */
4333 (void) utils_set_fd_cloexec(sock);
4334
4335 ret = lttcomm_listen_unix_sock(sock);
4336 if (ret < 0) {
4337 goto error;
4338 }
4339
4340 /*
4341 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
4342 * more will be added to this poll set.
4343 */
4344 ret = sessiond_set_thread_pollset(&events, 2);
4345 if (ret < 0) {
4346 goto error;
4347 }
4348
4349 /* Add the application registration socket */
4350 ret = lttng_poll_add(&events, sock, LPOLLIN | LPOLLPRI);
4351 if (ret < 0) {
4352 goto error;
4353 }
4354
4355 sessiond_notify_ready();
4356
4357 while (1) {
4358 DBG("Health check ready");
4359
4360 /* Inifinite blocking call, waiting for transmission */
4361 restart:
4362 ret = lttng_poll_wait(&events, -1);
4363 if (ret < 0) {
4364 /*
4365 * Restart interrupted system call.
4366 */
4367 if (errno == EINTR) {
4368 goto restart;
4369 }
4370 goto error;
4371 }
4372
4373 nb_fd = ret;
4374
4375 for (i = 0; i < nb_fd; i++) {
4376 /* Fetch once the poll data */
4377 revents = LTTNG_POLL_GETEV(&events, i);
4378 pollfd = LTTNG_POLL_GETFD(&events, i);
4379
4380 if (!revents) {
4381 /* No activity for this FD (poll implementation). */
4382 continue;
4383 }
4384
4385 /* Thread quit pipe has been closed. Killing thread. */
4386 ret = sessiond_check_thread_quit_pipe(pollfd, revents);
4387 if (ret) {
4388 err = 0;
4389 goto exit;
4390 }
4391
4392 /* Event on the registration socket */
4393 if (pollfd == sock) {
4394 if (revents & LPOLLIN) {
4395 continue;
4396 } else if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
4397 ERR("Health socket poll error");
4398 goto error;
4399 } else {
4400 ERR("Unexpected poll events %u for sock %d", revents, pollfd);
4401 goto error;
4402 }
4403 }
4404 }
4405
4406 new_sock = lttcomm_accept_unix_sock(sock);
4407 if (new_sock < 0) {
4408 goto error;
4409 }
4410
4411 /*
4412 * Set the CLOEXEC flag. Return code is useless because either way, the
4413 * show must go on.
4414 */
4415 (void) utils_set_fd_cloexec(new_sock);
4416
4417 DBG("Receiving data from client for health...");
4418 ret = lttcomm_recv_unix_sock(new_sock, (void *)&msg, sizeof(msg));
4419 if (ret <= 0) {
4420 DBG("Nothing recv() from client... continuing");
4421 ret = close(new_sock);
4422 if (ret) {
4423 PERROR("close");
4424 }
4425 continue;
4426 }
4427
4428 rcu_thread_online();
4429
4430 memset(&reply, 0, sizeof(reply));
4431 for (i = 0; i < NR_HEALTH_SESSIOND_TYPES; i++) {
4432 /*
4433 * health_check_state returns 0 if health is
4434 * bad.
4435 */
4436 if (!health_check_state(health_sessiond, i)) {
4437 reply.ret_code |= 1ULL << i;
4438 }
4439 }
4440
4441 DBG2("Health check return value %" PRIx64, reply.ret_code);
4442
4443 ret = send_unix_sock(new_sock, (void *) &reply, sizeof(reply));
4444 if (ret < 0) {
4445 ERR("Failed to send health data back to client");
4446 }
4447
4448 /* End of transmission */
4449 ret = close(new_sock);
4450 if (ret) {
4451 PERROR("close");
4452 }
4453 }
4454
4455 exit:
4456 error:
4457 if (err) {
4458 ERR("Health error occurred in %s", __func__);
4459 }
4460 DBG("Health check thread dying");
4461 unlink(config.health_unix_sock_path.value);
4462 if (sock >= 0) {
4463 ret = close(sock);
4464 if (ret) {
4465 PERROR("close");
4466 }
4467 }
4468
4469 lttng_poll_clean(&events);
4470 stop_threads();
4471 rcu_unregister_thread();
4472 return NULL;
4473 }
4474
4475 /*
4476 * This thread manage all clients request using the unix client socket for
4477 * communication.
4478 */
4479 static void *thread_manage_clients(void *data)
4480 {
4481 int sock = -1, ret, i, pollfd, err = -1;
4482 int sock_error;
4483 uint32_t revents, nb_fd;
4484 struct command_ctx *cmd_ctx = NULL;
4485 struct lttng_poll_event events;
4486
4487 DBG("[thread] Manage client started");
4488
4489 rcu_register_thread();
4490
4491 health_register(health_sessiond, HEALTH_SESSIOND_TYPE_CMD);
4492
4493 health_code_update();
4494
4495 ret = lttcomm_listen_unix_sock(client_sock);
4496 if (ret < 0) {
4497 goto error_listen;
4498 }
4499
4500 /*
4501 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
4502 * more will be added to this poll set.
4503 */
4504 ret = sessiond_set_thread_pollset(&events, 2);
4505 if (ret < 0) {
4506 goto error_create_poll;
4507 }
4508
4509 /* Add the application registration socket */
4510 ret = lttng_poll_add(&events, client_sock, LPOLLIN | LPOLLPRI);
4511 if (ret < 0) {
4512 goto error;
4513 }
4514
4515 sessiond_notify_ready();
4516 ret = sem_post(&load_info->message_thread_ready);
4517 if (ret) {
4518 PERROR("sem_post message_thread_ready");
4519 goto error;
4520 }
4521
4522 /* This testpoint is after we signal readiness to the parent. */
4523 if (testpoint(sessiond_thread_manage_clients)) {
4524 goto error;
4525 }
4526
4527 if (testpoint(sessiond_thread_manage_clients_before_loop)) {
4528 goto error;
4529 }
4530
4531 health_code_update();
4532
4533 while (1) {
4534 DBG("Accepting client command ...");
4535
4536 /* Inifinite blocking call, waiting for transmission */
4537 restart:
4538 health_poll_entry();
4539 ret = lttng_poll_wait(&events, -1);
4540 health_poll_exit();
4541 if (ret < 0) {
4542 /*
4543 * Restart interrupted system call.
4544 */
4545 if (errno == EINTR) {
4546 goto restart;
4547 }
4548 goto error;
4549 }
4550
4551 nb_fd = ret;
4552
4553 for (i = 0; i < nb_fd; i++) {
4554 /* Fetch once the poll data */
4555 revents = LTTNG_POLL_GETEV(&events, i);
4556 pollfd = LTTNG_POLL_GETFD(&events, i);
4557
4558 health_code_update();
4559
4560 if (!revents) {
4561 /* No activity for this FD (poll implementation). */
4562 continue;
4563 }
4564
4565 /* Thread quit pipe has been closed. Killing thread. */
4566 ret = sessiond_check_thread_quit_pipe(pollfd, revents);
4567 if (ret) {
4568 err = 0;
4569 goto exit;
4570 }
4571
4572 /* Event on the registration socket */
4573 if (pollfd == client_sock) {
4574 if (revents & LPOLLIN) {
4575 continue;
4576 } else if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
4577 ERR("Client socket poll error");
4578 goto error;
4579 } else {
4580 ERR("Unexpected poll events %u for sock %d", revents, pollfd);
4581 goto error;
4582 }
4583 }
4584 }
4585
4586 DBG("Wait for client response");
4587
4588 health_code_update();
4589
4590 sock = lttcomm_accept_unix_sock(client_sock);
4591 if (sock < 0) {
4592 goto error;
4593 }
4594
4595 /*
4596 * Set the CLOEXEC flag. Return code is useless because either way, the
4597 * show must go on.
4598 */
4599 (void) utils_set_fd_cloexec(sock);
4600
4601 /* Set socket option for credentials retrieval */
4602 ret = lttcomm_setsockopt_creds_unix_sock(sock);
4603 if (ret < 0) {
4604 goto error;
4605 }
4606
4607 /* Allocate context command to process the client request */
4608 cmd_ctx = zmalloc(sizeof(struct command_ctx));
4609 if (cmd_ctx == NULL) {
4610 PERROR("zmalloc cmd_ctx");
4611 goto error;
4612 }
4613
4614 /* Allocate data buffer for reception */
4615 cmd_ctx->lsm = zmalloc(sizeof(struct lttcomm_session_msg));
4616 if (cmd_ctx->lsm == NULL) {
4617 PERROR("zmalloc cmd_ctx->lsm");
4618 goto error;
4619 }
4620
4621 cmd_ctx->llm = NULL;
4622 cmd_ctx->session = NULL;
4623
4624 health_code_update();
4625
4626 /*
4627 * Data is received from the lttng client. The struct
4628 * lttcomm_session_msg (lsm) contains the command and data request of
4629 * the client.
4630 */
4631 DBG("Receiving data from client ...");
4632 ret = lttcomm_recv_creds_unix_sock(sock, cmd_ctx->lsm,
4633 sizeof(struct lttcomm_session_msg), &cmd_ctx->creds);
4634 if (ret <= 0) {
4635 DBG("Nothing recv() from client... continuing");
4636 ret = close(sock);
4637 if (ret) {
4638 PERROR("close");
4639 }
4640 sock = -1;
4641 clean_command_ctx(&cmd_ctx);
4642 continue;
4643 }
4644
4645 health_code_update();
4646
4647 // TODO: Validate cmd_ctx including sanity check for
4648 // security purpose.
4649
4650 rcu_thread_online();
4651 /*
4652 * This function dispatch the work to the kernel or userspace tracer
4653 * libs and fill the lttcomm_lttng_msg data structure of all the needed
4654 * informations for the client. The command context struct contains
4655 * everything this function may needs.
4656 */
4657 ret = process_client_msg(cmd_ctx, sock, &sock_error);
4658 rcu_thread_offline();
4659 if (ret < 0) {
4660 ret = close(sock);
4661 if (ret) {
4662 PERROR("close");
4663 }
4664 sock = -1;
4665 /*
4666 * TODO: Inform client somehow of the fatal error. At
4667 * this point, ret < 0 means that a zmalloc failed
4668 * (ENOMEM). Error detected but still accept
4669 * command, unless a socket error has been
4670 * detected.
4671 */
4672 clean_command_ctx(&cmd_ctx);
4673 continue;
4674 }
4675
4676 health_code_update();
4677
4678 DBG("Sending response (size: %d, retcode: %s (%d))",
4679 cmd_ctx->lttng_msg_size,
4680 lttng_strerror(-cmd_ctx->llm->ret_code),
4681 cmd_ctx->llm->ret_code);
4682 ret = send_unix_sock(sock, cmd_ctx->llm, cmd_ctx->lttng_msg_size);
4683 if (ret < 0) {
4684 ERR("Failed to send data back to client");
4685 }
4686
4687 /* End of transmission */
4688 ret = close(sock);
4689 if (ret) {
4690 PERROR("close");
4691 }
4692 sock = -1;
4693
4694 clean_command_ctx(&cmd_ctx);
4695
4696 health_code_update();
4697 }
4698
4699 exit:
4700 error:
4701 if (sock >= 0) {
4702 ret = close(sock);
4703 if (ret) {
4704 PERROR("close");
4705 }
4706 }
4707
4708 lttng_poll_clean(&events);
4709 clean_command_ctx(&cmd_ctx);
4710
4711 error_listen:
4712 error_create_poll:
4713 unlink(config.client_unix_sock_path.value);
4714 if (client_sock >= 0) {
4715 ret = close(client_sock);
4716 if (ret) {
4717 PERROR("close");
4718 }
4719 }
4720
4721 if (err) {
4722 health_error();
4723 ERR("Health error occurred in %s", __func__);
4724 }
4725
4726 health_unregister(health_sessiond);
4727
4728 DBG("Client thread dying");
4729
4730 rcu_unregister_thread();
4731
4732 /*
4733 * Since we are creating the consumer threads, we own them, so we need
4734 * to join them before our thread exits.
4735 */
4736 ret = join_consumer_thread(&kconsumer_data);
4737 if (ret) {
4738 errno = ret;
4739 PERROR("join_consumer");
4740 }
4741
4742 ret = join_consumer_thread(&ustconsumer32_data);
4743 if (ret) {
4744 errno = ret;
4745 PERROR("join_consumer ust32");
4746 }
4747
4748 ret = join_consumer_thread(&ustconsumer64_data);
4749 if (ret) {
4750 errno = ret;
4751 PERROR("join_consumer ust64");
4752 }
4753 return NULL;
4754 }
4755
4756 static int string_match(const char *str1, const char *str2)
4757 {
4758 return (str1 && str2) && !strcmp(str1, str2);
4759 }
4760
4761 /*
4762 * Take an option from the getopt output and set it in the right variable to be
4763 * used later.
4764 *
4765 * Return 0 on success else a negative value.
4766 */
4767 static int set_option(int opt, const char *arg, const char *optname)
4768 {
4769 int ret = 0;
4770
4771 if (string_match(optname, "client-sock") || opt == 'c') {
4772 if (!arg || *arg == '\0') {
4773 ret = -EINVAL;
4774 goto end;
4775 }
4776 if (lttng_is_setuid_setgid()) {
4777 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4778 "-c, --client-sock");
4779 } else {
4780 config_string_set(&config.client_unix_sock_path,
4781 strdup(arg));
4782 if (!config.client_unix_sock_path.value) {
4783 ret = -ENOMEM;
4784 PERROR("strdup");
4785 }
4786 }
4787 } else if (string_match(optname, "apps-sock") || opt == 'a') {
4788 if (!arg || *arg == '\0') {
4789 ret = -EINVAL;
4790 goto end;
4791 }
4792 if (lttng_is_setuid_setgid()) {
4793 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4794 "-a, --apps-sock");
4795 } else {
4796 config_string_set(&config.apps_unix_sock_path,
4797 strdup(arg));
4798 if (!config.apps_unix_sock_path.value) {
4799 ret = -ENOMEM;
4800 PERROR("strdup");
4801 }
4802 }
4803 } else if (string_match(optname, "daemonize") || opt == 'd') {
4804 config.daemonize = true;
4805 } else if (string_match(optname, "background") || opt == 'b') {
4806 config.background = true;
4807 } else if (string_match(optname, "group") || opt == 'g') {
4808 if (!arg || *arg == '\0') {
4809 ret = -EINVAL;
4810 goto end;
4811 }
4812 if (lttng_is_setuid_setgid()) {
4813 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4814 "-g, --group");
4815 } else {
4816 config_string_set(&config.tracing_group_name,
4817 strdup(arg));
4818 if (!config.tracing_group_name.value) {
4819 ret = -ENOMEM;
4820 PERROR("strdup");
4821 }
4822 }
4823 } else if (string_match(optname, "help") || opt == 'h') {
4824 ret = utils_show_help(8, "lttng-sessiond", help_msg);
4825 if (ret) {
4826 ERR("Cannot show --help for `lttng-sessiond`");
4827 perror("exec");
4828 }
4829 exit(ret ? EXIT_FAILURE : EXIT_SUCCESS);
4830 } else if (string_match(optname, "version") || opt == 'V') {
4831 fprintf(stdout, "%s\n", VERSION);
4832 exit(EXIT_SUCCESS);
4833 } else if (string_match(optname, "sig-parent") || opt == 'S') {
4834 config.sig_parent = true;
4835 } else if (string_match(optname, "kconsumerd-err-sock")) {
4836 if (!arg || *arg == '\0') {
4837 ret = -EINVAL;
4838 goto end;
4839 }
4840 if (lttng_is_setuid_setgid()) {
4841 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4842 "--kconsumerd-err-sock");
4843 } else {
4844 config_string_set(&config.kconsumerd_err_unix_sock_path,
4845 strdup(arg));
4846 if (!config.kconsumerd_err_unix_sock_path.value) {
4847 ret = -ENOMEM;
4848 PERROR("strdup");
4849 }
4850 }
4851 } else if (string_match(optname, "kconsumerd-cmd-sock")) {
4852 if (!arg || *arg == '\0') {
4853 ret = -EINVAL;
4854 goto end;
4855 }
4856 if (lttng_is_setuid_setgid()) {
4857 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4858 "--kconsumerd-cmd-sock");
4859 } else {
4860 config_string_set(&config.kconsumerd_cmd_unix_sock_path,
4861 strdup(arg));
4862 if (!config.kconsumerd_cmd_unix_sock_path.value) {
4863 ret = -ENOMEM;
4864 PERROR("strdup");
4865 }
4866 }
4867 } else if (string_match(optname, "ustconsumerd64-err-sock")) {
4868 if (!arg || *arg == '\0') {
4869 ret = -EINVAL;
4870 goto end;
4871 }
4872 if (lttng_is_setuid_setgid()) {
4873 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4874 "--ustconsumerd64-err-sock");
4875 } else {
4876 config_string_set(&config.consumerd64_err_unix_sock_path,
4877 strdup(arg));
4878 if (!config.consumerd64_err_unix_sock_path.value) {
4879 ret = -ENOMEM;
4880 PERROR("strdup");
4881 }
4882 }
4883 } else if (string_match(optname, "ustconsumerd64-cmd-sock")) {
4884 if (!arg || *arg == '\0') {
4885 ret = -EINVAL;
4886 goto end;
4887 }
4888 if (lttng_is_setuid_setgid()) {
4889 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4890 "--ustconsumerd64-cmd-sock");
4891 } else {
4892 config_string_set(&config.consumerd64_cmd_unix_sock_path,
4893 strdup(arg));
4894 if (!config.consumerd64_cmd_unix_sock_path.value) {
4895 ret = -ENOMEM;
4896 PERROR("strdup");
4897 }
4898 }
4899 } else if (string_match(optname, "ustconsumerd32-err-sock")) {
4900 if (!arg || *arg == '\0') {
4901 ret = -EINVAL;
4902 goto end;
4903 }
4904 if (lttng_is_setuid_setgid()) {
4905 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4906 "--ustconsumerd32-err-sock");
4907 } else {
4908 config_string_set(&config.consumerd32_err_unix_sock_path,
4909 strdup(arg));
4910 if (!config.consumerd32_err_unix_sock_path.value) {
4911 ret = -ENOMEM;
4912 PERROR("strdup");
4913 }
4914 }
4915 } else if (string_match(optname, "ustconsumerd32-cmd-sock")) {
4916 if (!arg || *arg == '\0') {
4917 ret = -EINVAL;
4918 goto end;
4919 }
4920 if (lttng_is_setuid_setgid()) {
4921 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4922 "--ustconsumerd32-cmd-sock");
4923 } else {
4924 config_string_set(&config.consumerd32_cmd_unix_sock_path,
4925 strdup(arg));
4926 if (!config.consumerd32_cmd_unix_sock_path.value) {
4927 ret = -ENOMEM;
4928 PERROR("strdup");
4929 }
4930 }
4931 } else if (string_match(optname, "no-kernel")) {
4932 config.no_kernel = true;
4933 } else if (string_match(optname, "quiet") || opt == 'q') {
4934 lttng_opt_quiet = true;
4935 } else if (string_match(optname, "verbose") || opt == 'v') {
4936 /* Verbose level can increase using multiple -v */
4937 if (arg) {
4938 /* Value obtained from config file */
4939 config.verbose = config_parse_value(arg);
4940 } else {
4941 /* -v used on command line */
4942 config.verbose++;
4943 }
4944 /* Clamp value to [0, 3] */
4945 config.verbose = config.verbose < 0 ? 0 :
4946 (config.verbose <= 3 ? config.verbose : 3);
4947 } else if (string_match(optname, "verbose-consumer")) {
4948 if (arg) {
4949 config.verbose_consumer = config_parse_value(arg);
4950 } else {
4951 config.verbose_consumer++;
4952 }
4953 } else if (string_match(optname, "consumerd32-path")) {
4954 if (!arg || *arg == '\0') {
4955 ret = -EINVAL;
4956 goto end;
4957 }
4958 if (lttng_is_setuid_setgid()) {
4959 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4960 "--consumerd32-path");
4961 } else {
4962 config_string_set(&config.consumerd32_bin_path,
4963 strdup(arg));
4964 if (!config.consumerd32_bin_path.value) {
4965 PERROR("strdup");
4966 ret = -ENOMEM;
4967 }
4968 }
4969 } else if (string_match(optname, "consumerd32-libdir")) {
4970 if (!arg || *arg == '\0') {
4971 ret = -EINVAL;
4972 goto end;
4973 }
4974 if (lttng_is_setuid_setgid()) {
4975 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4976 "--consumerd32-libdir");
4977 } else {
4978 config_string_set(&config.consumerd32_lib_dir,
4979 strdup(arg));
4980 if (!config.consumerd32_lib_dir.value) {
4981 PERROR("strdup");
4982 ret = -ENOMEM;
4983 }
4984 }
4985 } else if (string_match(optname, "consumerd64-path")) {
4986 if (!arg || *arg == '\0') {
4987 ret = -EINVAL;
4988 goto end;
4989 }
4990 if (lttng_is_setuid_setgid()) {
4991 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
4992 "--consumerd64-path");
4993 } else {
4994 config_string_set(&config.consumerd64_bin_path,
4995 strdup(arg));
4996 if (!config.consumerd64_bin_path.value) {
4997 PERROR("strdup");
4998 ret = -ENOMEM;
4999 }
5000 }
5001 } else if (string_match(optname, "consumerd64-libdir")) {
5002 if (!arg || *arg == '\0') {
5003 ret = -EINVAL;
5004 goto end;
5005 }
5006 if (lttng_is_setuid_setgid()) {
5007 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
5008 "--consumerd64-libdir");
5009 } else {
5010 config_string_set(&config.consumerd64_lib_dir,
5011 strdup(arg));
5012 if (!config.consumerd64_lib_dir.value) {
5013 PERROR("strdup");
5014 ret = -ENOMEM;
5015 }
5016 }
5017 } else if (string_match(optname, "pidfile") || opt == 'p') {
5018 if (!arg || *arg == '\0') {
5019 ret = -EINVAL;
5020 goto end;
5021 }
5022 if (lttng_is_setuid_setgid()) {
5023 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
5024 "-p, --pidfile");
5025 } else {
5026 config_string_set(&config.pid_file_path, strdup(arg));
5027 if (!config.pid_file_path.value) {
5028 PERROR("strdup");
5029 ret = -ENOMEM;
5030 }
5031 }
5032 } else if (string_match(optname, "agent-tcp-port")) {
5033 if (!arg || *arg == '\0') {
5034 ret = -EINVAL;
5035 goto end;
5036 }
5037 if (lttng_is_setuid_setgid()) {
5038 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
5039 "--agent-tcp-port");
5040 } else {
5041 unsigned long v;
5042
5043 errno = 0;
5044 v = strtoul(arg, NULL, 0);
5045 if (errno != 0 || !isdigit(arg[0])) {
5046 ERR("Wrong value in --agent-tcp-port parameter: %s", arg);
5047 return -1;
5048 }
5049 if (v == 0 || v >= 65535) {
5050 ERR("Port overflow in --agent-tcp-port parameter: %s", arg);
5051 return -1;
5052 }
5053 config.agent_tcp_port = (uint32_t) v;
5054 DBG3("Agent TCP port set to non default: %u", config.agent_tcp_port);
5055 }
5056 } else if (string_match(optname, "load") || opt == 'l') {
5057 if (!arg || *arg == '\0') {
5058 ret = -EINVAL;
5059 goto end;
5060 }
5061 if (lttng_is_setuid_setgid()) {
5062 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
5063 "-l, --load");
5064 } else {
5065 config_string_set(&config.load_session_path, strdup(arg));
5066 if (!config.load_session_path.value) {
5067 PERROR("strdup");
5068 ret = -ENOMEM;
5069 }
5070 }
5071 } else if (string_match(optname, "kmod-probes")) {
5072 if (!arg || *arg == '\0') {
5073 ret = -EINVAL;
5074 goto end;
5075 }
5076 if (lttng_is_setuid_setgid()) {
5077 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
5078 "--kmod-probes");
5079 } else {
5080 config_string_set(&config.kmod_probes_list, strdup(arg));
5081 if (!config.kmod_probes_list.value) {
5082 PERROR("strdup");
5083 ret = -ENOMEM;
5084 }
5085 }
5086 } else if (string_match(optname, "extra-kmod-probes")) {
5087 if (!arg || *arg == '\0') {
5088 ret = -EINVAL;
5089 goto end;
5090 }
5091 if (lttng_is_setuid_setgid()) {
5092 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
5093 "--extra-kmod-probes");
5094 } else {
5095 config_string_set(&config.kmod_extra_probes_list,
5096 strdup(arg));
5097 if (!config.kmod_extra_probes_list.value) {
5098 PERROR("strdup");
5099 ret = -ENOMEM;
5100 }
5101 }
5102 } else if (string_match(optname, "config") || opt == 'f') {
5103 /* This is handled in set_options() thus silent skip. */
5104 goto end;
5105 } else {
5106 /* Unknown option or other error.
5107 * Error is printed by getopt, just return */
5108 ret = -1;
5109 }
5110
5111 end:
5112 if (ret == -EINVAL) {
5113 const char *opt_name = "unknown";
5114 int i;
5115
5116 for (i = 0; i < sizeof(long_options) / sizeof(struct option);
5117 i++) {
5118 if (opt == long_options[i].val) {
5119 opt_name = long_options[i].name;
5120 break;
5121 }
5122 }
5123
5124 WARN("Invalid argument provided for option \"%s\", using default value.",
5125 opt_name);
5126 }
5127
5128 return ret;
5129 }
5130
5131 /*
5132 * config_entry_handler_cb used to handle options read from a config file.
5133 * See config_entry_handler_cb comment in common/config/session-config.h for the
5134 * return value conventions.
5135 */
5136 static int config_entry_handler(const struct config_entry *entry, void *unused)
5137 {
5138 int ret = 0, i;
5139
5140 if (!entry || !entry->name || !entry->value) {
5141 ret = -EINVAL;
5142 goto end;
5143 }
5144
5145 /* Check if the option is to be ignored */
5146 for (i = 0; i < sizeof(config_ignore_options) / sizeof(char *); i++) {
5147 if (!strcmp(entry->name, config_ignore_options[i])) {
5148 goto end;
5149 }
5150 }
5151
5152 for (i = 0; i < (sizeof(long_options) / sizeof(struct option)) - 1;
5153 i++) {
5154
5155 /* Ignore if not fully matched. */
5156 if (strcmp(entry->name, long_options[i].name)) {
5157 continue;
5158 }
5159
5160 /*
5161 * If the option takes no argument on the command line, we have to
5162 * check if the value is "true". We support non-zero numeric values,
5163 * true, on and yes.
5164 */
5165 if (!long_options[i].has_arg) {
5166 ret = config_parse_value(entry->value);
5167 if (ret <= 0) {
5168 if (ret) {
5169 WARN("Invalid configuration value \"%s\" for option %s",
5170 entry->value, entry->name);
5171 }
5172 /* False, skip boolean config option. */
5173 goto end;
5174 }
5175 }
5176
5177 ret = set_option(long_options[i].val, entry->value, entry->name);
5178 goto end;
5179 }
5180
5181 WARN("Unrecognized option \"%s\" in daemon configuration file.", entry->name);
5182
5183 end:
5184 return ret;
5185 }
5186
5187 /*
5188 * daemon configuration loading and argument parsing
5189 */
5190 static int set_options(int argc, char **argv)
5191 {
5192 int ret = 0, c = 0, option_index = 0;
5193 int orig_optopt = optopt, orig_optind = optind;
5194 char *optstring;
5195 const char *config_path = NULL;
5196
5197 optstring = utils_generate_optstring(long_options,
5198 sizeof(long_options) / sizeof(struct option));
5199 if (!optstring) {
5200 ret = -ENOMEM;
5201 goto end;
5202 }
5203
5204 /* Check for the --config option */
5205 while ((c = getopt_long(argc, argv, optstring, long_options,
5206 &option_index)) != -1) {
5207 if (c == '?') {
5208 ret = -EINVAL;
5209 goto end;
5210 } else if (c != 'f') {
5211 /* if not equal to --config option. */
5212 continue;
5213 }
5214
5215 if (lttng_is_setuid_setgid()) {
5216 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
5217 "-f, --config");
5218 } else {
5219 config_path = utils_expand_path(optarg);
5220 if (!config_path) {
5221 ERR("Failed to resolve path: %s", optarg);
5222 }
5223 }
5224 }
5225
5226 ret = config_get_section_entries(config_path, config_section_name,
5227 config_entry_handler, NULL);
5228 if (ret) {
5229 if (ret > 0) {
5230 ERR("Invalid configuration option at line %i", ret);
5231 ret = -1;
5232 }
5233 goto end;
5234 }
5235
5236 /* Reset getopt's global state */
5237 optopt = orig_optopt;
5238 optind = orig_optind;
5239 while (1) {
5240 option_index = -1;
5241 /*
5242 * getopt_long() will not set option_index if it encounters a
5243 * short option.
5244 */
5245 c = getopt_long(argc, argv, optstring, long_options,
5246 &option_index);
5247 if (c == -1) {
5248 break;
5249 }
5250
5251 /*
5252 * Pass NULL as the long option name if popt left the index
5253 * unset.
5254 */
5255 ret = set_option(c, optarg,
5256 option_index < 0 ? NULL :
5257 long_options[option_index].name);
5258 if (ret < 0) {
5259 break;
5260 }
5261 }
5262
5263 end:
5264 free(optstring);
5265 return ret;
5266 }
5267
5268 /*
5269 * Creates the two needed socket by the daemon.
5270 * apps_sock - The communication socket for all UST apps.
5271 * client_sock - The communication of the cli tool (lttng).
5272 */
5273 static int init_daemon_socket(void)
5274 {
5275 int ret = 0;
5276 mode_t old_umask;
5277
5278 old_umask = umask(0);
5279
5280 /* Create client tool unix socket */
5281 client_sock = lttcomm_create_unix_sock(config.client_unix_sock_path.value);
5282 if (client_sock < 0) {
5283 ERR("Create unix sock failed: %s", config.client_unix_sock_path.value);
5284 ret = -1;
5285 goto end;
5286 }
5287
5288 /* Set the cloexec flag */
5289 ret = utils_set_fd_cloexec(client_sock);
5290 if (ret < 0) {
5291 ERR("Unable to set CLOEXEC flag to the client Unix socket (fd: %d). "
5292 "Continuing but note that the consumer daemon will have a "
5293 "reference to this socket on exec()", client_sock);
5294 }
5295
5296 /* File permission MUST be 660 */
5297 ret = chmod(config.client_unix_sock_path.value, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP);
5298 if (ret < 0) {
5299 ERR("Set file permissions failed: %s", config.client_unix_sock_path.value);
5300 PERROR("chmod");
5301 goto end;
5302 }
5303
5304 /* Create the application unix socket */
5305 apps_sock = lttcomm_create_unix_sock(config.apps_unix_sock_path.value);
5306 if (apps_sock < 0) {
5307 ERR("Create unix sock failed: %s", config.apps_unix_sock_path.value);
5308 ret = -1;
5309 goto end;
5310 }
5311
5312 /* Set the cloexec flag */
5313 ret = utils_set_fd_cloexec(apps_sock);
5314 if (ret < 0) {
5315 ERR("Unable to set CLOEXEC flag to the app Unix socket (fd: %d). "
5316 "Continuing but note that the consumer daemon will have a "
5317 "reference to this socket on exec()", apps_sock);
5318 }
5319
5320 /* File permission MUST be 666 */
5321 ret = chmod(config.apps_unix_sock_path.value,
5322 S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH);
5323 if (ret < 0) {
5324 ERR("Set file permissions failed: %s", config.apps_unix_sock_path.value);
5325 PERROR("chmod");
5326 goto end;
5327 }
5328
5329 DBG3("Session daemon client socket %d and application socket %d created",
5330 client_sock, apps_sock);
5331
5332 end:
5333 umask(old_umask);
5334 return ret;
5335 }
5336
5337 /*
5338 * Check if the global socket is available, and if a daemon is answering at the
5339 * other side. If yes, error is returned.
5340 */
5341 static int check_existing_daemon(void)
5342 {
5343 /* Is there anybody out there ? */
5344 if (lttng_session_daemon_alive()) {
5345 return -EEXIST;
5346 }
5347
5348 return 0;
5349 }
5350
5351 /*
5352 * Set the tracing group gid onto the client socket.
5353 *
5354 * Race window between mkdir and chown is OK because we are going from more
5355 * permissive (root.root) to less permissive (root.tracing).
5356 */
5357 static int set_permissions(char *rundir)
5358 {
5359 int ret;
5360 gid_t gid;
5361
5362 gid = utils_get_group_id(config.tracing_group_name.value);
5363
5364 /* Set lttng run dir */
5365 ret = chown(rundir, 0, gid);
5366 if (ret < 0) {
5367 ERR("Unable to set group on %s", rundir);
5368 PERROR("chown");
5369 }
5370
5371 /*
5372 * Ensure all applications and tracing group can search the run
5373 * dir. Allow everyone to read the directory, since it does not
5374 * buy us anything to hide its content.
5375 */
5376 ret = chmod(rundir, S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH);
5377 if (ret < 0) {
5378 ERR("Unable to set permissions on %s", rundir);
5379 PERROR("chmod");
5380 }
5381
5382 /* lttng client socket path */
5383 ret = chown(config.client_unix_sock_path.value, 0, gid);
5384 if (ret < 0) {
5385 ERR("Unable to set group on %s", config.client_unix_sock_path.value);
5386 PERROR("chown");
5387 }
5388
5389 /* kconsumer error socket path */
5390 ret = chown(kconsumer_data.err_unix_sock_path, 0, 0);
5391 if (ret < 0) {
5392 ERR("Unable to set group on %s", kconsumer_data.err_unix_sock_path);
5393 PERROR("chown");
5394 }
5395
5396 /* 64-bit ustconsumer error socket path */
5397 ret = chown(ustconsumer64_data.err_unix_sock_path, 0, 0);
5398 if (ret < 0) {
5399 ERR("Unable to set group on %s", ustconsumer64_data.err_unix_sock_path);
5400 PERROR("chown");
5401 }
5402
5403 /* 32-bit ustconsumer compat32 error socket path */
5404 ret = chown(ustconsumer32_data.err_unix_sock_path, 0, 0);
5405 if (ret < 0) {
5406 ERR("Unable to set group on %s", ustconsumer32_data.err_unix_sock_path);
5407 PERROR("chown");
5408 }
5409
5410 DBG("All permissions are set");
5411
5412 return ret;
5413 }
5414
5415 /*
5416 * Create the lttng run directory needed for all global sockets and pipe.
5417 */
5418 static int create_lttng_rundir(void)
5419 {
5420 int ret;
5421
5422 DBG3("Creating LTTng run directory: %s", config.rundir.value);
5423
5424 ret = mkdir(config.rundir.value, S_IRWXU);
5425 if (ret < 0) {
5426 if (errno != EEXIST) {
5427 ERR("Unable to create %s", config.rundir.value);
5428 goto error;
5429 } else {
5430 ret = 0;
5431 }
5432 }
5433
5434 error:
5435 return ret;
5436 }
5437
5438 /*
5439 * Setup sockets and directory needed by the consumerds' communication with the
5440 * session daemon.
5441 */
5442 static int set_consumer_sockets(struct consumer_data *consumer_data)
5443 {
5444 int ret;
5445 char *path = NULL;
5446
5447 switch (consumer_data->type) {
5448 case LTTNG_CONSUMER_KERNEL:
5449 path = config.kconsumerd_path.value;
5450 break;
5451 case LTTNG_CONSUMER64_UST:
5452 path = config.consumerd64_path.value;
5453 break;
5454 case LTTNG_CONSUMER32_UST:
5455 path = config.consumerd32_path.value;
5456 break;
5457 default:
5458 ERR("Consumer type unknown");
5459 ret = -EINVAL;
5460 goto error;
5461 }
5462 assert(path);
5463
5464 DBG2("Creating consumer directory: %s", path);
5465
5466 ret = mkdir(path, S_IRWXU | S_IRGRP | S_IXGRP);
5467 if (ret < 0 && errno != EEXIST) {
5468 PERROR("mkdir");
5469 ERR("Failed to create %s", path);
5470 goto error;
5471 }
5472 if (is_root) {
5473 ret = chown(path, 0, utils_get_group_id(config.tracing_group_name.value));
5474 if (ret < 0) {
5475 ERR("Unable to set group on %s", path);
5476 PERROR("chown");
5477 goto error;
5478 }
5479 }
5480
5481 /* Create the consumerd error unix socket */
5482 consumer_data->err_sock =
5483 lttcomm_create_unix_sock(consumer_data->err_unix_sock_path);
5484 if (consumer_data->err_sock < 0) {
5485 ERR("Create unix sock failed: %s", consumer_data->err_unix_sock_path);
5486 ret = -1;
5487 goto error;
5488 }
5489
5490 /*
5491 * Set the CLOEXEC flag. Return code is useless because either way, the
5492 * show must go on.
5493 */
5494 ret = utils_set_fd_cloexec(consumer_data->err_sock);
5495 if (ret < 0) {
5496 PERROR("utils_set_fd_cloexec");
5497 /* continue anyway */
5498 }
5499
5500 /* File permission MUST be 660 */
5501 ret = chmod(consumer_data->err_unix_sock_path,
5502 S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP);
5503 if (ret < 0) {
5504 ERR("Set file permissions failed: %s", consumer_data->err_unix_sock_path);
5505 PERROR("chmod");
5506 goto error;
5507 }
5508
5509 error:
5510 return ret;
5511 }
5512
5513 /*
5514 * Signal handler for the daemon
5515 *
5516 * Simply stop all worker threads, leaving main() return gracefully after
5517 * joining all threads and calling cleanup().
5518 */
5519 static void sighandler(int sig)
5520 {
5521 switch (sig) {
5522 case SIGINT:
5523 DBG("SIGINT caught");
5524 stop_threads();
5525 break;
5526 case SIGTERM:
5527 DBG("SIGTERM caught");
5528 stop_threads();
5529 break;
5530 case SIGUSR1:
5531 CMM_STORE_SHARED(recv_child_signal, 1);
5532 break;
5533 default:
5534 break;
5535 }
5536 }
5537
5538 /*
5539 * Setup signal handler for :
5540 * SIGINT, SIGTERM, SIGPIPE
5541 */
5542 static int set_signal_handler(void)
5543 {
5544 int ret = 0;
5545 struct sigaction sa;
5546 sigset_t sigset;
5547
5548 if ((ret = sigemptyset(&sigset)) < 0) {
5549 PERROR("sigemptyset");
5550 return ret;
5551 }
5552
5553 sa.sa_mask = sigset;
5554 sa.sa_flags = 0;
5555
5556 sa.sa_handler = sighandler;
5557 if ((ret = sigaction(SIGTERM, &sa, NULL)) < 0) {
5558 PERROR("sigaction");
5559 return ret;
5560 }
5561
5562 if ((ret = sigaction(SIGINT, &sa, NULL)) < 0) {
5563 PERROR("sigaction");
5564 return ret;
5565 }
5566
5567 if ((ret = sigaction(SIGUSR1, &sa, NULL)) < 0) {
5568 PERROR("sigaction");
5569 return ret;
5570 }
5571
5572 sa.sa_handler = SIG_IGN;
5573 if ((ret = sigaction(SIGPIPE, &sa, NULL)) < 0) {
5574 PERROR("sigaction");
5575 return ret;
5576 }
5577
5578 DBG("Signal handler set for SIGTERM, SIGUSR1, SIGPIPE and SIGINT");
5579
5580 return ret;
5581 }
5582
5583 /*
5584 * Set open files limit to unlimited. This daemon can open a large number of
5585 * file descriptors in order to consume multiple kernel traces.
5586 */
5587 static void set_ulimit(void)
5588 {
5589 int ret;
5590 struct rlimit lim;
5591
5592 /* The kernel does not allow an infinite limit for open files */
5593 lim.rlim_cur = 65535;
5594 lim.rlim_max = 65535;
5595
5596 ret = setrlimit(RLIMIT_NOFILE, &lim);
5597 if (ret < 0) {
5598 PERROR("failed to set open files limit");
5599 }
5600 }
5601
5602 static int write_pidfile(void)
5603 {
5604 return utils_create_pid_file(getpid(), config.pid_file_path.value);
5605 }
5606
5607 /*
5608 * Create lockfile using the rundir and return its fd.
5609 */
5610 static int create_lockfile(void)
5611 {
5612 return utils_create_lock_file(config.lock_file_path.value);
5613 }
5614
5615 /*
5616 * Write agent TCP port using the rundir.
5617 */
5618 static int write_agent_port(void)
5619 {
5620 return utils_create_pid_file(config.agent_tcp_port,
5621 config.agent_port_file_path.value);
5622 }
5623
5624 static int set_clock_plugin_env(void)
5625 {
5626 int ret = 0;
5627 char *env_value = NULL;
5628
5629 if (!config.lttng_ust_clock_plugin.value) {
5630 goto end;
5631 }
5632
5633 ret = asprintf(&env_value, "LTTNG_UST_CLOCK_PLUGIN=%s",
5634 config.lttng_ust_clock_plugin.value);
5635 if (ret < 0) {
5636 PERROR("asprintf");
5637 goto end;
5638 }
5639
5640 ret = putenv(env_value);
5641 if (ret) {
5642 free(env_value);
5643 PERROR("putenv of LTTNG_UST_CLOCK_PLUGIN");
5644 goto end;
5645 }
5646
5647 DBG("Updated LTTNG_UST_CLOCK_PLUGIN environment variable to \"%s\"",
5648 config.lttng_ust_clock_plugin.value);
5649 end:
5650 return ret;
5651 }
5652
5653 static
5654 struct rotation_thread_timer_queue *create_rotate_timer_queue(void)
5655 {
5656 struct rotation_thread_timer_queue *queue = NULL;
5657
5658 queue = zmalloc(sizeof(struct rotation_thread_timer_queue));
5659 if (!queue) {
5660 PERROR("Failed to allocate timer rotate queue");
5661 goto end;
5662 }
5663
5664 queue->event_pipe = lttng_pipe_open(FD_CLOEXEC | O_NONBLOCK);
5665 CDS_INIT_LIST_HEAD(&queue->list);
5666 pthread_mutex_init(&queue->lock, NULL);
5667
5668 end:
5669 return queue;
5670 }
5671
5672 static
5673 void destroy_rotate_timer_queue(struct rotation_thread_timer_queue *queue)
5674 {
5675 struct sessiond_rotation_timer *node, *tmp_node;
5676
5677 if (!queue) {
5678 return;
5679 }
5680
5681 lttng_pipe_destroy(queue->event_pipe);
5682
5683 pthread_mutex_lock(&queue->lock);
5684 /* Empty wait queue. */
5685 cds_list_for_each_entry_safe(node, tmp_node, &queue->list, head) {
5686 cds_list_del(&node->head);
5687 free(node);
5688 }
5689 pthread_mutex_unlock(&queue->lock);
5690
5691 pthread_mutex_destroy(&queue->lock);
5692 free(queue);
5693 }
5694
5695 /*
5696 * main
5697 */
5698 int main(int argc, char **argv)
5699 {
5700 int ret = 0, retval = 0;
5701 void *status;
5702 const char *env_app_timeout;
5703 struct lttng_pipe *ust32_channel_monitor_pipe = NULL,
5704 *ust64_channel_monitor_pipe = NULL,
5705 *kernel_channel_monitor_pipe = NULL;
5706 bool notification_thread_running = false;
5707 bool rotation_thread_running = false;
5708 bool timer_thread_running = false;
5709 struct lttng_pipe *ust32_channel_rotate_pipe = NULL,
5710 *ust64_channel_rotate_pipe = NULL,
5711 *kernel_channel_rotate_pipe = NULL;
5712 struct timer_thread_parameters timer_thread_ctx;
5713 /* Queue of rotation jobs populated by the sessiond-timer. */
5714 struct rotation_thread_timer_queue *rotation_timer_queue = NULL;
5715 sem_t notification_thread_ready;
5716
5717 init_kernel_workarounds();
5718
5719 rcu_register_thread();
5720
5721 if (set_signal_handler()) {
5722 retval = -1;
5723 goto exit_set_signal_handler;
5724 }
5725
5726 if (sessiond_timer_signal_init()) {
5727 retval = -1;
5728 goto exit_set_signal_handler;
5729 }
5730
5731 page_size = sysconf(_SC_PAGESIZE);
5732 if (page_size < 0) {
5733 PERROR("sysconf _SC_PAGESIZE");
5734 page_size = LONG_MAX;
5735 WARN("Fallback page size to %ld", page_size);
5736 }
5737
5738 ret = sessiond_config_init(&config);
5739 if (ret) {
5740 retval = -1;
5741 goto exit_set_signal_handler;
5742 }
5743
5744 /*
5745 * Parse arguments and load the daemon configuration file.
5746 *
5747 * We have an exit_options exit path to free memory reserved by
5748 * set_options. This is needed because the rest of sessiond_cleanup()
5749 * depends on ht_cleanup_thread, which depends on lttng_daemonize, which
5750 * depends on set_options.
5751 */
5752 progname = argv[0];
5753 if (set_options(argc, argv)) {
5754 retval = -1;
5755 goto exit_options;
5756 }
5757
5758 /* Init config from environment variables. */
5759 sessiond_config_apply_env_config(&config);
5760
5761 /*
5762 * Resolve all paths received as arguments, configuration option, or
5763 * through environment variable as absolute paths. This is necessary
5764 * since daemonizing causes the sessiond's current working directory
5765 * to '/'.
5766 */
5767 ret = sessiond_config_resolve_paths(&config);
5768 if (ret) {
5769 goto exit_options;
5770 }
5771
5772 /* Apply config. */
5773 lttng_opt_verbose = config.verbose;
5774 lttng_opt_quiet = config.quiet;
5775 kconsumer_data.err_unix_sock_path =
5776 config.kconsumerd_err_unix_sock_path.value;
5777 kconsumer_data.cmd_unix_sock_path =
5778 config.kconsumerd_cmd_unix_sock_path.value;
5779 ustconsumer32_data.err_unix_sock_path =
5780 config.consumerd32_err_unix_sock_path.value;
5781 ustconsumer32_data.cmd_unix_sock_path =
5782 config.consumerd32_cmd_unix_sock_path.value;
5783 ustconsumer64_data.err_unix_sock_path =
5784 config.consumerd64_err_unix_sock_path.value;
5785 ustconsumer64_data.cmd_unix_sock_path =
5786 config.consumerd64_cmd_unix_sock_path.value;
5787 set_clock_plugin_env();
5788
5789 sessiond_config_log(&config);
5790
5791 /* Daemonize */
5792 if (config.daemonize || config.background) {
5793 int i;
5794
5795 ret = lttng_daemonize(&child_ppid, &recv_child_signal,
5796 !config.background);
5797 if (ret < 0) {
5798 retval = -1;
5799 goto exit_options;
5800 }
5801
5802 /*
5803 * We are in the child. Make sure all other file descriptors are
5804 * closed, in case we are called with more opened file
5805 * descriptors than the standard ones.
5806 */
5807 for (i = 3; i < sysconf(_SC_OPEN_MAX); i++) {
5808 (void) close(i);
5809 }
5810 }
5811
5812 if (run_as_create_worker(argv[0]) < 0) {
5813 goto exit_create_run_as_worker_cleanup;
5814 }
5815
5816 /*
5817 * Starting from here, we can create threads. This needs to be after
5818 * lttng_daemonize due to RCU.
5819 */
5820
5821 /*
5822 * Initialize the health check subsystem. This call should set the
5823 * appropriate time values.
5824 */
5825 health_sessiond = health_app_create(NR_HEALTH_SESSIOND_TYPES);
5826 if (!health_sessiond) {
5827 PERROR("health_app_create error");
5828 retval = -1;
5829 goto exit_health_sessiond_cleanup;
5830 }
5831
5832 /* Create thread to clean up RCU hash tables */
5833 if (init_ht_cleanup_thread(&ht_cleanup_thread)) {
5834 retval = -1;
5835 goto exit_ht_cleanup;
5836 }
5837
5838 /* Create thread quit pipe */
5839 if (init_thread_quit_pipe()) {
5840 retval = -1;
5841 goto exit_init_data;
5842 }
5843
5844 /* Check if daemon is UID = 0 */
5845 is_root = !getuid();
5846
5847 if (create_lttng_rundir()) {
5848 retval = -1;
5849 goto exit_init_data;
5850 }
5851
5852 if (is_root) {
5853 /* Create global run dir with root access */
5854
5855 kernel_channel_monitor_pipe = lttng_pipe_open(0);
5856 if (!kernel_channel_monitor_pipe) {
5857 ERR("Failed to create kernel consumer channel monitor pipe");
5858 retval = -1;
5859 goto exit_init_data;
5860 }
5861 kconsumer_data.channel_monitor_pipe =
5862 lttng_pipe_release_writefd(
5863 kernel_channel_monitor_pipe);
5864 if (kconsumer_data.channel_monitor_pipe < 0) {
5865 retval = -1;
5866 goto exit_init_data;
5867 }
5868 kernel_channel_rotate_pipe = lttng_pipe_open(0);
5869 if (!kernel_channel_rotate_pipe) {
5870 ERR("Failed to create kernel consumer channel rotate pipe");
5871 retval = -1;
5872 goto exit_init_data;
5873 }
5874 kconsumer_data.channel_rotate_pipe =
5875 lttng_pipe_release_writefd(
5876 kernel_channel_rotate_pipe);
5877 if (kconsumer_data.channel_rotate_pipe < 0) {
5878 retval = -1;
5879 goto exit_init_data;
5880 }
5881 }
5882
5883 lockfile_fd = create_lockfile();
5884 if (lockfile_fd < 0) {
5885 retval = -1;
5886 goto exit_init_data;
5887 }
5888
5889 /* Set consumer initial state */
5890 kernel_consumerd_state = CONSUMER_STOPPED;
5891 ust_consumerd_state = CONSUMER_STOPPED;
5892
5893 ust32_channel_monitor_pipe = lttng_pipe_open(0);
5894 if (!ust32_channel_monitor_pipe) {
5895 ERR("Failed to create 32-bit user space consumer channel monitor pipe");
5896 retval = -1;
5897 goto exit_init_data;
5898 }
5899 ustconsumer32_data.channel_monitor_pipe = lttng_pipe_release_writefd(
5900 ust32_channel_monitor_pipe);
5901 if (ustconsumer32_data.channel_monitor_pipe < 0) {
5902 retval = -1;
5903 goto exit_init_data;
5904 }
5905 ust32_channel_rotate_pipe = lttng_pipe_open(0);
5906 if (!ust32_channel_rotate_pipe) {
5907 ERR("Failed to create 32-bit user space consumer channel rotate pipe");
5908 retval = -1;
5909 goto exit_init_data;
5910 }
5911 ustconsumer32_data.channel_rotate_pipe = lttng_pipe_release_writefd(
5912 ust32_channel_rotate_pipe);
5913 if (ustconsumer32_data.channel_rotate_pipe < 0) {
5914 retval = -1;
5915 goto exit_init_data;
5916 }
5917
5918 /*
5919 * The rotation_timer_queue structure is shared between the sessiond timer
5920 * thread and the rotation thread. The main() keeps the ownership and
5921 * destroys it when both threads have quit.
5922 */
5923 rotation_timer_queue = create_rotate_timer_queue();
5924 if (!rotation_timer_queue) {
5925 retval = -1;
5926 goto exit_init_data;
5927 }
5928 timer_thread_ctx.rotation_timer_queue = rotation_timer_queue;
5929
5930 ust64_channel_monitor_pipe = lttng_pipe_open(0);
5931 if (!ust64_channel_monitor_pipe) {
5932 ERR("Failed to create 64-bit user space consumer channel monitor pipe");
5933 retval = -1;
5934 goto exit_init_data;
5935 }
5936 ustconsumer64_data.channel_monitor_pipe = lttng_pipe_release_writefd(
5937 ust64_channel_monitor_pipe);
5938 if (ustconsumer64_data.channel_monitor_pipe < 0) {
5939 retval = -1;
5940 goto exit_init_data;
5941 }
5942 ust64_channel_rotate_pipe = lttng_pipe_open(0);
5943 if (!ust64_channel_rotate_pipe) {
5944 ERR("Failed to create 64-bit user space consumer channel rotate pipe");
5945 retval = -1;
5946 goto exit_init_data;
5947 }
5948 ustconsumer64_data.channel_rotate_pipe = lttng_pipe_release_writefd(
5949 ust64_channel_rotate_pipe);
5950 if (ustconsumer64_data.channel_rotate_pipe < 0) {
5951 retval = -1;
5952 goto exit_init_data;
5953 }
5954
5955 /*
5956 * See if daemon already exist.
5957 */
5958 if (check_existing_daemon()) {
5959 ERR("Already running daemon.\n");
5960 /*
5961 * We do not goto exit because we must not cleanup()
5962 * because a daemon is already running.
5963 */
5964 retval = -1;
5965 goto exit_init_data;
5966 }
5967
5968 /*
5969 * Init UST app hash table. Alloc hash table before this point since
5970 * cleanup() can get called after that point.
5971 */
5972 if (ust_app_ht_alloc()) {
5973 ERR("Failed to allocate UST app hash table");
5974 retval = -1;
5975 goto exit_init_data;
5976 }
5977
5978 /*
5979 * Initialize agent app hash table. We allocate the hash table here
5980 * since cleanup() can get called after this point.
5981 */
5982 if (agent_app_ht_alloc()) {
5983 ERR("Failed to allocate Agent app hash table");
5984 retval = -1;
5985 goto exit_init_data;
5986 }
5987
5988 /*
5989 * These actions must be executed as root. We do that *after* setting up
5990 * the sockets path because we MUST make the check for another daemon using
5991 * those paths *before* trying to set the kernel consumer sockets and init
5992 * kernel tracer.
5993 */
5994 if (is_root) {
5995 if (set_consumer_sockets(&kconsumer_data)) {
5996 retval = -1;
5997 goto exit_init_data;
5998 }
5999
6000 /* Setup kernel tracer */
6001 if (!config.no_kernel) {
6002 init_kernel_tracer();
6003 if (kernel_tracer_fd >= 0) {
6004 ret = syscall_init_table();
6005 if (ret < 0) {
6006 ERR("Unable to populate syscall table. "
6007 "Syscall tracing won't work "
6008 "for this session daemon.");
6009 }
6010 }
6011 }
6012
6013 /* Set ulimit for open files */
6014 set_ulimit();
6015 }
6016 /* init lttng_fd tracking must be done after set_ulimit. */
6017 lttng_fd_init();
6018
6019 if (set_consumer_sockets(&ustconsumer64_data)) {
6020 retval = -1;
6021 goto exit_init_data;
6022 }
6023
6024 if (set_consumer_sockets(&ustconsumer32_data)) {
6025 retval = -1;
6026 goto exit_init_data;
6027 }
6028
6029 /* Setup the needed unix socket */
6030 if (init_daemon_socket()) {
6031 retval = -1;
6032 goto exit_init_data;
6033 }
6034
6035 /* Set credentials to socket */
6036 if (is_root && set_permissions(config.rundir.value)) {
6037 retval = -1;
6038 goto exit_init_data;
6039 }
6040
6041 /* Get parent pid if -S, --sig-parent is specified. */
6042 if (config.sig_parent) {
6043 ppid = getppid();
6044 }
6045
6046 /* Setup the kernel pipe for waking up the kernel thread */
6047 if (is_root && !config.no_kernel) {
6048 if (utils_create_pipe_cloexec(kernel_poll_pipe)) {
6049 retval = -1;
6050 goto exit_init_data;
6051 }
6052 }
6053
6054 /* Setup the thread apps communication pipe. */
6055 if (utils_create_pipe_cloexec(apps_cmd_pipe)) {
6056 retval = -1;
6057 goto exit_init_data;
6058 }
6059
6060 /* Setup the thread apps notify communication pipe. */
6061 if (utils_create_pipe_cloexec(apps_cmd_notify_pipe)) {
6062 retval = -1;
6063 goto exit_init_data;
6064 }
6065
6066 /* Initialize global buffer per UID and PID registry. */
6067 buffer_reg_init_uid_registry();
6068 buffer_reg_init_pid_registry();
6069
6070 /* Init UST command queue. */
6071 cds_wfcq_init(&ust_cmd_queue.head, &ust_cmd_queue.tail);
6072
6073 /*
6074 * Get session list pointer. This pointer MUST NOT be free'd. This list
6075 * is statically declared in session.c
6076 */
6077 session_list_ptr = session_get_list();
6078
6079 cmd_init();
6080
6081 /* Check for the application socket timeout env variable. */
6082 env_app_timeout = getenv(DEFAULT_APP_SOCKET_TIMEOUT_ENV);
6083 if (env_app_timeout) {
6084 config.app_socket_timeout = atoi(env_app_timeout);
6085 } else {
6086 config.app_socket_timeout = DEFAULT_APP_SOCKET_RW_TIMEOUT;
6087 }
6088
6089 ret = write_pidfile();
6090 if (ret) {
6091 ERR("Error in write_pidfile");
6092 retval = -1;
6093 goto exit_init_data;
6094 }
6095 ret = write_agent_port();
6096 if (ret) {
6097 ERR("Error in write_agent_port");
6098 retval = -1;
6099 goto exit_init_data;
6100 }
6101
6102 /* Initialize communication library */
6103 lttcomm_init();
6104 /* Initialize TCP timeout values */
6105 lttcomm_inet_init();
6106
6107 if (load_session_init_data(&load_info) < 0) {
6108 retval = -1;
6109 goto exit_init_data;
6110 }
6111 load_info->path = config.load_session_path.value;
6112
6113 /* Create health-check thread. */
6114 ret = pthread_create(&health_thread, default_pthread_attr(),
6115 thread_manage_health, (void *) NULL);
6116 if (ret) {
6117 errno = ret;
6118 PERROR("pthread_create health");
6119 retval = -1;
6120 goto exit_health;
6121 }
6122
6123 /*
6124 * The rotation thread needs the notification thread to be ready before
6125 * creating the rotate_notification_channel, so we use this semaphore as
6126 * a rendez-vous point.
6127 */
6128 sem_init(&notification_thread_ready, 0, 0);
6129
6130 /* notification_thread_data acquires the pipes' read side. */
6131 notification_thread_handle = notification_thread_handle_create(
6132 ust32_channel_monitor_pipe,
6133 ust64_channel_monitor_pipe,
6134 kernel_channel_monitor_pipe,
6135 &notification_thread_ready);
6136 if (!notification_thread_handle) {
6137 retval = -1;
6138 ERR("Failed to create notification thread shared data");
6139 stop_threads();
6140 goto exit_notification;
6141 }
6142
6143 /* Create notification thread. */
6144 ret = pthread_create(&notification_thread, default_pthread_attr(),
6145 thread_notification, notification_thread_handle);
6146 if (ret) {
6147 errno = ret;
6148 PERROR("pthread_create notification");
6149 retval = -1;
6150 stop_threads();
6151 goto exit_notification;
6152 }
6153 notification_thread_running = true;
6154
6155 /* Create timer thread. */
6156 ret = pthread_create(&timer_thread, default_pthread_attr(),
6157 sessiond_timer_thread, &timer_thread_ctx);
6158 if (ret) {
6159 errno = ret;
6160 PERROR("pthread_create timer");
6161 retval = -1;
6162 stop_threads();
6163 goto exit_notification;
6164 }
6165 timer_thread_running = true;
6166
6167 /* rotation_thread_data acquires the pipes' read side. */
6168 rotation_thread_handle = rotation_thread_handle_create(
6169 ust32_channel_rotate_pipe,
6170 ust64_channel_rotate_pipe,
6171 kernel_channel_rotate_pipe,
6172 thread_quit_pipe[0],
6173 rotation_timer_queue,
6174 notification_thread_handle,
6175 &notification_thread_ready);
6176 if (!rotation_thread_handle) {
6177 retval = -1;
6178 ERR("Failed to create rotation thread shared data");
6179 stop_threads();
6180 goto exit_rotation;
6181 }
6182
6183 /* Create rotation thread. */
6184 ret = pthread_create(&rotation_thread, default_pthread_attr(),
6185 thread_rotation, rotation_thread_handle);
6186 if (ret) {
6187 errno = ret;
6188 PERROR("pthread_create rotation");
6189 retval = -1;
6190 stop_threads();
6191 goto exit_rotation;
6192 }
6193 rotation_thread_running = true;
6194
6195 /* Create thread to manage the client socket */
6196 ret = pthread_create(&client_thread, default_pthread_attr(),
6197 thread_manage_clients, (void *) NULL);
6198 if (ret) {
6199 errno = ret;
6200 PERROR("pthread_create clients");
6201 retval = -1;
6202 stop_threads();
6203 goto exit_client;
6204 }
6205
6206 /* Create thread to dispatch registration */
6207 ret = pthread_create(&dispatch_thread, default_pthread_attr(),
6208 thread_dispatch_ust_registration, (void *) NULL);
6209 if (ret) {
6210 errno = ret;
6211 PERROR("pthread_create dispatch");
6212 retval = -1;
6213 stop_threads();
6214 goto exit_dispatch;
6215 }
6216
6217 /* Create thread to manage application registration. */
6218 ret = pthread_create(&reg_apps_thread, default_pthread_attr(),
6219 thread_registration_apps, (void *) NULL);
6220 if (ret) {
6221 errno = ret;
6222 PERROR("pthread_create registration");
6223 retval = -1;
6224 stop_threads();
6225 goto exit_reg_apps;
6226 }
6227
6228 /* Create thread to manage application socket */
6229 ret = pthread_create(&apps_thread, default_pthread_attr(),
6230 thread_manage_apps, (void *) NULL);
6231 if (ret) {
6232 errno = ret;
6233 PERROR("pthread_create apps");
6234 retval = -1;
6235 stop_threads();
6236 goto exit_apps;
6237 }
6238
6239 /* Create thread to manage application notify socket */
6240 ret = pthread_create(&apps_notify_thread, default_pthread_attr(),
6241 ust_thread_manage_notify, (void *) NULL);
6242 if (ret) {
6243 errno = ret;
6244 PERROR("pthread_create notify");
6245 retval = -1;
6246 stop_threads();
6247 goto exit_apps_notify;
6248 }
6249
6250 /* Create agent registration thread. */
6251 ret = pthread_create(&agent_reg_thread, default_pthread_attr(),
6252 agent_thread_manage_registration, (void *) NULL);
6253 if (ret) {
6254 errno = ret;
6255 PERROR("pthread_create agent");
6256 retval = -1;
6257 stop_threads();
6258 goto exit_agent_reg;
6259 }
6260
6261 /* Don't start this thread if kernel tracing is not requested nor root */
6262 if (is_root && !config.no_kernel) {
6263 /* Create kernel thread to manage kernel event */
6264 ret = pthread_create(&kernel_thread, default_pthread_attr(),
6265 thread_manage_kernel, (void *) NULL);
6266 if (ret) {
6267 errno = ret;
6268 PERROR("pthread_create kernel");
6269 retval = -1;
6270 stop_threads();
6271 goto exit_kernel;
6272 }
6273 }
6274
6275 /* Create session loading thread. */
6276 ret = pthread_create(&load_session_thread, default_pthread_attr(),
6277 thread_load_session, load_info);
6278 if (ret) {
6279 errno = ret;
6280 PERROR("pthread_create load_session_thread");
6281 retval = -1;
6282 stop_threads();
6283 goto exit_load_session;
6284 }
6285
6286 /*
6287 * This is where we start awaiting program completion (e.g. through
6288 * signal that asks threads to teardown).
6289 */
6290
6291 ret = pthread_join(load_session_thread, &status);
6292 if (ret) {
6293 errno = ret;
6294 PERROR("pthread_join load_session_thread");
6295 retval = -1;
6296 }
6297 exit_load_session:
6298
6299 if (is_root && !config.no_kernel) {
6300 ret = pthread_join(kernel_thread, &status);
6301 if (ret) {
6302 errno = ret;
6303 PERROR("pthread_join");
6304 retval = -1;
6305 }
6306 }
6307 exit_kernel:
6308
6309 ret = pthread_join(agent_reg_thread, &status);
6310 if (ret) {
6311 errno = ret;
6312 PERROR("pthread_join agent");
6313 retval = -1;
6314 }
6315 exit_agent_reg:
6316
6317 ret = pthread_join(apps_notify_thread, &status);
6318 if (ret) {
6319 errno = ret;
6320 PERROR("pthread_join apps notify");
6321 retval = -1;
6322 }
6323 exit_apps_notify:
6324
6325 ret = pthread_join(apps_thread, &status);
6326 if (ret) {
6327 errno = ret;
6328 PERROR("pthread_join apps");
6329 retval = -1;
6330 }
6331 exit_apps:
6332
6333 ret = pthread_join(reg_apps_thread, &status);
6334 if (ret) {
6335 errno = ret;
6336 PERROR("pthread_join");
6337 retval = -1;
6338 }
6339 exit_reg_apps:
6340
6341 /*
6342 * Join dispatch thread after joining reg_apps_thread to ensure
6343 * we don't leak applications in the queue.
6344 */
6345 ret = pthread_join(dispatch_thread, &status);
6346 if (ret) {
6347 errno = ret;
6348 PERROR("pthread_join");
6349 retval = -1;
6350 }
6351 exit_dispatch:
6352
6353 ret = pthread_join(client_thread, &status);
6354 if (ret) {
6355 errno = ret;
6356 PERROR("pthread_join");
6357 retval = -1;
6358 }
6359
6360 exit_client:
6361 exit_rotation:
6362 exit_notification:
6363 sem_destroy(&notification_thread_ready);
6364 ret = pthread_join(health_thread, &status);
6365 if (ret) {
6366 errno = ret;
6367 PERROR("pthread_join health thread");
6368 retval = -1;
6369 }
6370
6371 exit_health:
6372 exit_init_data:
6373 /*
6374 * Wait for all pending call_rcu work to complete before tearing
6375 * down data structures. call_rcu worker may be trying to
6376 * perform lookups in those structures.
6377 */
6378 rcu_barrier();
6379 /*
6380 * sessiond_cleanup() is called when no other thread is running, except
6381 * the ht_cleanup thread, which is needed to destroy the hash tables.
6382 */
6383 rcu_thread_online();
6384 sessiond_cleanup();
6385
6386 /*
6387 * Ensure all prior call_rcu are done. call_rcu callbacks may push
6388 * hash tables to the ht_cleanup thread. Therefore, we ensure that
6389 * the queue is empty before shutting down the clean-up thread.
6390 */
6391 rcu_barrier();
6392
6393 /*
6394 * The teardown of the notification system is performed after the
6395 * session daemon's teardown in order to allow it to be notified
6396 * of the active session and channels at the moment of the teardown.
6397 */
6398 if (notification_thread_handle) {
6399 if (notification_thread_running) {
6400 notification_thread_command_quit(
6401 notification_thread_handle);
6402 ret = pthread_join(notification_thread, &status);
6403 if (ret) {
6404 errno = ret;
6405 PERROR("pthread_join notification thread");
6406 retval = -1;
6407 }
6408 }
6409 notification_thread_handle_destroy(notification_thread_handle);
6410 }
6411
6412 if (rotation_thread_handle) {
6413 if (rotation_thread_running) {
6414 ret = pthread_join(rotation_thread, &status);
6415 if (ret) {
6416 errno = ret;
6417 PERROR("pthread_join rotation thread");
6418 retval = -1;
6419 }
6420 }
6421 rotation_thread_handle_destroy(rotation_thread_handle);
6422 }
6423
6424 if (timer_thread_running) {
6425 kill(getpid(), LTTNG_SESSIOND_SIG_EXIT);
6426 ret = pthread_join(timer_thread, &status);
6427 if (ret) {
6428 errno = ret;
6429 PERROR("pthread_join timer thread");
6430 retval = -1;
6431 }
6432 }
6433
6434 /*
6435 * After the rotation and timer thread have quit, we can safely destroy
6436 * the rotation_timer_queue.
6437 */
6438 destroy_rotate_timer_queue(rotation_timer_queue);
6439
6440 rcu_thread_offline();
6441 rcu_unregister_thread();
6442
6443 ret = fini_ht_cleanup_thread(&ht_cleanup_thread);
6444 if (ret) {
6445 retval = -1;
6446 }
6447 lttng_pipe_destroy(ust32_channel_monitor_pipe);
6448 lttng_pipe_destroy(ust64_channel_monitor_pipe);
6449 lttng_pipe_destroy(kernel_channel_monitor_pipe);
6450 lttng_pipe_destroy(ust32_channel_rotate_pipe);
6451 lttng_pipe_destroy(ust64_channel_rotate_pipe);
6452 lttng_pipe_destroy(kernel_channel_rotate_pipe);
6453 exit_ht_cleanup:
6454
6455 health_app_destroy(health_sessiond);
6456 exit_health_sessiond_cleanup:
6457 exit_create_run_as_worker_cleanup:
6458
6459 exit_options:
6460 sessiond_cleanup_options();
6461
6462 exit_set_signal_handler:
6463 if (!retval) {
6464 exit(EXIT_SUCCESS);
6465 } else {
6466 exit(EXIT_FAILURE);
6467 }
6468 }
This page took 0.205975 seconds and 5 git commands to generate.