2 * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * SPDX-License-Identifier: GPL-2.0-only
9 #include <lttng/trigger/trigger.h>
10 #include <lttng/notification/channel-internal.h>
11 #include <lttng/notification/notification-internal.h>
12 #include <lttng/condition/condition-internal.h>
13 #include <lttng/condition/buffer-usage-internal.h>
14 #include <common/error.h>
15 #include <common/config/session-config.h>
16 #include <common/defaults.h>
17 #include <common/utils.h>
18 #include <common/align.h>
19 #include <common/time.h>
24 #include "notification-thread.h"
25 #include "notification-thread-events.h"
26 #include "notification-thread-commands.h"
27 #include "lttng-sessiond.h"
28 #include "health-sessiond.h"
32 #include <urcu/list.h>
33 #include <urcu/rculfhash.h>
36 * Destroy the thread data previously created by the init function.
38 void notification_thread_handle_destroy(
39 struct notification_thread_handle
*handle
)
47 assert(cds_list_empty(&handle
->cmd_queue
.list
));
48 pthread_mutex_destroy(&handle
->cmd_queue
.lock
);
49 sem_destroy(&handle
->ready
);
51 if (handle
->cmd_queue
.event_pipe
) {
52 lttng_pipe_destroy(handle
->cmd_queue
.event_pipe
);
54 if (handle
->channel_monitoring_pipes
.ust32_consumer
>= 0) {
55 ret
= close(handle
->channel_monitoring_pipes
.ust32_consumer
);
57 PERROR("close 32-bit consumer channel monitoring pipe");
60 if (handle
->channel_monitoring_pipes
.ust64_consumer
>= 0) {
61 ret
= close(handle
->channel_monitoring_pipes
.ust64_consumer
);
63 PERROR("close 64-bit consumer channel monitoring pipe");
66 if (handle
->channel_monitoring_pipes
.kernel_consumer
>= 0) {
67 ret
= close(handle
->channel_monitoring_pipes
.kernel_consumer
);
69 PERROR("close kernel consumer channel monitoring pipe");
76 struct notification_thread_handle
*notification_thread_handle_create(
77 struct lttng_pipe
*ust32_channel_monitor_pipe
,
78 struct lttng_pipe
*ust64_channel_monitor_pipe
,
79 struct lttng_pipe
*kernel_channel_monitor_pipe
)
82 struct notification_thread_handle
*handle
;
83 struct lttng_pipe
*event_pipe
= NULL
;
85 handle
= zmalloc(sizeof(*handle
));
90 sem_init(&handle
->ready
, 0, 0);
92 event_pipe
= lttng_pipe_open(FD_CLOEXEC
);
94 ERR("event_pipe creation");
98 handle
->cmd_queue
.event_pipe
= event_pipe
;
101 CDS_INIT_LIST_HEAD(&handle
->cmd_queue
.list
);
102 ret
= pthread_mutex_init(&handle
->cmd_queue
.lock
, NULL
);
107 if (ust32_channel_monitor_pipe
) {
108 handle
->channel_monitoring_pipes
.ust32_consumer
=
109 lttng_pipe_release_readfd(
110 ust32_channel_monitor_pipe
);
111 if (handle
->channel_monitoring_pipes
.ust32_consumer
< 0) {
115 handle
->channel_monitoring_pipes
.ust32_consumer
= -1;
117 if (ust64_channel_monitor_pipe
) {
118 handle
->channel_monitoring_pipes
.ust64_consumer
=
119 lttng_pipe_release_readfd(
120 ust64_channel_monitor_pipe
);
121 if (handle
->channel_monitoring_pipes
.ust64_consumer
< 0) {
125 handle
->channel_monitoring_pipes
.ust64_consumer
= -1;
127 if (kernel_channel_monitor_pipe
) {
128 handle
->channel_monitoring_pipes
.kernel_consumer
=
129 lttng_pipe_release_readfd(
130 kernel_channel_monitor_pipe
);
131 if (handle
->channel_monitoring_pipes
.kernel_consumer
< 0) {
135 handle
->channel_monitoring_pipes
.kernel_consumer
= -1;
141 lttng_pipe_destroy(event_pipe
);
142 notification_thread_handle_destroy(handle
);
147 char *get_notification_channel_sock_path(void)
150 bool is_root
= !getuid();
153 sock_path
= zmalloc(LTTNG_PATH_MAX
);
159 ret
= snprintf(sock_path
, LTTNG_PATH_MAX
,
160 DEFAULT_GLOBAL_NOTIFICATION_CHANNEL_UNIX_SOCK
);
165 const char *home_path
= utils_get_home_dir();
168 ERR("Can't get HOME directory for socket creation");
172 ret
= snprintf(sock_path
, LTTNG_PATH_MAX
,
173 DEFAULT_HOME_NOTIFICATION_CHANNEL_UNIX_SOCK
,
187 void notification_channel_socket_destroy(int fd
)
190 char *sock_path
= get_notification_channel_sock_path();
192 DBG("[notification-thread] Destroying notification channel socket");
195 ret
= unlink(sock_path
);
198 PERROR("unlink notification channel socket");
204 PERROR("close notification channel socket");
209 int notification_channel_socket_create(void)
212 char *sock_path
= get_notification_channel_sock_path();
214 DBG("[notification-thread] Creating notification channel UNIX socket at %s",
217 ret
= lttcomm_create_unix_sock(sock_path
);
219 ERR("[notification-thread] Failed to create notification socket");
224 ret
= chmod(sock_path
, S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
);
226 ERR("Set file permissions failed: %s", sock_path
);
227 PERROR("chmod notification channel socket");
234 ret
= utils_get_group_id(config
.tracing_group_name
.value
, true,
237 /* Default to root group. */
241 ret
= chown(sock_path
, 0, gid
);
243 ERR("Failed to set the notification channel socket's group");
249 DBG("[notification-thread] Notification channel UNIX socket created (fd = %i)",
254 if (fd
>= 0 && close(fd
) < 0) {
255 PERROR("close notification channel socket");
262 int init_poll_set(struct lttng_poll_event
*poll_set
,
263 struct notification_thread_handle
*handle
,
264 int notification_channel_socket
)
269 * Create pollset with size 5:
270 * - notification channel socket (listen for new connections),
271 * - command queue event fd (internal sessiond commands),
272 * - consumerd (32-bit user space) channel monitor pipe,
273 * - consumerd (64-bit user space) channel monitor pipe,
274 * - consumerd (kernel) channel monitor pipe.
276 ret
= lttng_poll_create(poll_set
, 5, LTTNG_CLOEXEC
);
281 ret
= lttng_poll_add(poll_set
, notification_channel_socket
,
282 LPOLLIN
| LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
);
284 ERR("[notification-thread] Failed to add notification channel socket to pollset");
287 ret
= lttng_poll_add(poll_set
, lttng_pipe_get_readfd(handle
->cmd_queue
.event_pipe
),
290 ERR("[notification-thread] Failed to add notification command queue event fd to pollset");
293 ret
= lttng_poll_add(poll_set
,
294 handle
->channel_monitoring_pipes
.ust32_consumer
,
297 ERR("[notification-thread] Failed to add ust-32 channel monitoring pipe fd to pollset");
300 ret
= lttng_poll_add(poll_set
,
301 handle
->channel_monitoring_pipes
.ust64_consumer
,
304 ERR("[notification-thread] Failed to add ust-64 channel monitoring pipe fd to pollset");
307 if (handle
->channel_monitoring_pipes
.kernel_consumer
< 0) {
310 ret
= lttng_poll_add(poll_set
,
311 handle
->channel_monitoring_pipes
.kernel_consumer
,
314 ERR("[notification-thread] Failed to add kernel channel monitoring pipe fd to pollset");
320 lttng_poll_clean(poll_set
);
325 void fini_thread_state(struct notification_thread_state
*state
)
329 if (state
->client_socket_ht
) {
330 ret
= handle_notification_thread_client_disconnect_all(state
);
332 ret
= cds_lfht_destroy(state
->client_socket_ht
, NULL
);
335 if (state
->client_id_ht
) {
336 ret
= cds_lfht_destroy(state
->client_id_ht
, NULL
);
339 if (state
->triggers_ht
) {
340 ret
= handle_notification_thread_trigger_unregister_all(state
);
342 ret
= cds_lfht_destroy(state
->triggers_ht
, NULL
);
345 if (state
->channel_triggers_ht
) {
346 ret
= cds_lfht_destroy(state
->channel_triggers_ht
, NULL
);
349 if (state
->channel_state_ht
) {
350 ret
= cds_lfht_destroy(state
->channel_state_ht
, NULL
);
353 if (state
->notification_trigger_clients_ht
) {
354 ret
= cds_lfht_destroy(state
->notification_trigger_clients_ht
,
358 if (state
->channels_ht
) {
359 ret
= cds_lfht_destroy(state
->channels_ht
, NULL
);
362 if (state
->sessions_ht
) {
363 ret
= cds_lfht_destroy(state
->sessions_ht
, NULL
);
366 if (state
->triggers_by_name_uid_ht
) {
367 ret
= cds_lfht_destroy(state
->triggers_by_name_uid_ht
, NULL
);
370 if (state
->trigger_tokens_ht
) {
371 ret
= cds_lfht_destroy(state
->trigger_tokens_ht
, NULL
);
375 * Must be destroyed after all channels have been destroyed.
376 * See comment in struct lttng_session_trigger_list.
378 if (state
->session_triggers_ht
) {
379 ret
= cds_lfht_destroy(state
->session_triggers_ht
, NULL
);
382 if (state
->notification_channel_socket
>= 0) {
383 notification_channel_socket_destroy(
384 state
->notification_channel_socket
);
387 assert(cds_list_empty(&state
->tracer_event_sources_list
));
389 if (state
->executor
) {
390 action_executor_destroy(state
->executor
);
392 lttng_poll_clean(&state
->events
);
396 void mark_thread_as_ready(struct notification_thread_handle
*handle
)
398 DBG("Marking notification thread as ready");
399 sem_post(&handle
->ready
);
403 void wait_until_thread_is_ready(struct notification_thread_handle
*handle
)
405 DBG("Waiting for notification thread to be ready");
406 sem_wait(&handle
->ready
);
407 DBG("Notification thread is ready");
411 int init_thread_state(struct notification_thread_handle
*handle
,
412 struct notification_thread_state
*state
)
416 memset(state
, 0, sizeof(*state
));
417 state
->notification_channel_socket
= -1;
418 state
->trigger_id
.next_tracer_token
= 1;
419 lttng_poll_init(&state
->events
);
421 ret
= notification_channel_socket_create();
425 state
->notification_channel_socket
= ret
;
427 ret
= init_poll_set(&state
->events
, handle
,
428 state
->notification_channel_socket
);
433 DBG("[notification-thread] Listening on notification channel socket");
434 ret
= lttcomm_listen_unix_sock(state
->notification_channel_socket
);
436 ERR("[notification-thread] Listen failed on notification channel socket");
440 state
->client_socket_ht
= cds_lfht_new(DEFAULT_HT_SIZE
, 1, 0,
441 CDS_LFHT_AUTO_RESIZE
| CDS_LFHT_ACCOUNTING
, NULL
);
442 if (!state
->client_socket_ht
) {
446 state
->client_id_ht
= cds_lfht_new(DEFAULT_HT_SIZE
, 1, 0,
447 CDS_LFHT_AUTO_RESIZE
| CDS_LFHT_ACCOUNTING
, NULL
);
448 if (!state
->client_id_ht
) {
452 state
->channel_triggers_ht
= cds_lfht_new(DEFAULT_HT_SIZE
, 1, 0,
453 CDS_LFHT_AUTO_RESIZE
| CDS_LFHT_ACCOUNTING
, NULL
);
454 if (!state
->channel_triggers_ht
) {
458 state
->session_triggers_ht
= cds_lfht_new(DEFAULT_HT_SIZE
, 1, 0,
459 CDS_LFHT_AUTO_RESIZE
| CDS_LFHT_ACCOUNTING
, NULL
);
460 if (!state
->session_triggers_ht
) {
464 state
->channel_state_ht
= cds_lfht_new(DEFAULT_HT_SIZE
, 1, 0,
465 CDS_LFHT_AUTO_RESIZE
| CDS_LFHT_ACCOUNTING
, NULL
);
466 if (!state
->channel_state_ht
) {
470 state
->notification_trigger_clients_ht
= cds_lfht_new(DEFAULT_HT_SIZE
,
471 1, 0, CDS_LFHT_AUTO_RESIZE
| CDS_LFHT_ACCOUNTING
, NULL
);
472 if (!state
->notification_trigger_clients_ht
) {
476 state
->channels_ht
= cds_lfht_new(DEFAULT_HT_SIZE
,
477 1, 0, CDS_LFHT_AUTO_RESIZE
| CDS_LFHT_ACCOUNTING
, NULL
);
478 if (!state
->channels_ht
) {
481 state
->sessions_ht
= cds_lfht_new(DEFAULT_HT_SIZE
,
482 1, 0, CDS_LFHT_AUTO_RESIZE
| CDS_LFHT_ACCOUNTING
, NULL
);
483 if (!state
->sessions_ht
) {
486 state
->triggers_ht
= cds_lfht_new(DEFAULT_HT_SIZE
,
487 1, 0, CDS_LFHT_AUTO_RESIZE
| CDS_LFHT_ACCOUNTING
, NULL
);
488 if (!state
->triggers_ht
) {
491 state
->triggers_by_name_uid_ht
= cds_lfht_new(DEFAULT_HT_SIZE
,
492 1, 0, CDS_LFHT_AUTO_RESIZE
| CDS_LFHT_ACCOUNTING
, NULL
);
493 if (!state
->triggers_by_name_uid_ht
) {
497 state
->trigger_tokens_ht
= cds_lfht_new(DEFAULT_HT_SIZE
,
498 1, 0, CDS_LFHT_AUTO_RESIZE
| CDS_LFHT_ACCOUNTING
, NULL
);
499 if (!state
->trigger_tokens_ht
) {
503 CDS_INIT_LIST_HEAD(&state
->tracer_event_sources_list
);
505 state
->executor
= action_executor_create(handle
);
506 if (!state
->executor
) {
509 mark_thread_as_ready(handle
);
513 fini_thread_state(state
);
518 int handle_channel_monitoring_pipe(int fd
, uint32_t revents
,
519 struct notification_thread_handle
*handle
,
520 struct notification_thread_state
*state
)
523 enum lttng_domain_type domain
;
525 if (fd
== handle
->channel_monitoring_pipes
.ust32_consumer
||
526 fd
== handle
->channel_monitoring_pipes
.ust64_consumer
) {
527 domain
= LTTNG_DOMAIN_UST
;
528 } else if (fd
== handle
->channel_monitoring_pipes
.kernel_consumer
) {
529 domain
= LTTNG_DOMAIN_KERNEL
;
534 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
535 ret
= lttng_poll_del(&state
->events
, fd
);
537 ERR("[notification-thread] Failed to remove consumer monitoring pipe from poll set");
542 ret
= handle_notification_thread_channel_sample(
545 ERR("[notification-thread] Consumer sample handling error occurred");
554 * This thread services notification channel clients and commands received
555 * from various lttng-sessiond components over a command queue.
558 void *thread_notification(void *data
)
561 struct notification_thread_handle
*handle
= data
;
562 struct notification_thread_state state
;
564 DBG("[notification-thread] Started notification thread");
566 health_register(health_sessiond
, HEALTH_SESSIOND_TYPE_NOTIFICATION
);
567 rcu_register_thread();
571 ERR("[notification-thread] Invalid thread context provided");
575 health_code_update();
577 ret
= init_thread_state(handle
, &state
);
586 DBG("[notification-thread] Entering poll wait");
587 ret
= lttng_poll_wait(&state
.events
, -1);
588 DBG("[notification-thread] Poll wait returned (%i)", ret
);
592 * Restart interrupted system call.
594 if (errno
== EINTR
) {
597 ERR("[notification-thread] Error encountered during lttng_poll_wait (%i)", ret
);
602 for (i
= 0; i
< fd_count
; i
++) {
603 int fd
= LTTNG_POLL_GETFD(&state
.events
, i
);
604 uint32_t revents
= LTTNG_POLL_GETEV(&state
.events
, i
);
606 DBG("[notification-thread] Handling fd (%i) activity (%u)", fd
, revents
);
608 if (fd
== state
.notification_channel_socket
) {
609 if (revents
& LPOLLIN
) {
610 ret
= handle_notification_thread_client_connect(
616 (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
617 ERR("[notification-thread] Notification socket poll error");
620 ERR("[notification-thread] Unexpected poll events %u for notification socket %i", revents
, fd
);
623 } else if (fd
== lttng_pipe_get_readfd(handle
->cmd_queue
.event_pipe
)) {
624 ret
= handle_notification_thread_command(handle
,
627 DBG("[notification-thread] Error encountered while servicing command queue");
629 } else if (ret
> 0) {
632 } else if (fd
== handle
->channel_monitoring_pipes
.ust32_consumer
||
633 fd
== handle
->channel_monitoring_pipes
.ust64_consumer
||
634 fd
== handle
->channel_monitoring_pipes
.kernel_consumer
) {
635 ret
= handle_channel_monitoring_pipe(fd
,
636 revents
, handle
, &state
);
641 /* Activity on a client's socket. */
642 if (revents
& (LPOLLERR
| LPOLLHUP
| LPOLLRDHUP
)) {
644 * It doesn't matter if a command was
645 * pending on the client socket at this
646 * point since it now has no way to
647 * receive the notifications to which
648 * it was subscribing or unsubscribing.
650 ret
= handle_notification_thread_client_disconnect(
656 if (revents
& LPOLLIN
) {
657 ret
= handle_notification_thread_client_in(
664 if (revents
& LPOLLOUT
) {
665 ret
= handle_notification_thread_client_out(
677 fini_thread_state(&state
);
679 rcu_thread_offline();
680 rcu_unregister_thread();
681 health_unregister(health_sessiond
);
686 bool shutdown_notification_thread(void *thread_data
)
688 struct notification_thread_handle
*handle
= thread_data
;
690 notification_thread_command_quit(handle
);
694 struct lttng_thread
*launch_notification_thread(
695 struct notification_thread_handle
*handle
)
697 struct lttng_thread
*thread
;
699 thread
= lttng_thread_create("Notification",
701 shutdown_notification_thread
,
709 * Wait for the thread to be marked as "ready" before returning
710 * as other subsystems depend on the notification subsystem
711 * (e.g. rotation thread).
713 wait_until_thread_is_ready(handle
);