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