2 * Copyright (C) 2013 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
29 #include <sys/resource.h>
31 #include <sys/socket.h>
33 #include <sys/types.h>
34 #include <urcu/list.h>
39 #include <urcu/compiler.h>
42 #include <common/defaults.h>
43 #include <common/common.h>
44 #include <common/consumer/consumer.h>
45 #include <common/consumer/consumer-timer.h>
46 #include <common/compat/poll.h>
47 #include <common/sessiond-comm/sessiond-comm.h>
48 #include <common/utils.h>
49 #include <common/compat/getenv.h>
51 #include "lttng-relayd.h"
52 #include "health-relayd.h"
54 /* Global health check unix path */
56 char health_unix_sock_path
[PATH_MAX
];
58 int health_quit_pipe
[2] = { -1, -1 };
61 * Check if the thread quit pipe was triggered.
63 * Return 1 if it was triggered else 0;
66 int check_health_quit_pipe(int fd
, uint32_t events
)
68 if (fd
== health_quit_pipe
[0] && (events
& LPOLLIN
)) {
76 * Send data on a unix socket using the liblttsessiondcomm API.
78 * Return lttcomm error code.
80 static int send_unix_sock(int sock
, void *buf
, size_t len
)
82 /* Check valid length */
87 return lttcomm_send_unix_sock(sock
, buf
, len
);
90 static int create_lttng_rundir_with_perm(const char *rundir
)
94 DBG3("Creating LTTng run directory: %s", rundir
);
96 ret
= mkdir(rundir
, S_IRWXU
);
98 if (errno
!= EEXIST
) {
99 ERR("Unable to create %s", rundir
);
104 } else if (ret
== 0) {
105 int is_root
= !getuid();
110 ret
= utils_get_group_id(tracing_group_name
, true, &gid
);
112 /* Default to root group. */
116 ret
= chown(rundir
, 0, gid
);
118 ERR("Unable to set group on %s", rundir
);
125 S_IRUSR
| S_IWUSR
| S_IXUSR
| S_IRGRP
| S_IXGRP
| S_IROTH
| S_IXOTH
);
127 ERR("Unable to set permissions on %s", health_unix_sock_path
);
140 int parse_health_env(void)
142 const char *health_path
;
144 health_path
= lttng_secure_getenv(LTTNG_RELAYD_HEALTH_ENV
);
146 strncpy(health_unix_sock_path
, health_path
,
148 health_unix_sock_path
[PATH_MAX
- 1] = '\0';
155 int setup_health_path(void)
157 int is_root
, ret
= 0;
158 const char *home_path
= NULL
;
159 char *rundir
= NULL
, *relayd_path
= NULL
;
161 ret
= parse_health_env();
169 rundir
= strdup(DEFAULT_LTTNG_RUNDIR
);
176 * Create rundir from home path. This will create something like
179 home_path
= utils_get_home_dir();
181 if (home_path
== NULL
) {
182 /* TODO: Add --socket PATH option */
183 ERR("Can't get HOME directory for sockets creation.");
188 ret
= asprintf(&rundir
, DEFAULT_LTTNG_HOME_RUNDIR
, home_path
);
195 ret
= asprintf(&relayd_path
, DEFAULT_RELAYD_PATH
, rundir
);
201 ret
= create_lttng_rundir_with_perm(rundir
);
206 ret
= create_lttng_rundir_with_perm(relayd_path
);
212 if (strlen(health_unix_sock_path
) != 0) {
215 snprintf(health_unix_sock_path
, sizeof(health_unix_sock_path
),
216 DEFAULT_GLOBAL_RELAY_HEALTH_UNIX_SOCK
,
219 /* Set health check Unix path */
220 if (strlen(health_unix_sock_path
) != 0) {
224 snprintf(health_unix_sock_path
, sizeof(health_unix_sock_path
),
225 DEFAULT_HOME_RELAY_HEALTH_UNIX_SOCK
,
226 home_path
, (int) getpid());
236 * Thread managing health check socket.
238 void *thread_manage_health(void *data
)
240 int sock
= -1, new_sock
= -1, ret
, i
, pollfd
, err
= -1;
241 uint32_t revents
, nb_fd
;
242 struct lttng_poll_event events
;
243 struct health_comm_msg msg
;
244 struct health_comm_reply reply
;
247 DBG("[thread] Manage health check started");
251 rcu_register_thread();
253 /* We might hit an error path before this is created. */
254 lttng_poll_init(&events
);
256 /* Create unix socket */
257 sock
= lttcomm_create_unix_sock(health_unix_sock_path
);
259 ERR("Unable to create health check Unix socket");
266 /* lttng health client socket path permissions */
269 ret
= utils_get_group_id(tracing_group_name
, true, &gid
);
271 /* Default to root group. */
275 ret
= chown(health_unix_sock_path
, 0, gid
);
277 ERR("Unable to set group on %s", health_unix_sock_path
);
283 ret
= chmod(health_unix_sock_path
,
284 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
286 ERR("Unable to set permissions on %s", health_unix_sock_path
);
294 * Set the CLOEXEC flag. Return code is useless because either way, the
297 (void) utils_set_fd_cloexec(sock
);
299 ret
= lttcomm_listen_unix_sock(sock
);
304 /* Size is set to 1 for the consumer_channel pipe */
305 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
307 ERR("Poll set creation failed");
311 ret
= lttng_poll_add(&events
, health_quit_pipe
[0], LPOLLIN
);
316 /* Add the application registration socket */
317 ret
= lttng_poll_add(&events
, sock
, LPOLLIN
| LPOLLPRI
);
322 lttng_relay_notify_ready();
325 DBG("Health check ready");
327 /* Inifinite blocking call, waiting for transmission */
329 ret
= lttng_poll_wait(&events
, -1);
332 * Restart interrupted system call.
334 if (errno
== EINTR
) {
342 for (i
= 0; i
< nb_fd
; i
++) {
343 /* Fetch once the poll data */
344 revents
= LTTNG_POLL_GETEV(&events
, i
);
345 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
347 /* Thread quit pipe has been closed. Killing thread. */
348 ret
= check_health_quit_pipe(pollfd
, revents
);
354 /* Event on the registration socket */
355 if (pollfd
== sock
) {
356 if (revents
& LPOLLIN
) {
358 } else if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
359 ERR("Health socket poll error");
362 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
368 new_sock
= lttcomm_accept_unix_sock(sock
);
374 * Set the CLOEXEC flag. Return code is useless because either way, the
377 (void) utils_set_fd_cloexec(new_sock
);
379 DBG("Receiving data from client for health...");
380 ret
= lttcomm_recv_unix_sock(new_sock
, (void *)&msg
, sizeof(msg
));
382 DBG("Nothing recv() from client... continuing");
383 ret
= close(new_sock
);
393 assert(msg
.cmd
== HEALTH_CMD_CHECK
);
395 memset(&reply
, 0, sizeof(reply
));
396 for (i
= 0; i
< NR_HEALTH_RELAYD_TYPES
; i
++) {
398 * health_check_state return 0 if thread is in
401 if (!health_check_state(health_relayd
, i
)) {
402 reply
.ret_code
|= 1ULL << i
;
406 DBG2("Health check return value %" PRIx64
, reply
.ret_code
);
408 ret
= send_unix_sock(new_sock
, (void *) &reply
, sizeof(reply
));
410 ERR("Failed to send health data back to client");
413 /* End of transmission */
414 ret
= close(new_sock
);
422 lttng_relay_stop_threads();
425 ERR("Health error occurred in %s", __func__
);
427 DBG("Health check thread dying");
428 unlink(health_unix_sock_path
);
437 * We do NOT rmdir rundir nor the relayd path because there are
438 * other processes using them.
441 lttng_poll_clean(&events
);
443 rcu_unregister_thread();