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