2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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.
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.
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.
30 #include <sys/resource.h>
32 #include <sys/socket.h>
34 #include <sys/types.h>
35 #include <urcu/list.h>
41 #include <urcu/compiler.h>
44 #include <common/defaults.h>
45 #include <common/common.h>
46 #include <common/consumer.h>
47 #include <common/consumer-timer.h>
48 #include <common/compat/poll.h>
49 #include <common/sessiond-comm/sessiond-comm.h>
50 #include <common/utils.h>
52 #include "lttng-consumerd.h"
53 #include "health-consumerd.h"
55 /* TODO : support UST (all direct kernel-ctl accesses). */
57 /* threads (channel handling, poll, metadata, sessiond) */
59 static pthread_t channel_thread
, data_thread
, metadata_thread
,
60 sessiond_thread
, metadata_timer_thread
, health_thread
;
62 /* to count the number of times the user pressed ctrl+c */
63 static int sigintcount
= 0;
65 /* Argument variables */
66 int lttng_opt_quiet
; /* not static in error.h */
67 int lttng_opt_verbose
; /* not static in error.h */
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
;
74 /* the liblttngconsumerd context */
75 static struct lttng_consumer_local_data
*ctx
;
77 /* Consumerd health monitoring */
78 struct health_app
*health_consumerd
;
80 const char *tracing_group_name
= DEFAULT_TRACING_GROUP
;
82 enum lttng_consumer_type
lttng_consumer_get_type(void)
85 return LTTNG_CONSUMER_UNKNOWN
;
91 * Signal handler for the daemon
93 static void sighandler(int sig
)
95 if (sig
== SIGINT
&& sigintcount
++ == 0) {
96 DBG("ignoring first SIGINT");
101 * Ignore SIGPIPE because it should not stop the consumer whenever a
102 * SIGPIPE is catched through a FD operation.
104 if (sig
== SIGPIPE
) {
108 lttng_consumer_should_exit(ctx
);
112 * Setup signal handler for :
113 * SIGINT, SIGTERM, SIGPIPE
115 static int set_signal_handler(void)
121 if ((ret
= sigemptyset(&sigset
)) < 0) {
122 perror("sigemptyset");
126 sa
.sa_handler
= sighandler
;
129 if ((ret
= sigaction(SIGTERM
, &sa
, NULL
)) < 0) {
134 if ((ret
= sigaction(SIGINT
, &sa
, NULL
)) < 0) {
139 if ((ret
= sigaction(SIGPIPE
, &sa
, NULL
)) < 0) {
148 * Usage function on stream file.
150 static void usage(FILE *fp
)
152 fprintf(fp
, "Usage: %s OPTIONS\n\nOptions:\n", progname
);
153 fprintf(fp
, " -h, --help "
154 "Display this usage.\n");
155 fprintf(fp
, " -c, --consumerd-cmd-sock PATH "
156 "Specify path for the command socket\n");
157 fprintf(fp
, " -e, --consumerd-err-sock PATH "
158 "Specify path for the error socket\n");
159 fprintf(fp
, " -d, --daemonize "
160 "Start as a daemon.\n");
161 fprintf(fp
, " -q, --quiet "
162 "No output at all.\n");
163 fprintf(fp
, " -v, --verbose "
164 "Verbose mode. Activate DBG() macro.\n");
165 fprintf(fp
, " -V, --version "
166 "Show version number.\n");
167 fprintf(fp
, " -g, --group NAME "
168 "Specify the tracing group name. (default: tracing)\n");
169 fprintf(fp
, " -k, --kernel "
170 "Consumer kernel buffers (default).\n");
171 fprintf(fp
, " -u, --ust "
172 "Consumer UST buffers.%s\n",
173 #ifdef HAVE_LIBLTTNG_UST_CTL
176 " (support not compiled in)"
182 * daemon argument parsing
184 static void parse_args(int argc
, char **argv
)
188 static struct option long_options
[] = {
189 { "consumerd-cmd-sock", 1, 0, 'c' },
190 { "consumerd-err-sock", 1, 0, 'e' },
191 { "daemonize", 0, 0, 'd' },
192 { "group", 1, 0, 'g' },
193 { "help", 0, 0, 'h' },
194 { "quiet", 0, 0, 'q' },
195 { "verbose", 0, 0, 'v' },
196 { "version", 0, 0, 'V' },
197 { "kernel", 0, 0, 'k' },
198 #ifdef HAVE_LIBLTTNG_UST_CTL
199 { "ust", 0, 0, 'u' },
205 int option_index
= 0;
206 c
= getopt_long(argc
, argv
, "dhqvVku" "c:e:g:", long_options
, &option_index
);
213 fprintf(stderr
, "option %s", long_options
[option_index
].name
);
215 fprintf(stderr
, " with arg %s\n", optarg
);
219 snprintf(command_sock_path
, PATH_MAX
, "%s", optarg
);
222 snprintf(error_sock_path
, PATH_MAX
, "%s", optarg
);
228 tracing_group_name
= optarg
;
237 lttng_opt_verbose
= 1;
240 fprintf(stdout
, "%s\n", VERSION
);
243 opt_type
= LTTNG_CONSUMER_KERNEL
;
245 #ifdef HAVE_LIBLTTNG_UST_CTL
247 # if (CAA_BITS_PER_LONG == 64)
248 opt_type
= LTTNG_CONSUMER64_UST
;
249 # elif (CAA_BITS_PER_LONG == 32)
250 opt_type
= LTTNG_CONSUMER32_UST
;
252 # error "Unknown bitness"
264 * Set open files limit to unlimited. This daemon can open a large number of
265 * file descriptors in order to consumer multiple kernel traces.
267 static void set_ulimit(void)
272 /* The kernel does not allowed an infinite limit for open files */
273 lim
.rlim_cur
= 65535;
274 lim
.rlim_max
= 65535;
276 ret
= setrlimit(RLIMIT_NOFILE
, &lim
);
278 PERROR("failed to set open files limit");
285 int main(int argc
, char **argv
)
290 /* Parse arguments */
292 parse_args(argc
, argv
);
300 * child: setsid, close FD 0, 1, 2, chdir /
301 * parent: exit (if fork is successful)
309 * We are in the child. Make sure all other file
310 * descriptors are closed, in case we are called with
311 * more opened file descriptors than the standard ones.
313 for (i
= 3; i
< sysconf(_SC_OPEN_MAX
); i
++) {
318 /* Set up max poll set size */
319 lttng_poll_set_max_size();
321 if (*command_sock_path
== '\0') {
323 case LTTNG_CONSUMER_KERNEL
:
324 snprintf(command_sock_path
, PATH_MAX
, DEFAULT_KCONSUMERD_CMD_SOCK_PATH
,
325 DEFAULT_LTTNG_RUNDIR
);
327 case LTTNG_CONSUMER64_UST
:
328 snprintf(command_sock_path
, PATH_MAX
,
329 DEFAULT_USTCONSUMERD64_CMD_SOCK_PATH
, DEFAULT_LTTNG_RUNDIR
);
331 case LTTNG_CONSUMER32_UST
:
332 snprintf(command_sock_path
, PATH_MAX
,
333 DEFAULT_USTCONSUMERD32_CMD_SOCK_PATH
, DEFAULT_LTTNG_RUNDIR
);
336 WARN("Unknown consumerd type");
342 lttng_consumer_init();
345 /* Set limit for open files */
349 health_consumerd
= health_app_create(NR_HEALTH_CONSUMERD_TYPES
);
350 if (!health_consumerd
) {
354 /* create the consumer instance with and assign the callbacks */
355 ctx
= lttng_consumer_create(opt_type
, lttng_consumer_read_subbuffer
,
356 NULL
, lttng_consumer_on_recv_stream
, NULL
);
361 lttng_consumer_set_command_sock_path(ctx
, command_sock_path
);
362 if (*error_sock_path
== '\0') {
364 case LTTNG_CONSUMER_KERNEL
:
365 snprintf(error_sock_path
, PATH_MAX
, DEFAULT_KCONSUMERD_ERR_SOCK_PATH
,
366 DEFAULT_LTTNG_RUNDIR
);
368 case LTTNG_CONSUMER64_UST
:
369 snprintf(error_sock_path
, PATH_MAX
,
370 DEFAULT_USTCONSUMERD64_ERR_SOCK_PATH
, DEFAULT_LTTNG_RUNDIR
);
372 case LTTNG_CONSUMER32_UST
:
373 snprintf(error_sock_path
, PATH_MAX
,
374 DEFAULT_USTCONSUMERD32_ERR_SOCK_PATH
, DEFAULT_LTTNG_RUNDIR
);
377 WARN("Unknown consumerd type");
382 if (set_signal_handler() < 0) {
386 /* Connect to the socket created by lttng-sessiond to report errors */
387 DBG("Connecting to error socket %s", error_sock_path
);
388 ret
= lttcomm_connect_unix_sock(error_sock_path
);
389 /* not a fatal error, but all communication with lttng-sessiond will fail */
391 WARN("Cannot connect to error socket (is lttng-sessiond started?)");
393 lttng_consumer_set_error_sock(ctx
, ret
);
396 * Block RT signals used for UST periodical metadata flush and the live
397 * timer in main, and create a dedicated thread to handle these signals.
399 consumer_signal_init();
401 ctx
->type
= opt_type
;
403 /* Initialize communication library */
406 ret
= utils_create_pipe(health_quit_pipe
);
408 goto error_health_pipe
;
411 /* Create thread to manage the client socket */
412 ret
= pthread_create(&health_thread
, NULL
,
413 thread_manage_health
, (void *) NULL
);
415 PERROR("pthread_create health");
419 /* Create thread to manage channels */
420 ret
= pthread_create(&channel_thread
, NULL
, consumer_thread_channel_poll
,
423 perror("pthread_create");
427 /* Create thread to manage the polling/writing of trace metadata */
428 ret
= pthread_create(&metadata_thread
, NULL
, consumer_thread_metadata_poll
,
431 perror("pthread_create");
435 /* Create thread to manage the polling/writing of trace data */
436 ret
= pthread_create(&data_thread
, NULL
, consumer_thread_data_poll
,
439 perror("pthread_create");
443 /* Create the thread to manage the receive of fd */
444 ret
= pthread_create(&sessiond_thread
, NULL
, consumer_thread_sessiond_poll
,
447 perror("pthread_create");
452 * Create the thread to manage the UST metadata periodic timer and
455 ret
= pthread_create(&metadata_timer_thread
, NULL
,
456 consumer_timer_thread
, (void *) ctx
);
458 perror("pthread_create");
459 goto metadata_timer_error
;
462 ret
= pthread_detach(metadata_timer_thread
);
465 perror("pthread_detach");
468 metadata_timer_error
:
469 ret
= pthread_join(sessiond_thread
, &status
);
471 perror("pthread_join");
476 ret
= pthread_join(data_thread
, &status
);
478 perror("pthread_join");
483 ret
= pthread_join(metadata_thread
, &status
);
485 perror("pthread_join");
490 ret
= pthread_join(channel_thread
, &status
);
492 perror("pthread_join");
497 ret
= pthread_join(health_thread
, &status
);
499 PERROR("pthread_join health thread");
500 goto error
; /* join error, exit without cleanup */
504 utils_close_pipe(health_quit_pipe
);
509 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_EXIT_SUCCESS
);
516 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_EXIT_FAILURE
);
520 lttng_consumer_destroy(ctx
);
521 lttng_consumer_cleanup();
522 if (health_consumerd
) {
523 health_app_destroy(health_consumerd
);