2 * Copyright (C) 2017 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License, version 2 only, as
6 * published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 51
15 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 #include <urcu/rculfhash.h>
22 #include <common/defaults.h>
23 #include <common/error.h>
24 #include <common/futex.h>
25 #include <common/unix.h>
26 #include <common/dynamic-buffer.h>
27 #include <common/hashtable/utils.h>
28 #include <common/sessiond-comm/sessiond-comm.h>
29 #include <common/macros.h>
30 #include <lttng/condition/condition.h>
31 #include <lttng/action/action-internal.h>
32 #include <lttng/notification/notification-internal.h>
33 #include <lttng/condition/condition-internal.h>
34 #include <lttng/condition/buffer-usage-internal.h>
35 #include <lttng/condition/session-consumed-size-internal.h>
36 #include <lttng/condition/session-rotation-internal.h>
37 #include <lttng/notification/channel-internal.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 enum lttng_object_type
{
55 LTTNG_OBJECT_TYPE_UNKNOWN
,
56 LTTNG_OBJECT_TYPE_NONE
,
57 LTTNG_OBJECT_TYPE_CHANNEL
,
58 LTTNG_OBJECT_TYPE_SESSION
,
61 struct lttng_trigger_list_element
{
62 /* No ownership of the trigger object is assumed. */
63 const struct lttng_trigger
*trigger
;
64 struct cds_list_head node
;
67 struct lttng_channel_trigger_list
{
68 struct channel_key channel_key
;
69 /* List of struct lttng_trigger_list_element. */
70 struct cds_list_head list
;
71 /* Node in the channel_triggers_ht */
72 struct cds_lfht_node channel_triggers_ht_node
;
73 /* call_rcu delayed reclaim. */
74 struct rcu_head rcu_node
;
78 * List of triggers applying to a given session.
81 * - lttng_session_trigger_list_create()
82 * - lttng_session_trigger_list_build()
83 * - lttng_session_trigger_list_destroy()
84 * - lttng_session_trigger_list_add()
86 struct lttng_session_trigger_list
{
88 * Not owned by this; points to the session_info structure's
91 const char *session_name
;
92 /* List of struct lttng_trigger_list_element. */
93 struct cds_list_head list
;
94 /* Node in the session_triggers_ht */
95 struct cds_lfht_node session_triggers_ht_node
;
97 * Weak reference to the notification system's session triggers
100 * The session trigger list structure structure is owned by
101 * the session's session_info.
103 * The session_info is kept alive the the channel_infos holding a
104 * reference to it (reference counting). When those channels are
105 * destroyed (at runtime or on teardown), the reference they hold
106 * to the session_info are released. On destruction of session_info,
107 * session_info_destroy() will remove the list of triggers applying
108 * to this session from the notification system's state.
110 * This implies that the session_triggers_ht must be destroyed
111 * after the channels.
113 struct cds_lfht
*session_triggers_ht
;
114 /* Used for delayed RCU reclaim. */
115 struct rcu_head rcu_node
;
118 struct lttng_trigger_ht_element
{
119 struct lttng_trigger
*trigger
;
120 struct cds_lfht_node node
;
121 /* call_rcu delayed reclaim. */
122 struct rcu_head rcu_node
;
125 struct lttng_condition_list_element
{
126 struct lttng_condition
*condition
;
127 struct cds_list_head node
;
130 struct notification_client_list_element
{
131 struct notification_client
*client
;
132 struct cds_list_head node
;
135 struct notification_client_list
{
136 const struct lttng_trigger
*trigger
;
137 struct cds_list_head list
;
138 struct cds_lfht_node notification_trigger_ht_node
;
139 /* call_rcu delayed reclaim. */
140 struct rcu_head rcu_node
;
143 struct notification_client
{
145 /* Client protocol version. */
146 uint8_t major
, minor
;
150 * Indicates if the credentials and versions of the client have been
155 * Conditions to which the client's notification channel is subscribed.
156 * List of struct lttng_condition_list_node. The condition member is
157 * owned by the client.
159 struct cds_list_head condition_list
;
160 struct cds_lfht_node client_socket_ht_node
;
164 * During the reception of a message, the reception
165 * buffers' "size" is set to contain the current
166 * message's complete payload.
168 struct lttng_dynamic_buffer buffer
;
169 /* Bytes left to receive for the current message. */
170 size_t bytes_to_receive
;
171 /* Type of the message being received. */
172 enum lttng_notification_channel_message_type msg_type
;
174 * Indicates whether or not credentials are expected
179 * Indicates whether or not credentials were received
183 /* Only used during credentials reception. */
184 lttng_sock_cred creds
;
188 * Indicates whether or not a notification addressed to
189 * this client was dropped because a command reply was
192 * A notification is dropped whenever the buffer is not
195 bool dropped_notification
;
197 * Indicates whether or not a command reply is already
198 * buffered. In this case, it means that the client is
199 * not consuming command replies before emitting a new
200 * one. This could be caused by a protocol error or a
201 * misbehaving/malicious client.
203 bool queued_command_reply
;
204 struct lttng_dynamic_buffer buffer
;
207 /* call_rcu delayed reclaim. */
208 struct rcu_head rcu_node
;
211 struct channel_state_sample
{
212 struct channel_key key
;
213 struct cds_lfht_node channel_state_ht_node
;
214 uint64_t highest_usage
;
215 uint64_t lowest_usage
;
216 uint64_t channel_total_consumed
;
217 /* call_rcu delayed reclaim. */
218 struct rcu_head rcu_node
;
221 static unsigned long hash_channel_key(struct channel_key
*key
);
222 static int evaluate_buffer_condition(const struct lttng_condition
*condition
,
223 struct lttng_evaluation
**evaluation
,
224 const struct notification_thread_state
*state
,
225 const struct channel_state_sample
*previous_sample
,
226 const struct channel_state_sample
*latest_sample
,
227 uint64_t previous_session_consumed_total
,
228 uint64_t latest_session_consumed_total
,
229 struct channel_info
*channel_info
);
231 int send_evaluation_to_clients(const struct lttng_trigger
*trigger
,
232 const struct lttng_evaluation
*evaluation
,
233 struct notification_client_list
*client_list
,
234 struct notification_thread_state
*state
,
235 uid_t channel_uid
, gid_t channel_gid
);
238 /* session_info API */
240 void session_info_destroy(void *_data
);
242 void session_info_get(struct session_info
*session_info
);
244 void session_info_put(struct session_info
*session_info
);
246 struct session_info
*session_info_create(const char *name
,
247 uid_t uid
, gid_t gid
,
248 struct lttng_session_trigger_list
*trigger_list
,
249 struct cds_lfht
*sessions_ht
);
251 void session_info_add_channel(struct session_info
*session_info
,
252 struct channel_info
*channel_info
);
254 void session_info_remove_channel(struct session_info
*session_info
,
255 struct channel_info
*channel_info
);
257 /* lttng_session_trigger_list API */
259 struct lttng_session_trigger_list
*lttng_session_trigger_list_create(
260 const char *session_name
,
261 struct cds_lfht
*session_triggers_ht
);
263 struct lttng_session_trigger_list
*lttng_session_trigger_list_build(
264 const struct notification_thread_state
*state
,
265 const char *session_name
);
267 void lttng_session_trigger_list_destroy(
268 struct lttng_session_trigger_list
*list
);
270 int lttng_session_trigger_list_add(struct lttng_session_trigger_list
*list
,
271 const struct lttng_trigger
*trigger
);
275 int match_client(struct cds_lfht_node
*node
, const void *key
)
277 /* This double-cast is intended to supress pointer-to-cast warning. */
278 int socket
= (int) (intptr_t) key
;
279 struct notification_client
*client
;
281 client
= caa_container_of(node
, struct notification_client
,
282 client_socket_ht_node
);
284 return !!(client
->socket
== socket
);
288 int match_channel_trigger_list(struct cds_lfht_node
*node
, const void *key
)
290 struct channel_key
*channel_key
= (struct channel_key
*) key
;
291 struct lttng_channel_trigger_list
*trigger_list
;
293 trigger_list
= caa_container_of(node
, struct lttng_channel_trigger_list
,
294 channel_triggers_ht_node
);
296 return !!((channel_key
->key
== trigger_list
->channel_key
.key
) &&
297 (channel_key
->domain
== trigger_list
->channel_key
.domain
));
301 int match_session_trigger_list(struct cds_lfht_node
*node
, const void *key
)
303 const char *session_name
= (const char *) key
;
304 struct lttng_session_trigger_list
*trigger_list
;
306 trigger_list
= caa_container_of(node
, struct lttng_session_trigger_list
,
307 session_triggers_ht_node
);
309 return !!(strcmp(trigger_list
->session_name
, session_name
) == 0);
313 int match_channel_state_sample(struct cds_lfht_node
*node
, const void *key
)
315 struct channel_key
*channel_key
= (struct channel_key
*) key
;
316 struct channel_state_sample
*sample
;
318 sample
= caa_container_of(node
, struct channel_state_sample
,
319 channel_state_ht_node
);
321 return !!((channel_key
->key
== sample
->key
.key
) &&
322 (channel_key
->domain
== sample
->key
.domain
));
326 int match_channel_info(struct cds_lfht_node
*node
, const void *key
)
328 struct channel_key
*channel_key
= (struct channel_key
*) key
;
329 struct channel_info
*channel_info
;
331 channel_info
= caa_container_of(node
, struct channel_info
,
334 return !!((channel_key
->key
== channel_info
->key
.key
) &&
335 (channel_key
->domain
== channel_info
->key
.domain
));
339 int match_condition(struct cds_lfht_node
*node
, const void *key
)
341 struct lttng_condition
*condition_key
= (struct lttng_condition
*) key
;
342 struct lttng_trigger_ht_element
*trigger
;
343 struct lttng_condition
*condition
;
345 trigger
= caa_container_of(node
, struct lttng_trigger_ht_element
,
347 condition
= lttng_trigger_get_condition(trigger
->trigger
);
350 return !!lttng_condition_is_equal(condition_key
, condition
);
354 int match_client_list_condition(struct cds_lfht_node
*node
, const void *key
)
356 struct lttng_condition
*condition_key
= (struct lttng_condition
*) key
;
357 struct notification_client_list
*client_list
;
358 const struct lttng_condition
*condition
;
360 assert(condition_key
);
362 client_list
= caa_container_of(node
, struct notification_client_list
,
363 notification_trigger_ht_node
);
364 condition
= lttng_trigger_get_const_condition(client_list
->trigger
);
366 return !!lttng_condition_is_equal(condition_key
, condition
);
370 int match_session(struct cds_lfht_node
*node
, const void *key
)
372 const char *name
= key
;
373 struct session_info
*session_info
= caa_container_of(
374 node
, struct session_info
, sessions_ht_node
);
376 return !strcmp(session_info
->name
, name
);
380 unsigned long lttng_condition_buffer_usage_hash(
381 const struct lttng_condition
*_condition
)
384 unsigned long condition_type
;
385 struct lttng_condition_buffer_usage
*condition
;
387 condition
= container_of(_condition
,
388 struct lttng_condition_buffer_usage
, parent
);
390 condition_type
= (unsigned long) condition
->parent
.type
;
391 hash
= hash_key_ulong((void *) condition_type
, lttng_ht_seed
);
392 if (condition
->session_name
) {
393 hash
^= hash_key_str(condition
->session_name
, lttng_ht_seed
);
395 if (condition
->channel_name
) {
396 hash
^= hash_key_str(condition
->channel_name
, lttng_ht_seed
);
398 if (condition
->domain
.set
) {
399 hash
^= hash_key_ulong(
400 (void *) condition
->domain
.type
,
403 if (condition
->threshold_ratio
.set
) {
406 val
= condition
->threshold_ratio
.value
* (double) UINT32_MAX
;
407 hash
^= hash_key_u64(&val
, lttng_ht_seed
);
408 } else if (condition
->threshold_bytes
.set
) {
411 val
= condition
->threshold_bytes
.value
;
412 hash
^= hash_key_u64(&val
, lttng_ht_seed
);
418 unsigned long lttng_condition_session_consumed_size_hash(
419 const struct lttng_condition
*_condition
)
422 unsigned long condition_type
=
423 (unsigned long) LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE
;
424 struct lttng_condition_session_consumed_size
*condition
;
427 condition
= container_of(_condition
,
428 struct lttng_condition_session_consumed_size
, parent
);
430 hash
= hash_key_ulong((void *) condition_type
, lttng_ht_seed
);
431 if (condition
->session_name
) {
432 hash
^= hash_key_str(condition
->session_name
, lttng_ht_seed
);
434 val
= condition
->consumed_threshold_bytes
.value
;
435 hash
^= hash_key_u64(&val
, lttng_ht_seed
);
440 unsigned long lttng_condition_session_rotation_hash(
441 const struct lttng_condition
*_condition
)
443 unsigned long hash
, condition_type
;
444 struct lttng_condition_session_rotation
*condition
;
446 condition
= container_of(_condition
,
447 struct lttng_condition_session_rotation
, parent
);
448 condition_type
= (unsigned long) condition
->parent
.type
;
449 hash
= hash_key_ulong((void *) condition_type
, lttng_ht_seed
);
450 assert(condition
->session_name
);
451 hash
^= hash_key_str(condition
->session_name
, lttng_ht_seed
);
456 * The lttng_condition hashing code is kept in this file (rather than
457 * condition.c) since it makes use of GPLv2 code (hashtable utils), which we
458 * don't want to link in liblttng-ctl.
461 unsigned long lttng_condition_hash(const struct lttng_condition
*condition
)
463 switch (condition
->type
) {
464 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW
:
465 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH
:
466 return lttng_condition_buffer_usage_hash(condition
);
467 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE
:
468 return lttng_condition_session_consumed_size_hash(condition
);
469 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
:
470 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED
:
471 return lttng_condition_session_rotation_hash(condition
);
473 ERR("[notification-thread] Unexpected condition type caught");
479 unsigned long hash_channel_key(struct channel_key
*key
)
481 unsigned long key_hash
= hash_key_u64(&key
->key
, lttng_ht_seed
);
482 unsigned long domain_hash
= hash_key_ulong(
483 (void *) (unsigned long) key
->domain
, lttng_ht_seed
);
485 return key_hash
^ domain_hash
;
489 * Get the type of object to which a given condition applies. Bindings let
490 * the notification system evaluate a trigger's condition when a given
491 * object's state is updated.
493 * For instance, a condition bound to a channel will be evaluated everytime
494 * the channel's state is changed by a channel monitoring sample.
497 enum lttng_object_type
get_condition_binding_object(
498 const struct lttng_condition
*condition
)
500 switch (lttng_condition_get_type(condition
)) {
501 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW
:
502 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH
:
503 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE
:
504 return LTTNG_OBJECT_TYPE_CHANNEL
;
505 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
:
506 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED
:
507 return LTTNG_OBJECT_TYPE_SESSION
;
509 return LTTNG_OBJECT_TYPE_UNKNOWN
;
514 void free_channel_info_rcu(struct rcu_head
*node
)
516 free(caa_container_of(node
, struct channel_info
, rcu_node
));
520 void channel_info_destroy(struct channel_info
*channel_info
)
526 if (channel_info
->session_info
) {
527 session_info_remove_channel(channel_info
->session_info
,
529 session_info_put(channel_info
->session_info
);
531 if (channel_info
->name
) {
532 free(channel_info
->name
);
534 call_rcu(&channel_info
->rcu_node
, free_channel_info_rcu
);
538 void free_session_info_rcu(struct rcu_head
*node
)
540 free(caa_container_of(node
, struct session_info
, rcu_node
));
543 /* Don't call directly, use the ref-counting mechanism. */
545 void session_info_destroy(void *_data
)
547 struct session_info
*session_info
= _data
;
550 assert(session_info
);
551 if (session_info
->channel_infos_ht
) {
552 ret
= cds_lfht_destroy(session_info
->channel_infos_ht
, NULL
);
554 ERR("[notification-thread] Failed to destroy channel information hash table");
557 lttng_session_trigger_list_destroy(session_info
->trigger_list
);
560 cds_lfht_del(session_info
->sessions_ht
,
561 &session_info
->sessions_ht_node
);
563 free(session_info
->name
);
564 call_rcu(&session_info
->rcu_node
, free_session_info_rcu
);
568 void session_info_get(struct session_info
*session_info
)
573 lttng_ref_get(&session_info
->ref
);
577 void session_info_put(struct session_info
*session_info
)
582 lttng_ref_put(&session_info
->ref
);
586 struct session_info
*session_info_create(const char *name
, uid_t uid
, gid_t gid
,
587 struct lttng_session_trigger_list
*trigger_list
,
588 struct cds_lfht
*sessions_ht
)
590 struct session_info
*session_info
;
594 session_info
= zmalloc(sizeof(*session_info
));
598 lttng_ref_init(&session_info
->ref
, session_info_destroy
);
600 session_info
->channel_infos_ht
= cds_lfht_new(DEFAULT_HT_SIZE
,
601 1, 0, CDS_LFHT_AUTO_RESIZE
| CDS_LFHT_ACCOUNTING
, NULL
);
602 if (!session_info
->channel_infos_ht
) {
606 cds_lfht_node_init(&session_info
->sessions_ht_node
);
607 session_info
->name
= strdup(name
);
608 if (!session_info
->name
) {
611 session_info
->uid
= uid
;
612 session_info
->gid
= gid
;
613 session_info
->trigger_list
= trigger_list
;
614 session_info
->sessions_ht
= sessions_ht
;
618 session_info_put(session_info
);
623 void session_info_add_channel(struct session_info
*session_info
,
624 struct channel_info
*channel_info
)
627 cds_lfht_add(session_info
->channel_infos_ht
,
628 hash_channel_key(&channel_info
->key
),
629 &channel_info
->session_info_channels_ht_node
);
634 void session_info_remove_channel(struct session_info
*session_info
,
635 struct channel_info
*channel_info
)
638 cds_lfht_del(session_info
->channel_infos_ht
,
639 &channel_info
->session_info_channels_ht_node
);
644 struct channel_info
*channel_info_create(const char *channel_name
,
645 struct channel_key
*channel_key
, uint64_t channel_capacity
,
646 struct session_info
*session_info
)
648 struct channel_info
*channel_info
= zmalloc(sizeof(*channel_info
));
654 cds_lfht_node_init(&channel_info
->channels_ht_node
);
655 cds_lfht_node_init(&channel_info
->session_info_channels_ht_node
);
656 memcpy(&channel_info
->key
, channel_key
, sizeof(*channel_key
));
657 channel_info
->capacity
= channel_capacity
;
659 channel_info
->name
= strdup(channel_name
);
660 if (!channel_info
->name
) {
665 * Set the references between session and channel infos:
666 * - channel_info holds a strong reference to session_info
667 * - session_info holds a weak reference to channel_info
669 session_info_get(session_info
);
670 session_info_add_channel(session_info
, channel_info
);
671 channel_info
->session_info
= session_info
;
675 channel_info_destroy(channel_info
);
679 /* RCU read lock must be held by the caller. */
681 struct notification_client_list
*get_client_list_from_condition(
682 struct notification_thread_state
*state
,
683 const struct lttng_condition
*condition
)
685 struct cds_lfht_node
*node
;
686 struct cds_lfht_iter iter
;
688 cds_lfht_lookup(state
->notification_trigger_clients_ht
,
689 lttng_condition_hash(condition
),
690 match_client_list_condition
,
693 node
= cds_lfht_iter_get_node(&iter
);
695 return node
? caa_container_of(node
,
696 struct notification_client_list
,
697 notification_trigger_ht_node
) : NULL
;
700 /* This function must be called with the RCU read lock held. */
702 int evaluate_channel_condition_for_client(
703 const struct lttng_condition
*condition
,
704 struct notification_thread_state
*state
,
705 struct lttng_evaluation
**evaluation
,
706 uid_t
*session_uid
, gid_t
*session_gid
)
709 struct cds_lfht_iter iter
;
710 struct cds_lfht_node
*node
;
711 struct channel_info
*channel_info
= NULL
;
712 struct channel_key
*channel_key
= NULL
;
713 struct channel_state_sample
*last_sample
= NULL
;
714 struct lttng_channel_trigger_list
*channel_trigger_list
= NULL
;
716 /* Find the channel associated with the condition. */
717 cds_lfht_for_each_entry(state
->channel_triggers_ht
, &iter
,
718 channel_trigger_list
, channel_triggers_ht_node
) {
719 struct lttng_trigger_list_element
*element
;
721 cds_list_for_each_entry(element
, &channel_trigger_list
->list
, node
) {
722 const struct lttng_condition
*current_condition
=
723 lttng_trigger_get_const_condition(
726 assert(current_condition
);
727 if (!lttng_condition_is_equal(condition
,
728 current_condition
)) {
732 /* Found the trigger, save the channel key. */
733 channel_key
= &channel_trigger_list
->channel_key
;
737 /* The channel key was found stop iteration. */
743 /* No channel found; normal exit. */
744 DBG("[notification-thread] No known channel associated with newly subscribed-to condition");
749 /* Fetch channel info for the matching channel. */
750 cds_lfht_lookup(state
->channels_ht
,
751 hash_channel_key(channel_key
),
755 node
= cds_lfht_iter_get_node(&iter
);
757 channel_info
= caa_container_of(node
, struct channel_info
,
760 /* Retrieve the channel's last sample, if it exists. */
761 cds_lfht_lookup(state
->channel_state_ht
,
762 hash_channel_key(channel_key
),
763 match_channel_state_sample
,
766 node
= cds_lfht_iter_get_node(&iter
);
768 last_sample
= caa_container_of(node
,
769 struct channel_state_sample
,
770 channel_state_ht_node
);
772 /* Nothing to evaluate, no sample was ever taken. Normal exit */
773 DBG("[notification-thread] No channel sample associated with newly subscribed-to condition");
778 ret
= evaluate_buffer_condition(condition
, evaluation
, state
,
780 0, channel_info
->session_info
->consumed_data_size
,
783 WARN("[notification-thread] Fatal error occurred while evaluating a newly subscribed-to condition");
787 *session_uid
= channel_info
->session_info
->uid
;
788 *session_gid
= channel_info
->session_info
->gid
;
794 const char *get_condition_session_name(const struct lttng_condition
*condition
)
796 const char *session_name
= NULL
;
797 enum lttng_condition_status status
;
799 switch (lttng_condition_get_type(condition
)) {
800 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW
:
801 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH
:
802 status
= lttng_condition_buffer_usage_get_session_name(
803 condition
, &session_name
);
805 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE
:
806 status
= lttng_condition_session_consumed_size_get_session_name(
807 condition
, &session_name
);
809 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
:
810 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED
:
811 status
= lttng_condition_session_rotation_get_session_name(
812 condition
, &session_name
);
817 if (status
!= LTTNG_CONDITION_STATUS_OK
) {
818 ERR("[notification-thread] Failed to retrieve session rotation condition's session name");
825 /* This function must be called with the RCU read lock held. */
827 int evaluate_session_condition_for_client(
828 const struct lttng_condition
*condition
,
829 struct notification_thread_state
*state
,
830 struct lttng_evaluation
**evaluation
,
831 uid_t
*session_uid
, gid_t
*session_gid
)
834 struct cds_lfht_iter iter
;
835 struct cds_lfht_node
*node
;
836 const char *session_name
;
837 struct session_info
*session_info
= NULL
;
839 session_name
= get_condition_session_name(condition
);
841 /* Find the session associated with the trigger. */
842 cds_lfht_lookup(state
->sessions_ht
,
843 hash_key_str(session_name
, lttng_ht_seed
),
847 node
= cds_lfht_iter_get_node(&iter
);
849 DBG("[notification-thread] No known session matching name \"%s\"",
855 session_info
= caa_container_of(node
, struct session_info
,
857 session_info_get(session_info
);
860 * Evaluation is performed in-line here since only one type of
861 * session-bound condition is handled for the moment.
863 switch (lttng_condition_get_type(condition
)) {
864 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
:
865 if (!session_info
->rotation
.ongoing
) {
867 goto end_session_put
;
870 *evaluation
= lttng_evaluation_session_rotation_ongoing_create(
871 session_info
->rotation
.id
);
874 ERR("[notification-thread] Failed to create session rotation ongoing evaluation for session \"%s\"",
877 goto end_session_put
;
883 goto end_session_put
;
886 *session_uid
= session_info
->uid
;
887 *session_gid
= session_info
->gid
;
890 session_info_put(session_info
);
895 /* This function must be called with the RCU read lock held. */
897 int evaluate_condition_for_client(const struct lttng_trigger
*trigger
,
898 const struct lttng_condition
*condition
,
899 struct notification_client
*client
,
900 struct notification_thread_state
*state
)
903 struct lttng_evaluation
*evaluation
= NULL
;
904 struct notification_client_list client_list
= { 0 };
905 struct notification_client_list_element client_list_element
= { 0 };
906 uid_t object_uid
= 0;
907 gid_t object_gid
= 0;
914 switch (get_condition_binding_object(condition
)) {
915 case LTTNG_OBJECT_TYPE_SESSION
:
916 ret
= evaluate_session_condition_for_client(condition
, state
,
917 &evaluation
, &object_uid
, &object_gid
);
919 case LTTNG_OBJECT_TYPE_CHANNEL
:
920 ret
= evaluate_channel_condition_for_client(condition
, state
,
921 &evaluation
, &object_uid
, &object_gid
);
923 case LTTNG_OBJECT_TYPE_NONE
:
926 case LTTNG_OBJECT_TYPE_UNKNOWN
:
933 /* Evaluation yielded nothing. Normal exit. */
934 DBG("[notification-thread] Newly subscribed-to condition evaluated to false, nothing to report to client");
940 * Create a temporary client list with the client currently
943 cds_lfht_node_init(&client_list
.notification_trigger_ht_node
);
944 CDS_INIT_LIST_HEAD(&client_list
.list
);
945 client_list
.trigger
= trigger
;
947 CDS_INIT_LIST_HEAD(&client_list_element
.node
);
948 client_list_element
.client
= client
;
949 cds_list_add(&client_list_element
.node
, &client_list
.list
);
951 /* Send evaluation result to the newly-subscribed client. */
952 DBG("[notification-thread] Newly subscribed-to condition evaluated to true, notifying client");
953 ret
= send_evaluation_to_clients(trigger
, evaluation
, &client_list
,
954 state
, object_uid
, object_gid
);
961 int notification_thread_client_subscribe(struct notification_client
*client
,
962 struct lttng_condition
*condition
,
963 struct notification_thread_state
*state
,
964 enum lttng_notification_channel_status
*_status
)
967 struct notification_client_list
*client_list
;
968 struct lttng_condition_list_element
*condition_list_element
= NULL
;
969 struct notification_client_list_element
*client_list_element
= NULL
;
970 enum lttng_notification_channel_status status
=
971 LTTNG_NOTIFICATION_CHANNEL_STATUS_OK
;
974 * Ensure that the client has not already subscribed to this condition
977 cds_list_for_each_entry(condition_list_element
, &client
->condition_list
, node
) {
978 if (lttng_condition_is_equal(condition_list_element
->condition
,
980 status
= LTTNG_NOTIFICATION_CHANNEL_STATUS_ALREADY_SUBSCRIBED
;
985 condition_list_element
= zmalloc(sizeof(*condition_list_element
));
986 if (!condition_list_element
) {
990 client_list_element
= zmalloc(sizeof(*client_list_element
));
991 if (!client_list_element
) {
999 * Add the newly-subscribed condition to the client's subscription list.
1001 CDS_INIT_LIST_HEAD(&condition_list_element
->node
);
1002 condition_list_element
->condition
= condition
;
1003 cds_list_add(&condition_list_element
->node
, &client
->condition_list
);
1005 client_list
= get_client_list_from_condition(state
, condition
);
1008 * No notification-emiting trigger registered with this
1009 * condition. We don't evaluate the condition right away
1010 * since this trigger is not registered yet.
1012 free(client_list_element
);
1017 * The condition to which the client just subscribed is evaluated
1018 * at this point so that conditions that are already TRUE result
1019 * in a notification being sent out.
1021 if (evaluate_condition_for_client(client_list
->trigger
, condition
,
1023 WARN("[notification-thread] Evaluation of a condition on client subscription failed, aborting.");
1025 free(client_list_element
);
1030 * Add the client to the list of clients interested in a given trigger
1031 * if a "notification" trigger with a corresponding condition was
1034 client_list_element
->client
= client
;
1035 CDS_INIT_LIST_HEAD(&client_list_element
->node
);
1036 cds_list_add(&client_list_element
->node
, &client_list
->list
);
1045 free(condition_list_element
);
1046 free(client_list_element
);
1051 int notification_thread_client_unsubscribe(
1052 struct notification_client
*client
,
1053 struct lttng_condition
*condition
,
1054 struct notification_thread_state
*state
,
1055 enum lttng_notification_channel_status
*_status
)
1057 struct notification_client_list
*client_list
;
1058 struct lttng_condition_list_element
*condition_list_element
,
1060 struct notification_client_list_element
*client_list_element
,
1062 bool condition_found
= false;
1063 enum lttng_notification_channel_status status
=
1064 LTTNG_NOTIFICATION_CHANNEL_STATUS_OK
;
1066 /* Remove the condition from the client's condition list. */
1067 cds_list_for_each_entry_safe(condition_list_element
, condition_tmp
,
1068 &client
->condition_list
, node
) {
1069 if (!lttng_condition_is_equal(condition_list_element
->condition
,
1074 cds_list_del(&condition_list_element
->node
);
1076 * The caller may be iterating on the client's conditions to
1077 * tear down a client's connection. In this case, the condition
1078 * will be destroyed at the end.
1080 if (condition
!= condition_list_element
->condition
) {
1081 lttng_condition_destroy(
1082 condition_list_element
->condition
);
1084 free(condition_list_element
);
1085 condition_found
= true;
1089 if (!condition_found
) {
1090 status
= LTTNG_NOTIFICATION_CHANNEL_STATUS_UNKNOWN_CONDITION
;
1095 * Remove the client from the list of clients interested the trigger
1096 * matching the condition.
1099 client_list
= get_client_list_from_condition(state
, condition
);
1104 cds_list_for_each_entry_safe(client_list_element
, client_tmp
,
1105 &client_list
->list
, node
) {
1106 if (client_list_element
->client
->socket
!= client
->socket
) {
1109 cds_list_del(&client_list_element
->node
);
1110 free(client_list_element
);
1116 lttng_condition_destroy(condition
);
1124 void free_notification_client_rcu(struct rcu_head
*node
)
1126 free(caa_container_of(node
, struct notification_client
, rcu_node
));
1130 void notification_client_destroy(struct notification_client
*client
,
1131 struct notification_thread_state
*state
)
1133 struct lttng_condition_list_element
*condition_list_element
, *tmp
;
1139 /* Release all conditions to which the client was subscribed. */
1140 cds_list_for_each_entry_safe(condition_list_element
, tmp
,
1141 &client
->condition_list
, node
) {
1142 (void) notification_thread_client_unsubscribe(client
,
1143 condition_list_element
->condition
, state
, NULL
);
1146 if (client
->socket
>= 0) {
1147 (void) lttcomm_close_unix_sock(client
->socket
);
1149 lttng_dynamic_buffer_reset(&client
->communication
.inbound
.buffer
);
1150 lttng_dynamic_buffer_reset(&client
->communication
.outbound
.buffer
);
1151 call_rcu(&client
->rcu_node
, free_notification_client_rcu
);
1155 * Call with rcu_read_lock held (and hold for the lifetime of the returned
1159 struct notification_client
*get_client_from_socket(int socket
,
1160 struct notification_thread_state
*state
)
1162 struct cds_lfht_iter iter
;
1163 struct cds_lfht_node
*node
;
1164 struct notification_client
*client
= NULL
;
1166 cds_lfht_lookup(state
->client_socket_ht
,
1167 hash_key_ulong((void *) (unsigned long) socket
, lttng_ht_seed
),
1169 (void *) (unsigned long) socket
,
1171 node
= cds_lfht_iter_get_node(&iter
);
1176 client
= caa_container_of(node
, struct notification_client
,
1177 client_socket_ht_node
);
1183 bool buffer_usage_condition_applies_to_channel(
1184 const struct lttng_condition
*condition
,
1185 const struct channel_info
*channel_info
)
1187 enum lttng_condition_status status
;
1188 enum lttng_domain_type condition_domain
;
1189 const char *condition_session_name
= NULL
;
1190 const char *condition_channel_name
= NULL
;
1192 status
= lttng_condition_buffer_usage_get_domain_type(condition
,
1194 assert(status
== LTTNG_CONDITION_STATUS_OK
);
1195 if (channel_info
->key
.domain
!= condition_domain
) {
1199 status
= lttng_condition_buffer_usage_get_session_name(
1200 condition
, &condition_session_name
);
1201 assert((status
== LTTNG_CONDITION_STATUS_OK
) && condition_session_name
);
1203 status
= lttng_condition_buffer_usage_get_channel_name(
1204 condition
, &condition_channel_name
);
1205 assert((status
== LTTNG_CONDITION_STATUS_OK
) && condition_channel_name
);
1207 if (strcmp(channel_info
->session_info
->name
, condition_session_name
)) {
1210 if (strcmp(channel_info
->name
, condition_channel_name
)) {
1220 bool session_consumed_size_condition_applies_to_channel(
1221 const struct lttng_condition
*condition
,
1222 const struct channel_info
*channel_info
)
1224 enum lttng_condition_status status
;
1225 const char *condition_session_name
= NULL
;
1227 status
= lttng_condition_session_consumed_size_get_session_name(
1228 condition
, &condition_session_name
);
1229 assert((status
== LTTNG_CONDITION_STATUS_OK
) && condition_session_name
);
1231 if (strcmp(channel_info
->session_info
->name
, condition_session_name
)) {
1241 bool trigger_applies_to_channel(const struct lttng_trigger
*trigger
,
1242 const struct channel_info
*channel_info
)
1244 const struct lttng_condition
*condition
;
1245 bool trigger_applies
;
1247 condition
= lttng_trigger_get_const_condition(trigger
);
1252 switch (lttng_condition_get_type(condition
)) {
1253 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW
:
1254 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH
:
1255 trigger_applies
= buffer_usage_condition_applies_to_channel(
1256 condition
, channel_info
);
1258 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE
:
1259 trigger_applies
= session_consumed_size_condition_applies_to_channel(
1260 condition
, channel_info
);
1266 return trigger_applies
;
1272 bool trigger_applies_to_client(struct lttng_trigger
*trigger
,
1273 struct notification_client
*client
)
1275 bool applies
= false;
1276 struct lttng_condition_list_element
*condition_list_element
;
1278 cds_list_for_each_entry(condition_list_element
, &client
->condition_list
,
1280 applies
= lttng_condition_is_equal(
1281 condition_list_element
->condition
,
1282 lttng_trigger_get_condition(trigger
));
1290 /* Must be called with RCU read lock held. */
1292 struct lttng_session_trigger_list
*get_session_trigger_list(
1293 struct notification_thread_state
*state
,
1294 const char *session_name
)
1296 struct lttng_session_trigger_list
*list
= NULL
;
1297 struct cds_lfht_node
*node
;
1298 struct cds_lfht_iter iter
;
1300 cds_lfht_lookup(state
->session_triggers_ht
,
1301 hash_key_str(session_name
, lttng_ht_seed
),
1302 match_session_trigger_list
,
1305 node
= cds_lfht_iter_get_node(&iter
);
1308 * Not an error, the list of triggers applying to that session
1309 * will be initialized when the session is created.
1311 DBG("[notification-thread] No trigger list found for session \"%s\" as it is not yet known to the notification system",
1316 list
= caa_container_of(node
,
1317 struct lttng_session_trigger_list
,
1318 session_triggers_ht_node
);
1324 * Allocate an empty lttng_session_trigger_list for the session named
1327 * No ownership of 'session_name' is assumed by the session trigger list.
1328 * It is the caller's responsability to ensure the session name is alive
1329 * for as long as this list is.
1332 struct lttng_session_trigger_list
*lttng_session_trigger_list_create(
1333 const char *session_name
,
1334 struct cds_lfht
*session_triggers_ht
)
1336 struct lttng_session_trigger_list
*list
;
1338 list
= zmalloc(sizeof(*list
));
1342 list
->session_name
= session_name
;
1343 CDS_INIT_LIST_HEAD(&list
->list
);
1344 cds_lfht_node_init(&list
->session_triggers_ht_node
);
1345 list
->session_triggers_ht
= session_triggers_ht
;
1348 /* Publish the list through the session_triggers_ht. */
1349 cds_lfht_add(session_triggers_ht
,
1350 hash_key_str(session_name
, lttng_ht_seed
),
1351 &list
->session_triggers_ht_node
);
1358 void free_session_trigger_list_rcu(struct rcu_head
*node
)
1360 free(caa_container_of(node
, struct lttng_session_trigger_list
,
1365 void lttng_session_trigger_list_destroy(struct lttng_session_trigger_list
*list
)
1367 struct lttng_trigger_list_element
*trigger_list_element
, *tmp
;
1369 /* Empty the list element by element, and then free the list itself. */
1370 cds_list_for_each_entry_safe(trigger_list_element
, tmp
,
1371 &list
->list
, node
) {
1372 cds_list_del(&trigger_list_element
->node
);
1373 free(trigger_list_element
);
1376 /* Unpublish the list from the session_triggers_ht. */
1377 cds_lfht_del(list
->session_triggers_ht
,
1378 &list
->session_triggers_ht_node
);
1380 call_rcu(&list
->rcu_node
, free_session_trigger_list_rcu
);
1384 int lttng_session_trigger_list_add(struct lttng_session_trigger_list
*list
,
1385 const struct lttng_trigger
*trigger
)
1388 struct lttng_trigger_list_element
*new_element
=
1389 zmalloc(sizeof(*new_element
));
1395 CDS_INIT_LIST_HEAD(&new_element
->node
);
1396 new_element
->trigger
= trigger
;
1397 cds_list_add(&new_element
->node
, &list
->list
);
1403 bool trigger_applies_to_session(const struct lttng_trigger
*trigger
,
1404 const char *session_name
)
1406 bool applies
= false;
1407 const struct lttng_condition
*condition
;
1409 condition
= lttng_trigger_get_const_condition(trigger
);
1410 switch (lttng_condition_get_type(condition
)) {
1411 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
:
1412 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED
:
1414 enum lttng_condition_status condition_status
;
1415 const char *condition_session_name
;
1417 condition_status
= lttng_condition_session_rotation_get_session_name(
1418 condition
, &condition_session_name
);
1419 if (condition_status
!= LTTNG_CONDITION_STATUS_OK
) {
1420 ERR("[notification-thread] Failed to retrieve session rotation condition's session name");
1424 assert(condition_session_name
);
1425 applies
= !strcmp(condition_session_name
, session_name
);
1436 * Allocate and initialize an lttng_session_trigger_list which contains
1437 * all triggers that apply to the session named 'session_name'.
1439 * No ownership of 'session_name' is assumed by the session trigger list.
1440 * It is the caller's responsability to ensure the session name is alive
1441 * for as long as this list is.
1444 struct lttng_session_trigger_list
*lttng_session_trigger_list_build(
1445 const struct notification_thread_state
*state
,
1446 const char *session_name
)
1448 int trigger_count
= 0;
1449 struct lttng_session_trigger_list
*session_trigger_list
= NULL
;
1450 struct lttng_trigger_ht_element
*trigger_ht_element
= NULL
;
1451 struct cds_lfht_iter iter
;
1453 session_trigger_list
= lttng_session_trigger_list_create(session_name
,
1454 state
->session_triggers_ht
);
1456 /* Add all triggers applying to the session named 'session_name'. */
1457 cds_lfht_for_each_entry(state
->triggers_ht
, &iter
, trigger_ht_element
,
1461 if (!trigger_applies_to_session(trigger_ht_element
->trigger
,
1466 ret
= lttng_session_trigger_list_add(session_trigger_list
,
1467 trigger_ht_element
->trigger
);
1475 DBG("[notification-thread] Found %i triggers that apply to newly created session",
1477 return session_trigger_list
;
1479 lttng_session_trigger_list_destroy(session_trigger_list
);
1484 struct session_info
*find_or_create_session_info(
1485 struct notification_thread_state
*state
,
1486 const char *name
, uid_t uid
, gid_t gid
)
1488 struct session_info
*session
= NULL
;
1489 struct cds_lfht_node
*node
;
1490 struct cds_lfht_iter iter
;
1491 struct lttng_session_trigger_list
*trigger_list
;
1494 cds_lfht_lookup(state
->sessions_ht
,
1495 hash_key_str(name
, lttng_ht_seed
),
1499 node
= cds_lfht_iter_get_node(&iter
);
1501 DBG("[notification-thread] Found session info of session \"%s\" (uid = %i, gid = %i)",
1503 session
= caa_container_of(node
, struct session_info
,
1505 assert(session
->uid
== uid
);
1506 assert(session
->gid
== gid
);
1507 session_info_get(session
);
1511 trigger_list
= lttng_session_trigger_list_build(state
, name
);
1512 if (!trigger_list
) {
1516 session
= session_info_create(name
, uid
, gid
, trigger_list
,
1517 state
->sessions_ht
);
1519 ERR("[notification-thread] Failed to allocation session info for session \"%s\" (uid = %i, gid = %i)",
1521 lttng_session_trigger_list_destroy(trigger_list
);
1524 trigger_list
= NULL
;
1526 cds_lfht_add(state
->sessions_ht
, hash_key_str(name
, lttng_ht_seed
),
1527 &session
->sessions_ht_node
);
1533 session_info_put(session
);
1538 int handle_notification_thread_command_add_channel(
1539 struct notification_thread_state
*state
,
1540 const char *session_name
, uid_t session_uid
, gid_t session_gid
,
1541 const char *channel_name
, enum lttng_domain_type channel_domain
,
1542 uint64_t channel_key_int
, uint64_t channel_capacity
,
1543 enum lttng_error_code
*cmd_result
)
1545 struct cds_list_head trigger_list
;
1546 struct channel_info
*new_channel_info
= NULL
;
1547 struct channel_key channel_key
= {
1548 .key
= channel_key_int
,
1549 .domain
= channel_domain
,
1551 struct lttng_channel_trigger_list
*channel_trigger_list
= NULL
;
1552 struct lttng_trigger_ht_element
*trigger_ht_element
= NULL
;
1553 int trigger_count
= 0;
1554 struct cds_lfht_iter iter
;
1555 struct session_info
*session_info
= NULL
;
1557 DBG("[notification-thread] Adding channel %s from session %s, channel key = %" PRIu64
" in %s domain",
1558 channel_name
, session_name
, channel_key_int
,
1559 channel_domain
== LTTNG_DOMAIN_KERNEL
? "kernel" : "user space");
1561 CDS_INIT_LIST_HEAD(&trigger_list
);
1563 session_info
= find_or_create_session_info(state
, session_name
,
1564 session_uid
, session_gid
);
1565 if (!session_info
) {
1566 /* Allocation error or an internal error occurred. */
1570 new_channel_info
= channel_info_create(channel_name
, &channel_key
,
1571 channel_capacity
, session_info
);
1572 if (!new_channel_info
) {
1577 /* Build a list of all triggers applying to the new channel. */
1578 cds_lfht_for_each_entry(state
->triggers_ht
, &iter
, trigger_ht_element
,
1580 struct lttng_trigger_list_element
*new_element
;
1582 if (!trigger_applies_to_channel(trigger_ht_element
->trigger
,
1583 new_channel_info
)) {
1587 new_element
= zmalloc(sizeof(*new_element
));
1592 CDS_INIT_LIST_HEAD(&new_element
->node
);
1593 new_element
->trigger
= trigger_ht_element
->trigger
;
1594 cds_list_add(&new_element
->node
, &trigger_list
);
1599 DBG("[notification-thread] Found %i triggers that apply to newly added channel",
1601 channel_trigger_list
= zmalloc(sizeof(*channel_trigger_list
));
1602 if (!channel_trigger_list
) {
1605 channel_trigger_list
->channel_key
= new_channel_info
->key
;
1606 CDS_INIT_LIST_HEAD(&channel_trigger_list
->list
);
1607 cds_lfht_node_init(&channel_trigger_list
->channel_triggers_ht_node
);
1608 cds_list_splice(&trigger_list
, &channel_trigger_list
->list
);
1611 /* Add channel to the channel_ht which owns the channel_infos. */
1612 cds_lfht_add(state
->channels_ht
,
1613 hash_channel_key(&new_channel_info
->key
),
1614 &new_channel_info
->channels_ht_node
);
1616 * Add the list of triggers associated with this channel to the
1617 * channel_triggers_ht.
1619 cds_lfht_add(state
->channel_triggers_ht
,
1620 hash_channel_key(&new_channel_info
->key
),
1621 &channel_trigger_list
->channel_triggers_ht_node
);
1623 session_info_put(session_info
);
1624 *cmd_result
= LTTNG_OK
;
1627 channel_info_destroy(new_channel_info
);
1628 session_info_put(session_info
);
1633 void free_channel_trigger_list_rcu(struct rcu_head
*node
)
1635 free(caa_container_of(node
, struct lttng_channel_trigger_list
,
1640 void free_channel_state_sample_rcu(struct rcu_head
*node
)
1642 free(caa_container_of(node
, struct channel_state_sample
,
1647 int handle_notification_thread_command_remove_channel(
1648 struct notification_thread_state
*state
,
1649 uint64_t channel_key
, enum lttng_domain_type domain
,
1650 enum lttng_error_code
*cmd_result
)
1652 struct cds_lfht_node
*node
;
1653 struct cds_lfht_iter iter
;
1654 struct lttng_channel_trigger_list
*trigger_list
;
1655 struct lttng_trigger_list_element
*trigger_list_element
, *tmp
;
1656 struct channel_key key
= { .key
= channel_key
, .domain
= domain
};
1657 struct channel_info
*channel_info
;
1659 DBG("[notification-thread] Removing channel key = %" PRIu64
" in %s domain",
1660 channel_key
, domain
== LTTNG_DOMAIN_KERNEL
? "kernel" : "user space");
1664 cds_lfht_lookup(state
->channel_triggers_ht
,
1665 hash_channel_key(&key
),
1666 match_channel_trigger_list
,
1669 node
= cds_lfht_iter_get_node(&iter
);
1671 * There is a severe internal error if we are being asked to remove a
1672 * channel that doesn't exist.
1675 ERR("[notification-thread] Channel being removed is unknown to the notification thread");
1679 /* Free the list of triggers associated with this channel. */
1680 trigger_list
= caa_container_of(node
, struct lttng_channel_trigger_list
,
1681 channel_triggers_ht_node
);
1682 cds_list_for_each_entry_safe(trigger_list_element
, tmp
,
1683 &trigger_list
->list
, node
) {
1684 cds_list_del(&trigger_list_element
->node
);
1685 free(trigger_list_element
);
1687 cds_lfht_del(state
->channel_triggers_ht
, node
);
1688 call_rcu(&trigger_list
->rcu_node
, free_channel_trigger_list_rcu
);
1690 /* Free sampled channel state. */
1691 cds_lfht_lookup(state
->channel_state_ht
,
1692 hash_channel_key(&key
),
1693 match_channel_state_sample
,
1696 node
= cds_lfht_iter_get_node(&iter
);
1698 * This is expected to be NULL if the channel is destroyed before we
1699 * received a sample.
1702 struct channel_state_sample
*sample
= caa_container_of(node
,
1703 struct channel_state_sample
,
1704 channel_state_ht_node
);
1706 cds_lfht_del(state
->channel_state_ht
, node
);
1707 call_rcu(&sample
->rcu_node
, free_channel_state_sample_rcu
);
1710 /* Remove the channel from the channels_ht and free it. */
1711 cds_lfht_lookup(state
->channels_ht
,
1712 hash_channel_key(&key
),
1716 node
= cds_lfht_iter_get_node(&iter
);
1718 channel_info
= caa_container_of(node
, struct channel_info
,
1720 cds_lfht_del(state
->channels_ht
, node
);
1721 channel_info_destroy(channel_info
);
1724 *cmd_result
= LTTNG_OK
;
1729 int handle_notification_thread_command_session_rotation(
1730 struct notification_thread_state
*state
,
1731 enum notification_thread_command_type cmd_type
,
1732 const char *session_name
, uid_t session_uid
, gid_t session_gid
,
1733 uint64_t trace_archive_chunk_id
,
1734 struct lttng_trace_archive_location
*location
,
1735 enum lttng_error_code
*_cmd_result
)
1738 enum lttng_error_code cmd_result
= LTTNG_OK
;
1739 struct lttng_session_trigger_list
*trigger_list
;
1740 struct lttng_trigger_list_element
*trigger_list_element
;
1741 struct session_info
*session_info
;
1745 session_info
= find_or_create_session_info(state
, session_name
,
1746 session_uid
, session_gid
);
1747 if (!session_info
) {
1748 /* Allocation error or an internal error occurred. */
1750 cmd_result
= LTTNG_ERR_NOMEM
;
1754 session_info
->rotation
.ongoing
=
1755 cmd_type
== NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING
;
1756 session_info
->rotation
.id
= trace_archive_chunk_id
;
1757 trigger_list
= get_session_trigger_list(state
, session_name
);
1758 if (!trigger_list
) {
1759 DBG("[notification-thread] No triggers applying to session \"%s\" found",
1764 cds_list_for_each_entry(trigger_list_element
, &trigger_list
->list
,
1766 const struct lttng_condition
*condition
;
1767 const struct lttng_action
*action
;
1768 const struct lttng_trigger
*trigger
;
1769 struct notification_client_list
*client_list
;
1770 struct lttng_evaluation
*evaluation
= NULL
;
1771 enum lttng_condition_type condition_type
;
1773 trigger
= trigger_list_element
->trigger
;
1774 condition
= lttng_trigger_get_const_condition(trigger
);
1776 condition_type
= lttng_condition_get_type(condition
);
1778 if (condition_type
== LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
&&
1779 cmd_type
!= NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING
) {
1781 } else if (condition_type
== LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED
&&
1782 cmd_type
!= NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_COMPLETED
) {
1786 action
= lttng_trigger_get_const_action(trigger
);
1788 /* Notify actions are the only type currently supported. */
1789 assert(lttng_action_get_type_const(action
) ==
1790 LTTNG_ACTION_TYPE_NOTIFY
);
1792 client_list
= get_client_list_from_condition(state
, condition
);
1793 assert(client_list
);
1795 if (cds_list_empty(&client_list
->list
)) {
1797 * No clients interested in the evaluation's result,
1803 if (cmd_type
== NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING
) {
1804 evaluation
= lttng_evaluation_session_rotation_ongoing_create(
1805 trace_archive_chunk_id
);
1807 evaluation
= lttng_evaluation_session_rotation_completed_create(
1808 trace_archive_chunk_id
, location
);
1812 /* Internal error */
1814 cmd_result
= LTTNG_ERR_UNK
;
1818 /* Dispatch evaluation result to all clients. */
1819 ret
= send_evaluation_to_clients(trigger_list_element
->trigger
,
1820 evaluation
, client_list
, state
,
1823 lttng_evaluation_destroy(evaluation
);
1824 if (caa_unlikely(ret
)) {
1829 session_info_put(session_info
);
1830 *_cmd_result
= cmd_result
;
1836 int condition_is_supported(struct lttng_condition
*condition
)
1840 switch (lttng_condition_get_type(condition
)) {
1841 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW
:
1842 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH
:
1844 enum lttng_domain_type domain
;
1846 ret
= lttng_condition_buffer_usage_get_domain_type(condition
,
1853 if (domain
!= LTTNG_DOMAIN_KERNEL
) {
1859 * Older kernel tracers don't expose the API to monitor their
1860 * buffers. Therefore, we reject triggers that require that
1861 * mechanism to be available to be evaluated.
1863 ret
= kernel_supports_ring_buffer_snapshot_sample_positions(
1874 /* Must be called with RCU read lock held. */
1876 int bind_trigger_to_matching_session(const struct lttng_trigger
*trigger
,
1877 struct notification_thread_state
*state
)
1880 const struct lttng_condition
*condition
;
1881 const char *session_name
;
1882 struct lttng_session_trigger_list
*trigger_list
;
1884 condition
= lttng_trigger_get_const_condition(trigger
);
1885 switch (lttng_condition_get_type(condition
)) {
1886 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING
:
1887 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED
:
1889 enum lttng_condition_status status
;
1891 status
= lttng_condition_session_rotation_get_session_name(
1892 condition
, &session_name
);
1893 if (status
!= LTTNG_CONDITION_STATUS_OK
) {
1894 ERR("[notification-thread] Failed to bind trigger to session: unable to get 'session_rotation' condition's session name");
1905 trigger_list
= get_session_trigger_list(state
, session_name
);
1906 if (!trigger_list
) {
1907 DBG("[notification-thread] Unable to bind trigger applying to session \"%s\" as it is not yet known to the notification system",
1913 DBG("[notification-thread] Newly registered trigger bound to session \"%s\"",
1915 ret
= lttng_session_trigger_list_add(trigger_list
, trigger
);
1920 /* Must be called with RCU read lock held. */
1922 int bind_trigger_to_matching_channels(const struct lttng_trigger
*trigger
,
1923 struct notification_thread_state
*state
)
1926 struct cds_lfht_node
*node
;
1927 struct cds_lfht_iter iter
;
1928 struct channel_info
*channel
;
1930 cds_lfht_for_each_entry(state
->channels_ht
, &iter
, channel
,
1932 struct lttng_trigger_list_element
*trigger_list_element
;
1933 struct lttng_channel_trigger_list
*trigger_list
;
1935 if (!trigger_applies_to_channel(trigger
, channel
)) {
1939 cds_lfht_lookup(state
->channel_triggers_ht
,
1940 hash_channel_key(&channel
->key
),
1941 match_channel_trigger_list
,
1944 node
= cds_lfht_iter_get_node(&iter
);
1946 trigger_list
= caa_container_of(node
,
1947 struct lttng_channel_trigger_list
,
1948 channel_triggers_ht_node
);
1950 trigger_list_element
= zmalloc(sizeof(*trigger_list_element
));
1951 if (!trigger_list_element
) {
1955 CDS_INIT_LIST_HEAD(&trigger_list_element
->node
);
1956 trigger_list_element
->trigger
= trigger
;
1957 cds_list_add(&trigger_list_element
->node
, &trigger_list
->list
);
1958 DBG("[notification-thread] Newly registered trigger bound to channel \"%s\"",
1966 * FIXME A client's credentials are not checked when registering a trigger, nor
1967 * are they stored alongside with the trigger.
1969 * The effects of this are benign since:
1970 * - The client will succeed in registering the trigger, as it is valid,
1971 * - The trigger will, internally, be bound to the channel/session,
1972 * - The notifications will not be sent since the client's credentials
1973 * are checked against the channel at that moment.
1975 * If this function returns a non-zero value, it means something is
1976 * fundamentally broken and the whole subsystem/thread will be torn down.
1978 * If a non-fatal error occurs, just set the cmd_result to the appropriate
1982 int handle_notification_thread_command_register_trigger(
1983 struct notification_thread_state
*state
,
1984 struct lttng_trigger
*trigger
,
1985 enum lttng_error_code
*cmd_result
)
1988 struct lttng_condition
*condition
;
1989 struct notification_client
*client
;
1990 struct notification_client_list
*client_list
= NULL
;
1991 struct lttng_trigger_ht_element
*trigger_ht_element
= NULL
;
1992 struct notification_client_list_element
*client_list_element
, *tmp
;
1993 struct cds_lfht_node
*node
;
1994 struct cds_lfht_iter iter
;
1995 bool free_trigger
= true;
1999 condition
= lttng_trigger_get_condition(trigger
);
2002 ret
= condition_is_supported(condition
);
2005 } else if (ret
== 0) {
2006 *cmd_result
= LTTNG_ERR_NOT_SUPPORTED
;
2009 /* Feature is supported, continue. */
2013 trigger_ht_element
= zmalloc(sizeof(*trigger_ht_element
));
2014 if (!trigger_ht_element
) {
2019 /* Add trigger to the trigger_ht. */
2020 cds_lfht_node_init(&trigger_ht_element
->node
);
2021 trigger_ht_element
->trigger
= trigger
;
2023 node
= cds_lfht_add_unique(state
->triggers_ht
,
2024 lttng_condition_hash(condition
),
2027 &trigger_ht_element
->node
);
2028 if (node
!= &trigger_ht_element
->node
) {
2029 /* Not a fatal error, simply report it to the client. */
2030 *cmd_result
= LTTNG_ERR_TRIGGER_EXISTS
;
2031 goto error_free_ht_element
;
2035 * Ownership of the trigger and of its wrapper was transfered to
2038 trigger_ht_element
= NULL
;
2039 free_trigger
= false;
2042 * The rest only applies to triggers that have a "notify" action.
2043 * It is not skipped as this is the only action type currently
2046 client_list
= zmalloc(sizeof(*client_list
));
2049 goto error_free_ht_element
;
2051 cds_lfht_node_init(&client_list
->notification_trigger_ht_node
);
2052 CDS_INIT_LIST_HEAD(&client_list
->list
);
2053 client_list
->trigger
= trigger
;
2055 /* Build a list of clients to which this new trigger applies. */
2056 cds_lfht_for_each_entry(state
->client_socket_ht
, &iter
, client
,
2057 client_socket_ht_node
) {
2058 if (!trigger_applies_to_client(trigger
, client
)) {
2062 client_list_element
= zmalloc(sizeof(*client_list_element
));
2063 if (!client_list_element
) {
2065 goto error_free_client_list
;
2067 CDS_INIT_LIST_HEAD(&client_list_element
->node
);
2068 client_list_element
->client
= client
;
2069 cds_list_add(&client_list_element
->node
, &client_list
->list
);
2072 cds_lfht_add(state
->notification_trigger_clients_ht
,
2073 lttng_condition_hash(condition
),
2074 &client_list
->notification_trigger_ht_node
);
2076 switch (get_condition_binding_object(condition
)) {
2077 case LTTNG_OBJECT_TYPE_SESSION
:
2078 /* Add the trigger to the list if it matches a known session. */
2079 ret
= bind_trigger_to_matching_session(trigger
, state
);
2081 goto error_free_client_list
;
2084 case LTTNG_OBJECT_TYPE_CHANNEL
:
2086 * Add the trigger to list of triggers bound to the channels
2089 ret
= bind_trigger_to_matching_channels(trigger
, state
);
2091 goto error_free_client_list
;
2094 case LTTNG_OBJECT_TYPE_NONE
:
2097 ERR("[notification-thread] Unknown object type on which to bind a newly registered trigger was encountered");
2099 goto error_free_client_list
;
2103 * Since there is nothing preventing clients from subscribing to a
2104 * condition before the corresponding trigger is registered, we have
2105 * to evaluate this new condition right away.
2107 * At some point, we were waiting for the next "evaluation" (e.g. on
2108 * reception of a channel sample) to evaluate this new condition, but
2111 * The reason it was broken is that waiting for the next sample
2112 * does not allow us to properly handle transitions for edge-triggered
2115 * Consider this example: when we handle a new channel sample, we
2116 * evaluate each conditions twice: once with the previous state, and
2117 * again with the newest state. We then use those two results to
2118 * determine whether a state change happened: a condition was false and
2119 * became true. If a state change happened, we have to notify clients.
2121 * Now, if a client subscribes to a given notification and registers
2122 * a trigger *after* that subscription, we have to make sure the
2123 * condition is evaluated at this point while considering only the
2124 * current state. Otherwise, the next evaluation cycle may only see
2125 * that the evaluations remain the same (true for samples n-1 and n) and
2126 * the client will never know that the condition has been met.
2128 cds_list_for_each_entry_safe(client_list_element
, tmp
,
2129 &client_list
->list
, node
) {
2130 ret
= evaluate_condition_for_client(trigger
, condition
,
2131 client_list_element
->client
, state
);
2133 goto error_free_client_list
;
2138 * Client list ownership transferred to the
2139 * notification_trigger_clients_ht.
2143 *cmd_result
= LTTNG_OK
;
2144 error_free_client_list
:
2146 cds_list_for_each_entry_safe(client_list_element
, tmp
,
2147 &client_list
->list
, node
) {
2148 free(client_list_element
);
2152 error_free_ht_element
:
2153 free(trigger_ht_element
);
2156 struct lttng_action
*action
= lttng_trigger_get_action(trigger
);
2158 lttng_condition_destroy(condition
);
2159 lttng_action_destroy(action
);
2160 lttng_trigger_destroy(trigger
);
2167 void free_notification_client_list_rcu(struct rcu_head
*node
)
2169 free(caa_container_of(node
, struct notification_client_list
,
2174 void free_lttng_trigger_ht_element_rcu(struct rcu_head
*node
)
2176 free(caa_container_of(node
, struct lttng_trigger_ht_element
,
2181 int handle_notification_thread_command_unregister_trigger(
2182 struct notification_thread_state
*state
,
2183 struct lttng_trigger
*trigger
,
2184 enum lttng_error_code
*_cmd_reply
)
2186 struct cds_lfht_iter iter
;
2187 struct cds_lfht_node
*triggers_ht_node
;
2188 struct lttng_channel_trigger_list
*trigger_list
;
2189 struct notification_client_list
*client_list
;
2190 struct notification_client_list_element
*client_list_element
, *tmp
;
2191 struct lttng_trigger_ht_element
*trigger_ht_element
= NULL
;
2192 struct lttng_condition
*condition
= lttng_trigger_get_condition(
2194 struct lttng_action
*action
;
2195 enum lttng_error_code cmd_reply
;
2199 cds_lfht_lookup(state
->triggers_ht
,
2200 lttng_condition_hash(condition
),
2204 triggers_ht_node
= cds_lfht_iter_get_node(&iter
);
2205 if (!triggers_ht_node
) {
2206 cmd_reply
= LTTNG_ERR_TRIGGER_NOT_FOUND
;
2209 cmd_reply
= LTTNG_OK
;
2212 /* Remove trigger from channel_triggers_ht. */
2213 cds_lfht_for_each_entry(state
->channel_triggers_ht
, &iter
, trigger_list
,
2214 channel_triggers_ht_node
) {
2215 struct lttng_trigger_list_element
*trigger_element
, *tmp
;
2217 cds_list_for_each_entry_safe(trigger_element
, tmp
,
2218 &trigger_list
->list
, node
) {
2219 const struct lttng_condition
*current_condition
=
2220 lttng_trigger_get_const_condition(
2221 trigger_element
->trigger
);
2223 assert(current_condition
);
2224 if (!lttng_condition_is_equal(condition
,
2225 current_condition
)) {
2229 DBG("[notification-thread] Removed trigger from channel_triggers_ht");
2230 cds_list_del(&trigger_element
->node
);
2231 /* A trigger can only appear once per channel */
2237 * Remove and release the client list from
2238 * notification_trigger_clients_ht.
2240 client_list
= get_client_list_from_condition(state
, condition
);
2241 assert(client_list
);
2243 cds_list_for_each_entry_safe(client_list_element
, tmp
,
2244 &client_list
->list
, node
) {
2245 free(client_list_element
);
2247 cds_lfht_del(state
->notification_trigger_clients_ht
,
2248 &client_list
->notification_trigger_ht_node
);
2249 call_rcu(&client_list
->rcu_node
, free_notification_client_list_rcu
);
2251 /* Remove trigger from triggers_ht. */
2252 trigger_ht_element
= caa_container_of(triggers_ht_node
,
2253 struct lttng_trigger_ht_element
, node
);
2254 cds_lfht_del(state
->triggers_ht
, triggers_ht_node
);
2256 condition
= lttng_trigger_get_condition(trigger_ht_element
->trigger
);
2257 lttng_condition_destroy(condition
);
2258 action
= lttng_trigger_get_action(trigger_ht_element
->trigger
);
2259 lttng_action_destroy(action
);
2260 lttng_trigger_destroy(trigger_ht_element
->trigger
);
2261 call_rcu(&trigger_ht_element
->rcu_node
, free_lttng_trigger_ht_element_rcu
);
2265 *_cmd_reply
= cmd_reply
;
2270 /* Returns 0 on success, 1 on exit requested, negative value on error. */
2271 int handle_notification_thread_command(
2272 struct notification_thread_handle
*handle
,
2273 struct notification_thread_state
*state
)
2277 struct notification_thread_command
*cmd
;
2279 /* Read the event pipe to put it back into a quiescent state. */
2280 ret
= read(lttng_pipe_get_readfd(handle
->cmd_queue
.event_pipe
), &counter
,
2286 pthread_mutex_lock(&handle
->cmd_queue
.lock
);
2287 cmd
= cds_list_first_entry(&handle
->cmd_queue
.list
,
2288 struct notification_thread_command
, cmd_list_node
);
2289 switch (cmd
->type
) {
2290 case NOTIFICATION_COMMAND_TYPE_REGISTER_TRIGGER
:
2291 DBG("[notification-thread] Received register trigger command");
2292 ret
= handle_notification_thread_command_register_trigger(
2293 state
, cmd
->parameters
.trigger
,
2296 case NOTIFICATION_COMMAND_TYPE_UNREGISTER_TRIGGER
:
2297 DBG("[notification-thread] Received unregister trigger command");
2298 ret
= handle_notification_thread_command_unregister_trigger(
2299 state
, cmd
->parameters
.trigger
,
2302 case NOTIFICATION_COMMAND_TYPE_ADD_CHANNEL
:
2303 DBG("[notification-thread] Received add channel command");
2304 ret
= handle_notification_thread_command_add_channel(
2306 cmd
->parameters
.add_channel
.session
.name
,
2307 cmd
->parameters
.add_channel
.session
.uid
,
2308 cmd
->parameters
.add_channel
.session
.gid
,
2309 cmd
->parameters
.add_channel
.channel
.name
,
2310 cmd
->parameters
.add_channel
.channel
.domain
,
2311 cmd
->parameters
.add_channel
.channel
.key
,
2312 cmd
->parameters
.add_channel
.channel
.capacity
,
2315 case NOTIFICATION_COMMAND_TYPE_REMOVE_CHANNEL
:
2316 DBG("[notification-thread] Received remove channel command");
2317 ret
= handle_notification_thread_command_remove_channel(
2318 state
, cmd
->parameters
.remove_channel
.key
,
2319 cmd
->parameters
.remove_channel
.domain
,
2322 case NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING
:
2323 case NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_COMPLETED
:
2324 DBG("[notification-thread] Received session rotation %s command",
2325 cmd
->type
== NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING
?
2326 "ongoing" : "completed");
2327 ret
= handle_notification_thread_command_session_rotation(
2330 cmd
->parameters
.session_rotation
.session_name
,
2331 cmd
->parameters
.session_rotation
.uid
,
2332 cmd
->parameters
.session_rotation
.gid
,
2333 cmd
->parameters
.session_rotation
.trace_archive_chunk_id
,
2334 cmd
->parameters
.session_rotation
.location
,
2337 case NOTIFICATION_COMMAND_TYPE_QUIT
:
2338 DBG("[notification-thread] Received quit command");
2339 cmd
->reply_code
= LTTNG_OK
;
2343 ERR("[notification-thread] Unknown internal command received");
2351 cds_list_del(&cmd
->cmd_list_node
);
2352 lttng_waiter_wake_up(&cmd
->reply_waiter
);
2353 pthread_mutex_unlock(&handle
->cmd_queue
.lock
);
2356 /* Wake-up and return a fatal error to the calling thread. */
2357 lttng_waiter_wake_up(&cmd
->reply_waiter
);
2358 pthread_mutex_unlock(&handle
->cmd_queue
.lock
);
2359 cmd
->reply_code
= LTTNG_ERR_FATAL
;
2361 /* Indicate a fatal error to the caller. */
2366 unsigned long hash_client_socket(int socket
)
2368 return hash_key_ulong((void *) (unsigned long) socket
, lttng_ht_seed
);
2372 int socket_set_non_blocking(int socket
)
2376 /* Set the pipe as non-blocking. */
2377 ret
= fcntl(socket
, F_GETFL
, 0);
2379 PERROR("fcntl get socket flags");
2384 ret
= fcntl(socket
, F_SETFL
, flags
| O_NONBLOCK
);
2386 PERROR("fcntl set O_NONBLOCK socket flag");
2389 DBG("Client socket (fd = %i) set as non-blocking", socket
);
2395 int client_reset_inbound_state(struct notification_client
*client
)
2399 ret
= lttng_dynamic_buffer_set_size(
2400 &client
->communication
.inbound
.buffer
, 0);
2403 client
->communication
.inbound
.bytes_to_receive
=
2404 sizeof(struct lttng_notification_channel_message
);
2405 client
->communication
.inbound
.msg_type
=
2406 LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_UNKNOWN
;
2407 LTTNG_SOCK_SET_UID_CRED(&client
->communication
.inbound
.creds
, -1);
2408 LTTNG_SOCK_SET_GID_CRED(&client
->communication
.inbound
.creds
, -1);
2409 ret
= lttng_dynamic_buffer_set_size(
2410 &client
->communication
.inbound
.buffer
,
2411 client
->communication
.inbound
.bytes_to_receive
);
2415 int handle_notification_thread_client_connect(
2416 struct notification_thread_state
*state
)
2419 struct notification_client
*client
;
2421 DBG("[notification-thread] Handling new notification channel client connection");
2423 client
= zmalloc(sizeof(*client
));
2429 CDS_INIT_LIST_HEAD(&client
->condition_list
);
2430 lttng_dynamic_buffer_init(&client
->communication
.inbound
.buffer
);
2431 lttng_dynamic_buffer_init(&client
->communication
.outbound
.buffer
);
2432 client
->communication
.inbound
.expect_creds
= true;
2433 ret
= client_reset_inbound_state(client
);
2435 ERR("[notification-thread] Failed to reset client communication's inbound state");
2440 ret
= lttcomm_accept_unix_sock(state
->notification_channel_socket
);
2442 ERR("[notification-thread] Failed to accept new notification channel client connection");
2447 client
->socket
= ret
;
2449 ret
= socket_set_non_blocking(client
->socket
);
2451 ERR("[notification-thread] Failed to set new notification channel client connection socket as non-blocking");
2455 ret
= lttcomm_setsockopt_creds_unix_sock(client
->socket
);
2457 ERR("[notification-thread] Failed to set socket options on new notification channel client socket");
2462 ret
= lttng_poll_add(&state
->events
, client
->socket
,
2463 LPOLLIN
| LPOLLERR
|
2464 LPOLLHUP
| LPOLLRDHUP
);
2466 ERR("[notification-thread] Failed to add notification channel client socket to poll set");
2470 DBG("[notification-thread] Added new notification channel client socket (%i) to poll set",
2474 cds_lfht_add(state
->client_socket_ht
,
2475 hash_client_socket(client
->socket
),
2476 &client
->client_socket_ht_node
);
2481 notification_client_destroy(client
, state
);
2485 int handle_notification_thread_client_disconnect(
2487 struct notification_thread_state
*state
)
2490 struct notification_client
*client
;
2493 DBG("[notification-thread] Closing client connection (socket fd = %i)",
2495 client
= get_client_from_socket(client_socket
, state
);
2497 /* Internal state corruption, fatal error. */
2498 ERR("[notification-thread] Unable to find client (socket fd = %i)",
2504 ret
= lttng_poll_del(&state
->events
, client_socket
);
2506 ERR("[notification-thread] Failed to remove client socket from poll set");
2508 cds_lfht_del(state
->client_socket_ht
,
2509 &client
->client_socket_ht_node
);
2510 notification_client_destroy(client
, state
);
2516 int handle_notification_thread_client_disconnect_all(
2517 struct notification_thread_state
*state
)
2519 struct cds_lfht_iter iter
;
2520 struct notification_client
*client
;
2521 bool error_encoutered
= false;
2524 DBG("[notification-thread] Closing all client connections");
2525 cds_lfht_for_each_entry(state
->client_socket_ht
, &iter
, client
,
2526 client_socket_ht_node
) {
2529 ret
= handle_notification_thread_client_disconnect(
2530 client
->socket
, state
);
2532 error_encoutered
= true;
2536 return error_encoutered
? 1 : 0;
2539 int handle_notification_thread_trigger_unregister_all(
2540 struct notification_thread_state
*state
)
2542 bool error_occurred
= false;
2543 struct cds_lfht_iter iter
;
2544 struct lttng_trigger_ht_element
*trigger_ht_element
;
2546 cds_lfht_for_each_entry(state
->triggers_ht
, &iter
, trigger_ht_element
,
2548 int ret
= handle_notification_thread_command_unregister_trigger(
2549 state
, trigger_ht_element
->trigger
, NULL
);
2551 error_occurred
= true;
2554 return error_occurred
? -1 : 0;
2558 int client_flush_outgoing_queue(struct notification_client
*client
,
2559 struct notification_thread_state
*state
)
2562 size_t to_send_count
;
2564 assert(client
->communication
.outbound
.buffer
.size
!= 0);
2565 to_send_count
= client
->communication
.outbound
.buffer
.size
;
2566 DBG("[notification-thread] Flushing client (socket fd = %i) outgoing queue",
2569 ret
= lttcomm_send_unix_sock_non_block(client
->socket
,
2570 client
->communication
.outbound
.buffer
.data
,
2572 if ((ret
< 0 && (errno
== EAGAIN
|| errno
== EWOULDBLOCK
)) ||
2573 (ret
> 0 && ret
< to_send_count
)) {
2574 DBG("[notification-thread] Client (socket fd = %i) outgoing queue could not be completely flushed",
2576 to_send_count
-= max(ret
, 0);
2578 memcpy(client
->communication
.outbound
.buffer
.data
,
2579 client
->communication
.outbound
.buffer
.data
+
2580 client
->communication
.outbound
.buffer
.size
- to_send_count
,
2582 ret
= lttng_dynamic_buffer_set_size(
2583 &client
->communication
.outbound
.buffer
,
2590 * We want to be notified whenever there is buffer space
2591 * available to send the rest of the payload.
2593 ret
= lttng_poll_mod(&state
->events
, client
->socket
,
2594 CLIENT_POLL_MASK_IN_OUT
);
2598 } else if (ret
< 0) {
2599 /* Generic error, disconnect the client. */
2600 ERR("[notification-thread] Failed to send flush outgoing queue, disconnecting client (socket fd = %i)",
2602 ret
= handle_notification_thread_client_disconnect(
2603 client
->socket
, state
);
2608 /* No error and flushed the queue completely. */
2609 ret
= lttng_dynamic_buffer_set_size(
2610 &client
->communication
.outbound
.buffer
, 0);
2614 ret
= lttng_poll_mod(&state
->events
, client
->socket
,
2615 CLIENT_POLL_MASK_IN
);
2620 client
->communication
.outbound
.queued_command_reply
= false;
2621 client
->communication
.outbound
.dropped_notification
= false;
2630 int client_send_command_reply(struct notification_client
*client
,
2631 struct notification_thread_state
*state
,
2632 enum lttng_notification_channel_status status
)
2635 struct lttng_notification_channel_command_reply reply
= {
2636 .status
= (int8_t) status
,
2638 struct lttng_notification_channel_message msg
= {
2639 .type
= (int8_t) LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_COMMAND_REPLY
,
2640 .size
= sizeof(reply
),
2642 char buffer
[sizeof(msg
) + sizeof(reply
)];
2644 if (client
->communication
.outbound
.queued_command_reply
) {
2645 /* Protocol error. */
2649 memcpy(buffer
, &msg
, sizeof(msg
));
2650 memcpy(buffer
+ sizeof(msg
), &reply
, sizeof(reply
));
2651 DBG("[notification-thread] Send command reply (%i)", (int) status
);
2653 /* Enqueue buffer to outgoing queue and flush it. */
2654 ret
= lttng_dynamic_buffer_append(
2655 &client
->communication
.outbound
.buffer
,
2656 buffer
, sizeof(buffer
));
2661 ret
= client_flush_outgoing_queue(client
, state
);
2666 if (client
->communication
.outbound
.buffer
.size
!= 0) {
2667 /* Queue could not be emptied. */
2668 client
->communication
.outbound
.queued_command_reply
= true;
2677 int client_dispatch_message(struct notification_client
*client
,
2678 struct notification_thread_state
*state
)
2682 if (client
->communication
.inbound
.msg_type
!=
2683 LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_HANDSHAKE
&&
2684 client
->communication
.inbound
.msg_type
!=
2685 LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_UNKNOWN
&&
2686 !client
->validated
) {
2687 WARN("[notification-thread] client attempted a command before handshake");
2692 switch (client
->communication
.inbound
.msg_type
) {
2693 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_UNKNOWN
:
2696 * Receiving message header. The function will be called again
2697 * once the rest of the message as been received and can be
2700 const struct lttng_notification_channel_message
*msg
;
2702 assert(sizeof(*msg
) ==
2703 client
->communication
.inbound
.buffer
.size
);
2704 msg
= (const struct lttng_notification_channel_message
*)
2705 client
->communication
.inbound
.buffer
.data
;
2707 if (msg
->size
== 0 || msg
->size
> DEFAULT_MAX_NOTIFICATION_CLIENT_MESSAGE_PAYLOAD_SIZE
) {
2708 ERR("[notification-thread] Invalid notification channel message: length = %u", msg
->size
);
2713 switch (msg
->type
) {
2714 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_SUBSCRIBE
:
2715 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_UNSUBSCRIBE
:
2716 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_HANDSHAKE
:
2720 ERR("[notification-thread] Invalid notification channel message: unexpected message type");
2724 client
->communication
.inbound
.bytes_to_receive
= msg
->size
;
2725 client
->communication
.inbound
.msg_type
=
2726 (enum lttng_notification_channel_message_type
) msg
->type
;
2727 ret
= lttng_dynamic_buffer_set_size(
2728 &client
->communication
.inbound
.buffer
, msg
->size
);
2734 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_HANDSHAKE
:
2736 struct lttng_notification_channel_command_handshake
*handshake_client
;
2737 struct lttng_notification_channel_command_handshake handshake_reply
= {
2738 .major
= LTTNG_NOTIFICATION_CHANNEL_VERSION_MAJOR
,
2739 .minor
= LTTNG_NOTIFICATION_CHANNEL_VERSION_MINOR
,
2741 struct lttng_notification_channel_message msg_header
= {
2742 .type
= LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_HANDSHAKE
,
2743 .size
= sizeof(handshake_reply
),
2745 enum lttng_notification_channel_status status
=
2746 LTTNG_NOTIFICATION_CHANNEL_STATUS_OK
;
2747 char send_buffer
[sizeof(msg_header
) + sizeof(handshake_reply
)];
2749 memcpy(send_buffer
, &msg_header
, sizeof(msg_header
));
2750 memcpy(send_buffer
+ sizeof(msg_header
), &handshake_reply
,
2751 sizeof(handshake_reply
));
2754 (struct lttng_notification_channel_command_handshake
*)
2755 client
->communication
.inbound
.buffer
.data
;
2756 client
->major
= handshake_client
->major
;
2757 client
->minor
= handshake_client
->minor
;
2758 if (!client
->communication
.inbound
.creds_received
) {
2759 ERR("[notification-thread] No credentials received from client");
2764 client
->uid
= LTTNG_SOCK_GET_UID_CRED(
2765 &client
->communication
.inbound
.creds
);
2766 client
->gid
= LTTNG_SOCK_GET_GID_CRED(
2767 &client
->communication
.inbound
.creds
);
2768 DBG("[notification-thread] Received handshake from client (uid = %u, gid = %u) with version %i.%i",
2769 client
->uid
, client
->gid
, (int) client
->major
,
2770 (int) client
->minor
);
2772 if (handshake_client
->major
!= LTTNG_NOTIFICATION_CHANNEL_VERSION_MAJOR
) {
2773 status
= LTTNG_NOTIFICATION_CHANNEL_STATUS_UNSUPPORTED_VERSION
;
2776 ret
= lttng_dynamic_buffer_append(&client
->communication
.outbound
.buffer
,
2777 send_buffer
, sizeof(send_buffer
));
2779 ERR("[notification-thread] Failed to send protocol version to notification channel client");
2783 ret
= client_flush_outgoing_queue(client
, state
);
2788 ret
= client_send_command_reply(client
, state
, status
);
2790 ERR("[notification-thread] Failed to send reply to notification channel client");
2794 /* Set reception state to receive the next message header. */
2795 ret
= client_reset_inbound_state(client
);
2797 ERR("[notification-thread] Failed to reset client communication's inbound state");
2800 client
->validated
= true;
2803 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_SUBSCRIBE
:
2804 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_UNSUBSCRIBE
:
2806 struct lttng_condition
*condition
;
2807 enum lttng_notification_channel_status status
=
2808 LTTNG_NOTIFICATION_CHANNEL_STATUS_OK
;
2809 const struct lttng_buffer_view condition_view
=
2810 lttng_buffer_view_from_dynamic_buffer(
2811 &client
->communication
.inbound
.buffer
,
2813 size_t expected_condition_size
=
2814 client
->communication
.inbound
.buffer
.size
;
2816 ret
= lttng_condition_create_from_buffer(&condition_view
,
2818 if (ret
!= expected_condition_size
) {
2819 ERR("[notification-thread] Malformed condition received from client");
2823 if (client
->communication
.inbound
.msg_type
==
2824 LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_SUBSCRIBE
) {
2825 ret
= notification_thread_client_subscribe(client
,
2826 condition
, state
, &status
);
2828 ret
= notification_thread_client_unsubscribe(client
,
2829 condition
, state
, &status
);
2835 ret
= client_send_command_reply(client
, state
, status
);
2837 ERR("[notification-thread] Failed to send reply to notification channel client");
2841 /* Set reception state to receive the next message header. */
2842 ret
= client_reset_inbound_state(client
);
2844 ERR("[notification-thread] Failed to reset client communication's inbound state");
2856 /* Incoming data from client. */
2857 int handle_notification_thread_client_in(
2858 struct notification_thread_state
*state
, int socket
)
2861 struct notification_client
*client
;
2865 client
= get_client_from_socket(socket
, state
);
2867 /* Internal error, abort. */
2872 offset
= client
->communication
.inbound
.buffer
.size
-
2873 client
->communication
.inbound
.bytes_to_receive
;
2874 if (client
->communication
.inbound
.expect_creds
) {
2875 recv_ret
= lttcomm_recv_creds_unix_sock(socket
,
2876 client
->communication
.inbound
.buffer
.data
+ offset
,
2877 client
->communication
.inbound
.bytes_to_receive
,
2878 &client
->communication
.inbound
.creds
);
2880 client
->communication
.inbound
.expect_creds
= false;
2881 client
->communication
.inbound
.creds_received
= true;
2884 recv_ret
= lttcomm_recv_unix_sock_non_block(socket
,
2885 client
->communication
.inbound
.buffer
.data
+ offset
,
2886 client
->communication
.inbound
.bytes_to_receive
);
2889 goto error_disconnect_client
;
2892 client
->communication
.inbound
.bytes_to_receive
-= recv_ret
;
2893 if (client
->communication
.inbound
.bytes_to_receive
== 0) {
2894 ret
= client_dispatch_message(client
, state
);
2897 * Only returns an error if this client must be
2900 goto error_disconnect_client
;
2907 error_disconnect_client
:
2908 ret
= handle_notification_thread_client_disconnect(socket
, state
);
2912 /* Client ready to receive outgoing data. */
2913 int handle_notification_thread_client_out(
2914 struct notification_thread_state
*state
, int socket
)
2917 struct notification_client
*client
;
2919 client
= get_client_from_socket(socket
, state
);
2921 /* Internal error, abort. */
2926 ret
= client_flush_outgoing_queue(client
, state
);
2935 bool evaluate_buffer_usage_condition(const struct lttng_condition
*condition
,
2936 const struct channel_state_sample
*sample
,
2937 uint64_t buffer_capacity
)
2939 bool result
= false;
2941 enum lttng_condition_type condition_type
;
2942 const struct lttng_condition_buffer_usage
*use_condition
= container_of(
2943 condition
, struct lttng_condition_buffer_usage
,
2946 if (use_condition
->threshold_bytes
.set
) {
2947 threshold
= use_condition
->threshold_bytes
.value
;
2950 * Threshold was expressed as a ratio.
2952 * TODO the threshold (in bytes) of conditions expressed
2953 * as a ratio of total buffer size could be cached to
2954 * forego this double-multiplication or it could be performed
2955 * as fixed-point math.
2957 * Note that caching should accomodate the case where the
2958 * condition applies to multiple channels (i.e. don't assume
2959 * that all channels matching my_chann* have the same size...)
2961 threshold
= (uint64_t) (use_condition
->threshold_ratio
.value
*
2962 (double) buffer_capacity
);
2965 condition_type
= lttng_condition_get_type(condition
);
2966 if (condition_type
== LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW
) {
2967 DBG("[notification-thread] Low buffer usage condition being evaluated: threshold = %" PRIu64
", highest usage = %" PRIu64
,
2968 threshold
, sample
->highest_usage
);
2971 * The low condition should only be triggered once _all_ of the
2972 * streams in a channel have gone below the "low" threshold.
2974 if (sample
->highest_usage
<= threshold
) {
2978 DBG("[notification-thread] High buffer usage condition being evaluated: threshold = %" PRIu64
", highest usage = %" PRIu64
,
2979 threshold
, sample
->highest_usage
);
2982 * For high buffer usage scenarios, we want to trigger whenever
2983 * _any_ of the streams has reached the "high" threshold.
2985 if (sample
->highest_usage
>= threshold
) {
2994 bool evaluate_session_consumed_size_condition(
2995 const struct lttng_condition
*condition
,
2996 uint64_t session_consumed_size
)
2999 const struct lttng_condition_session_consumed_size
*size_condition
=
3000 container_of(condition
,
3001 struct lttng_condition_session_consumed_size
,
3004 threshold
= size_condition
->consumed_threshold_bytes
.value
;
3005 DBG("[notification-thread] Session consumed size condition being evaluated: threshold = %" PRIu64
", current size = %" PRIu64
,
3006 threshold
, session_consumed_size
);
3007 return session_consumed_size
>= threshold
;
3011 int evaluate_buffer_condition(const struct lttng_condition
*condition
,
3012 struct lttng_evaluation
**evaluation
,
3013 const struct notification_thread_state
*state
,
3014 const struct channel_state_sample
*previous_sample
,
3015 const struct channel_state_sample
*latest_sample
,
3016 uint64_t previous_session_consumed_total
,
3017 uint64_t latest_session_consumed_total
,
3018 struct channel_info
*channel_info
)
3021 enum lttng_condition_type condition_type
;
3022 const bool previous_sample_available
= !!previous_sample
;
3023 bool previous_sample_result