2 * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * SPDX-License-Identifier: GPL-2.0-only
8 #include "lttng/action/action.h"
9 #include "lttng/trigger/trigger-internal.h"
12 #include <urcu/rculfhash.h>
14 #include <common/defaults.h>
15 #include <common/error.h>
16 #include <common/futex.h>
17 #include <common/unix.h>
18 #include <common/dynamic-buffer.h>
19 #include <common/hashtable/utils.h>
20 #include <common/sessiond-comm/sessiond-comm.h>
21 #include <common/macros.h>
22 #include <lttng/condition/condition.h>
23 #include <lttng/action/action-internal.h>
24 #include <lttng/action/group-internal.h>
25 #include <lttng/domain-internal.h>
26 #include <lttng/notification/notification-internal.h>
27 #include <lttng/condition/condition-internal.h>
28 #include <lttng/condition/buffer-usage-internal.h>
29 #include <lttng/condition/session-consumed-size-internal.h>
30 #include <lttng/condition/session-rotation-internal.h>
31 #include <lttng/condition/on-event-internal.h>
32 #include <lttng/domain-internal.h>
33 #include <lttng/notification/channel-internal.h>
34 #include <lttng/trigger/trigger-internal.h>
35 #include <lttng/event-rule/event-rule-internal.h>
43 #include "condition-internal.h"
44 #include "event-notifier-error-accounting.h"
45 #include "notification-thread.h"
46 #include "notification-thread-events.h"
47 #include "notification-thread-commands.h"
48 #include "lttng-sessiond.h"
51 #define CLIENT_POLL_MASK_IN (LPOLLIN | LPOLLERR | LPOLLHUP | LPOLLRDHUP)
52 #define CLIENT_POLL_MASK_IN_OUT (CLIENT_POLL_MASK_IN | LPOLLOUT)
54 /* The tracers currently limit the capture size to PIPE_BUF (4kb on linux). */
55 #define MAX_CAPTURE_SIZE (PIPE_BUF)
57 enum lttng_object_type
{
58 LTTNG_OBJECT_TYPE_UNKNOWN
,
59 LTTNG_OBJECT_TYPE_NONE
,
60 LTTNG_OBJECT_TYPE_CHANNEL
,
61 LTTNG_OBJECT_TYPE_SESSION
,
64 struct lttng_trigger_list_element
{
65 /* No ownership of the trigger object is assumed. */
66 struct lttng_trigger
*trigger
;
67 struct cds_list_head node
;
70 struct lttng_channel_trigger_list
{
71 struct channel_key channel_key
;
72 /* List of struct lttng_trigger_list_element. */
73 struct cds_list_head list
;
74 /* Node in the channel_triggers_ht */
75 struct cds_lfht_node channel_triggers_ht_node
;
76 /* call_rcu delayed reclaim. */
77 struct rcu_head rcu_node
;
81 * List of triggers applying to a given session.
84 * - lttng_session_trigger_list_create()
85 * - lttng_session_trigger_list_build()
86 * - lttng_session_trigger_list_destroy()
87 * - lttng_session_trigger_list_add()
89 struct lttng_session_trigger_list
{
91 * Not owned by this; points to the session_info structure's
94 const char *session_name
;
95 /* List of struct lttng_trigger_list_element. */
96 struct cds_list_head list
;
97 /* Node in the session_triggers_ht */
98 struct cds_lfht_node session_triggers_ht_node
;
100 * Weak reference to the notification system's session triggers
103 * The session trigger list structure structure is owned by
104 * the session's session_info.
106 * The session_info is kept alive the the channel_infos holding a
107 * reference to it (reference counting). When those channels are
108 * destroyed (at runtime or on teardown), the reference they hold
109 * to the session_info are released. On destruction of session_info,
110 * session_info_destroy() will remove the list of triggers applying
111 * to this session from the notification system's state.
113 * This implies that the session_triggers_ht must be destroyed
114 * after the channels.
116 struct cds_lfht
*session_triggers_ht
;
117 /* Used for delayed RCU reclaim. */
118 struct rcu_head rcu_node
;
121 struct lttng_trigger_ht_element
{
122 struct lttng_trigger
*trigger
;
123 struct cds_lfht_node node
;
124 struct cds_lfht_node node_by_name_uid
;
125 /* call_rcu delayed reclaim. */
126 struct rcu_head rcu_node
;
129 struct lttng_condition_list_element
{
130 struct lttng_condition
*condition
;
131 struct cds_list_head node
;
134 struct channel_state_sample
{
135 struct channel_key key
;
136 struct cds_lfht_node channel_state_ht_node
;
137 uint64_t highest_usage
;
138 uint64_t lowest_usage
;
139 uint64_t channel_total_consumed
;
140 /* call_rcu delayed reclaim. */
141 struct rcu_head rcu_node
;
144 static unsigned long hash_channel_key(struct channel_key
*key
);
145 static int evaluate_buffer_condition(const struct lttng_condition
*condition
,
146 struct lttng_evaluation
**evaluation
,
147 const struct notification_thread_state
*state
,
148 const struct channel_state_sample
*previous_sample
,
149 const struct channel_state_sample
*latest_sample
,
150 uint64_t previous_session_consumed_total
,
151 uint64_t latest_session_consumed_total
,
152 struct channel_info
*channel_info
);
154 int send_evaluation_to_clients(const struct lttng_trigger
*trigger
,
155 const struct lttng_evaluation
*evaluation
,
156 struct notification_client_list
*client_list
,
157 struct notification_thread_state
*state
,
158 uid_t channel_uid
, gid_t channel_gid
);
161 /* session_info API */
163 void session_info_destroy(void *_data
);
165 void session_info_get(struct session_info
*session_info
);
167 void session_info_put(struct session_info
*session_info
);
169 struct session_info
*session_info_create(const char *name
,
170 uid_t uid
, gid_t gid
,
171 struct lttng_session_trigger_list
*trigger_list
,
172 struct cds_lfht
*sessions_ht
);
174 void session_info_add_channel(struct session_info
*session_info
,
175 struct channel_info
*channel_info
);
177 void session_info_remove_channel(struct session_info
*session_info
,
178 struct channel_info
*channel_info
);
180 /* lttng_session_trigger_list API */
182 struct lttng_session_trigger_list
*lttng_session_trigger_list_create(
183 const char *session_name
,
184 struct cds_lfht
*session_triggers_ht
);
186 struct lttng_session_trigger_list
*lttng_session_trigger_list_build(
187 const struct notification_thread_state
*state
,
188 const char *session_name
);
190 void lttng_session_trigger_list_destroy(
191 struct lttng_session_trigger_list
*list
);
193 int lttng_session_trigger_list_add(struct lttng_session_trigger_list
*list
,
194 struct lttng_trigger
*trigger
);
197 int client_handle_transmission_status(
198 struct notification_client
*client
,
199 enum client_transmission_status transmission_status
,
200 struct notification_thread_state
*state
);
203 int handle_one_event_notifier_notification(
204 struct notification_thread_state
*state
,
205 int pipe
, enum lttng_domain_type domain
);
208 void free_lttng_trigger_ht_element_rcu(struct rcu_head
*node
);
211 int match_client_socket(struct cds_lfht_node
*node
, const void *key
)
213 /* This double-cast is intended to supress pointer-to-cast warning. */
214 const int socket
= (int) (intptr_t) key
;
215 const struct notification_client
*client
= caa_container_of(node
,
216 struct notification_client
, client_socket_ht_node
);
218 return client
->socket
== socket
;
222 int match_client_id(struct cds_lfht_node
*node
, const void *key
)
224 /* This double-cast is intended to supress pointer-to-cast warning. */
225 const notification_client_id id
= *((notification_client_id
*) key
);
226 const struct notification_client
*client
= caa_container_of(
227 node
, struct notification_client
, client_id_ht_node
);
229 return client
->id
== id
;
233 int match_channel_trigger_list(struct cds_lfht_node
*node
, const void *key
)
235 struct channel_key
*channel_key
= (struct channel_key
*) key
;
236 struct lttng_channel_trigger_list
*trigger_list
;
238 trigger_list
= caa_container_of(node
, struct lttng_channel_trigger_list
,
239 channel_triggers_ht_node
);
241 return !!((channel_key
->key
== trigger_list
->channel_key
.key
) &&
242 (channel_key
->domain
== trigger_list
->channel_key
.domain
));
246 int match_session_trigger_list(struct cds_lfht_node
*node
, const void *key
)
248 const char *session_name
= (const char *) key
;
249 struct lttng_session_trigger_list
*trigger_list
;
251 trigger_list
= caa_container_of(node
, struct lttng_session_trigger_list
,
252 session_triggers_ht_node
);
254 return !!(strcmp(trigger_list
->session_name
, session_name
) == 0);
258 int match_channel_state_sample(struct cds_lfht_node
*node
, const void *key
)
260 struct channel_key
*channel_key
= (struct channel_key
*) key
;
261 struct channel_state_sample
*sample
;
263 sample
= caa_container_of(node
, struct channel_state_sample
,
264 channel_state_ht_node
);
266 return !!((channel_key
->key
== sample
->key
.key
) &&
267 (channel_key
->domain
== sample
->key
.domain
));
271 int match_channel_info(struct cds_lfht_node
*node
, const void *key
)
273 struct channel_key
*channel_key
= (struct channel_key
*) key
;
274 struct channel_info
*channel_info
;
276 channel_info
= caa_container_of(node
, struct channel_info
,
279 return !!((channel_key
->key
== channel_info
->key
.key
) &&
280 (channel_key
->domain
== channel_info
->key
.domain
));
284 int match_trigger(struct cds_lfht_node
*node
, const void *key
)
286 struct lttng_trigger
*trigger_key
= (struct lttng_trigger
*) key
;
287 struct lttng_trigger_ht_element
*trigger_ht_element
;
289 trigger_ht_element
= caa_container_of(node
, struct lttng_trigger_ht_element
,
292 return !!lttng_trigger_is_equal(trigger_key
, trigger_ht_element
->trigger
);
296 int match_trigger_token(struct cds_lfht_node
*node
, const void *key
)
298 const uint64_t *_key
= key
;
299 struct notification_trigger_tokens_ht_element
*element
;
301 element
= caa_container_of(node
,
302 struct notification_trigger_tokens_ht_element
, node
);
303 return *_key
== element
->token
;
307 int match_client_list_condition(struct cds_lfht_node
*node
, const void *key
)
309 struct lttng_condition
*condition_key
= (struct lttng_condition
*) key
;
310 struct notification_client_list
*client_list
;
311 const struct lttng_condition
*condition
;
313 assert(condition_key
);
315 client_list
= caa_container_of(node
, struct notification_client_list
,
316 notification_trigger_clients_ht_node
);
317 condition
= lttng_trigger_get_const_condition(client_list
->trigger
);
319 return !!lttng_condition_is_equal(condition_key
, condition
);
323 int match_session(struct cds_lfht_node
*node
, const void *key
)
325 const char *name
= key
;
326 struct session_info
*session_info
= caa_container_of(
327 node
, struct session_info
, sessions_ht_node
);
329 return !strcmp(session_info
->name
, name
);
333 const char *notification_command_type_str(
334 enum notification_thread_command_type type
)
337 case NOTIFICATION_COMMAND_TYPE_REGISTER_TRIGGER
:
338 return "REGISTER_TRIGGER";
339 case NOTIFICATION_COMMAND_TYPE_UNREGISTER_TRIGGER
:
340 return "UNREGISTER_TRIGGER";
341 case NOTIFICATION_COMMAND_TYPE_ADD_CHANNEL
:
342 return "ADD_CHANNEL";
343 case NOTIFICATION_COMMAND_TYPE_REMOVE_CHANNEL
:
344 return "REMOVE_CHANNEL";
345 case NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING
:
346 return "SESSION_ROTATION_ONGOING";
347 case NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_COMPLETED
:
348 return "SESSION_ROTATION_COMPLETED";
349 case NOTIFICATION_COMMAND_TYPE_ADD_TRACER_EVENT_SOURCE
:
350 return "ADD_TRACER_EVENT_SOURCE";
351 case NOTIFICATION_COMMAND_TYPE_REMOVE_TRACER_EVENT_SOURCE
:
352 return "REMOVE_TRACER_EVENT_SOURCE";
353 case NOTIFICATION_COMMAND_TYPE_LIST_TRIGGERS
:
354 return "LIST_TRIGGERS";
355 case NOTIFICATION_COMMAND_TYPE_QUIT
:
357 case NOTIFICATION_COMMAND_TYPE_CLIENT_COMMUNICATION_UPDATE
:
358 return "CLIENT_COMMUNICATION_UPDATE";
365 * Match trigger based on name and credentials only.
366 * Name duplication is NOT allowed for the same uid.
369 int match_trigger_by_name_uid(struct cds_lfht_node
*node
,
374 const char *key_name
;
375 enum lttng_trigger_status status
;
376 const struct lttng_credentials
*key_creds
;
377 const struct lttng_credentials
*node_creds
;
378 const struct lttng_trigger
*trigger_key
=
379 (const struct lttng_trigger
*) key
;
380 const struct lttng_trigger_ht_element
*trigger_ht_element
=
381 caa_container_of(node
,
382 struct lttng_trigger_ht_element
,
385 status
= lttng_trigger_get_name(trigger_ht_element
->trigger
, &name
);
386 assert(status
== LTTNG_TRIGGER_STATUS_OK
);
388 status
= lttng_trigger_get_name(trigger_key
, &key_name
);
389 assert(status
== LTTNG_TRIGGER_STATUS_OK
);
391 /* Compare the names. */
392 if (strcmp(name
, key_name
) != 0) {
396 /* Compare the owners' UIDs. */
397 key_creds
= lttng_trigger_get_credentials(trigger_key
);
398 node_creds
= lttng_trigger_get_credentials(trigger_ht_element
->trigger
);
400 match
= lttng_credentials_is_equal_uid(key_creds
, node_creds
);
407 * Hash trigger based on name and credentials only.
410 unsigned long hash_trigger_by_name_uid(const struct lttng_trigger
*trigger
)
412 unsigned long hash
= 0;
413 const struct lttng_credentials
*trigger_creds
;
414 const char *trigger_name
;
415 enum lttng_trigger_status status
;
417 status
= lttng_trigger_get_name(trigger
, &trigger_name
);
418 if (status
== LTTNG_TRIGGER_STATUS_OK
) {
419 hash
= hash_key_str(trigger_name
, lttng_ht_seed
);
422 trigger_creds
= lttng_trigger_get_credentials(trigger
);
423 hash
^= hash_key_ulong((void *) (unsigned long) LTTNG_OPTIONAL_GET(trigger_creds
->uid
),
430 unsigned long hash_channel_key(struct channel_key
*key
)
432 unsigned long key_hash
= hash_key_u64(&key
->key
, lttng_ht_seed
);
433 unsigned long domain_hash
= hash_key_ulong(
434 (void *) (unsigned long) key
->domain
, lttng_ht_seed
);
436 return key_hash
^ domain_hash
;
440 unsigned long hash_client_socket(int socket
)
442 return hash_key_ulong((void *) (unsigned long) socket
, lttng_ht_seed
);
446 unsigned long hash_client_id(notification_client_id id
)
448 return hash_key_u64(&id
, lttng_ht_seed
);
452 * Get the type of object to which a given condition applies. Bindings let
453 * the notification system evaluate a trigger's condition when a given
454 * object's state is updated.
456 * For instance, a condition bound to a channel will be evaluated everytime
457 * the channel's state is changed by a channel monitoring sample.
460 enum lttng_object_type
get_condition_binding_object(
461 const struct lttng_condition
*condition
)
463 switch (lttng_condition_get_type(condition
)) {
464 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW
:
465 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH
:
466 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE
:
467 return LTTNG_OBJECT_TYPE_CHANNEL
;
468 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
:
469 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED
:
470 return LTTNG_OBJECT_TYPE_SESSION
;
471 case LTTNG_CONDITION_TYPE_ON_EVENT
:
472 return LTTNG_OBJECT_TYPE_NONE
;
474 return LTTNG_OBJECT_TYPE_UNKNOWN
;
479 void free_channel_info_rcu(struct rcu_head
*node
)
481 free(caa_container_of(node
, struct channel_info
, rcu_node
));
485 void channel_info_destroy(struct channel_info
*channel_info
)
491 if (channel_info
->session_info
) {
492 session_info_remove_channel(channel_info
->session_info
,
494 session_info_put(channel_info
->session_info
);
496 if (channel_info
->name
) {
497 free(channel_info
->name
);
499 call_rcu(&channel_info
->rcu_node
, free_channel_info_rcu
);
503 void free_session_info_rcu(struct rcu_head
*node
)
505 free(caa_container_of(node
, struct session_info
, rcu_node
));
508 /* Don't call directly, use the ref-counting mechanism. */
510 void session_info_destroy(void *_data
)
512 struct session_info
*session_info
= _data
;
515 assert(session_info
);
516 if (session_info
->channel_infos_ht
) {
517 ret
= cds_lfht_destroy(session_info
->channel_infos_ht
, NULL
);
519 ERR("[notification-thread] Failed to destroy channel information hash table");
522 lttng_session_trigger_list_destroy(session_info
->trigger_list
);
525 cds_lfht_del(session_info
->sessions_ht
,
526 &session_info
->sessions_ht_node
);
528 free(session_info
->name
);
529 call_rcu(&session_info
->rcu_node
, free_session_info_rcu
);
533 void session_info_get(struct session_info
*session_info
)
538 lttng_ref_get(&session_info
->ref
);
542 void session_info_put(struct session_info
*session_info
)
547 lttng_ref_put(&session_info
->ref
);
551 struct session_info
*session_info_create(const char *name
, uid_t uid
, gid_t gid
,
552 struct lttng_session_trigger_list
*trigger_list
,
553 struct cds_lfht
*sessions_ht
)
555 struct session_info
*session_info
;
559 session_info
= zmalloc(sizeof(*session_info
));
563 lttng_ref_init(&session_info
->ref
, session_info_destroy
);
565 session_info
->channel_infos_ht
= cds_lfht_new(DEFAULT_HT_SIZE
,
566 1, 0, CDS_LFHT_AUTO_RESIZE
| CDS_LFHT_ACCOUNTING
, NULL
);
567 if (!session_info
->channel_infos_ht
) {
571 cds_lfht_node_init(&session_info
->sessions_ht_node
);
572 session_info
->name
= strdup(name
);
573 if (!session_info
->name
) {
576 session_info
->uid
= uid
;
577 session_info
->gid
= gid
;
578 session_info
->trigger_list
= trigger_list
;
579 session_info
->sessions_ht
= sessions_ht
;
583 session_info_put(session_info
);
588 void session_info_add_channel(struct session_info
*session_info
,
589 struct channel_info
*channel_info
)
592 cds_lfht_add(session_info
->channel_infos_ht
,
593 hash_channel_key(&channel_info
->key
),
594 &channel_info
->session_info_channels_ht_node
);
599 void session_info_remove_channel(struct session_info
*session_info
,
600 struct channel_info
*channel_info
)
603 cds_lfht_del(session_info
->channel_infos_ht
,
604 &channel_info
->session_info_channels_ht_node
);
609 struct channel_info
*channel_info_create(const char *channel_name
,
610 struct channel_key
*channel_key
, uint64_t channel_capacity
,
611 struct session_info
*session_info
)
613 struct channel_info
*channel_info
= zmalloc(sizeof(*channel_info
));
619 cds_lfht_node_init(&channel_info
->channels_ht_node
);
620 cds_lfht_node_init(&channel_info
->session_info_channels_ht_node
);
621 memcpy(&channel_info
->key
, channel_key
, sizeof(*channel_key
));
622 channel_info
->capacity
= channel_capacity
;
624 channel_info
->name
= strdup(channel_name
);
625 if (!channel_info
->name
) {
630 * Set the references between session and channel infos:
631 * - channel_info holds a strong reference to session_info
632 * - session_info holds a weak reference to channel_info
634 session_info_get(session_info
);
635 session_info_add_channel(session_info
, channel_info
);
636 channel_info
->session_info
= session_info
;
640 channel_info_destroy(channel_info
);
645 bool notification_client_list_get(struct notification_client_list
*list
)
647 return urcu_ref_get_unless_zero(&list
->ref
);
651 void free_notification_client_list_rcu(struct rcu_head
*node
)
653 free(caa_container_of(node
, struct notification_client_list
,
658 void notification_client_list_release(struct urcu_ref
*list_ref
)
660 struct notification_client_list
*list
=
661 container_of(list_ref
, typeof(*list
), ref
);
662 struct notification_client_list_element
*client_list_element
, *tmp
;
664 if (list
->notification_trigger_clients_ht
) {
666 cds_lfht_del(list
->notification_trigger_clients_ht
,
667 &list
->notification_trigger_clients_ht_node
);
669 list
->notification_trigger_clients_ht
= NULL
;
671 cds_list_for_each_entry_safe(client_list_element
, tmp
,
673 free(client_list_element
);
675 pthread_mutex_destroy(&list
->lock
);
676 call_rcu(&list
->rcu_node
, free_notification_client_list_rcu
);
680 struct notification_client_list
*notification_client_list_create(
681 const struct lttng_trigger
*trigger
)
683 struct notification_client_list
*client_list
=
684 zmalloc(sizeof(*client_list
));
689 pthread_mutex_init(&client_list
->lock
, NULL
);
690 urcu_ref_init(&client_list
->ref
);
691 cds_lfht_node_init(&client_list
->notification_trigger_clients_ht_node
);
692 CDS_INIT_LIST_HEAD(&client_list
->list
);
693 client_list
->trigger
= trigger
;
699 void publish_notification_client_list(
700 struct notification_thread_state
*state
,
701 struct notification_client_list
*list
)
703 const struct lttng_condition
*condition
=
704 lttng_trigger_get_const_condition(list
->trigger
);
706 assert(!list
->notification_trigger_clients_ht
);
707 notification_client_list_get(list
);
709 list
->notification_trigger_clients_ht
=
710 state
->notification_trigger_clients_ht
;
713 cds_lfht_add(state
->notification_trigger_clients_ht
,
714 lttng_condition_hash(condition
),
715 &list
->notification_trigger_clients_ht_node
);
720 void notification_client_list_put(struct notification_client_list
*list
)
725 return urcu_ref_put(&list
->ref
, notification_client_list_release
);
728 /* Provides a reference to the returned list. */
730 struct notification_client_list
*get_client_list_from_condition(
731 struct notification_thread_state
*state
,
732 const struct lttng_condition
*condition
)
734 struct cds_lfht_node
*node
;
735 struct cds_lfht_iter iter
;
736 struct notification_client_list
*list
= NULL
;
739 cds_lfht_lookup(state
->notification_trigger_clients_ht
,
740 lttng_condition_hash(condition
),
741 match_client_list_condition
,
744 node
= cds_lfht_iter_get_node(&iter
);
746 list
= container_of(node
, struct notification_client_list
,
747 notification_trigger_clients_ht_node
);
748 list
= notification_client_list_get(list
) ? list
: NULL
;
756 int evaluate_channel_condition_for_client(
757 const struct lttng_condition
*condition
,
758 struct notification_thread_state
*state
,
759 struct lttng_evaluation
**evaluation
,
760 uid_t
*session_uid
, gid_t
*session_gid
)
763 struct cds_lfht_iter iter
;
764 struct cds_lfht_node
*node
;
765 struct channel_info
*channel_info
= NULL
;
766 struct channel_key
*channel_key
= NULL
;
767 struct channel_state_sample
*last_sample
= NULL
;
768 struct lttng_channel_trigger_list
*channel_trigger_list
= NULL
;
772 /* Find the channel associated with the condition. */
773 cds_lfht_for_each_entry(state
->channel_triggers_ht
, &iter
,
774 channel_trigger_list
, channel_triggers_ht_node
) {
775 struct lttng_trigger_list_element
*element
;
777 cds_list_for_each_entry(element
, &channel_trigger_list
->list
, node
) {
778 const struct lttng_condition
*current_condition
=
779 lttng_trigger_get_const_condition(
782 assert(current_condition
);
783 if (!lttng_condition_is_equal(condition
,
784 current_condition
)) {
788 /* Found the trigger, save the channel key. */
789 channel_key
= &channel_trigger_list
->channel_key
;
793 /* The channel key was found stop iteration. */
799 /* No channel found; normal exit. */
800 DBG("[notification-thread] No known channel associated with newly subscribed-to condition");
805 /* Fetch channel info for the matching channel. */
806 cds_lfht_lookup(state
->channels_ht
,
807 hash_channel_key(channel_key
),
811 node
= cds_lfht_iter_get_node(&iter
);
813 channel_info
= caa_container_of(node
, struct channel_info
,
816 /* Retrieve the channel's last sample, if it exists. */
817 cds_lfht_lookup(state
->channel_state_ht
,
818 hash_channel_key(channel_key
),
819 match_channel_state_sample
,
822 node
= cds_lfht_iter_get_node(&iter
);
824 last_sample
= caa_container_of(node
,
825 struct channel_state_sample
,
826 channel_state_ht_node
);
828 /* Nothing to evaluate, no sample was ever taken. Normal exit */
829 DBG("[notification-thread] No channel sample associated with newly subscribed-to condition");
834 ret
= evaluate_buffer_condition(condition
, evaluation
, state
,
836 0, channel_info
->session_info
->consumed_data_size
,
839 WARN("[notification-thread] Fatal error occurred while evaluating a newly subscribed-to condition");
843 *session_uid
= channel_info
->session_info
->uid
;
844 *session_gid
= channel_info
->session_info
->gid
;
851 const char *get_condition_session_name(const struct lttng_condition
*condition
)
853 const char *session_name
= NULL
;
854 enum lttng_condition_status status
;
856 switch (lttng_condition_get_type(condition
)) {
857 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW
:
858 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH
:
859 status
= lttng_condition_buffer_usage_get_session_name(
860 condition
, &session_name
);
862 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE
:
863 status
= lttng_condition_session_consumed_size_get_session_name(
864 condition
, &session_name
);
866 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
:
867 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED
:
868 status
= lttng_condition_session_rotation_get_session_name(
869 condition
, &session_name
);
874 if (status
!= LTTNG_CONDITION_STATUS_OK
) {
875 ERR("[notification-thread] Failed to retrieve session rotation condition's session name");
883 int evaluate_session_condition_for_client(
884 const struct lttng_condition
*condition
,
885 struct notification_thread_state
*state
,
886 struct lttng_evaluation
**evaluation
,
887 uid_t
*session_uid
, gid_t
*session_gid
)
890 struct cds_lfht_iter iter
;
891 struct cds_lfht_node
*node
;
892 const char *session_name
;
893 struct session_info
*session_info
= NULL
;
896 session_name
= get_condition_session_name(condition
);
898 /* Find the session associated with the trigger. */
899 cds_lfht_lookup(state
->sessions_ht
,
900 hash_key_str(session_name
, lttng_ht_seed
),
904 node
= cds_lfht_iter_get_node(&iter
);
906 DBG("[notification-thread] No known session matching name \"%s\"",
912 session_info
= caa_container_of(node
, struct session_info
,
914 session_info_get(session_info
);
917 * Evaluation is performed in-line here since only one type of
918 * session-bound condition is handled for the moment.
920 switch (lttng_condition_get_type(condition
)) {
921 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
:
922 if (!session_info
->rotation
.ongoing
) {
924 goto end_session_put
;
927 *evaluation
= lttng_evaluation_session_rotation_ongoing_create(
928 session_info
->rotation
.id
);
931 ERR("[notification-thread] Failed to create session rotation ongoing evaluation for session \"%s\"",
934 goto end_session_put
;
940 goto end_session_put
;
943 *session_uid
= session_info
->uid
;
944 *session_gid
= session_info
->gid
;
947 session_info_put(session_info
);
954 int evaluate_condition_for_client(const struct lttng_trigger
*trigger
,
955 const struct lttng_condition
*condition
,
956 struct notification_client
*client
,
957 struct notification_thread_state
*state
)
960 struct lttng_evaluation
*evaluation
= NULL
;
961 struct notification_client_list client_list
= {
962 .lock
= PTHREAD_MUTEX_INITIALIZER
,
964 struct notification_client_list_element client_list_element
= { 0 };
965 uid_t object_uid
= 0;
966 gid_t object_gid
= 0;
973 switch (get_condition_binding_object(condition
)) {
974 case LTTNG_OBJECT_TYPE_SESSION
:
975 ret
= evaluate_session_condition_for_client(condition
, state
,
976 &evaluation
, &object_uid
, &object_gid
);
978 case LTTNG_OBJECT_TYPE_CHANNEL
:
979 ret
= evaluate_channel_condition_for_client(condition
, state
,
980 &evaluation
, &object_uid
, &object_gid
);
982 case LTTNG_OBJECT_TYPE_NONE
:
983 DBG("[notification-thread] Newly subscribed-to condition not bound to object, nothing to evaluate");
986 case LTTNG_OBJECT_TYPE_UNKNOWN
:
996 /* Evaluation yielded nothing. Normal exit. */
997 DBG("[notification-thread] Newly subscribed-to condition evaluated to false, nothing to report to client");
1003 * Create a temporary client list with the client currently
1006 cds_lfht_node_init(&client_list
.notification_trigger_clients_ht_node
);
1007 CDS_INIT_LIST_HEAD(&client_list
.list
);
1008 client_list
.trigger
= trigger
;
1010 CDS_INIT_LIST_HEAD(&client_list_element
.node
);
1011 client_list_element
.client
= client
;
1012 cds_list_add(&client_list_element
.node
, &client_list
.list
);
1014 /* Send evaluation result to the newly-subscribed client. */
1015 DBG("[notification-thread] Newly subscribed-to condition evaluated to true, notifying client");
1016 ret
= send_evaluation_to_clients(trigger
, evaluation
, &client_list
,
1017 state
, object_uid
, object_gid
);
1024 int notification_thread_client_subscribe(struct notification_client
*client
,
1025 struct lttng_condition
*condition
,
1026 struct notification_thread_state
*state
,
1027 enum lttng_notification_channel_status
*_status
)
1030 struct notification_client_list
*client_list
= NULL
;
1031 struct lttng_condition_list_element
*condition_list_element
= NULL
;
1032 struct notification_client_list_element
*client_list_element
= NULL
;
1033 enum lttng_notification_channel_status status
=
1034 LTTNG_NOTIFICATION_CHANNEL_STATUS_OK
;
1037 * Ensure that the client has not already subscribed to this condition
1040 cds_list_for_each_entry(condition_list_element
, &client
->condition_list
, node
) {
1041 if (lttng_condition_is_equal(condition_list_element
->condition
,
1043 status
= LTTNG_NOTIFICATION_CHANNEL_STATUS_ALREADY_SUBSCRIBED
;
1048 condition_list_element
= zmalloc(sizeof(*condition_list_element
));
1049 if (!condition_list_element
) {
1053 client_list_element
= zmalloc(sizeof(*client_list_element
));
1054 if (!client_list_element
) {
1060 * Add the newly-subscribed condition to the client's subscription list.
1062 CDS_INIT_LIST_HEAD(&condition_list_element
->node
);
1063 condition_list_element
->condition
= condition
;
1064 cds_list_add(&condition_list_element
->node
, &client
->condition_list
);
1066 client_list
= get_client_list_from_condition(state
, condition
);
1069 * No notification-emiting trigger registered with this
1070 * condition. We don't evaluate the condition right away
1071 * since this trigger is not registered yet.
1073 free(client_list_element
);
1078 * The condition to which the client just subscribed is evaluated
1079 * at this point so that conditions that are already TRUE result
1080 * in a notification being sent out.
1082 * The client_list's trigger is used without locking the list itself.
1083 * This is correct since the list doesn't own the trigger and the
1084 * object is immutable.
1086 if (evaluate_condition_for_client(client_list
->trigger
, condition
,
1088 WARN("[notification-thread] Evaluation of a condition on client subscription failed, aborting.");
1090 free(client_list_element
);
1095 * Add the client to the list of clients interested in a given trigger
1096 * if a "notification" trigger with a corresponding condition was
1099 client_list_element
->client
= client
;
1100 CDS_INIT_LIST_HEAD(&client_list_element
->node
);
1102 pthread_mutex_lock(&client_list
->lock
);
1103 cds_list_add(&client_list_element
->node
, &client_list
->list
);
1104 pthread_mutex_unlock(&client_list
->lock
);
1110 notification_client_list_put(client_list
);
1114 free(condition_list_element
);
1115 free(client_list_element
);
1120 int notification_thread_client_unsubscribe(
1121 struct notification_client
*client
,
1122 struct lttng_condition
*condition
,
1123 struct notification_thread_state
*state
,
1124 enum lttng_notification_channel_status
*_status
)
1126 struct notification_client_list
*client_list
;
1127 struct lttng_condition_list_element
*condition_list_element
,
1129 struct notification_client_list_element
*client_list_element
,
1131 bool condition_found
= false;
1132 enum lttng_notification_channel_status status
=
1133 LTTNG_NOTIFICATION_CHANNEL_STATUS_OK
;
1135 /* Remove the condition from the client's condition list. */
1136 cds_list_for_each_entry_safe(condition_list_element
, condition_tmp
,
1137 &client
->condition_list
, node
) {
1138 if (!lttng_condition_is_equal(condition_list_element
->condition
,
1143 cds_list_del(&condition_list_element
->node
);
1145 * The caller may be iterating on the client's conditions to
1146 * tear down a client's connection. In this case, the condition
1147 * will be destroyed at the end.
1149 if (condition
!= condition_list_element
->condition
) {
1150 lttng_condition_destroy(
1151 condition_list_element
->condition
);
1153 free(condition_list_element
);
1154 condition_found
= true;
1158 if (!condition_found
) {
1159 status
= LTTNG_NOTIFICATION_CHANNEL_STATUS_UNKNOWN_CONDITION
;
1164 * Remove the client from the list of clients interested the trigger
1165 * matching the condition.
1167 client_list
= get_client_list_from_condition(state
, condition
);
1172 pthread_mutex_lock(&client_list
->lock
);
1173 cds_list_for_each_entry_safe(client_list_element
, client_tmp
,
1174 &client_list
->list
, node
) {
1175 if (client_list_element
->client
->id
!= client
->id
) {
1178 cds_list_del(&client_list_element
->node
);
1179 free(client_list_element
);
1182 pthread_mutex_unlock(&client_list
->lock
);
1183 notification_client_list_put(client_list
);
1186 lttng_condition_destroy(condition
);
1194 void free_notification_client_rcu(struct rcu_head
*node
)
1196 free(caa_container_of(node
, struct notification_client
, rcu_node
));
1200 void notification_client_destroy(struct notification_client
*client
,
1201 struct notification_thread_state
*state
)
1208 * The client object is not reachable by other threads, no need to lock
1211 if (client
->socket
>= 0) {
1212 (void) lttcomm_close_unix_sock(client
->socket
);
1213 client
->socket
= -1;
1215 client
->communication
.active
= false;
1216 lttng_payload_reset(&client
->communication
.inbound
.payload
);
1217 lttng_payload_reset(&client
->communication
.outbound
.payload
);
1218 pthread_mutex_destroy(&client
->lock
);
1219 call_rcu(&client
->rcu_node
, free_notification_client_rcu
);
1223 * Call with rcu_read_lock held (and hold for the lifetime of the returned
1227 struct notification_client
*get_client_from_socket(int socket
,
1228 struct notification_thread_state
*state
)
1230 struct cds_lfht_iter iter
;
1231 struct cds_lfht_node
*node
;
1232 struct notification_client
*client
= NULL
;
1234 cds_lfht_lookup(state
->client_socket_ht
,
1235 hash_client_socket(socket
),
1236 match_client_socket
,
1237 (void *) (unsigned long) socket
,
1239 node
= cds_lfht_iter_get_node(&iter
);
1244 client
= caa_container_of(node
, struct notification_client
,
1245 client_socket_ht_node
);
1251 * Call with rcu_read_lock held (and hold for the lifetime of the returned
1255 struct notification_client
*get_client_from_id(notification_client_id id
,
1256 struct notification_thread_state
*state
)
1258 struct cds_lfht_iter iter
;
1259 struct cds_lfht_node
*node
;
1260 struct notification_client
*client
= NULL
;
1262 cds_lfht_lookup(state
->client_id_ht
,
1267 node
= cds_lfht_iter_get_node(&iter
);
1272 client
= caa_container_of(node
, struct notification_client
,
1279 bool buffer_usage_condition_applies_to_channel(
1280 const struct lttng_condition
*condition
,
1281 const struct channel_info
*channel_info
)
1283 enum lttng_condition_status status
;
1284 enum lttng_domain_type condition_domain
;
1285 const char *condition_session_name
= NULL
;
1286 const char *condition_channel_name
= NULL
;
1288 status
= lttng_condition_buffer_usage_get_domain_type(condition
,
1290 assert(status
== LTTNG_CONDITION_STATUS_OK
);
1291 if (channel_info
->key
.domain
!= condition_domain
) {
1295 status
= lttng_condition_buffer_usage_get_session_name(
1296 condition
, &condition_session_name
);
1297 assert((status
== LTTNG_CONDITION_STATUS_OK
) && condition_session_name
);
1299 status
= lttng_condition_buffer_usage_get_channel_name(
1300 condition
, &condition_channel_name
);
1301 assert((status
== LTTNG_CONDITION_STATUS_OK
) && condition_channel_name
);
1303 if (strcmp(channel_info
->session_info
->name
, condition_session_name
)) {
1306 if (strcmp(channel_info
->name
, condition_channel_name
)) {
1316 bool session_consumed_size_condition_applies_to_channel(
1317 const struct lttng_condition
*condition
,
1318 const struct channel_info
*channel_info
)
1320 enum lttng_condition_status status
;
1321 const char *condition_session_name
= NULL
;
1323 status
= lttng_condition_session_consumed_size_get_session_name(
1324 condition
, &condition_session_name
);
1325 assert((status
== LTTNG_CONDITION_STATUS_OK
) && condition_session_name
);
1327 if (strcmp(channel_info
->session_info
->name
, condition_session_name
)) {
1337 bool trigger_applies_to_channel(const struct lttng_trigger
*trigger
,
1338 const struct channel_info
*channel_info
)
1340 const struct lttng_condition
*condition
;
1341 bool trigger_applies
;
1343 condition
= lttng_trigger_get_const_condition(trigger
);
1348 switch (lttng_condition_get_type(condition
)) {
1349 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW
:
1350 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH
:
1351 trigger_applies
= buffer_usage_condition_applies_to_channel(
1352 condition
, channel_info
);
1354 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE
:
1355 trigger_applies
= session_consumed_size_condition_applies_to_channel(
1356 condition
, channel_info
);
1362 return trigger_applies
;
1368 bool trigger_applies_to_client(struct lttng_trigger
*trigger
,
1369 struct notification_client
*client
)
1371 bool applies
= false;
1372 struct lttng_condition_list_element
*condition_list_element
;
1374 cds_list_for_each_entry(condition_list_element
, &client
->condition_list
,
1376 applies
= lttng_condition_is_equal(
1377 condition_list_element
->condition
,
1378 lttng_trigger_get_condition(trigger
));
1386 /* Must be called with RCU read lock held. */
1388 struct lttng_session_trigger_list
*get_session_trigger_list(
1389 struct notification_thread_state
*state
,
1390 const char *session_name
)
1392 struct lttng_session_trigger_list
*list
= NULL
;
1393 struct cds_lfht_node
*node
;
1394 struct cds_lfht_iter iter
;
1396 cds_lfht_lookup(state
->session_triggers_ht
,
1397 hash_key_str(session_name
, lttng_ht_seed
),
1398 match_session_trigger_list
,
1401 node
= cds_lfht_iter_get_node(&iter
);
1404 * Not an error, the list of triggers applying to that session
1405 * will be initialized when the session is created.
1407 DBG("[notification-thread] No trigger list found for session \"%s\" as it is not yet known to the notification system",
1412 list
= caa_container_of(node
,
1413 struct lttng_session_trigger_list
,
1414 session_triggers_ht_node
);
1420 * Allocate an empty lttng_session_trigger_list for the session named
1423 * No ownership of 'session_name' is assumed by the session trigger list.
1424 * It is the caller's responsability to ensure the session name is alive
1425 * for as long as this list is.
1428 struct lttng_session_trigger_list
*lttng_session_trigger_list_create(
1429 const char *session_name
,
1430 struct cds_lfht
*session_triggers_ht
)
1432 struct lttng_session_trigger_list
*list
;
1434 list
= zmalloc(sizeof(*list
));
1438 list
->session_name
= session_name
;
1439 CDS_INIT_LIST_HEAD(&list
->list
);
1440 cds_lfht_node_init(&list
->session_triggers_ht_node
);
1441 list
->session_triggers_ht
= session_triggers_ht
;
1444 /* Publish the list through the session_triggers_ht. */
1445 cds_lfht_add(session_triggers_ht
,
1446 hash_key_str(session_name
, lttng_ht_seed
),
1447 &list
->session_triggers_ht_node
);
1454 void free_session_trigger_list_rcu(struct rcu_head
*node
)
1456 free(caa_container_of(node
, struct lttng_session_trigger_list
,
1461 void lttng_session_trigger_list_destroy(struct lttng_session_trigger_list
*list
)
1463 struct lttng_trigger_list_element
*trigger_list_element
, *tmp
;
1465 /* Empty the list element by element, and then free the list itself. */
1466 cds_list_for_each_entry_safe(trigger_list_element
, tmp
,
1467 &list
->list
, node
) {
1468 cds_list_del(&trigger_list_element
->node
);
1469 free(trigger_list_element
);
1472 /* Unpublish the list from the session_triggers_ht. */
1473 cds_lfht_del(list
->session_triggers_ht
,
1474 &list
->session_triggers_ht_node
);
1476 call_rcu(&list
->rcu_node
, free_session_trigger_list_rcu
);
1480 int lttng_session_trigger_list_add(struct lttng_session_trigger_list
*list
,
1481 struct lttng_trigger
*trigger
)
1484 struct lttng_trigger_list_element
*new_element
=
1485 zmalloc(sizeof(*new_element
));
1491 CDS_INIT_LIST_HEAD(&new_element
->node
);
1492 new_element
->trigger
= trigger
;
1493 cds_list_add(&new_element
->node
, &list
->list
);
1499 bool trigger_applies_to_session(const struct lttng_trigger
*trigger
,
1500 const char *session_name
)
1502 bool applies
= false;
1503 const struct lttng_condition
*condition
;
1505 condition
= lttng_trigger_get_const_condition(trigger
);
1506 switch (lttng_condition_get_type(condition
)) {
1507 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
:
1508 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED
:
1510 enum lttng_condition_status condition_status
;
1511 const char *condition_session_name
;
1513 condition_status
= lttng_condition_session_rotation_get_session_name(
1514 condition
, &condition_session_name
);
1515 if (condition_status
!= LTTNG_CONDITION_STATUS_OK
) {
1516 ERR("[notification-thread] Failed to retrieve session rotation condition's session name");
1520 assert(condition_session_name
);
1521 applies
= !strcmp(condition_session_name
, session_name
);
1532 * Allocate and initialize an lttng_session_trigger_list which contains
1533 * all triggers that apply to the session named 'session_name'.
1535 * No ownership of 'session_name' is assumed by the session trigger list.
1536 * It is the caller's responsability to ensure the session name is alive
1537 * for as long as this list is.
1540 struct lttng_session_trigger_list
*lttng_session_trigger_list_build(
1541 const struct notification_thread_state
*state
,
1542 const char *session_name
)
1544 int trigger_count
= 0;
1545 struct lttng_session_trigger_list
*session_trigger_list
= NULL
;
1546 struct lttng_trigger_ht_element
*trigger_ht_element
= NULL
;
1547 struct cds_lfht_iter iter
;
1549 session_trigger_list
= lttng_session_trigger_list_create(session_name
,
1550 state
->session_triggers_ht
);
1552 /* Add all triggers applying to the session named 'session_name'. */
1553 cds_lfht_for_each_entry(state
->triggers_ht
, &iter
, trigger_ht_element
,
1557 if (!trigger_applies_to_session(trigger_ht_element
->trigger
,
1562 ret
= lttng_session_trigger_list_add(session_trigger_list
,
1563 trigger_ht_element
->trigger
);
1571 DBG("[notification-thread] Found %i triggers that apply to newly created session",
1573 return session_trigger_list
;
1575 lttng_session_trigger_list_destroy(session_trigger_list
);
1580 struct session_info
*find_or_create_session_info(
1581 struct notification_thread_state
*state
,
1582 const char *name
, uid_t uid
, gid_t gid
)
1584 struct session_info
*session
= NULL
;
1585 struct cds_lfht_node
*node
;
1586 struct cds_lfht_iter iter
;
1587 struct lttng_session_trigger_list
*trigger_list
;
1590 cds_lfht_lookup(state
->sessions_ht
,
1591 hash_key_str(name
, lttng_ht_seed
),
1595 node
= cds_lfht_iter_get_node(&iter
);
1597 DBG("[notification-thread] Found session info of session \"%s\" (uid = %i, gid = %i)",
1599 session
= caa_container_of(node
, struct session_info
,
1601 assert(session
->uid
== uid
);
1602 assert(session
->gid
== gid
);
1603 session_info_get(session
);
1607 trigger_list
= lttng_session_trigger_list_build(state
, name
);
1608 if (!trigger_list
) {
1612 session
= session_info_create(name
, uid
, gid
, trigger_list
,
1613 state
->sessions_ht
);
1615 ERR("[notification-thread] Failed to allocation session info for session \"%s\" (uid = %i, gid = %i)",
1617 lttng_session_trigger_list_destroy(trigger_list
);
1620 trigger_list
= NULL
;
1622 cds_lfht_add(state
->sessions_ht
, hash_key_str(name
, lttng_ht_seed
),
1623 &session
->sessions_ht_node
);
1629 session_info_put(session
);
1634 int handle_notification_thread_command_add_channel(
1635 struct notification_thread_state
*state
,
1636 const char *session_name
, uid_t session_uid
, gid_t session_gid
,
1637 const char *channel_name
, enum lttng_domain_type channel_domain
,
1638 uint64_t channel_key_int
, uint64_t channel_capacity
,
1639 enum lttng_error_code
*cmd_result
)
1641 struct cds_list_head trigger_list
;
1642 struct channel_info
*new_channel_info
= NULL
;
1643 struct channel_key channel_key
= {
1644 .key
= channel_key_int
,
1645 .domain
= channel_domain
,
1647 struct lttng_channel_trigger_list
*channel_trigger_list
= NULL
;
1648 struct lttng_trigger_ht_element
*trigger_ht_element
= NULL
;
1649 int trigger_count
= 0;
1650 struct cds_lfht_iter iter
;
1651 struct session_info
*session_info
= NULL
;
1653 DBG("[notification-thread] Adding channel %s from session %s, channel key = %" PRIu64
" in %s domain",
1654 channel_name
, session_name
, channel_key_int
,
1655 lttng_domain_type_str(channel_domain
));
1657 CDS_INIT_LIST_HEAD(&trigger_list
);
1659 session_info
= find_or_create_session_info(state
, session_name
,
1660 session_uid
, session_gid
);
1661 if (!session_info
) {
1662 /* Allocation error or an internal error occurred. */
1666 new_channel_info
= channel_info_create(channel_name
, &channel_key
,
1667 channel_capacity
, session_info
);
1668 if (!new_channel_info
) {
1673 /* Build a list of all triggers applying to the new channel. */
1674 cds_lfht_for_each_entry(state
->triggers_ht
, &iter
, trigger_ht_element
,
1676 struct lttng_trigger_list_element
*new_element
;
1678 if (!trigger_applies_to_channel(trigger_ht_element
->trigger
,
1679 new_channel_info
)) {
1683 new_element
= zmalloc(sizeof(*new_element
));
1688 CDS_INIT_LIST_HEAD(&new_element
->node
);
1689 new_element
->trigger
= trigger_ht_element
->trigger
;
1690 cds_list_add(&new_element
->node
, &trigger_list
);
1695 DBG("[notification-thread] Found %i triggers that apply to newly added channel",
1697 channel_trigger_list
= zmalloc(sizeof(*channel_trigger_list
));
1698 if (!channel_trigger_list
) {
1701 channel_trigger_list
->channel_key
= new_channel_info
->key
;
1702 CDS_INIT_LIST_HEAD(&channel_trigger_list
->list
);
1703 cds_lfht_node_init(&channel_trigger_list
->channel_triggers_ht_node
);
1704 cds_list_splice(&trigger_list
, &channel_trigger_list
->list
);
1707 /* Add channel to the channel_ht which owns the channel_infos. */
1708 cds_lfht_add(state
->channels_ht
,
1709 hash_channel_key(&new_channel_info
->key
),
1710 &new_channel_info
->channels_ht_node
);
1712 * Add the list of triggers associated with this channel to the
1713 * channel_triggers_ht.
1715 cds_lfht_add(state
->channel_triggers_ht
,
1716 hash_channel_key(&new_channel_info
->key
),
1717 &channel_trigger_list
->channel_triggers_ht_node
);
1719 session_info_put(session_info
);
1720 *cmd_result
= LTTNG_OK
;
1723 channel_info_destroy(new_channel_info
);
1724 session_info_put(session_info
);
1729 void free_channel_trigger_list_rcu(struct rcu_head
*node
)
1731 free(caa_container_of(node
, struct lttng_channel_trigger_list
,
1736 void free_channel_state_sample_rcu(struct rcu_head
*node
)
1738 free(caa_container_of(node
, struct channel_state_sample
,
1743 int handle_notification_thread_command_remove_channel(
1744 struct notification_thread_state
*state
,
1745 uint64_t channel_key
, enum lttng_domain_type domain
,
1746 enum lttng_error_code
*cmd_result
)
1748 struct cds_lfht_node
*node
;
1749 struct cds_lfht_iter iter
;
1750 struct lttng_channel_trigger_list
*trigger_list
;
1751 struct lttng_trigger_list_element
*trigger_list_element
, *tmp
;
1752 struct channel_key key
= { .key
= channel_key
, .domain
= domain
};
1753 struct channel_info
*channel_info
;
1755 DBG("[notification-thread] Removing channel key = %" PRIu64
" in %s domain",
1756 channel_key
, lttng_domain_type_str(domain
));
1760 cds_lfht_lookup(state
->channel_triggers_ht
,
1761 hash_channel_key(&key
),
1762 match_channel_trigger_list
,
1765 node
= cds_lfht_iter_get_node(&iter
);
1767 * There is a severe internal error if we are being asked to remove a
1768 * channel that doesn't exist.
1771 ERR("[notification-thread] Channel being removed is unknown to the notification thread");
1775 /* Free the list of triggers associated with this channel. */
1776 trigger_list
= caa_container_of(node
, struct lttng_channel_trigger_list
,
1777 channel_triggers_ht_node
);
1778 cds_list_for_each_entry_safe(trigger_list_element
, tmp
,
1779 &trigger_list
->list
, node
) {
1780 cds_list_del(&trigger_list_element
->node
);
1781 free(trigger_list_element
);
1783 cds_lfht_del(state
->channel_triggers_ht
, node
);
1784 call_rcu(&trigger_list
->rcu_node
, free_channel_trigger_list_rcu
);
1786 /* Free sampled channel state. */
1787 cds_lfht_lookup(state
->channel_state_ht
,
1788 hash_channel_key(&key
),
1789 match_channel_state_sample
,
1792 node
= cds_lfht_iter_get_node(&iter
);
1794 * This is expected to be NULL if the channel is destroyed before we
1795 * received a sample.
1798 struct channel_state_sample
*sample
= caa_container_of(node
,
1799 struct channel_state_sample
,
1800 channel_state_ht_node
);
1802 cds_lfht_del(state
->channel_state_ht
, node
);
1803 call_rcu(&sample
->rcu_node
, free_channel_state_sample_rcu
);
1806 /* Remove the channel from the channels_ht and free it. */
1807 cds_lfht_lookup(state
->channels_ht
,
1808 hash_channel_key(&key
),
1812 node
= cds_lfht_iter_get_node(&iter
);
1814 channel_info
= caa_container_of(node
, struct channel_info
,
1816 cds_lfht_del(state
->channels_ht
, node
);
1817 channel_info_destroy(channel_info
);
1820 *cmd_result
= LTTNG_OK
;
1825 int handle_notification_thread_command_session_rotation(
1826 struct notification_thread_state
*state
,
1827 enum notification_thread_command_type cmd_type
,
1828 const char *session_name
, uid_t session_uid
, gid_t session_gid
,
1829 uint64_t trace_archive_chunk_id
,
1830 struct lttng_trace_archive_location
*location
,
1831 enum lttng_error_code
*_cmd_result
)
1834 enum lttng_error_code cmd_result
= LTTNG_OK
;
1835 struct lttng_session_trigger_list
*trigger_list
;
1836 struct lttng_trigger_list_element
*trigger_list_element
;
1837 struct session_info
*session_info
;
1838 const struct lttng_credentials session_creds
= {
1839 .uid
= LTTNG_OPTIONAL_INIT_VALUE(session_uid
),
1840 .gid
= LTTNG_OPTIONAL_INIT_VALUE(session_gid
),
1845 session_info
= find_or_create_session_info(state
, session_name
,
1846 session_uid
, session_gid
);
1847 if (!session_info
) {
1848 /* Allocation error or an internal error occurred. */
1850 cmd_result
= LTTNG_ERR_NOMEM
;
1854 session_info
->rotation
.ongoing
=
1855 cmd_type
== NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING
;
1856 session_info
->rotation
.id
= trace_archive_chunk_id
;
1857 trigger_list
= get_session_trigger_list(state
, session_name
);
1858 if (!trigger_list
) {
1859 DBG("[notification-thread] No triggers applying to session \"%s\" found",
1864 cds_list_for_each_entry(trigger_list_element
, &trigger_list
->list
,
1866 const struct lttng_condition
*condition
;
1867 struct lttng_trigger
*trigger
;
1868 struct notification_client_list
*client_list
;
1869 struct lttng_evaluation
*evaluation
= NULL
;
1870 enum lttng_condition_type condition_type
;
1871 enum action_executor_status executor_status
;
1873 trigger
= trigger_list_element
->trigger
;
1874 condition
= lttng_trigger_get_const_condition(trigger
);
1876 condition_type
= lttng_condition_get_type(condition
);
1878 if (condition_type
== LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
&&
1879 cmd_type
!= NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING
) {
1881 } else if (condition_type
== LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED
&&
1882 cmd_type
!= NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_COMPLETED
) {
1886 client_list
= get_client_list_from_condition(state
, condition
);
1887 if (cmd_type
== NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING
) {
1888 evaluation
= lttng_evaluation_session_rotation_ongoing_create(
1889 trace_archive_chunk_id
);
1891 evaluation
= lttng_evaluation_session_rotation_completed_create(
1892 trace_archive_chunk_id
, location
);
1896 /* Internal error */
1898 cmd_result
= LTTNG_ERR_UNK
;
1903 * Ownership of `evaluation` transferred to the action executor
1904 * no matter the result.
1906 executor_status
= action_executor_enqueue(state
->executor
,
1907 trigger
, evaluation
, &session_creds
,
1910 switch (executor_status
) {
1911 case ACTION_EXECUTOR_STATUS_OK
:
1913 case ACTION_EXECUTOR_STATUS_ERROR
:
1914 case ACTION_EXECUTOR_STATUS_INVALID
:
1916 * TODO Add trigger identification (name/id) when
1917 * it is added to the API.
1919 ERR("Fatal error occurred while enqueuing action associated with session rotation trigger");
1922 case ACTION_EXECUTOR_STATUS_OVERFLOW
:
1924 * TODO Add trigger identification (name/id) when
1925 * it is added to the API.
1927 * Not a fatal error.
1929 WARN("No space left when enqueuing action associated with session rotation trigger");
1937 notification_client_list_put(client_list
);
1938 if (caa_unlikely(ret
)) {
1943 session_info_put(session_info
);
1944 *_cmd_result
= cmd_result
;
1950 int handle_notification_thread_command_add_tracer_event_source(
1951 struct notification_thread_state
*state
,
1952 int tracer_event_source_fd
,
1953 enum lttng_domain_type domain_type
,
1954 enum lttng_error_code
*_cmd_result
)
1957 enum lttng_error_code cmd_result
= LTTNG_OK
;
1958 struct notification_event_tracer_event_source_element
*element
= NULL
;
1960 element
= zmalloc(sizeof(*element
));
1962 cmd_result
= LTTNG_ERR_NOMEM
;
1967 element
->fd
= tracer_event_source_fd
;
1968 element
->domain
= domain_type
;
1970 cds_list_add(&element
->node
, &state
->tracer_event_sources_list
);
1972 DBG3("[notification-thread] Adding tracer event source fd to poll set: tracer_event_source_fd = %d, domain = '%s'",
1973 tracer_event_source_fd
,
1974 lttng_domain_type_str(domain_type
));
1976 /* Adding the read side pipe to the event poll. */
1977 ret
= lttng_poll_add(&state
->events
, tracer_event_source_fd
, LPOLLIN
| LPOLLERR
);
1979 ERR("[notification-thread] Failed to add tracer event source to poll set: tracer_event_source_fd = %d, domain = '%s'",
1980 tracer_event_source_fd
,
1981 lttng_domain_type_str(element
->domain
));
1982 cds_list_del(&element
->node
);
1987 element
->is_fd_in_poll_set
= true;
1990 *_cmd_result
= cmd_result
;
1995 int drain_event_notifier_notification_pipe(
1996 struct notification_thread_state
*state
,
1997 int pipe
, enum lttng_domain_type domain
)
1999 struct lttng_poll_event events
= {0};
2002 ret
= lttng_poll_create(&events
, 1, LTTNG_CLOEXEC
);
2004 ERR("[notification-thread] Error creating lttng_poll_event");
2008 ret
= lttng_poll_add(&events
, pipe
, LPOLLIN
);
2010 ERR("[notification-thread] Error adding fd event notifier notification pipe to lttng_poll_event: fd = %d",
2017 * Continue to consume notifications as long as there are new
2018 * ones coming in. The tracer has been asked to stop producing
2021 * LPOLLIN is explicitly checked since LPOLLHUP is implicitly
2022 * monitored (on Linux, at least) and will be returned when
2023 * the pipe is closed but empty.
2025 ret
= lttng_poll_wait_interruptible(&events
, 0);
2026 if (ret
== 0 || (LTTNG_POLL_GETEV(&events
, 0) & LPOLLIN
) == 0) {
2027 /* No more notification to be read on this pipe. */
2030 } else if (ret
< 0) {
2031 PERROR("Failed on lttng_poll_wait_interruptible() call");
2036 ret
= handle_one_event_notifier_notification(state
, pipe
, domain
);
2038 ERR("[notification-thread] Error consuming an event notifier notification from pipe: fd = %d",
2043 lttng_poll_clean(&events
);
2048 int handle_notification_thread_command_remove_tracer_event_source(
2049 struct notification_thread_state
*state
,
2050 int tracer_event_source_fd
,
2051 enum lttng_error_code
*_cmd_result
)
2055 enum lttng_error_code cmd_result
= LTTNG_OK
;
2056 struct notification_event_tracer_event_source_element
*source_element
= NULL
, *tmp
;
2058 cds_list_for_each_entry_safe(source_element
, tmp
,
2059 &state
->tracer_event_sources_list
, node
) {
2060 if (source_element
->fd
!= tracer_event_source_fd
) {
2064 DBG("[notification-thread] Removed tracer event source from poll set: tracer_event_source_fd = %d, domain = '%s'",
2065 tracer_event_source_fd
,
2066 lttng_domain_type_str(source_element
->domain
));
2067 cds_list_del(&source_element
->node
);
2074 * This is temporarily allowed since the poll activity set is
2075 * not properly cleaned-up for the moment. This is adressed in
2078 source_element
= NULL
;
2082 if (!source_element
->is_fd_in_poll_set
) {
2083 /* Skip the poll set removal. */
2087 DBG3("[notification-thread] Removing tracer event source from poll set: tracer_event_source_fd = %d, domain = '%s'",
2088 tracer_event_source_fd
,
2089 lttng_domain_type_str(source_element
->domain
));
2091 /* Removing the fd from the event poll set. */
2092 ret
= lttng_poll_del(&state
->events
, tracer_event_source_fd
);
2094 ERR("[notification-thread] Failed to remove tracer event source from poll set: tracer_event_source_fd = %d, domain = '%s'",
2095 tracer_event_source_fd
,
2096 lttng_domain_type_str(source_element
->domain
));
2097 cmd_result
= LTTNG_ERR_FATAL
;
2101 source_element
->is_fd_in_poll_set
= false;
2103 ret
= drain_event_notifier_notification_pipe(state
, tracer_event_source_fd
,
2104 source_element
->domain
);
2106 ERR("[notification-thread] Error draining event notifier notification: tracer_event_source_fd = %d, domain = %s",
2107 tracer_event_source_fd
,
2108 lttng_domain_type_str(source_element
->domain
));
2109 cmd_result
= LTTNG_ERR_FATAL
;
2114 * The drain_event_notifier_notification_pipe() call might have read
2115 * data from an fd that we received in event in the latest _poll_wait()
2116 * call. Make sure the thread call poll_wait() again to ensure we have
2119 state
->restart_poll
= true;
2122 free(source_element
);
2123 *_cmd_result
= cmd_result
;
2128 int condition_on_event_update_error_count(struct lttng_trigger
*trigger
)
2131 uint64_t error_count
= 0;
2132 struct lttng_condition
*condition
;
2133 enum event_notifier_error_accounting_status status
;
2135 condition
= lttng_trigger_get_condition(trigger
);
2136 assert(lttng_condition_get_type(condition
) ==
2137 LTTNG_CONDITION_TYPE_ON_EVENT
);
2139 status
= event_notifier_error_accounting_get_count(trigger
, &error_count
);
2140 if (status
!= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
) {
2141 uid_t trigger_owner_uid
;
2142 const char *trigger_name
;
2143 const enum lttng_trigger_status trigger_status
=
2144 lttng_trigger_get_owner_uid(
2145 trigger
, &trigger_owner_uid
);
2147 assert(trigger_status
== LTTNG_TRIGGER_STATUS_OK
);
2148 if (lttng_trigger_get_name(trigger
, &trigger_name
) != LTTNG_TRIGGER_STATUS_OK
) {
2149 trigger_name
= "(unnamed)";
2152 ERR("Failed to get event notifier error count of trigger for update: trigger owner = %d, trigger name = '%s'",
2153 trigger_owner_uid
, trigger_name
);
2157 lttng_condition_on_event_set_error_count(condition
, error_count
);
2161 int handle_notification_thread_remove_tracer_event_source_no_result(
2162 struct notification_thread_state
*state
,
2163 int tracer_event_source_fd
)
2166 enum lttng_error_code cmd_result
;
2168 ret
= handle_notification_thread_command_remove_tracer_event_source(
2169 state
, tracer_event_source_fd
, &cmd_result
);
2175 bool action_type_needs_tracer_notifier(enum lttng_action_type action_type
)
2177 switch (action_type
) {
2178 case LTTNG_ACTION_TYPE_NOTIFY
:
2179 case LTTNG_ACTION_TYPE_START_SESSION
:
2180 case LTTNG_ACTION_TYPE_STOP_SESSION
:
2181 case LTTNG_ACTION_TYPE_SNAPSHOT_SESSION
:
2182 case LTTNG_ACTION_TYPE_ROTATE_SESSION
:
2184 case LTTNG_ACTION_TYPE_GROUP
:
2185 case LTTNG_ACTION_TYPE_UNKNOWN
:
2192 bool action_needs_tracer_notifier(const struct lttng_action
*action
)
2194 bool needs_tracer_notifier
= false;
2195 unsigned int i
, count
;
2196 enum lttng_action_status action_status
;
2197 enum lttng_action_type action_type
;
2200 /* If there is only one action. Check if it needs a tracer notifier. */
2201 action_type
= lttng_action_get_type(action
);
2202 if (action_type
!= LTTNG_ACTION_TYPE_GROUP
) {
2203 needs_tracer_notifier
= action_type_needs_tracer_notifier(
2209 * Iterate over all the actions of the action group and check if any of
2210 * them needs a tracer notifier.
2212 action_status
= lttng_action_group_get_count(action
, &count
);
2213 assert(action_status
== LTTNG_ACTION_STATUS_OK
);
2214 for (i
= 0; i
< count
; i
++) {
2215 const struct lttng_action
*inner_action
=
2216 lttng_action_group_get_at_index(action
, i
);
2218 action_type
= lttng_action_get_type(inner_action
);
2219 if (action_type_needs_tracer_notifier(action_type
)) {
2220 needs_tracer_notifier
= true;
2226 return needs_tracer_notifier
;
2230 * A given trigger needs a tracer notifier if
2231 * it has an event-rule condition,
2233 * it has one or more sessiond-execution action.
2236 bool trigger_needs_tracer_notifier(const struct lttng_trigger
*trigger
)
2238 bool needs_tracer_notifier
= false;
2239 const struct lttng_condition
*condition
=
2240 lttng_trigger_get_const_condition(trigger
);
2241 const struct lttng_action
*action
=
2242 lttng_trigger_get_const_action(trigger
);
2244 switch (lttng_condition_get_type(condition
)) {
2245 case LTTNG_CONDITION_TYPE_ON_EVENT
:
2246 needs_tracer_notifier
= action_needs_tracer_notifier(action
);
2248 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE
:
2249 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH
:
2250 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW
:
2251 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
:
2252 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED
:
2254 case LTTNG_CONDITION_TYPE_UNKNOWN
:
2259 return needs_tracer_notifier
;
2262 static int handle_notification_thread_command_list_triggers(
2263 struct notification_thread_handle
*handle
,
2264 struct notification_thread_state
*state
,
2266 struct lttng_triggers
**triggers
,
2267 enum lttng_error_code
*_cmd_result
)
2270 enum lttng_error_code cmd_result
= LTTNG_OK
;
2271 struct cds_lfht_iter iter
;
2272 struct lttng_trigger_ht_element
*trigger_ht_element
;
2273 struct lttng_triggers
*local_triggers
= NULL
;
2274 const struct lttng_credentials
*creds
;
2278 local_triggers
= lttng_triggers_create();
2279 if (!local_triggers
) {
2280 /* Not a fatal error. */
2281 cmd_result
= LTTNG_ERR_NOMEM
;
2285 cds_lfht_for_each_entry(state
->triggers_ht
, &iter
,
2286 trigger_ht_element
, node
) {
2288 * Only return the triggers to which the client has access.
2289 * The root user has visibility over all triggers.
2291 creds
= lttng_trigger_get_credentials(trigger_ht_element
->trigger
);
2292 if (client_uid
!= lttng_credentials_get_uid(creds
) && client_uid
!= 0) {
2296 if (trigger_needs_tracer_notifier(trigger_ht_element
->trigger
)) {
2297 ret
= condition_on_event_update_error_count(
2298 trigger_ht_element
->trigger
);
2302 ret
= lttng_triggers_add(local_triggers
,
2303 trigger_ht_element
->trigger
);
2305 /* Not a fatal error. */
2307 cmd_result
= LTTNG_ERR_NOMEM
;
2312 /* Transferring ownership to the caller. */
2313 *triggers
= local_triggers
;
2314 local_triggers
= NULL
;
2318 lttng_triggers_destroy(local_triggers
);
2319 *_cmd_result
= cmd_result
;
2324 bool condition_is_supported(struct lttng_condition
*condition
)
2328 switch (lttng_condition_get_type(condition
)) {
2329 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW
:
2330 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH
:
2333 enum lttng_domain_type domain
;
2335 ret
= lttng_condition_buffer_usage_get_domain_type(condition
,
2339 if (domain
!= LTTNG_DOMAIN_KERNEL
) {
2340 is_supported
= true;
2345 * Older kernel tracers don't expose the API to monitor their
2346 * buffers. Therefore, we reject triggers that require that
2347 * mechanism to be available to be evaluated.
2349 * Assume unsupported on error.
2351 is_supported
= kernel_supports_ring_buffer_snapshot_sample_positions() == 1;
2354 case LTTNG_CONDITION_TYPE_ON_EVENT
:
2356 const struct lttng_event_rule
*event_rule
;
2357 enum lttng_domain_type domain
;
2358 const enum lttng_condition_status status
=
2359 lttng_condition_on_event_get_rule(
2360 condition
, &event_rule
);
2362 assert(status
== LTTNG_CONDITION_STATUS_OK
);
2364 domain
= lttng_event_rule_get_domain_type(event_rule
);
2365 if (domain
!= LTTNG_DOMAIN_KERNEL
) {
2366 is_supported
= true;
2371 * Older kernel tracers can't emit notification. Therefore, we
2372 * reject triggers that require that mechanism to be available
2375 * Assume unsupported on error.
2377 is_supported
= kernel_supports_event_notifiers() == 1;
2381 is_supported
= true;
2384 return is_supported
;
2387 /* Must be called with RCU read lock held. */
2389 int bind_trigger_to_matching_session(struct lttng_trigger
*trigger
,
2390 struct notification_thread_state
*state
)
2393 const struct lttng_condition
*condition
;
2394 const char *session_name
;
2395 struct lttng_session_trigger_list
*trigger_list
;
2397 condition
= lttng_trigger_get_const_condition(trigger
);
2398 switch (lttng_condition_get_type(condition
)) {
2399 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
:
2400 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED
:
2402 enum lttng_condition_status status
;
2404 status
= lttng_condition_session_rotation_get_session_name(
2405 condition
, &session_name
);
2406 if (status
!= LTTNG_CONDITION_STATUS_OK
) {
2407 ERR("[notification-thread] Failed to bind trigger to session: unable to get 'session_rotation' condition's session name");
2418 trigger_list
= get_session_trigger_list(state
, session_name
);
2419 if (!trigger_list
) {
2420 DBG("[notification-thread] Unable to bind trigger applying to session \"%s\" as it is not yet known to the notification system",
2426 DBG("[notification-thread] Newly registered trigger bound to session \"%s\"",
2428 ret
= lttng_session_trigger_list_add(trigger_list
, trigger
);
2433 /* Must be called with RCU read lock held. */
2435 int bind_trigger_to_matching_channels(struct lttng_trigger
*trigger
,
2436 struct notification_thread_state
*state
)
2439 struct cds_lfht_node
*node
;
2440 struct cds_lfht_iter iter
;
2441 struct channel_info
*channel
;
2443 cds_lfht_for_each_entry(state
->channels_ht
, &iter
, channel
,
2445 struct lttng_trigger_list_element
*trigger_list_element
;
2446 struct lttng_channel_trigger_list
*trigger_list
;
2447 struct cds_lfht_iter lookup_iter
;
2449 if (!trigger_applies_to_channel(trigger
, channel
)) {
2453 cds_lfht_lookup(state
->channel_triggers_ht
,
2454 hash_channel_key(&channel
->key
),
2455 match_channel_trigger_list
,
2458 node
= cds_lfht_iter_get_node(&lookup_iter
);
2460 trigger_list
= caa_container_of(node
,
2461 struct lttng_channel_trigger_list
,
2462 channel_triggers_ht_node
);
2464 trigger_list_element
= zmalloc(sizeof(*trigger_list_element
));
2465 if (!trigger_list_element
) {
2469 CDS_INIT_LIST_HEAD(&trigger_list_element
->node
);
2470 trigger_list_element
->trigger
= trigger
;
2471 cds_list_add(&trigger_list_element
->node
, &trigger_list
->list
);
2472 DBG("[notification-thread] Newly registered trigger bound to channel \"%s\"",
2480 bool is_trigger_action_notify(const struct lttng_trigger
*trigger
)
2482 bool is_notify
= false;
2483 unsigned int i
, count
;
2484 enum lttng_action_status action_status
;
2485 const struct lttng_action
*action
=
2486 lttng_trigger_get_const_action(trigger
);
2487 enum lttng_action_type action_type
;
2490 action_type
= lttng_action_get_type(action
);
2491 if (action_type
== LTTNG_ACTION_TYPE_NOTIFY
) {
2494 } else if (action_type
!= LTTNG_ACTION_TYPE_GROUP
) {
2498 action_status
= lttng_action_group_get_count(action
, &count
);
2499 assert(action_status
== LTTNG_ACTION_STATUS_OK
);
2501 for (i
= 0; i
< count
; i
++) {
2502 const struct lttng_action
*inner_action
=
2503 lttng_action_group_get_at_index(
2506 action_type
= lttng_action_get_type(inner_action
);
2507 if (action_type
== LTTNG_ACTION_TYPE_NOTIFY
) {
2517 static bool trigger_name_taken(struct notification_thread_state
*state
,
2518 const struct lttng_trigger
*trigger
)
2520 struct cds_lfht_iter iter
;
2523 * No duplicata is allowed in the triggers_by_name_uid_ht.
2524 * The match is done against the trigger name and uid.
2526 cds_lfht_lookup(state
->triggers_by_name_uid_ht
,
2527 hash_trigger_by_name_uid(trigger
),
2528 match_trigger_by_name_uid
,
2531 return !!cds_lfht_iter_get_node(&iter
);
2535 enum lttng_error_code
generate_trigger_name(
2536 struct notification_thread_state
*state
,
2537 struct lttng_trigger
*trigger
, const char **name
)
2539 enum lttng_error_code ret_code
= LTTNG_OK
;
2541 enum lttng_trigger_status status
;
2544 const int ret
= lttng_trigger_generate_name(trigger
,
2545 state
->trigger_id
.name_offset
++);
2547 /* The only reason this can fail right now. */
2548 ret_code
= LTTNG_ERR_NOMEM
;
2552 status
= lttng_trigger_get_name(trigger
, name
);
2553 assert(status
== LTTNG_TRIGGER_STATUS_OK
);
2555 taken
= trigger_name_taken(state
, trigger
);
2556 } while (taken
|| state
->trigger_id
.name_offset
== UINT64_MAX
);
2562 void notif_thread_state_remove_trigger_ht_elem(
2563 struct notification_thread_state
*state
,
2564 struct lttng_trigger_ht_element
*trigger_ht_element
)
2567 assert(trigger_ht_element
);
2569 cds_lfht_del(state
->triggers_ht
, &trigger_ht_element
->node
);
2570 cds_lfht_del(state
->triggers_by_name_uid_ht
, &trigger_ht_element
->node_by_name_uid
);
2574 * FIXME A client's credentials are not checked when registering a trigger.
2576 * The effects of this are benign since:
2577 * - The client will succeed in registering the trigger, as it is valid,
2578 * - The trigger will, internally, be bound to the channel/session,
2579 * - The notifications will not be sent since the client's credentials
2580 * are checked against the channel at that moment.
2582 * If this function returns a non-zero value, it means something is
2583 * fundamentally broken and the whole subsystem/thread will be torn down.
2585 * If a non-fatal error occurs, just set the cmd_result to the appropriate
2589 int handle_notification_thread_command_register_trigger(
2590 struct notification_thread_state
*state
,
2591 struct lttng_trigger
*trigger
,
2592 enum lttng_error_code
*cmd_result
)
2595 struct lttng_condition
*condition
;
2596 struct notification_client
*client
;
2597 struct notification_client_list
*client_list
= NULL
;
2598 struct lttng_trigger_ht_element
*trigger_ht_element
= NULL
;
2599 struct notification_client_list_element
*client_list_element
;
2600 struct notification_trigger_tokens_ht_element
*trigger_tokens_ht_element
= NULL
;
2601 struct cds_lfht_node
*node
;
2602 struct cds_lfht_iter iter
;
2603 const char* trigger_name
;
2604 bool free_trigger
= true;
2605 struct lttng_evaluation
*evaluation
= NULL
;
2606 struct lttng_credentials object_creds
;
2609 enum action_executor_status executor_status
;
2610 const uint64_t trigger_tracer_token
=
2611 state
->trigger_id
.next_tracer_token
++;
2615 /* Set the trigger's tracer token. */
2616 lttng_trigger_set_tracer_token(trigger
, trigger_tracer_token
);
2618 if (lttng_trigger_get_name(trigger
, &trigger_name
) ==
2619 LTTNG_TRIGGER_STATUS_UNSET
) {
2620 const enum lttng_error_code ret_code
= generate_trigger_name(
2621 state
, trigger
, &trigger_name
);
2623 if (ret_code
!= LTTNG_OK
) {
2626 *cmd_result
= ret_code
;
2629 } else if (trigger_name_taken(state
, trigger
)) {
2630 /* Not a fatal error. */
2631 *cmd_result
= LTTNG_ERR_TRIGGER_EXISTS
;
2636 condition
= lttng_trigger_get_condition(trigger
);
2639 /* Some conditions require tracers to implement a minimal ABI version. */
2640 if (!condition_is_supported(condition
)) {
2641 *cmd_result
= LTTNG_ERR_NOT_SUPPORTED
;
2645 trigger_ht_element
= zmalloc(sizeof(*trigger_ht_element
));
2646 if (!trigger_ht_element
) {
2651 /* Add trigger to the trigger_ht. */
2652 cds_lfht_node_init(&trigger_ht_element
->node
);
2653 cds_lfht_node_init(&trigger_ht_element
->node_by_name_uid
);
2654 trigger_ht_element
->trigger
= trigger
;
2656 node
= cds_lfht_add_unique(state
->triggers_ht
,
2657 lttng_condition_hash(condition
),
2660 &trigger_ht_element
->node
);
2661 if (node
!= &trigger_ht_element
->node
) {
2662 /* Not a fatal error, simply report it to the client. */
2663 *cmd_result
= LTTNG_ERR_TRIGGER_EXISTS
;
2664 goto error_free_ht_element
;
2667 node
= cds_lfht_add_unique(state
->triggers_by_name_uid_ht
,
2668 hash_trigger_by_name_uid(trigger
),
2669 match_trigger_by_name_uid
,
2671 &trigger_ht_element
->node_by_name_uid
);
2672 if (node
!= &trigger_ht_element
->node_by_name_uid
) {
2673 /* Not a fatal error, simply report it to the client. */
2674 cds_lfht_del(state
->triggers_ht
, &trigger_ht_element
->node
);
2675 *cmd_result
= LTTNG_ERR_TRIGGER_EXISTS
;
2676 goto error_free_ht_element
;
2679 if (lttng_condition_get_type(condition
) == LTTNG_CONDITION_TYPE_ON_EVENT
) {
2680 trigger_tokens_ht_element
= zmalloc(sizeof(*trigger_tokens_ht_element
));
2681 if (!trigger_tokens_ht_element
) {
2684 notif_thread_state_remove_trigger_ht_elem(state
,
2685 trigger_ht_element
);
2686 goto error_free_ht_element
;
2689 /* Add trigger token to the trigger_tokens_ht. */
2690 cds_lfht_node_init(&trigger_tokens_ht_element
->node
);
2691 trigger_tokens_ht_element
->token
=
2692 LTTNG_OPTIONAL_GET(trigger
->tracer_token
);
2693 trigger_tokens_ht_element
->trigger
= trigger
;
2695 node
= cds_lfht_add_unique(state
->trigger_tokens_ht
,
2696 hash_key_u64(&trigger_tokens_ht_element
->token
,
2698 match_trigger_token
,
2699 &trigger_tokens_ht_element
->token
,
2700 &trigger_tokens_ht_element
->node
);
2701 if (node
!= &trigger_tokens_ht_element
->node
) {
2702 /* Internal corruption, fatal error. */
2704 *cmd_result
= LTTNG_ERR_TRIGGER_EXISTS
;
2705 notif_thread_state_remove_trigger_ht_elem(state
,
2706 trigger_ht_element
);
2707 goto error_free_ht_element
;
2710 if (trigger_needs_tracer_notifier(trigger
)) {
2711 uint64_t error_counter_index
= 0;
2712 enum event_notifier_error_accounting_status error_accounting_status
;
2714 error_accounting_status
= event_notifier_error_accounting_register_event_notifier(
2715 trigger
, &error_counter_index
);
2716 if (error_accounting_status
!= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
) {
2717 if (error_accounting_status
== EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_NO_INDEX_AVAILABLE
) {
2718 DBG("Event notifier group error accounting map is full");
2719 *cmd_result
= LTTNG_ERR_EVENT_NOTIFIER_ERROR_ACCOUNTING_FULL
;
2721 ERR("Failed to register event notifier for error accounting");
2722 *cmd_result
= LTTNG_ERR_EVENT_NOTIFIER_REGISTRATION
;
2725 cds_lfht_del(state
->trigger_tokens_ht
,
2726 &trigger_tokens_ht_element
->node
);
2727 notif_thread_state_remove_trigger_ht_elem(state
,
2728 trigger_ht_element
);
2729 goto error_free_ht_element
;
2732 lttng_condition_on_event_set_error_counter_index(
2733 condition
, error_counter_index
);
2739 * Ownership of the trigger and of its wrapper was transfered to
2740 * the triggers_ht. Same for token ht element if necessary.
2742 trigger_tokens_ht_element
= NULL
;
2743 trigger_ht_element
= NULL
;
2744 free_trigger
= false;
2747 * The rest only applies to triggers that have a "notify" action.
2748 * It is not skipped as this is the only action type currently
2751 if (is_trigger_action_notify(trigger
)) {
2752 client_list
= notification_client_list_create(trigger
);
2755 goto error_free_ht_element
;
2758 /* Build a list of clients to which this new trigger applies. */
2759 cds_lfht_for_each_entry (state
->client_socket_ht
, &iter
, client
,
2760 client_socket_ht_node
) {
2761 if (!trigger_applies_to_client(trigger
, client
)) {
2765 client_list_element
=
2766 zmalloc(sizeof(*client_list_element
));
2767 if (!client_list_element
) {
2769 goto error_put_client_list
;
2772 CDS_INIT_LIST_HEAD(&client_list_element
->node
);
2773 client_list_element
->client
= client
;
2774 cds_list_add(&client_list_element
->node
,
2775 &client_list
->list
);
2779 * Client list ownership transferred to the
2780 * notification_trigger_clients_ht.
2782 publish_notification_client_list(state
, client_list
);
2785 switch (get_condition_binding_object(condition
)) {
2786 case LTTNG_OBJECT_TYPE_SESSION
:
2787 /* Add the trigger to the list if it matches a known session. */
2788 ret
= bind_trigger_to_matching_session(trigger
, state
);
2790 goto error_put_client_list
;
2793 case LTTNG_OBJECT_TYPE_CHANNEL
:
2795 * Add the trigger to list of triggers bound to the channels
2798 ret
= bind_trigger_to_matching_channels(trigger
, state
);
2800 goto error_put_client_list
;
2803 case LTTNG_OBJECT_TYPE_NONE
:
2806 ERR("Unknown object type on which to bind a newly registered trigger was encountered");
2808 goto error_put_client_list
;
2812 * The new trigger's condition must be evaluated against the current
2815 * In the case of `notify` action, nothing preventing clients from
2816 * subscribing to a condition before the corresponding trigger is
2817 * registered, we have to evaluate this new condition right away.
2819 * At some point, we were waiting for the next "evaluation" (e.g. on
2820 * reception of a channel sample) to evaluate this new condition, but
2823 * The reason it was broken is that waiting for the next sample
2824 * does not allow us to properly handle transitions for edge-triggered
2827 * Consider this example: when we handle a new channel sample, we
2828 * evaluate each conditions twice: once with the previous state, and
2829 * again with the newest state. We then use those two results to
2830 * determine whether a state change happened: a condition was false and
2831 * became true. If a state change happened, we have to notify clients.
2833 * Now, if a client subscribes to a given notification and registers
2834 * a trigger *after* that subscription, we have to make sure the
2835 * condition is evaluated at this point while considering only the
2836 * current state. Otherwise, the next evaluation cycle may only see
2837 * that the evaluations remain the same (true for samples n-1 and n) and
2838 * the client will never know that the condition has been met.
2840 switch (get_condition_binding_object(condition
)) {
2841 case LTTNG_OBJECT_TYPE_SESSION
:
2842 ret
= evaluate_session_condition_for_client(condition
, state
,
2843 &evaluation
, &object_uid
,
2845 LTTNG_OPTIONAL_SET(&object_creds
.uid
, object_uid
);
2846 LTTNG_OPTIONAL_SET(&object_creds
.gid
, object_gid
);
2848 case LTTNG_OBJECT_TYPE_CHANNEL
:
2849 ret
= evaluate_channel_condition_for_client(condition
, state
,
2850 &evaluation
, &object_uid
,
2852 LTTNG_OPTIONAL_SET(&object_creds
.uid
, object_uid
);
2853 LTTNG_OPTIONAL_SET(&object_creds
.gid
, object_gid
);
2855 case LTTNG_OBJECT_TYPE_NONE
:
2858 case LTTNG_OBJECT_TYPE_UNKNOWN
:
2866 goto error_put_client_list
;
2869 DBG("Newly registered trigger's condition evaluated to %s",
2870 evaluation
? "true" : "false");
2872 /* Evaluation yielded nothing. Normal exit. */
2878 * Ownership of `evaluation` transferred to the action executor
2879 * no matter the result.
2881 executor_status
= action_executor_enqueue(state
->executor
, trigger
,
2882 evaluation
, &object_creds
, client_list
);
2884 switch (executor_status
) {
2885 case ACTION_EXECUTOR_STATUS_OK
:
2887 case ACTION_EXECUTOR_STATUS_ERROR
:
2888 case ACTION_EXECUTOR_STATUS_INVALID
:
2890 * TODO Add trigger identification (name/id) when
2891 * it is added to the API.
2893 ERR("Fatal error occurred while enqueuing action associated to newly registered trigger");
2895 goto error_put_client_list
;
2896 case ACTION_EXECUTOR_STATUS_OVERFLOW
:
2898 * TODO Add trigger identification (name/id) when
2899 * it is added to the API.
2901 * Not a fatal error.
2903 WARN("No space left when enqueuing action associated to newly registered trigger");
2911 *cmd_result
= LTTNG_OK
;
2912 DBG("Registered trigger: name = `%s`, tracer token = %" PRIu64
,
2913 trigger_name
, trigger_tracer_token
);
2915 error_put_client_list
:
2916 notification_client_list_put(client_list
);
2918 error_free_ht_element
:
2919 if (trigger_ht_element
) {
2920 /* Delayed removal due to RCU constraint on delete. */
2921 call_rcu(&trigger_ht_element
->rcu_node
,
2922 free_lttng_trigger_ht_element_rcu
);
2925 free(trigger_tokens_ht_element
);
2928 lttng_trigger_destroy(trigger
);
2935 void free_lttng_trigger_ht_element_rcu(struct rcu_head
*node
)
2937 free(caa_container_of(node
, struct lttng_trigger_ht_element
,
2942 void free_notification_trigger_tokens_ht_element_rcu(struct rcu_head
*node
)
2944 free(caa_container_of(node
, struct notification_trigger_tokens_ht_element
,
2949 int handle_notification_thread_command_unregister_trigger(
2950 struct notification_thread_state
*state
,
2951 const struct lttng_trigger
*trigger
,
2952 enum lttng_error_code
*_cmd_reply
)
2954 struct cds_lfht_iter iter
;
2955 struct cds_lfht_node
*triggers_ht_node
;
2956 struct lttng_channel_trigger_list
*trigger_list
;
2957 struct notification_client_list
*client_list
;
2958 struct lttng_trigger_ht_element
*trigger_ht_element
= NULL
;
2959 const struct lttng_condition
*condition
= lttng_trigger_get_const_condition(
2961 enum lttng_error_code cmd_reply
;
2965 cds_lfht_lookup(state
->triggers_ht
,
2966 lttng_condition_hash(condition
),
2970 triggers_ht_node
= cds_lfht_iter_get_node(&iter
);
2971 if (!triggers_ht_node
) {
2972 cmd_reply
= LTTNG_ERR_TRIGGER_NOT_FOUND
;
2975 cmd_reply
= LTTNG_OK
;
2978 /* Remove trigger from channel_triggers_ht. */
2979 cds_lfht_for_each_entry(state
->channel_triggers_ht
, &iter
, trigger_list
,
2980 channel_triggers_ht_node
) {
2981 struct lttng_trigger_list_element
*trigger_element
, *tmp
;
2983 cds_list_for_each_entry_safe(trigger_element
, tmp
,
2984 &trigger_list
->list
, node
) {
2985 if (!lttng_trigger_is_equal(trigger
, trigger_element
->trigger
)) {
2989 DBG("[notification-thread] Removed trigger from channel_triggers_ht");
2990 cds_list_del(&trigger_element
->node
);
2991 /* A trigger can only appear once per channel */
2996 if (lttng_condition_get_type(condition
) ==
2997 LTTNG_CONDITION_TYPE_ON_EVENT
) {
2998 struct notification_trigger_tokens_ht_element
2999 *trigger_tokens_ht_element
;
3001 cds_lfht_for_each_entry (state
->trigger_tokens_ht
, &iter
,
3002 trigger_tokens_ht_element
, node
) {
3003 if (!lttng_trigger_is_equal(trigger
,
3004 trigger_tokens_ht_element
->trigger
)) {
3008 if (trigger_needs_tracer_notifier(trigger_tokens_ht_element
->trigger
)) {
3009 event_notifier_error_accounting_unregister_event_notifier(
3010 trigger_tokens_ht_element
->trigger
);
3013 DBG("[notification-thread] Removed trigger from tokens_ht");
3014 cds_lfht_del(state
->trigger_tokens_ht
,
3015 &trigger_tokens_ht_element
->node
);
3016 call_rcu(&trigger_tokens_ht_element
->rcu_node
,
3017 free_notification_trigger_tokens_ht_element_rcu
);
3023 if (is_trigger_action_notify(trigger
)) {
3025 * Remove and release the client list from
3026 * notification_trigger_clients_ht.
3028 client_list
= get_client_list_from_condition(state
, condition
);
3029 assert(client_list
);
3031 /* Put new reference and the hashtable's reference. */
3032 notification_client_list_put(client_list
);
3033 notification_client_list_put(client_list
);
3037 trigger_ht_element
= caa_container_of(triggers_ht_node
,
3038 struct lttng_trigger_ht_element
, node
);
3040 /* Remove trigger from triggers_ht. */
3041 notif_thread_state_remove_trigger_ht_elem(state
, trigger_ht_element
);
3043 /* Release the ownership of the trigger. */
3044 lttng_trigger_destroy(trigger_ht_element
->trigger
);
3045 call_rcu(&trigger_ht_element
->rcu_node
, free_lttng_trigger_ht_element_rcu
);
3049 *_cmd_reply
= cmd_reply
;
3054 /* Returns 0 on success, 1 on exit requested, negative value on error. */
3055 int handle_notification_thread_command(
3056 struct notification_thread_handle
*handle
,
3057 struct notification_thread_state
*state
)
3061 struct notification_thread_command
*cmd
;
3063 /* Read the event pipe to put it back into a quiescent state. */
3064 ret
= lttng_read(lttng_pipe_get_readfd(handle
->cmd_queue
.event_pipe
), &counter
,
3066 if (ret
!= sizeof(counter
)) {
3070 pthread_mutex_lock(&handle
->cmd_queue
.lock
);
3071 cmd
= cds_list_first_entry(&handle
->cmd_queue
.list
,
3072 struct notification_thread_command
, cmd_list_node
);
3073 cds_list_del(&cmd
->cmd_list_node
);
3074 pthread_mutex_unlock(&handle
->cmd_queue
.lock
);
3076 DBG("[notification-thread] Received `%s` command",
3077 notification_command_type_str(cmd
->type
));
3078 switch (cmd
->type
) {
3079 case NOTIFICATION_COMMAND_TYPE_REGISTER_TRIGGER
:
3080 ret
= handle_notification_thread_command_register_trigger(state
,
3081 cmd
->parameters
.register_trigger
.trigger
,
3084 case NOTIFICATION_COMMAND_TYPE_UNREGISTER_TRIGGER
:
3085 ret
= handle_notification_thread_command_unregister_trigger(
3087 cmd
->parameters
.unregister_trigger
.trigger
,
3090 case NOTIFICATION_COMMAND_TYPE_ADD_CHANNEL
:
3091 ret
= handle_notification_thread_command_add_channel(
3093 cmd
->parameters
.add_channel
.session
.name
,
3094 cmd
->parameters
.add_channel
.session
.uid
,
3095 cmd
->parameters
.add_channel
.session
.gid
,
3096 cmd
->parameters
.add_channel
.channel
.name
,
3097 cmd
->parameters
.add_channel
.channel
.domain
,
3098 cmd
->parameters
.add_channel
.channel
.key
,
3099 cmd
->parameters
.add_channel
.channel
.capacity
,
3102 case NOTIFICATION_COMMAND_TYPE_REMOVE_CHANNEL
:
3103 ret
= handle_notification_thread_command_remove_channel(
3104 state
, cmd
->parameters
.remove_channel
.key
,
3105 cmd
->parameters
.remove_channel
.domain
,
3108 case NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING
:
3109 case NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_COMPLETED
:
3110 ret
= handle_notification_thread_command_session_rotation(
3113 cmd
->parameters
.session_rotation
.session_name
,
3114 cmd
->parameters
.session_rotation
.uid
,
3115 cmd
->parameters
.session_rotation
.gid
,
3116 cmd
->parameters
.session_rotation
.trace_archive_chunk_id
,
3117 cmd
->parameters
.session_rotation
.location
,
3120 case NOTIFICATION_COMMAND_TYPE_ADD_TRACER_EVENT_SOURCE
:
3121 ret
= handle_notification_thread_command_add_tracer_event_source(
3123 cmd
->parameters
.tracer_event_source
.tracer_event_source_fd
,
3124 cmd
->parameters
.tracer_event_source
.domain
,
3127 case NOTIFICATION_COMMAND_TYPE_REMOVE_TRACER_EVENT_SOURCE
:
3128 ret
= handle_notification_thread_command_remove_tracer_event_source(
3130 cmd
->parameters
.tracer_event_source
.tracer_event_source_fd
,
3133 case NOTIFICATION_COMMAND_TYPE_LIST_TRIGGERS
:
3135 struct lttng_triggers
*triggers
= NULL
;
3137 ret
= handle_notification_thread_command_list_triggers(
3140 cmd
->parameters
.list_triggers
.uid
,
3143 cmd
->reply
.list_triggers
.triggers
= triggers
;
3147 case NOTIFICATION_COMMAND_TYPE_QUIT
:
3148 cmd
->reply_code
= LTTNG_OK
;
3151 case NOTIFICATION_COMMAND_TYPE_CLIENT_COMMUNICATION_UPDATE
:
3153 const enum client_transmission_status client_status
=
3154 cmd
->parameters
.client_communication_update
3156 const notification_client_id client_id
=
3157 cmd
->parameters
.client_communication_update
.id
;
3158 struct notification_client
*client
;
3161 client
= get_client_from_id(client_id
, state
);
3165 * Client error was probably already picked-up by the
3166 * notification thread or it has disconnected
3167 * gracefully while this command was queued.
3169 DBG("Failed to find notification client to update communication status, client id = %" PRIu64
,
3173 ret
= client_handle_transmission_status(
3174 client
, client_status
, state
);
3180 ERR("[notification-thread] Unknown internal command received");
3188 if (cmd
->is_async
) {
3192 lttng_waiter_wake_up(&cmd
->reply_waiter
);
3196 /* Wake-up and return a fatal error to the calling thread. */
3197 lttng_waiter_wake_up(&cmd
->reply_waiter
);
3198 cmd
->reply_code
= LTTNG_ERR_FATAL
;
3200 /* Indicate a fatal error to the caller. */
3205 int socket_set_non_blocking(int socket
)
3209 /* Set the pipe as non-blocking. */
3210 ret
= fcntl(socket
, F_GETFL
, 0);
3212 PERROR("fcntl get socket flags");
3217 ret
= fcntl(socket
, F_SETFL
, flags
| O_NONBLOCK
);
3219 PERROR("fcntl set O_NONBLOCK socket flag");
3222 DBG("Client socket (fd = %i) set as non-blocking", socket
);
3228 int client_reset_inbound_state(struct notification_client
*client
)
3233 lttng_payload_clear(&client
->communication
.inbound
.payload
);
3235 client
->communication
.inbound
.bytes_to_receive
=
3236 sizeof(struct lttng_notification_channel_message
);
3237 client
->communication
.inbound
.msg_type
=
3238 LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_UNKNOWN
;
3239 LTTNG_SOCK_SET_UID_CRED(&client
->communication
.inbound
.creds
, -1);
3240 LTTNG_SOCK_SET_GID_CRED(&client
->communication
.inbound
.creds
, -1);
3241 ret
= lttng_dynamic_buffer_set_size(
3242 &client
->communication
.inbound
.payload
.buffer
,
3243 client
->communication
.inbound
.bytes_to_receive
);
3248 int handle_notification_thread_client_connect(
3249 struct notification_thread_state
*state
)
3252 struct notification_client
*client
;
3254 DBG("[notification-thread] Handling new notification channel client connection");
3256 client
= zmalloc(sizeof(*client
));
3263 pthread_mutex_init(&client
->lock
, NULL
);
3264 client
->id
= state
->next_notification_client_id
++;
3265 CDS_INIT_LIST_HEAD(&client
->condition_list
);
3266 lttng_payload_init(&client
->communication
.inbound
.payload
);
3267 lttng_payload_init(&client
->communication
.outbound
.payload
);
3268 client
->communication
.inbound
.expect_creds
= true;
3270 ret
= client_reset_inbound_state(client
);
3272 ERR("[notification-thread] Failed to reset client communication's inbound state");
3277 ret
= lttcomm_accept_unix_sock(state
->notification_channel_socket
);
3279 ERR("[notification-thread] Failed to accept new notification channel client connection");
3284 client
->socket
= ret
;
3286 ret
= socket_set_non_blocking(client
->socket
);
3288 ERR("[notification-thread] Failed to set new notification channel client connection socket as non-blocking");
3292 ret
= lttcomm_setsockopt_creds_unix_sock(client
->socket
);
3294 ERR("[notification-thread] Failed to set socket options on new notification channel client socket");
3299 ret
= lttng_poll_add(&state
->events
, client
->socket
,
3300 LPOLLIN
| LPOLLERR
|
3301 LPOLLHUP
| LPOLLRDHUP
);
3303 ERR("[notification-thread] Failed to add notification channel client socket to poll set");
3307 DBG("[notification-thread] Added new notification channel client socket (%i) to poll set",
3311 cds_lfht_add(state
->client_socket_ht
,
3312 hash_client_socket(client
->socket
),
3313 &client
->client_socket_ht_node
);
3314 cds_lfht_add(state
->client_id_ht
,
3315 hash_client_id(client
->id
),
3316 &client
->client_id_ht_node
);
3322 notification_client_destroy(client
, state
);
3327 * RCU read-lock must be held by the caller.
3328 * Client lock must _not_ be held by the caller.
3331 int notification_thread_client_disconnect(
3332 struct notification_client
*client
,
3333 struct notification_thread_state
*state
)
3336 struct lttng_condition_list_element
*condition_list_element
, *tmp
;
3338 /* Acquire the client lock to disable its communication atomically. */
3339 pthread_mutex_lock(&client
->lock
);
3340 client
->communication
.active
= false;
3341 cds_lfht_del(state
->client_socket_ht
, &client
->client_socket_ht_node
);
3342 cds_lfht_del(state
->client_id_ht
, &client
->client_id_ht_node
);
3343 pthread_mutex_unlock(&client
->lock
);
3345 ret
= lttng_poll_del(&state
->events
, client
->socket
);
3347 ERR("[notification-thread] Failed to remove client socket %d from poll set",
3351 /* Release all conditions to which the client was subscribed. */
3352 cds_list_for_each_entry_safe(condition_list_element
, tmp
,
3353 &client
->condition_list
, node
) {
3354 (void) notification_thread_client_unsubscribe(client
,
3355 condition_list_element
->condition
, state
, NULL
);
3359 * Client no longer accessible to other threads (through the
3362 notification_client_destroy(client
, state
);
3366 int handle_notification_thread_client_disconnect(
3367 int client_socket
, struct notification_thread_state
*state
)
3370 struct notification_client
*client
;
3373 DBG("[notification-thread] Closing client connection (socket fd = %i)",
3375 client
= get_client_from_socket(client_socket
, state
);
3377 /* Internal state corruption, fatal error. */
3378 ERR("[notification-thread] Unable to find client (socket fd = %i)",
3384 ret
= notification_thread_client_disconnect(client
, state
);
3390 int handle_notification_thread_client_disconnect_all(
3391 struct notification_thread_state
*state
)
3393 struct cds_lfht_iter iter
;
3394 struct notification_client
*client
;
3395 bool error_encoutered
= false;
3398 DBG("[notification-thread] Closing all client connections");
3399 cds_lfht_for_each_entry(state
->client_socket_ht
, &iter
, client
,
3400 client_socket_ht_node
) {
3403 ret
= notification_thread_client_disconnect(
3406 error_encoutered
= true;
3410 return error_encoutered
? 1 : 0;
3413 int handle_notification_thread_trigger_unregister_all(
3414 struct notification_thread_state
*state
)
3416 bool error_occurred
= false;
3417 struct cds_lfht_iter iter
;
3418 struct lttng_trigger_ht_element
*trigger_ht_element
;
3421 cds_lfht_for_each_entry(state
->triggers_ht
, &iter
, trigger_ht_element
,
3423 int ret
= handle_notification_thread_command_unregister_trigger(
3424 state
, trigger_ht_element
->trigger
, NULL
);
3426 error_occurred
= true;
3430 return error_occurred
? -1 : 0;
3434 int client_handle_transmission_status(
3435 struct notification_client
*client
,
3436 enum client_transmission_status transmission_status
,
3437 struct notification_thread_state
*state
)
3441 switch (transmission_status
) {
3442 case CLIENT_TRANSMISSION_STATUS_COMPLETE
:
3443 ret
= lttng_poll_mod(&state
->events
, client
->socket
,
3444 CLIENT_POLL_MASK_IN
);
3450 case CLIENT_TRANSMISSION_STATUS_QUEUED
:
3452 * We want to be notified whenever there is buffer space
3453 * available to send the rest of the payload.
3455 ret
= lttng_poll_mod(&state
->events
, client
->socket
,
3456 CLIENT_POLL_MASK_IN_OUT
);
3461 case CLIENT_TRANSMISSION_STATUS_FAIL
:
3462 ret
= notification_thread_client_disconnect(client
, state
);
3467 case CLIENT_TRANSMISSION_STATUS_ERROR
:
3477 /* Client lock must be acquired by caller. */
3479 enum client_transmission_status
client_flush_outgoing_queue(
3480 struct notification_client
*client
)
3483 size_t to_send_count
;
3484 enum client_transmission_status status
;
3485 struct lttng_payload_view pv
= lttng_payload_view_from_payload(
3486 &client
->communication
.outbound
.payload
, 0, -1);
3487 const int fds_to_send_count
=
3488 lttng_payload_view_get_fd_handle_count(&pv
);
3490 ASSERT_LOCKED(client
->lock
);
3492 if (!client
->communication
.active
) {
3493 status
= CLIENT_TRANSMISSION_STATUS_FAIL
;
3497 if (pv
.buffer
.size
== 0) {
3499 * If both data and fds are equal to zero, we are in an invalid
3502 assert(fds_to_send_count
!= 0);
3507 to_send_count
= pv
.buffer
.size
;
3508 DBG("[notification-thread] Flushing client (socket fd = %i) outgoing queue",
3511 ret
= lttcomm_send_unix_sock_non_block(client
->socket
,
3514 if ((ret
>= 0 && ret
< to_send_count
)) {
3515 DBG("[notification-thread] Client (socket fd = %i) outgoing queue could not be completely flushed",
3517 to_send_count
-= max(ret
, 0);
3519 memmove(client
->communication
.outbound
.payload
.buffer
.data
,
3521 pv
.buffer
.size
- to_send_count
,
3523 ret
= lttng_dynamic_buffer_set_size(
3524 &client
->communication
.outbound
.payload
.buffer
,
3530 status
= CLIENT_TRANSMISSION_STATUS_QUEUED
;
3532 } else if (ret
< 0) {
3533 /* Generic error, disable the client's communication. */
3534 ERR("[notification-thread] Failed to flush outgoing queue, disconnecting client (socket fd = %i)",
3536 client
->communication
.active
= false;
3537 status
= CLIENT_TRANSMISSION_STATUS_FAIL
;
3541 * No error and flushed the queue completely.
3543 * The payload buffer size is used later to
3544 * check if there is notifications queued. So albeit that the
3545 * direct caller knows that the transmission is complete, we
3546 * need to set the buffer size to zero.
3548 ret
= lttng_dynamic_buffer_set_size(
3549 &client
->communication
.outbound
.payload
.buffer
, 0);
3556 /* No fds to send, transmission is complete. */
3557 if (fds_to_send_count
== 0) {
3558 status
= CLIENT_TRANSMISSION_STATUS_COMPLETE
;
3562 ret
= lttcomm_send_payload_view_fds_unix_sock_non_block(
3563 client
->socket
, &pv
);
3565 /* Generic error, disable the client's communication. */
3566 ERR("[notification-thread] Failed to flush outgoing fds queue, disconnecting client (socket fd = %i)",
3568 client
->communication
.active
= false;
3569 status
= CLIENT_TRANSMISSION_STATUS_FAIL
;
3571 } else if (ret
== 0) {
3572 /* Nothing could be sent. */
3573 status
= CLIENT_TRANSMISSION_STATUS_QUEUED
;
3575 /* Fd passing is an all or nothing kind of thing. */
3576 status
= CLIENT_TRANSMISSION_STATUS_COMPLETE
;
3578 * The payload _fd_array count is used later to
3579 * check if there is notifications queued. So although the
3580 * direct caller knows that the transmission is complete, we
3581 * need to clear the _fd_array for the queuing check.
3583 lttng_dynamic_pointer_array_clear(
3584 &client
->communication
.outbound
.payload
3589 if (status
== CLIENT_TRANSMISSION_STATUS_COMPLETE
) {
3590 client
->communication
.outbound
.queued_command_reply
= false;
3591 client
->communication
.outbound
.dropped_notification
= false;
3592 lttng_payload_clear(&client
->communication
.outbound
.payload
);
3597 return CLIENT_TRANSMISSION_STATUS_ERROR
;
3601 bool client_has_outbound_data_left(
3602 const struct notification_client
*client
)
3604 const struct lttng_payload_view pv
= lttng_payload_view_from_payload(
3605 &client
->communication
.outbound
.payload
, 0, -1);
3606 const bool has_data
= pv
.buffer
.size
!= 0;
3607 const bool has_fds
= lttng_payload_view_get_fd_handle_count(&pv
);
3609 return has_data
|| has_fds
;
3612 /* Client lock must _not_ be held by the caller. */
3614 int client_send_command_reply(struct notification_client
*client
,
3615 struct notification_thread_state
*state
,
3616 enum lttng_notification_channel_status status
)
3619 struct lttng_notification_channel_command_reply reply
= {
3620 .status
= (int8_t) status
,
3622 struct lttng_notification_channel_message msg
= {
3623 .type
= (int8_t) LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_COMMAND_REPLY
,
3624 .size
= sizeof(reply
),
3626 char buffer
[sizeof(msg
) + sizeof(reply
)];
3627 enum client_transmission_status transmission_status
;
3629 memcpy(buffer
, &msg
, sizeof(msg
));
3630 memcpy(buffer
+ sizeof(msg
), &reply
, sizeof(reply
));
3631 DBG("[notification-thread] Send command reply (%i)", (int) status
);
3633 pthread_mutex_lock(&client
->lock
);
3634 if (client
->communication
.outbound
.queued_command_reply
) {
3635 /* Protocol error. */
3639 /* Enqueue buffer to outgoing queue and flush it. */
3640 ret
= lttng_dynamic_buffer_append(
3641 &client
->communication
.outbound
.payload
.buffer
,
3642 buffer
, sizeof(buffer
));
3647 transmission_status
= client_flush_outgoing_queue(client
);
3649 if (client_has_outbound_data_left(client
)) {
3650 /* Queue could not be emptied. */
3651 client
->communication
.outbound
.queued_command_reply
= true;
3654 pthread_mutex_unlock(&client
->lock
);
3655 ret
= client_handle_transmission_status(
3656 client
, transmission_status
, state
);
3663 pthread_mutex_unlock(&client
->lock
);
3669 int client_handle_message_unknown(struct notification_client
*client
,
3670 struct notification_thread_state
*state
)
3674 * Receiving message header. The function will be called again
3675 * once the rest of the message as been received and can be
3678 const struct lttng_notification_channel_message
*msg
;
3680 assert(sizeof(*msg
) == client
->communication
.inbound
.payload
.buffer
.size
);
3681 msg
= (const struct lttng_notification_channel_message
*)
3682 client
->communication
.inbound
.payload
.buffer
.data
;
3684 if (msg
->size
== 0 ||
3685 msg
->size
> DEFAULT_MAX_NOTIFICATION_CLIENT_MESSAGE_PAYLOAD_SIZE
) {
3686 ERR("[notification-thread] Invalid notification channel message: length = %u",
3692 switch (msg
->type
) {
3693 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_SUBSCRIBE
:
3694 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_UNSUBSCRIBE
:
3695 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_HANDSHAKE
:
3699 ERR("[notification-thread] Invalid notification channel message: unexpected message type");
3703 client
->communication
.inbound
.bytes_to_receive
= msg
->size
;
3704 client
->communication
.inbound
.fds_to_receive
= msg
->fds
;
3705 client
->communication
.inbound
.msg_type
=
3706 (enum lttng_notification_channel_message_type
) msg
->type
;
3707 ret
= lttng_dynamic_buffer_set_size(
3708 &client
->communication
.inbound
.payload
.buffer
, msg
->size
);
3710 /* msg is not valid anymore due to lttng_dynamic_buffer_set_size. */
3717 int client_handle_message_handshake(struct notification_client
*client
,
3718 struct notification_thread_state
*state
)
3721 struct lttng_notification_channel_command_handshake
*handshake_client
;
3722 const struct lttng_notification_channel_command_handshake handshake_reply
= {
3723 .major
= LTTNG_NOTIFICATION_CHANNEL_VERSION_MAJOR
,
3724 .minor
= LTTNG_NOTIFICATION_CHANNEL_VERSION_MINOR
,
3726 const struct lttng_notification_channel_message msg_header
= {
3727 .type
= LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_HANDSHAKE
,
3728 .size
= sizeof(handshake_reply
),
3730 enum lttng_notification_channel_status status
=
3731 LTTNG_NOTIFICATION_CHANNEL_STATUS_OK
;
3732 char send_buffer
[sizeof(msg_header
) + sizeof(handshake_reply
)];
3734 memcpy(send_buffer
, &msg_header
, sizeof(msg_header
));
3735 memcpy(send_buffer
+ sizeof(msg_header
), &handshake_reply
,
3736 sizeof(handshake_reply
));
3739 (struct lttng_notification_channel_command_handshake
*)
3740 client
->communication
.inbound
.payload
.buffer
3742 client
->major
= handshake_client
->major
;
3743 client
->minor
= handshake_client
->minor
;
3744 if (!client
->communication
.inbound
.creds_received
) {
3745 ERR("[notification-thread] No credentials received from client");
3750 client
->uid
= LTTNG_SOCK_GET_UID_CRED(
3751 &client
->communication
.inbound
.creds
);
3752 client
->gid
= LTTNG_SOCK_GET_GID_CRED(
3753 &client
->communication
.inbound
.creds
);
3754 DBG("[notification-thread] Received handshake from client (uid = %u, gid = %u) with version %i.%i",
3755 client
->uid
, client
->gid
, (int) client
->major
,
3756 (int) client
->minor
);
3758 if (handshake_client
->major
!=
3759 LTTNG_NOTIFICATION_CHANNEL_VERSION_MAJOR
) {
3760 status
= LTTNG_NOTIFICATION_CHANNEL_STATUS_UNSUPPORTED_VERSION
;
3763 pthread_mutex_lock(&client
->lock
);
3764 /* Outgoing queue will be flushed when the command reply is sent. */
3765 ret
= lttng_dynamic_buffer_append(
3766 &client
->communication
.outbound
.payload
.buffer
, send_buffer
,
3767 sizeof(send_buffer
));
3769 ERR("[notification-thread] Failed to send protocol version to notification channel client");
3773 client
->validated
= true;
3774 client
->communication
.active
= true;
3775 pthread_mutex_unlock(&client
->lock
);
3777 /* Set reception state to receive the next message header. */
3778 ret
= client_reset_inbound_state(client
);
3780 ERR("[notification-thread] Failed to reset client communication's inbound state");
3784 /* Flushes the outgoing queue. */
3785 ret
= client_send_command_reply(client
, state
, status
);
3787 ERR("[notification-thread] Failed to send reply to notification channel client");
3793 pthread_mutex_unlock(&client
->lock
);
3799 int client_handle_message_subscription(
3800 struct notification_client
*client
,
3801 enum lttng_notification_channel_message_type msg_type
,
3802 struct notification_thread_state
*state
)
3805 struct lttng_condition
*condition
;
3806 enum lttng_notification_channel_status status
=
3807 LTTNG_NOTIFICATION_CHANNEL_STATUS_OK
;
3808 struct lttng_payload_view condition_view
=
3809 lttng_payload_view_from_payload(
3810 &client
->communication
.inbound
.payload
,
3812 size_t expected_condition_size
;
3815 * No need to lock client to sample the inbound state as the only
3816 * other thread accessing clients (action executor) only uses the
3819 expected_condition_size
= client
->communication
.inbound
.payload
.buffer
.size
;
3820 ret
= lttng_condition_create_from_payload(&condition_view
, &condition
);
3821 if (ret
!= expected_condition_size
) {
3822 ERR("[notification-thread] Malformed condition received from client");
3826 if (msg_type
== LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_SUBSCRIBE
) {
3827 ret
= notification_thread_client_subscribe(
3828 client
, condition
, state
, &status
);
3830 ret
= notification_thread_client_unsubscribe(
3831 client
, condition
, state
, &status
);
3838 /* Set reception state to receive the next message header. */
3839 ret
= client_reset_inbound_state(client
);
3841 ERR("[notification-thread] Failed to reset client communication's inbound state");
3845 ret
= client_send_command_reply(client
, state
, status
);
3847 ERR("[notification-thread] Failed to send reply to notification channel client");
3856 int client_dispatch_message(struct notification_client
*client
,
3857 struct notification_thread_state
*state
)
3861 if (client
->communication
.inbound
.msg_type
!=
3862 LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_HANDSHAKE
&&
3863 client
->communication
.inbound
.msg_type
!=
3864 LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_UNKNOWN
&&
3865 !client
->validated
) {
3866 WARN("[notification-thread] client attempted a command before handshake");
3871 switch (client
->communication
.inbound
.msg_type
) {
3872 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_UNKNOWN
:
3874 ret
= client_handle_message_unknown(client
, state
);
3877 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_HANDSHAKE
:
3879 ret
= client_handle_message_handshake(client
, state
);
3882 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_SUBSCRIBE
:
3883 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_UNSUBSCRIBE
:
3885 ret
= client_handle_message_subscription(client
,
3886 client
->communication
.inbound
.msg_type
, state
);
3896 /* Incoming data from client. */
3897 int handle_notification_thread_client_in(
3898 struct notification_thread_state
*state
, int socket
)
3901 struct notification_client
*client
;
3906 client
= get_client_from_socket(socket
, state
);
3908 /* Internal error, abort. */
3913 offset
= client
->communication
.inbound
.payload
.buffer
.size
-
3914 client
->communication
.inbound
.bytes_to_receive
;
3915 if (client
->communication
.inbound
.expect_creds
) {
3916 recv_ret
= lttcomm_recv_creds_unix_sock(socket
,
3917 client
->communication
.inbound
.payload
.buffer
.data
+ offset
,
3918 client
->communication
.inbound
.bytes_to_receive
,
3919 &client
->communication
.inbound
.creds
);
3921 client
->communication
.inbound
.expect_creds
= false;
3922 client
->communication
.inbound
.creds_received
= true;
3925 recv_ret
= lttcomm_recv_unix_sock_non_block(socket
,
3926 client
->communication
.inbound
.payload
.buffer
.data
+ offset
,
3927 client
->communication
.inbound
.bytes_to_receive
);
3929 if (recv_ret
>= 0) {
3930 client
->communication
.inbound
.bytes_to_receive
-= recv_ret
;
3932 goto error_disconnect_client
;
3935 if (client
->communication
.inbound
.bytes_to_receive
!= 0) {
3936 /* Message incomplete wait for more data. */
3941 assert(client
->communication
.inbound
.bytes_to_receive
== 0);
3944 if (client
->communication
.inbound
.fds_to_receive
!= 0) {
3945 ret
= lttcomm_recv_payload_fds_unix_sock_non_block(
3947 client
->communication
.inbound
.fds_to_receive
,
3948 &client
->communication
.inbound
.payload
);
3951 * Fds received. non blocking fds passing is all
3954 ssize_t expected_size
;
3956 expected_size
= sizeof(int) *
3957 client
->communication
.inbound
3959 assert(ret
== expected_size
);
3960 client
->communication
.inbound
.fds_to_receive
= 0;
3961 } else if (ret
== 0) {
3962 /* Received nothing. */
3966 goto error_disconnect_client
;
3970 /* At this point the message is complete.*/
3971 assert(client
->communication
.inbound
.bytes_to_receive
== 0 &&
3972 client
->communication
.inbound
.fds_to_receive
== 0);
3973 ret
= client_dispatch_message(client
, state
);
3976 * Only returns an error if this client must be
3979 goto error_disconnect_client
;
3986 error_disconnect_client
:
3987 ret
= notification_thread_client_disconnect(client
, state
);
3991 /* Client ready to receive outgoing data. */
3992 int handle_notification_thread_client_out(
3993 struct notification_thread_state
*state
, int socket
)
3996 struct notification_client
*client
;
3997 enum client_transmission_status transmission_status
;
4000 client
= get_client_from_socket(socket
, state
);
4002 /* Internal error, abort. */
4007 pthread_mutex_lock(&client
->lock
);
4008 transmission_status
= client_flush_outgoing_queue(client
);
4009 pthread_mutex_unlock(&client
->lock
);
4011 ret
= client_handle_transmission_status(
4012 client
, transmission_status
, state
);
4022 bool evaluate_buffer_usage_condition(const struct lttng_condition
*condition
,
4023 const struct channel_state_sample
*sample
,
4024 uint64_t buffer_capacity
)
4026 bool result
= false;
4028 enum lttng_condition_type condition_type
;
4029 const struct lttng_condition_buffer_usage
*use_condition
= container_of(
4030 condition
, struct lttng_condition_buffer_usage
,
4033 if (use_condition
->threshold_bytes
.set
) {
4034 threshold
= use_condition
->threshold_bytes
.value
;
4037 * Threshold was expressed as a ratio.
4039 * TODO the threshold (in bytes) of conditions expressed
4040 * as a ratio of total buffer size could be cached to
4041 * forego this double-multiplication or it could be performed
4042 * as fixed-point math.
4044 * Note that caching should accommodates the case where the
4045 * condition applies to multiple channels (i.e. don't assume
4046 * that all channels matching my_chann* have the same size...)
4048 threshold
= (uint64_t) (use_condition
->threshold_ratio
.value
*
4049 (double) buffer_capacity
);
4052 condition_type
= lttng_condition_get_type(condition
);
4053 if (condition_type
== LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW
) {
4054 DBG("[notification-thread] Low buffer usage condition being evaluated: threshold = %" PRIu64
", highest usage = %" PRIu64
,
4055 threshold
, sample
->highest_usage
);
4058 * The low condition should only be triggered once _all_ of the
4059 * streams in a channel have gone below the "low" threshold.
4061 if (sample
->highest_usage
<= threshold
) {
4065 DBG("[notification-thread] High buffer usage condition being evaluated: threshold = %" PRIu64
", highest usage = %" PRIu64
,
4066 threshold
, sample
->highest_usage
);
4069 * For high buffer usage scenarios, we want to trigger whenever
4070 * _any_ of the streams has reached the "high" threshold.
4072 if (sample
->highest_usage
>= threshold
) {
4081 bool evaluate_session_consumed_size_condition(
4082 const struct lttng_condition
*condition
,
4083 uint64_t session_consumed_size
)
4086 const struct lttng_condition_session_consumed_size
*size_condition
=
4087 container_of(condition
,
4088 struct lttng_condition_session_consumed_size
,
4091 threshold
= size_condition
->consumed_threshold_bytes
.value
;
4092 DBG("[notification-thread] Session consumed size condition being evaluated: threshold = %" PRIu64
", current size = %" PRIu64
,
4093 threshold
, session_consumed_size
);
4094 return session_consumed_size
>= threshold
;
4098 int evaluate_buffer_condition(const struct lttng_condition
*condition
,
4099 struct lttng_evaluation
**evaluation
,
4100 const struct notification_thread_state
*state
,
4101 const struct channel_state_sample
*previous_sample
,
4102 const struct channel_state_sample
*latest_sample
,
4103 uint64_t previous_session_consumed_total
,
4104 uint64_t latest_session_consumed_total
,
4105 struct channel_info
*channel_info
)
4108 enum lttng_condition_type condition_type
;
4109 const bool previous_sample_available
= !!previous_sample
;
4110 bool previous_sample_result
= false;
4111 bool latest_sample_result
;
4113 condition_type
= lttng_condition_get_type(condition
);
4115 switch (condition_type
) {
4116 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW
:
4117 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH
:
4118 if (caa_likely(previous_sample_available
)) {
4119 previous_sample_result
=
4120 evaluate_buffer_usage_condition(condition
,
4121 previous_sample
, channel_info
->capacity
);
4123 latest_sample_result
= evaluate_buffer_usage_condition(
4124 condition
, latest_sample
,
4125 channel_info
->capacity
);
4127 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE
:
4128 if (caa_likely(previous_sample_available
)) {
4129 previous_sample_result
=
4130 evaluate_session_consumed_size_condition(
4132 previous_session_consumed_total
);
4134 latest_sample_result
=
4135 evaluate_session_consumed_size_condition(
4137 latest_session_consumed_total
);
4140 /* Unknown condition type; internal error. */
4144 if (!latest_sample_result
||
4145 (previous_sample_result
== latest_sample_result
)) {
4147 * Only trigger on a condition evaluation transition.
4149 * NOTE: This edge-triggered logic may not be appropriate for
4150 * future condition types.
4155 if (!evaluation
|| !latest_sample_result
) {
4159 switch (condition_type
) {
4160 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW
:
4161 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH
:
4162 *evaluation
= lttng_evaluation_buffer_usage_create(
4164 latest_sample
->highest_usage
,
4165 channel_info
->capacity
);
4167 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE
:
4168 *evaluation
= lttng_evaluation_session_consumed_size_create(
4169 latest_session_consumed_total
);
4184 int client_notification_overflow(struct notification_client
*client
)
4187 const struct lttng_notification_channel_message msg
= {
4188 .type
= (int8_t) LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_NOTIFICATION_DROPPED
,
4191 ASSERT_LOCKED(client
->lock
);
4193 DBG("Dropping notification addressed to client (socket fd = %i)",
4195 if (client
->communication
.outbound
.dropped_notification
) {
4197 * The client already has a "notification dropped" message
4198 * in its outgoing queue. Nothing to do since all
4199 * of those messages are coalesced.
4204 client
->communication
.outbound
.dropped_notification
= true;
4205 ret
= lttng_dynamic_buffer_append(
4206 &client
->communication
.outbound
.payload
.buffer
, &msg
,
4209 PERROR("Failed to enqueue \"dropped notification\" message in client's (socket fd = %i) outgoing queue",
4216 static int client_handle_transmission_status_wrapper(
4217 struct notification_client
*client
,
4218 enum client_transmission_status status
,
4221 return client_handle_transmission_status(client
, status
,
4222 (struct notification_thread_state
*) user_data
);
4226 int send_evaluation_to_clients(const struct lttng_trigger
*trigger
,
4227 const struct lttng_evaluation
*evaluation
,
4228 struct notification_client_list
* client_list
,
4229 struct notification_thread_state
*state
,
4230 uid_t object_uid
, gid_t object_gid
)
4232 const struct lttng_credentials creds
= {
4233 .uid
= LTTNG_OPTIONAL_INIT_VALUE(object_uid
),
4234 .gid
= LTTNG_OPTIONAL_INIT_VALUE(object_gid
),
4237 return notification_client_list_send_evaluation(client_list
,
4238 lttng_trigger_get_const_condition(trigger
), evaluation
,
4239 lttng_trigger_get_credentials(trigger
),
4241 client_handle_transmission_status_wrapper
, state
);
4245 * Permission checks relative to notification channel clients are performed
4246 * here. Notice how object, client, and trigger credentials are involved in
4249 * The `object` credentials are the credentials associated with the "subject"
4250 * of a condition. For instance, a `rotation completed` condition applies
4251 * to a session. When that condition is met, it will produce an evaluation
4252 * against a session. Hence, in this case, the `object` credentials are the
4253 * credentials of the "subject" session.
4255 * The `trigger` credentials are the credentials of the user that registered the
4258 * The `client` credentials are the credentials of the user that created a given
4259 * notification channel.
4261 * In terms of visibility, it is expected that non-privilieged users can only
4262 * register triggers against "their" objects (their own sessions and
4263 * applications they are allowed to interact with). They can then open a
4264 * notification channel and subscribe to notifications associated with those
4267 * As for privilieged users, they can register triggers against the objects of
4268 * other users. They can then subscribe to the notifications associated to their
4269 * triggers. Privilieged users _can't_ subscribe to the notifications of
4270 * triggers owned by other users; they must create their own triggers.
4272 * This is more a concern of usability than security. It would be difficult for
4273 * a root user reliably subscribe to a specific set of conditions without
4274 * interference from external users (those could, for instance, unregister
4278 int notification_client_list_send_evaluation(
4279 struct notification_client_list
*client_list
,
4280 const struct lttng_condition
*condition
,
4281 const struct lttng_evaluation
*evaluation
,
4282 const struct lttng_credentials
*trigger_creds
,
4283 const struct lttng_credentials
*source_object_creds
,
4284 report_client_transmission_result_cb client_report
,
4288 struct lttng_payload msg_payload
;
4289 struct notification_client_list_element
*client_list_element
, *tmp
;
4290 const struct lttng_notification notification
= {
4291 .condition
= (struct lttng_condition
*) condition
,
4292 .evaluation
= (struct lttng_evaluation
*) evaluation
,
4294 struct lttng_notification_channel_message msg_header
= {
4295 .type
= (int8_t) LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_NOTIFICATION
,
4298 lttng_payload_init(&msg_payload
);
4300 ret
= lttng_dynamic_buffer_append(&msg_payload
.buffer
, &msg_header
,
4301 sizeof(msg_header
));
4306 ret
= lttng_notification_serialize(¬ification
, &msg_payload
);
4308 ERR("[notification-thread] Failed to serialize notification");
4313 /* Update payload size. */
4314 ((struct lttng_notification_channel_message
*) msg_payload
.buffer
.data
)
4315 ->size
= (uint32_t)(
4316 msg_payload
.buffer
.size
- sizeof(msg_header
));
4318 /* Update the payload number of fds. */
4320 const struct lttng_payload_view pv
= lttng_payload_view_from_payload(
4321 &msg_payload
, 0, -1);
4323 ((struct lttng_notification_channel_message
*)
4324 msg_payload
.buffer
.data
)->fds
= (uint32_t)
4325 lttng_payload_view_get_fd_handle_count(&pv
);
4328 pthread_mutex_lock(&client_list
->lock
);
4329 cds_list_for_each_entry_safe(client_list_element
, tmp
,
4330 &client_list
->list
, node
) {
4331 enum client_transmission_status transmission_status
;
4332 struct notification_client
*client
=
4333 client_list_element
->client
;
4336 pthread_mutex_lock(&client
->lock
);
4337 if (!client
->communication
.active
) {
4339 * Skip inactive client (protocol error or
4342 DBG("Skipping client at it is marked as inactive");
4346 if (source_object_creds
) {
4347 if (client
->uid
!= lttng_credentials_get_uid(source_object_creds
) &&
4348 client
->gid
!= lttng_credentials_get_gid(source_object_creds
) &&
4351 * Client is not allowed to monitor this
4354 DBG("[notification-thread] Skipping client at it does not have the object permission to receive notification for this trigger");
4359 if (client
->uid
!= lttng_credentials_get_uid(trigger_creds
) && client
->gid
!= lttng_credentials_get_gid(trigger_creds
)) {
4360 DBG("[notification-thread] Skipping client at it does not have the permission to receive notification for this trigger");
4364 DBG("[notification-thread] Sending notification to client (fd = %i, %zu bytes)",
4365 client
->socket
, msg_payload
.buffer
.size
);
4367 if (client_has_outbound_data_left(client
)) {
4369 * Outgoing data is already buffered for this client;
4370 * drop the notification and enqueue a "dropped
4371 * notification" message if this is the first dropped
4372 * notification since the socket spilled-over to the
4375 ret
= client_notification_overflow(client
);
4382 ret
= lttng_payload_copy(&msg_payload
, &client
->communication
.outbound
.payload
);
4388 transmission_status
= client_flush_outgoing_queue(client
);
4389 pthread_mutex_unlock(&client
->lock
);
4390 ret
= client_report(client
, transmission_status
, user_data
);
4393 goto end_unlock_list
;
4399 pthread_mutex_unlock(&client
->lock
);
4402 goto end_unlock_list
;
4408 pthread_mutex_unlock(&client_list
->lock
);
4410 lttng_payload_reset(&msg_payload
);
4415 struct lttng_event_notifier_notification
*recv_one_event_notifier_notification(
4416 int notification_pipe_read_fd
, enum lttng_domain_type domain
)
4420 struct lttng_event_notifier_notification
*notification
= NULL
;
4421 char *capture_buffer
= NULL
;
4422 size_t capture_buffer_size
;
4423 void *reception_buffer
;
4424 size_t reception_size
;
4426 struct lttng_ust_abi_event_notifier_notification ust_notification
;
4427 struct lttng_kernel_event_notifier_notification kernel_notification
;
4429 /* Init lttng_event_notifier_notification */
4431 case LTTNG_DOMAIN_UST
:
4432 reception_buffer
= (void *) &ust_notification
;
4433 reception_size
= sizeof(ust_notification
);
4435 case LTTNG_DOMAIN_KERNEL
:
4436 reception_buffer
= (void *) &kernel_notification
;
4437 reception_size
= sizeof(kernel_notification
);
4444 * The monitoring pipe only holds messages smaller than PIPE_BUF,
4445 * ensuring that read/write of tracer notifications are atomic.
4447 ret
= lttng_read(notification_pipe_read_fd
, reception_buffer
,
4449 if (ret
!= reception_size
) {
4450 PERROR("Failed to read from event source notification pipe: fd = %d, size to read = %zu, ret = %d",
4451 notification_pipe_read_fd
, reception_size
, ret
);
4457 case LTTNG_DOMAIN_UST
:
4458 token
= ust_notification
.token
;
4459 capture_buffer_size
= ust_notification
.capture_buf_size
;
4461 case LTTNG_DOMAIN_KERNEL
:
4462 token
= kernel_notification
.token
;
4463 capture_buffer_size
= kernel_notification
.capture_buf_size
;
4469 if (capture_buffer_size
== 0) {
4470 capture_buffer
= NULL
;
4474 if (capture_buffer_size
> MAX_CAPTURE_SIZE
) {
4475 ERR("[notification-thread] Event notifier has a capture payload size which exceeds the maximum allowed size: capture_payload_size = %zu bytes, max allowed size = %d bytes",
4476 capture_buffer_size
, MAX_CAPTURE_SIZE
);
4480 capture_buffer
= zmalloc(capture_buffer_size
);
4481 if (!capture_buffer
) {
4482 ERR("[notification-thread] Failed to allocate capture buffer");
4486 /* Fetch additional payload (capture). */
4487 ret
= lttng_read(notification_pipe_read_fd
, capture_buffer
, capture_buffer_size
);
4488 if (ret
!= capture_buffer_size
) {
4489 ERR("[notification-thread] Failed to read from event source pipe (fd = %i)",
4490 notification_pipe_read_fd
);
4495 notification
= lttng_event_notifier_notification_create(token
, domain
,
4496 capture_buffer
, capture_buffer_size
);
4497 if (notification
== NULL
) {
4502 * Ownership transfered to the lttng_event_notifier_notification object.
4504 capture_buffer
= NULL
;
4507 free(capture_buffer
);
4508 return notification
;
4512 int dispatch_one_event_notifier_notification(struct notification_thread_state
*state
,
4513 struct lttng_event_notifier_notification
*notification
)
4515 struct cds_lfht_node
*node
;
4516 struct cds_lfht_iter iter
;
4517 struct notification_trigger_tokens_ht_element
*element
;
4518 enum lttng_trigger_status trigger_status
;
4519 struct lttng_evaluation
*evaluation
= NULL
;
4520 enum action_executor_status executor_status
;
4521 struct notification_client_list
*client_list
= NULL
;
4522 const char *trigger_name
;
4524 unsigned int capture_count
= 0;
4526 /* Find triggers associated with this token. */
4528 cds_lfht_lookup(state
->trigger_tokens_ht
,
4529 hash_key_u64(¬ification
->tracer_token
, lttng_ht_seed
),
4530 match_trigger_token
, ¬ification
->tracer_token
, &iter
);
4531 node
= cds_lfht_iter_get_node(&iter
);
4532 if (caa_unlikely(!node
)) {
4534 * This is not an error, slow consumption of the tracer
4535 * notifications can lead to situations where a trigger is
4536 * removed but we still get tracer notifications matching a
4537 * trigger that no longer exists.
4543 element
= caa_container_of(node
,
4544 struct notification_trigger_tokens_ht_element
,
4547 if (!lttng_trigger_should_fire(element
->trigger
)) {
4552 lttng_trigger_fire(element
->trigger
);
4554 trigger_status
= lttng_trigger_get_name(element
->trigger
, &trigger_name
);
4555 assert(trigger_status
== LTTNG_TRIGGER_STATUS_OK
);
4557 if (lttng_condition_on_event_get_capture_descriptor_count(
4558 lttng_trigger_get_const_condition(element
->trigger
),
4559 &capture_count
) != LTTNG_CONDITION_STATUS_OK
) {
4560 ERR("Failed to get capture count");
4565 if (!notification
->capture_buffer
&& capture_count
!= 0) {
4566 ERR("Expected capture but capture buffer is null");
4571 evaluation
= lttng_evaluation_on_event_create(
4572 container_of(lttng_trigger_get_const_condition(
4574 struct lttng_condition_on_event
,
4577 notification
->capture_buffer
,
4578 notification
->capture_buf_size
, false);
4580 if (evaluation
== NULL
) {
4581 ERR("[notification-thread] Failed to create event rule hit evaluation while creating and enqueuing action executor job");
4585 client_list
= get_client_list_from_condition(state
,
4586 lttng_trigger_get_const_condition(element
->trigger
));
4587 executor_status
= action_executor_enqueue(state
->executor
,
4588 element
->trigger
, evaluation
, NULL
, client_list
);
4589 switch (executor_status
) {
4590 case ACTION_EXECUTOR_STATUS_OK
:
4593 case ACTION_EXECUTOR_STATUS_OVERFLOW
:
4595 struct notification_client_list_element
*client_list_element
,
4599 * Not a fatal error; this is expected and simply means the
4600 * executor has too much work queued already.
4604 /* No clients subscribed to notifications for this trigger. */
4609 /* Warn clients that a notification (or more) was dropped. */
4610 pthread_mutex_lock(&client_list
->lock
);
4611 cds_list_for_each_entry_safe(client_list_element
, tmp
,
4612 &client_list
->list
, node
) {
4613 enum client_transmission_status transmission_status
;
4614 struct notification_client
*client
=
4615 client_list_element
->client
;
4617 pthread_mutex_lock(&client
->lock
);
4618 ret
= client_notification_overflow(client
);
4624 transmission_status
=
4625 client_flush_outgoing_queue(client
);
4626 ret
= client_handle_transmission_status(
4627 client
, transmission_status
, state
);
4633 pthread_mutex_unlock(&client
->lock
);
4639 pthread_mutex_unlock(&client_list
->lock
);
4642 case ACTION_EXECUTOR_STATUS_INVALID
:
4643 case ACTION_EXECUTOR_STATUS_ERROR
:
4644 /* Fatal error, shut down everything. */
4645 ERR("Fatal error encoutered while enqueuing action to the action executor");
4649 /* Unhandled error. */
4654 notification_client_list_put(client_list
);
4661 int handle_one_event_notifier_notification(
4662 struct notification_thread_state
*state
,
4663 int pipe
, enum lttng_domain_type domain
)
4666 struct lttng_event_notifier_notification
*notification
= NULL
;
4668 notification
= recv_one_event_notifier_notification(pipe
, domain
);
4669 if (notification
== NULL
) {
4670 /* Reception failed, don't consider it fatal. */
4671 ERR("[notification-thread] Error receiving an event notifier notification from tracer: fd = %i, domain = %s",
4672 pipe
, lttng_domain_type_str(domain
));
4676 ret
= dispatch_one_event_notifier_notification(state
, notification
);
4678 ERR("[notification-thread] Error dispatching an event notifier notification from tracer: fd = %i, domain = %s",
4679 pipe
, lttng_domain_type_str(domain
));
4684 lttng_event_notifier_notification_destroy(notification
);
4688 int handle_notification_thread_event_notification(struct notification_thread_state
*state
,
4689 int pipe
, enum lttng_domain_type domain
)
4691 return handle_one_event_notifier_notification(state
, pipe
, domain
);
4694 int handle_notification_thread_channel_sample(
4695 struct notification_thread_state
*state
, int pipe
,
4696 enum lttng_domain_type domain
)
4699 struct lttcomm_consumer_channel_monitor_msg sample_msg
;
4700 struct channel_info
*channel_info
;
4701 struct cds_lfht_node
*node
;
4702 struct cds_lfht_iter iter
;
4703 struct lttng_channel_trigger_list
*trigger_list
;
4704 struct lttng_trigger_list_element
*trigger_list_element
;
4705 bool previous_sample_available
= false;
4706 struct channel_state_sample previous_sample
, latest_sample
;
4707 uint64_t previous_session_consumed_total
, latest_session_consumed_total
;
4708 struct lttng_credentials channel_creds
;
4711 * The monitoring pipe only holds messages smaller than PIPE_BUF,
4712 * ensuring that read/write of sampling messages are atomic.
4714 ret
= lttng_read(pipe
, &sample_msg
, sizeof(sample_msg
));
4715 if (ret
!= sizeof(sample_msg
)) {
4716 ERR("[notification-thread] Failed to read from monitoring pipe (fd = %i)",
4723 latest_sample
.key
.key
= sample_msg
.key
;
4724 latest_sample
.key
.domain
= domain
;
4725 latest_sample
.highest_usage
= sample_msg
.highest
;
4726 latest_sample
.lowest_usage
= sample_msg
.lowest
;
4727 latest_sample
.channel_total_consumed
= sample_msg
.total_consumed
;
4731 /* Retrieve the channel's informations */
4732 cds_lfht_lookup(state
->channels_ht
,
4733 hash_channel_key(&latest_sample
.key
),
4737 node
= cds_lfht_iter_get_node(&iter
);
4738 if (caa_unlikely(!node
)) {
4740 * Not an error since the consumer can push a sample to the pipe
4741 * and the rest of the session daemon could notify us of the
4742 * channel's destruction before we get a chance to process that
4745 DBG("[notification-thread] Received a sample for an unknown channel from consumerd, key = %" PRIu64
" in %s domain",
4746 latest_sample
.key
.key
,
4747 lttng_domain_type_str(domain
));
4750 channel_info
= caa_container_of(node
, struct channel_info
,
4752 DBG("[notification-thread] Handling channel sample for channel %s (key = %" PRIu64
") in session %s (highest usage = %" PRIu64
", lowest usage = %" PRIu64
", total consumed = %" PRIu64
")",
4754 latest_sample
.key
.key
,
4755 channel_info
->session_info
->name
,
4756 latest_sample
.highest_usage
,
4757 latest_sample
.lowest_usage
,
4758 latest_sample
.channel_total_consumed
);
4760 previous_session_consumed_total
=
4761 channel_info
->session_info
->consumed_data_size
;
4763 /* Retrieve the channel's last sample, if it exists, and update it. */
4764 cds_lfht_lookup(state
->channel_state_ht
,
4765 hash_channel_key(&latest_sample
.key
),
4766 match_channel_state_sample
,
4769 node
= cds_lfht_iter_get_node(&iter
);
4770 if (caa_likely(node
)) {
4771 struct channel_state_sample
*stored_sample
;
4773 /* Update the sample stored. */
4774 stored_sample
= caa_container_of(node
,
4775 struct channel_state_sample
,
4776 channel_state_ht_node
);
4778 memcpy(&previous_sample
, stored_sample
,
4779 sizeof(previous_sample
));
4780 stored_sample
->highest_usage
= latest_sample
.highest_usage
;
4781 stored_sample
->lowest_usage
= latest_sample
.lowest_usage
;
4782 stored_sample
->channel_total_consumed
= latest_sample
.channel_total_consumed
;
4783 previous_sample_available
= true;
4785 latest_session_consumed_total
=
4786 previous_session_consumed_total
+
4787 (latest_sample
.channel_total_consumed
- previous_sample
.channel_total_consumed
);
4790 * This is the channel's first sample, allocate space for and
4791 * store the new sample.
4793 struct channel_state_sample
*stored_sample
;
4795 stored_sample
= zmalloc(sizeof(*stored_sample
));
4796 if (!stored_sample
) {
4801 memcpy(stored_sample
, &latest_sample
, sizeof(*stored_sample
));
4802 cds_lfht_node_init(&stored_sample
->channel_state_ht_node
);
4803 cds_lfht_add(state
->channel_state_ht
,
4804 hash_channel_key(&stored_sample
->key
),
4805 &stored_sample
->channel_state_ht_node
);
4807 latest_session_consumed_total
=
4808 previous_session_consumed_total
+
4809 latest_sample
.channel_total_consumed
;
4812 channel_info
->session_info
->consumed_data_size
=
4813 latest_session_consumed_total
;
4815 /* Find triggers associated with this channel. */
4816 cds_lfht_lookup(state
->channel_triggers_ht
,
4817 hash_channel_key(&latest_sample
.key
),
4818 match_channel_trigger_list
,
4821 node
= cds_lfht_iter_get_node(&iter
);
4822 if (caa_likely(!node
)) {
4826 channel_creds
= (typeof(channel_creds
)) {
4827 .uid
= LTTNG_OPTIONAL_INIT_VALUE(channel_info
->session_info
->uid
),
4828 .gid
= LTTNG_OPTIONAL_INIT_VALUE(channel_info
->session_info
->gid
),
4831 trigger_list
= caa_container_of(node
, struct lttng_channel_trigger_list
,
4832 channel_triggers_ht_node
);
4833 cds_list_for_each_entry(trigger_list_element
, &trigger_list
->list
,
4835 const struct lttng_condition
*condition
;
4836 struct lttng_trigger
*trigger
;
4837 struct notification_client_list
*client_list
= NULL
;
4838 struct lttng_evaluation
*evaluation
= NULL
;
4839 enum action_executor_status executor_status
;
4842 trigger
= trigger_list_element
->trigger
;
4843 condition
= lttng_trigger_get_const_condition(trigger
);
4847 * Check if any client is subscribed to the result of this
4850 client_list
= get_client_list_from_condition(state
, condition
);
4852 ret
= evaluate_buffer_condition(condition
, &evaluation
, state
,
4853 previous_sample_available
? &previous_sample
: NULL
,
4855 previous_session_consumed_total
,
4856 latest_session_consumed_total
,
4858 if (caa_unlikely(ret
)) {
4862 if (caa_likely(!evaluation
)) {
4866 if (!lttng_trigger_should_fire(trigger
)) {
4870 lttng_trigger_fire(trigger
);
4873 * Ownership of `evaluation` transferred to the action executor
4874 * no matter the result.
4876 executor_status
= action_executor_enqueue(state
->executor
,
4877 trigger
, evaluation
, &channel_creds
,
4880 switch (executor_status
) {
4881 case ACTION_EXECUTOR_STATUS_OK
:
4883 case ACTION_EXECUTOR_STATUS_ERROR
:
4884 case ACTION_EXECUTOR_STATUS_INVALID
:
4886 * TODO Add trigger identification (name/id) when
4887 * it is added to the API.
4889 ERR("Fatal error occurred while enqueuing action associated with buffer-condition trigger");
4892 case ACTION_EXECUTOR_STATUS_OVERFLOW
:
4894 * TODO Add trigger identification (name/id) when
4895 * it is added to the API.
4897 * Not a fatal error.
4899 WARN("No space left when enqueuing action associated with buffer-condition trigger");
4907 notification_client_list_put(client_list
);
4908 if (caa_unlikely(ret
)) {