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/list-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/event-rule-matches-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 struct cds_list_head client_list_trigger_node
;
126 /* call_rcu delayed reclaim. */
127 struct rcu_head rcu_node
;
130 struct lttng_condition_list_element
{
131 struct lttng_condition
*condition
;
132 struct cds_list_head node
;
135 struct channel_state_sample
{
136 struct channel_key key
;
137 struct cds_lfht_node channel_state_ht_node
;
138 uint64_t highest_usage
;
139 uint64_t lowest_usage
;
140 uint64_t channel_total_consumed
;
141 /* call_rcu delayed reclaim. */
142 struct rcu_head rcu_node
;
145 static unsigned long hash_channel_key(struct channel_key
*key
);
146 static int evaluate_buffer_condition(const struct lttng_condition
*condition
,
147 struct lttng_evaluation
**evaluation
,
148 const struct notification_thread_state
*state
,
149 const struct channel_state_sample
*previous_sample
,
150 const struct channel_state_sample
*latest_sample
,
151 uint64_t previous_session_consumed_total
,
152 uint64_t latest_session_consumed_total
,
153 struct channel_info
*channel_info
);
155 int send_evaluation_to_clients(const struct lttng_trigger
*trigger
,
156 const struct lttng_evaluation
*evaluation
,
157 struct notification_client_list
*client_list
,
158 struct notification_thread_state
*state
,
159 uid_t channel_uid
, gid_t channel_gid
);
162 /* session_info API */
164 void session_info_destroy(void *_data
);
166 void session_info_get(struct session_info
*session_info
);
168 void session_info_put(struct session_info
*session_info
);
170 struct session_info
*session_info_create(const char *name
,
171 uid_t uid
, gid_t gid
,
172 struct lttng_session_trigger_list
*trigger_list
,
173 struct cds_lfht
*sessions_ht
);
175 void session_info_add_channel(struct session_info
*session_info
,
176 struct channel_info
*channel_info
);
178 void session_info_remove_channel(struct session_info
*session_info
,
179 struct channel_info
*channel_info
);
181 /* lttng_session_trigger_list API */
183 struct lttng_session_trigger_list
*lttng_session_trigger_list_create(
184 const char *session_name
,
185 struct cds_lfht
*session_triggers_ht
);
187 struct lttng_session_trigger_list
*lttng_session_trigger_list_build(
188 const struct notification_thread_state
*state
,
189 const char *session_name
);
191 void lttng_session_trigger_list_destroy(
192 struct lttng_session_trigger_list
*list
);
194 int lttng_session_trigger_list_add(struct lttng_session_trigger_list
*list
,
195 struct lttng_trigger
*trigger
);
198 int client_handle_transmission_status(
199 struct notification_client
*client
,
200 enum client_transmission_status transmission_status
,
201 struct notification_thread_state
*state
);
204 int handle_one_event_notifier_notification(
205 struct notification_thread_state
*state
,
206 int pipe
, enum lttng_domain_type domain
);
209 void free_lttng_trigger_ht_element_rcu(struct rcu_head
*node
);
212 int match_client_socket(struct cds_lfht_node
*node
, const void *key
)
214 /* This double-cast is intended to supress pointer-to-cast warning. */
215 const int socket
= (int) (intptr_t) key
;
216 const struct notification_client
*client
= caa_container_of(node
,
217 struct notification_client
, client_socket_ht_node
);
219 return client
->socket
== socket
;
223 int match_client_id(struct cds_lfht_node
*node
, const void *key
)
225 /* This double-cast is intended to supress pointer-to-cast warning. */
226 const notification_client_id id
= *((notification_client_id
*) key
);
227 const struct notification_client
*client
= caa_container_of(
228 node
, struct notification_client
, client_id_ht_node
);
230 return client
->id
== id
;
234 int match_channel_trigger_list(struct cds_lfht_node
*node
, const void *key
)
236 struct channel_key
*channel_key
= (struct channel_key
*) key
;
237 struct lttng_channel_trigger_list
*trigger_list
;
239 trigger_list
= caa_container_of(node
, struct lttng_channel_trigger_list
,
240 channel_triggers_ht_node
);
242 return !!((channel_key
->key
== trigger_list
->channel_key
.key
) &&
243 (channel_key
->domain
== trigger_list
->channel_key
.domain
));
247 int match_session_trigger_list(struct cds_lfht_node
*node
, const void *key
)
249 const char *session_name
= (const char *) key
;
250 struct lttng_session_trigger_list
*trigger_list
;
252 trigger_list
= caa_container_of(node
, struct lttng_session_trigger_list
,
253 session_triggers_ht_node
);
255 return !!(strcmp(trigger_list
->session_name
, session_name
) == 0);
259 int match_channel_state_sample(struct cds_lfht_node
*node
, const void *key
)
261 struct channel_key
*channel_key
= (struct channel_key
*) key
;
262 struct channel_state_sample
*sample
;
264 sample
= caa_container_of(node
, struct channel_state_sample
,
265 channel_state_ht_node
);
267 return !!((channel_key
->key
== sample
->key
.key
) &&
268 (channel_key
->domain
== sample
->key
.domain
));
272 int match_channel_info(struct cds_lfht_node
*node
, const void *key
)
274 struct channel_key
*channel_key
= (struct channel_key
*) key
;
275 struct channel_info
*channel_info
;
277 channel_info
= caa_container_of(node
, struct channel_info
,
280 return !!((channel_key
->key
== channel_info
->key
.key
) &&
281 (channel_key
->domain
== channel_info
->key
.domain
));
285 int match_trigger(struct cds_lfht_node
*node
, const void *key
)
287 struct lttng_trigger
*trigger_key
= (struct lttng_trigger
*) key
;
288 struct lttng_trigger_ht_element
*trigger_ht_element
;
290 trigger_ht_element
= caa_container_of(node
, struct lttng_trigger_ht_element
,
293 return !!lttng_trigger_is_equal(trigger_key
, trigger_ht_element
->trigger
);
297 int match_trigger_token(struct cds_lfht_node
*node
, const void *key
)
299 const uint64_t *_key
= key
;
300 struct notification_trigger_tokens_ht_element
*element
;
302 element
= caa_container_of(node
,
303 struct notification_trigger_tokens_ht_element
, node
);
304 return *_key
== element
->token
;
308 int match_client_list_condition(struct cds_lfht_node
*node
, const void *key
)
310 struct lttng_condition
*condition_key
= (struct lttng_condition
*) key
;
311 struct notification_client_list
*client_list
;
312 const struct lttng_condition
*condition
;
314 assert(condition_key
);
316 client_list
= caa_container_of(node
, struct notification_client_list
,
317 notification_trigger_clients_ht_node
);
318 condition
= client_list
->condition
;
320 return !!lttng_condition_is_equal(condition_key
, condition
);
324 int match_session(struct cds_lfht_node
*node
, const void *key
)
326 const char *name
= key
;
327 struct session_info
*session_info
= caa_container_of(
328 node
, struct session_info
, sessions_ht_node
);
330 return !strcmp(session_info
->name
, name
);
334 const char *notification_command_type_str(
335 enum notification_thread_command_type type
)
338 case NOTIFICATION_COMMAND_TYPE_REGISTER_TRIGGER
:
339 return "REGISTER_TRIGGER";
340 case NOTIFICATION_COMMAND_TYPE_UNREGISTER_TRIGGER
:
341 return "UNREGISTER_TRIGGER";
342 case NOTIFICATION_COMMAND_TYPE_ADD_CHANNEL
:
343 return "ADD_CHANNEL";
344 case NOTIFICATION_COMMAND_TYPE_REMOVE_CHANNEL
:
345 return "REMOVE_CHANNEL";
346 case NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING
:
347 return "SESSION_ROTATION_ONGOING";
348 case NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_COMPLETED
:
349 return "SESSION_ROTATION_COMPLETED";
350 case NOTIFICATION_COMMAND_TYPE_ADD_TRACER_EVENT_SOURCE
:
351 return "ADD_TRACER_EVENT_SOURCE";
352 case NOTIFICATION_COMMAND_TYPE_REMOVE_TRACER_EVENT_SOURCE
:
353 return "REMOVE_TRACER_EVENT_SOURCE";
354 case NOTIFICATION_COMMAND_TYPE_LIST_TRIGGERS
:
355 return "LIST_TRIGGERS";
356 case NOTIFICATION_COMMAND_TYPE_GET_TRIGGER
:
357 return "GET_TRIGGER";
358 case NOTIFICATION_COMMAND_TYPE_QUIT
:
360 case NOTIFICATION_COMMAND_TYPE_CLIENT_COMMUNICATION_UPDATE
:
361 return "CLIENT_COMMUNICATION_UPDATE";
368 * Match trigger based on name and credentials only.
369 * Name duplication is NOT allowed for the same uid.
372 int match_trigger_by_name_uid(struct cds_lfht_node
*node
,
376 const char *element_trigger_name
;
377 const char *key_name
;
378 enum lttng_trigger_status status
;
379 const struct lttng_credentials
*key_creds
;
380 const struct lttng_credentials
*node_creds
;
381 const struct lttng_trigger
*trigger_key
=
382 (const struct lttng_trigger
*) key
;
383 const struct lttng_trigger_ht_element
*trigger_ht_element
=
384 caa_container_of(node
,
385 struct lttng_trigger_ht_element
,
388 status
= lttng_trigger_get_name(trigger_ht_element
->trigger
,
389 &element_trigger_name
);
390 element_trigger_name
= status
== LTTNG_TRIGGER_STATUS_OK
?
391 element_trigger_name
: NULL
;
393 status
= lttng_trigger_get_name(trigger_key
, &key_name
);
394 key_name
= status
== LTTNG_TRIGGER_STATUS_OK
? key_name
: NULL
;
398 * Consider null names as not equal. This is to maintain backwards
399 * compatibility with pre-2.13 anonymous triggers. Multiples anonymous
400 * triggers are allowed for a given user.
402 if (!element_trigger_name
|| !key_name
) {
406 if (strcmp(element_trigger_name
, key_name
) != 0) {
410 /* Compare the owners' UIDs. */
411 key_creds
= lttng_trigger_get_credentials(trigger_key
);
412 node_creds
= lttng_trigger_get_credentials(trigger_ht_element
->trigger
);
414 match
= lttng_credentials_is_equal_uid(key_creds
, node_creds
);
421 * Hash trigger based on name and credentials only.
424 unsigned long hash_trigger_by_name_uid(const struct lttng_trigger
*trigger
)
426 unsigned long hash
= 0;
427 const struct lttng_credentials
*trigger_creds
;
428 const char *trigger_name
;
429 enum lttng_trigger_status status
;
431 status
= lttng_trigger_get_name(trigger
, &trigger_name
);
432 if (status
== LTTNG_TRIGGER_STATUS_OK
) {
433 hash
= hash_key_str(trigger_name
, lttng_ht_seed
);
436 trigger_creds
= lttng_trigger_get_credentials(trigger
);
437 hash
^= hash_key_ulong((void *) (unsigned long) LTTNG_OPTIONAL_GET(trigger_creds
->uid
),
444 unsigned long hash_channel_key(struct channel_key
*key
)
446 unsigned long key_hash
= hash_key_u64(&key
->key
, lttng_ht_seed
);
447 unsigned long domain_hash
= hash_key_ulong(
448 (void *) (unsigned long) key
->domain
, lttng_ht_seed
);
450 return key_hash
^ domain_hash
;
454 unsigned long hash_client_socket(int socket
)
456 return hash_key_ulong((void *) (unsigned long) socket
, lttng_ht_seed
);
460 unsigned long hash_client_id(notification_client_id id
)
462 return hash_key_u64(&id
, lttng_ht_seed
);
466 * Get the type of object to which a given condition applies. Bindings let
467 * the notification system evaluate a trigger's condition when a given
468 * object's state is updated.
470 * For instance, a condition bound to a channel will be evaluated everytime
471 * the channel's state is changed by a channel monitoring sample.
474 enum lttng_object_type
get_condition_binding_object(
475 const struct lttng_condition
*condition
)
477 switch (lttng_condition_get_type(condition
)) {
478 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW
:
479 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH
:
480 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE
:
481 return LTTNG_OBJECT_TYPE_CHANNEL
;
482 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
:
483 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED
:
484 return LTTNG_OBJECT_TYPE_SESSION
;
485 case LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES
:
486 return LTTNG_OBJECT_TYPE_NONE
;
488 return LTTNG_OBJECT_TYPE_UNKNOWN
;
493 void free_channel_info_rcu(struct rcu_head
*node
)
495 free(caa_container_of(node
, struct channel_info
, rcu_node
));
499 void channel_info_destroy(struct channel_info
*channel_info
)
505 if (channel_info
->session_info
) {
506 session_info_remove_channel(channel_info
->session_info
,
508 session_info_put(channel_info
->session_info
);
510 if (channel_info
->name
) {
511 free(channel_info
->name
);
513 call_rcu(&channel_info
->rcu_node
, free_channel_info_rcu
);
517 void free_session_info_rcu(struct rcu_head
*node
)
519 free(caa_container_of(node
, struct session_info
, rcu_node
));
522 /* Don't call directly, use the ref-counting mechanism. */
524 void session_info_destroy(void *_data
)
526 struct session_info
*session_info
= _data
;
529 assert(session_info
);
530 if (session_info
->channel_infos_ht
) {
531 ret
= cds_lfht_destroy(session_info
->channel_infos_ht
, NULL
);
533 ERR("Failed to destroy channel information hash table");
536 lttng_session_trigger_list_destroy(session_info
->trigger_list
);
539 cds_lfht_del(session_info
->sessions_ht
,
540 &session_info
->sessions_ht_node
);
542 free(session_info
->name
);
543 call_rcu(&session_info
->rcu_node
, free_session_info_rcu
);
547 void session_info_get(struct session_info
*session_info
)
552 lttng_ref_get(&session_info
->ref
);
556 void session_info_put(struct session_info
*session_info
)
561 lttng_ref_put(&session_info
->ref
);
565 struct session_info
*session_info_create(const char *name
, uid_t uid
, gid_t gid
,
566 struct lttng_session_trigger_list
*trigger_list
,
567 struct cds_lfht
*sessions_ht
)
569 struct session_info
*session_info
;
573 session_info
= zmalloc(sizeof(*session_info
));
577 lttng_ref_init(&session_info
->ref
, session_info_destroy
);
579 session_info
->channel_infos_ht
= cds_lfht_new(DEFAULT_HT_SIZE
,
580 1, 0, CDS_LFHT_AUTO_RESIZE
| CDS_LFHT_ACCOUNTING
, NULL
);
581 if (!session_info
->channel_infos_ht
) {
585 cds_lfht_node_init(&session_info
->sessions_ht_node
);
586 session_info
->name
= strdup(name
);
587 if (!session_info
->name
) {
590 session_info
->uid
= uid
;
591 session_info
->gid
= gid
;
592 session_info
->trigger_list
= trigger_list
;
593 session_info
->sessions_ht
= sessions_ht
;
597 session_info_put(session_info
);
602 void session_info_add_channel(struct session_info
*session_info
,
603 struct channel_info
*channel_info
)
606 cds_lfht_add(session_info
->channel_infos_ht
,
607 hash_channel_key(&channel_info
->key
),
608 &channel_info
->session_info_channels_ht_node
);
613 void session_info_remove_channel(struct session_info
*session_info
,
614 struct channel_info
*channel_info
)
617 cds_lfht_del(session_info
->channel_infos_ht
,
618 &channel_info
->session_info_channels_ht_node
);
623 struct channel_info
*channel_info_create(const char *channel_name
,
624 struct channel_key
*channel_key
, uint64_t channel_capacity
,
625 struct session_info
*session_info
)
627 struct channel_info
*channel_info
= zmalloc(sizeof(*channel_info
));
633 cds_lfht_node_init(&channel_info
->channels_ht_node
);
634 cds_lfht_node_init(&channel_info
->session_info_channels_ht_node
);
635 memcpy(&channel_info
->key
, channel_key
, sizeof(*channel_key
));
636 channel_info
->capacity
= channel_capacity
;
638 channel_info
->name
= strdup(channel_name
);
639 if (!channel_info
->name
) {
644 * Set the references between session and channel infos:
645 * - channel_info holds a strong reference to session_info
646 * - session_info holds a weak reference to channel_info
648 session_info_get(session_info
);
649 session_info_add_channel(session_info
, channel_info
);
650 channel_info
->session_info
= session_info
;
654 channel_info_destroy(channel_info
);
659 bool notification_client_list_get(struct notification_client_list
*list
)
661 return urcu_ref_get_unless_zero(&list
->ref
);
665 void free_notification_client_list_rcu(struct rcu_head
*node
)
667 free(caa_container_of(node
, struct notification_client_list
,
672 void notification_client_list_release(struct urcu_ref
*list_ref
)
674 struct notification_client_list
*list
=
675 container_of(list_ref
, typeof(*list
), ref
);
676 struct notification_client_list_element
*client_list_element
, *tmp
;
678 lttng_condition_put(list
->condition
);
680 if (list
->notification_trigger_clients_ht
) {
683 cds_lfht_del(list
->notification_trigger_clients_ht
,
684 &list
->notification_trigger_clients_ht_node
);
686 list
->notification_trigger_clients_ht
= NULL
;
688 cds_list_for_each_entry_safe(client_list_element
, tmp
,
689 &list
->clients_list
, node
) {
690 free(client_list_element
);
693 assert(cds_list_empty(&list
->triggers_list
));
695 pthread_mutex_destroy(&list
->lock
);
696 call_rcu(&list
->rcu_node
, free_notification_client_list_rcu
);
700 bool condition_applies_to_client(const struct lttng_condition
*condition
,
701 struct notification_client
*client
)
703 bool applies
= false;
704 struct lttng_condition_list_element
*condition_list_element
;
706 cds_list_for_each_entry(condition_list_element
, &client
->condition_list
,
708 applies
= lttng_condition_is_equal(
709 condition_list_element
->condition
,
720 struct notification_client_list
*notification_client_list_create(
721 struct notification_thread_state
*state
,
722 const struct lttng_condition
*condition
)
724 struct notification_client
*client
;
725 struct cds_lfht_iter iter
;
726 struct notification_client_list
*client_list
;
728 client_list
= zmalloc(sizeof(*client_list
));
730 PERROR("Failed to allocate notification client list");
734 pthread_mutex_init(&client_list
->lock
, NULL
);
736 * The trigger that owns the condition has the first reference to this
739 urcu_ref_init(&client_list
->ref
);
740 cds_lfht_node_init(&client_list
->notification_trigger_clients_ht_node
);
741 CDS_INIT_LIST_HEAD(&client_list
->clients_list
);
742 CDS_INIT_LIST_HEAD(&client_list
->triggers_list
);
745 * Create a copy of the condition so that it's independent of any
746 * trigger. The client list may outlive the trigger object (which owns
747 * the condition) that is used to create it.
749 client_list
->condition
= lttng_condition_copy(condition
);
751 /* Build a list of clients to which this new condition applies. */
752 cds_lfht_for_each_entry (state
->client_socket_ht
, &iter
, client
,
753 client_socket_ht_node
) {
754 struct notification_client_list_element
*client_list_element
;
756 if (!condition_applies_to_client(condition
, client
)) {
760 client_list_element
= zmalloc(sizeof(*client_list_element
));
761 if (!client_list_element
) {
762 goto error_put_client_list
;
765 CDS_INIT_LIST_HEAD(&client_list_element
->node
);
766 client_list_element
->client
= client
;
767 cds_list_add(&client_list_element
->node
, &client_list
->clients_list
);
770 client_list
->notification_trigger_clients_ht
=
771 state
->notification_trigger_clients_ht
;
775 * Add the client list to the global list of client list.
777 cds_lfht_add_unique(state
->notification_trigger_clients_ht
,
778 lttng_condition_hash(client_list
->condition
),
779 match_client_list_condition
,
780 client_list
->condition
,
781 &client_list
->notification_trigger_clients_ht_node
);
785 error_put_client_list
:
786 notification_client_list_put(client_list
);
793 void notification_client_list_put(struct notification_client_list
*list
)
798 return urcu_ref_put(&list
->ref
, notification_client_list_release
);
801 /* Provides a reference to the returned list. */
803 struct notification_client_list
*get_client_list_from_condition(
804 struct notification_thread_state
*state
,
805 const struct lttng_condition
*condition
)
807 struct cds_lfht_node
*node
;
808 struct cds_lfht_iter iter
;
809 struct notification_client_list
*list
= NULL
;
812 cds_lfht_lookup(state
->notification_trigger_clients_ht
,
813 lttng_condition_hash(condition
),
814 match_client_list_condition
,
817 node
= cds_lfht_iter_get_node(&iter
);
819 list
= container_of(node
, struct notification_client_list
,
820 notification_trigger_clients_ht_node
);
821 list
= notification_client_list_get(list
) ? list
: NULL
;
829 int evaluate_channel_condition_for_client(
830 const struct lttng_condition
*condition
,
831 struct notification_thread_state
*state
,
832 struct lttng_evaluation
**evaluation
,
833 uid_t
*session_uid
, gid_t
*session_gid
)
836 struct cds_lfht_iter iter
;
837 struct cds_lfht_node
*node
;
838 struct channel_info
*channel_info
= NULL
;
839 struct channel_key
*channel_key
= NULL
;
840 struct channel_state_sample
*last_sample
= NULL
;
841 struct lttng_channel_trigger_list
*channel_trigger_list
= NULL
;
845 /* Find the channel associated with the condition. */
846 cds_lfht_for_each_entry(state
->channel_triggers_ht
, &iter
,
847 channel_trigger_list
, channel_triggers_ht_node
) {
848 struct lttng_trigger_list_element
*element
;
850 cds_list_for_each_entry(element
, &channel_trigger_list
->list
, node
) {
851 const struct lttng_condition
*current_condition
=
852 lttng_trigger_get_const_condition(
855 assert(current_condition
);
856 if (!lttng_condition_is_equal(condition
,
857 current_condition
)) {
861 /* Found the trigger, save the channel key. */
862 channel_key
= &channel_trigger_list
->channel_key
;
866 /* The channel key was found stop iteration. */
872 /* No channel found; normal exit. */
873 DBG("No known channel associated with newly subscribed-to condition");
878 /* Fetch channel info for the matching channel. */
879 cds_lfht_lookup(state
->channels_ht
,
880 hash_channel_key(channel_key
),
884 node
= cds_lfht_iter_get_node(&iter
);
886 channel_info
= caa_container_of(node
, struct channel_info
,
889 /* Retrieve the channel's last sample, if it exists. */
890 cds_lfht_lookup(state
->channel_state_ht
,
891 hash_channel_key(channel_key
),
892 match_channel_state_sample
,
895 node
= cds_lfht_iter_get_node(&iter
);
897 last_sample
= caa_container_of(node
,
898 struct channel_state_sample
,
899 channel_state_ht_node
);
901 /* Nothing to evaluate, no sample was ever taken. Normal exit */
902 DBG("No channel sample associated with newly subscribed-to condition");
907 ret
= evaluate_buffer_condition(condition
, evaluation
, state
,
909 0, channel_info
->session_info
->consumed_data_size
,
912 WARN("Fatal error occurred while evaluating a newly subscribed-to condition");
916 *session_uid
= channel_info
->session_info
->uid
;
917 *session_gid
= channel_info
->session_info
->gid
;
924 const char *get_condition_session_name(const struct lttng_condition
*condition
)
926 const char *session_name
= NULL
;
927 enum lttng_condition_status status
;
929 switch (lttng_condition_get_type(condition
)) {
930 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW
:
931 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH
:
932 status
= lttng_condition_buffer_usage_get_session_name(
933 condition
, &session_name
);
935 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE
:
936 status
= lttng_condition_session_consumed_size_get_session_name(
937 condition
, &session_name
);
939 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
:
940 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED
:
941 status
= lttng_condition_session_rotation_get_session_name(
942 condition
, &session_name
);
947 if (status
!= LTTNG_CONDITION_STATUS_OK
) {
948 ERR("Failed to retrieve session rotation condition's session name");
956 int evaluate_session_condition_for_client(
957 const struct lttng_condition
*condition
,
958 struct notification_thread_state
*state
,
959 struct lttng_evaluation
**evaluation
,
960 uid_t
*session_uid
, gid_t
*session_gid
)
963 struct cds_lfht_iter iter
;
964 struct cds_lfht_node
*node
;
965 const char *session_name
;
966 struct session_info
*session_info
= NULL
;
969 session_name
= get_condition_session_name(condition
);
971 /* Find the session associated with the trigger. */
972 cds_lfht_lookup(state
->sessions_ht
,
973 hash_key_str(session_name
, lttng_ht_seed
),
977 node
= cds_lfht_iter_get_node(&iter
);
979 DBG("No known session matching name \"%s\"",
985 session_info
= caa_container_of(node
, struct session_info
,
987 session_info_get(session_info
);
990 * Evaluation is performed in-line here since only one type of
991 * session-bound condition is handled for the moment.
993 switch (lttng_condition_get_type(condition
)) {
994 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
:
995 if (!session_info
->rotation
.ongoing
) {
997 goto end_session_put
;
1000 *evaluation
= lttng_evaluation_session_rotation_ongoing_create(
1001 session_info
->rotation
.id
);
1004 ERR("Failed to create session rotation ongoing evaluation for session \"%s\"",
1005 session_info
->name
);
1007 goto end_session_put
;
1013 goto end_session_put
;
1016 *session_uid
= session_info
->uid
;
1017 *session_gid
= session_info
->gid
;
1020 session_info_put(session_info
);
1027 int evaluate_condition_for_client(const struct lttng_trigger
*trigger
,
1028 const struct lttng_condition
*condition
,
1029 struct notification_client
*client
,
1030 struct notification_thread_state
*state
)
1033 struct lttng_evaluation
*evaluation
= NULL
;
1034 struct notification_client_list client_list
= {
1035 .lock
= PTHREAD_MUTEX_INITIALIZER
,
1037 struct notification_client_list_element client_list_element
= { 0 };
1038 uid_t object_uid
= 0;
1039 gid_t object_gid
= 0;
1046 switch (get_condition_binding_object(condition
)) {
1047 case LTTNG_OBJECT_TYPE_SESSION
:
1048 ret
= evaluate_session_condition_for_client(condition
, state
,
1049 &evaluation
, &object_uid
, &object_gid
);
1051 case LTTNG_OBJECT_TYPE_CHANNEL
:
1052 ret
= evaluate_channel_condition_for_client(condition
, state
,
1053 &evaluation
, &object_uid
, &object_gid
);
1055 case LTTNG_OBJECT_TYPE_NONE
:
1056 DBG("Newly subscribed-to condition not bound to object, nothing to evaluate");
1059 case LTTNG_OBJECT_TYPE_UNKNOWN
:
1069 /* Evaluation yielded nothing. Normal exit. */
1070 DBG("Newly subscribed-to condition evaluated to false, nothing to report to client");
1076 * Create a temporary client list with the client currently
1079 cds_lfht_node_init(&client_list
.notification_trigger_clients_ht_node
);
1080 CDS_INIT_LIST_HEAD(&client_list
.clients_list
);
1082 CDS_INIT_LIST_HEAD(&client_list_element
.node
);
1083 client_list_element
.client
= client
;
1084 cds_list_add(&client_list_element
.node
, &client_list
.clients_list
);
1086 /* Send evaluation result to the newly-subscribed client. */
1087 DBG("Newly subscribed-to condition evaluated to true, notifying client");
1088 ret
= send_evaluation_to_clients(trigger
, evaluation
, &client_list
,
1089 state
, object_uid
, object_gid
);
1096 int notification_thread_client_subscribe(struct notification_client
*client
,
1097 struct lttng_condition
*condition
,
1098 struct notification_thread_state
*state
,
1099 enum lttng_notification_channel_status
*_status
)
1102 struct notification_client_list
*client_list
= NULL
;
1103 struct lttng_condition_list_element
*condition_list_element
= NULL
;
1104 struct notification_client_list_element
*client_list_element
= NULL
;
1105 struct lttng_trigger_ht_element
*trigger_ht_element
;
1106 enum lttng_notification_channel_status status
=
1107 LTTNG_NOTIFICATION_CHANNEL_STATUS_OK
;
1110 * Ensure that the client has not already subscribed to this condition
1113 cds_list_for_each_entry(condition_list_element
, &client
->condition_list
, node
) {
1114 if (lttng_condition_is_equal(condition_list_element
->condition
,
1116 status
= LTTNG_NOTIFICATION_CHANNEL_STATUS_ALREADY_SUBSCRIBED
;
1121 condition_list_element
= zmalloc(sizeof(*condition_list_element
));
1122 if (!condition_list_element
) {
1126 client_list_element
= zmalloc(sizeof(*client_list_element
));
1127 if (!client_list_element
) {
1133 * Add the newly-subscribed condition to the client's subscription list.
1135 CDS_INIT_LIST_HEAD(&condition_list_element
->node
);
1136 condition_list_element
->condition
= condition
;
1138 cds_list_add(&condition_list_element
->node
, &client
->condition_list
);
1140 client_list
= get_client_list_from_condition(
1141 state
, condition_list_element
->condition
);
1144 * No notification-emiting trigger registered with this
1145 * condition. We don't evaluate the condition right away
1146 * since this trigger is not registered yet.
1148 free(client_list_element
);
1153 * The condition to which the client just subscribed is evaluated
1154 * at this point so that conditions that are already TRUE result
1155 * in a notification being sent out.
1157 * Note the iteration on all triggers which share an identical
1158 * `condition` than the one to which the client is registering. This is
1159 * done to ensure that the client receives a distinct notification for
1160 * all triggers that have a `notify` action that have this condition.
1162 pthread_mutex_lock(&client_list
->lock
);
1163 cds_list_for_each_entry(trigger_ht_element
,
1164 &client_list
->triggers_list
, client_list_trigger_node
) {
1165 if (evaluate_condition_for_client(trigger_ht_element
->trigger
, condition_list_element
->condition
,
1167 WARN("Evaluation of a condition on client subscription failed, aborting.");
1169 free(client_list_element
);
1170 pthread_mutex_unlock(&client_list
->lock
);
1174 pthread_mutex_unlock(&client_list
->lock
);
1177 * Add the client to the list of clients interested in a given trigger
1178 * if a "notification" trigger with a corresponding condition was
1181 client_list_element
->client
= client
;
1182 CDS_INIT_LIST_HEAD(&client_list_element
->node
);
1184 pthread_mutex_lock(&client_list
->lock
);
1185 cds_list_add(&client_list_element
->node
, &client_list
->clients_list
);
1186 pthread_mutex_unlock(&client_list
->lock
);
1192 notification_client_list_put(client_list
);
1194 lttng_condition_destroy(condition
);
1197 free(condition_list_element
);
1198 free(client_list_element
);
1199 lttng_condition_destroy(condition
);
1204 int notification_thread_client_unsubscribe(
1205 struct notification_client
*client
,
1206 struct lttng_condition
*condition
,
1207 struct notification_thread_state
*state
,
1208 enum lttng_notification_channel_status
*_status
)
1210 struct notification_client_list
*client_list
;
1211 struct lttng_condition_list_element
*condition_list_element
,
1213 struct notification_client_list_element
*client_list_element
,
1215 bool condition_found
= false;
1216 enum lttng_notification_channel_status status
=
1217 LTTNG_NOTIFICATION_CHANNEL_STATUS_OK
;
1219 /* Remove the condition from the client's condition list. */
1220 cds_list_for_each_entry_safe(condition_list_element
, condition_tmp
,
1221 &client
->condition_list
, node
) {
1222 if (!lttng_condition_is_equal(condition_list_element
->condition
,
1227 cds_list_del(&condition_list_element
->node
);
1229 * The caller may be iterating on the client's conditions to
1230 * tear down a client's connection. In this case, the condition
1231 * will be destroyed at the end.
1233 if (condition
!= condition_list_element
->condition
) {
1234 lttng_condition_destroy(
1235 condition_list_element
->condition
);
1237 free(condition_list_element
);
1238 condition_found
= true;
1242 if (!condition_found
) {
1243 status
= LTTNG_NOTIFICATION_CHANNEL_STATUS_UNKNOWN_CONDITION
;
1248 * Remove the client from the list of clients interested the trigger
1249 * matching the condition.
1251 client_list
= get_client_list_from_condition(state
, condition
);
1256 pthread_mutex_lock(&client_list
->lock
);
1257 cds_list_for_each_entry_safe(client_list_element
, client_tmp
,
1258 &client_list
->clients_list
, node
) {
1259 if (client_list_element
->client
->id
!= client
->id
) {
1262 cds_list_del(&client_list_element
->node
);
1263 free(client_list_element
);
1266 pthread_mutex_unlock(&client_list
->lock
);
1267 notification_client_list_put(client_list
);
1270 lttng_condition_destroy(condition
);
1278 void free_notification_client_rcu(struct rcu_head
*node
)
1280 free(caa_container_of(node
, struct notification_client
, rcu_node
));
1284 void notification_client_destroy(struct notification_client
*client
,
1285 struct notification_thread_state
*state
)
1292 * The client object is not reachable by other threads, no need to lock
1295 if (client
->socket
>= 0) {
1296 (void) lttcomm_close_unix_sock(client
->socket
);
1297 client
->socket
= -1;
1299 client
->communication
.active
= false;
1300 lttng_payload_reset(&client
->communication
.inbound
.payload
);
1301 lttng_payload_reset(&client
->communication
.outbound
.payload
);
1302 pthread_mutex_destroy(&client
->lock
);
1303 call_rcu(&client
->rcu_node
, free_notification_client_rcu
);
1307 * Call with rcu_read_lock held (and hold for the lifetime of the returned
1311 struct notification_client
*get_client_from_socket(int socket
,
1312 struct notification_thread_state
*state
)
1314 struct cds_lfht_iter iter
;
1315 struct cds_lfht_node
*node
;
1316 struct notification_client
*client
= NULL
;
1318 cds_lfht_lookup(state
->client_socket_ht
,
1319 hash_client_socket(socket
),
1320 match_client_socket
,
1321 (void *) (unsigned long) socket
,
1323 node
= cds_lfht_iter_get_node(&iter
);
1328 client
= caa_container_of(node
, struct notification_client
,
1329 client_socket_ht_node
);
1335 * Call with rcu_read_lock held (and hold for the lifetime of the returned
1339 struct notification_client
*get_client_from_id(notification_client_id id
,
1340 struct notification_thread_state
*state
)
1342 struct cds_lfht_iter iter
;
1343 struct cds_lfht_node
*node
;
1344 struct notification_client
*client
= NULL
;
1346 cds_lfht_lookup(state
->client_id_ht
,
1351 node
= cds_lfht_iter_get_node(&iter
);
1356 client
= caa_container_of(node
, struct notification_client
,
1363 bool buffer_usage_condition_applies_to_channel(
1364 const struct lttng_condition
*condition
,
1365 const struct channel_info
*channel_info
)
1367 enum lttng_condition_status status
;
1368 enum lttng_domain_type condition_domain
;
1369 const char *condition_session_name
= NULL
;
1370 const char *condition_channel_name
= NULL
;
1372 status
= lttng_condition_buffer_usage_get_domain_type(condition
,
1374 assert(status
== LTTNG_CONDITION_STATUS_OK
);
1375 if (channel_info
->key
.domain
!= condition_domain
) {
1379 status
= lttng_condition_buffer_usage_get_session_name(
1380 condition
, &condition_session_name
);
1381 assert((status
== LTTNG_CONDITION_STATUS_OK
) && condition_session_name
);
1383 status
= lttng_condition_buffer_usage_get_channel_name(
1384 condition
, &condition_channel_name
);
1385 assert((status
== LTTNG_CONDITION_STATUS_OK
) && condition_channel_name
);
1387 if (strcmp(channel_info
->session_info
->name
, condition_session_name
)) {
1390 if (strcmp(channel_info
->name
, condition_channel_name
)) {
1400 bool session_consumed_size_condition_applies_to_channel(
1401 const struct lttng_condition
*condition
,
1402 const struct channel_info
*channel_info
)
1404 enum lttng_condition_status status
;
1405 const char *condition_session_name
= NULL
;
1407 status
= lttng_condition_session_consumed_size_get_session_name(
1408 condition
, &condition_session_name
);
1409 assert((status
== LTTNG_CONDITION_STATUS_OK
) && condition_session_name
);
1411 if (strcmp(channel_info
->session_info
->name
, condition_session_name
)) {
1421 bool trigger_applies_to_channel(const struct lttng_trigger
*trigger
,
1422 const struct channel_info
*channel_info
)
1424 const struct lttng_condition
*condition
;
1425 bool trigger_applies
;
1427 condition
= lttng_trigger_get_const_condition(trigger
);
1432 switch (lttng_condition_get_type(condition
)) {
1433 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW
:
1434 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH
:
1435 trigger_applies
= buffer_usage_condition_applies_to_channel(
1436 condition
, channel_info
);
1438 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE
:
1439 trigger_applies
= session_consumed_size_condition_applies_to_channel(
1440 condition
, channel_info
);
1446 return trigger_applies
;
1451 /* Must be called with RCU read lock held. */
1453 struct lttng_session_trigger_list
*get_session_trigger_list(
1454 struct notification_thread_state
*state
,
1455 const char *session_name
)
1457 struct lttng_session_trigger_list
*list
= NULL
;
1458 struct cds_lfht_node
*node
;
1459 struct cds_lfht_iter iter
;
1461 cds_lfht_lookup(state
->session_triggers_ht
,
1462 hash_key_str(session_name
, lttng_ht_seed
),
1463 match_session_trigger_list
,
1466 node
= cds_lfht_iter_get_node(&iter
);
1469 * Not an error, the list of triggers applying to that session
1470 * will be initialized when the session is created.
1472 DBG("No trigger list found for session \"%s\" as it is not yet known to the notification system",
1477 list
= caa_container_of(node
,
1478 struct lttng_session_trigger_list
,
1479 session_triggers_ht_node
);
1485 * Allocate an empty lttng_session_trigger_list for the session named
1488 * No ownership of 'session_name' is assumed by the session trigger list.
1489 * It is the caller's responsability to ensure the session name is alive
1490 * for as long as this list is.
1493 struct lttng_session_trigger_list
*lttng_session_trigger_list_create(
1494 const char *session_name
,
1495 struct cds_lfht
*session_triggers_ht
)
1497 struct lttng_session_trigger_list
*list
;
1499 list
= zmalloc(sizeof(*list
));
1503 list
->session_name
= session_name
;
1504 CDS_INIT_LIST_HEAD(&list
->list
);
1505 cds_lfht_node_init(&list
->session_triggers_ht_node
);
1506 list
->session_triggers_ht
= session_triggers_ht
;
1509 /* Publish the list through the session_triggers_ht. */
1510 cds_lfht_add(session_triggers_ht
,
1511 hash_key_str(session_name
, lttng_ht_seed
),
1512 &list
->session_triggers_ht_node
);
1519 void free_session_trigger_list_rcu(struct rcu_head
*node
)
1521 free(caa_container_of(node
, struct lttng_session_trigger_list
,
1526 void lttng_session_trigger_list_destroy(struct lttng_session_trigger_list
*list
)
1528 struct lttng_trigger_list_element
*trigger_list_element
, *tmp
;
1530 /* Empty the list element by element, and then free the list itself. */
1531 cds_list_for_each_entry_safe(trigger_list_element
, tmp
,
1532 &list
->list
, node
) {
1533 cds_list_del(&trigger_list_element
->node
);
1534 free(trigger_list_element
);
1537 /* Unpublish the list from the session_triggers_ht. */
1538 cds_lfht_del(list
->session_triggers_ht
,
1539 &list
->session_triggers_ht_node
);
1541 call_rcu(&list
->rcu_node
, free_session_trigger_list_rcu
);
1545 int lttng_session_trigger_list_add(struct lttng_session_trigger_list
*list
,
1546 struct lttng_trigger
*trigger
)
1549 struct lttng_trigger_list_element
*new_element
=
1550 zmalloc(sizeof(*new_element
));
1556 CDS_INIT_LIST_HEAD(&new_element
->node
);
1557 new_element
->trigger
= trigger
;
1558 cds_list_add(&new_element
->node
, &list
->list
);
1564 bool trigger_applies_to_session(const struct lttng_trigger
*trigger
,
1565 const char *session_name
)
1567 bool applies
= false;
1568 const struct lttng_condition
*condition
;
1570 condition
= lttng_trigger_get_const_condition(trigger
);
1571 switch (lttng_condition_get_type(condition
)) {
1572 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
:
1573 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED
:
1575 enum lttng_condition_status condition_status
;
1576 const char *condition_session_name
;
1578 condition_status
= lttng_condition_session_rotation_get_session_name(
1579 condition
, &condition_session_name
);
1580 if (condition_status
!= LTTNG_CONDITION_STATUS_OK
) {
1581 ERR("Failed to retrieve session rotation condition's session name");
1585 assert(condition_session_name
);
1586 applies
= !strcmp(condition_session_name
, session_name
);
1597 * Allocate and initialize an lttng_session_trigger_list which contains
1598 * all triggers that apply to the session named 'session_name'.
1600 * No ownership of 'session_name' is assumed by the session trigger list.
1601 * It is the caller's responsability to ensure the session name is alive
1602 * for as long as this list is.
1605 struct lttng_session_trigger_list
*lttng_session_trigger_list_build(
1606 const struct notification_thread_state
*state
,
1607 const char *session_name
)
1609 int trigger_count
= 0;
1610 struct lttng_session_trigger_list
*session_trigger_list
= NULL
;
1611 struct lttng_trigger_ht_element
*trigger_ht_element
= NULL
;
1612 struct cds_lfht_iter iter
;
1614 session_trigger_list
= lttng_session_trigger_list_create(session_name
,
1615 state
->session_triggers_ht
);
1617 /* Add all triggers applying to the session named 'session_name'. */
1618 cds_lfht_for_each_entry(state
->triggers_ht
, &iter
, trigger_ht_element
,
1622 if (!trigger_applies_to_session(trigger_ht_element
->trigger
,
1627 ret
= lttng_session_trigger_list_add(session_trigger_list
,
1628 trigger_ht_element
->trigger
);
1636 DBG("Found %i triggers that apply to newly created session",
1638 return session_trigger_list
;
1640 lttng_session_trigger_list_destroy(session_trigger_list
);
1645 struct session_info
*find_or_create_session_info(
1646 struct notification_thread_state
*state
,
1647 const char *name
, uid_t uid
, gid_t gid
)
1649 struct session_info
*session
= NULL
;
1650 struct cds_lfht_node
*node
;
1651 struct cds_lfht_iter iter
;
1652 struct lttng_session_trigger_list
*trigger_list
;
1655 cds_lfht_lookup(state
->sessions_ht
,
1656 hash_key_str(name
, lttng_ht_seed
),
1660 node
= cds_lfht_iter_get_node(&iter
);
1662 DBG("Found session info of session \"%s\" (uid = %i, gid = %i)",
1664 session
= caa_container_of(node
, struct session_info
,
1666 assert(session
->uid
== uid
);
1667 assert(session
->gid
== gid
);
1668 session_info_get(session
);
1672 trigger_list
= lttng_session_trigger_list_build(state
, name
);
1673 if (!trigger_list
) {
1677 session
= session_info_create(name
, uid
, gid
, trigger_list
,
1678 state
->sessions_ht
);
1680 ERR("Failed to allocation session info for session \"%s\" (uid = %i, gid = %i)",
1682 lttng_session_trigger_list_destroy(trigger_list
);
1685 trigger_list
= NULL
;
1687 cds_lfht_add(state
->sessions_ht
, hash_key_str(name
, lttng_ht_seed
),
1688 &session
->sessions_ht_node
);
1694 session_info_put(session
);
1699 int handle_notification_thread_command_add_channel(
1700 struct notification_thread_state
*state
,
1701 const char *session_name
, uid_t session_uid
, gid_t session_gid
,
1702 const char *channel_name
, enum lttng_domain_type channel_domain
,
1703 uint64_t channel_key_int
, uint64_t channel_capacity
,
1704 enum lttng_error_code
*cmd_result
)
1706 struct cds_list_head trigger_list
;
1707 struct channel_info
*new_channel_info
= NULL
;
1708 struct channel_key channel_key
= {
1709 .key
= channel_key_int
,
1710 .domain
= channel_domain
,
1712 struct lttng_channel_trigger_list
*channel_trigger_list
= NULL
;
1713 struct lttng_trigger_ht_element
*trigger_ht_element
= NULL
;
1714 int trigger_count
= 0;
1715 struct cds_lfht_iter iter
;
1716 struct session_info
*session_info
= NULL
;
1718 DBG("Adding channel %s from session %s, channel key = %" PRIu64
" in %s domain",
1719 channel_name
, session_name
, channel_key_int
,
1720 lttng_domain_type_str(channel_domain
));
1722 CDS_INIT_LIST_HEAD(&trigger_list
);
1724 session_info
= find_or_create_session_info(state
, session_name
,
1725 session_uid
, session_gid
);
1726 if (!session_info
) {
1727 /* Allocation error or an internal error occurred. */
1731 new_channel_info
= channel_info_create(channel_name
, &channel_key
,
1732 channel_capacity
, session_info
);
1733 if (!new_channel_info
) {
1738 /* Build a list of all triggers applying to the new channel. */
1739 cds_lfht_for_each_entry(state
->triggers_ht
, &iter
, trigger_ht_element
,
1741 struct lttng_trigger_list_element
*new_element
;
1743 if (!trigger_applies_to_channel(trigger_ht_element
->trigger
,
1744 new_channel_info
)) {
1748 new_element
= zmalloc(sizeof(*new_element
));
1753 CDS_INIT_LIST_HEAD(&new_element
->node
);
1754 new_element
->trigger
= trigger_ht_element
->trigger
;
1755 cds_list_add(&new_element
->node
, &trigger_list
);
1760 DBG("Found %i triggers that apply to newly added channel",
1762 channel_trigger_list
= zmalloc(sizeof(*channel_trigger_list
));
1763 if (!channel_trigger_list
) {
1766 channel_trigger_list
->channel_key
= new_channel_info
->key
;
1767 CDS_INIT_LIST_HEAD(&channel_trigger_list
->list
);
1768 cds_lfht_node_init(&channel_trigger_list
->channel_triggers_ht_node
);
1769 cds_list_splice(&trigger_list
, &channel_trigger_list
->list
);
1772 /* Add channel to the channel_ht which owns the channel_infos. */
1773 cds_lfht_add(state
->channels_ht
,
1774 hash_channel_key(&new_channel_info
->key
),
1775 &new_channel_info
->channels_ht_node
);
1777 * Add the list of triggers associated with this channel to the
1778 * channel_triggers_ht.
1780 cds_lfht_add(state
->channel_triggers_ht
,
1781 hash_channel_key(&new_channel_info
->key
),
1782 &channel_trigger_list
->channel_triggers_ht_node
);
1784 session_info_put(session_info
);
1785 *cmd_result
= LTTNG_OK
;
1788 channel_info_destroy(new_channel_info
);
1789 session_info_put(session_info
);
1794 void free_channel_trigger_list_rcu(struct rcu_head
*node
)
1796 free(caa_container_of(node
, struct lttng_channel_trigger_list
,
1801 void free_channel_state_sample_rcu(struct rcu_head
*node
)
1803 free(caa_container_of(node
, struct channel_state_sample
,
1808 int handle_notification_thread_command_remove_channel(
1809 struct notification_thread_state
*state
,
1810 uint64_t channel_key
, enum lttng_domain_type domain
,
1811 enum lttng_error_code
*cmd_result
)
1813 struct cds_lfht_node
*node
;
1814 struct cds_lfht_iter iter
;
1815 struct lttng_channel_trigger_list
*trigger_list
;
1816 struct lttng_trigger_list_element
*trigger_list_element
, *tmp
;
1817 struct channel_key key
= { .key
= channel_key
, .domain
= domain
};
1818 struct channel_info
*channel_info
;
1820 DBG("Removing channel key = %" PRIu64
" in %s domain",
1821 channel_key
, lttng_domain_type_str(domain
));
1825 cds_lfht_lookup(state
->channel_triggers_ht
,
1826 hash_channel_key(&key
),
1827 match_channel_trigger_list
,
1830 node
= cds_lfht_iter_get_node(&iter
);
1832 * There is a severe internal error if we are being asked to remove a
1833 * channel that doesn't exist.
1836 ERR("Channel being removed is unknown to the notification thread");
1840 /* Free the list of triggers associated with this channel. */
1841 trigger_list
= caa_container_of(node
, struct lttng_channel_trigger_list
,
1842 channel_triggers_ht_node
);
1843 cds_list_for_each_entry_safe(trigger_list_element
, tmp
,
1844 &trigger_list
->list
, node
) {
1845 cds_list_del(&trigger_list_element
->node
);
1846 free(trigger_list_element
);
1848 cds_lfht_del(state
->channel_triggers_ht
, node
);
1849 call_rcu(&trigger_list
->rcu_node
, free_channel_trigger_list_rcu
);
1851 /* Free sampled channel state. */
1852 cds_lfht_lookup(state
->channel_state_ht
,
1853 hash_channel_key(&key
),
1854 match_channel_state_sample
,
1857 node
= cds_lfht_iter_get_node(&iter
);
1859 * This is expected to be NULL if the channel is destroyed before we
1860 * received a sample.
1863 struct channel_state_sample
*sample
= caa_container_of(node
,
1864 struct channel_state_sample
,
1865 channel_state_ht_node
);
1867 cds_lfht_del(state
->channel_state_ht
, node
);
1868 call_rcu(&sample
->rcu_node
, free_channel_state_sample_rcu
);
1871 /* Remove the channel from the channels_ht and free it. */
1872 cds_lfht_lookup(state
->channels_ht
,
1873 hash_channel_key(&key
),
1877 node
= cds_lfht_iter_get_node(&iter
);
1879 channel_info
= caa_container_of(node
, struct channel_info
,
1881 cds_lfht_del(state
->channels_ht
, node
);
1882 channel_info_destroy(channel_info
);
1885 *cmd_result
= LTTNG_OK
;
1890 int handle_notification_thread_command_session_rotation(
1891 struct notification_thread_state
*state
,
1892 enum notification_thread_command_type cmd_type
,
1893 const char *session_name
, uid_t session_uid
, gid_t session_gid
,
1894 uint64_t trace_archive_chunk_id
,
1895 struct lttng_trace_archive_location
*location
,
1896 enum lttng_error_code
*_cmd_result
)
1899 enum lttng_error_code cmd_result
= LTTNG_OK
;
1900 struct lttng_session_trigger_list
*trigger_list
;
1901 struct lttng_trigger_list_element
*trigger_list_element
;
1902 struct session_info
*session_info
;
1903 const struct lttng_credentials session_creds
= {
1904 .uid
= LTTNG_OPTIONAL_INIT_VALUE(session_uid
),
1905 .gid
= LTTNG_OPTIONAL_INIT_VALUE(session_gid
),
1910 session_info
= find_or_create_session_info(state
, session_name
,
1911 session_uid
, session_gid
);
1912 if (!session_info
) {
1913 /* Allocation error or an internal error occurred. */
1915 cmd_result
= LTTNG_ERR_NOMEM
;
1919 session_info
->rotation
.ongoing
=
1920 cmd_type
== NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING
;
1921 session_info
->rotation
.id
= trace_archive_chunk_id
;
1922 trigger_list
= get_session_trigger_list(state
, session_name
);
1923 if (!trigger_list
) {
1924 DBG("No triggers applying to session \"%s\" found",
1929 cds_list_for_each_entry(trigger_list_element
, &trigger_list
->list
,
1931 const struct lttng_condition
*condition
;
1932 struct lttng_trigger
*trigger
;
1933 struct notification_client_list
*client_list
;
1934 struct lttng_evaluation
*evaluation
= NULL
;
1935 enum lttng_condition_type condition_type
;
1936 enum action_executor_status executor_status
;
1938 trigger
= trigger_list_element
->trigger
;
1939 condition
= lttng_trigger_get_const_condition(trigger
);
1941 condition_type
= lttng_condition_get_type(condition
);
1943 if (condition_type
== LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
&&
1944 cmd_type
!= NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING
) {
1946 } else if (condition_type
== LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED
&&
1947 cmd_type
!= NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_COMPLETED
) {
1951 client_list
= get_client_list_from_condition(state
, condition
);
1952 if (cmd_type
== NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING
) {
1953 evaluation
= lttng_evaluation_session_rotation_ongoing_create(
1954 trace_archive_chunk_id
);
1956 evaluation
= lttng_evaluation_session_rotation_completed_create(
1957 trace_archive_chunk_id
, location
);
1961 /* Internal error */
1963 cmd_result
= LTTNG_ERR_UNK
;
1968 * Ownership of `evaluation` transferred to the action executor
1969 * no matter the result.
1971 executor_status
= action_executor_enqueue_trigger(
1972 state
->executor
, trigger
, evaluation
,
1973 &session_creds
, client_list
);
1975 switch (executor_status
) {
1976 case ACTION_EXECUTOR_STATUS_OK
:
1978 case ACTION_EXECUTOR_STATUS_ERROR
:
1979 case ACTION_EXECUTOR_STATUS_INVALID
:
1981 * TODO Add trigger identification (name/id) when
1982 * it is added to the API.
1984 ERR("Fatal error occurred while enqueuing action associated with session rotation trigger");
1987 case ACTION_EXECUTOR_STATUS_OVERFLOW
:
1989 * TODO Add trigger identification (name/id) when
1990 * it is added to the API.
1992 * Not a fatal error.
1994 WARN("No space left when enqueuing action associated with session rotation trigger");
2002 notification_client_list_put(client_list
);
2003 if (caa_unlikely(ret
)) {
2008 session_info_put(session_info
);
2009 *_cmd_result
= cmd_result
;
2015 int handle_notification_thread_command_add_tracer_event_source(
2016 struct notification_thread_state
*state
,
2017 int tracer_event_source_fd
,
2018 enum lttng_domain_type domain_type
,
2019 enum lttng_error_code
*_cmd_result
)
2022 enum lttng_error_code cmd_result
= LTTNG_OK
;
2023 struct notification_event_tracer_event_source_element
*element
= NULL
;
2025 element
= zmalloc(sizeof(*element
));
2027 cmd_result
= LTTNG_ERR_NOMEM
;
2032 element
->fd
= tracer_event_source_fd
;
2033 element
->domain
= domain_type
;
2035 cds_list_add(&element
->node
, &state
->tracer_event_sources_list
);
2037 DBG3("Adding tracer event source fd to poll set: tracer_event_source_fd = %d, domain = '%s'",
2038 tracer_event_source_fd
,
2039 lttng_domain_type_str(domain_type
));
2041 /* Adding the read side pipe to the event poll. */
2042 ret
= lttng_poll_add(&state
->events
, tracer_event_source_fd
, LPOLLIN
| LPOLLERR
);
2044 ERR("Failed to add tracer event source to poll set: tracer_event_source_fd = %d, domain = '%s'",
2045 tracer_event_source_fd
,
2046 lttng_domain_type_str(element
->domain
));
2047 cds_list_del(&element
->node
);
2052 element
->is_fd_in_poll_set
= true;
2055 *_cmd_result
= cmd_result
;
2060 int drain_event_notifier_notification_pipe(
2061 struct notification_thread_state
*state
,
2062 int pipe
, enum lttng_domain_type domain
)
2064 struct lttng_poll_event events
= {0};
2067 ret
= lttng_poll_create(&events
, 1, LTTNG_CLOEXEC
);
2069 ERR("Error creating lttng_poll_event");
2073 ret
= lttng_poll_add(&events
, pipe
, LPOLLIN
);
2075 ERR("Error adding fd event notifier notification pipe to lttng_poll_event: fd = %d",
2082 * Continue to consume notifications as long as there are new
2083 * ones coming in. The tracer has been asked to stop producing
2086 * LPOLLIN is explicitly checked since LPOLLHUP is implicitly
2087 * monitored (on Linux, at least) and will be returned when
2088 * the pipe is closed but empty.
2090 ret
= lttng_poll_wait_interruptible(&events
, 0);
2091 if (ret
== 0 || (LTTNG_POLL_GETEV(&events
, 0) & LPOLLIN
) == 0) {
2092 /* No more notification to be read on this pipe. */
2095 } else if (ret
< 0) {
2096 PERROR("Failed on lttng_poll_wait_interruptible() call");
2101 ret
= handle_one_event_notifier_notification(state
, pipe
, domain
);
2103 ERR("Error consuming an event notifier notification from pipe: fd = %d",
2108 lttng_poll_clean(&events
);
2113 int handle_notification_thread_command_remove_tracer_event_source(
2114 struct notification_thread_state
*state
,
2115 int tracer_event_source_fd
,
2116 enum lttng_error_code
*_cmd_result
)
2120 enum lttng_error_code cmd_result
= LTTNG_OK
;
2121 struct notification_event_tracer_event_source_element
*source_element
= NULL
, *tmp
;
2123 cds_list_for_each_entry_safe(source_element
, tmp
,
2124 &state
->tracer_event_sources_list
, node
) {
2125 if (source_element
->fd
!= tracer_event_source_fd
) {
2129 DBG("Removed tracer event source from poll set: tracer_event_source_fd = %d, domain = '%s'",
2130 tracer_event_source_fd
,
2131 lttng_domain_type_str(source_element
->domain
));
2132 cds_list_del(&source_element
->node
);
2139 * This is temporarily allowed since the poll activity set is
2140 * not properly cleaned-up for the moment. This is adressed in
2143 source_element
= NULL
;
2147 if (!source_element
->is_fd_in_poll_set
) {
2148 /* Skip the poll set removal. */
2152 DBG3("Removing tracer event source from poll set: tracer_event_source_fd = %d, domain = '%s'",
2153 tracer_event_source_fd
,
2154 lttng_domain_type_str(source_element
->domain
));
2156 /* Removing the fd from the event poll set. */
2157 ret
= lttng_poll_del(&state
->events
, tracer_event_source_fd
);
2159 ERR("Failed to remove tracer event source from poll set: tracer_event_source_fd = %d, domain = '%s'",
2160 tracer_event_source_fd
,
2161 lttng_domain_type_str(source_element
->domain
));
2162 cmd_result
= LTTNG_ERR_FATAL
;
2166 source_element
->is_fd_in_poll_set
= false;
2168 ret
= drain_event_notifier_notification_pipe(state
, tracer_event_source_fd
,
2169 source_element
->domain
);
2171 ERR("Error draining event notifier notification: tracer_event_source_fd = %d, domain = %s",
2172 tracer_event_source_fd
,
2173 lttng_domain_type_str(source_element
->domain
));
2174 cmd_result
= LTTNG_ERR_FATAL
;
2179 * The drain_event_notifier_notification_pipe() call might have read
2180 * data from an fd that we received in event in the latest _poll_wait()
2181 * call. Make sure the thread call poll_wait() again to ensure we have
2184 state
->restart_poll
= true;
2187 free(source_element
);
2188 *_cmd_result
= cmd_result
;
2192 int handle_notification_thread_remove_tracer_event_source_no_result(
2193 struct notification_thread_state
*state
,
2194 int tracer_event_source_fd
)
2197 enum lttng_error_code cmd_result
;
2199 ret
= handle_notification_thread_command_remove_tracer_event_source(
2200 state
, tracer_event_source_fd
, &cmd_result
);
2205 static int handle_notification_thread_command_list_triggers(
2206 struct notification_thread_handle
*handle
,
2207 struct notification_thread_state
*state
,
2209 struct lttng_triggers
**triggers
,
2210 enum lttng_error_code
*_cmd_result
)
2213 enum lttng_error_code cmd_result
= LTTNG_OK
;
2214 struct cds_lfht_iter iter
;
2215 struct lttng_trigger_ht_element
*trigger_ht_element
;
2216 struct lttng_triggers
*local_triggers
= NULL
;
2217 const struct lttng_credentials
*creds
;
2221 local_triggers
= lttng_triggers_create();
2222 if (!local_triggers
) {
2223 /* Not a fatal error. */
2224 cmd_result
= LTTNG_ERR_NOMEM
;
2228 cds_lfht_for_each_entry(state
->triggers_ht
, &iter
,
2229 trigger_ht_element
, node
) {
2231 * Only return the triggers to which the client has access.
2232 * The root user has visibility over all triggers.
2234 creds
= lttng_trigger_get_credentials(trigger_ht_element
->trigger
);
2235 if (client_uid
!= lttng_credentials_get_uid(creds
) && client_uid
!= 0) {
2239 ret
= lttng_triggers_add(local_triggers
,
2240 trigger_ht_element
->trigger
);
2242 /* Not a fatal error. */
2244 cmd_result
= LTTNG_ERR_NOMEM
;
2249 /* Transferring ownership to the caller. */
2250 *triggers
= local_triggers
;
2251 local_triggers
= NULL
;
2255 lttng_triggers_destroy(local_triggers
);
2256 *_cmd_result
= cmd_result
;
2260 static inline void get_trigger_info_for_log(const struct lttng_trigger
*trigger
,
2261 const char **trigger_name
,
2262 uid_t
*trigger_owner_uid
)
2264 enum lttng_trigger_status trigger_status
;
2266 trigger_status
= lttng_trigger_get_name(trigger
, trigger_name
);
2267 switch (trigger_status
) {
2268 case LTTNG_TRIGGER_STATUS_OK
:
2270 case LTTNG_TRIGGER_STATUS_UNSET
:
2271 *trigger_name
= "(anonymous)";
2277 trigger_status
= lttng_trigger_get_owner_uid(trigger
,
2279 assert(trigger_status
== LTTNG_TRIGGER_STATUS_OK
);
2282 static int handle_notification_thread_command_get_trigger(
2283 struct notification_thread_state
*state
,
2284 const struct lttng_trigger
*trigger
,
2285 struct lttng_trigger
**registered_trigger
,
2286 enum lttng_error_code
*_cmd_result
)
2289 struct cds_lfht_iter iter
;
2290 struct lttng_trigger_ht_element
*trigger_ht_element
;
2291 enum lttng_error_code cmd_result
= LTTNG_ERR_TRIGGER_NOT_FOUND
;
2292 const char *trigger_name
;
2293 uid_t trigger_owner_uid
;
2297 cds_lfht_for_each_entry(
2298 state
->triggers_ht
, &iter
, trigger_ht_element
, node
) {
2299 if (lttng_trigger_is_equal(
2300 trigger
, trigger_ht_element
->trigger
)) {
2301 /* Take one reference on the return trigger. */
2302 *registered_trigger
= trigger_ht_element
->trigger
;
2303 lttng_trigger_get(*registered_trigger
);
2305 cmd_result
= LTTNG_OK
;
2310 /* Not a fatal error if the trigger is not found. */
2311 get_trigger_info_for_log(trigger
, &trigger_name
, &trigger_owner_uid
);
2312 DBG("Failed to retrieve registered version of trigger: trigger name = '%s', trigger owner uid = %d",
2313 trigger_name
, (int) trigger_owner_uid
);
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_EVENT_RULE_MATCHES
:
2356 const struct lttng_event_rule
*event_rule
;
2357 enum lttng_domain_type domain
;
2358 const enum lttng_condition_status status
=
2359 lttng_condition_event_rule_matches_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("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("Unable to bind trigger applying to session \"%s\" as it is not yet known to the notification system",
2426 DBG("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("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_LIST
) {
2498 action_status
= lttng_action_list_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_list_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 enum lttng_error_code
setup_tracer_notifier(
2575 struct notification_thread_state
*state
,
2576 struct lttng_trigger
*trigger
)
2578 enum lttng_error_code ret
;
2579 enum event_notifier_error_accounting_status error_accounting_status
;
2580 struct cds_lfht_node
*node
;
2581 uint64_t error_counter_index
= 0;
2582 struct lttng_condition
*condition
= lttng_trigger_get_condition(trigger
);
2583 struct notification_trigger_tokens_ht_element
*trigger_tokens_ht_element
= NULL
;
2585 trigger_tokens_ht_element
= zmalloc(sizeof(*trigger_tokens_ht_element
));
2586 if (!trigger_tokens_ht_element
) {
2587 ret
= LTTNG_ERR_NOMEM
;
2591 /* Add trigger token to the trigger_tokens_ht. */
2592 cds_lfht_node_init(&trigger_tokens_ht_element
->node
);
2593 trigger_tokens_ht_element
->token
= LTTNG_OPTIONAL_GET(trigger
->tracer_token
);
2594 trigger_tokens_ht_element
->trigger
= trigger
;
2596 node
= cds_lfht_add_unique(state
->trigger_tokens_ht
,
2597 hash_key_u64(&trigger_tokens_ht_element
->token
, lttng_ht_seed
),
2598 match_trigger_token
,
2599 &trigger_tokens_ht_element
->token
,
2600 &trigger_tokens_ht_element
->node
);
2601 if (node
!= &trigger_tokens_ht_element
->node
) {
2602 ret
= LTTNG_ERR_TRIGGER_EXISTS
;
2603 goto error_free_ht_element
;
2606 error_accounting_status
= event_notifier_error_accounting_register_event_notifier(
2607 trigger
, &error_counter_index
);
2608 if (error_accounting_status
!= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
) {
2609 if (error_accounting_status
== EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_NO_INDEX_AVAILABLE
) {
2610 DBG("Trigger list error accounting counter full.");
2611 ret
= LTTNG_ERR_EVENT_NOTIFIER_ERROR_ACCOUNTING_FULL
;
2613 ERR("Error registering trigger for error accounting");
2614 ret
= LTTNG_ERR_EVENT_NOTIFIER_REGISTRATION
;
2617 goto error_remove_ht_element
;
2620 lttng_condition_event_rule_matches_set_error_counter_index(
2621 condition
, error_counter_index
);
2626 error_remove_ht_element
:
2627 cds_lfht_del(state
->trigger_tokens_ht
, &trigger_tokens_ht_element
->node
);
2628 error_free_ht_element
:
2629 free(trigger_tokens_ht_element
);
2635 * FIXME A client's credentials are not checked when registering a trigger.
2637 * The effects of this are benign since:
2638 * - The client will succeed in registering the trigger, as it is valid,
2639 * - The trigger will, internally, be bound to the channel/session,
2640 * - The notifications will not be sent since the client's credentials
2641 * are checked against the channel at that moment.
2643 * If this function returns a non-zero value, it means something is
2644 * fundamentally broken and the whole subsystem/thread will be torn down.
2646 * If a non-fatal error occurs, just set the cmd_result to the appropriate
2650 int handle_notification_thread_command_register_trigger(
2651 struct notification_thread_state
*state
,
2652 struct lttng_trigger
*trigger
,
2653 bool is_trigger_anonymous
,
2654 enum lttng_error_code
*cmd_result
)
2657 struct lttng_condition
*condition
;
2658 struct notification_client_list
*client_list
= NULL
;
2659 struct lttng_trigger_ht_element
*trigger_ht_element
= NULL
;
2660 struct cds_lfht_node
*node
;
2661 const char* trigger_name
;
2662 bool free_trigger
= true;
2663 struct lttng_evaluation
*evaluation
= NULL
;
2664 struct lttng_credentials object_creds
;
2667 enum action_executor_status executor_status
;
2668 const uint64_t trigger_tracer_token
=
2669 state
->trigger_id
.next_tracer_token
++;
2673 /* Set the trigger's tracer token. */
2674 lttng_trigger_set_tracer_token(trigger
, trigger_tracer_token
);
2676 if (!is_trigger_anonymous
) {
2677 if (lttng_trigger_get_name(trigger
, &trigger_name
) ==
2678 LTTNG_TRIGGER_STATUS_UNSET
) {
2679 const enum lttng_error_code ret_code
=
2680 generate_trigger_name(state
, trigger
,
2683 if (ret_code
!= LTTNG_OK
) {
2686 *cmd_result
= ret_code
;
2689 } else if (trigger_name_taken(state
, trigger
)) {
2690 /* Not a fatal error. */
2691 *cmd_result
= LTTNG_ERR_TRIGGER_EXISTS
;
2696 trigger_name
= "(anonymous)";
2699 condition
= lttng_trigger_get_condition(trigger
);
2702 /* Some conditions require tracers to implement a minimal ABI version. */
2703 if (!condition_is_supported(condition
)) {
2704 *cmd_result
= LTTNG_ERR_NOT_SUPPORTED
;
2708 trigger_ht_element
= zmalloc(sizeof(*trigger_ht_element
));
2709 if (!trigger_ht_element
) {
2714 /* Add trigger to the trigger_ht. */
2715 cds_lfht_node_init(&trigger_ht_element
->node
);
2716 cds_lfht_node_init(&trigger_ht_element
->node_by_name_uid
);
2717 trigger_ht_element
->trigger
= trigger
;
2719 node
= cds_lfht_add_unique(state
->triggers_ht
,
2720 lttng_condition_hash(condition
),
2723 &trigger_ht_element
->node
);
2724 if (node
!= &trigger_ht_element
->node
) {
2725 /* Not a fatal error, simply report it to the client. */
2726 *cmd_result
= LTTNG_ERR_TRIGGER_EXISTS
;
2727 goto error_free_ht_element
;
2730 node
= cds_lfht_add_unique(state
->triggers_by_name_uid_ht
,
2731 hash_trigger_by_name_uid(trigger
),
2732 match_trigger_by_name_uid
,
2734 &trigger_ht_element
->node_by_name_uid
);
2735 if (node
!= &trigger_ht_element
->node_by_name_uid
) {
2736 /* Internal error: add to triggers_ht should have failed. */
2738 goto error_free_ht_element
;
2741 /* From this point consider the trigger registered. */
2742 lttng_trigger_set_as_registered(trigger
);
2745 * Some triggers might need a tracer notifier depending on its
2746 * condition and actions.
2748 if (lttng_trigger_needs_tracer_notifier(trigger
)) {
2749 enum lttng_error_code error_code
;
2751 error_code
= setup_tracer_notifier(state
, trigger
);
2752 if (error_code
!= LTTNG_OK
) {
2753 notif_thread_state_remove_trigger_ht_elem(state
,
2754 trigger_ht_element
);
2755 if (error_code
== LTTNG_ERR_NOMEM
) {
2758 *cmd_result
= error_code
;
2762 goto error_free_ht_element
;
2767 * The rest only applies to triggers that have a "notify" action.
2768 * It is not skipped as this is the only action type currently
2771 if (is_trigger_action_notify(trigger
)) {
2773 * Find or create the client list of this condition. It may
2774 * already be present if another trigger is already registered
2775 * with the same condition.
2777 client_list
= get_client_list_from_condition(state
, condition
);
2780 * No client list for this condition yet. We create new
2781 * one and build it up.
2783 client_list
= notification_client_list_create(state
, condition
);
2785 ERR("Error creating notification client list for trigger %s", trigger
->name
);
2786 goto error_free_ht_element
;
2790 CDS_INIT_LIST_HEAD(&trigger_ht_element
->client_list_trigger_node
);
2792 pthread_mutex_lock(&client_list
->lock
);
2793 cds_list_add(&trigger_ht_element
->client_list_trigger_node
, &client_list
->triggers_list
);
2794 pthread_mutex_unlock(&client_list
->lock
);
2798 * Ownership of the trigger and of its wrapper was transfered to
2799 * the triggers_ht. Same for token ht element if necessary.
2801 trigger_ht_element
= NULL
;
2802 free_trigger
= false;
2804 switch (get_condition_binding_object(condition
)) {
2805 case LTTNG_OBJECT_TYPE_SESSION
:
2806 /* Add the trigger to the list if it matches a known session. */
2807 ret
= bind_trigger_to_matching_session(trigger
, state
);
2809 goto error_free_ht_element
;
2812 case LTTNG_OBJECT_TYPE_CHANNEL
:
2814 * Add the trigger to list of triggers bound to the channels
2817 ret
= bind_trigger_to_matching_channels(trigger
, state
);
2819 goto error_free_ht_element
;
2822 case LTTNG_OBJECT_TYPE_NONE
:
2825 ERR("Unknown object type on which to bind a newly registered trigger was encountered");
2827 goto error_free_ht_element
;
2831 * The new trigger's condition must be evaluated against the current
2834 * In the case of `notify` action, nothing preventing clients from
2835 * subscribing to a condition before the corresponding trigger is
2836 * registered, we have to evaluate this new condition right away.
2838 * At some point, we were waiting for the next "evaluation" (e.g. on
2839 * reception of a channel sample) to evaluate this new condition, but
2842 * The reason it was broken is that waiting for the next sample
2843 * does not allow us to properly handle transitions for edge-triggered
2846 * Consider this example: when we handle a new channel sample, we
2847 * evaluate each conditions twice: once with the previous state, and
2848 * again with the newest state. We then use those two results to
2849 * determine whether a state change happened: a condition was false and
2850 * became true. If a state change happened, we have to notify clients.
2852 * Now, if a client subscribes to a given notification and registers
2853 * a trigger *after* that subscription, we have to make sure the
2854 * condition is evaluated at this point while considering only the
2855 * current state. Otherwise, the next evaluation cycle may only see
2856 * that the evaluations remain the same (true for samples n-1 and n) and
2857 * the client will never know that the condition has been met.
2859 switch (get_condition_binding_object(condition
)) {
2860 case LTTNG_OBJECT_TYPE_SESSION
:
2861 ret
= evaluate_session_condition_for_client(condition
, state
,
2862 &evaluation
, &object_uid
,
2864 LTTNG_OPTIONAL_SET(&object_creds
.uid
, object_uid
);
2865 LTTNG_OPTIONAL_SET(&object_creds
.gid
, object_gid
);
2867 case LTTNG_OBJECT_TYPE_CHANNEL
:
2868 ret
= evaluate_channel_condition_for_client(condition
, state
,
2869 &evaluation
, &object_uid
,
2871 LTTNG_OPTIONAL_SET(&object_creds
.uid
, object_uid
);
2872 LTTNG_OPTIONAL_SET(&object_creds
.gid
, object_gid
);
2874 case LTTNG_OBJECT_TYPE_NONE
:
2877 case LTTNG_OBJECT_TYPE_UNKNOWN
:
2885 goto error_free_ht_element
;
2888 DBG("Newly registered trigger's condition evaluated to %s",
2889 evaluation
? "true" : "false");
2891 /* Evaluation yielded nothing. Normal exit. */
2897 * Ownership of `evaluation` transferred to the action executor
2898 * no matter the result.
2900 executor_status
= action_executor_enqueue_trigger(state
->executor
,
2901 trigger
, evaluation
, &object_creds
, client_list
);
2903 switch (executor_status
) {
2904 case ACTION_EXECUTOR_STATUS_OK
:
2906 case ACTION_EXECUTOR_STATUS_ERROR
:
2907 case ACTION_EXECUTOR_STATUS_INVALID
:
2909 * TODO Add trigger identification (name/id) when
2910 * it is added to the API.
2912 ERR("Fatal error occurred while enqueuing action associated to newly registered trigger");
2914 goto error_free_ht_element
;
2915 case ACTION_EXECUTOR_STATUS_OVERFLOW
:
2917 * TODO Add trigger identification (name/id) when
2918 * it is added to the API.
2920 * Not a fatal error.
2922 WARN("No space left when enqueuing action associated to newly registered trigger");
2930 *cmd_result
= LTTNG_OK
;
2931 DBG("Registered trigger: name = `%s`, tracer token = %" PRIu64
,
2932 trigger_name
, trigger_tracer_token
);
2935 error_free_ht_element
:
2936 if (trigger_ht_element
) {
2937 /* Delayed removal due to RCU constraint on delete. */
2938 call_rcu(&trigger_ht_element
->rcu_node
,
2939 free_lttng_trigger_ht_element_rcu
);
2944 * Other objects might have a reference to the trigger, mark it
2947 lttng_trigger_set_as_unregistered(trigger
);
2948 lttng_trigger_destroy(trigger
);
2956 void free_lttng_trigger_ht_element_rcu(struct rcu_head
*node
)
2958 free(caa_container_of(node
, struct lttng_trigger_ht_element
,
2963 void free_notification_trigger_tokens_ht_element_rcu(struct rcu_head
*node
)
2965 free(caa_container_of(node
, struct notification_trigger_tokens_ht_element
,
2970 void teardown_tracer_notifier(struct notification_thread_state
*state
,
2971 const struct lttng_trigger
*trigger
)
2973 struct cds_lfht_iter iter
;
2974 struct notification_trigger_tokens_ht_element
*trigger_tokens_ht_element
;
2976 cds_lfht_for_each_entry(state
->trigger_tokens_ht
, &iter
,
2977 trigger_tokens_ht_element
, node
) {
2979 if (!lttng_trigger_is_equal(trigger
,
2980 trigger_tokens_ht_element
->trigger
)) {
2984 event_notifier_error_accounting_unregister_event_notifier(
2985 trigger_tokens_ht_element
->trigger
);
2987 /* TODO talk to all app and remove it */
2988 DBG("Removed trigger from tokens_ht");
2989 cds_lfht_del(state
->trigger_tokens_ht
,
2990 &trigger_tokens_ht_element
->node
);
2992 call_rcu(&trigger_tokens_ht_element
->rcu_node
,
2993 free_notification_trigger_tokens_ht_element_rcu
);
3000 int handle_notification_thread_command_unregister_trigger(
3001 struct notification_thread_state
*state
,
3002 const struct lttng_trigger
*trigger
,
3003 enum lttng_error_code
*_cmd_reply
)
3005 struct cds_lfht_iter iter
;
3006 struct cds_lfht_node
*triggers_ht_node
;
3007 struct lttng_channel_trigger_list
*trigger_list
;
3008 struct notification_client_list
*client_list
;
3009 struct lttng_trigger_ht_element
*trigger_ht_element
= NULL
;
3010 const struct lttng_condition
*condition
= lttng_trigger_get_const_condition(
3012 enum lttng_error_code cmd_reply
;
3016 cds_lfht_lookup(state
->triggers_ht
,
3017 lttng_condition_hash(condition
),
3021 triggers_ht_node
= cds_lfht_iter_get_node(&iter
);
3022 if (!triggers_ht_node
) {
3023 cmd_reply
= LTTNG_ERR_TRIGGER_NOT_FOUND
;
3026 cmd_reply
= LTTNG_OK
;
3029 trigger_ht_element
= caa_container_of(triggers_ht_node
,
3030 struct lttng_trigger_ht_element
, node
);
3032 /* Remove trigger from channel_triggers_ht. */
3033 cds_lfht_for_each_entry(state
->channel_triggers_ht
, &iter
, trigger_list
,
3034 channel_triggers_ht_node
) {
3035 struct lttng_trigger_list_element
*trigger_element
, *tmp
;
3037 cds_list_for_each_entry_safe(trigger_element
, tmp
,
3038 &trigger_list
->list
, node
) {
3039 if (!lttng_trigger_is_equal(trigger
, trigger_element
->trigger
)) {
3043 DBG("Removed trigger from channel_triggers_ht");
3044 cds_list_del(&trigger_element
->node
);
3045 /* A trigger can only appear once per channel */
3050 if (lttng_trigger_needs_tracer_notifier(trigger
)) {
3051 teardown_tracer_notifier(state
, trigger
);
3054 if (is_trigger_action_notify(trigger
)) {
3056 * Remove and release the client list from
3057 * notification_trigger_clients_ht.
3059 client_list
= get_client_list_from_condition(state
, condition
);
3060 assert(client_list
);
3062 pthread_mutex_lock(&client_list
->lock
);
3063 cds_list_del(&trigger_ht_element
->client_list_trigger_node
);
3064 pthread_mutex_unlock(&client_list
->lock
);
3066 /* Put new reference and the hashtable's reference. */
3067 notification_client_list_put(client_list
);
3068 notification_client_list_put(client_list
);
3072 /* Remove trigger from triggers_ht. */
3073 notif_thread_state_remove_trigger_ht_elem(state
, trigger_ht_element
);
3075 /* Release the ownership of the trigger. */
3076 lttng_trigger_destroy(trigger_ht_element
->trigger
);
3077 call_rcu(&trigger_ht_element
->rcu_node
, free_lttng_trigger_ht_element_rcu
);
3081 *_cmd_reply
= cmd_reply
;
3086 /* Returns 0 on success, 1 on exit requested, negative value on error. */
3087 int handle_notification_thread_command(
3088 struct notification_thread_handle
*handle
,
3089 struct notification_thread_state
*state
)
3093 struct notification_thread_command
*cmd
;
3095 /* Read the event pipe to put it back into a quiescent state. */
3096 ret
= lttng_read(lttng_pipe_get_readfd(handle
->cmd_queue
.event_pipe
), &counter
,
3098 if (ret
!= sizeof(counter
)) {
3102 pthread_mutex_lock(&handle
->cmd_queue
.lock
);
3103 cmd
= cds_list_first_entry(&handle
->cmd_queue
.list
,
3104 struct notification_thread_command
, cmd_list_node
);
3105 cds_list_del(&cmd
->cmd_list_node
);
3106 pthread_mutex_unlock(&handle
->cmd_queue
.lock
);
3108 DBG("Received `%s` command",
3109 notification_command_type_str(cmd
->type
));
3110 switch (cmd
->type
) {
3111 case NOTIFICATION_COMMAND_TYPE_REGISTER_TRIGGER
:
3112 ret
= handle_notification_thread_command_register_trigger(state
,
3113 cmd
->parameters
.register_trigger
.trigger
,
3114 cmd
->parameters
.register_trigger
.is_trigger_anonymous
,
3117 case NOTIFICATION_COMMAND_TYPE_UNREGISTER_TRIGGER
:
3118 ret
= handle_notification_thread_command_unregister_trigger(
3120 cmd
->parameters
.unregister_trigger
.trigger
,
3123 case NOTIFICATION_COMMAND_TYPE_ADD_CHANNEL
:
3124 ret
= handle_notification_thread_command_add_channel(
3126 cmd
->parameters
.add_channel
.session
.name
,
3127 cmd
->parameters
.add_channel
.session
.uid
,
3128 cmd
->parameters
.add_channel
.session
.gid
,
3129 cmd
->parameters
.add_channel
.channel
.name
,
3130 cmd
->parameters
.add_channel
.channel
.domain
,
3131 cmd
->parameters
.add_channel
.channel
.key
,
3132 cmd
->parameters
.add_channel
.channel
.capacity
,
3135 case NOTIFICATION_COMMAND_TYPE_REMOVE_CHANNEL
:
3136 ret
= handle_notification_thread_command_remove_channel(
3137 state
, cmd
->parameters
.remove_channel
.key
,
3138 cmd
->parameters
.remove_channel
.domain
,
3141 case NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING
:
3142 case NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_COMPLETED
:
3143 ret
= handle_notification_thread_command_session_rotation(
3146 cmd
->parameters
.session_rotation
.session_name
,
3147 cmd
->parameters
.session_rotation
.uid
,
3148 cmd
->parameters
.session_rotation
.gid
,
3149 cmd
->parameters
.session_rotation
.trace_archive_chunk_id
,
3150 cmd
->parameters
.session_rotation
.location
,
3153 case NOTIFICATION_COMMAND_TYPE_ADD_TRACER_EVENT_SOURCE
:
3154 ret
= handle_notification_thread_command_add_tracer_event_source(
3156 cmd
->parameters
.tracer_event_source
.tracer_event_source_fd
,
3157 cmd
->parameters
.tracer_event_source
.domain
,
3160 case NOTIFICATION_COMMAND_TYPE_REMOVE_TRACER_EVENT_SOURCE
:
3161 ret
= handle_notification_thread_command_remove_tracer_event_source(
3163 cmd
->parameters
.tracer_event_source
.tracer_event_source_fd
,
3166 case NOTIFICATION_COMMAND_TYPE_LIST_TRIGGERS
:
3168 struct lttng_triggers
*triggers
= NULL
;
3170 ret
= handle_notification_thread_command_list_triggers(
3173 cmd
->parameters
.list_triggers
.uid
,
3176 cmd
->reply
.list_triggers
.triggers
= triggers
;
3180 case NOTIFICATION_COMMAND_TYPE_QUIT
:
3181 cmd
->reply_code
= LTTNG_OK
;
3184 case NOTIFICATION_COMMAND_TYPE_GET_TRIGGER
:
3186 struct lttng_trigger
*trigger
= NULL
;
3188 ret
= handle_notification_thread_command_get_trigger(state
,
3189 cmd
->parameters
.get_trigger
.trigger
, &trigger
,
3191 cmd
->reply
.get_trigger
.trigger
= trigger
;
3194 case NOTIFICATION_COMMAND_TYPE_CLIENT_COMMUNICATION_UPDATE
:
3196 const enum client_transmission_status client_status
=
3197 cmd
->parameters
.client_communication_update
3199 const notification_client_id client_id
=
3200 cmd
->parameters
.client_communication_update
.id
;
3201 struct notification_client
*client
;
3204 client
= get_client_from_id(client_id
, state
);
3208 * Client error was probably already picked-up by the
3209 * notification thread or it has disconnected
3210 * gracefully while this command was queued.
3212 DBG("Failed to find notification client to update communication status, client id = %" PRIu64
,
3216 ret
= client_handle_transmission_status(
3217 client
, client_status
, state
);
3223 ERR("Unknown internal command received");
3231 if (cmd
->is_async
) {
3235 lttng_waiter_wake_up(&cmd
->reply_waiter
);
3239 /* Wake-up and return a fatal error to the calling thread. */
3240 lttng_waiter_wake_up(&cmd
->reply_waiter
);
3241 cmd
->reply_code
= LTTNG_ERR_FATAL
;
3243 /* Indicate a fatal error to the caller. */
3248 int socket_set_non_blocking(int socket
)
3252 /* Set the pipe as non-blocking. */
3253 ret
= fcntl(socket
, F_GETFL
, 0);
3255 PERROR("fcntl get socket flags");
3260 ret
= fcntl(socket
, F_SETFL
, flags
| O_NONBLOCK
);
3262 PERROR("fcntl set O_NONBLOCK socket flag");
3265 DBG("Client socket (fd = %i) set as non-blocking", socket
);
3271 int client_reset_inbound_state(struct notification_client
*client
)
3276 lttng_payload_clear(&client
->communication
.inbound
.payload
);
3278 client
->communication
.inbound
.bytes_to_receive
=
3279 sizeof(struct lttng_notification_channel_message
);
3280 client
->communication
.inbound
.msg_type
=
3281 LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_UNKNOWN
;
3282 LTTNG_SOCK_SET_UID_CRED(&client
->communication
.inbound
.creds
, -1);
3283 LTTNG_SOCK_SET_GID_CRED(&client
->communication
.inbound
.creds
, -1);
3284 ret
= lttng_dynamic_buffer_set_size(
3285 &client
->communication
.inbound
.payload
.buffer
,
3286 client
->communication
.inbound
.bytes_to_receive
);
3291 int handle_notification_thread_client_connect(
3292 struct notification_thread_state
*state
)
3295 struct notification_client
*client
;
3297 DBG("Handling new notification channel client connection");
3299 client
= zmalloc(sizeof(*client
));
3306 pthread_mutex_init(&client
->lock
, NULL
);
3307 client
->id
= state
->next_notification_client_id
++;
3308 CDS_INIT_LIST_HEAD(&client
->condition_list
);
3309 lttng_payload_init(&client
->communication
.inbound
.payload
);
3310 lttng_payload_init(&client
->communication
.outbound
.payload
);
3311 client
->communication
.inbound
.expect_creds
= true;
3313 ret
= client_reset_inbound_state(client
);
3315 ERR("Failed to reset client communication's inbound state");
3320 ret
= lttcomm_accept_unix_sock(state
->notification_channel_socket
);
3322 ERR("Failed to accept new notification channel client connection");
3327 client
->socket
= ret
;
3329 ret
= socket_set_non_blocking(client
->socket
);
3331 ERR("Failed to set new notification channel client connection socket as non-blocking");
3335 ret
= lttcomm_setsockopt_creds_unix_sock(client
->socket
);
3337 ERR("Failed to set socket options on new notification channel client socket");
3342 ret
= lttng_poll_add(&state
->events
, client
->socket
,
3343 LPOLLIN
| LPOLLERR
|
3344 LPOLLHUP
| LPOLLRDHUP
);
3346 ERR("Failed to add notification channel client socket to poll set");
3350 DBG("Added new notification channel client socket (%i) to poll set",
3354 cds_lfht_add(state
->client_socket_ht
,
3355 hash_client_socket(client
->socket
),
3356 &client
->client_socket_ht_node
);
3357 cds_lfht_add(state
->client_id_ht
,
3358 hash_client_id(client
->id
),
3359 &client
->client_id_ht_node
);
3365 notification_client_destroy(client
, state
);
3370 * RCU read-lock must be held by the caller.
3371 * Client lock must _not_ be held by the caller.
3374 int notification_thread_client_disconnect(
3375 struct notification_client
*client
,
3376 struct notification_thread_state
*state
)
3379 struct lttng_condition_list_element
*condition_list_element
, *tmp
;
3381 /* Acquire the client lock to disable its communication atomically. */
3382 pthread_mutex_lock(&client
->lock
);
3383 client
->communication
.active
= false;
3384 cds_lfht_del(state
->client_socket_ht
, &client
->client_socket_ht_node
);
3385 cds_lfht_del(state
->client_id_ht
, &client
->client_id_ht_node
);
3386 pthread_mutex_unlock(&client
->lock
);
3388 ret
= lttng_poll_del(&state
->events
, client
->socket
);
3390 ERR("Failed to remove client socket %d from poll set",
3394 /* Release all conditions to which the client was subscribed. */
3395 cds_list_for_each_entry_safe(condition_list_element
, tmp
,
3396 &client
->condition_list
, node
) {
3397 (void) notification_thread_client_unsubscribe(client
,
3398 condition_list_element
->condition
, state
, NULL
);
3402 * Client no longer accessible to other threads (through the
3405 notification_client_destroy(client
, state
);
3409 int handle_notification_thread_client_disconnect(
3410 int client_socket
, struct notification_thread_state
*state
)
3413 struct notification_client
*client
;
3416 DBG("Closing client connection (socket fd = %i)",
3418 client
= get_client_from_socket(client_socket
, state
);
3420 /* Internal state corruption, fatal error. */
3421 ERR("Unable to find client (socket fd = %i)",
3427 ret
= notification_thread_client_disconnect(client
, state
);
3433 int handle_notification_thread_client_disconnect_all(
3434 struct notification_thread_state
*state
)
3436 struct cds_lfht_iter iter
;
3437 struct notification_client
*client
;
3438 bool error_encoutered
= false;
3441 DBG("Closing all client connections");
3442 cds_lfht_for_each_entry(state
->client_socket_ht
, &iter
, client
,
3443 client_socket_ht_node
) {
3446 ret
= notification_thread_client_disconnect(
3449 error_encoutered
= true;
3453 return error_encoutered
? 1 : 0;
3456 int handle_notification_thread_trigger_unregister_all(
3457 struct notification_thread_state
*state
)
3459 bool error_occurred
= false;
3460 struct cds_lfht_iter iter
;
3461 struct lttng_trigger_ht_element
*trigger_ht_element
;
3464 cds_lfht_for_each_entry(state
->triggers_ht
, &iter
, trigger_ht_element
,
3466 int ret
= handle_notification_thread_command_unregister_trigger(
3467 state
, trigger_ht_element
->trigger
, NULL
);
3469 error_occurred
= true;
3473 return error_occurred
? -1 : 0;
3477 int client_handle_transmission_status(
3478 struct notification_client
*client
,
3479 enum client_transmission_status transmission_status
,
3480 struct notification_thread_state
*state
)
3484 switch (transmission_status
) {
3485 case CLIENT_TRANSMISSION_STATUS_COMPLETE
:
3486 ret
= lttng_poll_mod(&state
->events
, client
->socket
,
3487 CLIENT_POLL_MASK_IN
);
3493 case CLIENT_TRANSMISSION_STATUS_QUEUED
:
3495 * We want to be notified whenever there is buffer space
3496 * available to send the rest of the payload.
3498 ret
= lttng_poll_mod(&state
->events
, client
->socket
,
3499 CLIENT_POLL_MASK_IN_OUT
);
3504 case CLIENT_TRANSMISSION_STATUS_FAIL
:
3505 ret
= notification_thread_client_disconnect(client
, state
);
3510 case CLIENT_TRANSMISSION_STATUS_ERROR
:
3520 /* Client lock must be acquired by caller. */
3522 enum client_transmission_status
client_flush_outgoing_queue(
3523 struct notification_client
*client
)
3526 size_t to_send_count
;
3527 enum client_transmission_status status
;
3528 struct lttng_payload_view pv
= lttng_payload_view_from_payload(
3529 &client
->communication
.outbound
.payload
, 0, -1);
3530 const int fds_to_send_count
=
3531 lttng_payload_view_get_fd_handle_count(&pv
);
3533 ASSERT_LOCKED(client
->lock
);
3535 if (!client
->communication
.active
) {
3536 status
= CLIENT_TRANSMISSION_STATUS_FAIL
;
3540 if (pv
.buffer
.size
== 0) {
3542 * If both data and fds are equal to zero, we are in an invalid
3545 assert(fds_to_send_count
!= 0);
3550 to_send_count
= pv
.buffer
.size
;
3551 DBG("Flushing client (socket fd = %i) outgoing queue",
3554 ret
= lttcomm_send_unix_sock_non_block(client
->socket
,
3557 if ((ret
>= 0 && ret
< to_send_count
)) {
3558 DBG("Client (socket fd = %i) outgoing queue could not be completely flushed",
3560 to_send_count
-= max(ret
, 0);
3562 memmove(client
->communication
.outbound
.payload
.buffer
.data
,
3564 pv
.buffer
.size
- to_send_count
,
3566 ret
= lttng_dynamic_buffer_set_size(
3567 &client
->communication
.outbound
.payload
.buffer
,
3573 status
= CLIENT_TRANSMISSION_STATUS_QUEUED
;
3575 } else if (ret
< 0) {
3576 /* Generic error, disable the client's communication. */
3577 ERR("Failed to flush outgoing queue, disconnecting client (socket fd = %i)",
3579 client
->communication
.active
= false;
3580 status
= CLIENT_TRANSMISSION_STATUS_FAIL
;
3584 * No error and flushed the queue completely.
3586 * The payload buffer size is used later to
3587 * check if there is notifications queued. So albeit that the
3588 * direct caller knows that the transmission is complete, we
3589 * need to set the buffer size to zero.
3591 ret
= lttng_dynamic_buffer_set_size(
3592 &client
->communication
.outbound
.payload
.buffer
, 0);
3599 /* No fds to send, transmission is complete. */
3600 if (fds_to_send_count
== 0) {
3601 status
= CLIENT_TRANSMISSION_STATUS_COMPLETE
;
3605 ret
= lttcomm_send_payload_view_fds_unix_sock_non_block(
3606 client
->socket
, &pv
);
3608 /* Generic error, disable the client's communication. */
3609 ERR("Failed to flush outgoing fds queue, disconnecting client (socket fd = %i)",
3611 client
->communication
.active
= false;
3612 status
= CLIENT_TRANSMISSION_STATUS_FAIL
;
3614 } else if (ret
== 0) {
3615 /* Nothing could be sent. */
3616 status
= CLIENT_TRANSMISSION_STATUS_QUEUED
;
3618 /* Fd passing is an all or nothing kind of thing. */
3619 status
= CLIENT_TRANSMISSION_STATUS_COMPLETE
;
3621 * The payload _fd_array count is used later to
3622 * check if there is notifications queued. So although the
3623 * direct caller knows that the transmission is complete, we
3624 * need to clear the _fd_array for the queuing check.
3626 lttng_dynamic_pointer_array_clear(
3627 &client
->communication
.outbound
.payload
3632 if (status
== CLIENT_TRANSMISSION_STATUS_COMPLETE
) {
3633 client
->communication
.outbound
.queued_command_reply
= false;
3634 client
->communication
.outbound
.dropped_notification
= false;
3635 lttng_payload_clear(&client
->communication
.outbound
.payload
);
3640 return CLIENT_TRANSMISSION_STATUS_ERROR
;
3644 bool client_has_outbound_data_left(
3645 const struct notification_client
*client
)
3647 const struct lttng_payload_view pv
= lttng_payload_view_from_payload(
3648 &client
->communication
.outbound
.payload
, 0, -1);
3649 const bool has_data
= pv
.buffer
.size
!= 0;
3650 const bool has_fds
= lttng_payload_view_get_fd_handle_count(&pv
);
3652 return has_data
|| has_fds
;
3655 /* Client lock must _not_ be held by the caller. */
3657 int client_send_command_reply(struct notification_client
*client
,
3658 struct notification_thread_state
*state
,
3659 enum lttng_notification_channel_status status
)
3662 struct lttng_notification_channel_command_reply reply
= {
3663 .status
= (int8_t) status
,
3665 struct lttng_notification_channel_message msg
= {
3666 .type
= (int8_t) LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_COMMAND_REPLY
,
3667 .size
= sizeof(reply
),
3669 char buffer
[sizeof(msg
) + sizeof(reply
)];
3670 enum client_transmission_status transmission_status
;
3672 memcpy(buffer
, &msg
, sizeof(msg
));
3673 memcpy(buffer
+ sizeof(msg
), &reply
, sizeof(reply
));
3674 DBG("Send command reply (%i)", (int) status
);
3676 pthread_mutex_lock(&client
->lock
);
3677 if (client
->communication
.outbound
.queued_command_reply
) {
3678 /* Protocol error. */
3682 /* Enqueue buffer to outgoing queue and flush it. */
3683 ret
= lttng_dynamic_buffer_append(
3684 &client
->communication
.outbound
.payload
.buffer
,
3685 buffer
, sizeof(buffer
));
3690 transmission_status
= client_flush_outgoing_queue(client
);
3692 if (client_has_outbound_data_left(client
)) {
3693 /* Queue could not be emptied. */
3694 client
->communication
.outbound
.queued_command_reply
= true;
3697 pthread_mutex_unlock(&client
->lock
);
3698 ret
= client_handle_transmission_status(
3699 client
, transmission_status
, state
);
3706 pthread_mutex_unlock(&client
->lock
);
3712 int client_handle_message_unknown(struct notification_client
*client
,
3713 struct notification_thread_state
*state
)
3717 * Receiving message header. The function will be called again
3718 * once the rest of the message as been received and can be
3721 const struct lttng_notification_channel_message
*msg
;
3723 assert(sizeof(*msg
) == client
->communication
.inbound
.payload
.buffer
.size
);
3724 msg
= (const struct lttng_notification_channel_message
*)
3725 client
->communication
.inbound
.payload
.buffer
.data
;
3727 if (msg
->size
== 0 ||
3728 msg
->size
> DEFAULT_MAX_NOTIFICATION_CLIENT_MESSAGE_PAYLOAD_SIZE
) {
3729 ERR("Invalid notification channel message: length = %u",
3735 switch (msg
->type
) {
3736 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_SUBSCRIBE
:
3737 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_UNSUBSCRIBE
:
3738 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_HANDSHAKE
:
3742 ERR("Invalid notification channel message: unexpected message type");
3746 client
->communication
.inbound
.bytes_to_receive
= msg
->size
;
3747 client
->communication
.inbound
.fds_to_receive
= msg
->fds
;
3748 client
->communication
.inbound
.msg_type
=
3749 (enum lttng_notification_channel_message_type
) msg
->type
;
3750 ret
= lttng_dynamic_buffer_set_size(
3751 &client
->communication
.inbound
.payload
.buffer
, msg
->size
);
3753 /* msg is not valid anymore due to lttng_dynamic_buffer_set_size. */
3760 int client_handle_message_handshake(struct notification_client
*client
,
3761 struct notification_thread_state
*state
)
3764 struct lttng_notification_channel_command_handshake
*handshake_client
;
3765 const struct lttng_notification_channel_command_handshake handshake_reply
= {
3766 .major
= LTTNG_NOTIFICATION_CHANNEL_VERSION_MAJOR
,
3767 .minor
= LTTNG_NOTIFICATION_CHANNEL_VERSION_MINOR
,
3769 const struct lttng_notification_channel_message msg_header
= {
3770 .type
= LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_HANDSHAKE
,
3771 .size
= sizeof(handshake_reply
),
3773 enum lttng_notification_channel_status status
=
3774 LTTNG_NOTIFICATION_CHANNEL_STATUS_OK
;
3775 char send_buffer
[sizeof(msg_header
) + sizeof(handshake_reply
)];
3777 memcpy(send_buffer
, &msg_header
, sizeof(msg_header
));
3778 memcpy(send_buffer
+ sizeof(msg_header
), &handshake_reply
,
3779 sizeof(handshake_reply
));
3782 (struct lttng_notification_channel_command_handshake
*)
3783 client
->communication
.inbound
.payload
.buffer
3785 client
->major
= handshake_client
->major
;
3786 client
->minor
= handshake_client
->minor
;
3787 if (!client
->communication
.inbound
.creds_received
) {
3788 ERR("No credentials received from client");
3793 client
->uid
= LTTNG_SOCK_GET_UID_CRED(
3794 &client
->communication
.inbound
.creds
);
3795 client
->gid
= LTTNG_SOCK_GET_GID_CRED(
3796 &client
->communication
.inbound
.creds
);
3797 DBG("Received handshake from client (uid = %u, gid = %u) with version %i.%i",
3798 client
->uid
, client
->gid
, (int) client
->major
,
3799 (int) client
->minor
);
3801 if (handshake_client
->major
!=
3802 LTTNG_NOTIFICATION_CHANNEL_VERSION_MAJOR
) {
3803 status
= LTTNG_NOTIFICATION_CHANNEL_STATUS_UNSUPPORTED_VERSION
;
3806 pthread_mutex_lock(&client
->lock
);
3807 /* Outgoing queue will be flushed when the command reply is sent. */
3808 ret
= lttng_dynamic_buffer_append(
3809 &client
->communication
.outbound
.payload
.buffer
, send_buffer
,
3810 sizeof(send_buffer
));
3812 ERR("Failed to send protocol version to notification channel client");
3816 client
->validated
= true;
3817 client
->communication
.active
= true;
3818 pthread_mutex_unlock(&client
->lock
);
3820 /* Set reception state to receive the next message header. */
3821 ret
= client_reset_inbound_state(client
);
3823 ERR("Failed to reset client communication's inbound state");
3827 /* Flushes the outgoing queue. */
3828 ret
= client_send_command_reply(client
, state
, status
);
3830 ERR("Failed to send reply to notification channel client");
3836 pthread_mutex_unlock(&client
->lock
);
3842 int client_handle_message_subscription(
3843 struct notification_client
*client
,
3844 enum lttng_notification_channel_message_type msg_type
,
3845 struct notification_thread_state
*state
)
3848 struct lttng_condition
*condition
;
3849 enum lttng_notification_channel_status status
=
3850 LTTNG_NOTIFICATION_CHANNEL_STATUS_OK
;
3851 struct lttng_payload_view condition_view
=
3852 lttng_payload_view_from_payload(
3853 &client
->communication
.inbound
.payload
,
3855 size_t expected_condition_size
;
3858 * No need to lock client to sample the inbound state as the only
3859 * other thread accessing clients (action executor) only uses the
3862 expected_condition_size
= client
->communication
.inbound
.payload
.buffer
.size
;
3863 ret
= lttng_condition_create_from_payload(&condition_view
, &condition
);
3864 if (ret
!= expected_condition_size
) {
3865 ERR("Malformed condition received from client");
3869 /* Ownership of condition is always transferred. */
3870 if (msg_type
== LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_SUBSCRIBE
) {
3871 ret
= notification_thread_client_subscribe(
3872 client
, condition
, state
, &status
);
3874 ret
= notification_thread_client_unsubscribe(
3875 client
, condition
, state
, &status
);
3882 /* Set reception state to receive the next message header. */
3883 ret
= client_reset_inbound_state(client
);
3885 ERR("Failed to reset client communication's inbound state");
3889 ret
= client_send_command_reply(client
, state
, status
);
3891 ERR("Failed to send reply to notification channel client");
3900 int client_dispatch_message(struct notification_client
*client
,
3901 struct notification_thread_state
*state
)
3905 if (client
->communication
.inbound
.msg_type
!=
3906 LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_HANDSHAKE
&&
3907 client
->communication
.inbound
.msg_type
!=
3908 LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_UNKNOWN
&&
3909 !client
->validated
) {
3910 WARN("client attempted a command before handshake");
3915 switch (client
->communication
.inbound
.msg_type
) {
3916 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_UNKNOWN
:
3918 ret
= client_handle_message_unknown(client
, state
);
3921 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_HANDSHAKE
:
3923 ret
= client_handle_message_handshake(client
, state
);
3926 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_SUBSCRIBE
:
3927 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_UNSUBSCRIBE
:
3929 ret
= client_handle_message_subscription(client
,
3930 client
->communication
.inbound
.msg_type
, state
);
3940 /* Incoming data from client. */
3941 int handle_notification_thread_client_in(
3942 struct notification_thread_state
*state
, int socket
)
3945 struct notification_client
*client
;
3950 client
= get_client_from_socket(socket
, state
);
3952 /* Internal error, abort. */
3957 if (client
->communication
.inbound
.bytes_to_receive
== 0 &&
3958 client
->communication
.inbound
.fds_to_receive
!= 0) {
3959 /* Only FDs left to receive. */
3963 offset
= client
->communication
.inbound
.payload
.buffer
.size
-
3964 client
->communication
.inbound
.bytes_to_receive
;
3965 if (client
->communication
.inbound
.expect_creds
) {
3966 recv_ret
= lttcomm_recv_creds_unix_sock(socket
,
3967 client
->communication
.inbound
.payload
.buffer
.data
+ offset
,
3968 client
->communication
.inbound
.bytes_to_receive
,
3969 &client
->communication
.inbound
.creds
);
3971 client
->communication
.inbound
.expect_creds
= false;
3972 client
->communication
.inbound
.creds_received
= true;
3975 recv_ret
= lttcomm_recv_unix_sock_non_block(socket
,
3976 client
->communication
.inbound
.payload
.buffer
.data
+ offset
,
3977 client
->communication
.inbound
.bytes_to_receive
);
3979 if (recv_ret
>= 0) {
3980 client
->communication
.inbound
.bytes_to_receive
-= recv_ret
;
3982 goto error_disconnect_client
;
3985 if (client
->communication
.inbound
.bytes_to_receive
!= 0) {
3986 /* Message incomplete wait for more data. */
3992 assert(client
->communication
.inbound
.bytes_to_receive
== 0);
3995 if (client
->communication
.inbound
.fds_to_receive
!= 0) {
3996 ret
= lttcomm_recv_payload_fds_unix_sock_non_block(
3998 client
->communication
.inbound
.fds_to_receive
,
3999 &client
->communication
.inbound
.payload
);
4002 * Fds received. non blocking fds passing is all
4005 ssize_t expected_size
;
4007 expected_size
= sizeof(int) *
4008 client
->communication
.inbound
4010 assert(ret
== expected_size
);
4011 client
->communication
.inbound
.fds_to_receive
= 0;
4012 } else if (ret
== 0) {
4013 /* Received nothing. */
4017 goto error_disconnect_client
;
4021 /* At this point the message is complete.*/
4022 assert(client
->communication
.inbound
.bytes_to_receive
== 0 &&
4023 client
->communication
.inbound
.fds_to_receive
== 0);
4024 ret
= client_dispatch_message(client
, state
);
4027 * Only returns an error if this client must be
4030 goto error_disconnect_client
;
4037 error_disconnect_client
:
4038 ret
= notification_thread_client_disconnect(client
, state
);
4042 /* Client ready to receive outgoing data. */
4043 int handle_notification_thread_client_out(
4044 struct notification_thread_state
*state
, int socket
)
4047 struct notification_client
*client
;
4048 enum client_transmission_status transmission_status
;
4051 client
= get_client_from_socket(socket
, state
);
4053 /* Internal error, abort. */
4058 pthread_mutex_lock(&client
->lock
);
4059 transmission_status
= client_flush_outgoing_queue(client
);
4060 pthread_mutex_unlock(&client
->lock
);
4062 ret
= client_handle_transmission_status(
4063 client
, transmission_status
, state
);
4073 bool evaluate_buffer_usage_condition(const struct lttng_condition
*condition
,
4074 const struct channel_state_sample
*sample
,
4075 uint64_t buffer_capacity
)
4077 bool result
= false;
4079 enum lttng_condition_type condition_type
;
4080 const struct lttng_condition_buffer_usage
*use_condition
= container_of(
4081 condition
, struct lttng_condition_buffer_usage
,
4084 if (use_condition
->threshold_bytes
.set
) {
4085 threshold
= use_condition
->threshold_bytes
.value
;
4088 * Threshold was expressed as a ratio.
4090 * TODO the threshold (in bytes) of conditions expressed
4091 * as a ratio of total buffer size could be cached to
4092 * forego this double-multiplication or it could be performed
4093 * as fixed-point math.
4095 * Note that caching should accommodates the case where the
4096 * condition applies to multiple channels (i.e. don't assume
4097 * that all channels matching my_chann* have the same size...)
4099 threshold
= (uint64_t) (use_condition
->threshold_ratio
.value
*
4100 (double) buffer_capacity
);
4103 condition_type
= lttng_condition_get_type(condition
);
4104 if (condition_type
== LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW
) {
4105 DBG("Low buffer usage condition being evaluated: threshold = %" PRIu64
", highest usage = %" PRIu64
,
4106 threshold
, sample
->highest_usage
);
4109 * The low condition should only be triggered once _all_ of the
4110 * streams in a channel have gone below the "low" threshold.
4112 if (sample
->highest_usage
<= threshold
) {
4116 DBG("High buffer usage condition being evaluated: threshold = %" PRIu64
", highest usage = %" PRIu64
,
4117 threshold
, sample
->highest_usage
);
4120 * For high buffer usage scenarios, we want to trigger whenever
4121 * _any_ of the streams has reached the "high" threshold.
4123 if (sample
->highest_usage
>= threshold
) {
4132 bool evaluate_session_consumed_size_condition(
4133 const struct lttng_condition
*condition
,
4134 uint64_t session_consumed_size
)
4137 const struct lttng_condition_session_consumed_size
*size_condition
=
4138 container_of(condition
,
4139 struct lttng_condition_session_consumed_size
,
4142 threshold
= size_condition
->consumed_threshold_bytes
.value
;
4143 DBG("Session consumed size condition being evaluated: threshold = %" PRIu64
", current size = %" PRIu64
,
4144 threshold
, session_consumed_size
);
4145 return session_consumed_size
>= threshold
;
4149 int evaluate_buffer_condition(const struct lttng_condition
*condition
,
4150 struct lttng_evaluation
**evaluation
,
4151 const struct notification_thread_state
*state
,
4152 const struct channel_state_sample
*previous_sample
,
4153 const struct channel_state_sample
*latest_sample
,
4154 uint64_t previous_session_consumed_total
,
4155 uint64_t latest_session_consumed_total
,
4156 struct channel_info
*channel_info
)
4159 enum lttng_condition_type condition_type
;
4160 const bool previous_sample_available
= !!previous_sample
;
4161 bool previous_sample_result
= false;
4162 bool latest_sample_result
;
4164 condition_type
= lttng_condition_get_type(condition
);
4166 switch (condition_type
) {
4167 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW
:
4168 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH
:
4169 if (caa_likely(previous_sample_available
)) {
4170 previous_sample_result
=
4171 evaluate_buffer_usage_condition(condition
,
4172 previous_sample
, channel_info
->capacity
);
4174 latest_sample_result
= evaluate_buffer_usage_condition(
4175 condition
, latest_sample
,
4176 channel_info
->capacity
);
4178 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE
:
4179 if (caa_likely(previous_sample_available
)) {
4180 previous_sample_result
=
4181 evaluate_session_consumed_size_condition(
4183 previous_session_consumed_total
);
4185 latest_sample_result
=
4186 evaluate_session_consumed_size_condition(
4188 latest_session_consumed_total
);
4191 /* Unknown condition type; internal error. */
4195 if (!latest_sample_result
||
4196 (previous_sample_result
== latest_sample_result
)) {
4198 * Only trigger on a condition evaluation transition.
4200 * NOTE: This edge-triggered logic may not be appropriate for
4201 * future condition types.
4206 if (!evaluation
|| !latest_sample_result
) {
4210 switch (condition_type
) {
4211 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW
:
4212 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH
:
4213 *evaluation
= lttng_evaluation_buffer_usage_create(
4215 latest_sample
->highest_usage
,
4216 channel_info
->capacity
);
4218 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE
:
4219 *evaluation
= lttng_evaluation_session_consumed_size_create(
4220 latest_session_consumed_total
);
4235 int client_notification_overflow(struct notification_client
*client
)
4238 const struct lttng_notification_channel_message msg
= {
4239 .type
= (int8_t) LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_NOTIFICATION_DROPPED
,
4242 ASSERT_LOCKED(client
->lock
);
4244 DBG("Dropping notification addressed to client (socket fd = %i)",
4246 if (client
->communication
.outbound
.dropped_notification
) {
4248 * The client already has a "notification dropped" message
4249 * in its outgoing queue. Nothing to do since all
4250 * of those messages are coalesced.
4255 client
->communication
.outbound
.dropped_notification
= true;
4256 ret
= lttng_dynamic_buffer_append(
4257 &client
->communication
.outbound
.payload
.buffer
, &msg
,
4260 PERROR("Failed to enqueue \"dropped notification\" message in client's (socket fd = %i) outgoing queue",
4267 static int client_handle_transmission_status_wrapper(
4268 struct notification_client
*client
,
4269 enum client_transmission_status status
,
4272 return client_handle_transmission_status(client
, status
,
4273 (struct notification_thread_state
*) user_data
);
4277 int send_evaluation_to_clients(const struct lttng_trigger
*trigger
,
4278 const struct lttng_evaluation
*evaluation
,
4279 struct notification_client_list
* client_list
,
4280 struct notification_thread_state
*state
,
4281 uid_t object_uid
, gid_t object_gid
)
4283 const struct lttng_credentials creds
= {
4284 .uid
= LTTNG_OPTIONAL_INIT_VALUE(object_uid
),
4285 .gid
= LTTNG_OPTIONAL_INIT_VALUE(object_gid
),
4288 return notification_client_list_send_evaluation(client_list
,
4289 trigger
, evaluation
,
4291 client_handle_transmission_status_wrapper
, state
);
4295 * Permission checks relative to notification channel clients are performed
4296 * here. Notice how object, client, and trigger credentials are involved in
4299 * The `object` credentials are the credentials associated with the "subject"
4300 * of a condition. For instance, a `rotation completed` condition applies
4301 * to a session. When that condition is met, it will produce an evaluation
4302 * against a session. Hence, in this case, the `object` credentials are the
4303 * credentials of the "subject" session.
4305 * The `trigger` credentials are the credentials of the user that registered the
4308 * The `client` credentials are the credentials of the user that created a given
4309 * notification channel.
4311 * In terms of visibility, it is expected that non-privilieged users can only
4312 * register triggers against "their" objects (their own sessions and
4313 * applications they are allowed to interact with). They can then open a
4314 * notification channel and subscribe to notifications associated with those
4317 * As for privilieged users, they can register triggers against the objects of
4318 * other users. They can then subscribe to the notifications associated to their
4319 * triggers. Privilieged users _can't_ subscribe to the notifications of
4320 * triggers owned by other users; they must create their own triggers.
4322 * This is more a concern of usability than security. It would be difficult for
4323 * a root user reliably subscribe to a specific set of conditions without
4324 * interference from external users (those could, for instance, unregister
4328 int notification_client_list_send_evaluation(
4329 struct notification_client_list
*client_list
,
4330 const struct lttng_trigger
*trigger
,
4331 const struct lttng_evaluation
*evaluation
,
4332 const struct lttng_credentials
*source_object_creds
,
4333 report_client_transmission_result_cb client_report
,
4337 struct lttng_payload msg_payload
;
4338 struct notification_client_list_element
*client_list_element
, *tmp
;
4339 const struct lttng_notification notification
= {
4340 .trigger
= (struct lttng_trigger
*) trigger
,
4341 .evaluation
= (struct lttng_evaluation
*) evaluation
,
4343 struct lttng_notification_channel_message msg_header
= {
4344 .type
= (int8_t) LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_NOTIFICATION
,
4346 const struct lttng_credentials
*trigger_creds
=
4347 lttng_trigger_get_credentials(trigger
);
4349 lttng_payload_init(&msg_payload
);
4351 ret
= lttng_dynamic_buffer_append(&msg_payload
.buffer
, &msg_header
,
4352 sizeof(msg_header
));
4357 ret
= lttng_notification_serialize(¬ification
, &msg_payload
);
4359 ERR("Failed to serialize notification");
4364 /* Update payload size. */
4365 ((struct lttng_notification_channel_message
*) msg_payload
.buffer
.data
)
4366 ->size
= (uint32_t)(
4367 msg_payload
.buffer
.size
- sizeof(msg_header
));
4369 /* Update the payload number of fds. */
4371 const struct lttng_payload_view pv
= lttng_payload_view_from_payload(
4372 &msg_payload
, 0, -1);
4374 ((struct lttng_notification_channel_message
*)
4375 msg_payload
.buffer
.data
)->fds
= (uint32_t)
4376 lttng_payload_view_get_fd_handle_count(&pv
);
4379 pthread_mutex_lock(&client_list
->lock
);
4380 cds_list_for_each_entry_safe(client_list_element
, tmp
,
4381 &client_list
->clients_list
, node
) {
4382 enum client_transmission_status transmission_status
;
4383 struct notification_client
*client
=
4384 client_list_element
->client
;
4387 pthread_mutex_lock(&client
->lock
);
4388 if (!client
->communication
.active
) {
4390 * Skip inactive client (protocol error or
4393 DBG("Skipping client at it is marked as inactive");
4397 if (source_object_creds
) {
4398 if (client
->uid
!= lttng_credentials_get_uid(source_object_creds
) &&
4399 client
->gid
!= lttng_credentials_get_gid(source_object_creds
) &&
4402 * Client is not allowed to monitor this
4405 DBG("Skipping client at it does not have the object permission to receive notification for this trigger");
4410 if (client
->uid
!= lttng_credentials_get_uid(trigger_creds
)) {
4411 DBG("Skipping client at it does not have the permission to receive notification for this trigger");
4415 DBG("Sending notification to client (fd = %i, %zu bytes)",
4416 client
->socket
, msg_payload
.buffer
.size
);
4418 if (client_has_outbound_data_left(client
)) {
4420 * Outgoing data is already buffered for this client;
4421 * drop the notification and enqueue a "dropped
4422 * notification" message if this is the first dropped
4423 * notification since the socket spilled-over to the
4426 ret
= client_notification_overflow(client
);
4433 ret
= lttng_payload_copy(&msg_payload
, &client
->communication
.outbound
.payload
);
4439 transmission_status
= client_flush_outgoing_queue(client
);
4440 pthread_mutex_unlock(&client
->lock
);
4441 ret
= client_report(client
, transmission_status
, user_data
);
4444 goto end_unlock_list
;
4450 pthread_mutex_unlock(&client
->lock
);
4453 goto end_unlock_list
;
4459 pthread_mutex_unlock(&client_list
->lock
);
4461 lttng_payload_reset(&msg_payload
);
4466 struct lttng_event_notifier_notification
*recv_one_event_notifier_notification(
4467 int notification_pipe_read_fd
, enum lttng_domain_type domain
)
4471 struct lttng_event_notifier_notification
*notification
= NULL
;
4472 char *capture_buffer
= NULL
;
4473 size_t capture_buffer_size
;
4474 void *reception_buffer
;
4475 size_t reception_size
;
4477 struct lttng_ust_abi_event_notifier_notification ust_notification
;
4478 struct lttng_kernel_abi_event_notifier_notification kernel_notification
;
4480 /* Init lttng_event_notifier_notification */
4482 case LTTNG_DOMAIN_UST
:
4483 reception_buffer
= (void *) &ust_notification
;
4484 reception_size
= sizeof(ust_notification
);
4486 case LTTNG_DOMAIN_KERNEL
:
4487 reception_buffer
= (void *) &kernel_notification
;
4488 reception_size
= sizeof(kernel_notification
);
4495 * The monitoring pipe only holds messages smaller than PIPE_BUF,
4496 * ensuring that read/write of tracer notifications are atomic.
4498 ret
= lttng_read(notification_pipe_read_fd
, reception_buffer
,
4500 if (ret
!= reception_size
) {
4501 PERROR("Failed to read from event source notification pipe: fd = %d, size to read = %zu, ret = %d",
4502 notification_pipe_read_fd
, reception_size
, ret
);
4508 case LTTNG_DOMAIN_UST
:
4509 token
= ust_notification
.token
;
4510 capture_buffer_size
= ust_notification
.capture_buf_size
;
4512 case LTTNG_DOMAIN_KERNEL
:
4513 token
= kernel_notification
.token
;
4514 capture_buffer_size
= kernel_notification
.capture_buf_size
;
4520 if (capture_buffer_size
== 0) {
4521 capture_buffer
= NULL
;
4525 if (capture_buffer_size
> MAX_CAPTURE_SIZE
) {
4526 ERR("Event notifier has a capture payload size which exceeds the maximum allowed size: capture_payload_size = %zu bytes, max allowed size = %d bytes",
4527 capture_buffer_size
, MAX_CAPTURE_SIZE
);
4531 capture_buffer
= zmalloc(capture_buffer_size
);
4532 if (!capture_buffer
) {
4533 ERR("Failed to allocate capture buffer");
4537 /* Fetch additional payload (capture). */
4538 ret
= lttng_read(notification_pipe_read_fd
, capture_buffer
, capture_buffer_size
);
4539 if (ret
!= capture_buffer_size
) {
4540 ERR("Failed to read from event source pipe (fd = %i)",
4541 notification_pipe_read_fd
);
4546 notification
= lttng_event_notifier_notification_create(token
, domain
,
4547 capture_buffer
, capture_buffer_size
);
4548 if (notification
== NULL
) {
4553 * Ownership transfered to the lttng_event_notifier_notification object.
4555 capture_buffer
= NULL
;
4558 free(capture_buffer
);
4559 return notification
;
4563 int dispatch_one_event_notifier_notification(struct notification_thread_state
*state
,
4564 struct lttng_event_notifier_notification
*notification
)
4566 struct cds_lfht_node
*node
;
4567 struct cds_lfht_iter iter
;
4568 struct notification_trigger_tokens_ht_element
*element
;
4569 struct lttng_evaluation
*evaluation
= NULL
;
4570 enum action_executor_status executor_status
;
4571 struct notification_client_list
*client_list
= NULL
;
4573 unsigned int capture_count
= 0;
4575 /* Find triggers associated with this token. */
4577 cds_lfht_lookup(state
->trigger_tokens_ht
,
4578 hash_key_u64(¬ification
->tracer_token
, lttng_ht_seed
),
4579 match_trigger_token
, ¬ification
->tracer_token
, &iter
);
4580 node
= cds_lfht_iter_get_node(&iter
);
4581 if (caa_unlikely(!node
)) {
4583 * This is not an error, slow consumption of the tracer
4584 * notifications can lead to situations where a trigger is
4585 * removed but we still get tracer notifications matching a
4586 * trigger that no longer exists.
4592 element
= caa_container_of(node
,
4593 struct notification_trigger_tokens_ht_element
,
4596 if (lttng_condition_event_rule_matches_get_capture_descriptor_count(
4597 lttng_trigger_get_const_condition(element
->trigger
),
4598 &capture_count
) != LTTNG_CONDITION_STATUS_OK
) {
4599 ERR("Failed to get capture count");
4604 if (!notification
->capture_buffer
&& capture_count
!= 0) {
4605 ERR("Expected capture but capture buffer is null");
4610 evaluation
= lttng_evaluation_event_rule_matches_create(
4611 container_of(lttng_trigger_get_const_condition(
4613 struct lttng_condition_event_rule_matches
,
4615 notification
->capture_buffer
,
4616 notification
->capture_buf_size
, false);
4618 if (evaluation
== NULL
) {
4619 ERR("Failed to create event rule matches evaluation while creating and enqueuing action executor job");
4624 client_list
= get_client_list_from_condition(state
,
4625 lttng_trigger_get_const_condition(element
->trigger
));
4626 executor_status
= action_executor_enqueue_trigger(state
->executor
,
4627 element
->trigger
, evaluation
, NULL
, client_list
);
4628 switch (executor_status
) {
4629 case ACTION_EXECUTOR_STATUS_OK
:
4632 case ACTION_EXECUTOR_STATUS_OVERFLOW
:
4634 struct notification_client_list_element
*client_list_element
,
4638 * Not a fatal error; this is expected and simply means the
4639 * executor has too much work queued already.
4643 /* No clients subscribed to notifications for this trigger. */
4648 /* Warn clients that a notification (or more) was dropped. */
4649 pthread_mutex_lock(&client_list
->lock
);
4650 cds_list_for_each_entry_safe(client_list_element
, tmp
,
4651 &client_list
->clients_list
, node
) {
4652 enum client_transmission_status transmission_status
;
4653 struct notification_client
*client
=
4654 client_list_element
->client
;
4656 pthread_mutex_lock(&client
->lock
);
4657 ret
= client_notification_overflow(client
);
4663 transmission_status
=
4664 client_flush_outgoing_queue(client
);
4665 ret
= client_handle_transmission_status(
4666 client
, transmission_status
, state
);
4672 pthread_mutex_unlock(&client
->lock
);
4678 pthread_mutex_unlock(&client_list
->lock
);
4681 case ACTION_EXECUTOR_STATUS_INVALID
:
4682 case ACTION_EXECUTOR_STATUS_ERROR
:
4683 /* Fatal error, shut down everything. */
4684 ERR("Fatal error encoutered while enqueuing action to the action executor");
4688 /* Unhandled error. */
4693 notification_client_list_put(client_list
);
4700 int handle_one_event_notifier_notification(
4701 struct notification_thread_state
*state
,
4702 int pipe
, enum lttng_domain_type domain
)
4705 struct lttng_event_notifier_notification
*notification
= NULL
;
4707 notification
= recv_one_event_notifier_notification(pipe
, domain
);
4708 if (notification
== NULL
) {
4709 /* Reception failed, don't consider it fatal. */
4710 ERR("Error receiving an event notifier notification from tracer: fd = %i, domain = %s",
4711 pipe
, lttng_domain_type_str(domain
));
4715 ret
= dispatch_one_event_notifier_notification(state
, notification
);
4717 ERR("Error dispatching an event notifier notification from tracer: fd = %i, domain = %s",
4718 pipe
, lttng_domain_type_str(domain
));
4723 lttng_event_notifier_notification_destroy(notification
);
4727 int handle_notification_thread_event_notification(struct notification_thread_state
*state
,
4728 int pipe
, enum lttng_domain_type domain
)
4730 return handle_one_event_notifier_notification(state
, pipe
, domain
);
4733 int handle_notification_thread_channel_sample(
4734 struct notification_thread_state
*state
, int pipe
,
4735 enum lttng_domain_type domain
)
4738 struct lttcomm_consumer_channel_monitor_msg sample_msg
;
4739 struct channel_info
*channel_info
;
4740 struct cds_lfht_node
*node
;
4741 struct cds_lfht_iter iter
;
4742 struct lttng_channel_trigger_list
*trigger_list
;
4743 struct lttng_trigger_list_element
*trigger_list_element
;
4744 bool previous_sample_available
= false;
4745 struct channel_state_sample previous_sample
, latest_sample
;
4746 uint64_t previous_session_consumed_total
, latest_session_consumed_total
;
4747 struct lttng_credentials channel_creds
;
4750 * The monitoring pipe only holds messages smaller than PIPE_BUF,
4751 * ensuring that read/write of sampling messages are atomic.
4753 ret
= lttng_read(pipe
, &sample_msg
, sizeof(sample_msg
));
4754 if (ret
!= sizeof(sample_msg
)) {
4755 ERR("Failed to read from monitoring pipe (fd = %i)",
4762 latest_sample
.key
.key
= sample_msg
.key
;
4763 latest_sample
.key
.domain
= domain
;
4764 latest_sample
.highest_usage
= sample_msg
.highest
;
4765 latest_sample
.lowest_usage
= sample_msg
.lowest
;
4766 latest_sample
.channel_total_consumed
= sample_msg
.total_consumed
;
4770 /* Retrieve the channel's informations */
4771 cds_lfht_lookup(state
->channels_ht
,
4772 hash_channel_key(&latest_sample
.key
),
4776 node
= cds_lfht_iter_get_node(&iter
);
4777 if (caa_unlikely(!node
)) {
4779 * Not an error since the consumer can push a sample to the pipe
4780 * and the rest of the session daemon could notify us of the
4781 * channel's destruction before we get a chance to process that
4784 DBG("Received a sample for an unknown channel from consumerd, key = %" PRIu64
" in %s domain",
4785 latest_sample
.key
.key
,
4786 lttng_domain_type_str(domain
));
4789 channel_info
= caa_container_of(node
, struct channel_info
,
4791 DBG("Handling channel sample for channel %s (key = %" PRIu64
") in session %s (highest usage = %" PRIu64
", lowest usage = %" PRIu64
", total consumed = %" PRIu64
")",
4793 latest_sample
.key
.key
,
4794 channel_info
->session_info
->name
,
4795 latest_sample
.highest_usage
,
4796 latest_sample
.lowest_usage
,
4797 latest_sample
.channel_total_consumed
);
4799 previous_session_consumed_total
=
4800 channel_info
->session_info
->consumed_data_size
;
4802 /* Retrieve the channel's last sample, if it exists, and update it. */
4803 cds_lfht_lookup(state
->channel_state_ht
,
4804 hash_channel_key(&latest_sample
.key
),
4805 match_channel_state_sample
,
4808 node
= cds_lfht_iter_get_node(&iter
);
4809 if (caa_likely(node
)) {
4810 struct channel_state_sample
*stored_sample
;
4812 /* Update the sample stored. */
4813 stored_sample
= caa_container_of(node
,
4814 struct channel_state_sample
,
4815 channel_state_ht_node
);
4817 memcpy(&previous_sample
, stored_sample
,
4818 sizeof(previous_sample
));
4819 stored_sample
->highest_usage
= latest_sample
.highest_usage
;
4820 stored_sample
->lowest_usage
= latest_sample
.lowest_usage
;
4821 stored_sample
->channel_total_consumed
= latest_sample
.channel_total_consumed
;
4822 previous_sample_available
= true;
4824 latest_session_consumed_total
=
4825 previous_session_consumed_total
+
4826 (latest_sample
.channel_total_consumed
- previous_sample
.channel_total_consumed
);
4829 * This is the channel's first sample, allocate space for and
4830 * store the new sample.
4832 struct channel_state_sample
*stored_sample
;
4834 stored_sample
= zmalloc(sizeof(*stored_sample
));
4835 if (!stored_sample
) {
4840 memcpy(stored_sample
, &latest_sample
, sizeof(*stored_sample
));
4841 cds_lfht_node_init(&stored_sample
->channel_state_ht_node
);
4842 cds_lfht_add(state
->channel_state_ht
,
4843 hash_channel_key(&stored_sample
->key
),
4844 &stored_sample
->channel_state_ht_node
);
4846 latest_session_consumed_total
=
4847 previous_session_consumed_total
+
4848 latest_sample
.channel_total_consumed
;
4851 channel_info
->session_info
->consumed_data_size
=
4852 latest_session_consumed_total
;
4854 /* Find triggers associated with this channel. */
4855 cds_lfht_lookup(state
->channel_triggers_ht
,
4856 hash_channel_key(&latest_sample
.key
),
4857 match_channel_trigger_list
,
4860 node
= cds_lfht_iter_get_node(&iter
);
4861 if (caa_likely(!node
)) {
4865 channel_creds
= (typeof(channel_creds
)) {
4866 .uid
= LTTNG_OPTIONAL_INIT_VALUE(channel_info
->session_info
->uid
),
4867 .gid
= LTTNG_OPTIONAL_INIT_VALUE(channel_info
->session_info
->gid
),
4870 trigger_list
= caa_container_of(node
, struct lttng_channel_trigger_list
,
4871 channel_triggers_ht_node
);
4872 cds_list_for_each_entry(trigger_list_element
, &trigger_list
->list
,
4874 const struct lttng_condition
*condition
;
4875 struct lttng_trigger
*trigger
;
4876 struct notification_client_list
*client_list
= NULL
;
4877 struct lttng_evaluation
*evaluation
= NULL
;
4878 enum action_executor_status executor_status
;
4881 trigger
= trigger_list_element
->trigger
;
4882 condition
= lttng_trigger_get_const_condition(trigger
);
4886 * Check if any client is subscribed to the result of this
4889 client_list
= get_client_list_from_condition(state
, condition
);
4891 ret
= evaluate_buffer_condition(condition
, &evaluation
, state
,
4892 previous_sample_available
? &previous_sample
: NULL
,
4894 previous_session_consumed_total
,
4895 latest_session_consumed_total
,
4897 if (caa_unlikely(ret
)) {
4901 if (caa_likely(!evaluation
)) {
4906 * Ownership of `evaluation` transferred to the action executor
4907 * no matter the result.
4909 executor_status
= action_executor_enqueue_trigger(
4910 state
->executor
, trigger
, evaluation
,
4911 &channel_creds
, client_list
);
4913 switch (executor_status
) {
4914 case ACTION_EXECUTOR_STATUS_OK
:
4916 case ACTION_EXECUTOR_STATUS_ERROR
:
4917 case ACTION_EXECUTOR_STATUS_INVALID
:
4919 * TODO Add trigger identification (name/id) when
4920 * it is added to the API.
4922 ERR("Fatal error occurred while enqueuing action associated with buffer-condition trigger");
4925 case ACTION_EXECUTOR_STATUS_OVERFLOW
:
4927 * TODO Add trigger identification (name/id) when
4928 * it is added to the API.
4930 * Not a fatal error.
4932 WARN("No space left when enqueuing action associated with buffer-condition trigger");
4940 notification_client_list_put(client_list
);
4941 if (caa_unlikely(ret
)) {