Bump minimum kernel version to 2.6.30 to use EFD_SEMAPHORE
[lttng-tools.git] / src / bin / lttng-sessiond / notification-thread-events.cpp
... / ...
CommitLineData
1/*
2 * Copyright (C) 2017 Jérémie Galarneau <jeremie.galarneau@efficios.com>
3 *
4 * SPDX-License-Identifier: GPL-2.0-only
5 *
6 */
7
8#include "lttng/action/action.h"
9#include "lttng/trigger/trigger-internal.hpp"
10#define _LGPL_SOURCE
11#include <urcu.h>
12#include <urcu/rculfhash.h>
13
14#include <common/defaults.hpp>
15#include <common/error.hpp>
16#include <common/futex.hpp>
17#include <common/unix.hpp>
18#include <common/dynamic-buffer.hpp>
19#include <common/hashtable/utils.hpp>
20#include <common/sessiond-comm/sessiond-comm.hpp>
21#include <common/macros.hpp>
22#include <lttng/condition/condition.h>
23#include <lttng/action/action-internal.hpp>
24#include <lttng/action/list-internal.hpp>
25#include <lttng/domain-internal.hpp>
26#include <lttng/notification/notification-internal.hpp>
27#include <lttng/condition/condition-internal.hpp>
28#include <lttng/condition/buffer-usage-internal.hpp>
29#include <lttng/condition/session-consumed-size-internal.hpp>
30#include <lttng/condition/session-rotation-internal.hpp>
31#include <lttng/condition/event-rule-matches-internal.hpp>
32#include <lttng/domain-internal.hpp>
33#include <lttng/notification/channel-internal.hpp>
34#include <lttng/trigger/trigger-internal.hpp>
35#include <lttng/event-rule/event-rule-internal.hpp>
36
37#include <time.h>
38#include <unistd.h>
39#include <inttypes.h>
40#include <fcntl.h>
41
42#include "condition-internal.hpp"
43#include "event-notifier-error-accounting.hpp"
44#include "notification-thread.hpp"
45#include "notification-thread-events.hpp"
46#include "notification-thread-commands.hpp"
47#include "lttng-sessiond.hpp"
48#include "kernel.hpp"
49
50#define CLIENT_POLL_MASK_IN (LPOLLIN | LPOLLERR | LPOLLHUP | LPOLLRDHUP)
51#define CLIENT_POLL_MASK_IN_OUT (CLIENT_POLL_MASK_IN | LPOLLOUT)
52
53/* The tracers currently limit the capture size to PIPE_BUF (4kb on linux). */
54#define MAX_CAPTURE_SIZE (PIPE_BUF)
55
56enum lttng_object_type {
57 LTTNG_OBJECT_TYPE_UNKNOWN,
58 LTTNG_OBJECT_TYPE_NONE,
59 LTTNG_OBJECT_TYPE_CHANNEL,
60 LTTNG_OBJECT_TYPE_SESSION,
61};
62
63struct lttng_trigger_list_element {
64 /* No ownership of the trigger object is assumed. */
65 struct lttng_trigger *trigger;
66 struct cds_list_head node;
67};
68
69struct lttng_channel_trigger_list {
70 struct channel_key channel_key;
71 /* List of struct lttng_trigger_list_element. */
72 struct cds_list_head list;
73 /* Node in the channel_triggers_ht */
74 struct cds_lfht_node channel_triggers_ht_node;
75 /* call_rcu delayed reclaim. */
76 struct rcu_head rcu_node;
77};
78
79/*
80 * List of triggers applying to a given session.
81 *
82 * See:
83 * - lttng_session_trigger_list_create()
84 * - lttng_session_trigger_list_build()
85 * - lttng_session_trigger_list_destroy()
86 * - lttng_session_trigger_list_add()
87 */
88struct lttng_session_trigger_list {
89 /*
90 * Not owned by this; points to the session_info structure's
91 * session name.
92 */
93 const char *session_name;
94 /* List of struct lttng_trigger_list_element. */
95 struct cds_list_head list;
96 /* Node in the session_triggers_ht */
97 struct cds_lfht_node session_triggers_ht_node;
98 /*
99 * Weak reference to the notification system's session triggers
100 * hashtable.
101 *
102 * The session trigger list structure structure is owned by
103 * the session's session_info.
104 *
105 * The session_info is kept alive the the channel_infos holding a
106 * reference to it (reference counting). When those channels are
107 * destroyed (at runtime or on teardown), the reference they hold
108 * to the session_info are released. On destruction of session_info,
109 * session_info_destroy() will remove the list of triggers applying
110 * to this session from the notification system's state.
111 *
112 * This implies that the session_triggers_ht must be destroyed
113 * after the channels.
114 */
115 struct cds_lfht *session_triggers_ht;
116 /* Used for delayed RCU reclaim. */
117 struct rcu_head rcu_node;
118};
119
120struct lttng_trigger_ht_element {
121 struct lttng_trigger *trigger;
122 struct cds_lfht_node node;
123 struct cds_lfht_node node_by_name_uid;
124 struct cds_list_head client_list_trigger_node;
125 /* call_rcu delayed reclaim. */
126 struct rcu_head rcu_node;
127};
128
129struct lttng_condition_list_element {
130 struct lttng_condition *condition;
131 struct cds_list_head node;
132};
133
134struct channel_state_sample {
135 struct channel_key key;
136 struct cds_lfht_node channel_state_ht_node;
137 uint64_t highest_usage;
138 uint64_t lowest_usage;
139 uint64_t channel_total_consumed;
140 /* call_rcu delayed reclaim. */
141 struct rcu_head rcu_node;
142};
143
144static unsigned long hash_channel_key(struct channel_key *key);
145static int evaluate_buffer_condition(const struct lttng_condition *condition,
146 struct lttng_evaluation **evaluation,
147 const struct notification_thread_state *state,
148 const struct channel_state_sample *previous_sample,
149 const struct channel_state_sample *latest_sample,
150 uint64_t previous_session_consumed_total,
151 uint64_t latest_session_consumed_total,
152 struct channel_info *channel_info);
153static
154int send_evaluation_to_clients(const struct lttng_trigger *trigger,
155 const struct lttng_evaluation *evaluation,
156 struct notification_client_list *client_list,
157 struct notification_thread_state *state,
158 uid_t channel_uid, gid_t channel_gid);
159
160
161/* session_info API */
162static
163void session_info_destroy(void *_data);
164static
165void session_info_get(struct session_info *session_info);
166static
167void session_info_put(struct session_info *session_info);
168static
169struct session_info *session_info_create(const char *name,
170 uid_t uid, gid_t gid,
171 struct lttng_session_trigger_list *trigger_list,
172 struct cds_lfht *sessions_ht);
173static
174void session_info_add_channel(struct session_info *session_info,
175 struct channel_info *channel_info);
176static
177void session_info_remove_channel(struct session_info *session_info,
178 struct channel_info *channel_info);
179
180/* lttng_session_trigger_list API */
181static
182struct lttng_session_trigger_list *lttng_session_trigger_list_create(
183 const char *session_name,
184 struct cds_lfht *session_triggers_ht);
185static
186struct lttng_session_trigger_list *lttng_session_trigger_list_build(
187 const struct notification_thread_state *state,
188 const char *session_name);
189static
190void lttng_session_trigger_list_destroy(
191 struct lttng_session_trigger_list *list);
192static
193int lttng_session_trigger_list_add(struct lttng_session_trigger_list *list,
194 struct lttng_trigger *trigger);
195
196static
197int client_handle_transmission_status(
198 struct notification_client *client,
199 enum client_transmission_status transmission_status,
200 struct notification_thread_state *state);
201
202static
203int handle_one_event_notifier_notification(
204 struct notification_thread_state *state,
205 int pipe, enum lttng_domain_type domain);
206
207static
208void free_lttng_trigger_ht_element_rcu(struct rcu_head *node);
209
210static
211int match_client_socket(struct cds_lfht_node *node, const void *key)
212{
213 /* This double-cast is intended to supress pointer-to-cast warning. */
214 const int socket = (int) (intptr_t) key;
215 const struct notification_client *client = caa_container_of(node,
216 struct notification_client, client_socket_ht_node);
217
218 return client->socket == socket;
219}
220
221static
222int match_client_id(struct cds_lfht_node *node, const void *key)
223{
224 /* This double-cast is intended to supress pointer-to-cast warning. */
225 const notification_client_id id = *((notification_client_id *) key);
226 const struct notification_client *client = caa_container_of(
227 node, struct notification_client, client_id_ht_node);
228
229 return client->id == id;
230}
231
232static
233int match_channel_trigger_list(struct cds_lfht_node *node, const void *key)
234{
235 struct channel_key *channel_key = (struct channel_key *) key;
236 struct lttng_channel_trigger_list *trigger_list;
237
238 trigger_list = caa_container_of(node, struct lttng_channel_trigger_list,
239 channel_triggers_ht_node);
240
241 return !!((channel_key->key == trigger_list->channel_key.key) &&
242 (channel_key->domain == trigger_list->channel_key.domain));
243}
244
245static
246int match_session_trigger_list(struct cds_lfht_node *node, const void *key)
247{
248 const char *session_name = (const char *) key;
249 struct lttng_session_trigger_list *trigger_list;
250
251 trigger_list = caa_container_of(node, struct lttng_session_trigger_list,
252 session_triggers_ht_node);
253
254 return !!(strcmp(trigger_list->session_name, session_name) == 0);
255}
256
257static
258int match_channel_state_sample(struct cds_lfht_node *node, const void *key)
259{
260 struct channel_key *channel_key = (struct channel_key *) key;
261 struct channel_state_sample *sample;
262
263 sample = caa_container_of(node, struct channel_state_sample,
264 channel_state_ht_node);
265
266 return !!((channel_key->key == sample->key.key) &&
267 (channel_key->domain == sample->key.domain));
268}
269
270static
271int match_channel_info(struct cds_lfht_node *node, const void *key)
272{
273 struct channel_key *channel_key = (struct channel_key *) key;
274 struct channel_info *channel_info;
275
276 channel_info = caa_container_of(node, struct channel_info,
277 channels_ht_node);
278
279 return !!((channel_key->key == channel_info->key.key) &&
280 (channel_key->domain == channel_info->key.domain));
281}
282
283static
284int match_trigger(struct cds_lfht_node *node, const void *key)
285{
286 struct lttng_trigger *trigger_key = (struct lttng_trigger *) key;
287 struct lttng_trigger_ht_element *trigger_ht_element;
288
289 trigger_ht_element = caa_container_of(node, struct lttng_trigger_ht_element,
290 node);
291
292 return !!lttng_trigger_is_equal(trigger_key, trigger_ht_element->trigger);
293}
294
295static
296int match_trigger_token(struct cds_lfht_node *node, const void *key)
297{
298 const uint64_t *_key = (uint64_t *) key;
299 struct notification_trigger_tokens_ht_element *element;
300
301 element = caa_container_of(node,
302 struct notification_trigger_tokens_ht_element, node);
303 return *_key == element->token;
304}
305
306static
307int match_client_list_condition(struct cds_lfht_node *node, const void *key)
308{
309 struct lttng_condition *condition_key = (struct lttng_condition *) key;
310 struct notification_client_list *client_list;
311 const struct lttng_condition *condition;
312
313 LTTNG_ASSERT(condition_key);
314
315 client_list = caa_container_of(node, struct notification_client_list,
316 notification_trigger_clients_ht_node);
317 condition = client_list->condition;
318
319 return !!lttng_condition_is_equal(condition_key, condition);
320}
321
322static
323int match_session(struct cds_lfht_node *node, const void *key)
324{
325 const char *name = (const char *) key;
326 struct session_info *session_info = caa_container_of(
327 node, struct session_info, sessions_ht_node);
328
329 return !strcmp(session_info->name, name);
330}
331
332static
333const char *notification_command_type_str(
334 enum notification_thread_command_type type)
335{
336 switch (type) {
337 case NOTIFICATION_COMMAND_TYPE_REGISTER_TRIGGER:
338 return "REGISTER_TRIGGER";
339 case NOTIFICATION_COMMAND_TYPE_UNREGISTER_TRIGGER:
340 return "UNREGISTER_TRIGGER";
341 case NOTIFICATION_COMMAND_TYPE_ADD_CHANNEL:
342 return "ADD_CHANNEL";
343 case NOTIFICATION_COMMAND_TYPE_REMOVE_CHANNEL:
344 return "REMOVE_CHANNEL";
345 case NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING:
346 return "SESSION_ROTATION_ONGOING";
347 case NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_COMPLETED:
348 return "SESSION_ROTATION_COMPLETED";
349 case NOTIFICATION_COMMAND_TYPE_ADD_TRACER_EVENT_SOURCE:
350 return "ADD_TRACER_EVENT_SOURCE";
351 case NOTIFICATION_COMMAND_TYPE_REMOVE_TRACER_EVENT_SOURCE:
352 return "REMOVE_TRACER_EVENT_SOURCE";
353 case NOTIFICATION_COMMAND_TYPE_LIST_TRIGGERS:
354 return "LIST_TRIGGERS";
355 case NOTIFICATION_COMMAND_TYPE_GET_TRIGGER:
356 return "GET_TRIGGER";
357 case NOTIFICATION_COMMAND_TYPE_QUIT:
358 return "QUIT";
359 case NOTIFICATION_COMMAND_TYPE_CLIENT_COMMUNICATION_UPDATE:
360 return "CLIENT_COMMUNICATION_UPDATE";
361 default:
362 abort();
363 }
364}
365
366/*
367 * Match trigger based on name and credentials only.
368 * Name duplication is NOT allowed for the same uid.
369 */
370static
371int match_trigger_by_name_uid(struct cds_lfht_node *node,
372 const void *key)
373{
374 bool match = false;
375 const char *element_trigger_name;
376 const char *key_name;
377 enum lttng_trigger_status status;
378 const struct lttng_credentials *key_creds;
379 const struct lttng_credentials *node_creds;
380 const struct lttng_trigger *trigger_key =
381 (const struct lttng_trigger *) key;
382 const struct lttng_trigger_ht_element *trigger_ht_element =
383 caa_container_of(node,
384 struct lttng_trigger_ht_element,
385 node_by_name_uid);
386
387 status = lttng_trigger_get_name(trigger_ht_element->trigger,
388 &element_trigger_name);
389 element_trigger_name = status == LTTNG_TRIGGER_STATUS_OK ?
390 element_trigger_name : NULL;
391
392 status = lttng_trigger_get_name(trigger_key, &key_name);
393 key_name = status == LTTNG_TRIGGER_STATUS_OK ? key_name : NULL;
394
395 /*
396 * Compare the names.
397 * Consider null names as not equal. This is to maintain backwards
398 * compatibility with pre-2.13 anonymous triggers. Multiples anonymous
399 * triggers are allowed for a given user.
400 */
401 if (!element_trigger_name || !key_name) {
402 goto end;
403 }
404
405 if (strcmp(element_trigger_name, key_name) != 0) {
406 goto end;
407 }
408
409 /* Compare the owners' UIDs. */
410 key_creds = lttng_trigger_get_credentials(trigger_key);
411 node_creds = lttng_trigger_get_credentials(trigger_ht_element->trigger);
412
413 match = lttng_credentials_is_equal_uid(key_creds, node_creds);
414
415end:
416 return match;
417}
418
419/*
420 * Hash trigger based on name and credentials only.
421 */
422static
423unsigned long hash_trigger_by_name_uid(const struct lttng_trigger *trigger)
424{
425 unsigned long hash = 0;
426 const struct lttng_credentials *trigger_creds;
427 const char *trigger_name;
428 enum lttng_trigger_status status;
429
430 status = lttng_trigger_get_name(trigger, &trigger_name);
431 if (status == LTTNG_TRIGGER_STATUS_OK) {
432 hash = hash_key_str(trigger_name, lttng_ht_seed);
433 }
434
435 trigger_creds = lttng_trigger_get_credentials(trigger);
436 hash ^= hash_key_ulong((void *) (unsigned long) LTTNG_OPTIONAL_GET(trigger_creds->uid),
437 lttng_ht_seed);
438
439 return hash;
440}
441
442static
443unsigned long hash_channel_key(struct channel_key *key)
444{
445 unsigned long key_hash = hash_key_u64(&key->key, lttng_ht_seed);
446 unsigned long domain_hash = hash_key_ulong(
447 (void *) (unsigned long) key->domain, lttng_ht_seed);
448
449 return key_hash ^ domain_hash;
450}
451
452static
453unsigned long hash_client_socket(int socket)
454{
455 return hash_key_ulong((void *) (unsigned long) socket, lttng_ht_seed);
456}
457
458static
459unsigned long hash_client_id(notification_client_id id)
460{
461 return hash_key_u64(&id, lttng_ht_seed);
462}
463
464/*
465 * Get the type of object to which a given condition applies. Bindings let
466 * the notification system evaluate a trigger's condition when a given
467 * object's state is updated.
468 *
469 * For instance, a condition bound to a channel will be evaluated everytime
470 * the channel's state is changed by a channel monitoring sample.
471 */
472static
473enum lttng_object_type get_condition_binding_object(
474 const struct lttng_condition *condition)
475{
476 switch (lttng_condition_get_type(condition)) {
477 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW:
478 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH:
479 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE:
480 return LTTNG_OBJECT_TYPE_CHANNEL;
481 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING:
482 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED:
483 return LTTNG_OBJECT_TYPE_SESSION;
484 case LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES:
485 return LTTNG_OBJECT_TYPE_NONE;
486 default:
487 return LTTNG_OBJECT_TYPE_UNKNOWN;
488 }
489}
490
491static
492void free_channel_info_rcu(struct rcu_head *node)
493{
494 free(caa_container_of(node, struct channel_info, rcu_node));
495}
496
497static
498void channel_info_destroy(struct channel_info *channel_info)
499{
500 if (!channel_info) {
501 return;
502 }
503
504 if (channel_info->session_info) {
505 session_info_remove_channel(channel_info->session_info,
506 channel_info);
507 session_info_put(channel_info->session_info);
508 }
509 if (channel_info->name) {
510 free(channel_info->name);
511 }
512 call_rcu(&channel_info->rcu_node, free_channel_info_rcu);
513}
514
515static
516void free_session_info_rcu(struct rcu_head *node)
517{
518 free(caa_container_of(node, struct session_info, rcu_node));
519}
520
521/* Don't call directly, use the ref-counting mechanism. */
522static
523void session_info_destroy(void *_data)
524{
525 struct session_info *session_info = (struct session_info *) _data;
526 int ret;
527
528 LTTNG_ASSERT(session_info);
529 if (session_info->channel_infos_ht) {
530 ret = cds_lfht_destroy(session_info->channel_infos_ht, NULL);
531 if (ret) {
532 ERR("Failed to destroy channel information hash table");
533 }
534 }
535 lttng_session_trigger_list_destroy(session_info->trigger_list);
536
537 rcu_read_lock();
538 cds_lfht_del(session_info->sessions_ht,
539 &session_info->sessions_ht_node);
540 rcu_read_unlock();
541 free(session_info->name);
542 call_rcu(&session_info->rcu_node, free_session_info_rcu);
543}
544
545static
546void session_info_get(struct session_info *session_info)
547{
548 if (!session_info) {
549 return;
550 }
551 lttng_ref_get(&session_info->ref);
552}
553
554static
555void session_info_put(struct session_info *session_info)
556{
557 if (!session_info) {
558 return;
559 }
560 lttng_ref_put(&session_info->ref);
561}
562
563static
564struct session_info *session_info_create(const char *name, uid_t uid, gid_t gid,
565 struct lttng_session_trigger_list *trigger_list,
566 struct cds_lfht *sessions_ht)
567{
568 struct session_info *session_info;
569
570 LTTNG_ASSERT(name);
571
572 session_info = zmalloc<struct session_info>();
573 if (!session_info) {
574 goto end;
575 }
576 lttng_ref_init(&session_info->ref, session_info_destroy);
577
578 session_info->channel_infos_ht = cds_lfht_new(DEFAULT_HT_SIZE,
579 1, 0, CDS_LFHT_AUTO_RESIZE | CDS_LFHT_ACCOUNTING, NULL);
580 if (!session_info->channel_infos_ht) {
581 goto error;
582 }
583
584 cds_lfht_node_init(&session_info->sessions_ht_node);
585 session_info->name = strdup(name);
586 if (!session_info->name) {
587 goto error;
588 }
589 session_info->uid = uid;
590 session_info->gid = gid;
591 session_info->trigger_list = trigger_list;
592 session_info->sessions_ht = sessions_ht;
593end:
594 return session_info;
595error:
596 session_info_put(session_info);
597 return NULL;
598}
599
600static
601void session_info_add_channel(struct session_info *session_info,
602 struct channel_info *channel_info)
603{
604 rcu_read_lock();
605 cds_lfht_add(session_info->channel_infos_ht,
606 hash_channel_key(&channel_info->key),
607 &channel_info->session_info_channels_ht_node);
608 rcu_read_unlock();
609}
610
611static
612void session_info_remove_channel(struct session_info *session_info,
613 struct channel_info *channel_info)
614{
615 rcu_read_lock();
616 cds_lfht_del(session_info->channel_infos_ht,
617 &channel_info->session_info_channels_ht_node);
618 rcu_read_unlock();
619}
620
621static
622struct channel_info *channel_info_create(const char *channel_name,
623 struct channel_key *channel_key, uint64_t channel_capacity,
624 struct session_info *session_info)
625{
626 struct channel_info *channel_info = zmalloc<struct channel_info>();
627
628 if (!channel_info) {
629 goto end;
630 }
631
632 cds_lfht_node_init(&channel_info->channels_ht_node);
633 cds_lfht_node_init(&channel_info->session_info_channels_ht_node);
634 memcpy(&channel_info->key, channel_key, sizeof(*channel_key));
635 channel_info->capacity = channel_capacity;
636
637 channel_info->name = strdup(channel_name);
638 if (!channel_info->name) {
639 goto error;
640 }
641
642 /*
643 * Set the references between session and channel infos:
644 * - channel_info holds a strong reference to session_info
645 * - session_info holds a weak reference to channel_info
646 */
647 session_info_get(session_info);
648 session_info_add_channel(session_info, channel_info);
649 channel_info->session_info = session_info;
650end:
651 return channel_info;
652error:
653 channel_info_destroy(channel_info);
654 return NULL;
655}
656
657bool notification_client_list_get(struct notification_client_list *list)
658{
659 return urcu_ref_get_unless_zero(&list->ref);
660}
661
662static
663void free_notification_client_list_rcu(struct rcu_head *node)
664{
665 free(caa_container_of(node, struct notification_client_list,
666 rcu_node));
667}
668
669static
670void notification_client_list_release(struct urcu_ref *list_ref)
671{
672 struct notification_client_list *list =
673 container_of(list_ref, typeof(*list), ref);
674 struct notification_client_list_element *client_list_element, *tmp;
675
676 lttng_condition_put(list->condition);
677
678 if (list->notification_trigger_clients_ht) {
679 rcu_read_lock();
680
681 cds_lfht_del(list->notification_trigger_clients_ht,
682 &list->notification_trigger_clients_ht_node);
683 rcu_read_unlock();
684 list->notification_trigger_clients_ht = NULL;
685 }
686 cds_list_for_each_entry_safe(client_list_element, tmp,
687 &list->clients_list, node) {
688 free(client_list_element);
689 }
690
691 LTTNG_ASSERT(cds_list_empty(&list->triggers_list));
692
693 pthread_mutex_destroy(&list->lock);
694 call_rcu(&list->rcu_node, free_notification_client_list_rcu);
695}
696
697static
698bool condition_applies_to_client(const struct lttng_condition *condition,
699 struct notification_client *client)
700{
701 bool applies = false;
702 struct lttng_condition_list_element *condition_list_element;
703
704 cds_list_for_each_entry(condition_list_element, &client->condition_list,
705 node) {
706 applies = lttng_condition_is_equal(
707 condition_list_element->condition,
708 condition);
709 if (applies) {
710 break;
711 }
712 }
713
714 return applies;
715}
716
717static
718struct notification_client_list *notification_client_list_create(
719 struct notification_thread_state *state,
720 const struct lttng_condition *condition)
721{
722 struct notification_client *client;
723 struct cds_lfht_iter iter;
724 struct notification_client_list *client_list;
725
726 client_list = zmalloc<notification_client_list>();
727 if (!client_list) {
728 PERROR("Failed to allocate notification client list");
729 goto end;
730 }
731
732 pthread_mutex_init(&client_list->lock, NULL);
733 /*
734 * The trigger that owns the condition has the first reference to this
735 * client list.
736 */
737 urcu_ref_init(&client_list->ref);
738 cds_lfht_node_init(&client_list->notification_trigger_clients_ht_node);
739 CDS_INIT_LIST_HEAD(&client_list->clients_list);
740 CDS_INIT_LIST_HEAD(&client_list->triggers_list);
741
742 /*
743 * Create a copy of the condition so that it's independent of any
744 * trigger. The client list may outlive the trigger object (which owns
745 * the condition) that is used to create it.
746 */
747 client_list->condition = lttng_condition_copy(condition);
748
749 /* Build a list of clients to which this new condition applies. */
750 cds_lfht_for_each_entry (state->client_socket_ht, &iter, client,
751 client_socket_ht_node) {
752 struct notification_client_list_element *client_list_element;
753
754 if (!condition_applies_to_client(condition, client)) {
755 continue;
756 }
757
758 client_list_element = zmalloc<notification_client_list_element>();
759 if (!client_list_element) {
760 goto error_put_client_list;
761 }
762
763 CDS_INIT_LIST_HEAD(&client_list_element->node);
764 client_list_element->client = client;
765 cds_list_add(&client_list_element->node, &client_list->clients_list);
766 }
767
768 client_list->notification_trigger_clients_ht =
769 state->notification_trigger_clients_ht;
770
771 rcu_read_lock();
772 /*
773 * Add the client list to the global list of client list.
774 */
775 cds_lfht_add_unique(state->notification_trigger_clients_ht,
776 lttng_condition_hash(client_list->condition),
777 match_client_list_condition,
778 client_list->condition,
779 &client_list->notification_trigger_clients_ht_node);
780 rcu_read_unlock();
781 goto end;
782
783error_put_client_list:
784 notification_client_list_put(client_list);
785 client_list = NULL;
786
787end:
788 return client_list;
789}
790
791void notification_client_list_put(struct notification_client_list *list)
792{
793 if (!list) {
794 return;
795 }
796 return urcu_ref_put(&list->ref, notification_client_list_release);
797}
798
799/* Provides a reference to the returned list. */
800static
801struct notification_client_list *get_client_list_from_condition(
802 struct notification_thread_state *state,
803 const struct lttng_condition *condition)
804{
805 struct cds_lfht_node *node;
806 struct cds_lfht_iter iter;
807 struct notification_client_list *list = NULL;
808
809 rcu_read_lock();
810 cds_lfht_lookup(state->notification_trigger_clients_ht,
811 lttng_condition_hash(condition),
812 match_client_list_condition,
813 condition,
814 &iter);
815 node = cds_lfht_iter_get_node(&iter);
816 if (node) {
817 list = container_of(node, struct notification_client_list,
818 notification_trigger_clients_ht_node);
819 list = notification_client_list_get(list) ? list : NULL;
820 }
821
822 rcu_read_unlock();
823 return list;
824}
825
826static
827int evaluate_channel_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)
832{
833 int ret;
834 struct cds_lfht_iter iter;
835 struct cds_lfht_node *node;
836 struct channel_info *channel_info = NULL;
837 struct channel_key *channel_key = NULL;
838 struct channel_state_sample *last_sample = NULL;
839 struct lttng_channel_trigger_list *channel_trigger_list = NULL;
840
841 rcu_read_lock();
842
843 /* Find the channel associated with the condition. */
844 cds_lfht_for_each_entry(state->channel_triggers_ht, &iter,
845 channel_trigger_list, channel_triggers_ht_node) {
846 struct lttng_trigger_list_element *element;
847
848 cds_list_for_each_entry(element, &channel_trigger_list->list, node) {
849 const struct lttng_condition *current_condition =
850 lttng_trigger_get_const_condition(
851 element->trigger);
852
853 LTTNG_ASSERT(current_condition);
854 if (!lttng_condition_is_equal(condition,
855 current_condition)) {
856 continue;
857 }
858
859 /* Found the trigger, save the channel key. */
860 channel_key = &channel_trigger_list->channel_key;
861 break;
862 }
863 if (channel_key) {
864 /* The channel key was found stop iteration. */
865 break;
866 }
867 }
868
869 if (!channel_key){
870 /* No channel found; normal exit. */
871 DBG("No known channel associated with newly subscribed-to condition");
872 ret = 0;
873 goto end;
874 }
875
876 /* Fetch channel info for the matching channel. */
877 cds_lfht_lookup(state->channels_ht,
878 hash_channel_key(channel_key),
879 match_channel_info,
880 channel_key,
881 &iter);
882 node = cds_lfht_iter_get_node(&iter);
883 LTTNG_ASSERT(node);
884 channel_info = caa_container_of(node, struct channel_info,
885 channels_ht_node);
886
887 /* Retrieve the channel's last sample, if it exists. */
888 cds_lfht_lookup(state->channel_state_ht,
889 hash_channel_key(channel_key),
890 match_channel_state_sample,
891 channel_key,
892 &iter);
893 node = cds_lfht_iter_get_node(&iter);
894 if (node) {
895 last_sample = caa_container_of(node,
896 struct channel_state_sample,
897 channel_state_ht_node);
898 } else {
899 /* Nothing to evaluate, no sample was ever taken. Normal exit */
900 DBG("No channel sample associated with newly subscribed-to condition");
901 ret = 0;
902 goto end;
903 }
904
905 ret = evaluate_buffer_condition(condition, evaluation, state,
906 NULL, last_sample,
907 0, channel_info->session_info->consumed_data_size,
908 channel_info);
909 if (ret) {
910 WARN("Fatal error occurred while evaluating a newly subscribed-to condition");
911 goto end;
912 }
913
914 *session_uid = channel_info->session_info->uid;
915 *session_gid = channel_info->session_info->gid;
916end:
917 rcu_read_unlock();
918 return ret;
919}
920
921static
922const char *get_condition_session_name(const struct lttng_condition *condition)
923{
924 const char *session_name = NULL;
925 enum lttng_condition_status status;
926
927 switch (lttng_condition_get_type(condition)) {
928 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW:
929 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH:
930 status = lttng_condition_buffer_usage_get_session_name(
931 condition, &session_name);
932 break;
933 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE:
934 status = lttng_condition_session_consumed_size_get_session_name(
935 condition, &session_name);
936 break;
937 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING:
938 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED:
939 status = lttng_condition_session_rotation_get_session_name(
940 condition, &session_name);
941 break;
942 default:
943 abort();
944 }
945 if (status != LTTNG_CONDITION_STATUS_OK) {
946 ERR("Failed to retrieve session rotation condition's session name");
947 goto end;
948 }
949end:
950 return session_name;
951}
952
953static
954int evaluate_session_condition_for_client(
955 const struct lttng_condition *condition,
956 struct notification_thread_state *state,
957 struct lttng_evaluation **evaluation,
958 uid_t *session_uid, gid_t *session_gid)
959{
960 int ret;
961 struct cds_lfht_iter iter;
962 struct cds_lfht_node *node;
963 const char *session_name;
964 struct session_info *session_info = NULL;
965
966 rcu_read_lock();
967 session_name = get_condition_session_name(condition);
968
969 /* Find the session associated with the trigger. */
970 cds_lfht_lookup(state->sessions_ht,
971 hash_key_str(session_name, lttng_ht_seed),
972 match_session,
973 session_name,
974 &iter);
975 node = cds_lfht_iter_get_node(&iter);
976 if (!node) {
977 DBG("No known session matching name \"%s\"",
978 session_name);
979 ret = 0;
980 goto end;
981 }
982
983 session_info = caa_container_of(node, struct session_info,
984 sessions_ht_node);
985 session_info_get(session_info);
986
987 /*
988 * Evaluation is performed in-line here since only one type of
989 * session-bound condition is handled for the moment.
990 */
991 switch (lttng_condition_get_type(condition)) {
992 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING:
993 if (!session_info->rotation.ongoing) {
994 ret = 0;
995 goto end_session_put;
996 }
997
998 *evaluation = lttng_evaluation_session_rotation_ongoing_create(
999 session_info->rotation.id);
1000 if (!*evaluation) {
1001 /* Fatal error. */
1002 ERR("Failed to create session rotation ongoing evaluation for session \"%s\"",
1003 session_info->name);
1004 ret = -1;
1005 goto end_session_put;
1006 }
1007 ret = 0;
1008 break;
1009 default:
1010 ret = 0;
1011 goto end_session_put;
1012 }
1013
1014 *session_uid = session_info->uid;
1015 *session_gid = session_info->gid;
1016
1017end_session_put:
1018 session_info_put(session_info);
1019end:
1020 rcu_read_unlock();
1021 return ret;
1022}
1023
1024static
1025int evaluate_condition_for_client(const struct lttng_trigger *trigger,
1026 const struct lttng_condition *condition,
1027 struct notification_client *client,
1028 struct notification_thread_state *state)
1029{
1030 int ret;
1031 struct lttng_evaluation *evaluation = NULL;
1032 struct notification_client_list client_list = {
1033 .lock = PTHREAD_MUTEX_INITIALIZER,
1034 .ref = {},
1035 .condition = NULL,
1036 .triggers_list = {},
1037 .clients_list = {},
1038 .notification_trigger_clients_ht = NULL,
1039 .notification_trigger_clients_ht_node = {},
1040 .rcu_node = {},
1041 };
1042 struct notification_client_list_element client_list_element = {};
1043 uid_t object_uid = 0;
1044 gid_t object_gid = 0;
1045
1046 LTTNG_ASSERT(trigger);
1047 LTTNG_ASSERT(condition);
1048 LTTNG_ASSERT(client);
1049 LTTNG_ASSERT(state);
1050
1051 switch (get_condition_binding_object(condition)) {
1052 case LTTNG_OBJECT_TYPE_SESSION:
1053 ret = evaluate_session_condition_for_client(condition, state,
1054 &evaluation, &object_uid, &object_gid);
1055 break;
1056 case LTTNG_OBJECT_TYPE_CHANNEL:
1057 ret = evaluate_channel_condition_for_client(condition, state,
1058 &evaluation, &object_uid, &object_gid);
1059 break;
1060 case LTTNG_OBJECT_TYPE_NONE:
1061 DBG("Newly subscribed-to condition not bound to object, nothing to evaluate");
1062 ret = 0;
1063 goto end;
1064 case LTTNG_OBJECT_TYPE_UNKNOWN:
1065 default:
1066 ret = -1;
1067 goto end;
1068 }
1069 if (ret) {
1070 /* Fatal error. */
1071 goto end;
1072 }
1073 if (!evaluation) {
1074 /* Evaluation yielded nothing. Normal exit. */
1075 DBG("Newly subscribed-to condition evaluated to false, nothing to report to client");
1076 ret = 0;
1077 goto end;
1078 }
1079
1080 /*
1081 * Create a temporary client list with the client currently
1082 * subscribing.
1083 */
1084 cds_lfht_node_init(&client_list.notification_trigger_clients_ht_node);
1085 CDS_INIT_LIST_HEAD(&client_list.clients_list);
1086
1087 CDS_INIT_LIST_HEAD(&client_list_element.node);
1088 client_list_element.client = client;
1089 cds_list_add(&client_list_element.node, &client_list.clients_list);
1090
1091 /* Send evaluation result to the newly-subscribed client. */
1092 DBG("Newly subscribed-to condition evaluated to true, notifying client");
1093 ret = send_evaluation_to_clients(trigger, evaluation, &client_list,
1094 state, object_uid, object_gid);
1095
1096end:
1097 return ret;
1098}
1099
1100static
1101int notification_thread_client_subscribe(struct notification_client *client,
1102 struct lttng_condition *condition,
1103 struct notification_thread_state *state,
1104 enum lttng_notification_channel_status *_status)
1105{
1106 int ret = 0;
1107 struct notification_client_list *client_list = NULL;
1108 struct lttng_condition_list_element *condition_list_element = NULL;
1109 struct notification_client_list_element *client_list_element = NULL;
1110 struct lttng_trigger_ht_element *trigger_ht_element;
1111 enum lttng_notification_channel_status status =
1112 LTTNG_NOTIFICATION_CHANNEL_STATUS_OK;
1113
1114 /*
1115 * Ensure that the client has not already subscribed to this condition
1116 * before.
1117 */
1118 cds_list_for_each_entry(condition_list_element, &client->condition_list, node) {
1119 if (lttng_condition_is_equal(condition_list_element->condition,
1120 condition)) {
1121 status = LTTNG_NOTIFICATION_CHANNEL_STATUS_ALREADY_SUBSCRIBED;
1122 goto end;
1123 }
1124 }
1125
1126 condition_list_element = zmalloc<lttng_condition_list_element>();
1127 if (!condition_list_element) {
1128 ret = -1;
1129 goto error;
1130 }
1131 client_list_element = zmalloc<notification_client_list_element>();
1132 if (!client_list_element) {
1133 ret = -1;
1134 goto error;
1135 }
1136
1137 /*
1138 * Add the newly-subscribed condition to the client's subscription list.
1139 */
1140 CDS_INIT_LIST_HEAD(&condition_list_element->node);
1141 condition_list_element->condition = condition;
1142 condition = NULL;
1143 cds_list_add(&condition_list_element->node, &client->condition_list);
1144
1145 client_list = get_client_list_from_condition(
1146 state, condition_list_element->condition);
1147 if (!client_list) {
1148 /*
1149 * No notification-emiting trigger registered with this
1150 * condition. We don't evaluate the condition right away
1151 * since this trigger is not registered yet.
1152 */
1153 free(client_list_element);
1154 goto end;
1155 }
1156
1157 /*
1158 * The condition to which the client just subscribed is evaluated
1159 * at this point so that conditions that are already TRUE result
1160 * in a notification being sent out.
1161 *
1162 * Note the iteration on all triggers which share an identical
1163 * `condition` than the one to which the client is registering. This is
1164 * done to ensure that the client receives a distinct notification for
1165 * all triggers that have a `notify` action that have this condition.
1166 */
1167 pthread_mutex_lock(&client_list->lock);
1168 cds_list_for_each_entry(trigger_ht_element,
1169 &client_list->triggers_list, client_list_trigger_node) {
1170 if (evaluate_condition_for_client(trigger_ht_element->trigger, condition_list_element->condition,
1171 client, state)) {
1172 WARN("Evaluation of a condition on client subscription failed, aborting.");
1173 ret = -1;
1174 free(client_list_element);
1175 pthread_mutex_unlock(&client_list->lock);
1176 goto end;
1177 }
1178 }
1179 pthread_mutex_unlock(&client_list->lock);
1180
1181 /*
1182 * Add the client to the list of clients interested in a given trigger
1183 * if a "notification" trigger with a corresponding condition was
1184 * added prior.
1185 */
1186 client_list_element->client = client;
1187 CDS_INIT_LIST_HEAD(&client_list_element->node);
1188
1189 pthread_mutex_lock(&client_list->lock);
1190 cds_list_add(&client_list_element->node, &client_list->clients_list);
1191 pthread_mutex_unlock(&client_list->lock);
1192end:
1193 if (_status) {
1194 *_status = status;
1195 }
1196 if (client_list) {
1197 notification_client_list_put(client_list);
1198 }
1199 lttng_condition_destroy(condition);
1200 return ret;
1201error:
1202 free(condition_list_element);
1203 free(client_list_element);
1204 lttng_condition_destroy(condition);
1205 return ret;
1206}
1207
1208static
1209int notification_thread_client_unsubscribe(
1210 struct notification_client *client,
1211 struct lttng_condition *condition,
1212 struct notification_thread_state *state,
1213 enum lttng_notification_channel_status *_status)
1214{
1215 struct notification_client_list *client_list;
1216 struct lttng_condition_list_element *condition_list_element,
1217 *condition_tmp;
1218 struct notification_client_list_element *client_list_element,
1219 *client_tmp;
1220 bool condition_found = false;
1221 enum lttng_notification_channel_status status =
1222 LTTNG_NOTIFICATION_CHANNEL_STATUS_OK;
1223
1224 /* Remove the condition from the client's condition list. */
1225 cds_list_for_each_entry_safe(condition_list_element, condition_tmp,
1226 &client->condition_list, node) {
1227 if (!lttng_condition_is_equal(condition_list_element->condition,
1228 condition)) {
1229 continue;
1230 }
1231
1232 cds_list_del(&condition_list_element->node);
1233 /*
1234 * The caller may be iterating on the client's conditions to
1235 * tear down a client's connection. In this case, the condition
1236 * will be destroyed at the end.
1237 */
1238 if (condition != condition_list_element->condition) {
1239 lttng_condition_destroy(
1240 condition_list_element->condition);
1241 }
1242 free(condition_list_element);
1243 condition_found = true;
1244 break;
1245 }
1246
1247 if (!condition_found) {
1248 status = LTTNG_NOTIFICATION_CHANNEL_STATUS_UNKNOWN_CONDITION;
1249 goto end;
1250 }
1251
1252 /*
1253 * Remove the client from the list of clients interested the trigger
1254 * matching the condition.
1255 */
1256 client_list = get_client_list_from_condition(state, condition);
1257 if (!client_list) {
1258 goto end;
1259 }
1260
1261 pthread_mutex_lock(&client_list->lock);
1262 cds_list_for_each_entry_safe(client_list_element, client_tmp,
1263 &client_list->clients_list, node) {
1264 if (client_list_element->client->id != client->id) {
1265 continue;
1266 }
1267 cds_list_del(&client_list_element->node);
1268 free(client_list_element);
1269 break;
1270 }
1271 pthread_mutex_unlock(&client_list->lock);
1272 notification_client_list_put(client_list);
1273 client_list = NULL;
1274end:
1275 lttng_condition_destroy(condition);
1276 if (_status) {
1277 *_status = status;
1278 }
1279 return 0;
1280}
1281
1282static
1283void free_notification_client_rcu(struct rcu_head *node)
1284{
1285 free(caa_container_of(node, struct notification_client, rcu_node));
1286}
1287
1288static
1289void notification_client_destroy(struct notification_client *client)
1290{
1291 if (!client) {
1292 return;
1293 }
1294
1295 /*
1296 * The client object is not reachable by other threads, no need to lock
1297 * the client here.
1298 */
1299 if (client->socket >= 0) {
1300 (void) lttcomm_close_unix_sock(client->socket);
1301 client->socket = -1;
1302 }
1303 client->communication.active = false;
1304 lttng_payload_reset(&client->communication.inbound.payload);
1305 lttng_payload_reset(&client->communication.outbound.payload);
1306 pthread_mutex_destroy(&client->lock);
1307 call_rcu(&client->rcu_node, free_notification_client_rcu);
1308}
1309
1310/*
1311 * Call with rcu_read_lock held (and hold for the lifetime of the returned
1312 * client pointer).
1313 */
1314static
1315struct notification_client *get_client_from_socket(int socket,
1316 struct notification_thread_state *state)
1317{
1318 struct cds_lfht_iter iter;
1319 struct cds_lfht_node *node;
1320 struct notification_client *client = NULL;
1321
1322 ASSERT_RCU_READ_LOCKED();
1323
1324 cds_lfht_lookup(state->client_socket_ht,
1325 hash_client_socket(socket),
1326 match_client_socket,
1327 (void *) (unsigned long) socket,
1328 &iter);
1329 node = cds_lfht_iter_get_node(&iter);
1330 if (!node) {
1331 goto end;
1332 }
1333
1334 client = caa_container_of(node, struct notification_client,
1335 client_socket_ht_node);
1336end:
1337 return client;
1338}
1339
1340/*
1341 * Call with rcu_read_lock held (and hold for the lifetime of the returned
1342 * client pointer).
1343 */
1344static
1345struct notification_client *get_client_from_id(notification_client_id id,
1346 struct notification_thread_state *state)
1347{
1348 struct cds_lfht_iter iter;
1349 struct cds_lfht_node *node;
1350 struct notification_client *client = NULL;
1351
1352 ASSERT_RCU_READ_LOCKED();
1353
1354 cds_lfht_lookup(state->client_id_ht,
1355 hash_client_id(id),
1356 match_client_id,
1357 &id,
1358 &iter);
1359 node = cds_lfht_iter_get_node(&iter);
1360 if (!node) {
1361 goto end;
1362 }
1363
1364 client = caa_container_of(node, struct notification_client,
1365 client_id_ht_node);
1366end:
1367 return client;
1368}
1369
1370static
1371bool buffer_usage_condition_applies_to_channel(
1372 const struct lttng_condition *condition,
1373 const struct channel_info *channel_info)
1374{
1375 enum lttng_condition_status status;
1376 enum lttng_domain_type condition_domain;
1377 const char *condition_session_name = NULL;
1378 const char *condition_channel_name = NULL;
1379
1380 status = lttng_condition_buffer_usage_get_domain_type(condition,
1381 &condition_domain);
1382 LTTNG_ASSERT(status == LTTNG_CONDITION_STATUS_OK);
1383 if (channel_info->key.domain != condition_domain) {
1384 goto fail;
1385 }
1386
1387 status = lttng_condition_buffer_usage_get_session_name(
1388 condition, &condition_session_name);
1389 LTTNG_ASSERT((status == LTTNG_CONDITION_STATUS_OK) && condition_session_name);
1390
1391 status = lttng_condition_buffer_usage_get_channel_name(
1392 condition, &condition_channel_name);
1393 LTTNG_ASSERT((status == LTTNG_CONDITION_STATUS_OK) && condition_channel_name);
1394
1395 if (strcmp(channel_info->session_info->name, condition_session_name)) {
1396 goto fail;
1397 }
1398 if (strcmp(channel_info->name, condition_channel_name)) {
1399 goto fail;
1400 }
1401
1402 return true;
1403fail:
1404 return false;
1405}
1406
1407static
1408bool session_consumed_size_condition_applies_to_channel(
1409 const struct lttng_condition *condition,
1410 const struct channel_info *channel_info)
1411{
1412 enum lttng_condition_status status;
1413 const char *condition_session_name = NULL;
1414
1415 status = lttng_condition_session_consumed_size_get_session_name(
1416 condition, &condition_session_name);
1417 LTTNG_ASSERT((status == LTTNG_CONDITION_STATUS_OK) && condition_session_name);
1418
1419 if (strcmp(channel_info->session_info->name, condition_session_name)) {
1420 goto fail;
1421 }
1422
1423 return true;
1424fail:
1425 return false;
1426}
1427
1428static
1429bool trigger_applies_to_channel(const struct lttng_trigger *trigger,
1430 const struct channel_info *channel_info)
1431{
1432 const struct lttng_condition *condition;
1433 bool trigger_applies;
1434
1435 condition = lttng_trigger_get_const_condition(trigger);
1436 if (!condition) {
1437 goto fail;
1438 }
1439
1440 switch (lttng_condition_get_type(condition)) {
1441 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW:
1442 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH:
1443 trigger_applies = buffer_usage_condition_applies_to_channel(
1444 condition, channel_info);
1445 break;
1446 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE:
1447 trigger_applies = session_consumed_size_condition_applies_to_channel(
1448 condition, channel_info);
1449 break;
1450 default:
1451 goto fail;
1452 }
1453
1454 return trigger_applies;
1455fail:
1456 return false;
1457}
1458
1459/* Must be called with RCU read lock held. */
1460static
1461struct lttng_session_trigger_list *get_session_trigger_list(
1462 struct notification_thread_state *state,
1463 const char *session_name)
1464{
1465 struct lttng_session_trigger_list *list = NULL;
1466 struct cds_lfht_node *node;
1467 struct cds_lfht_iter iter;
1468
1469 ASSERT_RCU_READ_LOCKED();
1470
1471 cds_lfht_lookup(state->session_triggers_ht,
1472 hash_key_str(session_name, lttng_ht_seed),
1473 match_session_trigger_list,
1474 session_name,
1475 &iter);
1476 node = cds_lfht_iter_get_node(&iter);
1477 if (!node) {
1478 /*
1479 * Not an error, the list of triggers applying to that session
1480 * will be initialized when the session is created.
1481 */
1482 DBG("No trigger list found for session \"%s\" as it is not yet known to the notification system",
1483 session_name);
1484 goto end;
1485 }
1486
1487 list = caa_container_of(node,
1488 struct lttng_session_trigger_list,
1489 session_triggers_ht_node);
1490end:
1491 return list;
1492}
1493
1494/*
1495 * Allocate an empty lttng_session_trigger_list for the session named
1496 * 'session_name'.
1497 *
1498 * No ownership of 'session_name' is assumed by the session trigger list.
1499 * It is the caller's responsability to ensure the session name is alive
1500 * for as long as this list is.
1501 */
1502static
1503struct lttng_session_trigger_list *lttng_session_trigger_list_create(
1504 const char *session_name,
1505 struct cds_lfht *session_triggers_ht)
1506{
1507 struct lttng_session_trigger_list *list;
1508
1509 list = zmalloc<lttng_session_trigger_list>();
1510 if (!list) {
1511 goto end;
1512 }
1513 list->session_name = session_name;
1514 CDS_INIT_LIST_HEAD(&list->list);
1515 cds_lfht_node_init(&list->session_triggers_ht_node);
1516 list->session_triggers_ht = session_triggers_ht;
1517
1518 rcu_read_lock();
1519 /* Publish the list through the session_triggers_ht. */
1520 cds_lfht_add(session_triggers_ht,
1521 hash_key_str(session_name, lttng_ht_seed),
1522 &list->session_triggers_ht_node);
1523 rcu_read_unlock();
1524end:
1525 return list;
1526}
1527
1528static
1529void free_session_trigger_list_rcu(struct rcu_head *node)
1530{
1531 free(caa_container_of(node, struct lttng_session_trigger_list,
1532 rcu_node));
1533}
1534
1535static
1536void lttng_session_trigger_list_destroy(struct lttng_session_trigger_list *list)
1537{
1538 struct lttng_trigger_list_element *trigger_list_element, *tmp;
1539
1540 /* Empty the list element by element, and then free the list itself. */
1541 cds_list_for_each_entry_safe(trigger_list_element, tmp,
1542 &list->list, node) {
1543 cds_list_del(&trigger_list_element->node);
1544 free(trigger_list_element);
1545 }
1546 rcu_read_lock();
1547 /* Unpublish the list from the session_triggers_ht. */
1548 cds_lfht_del(list->session_triggers_ht,
1549 &list->session_triggers_ht_node);
1550 rcu_read_unlock();
1551 call_rcu(&list->rcu_node, free_session_trigger_list_rcu);
1552}
1553
1554static
1555int lttng_session_trigger_list_add(struct lttng_session_trigger_list *list,
1556 struct lttng_trigger *trigger)
1557{
1558 int ret = 0;
1559 struct lttng_trigger_list_element *new_element =
1560 zmalloc<lttng_trigger_list_element>();
1561
1562 if (!new_element) {
1563 ret = -1;
1564 goto end;
1565 }
1566 CDS_INIT_LIST_HEAD(&new_element->node);
1567 new_element->trigger = trigger;
1568 cds_list_add(&new_element->node, &list->list);
1569end:
1570 return ret;
1571}
1572
1573static
1574bool trigger_applies_to_session(const struct lttng_trigger *trigger,
1575 const char *session_name)
1576{
1577 bool applies = false;
1578 const struct lttng_condition *condition;
1579
1580 condition = lttng_trigger_get_const_condition(trigger);
1581 switch (lttng_condition_get_type(condition)) {
1582 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING:
1583 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED:
1584 {
1585 enum lttng_condition_status condition_status;
1586 const char *condition_session_name;
1587
1588 condition_status = lttng_condition_session_rotation_get_session_name(
1589 condition, &condition_session_name);
1590 if (condition_status != LTTNG_CONDITION_STATUS_OK) {
1591 ERR("Failed to retrieve session rotation condition's session name");
1592 goto end;
1593 }
1594
1595 LTTNG_ASSERT(condition_session_name);
1596 applies = !strcmp(condition_session_name, session_name);
1597 break;
1598 }
1599 default:
1600 goto end;
1601 }
1602end:
1603 return applies;
1604}
1605
1606/*
1607 * Allocate and initialize an lttng_session_trigger_list which contains
1608 * all triggers that apply to the session named 'session_name'.
1609 *
1610 * No ownership of 'session_name' is assumed by the session trigger list.
1611 * It is the caller's responsability to ensure the session name is alive
1612 * for as long as this list is.
1613 */
1614static
1615struct lttng_session_trigger_list *lttng_session_trigger_list_build(
1616 const struct notification_thread_state *state,
1617 const char *session_name)
1618{
1619 int trigger_count = 0;
1620 struct lttng_session_trigger_list *session_trigger_list = NULL;
1621 struct lttng_trigger_ht_element *trigger_ht_element = NULL;
1622 struct cds_lfht_iter iter;
1623
1624 session_trigger_list = lttng_session_trigger_list_create(session_name,
1625 state->session_triggers_ht);
1626
1627 /* Add all triggers applying to the session named 'session_name'. */
1628 cds_lfht_for_each_entry(state->triggers_ht, &iter, trigger_ht_element,
1629 node) {
1630 int ret;
1631
1632 if (!trigger_applies_to_session(trigger_ht_element->trigger,
1633 session_name)) {
1634 continue;
1635 }
1636
1637 ret = lttng_session_trigger_list_add(session_trigger_list,
1638 trigger_ht_element->trigger);
1639 if (ret) {
1640 goto error;
1641 }
1642
1643 trigger_count++;
1644 }
1645
1646 DBG("Found %i triggers that apply to newly created session",
1647 trigger_count);
1648 return session_trigger_list;
1649error:
1650 lttng_session_trigger_list_destroy(session_trigger_list);
1651 return NULL;
1652}
1653
1654static
1655struct session_info *find_or_create_session_info(
1656 struct notification_thread_state *state,
1657 const char *name, uid_t uid, gid_t gid)
1658{
1659 struct session_info *session = NULL;
1660 struct cds_lfht_node *node;
1661 struct cds_lfht_iter iter;
1662 struct lttng_session_trigger_list *trigger_list;
1663
1664 rcu_read_lock();
1665 cds_lfht_lookup(state->sessions_ht,
1666 hash_key_str(name, lttng_ht_seed),
1667 match_session,
1668 name,
1669 &iter);
1670 node = cds_lfht_iter_get_node(&iter);
1671 if (node) {
1672 DBG("Found session info of session \"%s\" (uid = %i, gid = %i)",
1673 name, uid, gid);
1674 session = caa_container_of(node, struct session_info,
1675 sessions_ht_node);
1676 LTTNG_ASSERT(session->uid == uid);
1677 LTTNG_ASSERT(session->gid == gid);
1678 session_info_get(session);
1679 goto end;
1680 }
1681
1682 trigger_list = lttng_session_trigger_list_build(state, name);
1683 if (!trigger_list) {
1684 goto error;
1685 }
1686
1687 session = session_info_create(name, uid, gid, trigger_list,
1688 state->sessions_ht);
1689 if (!session) {
1690 ERR("Failed to allocation session info for session \"%s\" (uid = %i, gid = %i)",
1691 name, uid, gid);
1692 lttng_session_trigger_list_destroy(trigger_list);
1693 goto error;
1694 }
1695 trigger_list = NULL;
1696
1697 cds_lfht_add(state->sessions_ht, hash_key_str(name, lttng_ht_seed),
1698 &session->sessions_ht_node);
1699end:
1700 rcu_read_unlock();
1701 return session;
1702error:
1703 rcu_read_unlock();
1704 session_info_put(session);
1705 return NULL;
1706}
1707
1708static
1709int handle_notification_thread_command_add_channel(
1710 struct notification_thread_state *state,
1711 const char *session_name, uid_t session_uid, gid_t session_gid,
1712 const char *channel_name, enum lttng_domain_type channel_domain,
1713 uint64_t channel_key_int, uint64_t channel_capacity,
1714 enum lttng_error_code *cmd_result)
1715{
1716 struct cds_list_head trigger_list;
1717 struct channel_info *new_channel_info = NULL;
1718 struct channel_key channel_key = {
1719 .key = channel_key_int,
1720 .domain = channel_domain,
1721 };
1722 struct lttng_channel_trigger_list *channel_trigger_list = NULL;
1723 struct lttng_trigger_ht_element *trigger_ht_element = NULL;
1724 int trigger_count = 0;
1725 struct cds_lfht_iter iter;
1726 struct session_info *session_info = NULL;
1727
1728 DBG("Adding channel %s from session %s, channel key = %" PRIu64 " in %s domain",
1729 channel_name, session_name, channel_key_int,
1730 lttng_domain_type_str(channel_domain));
1731
1732 CDS_INIT_LIST_HEAD(&trigger_list);
1733
1734 session_info = find_or_create_session_info(state, session_name,
1735 session_uid, session_gid);
1736 if (!session_info) {
1737 /* Allocation error or an internal error occurred. */
1738 goto error;
1739 }
1740
1741 new_channel_info = channel_info_create(channel_name, &channel_key,
1742 channel_capacity, session_info);
1743 if (!new_channel_info) {
1744 goto error;
1745 }
1746
1747 rcu_read_lock();
1748 /* Build a list of all triggers applying to the new channel. */
1749 cds_lfht_for_each_entry(state->triggers_ht, &iter, trigger_ht_element,
1750 node) {
1751 struct lttng_trigger_list_element *new_element;
1752
1753 if (!trigger_applies_to_channel(trigger_ht_element->trigger,
1754 new_channel_info)) {
1755 continue;
1756 }
1757
1758 new_element = zmalloc<lttng_trigger_list_element>();
1759 if (!new_element) {
1760 rcu_read_unlock();
1761 goto error;
1762 }
1763 CDS_INIT_LIST_HEAD(&new_element->node);
1764 new_element->trigger = trigger_ht_element->trigger;
1765 cds_list_add(&new_element->node, &trigger_list);
1766 trigger_count++;
1767 }
1768 rcu_read_unlock();
1769
1770 DBG("Found %i triggers that apply to newly added channel",
1771 trigger_count);
1772 channel_trigger_list = zmalloc<lttng_channel_trigger_list>();
1773 if (!channel_trigger_list) {
1774 goto error;
1775 }
1776 channel_trigger_list->channel_key = new_channel_info->key;
1777 CDS_INIT_LIST_HEAD(&channel_trigger_list->list);
1778 cds_lfht_node_init(&channel_trigger_list->channel_triggers_ht_node);
1779 cds_list_splice(&trigger_list, &channel_trigger_list->list);
1780
1781 rcu_read_lock();
1782 /* Add channel to the channel_ht which owns the channel_infos. */
1783 cds_lfht_add(state->channels_ht,
1784 hash_channel_key(&new_channel_info->key),
1785 &new_channel_info->channels_ht_node);
1786 /*
1787 * Add the list of triggers associated with this channel to the
1788 * channel_triggers_ht.
1789 */
1790 cds_lfht_add(state->channel_triggers_ht,
1791 hash_channel_key(&new_channel_info->key),
1792 &channel_trigger_list->channel_triggers_ht_node);
1793 rcu_read_unlock();
1794 session_info_put(session_info);
1795 *cmd_result = LTTNG_OK;
1796 return 0;
1797error:
1798 channel_info_destroy(new_channel_info);
1799 session_info_put(session_info);
1800 return 1;
1801}
1802
1803static
1804void free_channel_trigger_list_rcu(struct rcu_head *node)
1805{
1806 free(caa_container_of(node, struct lttng_channel_trigger_list,
1807 rcu_node));
1808}
1809
1810static
1811void free_channel_state_sample_rcu(struct rcu_head *node)
1812{
1813 free(caa_container_of(node, struct channel_state_sample,
1814 rcu_node));
1815}
1816
1817static
1818int handle_notification_thread_command_remove_channel(
1819 struct notification_thread_state *state,
1820 uint64_t channel_key, enum lttng_domain_type domain,
1821 enum lttng_error_code *cmd_result)
1822{
1823 struct cds_lfht_node *node;
1824 struct cds_lfht_iter iter;
1825 struct lttng_channel_trigger_list *trigger_list;
1826 struct lttng_trigger_list_element *trigger_list_element, *tmp;
1827 struct channel_key key = { .key = channel_key, .domain = domain };
1828 struct channel_info *channel_info;
1829
1830 DBG("Removing channel key = %" PRIu64 " in %s domain",
1831 channel_key, lttng_domain_type_str(domain));
1832
1833 rcu_read_lock();
1834
1835 cds_lfht_lookup(state->channel_triggers_ht,
1836 hash_channel_key(&key),
1837 match_channel_trigger_list,
1838 &key,
1839 &iter);
1840 node = cds_lfht_iter_get_node(&iter);
1841 /*
1842 * There is a severe internal error if we are being asked to remove a
1843 * channel that doesn't exist.
1844 */
1845 if (!node) {
1846 ERR("Channel being removed is unknown to the notification thread");
1847 goto end;
1848 }
1849
1850 /* Free the list of triggers associated with this channel. */
1851 trigger_list = caa_container_of(node, struct lttng_channel_trigger_list,
1852 channel_triggers_ht_node);
1853 cds_list_for_each_entry_safe(trigger_list_element, tmp,
1854 &trigger_list->list, node) {
1855 cds_list_del(&trigger_list_element->node);
1856 free(trigger_list_element);
1857 }
1858 cds_lfht_del(state->channel_triggers_ht, node);
1859 call_rcu(&trigger_list->rcu_node, free_channel_trigger_list_rcu);
1860
1861 /* Free sampled channel state. */
1862 cds_lfht_lookup(state->channel_state_ht,
1863 hash_channel_key(&key),
1864 match_channel_state_sample,
1865 &key,
1866 &iter);
1867 node = cds_lfht_iter_get_node(&iter);
1868 /*
1869 * This is expected to be NULL if the channel is destroyed before we
1870 * received a sample.
1871 */
1872 if (node) {
1873 struct channel_state_sample *sample = caa_container_of(node,
1874 struct channel_state_sample,
1875 channel_state_ht_node);
1876
1877 cds_lfht_del(state->channel_state_ht, node);
1878 call_rcu(&sample->rcu_node, free_channel_state_sample_rcu);
1879 }
1880
1881 /* Remove the channel from the channels_ht and free it. */
1882 cds_lfht_lookup(state->channels_ht,
1883 hash_channel_key(&key),
1884 match_channel_info,
1885 &key,
1886 &iter);
1887 node = cds_lfht_iter_get_node(&iter);
1888 LTTNG_ASSERT(node);
1889 channel_info = caa_container_of(node, struct channel_info,
1890 channels_ht_node);
1891 cds_lfht_del(state->channels_ht, node);
1892 channel_info_destroy(channel_info);
1893end:
1894 rcu_read_unlock();
1895 *cmd_result = LTTNG_OK;
1896 return 0;
1897}
1898
1899static
1900int handle_notification_thread_command_session_rotation(
1901 struct notification_thread_state *state,
1902 enum notification_thread_command_type cmd_type,
1903 const char *session_name, uid_t session_uid, gid_t session_gid,
1904 uint64_t trace_archive_chunk_id,
1905 struct lttng_trace_archive_location *location,
1906 enum lttng_error_code *_cmd_result)
1907{
1908 int ret = 0;
1909 enum lttng_error_code cmd_result = LTTNG_OK;
1910 struct lttng_session_trigger_list *trigger_list;
1911 struct lttng_trigger_list_element *trigger_list_element;
1912 struct session_info *session_info;
1913 const struct lttng_credentials session_creds = {
1914 .uid = LTTNG_OPTIONAL_INIT_VALUE(session_uid),
1915 .gid = LTTNG_OPTIONAL_INIT_VALUE(session_gid),
1916 };
1917
1918 rcu_read_lock();
1919
1920 session_info = find_or_create_session_info(state, session_name,
1921 session_uid, session_gid);
1922 if (!session_info) {
1923 /* Allocation error or an internal error occurred. */
1924 ret = -1;
1925 cmd_result = LTTNG_ERR_NOMEM;
1926 goto end;
1927 }
1928
1929 session_info->rotation.ongoing =
1930 cmd_type == NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING;
1931 session_info->rotation.id = trace_archive_chunk_id;
1932 trigger_list = get_session_trigger_list(state, session_name);
1933 if (!trigger_list) {
1934 DBG("No triggers applying to session \"%s\" found",
1935 session_name);
1936 goto end;
1937 }
1938
1939 cds_list_for_each_entry(trigger_list_element, &trigger_list->list,
1940 node) {
1941 const struct lttng_condition *condition;
1942 struct lttng_trigger *trigger;
1943 struct notification_client_list *client_list;
1944 struct lttng_evaluation *evaluation = NULL;
1945 enum lttng_condition_type condition_type;
1946 enum action_executor_status executor_status;
1947
1948 trigger = trigger_list_element->trigger;
1949 condition = lttng_trigger_get_const_condition(trigger);
1950 LTTNG_ASSERT(condition);
1951 condition_type = lttng_condition_get_type(condition);
1952
1953 if (condition_type == LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING &&
1954 cmd_type != NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING) {
1955 continue;
1956 } else if (condition_type == LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED &&
1957 cmd_type != NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_COMPLETED) {
1958 continue;
1959 }
1960
1961 client_list = get_client_list_from_condition(state, condition);
1962 if (cmd_type == NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING) {
1963 evaluation = lttng_evaluation_session_rotation_ongoing_create(
1964 trace_archive_chunk_id);
1965 } else {
1966 evaluation = lttng_evaluation_session_rotation_completed_create(
1967 trace_archive_chunk_id, location);
1968 }
1969
1970 if (!evaluation) {
1971 /* Internal error */
1972 ret = -1;
1973 cmd_result = LTTNG_ERR_UNK;
1974 goto put_list;
1975 }
1976
1977 /*
1978 * Ownership of `evaluation` transferred to the action executor
1979 * no matter the result.
1980 */
1981 executor_status = action_executor_enqueue_trigger(
1982 state->executor, trigger, evaluation,
1983 &session_creds, client_list);
1984 evaluation = NULL;
1985 switch (executor_status) {
1986 case ACTION_EXECUTOR_STATUS_OK:
1987 break;
1988 case ACTION_EXECUTOR_STATUS_ERROR:
1989 case ACTION_EXECUTOR_STATUS_INVALID:
1990 /*
1991 * TODO Add trigger identification (name/id) when
1992 * it is added to the API.
1993 */
1994 ERR("Fatal error occurred while enqueuing action associated with session rotation trigger");
1995 ret = -1;
1996 goto put_list;
1997 case ACTION_EXECUTOR_STATUS_OVERFLOW:
1998 /*
1999 * TODO Add trigger identification (name/id) when
2000 * it is added to the API.
2001 *
2002 * Not a fatal error.
2003 */
2004 WARN("No space left when enqueuing action associated with session rotation trigger");
2005 ret = 0;
2006 goto put_list;
2007 default:
2008 abort();
2009 }
2010
2011put_list:
2012 notification_client_list_put(client_list);
2013 if (caa_unlikely(ret)) {
2014 break;
2015 }
2016 }
2017end:
2018 session_info_put(session_info);
2019 *_cmd_result = cmd_result;
2020 rcu_read_unlock();
2021 return ret;
2022}
2023
2024static
2025int handle_notification_thread_command_add_tracer_event_source(
2026 struct notification_thread_state *state,
2027 int tracer_event_source_fd,
2028 enum lttng_domain_type domain_type,
2029 enum lttng_error_code *_cmd_result)
2030{
2031 int ret = 0;
2032 enum lttng_error_code cmd_result = LTTNG_OK;
2033 struct notification_event_tracer_event_source_element *element = NULL;
2034
2035 element = zmalloc<notification_event_tracer_event_source_element>();
2036 if (!element) {
2037 cmd_result = LTTNG_ERR_NOMEM;
2038 ret = -1;
2039 goto end;
2040 }
2041
2042 element->fd = tracer_event_source_fd;
2043 element->domain = domain_type;
2044
2045 cds_list_add(&element->node, &state->tracer_event_sources_list);
2046
2047 DBG3("Adding tracer event source fd to poll set: tracer_event_source_fd = %d, domain = '%s'",
2048 tracer_event_source_fd,
2049 lttng_domain_type_str(domain_type));
2050
2051 /* Adding the read side pipe to the event poll. */
2052 ret = lttng_poll_add(&state->events, tracer_event_source_fd, LPOLLPRI | LPOLLIN | LPOLLERR);
2053 if (ret < 0) {
2054 ERR("Failed to add tracer event source to poll set: tracer_event_source_fd = %d, domain = '%s'",
2055 tracer_event_source_fd,
2056 lttng_domain_type_str(element->domain));
2057 cds_list_del(&element->node);
2058 free(element);
2059 goto end;
2060 }
2061
2062 element->is_fd_in_poll_set = true;
2063
2064end:
2065 *_cmd_result = cmd_result;
2066 return ret;
2067}
2068
2069static
2070int drain_event_notifier_notification_pipe(
2071 struct notification_thread_state *state,
2072 int pipe, enum lttng_domain_type domain)
2073{
2074 struct lttng_poll_event events = {};
2075 int ret;
2076
2077 ret = lttng_poll_create(&events, 1, LTTNG_CLOEXEC);
2078 if (ret < 0) {
2079 ERR("Error creating lttng_poll_event");
2080 goto end;
2081 }
2082
2083 ret = lttng_poll_add(&events, pipe, LPOLLIN);
2084 if (ret < 0) {
2085 ERR("Error adding fd event notifier notification pipe to lttng_poll_event: fd = %d",
2086 pipe);
2087 goto end;
2088 }
2089
2090 while (true) {
2091 /*
2092 * Continue to consume notifications as long as there are new
2093 * ones coming in. The tracer has been asked to stop producing
2094 * them.
2095 *
2096 * LPOLLIN is explicitly checked since LPOLLHUP is implicitly
2097 * monitored (on Linux, at least) and will be returned when
2098 * the pipe is closed but empty.
2099 */
2100 ret = lttng_poll_wait_interruptible(&events, 0);
2101 if (ret == 0 || (LTTNG_POLL_GETEV(&events, 0) & LPOLLIN) == 0) {
2102 /* No more notification to be read on this pipe. */
2103 ret = 0;
2104 goto end;
2105 } else if (ret < 0) {
2106 PERROR("Failed on lttng_poll_wait_interruptible() call");
2107 ret = -1;
2108 goto end;
2109 }
2110
2111 ret = handle_one_event_notifier_notification(state, pipe, domain);
2112 if (ret) {
2113 ERR("Error consuming an event notifier notification from pipe: fd = %d",
2114 pipe);
2115 }
2116 }
2117end:
2118 lttng_poll_clean(&events);
2119 return ret;
2120}
2121
2122static
2123struct notification_event_tracer_event_source_element *
2124find_tracer_event_source_element(struct notification_thread_state *state,
2125 int tracer_event_source_fd)
2126{
2127 struct notification_event_tracer_event_source_element *source_element;
2128
2129 cds_list_for_each_entry(source_element,
2130 &state->tracer_event_sources_list, node) {
2131 if (source_element->fd == tracer_event_source_fd) {
2132 goto end;
2133 }
2134 }
2135
2136 source_element = NULL;
2137end:
2138 return source_element;
2139}
2140
2141static
2142int remove_tracer_event_source_from_pollset(
2143 struct notification_thread_state *state,
2144 struct notification_event_tracer_event_source_element *source_element)
2145{
2146 int ret = 0;
2147
2148 LTTNG_ASSERT(source_element->is_fd_in_poll_set);
2149
2150 DBG3("Removing tracer event source from poll set: tracer_event_source_fd = %d, domain = '%s'",
2151 source_element->fd,
2152 lttng_domain_type_str(source_element->domain));
2153
2154 /* Removing the fd from the event poll set. */
2155 ret = lttng_poll_del(&state->events, source_element->fd);
2156 if (ret < 0) {
2157 ERR("Failed to remove tracer event source from poll set: tracer_event_source_fd = %d, domain = '%s'",
2158 source_element->fd,
2159 lttng_domain_type_str(source_element->domain));
2160 ret = -1;
2161 goto end;
2162 }
2163
2164 source_element->is_fd_in_poll_set = false;
2165
2166 /*
2167 * Force the notification thread to restart the poll() loop to ensure
2168 * that any events from the removed fd are removed.
2169 */
2170 state->restart_poll = true;
2171
2172 ret = drain_event_notifier_notification_pipe(state, source_element->fd,
2173 source_element->domain);
2174 if (ret) {
2175 ERR("Error draining event notifier notification: tracer_event_source_fd = %d, domain = %s",
2176 source_element->fd,
2177 lttng_domain_type_str(source_element->domain));
2178 ret = -1;
2179 goto end;
2180 }
2181
2182end:
2183 return ret;
2184}
2185
2186int handle_notification_thread_tracer_event_source_died(
2187 struct notification_thread_state *state,
2188 int tracer_event_source_fd)
2189{
2190 int ret = 0;
2191 struct notification_event_tracer_event_source_element *source_element;
2192
2193 source_element = find_tracer_event_source_element(state,
2194 tracer_event_source_fd);
2195
2196 LTTNG_ASSERT(source_element);
2197
2198 ret = remove_tracer_event_source_from_pollset(state, source_element);
2199 if (ret) {
2200 ERR("Failed to remove dead tracer event source from poll set");
2201 }
2202
2203 return ret;
2204}
2205
2206static
2207int handle_notification_thread_command_remove_tracer_event_source(
2208 struct notification_thread_state *state,
2209 int tracer_event_source_fd,
2210 enum lttng_error_code *_cmd_result)
2211{
2212 int ret = 0;
2213 enum lttng_error_code cmd_result = LTTNG_OK;
2214 struct notification_event_tracer_event_source_element *source_element = NULL;
2215
2216 source_element = find_tracer_event_source_element(state,
2217 tracer_event_source_fd);
2218
2219 LTTNG_ASSERT(source_element);
2220
2221 /* Remove the tracer source from the list. */
2222 cds_list_del(&source_element->node);
2223
2224 if (!source_element->is_fd_in_poll_set) {
2225 /* Skip the poll set removal. */
2226 goto end;
2227 }
2228
2229 ret = remove_tracer_event_source_from_pollset(state, source_element);
2230 if (ret) {
2231 ERR("Failed to remove tracer event source from poll set");
2232 cmd_result = LTTNG_ERR_FATAL;
2233 }
2234
2235end:
2236 free(source_element);
2237 *_cmd_result = cmd_result;
2238 return ret;
2239}
2240
2241static int handle_notification_thread_command_list_triggers(
2242 struct notification_thread_handle *handle __attribute__((unused)),
2243 struct notification_thread_state *state,
2244 uid_t client_uid,
2245 struct lttng_triggers **triggers,
2246 enum lttng_error_code *_cmd_result)
2247{
2248 int ret = 0;
2249 enum lttng_error_code cmd_result = LTTNG_OK;
2250 struct cds_lfht_iter iter;
2251 struct lttng_trigger_ht_element *trigger_ht_element;
2252 struct lttng_triggers *local_triggers = NULL;
2253 const struct lttng_credentials *creds;
2254
2255 rcu_read_lock();
2256
2257 local_triggers = lttng_triggers_create();
2258 if (!local_triggers) {
2259 /* Not a fatal error. */
2260 cmd_result = LTTNG_ERR_NOMEM;
2261 goto end;
2262 }
2263
2264 cds_lfht_for_each_entry(state->triggers_ht, &iter,
2265 trigger_ht_element, node) {
2266 /*
2267 * Only return the triggers to which the client has access.
2268 * The root user has visibility over all triggers.
2269 */
2270 creds = lttng_trigger_get_credentials(trigger_ht_element->trigger);
2271 if (client_uid != lttng_credentials_get_uid(creds) && client_uid != 0) {
2272 continue;
2273 }
2274
2275 ret = lttng_triggers_add(local_triggers,
2276 trigger_ht_element->trigger);
2277 if (ret < 0) {
2278 /* Not a fatal error. */
2279 ret = 0;
2280 cmd_result = LTTNG_ERR_NOMEM;
2281 goto end;
2282 }
2283 }
2284
2285 /* Transferring ownership to the caller. */
2286 *triggers = local_triggers;
2287 local_triggers = NULL;
2288
2289end:
2290 rcu_read_unlock();
2291 lttng_triggers_destroy(local_triggers);
2292 *_cmd_result = cmd_result;
2293 return ret;
2294}
2295
2296static inline void get_trigger_info_for_log(const struct lttng_trigger *trigger,
2297 const char **trigger_name,
2298 uid_t *trigger_owner_uid)
2299{
2300 enum lttng_trigger_status trigger_status;
2301
2302 trigger_status = lttng_trigger_get_name(trigger, trigger_name);
2303 switch (trigger_status) {
2304 case LTTNG_TRIGGER_STATUS_OK:
2305 break;
2306 case LTTNG_TRIGGER_STATUS_UNSET:
2307 *trigger_name = "(anonymous)";
2308 break;
2309 default:
2310 abort();
2311 }
2312
2313 trigger_status = lttng_trigger_get_owner_uid(trigger,
2314 trigger_owner_uid);
2315 LTTNG_ASSERT(trigger_status == LTTNG_TRIGGER_STATUS_OK);
2316}
2317
2318static int handle_notification_thread_command_get_trigger(
2319 struct notification_thread_state *state,
2320 const struct lttng_trigger *trigger,
2321 struct lttng_trigger **registered_trigger,
2322 enum lttng_error_code *_cmd_result)
2323{
2324 int ret = -1;
2325 struct cds_lfht_iter iter;
2326 struct lttng_trigger_ht_element *trigger_ht_element;
2327 enum lttng_error_code cmd_result = LTTNG_ERR_TRIGGER_NOT_FOUND;
2328 const char *trigger_name;
2329 uid_t trigger_owner_uid;
2330
2331 rcu_read_lock();
2332
2333 cds_lfht_for_each_entry(
2334 state->triggers_ht, &iter, trigger_ht_element, node) {
2335 if (lttng_trigger_is_equal(
2336 trigger, trigger_ht_element->trigger)) {
2337 /* Take one reference on the return trigger. */
2338 *registered_trigger = trigger_ht_element->trigger;
2339 lttng_trigger_get(*registered_trigger);
2340 ret = 0;
2341 cmd_result = LTTNG_OK;
2342 goto end;
2343 }
2344 }
2345
2346 /* Not a fatal error if the trigger is not found. */
2347 get_trigger_info_for_log(trigger, &trigger_name, &trigger_owner_uid);
2348 DBG("Failed to retrieve registered version of trigger: trigger name = '%s', trigger owner uid = %d",
2349 trigger_name, (int) trigger_owner_uid);
2350
2351 ret = 0;
2352
2353end:
2354 rcu_read_unlock();
2355 *_cmd_result = cmd_result;
2356 return ret;
2357}
2358
2359static
2360bool condition_is_supported(struct lttng_condition *condition)
2361{
2362 bool is_supported;
2363
2364 switch (lttng_condition_get_type(condition)) {
2365 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW:
2366 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH:
2367 {
2368 int ret;
2369 enum lttng_domain_type domain;
2370
2371 ret = lttng_condition_buffer_usage_get_domain_type(condition,
2372 &domain);
2373 LTTNG_ASSERT(ret == 0);
2374
2375 if (domain != LTTNG_DOMAIN_KERNEL) {
2376 is_supported = true;
2377 goto end;
2378 }
2379
2380 /*
2381 * Older kernel tracers don't expose the API to monitor their
2382 * buffers. Therefore, we reject triggers that require that
2383 * mechanism to be available to be evaluated.
2384 *
2385 * Assume unsupported on error.
2386 */
2387 is_supported = kernel_supports_ring_buffer_snapshot_sample_positions() == 1;
2388 break;
2389 }
2390 case LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES:
2391 {
2392 const struct lttng_event_rule *event_rule;
2393 enum lttng_domain_type domain;
2394 const enum lttng_condition_status status =
2395 lttng_condition_event_rule_matches_get_rule(
2396 condition, &event_rule);
2397
2398 LTTNG_ASSERT(status == LTTNG_CONDITION_STATUS_OK);
2399
2400 domain = lttng_event_rule_get_domain_type(event_rule);
2401 if (domain != LTTNG_DOMAIN_KERNEL) {
2402 is_supported = true;
2403 goto end;
2404 }
2405
2406 /*
2407 * Older kernel tracers can't emit notification. Therefore, we
2408 * reject triggers that require that mechanism to be available
2409 * to be evaluated.
2410 *
2411 * Assume unsupported on error.
2412 */
2413 is_supported = kernel_supports_event_notifiers() == 1;
2414 break;
2415 }
2416 default:
2417 is_supported = true;
2418 }
2419end:
2420 return is_supported;
2421}
2422
2423/* Must be called with RCU read lock held. */
2424static
2425int bind_trigger_to_matching_session(struct lttng_trigger *trigger,
2426 struct notification_thread_state *state)
2427{
2428 int ret = 0;
2429 const struct lttng_condition *condition;
2430 const char *session_name;
2431 struct lttng_session_trigger_list *trigger_list;
2432
2433 ASSERT_RCU_READ_LOCKED();
2434
2435 condition = lttng_trigger_get_const_condition(trigger);
2436 switch (lttng_condition_get_type(condition)) {
2437 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING:
2438 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED:
2439 {
2440 enum lttng_condition_status status;
2441
2442 status = lttng_condition_session_rotation_get_session_name(
2443 condition, &session_name);
2444 if (status != LTTNG_CONDITION_STATUS_OK) {
2445 ERR("Failed to bind trigger to session: unable to get 'session_rotation' condition's session name");
2446 ret = -1;
2447 goto end;
2448 }
2449 break;
2450 }
2451 default:
2452 ret = -1;
2453 goto end;
2454 }
2455
2456 trigger_list = get_session_trigger_list(state, session_name);
2457 if (!trigger_list) {
2458 DBG("Unable to bind trigger applying to session \"%s\" as it is not yet known to the notification system",
2459 session_name);
2460 goto end;
2461
2462 }
2463
2464 DBG("Newly registered trigger bound to session \"%s\"",
2465 session_name);
2466 ret = lttng_session_trigger_list_add(trigger_list, trigger);
2467end:
2468 return ret;
2469}
2470
2471/* Must be called with RCU read lock held. */
2472static
2473int bind_trigger_to_matching_channels(struct lttng_trigger *trigger,
2474 struct notification_thread_state *state)
2475{
2476 int ret = 0;
2477 struct cds_lfht_node *node;
2478 struct cds_lfht_iter iter;
2479 struct channel_info *channel;
2480
2481 ASSERT_RCU_READ_LOCKED();
2482
2483 cds_lfht_for_each_entry(state->channels_ht, &iter, channel,
2484 channels_ht_node) {
2485 struct lttng_trigger_list_element *trigger_list_element;
2486 struct lttng_channel_trigger_list *trigger_list;
2487 struct cds_lfht_iter lookup_iter;
2488
2489 if (!trigger_applies_to_channel(trigger, channel)) {
2490 continue;
2491 }
2492
2493 cds_lfht_lookup(state->channel_triggers_ht,
2494 hash_channel_key(&channel->key),
2495 match_channel_trigger_list,
2496 &channel->key,
2497 &lookup_iter);
2498 node = cds_lfht_iter_get_node(&lookup_iter);
2499 LTTNG_ASSERT(node);
2500 trigger_list = caa_container_of(node,
2501 struct lttng_channel_trigger_list,
2502 channel_triggers_ht_node);
2503
2504 trigger_list_element = zmalloc<lttng_trigger_list_element>();
2505 if (!trigger_list_element) {
2506 ret = -1;
2507 goto end;
2508 }
2509 CDS_INIT_LIST_HEAD(&trigger_list_element->node);
2510 trigger_list_element->trigger = trigger;
2511 cds_list_add(&trigger_list_element->node, &trigger_list->list);
2512 DBG("Newly registered trigger bound to channel \"%s\"",
2513 channel->name);
2514 }
2515end:
2516 return ret;
2517}
2518
2519static
2520bool is_trigger_action_notify(const struct lttng_trigger *trigger)
2521{
2522 bool is_notify = false;
2523 unsigned int i, count;
2524 enum lttng_action_status action_status;
2525 const struct lttng_action *action =
2526 lttng_trigger_get_const_action(trigger);
2527 enum lttng_action_type action_type;
2528
2529 LTTNG_ASSERT(action);
2530 action_type = lttng_action_get_type(action);
2531 if (action_type == LTTNG_ACTION_TYPE_NOTIFY) {
2532 is_notify = true;
2533 goto end;
2534 } else if (action_type != LTTNG_ACTION_TYPE_LIST) {
2535 goto end;
2536 }
2537
2538 action_status = lttng_action_list_get_count(action, &count);
2539 LTTNG_ASSERT(action_status == LTTNG_ACTION_STATUS_OK);
2540
2541 for (i = 0; i < count; i++) {
2542 const struct lttng_action *inner_action =
2543 lttng_action_list_get_at_index(
2544 action, i);
2545
2546 action_type = lttng_action_get_type(inner_action);
2547 if (action_type == LTTNG_ACTION_TYPE_NOTIFY) {
2548 is_notify = true;
2549 goto end;
2550 }
2551 }
2552
2553end:
2554 return is_notify;
2555}
2556
2557static bool trigger_name_taken(struct notification_thread_state *state,
2558 const struct lttng_trigger *trigger)
2559{
2560 struct cds_lfht_iter iter;
2561
2562 /*
2563 * No duplicata is allowed in the triggers_by_name_uid_ht.
2564 * The match is done against the trigger name and uid.
2565 */
2566 cds_lfht_lookup(state->triggers_by_name_uid_ht,
2567 hash_trigger_by_name_uid(trigger),
2568 match_trigger_by_name_uid,
2569 trigger,
2570 &iter);
2571 return !!cds_lfht_iter_get_node(&iter);
2572}
2573
2574static
2575enum lttng_error_code generate_trigger_name(
2576 struct notification_thread_state *state,
2577 struct lttng_trigger *trigger, const char **name)
2578{
2579 enum lttng_error_code ret_code = LTTNG_OK;
2580 bool taken = false;
2581 enum lttng_trigger_status status;
2582
2583 do {
2584 const int ret = lttng_trigger_generate_name(trigger,
2585 state->trigger_id.name_offset++);
2586 if (ret) {
2587 /* The only reason this can fail right now. */
2588 ret_code = LTTNG_ERR_NOMEM;
2589 break;
2590 }
2591
2592 status = lttng_trigger_get_name(trigger, name);
2593 LTTNG_ASSERT(status == LTTNG_TRIGGER_STATUS_OK);
2594
2595 taken = trigger_name_taken(state, trigger);
2596 } while (taken || state->trigger_id.name_offset == UINT64_MAX);
2597
2598 return ret_code;
2599}
2600
2601static inline
2602void notif_thread_state_remove_trigger_ht_elem(
2603 struct notification_thread_state *state,
2604 struct lttng_trigger_ht_element *trigger_ht_element)
2605{
2606 LTTNG_ASSERT(state);
2607 LTTNG_ASSERT(trigger_ht_element);
2608
2609 cds_lfht_del(state->triggers_ht, &trigger_ht_element->node);
2610 cds_lfht_del(state->triggers_by_name_uid_ht, &trigger_ht_element->node_by_name_uid);
2611}
2612
2613static
2614enum lttng_error_code setup_tracer_notifier(
2615 struct notification_thread_state *state,
2616 struct lttng_trigger *trigger)
2617{
2618 enum lttng_error_code ret;
2619 enum event_notifier_error_accounting_status error_accounting_status;
2620 struct cds_lfht_node *node;
2621 uint64_t error_counter_index = 0;
2622 struct lttng_condition *condition = lttng_trigger_get_condition(trigger);
2623 struct notification_trigger_tokens_ht_element *trigger_tokens_ht_element = NULL;
2624
2625 trigger_tokens_ht_element = zmalloc<notification_trigger_tokens_ht_element>();
2626 if (!trigger_tokens_ht_element) {
2627 ret = LTTNG_ERR_NOMEM;
2628 goto end;
2629 }
2630
2631 /* Add trigger token to the trigger_tokens_ht. */
2632 cds_lfht_node_init(&trigger_tokens_ht_element->node);
2633 trigger_tokens_ht_element->token = LTTNG_OPTIONAL_GET(trigger->tracer_token);
2634 trigger_tokens_ht_element->trigger = trigger;
2635
2636 node = cds_lfht_add_unique(state->trigger_tokens_ht,
2637 hash_key_u64(&trigger_tokens_ht_element->token, lttng_ht_seed),
2638 match_trigger_token,
2639 &trigger_tokens_ht_element->token,
2640 &trigger_tokens_ht_element->node);
2641 if (node != &trigger_tokens_ht_element->node) {
2642 ret = LTTNG_ERR_TRIGGER_EXISTS;
2643 goto error_free_ht_element;
2644 }
2645
2646 error_accounting_status = event_notifier_error_accounting_register_event_notifier(
2647 trigger, &error_counter_index);
2648 if (error_accounting_status != EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK) {
2649 if (error_accounting_status == EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_NO_INDEX_AVAILABLE) {
2650 DBG("Trigger list error accounting counter full.");
2651 ret = LTTNG_ERR_EVENT_NOTIFIER_ERROR_ACCOUNTING_FULL;
2652 } else {
2653 ERR("Error registering trigger for error accounting");
2654 ret = LTTNG_ERR_EVENT_NOTIFIER_REGISTRATION;
2655 }
2656
2657 goto error_remove_ht_element;
2658 }
2659
2660 lttng_condition_event_rule_matches_set_error_counter_index(
2661 condition, error_counter_index);
2662
2663 ret = LTTNG_OK;
2664 goto end;
2665
2666error_remove_ht_element:
2667 cds_lfht_del(state->trigger_tokens_ht, &trigger_tokens_ht_element->node);
2668error_free_ht_element:
2669 free(trigger_tokens_ht_element);
2670end:
2671 return ret;
2672}
2673
2674/*
2675 * FIXME A client's credentials are not checked when registering a trigger.
2676 *
2677 * The effects of this are benign since:
2678 * - The client will succeed in registering the trigger, as it is valid,
2679 * - The trigger will, internally, be bound to the channel/session,
2680 * - The notifications will not be sent since the client's credentials
2681 * are checked against the channel at that moment.
2682 *
2683 * If this function returns a non-zero value, it means something is
2684 * fundamentally broken and the whole subsystem/thread will be torn down.
2685 *
2686 * If a non-fatal error occurs, just set the cmd_result to the appropriate
2687 * error code.
2688 */
2689static
2690int handle_notification_thread_command_register_trigger(
2691 struct notification_thread_state *state,
2692 struct lttng_trigger *trigger,
2693 bool is_trigger_anonymous,
2694 enum lttng_error_code *cmd_result)
2695{
2696 int ret = 0;
2697 struct lttng_condition *condition;
2698 struct notification_client_list *client_list = NULL;
2699 struct lttng_trigger_ht_element *trigger_ht_element = NULL;
2700 struct cds_lfht_node *node;
2701 const char* trigger_name;
2702 bool free_trigger = true;
2703 struct lttng_evaluation *evaluation = NULL;
2704 struct lttng_credentials object_creds;
2705 uid_t object_uid;
2706 gid_t object_gid;
2707 enum action_executor_status executor_status;
2708 const uint64_t trigger_tracer_token =
2709 state->trigger_id.next_tracer_token++;
2710
2711 rcu_read_lock();
2712
2713 /* Set the trigger's tracer token. */
2714 lttng_trigger_set_tracer_token(trigger, trigger_tracer_token);
2715
2716 if (!is_trigger_anonymous) {
2717 if (lttng_trigger_get_name(trigger, &trigger_name) ==
2718 LTTNG_TRIGGER_STATUS_UNSET) {
2719 const enum lttng_error_code ret_code =
2720 generate_trigger_name(state, trigger,
2721 &trigger_name);
2722
2723 if (ret_code != LTTNG_OK) {
2724 /* Fatal error. */
2725 ret = -1;
2726 *cmd_result = ret_code;
2727 goto error;
2728 }
2729 } else if (trigger_name_taken(state, trigger)) {
2730 /* Not a fatal error. */
2731 *cmd_result = LTTNG_ERR_TRIGGER_EXISTS;
2732 ret = 0;
2733 goto error;
2734 }
2735 } else {
2736 trigger_name = "(anonymous)";
2737 }
2738
2739 condition = lttng_trigger_get_condition(trigger);
2740 LTTNG_ASSERT(condition);
2741
2742 /* Some conditions require tracers to implement a minimal ABI version. */
2743 if (!condition_is_supported(condition)) {
2744 *cmd_result = LTTNG_ERR_NOT_SUPPORTED;
2745 goto error;
2746 }
2747
2748 trigger_ht_element = zmalloc<lttng_trigger_ht_element>();
2749 if (!trigger_ht_element) {
2750 ret = -1;
2751 goto error;
2752 }
2753
2754 /* Add trigger to the trigger_ht. */
2755 cds_lfht_node_init(&trigger_ht_element->node);
2756 cds_lfht_node_init(&trigger_ht_element->node_by_name_uid);
2757 trigger_ht_element->trigger = trigger;
2758
2759 node = cds_lfht_add_unique(state->triggers_ht,
2760 lttng_condition_hash(condition),
2761 match_trigger,
2762 trigger,
2763 &trigger_ht_element->node);
2764 if (node != &trigger_ht_element->node) {
2765 /* Not a fatal error, simply report it to the client. */
2766 *cmd_result = LTTNG_ERR_TRIGGER_EXISTS;
2767 goto error_free_ht_element;
2768 }
2769
2770 node = cds_lfht_add_unique(state->triggers_by_name_uid_ht,
2771 hash_trigger_by_name_uid(trigger),
2772 match_trigger_by_name_uid,
2773 trigger,
2774 &trigger_ht_element->node_by_name_uid);
2775 if (node != &trigger_ht_element->node_by_name_uid) {
2776 /* Internal error: add to triggers_ht should have failed. */
2777 ret = -1;
2778 goto error_free_ht_element;
2779 }
2780
2781 /* From this point consider the trigger registered. */
2782 lttng_trigger_set_as_registered(trigger);
2783
2784 /*
2785 * Some triggers might need a tracer notifier depending on its
2786 * condition and actions.
2787 */
2788 if (lttng_trigger_needs_tracer_notifier(trigger)) {
2789 enum lttng_error_code error_code;
2790
2791 error_code = setup_tracer_notifier(state, trigger);
2792 if (error_code != LTTNG_OK) {
2793 notif_thread_state_remove_trigger_ht_elem(state,
2794 trigger_ht_element);
2795 if (error_code == LTTNG_ERR_NOMEM) {
2796 ret = -1;
2797 } else {
2798 *cmd_result = error_code;
2799 ret = 0;
2800 }
2801
2802 goto error_free_ht_element;
2803 }
2804 }
2805
2806 /*
2807 * The rest only applies to triggers that have a "notify" action.
2808 * It is not skipped as this is the only action type currently
2809 * supported.
2810 */
2811 if (is_trigger_action_notify(trigger)) {
2812 /*
2813 * Find or create the client list of this condition. It may
2814 * already be present if another trigger is already registered
2815 * with the same condition.
2816 */
2817 client_list = get_client_list_from_condition(state, condition);
2818 if (!client_list) {
2819 /*
2820 * No client list for this condition yet. We create new
2821 * one and build it up.
2822 */
2823 client_list = notification_client_list_create(state, condition);
2824 if (!client_list) {
2825 ERR("Error creating notification client list for trigger %s", trigger->name);
2826 goto error_free_ht_element;
2827 }
2828 }
2829
2830 CDS_INIT_LIST_HEAD(&trigger_ht_element->client_list_trigger_node);
2831
2832 pthread_mutex_lock(&client_list->lock);
2833 cds_list_add(&trigger_ht_element->client_list_trigger_node, &client_list->triggers_list);
2834 pthread_mutex_unlock(&client_list->lock);
2835 }
2836
2837 /*
2838 * Ownership of the trigger and of its wrapper was transfered to
2839 * the triggers_ht. Same for token ht element if necessary.
2840 */
2841 trigger_ht_element = NULL;
2842 free_trigger = false;
2843
2844 switch (get_condition_binding_object(condition)) {
2845 case LTTNG_OBJECT_TYPE_SESSION:
2846 /* Add the trigger to the list if it matches a known session. */
2847 ret = bind_trigger_to_matching_session(trigger, state);
2848 if (ret) {
2849 goto error_free_ht_element;
2850 }
2851 break;
2852 case LTTNG_OBJECT_TYPE_CHANNEL:
2853 /*
2854 * Add the trigger to list of triggers bound to the channels
2855 * currently known.
2856 */
2857 ret = bind_trigger_to_matching_channels(trigger, state);
2858 if (ret) {
2859 goto error_free_ht_element;
2860 }
2861 break;
2862 case LTTNG_OBJECT_TYPE_NONE:
2863 break;
2864 default:
2865 ERR("Unknown object type on which to bind a newly registered trigger was encountered");
2866 ret = -1;
2867 goto error_free_ht_element;
2868 }
2869
2870 /*
2871 * The new trigger's condition must be evaluated against the current
2872 * state.
2873 *
2874 * In the case of `notify` action, nothing preventing clients from
2875 * subscribing to a condition before the corresponding trigger is
2876 * registered, we have to evaluate this new condition right away.
2877 *
2878 * At some point, we were waiting for the next "evaluation" (e.g. on
2879 * reception of a channel sample) to evaluate this new condition, but
2880 * that was broken.
2881 *
2882 * The reason it was broken is that waiting for the next sample
2883 * does not allow us to properly handle transitions for edge-triggered
2884 * conditions.
2885 *
2886 * Consider this example: when we handle a new channel sample, we
2887 * evaluate each conditions twice: once with the previous state, and
2888 * again with the newest state. We then use those two results to
2889 * determine whether a state change happened: a condition was false and
2890 * became true. If a state change happened, we have to notify clients.
2891 *
2892 * Now, if a client subscribes to a given notification and registers
2893 * a trigger *after* that subscription, we have to make sure the
2894 * condition is evaluated at this point while considering only the
2895 * current state. Otherwise, the next evaluation cycle may only see
2896 * that the evaluations remain the same (true for samples n-1 and n) and
2897 * the client will never know that the condition has been met.
2898 */
2899 switch (get_condition_binding_object(condition)) {
2900 case LTTNG_OBJECT_TYPE_SESSION:
2901 ret = evaluate_session_condition_for_client(condition, state,
2902 &evaluation, &object_uid,
2903 &object_gid);
2904 LTTNG_OPTIONAL_SET(&object_creds.uid, object_uid);
2905 LTTNG_OPTIONAL_SET(&object_creds.gid, object_gid);
2906 break;
2907 case LTTNG_OBJECT_TYPE_CHANNEL:
2908 ret = evaluate_channel_condition_for_client(condition, state,
2909 &evaluation, &object_uid,
2910 &object_gid);
2911 LTTNG_OPTIONAL_SET(&object_creds.uid, object_uid);
2912 LTTNG_OPTIONAL_SET(&object_creds.gid, object_gid);
2913 break;
2914 case LTTNG_OBJECT_TYPE_NONE:
2915 ret = 0;
2916 break;
2917 case LTTNG_OBJECT_TYPE_UNKNOWN:
2918 default:
2919 ret = -1;
2920 break;
2921 }
2922
2923 if (ret) {
2924 /* Fatal error. */
2925 goto error_free_ht_element;
2926 }
2927
2928 DBG("Newly registered trigger's condition evaluated to %s",
2929 evaluation ? "true" : "false");
2930 if (!evaluation) {
2931 /* Evaluation yielded nothing. Normal exit. */
2932 ret = 0;
2933 goto success;
2934 }
2935
2936 /*
2937 * Ownership of `evaluation` transferred to the action executor
2938 * no matter the result.
2939 */
2940 executor_status = action_executor_enqueue_trigger(state->executor,
2941 trigger, evaluation, &object_creds, client_list);
2942 evaluation = NULL;
2943 switch (executor_status) {
2944 case ACTION_EXECUTOR_STATUS_OK:
2945 break;
2946 case ACTION_EXECUTOR_STATUS_ERROR:
2947 case ACTION_EXECUTOR_STATUS_INVALID:
2948 /*
2949 * TODO Add trigger identification (name/id) when
2950 * it is added to the API.
2951 */
2952 ERR("Fatal error occurred while enqueuing action associated to newly registered trigger");
2953 ret = -1;
2954 goto error_free_ht_element;
2955 case ACTION_EXECUTOR_STATUS_OVERFLOW:
2956 /*
2957 * TODO Add trigger identification (name/id) when
2958 * it is added to the API.
2959 *
2960 * Not a fatal error.
2961 */
2962 WARN("No space left when enqueuing action associated to newly registered trigger");
2963 ret = 0;
2964 goto success;
2965 default:
2966 abort();
2967 }
2968
2969success:
2970 *cmd_result = LTTNG_OK;
2971 DBG("Registered trigger: name = `%s`, tracer token = %" PRIu64,
2972 trigger_name, trigger_tracer_token);
2973 goto end;
2974
2975error_free_ht_element:
2976 if (trigger_ht_element) {
2977 /* Delayed removal due to RCU constraint on delete. */
2978 call_rcu(&trigger_ht_element->rcu_node,
2979 free_lttng_trigger_ht_element_rcu);
2980 }
2981error:
2982 if (free_trigger) {
2983 /*
2984 * Other objects might have a reference to the trigger, mark it
2985 * as unregistered.
2986 */
2987 lttng_trigger_set_as_unregistered(trigger);
2988 lttng_trigger_destroy(trigger);
2989 }
2990end:
2991 rcu_read_unlock();
2992 return ret;
2993}
2994
2995static
2996void free_lttng_trigger_ht_element_rcu(struct rcu_head *node)
2997{
2998 free(caa_container_of(node, struct lttng_trigger_ht_element,
2999 rcu_node));
3000}
3001
3002static
3003void free_notification_trigger_tokens_ht_element_rcu(struct rcu_head *node)
3004{
3005 free(caa_container_of(node, struct notification_trigger_tokens_ht_element,
3006 rcu_node));
3007}
3008
3009static
3010void teardown_tracer_notifier(struct notification_thread_state *state,
3011 const struct lttng_trigger *trigger)
3012{
3013 struct cds_lfht_iter iter;
3014 struct notification_trigger_tokens_ht_element *trigger_tokens_ht_element;
3015
3016 cds_lfht_for_each_entry(state->trigger_tokens_ht, &iter,
3017 trigger_tokens_ht_element, node) {
3018
3019 if (!lttng_trigger_is_equal(trigger,
3020 trigger_tokens_ht_element->trigger)) {
3021 continue;
3022 }
3023
3024 event_notifier_error_accounting_unregister_event_notifier(
3025 trigger_tokens_ht_element->trigger);
3026
3027 /* TODO talk to all app and remove it */
3028 DBG("Removed trigger from tokens_ht");
3029 cds_lfht_del(state->trigger_tokens_ht,
3030 &trigger_tokens_ht_element->node);
3031
3032 call_rcu(&trigger_tokens_ht_element->rcu_node,
3033 free_notification_trigger_tokens_ht_element_rcu);
3034
3035 break;
3036 }
3037}
3038
3039static
3040int handle_notification_thread_command_unregister_trigger(
3041 struct notification_thread_state *state,
3042 const struct lttng_trigger *trigger,
3043 enum lttng_error_code *_cmd_reply)
3044{
3045 struct cds_lfht_iter iter;
3046 struct cds_lfht_node *triggers_ht_node;
3047 struct lttng_channel_trigger_list *trigger_list;
3048 struct notification_client_list *client_list;
3049 struct lttng_trigger_ht_element *trigger_ht_element = NULL;
3050 const struct lttng_condition *condition = lttng_trigger_get_const_condition(
3051 trigger);
3052 enum lttng_error_code cmd_reply;
3053
3054 rcu_read_lock();
3055
3056 cds_lfht_lookup(state->triggers_ht,
3057 lttng_condition_hash(condition),
3058 match_trigger,
3059 trigger,
3060 &iter);
3061 triggers_ht_node = cds_lfht_iter_get_node(&iter);
3062 if (!triggers_ht_node) {
3063 cmd_reply = LTTNG_ERR_TRIGGER_NOT_FOUND;
3064 goto end;
3065 } else {
3066 cmd_reply = LTTNG_OK;
3067 }
3068
3069 trigger_ht_element = caa_container_of(triggers_ht_node,
3070 struct lttng_trigger_ht_element, node);
3071
3072 /* Remove trigger from channel_triggers_ht. */
3073 cds_lfht_for_each_entry(state->channel_triggers_ht, &iter, trigger_list,
3074 channel_triggers_ht_node) {
3075 struct lttng_trigger_list_element *trigger_element, *tmp;
3076
3077 cds_list_for_each_entry_safe(trigger_element, tmp,
3078 &trigger_list->list, node) {
3079 if (!lttng_trigger_is_equal(trigger, trigger_element->trigger)) {
3080 continue;
3081 }
3082
3083 DBG("Removed trigger from channel_triggers_ht");
3084 cds_list_del(&trigger_element->node);
3085 /* A trigger can only appear once per channel */
3086 break;
3087 }
3088 }
3089
3090 if (lttng_trigger_needs_tracer_notifier(trigger)) {
3091 teardown_tracer_notifier(state, trigger);
3092 }
3093
3094 if (is_trigger_action_notify(trigger)) {
3095 /*
3096 * Remove and release the client list from
3097 * notification_trigger_clients_ht.
3098 */
3099 client_list = get_client_list_from_condition(state, condition);
3100 LTTNG_ASSERT(client_list);
3101
3102 pthread_mutex_lock(&client_list->lock);
3103 cds_list_del(&trigger_ht_element->client_list_trigger_node);
3104 pthread_mutex_unlock(&client_list->lock);
3105
3106 /* Put new reference and the hashtable's reference. */
3107 notification_client_list_put(client_list);
3108 notification_client_list_put(client_list);
3109 client_list = NULL;
3110 }
3111
3112 /* Remove trigger from triggers_ht. */
3113 notif_thread_state_remove_trigger_ht_elem(state, trigger_ht_element);
3114
3115 /* Release the ownership of the trigger. */
3116 lttng_trigger_destroy(trigger_ht_element->trigger);
3117 call_rcu(&trigger_ht_element->rcu_node, free_lttng_trigger_ht_element_rcu);
3118end:
3119 rcu_read_unlock();
3120 if (_cmd_reply) {
3121 *_cmd_reply = cmd_reply;
3122 }
3123 return 0;
3124}
3125
3126static
3127int pop_cmd_queue(struct notification_thread_handle *handle,
3128 struct notification_thread_command **cmd)
3129{
3130 int ret;
3131 uint64_t counter;
3132
3133 pthread_mutex_lock(&handle->cmd_queue.lock);
3134 ret = lttng_read(handle->cmd_queue.event_fd, &counter, sizeof(counter));
3135 if (ret != sizeof(counter)) {
3136 ret = -1;
3137 goto error_unlock;
3138 }
3139
3140 *cmd = cds_list_first_entry(&handle->cmd_queue.list,
3141 struct notification_thread_command, cmd_list_node);
3142 cds_list_del(&((*cmd)->cmd_list_node));
3143 ret = 0;
3144
3145error_unlock:
3146 pthread_mutex_unlock(&handle->cmd_queue.lock);
3147 return ret;
3148}
3149
3150/* Returns 0 on success, 1 on exit requested, negative value on error. */
3151int handle_notification_thread_command(
3152 struct notification_thread_handle *handle,
3153 struct notification_thread_state *state)
3154{
3155 int ret;
3156 struct notification_thread_command *cmd;
3157
3158 ret = pop_cmd_queue(handle, &cmd);
3159 if (ret) {
3160 goto error;
3161 }
3162
3163 DBG("Received `%s` command",
3164 notification_command_type_str(cmd->type));
3165 switch (cmd->type) {
3166 case NOTIFICATION_COMMAND_TYPE_REGISTER_TRIGGER:
3167 ret = handle_notification_thread_command_register_trigger(state,
3168 cmd->parameters.register_trigger.trigger,
3169 cmd->parameters.register_trigger.is_trigger_anonymous,
3170 &cmd->reply_code);
3171 break;
3172 case NOTIFICATION_COMMAND_TYPE_UNREGISTER_TRIGGER:
3173 ret = handle_notification_thread_command_unregister_trigger(
3174 state,
3175 cmd->parameters.unregister_trigger.trigger,
3176 &cmd->reply_code);
3177 break;
3178 case NOTIFICATION_COMMAND_TYPE_ADD_CHANNEL:
3179 ret = handle_notification_thread_command_add_channel(
3180 state,
3181 cmd->parameters.add_channel.session.name,
3182 cmd->parameters.add_channel.session.uid,
3183 cmd->parameters.add_channel.session.gid,
3184 cmd->parameters.add_channel.channel.name,
3185 cmd->parameters.add_channel.channel.domain,
3186 cmd->parameters.add_channel.channel.key,
3187 cmd->parameters.add_channel.channel.capacity,
3188 &cmd->reply_code);
3189 break;
3190 case NOTIFICATION_COMMAND_TYPE_REMOVE_CHANNEL:
3191 ret = handle_notification_thread_command_remove_channel(
3192 state, cmd->parameters.remove_channel.key,
3193 cmd->parameters.remove_channel.domain,
3194 &cmd->reply_code);
3195 break;
3196 case NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING:
3197 case NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_COMPLETED:
3198 ret = handle_notification_thread_command_session_rotation(
3199 state,
3200 cmd->type,
3201 cmd->parameters.session_rotation.session_name,
3202 cmd->parameters.session_rotation.uid,
3203 cmd->parameters.session_rotation.gid,
3204 cmd->parameters.session_rotation.trace_archive_chunk_id,
3205 cmd->parameters.session_rotation.location,
3206 &cmd->reply_code);
3207 break;
3208 case NOTIFICATION_COMMAND_TYPE_ADD_TRACER_EVENT_SOURCE:
3209 ret = handle_notification_thread_command_add_tracer_event_source(
3210 state,
3211 cmd->parameters.tracer_event_source.tracer_event_source_fd,
3212 cmd->parameters.tracer_event_source.domain,
3213 &cmd->reply_code);
3214 break;
3215 case NOTIFICATION_COMMAND_TYPE_REMOVE_TRACER_EVENT_SOURCE:
3216 ret = handle_notification_thread_command_remove_tracer_event_source(
3217 state,
3218 cmd->parameters.tracer_event_source.tracer_event_source_fd,
3219 &cmd->reply_code);
3220 break;
3221 case NOTIFICATION_COMMAND_TYPE_LIST_TRIGGERS:
3222 {
3223 struct lttng_triggers *triggers = NULL;
3224
3225 ret = handle_notification_thread_command_list_triggers(
3226 handle,
3227 state,
3228 cmd->parameters.list_triggers.uid,
3229 &triggers,
3230 &cmd->reply_code);
3231 cmd->reply.list_triggers.triggers = triggers;
3232 ret = 0;
3233 break;
3234 }
3235 case NOTIFICATION_COMMAND_TYPE_QUIT:
3236 cmd->reply_code = LTTNG_OK;
3237 ret = 1;
3238 goto end;
3239 case NOTIFICATION_COMMAND_TYPE_GET_TRIGGER:
3240 {
3241 struct lttng_trigger *trigger = NULL;
3242
3243 ret = handle_notification_thread_command_get_trigger(state,
3244 cmd->parameters.get_trigger.trigger, &trigger,
3245 &cmd->reply_code);
3246 cmd->reply.get_trigger.trigger = trigger;
3247 break;
3248 }
3249 case NOTIFICATION_COMMAND_TYPE_CLIENT_COMMUNICATION_UPDATE:
3250 {
3251 const enum client_transmission_status client_status =
3252 cmd->parameters.client_communication_update
3253 .status;
3254 const notification_client_id client_id =
3255 cmd->parameters.client_communication_update.id;
3256 struct notification_client *client;
3257
3258 rcu_read_lock();
3259 client = get_client_from_id(client_id, state);
3260
3261 if (!client) {
3262 /*
3263 * Client error was probably already picked-up by the
3264 * notification thread or it has disconnected
3265 * gracefully while this command was queued.
3266 */
3267 DBG("Failed to find notification client to update communication status, client id = %" PRIu64,
3268 client_id);
3269 ret = 0;
3270 } else {
3271 ret = client_handle_transmission_status(
3272 client, client_status, state);
3273 }
3274 rcu_read_unlock();
3275 break;
3276 }
3277 default:
3278 ERR("Unknown internal command received");
3279 goto error_unlock;
3280 }
3281
3282 if (ret) {
3283 goto error_unlock;
3284 }
3285end:
3286 if (cmd->is_async) {
3287 free(cmd);
3288 cmd = NULL;
3289 } else {
3290 lttng_waiter_wake_up(&cmd->reply_waiter);
3291 }
3292 return ret;
3293error_unlock:
3294 /* Wake-up and return a fatal error to the calling thread. */
3295 lttng_waiter_wake_up(&cmd->reply_waiter);
3296 cmd->reply_code = LTTNG_ERR_FATAL;
3297error:
3298 /* Indicate a fatal error to the caller. */
3299 return -1;
3300}
3301
3302static
3303int socket_set_non_blocking(int socket)
3304{
3305 int ret, flags;
3306
3307 /* Set the pipe as non-blocking. */
3308 ret = fcntl(socket, F_GETFL, 0);
3309 if (ret == -1) {
3310 PERROR("fcntl get socket flags");
3311 goto end;
3312 }
3313 flags = ret;
3314
3315 ret = fcntl(socket, F_SETFL, flags | O_NONBLOCK);
3316 if (ret == -1) {
3317 PERROR("fcntl set O_NONBLOCK socket flag");
3318 goto end;
3319 }
3320 DBG("Client socket (fd = %i) set as non-blocking", socket);
3321end:
3322 return ret;
3323}
3324
3325static
3326int client_reset_inbound_state(struct notification_client *client)
3327{
3328 int ret;
3329
3330
3331 lttng_payload_clear(&client->communication.inbound.payload);
3332
3333 client->communication.inbound.bytes_to_receive =
3334 sizeof(struct lttng_notification_channel_message);
3335 client->communication.inbound.msg_type =
3336 LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_UNKNOWN;
3337 LTTNG_SOCK_SET_UID_CRED(&client->communication.inbound.creds, -1);
3338 LTTNG_SOCK_SET_GID_CRED(&client->communication.inbound.creds, -1);
3339 ret = lttng_dynamic_buffer_set_size(
3340 &client->communication.inbound.payload.buffer,
3341 client->communication.inbound.bytes_to_receive);
3342
3343 return ret;
3344}
3345
3346int handle_notification_thread_client_connect(
3347 struct notification_thread_state *state)
3348{
3349 int ret;
3350 struct notification_client *client;
3351
3352 DBG("Handling new notification channel client connection");
3353
3354 client = zmalloc<notification_client>();
3355 if (!client) {
3356 /* Fatal error. */
3357 ret = -1;
3358 goto error;
3359 }
3360
3361 pthread_mutex_init(&client->lock, NULL);
3362 client->id = state->next_notification_client_id++;
3363 CDS_INIT_LIST_HEAD(&client->condition_list);
3364 lttng_payload_init(&client->communication.inbound.payload);
3365 lttng_payload_init(&client->communication.outbound.payload);
3366 client->communication.inbound.expect_creds = true;
3367
3368 ret = client_reset_inbound_state(client);
3369 if (ret) {
3370 ERR("Failed to reset client communication's inbound state");
3371 ret = 0;
3372 goto error;
3373 }
3374
3375 ret = lttcomm_accept_unix_sock(state->notification_channel_socket);
3376 if (ret < 0) {
3377 ERR("Failed to accept new notification channel client connection");
3378 ret = 0;
3379 goto error;
3380 }
3381
3382 client->socket = ret;
3383
3384 ret = socket_set_non_blocking(client->socket);
3385 if (ret) {
3386 ERR("Failed to set new notification channel client connection socket as non-blocking");
3387 goto error;
3388 }
3389
3390 ret = lttcomm_setsockopt_creds_unix_sock(client->socket);
3391 if (ret < 0) {
3392 ERR("Failed to set socket options on new notification channel client socket");
3393 ret = 0;
3394 goto error;
3395 }
3396
3397 ret = lttng_poll_add(&state->events, client->socket,
3398 LPOLLIN | LPOLLERR |
3399 LPOLLHUP | LPOLLRDHUP);
3400 if (ret < 0) {
3401 ERR("Failed to add notification channel client socket to poll set");
3402 ret = 0;
3403 goto error;
3404 }
3405 DBG("Added new notification channel client socket (%i) to poll set",
3406 client->socket);
3407
3408 rcu_read_lock();
3409 cds_lfht_add(state->client_socket_ht,
3410 hash_client_socket(client->socket),
3411 &client->client_socket_ht_node);
3412 cds_lfht_add(state->client_id_ht,
3413 hash_client_id(client->id),
3414 &client->client_id_ht_node);
3415 rcu_read_unlock();
3416
3417 return ret;
3418
3419error:
3420 notification_client_destroy(client);
3421 return ret;
3422}
3423
3424/*
3425 * RCU read-lock must be held by the caller.
3426 * Client lock must _not_ be held by the caller.
3427 */
3428static
3429int notification_thread_client_disconnect(
3430 struct notification_client *client,
3431 struct notification_thread_state *state)
3432{
3433 int ret;
3434 struct lttng_condition_list_element *condition_list_element, *tmp;
3435
3436 ASSERT_RCU_READ_LOCKED();
3437
3438 /* Acquire the client lock to disable its communication atomically. */
3439 pthread_mutex_lock(&client->lock);
3440 client->communication.active = false;
3441 cds_lfht_del(state->client_socket_ht, &client->client_socket_ht_node);
3442 cds_lfht_del(state->client_id_ht, &client->client_id_ht_node);
3443 pthread_mutex_unlock(&client->lock);
3444
3445 ret = lttng_poll_del(&state->events, client->socket);
3446 if (ret) {
3447 ERR("Failed to remove client socket %d from poll set",
3448 client->socket);
3449 }
3450
3451 /* Release all conditions to which the client was subscribed. */
3452 cds_list_for_each_entry_safe(condition_list_element, tmp,
3453 &client->condition_list, node) {
3454 (void) notification_thread_client_unsubscribe(client,
3455 condition_list_element->condition, state, NULL);
3456 }
3457
3458 /*
3459 * Client no longer accessible to other threads (through the
3460 * client lists).
3461 */
3462 notification_client_destroy(client);
3463 return ret;
3464}
3465
3466int handle_notification_thread_client_disconnect(
3467 int client_socket, struct notification_thread_state *state)
3468{
3469 int ret = 0;
3470 struct notification_client *client;
3471
3472 rcu_read_lock();
3473 DBG("Closing client connection (socket fd = %i)",
3474 client_socket);
3475 client = get_client_from_socket(client_socket, state);
3476 if (!client) {
3477 /* Internal state corruption, fatal error. */
3478 ERR("Unable to find client (socket fd = %i)",
3479 client_socket);
3480 ret = -1;
3481 goto end;
3482 }
3483
3484 ret = notification_thread_client_disconnect(client, state);
3485end:
3486 rcu_read_unlock();
3487 return ret;
3488}
3489
3490int handle_notification_thread_client_disconnect_all(
3491 struct notification_thread_state *state)
3492{
3493 struct cds_lfht_iter iter;
3494 struct notification_client *client;
3495 bool error_encoutered = false;
3496
3497 rcu_read_lock();
3498 DBG("Closing all client connections");
3499 cds_lfht_for_each_entry(state->client_socket_ht, &iter, client,
3500 client_socket_ht_node) {
3501 int ret;
3502
3503 ret = notification_thread_client_disconnect(
3504 client, state);
3505 if (ret) {
3506 error_encoutered = true;
3507 }
3508 }
3509 rcu_read_unlock();
3510 return error_encoutered ? 1 : 0;
3511}
3512
3513int handle_notification_thread_trigger_unregister_all(
3514 struct notification_thread_state *state)
3515{
3516 bool error_occurred = false;
3517 struct cds_lfht_iter iter;
3518 struct lttng_trigger_ht_element *trigger_ht_element;
3519
3520 rcu_read_lock();
3521 cds_lfht_for_each_entry(state->triggers_ht, &iter, trigger_ht_element,
3522 node) {
3523 int ret = handle_notification_thread_command_unregister_trigger(
3524 state, trigger_ht_element->trigger, NULL);
3525 if (ret) {
3526 error_occurred = true;
3527 }
3528 }
3529 rcu_read_unlock();
3530 return error_occurred ? -1 : 0;
3531}
3532
3533static
3534int client_handle_transmission_status(
3535 struct notification_client *client,
3536 enum client_transmission_status transmission_status,
3537 struct notification_thread_state *state)
3538{
3539 int ret = 0;
3540
3541 switch (transmission_status) {
3542 case CLIENT_TRANSMISSION_STATUS_COMPLETE:
3543 ret = lttng_poll_mod(&state->events, client->socket,
3544 CLIENT_POLL_MASK_IN);
3545 if (ret) {
3546 goto end;
3547 }
3548
3549 break;
3550 case CLIENT_TRANSMISSION_STATUS_QUEUED:
3551 /*
3552 * We want to be notified whenever there is buffer space
3553 * available to send the rest of the payload.
3554 */
3555 ret = lttng_poll_mod(&state->events, client->socket,
3556 CLIENT_POLL_MASK_IN_OUT);
3557 if (ret) {
3558 goto end;
3559 }
3560 break;
3561 case CLIENT_TRANSMISSION_STATUS_FAIL:
3562 ret = notification_thread_client_disconnect(client, state);
3563 if (ret) {
3564 goto end;
3565 }
3566 break;
3567 case CLIENT_TRANSMISSION_STATUS_ERROR:
3568 ret = -1;
3569 goto end;
3570 default:
3571 abort();
3572 }
3573end:
3574 return ret;
3575}
3576
3577/* Client lock must be acquired by caller. */
3578static
3579enum client_transmission_status client_flush_outgoing_queue(
3580 struct notification_client *client)
3581{
3582 ssize_t ret;
3583 size_t to_send_count;
3584 enum client_transmission_status status;
3585 struct lttng_payload_view pv = lttng_payload_view_from_payload(
3586 &client->communication.outbound.payload, 0, -1);
3587 const int fds_to_send_count =
3588 lttng_payload_view_get_fd_handle_count(&pv);
3589
3590 ASSERT_LOCKED(client->lock);
3591
3592 if (!client->communication.active) {
3593 status = CLIENT_TRANSMISSION_STATUS_FAIL;
3594 goto end;
3595 }
3596
3597 if (pv.buffer.size == 0) {
3598 /*
3599 * If both data and fds are equal to zero, we are in an invalid
3600 * state.
3601 */
3602 LTTNG_ASSERT(fds_to_send_count != 0);
3603 goto send_fds;
3604 }
3605
3606 /* Send data. */
3607 to_send_count = pv.buffer.size;
3608 DBG("Flushing client (socket fd = %i) outgoing queue",
3609 client->socket);
3610
3611 ret = lttcomm_send_unix_sock_non_block(client->socket,
3612 pv.buffer.data,
3613 to_send_count);
3614 if ((ret >= 0 && ret < to_send_count)) {
3615 DBG("Client (socket fd = %i) outgoing queue could not be completely flushed",
3616 client->socket);
3617 to_send_count -= std::max(ret, (ssize_t) 0);
3618
3619 memmove(client->communication.outbound.payload.buffer.data,
3620 pv.buffer.data +
3621 pv.buffer.size - to_send_count,
3622 to_send_count);
3623 ret = lttng_dynamic_buffer_set_size(
3624 &client->communication.outbound.payload.buffer,
3625 to_send_count);
3626 if (ret) {
3627 goto error;
3628 }
3629
3630 status = CLIENT_TRANSMISSION_STATUS_QUEUED;
3631 goto end;
3632 } else if (ret < 0) {
3633 /* Generic error, disable the client's communication. */
3634 ERR("Failed to flush outgoing queue, disconnecting client (socket fd = %i)",
3635 client->socket);
3636 client->communication.active = false;
3637 status = CLIENT_TRANSMISSION_STATUS_FAIL;
3638 goto end;
3639 } else {
3640 /*
3641 * No error and flushed the queue completely.
3642 *
3643 * The payload buffer size is used later to
3644 * check if there is notifications queued. So albeit that the
3645 * direct caller knows that the transmission is complete, we
3646 * need to set the buffer size to zero.
3647 */
3648 ret = lttng_dynamic_buffer_set_size(
3649 &client->communication.outbound.payload.buffer, 0);
3650 if (ret) {
3651 goto error;
3652 }
3653 }
3654
3655send_fds:
3656 /* No fds to send, transmission is complete. */
3657 if (fds_to_send_count == 0) {
3658 status = CLIENT_TRANSMISSION_STATUS_COMPLETE;
3659 goto end;
3660 }
3661
3662 ret = lttcomm_send_payload_view_fds_unix_sock_non_block(
3663 client->socket, &pv);
3664 if (ret < 0) {
3665 /* Generic error, disable the client's communication. */
3666 ERR("Failed to flush outgoing fds queue, disconnecting client (socket fd = %i)",
3667 client->socket);
3668 client->communication.active = false;
3669 status = CLIENT_TRANSMISSION_STATUS_FAIL;
3670 goto end;
3671 } else if (ret == 0) {
3672 /* Nothing could be sent. */
3673 status = CLIENT_TRANSMISSION_STATUS_QUEUED;
3674 } else {
3675 /* Fd passing is an all or nothing kind of thing. */
3676 status = CLIENT_TRANSMISSION_STATUS_COMPLETE;
3677 /*
3678 * The payload _fd_array count is used later to
3679 * check if there is notifications queued. So although the
3680 * direct caller knows that the transmission is complete, we
3681 * need to clear the _fd_array for the queuing check.
3682 */
3683 lttng_dynamic_pointer_array_clear(
3684 &client->communication.outbound.payload
3685 ._fd_handles);
3686 }
3687
3688end:
3689 if (status == CLIENT_TRANSMISSION_STATUS_COMPLETE) {
3690 client->communication.outbound.queued_command_reply = false;
3691 client->communication.outbound.dropped_notification = false;
3692 lttng_payload_clear(&client->communication.outbound.payload);
3693 }
3694
3695 return status;
3696error:
3697 return CLIENT_TRANSMISSION_STATUS_ERROR;
3698}
3699
3700static
3701bool client_has_outbound_data_left(
3702 const struct notification_client *client)
3703{
3704 const struct lttng_payload_view pv = lttng_payload_view_from_payload(
3705 &client->communication.outbound.payload, 0, -1);
3706 const bool has_data = pv.buffer.size != 0;
3707 const bool has_fds = lttng_payload_view_get_fd_handle_count(&pv);
3708
3709 return has_data || has_fds;
3710}
3711
3712/* Client lock must _not_ be held by the caller. */
3713static
3714int client_send_command_reply(struct notification_client *client,
3715 struct notification_thread_state *state,
3716 enum lttng_notification_channel_status status)
3717{
3718 int ret;
3719 struct lttng_notification_channel_command_reply reply = {
3720 .status = (int8_t) status,
3721 };
3722 struct lttng_notification_channel_message msg = {
3723 .type = (int8_t) LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_COMMAND_REPLY,
3724 .size = sizeof(reply),
3725 .fds = 0,
3726 };
3727 char buffer[sizeof(msg) + sizeof(reply)];
3728 enum client_transmission_status transmission_status;
3729
3730 memcpy(buffer, &msg, sizeof(msg));
3731 memcpy(buffer + sizeof(msg), &reply, sizeof(reply));
3732 DBG("Send command reply (%i)", (int) status);
3733
3734 pthread_mutex_lock(&client->lock);
3735 if (client->communication.outbound.queued_command_reply) {
3736 /* Protocol error. */
3737 goto error_unlock;
3738 }
3739
3740 /* Enqueue buffer to outgoing queue and flush it. */
3741 ret = lttng_dynamic_buffer_append(
3742 &client->communication.outbound.payload.buffer,
3743 buffer, sizeof(buffer));
3744 if (ret) {
3745 goto error_unlock;
3746 }
3747
3748 transmission_status = client_flush_outgoing_queue(client);
3749
3750 if (client_has_outbound_data_left(client)) {
3751 /* Queue could not be emptied. */
3752 client->communication.outbound.queued_command_reply = true;
3753 }
3754
3755 pthread_mutex_unlock(&client->lock);
3756 ret = client_handle_transmission_status(
3757 client, transmission_status, state);
3758 if (ret) {
3759 goto error;
3760 }
3761
3762 return 0;
3763error_unlock:
3764 pthread_mutex_unlock(&client->lock);
3765error:
3766 return -1;
3767}
3768
3769static
3770int client_handle_message_unknown(struct notification_client *client,
3771 struct notification_thread_state *state __attribute__((unused)))
3772{
3773 int ret;
3774 /*
3775 * Receiving message header. The function will be called again
3776 * once the rest of the message as been received and can be
3777 * interpreted.
3778 */
3779 const struct lttng_notification_channel_message *msg;
3780
3781 LTTNG_ASSERT(sizeof(*msg) == client->communication.inbound.payload.buffer.size);
3782 msg = (const struct lttng_notification_channel_message *)
3783 client->communication.inbound.payload.buffer.data;
3784
3785 if (msg->size == 0 ||
3786 msg->size > DEFAULT_MAX_NOTIFICATION_CLIENT_MESSAGE_PAYLOAD_SIZE) {
3787 ERR("Invalid notification channel message: length = %u",
3788 msg->size);
3789 ret = -1;
3790 goto end;
3791 }
3792
3793 switch (msg->type) {
3794 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_SUBSCRIBE:
3795 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_UNSUBSCRIBE:
3796 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_HANDSHAKE:
3797 break;
3798 default:
3799 ret = -1;
3800 ERR("Invalid notification channel message: unexpected message type");
3801 goto end;
3802 }
3803
3804 client->communication.inbound.bytes_to_receive = msg->size;
3805 client->communication.inbound.fds_to_receive = msg->fds;
3806 client->communication.inbound.msg_type =
3807 (enum lttng_notification_channel_message_type) msg->type;
3808 ret = lttng_dynamic_buffer_set_size(
3809 &client->communication.inbound.payload.buffer, msg->size);
3810
3811 /* msg is not valid anymore due to lttng_dynamic_buffer_set_size. */
3812 msg = NULL;
3813end:
3814 return ret;
3815}
3816
3817static
3818int client_handle_message_handshake(struct notification_client *client,
3819 struct notification_thread_state *state)
3820{
3821 int ret;
3822 struct lttng_notification_channel_command_handshake *handshake_client;
3823 const struct lttng_notification_channel_command_handshake handshake_reply = {
3824 .major = LTTNG_NOTIFICATION_CHANNEL_VERSION_MAJOR,
3825 .minor = LTTNG_NOTIFICATION_CHANNEL_VERSION_MINOR,
3826 };
3827 const struct lttng_notification_channel_message msg_header = {
3828 .type = LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_HANDSHAKE,
3829 .size = sizeof(handshake_reply),
3830 .fds = 0,
3831 };
3832 enum lttng_notification_channel_status status =
3833 LTTNG_NOTIFICATION_CHANNEL_STATUS_OK;
3834 char send_buffer[sizeof(msg_header) + sizeof(handshake_reply)];
3835
3836 memcpy(send_buffer, &msg_header, sizeof(msg_header));
3837 memcpy(send_buffer + sizeof(msg_header), &handshake_reply,
3838 sizeof(handshake_reply));
3839
3840 handshake_client =
3841 (struct lttng_notification_channel_command_handshake *)
3842 client->communication.inbound.payload.buffer
3843 .data;
3844 client->major = handshake_client->major;
3845 client->minor = handshake_client->minor;
3846 if (!client->communication.inbound.creds_received) {
3847 ERR("No credentials received from client");
3848 ret = -1;
3849 goto end;
3850 }
3851
3852 client->uid = LTTNG_SOCK_GET_UID_CRED(
3853 &client->communication.inbound.creds);
3854 client->gid = LTTNG_SOCK_GET_GID_CRED(
3855 &client->communication.inbound.creds);
3856 client->is_sessiond = LTTNG_SOCK_GET_PID_CRED(&client->communication.inbound.creds) == getpid();
3857 DBG("Received handshake from client: uid = %u, gid = %u, protocol version = %i.%i, client is sessiond = %s",
3858 client->uid, client->gid, (int) client->major,
3859 (int) client->minor,
3860 client->is_sessiond ? "true" : "false");
3861
3862 if (handshake_client->major !=
3863 LTTNG_NOTIFICATION_CHANNEL_VERSION_MAJOR) {
3864 status = LTTNG_NOTIFICATION_CHANNEL_STATUS_UNSUPPORTED_VERSION;
3865 }
3866
3867 pthread_mutex_lock(&client->lock);
3868 /* Outgoing queue will be flushed when the command reply is sent. */
3869 ret = lttng_dynamic_buffer_append(
3870 &client->communication.outbound.payload.buffer, send_buffer,
3871 sizeof(send_buffer));
3872 if (ret) {
3873 ERR("Failed to send protocol version to notification channel client");
3874 goto end_unlock;
3875 }
3876
3877 client->validated = true;
3878 client->communication.active = true;
3879 pthread_mutex_unlock(&client->lock);
3880
3881 /* Set reception state to receive the next message header. */
3882 ret = client_reset_inbound_state(client);
3883 if (ret) {
3884 ERR("Failed to reset client communication's inbound state");
3885 goto end;
3886 }
3887
3888 /* Flushes the outgoing queue. */
3889 ret = client_send_command_reply(client, state, status);
3890 if (ret) {
3891 ERR("Failed to send reply to notification channel client");
3892 goto end;
3893 }
3894
3895 goto end;
3896end_unlock:
3897 pthread_mutex_unlock(&client->lock);
3898end:
3899 return ret;
3900}
3901
3902static
3903int client_handle_message_subscription(
3904 struct notification_client *client,
3905 enum lttng_notification_channel_message_type msg_type,
3906 struct notification_thread_state *state)
3907{
3908 int ret;
3909 struct lttng_condition *condition;
3910 enum lttng_notification_channel_status status =
3911 LTTNG_NOTIFICATION_CHANNEL_STATUS_OK;
3912 struct lttng_payload_view condition_view =
3913 lttng_payload_view_from_payload(
3914 &client->communication.inbound.payload,
3915 0, -1);
3916 size_t expected_condition_size;
3917
3918 /*
3919 * No need to lock client to sample the inbound state as the only
3920 * other thread accessing clients (action executor) only uses the
3921 * outbound state.
3922 */
3923 expected_condition_size = client->communication.inbound.payload.buffer.size;
3924 ret = lttng_condition_create_from_payload(&condition_view, &condition);
3925 if (ret != expected_condition_size) {
3926 ERR("Malformed condition received from client");
3927 goto end;
3928 }
3929
3930 /* Ownership of condition is always transferred. */
3931 if (msg_type == LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_SUBSCRIBE) {
3932 ret = notification_thread_client_subscribe(
3933 client, condition, state, &status);
3934 } else {
3935 ret = notification_thread_client_unsubscribe(
3936 client, condition, state, &status);
3937 }
3938
3939 if (ret) {
3940 goto end;
3941 }
3942
3943 /* Set reception state to receive the next message header. */
3944 ret = client_reset_inbound_state(client);
3945 if (ret) {
3946 ERR("Failed to reset client communication's inbound state");
3947 goto end;
3948 }
3949
3950 ret = client_send_command_reply(client, state, status);
3951 if (ret) {
3952 ERR("Failed to send reply to notification channel client");
3953 goto end;
3954 }
3955
3956end:
3957 return ret;
3958}
3959
3960static
3961int client_dispatch_message(struct notification_client *client,
3962 struct notification_thread_state *state)
3963{
3964 int ret = 0;
3965
3966 if (client->communication.inbound.msg_type !=
3967 LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_HANDSHAKE &&
3968 client->communication.inbound.msg_type !=
3969 LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_UNKNOWN &&
3970 !client->validated) {
3971 WARN("client attempted a command before handshake");
3972 ret = -1;
3973 goto end;
3974 }
3975
3976 switch (client->communication.inbound.msg_type) {
3977 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_UNKNOWN:
3978 {
3979 ret = client_handle_message_unknown(client, state);
3980 break;
3981 }
3982 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_HANDSHAKE:
3983 {
3984 ret = client_handle_message_handshake(client, state);
3985 break;
3986 }
3987 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_SUBSCRIBE:
3988 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_UNSUBSCRIBE:
3989 {
3990 ret = client_handle_message_subscription(client,
3991 client->communication.inbound.msg_type, state);
3992 break;
3993 }
3994 default:
3995 abort();
3996 }
3997end:
3998 return ret;
3999}
4000
4001/* Incoming data from client. */
4002int handle_notification_thread_client_in(
4003 struct notification_thread_state *state, int socket)
4004{
4005 int ret = 0;
4006 struct notification_client *client;
4007 ssize_t recv_ret;
4008 size_t offset;
4009
4010 rcu_read_lock();
4011 client = get_client_from_socket(socket, state);
4012 if (!client) {
4013 /* Internal error, abort. */
4014 ret = -1;
4015 goto end;
4016 }
4017
4018 if (client->communication.inbound.bytes_to_receive == 0 &&
4019 client->communication.inbound.fds_to_receive != 0) {
4020 /* Only FDs left to receive. */
4021 goto receive_fds;
4022 }
4023
4024 offset = client->communication.inbound.payload.buffer.size -
4025 client->communication.inbound.bytes_to_receive;
4026 if (client->communication.inbound.expect_creds) {
4027 recv_ret = lttcomm_recv_creds_unix_sock(socket,
4028 client->communication.inbound.payload.buffer.data + offset,
4029 client->communication.inbound.bytes_to_receive,
4030 &client->communication.inbound.creds);
4031 if (recv_ret > 0) {
4032 client->communication.inbound.expect_creds = false;
4033 client->communication.inbound.creds_received = true;
4034 }
4035 } else {
4036 recv_ret = lttcomm_recv_unix_sock_non_block(socket,
4037 client->communication.inbound.payload.buffer.data + offset,
4038 client->communication.inbound.bytes_to_receive);
4039 }
4040 if (recv_ret >= 0) {
4041 client->communication.inbound.bytes_to_receive -= recv_ret;
4042 } else {
4043 goto error_disconnect_client;
4044 }
4045
4046 if (client->communication.inbound.bytes_to_receive != 0) {
4047 /* Message incomplete wait for more data. */
4048 ret = 0;
4049 goto end;
4050 }
4051
4052receive_fds:
4053 LTTNG_ASSERT(client->communication.inbound.bytes_to_receive == 0);
4054
4055 /* Receive fds. */
4056 if (client->communication.inbound.fds_to_receive != 0) {
4057 ret = lttcomm_recv_payload_fds_unix_sock_non_block(
4058 client->socket,
4059 client->communication.inbound.fds_to_receive,
4060 &client->communication.inbound.payload);
4061 if (ret > 0) {
4062 /*
4063 * Fds received. non blocking fds passing is all
4064 * or nothing.
4065 */
4066 ssize_t expected_size;
4067
4068 expected_size = sizeof(int) *
4069 client->communication.inbound
4070 .fds_to_receive;
4071 LTTNG_ASSERT(ret == expected_size);
4072 client->communication.inbound.fds_to_receive = 0;
4073 } else if (ret == 0) {
4074 /* Received nothing. */
4075 ret = 0;
4076 goto end;
4077 } else {
4078 goto error_disconnect_client;
4079 }
4080 }
4081
4082 /* At this point the message is complete.*/
4083 LTTNG_ASSERT(client->communication.inbound.bytes_to_receive == 0 &&
4084 client->communication.inbound.fds_to_receive == 0);
4085 ret = client_dispatch_message(client, state);
4086 if (ret) {
4087 /*
4088 * Only returns an error if this client must be
4089 * disconnected.
4090 */
4091 goto error_disconnect_client;
4092 }
4093
4094end:
4095 rcu_read_unlock();
4096 return ret;
4097
4098error_disconnect_client:
4099 ret = notification_thread_client_disconnect(client, state);
4100 goto end;
4101}
4102
4103/* Client ready to receive outgoing data. */
4104int handle_notification_thread_client_out(
4105 struct notification_thread_state *state, int socket)
4106{
4107 int ret;
4108 struct notification_client *client;
4109 enum client_transmission_status transmission_status;
4110
4111 rcu_read_lock();
4112 client = get_client_from_socket(socket, state);
4113 if (!client) {
4114 /* Internal error, abort. */
4115 ret = -1;
4116 goto end;
4117 }
4118
4119 pthread_mutex_lock(&client->lock);
4120 transmission_status = client_flush_outgoing_queue(client);
4121 pthread_mutex_unlock(&client->lock);
4122
4123 ret = client_handle_transmission_status(
4124 client, transmission_status, state);
4125 if (ret) {
4126 goto end;
4127 }
4128end:
4129 rcu_read_unlock();
4130 return ret;
4131}
4132
4133static
4134bool evaluate_buffer_usage_condition(const struct lttng_condition *condition,
4135 const struct channel_state_sample *sample,
4136 uint64_t buffer_capacity)
4137{
4138 bool result = false;
4139 uint64_t threshold;
4140 enum lttng_condition_type condition_type;
4141 const struct lttng_condition_buffer_usage *use_condition = container_of(
4142 condition, struct lttng_condition_buffer_usage,
4143 parent);
4144
4145 if (use_condition->threshold_bytes.set) {
4146 threshold = use_condition->threshold_bytes.value;
4147 } else {
4148 /*
4149 * Threshold was expressed as a ratio.
4150 *
4151 * TODO the threshold (in bytes) of conditions expressed
4152 * as a ratio of total buffer size could be cached to
4153 * forego this double-multiplication or it could be performed
4154 * as fixed-point math.
4155 *
4156 * Note that caching should accommodates the case where the
4157 * condition applies to multiple channels (i.e. don't assume
4158 * that all channels matching my_chann* have the same size...)
4159 */
4160 threshold = (uint64_t) (use_condition->threshold_ratio.value *
4161 (double) buffer_capacity);
4162 }
4163
4164 condition_type = lttng_condition_get_type(condition);
4165 if (condition_type == LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW) {
4166 DBG("Low buffer usage condition being evaluated: threshold = %" PRIu64 ", highest usage = %" PRIu64,
4167 threshold, sample->highest_usage);
4168
4169 /*
4170 * The low condition should only be triggered once _all_ of the
4171 * streams in a channel have gone below the "low" threshold.
4172 */
4173 if (sample->highest_usage <= threshold) {
4174 result = true;
4175 }
4176 } else {
4177 DBG("High buffer usage condition being evaluated: threshold = %" PRIu64 ", highest usage = %" PRIu64,
4178 threshold, sample->highest_usage);
4179
4180 /*
4181 * For high buffer usage scenarios, we want to trigger whenever
4182 * _any_ of the streams has reached the "high" threshold.
4183 */
4184 if (sample->highest_usage >= threshold) {
4185 result = true;
4186 }
4187 }
4188
4189 return result;
4190}
4191
4192static
4193bool evaluate_session_consumed_size_condition(
4194 const struct lttng_condition *condition,
4195 uint64_t session_consumed_size)
4196{
4197 uint64_t threshold;
4198 const struct lttng_condition_session_consumed_size *size_condition =
4199 container_of(condition,
4200 struct lttng_condition_session_consumed_size,
4201 parent);
4202
4203 threshold = size_condition->consumed_threshold_bytes.value;
4204 DBG("Session consumed size condition being evaluated: threshold = %" PRIu64 ", current size = %" PRIu64,
4205 threshold, session_consumed_size);
4206 return session_consumed_size >= threshold;
4207}
4208
4209static
4210int evaluate_buffer_condition(const struct lttng_condition *condition,
4211 struct lttng_evaluation **evaluation,
4212 const struct notification_thread_state *state __attribute__((unused)),
4213 const struct channel_state_sample *previous_sample,
4214 const struct channel_state_sample *latest_sample,
4215 uint64_t previous_session_consumed_total,
4216 uint64_t latest_session_consumed_total,
4217 struct channel_info *channel_info)
4218{
4219 int ret = 0;
4220 enum lttng_condition_type condition_type;
4221 const bool previous_sample_available = !!previous_sample;
4222 bool previous_sample_result = false;
4223 bool latest_sample_result;
4224
4225 condition_type = lttng_condition_get_type(condition);
4226
4227 switch (condition_type) {
4228 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW:
4229 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH:
4230 if (caa_likely(previous_sample_available)) {
4231 previous_sample_result =
4232 evaluate_buffer_usage_condition(condition,
4233 previous_sample, channel_info->capacity);
4234 }
4235 latest_sample_result = evaluate_buffer_usage_condition(
4236 condition, latest_sample,
4237 channel_info->capacity);
4238 break;
4239 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE:
4240 if (caa_likely(previous_sample_available)) {
4241 previous_sample_result =
4242 evaluate_session_consumed_size_condition(
4243 condition,
4244 previous_session_consumed_total);
4245 }
4246 latest_sample_result =
4247 evaluate_session_consumed_size_condition(
4248 condition,
4249 latest_session_consumed_total);
4250 break;
4251 default:
4252 /* Unknown condition type; internal error. */
4253 abort();
4254 }
4255
4256 if (!latest_sample_result ||
4257 (previous_sample_result == latest_sample_result)) {
4258 /*
4259 * Only trigger on a condition evaluation transition.
4260 *
4261 * NOTE: This edge-triggered logic may not be appropriate for
4262 * future condition types.
4263 */
4264 goto end;
4265 }
4266
4267 if (!evaluation || !latest_sample_result) {
4268 goto end;
4269 }
4270
4271 switch (condition_type) {
4272 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW:
4273 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH:
4274 *evaluation = lttng_evaluation_buffer_usage_create(
4275 condition_type,
4276 latest_sample->highest_usage,
4277 channel_info->capacity);
4278 break;
4279 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE:
4280 *evaluation = lttng_evaluation_session_consumed_size_create(
4281 latest_session_consumed_total);
4282 break;
4283 default:
4284 abort();
4285 }
4286
4287 if (!*evaluation) {
4288 ret = -1;
4289 goto end;
4290 }
4291end:
4292 return ret;
4293}
4294
4295static
4296int client_notification_overflow(struct notification_client *client)
4297{
4298 int ret = 0;
4299 const struct lttng_notification_channel_message msg = {
4300 .type = (int8_t) LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_NOTIFICATION_DROPPED,
4301 .size = 0,
4302 .fds = 0,
4303 };
4304
4305 ASSERT_LOCKED(client->lock);
4306
4307 DBG("Dropping notification addressed to client (socket fd = %i)",
4308 client->socket);
4309 if (client->communication.outbound.dropped_notification) {
4310 /*
4311 * The client already has a "notification dropped" message
4312 * in its outgoing queue. Nothing to do since all
4313 * of those messages are coalesced.
4314 */
4315 goto end;
4316 }
4317
4318 client->communication.outbound.dropped_notification = true;
4319 ret = lttng_dynamic_buffer_append(
4320 &client->communication.outbound.payload.buffer, &msg,
4321 sizeof(msg));
4322 if (ret) {
4323 PERROR("Failed to enqueue \"dropped notification\" message in client's (socket fd = %i) outgoing queue",
4324 client->socket);
4325 }
4326end:
4327 return ret;
4328}
4329
4330static int client_handle_transmission_status_wrapper(
4331 struct notification_client *client,
4332 enum client_transmission_status status,
4333 void *user_data)
4334{
4335 return client_handle_transmission_status(client, status,
4336 (struct notification_thread_state *) user_data);
4337}
4338
4339static
4340int send_evaluation_to_clients(const struct lttng_trigger *trigger,
4341 const struct lttng_evaluation *evaluation,
4342 struct notification_client_list* client_list,
4343 struct notification_thread_state *state,
4344 uid_t object_uid, gid_t object_gid)
4345{
4346 const struct lttng_credentials creds = {
4347 .uid = LTTNG_OPTIONAL_INIT_VALUE(object_uid),
4348 .gid = LTTNG_OPTIONAL_INIT_VALUE(object_gid),
4349 };
4350
4351 return notification_client_list_send_evaluation(client_list,
4352 trigger, evaluation,
4353 &creds,
4354 client_handle_transmission_status_wrapper, state);
4355}
4356
4357/*
4358 * Permission checks relative to notification channel clients are performed
4359 * here. Notice how object, client, and trigger credentials are involved in
4360 * this check.
4361 *
4362 * The `object` credentials are the credentials associated with the "subject"
4363 * of a condition. For instance, a `rotation completed` condition applies
4364 * to a session. When that condition is met, it will produce an evaluation
4365 * against a session. Hence, in this case, the `object` credentials are the
4366 * credentials of the "subject" session.
4367 *
4368 * The `trigger` credentials are the credentials of the user that registered the
4369 * trigger.
4370 *
4371 * The `client` credentials are the credentials of the user that created a given
4372 * notification channel.
4373 *
4374 * In terms of visibility, it is expected that non-privilieged users can only
4375 * register triggers against "their" objects (their own sessions and
4376 * applications they are allowed to interact with). They can then open a
4377 * notification channel and subscribe to notifications associated with those
4378 * triggers.
4379 *
4380 * As for privilieged users, they can register triggers against the objects of
4381 * other users. They can then subscribe to the notifications associated to their
4382 * triggers. Privilieged users _can't_ subscribe to the notifications of
4383 * triggers owned by other users; they must create their own triggers.
4384 *
4385 * This is more a concern of usability than security. It would be difficult for
4386 * a root user reliably subscribe to a specific set of conditions without
4387 * interference from external users (those could, for instance, unregister
4388 * their triggers).
4389 */
4390int notification_client_list_send_evaluation(
4391 struct notification_client_list *client_list,
4392 const struct lttng_trigger *trigger,
4393 const struct lttng_evaluation *evaluation,
4394 const struct lttng_credentials *source_object_creds,
4395 report_client_transmission_result_cb client_report,
4396 void *user_data)
4397{
4398 int ret = 0;
4399 struct lttng_payload msg_payload;
4400 struct notification_client_list_element *client_list_element, *tmp;
4401 const struct lttng_notification notification = {
4402 .trigger = (struct lttng_trigger *) trigger,
4403 .evaluation = (struct lttng_evaluation *) evaluation,
4404 };
4405 struct lttng_notification_channel_message msg_header = {
4406 .type = (int8_t) LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_NOTIFICATION,
4407 .size = 0,
4408 .fds = 0,
4409 };
4410 const struct lttng_credentials *trigger_creds =
4411 lttng_trigger_get_credentials(trigger);
4412
4413 lttng_payload_init(&msg_payload);
4414
4415 ret = lttng_dynamic_buffer_append(&msg_payload.buffer, &msg_header,
4416 sizeof(msg_header));
4417 if (ret) {
4418 goto end;
4419 }
4420
4421 ret = lttng_notification_serialize(&notification, &msg_payload);
4422 if (ret) {
4423 ERR("Failed to serialize notification");
4424 ret = -1;
4425 goto end;
4426 }
4427
4428 /* Update payload size. */
4429 ((struct lttng_notification_channel_message *) msg_payload.buffer.data)
4430 ->size = (uint32_t)(
4431 msg_payload.buffer.size - sizeof(msg_header));
4432
4433 /* Update the payload number of fds. */
4434 {
4435 const struct lttng_payload_view pv = lttng_payload_view_from_payload(
4436 &msg_payload, 0, -1);
4437
4438 ((struct lttng_notification_channel_message *)
4439 msg_payload.buffer.data)->fds = (uint32_t)
4440 lttng_payload_view_get_fd_handle_count(&pv);
4441 }
4442
4443 pthread_mutex_lock(&client_list->lock);
4444 cds_list_for_each_entry_safe(client_list_element, tmp,
4445 &client_list->clients_list, node) {
4446 enum client_transmission_status transmission_status;
4447 struct notification_client *client =
4448 client_list_element->client;
4449
4450 ret = 0;
4451 pthread_mutex_lock(&client->lock);
4452 if (!client->communication.active) {
4453 /*
4454 * Skip inactive client (protocol error or
4455 * disconnecting).
4456 */
4457 DBG("Skipping client at it is marked as inactive");
4458 goto skip_client;
4459 }
4460
4461 if (lttng_trigger_is_hidden(trigger) && !client->is_sessiond) {
4462 /*
4463 * Notifications resulting from an hidden trigger are
4464 * only sent to the session daemon.
4465 */
4466 DBG("Skipping client as the trigger is hidden and the client is not the session daemon");
4467 goto skip_client;
4468 }
4469
4470 if (source_object_creds) {
4471 if (client->uid != lttng_credentials_get_uid(source_object_creds) &&
4472 client->gid != lttng_credentials_get_gid(source_object_creds) &&
4473 client->uid != 0) {
4474 /*
4475 * Client is not allowed to monitor this
4476 * object.
4477 */
4478 DBG("Skipping client at it does not have the object permission to receive notification for this trigger");
4479 goto skip_client;
4480 }
4481 }
4482
4483 if (client->uid != lttng_credentials_get_uid(trigger_creds)) {
4484 DBG("Skipping client at it does not have the permission to receive notification for this trigger");
4485 goto skip_client;
4486 }
4487
4488 DBG("Sending notification to client (fd = %i, %zu bytes)",
4489 client->socket, msg_payload.buffer.size);
4490
4491 if (client_has_outbound_data_left(client)) {
4492 /*
4493 * Outgoing data is already buffered for this client;
4494 * drop the notification and enqueue a "dropped
4495 * notification" message if this is the first dropped
4496 * notification since the socket spilled-over to the
4497 * queue.
4498 */
4499 ret = client_notification_overflow(client);
4500 if (ret) {
4501 /* Fatal error. */
4502 goto skip_client;
4503 }
4504 }
4505
4506 ret = lttng_payload_copy(&msg_payload, &client->communication.outbound.payload);
4507 if (ret) {
4508 /* Fatal error. */
4509 goto skip_client;
4510 }
4511
4512 transmission_status = client_flush_outgoing_queue(client);
4513 pthread_mutex_unlock(&client->lock);
4514 ret = client_report(client, transmission_status, user_data);
4515 if (ret) {
4516 /* Fatal error. */
4517 goto end_unlock_list;
4518 }
4519
4520 continue;
4521
4522skip_client:
4523 pthread_mutex_unlock(&client->lock);
4524 if (ret) {
4525 /* Fatal error. */
4526 goto end_unlock_list;
4527 }
4528 }
4529 ret = 0;
4530
4531end_unlock_list:
4532 pthread_mutex_unlock(&client_list->lock);
4533end:
4534 lttng_payload_reset(&msg_payload);
4535 return ret;
4536}
4537
4538static
4539struct lttng_event_notifier_notification *recv_one_event_notifier_notification(
4540 int notification_pipe_read_fd, enum lttng_domain_type domain)
4541{
4542 int ret;
4543 uint64_t token;
4544 struct lttng_event_notifier_notification *notification = NULL;
4545 char *capture_buffer = NULL;
4546 size_t capture_buffer_size;
4547 void *reception_buffer;
4548 size_t reception_size;
4549
4550 struct lttng_ust_abi_event_notifier_notification ust_notification;
4551 struct lttng_kernel_abi_event_notifier_notification kernel_notification;
4552
4553 /* Init lttng_event_notifier_notification */
4554 switch(domain) {
4555 case LTTNG_DOMAIN_UST:
4556 reception_buffer = (void *) &ust_notification;
4557 reception_size = sizeof(ust_notification);
4558 break;
4559 case LTTNG_DOMAIN_KERNEL:
4560 reception_buffer = (void *) &kernel_notification;
4561 reception_size = sizeof(kernel_notification);
4562 break;
4563 default:
4564 abort();
4565 }
4566
4567 /*
4568 * The monitoring pipe only holds messages smaller than PIPE_BUF,
4569 * ensuring that read/write of tracer notifications are atomic.
4570 */
4571 ret = lttng_read(notification_pipe_read_fd, reception_buffer,
4572 reception_size);
4573 if (ret != reception_size) {
4574 PERROR("Failed to read from event source notification pipe: fd = %d, size to read = %zu, ret = %d",
4575 notification_pipe_read_fd, reception_size, ret);
4576 ret = -1;
4577 goto end;
4578 }
4579
4580 switch(domain) {
4581 case LTTNG_DOMAIN_UST:
4582 token = ust_notification.token;
4583 capture_buffer_size = ust_notification.capture_buf_size;
4584 break;
4585 case LTTNG_DOMAIN_KERNEL:
4586 token = kernel_notification.token;
4587 capture_buffer_size = kernel_notification.capture_buf_size;
4588 break;
4589 default:
4590 abort();
4591 }
4592
4593 if (capture_buffer_size == 0) {
4594 capture_buffer = NULL;
4595 goto skip_capture;
4596 }
4597
4598 if (capture_buffer_size > MAX_CAPTURE_SIZE) {
4599 ERR("Event notifier has a capture payload size which exceeds the maximum allowed size: capture_payload_size = %zu bytes, max allowed size = %d bytes",
4600 capture_buffer_size, MAX_CAPTURE_SIZE);
4601 goto end;
4602 }
4603
4604 capture_buffer = calloc<char>(capture_buffer_size);
4605 if (!capture_buffer) {
4606 ERR("Failed to allocate capture buffer");
4607 goto end;
4608 }
4609
4610 /* Fetch additional payload (capture). */
4611 ret = lttng_read(notification_pipe_read_fd, capture_buffer, capture_buffer_size);
4612 if (ret != capture_buffer_size) {
4613 ERR("Failed to read from event source pipe (fd = %i)",
4614 notification_pipe_read_fd);
4615 goto end;
4616 }
4617
4618skip_capture:
4619 notification = lttng_event_notifier_notification_create(token, domain,
4620 capture_buffer, capture_buffer_size);
4621 if (notification == NULL) {
4622 goto end;
4623 }
4624
4625 /*
4626 * Ownership transfered to the lttng_event_notifier_notification object.
4627 */
4628 capture_buffer = NULL;
4629
4630end:
4631 free(capture_buffer);
4632 return notification;
4633}
4634
4635static
4636int dispatch_one_event_notifier_notification(struct notification_thread_state *state,
4637 struct lttng_event_notifier_notification *notification)
4638{
4639 struct cds_lfht_node *node;
4640 struct cds_lfht_iter iter;
4641 struct notification_trigger_tokens_ht_element *element;
4642 struct lttng_evaluation *evaluation = NULL;
4643 enum action_executor_status executor_status;
4644 struct notification_client_list *client_list = NULL;
4645 int ret;
4646 unsigned int capture_count = 0;
4647
4648 /* Find triggers associated with this token. */
4649 rcu_read_lock();
4650 cds_lfht_lookup(state->trigger_tokens_ht,
4651 hash_key_u64(&notification->tracer_token, lttng_ht_seed),
4652 match_trigger_token, &notification->tracer_token, &iter);
4653 node = cds_lfht_iter_get_node(&iter);
4654 if (caa_unlikely(!node)) {
4655 /*
4656 * This is not an error, slow consumption of the tracer
4657 * notifications can lead to situations where a trigger is
4658 * removed but we still get tracer notifications matching a
4659 * trigger that no longer exists.
4660 */
4661 ret = 0;
4662 goto end_unlock;
4663 }
4664
4665 element = caa_container_of(node,
4666 struct notification_trigger_tokens_ht_element,
4667 node);
4668
4669 if (lttng_condition_event_rule_matches_get_capture_descriptor_count(
4670 lttng_trigger_get_const_condition(element->trigger),
4671 &capture_count) != LTTNG_CONDITION_STATUS_OK) {
4672 ERR("Failed to get capture count");
4673 ret = -1;
4674 goto end;
4675 }
4676
4677 if (!notification->capture_buffer && capture_count != 0) {
4678 ERR("Expected capture but capture buffer is null");
4679 ret = -1;
4680 goto end;
4681 }
4682
4683 evaluation = lttng_evaluation_event_rule_matches_create(
4684 container_of(lttng_trigger_get_const_condition(
4685 element->trigger),
4686 struct lttng_condition_event_rule_matches,
4687 parent),
4688 notification->capture_buffer,
4689 notification->capture_buf_size, false);
4690
4691 if (evaluation == NULL) {
4692 ERR("Failed to create event rule matches evaluation while creating and enqueuing action executor job");
4693 ret = -1;
4694 goto end_unlock;
4695 }
4696
4697 client_list = get_client_list_from_condition(state,
4698 lttng_trigger_get_const_condition(element->trigger));
4699 executor_status = action_executor_enqueue_trigger(state->executor,
4700 element->trigger, evaluation, NULL, client_list);
4701 switch (executor_status) {
4702 case ACTION_EXECUTOR_STATUS_OK:
4703 ret = 0;
4704 break;
4705 case ACTION_EXECUTOR_STATUS_OVERFLOW:
4706 {
4707 struct notification_client_list_element *client_list_element,
4708 *tmp;
4709
4710 /*
4711 * Not a fatal error; this is expected and simply means the
4712 * executor has too much work queued already.
4713 */
4714 ret = 0;
4715
4716 /* No clients subscribed to notifications for this trigger. */
4717 if (!client_list) {
4718 break;
4719 }
4720
4721 /* Warn clients that a notification (or more) was dropped. */
4722 pthread_mutex_lock(&client_list->lock);
4723 cds_list_for_each_entry_safe(client_list_element, tmp,
4724 &client_list->clients_list, node) {
4725 enum client_transmission_status transmission_status;
4726 struct notification_client *client =
4727 client_list_element->client;
4728
4729 pthread_mutex_lock(&client->lock);
4730 ret = client_notification_overflow(client);
4731 if (ret) {
4732 /* Fatal error. */
4733 goto next_client;
4734 }
4735
4736 transmission_status =
4737 client_flush_outgoing_queue(client);
4738 ret = client_handle_transmission_status(
4739 client, transmission_status, state);
4740 if (ret) {
4741 /* Fatal error. */
4742 goto next_client;
4743 }
4744next_client:
4745 pthread_mutex_unlock(&client->lock);
4746 if (ret) {
4747 break;
4748 }
4749 }
4750
4751 pthread_mutex_unlock(&client_list->lock);
4752 break;
4753 }
4754 case ACTION_EXECUTOR_STATUS_INVALID:
4755 case ACTION_EXECUTOR_STATUS_ERROR:
4756 /* Fatal error, shut down everything. */
4757 ERR("Fatal error encoutered while enqueuing action to the action executor");
4758 ret = -1;
4759 goto end_unlock;
4760 default:
4761 /* Unhandled error. */
4762 abort();
4763 }
4764
4765end_unlock:
4766 notification_client_list_put(client_list);
4767 rcu_read_unlock();
4768end:
4769 return ret;
4770}
4771
4772static
4773int handle_one_event_notifier_notification(
4774 struct notification_thread_state *state,
4775 int pipe, enum lttng_domain_type domain)
4776{
4777 int ret = 0;
4778 struct lttng_event_notifier_notification *notification = NULL;
4779
4780 notification = recv_one_event_notifier_notification(pipe, domain);
4781 if (notification == NULL) {
4782 /* Reception failed, don't consider it fatal. */
4783 ERR("Error receiving an event notifier notification from tracer: fd = %i, domain = %s",
4784 pipe, lttng_domain_type_str(domain));
4785 goto end;
4786 }
4787
4788 ret = dispatch_one_event_notifier_notification(state, notification);
4789 if (ret) {
4790 ERR("Error dispatching an event notifier notification from tracer: fd = %i, domain = %s",
4791 pipe, lttng_domain_type_str(domain));
4792 goto end;
4793 }
4794
4795end:
4796 lttng_event_notifier_notification_destroy(notification);
4797 return ret;
4798}
4799
4800int handle_notification_thread_event_notification(struct notification_thread_state *state,
4801 int pipe, enum lttng_domain_type domain)
4802{
4803 return handle_one_event_notifier_notification(state, pipe, domain);
4804}
4805
4806int handle_notification_thread_channel_sample(
4807 struct notification_thread_state *state, int pipe,
4808 enum lttng_domain_type domain)
4809{
4810 int ret = 0;
4811 struct lttcomm_consumer_channel_monitor_msg sample_msg;
4812 struct channel_info *channel_info;
4813 struct cds_lfht_node *node;
4814 struct cds_lfht_iter iter;
4815 struct lttng_channel_trigger_list *trigger_list;
4816 struct lttng_trigger_list_element *trigger_list_element;
4817 bool previous_sample_available = false;
4818 struct channel_state_sample previous_sample, latest_sample;
4819 uint64_t previous_session_consumed_total, latest_session_consumed_total;
4820 struct lttng_credentials channel_creds;
4821
4822 /*
4823 * The monitoring pipe only holds messages smaller than PIPE_BUF,
4824 * ensuring that read/write of sampling messages are atomic.
4825 */
4826 ret = lttng_read(pipe, &sample_msg, sizeof(sample_msg));
4827 if (ret != sizeof(sample_msg)) {
4828 ERR("Failed to read from monitoring pipe (fd = %i)",
4829 pipe);
4830 ret = -1;
4831 goto end;
4832 }
4833
4834 ret = 0;
4835 latest_sample.key.key = sample_msg.key;
4836 latest_sample.key.domain = domain;
4837 latest_sample.highest_usage = sample_msg.highest;
4838 latest_sample.lowest_usage = sample_msg.lowest;
4839 latest_sample.channel_total_consumed = sample_msg.total_consumed;
4840
4841 rcu_read_lock();
4842
4843 /* Retrieve the channel's informations */
4844 cds_lfht_lookup(state->channels_ht,
4845 hash_channel_key(&latest_sample.key),
4846 match_channel_info,
4847 &latest_sample.key,
4848 &iter);
4849 node = cds_lfht_iter_get_node(&iter);
4850 if (caa_unlikely(!node)) {
4851 /*
4852 * Not an error since the consumer can push a sample to the pipe
4853 * and the rest of the session daemon could notify us of the
4854 * channel's destruction before we get a chance to process that
4855 * sample.
4856 */
4857 DBG("Received a sample for an unknown channel from consumerd, key = %" PRIu64 " in %s domain",
4858 latest_sample.key.key,
4859 lttng_domain_type_str(domain));
4860 goto end_unlock;
4861 }
4862 channel_info = caa_container_of(node, struct channel_info,
4863 channels_ht_node);
4864 DBG("Handling channel sample for channel %s (key = %" PRIu64 ") in session %s (highest usage = %" PRIu64 ", lowest usage = %" PRIu64", total consumed = %" PRIu64")",
4865 channel_info->name,
4866 latest_sample.key.key,
4867 channel_info->session_info->name,
4868 latest_sample.highest_usage,
4869 latest_sample.lowest_usage,
4870 latest_sample.channel_total_consumed);
4871
4872 previous_session_consumed_total =
4873 channel_info->session_info->consumed_data_size;
4874
4875 /* Retrieve the channel's last sample, if it exists, and update it. */
4876 cds_lfht_lookup(state->channel_state_ht,
4877 hash_channel_key(&latest_sample.key),
4878 match_channel_state_sample,
4879 &latest_sample.key,
4880 &iter);
4881 node = cds_lfht_iter_get_node(&iter);
4882 if (caa_likely(node)) {
4883 struct channel_state_sample *stored_sample;
4884
4885 /* Update the sample stored. */
4886 stored_sample = caa_container_of(node,
4887 struct channel_state_sample,
4888 channel_state_ht_node);
4889
4890 memcpy(&previous_sample, stored_sample,
4891 sizeof(previous_sample));
4892 stored_sample->highest_usage = latest_sample.highest_usage;
4893 stored_sample->lowest_usage = latest_sample.lowest_usage;
4894 stored_sample->channel_total_consumed = latest_sample.channel_total_consumed;
4895 previous_sample_available = true;
4896
4897 latest_session_consumed_total =
4898 previous_session_consumed_total +
4899 (latest_sample.channel_total_consumed - previous_sample.channel_total_consumed);
4900 } else {
4901 /*
4902 * This is the channel's first sample, allocate space for and
4903 * store the new sample.
4904 */
4905 struct channel_state_sample *stored_sample;
4906
4907 stored_sample = zmalloc<channel_state_sample>();
4908 if (!stored_sample) {
4909 ret = -1;
4910 goto end_unlock;
4911 }
4912
4913 memcpy(stored_sample, &latest_sample, sizeof(*stored_sample));
4914 cds_lfht_node_init(&stored_sample->channel_state_ht_node);
4915 cds_lfht_add(state->channel_state_ht,
4916 hash_channel_key(&stored_sample->key),
4917 &stored_sample->channel_state_ht_node);
4918
4919 latest_session_consumed_total =
4920 previous_session_consumed_total +
4921 latest_sample.channel_total_consumed;
4922 }
4923
4924 channel_info->session_info->consumed_data_size =
4925 latest_session_consumed_total;
4926
4927 /* Find triggers associated with this channel. */
4928 cds_lfht_lookup(state->channel_triggers_ht,
4929 hash_channel_key(&latest_sample.key),
4930 match_channel_trigger_list,
4931 &latest_sample.key,
4932 &iter);
4933 node = cds_lfht_iter_get_node(&iter);
4934 if (caa_likely(!node)) {
4935 goto end_unlock;
4936 }
4937
4938 channel_creds = (typeof(channel_creds)) {
4939 .uid = LTTNG_OPTIONAL_INIT_VALUE(channel_info->session_info->uid),
4940 .gid = LTTNG_OPTIONAL_INIT_VALUE(channel_info->session_info->gid),
4941 };
4942
4943 trigger_list = caa_container_of(node, struct lttng_channel_trigger_list,
4944 channel_triggers_ht_node);
4945 cds_list_for_each_entry(trigger_list_element, &trigger_list->list,
4946 node) {
4947 const struct lttng_condition *condition;
4948 struct lttng_trigger *trigger;
4949 struct notification_client_list *client_list = NULL;
4950 struct lttng_evaluation *evaluation = NULL;
4951 enum action_executor_status executor_status;
4952
4953 ret = 0;
4954 trigger = trigger_list_element->trigger;
4955 condition = lttng_trigger_get_const_condition(trigger);
4956 LTTNG_ASSERT(condition);
4957
4958 /*
4959 * Check if any client is subscribed to the result of this
4960 * evaluation.
4961 */
4962 client_list = get_client_list_from_condition(state, condition);
4963
4964 ret = evaluate_buffer_condition(condition, &evaluation, state,
4965 previous_sample_available ? &previous_sample : NULL,
4966 &latest_sample,
4967 previous_session_consumed_total,
4968 latest_session_consumed_total,
4969 channel_info);
4970 if (caa_unlikely(ret)) {
4971 goto put_list;
4972 }
4973
4974 if (caa_likely(!evaluation)) {
4975 goto put_list;
4976 }
4977
4978 /*
4979 * Ownership of `evaluation` transferred to the action executor
4980 * no matter the result.
4981 */
4982 executor_status = action_executor_enqueue_trigger(
4983 state->executor, trigger, evaluation,
4984 &channel_creds, client_list);
4985 evaluation = NULL;
4986 switch (executor_status) {
4987 case ACTION_EXECUTOR_STATUS_OK:
4988 break;
4989 case ACTION_EXECUTOR_STATUS_ERROR:
4990 case ACTION_EXECUTOR_STATUS_INVALID:
4991 /*
4992 * TODO Add trigger identification (name/id) when
4993 * it is added to the API.
4994 */
4995 ERR("Fatal error occurred while enqueuing action associated with buffer-condition trigger");
4996 ret = -1;
4997 goto put_list;
4998 case ACTION_EXECUTOR_STATUS_OVERFLOW:
4999 /*
5000 * TODO Add trigger identification (name/id) when
5001 * it is added to the API.
5002 *
5003 * Not a fatal error.
5004 */
5005 WARN("No space left when enqueuing action associated with buffer-condition trigger");
5006 ret = 0;
5007 goto put_list;
5008 default:
5009 abort();
5010 }
5011
5012put_list:
5013 notification_client_list_put(client_list);
5014 if (caa_unlikely(ret)) {
5015 break;
5016 }
5017 }
5018end_unlock:
5019 rcu_read_unlock();
5020end:
5021 return ret;
5022}
This page took 0.147893 seconds and 4 git commands to generate.