Merge branch 'master' into benchmark
[lttng-tools.git] / ltt-sessiond / main.c
1 /*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the Free
7 * Software Foundation; only version 2 of the License.
8 *
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
12 * more details.
13 *
14 * You should have received a copy of the GNU General Public License along with
15 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
16 * Place - Suite 330, Boston, MA 02111-1307, USA.
17 */
18
19 #define _GNU_SOURCE
20 #include <fcntl.h>
21 #include <getopt.h>
22 #include <grp.h>
23 #include <limits.h>
24 #include <pthread.h>
25 #include <semaphore.h>
26 #include <signal.h>
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <string.h>
30 #include <sys/mman.h>
31 #include <sys/mount.h>
32 #include <sys/resource.h>
33 #include <sys/socket.h>
34 #include <sys/stat.h>
35 #include <sys/types.h>
36 #include <sys/wait.h>
37 #include <urcu/futex.h>
38 #include <unistd.h>
39
40 #include <ltt-kconsumerd.h>
41 #include <lttng-sessiond-comm.h>
42 #include <lttng/lttng-kconsumerd.h>
43 #include <lttngerr.h>
44
45 #include "channel.h"
46 #include "compat/poll.h"
47 #include "context.h"
48 #include "event.h"
49 #include "futex.h"
50 #include "kernel-ctl.h"
51 #include "ltt-sessiond.h"
52 #include "shm.h"
53 #include "ust-app.h"
54 #include "ust-ctl.h"
55 #include "utils.h"
56 #include "ust-ctl.h"
57
58 #include "benchmark.h"
59
60 /* Const values */
61 const char default_home_dir[] = DEFAULT_HOME_DIR;
62 const char default_tracing_group[] = LTTNG_DEFAULT_TRACING_GROUP;
63 const char default_ust_sock_dir[] = DEFAULT_UST_SOCK_DIR;
64 const char default_global_apps_pipe[] = DEFAULT_GLOBAL_APPS_PIPE;
65
66 /* Variables */
67 int opt_verbose; /* Not static for lttngerr.h */
68 int opt_verbose_kconsumerd; /* Not static for lttngerr.h */
69 int opt_quiet; /* Not static for lttngerr.h */
70
71 const char *progname;
72 const char *opt_tracing_group;
73 static int opt_sig_parent;
74 static int opt_daemon;
75 static int is_root; /* Set to 1 if the daemon is running as root */
76 static pid_t ppid; /* Parent PID for --sig-parent option */
77 static pid_t kconsumerd_pid;
78 static int dispatch_thread_exit;
79
80 /* Global application Unix socket path */
81 static char apps_unix_sock_path[PATH_MAX];
82 /* Global client Unix socket path */
83 static char client_unix_sock_path[PATH_MAX];
84 /* kconsumerd error and command Unix socket path */
85 static char kconsumerd_err_unix_sock_path[PATH_MAX];
86 static char kconsumerd_cmd_unix_sock_path[PATH_MAX];
87 /* global wait shm path for UST */
88 static char wait_shm_path[PATH_MAX];
89
90 /* Sockets and FDs */
91 static int client_sock;
92 static int apps_sock;
93 static int kconsumerd_err_sock;
94 static int kconsumerd_cmd_sock;
95 static int kernel_tracer_fd;
96 static int kernel_poll_pipe[2];
97
98 /*
99 * Quit pipe for all threads. This permits a single cancellation point
100 * for all threads when receiving an event on the pipe.
101 */
102 static int thread_quit_pipe[2];
103
104 /*
105 * This pipe is used to inform the thread managing application communication
106 * that a command is queued and ready to be processed.
107 */
108 static int apps_cmd_pipe[2];
109
110 /* Pthread, Mutexes and Semaphores */
111 static pthread_t kconsumerd_thread;
112 static pthread_t apps_thread;
113 static pthread_t reg_apps_thread;
114 static pthread_t client_thread;
115 static pthread_t kernel_thread;
116 static pthread_t dispatch_thread;
117 static sem_t kconsumerd_sem;
118
119
120 /* Mutex to control kconsumerd pid assignation */
121 static pthread_mutex_t kconsumerd_pid_mutex;
122
123 /*
124 * UST registration command queue. This queue is tied with a futex and uses a N
125 * wakers / 1 waiter implemented and detailed in futex.c/.h
126 *
127 * The thread_manage_apps and thread_dispatch_ust_registration interact with
128 * this queue and the wait/wake scheme.
129 */
130 static struct ust_cmd_queue ust_cmd_queue;
131
132 /*
133 * Pointer initialized before thread creation.
134 *
135 * This points to the tracing session list containing the session count and a
136 * mutex lock. The lock MUST be taken if you iterate over the list. The lock
137 * MUST NOT be taken if you call a public function in session.c.
138 *
139 * The lock is nested inside the structure: session_list_ptr->lock. Please use
140 * session_lock_list and session_unlock_list for lock acquisition.
141 */
142 static struct ltt_session_list *session_list_ptr;
143
144 /*
145 * Create a poll set with O_CLOEXEC and add the thread quit pipe to the set.
146 */
147 static int create_thread_poll_set(struct lttng_poll_event *events,
148 unsigned int size)
149 {
150 int ret;
151
152 if (events == NULL || size == 0) {
153 ret = -1;
154 goto error;
155 }
156
157 ret = lttng_poll_create(events, size, LTTNG_CLOEXEC);
158 if (ret < 0) {
159 goto error;
160 }
161
162 /* Add quit pipe */
163 ret = lttng_poll_add(events, thread_quit_pipe[0], LPOLLIN);
164 if (ret < 0) {
165 goto error;
166 }
167
168 return 0;
169
170 error:
171 return ret;
172 }
173
174 /*
175 * Check if the thread quit pipe was triggered.
176 *
177 * Return 1 if it was triggered else 0;
178 */
179 static int check_thread_quit_pipe(int fd, uint32_t events)
180 {
181 if (fd == thread_quit_pipe[0] && (events & LPOLLIN)) {
182 return 1;
183 }
184
185 return 0;
186 }
187
188 /*
189 * Remove modules in reverse load order.
190 */
191 static int modprobe_remove_kernel_modules(void)
192 {
193 int ret = 0, i;
194 char modprobe[256];
195
196 for (i = ARRAY_SIZE(kernel_modules_list) - 1; i >= 0; i--) {
197 ret = snprintf(modprobe, sizeof(modprobe),
198 "/sbin/modprobe --remove --quiet %s",
199 kernel_modules_list[i].name);
200 if (ret < 0) {
201 perror("snprintf modprobe --remove");
202 goto error;
203 }
204 modprobe[sizeof(modprobe) - 1] = '\0';
205 ret = system(modprobe);
206 if (ret == -1) {
207 ERR("Unable to launch modprobe --remove for module %s",
208 kernel_modules_list[i].name);
209 } else if (kernel_modules_list[i].required
210 && WEXITSTATUS(ret) != 0) {
211 ERR("Unable to remove module %s",
212 kernel_modules_list[i].name);
213 } else {
214 DBG("Modprobe removal successful %s",
215 kernel_modules_list[i].name);
216 }
217 }
218
219 error:
220 return ret;
221 }
222
223 /*
224 * Return group ID of the tracing group or -1 if not found.
225 */
226 static gid_t allowed_group(void)
227 {
228 struct group *grp;
229
230 if (opt_tracing_group) {
231 grp = getgrnam(opt_tracing_group);
232 } else {
233 grp = getgrnam(default_tracing_group);
234 }
235 if (!grp) {
236 return -1;
237 } else {
238 return grp->gr_gid;
239 }
240 }
241
242 /*
243 * Init thread quit pipe.
244 *
245 * Return -1 on error or 0 if all pipes are created.
246 */
247 static int init_thread_quit_pipe(void)
248 {
249 int ret;
250
251 ret = pipe2(thread_quit_pipe, O_CLOEXEC);
252 if (ret < 0) {
253 perror("thread quit pipe");
254 goto error;
255 }
256
257 error:
258 return ret;
259 }
260
261 /*
262 * Complete teardown of a kernel session. This free all data structure related
263 * to a kernel session and update counter.
264 */
265 static void teardown_kernel_session(struct ltt_session *session)
266 {
267 if (session->kernel_session != NULL) {
268 DBG("Tearing down kernel session");
269
270 /*
271 * If a custom kernel consumer was registered, close the socket before
272 * tearing down the complete kernel session structure
273 */
274 if (session->kernel_session->consumer_fd != kconsumerd_cmd_sock) {
275 lttcomm_close_unix_sock(session->kernel_session->consumer_fd);
276 }
277
278 trace_kernel_destroy_session(session->kernel_session);
279 /* Extra precaution */
280 session->kernel_session = NULL;
281 }
282 }
283
284 /*
285 * Stop all threads by closing the thread quit pipe.
286 */
287 static void stop_threads(void)
288 {
289 int ret;
290
291 /* Stopping all threads */
292 DBG("Terminating all threads");
293 ret = notify_thread_pipe(thread_quit_pipe[1]);
294 if (ret < 0) {
295 ERR("write error on thread quit pipe");
296 }
297
298 /* Dispatch thread */
299 dispatch_thread_exit = 1;
300 futex_nto1_wake(&ust_cmd_queue.futex);
301 }
302
303 /*
304 * Cleanup the daemon
305 */
306 static void cleanup(void)
307 {
308 int ret;
309 char *cmd;
310 struct ltt_session *sess, *stmp;
311
312 DBG("Cleaning up");
313
314 /* <fun> */
315 MSG("%c[%d;%dm*** assert failed *** ==> %c[%dm%c[%d;%dm"
316 "Matthew, BEET driven development works!%c[%dm",
317 27, 1, 31, 27, 0, 27, 1, 33, 27, 0);
318 /* </fun> */
319
320 if (is_root) {
321 DBG("Removing %s directory", LTTNG_RUNDIR);
322 ret = asprintf(&cmd, "rm -rf " LTTNG_RUNDIR);
323 if (ret < 0) {
324 ERR("asprintf failed. Something is really wrong!");
325 }
326
327 /* Remove lttng run directory */
328 ret = system(cmd);
329 if (ret < 0) {
330 ERR("Unable to clean " LTTNG_RUNDIR);
331 }
332 }
333
334 DBG("Cleaning up all session");
335
336 /* Destroy session list mutex */
337 if (session_list_ptr != NULL) {
338 pthread_mutex_destroy(&session_list_ptr->lock);
339
340 /* Cleanup ALL session */
341 cds_list_for_each_entry_safe(sess, stmp,
342 &session_list_ptr->head, list) {
343 teardown_kernel_session(sess);
344 // TODO complete session cleanup (including UST)
345 }
346 }
347
348 DBG("Closing all UST sockets");
349 ust_app_clean_list();
350
351 pthread_mutex_destroy(&kconsumerd_pid_mutex);
352
353 DBG("Closing kernel fd");
354 close(kernel_tracer_fd);
355
356 if (is_root) {
357 DBG("Unloading kernel modules");
358 modprobe_remove_kernel_modules();
359 }
360
361 close(thread_quit_pipe[0]);
362 close(thread_quit_pipe[1]);
363
364 /* OUTPUT BENCHMARK RESULTS */
365 bench_init();
366
367 if (getenv("BENCH_UST_NOTIFY")) {
368 bench_print_ust_notification();
369 }
370
371 if (getenv("BENCH_UST_REGISTER")) {
372 bench_print_ust_register();
373 }
374
375 if (getenv("BENCH_BOOT_PROCESS")) {
376 bench_print_boot_process();
377 }
378
379 bench_close();
380 /* END BENCHMARK */
381 }
382
383 /*
384 * Send data on a unix socket using the liblttsessiondcomm API.
385 *
386 * Return lttcomm error code.
387 */
388 static int send_unix_sock(int sock, void *buf, size_t len)
389 {
390 /* Check valid length */
391 if (len <= 0) {
392 return -1;
393 }
394
395 return lttcomm_send_unix_sock(sock, buf, len);
396 }
397
398 /*
399 * Free memory of a command context structure.
400 */
401 static void clean_command_ctx(struct command_ctx **cmd_ctx)
402 {
403 DBG("Clean command context structure");
404 if (*cmd_ctx) {
405 if ((*cmd_ctx)->llm) {
406 free((*cmd_ctx)->llm);
407 }
408 if ((*cmd_ctx)->lsm) {
409 free((*cmd_ctx)->lsm);
410 }
411 free(*cmd_ctx);
412 *cmd_ctx = NULL;
413 }
414 }
415
416 /*
417 * Send all stream fds of kernel channel to the consumer.
418 */
419 static int send_kconsumerd_channel_fds(int sock,
420 struct ltt_kernel_channel *channel)
421 {
422 int ret;
423 size_t nb_fd;
424 struct ltt_kernel_stream *stream;
425 struct lttcomm_kconsumerd_header lkh;
426 struct lttcomm_kconsumerd_msg lkm;
427
428 DBG("Sending fds of channel %s to kernel consumer",
429 channel->channel->name);
430
431 nb_fd = channel->stream_count;
432
433 /* Setup header */
434 lkh.payload_size = nb_fd * sizeof(struct lttcomm_kconsumerd_msg);
435 lkh.cmd_type = ADD_STREAM;
436
437 DBG("Sending kconsumerd header");
438
439 ret = lttcomm_send_unix_sock(sock, &lkh,
440 sizeof(struct lttcomm_kconsumerd_header));
441 if (ret < 0) {
442 perror("send kconsumerd header");
443 goto error;
444 }
445
446 cds_list_for_each_entry(stream, &channel->stream_list.head, list) {
447 if (stream->fd != 0) {
448 lkm.fd = stream->fd;
449 lkm.state = stream->state;
450 lkm.max_sb_size = channel->channel->attr.subbuf_size;
451 lkm.output = channel->channel->attr.output;
452 strncpy(lkm.path_name, stream->pathname, PATH_MAX);
453 lkm.path_name[PATH_MAX - 1] = '\0';
454
455 DBG("Sending fd %d to kconsumerd", lkm.fd);
456
457 ret = lttcomm_send_fds_unix_sock(sock, &lkm,
458 &lkm.fd, 1, sizeof(lkm));
459 if (ret < 0) {
460 perror("send kconsumerd fd");
461 goto error;
462 }
463 }
464 }
465
466 DBG("Kconsumerd channel fds sent");
467
468 return 0;
469
470 error:
471 return ret;
472 }
473
474 /*
475 * Send all stream fds of the kernel session to the consumer.
476 */
477 static int send_kconsumerd_fds(struct ltt_kernel_session *session)
478 {
479 int ret;
480 struct ltt_kernel_channel *chan;
481 struct lttcomm_kconsumerd_header lkh;
482 struct lttcomm_kconsumerd_msg lkm;
483
484 /* Setup header */
485 lkh.payload_size = sizeof(struct lttcomm_kconsumerd_msg);
486 lkh.cmd_type = ADD_STREAM;
487
488 DBG("Sending kconsumerd header for metadata");
489
490 ret = lttcomm_send_unix_sock(session->consumer_fd, &lkh,
491 sizeof(struct lttcomm_kconsumerd_header));
492 if (ret < 0) {
493 perror("send kconsumerd header");
494 goto error;
495 }
496
497 DBG("Sending metadata stream fd");
498
499 /* Extra protection. It's NOT suppose to be set to 0 at this point */
500 if (session->consumer_fd == 0) {
501 session->consumer_fd = kconsumerd_cmd_sock;
502 }
503
504 if (session->metadata_stream_fd != 0) {
505 /* Send metadata stream fd first */
506 lkm.fd = session->metadata_stream_fd;
507 lkm.state = ACTIVE_FD;
508 lkm.max_sb_size = session->metadata->conf->attr.subbuf_size;
509 lkm.output = DEFAULT_KERNEL_CHANNEL_OUTPUT;
510 strncpy(lkm.path_name, session->metadata->pathname, PATH_MAX);
511 lkm.path_name[PATH_MAX - 1] = '\0';
512
513 ret = lttcomm_send_fds_unix_sock(session->consumer_fd, &lkm,
514 &lkm.fd, 1, sizeof(lkm));
515 if (ret < 0) {
516 perror("send kconsumerd fd");
517 goto error;
518 }
519 }
520
521 cds_list_for_each_entry(chan, &session->channel_list.head, list) {
522 ret = send_kconsumerd_channel_fds(session->consumer_fd, chan);
523 if (ret < 0) {
524 goto error;
525 }
526 }
527
528 DBG("Kconsumerd fds (metadata and channel streams) sent");
529
530 return 0;
531
532 error:
533 return ret;
534 }
535
536 /*
537 * Notify UST applications using the shm mmap futex.
538 */
539 static int notify_ust_apps(int active)
540 {
541 char *wait_shm_mmap;
542
543 DBG("Notifying applications of session daemon state: %d", active);
544
545 tracepoint(ust_notify_apps_start);
546
547 /* See shm.c for this call implying mmap, shm and futex calls */
548 wait_shm_mmap = shm_ust_get_mmap(wait_shm_path, is_root);
549 if (wait_shm_mmap == NULL) {
550 goto error;
551 }
552
553 /* Wake waiting process */
554 futex_wait_update((int32_t *) wait_shm_mmap, active);
555
556 tracepoint(ust_notify_apps_stop);
557
558 /* Apps notified successfully */
559 return 0;
560
561 error:
562 return -1;
563 }
564
565 /*
566 * Setup the outgoing data buffer for the response (llm) by allocating the
567 * right amount of memory and copying the original information from the lsm
568 * structure.
569 *
570 * Return total size of the buffer pointed by buf.
571 */
572 static int setup_lttng_msg(struct command_ctx *cmd_ctx, size_t size)
573 {
574 int ret, buf_size;
575
576 buf_size = size;
577
578 cmd_ctx->llm = malloc(sizeof(struct lttcomm_lttng_msg) + buf_size);
579 if (cmd_ctx->llm == NULL) {
580 perror("malloc");
581 ret = -ENOMEM;
582 goto error;
583 }
584
585 /* Copy common data */
586 cmd_ctx->llm->cmd_type = cmd_ctx->lsm->cmd_type;
587 cmd_ctx->llm->pid = cmd_ctx->lsm->domain.attr.pid;
588
589 cmd_ctx->llm->data_size = size;
590 cmd_ctx->lttng_msg_size = sizeof(struct lttcomm_lttng_msg) + buf_size;
591
592 return buf_size;
593
594 error:
595 return ret;
596 }
597
598 /*
599 * Update the kernel poll set of all channel fd available over all tracing
600 * session. Add the wakeup pipe at the end of the set.
601 */
602 static int update_kernel_poll(struct lttng_poll_event *events)
603 {
604 int ret;
605 struct ltt_session *session;
606 struct ltt_kernel_channel *channel;
607
608 DBG("Updating kernel poll set");
609
610 session_lock_list();
611 cds_list_for_each_entry(session, &session_list_ptr->head, list) {
612 session_lock(session);
613 if (session->kernel_session == NULL) {
614 session_unlock(session);
615 continue;
616 }
617
618 cds_list_for_each_entry(channel,
619 &session->kernel_session->channel_list.head, list) {
620 /* Add channel fd to the kernel poll set */
621 ret = lttng_poll_add(events, channel->fd, LPOLLIN | LPOLLRDNORM);
622 if (ret < 0) {
623 session_unlock(session);
624 goto error;
625 }
626 DBG("Channel fd %d added to kernel set", channel->fd);
627 }
628 session_unlock(session);
629 }
630 session_unlock_list();
631
632 return 0;
633
634 error:
635 session_unlock_list();
636 return -1;
637 }
638
639 /*
640 * Find the channel fd from 'fd' over all tracing session. When found, check
641 * for new channel stream and send those stream fds to the kernel consumer.
642 *
643 * Useful for CPU hotplug feature.
644 */
645 static int update_kernel_stream(int fd)
646 {
647 int ret = 0;
648 struct ltt_session *session;
649 struct ltt_kernel_channel *channel;
650
651 DBG("Updating kernel streams for channel fd %d", fd);
652
653 session_lock_list();
654 cds_list_for_each_entry(session, &session_list_ptr->head, list) {
655 session_lock(session);
656 if (session->kernel_session == NULL) {
657 session_unlock(session);
658 continue;
659 }
660
661 /* This is not suppose to be 0 but this is an extra security check */
662 if (session->kernel_session->consumer_fd == 0) {
663 session->kernel_session->consumer_fd = kconsumerd_cmd_sock;
664 }
665
666 cds_list_for_each_entry(channel,
667 &session->kernel_session->channel_list.head, list) {
668 if (channel->fd == fd) {
669 DBG("Channel found, updating kernel streams");
670 ret = kernel_open_channel_stream(channel);
671 if (ret < 0) {
672 goto error;
673 }
674
675 /*
676 * Have we already sent fds to the consumer? If yes, it means
677 * that tracing is started so it is safe to send our updated
678 * stream fds.
679 */
680 if (session->kernel_session->kconsumer_fds_sent == 1) {
681 ret = send_kconsumerd_channel_fds(
682 session->kernel_session->consumer_fd, channel);
683 if (ret < 0) {
684 goto error;
685 }
686 }
687 goto error;
688 }
689 }
690 session_unlock(session);
691 }
692 session_unlock_list();
693 return ret;
694
695 error:
696 session_unlock(session);
697 session_unlock_list();
698 return ret;
699 }
700
701 /*
702 * This thread manage event coming from the kernel.
703 *
704 * Features supported in this thread:
705 * -) CPU Hotplug
706 */
707 static void *thread_manage_kernel(void *data)
708 {
709 int ret, i, pollfd, update_poll_flag = 1;
710 uint32_t revents, nb_fd;
711 char tmp;
712 struct lttng_poll_event events;
713
714 tracepoint(sessiond_th_kern_start);
715
716 DBG("Thread manage kernel started");
717
718 ret = create_thread_poll_set(&events, 2);
719 if (ret < 0) {
720 goto error;
721 }
722
723 ret = lttng_poll_add(&events, kernel_poll_pipe[0], LPOLLIN);
724 if (ret < 0) {
725 goto error;
726 }
727
728 while (1) {
729 if (update_poll_flag == 1) {
730 ret = update_kernel_poll(&events);
731 if (ret < 0) {
732 goto error;
733 }
734 update_poll_flag = 0;
735 }
736
737 nb_fd = LTTNG_POLL_GETNB(&events);
738
739 DBG("Thread kernel polling on %d fds", nb_fd);
740
741 /* Zeroed the poll events */
742 lttng_poll_reset(&events);
743
744 tracepoint(sessiond_th_kern_poll);
745
746 /* Poll infinite value of time */
747 ret = lttng_poll_wait(&events, -1);
748 if (ret < 0) {
749 goto error;
750 } else if (ret == 0) {
751 /* Should not happen since timeout is infinite */
752 ERR("Return value of poll is 0 with an infinite timeout.\n"
753 "This should not have happened! Continuing...");
754 continue;
755 }
756
757 for (i = 0; i < nb_fd; i++) {
758 /* Fetch once the poll data */
759 revents = LTTNG_POLL_GETEV(&events, i);
760 pollfd = LTTNG_POLL_GETFD(&events, i);
761
762 /* Thread quit pipe has been closed. Killing thread. */
763 ret = check_thread_quit_pipe(pollfd, revents);
764 if (ret) {
765 goto error;
766 }
767
768 /* Check for data on kernel pipe */
769 if (pollfd == kernel_poll_pipe[0] && (revents & LPOLLIN)) {
770 ret = read(kernel_poll_pipe[0], &tmp, 1);
771 update_poll_flag = 1;
772 continue;
773 } else {
774 /*
775 * New CPU detected by the kernel. Adding kernel stream to
776 * kernel session and updating the kernel consumer
777 */
778 if (revents & LPOLLIN) {
779 ret = update_kernel_stream(pollfd);
780 if (ret < 0) {
781 continue;
782 }
783 break;
784 /*
785 * TODO: We might want to handle the LPOLLERR | LPOLLHUP
786 * and unregister kernel stream at this point.
787 */
788 }
789 }
790 }
791 }
792
793 error:
794 DBG("Kernel thread dying");
795 close(kernel_poll_pipe[0]);
796 close(kernel_poll_pipe[1]);
797
798 lttng_poll_clean(&events);
799
800 return NULL;
801 }
802
803 /*
804 * This thread manage the kconsumerd error sent back to the session daemon.
805 */
806 static void *thread_manage_kconsumerd(void *data)
807 {
808 int sock = 0, i, ret, pollfd;
809 uint32_t revents, nb_fd;
810 enum lttcomm_return_code code;
811 struct lttng_poll_event events;
812
813 tracepoint(sessiond_th_kcon_start);
814
815 DBG("[thread] Manage kconsumerd started");
816
817 ret = lttcomm_listen_unix_sock(kconsumerd_err_sock);
818 if (ret < 0) {
819 goto error;
820 }
821
822 /*
823 * Pass 2 as size here for the thread quit pipe and kconsumerd_err_sock.
824 * Nothing more will be added to this poll set.
825 */
826 ret = create_thread_poll_set(&events, 2);
827 if (ret < 0) {
828 goto error;
829 }
830
831 ret = lttng_poll_add(&events, kconsumerd_err_sock, LPOLLIN | LPOLLRDHUP);
832 if (ret < 0) {
833 goto error;
834 }
835
836 nb_fd = LTTNG_POLL_GETNB(&events);
837
838 tracepoint(sessiond_th_kcon_poll);
839
840 /* Inifinite blocking call, waiting for transmission */
841 ret = lttng_poll_wait(&events, -1);
842 if (ret < 0) {
843 goto error;
844 }
845
846 for (i = 0; i < nb_fd; i++) {
847 /* Fetch once the poll data */
848 revents = LTTNG_POLL_GETEV(&events, i);
849 pollfd = LTTNG_POLL_GETFD(&events, i);
850
851 /* Thread quit pipe has been closed. Killing thread. */
852 ret = check_thread_quit_pipe(pollfd, revents);
853 if (ret) {
854 goto error;
855 }
856
857 /* Event on the registration socket */
858 if (pollfd == kconsumerd_err_sock) {
859 if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
860 ERR("Kconsumerd err socket poll error");
861 goto error;
862 }
863 }
864 }
865
866 sock = lttcomm_accept_unix_sock(kconsumerd_err_sock);
867 if (sock < 0) {
868 goto error;
869 }
870
871 /* Getting status code from kconsumerd */
872 ret = lttcomm_recv_unix_sock(sock, &code,
873 sizeof(enum lttcomm_return_code));
874 if (ret <= 0) {
875 goto error;
876 }
877
878 if (code == KCONSUMERD_COMMAND_SOCK_READY) {
879 kconsumerd_cmd_sock =
880 lttcomm_connect_unix_sock(kconsumerd_cmd_unix_sock_path);
881 if (kconsumerd_cmd_sock < 0) {
882 sem_post(&kconsumerd_sem);
883 perror("kconsumerd connect");
884 goto error;
885 }
886 /* Signal condition to tell that the kconsumerd is ready */
887 sem_post(&kconsumerd_sem);
888 DBG("Kconsumerd command socket ready");
889 } else {
890 DBG("Kconsumerd error when waiting for SOCK_READY : %s",
891 lttcomm_get_readable_code(-code));
892 goto error;
893 }
894
895 /* Remove the kconsumerd error sock since we've established a connexion */
896 ret = lttng_poll_del(&events, kconsumerd_err_sock);
897 if (ret < 0) {
898 goto error;
899 }
900
901 ret = lttng_poll_add(&events, sock, LPOLLIN | LPOLLRDHUP);
902 if (ret < 0) {
903 goto error;
904 }
905
906 /* Update number of fd */
907 nb_fd = LTTNG_POLL_GETNB(&events);
908
909 /* Inifinite blocking call, waiting for transmission */
910 ret = lttng_poll_wait(&events, -1);
911 if (ret < 0) {
912 goto error;
913 }
914
915 for (i = 0; i < nb_fd; i++) {
916 /* Fetch once the poll data */
917 revents = LTTNG_POLL_GETEV(&events, i);
918 pollfd = LTTNG_POLL_GETFD(&events, i);
919
920 /* Thread quit pipe has been closed. Killing thread. */
921 ret = check_thread_quit_pipe(pollfd, revents);
922 if (ret) {
923 goto error;
924 }
925
926 /* Event on the kconsumerd socket */
927 if (pollfd == sock) {
928 if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
929 ERR("Kconsumerd err socket second poll error");
930 goto error;
931 }
932 }
933 }
934
935 /* Wait for any kconsumerd error */
936 ret = lttcomm_recv_unix_sock(sock, &code,
937 sizeof(enum lttcomm_return_code));
938 if (ret <= 0) {
939 ERR("Kconsumerd closed the command socket");
940 goto error;
941 }
942
943 ERR("Kconsumerd return code : %s", lttcomm_get_readable_code(-code));
944
945 error:
946 DBG("Kconsumerd thread dying");
947 close(kconsumerd_err_sock);
948 close(kconsumerd_cmd_sock);
949 close(sock);
950
951 unlink(kconsumerd_err_unix_sock_path);
952 unlink(kconsumerd_cmd_unix_sock_path);
953 kconsumerd_pid = 0;
954
955 lttng_poll_clean(&events);
956
957 return NULL;
958 }
959
960 /*
961 * This thread manage application communication.
962 */
963 static void *thread_manage_apps(void *data)
964 {
965 int i, ret, pollfd;
966 uint32_t revents, nb_fd;
967 struct ust_command ust_cmd;
968 struct lttng_poll_event events;
969
970 tracepoint(sessiond_th_apps_start);
971
972 DBG("[thread] Manage application started");
973
974 ret = create_thread_poll_set(&events, 2);
975 if (ret < 0) {
976 goto error;
977 }
978
979 ret = lttng_poll_add(&events, apps_cmd_pipe[0], LPOLLIN | LPOLLRDHUP);
980 if (ret < 0) {
981 goto error;
982 }
983
984 while (1) {
985 /* Zeroed the events structure */
986 lttng_poll_reset(&events);
987
988 nb_fd = LTTNG_POLL_GETNB(&events);
989
990 DBG("Apps thread polling on %d fds", nb_fd);
991
992 tracepoint(sessiond_th_apps_poll);
993
994 /* Inifinite blocking call, waiting for transmission */
995 ret = lttng_poll_wait(&events, -1);
996 if (ret < 0) {
997 goto error;
998 }
999
1000 for (i = 0; i < nb_fd; i++) {
1001 /* Fetch once the poll data */
1002 revents = LTTNG_POLL_GETEV(&events, i);
1003 pollfd = LTTNG_POLL_GETFD(&events, i);
1004
1005 /* Thread quit pipe has been closed. Killing thread. */
1006 ret = check_thread_quit_pipe(pollfd, revents);
1007 if (ret) {
1008 goto error;
1009 }
1010
1011 /* Inspect the apps cmd pipe */
1012 if (pollfd == apps_cmd_pipe[0]) {
1013 if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
1014 ERR("Apps command pipe error");
1015 goto error;
1016 } else if (revents & LPOLLIN) {
1017 tracepoint(ust_register_read_start);
1018 /* Empty pipe */
1019 ret = read(apps_cmd_pipe[0], &ust_cmd, sizeof(ust_cmd));
1020 if (ret < 0 || ret < sizeof(ust_cmd)) {
1021 perror("read apps cmd pipe");
1022 goto error;
1023 }
1024 tracepoint(ust_register_read_stop);
1025
1026 tracepoint(ust_register_add_start);
1027 /* Register applicaton to the session daemon */
1028 ret = ust_app_register(&ust_cmd.reg_msg,
1029 ust_cmd.sock);
1030 if (ret < 0) {
1031 /* Only critical ENOMEM error can be returned here */
1032 goto error;
1033 }
1034 tracepoint(ust_register_add_stop);
1035
1036 tracepoint(ust_register_done_start);
1037 ret = ustctl_register_done(ust_cmd.sock);
1038 if (ret < 0) {
1039 /*
1040 * If the registration is not possible, we simply
1041 * unregister the apps and continue
1042 */
1043 ust_app_unregister(ust_cmd.sock);
1044 } else {
1045 /*
1046 * We just need here to monitor the close of the UST
1047 * socket and poll set monitor those by default.
1048 */
1049 ret = lttng_poll_add(&events, ust_cmd.sock, 0);
1050 if (ret < 0) {
1051 goto error;
1052 }
1053
1054 DBG("Apps with sock %d added to poll set",
1055 ust_cmd.sock);
1056 }
1057 tracepoint(ust_register_done_stop);
1058 break;
1059 }
1060 } else {
1061 /*
1062 * At this point, we know that a registered application made
1063 * the event at poll_wait.
1064 */
1065 if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
1066 /* Removing from the poll set */
1067 ret = lttng_poll_del(&events, pollfd);
1068 if (ret < 0) {
1069 goto error;
1070 }
1071
1072 /* Socket closed */
1073 ust_app_unregister(pollfd);
1074 break;
1075 }
1076 }
1077 }
1078 }
1079
1080 error:
1081 DBG("Application communication apps dying");
1082 close(apps_cmd_pipe[0]);
1083 close(apps_cmd_pipe[1]);
1084
1085 lttng_poll_clean(&events);
1086
1087 return NULL;
1088 }
1089
1090 /*
1091 * Dispatch request from the registration threads to the application
1092 * communication thread.
1093 */
1094 static void *thread_dispatch_ust_registration(void *data)
1095 {
1096 int ret;
1097 struct cds_wfq_node *node;
1098 struct ust_command *ust_cmd = NULL;
1099
1100 tracepoint(sessiond_th_dispatch_start);
1101
1102 DBG("[thread] Dispatch UST command started");
1103
1104 while (!dispatch_thread_exit) {
1105 /* Atomically prepare the queue futex */
1106 futex_nto1_prepare(&ust_cmd_queue.futex);
1107
1108 do {
1109 tracepoint(sessiond_th_dispatch_block);
1110
1111 /* Dequeue command for registration */
1112 node = cds_wfq_dequeue_blocking(&ust_cmd_queue.queue);
1113 if (node == NULL) {
1114 DBG("Waked up but nothing in the UST command queue");
1115 /* Continue thread execution */
1116 break;
1117 }
1118
1119 tracepoint(ust_dispatch_register_start);
1120
1121 ust_cmd = caa_container_of(node, struct ust_command, node);
1122
1123 DBG("Dispatching UST registration pid:%d ppid:%d uid:%d"
1124 " gid:%d sock:%d name:%s (version %d.%d)",
1125 ust_cmd->reg_msg.pid, ust_cmd->reg_msg.ppid,
1126 ust_cmd->reg_msg.uid, ust_cmd->reg_msg.gid,
1127 ust_cmd->sock, ust_cmd->reg_msg.name,
1128 ust_cmd->reg_msg.major, ust_cmd->reg_msg.minor);
1129 /*
1130 * Inform apps thread of the new application registration. This
1131 * call is blocking so we can be assured that the data will be read
1132 * at some point in time or wait to the end of the world :)
1133 */
1134 ret = write(apps_cmd_pipe[1], ust_cmd,
1135 sizeof(struct ust_command));
1136 if (ret < 0) {
1137 perror("write apps cmd pipe");
1138 if (errno == EBADF) {
1139 /*
1140 * We can't inform the application thread to process
1141 * registration. We will exit or else application
1142 * registration will not occur and tracing will never
1143 * start.
1144 */
1145 goto error;
1146 }
1147 }
1148 free(ust_cmd);
1149 } while (node != NULL);
1150
1151 tracepoint(ust_dispatch_register_stop);
1152
1153 /* Futex wait on queue. Blocking call on futex() */
1154 futex_nto1_wait(&ust_cmd_queue.futex);
1155 }
1156
1157 error:
1158 DBG("Dispatch thread dying");
1159 return NULL;
1160 }
1161
1162 /*
1163 * This thread manage application registration.
1164 */
1165 static void *thread_registration_apps(void *data)
1166 {
1167 int sock = 0, i, ret, pollfd;
1168 uint32_t revents, nb_fd;
1169 struct lttng_poll_event events;
1170 /*
1171 * Get allocated in this thread, enqueued to a global queue, dequeued and
1172 * freed in the manage apps thread.
1173 */
1174 struct ust_command *ust_cmd = NULL;
1175
1176 tracepoint(sessiond_th_reg_start);
1177
1178 DBG("[thread] Manage application registration started");
1179
1180 ret = lttcomm_listen_unix_sock(apps_sock);
1181 if (ret < 0) {
1182 goto error;
1183 }
1184
1185 /*
1186 * Pass 2 as size here for the thread quit pipe and apps socket. Nothing
1187 * more will be added to this poll set.
1188 */
1189 ret = create_thread_poll_set(&events, 2);
1190 if (ret < 0) {
1191 goto error;
1192 }
1193
1194 /* Add the application registration socket */
1195 ret = lttng_poll_add(&events, apps_sock, LPOLLIN | LPOLLRDHUP);
1196 if (ret < 0) {
1197 goto error;
1198 }
1199
1200 /* Notify all applications to register */
1201 ret = notify_ust_apps(1);
1202 if (ret < 0) {
1203 ERR("Failed to notify applications or create the wait shared memory.\n"
1204 "Execution continues but there might be problem for already\n"
1205 "running applications that wishes to register.");
1206 }
1207
1208 while (1) {
1209 DBG("Accepting application registration");
1210
1211 tracepoint(sessiond_th_reg_poll);
1212
1213 nb_fd = LTTNG_POLL_GETNB(&events);
1214
1215 /* Inifinite blocking call, waiting for transmission */
1216 ret = lttng_poll_wait(&events, -1);
1217 if (ret < 0) {
1218 goto error;
1219 }
1220
1221 for (i = 0; i < nb_fd; i++) {
1222 /* Fetch once the poll data */
1223 revents = LTTNG_POLL_GETEV(&events, i);
1224 pollfd = LTTNG_POLL_GETFD(&events, i);
1225
1226 /* Thread quit pipe has been closed. Killing thread. */
1227 ret = check_thread_quit_pipe(pollfd, revents);
1228 if (ret) {
1229 goto error;
1230 }
1231
1232 /* Event on the registration socket */
1233 if (pollfd == apps_sock) {
1234 if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
1235 ERR("Register apps socket poll error");
1236 goto error;
1237 } else if (revents & LPOLLIN) {
1238 /* Registration starts here. Recording cycles */
1239 tracepoint(ust_register_start);
1240
1241 sock = lttcomm_accept_unix_sock(apps_sock);
1242 if (sock < 0) {
1243 goto error;
1244 }
1245
1246 /* Create UST registration command for enqueuing */
1247 ust_cmd = malloc(sizeof(struct ust_command));
1248 if (ust_cmd == NULL) {
1249 perror("ust command malloc");
1250 goto error;
1251 }
1252
1253 /*
1254 * Using message-based transmissions to ensure we don't
1255 * have to deal with partially received messages.
1256 */
1257 ret = lttcomm_recv_unix_sock(sock, &ust_cmd->reg_msg,
1258 sizeof(struct ust_register_msg));
1259 if (ret < 0 || ret < sizeof(struct ust_register_msg)) {
1260 if (ret < 0) {
1261 perror("lttcomm_recv_unix_sock register apps");
1262 } else {
1263 ERR("Wrong size received on apps register");
1264 }
1265 free(ust_cmd);
1266 close(sock);
1267 continue;
1268 }
1269
1270 ust_cmd->sock = sock;
1271
1272 DBG("UST registration received with pid:%d ppid:%d uid:%d"
1273 " gid:%d sock:%d name:%s (version %d.%d)",
1274 ust_cmd->reg_msg.pid, ust_cmd->reg_msg.ppid,
1275 ust_cmd->reg_msg.uid, ust_cmd->reg_msg.gid,
1276 ust_cmd->sock, ust_cmd->reg_msg.name,
1277 ust_cmd->reg_msg.major, ust_cmd->reg_msg.minor);
1278
1279 /*
1280 * Lock free enqueue the registration request. The red pill
1281 * has been taken! This apps will be part of the *system*.
1282 */
1283 cds_wfq_enqueue(&ust_cmd_queue.queue, &ust_cmd->node);
1284
1285 /*
1286 * Wake the registration queue futex. Implicit memory
1287 * barrier with the exchange in cds_wfq_enqueue.
1288 */
1289 futex_nto1_wake(&ust_cmd_queue.futex);
1290
1291 tracepoint(ust_register_stop);
1292 }
1293 }
1294 }
1295 }
1296
1297 error:
1298 DBG("UST Registration thread dying");
1299
1300 /* Notify that the registration thread is gone */
1301 notify_ust_apps(0);
1302
1303 close(apps_sock);
1304 close(sock);
1305 unlink(apps_unix_sock_path);
1306
1307 lttng_poll_clean(&events);
1308
1309 return NULL;
1310 }
1311
1312 /*
1313 * Start the thread_manage_kconsumerd. This must be done after a kconsumerd
1314 * exec or it will fails.
1315 */
1316 static int spawn_kconsumerd_thread(void)
1317 {
1318 int ret;
1319
1320 /* Setup semaphore */
1321 sem_init(&kconsumerd_sem, 0, 0);
1322
1323 ret = pthread_create(&kconsumerd_thread, NULL,
1324 thread_manage_kconsumerd, (void *) NULL);
1325 if (ret != 0) {
1326 perror("pthread_create kconsumerd");
1327 goto error;
1328 }
1329
1330 /* Wait for the kconsumerd thread to be ready */
1331 sem_wait(&kconsumerd_sem);
1332
1333 if (kconsumerd_pid == 0) {
1334 ERR("Kconsumerd did not start");
1335 goto error;
1336 }
1337
1338 return 0;
1339
1340 error:
1341 ret = LTTCOMM_KERN_CONSUMER_FAIL;
1342 return ret;
1343 }
1344
1345 /*
1346 * Join kernel consumer thread
1347 */
1348 static int join_kconsumerd_thread(void)
1349 {
1350 void *status;
1351 int ret;
1352
1353 if (kconsumerd_pid != 0) {
1354 ret = kill(kconsumerd_pid, SIGTERM);
1355 if (ret) {
1356 ERR("Error killing kconsumerd");
1357 return ret;
1358 }
1359 return pthread_join(kconsumerd_thread, &status);
1360 } else {
1361 return 0;
1362 }
1363 }
1364
1365 /*
1366 * Fork and exec a kernel consumer daemon (kconsumerd).
1367 *
1368 * Return pid if successful else -1.
1369 */
1370 static pid_t spawn_kconsumerd(void)
1371 {
1372 int ret;
1373 pid_t pid;
1374 const char *verbosity;
1375
1376 DBG("Spawning kconsumerd");
1377
1378 pid = fork();
1379 if (pid == 0) {
1380 /*
1381 * Exec kconsumerd.
1382 */
1383 if (opt_verbose > 1 || opt_verbose_kconsumerd) {
1384 verbosity = "--verbose";
1385 } else {
1386 verbosity = "--quiet";
1387 }
1388 execl(INSTALL_BIN_PATH "/ltt-kconsumerd",
1389 "ltt-kconsumerd", verbosity, NULL);
1390 if (errno != 0) {
1391 perror("kernel start consumer exec");
1392 }
1393 exit(EXIT_FAILURE);
1394 } else if (pid > 0) {
1395 ret = pid;
1396 goto error;
1397 } else {
1398 perror("kernel start consumer fork");
1399 ret = -errno;
1400 goto error;
1401 }
1402
1403 error:
1404 return ret;
1405 }
1406
1407 /*
1408 * Spawn the kconsumerd daemon and session daemon thread.
1409 */
1410 static int start_kconsumerd(void)
1411 {
1412 int ret;
1413
1414 pthread_mutex_lock(&kconsumerd_pid_mutex);
1415 if (kconsumerd_pid != 0) {
1416 pthread_mutex_unlock(&kconsumerd_pid_mutex);
1417 goto end;
1418 }
1419
1420 ret = spawn_kconsumerd();
1421 if (ret < 0) {
1422 ERR("Spawning kconsumerd failed");
1423 ret = LTTCOMM_KERN_CONSUMER_FAIL;
1424 pthread_mutex_unlock(&kconsumerd_pid_mutex);
1425 goto error;
1426 }
1427
1428 /* Setting up the global kconsumerd_pid */
1429 kconsumerd_pid = ret;
1430 pthread_mutex_unlock(&kconsumerd_pid_mutex);
1431
1432 DBG("Kconsumerd pid %d", ret);
1433
1434 DBG("Spawning kconsumerd thread");
1435 ret = spawn_kconsumerd_thread();
1436 if (ret < 0) {
1437 ERR("Fatal error spawning kconsumerd thread");
1438 goto error;
1439 }
1440
1441 end:
1442 return 0;
1443
1444 error:
1445 return ret;
1446 }
1447
1448 /*
1449 * modprobe_kernel_modules
1450 */
1451 static int modprobe_kernel_modules(void)
1452 {
1453 int ret = 0, i;
1454 char modprobe[256];
1455
1456 for (i = 0; i < ARRAY_SIZE(kernel_modules_list); i++) {
1457 ret = snprintf(modprobe, sizeof(modprobe),
1458 "/sbin/modprobe %s%s",
1459 kernel_modules_list[i].required ? "" : "--quiet ",
1460 kernel_modules_list[i].name);
1461 if (ret < 0) {
1462 perror("snprintf modprobe");
1463 goto error;
1464 }
1465 modprobe[sizeof(modprobe) - 1] = '\0';
1466 ret = system(modprobe);
1467 if (ret == -1) {
1468 ERR("Unable to launch modprobe for module %s",
1469 kernel_modules_list[i].name);
1470 } else if (kernel_modules_list[i].required
1471 && WEXITSTATUS(ret) != 0) {
1472 ERR("Unable to load module %s",
1473 kernel_modules_list[i].name);
1474 } else {
1475 DBG("Modprobe successfully %s",
1476 kernel_modules_list[i].name);
1477 }
1478 }
1479
1480 error:
1481 return ret;
1482 }
1483
1484 /*
1485 * mount_debugfs
1486 */
1487 static int mount_debugfs(char *path)
1488 {
1489 int ret;
1490 char *type = "debugfs";
1491
1492 ret = mkdir_recursive(path, S_IRWXU | S_IRWXG, geteuid(), getegid());
1493 if (ret < 0) {
1494 PERROR("Cannot create debugfs path");
1495 goto error;
1496 }
1497
1498 ret = mount(type, path, type, 0, NULL);
1499 if (ret < 0) {
1500 PERROR("Cannot mount debugfs");
1501 goto error;
1502 }
1503
1504 DBG("Mounted debugfs successfully at %s", path);
1505
1506 error:
1507 return ret;
1508 }
1509
1510 /*
1511 * Setup necessary data for kernel tracer action.
1512 */
1513 static void init_kernel_tracer(void)
1514 {
1515 int ret;
1516 char *proc_mounts = "/proc/mounts";
1517 char line[256];
1518 char *debugfs_path = NULL, *lttng_path = NULL;
1519 FILE *fp;
1520
1521 /* Detect debugfs */
1522 fp = fopen(proc_mounts, "r");
1523 if (fp == NULL) {
1524 ERR("Unable to probe %s", proc_mounts);
1525 goto error;
1526 }
1527
1528 while (fgets(line, sizeof(line), fp) != NULL) {
1529 if (strstr(line, "debugfs") != NULL) {
1530 /* Remove first string */
1531 strtok(line, " ");
1532 /* Dup string here so we can reuse line later on */
1533 debugfs_path = strdup(strtok(NULL, " "));
1534 DBG("Got debugfs path : %s", debugfs_path);
1535 break;
1536 }
1537 }
1538
1539 fclose(fp);
1540
1541 /* Mount debugfs if needded */
1542 if (debugfs_path == NULL) {
1543 ret = asprintf(&debugfs_path, "/mnt/debugfs");
1544 if (ret < 0) {
1545 perror("asprintf debugfs path");
1546 goto error;
1547 }
1548 ret = mount_debugfs(debugfs_path);
1549 if (ret < 0) {
1550 perror("Cannot mount debugfs");
1551 goto error;
1552 }
1553 }
1554
1555 /* Modprobe lttng kernel modules */
1556 ret = modprobe_kernel_modules();
1557 if (ret < 0) {
1558 goto error;
1559 }
1560
1561 /* Setup lttng kernel path */
1562 ret = asprintf(&lttng_path, "%s/lttng", debugfs_path);
1563 if (ret < 0) {
1564 perror("asprintf lttng path");
1565 goto error;
1566 }
1567
1568 /* Open debugfs lttng */
1569 kernel_tracer_fd = open(lttng_path, O_RDWR);
1570 if (kernel_tracer_fd < 0) {
1571 DBG("Failed to open %s", lttng_path);
1572 goto error;
1573 }
1574
1575 free(lttng_path);
1576 free(debugfs_path);
1577 DBG("Kernel tracer fd %d", kernel_tracer_fd);
1578 return;
1579
1580 error:
1581 if (lttng_path) {
1582 free(lttng_path);
1583 }
1584 if (debugfs_path) {
1585 free(debugfs_path);
1586 }
1587 WARN("No kernel tracer available");
1588 kernel_tracer_fd = 0;
1589 return;
1590 }
1591
1592 /*
1593 * Init tracing by creating trace directory and sending fds kernel consumer.
1594 */
1595 static int init_kernel_tracing(struct ltt_kernel_session *session)
1596 {
1597 int ret = 0;
1598
1599 if (session->kconsumer_fds_sent == 0) {
1600 /*
1601 * Assign default kernel consumer socket if no consumer assigned to the
1602 * kernel session. At this point, it's NOT suppose to be 0 but this is
1603 * an extra security check.
1604 */
1605 if (session->consumer_fd == 0) {
1606 session->consumer_fd = kconsumerd_cmd_sock;
1607 }
1608
1609 ret = send_kconsumerd_fds(session);
1610 if (ret < 0) {
1611 ret = LTTCOMM_KERN_CONSUMER_FAIL;
1612 goto error;
1613 }
1614
1615 session->kconsumer_fds_sent = 1;
1616 }
1617
1618 error:
1619 return ret;
1620 }
1621
1622 /*
1623 * Create an UST session and add it to the session ust list.
1624 */
1625 static int create_ust_session(struct ltt_session *session,
1626 struct lttng_domain *domain)
1627 {
1628 int ret;
1629 struct ltt_ust_session *lus;
1630 struct ust_app *app;
1631
1632 switch (domain->type) {
1633 case LTTNG_DOMAIN_UST_PID:
1634 app = ust_app_get_by_pid(domain->attr.pid);
1635 if (app == NULL) {
1636 ret = LTTCOMM_APP_NOT_FOUND;
1637 goto error;
1638 }
1639 break;
1640 default:
1641 goto error;
1642 }
1643
1644 DBG("Creating UST session");
1645
1646 lus = trace_ust_create_session(session->path, domain->attr.pid, domain);
1647 if (lus == NULL) {
1648 ret = LTTCOMM_UST_SESS_FAIL;
1649 goto error;
1650 }
1651
1652 ret = mkdir_recursive(lus->path, S_IRWXU | S_IRWXG,
1653 geteuid(), allowed_group());
1654 if (ret < 0) {
1655 if (ret != -EEXIST) {
1656 ERR("Trace directory creation error");
1657 ret = LTTCOMM_UST_SESS_FAIL;
1658 goto error;
1659 }
1660 }
1661
1662 /* Create session on the UST tracer */
1663 ret = ustctl_create_session(app->sock, lus);
1664 if (ret < 0) {
1665 ret = LTTCOMM_UST_SESS_FAIL;
1666 goto error;
1667 }
1668
1669 cds_list_add(&lus->list, &session->ust_session_list.head);
1670 session->ust_session_list.count++;
1671
1672 return LTTCOMM_OK;
1673
1674 error:
1675 free(lus);
1676 return ret;
1677 }
1678
1679 /*
1680 * Create a kernel tracer session then create the default channel.
1681 */
1682 static int create_kernel_session(struct ltt_session *session)
1683 {
1684 int ret;
1685
1686 DBG("Creating kernel session");
1687
1688 ret = kernel_create_session(session, kernel_tracer_fd);
1689 if (ret < 0) {
1690 ret = LTTCOMM_KERN_SESS_FAIL;
1691 goto error;
1692 }
1693
1694 /* Set kernel consumer socket fd */
1695 if (kconsumerd_cmd_sock) {
1696 session->kernel_session->consumer_fd = kconsumerd_cmd_sock;
1697 }
1698
1699 ret = mkdir_recursive(session->kernel_session->trace_path,
1700 S_IRWXU | S_IRWXG, geteuid(), allowed_group());
1701 if (ret < 0) {
1702 if (ret != -EEXIST) {
1703 ERR("Trace directory creation error");
1704 goto error;
1705 }
1706 }
1707
1708 error:
1709 return ret;
1710 }
1711
1712 /*
1713 * Using the session list, filled a lttng_session array to send back to the
1714 * client for session listing.
1715 *
1716 * The session list lock MUST be acquired before calling this function. Use
1717 * session_lock_list() and session_unlock_list().
1718 */
1719 static void list_lttng_sessions(struct lttng_session *sessions)
1720 {
1721 int i = 0;
1722 struct ltt_session *session;
1723
1724 DBG("Getting all available session");
1725 /*
1726 * Iterate over session list and append data after the control struct in
1727 * the buffer.
1728 */
1729 cds_list_for_each_entry(session, &session_list_ptr->head, list) {
1730 strncpy(sessions[i].path, session->path, PATH_MAX);
1731 sessions[i].path[PATH_MAX - 1] = '\0';
1732 strncpy(sessions[i].name, session->name, NAME_MAX);
1733 sessions[i].name[NAME_MAX - 1] = '\0';
1734 i++;
1735 }
1736 }
1737
1738 /*
1739 * Fill lttng_channel array of all channels.
1740 */
1741 static void list_lttng_channels(struct ltt_session *session,
1742 struct lttng_channel *channels)
1743 {
1744 int i = 0;
1745 struct ltt_kernel_channel *kchan;
1746
1747 DBG("Listing channels for session %s", session->name);
1748
1749 /* Kernel channels */
1750 if (session->kernel_session != NULL) {
1751 cds_list_for_each_entry(kchan,
1752 &session->kernel_session->channel_list.head, list) {
1753 /* Copy lttng_channel struct to array */
1754 memcpy(&channels[i], kchan->channel, sizeof(struct lttng_channel));
1755 channels[i].enabled = kchan->enabled;
1756 i++;
1757 }
1758 }
1759
1760 /* TODO: Missing UST listing */
1761 }
1762
1763 /*
1764 * Fill lttng_event array of all events in the channel.
1765 */
1766 static void list_lttng_events(struct ltt_kernel_channel *kchan,
1767 struct lttng_event *events)
1768 {
1769 /*
1770 * TODO: This is ONLY kernel. Need UST support.
1771 */
1772 int i = 0;
1773 struct ltt_kernel_event *event;
1774
1775 DBG("Listing events for channel %s", kchan->channel->name);
1776
1777 /* Kernel channels */
1778 cds_list_for_each_entry(event, &kchan->events_list.head , list) {
1779 strncpy(events[i].name, event->event->name, LTTNG_SYMBOL_NAME_LEN);
1780 events[i].name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
1781 events[i].enabled = event->enabled;
1782 switch (event->event->instrumentation) {
1783 case LTTNG_KERNEL_TRACEPOINT:
1784 events[i].type = LTTNG_EVENT_TRACEPOINT;
1785 break;
1786 case LTTNG_KERNEL_KPROBE:
1787 case LTTNG_KERNEL_KRETPROBE:
1788 events[i].type = LTTNG_EVENT_PROBE;
1789 memcpy(&events[i].attr.probe, &event->event->u.kprobe,
1790 sizeof(struct lttng_kernel_kprobe));
1791 break;
1792 case LTTNG_KERNEL_FUNCTION:
1793 events[i].type = LTTNG_EVENT_FUNCTION;
1794 memcpy(&events[i].attr.ftrace, &event->event->u.ftrace,
1795 sizeof(struct lttng_kernel_function));
1796 break;
1797 case LTTNG_KERNEL_NOOP:
1798 events[i].type = LTTNG_EVENT_NOOP;
1799 break;
1800 case LTTNG_KERNEL_SYSCALL:
1801 events[i].type = LTTNG_EVENT_SYSCALL;
1802 break;
1803 case LTTNG_KERNEL_ALL:
1804 assert(0);
1805 break;
1806 }
1807 i++;
1808 }
1809 }
1810
1811 /*
1812 * Command LTTNG_DISABLE_CHANNEL processed by the client thread.
1813 */
1814 static int cmd_disable_channel(struct ltt_session *session,
1815 int domain, char *channel_name)
1816 {
1817 int ret;
1818
1819 switch (domain) {
1820 case LTTNG_DOMAIN_KERNEL:
1821 ret = channel_kernel_disable(session->kernel_session,
1822 channel_name);
1823 if (ret != LTTCOMM_OK) {
1824 goto error;
1825 }
1826
1827 kernel_wait_quiescent(kernel_tracer_fd);
1828 break;
1829 case LTTNG_DOMAIN_UST_PID:
1830 break;
1831 default:
1832 ret = LTTCOMM_UNKNOWN_DOMAIN;
1833 goto error;
1834 }
1835
1836 ret = LTTCOMM_OK;
1837
1838 error:
1839 return ret;
1840 }
1841
1842 /*
1843 * Copy channel from attributes and set it in the application channel list.
1844 */
1845 static int copy_ust_channel_to_app(struct ltt_ust_session *usess,
1846 struct lttng_channel *attr, struct ust_app *app)
1847 {
1848 int ret;
1849 struct ltt_ust_channel *uchan, *new_chan;
1850
1851 uchan = trace_ust_get_channel_by_name(attr->name, usess);
1852 if (uchan == NULL) {
1853 ret = LTTCOMM_FATAL;
1854 goto error;
1855 }
1856
1857 new_chan = trace_ust_create_channel(attr, usess->path);
1858 if (new_chan == NULL) {
1859 PERROR("malloc ltt_ust_channel");
1860 ret = LTTCOMM_FATAL;
1861 goto error;
1862 }
1863
1864 ret = channel_ust_copy(new_chan, uchan);
1865 if (ret < 0) {
1866 ret = LTTCOMM_FATAL;
1867 goto error;
1868 }
1869
1870 /* Add channel to the ust app channel list */
1871 cds_list_add(&new_chan->list, &app->channels.head);
1872 app->channels.count++;
1873
1874 error:
1875 return ret;
1876 }
1877
1878 /*
1879 * Command LTTNG_ENABLE_CHANNEL processed by the client thread.
1880 */
1881 static int cmd_enable_channel(struct ltt_session *session,
1882 struct lttng_domain *domain, struct lttng_channel *attr)
1883 {
1884 int ret;
1885
1886 switch (domain->type) {
1887 case LTTNG_DOMAIN_KERNEL:
1888 {
1889 struct ltt_kernel_channel *kchan;
1890
1891 kchan = trace_kernel_get_channel_by_name(attr->name,
1892 session->kernel_session);
1893 if (kchan == NULL) {
1894 ret = channel_kernel_create(session->kernel_session,
1895 attr, kernel_poll_pipe[1]);
1896 } else {
1897 ret = channel_kernel_enable(session->kernel_session, kchan);
1898 }
1899
1900 if (ret != LTTCOMM_OK) {
1901 goto error;
1902 }
1903
1904 kernel_wait_quiescent(kernel_tracer_fd);
1905 break;
1906 }
1907 case LTTNG_DOMAIN_UST_PID:
1908 {
1909 int sock;
1910 struct ltt_ust_channel *uchan;
1911 struct ltt_ust_session *usess;
1912 struct ust_app *app;
1913
1914 usess = trace_ust_get_session_by_pid(&session->ust_session_list,
1915 domain->attr.pid);
1916 if (usess == NULL) {
1917 ret = LTTCOMM_UST_CHAN_NOT_FOUND;
1918 goto error;
1919 }
1920
1921 app = ust_app_get_by_pid(domain->attr.pid);
1922 if (app == NULL) {
1923 ret = LTTCOMM_APP_NOT_FOUND;
1924 goto error;
1925 }
1926 sock = app->sock;
1927
1928 uchan = trace_ust_get_channel_by_name(attr->name, usess);
1929 if (uchan == NULL) {
1930 ret = channel_ust_create(usess, attr, sock);
1931 } else {
1932 ret = channel_ust_enable(usess, uchan, sock);
1933 }
1934
1935 if (ret != LTTCOMM_OK) {
1936 goto error;
1937 }
1938
1939 ret = copy_ust_channel_to_app(usess, attr, app);
1940 if (ret != LTTCOMM_OK) {
1941 goto error;
1942 }
1943
1944 DBG("UST channel %s created for app sock %d with pid %d",
1945 attr->name, app->sock, domain->attr.pid);
1946 break;
1947 }
1948 default:
1949 ret = LTTCOMM_UNKNOWN_DOMAIN;
1950 goto error;
1951 }
1952
1953 ret = LTTCOMM_OK;
1954
1955 error:
1956 return ret;
1957 }
1958
1959 /*
1960 * Command LTTNG_DISABLE_EVENT processed by the client thread.
1961 */
1962 static int cmd_disable_event(struct ltt_session *session, int domain,
1963 char *channel_name, char *event_name)
1964 {
1965 int ret;
1966 struct ltt_kernel_channel *kchan;
1967
1968 switch (domain) {
1969 case LTTNG_DOMAIN_KERNEL:
1970 kchan = trace_kernel_get_channel_by_name(channel_name,
1971 session->kernel_session);
1972 if (kchan == NULL) {
1973 ret = LTTCOMM_KERN_CHAN_NOT_FOUND;
1974 goto error;
1975 }
1976
1977 ret = event_kernel_disable_tracepoint(session->kernel_session, kchan, event_name);
1978 if (ret != LTTCOMM_OK) {
1979 goto error;
1980 }
1981
1982 kernel_wait_quiescent(kernel_tracer_fd);
1983 break;
1984 default:
1985 /* TODO: Userspace tracing */
1986 ret = LTTCOMM_NOT_IMPLEMENTED;
1987 goto error;
1988 }
1989
1990 ret = LTTCOMM_OK;
1991
1992 error:
1993 return ret;
1994 }
1995
1996 /*
1997 * Command LTTNG_DISABLE_ALL_EVENT processed by the client thread.
1998 */
1999 static int cmd_disable_event_all(struct ltt_session *session, int domain,
2000 char *channel_name)
2001 {
2002 int ret;
2003 struct ltt_kernel_channel *kchan;
2004
2005 switch (domain) {
2006 case LTTNG_DOMAIN_KERNEL:
2007 kchan = trace_kernel_get_channel_by_name(channel_name,
2008 session->kernel_session);
2009 if (kchan == NULL) {
2010 ret = LTTCOMM_KERN_CHAN_NOT_FOUND;
2011 goto error;
2012 }
2013
2014 ret = event_kernel_disable_all(session->kernel_session, kchan);
2015 if (ret != LTTCOMM_OK) {
2016 goto error;
2017 }
2018
2019 kernel_wait_quiescent(kernel_tracer_fd);
2020 break;
2021 default:
2022 /* TODO: Userspace tracing */
2023 ret = LTTCOMM_NOT_IMPLEMENTED;
2024 goto error;
2025 }
2026
2027 ret = LTTCOMM_OK;
2028
2029 error:
2030 return ret;
2031 }
2032
2033 /*
2034 * Command LTTNG_ADD_CONTEXT processed by the client thread.
2035 */
2036 static int cmd_add_context(struct ltt_session *session, int domain,
2037 char *channel_name, char *event_name, struct lttng_event_context *ctx)
2038 {
2039 int ret;
2040
2041 switch (domain) {
2042 case LTTNG_DOMAIN_KERNEL:
2043 /* Add kernel context to kernel tracer */
2044 ret = context_kernel_add(session->kernel_session, ctx,
2045 event_name, channel_name);
2046 if (ret != LTTCOMM_OK) {
2047 goto error;
2048 }
2049
2050 break;
2051 default:
2052 /* TODO: Userspace tracing */
2053 ret = LTTCOMM_NOT_IMPLEMENTED;
2054 goto error;
2055 }
2056
2057 ret = LTTCOMM_OK;
2058
2059 error:
2060 return ret;
2061 }
2062
2063 /*
2064 * Command LTTNG_ENABLE_EVENT processed by the client thread.
2065 */
2066 static int cmd_enable_event(struct ltt_session *session, int domain,
2067 char *channel_name, struct lttng_event *event)
2068 {
2069 int ret;
2070 struct ltt_kernel_channel *kchan;
2071
2072 switch (domain) {
2073 case LTTNG_DOMAIN_KERNEL:
2074 kchan = trace_kernel_get_channel_by_name(channel_name,
2075 session->kernel_session);
2076 if (kchan == NULL) {
2077 /* This call will notify the kernel thread */
2078 ret = channel_kernel_create(session->kernel_session,
2079 NULL, kernel_poll_pipe[1]);
2080 if (ret != LTTCOMM_OK) {
2081 goto error;
2082 }
2083 }
2084
2085 /* Get the newly created kernel channel pointer */
2086 kchan = trace_kernel_get_channel_by_name(channel_name,
2087 session->kernel_session);
2088 if (kchan == NULL) {
2089 /* This sould not happen... */
2090 ret = LTTCOMM_FATAL;
2091 goto error;
2092 }
2093
2094 ret = event_kernel_enable_tracepoint(session->kernel_session, kchan, event);
2095 if (ret != LTTCOMM_OK) {
2096 goto error;
2097 }
2098
2099 kernel_wait_quiescent(kernel_tracer_fd);
2100 break;
2101 default:
2102 /* TODO: Userspace tracing */
2103 ret = LTTCOMM_NOT_IMPLEMENTED;
2104 goto error;
2105 }
2106
2107 ret = LTTCOMM_OK;
2108
2109 error:
2110 return ret;
2111 }
2112
2113 /*
2114 * Command LTTNG_ENABLE_ALL_EVENT processed by the client thread.
2115 */
2116 static int cmd_enable_event_all(struct ltt_session *session, int domain,
2117 char *channel_name, int event_type)
2118 {
2119 int ret;
2120 struct ltt_kernel_channel *kchan;
2121
2122 switch (domain) {
2123 case LTTNG_DOMAIN_KERNEL:
2124 kchan = trace_kernel_get_channel_by_name(channel_name,
2125 session->kernel_session);
2126 if (kchan == NULL) {
2127 /* This call will notify the kernel thread */
2128 ret = channel_kernel_create(session->kernel_session, NULL,
2129 kernel_poll_pipe[1]);
2130 if (ret != LTTCOMM_OK) {
2131 goto error;
2132 }
2133 }
2134
2135 /* Get the newly created kernel channel pointer */
2136 kchan = trace_kernel_get_channel_by_name(channel_name,
2137 session->kernel_session);
2138 if (kchan == NULL) {
2139 /* This sould not happen... */
2140 ret = LTTCOMM_FATAL;
2141 goto error;
2142 }
2143
2144 switch (event_type) {
2145 case LTTNG_KERNEL_SYSCALL:
2146 ret = event_kernel_enable_all_syscalls(session->kernel_session,
2147 kchan, kernel_tracer_fd);
2148 break;
2149 case LTTNG_KERNEL_TRACEPOINT:
2150 /*
2151 * This call enables all LTTNG_KERNEL_TRACEPOINTS and
2152 * events already registered to the channel.
2153 */
2154 ret = event_kernel_enable_all_tracepoints(session->kernel_session,
2155 kchan, kernel_tracer_fd);
2156 break;
2157 case LTTNG_KERNEL_ALL:
2158 /* Enable syscalls and tracepoints */
2159 ret = event_kernel_enable_all(session->kernel_session,
2160 kchan, kernel_tracer_fd);
2161 break;
2162 default:
2163 ret = LTTCOMM_KERN_ENABLE_FAIL;
2164 goto error;
2165 }
2166 if (ret != LTTCOMM_OK) {
2167 goto error;
2168 }
2169
2170 kernel_wait_quiescent(kernel_tracer_fd);
2171 break;
2172 default:
2173 /* TODO: Userspace tracing */
2174 ret = LTTCOMM_NOT_IMPLEMENTED;
2175 goto error;
2176 }
2177
2178 ret = LTTCOMM_OK;
2179
2180 error:
2181 return ret;
2182 }
2183
2184 /*
2185 * Command LTTNG_LIST_TRACEPOINTS processed by the client thread.
2186 */
2187 static ssize_t cmd_list_tracepoints(int domain, struct lttng_event **events)
2188 {
2189 int ret;
2190 ssize_t nb_events = 0;
2191
2192 switch (domain) {
2193 case LTTNG_DOMAIN_KERNEL:
2194 nb_events = kernel_list_events(kernel_tracer_fd, events);
2195 if (nb_events < 0) {
2196 ret = LTTCOMM_KERN_LIST_FAIL;
2197 goto error;
2198 }
2199 break;
2200 default:
2201 /* TODO: Userspace listing */
2202 ret = LTTCOMM_NOT_IMPLEMENTED;
2203 goto error;
2204 }
2205
2206 return nb_events;
2207
2208 error:
2209 /* Return negative value to differentiate return code */
2210 return -ret;
2211 }
2212
2213 /*
2214 * Command LTTNG_START_TRACE processed by the client thread.
2215 */
2216 static int cmd_start_trace(struct ltt_session *session)
2217 {
2218 int ret;
2219 struct ltt_kernel_channel *kchan;
2220 struct ltt_kernel_session *ksession;
2221
2222 /* Short cut */
2223 ksession = session->kernel_session;
2224
2225 /* Kernel tracing */
2226 if (ksession != NULL) {
2227 /* Open kernel metadata */
2228 if (ksession->metadata == NULL) {
2229 ret = kernel_open_metadata(ksession, ksession->trace_path);
2230 if (ret < 0) {
2231 ret = LTTCOMM_KERN_META_FAIL;
2232 goto error;
2233 }
2234 }
2235
2236 /* Open kernel metadata stream */
2237 if (ksession->metadata_stream_fd == 0) {
2238 ret = kernel_open_metadata_stream(ksession);
2239 if (ret < 0) {
2240 ERR("Kernel create metadata stream failed");
2241 ret = LTTCOMM_KERN_STREAM_FAIL;
2242 goto error;
2243 }
2244 }
2245
2246 /* For each channel */
2247 cds_list_for_each_entry(kchan, &ksession->channel_list.head, list) {
2248 if (kchan->stream_count == 0) {
2249 ret = kernel_open_channel_stream(kchan);
2250 if (ret < 0) {
2251 ret = LTTCOMM_KERN_STREAM_FAIL;
2252 goto error;
2253 }
2254 /* Update the stream global counter */
2255 ksession->stream_count_global += ret;
2256 }
2257 }
2258
2259 /* Setup kernel consumer socket and send fds to it */
2260 ret = init_kernel_tracing(ksession);
2261 if (ret < 0) {
2262 ret = LTTCOMM_KERN_START_FAIL;
2263 goto error;
2264 }
2265
2266 /* This start the kernel tracing */
2267 ret = kernel_start_session(ksession);
2268 if (ret < 0) {
2269 ret = LTTCOMM_KERN_START_FAIL;
2270 goto error;
2271 }
2272
2273 /* Quiescent wait after starting trace */
2274 kernel_wait_quiescent(kernel_tracer_fd);
2275 }
2276
2277 /* TODO: Start all UST traces */
2278
2279 ret = LTTCOMM_OK;
2280
2281 error:
2282 return ret;
2283 }
2284
2285 /*
2286 * Command LTTNG_STOP_TRACE processed by the client thread.
2287 */
2288 static int cmd_stop_trace(struct ltt_session *session)
2289 {
2290 int ret;
2291 struct ltt_kernel_channel *kchan;
2292 struct ltt_kernel_session *ksession;
2293
2294 /* Short cut */
2295 ksession = session->kernel_session;
2296
2297 /* Kernel tracer */
2298 if (ksession != NULL) {
2299 DBG("Stop kernel tracing");
2300
2301 /* Flush all buffers before stopping */
2302 ret = kernel_metadata_flush_buffer(ksession->metadata_stream_fd);
2303 if (ret < 0) {
2304 ERR("Kernel metadata flush failed");
2305 }
2306
2307 cds_list_for_each_entry(kchan, &ksession->channel_list.head, list) {
2308 ret = kernel_flush_buffer(kchan);
2309 if (ret < 0) {
2310 ERR("Kernel flush buffer error");
2311 }
2312 }
2313
2314 ret = kernel_stop_session(ksession);
2315 if (ret < 0) {
2316 ret = LTTCOMM_KERN_STOP_FAIL;
2317 goto error;
2318 }
2319
2320 kernel_wait_quiescent(kernel_tracer_fd);
2321 }
2322
2323 /* TODO : User-space tracer */
2324
2325 ret = LTTCOMM_OK;
2326
2327 error:
2328 return ret;
2329 }
2330
2331 /*
2332 * Command LTTNG_CREATE_SESSION processed by the client thread.
2333 */
2334 static int cmd_create_session(char *name, char *path)
2335 {
2336 int ret;
2337
2338 ret = session_create(name, path);
2339 if (ret != LTTCOMM_OK) {
2340 goto error;
2341 }
2342
2343 ret = LTTCOMM_OK;
2344
2345 error:
2346 return ret;
2347 }
2348
2349 /*
2350 * Command LTTNG_DESTROY_SESSION processed by the client thread.
2351 */
2352 static int cmd_destroy_session(struct ltt_session *session, char *name)
2353 {
2354 int ret;
2355
2356 /* Clean kernel session teardown */
2357 teardown_kernel_session(session);
2358
2359 /*
2360 * Must notify the kernel thread here to update it's poll setin order
2361 * to remove the channel(s)' fd just destroyed.
2362 */
2363 ret = notify_thread_pipe(kernel_poll_pipe[1]);
2364 if (ret < 0) {
2365 perror("write kernel poll pipe");
2366 }
2367
2368 ret = session_destroy(name);
2369
2370 return ret;
2371 }
2372
2373 /*
2374 * Command LTTNG_CALIBRATE processed by the client thread.
2375 */
2376 static int cmd_calibrate(int domain, struct lttng_calibrate *calibrate)
2377 {
2378 int ret;
2379
2380 switch (domain) {
2381 case LTTNG_DOMAIN_KERNEL:
2382 {
2383 struct lttng_kernel_calibrate kcalibrate;
2384
2385 kcalibrate.type = calibrate->type;
2386 ret = kernel_calibrate(kernel_tracer_fd, &kcalibrate);
2387 if (ret < 0) {
2388 ret = LTTCOMM_KERN_ENABLE_FAIL;
2389 goto error;
2390 }
2391 break;
2392 }
2393 default:
2394 /* TODO: Userspace tracing */
2395 ret = LTTCOMM_NOT_IMPLEMENTED;
2396 goto error;
2397 }
2398
2399 ret = LTTCOMM_OK;
2400
2401 error:
2402 return ret;
2403 }
2404
2405 /*
2406 * Command LTTNG_REGISTER_CONSUMER processed by the client thread.
2407 */
2408 static int cmd_register_consumer(struct ltt_session *session, int domain,
2409 char *sock_path)
2410 {
2411 int ret, sock;
2412
2413 switch (domain) {
2414 case LTTNG_DOMAIN_KERNEL:
2415 /* Can't register a consumer if there is already one */
2416 if (session->kernel_session->consumer_fd != 0) {
2417 ret = LTTCOMM_KERN_CONSUMER_FAIL;
2418 goto error;
2419 }
2420
2421 sock = lttcomm_connect_unix_sock(sock_path);
2422 if (sock < 0) {
2423 ret = LTTCOMM_CONNECT_FAIL;
2424 goto error;
2425 }
2426
2427 session->kernel_session->consumer_fd = sock;
2428 break;
2429 default:
2430 /* TODO: Userspace tracing */
2431 ret = LTTCOMM_NOT_IMPLEMENTED;
2432 goto error;
2433 }
2434
2435 ret = LTTCOMM_OK;
2436
2437 error:
2438 return ret;
2439 }
2440
2441 /*
2442 * Command LTTNG_LIST_DOMAINS processed by the client thread.
2443 */
2444 static ssize_t cmd_list_domains(struct ltt_session *session,
2445 struct lttng_domain **domains)
2446 {
2447 int ret;
2448 ssize_t nb_dom = 0;
2449
2450 if (session->kernel_session != NULL) {
2451 nb_dom++;
2452 }
2453
2454 nb_dom += session->ust_session_list.count;
2455
2456 *domains = malloc(nb_dom * sizeof(struct lttng_domain));
2457 if (*domains == NULL) {
2458 ret = -LTTCOMM_FATAL;
2459 goto error;
2460 }
2461
2462 (*domains)[0].type = LTTNG_DOMAIN_KERNEL;
2463
2464 /* TODO: User-space tracer domain support */
2465
2466 return nb_dom;
2467
2468 error:
2469 return ret;
2470 }
2471
2472 /*
2473 * Command LTTNG_LIST_CHANNELS processed by the client thread.
2474 */
2475 static ssize_t cmd_list_channels(struct ltt_session *session,
2476 struct lttng_channel **channels)
2477 {
2478 int ret;
2479 ssize_t nb_chan = 0;
2480
2481 if (session->kernel_session != NULL) {
2482 nb_chan += session->kernel_session->channel_count;
2483 }
2484
2485 *channels = malloc(nb_chan * sizeof(struct lttng_channel));
2486 if (*channels == NULL) {
2487 ret = -LTTCOMM_FATAL;
2488 goto error;
2489 }
2490
2491 list_lttng_channels(session, *channels);
2492
2493 return nb_chan;
2494
2495 error:
2496 return ret;
2497 }
2498
2499 /*
2500 * Command LTTNG_LIST_EVENTS processed by the client thread.
2501 */
2502 static ssize_t cmd_list_events(struct ltt_session *session,
2503 char *channel_name, struct lttng_event **events)
2504 {
2505 int ret;
2506 ssize_t nb_event = 0;
2507 struct ltt_kernel_channel *kchan = NULL;
2508
2509 if (session->kernel_session != NULL) {
2510 kchan = trace_kernel_get_channel_by_name(channel_name,
2511 session->kernel_session);
2512 if (kchan == NULL) {
2513 ret = -LTTCOMM_KERN_CHAN_NOT_FOUND;
2514 goto error;
2515 }
2516 nb_event += kchan->event_count;
2517 }
2518
2519 *events = malloc(nb_event * sizeof(struct lttng_event));
2520 if (*events == NULL) {
2521 ret = -LTTCOMM_FATAL;
2522 goto error;
2523 }
2524
2525 list_lttng_events(kchan, *events);
2526
2527 /* TODO: User-space tracer support */
2528
2529 return nb_event;
2530
2531 error:
2532 return ret;
2533 }
2534
2535 /*
2536 * Process the command requested by the lttng client within the command
2537 * context structure. This function make sure that the return structure (llm)
2538 * is set and ready for transmission before returning.
2539 *
2540 * Return any error encountered or 0 for success.
2541 */
2542 static int process_client_msg(struct command_ctx *cmd_ctx)
2543 {
2544 int ret = LTTCOMM_OK;
2545 int need_tracing_session = 1;
2546
2547 DBG("Processing client command %d", cmd_ctx->lsm->cmd_type);
2548
2549 /*
2550 * Check for command that don't needs to allocate a returned payload. We do
2551 * this here so we don't have to make the call for no payload at each
2552 * command.
2553 */
2554 switch(cmd_ctx->lsm->cmd_type) {
2555 case LTTNG_LIST_SESSIONS:
2556 case LTTNG_LIST_TRACEPOINTS:
2557 case LTTNG_LIST_DOMAINS:
2558 case LTTNG_LIST_CHANNELS:
2559 case LTTNG_LIST_EVENTS:
2560 break;
2561 default:
2562 /* Setup lttng message with no payload */
2563 ret = setup_lttng_msg(cmd_ctx, 0);
2564 if (ret < 0) {
2565 /* This label does not try to unlock the session */
2566 goto init_setup_error;
2567 }
2568 }
2569
2570 /* Commands that DO NOT need a session. */
2571 switch (cmd_ctx->lsm->cmd_type) {
2572 case LTTNG_CALIBRATE:
2573 case LTTNG_CREATE_SESSION:
2574 case LTTNG_LIST_SESSIONS:
2575 case LTTNG_LIST_TRACEPOINTS:
2576 need_tracing_session = 0;
2577 break;
2578 default:
2579 DBG("Getting session %s by name", cmd_ctx->lsm->session.name);
2580 cmd_ctx->session = session_find_by_name(cmd_ctx->lsm->session.name);
2581 if (cmd_ctx->session == NULL) {
2582 if (cmd_ctx->lsm->session.name != NULL) {
2583 ret = LTTCOMM_SESS_NOT_FOUND;
2584 } else {
2585 /* If no session name specified */
2586 ret = LTTCOMM_SELECT_SESS;
2587 }
2588 goto error;
2589 } else {
2590 /* Acquire lock for the session */
2591 session_lock(cmd_ctx->session);
2592 }
2593 break;
2594 }
2595
2596 /*
2597 * Check domain type for specific "pre-action".
2598 */
2599 switch (cmd_ctx->lsm->domain.type) {
2600 case LTTNG_DOMAIN_KERNEL:
2601 /* Kernel tracer check */
2602 if (kernel_tracer_fd == 0) {
2603 /* Basically, load kernel tracer modules */
2604 init_kernel_tracer();
2605 if (kernel_tracer_fd == 0) {
2606 ret = LTTCOMM_KERN_NA;
2607 goto error;
2608 }
2609 }
2610
2611 /* Need a session for kernel command */
2612 if (need_tracing_session) {
2613 if (cmd_ctx->session->kernel_session == NULL) {
2614 ret = create_kernel_session(cmd_ctx->session);
2615 if (ret < 0) {
2616 ret = LTTCOMM_KERN_SESS_FAIL;
2617 goto error;
2618 }
2619 }
2620
2621 /* Start the kernel consumer daemon */
2622 if (kconsumerd_pid == 0 &&
2623 cmd_ctx->lsm->cmd_type != LTTNG_REGISTER_CONSUMER) {
2624 ret = start_kconsumerd();
2625 if (ret < 0) {
2626 ret = LTTCOMM_KERN_CONSUMER_FAIL;
2627 goto error;
2628 }
2629 }
2630 }
2631 break;
2632 case LTTNG_DOMAIN_UST_PID:
2633 {
2634 struct ltt_ust_session *usess;
2635
2636 if (need_tracing_session) {
2637 usess = trace_ust_get_session_by_pid(
2638 &cmd_ctx->session->ust_session_list,
2639 cmd_ctx->lsm->domain.attr.pid);
2640 if (usess == NULL) {
2641 ret = create_ust_session(cmd_ctx->session,
2642 &cmd_ctx->lsm->domain);
2643 if (ret != LTTCOMM_OK) {
2644 goto error;
2645 }
2646 }
2647 }
2648 break;
2649 }
2650 default:
2651 /* TODO Userspace tracer */
2652 break;
2653 }
2654
2655 /* Process by command type */
2656 switch (cmd_ctx->lsm->cmd_type) {
2657 case LTTNG_ADD_CONTEXT:
2658 {
2659 ret = cmd_add_context(cmd_ctx->session, cmd_ctx->lsm->domain.type,
2660 cmd_ctx->lsm->u.context.channel_name,
2661 cmd_ctx->lsm->u.context.event_name,
2662 &cmd_ctx->lsm->u.context.ctx);
2663 break;
2664 }
2665 case LTTNG_DISABLE_CHANNEL:
2666 {
2667 ret = cmd_disable_channel(cmd_ctx->session, cmd_ctx->lsm->domain.type,
2668 cmd_ctx->lsm->u.disable.channel_name);
2669 break;
2670 }
2671 case LTTNG_DISABLE_EVENT:
2672 {
2673 ret = cmd_disable_event(cmd_ctx->session, cmd_ctx->lsm->domain.type,
2674 cmd_ctx->lsm->u.disable.channel_name,
2675 cmd_ctx->lsm->u.disable.name);
2676 ret = LTTCOMM_OK;
2677 break;
2678 }
2679 case LTTNG_DISABLE_ALL_EVENT:
2680 {
2681 DBG("Disabling all kernel event");
2682
2683 ret = cmd_disable_event_all(cmd_ctx->session, cmd_ctx->lsm->domain.type,
2684 cmd_ctx->lsm->u.disable.channel_name);
2685 break;
2686 }
2687 case LTTNG_ENABLE_CHANNEL:
2688 {
2689 ret = cmd_enable_channel(cmd_ctx->session, &cmd_ctx->lsm->domain,
2690 &cmd_ctx->lsm->u.channel.chan);
2691 break;
2692 }
2693 case LTTNG_ENABLE_EVENT:
2694 {
2695 ret = cmd_enable_event(cmd_ctx->session, cmd_ctx->lsm->domain.type,
2696 cmd_ctx->lsm->u.enable.channel_name,
2697 &cmd_ctx->lsm->u.enable.event);
2698 break;
2699 }
2700 case LTTNG_ENABLE_ALL_EVENT:
2701 {
2702 DBG("Enabling all kernel event");
2703
2704 ret = cmd_enable_event_all(cmd_ctx->session, cmd_ctx->lsm->domain.type,
2705 cmd_ctx->lsm->u.enable.channel_name,
2706 cmd_ctx->lsm->u.enable.event.type);
2707 break;
2708 }
2709 case LTTNG_LIST_TRACEPOINTS:
2710 {
2711 struct lttng_event *events;
2712 ssize_t nb_events;
2713
2714 nb_events = cmd_list_tracepoints(cmd_ctx->lsm->domain.type, &events);
2715 if (nb_events < 0) {
2716 ret = -nb_events;
2717 goto error;
2718 }
2719
2720 /*
2721 * Setup lttng message with payload size set to the event list size in
2722 * bytes and then copy list into the llm payload.
2723 */
2724 ret = setup_lttng_msg(cmd_ctx, sizeof(struct lttng_event) * nb_events);
2725 if (ret < 0) {
2726 free(events);
2727 goto setup_error;
2728 }
2729
2730 /* Copy event list into message payload */
2731 memcpy(cmd_ctx->llm->payload, events,
2732 sizeof(struct lttng_event) * nb_events);
2733
2734 free(events);
2735
2736 ret = LTTCOMM_OK;
2737 break;
2738 }
2739 case LTTNG_START_TRACE:
2740 {
2741 ret = cmd_start_trace(cmd_ctx->session);
2742 break;
2743 }
2744 case LTTNG_STOP_TRACE:
2745 {
2746 ret = cmd_stop_trace(cmd_ctx->session);
2747 break;
2748 }
2749 case LTTNG_CREATE_SESSION:
2750 {
2751 tracepoint(create_session_start);
2752 ret = cmd_create_session(cmd_ctx->lsm->session.name,
2753 cmd_ctx->lsm->session.path);
2754 tracepoint(create_session_end);
2755 break;
2756 }
2757 case LTTNG_DESTROY_SESSION:
2758 {
2759 tracepoint(destroy_session_start);
2760 ret = cmd_destroy_session(cmd_ctx->session,
2761 cmd_ctx->lsm->session.name);
2762 tracepoint(destroy_session_end);
2763 break;
2764 }
2765 case LTTNG_LIST_DOMAINS:
2766 {
2767 ssize_t nb_dom;
2768 struct lttng_domain *domains;
2769
2770 nb_dom = cmd_list_domains(cmd_ctx->session, &domains);
2771 if (nb_dom < 0) {
2772 ret = -nb_dom;
2773 goto error;
2774 }
2775
2776 ret = setup_lttng_msg(cmd_ctx, nb_dom * sizeof(struct lttng_domain));
2777 if (ret < 0) {
2778 goto setup_error;
2779 }
2780
2781 /* Copy event list into message payload */
2782 memcpy(cmd_ctx->llm->payload, domains,
2783 nb_dom * sizeof(struct lttng_domain));
2784
2785 free(domains);
2786
2787 ret = LTTCOMM_OK;
2788 break;
2789 }
2790 case LTTNG_LIST_CHANNELS:
2791 {
2792 size_t nb_chan;
2793 struct lttng_channel *channels;
2794
2795 nb_chan = cmd_list_channels(cmd_ctx->session, &channels);
2796 if (nb_chan < 0) {
2797 ret = -nb_chan;
2798 goto error;
2799 }
2800
2801 ret = setup_lttng_msg(cmd_ctx, nb_chan * sizeof(struct lttng_channel));
2802 if (ret < 0) {
2803 goto setup_error;
2804 }
2805
2806 /* Copy event list into message payload */
2807 memcpy(cmd_ctx->llm->payload, channels,
2808 nb_chan * sizeof(struct lttng_channel));
2809
2810 free(channels);
2811
2812 ret = LTTCOMM_OK;
2813 break;
2814 }
2815 case LTTNG_LIST_EVENTS:
2816 {
2817 size_t nb_event;
2818 struct lttng_event *events = NULL;
2819
2820 nb_event = cmd_list_events(cmd_ctx->session,
2821 cmd_ctx->lsm->u.list.channel_name, &events);
2822 if (nb_event < 0) {
2823 ret = -nb_event;
2824 goto error;
2825 }
2826
2827 ret = setup_lttng_msg(cmd_ctx, nb_event * sizeof(struct lttng_event));
2828 if (ret < 0) {
2829 goto setup_error;
2830 }
2831
2832 /* Copy event list into message payload */
2833 memcpy(cmd_ctx->llm->payload, events,
2834 nb_event * sizeof(struct lttng_event));
2835
2836 free(events);
2837
2838 ret = LTTCOMM_OK;
2839 break;
2840 }
2841 case LTTNG_LIST_SESSIONS:
2842 {
2843 session_lock_list();
2844
2845 if (session_list_ptr->count == 0) {
2846 ret = LTTCOMM_NO_SESSION;
2847 session_unlock_list();
2848 goto error;
2849 }
2850
2851 ret = setup_lttng_msg(cmd_ctx, sizeof(struct lttng_session) *
2852 session_list_ptr->count);
2853 if (ret < 0) {
2854 session_unlock_list();
2855 goto setup_error;
2856 }
2857
2858 /* Filled the session array */
2859 list_lttng_sessions((struct lttng_session *)(cmd_ctx->llm->payload));
2860
2861 session_unlock_list();
2862
2863 ret = LTTCOMM_OK;
2864 break;
2865 }
2866 case LTTNG_CALIBRATE:
2867 {
2868 ret = cmd_calibrate(cmd_ctx->lsm->domain.type,
2869 &cmd_ctx->lsm->u.calibrate);
2870 break;
2871 }
2872 case LTTNG_REGISTER_CONSUMER:
2873 {
2874 ret = cmd_register_consumer(cmd_ctx->session, cmd_ctx->lsm->domain.type,
2875 cmd_ctx->lsm->u.reg.path);
2876 break;
2877 }
2878 default:
2879 ret = LTTCOMM_UND;
2880 break;
2881 }
2882
2883 error:
2884 if (cmd_ctx->llm == NULL) {
2885 DBG("Missing llm structure. Allocating one.");
2886 if (setup_lttng_msg(cmd_ctx, 0) < 0) {
2887 goto setup_error;
2888 }
2889 }
2890 /* Set return code */
2891 cmd_ctx->llm->ret_code = ret;
2892 setup_error:
2893 if (cmd_ctx->session) {
2894 session_unlock(cmd_ctx->session);
2895 }
2896 init_setup_error:
2897 return ret;
2898 }
2899
2900 /*
2901 * This thread manage all clients request using the unix client socket for
2902 * communication.
2903 */
2904 static void *thread_manage_clients(void *data)
2905 {
2906 int sock = 0, ret, i, pollfd;
2907 uint32_t revents, nb_fd;
2908 struct command_ctx *cmd_ctx = NULL;
2909 struct lttng_poll_event events;
2910
2911 tracepoint(sessiond_th_cli_start);
2912
2913 DBG("[thread] Manage client started");
2914
2915 ret = lttcomm_listen_unix_sock(client_sock);
2916 if (ret < 0) {
2917 goto error;
2918 }
2919
2920 /*
2921 * Pass 2 as size here for the thread quit pipe and client_sock. Nothing
2922 * more will be added to this poll set.
2923 */
2924 ret = create_thread_poll_set(&events, 2);
2925 if (ret < 0) {
2926 goto error;
2927 }
2928
2929 /* Add the application registration socket */
2930 ret = lttng_poll_add(&events, client_sock, LPOLLIN | LPOLLPRI);
2931 if (ret < 0) {
2932 goto error;
2933 }
2934
2935 /*
2936 * Notify parent pid that we are ready to accept command for client side.
2937 */
2938 if (opt_sig_parent) {
2939 kill(ppid, SIGCHLD);
2940 }
2941
2942 while (1) {
2943 DBG("Accepting client command ...");
2944
2945 tracepoint(sessiond_th_cli_poll);
2946
2947 nb_fd = LTTNG_POLL_GETNB(&events);
2948
2949 /* Inifinite blocking call, waiting for transmission */
2950 ret = lttng_poll_wait(&events, -1);
2951 if (ret < 0) {
2952 goto error;
2953 }
2954
2955 for (i = 0; i < nb_fd; i++) {
2956 /* Fetch once the poll data */
2957 revents = LTTNG_POLL_GETEV(&events, i);
2958 pollfd = LTTNG_POLL_GETFD(&events, i);
2959
2960 /* Thread quit pipe has been closed. Killing thread. */
2961 ret = check_thread_quit_pipe(pollfd, revents);
2962 if (ret) {
2963 goto error;
2964 }
2965
2966 /* Event on the registration socket */
2967 if (pollfd == client_sock) {
2968 if (revents & (LPOLLERR | LPOLLHUP | LPOLLRDHUP)) {
2969 ERR("Client socket poll error");
2970 goto error;
2971 }
2972 }
2973 }
2974
2975 DBG("Wait for client response");
2976
2977 sock = lttcomm_accept_unix_sock(client_sock);
2978 if (sock < 0) {
2979 goto error;
2980 }
2981
2982 /* Allocate context command to process the client request */
2983 cmd_ctx = malloc(sizeof(struct command_ctx));
2984 if (cmd_ctx == NULL) {
2985 perror("malloc cmd_ctx");
2986 goto error;
2987 }
2988
2989 /* Allocate data buffer for reception */
2990 cmd_ctx->lsm = malloc(sizeof(struct lttcomm_session_msg));
2991 if (cmd_ctx->lsm == NULL) {
2992 perror("malloc cmd_ctx->lsm");
2993 goto error;
2994 }
2995
2996 cmd_ctx->llm = NULL;
2997 cmd_ctx->session = NULL;
2998
2999 /*
3000 * Data is received from the lttng client. The struct
3001 * lttcomm_session_msg (lsm) contains the command and data request of
3002 * the client.
3003 */
3004 DBG("Receiving data from client ...");
3005 ret = lttcomm_recv_unix_sock(sock, cmd_ctx->lsm,
3006 sizeof(struct lttcomm_session_msg));
3007 if (ret <= 0) {
3008 DBG("Nothing recv() from client... continuing");
3009 close(sock);
3010 free(cmd_ctx);
3011 continue;
3012 }
3013
3014 // TODO: Validate cmd_ctx including sanity check for
3015 // security purpose.
3016
3017 /*
3018 * This function dispatch the work to the kernel or userspace tracer
3019 * libs and fill the lttcomm_lttng_msg data structure of all the needed
3020 * informations for the client. The command context struct contains
3021 * everything this function may needs.
3022 */
3023 ret = process_client_msg(cmd_ctx);
3024 if (ret < 0) {
3025 /*
3026 * TODO: Inform client somehow of the fatal error. At
3027 * this point, ret < 0 means that a malloc failed
3028 * (ENOMEM). Error detected but still accept command.
3029 */
3030 clean_command_ctx(&cmd_ctx);
3031 continue;
3032 }
3033
3034 DBG("Sending response (size: %d, retcode: %s)",
3035 cmd_ctx->lttng_msg_size,
3036 lttng_get_readable_code(-cmd_ctx->llm->ret_code));
3037 ret = send_unix_sock(sock, cmd_ctx->llm, cmd_ctx->lttng_msg_size);
3038 if (ret < 0) {
3039 ERR("Failed to send data back to client");
3040 }
3041
3042 clean_command_ctx(&cmd_ctx);
3043
3044 /* End of transmission */
3045 close(sock);
3046 }
3047
3048 error:
3049 DBG("Client thread dying");
3050 unlink(client_unix_sock_path);
3051 close(client_sock);
3052 close(sock);
3053
3054 lttng_poll_clean(&events);
3055 clean_command_ctx(&cmd_ctx);
3056 return NULL;
3057 }
3058
3059
3060 /*
3061 * usage function on stderr
3062 */
3063 static void usage(void)
3064 {
3065 fprintf(stderr, "Usage: %s OPTIONS\n\nOptions:\n", progname);
3066 fprintf(stderr, " -h, --help Display this usage.\n");
3067 fprintf(stderr, " -c, --client-sock PATH Specify path for the client unix socket\n");
3068 fprintf(stderr, " -a, --apps-sock PATH Specify path for apps unix socket\n");
3069 fprintf(stderr, " --kconsumerd-err-sock PATH Specify path for the kernel consumer error socket\n");
3070 fprintf(stderr, " --kconsumerd-cmd-sock PATH Specify path for the kernel consumer command socket\n");
3071 fprintf(stderr, " -d, --daemonize Start as a daemon.\n");
3072 fprintf(stderr, " -g, --group NAME Specify the tracing group name. (default: tracing)\n");
3073 fprintf(stderr, " -V, --version Show version number.\n");
3074 fprintf(stderr, " -S, --sig-parent Send SIGCHLD to parent pid to notify readiness.\n");
3075 fprintf(stderr, " -q, --quiet No output at all.\n");
3076 fprintf(stderr, " -v, --verbose Verbose mode. Activate DBG() macro.\n");
3077 fprintf(stderr, " --verbose-kconsumerd Verbose mode for kconsumerd. Activate DBG() macro.\n");
3078 }
3079
3080 /*
3081 * daemon argument parsing
3082 */
3083 static int parse_args(int argc, char **argv)
3084 {
3085 int c;
3086
3087 static struct option long_options[] = {
3088 { "client-sock", 1, 0, 'c' },
3089 { "apps-sock", 1, 0, 'a' },
3090 { "kconsumerd-cmd-sock", 1, 0, 0 },
3091 { "kconsumerd-err-sock", 1, 0, 0 },
3092 { "daemonize", 0, 0, 'd' },
3093 { "sig-parent", 0, 0, 'S' },
3094 { "help", 0, 0, 'h' },
3095 { "group", 1, 0, 'g' },
3096 { "version", 0, 0, 'V' },
3097 { "quiet", 0, 0, 'q' },
3098 { "verbose", 0, 0, 'v' },
3099 { "verbose-kconsumerd", 0, 0, 'Z' },
3100 { NULL, 0, 0, 0 }
3101 };
3102
3103 while (1) {
3104 int option_index = 0;
3105 c = getopt_long(argc, argv, "dhqvVS" "a:c:g:s:E:C:Z",
3106 long_options, &option_index);
3107 if (c == -1) {
3108 break;
3109 }
3110
3111 switch (c) {
3112 case 0:
3113 fprintf(stderr, "option %s", long_options[option_index].name);
3114 if (optarg) {
3115 fprintf(stderr, " with arg %s\n", optarg);
3116 }
3117 break;
3118 case 'c':
3119 snprintf(client_unix_sock_path, PATH_MAX, "%s", optarg);
3120 break;
3121 case 'a':
3122 snprintf(apps_unix_sock_path, PATH_MAX, "%s", optarg);
3123 break;
3124 case 'd':
3125 opt_daemon = 1;
3126 break;
3127 case 'g':
3128 opt_tracing_group = strdup(optarg);
3129 break;
3130 case 'h':
3131 usage();
3132 exit(EXIT_FAILURE);
3133 case 'V':
3134 fprintf(stdout, "%s\n", VERSION);
3135 exit(EXIT_SUCCESS);
3136 case 'S':
3137 opt_sig_parent = 1;
3138 break;
3139 case 'E':
3140 snprintf(kconsumerd_err_unix_sock_path, PATH_MAX, "%s", optarg);
3141 break;
3142 case 'C':
3143 snprintf(kconsumerd_cmd_unix_sock_path, PATH_MAX, "%s", optarg);
3144 break;
3145 case 'q':
3146 opt_quiet = 1;
3147 break;
3148 case 'v':
3149 /* Verbose level can increase using multiple -v */
3150 opt_verbose += 1;
3151 break;
3152 case 'Z':
3153 opt_verbose_kconsumerd += 1;
3154 break;
3155 default:
3156 /* Unknown option or other error.
3157 * Error is printed by getopt, just return */
3158 return -1;
3159 }
3160 }
3161
3162 return 0;
3163 }
3164
3165 /*
3166 * Creates the two needed socket by the daemon.
3167 * apps_sock - The communication socket for all UST apps.
3168 * client_sock - The communication of the cli tool (lttng).
3169 */
3170 static int init_daemon_socket(void)
3171 {
3172 int ret = 0;
3173 mode_t old_umask;
3174
3175 old_umask = umask(0);
3176
3177 /* Create client tool unix socket */
3178 client_sock = lttcomm_create_unix_sock(client_unix_sock_path);
3179 if (client_sock < 0) {
3180 ERR("Create unix sock failed: %s", client_unix_sock_path);
3181 ret = -1;
3182 goto end;
3183 }
3184
3185 /* File permission MUST be 660 */
3186 ret = chmod(client_unix_sock_path, S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP);
3187 if (ret < 0) {
3188 ERR("Set file permissions failed: %s", client_unix_sock_path);
3189 perror("chmod");
3190 goto end;
3191 }
3192
3193 /* Create the application unix socket */
3194 apps_sock = lttcomm_create_unix_sock(apps_unix_sock_path);
3195 if (apps_sock < 0) {
3196 ERR("Create unix sock failed: %s", apps_unix_sock_path);
3197 ret = -1;
3198 goto end;
3199 }
3200
3201 /* File permission MUST be 666 */
3202 ret = chmod(apps_unix_sock_path,
3203 S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH | S_IWOTH);
3204 if (ret < 0) {
3205 ERR("Set file permissions failed: %s", apps_unix_sock_path);
3206 perror("chmod");
3207 goto end;
3208 }
3209
3210 end:
3211 umask(old_umask);
3212 return ret;
3213 }
3214
3215 /*
3216 * Check if the global socket is available, and if a daemon is answering at the
3217 * other side. If yes, error is returned.
3218 */
3219 static int check_existing_daemon(void)
3220 {
3221 if (access(client_unix_sock_path, F_OK) < 0 &&
3222 access(apps_unix_sock_path, F_OK) < 0) {
3223 return 0;
3224 }
3225
3226 /* Is there anybody out there ? */
3227 if (lttng_session_daemon_alive()) {
3228 return -EEXIST;
3229 } else {
3230 return 0;
3231 }
3232 }
3233
3234 /*
3235 * Set the tracing group gid onto the client socket.
3236 *
3237 * Race window between mkdir and chown is OK because we are going from more
3238 * permissive (root.root) to les permissive (root.tracing).
3239 */
3240 static int set_permissions(void)
3241 {
3242 int ret;
3243 gid_t gid;
3244
3245 gid = allowed_group();
3246 if (gid < 0) {
3247 if (is_root) {
3248 WARN("No tracing group detected");
3249 ret = 0;
3250 } else {
3251 ERR("Missing tracing group. Aborting execution.");
3252 ret = -1;
3253 }
3254 goto end;
3255 }
3256
3257 /* Set lttng run dir */
3258 ret = chown(LTTNG_RUNDIR, 0, gid);
3259 if (ret < 0) {
3260 ERR("Unable to set group on " LTTNG_RUNDIR);
3261 perror("chown");
3262 }
3263
3264 /* lttng client socket path */
3265 ret = chown(client_unix_sock_path, 0, gid);
3266 if (ret < 0) {
3267 ERR("Unable to set group on %s", client_unix_sock_path);
3268 perror("chown");
3269 }
3270
3271 /* kconsumerd error socket path */
3272 ret = chown(kconsumerd_err_unix_sock_path, 0, gid);
3273 if (ret < 0) {
3274 ERR("Unable to set group on %s", kconsumerd_err_unix_sock_path);
3275 perror("chown");
3276 }
3277
3278 DBG("All permissions are set");
3279
3280 end:
3281 return ret;
3282 }
3283
3284 /*
3285 * Create the pipe used to wake up the kernel thread.
3286 */
3287 static int create_kernel_poll_pipe(void)
3288 {
3289 return pipe2(kernel_poll_pipe, O_CLOEXEC);
3290 }
3291
3292 /*
3293 * Create the application command pipe to wake thread_manage_apps.
3294 */
3295 static int create_apps_cmd_pipe(void)
3296 {
3297 return pipe2(apps_cmd_pipe, O_CLOEXEC);
3298 }
3299
3300 /*
3301 * Create the lttng run directory needed for all global sockets and pipe.
3302 */
3303 static int create_lttng_rundir(void)
3304 {
3305 int ret;
3306
3307 ret = mkdir(LTTNG_RUNDIR, S_IRWXU | S_IRWXG );
3308 if (ret < 0) {
3309 if (errno != EEXIST) {
3310 ERR("Unable to create " LTTNG_RUNDIR);
3311 goto error;
3312 } else {
3313 ret = 0;
3314 }
3315 }
3316
3317 error:
3318 return ret;
3319 }
3320
3321 /*
3322 * Setup sockets and directory needed by the kconsumerd communication with the
3323 * session daemon.
3324 */
3325 static int set_kconsumerd_sockets(void)
3326 {
3327 int ret;
3328
3329 if (strlen(kconsumerd_err_unix_sock_path) == 0) {
3330 snprintf(kconsumerd_err_unix_sock_path, PATH_MAX,
3331 KCONSUMERD_ERR_SOCK_PATH);
3332 }
3333
3334 if (strlen(kconsumerd_cmd_unix_sock_path) == 0) {
3335 snprintf(kconsumerd_cmd_unix_sock_path, PATH_MAX,
3336 KCONSUMERD_CMD_SOCK_PATH);
3337 }
3338
3339 ret = mkdir(KCONSUMERD_PATH, S_IRWXU | S_IRWXG);
3340 if (ret < 0) {
3341 if (errno != EEXIST) {
3342 ERR("Failed to create " KCONSUMERD_PATH);
3343 goto error;
3344 }
3345 ret = 0;
3346 }
3347
3348 /* Create the kconsumerd error unix socket */
3349 kconsumerd_err_sock =
3350 lttcomm_create_unix_sock(kconsumerd_err_unix_sock_path);
3351 if (kconsumerd_err_sock < 0) {
3352 ERR("Create unix sock failed: %s", kconsumerd_err_unix_sock_path);
3353 ret = -1;
3354 goto error;
3355 }
3356
3357 /* File permission MUST be 660 */
3358 ret = chmod(kconsumerd_err_unix_sock_path,
3359 S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP);
3360 if (ret < 0) {
3361 ERR("Set file permissions failed: %s", kconsumerd_err_unix_sock_path);
3362 perror("chmod");
3363 goto error;
3364 }
3365
3366 error:
3367 return ret;
3368 }
3369
3370 /*
3371 * Signal handler for the daemon
3372 *
3373 * Simply stop all worker threads, leaving main() return gracefully after
3374 * joining all threads and calling cleanup().
3375 */
3376 static void sighandler(int sig)
3377 {
3378 switch (sig) {
3379 case SIGPIPE:
3380 DBG("SIGPIPE catched");
3381 return;
3382 case SIGINT:
3383 DBG("SIGINT catched");
3384 stop_threads();
3385 break;
3386 case SIGTERM:
3387 DBG("SIGTERM catched");
3388 stop_threads();
3389 break;
3390 default:
3391 break;
3392 }
3393 }
3394
3395 /*
3396 * Setup signal handler for :
3397 * SIGINT, SIGTERM, SIGPIPE
3398 */
3399 static int set_signal_handler(void)
3400 {
3401 int ret = 0;
3402 struct sigaction sa;
3403 sigset_t sigset;
3404
3405 if ((ret = sigemptyset(&sigset)) < 0) {
3406 perror("sigemptyset");
3407 return ret;
3408 }
3409
3410 sa.sa_handler = sighandler;
3411 sa.sa_mask = sigset;
3412 sa.sa_flags = 0;
3413 if ((ret = sigaction(SIGTERM, &sa, NULL)) < 0) {
3414 perror("sigaction");
3415 return ret;
3416 }
3417
3418 if ((ret = sigaction(SIGINT, &sa, NULL)) < 0) {
3419 perror("sigaction");
3420 return ret;
3421 }
3422
3423 if ((ret = sigaction(SIGPIPE, &sa, NULL)) < 0) {
3424 perror("sigaction");
3425 return ret;
3426 }
3427
3428 DBG("Signal handler set for SIGTERM, SIGPIPE and SIGINT");
3429
3430 return ret;
3431 }
3432
3433 /*
3434 * Set open files limit to unlimited. This daemon can open a large number of
3435 * file descriptors in order to consumer multiple kernel traces.
3436 */
3437 static void set_ulimit(void)
3438 {
3439 int ret;
3440 struct rlimit lim;
3441
3442 /* The kernel does not allowed an infinite limit for open files */
3443 lim.rlim_cur = 65535;
3444 lim.rlim_max = 65535;
3445
3446 ret = setrlimit(RLIMIT_NOFILE, &lim);
3447 if (ret < 0) {
3448 perror("failed to set open files limit");
3449 }
3450 }
3451
3452 /*
3453 * main
3454 */
3455 int main(int argc, char **argv)
3456 {
3457 int ret = 0;
3458 void *status;
3459 const char *home_path;
3460
3461 tracepoint(sessiond_boot_start);
3462
3463 /* Create thread quit pipe */
3464 if ((ret = init_thread_quit_pipe()) < 0) {
3465 goto error;
3466 }
3467
3468 /* Parse arguments */
3469 progname = argv[0];
3470 if ((ret = parse_args(argc, argv) < 0)) {
3471 goto error;
3472 }
3473
3474 /* Daemonize */
3475 if (opt_daemon) {
3476 ret = daemon(0, 0);
3477 if (ret < 0) {
3478 perror("daemon");
3479 goto error;
3480 }
3481 }
3482
3483 /* Check if daemon is UID = 0 */
3484 is_root = !getuid();
3485
3486 if (is_root) {
3487 ret = create_lttng_rundir();
3488 if (ret < 0) {
3489 goto error;
3490 }
3491
3492 if (strlen(apps_unix_sock_path) == 0) {
3493 snprintf(apps_unix_sock_path, PATH_MAX,
3494 DEFAULT_GLOBAL_APPS_UNIX_SOCK);
3495 }
3496
3497 if (strlen(client_unix_sock_path) == 0) {
3498 snprintf(client_unix_sock_path, PATH_MAX,
3499 DEFAULT_GLOBAL_CLIENT_UNIX_SOCK);
3500 }
3501
3502 /* Set global SHM for ust */
3503 if (strlen(wait_shm_path) == 0) {
3504 snprintf(wait_shm_path, PATH_MAX,
3505 DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH);
3506 }
3507 } else {
3508 home_path = get_home_dir();
3509 if (home_path == NULL) {
3510 /* TODO: Add --socket PATH option */
3511 ERR("Can't get HOME directory for sockets creation.");
3512 ret = -EPERM;
3513 goto error;
3514 }
3515
3516 if (strlen(apps_unix_sock_path) == 0) {
3517 snprintf(apps_unix_sock_path, PATH_MAX,
3518 DEFAULT_HOME_APPS_UNIX_SOCK, home_path);
3519 }
3520
3521 /* Set the cli tool unix socket path */
3522 if (strlen(client_unix_sock_path) == 0) {
3523 snprintf(client_unix_sock_path, PATH_MAX,
3524 DEFAULT_HOME_CLIENT_UNIX_SOCK, home_path);
3525 }
3526
3527 /* Set global SHM for ust */
3528 if (strlen(wait_shm_path) == 0) {
3529 snprintf(wait_shm_path, PATH_MAX,
3530 DEFAULT_HOME_APPS_WAIT_SHM_PATH, geteuid());
3531 }
3532 }
3533
3534 DBG("Client socket path %s", client_unix_sock_path);
3535 DBG("Application socket path %s", apps_unix_sock_path);
3536
3537 /*
3538 * See if daemon already exist.
3539 */
3540 if ((ret = check_existing_daemon()) < 0) {
3541 ERR("Already running daemon.\n");
3542 /*
3543 * We do not goto exit because we must not cleanup()
3544 * because a daemon is already running.
3545 */
3546 goto error;
3547 }
3548
3549 /* After this point, we can safely call cleanup() with "goto exit" */
3550
3551 /*
3552 * These actions must be executed as root. We do that *after* setting up
3553 * the sockets path because we MUST make the check for another daemon using
3554 * those paths *before* trying to set the kernel consumer sockets and init
3555 * kernel tracer.
3556 */
3557 if (is_root) {
3558 ret = set_kconsumerd_sockets();
3559 if (ret < 0) {
3560 goto exit;
3561 }
3562
3563 /* Setup kernel tracer */
3564 init_kernel_tracer();
3565
3566 /* Set ulimit for open files */
3567 set_ulimit();
3568 }
3569
3570 if ((ret = set_signal_handler()) < 0) {
3571 goto exit;
3572 }
3573
3574 /* Setup the needed unix socket */
3575 if ((ret = init_daemon_socket()) < 0) {
3576 goto exit;
3577 }
3578
3579 /* Set credentials to socket */
3580 if (is_root && ((ret = set_permissions()) < 0)) {
3581 goto exit;
3582 }
3583
3584 /* Get parent pid if -S, --sig-parent is specified. */
3585 if (opt_sig_parent) {
3586 ppid = getppid();
3587 }
3588
3589 /* Setup the kernel pipe for waking up the kernel thread */
3590 if ((ret = create_kernel_poll_pipe()) < 0) {
3591 goto exit;
3592 }
3593
3594 /* Setup the thread apps communication pipe. */
3595 if ((ret = create_apps_cmd_pipe()) < 0) {
3596 goto exit;
3597 }
3598
3599 /* Init UST command queue. */
3600 cds_wfq_init(&ust_cmd_queue.queue);
3601
3602 /*
3603 * Get session list pointer. This pointer MUST NOT be free(). This list is
3604 * statically declared in session.c
3605 */
3606 session_list_ptr = session_get_list();
3607
3608 /* Set up max poll set size */
3609 lttng_poll_set_max_size();
3610
3611 /* Create thread to manage the client socket */
3612 ret = pthread_create(&client_thread, NULL,
3613 thread_manage_clients, (void *) NULL);
3614 if (ret != 0) {
3615 perror("pthread_create clients");
3616 goto exit_client;
3617 }
3618
3619 /* Create thread to dispatch registration */
3620 ret = pthread_create(&dispatch_thread, NULL,
3621 thread_dispatch_ust_registration, (void *) NULL);
3622 if (ret != 0) {
3623 perror("pthread_create dispatch");
3624 goto exit_dispatch;
3625 }
3626
3627 /* Create thread to manage application registration. */
3628 ret = pthread_create(&reg_apps_thread, NULL,
3629 thread_registration_apps, (void *) NULL);
3630 if (ret != 0) {
3631 perror("pthread_create registration");
3632 goto exit_reg_apps;
3633 }
3634
3635 /* Create thread to manage application socket */
3636 ret = pthread_create(&apps_thread, NULL,
3637 thread_manage_apps, (void *) NULL);
3638 if (ret != 0) {
3639 perror("pthread_create apps");
3640 goto exit_apps;
3641 }
3642
3643 /* Create kernel thread to manage kernel event */
3644 ret = pthread_create(&kernel_thread, NULL,
3645 thread_manage_kernel, (void *) NULL);
3646 if (ret != 0) {
3647 perror("pthread_create kernel");
3648 goto exit_kernel;
3649 }
3650
3651 tracepoint(sessiond_boot_end);
3652
3653 ret = pthread_join(kernel_thread, &status);
3654 if (ret != 0) {
3655 perror("pthread_join");
3656 goto error; /* join error, exit without cleanup */
3657 }
3658
3659 exit_kernel:
3660 ret = pthread_join(apps_thread, &status);
3661 if (ret != 0) {
3662 perror("pthread_join");
3663 goto error; /* join error, exit without cleanup */
3664 }
3665
3666 exit_apps:
3667 ret = pthread_join(reg_apps_thread, &status);
3668 if (ret != 0) {
3669 perror("pthread_join");
3670 goto error; /* join error, exit without cleanup */
3671 }
3672
3673 exit_reg_apps:
3674 ret = pthread_join(dispatch_thread, &status);
3675 if (ret != 0) {
3676 perror("pthread_join");
3677 goto error; /* join error, exit without cleanup */
3678 }
3679
3680 exit_dispatch:
3681 ret = pthread_join(client_thread, &status);
3682 if (ret != 0) {
3683 perror("pthread_join");
3684 goto error; /* join error, exit without cleanup */
3685 }
3686
3687 ret = join_kconsumerd_thread();
3688 if (ret != 0) {
3689 perror("join_kconsumerd");
3690 goto error; /* join error, exit without cleanup */
3691 }
3692
3693 exit_client:
3694 exit:
3695 /*
3696 * cleanup() is called when no other thread is running.
3697 */
3698 cleanup();
3699 if (!ret)
3700 exit(EXIT_SUCCESS);
3701 error:
3702 exit(EXIT_FAILURE);
3703 }
This page took 0.099605 seconds and 5 git commands to generate.