2 * Copyright (C) 2017 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License, version 2 only, as
6 * published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 51
15 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19 #include <lttng/trigger/trigger.h>
20 #include <lttng/notification/channel-internal.h>
21 #include <lttng/notification/notification-internal.h>
22 #include <lttng/condition/condition-internal.h>
23 #include <lttng/condition/buffer-usage-internal.h>
24 #include <common/error.h>
25 #include <common/config/session-config.h>
26 #include <common/defaults.h>
27 #include <common/utils.h>
28 #include <common/align.h>
29 #include <common/time.h>
30 #include <sys/eventfd.h>
35 #include "notification-thread.h"
36 #include "notification-thread-events.h"
37 #include "notification-thread-commands.h"
38 #include "lttng-sessiond.h"
39 #include "health-sessiond.h"
43 #include <urcu/list.h>
44 #include <urcu/rculfhash.h>
47 * Destroy the thread data previously created by the init function.
49 void notification_thread_handle_destroy(
50 struct notification_thread_handle
*handle
)
58 assert(cds_list_empty(&handle
->cmd_queue
.list
));
59 pthread_mutex_destroy(&handle
->cmd_queue
.lock
);
60 sem_destroy(&handle
->ready
);
62 if (handle
->cmd_queue
.event_pipe
) {
63 lttng_pipe_destroy(handle
->cmd_queue
.event_pipe
);
65 if (handle
->channel_monitoring_pipes
.ust32_consumer
>= 0) {
66 ret
= close(handle
->channel_monitoring_pipes
.ust32_consumer
);
68 PERROR("close 32-bit consumer channel monitoring pipe");
71 if (handle
->channel_monitoring_pipes
.ust64_consumer
>= 0) {
72 ret
= close(handle
->channel_monitoring_pipes
.ust64_consumer
);
74 PERROR("close 64-bit consumer channel monitoring pipe");
77 if (handle
->channel_monitoring_pipes
.kernel_consumer
>= 0) {
78 ret
= close(handle
->channel_monitoring_pipes
.kernel_consumer
);
80 PERROR("close kernel consumer channel monitoring pipe");
87 struct notification_thread_handle
*notification_thread_handle_create(
88 struct lttng_pipe
*ust32_channel_monitor_pipe
,
89 struct lttng_pipe
*ust64_channel_monitor_pipe
,
90 struct lttng_pipe
*kernel_channel_monitor_pipe
)
93 struct notification_thread_handle
*handle
;
94 struct lttng_pipe
*event_pipe
= NULL
;
96 handle
= zmalloc(sizeof(*handle
));
101 sem_init(&handle
->ready
, 0, 0);
103 event_pipe
= lttng_pipe_open(FD_CLOEXEC
);
105 ERR("event_pipe creation");
109 handle
->cmd_queue
.event_pipe
= event_pipe
;
112 CDS_INIT_LIST_HEAD(&handle
->cmd_queue
.list
);
113 ret
= pthread_mutex_init(&handle
->cmd_queue
.lock
, NULL
);
118 if (ust32_channel_monitor_pipe
) {
119 handle
->channel_monitoring_pipes
.ust32_consumer
=
120 lttng_pipe_release_readfd(
121 ust32_channel_monitor_pipe
);
122 if (handle
->channel_monitoring_pipes
.ust32_consumer
< 0) {
126 handle
->channel_monitoring_pipes
.ust32_consumer
= -1;
128 if (ust64_channel_monitor_pipe
) {
129 handle
->channel_monitoring_pipes
.ust64_consumer
=
130 lttng_pipe_release_readfd(
131 ust64_channel_monitor_pipe
);
132 if (handle
->channel_monitoring_pipes
.ust64_consumer
< 0) {
136 handle
->channel_monitoring_pipes
.ust64_consumer
= -1;
138 if (kernel_channel_monitor_pipe
) {
139 handle
->channel_monitoring_pipes
.kernel_consumer
=
140 lttng_pipe_release_readfd(
141 kernel_channel_monitor_pipe
);
142 if (handle
->channel_monitoring_pipes
.kernel_consumer
< 0) {
146 handle
->channel_monitoring_pipes
.kernel_consumer
= -1;
151 lttng_pipe_destroy(event_pipe
);
152 notification_thread_handle_destroy(handle
);
157 char *get_notification_channel_sock_path(void)
160 bool is_root
= !getuid();
163 sock_path
= zmalloc(LTTNG_PATH_MAX
);
169 ret
= snprintf(sock_path
, LTTNG_PATH_MAX
,
170 DEFAULT_GLOBAL_NOTIFICATION_CHANNEL_UNIX_SOCK
);
175 const char *home_path
= utils_get_home_dir();
178 ERR("Can't get HOME directory for socket creation");
182 ret
= snprintf(sock_path
, LTTNG_PATH_MAX
,
183 DEFAULT_HOME_NOTIFICATION_CHANNEL_UNIX_SOCK
,
197 void notification_channel_socket_destroy(int fd
)
200 char *sock_path
= get_notification_channel_sock_path();
202 DBG("[notification-thread] Destroying notification channel socket");
205 ret
= unlink(sock_path
);
208 PERROR("unlink notification channel socket");
214 PERROR("close notification channel socket");
219 int notification_channel_socket_create(void)
222 char *sock_path
= get_notification_channel_sock_path();
224 DBG("[notification-thread] Creating notification channel UNIX socket at %s",
227 ret
= lttcomm_create_unix_sock(sock_path
);
229 ERR("[notification-thread] Failed to create notification socket");
234 ret
= chmod(sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
236 ERR("Set file permissions failed: %s", sock_path
);
237 PERROR("chmod notification channel socket");
244 ret
= utils_get_group_id(config
.tracing_group_name
.value
, true,
247 /* Default to root group. */
251 ret
= chown(sock_path
, 0, gid
);
253 ERR("Failed to set the notification channel socket's group");
259 DBG("[notification-thread] Notification channel UNIX socket created (fd = %i)",
264 if (fd
>= 0 && close(fd
) < 0) {
265 PERROR("close notification channel socket");
272 int init_poll_set(struct lttng_poll_event
*poll_set
,
273 struct notification_thread_handle
*handle
,
274 int notification_channel_socket
)
279 * Create pollset with size 5:
280 * - notification channel socket (listen for new connections),
281 * - command queue event fd (internal sessiond commands),
282 * - consumerd (32-bit user space) channel monitor pipe,
283 * - consumerd (64-bit user space) channel monitor pipe,
284 * - consumerd (kernel) channel monitor pipe.
286 ret
= lttng_poll_create(poll_set
, 5, LTTNG_CLOEXEC
);
291 ret
= lttng_poll_add(poll_set
, notification_channel_socket
,
292 LPOLLIN
| LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
);
294 ERR("[notification-thread] Failed to add notification channel socket to pollset");
297 ret
= lttng_poll_add(poll_set
, lttng_pipe_get_readfd(handle
->cmd_queue
.event_pipe
),
300 ERR("[notification-thread] Failed to add notification command queue event fd to pollset");
303 ret
= lttng_poll_add(poll_set
,
304 handle
->channel_monitoring_pipes
.ust32_consumer
,
307 ERR("[notification-thread] Failed to add ust-32 channel monitoring pipe fd to pollset");
310 ret
= lttng_poll_add(poll_set
,
311 handle
->channel_monitoring_pipes
.ust64_consumer
,
314 ERR("[notification-thread] Failed to add ust-64 channel monitoring pipe fd to pollset");
317 if (handle
->channel_monitoring_pipes
.kernel_consumer
< 0) {
320 ret
= lttng_poll_add(poll_set
,
321 handle
->channel_monitoring_pipes
.kernel_consumer
,
324 ERR("[notification-thread] Failed to add kernel channel monitoring pipe fd to pollset");
330 lttng_poll_clean(poll_set
);
335 void fini_thread_state(struct notification_thread_state
*state
)
339 if (state
->client_socket_ht
) {
340 ret
= handle_notification_thread_client_disconnect_all(state
);
342 ret
= cds_lfht_destroy(state
->client_socket_ht
, NULL
);
345 if (state
->triggers_ht
) {
346 ret
= handle_notification_thread_trigger_unregister_all(state
);
348 ret
= cds_lfht_destroy(state
->triggers_ht
, NULL
);
351 if (state
->channel_triggers_ht
) {
352 ret
= cds_lfht_destroy(state
->channel_triggers_ht
, NULL
);
355 if (state
->channel_state_ht
) {
356 ret
= cds_lfht_destroy(state
->channel_state_ht
, NULL
);
359 if (state
->notification_trigger_clients_ht
) {
360 ret
= cds_lfht_destroy(state
->notification_trigger_clients_ht
,
364 if (state
->channels_ht
) {
365 ret
= cds_lfht_destroy(state
->channels_ht
, NULL
);
368 if (state
->sessions_ht
) {
369 ret
= cds_lfht_destroy(state
->sessions_ht
, NULL
);
373 * Must be destroyed after all channels have been destroyed.
374 * See comment in struct lttng_session_trigger_list.
376 if (state
->session_triggers_ht
) {
377 ret
= cds_lfht_destroy(state
->session_triggers_ht
, NULL
);
380 if (state
->notification_channel_socket
>= 0) {
381 notification_channel_socket_destroy(
382 state
->notification_channel_socket
);
384 lttng_poll_clean(&state
->events
);
388 void mark_thread_as_ready(struct notification_thread_handle
*handle
)
390 DBG("Marking notification thread as ready");
391 sem_post(&handle
->ready
);
395 void wait_until_thread_is_ready(struct notification_thread_handle
*handle
)
397 DBG("Waiting for notification thread to be ready");
398 sem_wait(&handle
->ready
);
399 DBG("Notification thread is ready");
403 int init_thread_state(struct notification_thread_handle
*handle
,
404 struct notification_thread_state
*state
)
408 memset(state
, 0, sizeof(*state
));
409 state
->notification_channel_socket
= -1;
410 lttng_poll_init(&state
->events
);
412 ret
= notification_channel_socket_create();
416 state
->notification_channel_socket
= ret
;
418 ret
= init_poll_set(&state
->events
, handle
,
419 state
->notification_channel_socket
);
424 DBG("[notification-thread] Listening on notification channel socket");
425 ret
= lttcomm_listen_unix_sock(state
->notification_channel_socket
);
427 ERR("[notification-thread] Listen failed on notification channel socket");
431 state
->client_socket_ht
= cds_lfht_new(DEFAULT_HT_SIZE
, 1, 0,
432 CDS_LFHT_AUTO_RESIZE
| CDS_LFHT_ACCOUNTING
, NULL
);
433 if (!state
->client_socket_ht
) {
437 state
->channel_triggers_ht
= cds_lfht_new(DEFAULT_HT_SIZE
, 1, 0,
438 CDS_LFHT_AUTO_RESIZE
| CDS_LFHT_ACCOUNTING
, NULL
);
439 if (!state
->channel_triggers_ht
) {
443 state
->session_triggers_ht
= cds_lfht_new(DEFAULT_HT_SIZE
, 1, 0,
444 CDS_LFHT_AUTO_RESIZE
| CDS_LFHT_ACCOUNTING
, NULL
);
445 if (!state
->session_triggers_ht
) {
449 state
->channel_state_ht
= cds_lfht_new(DEFAULT_HT_SIZE
, 1, 0,
450 CDS_LFHT_AUTO_RESIZE
| CDS_LFHT_ACCOUNTING
, NULL
);
451 if (!state
->channel_state_ht
) {
455 state
->notification_trigger_clients_ht
= cds_lfht_new(DEFAULT_HT_SIZE
,
456 1, 0, CDS_LFHT_AUTO_RESIZE
| CDS_LFHT_ACCOUNTING
, NULL
);
457 if (!state
->notification_trigger_clients_ht
) {
461 state
->channels_ht
= cds_lfht_new(DEFAULT_HT_SIZE
,
462 1, 0, CDS_LFHT_AUTO_RESIZE
| CDS_LFHT_ACCOUNTING
, NULL
);
463 if (!state
->channels_ht
) {
466 state
->sessions_ht
= cds_lfht_new(DEFAULT_HT_SIZE
,
467 1, 0, CDS_LFHT_AUTO_RESIZE
| CDS_LFHT_ACCOUNTING
, NULL
);
468 if (!state
->sessions_ht
) {
471 state
->triggers_ht
= cds_lfht_new(DEFAULT_HT_SIZE
,
472 1, 0, CDS_LFHT_AUTO_RESIZE
| CDS_LFHT_ACCOUNTING
, NULL
);
473 if (!state
->triggers_ht
) {
476 mark_thread_as_ready(handle
);
480 fini_thread_state(state
);
485 int handle_channel_monitoring_pipe(int fd
, uint32_t revents
,
486 struct notification_thread_handle
*handle
,
487 struct notification_thread_state
*state
)
490 enum lttng_domain_type domain
;
492 if (fd
== handle
->channel_monitoring_pipes
.ust32_consumer
||
493 fd
== handle
->channel_monitoring_pipes
.ust64_consumer
) {
494 domain
= LTTNG_DOMAIN_UST
;
495 } else if (fd
== handle
->channel_monitoring_pipes
.kernel_consumer
) {
496 domain
= LTTNG_DOMAIN_KERNEL
;
501 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
502 ret
= lttng_poll_del(&state
->events
, fd
);
504 ERR("[notification-thread] Failed to remove consumer monitoring pipe from poll set");
509 ret
= handle_notification_thread_channel_sample(
512 ERR("[notification-thread] Consumer sample handling error occurred");
521 * This thread services notification channel clients and commands received
522 * from various lttng-sessiond components over a command queue.
525 void *thread_notification(void *data
)
528 struct notification_thread_handle
*handle
= data
;
529 struct notification_thread_state state
;
531 DBG("[notification-thread] Started notification thread");
534 ERR("[notification-thread] Invalid thread context provided");
538 rcu_register_thread();
541 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_NOTIFICATION
);
542 health_code_update();
544 ret
= init_thread_state(handle
, &state
);
553 DBG("[notification-thread] Entering poll wait");
554 ret
= lttng_poll_wait(&state
.events
, -1);
555 DBG("[notification-thread] Poll wait returned (%i)", ret
);
559 * Restart interrupted system call.
561 if (errno
== EINTR
) {
564 ERR("[notification-thread] Error encountered during lttng_poll_wait (%i)", ret
);
569 for (i
= 0; i
< fd_count
; i
++) {
570 int fd
= LTTNG_POLL_GETFD(&state
.events
, i
);
571 uint32_t revents
= LTTNG_POLL_GETEV(&state
.events
, i
);
573 DBG("[notification-thread] Handling fd (%i) activity (%u)", fd
, revents
);
575 if (fd
== state
.notification_channel_socket
) {
576 if (revents
& LPOLLIN
) {
577 ret
= handle_notification_thread_client_connect(
583 (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
584 ERR("[notification-thread] Notification socket poll error");
587 ERR("[notification-thread] Unexpected poll events %u for notification socket %i", revents
, fd
);
590 } else if (fd
== lttng_pipe_get_readfd(handle
->cmd_queue
.event_pipe
)) {
591 ret
= handle_notification_thread_command(handle
,
594 DBG("[notification-thread] Error encountered while servicing command queue");
596 } else if (ret
> 0) {
599 } else if (fd
== handle
->channel_monitoring_pipes
.ust32_consumer
||
600 fd
== handle
->channel_monitoring_pipes
.ust64_consumer
||
601 fd
== handle
->channel_monitoring_pipes
.kernel_consumer
) {
602 ret
= handle_channel_monitoring_pipe(fd
,
603 revents
, handle
, &state
);
608 /* Activity on a client's socket. */
609 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
611 * It doesn't matter if a command was
612 * pending on the client socket at this
613 * point since it now has no way to
614 * receive the notifications to which
615 * it was subscribing or unsubscribing.
617 ret
= handle_notification_thread_client_disconnect(
623 if (revents
& LPOLLIN
) {
624 ret
= handle_notification_thread_client_in(
631 if (revents
& LPOLLOUT
) {
632 ret
= handle_notification_thread_client_out(
644 fini_thread_state(&state
);
645 health_unregister(health_sessiond
);
646 rcu_thread_offline();
647 rcu_unregister_thread();
653 bool shutdown_notification_thread(void *thread_data
)
655 struct notification_thread_handle
*handle
= thread_data
;
657 notification_thread_command_quit(handle
);
661 struct lttng_thread
*launch_notification_thread(
662 struct notification_thread_handle
*handle
)
664 struct lttng_thread
*thread
;
666 thread
= lttng_thread_create("Notification",
668 shutdown_notification_thread
,
676 * Wait for the thread to be marked as "ready" before returning
677 * as other subsystems depend on the notification subsystem
678 * (e.g. rotation thread).
680 wait_until_thread_is_ready(handle
);