1373a74b28212d5595d8c4f0dc18a89938e6a616
[lttng-tools.git] / src / bin / lttng-consumerd / lttng-consumerd.c
1 /*
2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License, version 2 only,
7 * as published by the Free Software Foundation.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17 */
18
19 #define _LGPL_SOURCE
20 #include <fcntl.h>
21 #include <getopt.h>
22 #include <grp.h>
23 #include <limits.h>
24 #include <pthread.h>
25 #include <signal.h>
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <sys/ipc.h>
30 #include <sys/resource.h>
31 #include <sys/shm.h>
32 #include <sys/socket.h>
33 #include <sys/stat.h>
34 #include <sys/types.h>
35 #include <urcu/list.h>
36 #include <poll.h>
37 #include <unistd.h>
38 #include <sys/mman.h>
39 #include <assert.h>
40 #include <urcu/compiler.h>
41 #include <ulimit.h>
42
43 #include <common/defaults.h>
44 #include <common/common.h>
45 #include <common/consumer/consumer.h>
46 #include <common/consumer/consumer-timer.h>
47 #include <common/compat/poll.h>
48 #include <common/compat/getenv.h>
49 #include <common/sessiond-comm/sessiond-comm.h>
50 #include <common/utils.h>
51
52 #include "lttng-consumerd.h"
53 #include "health-consumerd.h"
54
55 /* threads (channel handling, poll, metadata, sessiond) */
56
57 static pthread_t channel_thread, data_thread, metadata_thread,
58 sessiond_thread, metadata_timer_thread, health_thread;
59
60 /* to count the number of times the user pressed ctrl+c */
61 static int sigintcount = 0;
62
63 /* Argument variables */
64 int lttng_opt_quiet; /* not static in error.h */
65 int lttng_opt_verbose; /* not static in error.h */
66 int lttng_opt_mi; /* not static in error.h */
67
68 static int opt_daemon;
69 static const char *progname;
70 static char command_sock_path[PATH_MAX]; /* Global command socket path */
71 static char error_sock_path[PATH_MAX]; /* Global error path */
72 static enum lttng_consumer_type opt_type = LTTNG_CONSUMER_KERNEL;
73
74 /* the liblttngconsumerd context */
75 static struct lttng_consumer_local_data *ctx;
76
77 /* Consumerd health monitoring */
78 struct health_app *health_consumerd;
79
80 const char *tracing_group_name = DEFAULT_TRACING_GROUP;
81
82 int lttng_consumer_ready = NR_LTTNG_CONSUMER_READY;
83
84 enum lttng_consumer_type lttng_consumer_get_type(void)
85 {
86 if (!ctx) {
87 return LTTNG_CONSUMER_UNKNOWN;
88 }
89 return ctx->type;
90 }
91
92 /*
93 * Signal handler for the daemon
94 */
95 static void sighandler(int sig)
96 {
97 if (sig == SIGINT && sigintcount++ == 0) {
98 DBG("ignoring first SIGINT");
99 return;
100 }
101
102 if (ctx) {
103 lttng_consumer_should_exit(ctx);
104 }
105 }
106
107 /*
108 * Setup signal handler for :
109 * SIGINT, SIGTERM, SIGPIPE
110 */
111 static int set_signal_handler(void)
112 {
113 int ret = 0;
114 struct sigaction sa;
115 sigset_t sigset;
116
117 if ((ret = sigemptyset(&sigset)) < 0) {
118 PERROR("sigemptyset");
119 return ret;
120 }
121
122 sa.sa_mask = sigset;
123 sa.sa_flags = 0;
124
125 sa.sa_handler = sighandler;
126 if ((ret = sigaction(SIGTERM, &sa, NULL)) < 0) {
127 PERROR("sigaction");
128 return ret;
129 }
130
131 if ((ret = sigaction(SIGINT, &sa, NULL)) < 0) {
132 PERROR("sigaction");
133 return ret;
134 }
135
136 sa.sa_handler = SIG_IGN;
137 if ((ret = sigaction(SIGPIPE, &sa, NULL)) < 0) {
138 PERROR("sigaction");
139 return ret;
140 }
141
142 return ret;
143 }
144
145 /*
146 * Usage function on stream file.
147 */
148 static void usage(FILE *fp)
149 {
150 fprintf(fp, "Usage: %s OPTIONS\n\nOptions:\n", progname);
151 fprintf(fp, " -h, --help "
152 "Display this usage.\n");
153 fprintf(fp, " -c, --consumerd-cmd-sock PATH "
154 "Specify path for the command socket\n");
155 fprintf(fp, " -e, --consumerd-err-sock PATH "
156 "Specify path for the error socket\n");
157 fprintf(fp, " -d, --daemonize "
158 "Start as a daemon.\n");
159 fprintf(fp, " -q, --quiet "
160 "No output at all.\n");
161 fprintf(fp, " -v, --verbose "
162 "Verbose mode. Activate DBG() macro.\n");
163 fprintf(fp, " -V, --version "
164 "Show version number.\n");
165 fprintf(fp, " -g, --group NAME "
166 "Specify the tracing group name. (default: tracing)\n");
167 fprintf(fp, " -k, --kernel "
168 "Consumer kernel buffers (default).\n");
169 fprintf(fp, " -u, --ust "
170 "Consumer UST buffers.%s\n",
171 #ifdef HAVE_LIBLTTNG_UST_CTL
172 ""
173 #else
174 " (support not compiled in)"
175 #endif
176 );
177 }
178
179 /*
180 * daemon argument parsing
181 */
182 static int parse_args(int argc, char **argv)
183 {
184 int c, ret = 0;
185
186 static struct option long_options[] = {
187 { "consumerd-cmd-sock", 1, 0, 'c' },
188 { "consumerd-err-sock", 1, 0, 'e' },
189 { "daemonize", 0, 0, 'd' },
190 { "group", 1, 0, 'g' },
191 { "help", 0, 0, 'h' },
192 { "quiet", 0, 0, 'q' },
193 { "verbose", 0, 0, 'v' },
194 { "version", 0, 0, 'V' },
195 { "kernel", 0, 0, 'k' },
196 #ifdef HAVE_LIBLTTNG_UST_CTL
197 { "ust", 0, 0, 'u' },
198 #endif
199 { NULL, 0, 0, 0 }
200 };
201
202 while (1) {
203 int option_index = 0;
204 c = getopt_long(argc, argv, "dhqvVku" "c:e:g:",
205 long_options, &option_index);
206 if (c == -1) {
207 break;
208 }
209
210 switch (c) {
211 case 0:
212 fprintf(stderr, "option %s",
213 long_options[option_index].name);
214 if (optarg) {
215 fprintf(stderr, " with arg %s\n", optarg);
216 ret = -1;
217 goto end;
218 }
219 break;
220 case 'c':
221 if (lttng_is_setuid_setgid()) {
222 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
223 "-c, --consumerd-cmd-sock");
224 } else {
225 snprintf(command_sock_path, PATH_MAX, "%s", optarg);
226 }
227 break;
228 case 'e':
229 if (lttng_is_setuid_setgid()) {
230 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
231 "-e, --consumerd-err-sock");
232 } else {
233 snprintf(error_sock_path, PATH_MAX, "%s", optarg);
234 }
235 break;
236 case 'd':
237 opt_daemon = 1;
238 break;
239 case 'g':
240 if (lttng_is_setuid_setgid()) {
241 WARN("Getting '%s' argument from setuid/setgid binary refused for security reasons.",
242 "-g, --group");
243 } else {
244 tracing_group_name = optarg;
245 }
246 break;
247 case 'h':
248 usage(stdout);
249 exit(EXIT_SUCCESS);
250 case 'q':
251 lttng_opt_quiet = 1;
252 break;
253 case 'v':
254 lttng_opt_verbose = 1;
255 break;
256 case 'V':
257 fprintf(stdout, "%s\n", VERSION);
258 exit(EXIT_SUCCESS);
259 case 'k':
260 opt_type = LTTNG_CONSUMER_KERNEL;
261 break;
262 #ifdef HAVE_LIBLTTNG_UST_CTL
263 case 'u':
264 # if (CAA_BITS_PER_LONG == 64)
265 opt_type = LTTNG_CONSUMER64_UST;
266 # elif (CAA_BITS_PER_LONG == 32)
267 opt_type = LTTNG_CONSUMER32_UST;
268 # else
269 # error "Unknown bitness"
270 # endif
271 break;
272 #endif
273 default:
274 usage(stderr);
275 ret = -1;
276 goto end;
277 }
278 }
279 end:
280 return ret;
281 }
282
283 /*
284 * Set open files limit to unlimited. This daemon can open a large number of
285 * file descriptors in order to consumer multiple kernel traces.
286 */
287 static void set_ulimit(void)
288 {
289 int ret;
290 struct rlimit lim;
291
292 /* The kernel does not allowed an infinite limit for open files */
293 lim.rlim_cur = 65535;
294 lim.rlim_max = 65535;
295
296 ret = setrlimit(RLIMIT_NOFILE, &lim);
297 if (ret < 0) {
298 PERROR("failed to set open files limit");
299 }
300 }
301
302 /*
303 * main
304 */
305 int main(int argc, char **argv)
306 {
307 int ret = 0, retval = 0;
308 void *status;
309 struct lttng_consumer_local_data *tmp_ctx;
310
311 if (set_signal_handler()) {
312 retval = -1;
313 goto exit_set_signal_handler;
314 }
315
316 /* Parse arguments */
317 progname = argv[0];
318 if (parse_args(argc, argv)) {
319 retval = -1;
320 goto exit_options;
321 }
322
323 /* Daemonize */
324 if (opt_daemon) {
325 int i;
326
327 /*
328 * fork
329 * child: setsid, close FD 0, 1, 2, chdir /
330 * parent: exit (if fork is successful)
331 */
332 ret = daemon(0, 0);
333 if (ret < 0) {
334 PERROR("daemon");
335 retval = -1;
336 goto exit_options;
337 }
338 /*
339 * We are in the child. Make sure all other file
340 * descriptors are closed, in case we are called with
341 * more opened file descriptors than the standard ones.
342 */
343 for (i = 3; i < sysconf(_SC_OPEN_MAX); i++) {
344 (void) close(i);
345 }
346 }
347
348 /*
349 * Starting from here, we can create threads. This needs to be after
350 * lttng_daemonize due to RCU.
351 */
352
353 health_consumerd = health_app_create(NR_HEALTH_CONSUMERD_TYPES);
354 if (!health_consumerd) {
355 retval = -1;
356 goto exit_health_consumerd_cleanup;
357 }
358
359 if (*command_sock_path == '\0') {
360 switch (opt_type) {
361 case LTTNG_CONSUMER_KERNEL:
362 ret = snprintf(command_sock_path, PATH_MAX,
363 DEFAULT_KCONSUMERD_CMD_SOCK_PATH,
364 DEFAULT_LTTNG_RUNDIR);
365 if (ret < 0) {
366 retval = -1;
367 goto exit_init_data;
368 }
369 break;
370 case LTTNG_CONSUMER64_UST:
371 ret = snprintf(command_sock_path, PATH_MAX,
372 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH,
373 DEFAULT_LTTNG_RUNDIR);
374 if (ret < 0) {
375 retval = -1;
376 goto exit_init_data;
377 }
378 break;
379 case LTTNG_CONSUMER32_UST:
380 ret = snprintf(command_sock_path, PATH_MAX,
381 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH,
382 DEFAULT_LTTNG_RUNDIR);
383 if (ret < 0) {
384 retval = -1;
385 goto exit_init_data;
386 }
387 break;
388 default:
389 ERR("Unknown consumerd type");
390 retval = -1;
391 goto exit_init_data;
392 }
393 }
394
395 /* Init */
396 if (lttng_consumer_init()) {
397 retval = -1;
398 goto exit_init_data;
399 }
400
401 /* Initialize communication library */
402 lttcomm_init();
403 /* Initialize TCP timeout values */
404 lttcomm_inet_init();
405
406 if (!getuid()) {
407 /* Set limit for open files */
408 set_ulimit();
409 }
410
411 if (run_as_create_worker(argv[0]) < 0) {
412 goto exit_init_data;
413 }
414
415 /* create the consumer instance with and assign the callbacks */
416 ctx = lttng_consumer_create(opt_type, lttng_consumer_read_subbuffer,
417 NULL, lttng_consumer_on_recv_stream, NULL);
418 if (!ctx) {
419 retval = -1;
420 goto exit_init_data;
421 }
422
423 lttng_consumer_set_command_sock_path(ctx, command_sock_path);
424 if (*error_sock_path == '\0') {
425 switch (opt_type) {
426 case LTTNG_CONSUMER_KERNEL:
427 ret = snprintf(error_sock_path, PATH_MAX,
428 DEFAULT_KCONSUMERD_ERR_SOCK_PATH,
429 DEFAULT_LTTNG_RUNDIR);
430 if (ret < 0) {
431 retval = -1;
432 goto exit_init_data;
433 }
434 break;
435 case LTTNG_CONSUMER64_UST:
436 ret = snprintf(error_sock_path, PATH_MAX,
437 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH,
438 DEFAULT_LTTNG_RUNDIR);
439 if (ret < 0) {
440 retval = -1;
441 goto exit_init_data;
442 }
443 break;
444 case LTTNG_CONSUMER32_UST:
445 ret = snprintf(error_sock_path, PATH_MAX,
446 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH,
447 DEFAULT_LTTNG_RUNDIR);
448 if (ret < 0) {
449 retval = -1;
450 goto exit_init_data;
451 }
452 break;
453 default:
454 ERR("Unknown consumerd type");
455 retval = -1;
456 goto exit_init_data;
457 }
458 }
459
460 /* Connect to the socket created by lttng-sessiond to report errors */
461 DBG("Connecting to error socket %s", error_sock_path);
462 ret = lttcomm_connect_unix_sock(error_sock_path);
463 /*
464 * Not a fatal error, but all communication with lttng-sessiond will
465 * fail.
466 */
467 if (ret < 0) {
468 WARN("Cannot connect to error socket (is lttng-sessiond started?)");
469 }
470 lttng_consumer_set_error_sock(ctx, ret);
471
472 /*
473 * Block RT signals used for UST periodical metadata flush and the live
474 * timer in main, and create a dedicated thread to handle these signals.
475 */
476 if (consumer_signal_init()) {
477 retval = -1;
478 goto exit_init_data;
479 }
480
481 ctx->type = opt_type;
482
483 if (utils_create_pipe(health_quit_pipe)) {
484 retval = -1;
485 goto exit_health_pipe;
486 }
487
488 /* Create thread to manage the client socket */
489 ret = pthread_create(&health_thread, default_pthread_attr(),
490 thread_manage_health, (void *) NULL);
491 if (ret) {
492 errno = ret;
493 PERROR("pthread_create health");
494 retval = -1;
495 goto exit_health_thread;
496 }
497
498 /*
499 * Wait for health thread to be initialized before letting the
500 * sessiond thread reply to the sessiond that we are ready.
501 */
502 while (uatomic_read(&lttng_consumer_ready)) {
503 usleep(100000);
504 }
505 cmm_smp_mb(); /* Read ready before following operations */
506
507 /* Create thread to manage channels */
508 ret = pthread_create(&channel_thread, default_pthread_attr(),
509 consumer_thread_channel_poll,
510 (void *) ctx);
511 if (ret) {
512 errno = ret;
513 PERROR("pthread_create");
514 retval = -1;
515 goto exit_channel_thread;
516 }
517
518 /* Create thread to manage the polling/writing of trace metadata */
519 ret = pthread_create(&metadata_thread, default_pthread_attr(),
520 consumer_thread_metadata_poll,
521 (void *) ctx);
522 if (ret) {
523 errno = ret;
524 PERROR("pthread_create");
525 retval = -1;
526 goto exit_metadata_thread;
527 }
528
529 /* Create thread to manage the polling/writing of trace data */
530 ret = pthread_create(&data_thread, default_pthread_attr(),
531 consumer_thread_data_poll, (void *) ctx);
532 if (ret) {
533 errno = ret;
534 PERROR("pthread_create");
535 retval = -1;
536 goto exit_data_thread;
537 }
538
539 /* Create the thread to manage the receive of fd */
540 ret = pthread_create(&sessiond_thread, default_pthread_attr(),
541 consumer_thread_sessiond_poll,
542 (void *) ctx);
543 if (ret) {
544 errno = ret;
545 PERROR("pthread_create");
546 retval = -1;
547 goto exit_sessiond_thread;
548 }
549
550 /*
551 * Create the thread to manage the UST metadata periodic timer and
552 * live timer.
553 */
554 ret = pthread_create(&metadata_timer_thread, default_pthread_attr(),
555 consumer_timer_thread, (void *) ctx);
556 if (ret) {
557 errno = ret;
558 PERROR("pthread_create");
559 retval = -1;
560 goto exit_metadata_timer_thread;
561 }
562
563 ret = pthread_detach(metadata_timer_thread);
564 if (ret) {
565 errno = ret;
566 PERROR("pthread_detach");
567 retval = -1;
568 goto exit_metadata_timer_detach;
569 }
570
571 /*
572 * This is where we start awaiting program completion (e.g. through
573 * signal that asks threads to teardown.
574 */
575
576 exit_metadata_timer_detach:
577 exit_metadata_timer_thread:
578 ret = pthread_join(sessiond_thread, &status);
579 if (ret) {
580 errno = ret;
581 PERROR("pthread_join sessiond_thread");
582 retval = -1;
583 }
584 exit_sessiond_thread:
585
586 ret = pthread_join(data_thread, &status);
587 if (ret) {
588 errno = ret;
589 PERROR("pthread_join data_thread");
590 retval = -1;
591 }
592 exit_data_thread:
593
594 ret = pthread_join(metadata_thread, &status);
595 if (ret) {
596 errno = ret;
597 PERROR("pthread_join metadata_thread");
598 retval = -1;
599 }
600 exit_metadata_thread:
601
602 ret = pthread_join(channel_thread, &status);
603 if (ret) {
604 errno = ret;
605 PERROR("pthread_join channel_thread");
606 retval = -1;
607 }
608 exit_channel_thread:
609
610 ret = pthread_join(health_thread, &status);
611 if (ret) {
612 errno = ret;
613 PERROR("pthread_join health_thread");
614 retval = -1;
615 }
616 exit_health_thread:
617
618 utils_close_pipe(health_quit_pipe);
619 exit_health_pipe:
620
621 exit_init_data:
622 tmp_ctx = ctx;
623 ctx = NULL;
624 cmm_barrier(); /* Clear ctx for signal handler. */
625 lttng_consumer_destroy(tmp_ctx);
626 lttng_consumer_cleanup();
627
628 if (health_consumerd) {
629 health_app_destroy(health_consumerd);
630 }
631 /* Ensure all prior call_rcu are done. */
632 rcu_barrier();
633
634 run_as_destroy_worker();
635
636 exit_health_consumerd_cleanup:
637 exit_options:
638 exit_set_signal_handler:
639
640 if (!retval) {
641 exit(EXIT_SUCCESS);
642 } else {
643 exit(EXIT_FAILURE);
644 }
645 }
This page took 0.06584 seconds and 3 git commands to generate.