Fix: memcpy used on potentially overlapping regions
[lttng-tools.git] / src / bin / lttng-sessiond / notification-thread-events.c
1 /*
2 * Copyright (C) 2017 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
3 *
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License, version 2 only, as
6 * published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
11 * more details.
12 *
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 51
15 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
16 */
17
18 #define _LGPL_SOURCE
19 #include <urcu.h>
20 #include <urcu/rculfhash.h>
21
22 #include <common/defaults.h>
23 #include <common/error.h>
24 #include <common/futex.h>
25 #include <common/unix.h>
26 #include <common/dynamic-buffer.h>
27 #include <common/hashtable/utils.h>
28 #include <common/sessiond-comm/sessiond-comm.h>
29 #include <common/macros.h>
30 #include <lttng/condition/condition.h>
31 #include <lttng/action/action-internal.h>
32 #include <lttng/notification/notification-internal.h>
33 #include <lttng/condition/condition-internal.h>
34 #include <lttng/condition/buffer-usage-internal.h>
35 #include <lttng/condition/session-consumed-size-internal.h>
36 #include <lttng/condition/session-rotation-internal.h>
37 #include <lttng/notification/channel-internal.h>
38
39 #include <time.h>
40 #include <unistd.h>
41 #include <assert.h>
42 #include <inttypes.h>
43 #include <fcntl.h>
44
45 #include "notification-thread.h"
46 #include "notification-thread-events.h"
47 #include "notification-thread-commands.h"
48 #include "lttng-sessiond.h"
49 #include "kernel.h"
50
51 #define CLIENT_POLL_MASK_IN (LPOLLIN | LPOLLERR | LPOLLHUP | LPOLLRDHUP)
52 #define CLIENT_POLL_MASK_IN_OUT (CLIENT_POLL_MASK_IN | LPOLLOUT)
53
54 enum lttng_object_type {
55 LTTNG_OBJECT_TYPE_UNKNOWN,
56 LTTNG_OBJECT_TYPE_NONE,
57 LTTNG_OBJECT_TYPE_CHANNEL,
58 LTTNG_OBJECT_TYPE_SESSION,
59 };
60
61 struct lttng_trigger_list_element {
62 /* No ownership of the trigger object is assumed. */
63 const struct lttng_trigger *trigger;
64 struct cds_list_head node;
65 };
66
67 struct lttng_channel_trigger_list {
68 struct channel_key channel_key;
69 /* List of struct lttng_trigger_list_element. */
70 struct cds_list_head list;
71 /* Node in the channel_triggers_ht */
72 struct cds_lfht_node channel_triggers_ht_node;
73 /* call_rcu delayed reclaim. */
74 struct rcu_head rcu_node;
75 };
76
77 /*
78 * List of triggers applying to a given session.
79 *
80 * See:
81 * - lttng_session_trigger_list_create()
82 * - lttng_session_trigger_list_build()
83 * - lttng_session_trigger_list_destroy()
84 * - lttng_session_trigger_list_add()
85 */
86 struct lttng_session_trigger_list {
87 /*
88 * Not owned by this; points to the session_info structure's
89 * session name.
90 */
91 const char *session_name;
92 /* List of struct lttng_trigger_list_element. */
93 struct cds_list_head list;
94 /* Node in the session_triggers_ht */
95 struct cds_lfht_node session_triggers_ht_node;
96 /*
97 * Weak reference to the notification system's session triggers
98 * hashtable.
99 *
100 * The session trigger list structure structure is owned by
101 * the session's session_info.
102 *
103 * The session_info is kept alive the the channel_infos holding a
104 * reference to it (reference counting). When those channels are
105 * destroyed (at runtime or on teardown), the reference they hold
106 * to the session_info are released. On destruction of session_info,
107 * session_info_destroy() will remove the list of triggers applying
108 * to this session from the notification system's state.
109 *
110 * This implies that the session_triggers_ht must be destroyed
111 * after the channels.
112 */
113 struct cds_lfht *session_triggers_ht;
114 /* Used for delayed RCU reclaim. */
115 struct rcu_head rcu_node;
116 };
117
118 struct lttng_trigger_ht_element {
119 struct lttng_trigger *trigger;
120 struct cds_lfht_node node;
121 /* call_rcu delayed reclaim. */
122 struct rcu_head rcu_node;
123 };
124
125 struct lttng_condition_list_element {
126 struct lttng_condition *condition;
127 struct cds_list_head node;
128 };
129
130 struct notification_client_list_element {
131 struct notification_client *client;
132 struct cds_list_head node;
133 };
134
135 struct notification_client_list {
136 const struct lttng_trigger *trigger;
137 struct cds_list_head list;
138 struct cds_lfht_node notification_trigger_ht_node;
139 /* call_rcu delayed reclaim. */
140 struct rcu_head rcu_node;
141 };
142
143 struct notification_client {
144 int socket;
145 /* Client protocol version. */
146 uint8_t major, minor;
147 uid_t uid;
148 gid_t gid;
149 /*
150 * Indicates if the credentials and versions of the client have been
151 * checked.
152 */
153 bool validated;
154 /*
155 * Conditions to which the client's notification channel is subscribed.
156 * List of struct lttng_condition_list_node. The condition member is
157 * owned by the client.
158 */
159 struct cds_list_head condition_list;
160 struct cds_lfht_node client_socket_ht_node;
161 struct {
162 struct {
163 /*
164 * During the reception of a message, the reception
165 * buffers' "size" is set to contain the current
166 * message's complete payload.
167 */
168 struct lttng_dynamic_buffer buffer;
169 /* Bytes left to receive for the current message. */
170 size_t bytes_to_receive;
171 /* Type of the message being received. */
172 enum lttng_notification_channel_message_type msg_type;
173 /*
174 * Indicates whether or not credentials are expected
175 * from the client.
176 */
177 bool expect_creds;
178 /*
179 * Indicates whether or not credentials were received
180 * from the client.
181 */
182 bool creds_received;
183 /* Only used during credentials reception. */
184 lttng_sock_cred creds;
185 } inbound;
186 struct {
187 /*
188 * Indicates whether or not a notification addressed to
189 * this client was dropped because a command reply was
190 * already buffered.
191 *
192 * A notification is dropped whenever the buffer is not
193 * empty.
194 */
195 bool dropped_notification;
196 /*
197 * Indicates whether or not a command reply is already
198 * buffered. In this case, it means that the client is
199 * not consuming command replies before emitting a new
200 * one. This could be caused by a protocol error or a
201 * misbehaving/malicious client.
202 */
203 bool queued_command_reply;
204 struct lttng_dynamic_buffer buffer;
205 } outbound;
206 } communication;
207 /* call_rcu delayed reclaim. */
208 struct rcu_head rcu_node;
209 };
210
211 struct channel_state_sample {
212 struct channel_key key;
213 struct cds_lfht_node channel_state_ht_node;
214 uint64_t highest_usage;
215 uint64_t lowest_usage;
216 uint64_t channel_total_consumed;
217 /* call_rcu delayed reclaim. */
218 struct rcu_head rcu_node;
219 };
220
221 static unsigned long hash_channel_key(struct channel_key *key);
222 static int evaluate_buffer_condition(const struct lttng_condition *condition,
223 struct lttng_evaluation **evaluation,
224 const struct notification_thread_state *state,
225 const struct channel_state_sample *previous_sample,
226 const struct channel_state_sample *latest_sample,
227 uint64_t previous_session_consumed_total,
228 uint64_t latest_session_consumed_total,
229 struct channel_info *channel_info);
230 static
231 int send_evaluation_to_clients(const struct lttng_trigger *trigger,
232 const struct lttng_evaluation *evaluation,
233 struct notification_client_list *client_list,
234 struct notification_thread_state *state,
235 uid_t channel_uid, gid_t channel_gid);
236
237
238 /* session_info API */
239 static
240 void session_info_destroy(void *_data);
241 static
242 void session_info_get(struct session_info *session_info);
243 static
244 void session_info_put(struct session_info *session_info);
245 static
246 struct session_info *session_info_create(const char *name,
247 uid_t uid, gid_t gid,
248 struct lttng_session_trigger_list *trigger_list,
249 struct cds_lfht *sessions_ht);
250 static
251 void session_info_add_channel(struct session_info *session_info,
252 struct channel_info *channel_info);
253 static
254 void session_info_remove_channel(struct session_info *session_info,
255 struct channel_info *channel_info);
256
257 /* lttng_session_trigger_list API */
258 static
259 struct lttng_session_trigger_list *lttng_session_trigger_list_create(
260 const char *session_name,
261 struct cds_lfht *session_triggers_ht);
262 static
263 struct lttng_session_trigger_list *lttng_session_trigger_list_build(
264 const struct notification_thread_state *state,
265 const char *session_name);
266 static
267 void lttng_session_trigger_list_destroy(
268 struct lttng_session_trigger_list *list);
269 static
270 int lttng_session_trigger_list_add(struct lttng_session_trigger_list *list,
271 const struct lttng_trigger *trigger);
272
273
274 static
275 int match_client(struct cds_lfht_node *node, const void *key)
276 {
277 /* This double-cast is intended to supress pointer-to-cast warning. */
278 int socket = (int) (intptr_t) key;
279 struct notification_client *client;
280
281 client = caa_container_of(node, struct notification_client,
282 client_socket_ht_node);
283
284 return !!(client->socket == socket);
285 }
286
287 static
288 int match_channel_trigger_list(struct cds_lfht_node *node, const void *key)
289 {
290 struct channel_key *channel_key = (struct channel_key *) key;
291 struct lttng_channel_trigger_list *trigger_list;
292
293 trigger_list = caa_container_of(node, struct lttng_channel_trigger_list,
294 channel_triggers_ht_node);
295
296 return !!((channel_key->key == trigger_list->channel_key.key) &&
297 (channel_key->domain == trigger_list->channel_key.domain));
298 }
299
300 static
301 int match_session_trigger_list(struct cds_lfht_node *node, const void *key)
302 {
303 const char *session_name = (const char *) key;
304 struct lttng_session_trigger_list *trigger_list;
305
306 trigger_list = caa_container_of(node, struct lttng_session_trigger_list,
307 session_triggers_ht_node);
308
309 return !!(strcmp(trigger_list->session_name, session_name) == 0);
310 }
311
312 static
313 int match_channel_state_sample(struct cds_lfht_node *node, const void *key)
314 {
315 struct channel_key *channel_key = (struct channel_key *) key;
316 struct channel_state_sample *sample;
317
318 sample = caa_container_of(node, struct channel_state_sample,
319 channel_state_ht_node);
320
321 return !!((channel_key->key == sample->key.key) &&
322 (channel_key->domain == sample->key.domain));
323 }
324
325 static
326 int match_channel_info(struct cds_lfht_node *node, const void *key)
327 {
328 struct channel_key *channel_key = (struct channel_key *) key;
329 struct channel_info *channel_info;
330
331 channel_info = caa_container_of(node, struct channel_info,
332 channels_ht_node);
333
334 return !!((channel_key->key == channel_info->key.key) &&
335 (channel_key->domain == channel_info->key.domain));
336 }
337
338 static
339 int match_condition(struct cds_lfht_node *node, const void *key)
340 {
341 struct lttng_condition *condition_key = (struct lttng_condition *) key;
342 struct lttng_trigger_ht_element *trigger;
343 struct lttng_condition *condition;
344
345 trigger = caa_container_of(node, struct lttng_trigger_ht_element,
346 node);
347 condition = lttng_trigger_get_condition(trigger->trigger);
348 assert(condition);
349
350 return !!lttng_condition_is_equal(condition_key, condition);
351 }
352
353 static
354 int match_client_list_condition(struct cds_lfht_node *node, const void *key)
355 {
356 struct lttng_condition *condition_key = (struct lttng_condition *) key;
357 struct notification_client_list *client_list;
358 const struct lttng_condition *condition;
359
360 assert(condition_key);
361
362 client_list = caa_container_of(node, struct notification_client_list,
363 notification_trigger_ht_node);
364 condition = lttng_trigger_get_const_condition(client_list->trigger);
365
366 return !!lttng_condition_is_equal(condition_key, condition);
367 }
368
369 static
370 int match_session(struct cds_lfht_node *node, const void *key)
371 {
372 const char *name = key;
373 struct session_info *session_info = caa_container_of(
374 node, struct session_info, sessions_ht_node);
375
376 return !strcmp(session_info->name, name);
377 }
378
379 static
380 unsigned long lttng_condition_buffer_usage_hash(
381 const struct lttng_condition *_condition)
382 {
383 unsigned long hash;
384 unsigned long condition_type;
385 struct lttng_condition_buffer_usage *condition;
386
387 condition = container_of(_condition,
388 struct lttng_condition_buffer_usage, parent);
389
390 condition_type = (unsigned long) condition->parent.type;
391 hash = hash_key_ulong((void *) condition_type, lttng_ht_seed);
392 if (condition->session_name) {
393 hash ^= hash_key_str(condition->session_name, lttng_ht_seed);
394 }
395 if (condition->channel_name) {
396 hash ^= hash_key_str(condition->channel_name, lttng_ht_seed);
397 }
398 if (condition->domain.set) {
399 hash ^= hash_key_ulong(
400 (void *) condition->domain.type,
401 lttng_ht_seed);
402 }
403 if (condition->threshold_ratio.set) {
404 uint64_t val;
405
406 val = condition->threshold_ratio.value * (double) UINT32_MAX;
407 hash ^= hash_key_u64(&val, lttng_ht_seed);
408 } else if (condition->threshold_bytes.set) {
409 uint64_t val;
410
411 val = condition->threshold_bytes.value;
412 hash ^= hash_key_u64(&val, lttng_ht_seed);
413 }
414 return hash;
415 }
416
417 static
418 unsigned long lttng_condition_session_consumed_size_hash(
419 const struct lttng_condition *_condition)
420 {
421 unsigned long hash;
422 unsigned long condition_type =
423 (unsigned long) LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE;
424 struct lttng_condition_session_consumed_size *condition;
425 uint64_t val;
426
427 condition = container_of(_condition,
428 struct lttng_condition_session_consumed_size, parent);
429
430 hash = hash_key_ulong((void *) condition_type, lttng_ht_seed);
431 if (condition->session_name) {
432 hash ^= hash_key_str(condition->session_name, lttng_ht_seed);
433 }
434 val = condition->consumed_threshold_bytes.value;
435 hash ^= hash_key_u64(&val, lttng_ht_seed);
436 return hash;
437 }
438
439 static
440 unsigned long lttng_condition_session_rotation_hash(
441 const struct lttng_condition *_condition)
442 {
443 unsigned long hash, condition_type;
444 struct lttng_condition_session_rotation *condition;
445
446 condition = container_of(_condition,
447 struct lttng_condition_session_rotation, parent);
448 condition_type = (unsigned long) condition->parent.type;
449 hash = hash_key_ulong((void *) condition_type, lttng_ht_seed);
450 assert(condition->session_name);
451 hash ^= hash_key_str(condition->session_name, lttng_ht_seed);
452 return hash;
453 }
454
455 /*
456 * The lttng_condition hashing code is kept in this file (rather than
457 * condition.c) since it makes use of GPLv2 code (hashtable utils), which we
458 * don't want to link in liblttng-ctl.
459 */
460 static
461 unsigned long lttng_condition_hash(const struct lttng_condition *condition)
462 {
463 switch (condition->type) {
464 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW:
465 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH:
466 return lttng_condition_buffer_usage_hash(condition);
467 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE:
468 return lttng_condition_session_consumed_size_hash(condition);
469 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING:
470 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED:
471 return lttng_condition_session_rotation_hash(condition);
472 default:
473 ERR("[notification-thread] Unexpected condition type caught");
474 abort();
475 }
476 }
477
478 static
479 unsigned long hash_channel_key(struct channel_key *key)
480 {
481 unsigned long key_hash = hash_key_u64(&key->key, lttng_ht_seed);
482 unsigned long domain_hash = hash_key_ulong(
483 (void *) (unsigned long) key->domain, lttng_ht_seed);
484
485 return key_hash ^ domain_hash;
486 }
487
488 /*
489 * Get the type of object to which a given condition applies. Bindings let
490 * the notification system evaluate a trigger's condition when a given
491 * object's state is updated.
492 *
493 * For instance, a condition bound to a channel will be evaluated everytime
494 * the channel's state is changed by a channel monitoring sample.
495 */
496 static
497 enum lttng_object_type get_condition_binding_object(
498 const struct lttng_condition *condition)
499 {
500 switch (lttng_condition_get_type(condition)) {
501 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW:
502 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH:
503 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE:
504 return LTTNG_OBJECT_TYPE_CHANNEL;
505 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING:
506 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED:
507 return LTTNG_OBJECT_TYPE_SESSION;
508 default:
509 return LTTNG_OBJECT_TYPE_UNKNOWN;
510 }
511 }
512
513 static
514 void free_channel_info_rcu(struct rcu_head *node)
515 {
516 free(caa_container_of(node, struct channel_info, rcu_node));
517 }
518
519 static
520 void channel_info_destroy(struct channel_info *channel_info)
521 {
522 if (!channel_info) {
523 return;
524 }
525
526 if (channel_info->session_info) {
527 session_info_remove_channel(channel_info->session_info,
528 channel_info);
529 session_info_put(channel_info->session_info);
530 }
531 if (channel_info->name) {
532 free(channel_info->name);
533 }
534 call_rcu(&channel_info->rcu_node, free_channel_info_rcu);
535 }
536
537 static
538 void free_session_info_rcu(struct rcu_head *node)
539 {
540 free(caa_container_of(node, struct session_info, rcu_node));
541 }
542
543 /* Don't call directly, use the ref-counting mechanism. */
544 static
545 void session_info_destroy(void *_data)
546 {
547 struct session_info *session_info = _data;
548 int ret;
549
550 assert(session_info);
551 if (session_info->channel_infos_ht) {
552 ret = cds_lfht_destroy(session_info->channel_infos_ht, NULL);
553 if (ret) {
554 ERR("[notification-thread] Failed to destroy channel information hash table");
555 }
556 }
557 lttng_session_trigger_list_destroy(session_info->trigger_list);
558
559 rcu_read_lock();
560 cds_lfht_del(session_info->sessions_ht,
561 &session_info->sessions_ht_node);
562 rcu_read_unlock();
563 free(session_info->name);
564 call_rcu(&session_info->rcu_node, free_session_info_rcu);
565 }
566
567 static
568 void session_info_get(struct session_info *session_info)
569 {
570 if (!session_info) {
571 return;
572 }
573 lttng_ref_get(&session_info->ref);
574 }
575
576 static
577 void session_info_put(struct session_info *session_info)
578 {
579 if (!session_info) {
580 return;
581 }
582 lttng_ref_put(&session_info->ref);
583 }
584
585 static
586 struct session_info *session_info_create(const char *name, uid_t uid, gid_t gid,
587 struct lttng_session_trigger_list *trigger_list,
588 struct cds_lfht *sessions_ht)
589 {
590 struct session_info *session_info;
591
592 assert(name);
593
594 session_info = zmalloc(sizeof(*session_info));
595 if (!session_info) {
596 goto end;
597 }
598 lttng_ref_init(&session_info->ref, session_info_destroy);
599
600 session_info->channel_infos_ht = cds_lfht_new(DEFAULT_HT_SIZE,
601 1, 0, CDS_LFHT_AUTO_RESIZE | CDS_LFHT_ACCOUNTING, NULL);
602 if (!session_info->channel_infos_ht) {
603 goto error;
604 }
605
606 cds_lfht_node_init(&session_info->sessions_ht_node);
607 session_info->name = strdup(name);
608 if (!session_info->name) {
609 goto error;
610 }
611 session_info->uid = uid;
612 session_info->gid = gid;
613 session_info->trigger_list = trigger_list;
614 session_info->sessions_ht = sessions_ht;
615 end:
616 return session_info;
617 error:
618 session_info_put(session_info);
619 return NULL;
620 }
621
622 static
623 void session_info_add_channel(struct session_info *session_info,
624 struct channel_info *channel_info)
625 {
626 rcu_read_lock();
627 cds_lfht_add(session_info->channel_infos_ht,
628 hash_channel_key(&channel_info->key),
629 &channel_info->session_info_channels_ht_node);
630 rcu_read_unlock();
631 }
632
633 static
634 void session_info_remove_channel(struct session_info *session_info,
635 struct channel_info *channel_info)
636 {
637 rcu_read_lock();
638 cds_lfht_del(session_info->channel_infos_ht,
639 &channel_info->session_info_channels_ht_node);
640 rcu_read_unlock();
641 }
642
643 static
644 struct channel_info *channel_info_create(const char *channel_name,
645 struct channel_key *channel_key, uint64_t channel_capacity,
646 struct session_info *session_info)
647 {
648 struct channel_info *channel_info = zmalloc(sizeof(*channel_info));
649
650 if (!channel_info) {
651 goto end;
652 }
653
654 cds_lfht_node_init(&channel_info->channels_ht_node);
655 cds_lfht_node_init(&channel_info->session_info_channels_ht_node);
656 memcpy(&channel_info->key, channel_key, sizeof(*channel_key));
657 channel_info->capacity = channel_capacity;
658
659 channel_info->name = strdup(channel_name);
660 if (!channel_info->name) {
661 goto error;
662 }
663
664 /*
665 * Set the references between session and channel infos:
666 * - channel_info holds a strong reference to session_info
667 * - session_info holds a weak reference to channel_info
668 */
669 session_info_get(session_info);
670 session_info_add_channel(session_info, channel_info);
671 channel_info->session_info = session_info;
672 end:
673 return channel_info;
674 error:
675 channel_info_destroy(channel_info);
676 return NULL;
677 }
678
679 /* RCU read lock must be held by the caller. */
680 static
681 struct notification_client_list *get_client_list_from_condition(
682 struct notification_thread_state *state,
683 const struct lttng_condition *condition)
684 {
685 struct cds_lfht_node *node;
686 struct cds_lfht_iter iter;
687
688 cds_lfht_lookup(state->notification_trigger_clients_ht,
689 lttng_condition_hash(condition),
690 match_client_list_condition,
691 condition,
692 &iter);
693 node = cds_lfht_iter_get_node(&iter);
694
695 return node ? caa_container_of(node,
696 struct notification_client_list,
697 notification_trigger_ht_node) : NULL;
698 }
699
700 /* This function must be called with the RCU read lock held. */
701 static
702 int evaluate_channel_condition_for_client(
703 const struct lttng_condition *condition,
704 struct notification_thread_state *state,
705 struct lttng_evaluation **evaluation,
706 uid_t *session_uid, gid_t *session_gid)
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;
715
716 /* Find the channel associated with the condition. */
717 cds_lfht_for_each_entry(state->channel_triggers_ht, &iter,
718 channel_trigger_list, channel_triggers_ht_node) {
719 struct lttng_trigger_list_element *element;
720
721 cds_list_for_each_entry(element, &channel_trigger_list->list, node) {
722 const struct lttng_condition *current_condition =
723 lttng_trigger_get_const_condition(
724 element->trigger);
725
726 assert(current_condition);
727 if (!lttng_condition_is_equal(condition,
728 current_condition)) {
729 continue;
730 }
731
732 /* Found the trigger, save the channel key. */
733 channel_key = &channel_trigger_list->channel_key;
734 break;
735 }
736 if (channel_key) {
737 /* The channel key was found stop iteration. */
738 break;
739 }
740 }
741
742 if (!channel_key){
743 /* No channel found; normal exit. */
744 DBG("[notification-thread] No known channel associated with newly subscribed-to condition");
745 ret = 0;
746 goto end;
747 }
748
749 /* Fetch channel info for the matching channel. */
750 cds_lfht_lookup(state->channels_ht,
751 hash_channel_key(channel_key),
752 match_channel_info,
753 channel_key,
754 &iter);
755 node = cds_lfht_iter_get_node(&iter);
756 assert(node);
757 channel_info = caa_container_of(node, struct channel_info,
758 channels_ht_node);
759
760 /* Retrieve the channel's last sample, if it exists. */
761 cds_lfht_lookup(state->channel_state_ht,
762 hash_channel_key(channel_key),
763 match_channel_state_sample,
764 channel_key,
765 &iter);
766 node = cds_lfht_iter_get_node(&iter);
767 if (node) {
768 last_sample = caa_container_of(node,
769 struct channel_state_sample,
770 channel_state_ht_node);
771 } else {
772 /* Nothing to evaluate, no sample was ever taken. Normal exit */
773 DBG("[notification-thread] No channel sample associated with newly subscribed-to condition");
774 ret = 0;
775 goto end;
776 }
777
778 ret = evaluate_buffer_condition(condition, evaluation, state,
779 NULL, last_sample,
780 0, channel_info->session_info->consumed_data_size,
781 channel_info);
782 if (ret) {
783 WARN("[notification-thread] Fatal error occurred while evaluating a newly subscribed-to condition");
784 goto end;
785 }
786
787 *session_uid = channel_info->session_info->uid;
788 *session_gid = channel_info->session_info->gid;
789 end:
790 return ret;
791 }
792
793 static
794 const char *get_condition_session_name(const struct lttng_condition *condition)
795 {
796 const char *session_name = NULL;
797 enum lttng_condition_status status;
798
799 switch (lttng_condition_get_type(condition)) {
800 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW:
801 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH:
802 status = lttng_condition_buffer_usage_get_session_name(
803 condition, &session_name);
804 break;
805 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE:
806 status = lttng_condition_session_consumed_size_get_session_name(
807 condition, &session_name);
808 break;
809 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING:
810 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED:
811 status = lttng_condition_session_rotation_get_session_name(
812 condition, &session_name);
813 break;
814 default:
815 abort();
816 }
817 if (status != LTTNG_CONDITION_STATUS_OK) {
818 ERR("[notification-thread] Failed to retrieve session rotation condition's session name");
819 goto end;
820 }
821 end:
822 return session_name;
823 }
824
825 /* This function must be called with the RCU read lock held. */
826 static
827 int evaluate_session_condition_for_client(
828 const struct lttng_condition *condition,
829 struct notification_thread_state *state,
830 struct lttng_evaluation **evaluation,
831 uid_t *session_uid, gid_t *session_gid)
832 {
833 int ret;
834 struct cds_lfht_iter iter;
835 struct cds_lfht_node *node;
836 const char *session_name;
837 struct session_info *session_info = NULL;
838
839 session_name = get_condition_session_name(condition);
840
841 /* Find the session associated with the trigger. */
842 cds_lfht_lookup(state->sessions_ht,
843 hash_key_str(session_name, lttng_ht_seed),
844 match_session,
845 session_name,
846 &iter);
847 node = cds_lfht_iter_get_node(&iter);
848 if (!node) {
849 DBG("[notification-thread] No known session matching name \"%s\"",
850 session_name);
851 ret = 0;
852 goto end;
853 }
854
855 session_info = caa_container_of(node, struct session_info,
856 sessions_ht_node);
857 session_info_get(session_info);
858
859 /*
860 * Evaluation is performed in-line here since only one type of
861 * session-bound condition is handled for the moment.
862 */
863 switch (lttng_condition_get_type(condition)) {
864 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING:
865 if (!session_info->rotation.ongoing) {
866 ret = 0;
867 goto end_session_put;
868 }
869
870 *evaluation = lttng_evaluation_session_rotation_ongoing_create(
871 session_info->rotation.id);
872 if (!*evaluation) {
873 /* Fatal error. */
874 ERR("[notification-thread] Failed to create session rotation ongoing evaluation for session \"%s\"",
875 session_info->name);
876 ret = -1;
877 goto end_session_put;
878 }
879 ret = 0;
880 break;
881 default:
882 ret = 0;
883 goto end_session_put;
884 }
885
886 *session_uid = session_info->uid;
887 *session_gid = session_info->gid;
888
889 end_session_put:
890 session_info_put(session_info);
891 end:
892 return ret;
893 }
894
895 /* This function must be called with the RCU read lock held. */
896 static
897 int evaluate_condition_for_client(const struct lttng_trigger *trigger,
898 const struct lttng_condition *condition,
899 struct notification_client *client,
900 struct notification_thread_state *state)
901 {
902 int ret;
903 struct lttng_evaluation *evaluation = NULL;
904 struct notification_client_list client_list = { 0 };
905 struct notification_client_list_element client_list_element = { 0 };
906 uid_t object_uid = 0;
907 gid_t object_gid = 0;
908
909 assert(trigger);
910 assert(condition);
911 assert(client);
912 assert(state);
913
914 switch (get_condition_binding_object(condition)) {
915 case LTTNG_OBJECT_TYPE_SESSION:
916 ret = evaluate_session_condition_for_client(condition, state,
917 &evaluation, &object_uid, &object_gid);
918 break;
919 case LTTNG_OBJECT_TYPE_CHANNEL:
920 ret = evaluate_channel_condition_for_client(condition, state,
921 &evaluation, &object_uid, &object_gid);
922 break;
923 case LTTNG_OBJECT_TYPE_NONE:
924 ret = 0;
925 goto end;
926 case LTTNG_OBJECT_TYPE_UNKNOWN:
927 default:
928 ret = -1;
929 goto end;
930 }
931 if (ret) {
932 /* Fatal error. */
933 goto end;
934 }
935 if (!evaluation) {
936 /* Evaluation yielded nothing. Normal exit. */
937 DBG("[notification-thread] Newly subscribed-to condition evaluated to false, nothing to report to client");
938 ret = 0;
939 goto end;
940 }
941
942 /*
943 * Create a temporary client list with the client currently
944 * subscribing.
945 */
946 cds_lfht_node_init(&client_list.notification_trigger_ht_node);
947 CDS_INIT_LIST_HEAD(&client_list.list);
948 client_list.trigger = trigger;
949
950 CDS_INIT_LIST_HEAD(&client_list_element.node);
951 client_list_element.client = client;
952 cds_list_add(&client_list_element.node, &client_list.list);
953
954 /* Send evaluation result to the newly-subscribed client. */
955 DBG("[notification-thread] Newly subscribed-to condition evaluated to true, notifying client");
956 ret = send_evaluation_to_clients(trigger, evaluation, &client_list,
957 state, object_uid, object_gid);
958
959 end:
960 return ret;
961 }
962
963 static
964 int notification_thread_client_subscribe(struct notification_client *client,
965 struct lttng_condition *condition,
966 struct notification_thread_state *state,
967 enum lttng_notification_channel_status *_status)
968 {
969 int ret = 0;
970 struct notification_client_list *client_list;
971 struct lttng_condition_list_element *condition_list_element = NULL;
972 struct notification_client_list_element *client_list_element = NULL;
973 enum lttng_notification_channel_status status =
974 LTTNG_NOTIFICATION_CHANNEL_STATUS_OK;
975
976 /*
977 * Ensure that the client has not already subscribed to this condition
978 * before.
979 */
980 cds_list_for_each_entry(condition_list_element, &client->condition_list, node) {
981 if (lttng_condition_is_equal(condition_list_element->condition,
982 condition)) {
983 status = LTTNG_NOTIFICATION_CHANNEL_STATUS_ALREADY_SUBSCRIBED;
984 goto end;
985 }
986 }
987
988 condition_list_element = zmalloc(sizeof(*condition_list_element));
989 if (!condition_list_element) {
990 ret = -1;
991 goto error;
992 }
993 client_list_element = zmalloc(sizeof(*client_list_element));
994 if (!client_list_element) {
995 ret = -1;
996 goto error;
997 }
998
999 rcu_read_lock();
1000
1001 /*
1002 * Add the newly-subscribed condition to the client's subscription list.
1003 */
1004 CDS_INIT_LIST_HEAD(&condition_list_element->node);
1005 condition_list_element->condition = condition;
1006 cds_list_add(&condition_list_element->node, &client->condition_list);
1007
1008 client_list = get_client_list_from_condition(state, condition);
1009 if (!client_list) {
1010 /*
1011 * No notification-emiting trigger registered with this
1012 * condition. We don't evaluate the condition right away
1013 * since this trigger is not registered yet.
1014 */
1015 free(client_list_element);
1016 goto end_unlock;
1017 }
1018
1019 /*
1020 * The condition to which the client just subscribed is evaluated
1021 * at this point so that conditions that are already TRUE result
1022 * in a notification being sent out.
1023 */
1024 if (evaluate_condition_for_client(client_list->trigger, condition,
1025 client, state)) {
1026 WARN("[notification-thread] Evaluation of a condition on client subscription failed, aborting.");
1027 ret = -1;
1028 free(client_list_element);
1029 goto end_unlock;
1030 }
1031
1032 /*
1033 * Add the client to the list of clients interested in a given trigger
1034 * if a "notification" trigger with a corresponding condition was
1035 * added prior.
1036 */
1037 client_list_element->client = client;
1038 CDS_INIT_LIST_HEAD(&client_list_element->node);
1039 cds_list_add(&client_list_element->node, &client_list->list);
1040 end_unlock:
1041 rcu_read_unlock();
1042 end:
1043 if (_status) {
1044 *_status = status;
1045 }
1046 return ret;
1047 error:
1048 free(condition_list_element);
1049 free(client_list_element);
1050 return ret;
1051 }
1052
1053 static
1054 int notification_thread_client_unsubscribe(
1055 struct notification_client *client,
1056 struct lttng_condition *condition,
1057 struct notification_thread_state *state,
1058 enum lttng_notification_channel_status *_status)
1059 {
1060 struct notification_client_list *client_list;
1061 struct lttng_condition_list_element *condition_list_element,
1062 *condition_tmp;
1063 struct notification_client_list_element *client_list_element,
1064 *client_tmp;
1065 bool condition_found = false;
1066 enum lttng_notification_channel_status status =
1067 LTTNG_NOTIFICATION_CHANNEL_STATUS_OK;
1068
1069 /* Remove the condition from the client's condition list. */
1070 cds_list_for_each_entry_safe(condition_list_element, condition_tmp,
1071 &client->condition_list, node) {
1072 if (!lttng_condition_is_equal(condition_list_element->condition,
1073 condition)) {
1074 continue;
1075 }
1076
1077 cds_list_del(&condition_list_element->node);
1078 /*
1079 * The caller may be iterating on the client's conditions to
1080 * tear down a client's connection. In this case, the condition
1081 * will be destroyed at the end.
1082 */
1083 if (condition != condition_list_element->condition) {
1084 lttng_condition_destroy(
1085 condition_list_element->condition);
1086 }
1087 free(condition_list_element);
1088 condition_found = true;
1089 break;
1090 }
1091
1092 if (!condition_found) {
1093 status = LTTNG_NOTIFICATION_CHANNEL_STATUS_UNKNOWN_CONDITION;
1094 goto end;
1095 }
1096
1097 /*
1098 * Remove the client from the list of clients interested the trigger
1099 * matching the condition.
1100 */
1101 rcu_read_lock();
1102 client_list = get_client_list_from_condition(state, condition);
1103 if (!client_list) {
1104 goto end_unlock;
1105 }
1106
1107 cds_list_for_each_entry_safe(client_list_element, client_tmp,
1108 &client_list->list, node) {
1109 if (client_list_element->client->socket != client->socket) {
1110 continue;
1111 }
1112 cds_list_del(&client_list_element->node);
1113 free(client_list_element);
1114 break;
1115 }
1116 end_unlock:
1117 rcu_read_unlock();
1118 end:
1119 lttng_condition_destroy(condition);
1120 if (_status) {
1121 *_status = status;
1122 }
1123 return 0;
1124 }
1125
1126 static
1127 void free_notification_client_rcu(struct rcu_head *node)
1128 {
1129 free(caa_container_of(node, struct notification_client, rcu_node));
1130 }
1131
1132 static
1133 void notification_client_destroy(struct notification_client *client,
1134 struct notification_thread_state *state)
1135 {
1136 struct lttng_condition_list_element *condition_list_element, *tmp;
1137
1138 if (!client) {
1139 return;
1140 }
1141
1142 /* Release all conditions to which the client was subscribed. */
1143 cds_list_for_each_entry_safe(condition_list_element, tmp,
1144 &client->condition_list, node) {
1145 (void) notification_thread_client_unsubscribe(client,
1146 condition_list_element->condition, state, NULL);
1147 }
1148
1149 if (client->socket >= 0) {
1150 (void) lttcomm_close_unix_sock(client->socket);
1151 }
1152 lttng_dynamic_buffer_reset(&client->communication.inbound.buffer);
1153 lttng_dynamic_buffer_reset(&client->communication.outbound.buffer);
1154 call_rcu(&client->rcu_node, free_notification_client_rcu);
1155 }
1156
1157 /*
1158 * Call with rcu_read_lock held (and hold for the lifetime of the returned
1159 * client pointer).
1160 */
1161 static
1162 struct notification_client *get_client_from_socket(int socket,
1163 struct notification_thread_state *state)
1164 {
1165 struct cds_lfht_iter iter;
1166 struct cds_lfht_node *node;
1167 struct notification_client *client = NULL;
1168
1169 cds_lfht_lookup(state->client_socket_ht,
1170 hash_key_ulong((void *) (unsigned long) socket, lttng_ht_seed),
1171 match_client,
1172 (void *) (unsigned long) socket,
1173 &iter);
1174 node = cds_lfht_iter_get_node(&iter);
1175 if (!node) {
1176 goto end;
1177 }
1178
1179 client = caa_container_of(node, struct notification_client,
1180 client_socket_ht_node);
1181 end:
1182 return client;
1183 }
1184
1185 static
1186 bool buffer_usage_condition_applies_to_channel(
1187 const struct lttng_condition *condition,
1188 const struct channel_info *channel_info)
1189 {
1190 enum lttng_condition_status status;
1191 enum lttng_domain_type condition_domain;
1192 const char *condition_session_name = NULL;
1193 const char *condition_channel_name = NULL;
1194
1195 status = lttng_condition_buffer_usage_get_domain_type(condition,
1196 &condition_domain);
1197 assert(status == LTTNG_CONDITION_STATUS_OK);
1198 if (channel_info->key.domain != condition_domain) {
1199 goto fail;
1200 }
1201
1202 status = lttng_condition_buffer_usage_get_session_name(
1203 condition, &condition_session_name);
1204 assert((status == LTTNG_CONDITION_STATUS_OK) && condition_session_name);
1205
1206 status = lttng_condition_buffer_usage_get_channel_name(
1207 condition, &condition_channel_name);
1208 assert((status == LTTNG_CONDITION_STATUS_OK) && condition_channel_name);
1209
1210 if (strcmp(channel_info->session_info->name, condition_session_name)) {
1211 goto fail;
1212 }
1213 if (strcmp(channel_info->name, condition_channel_name)) {
1214 goto fail;
1215 }
1216
1217 return true;
1218 fail:
1219 return false;
1220 }
1221
1222 static
1223 bool session_consumed_size_condition_applies_to_channel(
1224 const struct lttng_condition *condition,
1225 const struct channel_info *channel_info)
1226 {
1227 enum lttng_condition_status status;
1228 const char *condition_session_name = NULL;
1229
1230 status = lttng_condition_session_consumed_size_get_session_name(
1231 condition, &condition_session_name);
1232 assert((status == LTTNG_CONDITION_STATUS_OK) && condition_session_name);
1233
1234 if (strcmp(channel_info->session_info->name, condition_session_name)) {
1235 goto fail;
1236 }
1237
1238 return true;
1239 fail:
1240 return false;
1241 }
1242
1243 static
1244 bool trigger_applies_to_channel(const struct lttng_trigger *trigger,
1245 const struct channel_info *channel_info)
1246 {
1247 const struct lttng_condition *condition;
1248 bool trigger_applies;
1249
1250 condition = lttng_trigger_get_const_condition(trigger);
1251 if (!condition) {
1252 goto fail;
1253 }
1254
1255 switch (lttng_condition_get_type(condition)) {
1256 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW:
1257 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH:
1258 trigger_applies = buffer_usage_condition_applies_to_channel(
1259 condition, channel_info);
1260 break;
1261 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE:
1262 trigger_applies = session_consumed_size_condition_applies_to_channel(
1263 condition, channel_info);
1264 break;
1265 default:
1266 goto fail;
1267 }
1268
1269 return trigger_applies;
1270 fail:
1271 return false;
1272 }
1273
1274 static
1275 bool trigger_applies_to_client(struct lttng_trigger *trigger,
1276 struct notification_client *client)
1277 {
1278 bool applies = false;
1279 struct lttng_condition_list_element *condition_list_element;
1280
1281 cds_list_for_each_entry(condition_list_element, &client->condition_list,
1282 node) {
1283 applies = lttng_condition_is_equal(
1284 condition_list_element->condition,
1285 lttng_trigger_get_condition(trigger));
1286 if (applies) {
1287 break;
1288 }
1289 }
1290 return applies;
1291 }
1292
1293 /* Must be called with RCU read lock held. */
1294 static
1295 struct lttng_session_trigger_list *get_session_trigger_list(
1296 struct notification_thread_state *state,
1297 const char *session_name)
1298 {
1299 struct lttng_session_trigger_list *list = NULL;
1300 struct cds_lfht_node *node;
1301 struct cds_lfht_iter iter;
1302
1303 cds_lfht_lookup(state->session_triggers_ht,
1304 hash_key_str(session_name, lttng_ht_seed),
1305 match_session_trigger_list,
1306 session_name,
1307 &iter);
1308 node = cds_lfht_iter_get_node(&iter);
1309 if (!node) {
1310 /*
1311 * Not an error, the list of triggers applying to that session
1312 * will be initialized when the session is created.
1313 */
1314 DBG("[notification-thread] No trigger list found for session \"%s\" as it is not yet known to the notification system",
1315 session_name);
1316 goto end;
1317 }
1318
1319 list = caa_container_of(node,
1320 struct lttng_session_trigger_list,
1321 session_triggers_ht_node);
1322 end:
1323 return list;
1324 }
1325
1326 /*
1327 * Allocate an empty lttng_session_trigger_list for the session named
1328 * 'session_name'.
1329 *
1330 * No ownership of 'session_name' is assumed by the session trigger list.
1331 * It is the caller's responsability to ensure the session name is alive
1332 * for as long as this list is.
1333 */
1334 static
1335 struct lttng_session_trigger_list *lttng_session_trigger_list_create(
1336 const char *session_name,
1337 struct cds_lfht *session_triggers_ht)
1338 {
1339 struct lttng_session_trigger_list *list;
1340
1341 list = zmalloc(sizeof(*list));
1342 if (!list) {
1343 goto end;
1344 }
1345 list->session_name = session_name;
1346 CDS_INIT_LIST_HEAD(&list->list);
1347 cds_lfht_node_init(&list->session_triggers_ht_node);
1348 list->session_triggers_ht = session_triggers_ht;
1349
1350 rcu_read_lock();
1351 /* Publish the list through the session_triggers_ht. */
1352 cds_lfht_add(session_triggers_ht,
1353 hash_key_str(session_name, lttng_ht_seed),
1354 &list->session_triggers_ht_node);
1355 rcu_read_unlock();
1356 end:
1357 return list;
1358 }
1359
1360 static
1361 void free_session_trigger_list_rcu(struct rcu_head *node)
1362 {
1363 free(caa_container_of(node, struct lttng_session_trigger_list,
1364 rcu_node));
1365 }
1366
1367 static
1368 void lttng_session_trigger_list_destroy(struct lttng_session_trigger_list *list)
1369 {
1370 struct lttng_trigger_list_element *trigger_list_element, *tmp;
1371
1372 /* Empty the list element by element, and then free the list itself. */
1373 cds_list_for_each_entry_safe(trigger_list_element, tmp,
1374 &list->list, node) {
1375 cds_list_del(&trigger_list_element->node);
1376 free(trigger_list_element);
1377 }
1378 rcu_read_lock();
1379 /* Unpublish the list from the session_triggers_ht. */
1380 cds_lfht_del(list->session_triggers_ht,
1381 &list->session_triggers_ht_node);
1382 rcu_read_unlock();
1383 call_rcu(&list->rcu_node, free_session_trigger_list_rcu);
1384 }
1385
1386 static
1387 int lttng_session_trigger_list_add(struct lttng_session_trigger_list *list,
1388 const struct lttng_trigger *trigger)
1389 {
1390 int ret = 0;
1391 struct lttng_trigger_list_element *new_element =
1392 zmalloc(sizeof(*new_element));
1393
1394 if (!new_element) {
1395 ret = -1;
1396 goto end;
1397 }
1398 CDS_INIT_LIST_HEAD(&new_element->node);
1399 new_element->trigger = trigger;
1400 cds_list_add(&new_element->node, &list->list);
1401 end:
1402 return ret;
1403 }
1404
1405 static
1406 bool trigger_applies_to_session(const struct lttng_trigger *trigger,
1407 const char *session_name)
1408 {
1409 bool applies = false;
1410 const struct lttng_condition *condition;
1411
1412 condition = lttng_trigger_get_const_condition(trigger);
1413 switch (lttng_condition_get_type(condition)) {
1414 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING:
1415 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED:
1416 {
1417 enum lttng_condition_status condition_status;
1418 const char *condition_session_name;
1419
1420 condition_status = lttng_condition_session_rotation_get_session_name(
1421 condition, &condition_session_name);
1422 if (condition_status != LTTNG_CONDITION_STATUS_OK) {
1423 ERR("[notification-thread] Failed to retrieve session rotation condition's session name");
1424 goto end;
1425 }
1426
1427 assert(condition_session_name);
1428 applies = !strcmp(condition_session_name, session_name);
1429 break;
1430 }
1431 default:
1432 goto end;
1433 }
1434 end:
1435 return applies;
1436 }
1437
1438 /*
1439 * Allocate and initialize an lttng_session_trigger_list which contains
1440 * all triggers that apply to the session named 'session_name'.
1441 *
1442 * No ownership of 'session_name' is assumed by the session trigger list.
1443 * It is the caller's responsability to ensure the session name is alive
1444 * for as long as this list is.
1445 */
1446 static
1447 struct lttng_session_trigger_list *lttng_session_trigger_list_build(
1448 const struct notification_thread_state *state,
1449 const char *session_name)
1450 {
1451 int trigger_count = 0;
1452 struct lttng_session_trigger_list *session_trigger_list = NULL;
1453 struct lttng_trigger_ht_element *trigger_ht_element = NULL;
1454 struct cds_lfht_iter iter;
1455
1456 session_trigger_list = lttng_session_trigger_list_create(session_name,
1457 state->session_triggers_ht);
1458
1459 /* Add all triggers applying to the session named 'session_name'. */
1460 cds_lfht_for_each_entry(state->triggers_ht, &iter, trigger_ht_element,
1461 node) {
1462 int ret;
1463
1464 if (!trigger_applies_to_session(trigger_ht_element->trigger,
1465 session_name)) {
1466 continue;
1467 }
1468
1469 ret = lttng_session_trigger_list_add(session_trigger_list,
1470 trigger_ht_element->trigger);
1471 if (ret) {
1472 goto error;
1473 }
1474
1475 trigger_count++;
1476 }
1477
1478 DBG("[notification-thread] Found %i triggers that apply to newly created session",
1479 trigger_count);
1480 return session_trigger_list;
1481 error:
1482 lttng_session_trigger_list_destroy(session_trigger_list);
1483 return NULL;
1484 }
1485
1486 static
1487 struct session_info *find_or_create_session_info(
1488 struct notification_thread_state *state,
1489 const char *name, uid_t uid, gid_t gid)
1490 {
1491 struct session_info *session = NULL;
1492 struct cds_lfht_node *node;
1493 struct cds_lfht_iter iter;
1494 struct lttng_session_trigger_list *trigger_list;
1495
1496 rcu_read_lock();
1497 cds_lfht_lookup(state->sessions_ht,
1498 hash_key_str(name, lttng_ht_seed),
1499 match_session,
1500 name,
1501 &iter);
1502 node = cds_lfht_iter_get_node(&iter);
1503 if (node) {
1504 DBG("[notification-thread] Found session info of session \"%s\" (uid = %i, gid = %i)",
1505 name, uid, gid);
1506 session = caa_container_of(node, struct session_info,
1507 sessions_ht_node);
1508 assert(session->uid == uid);
1509 assert(session->gid == gid);
1510 session_info_get(session);
1511 goto end;
1512 }
1513
1514 trigger_list = lttng_session_trigger_list_build(state, name);
1515 if (!trigger_list) {
1516 goto error;
1517 }
1518
1519 session = session_info_create(name, uid, gid, trigger_list,
1520 state->sessions_ht);
1521 if (!session) {
1522 ERR("[notification-thread] Failed to allocation session info for session \"%s\" (uid = %i, gid = %i)",
1523 name, uid, gid);
1524 lttng_session_trigger_list_destroy(trigger_list);
1525 goto error;
1526 }
1527 trigger_list = NULL;
1528
1529 cds_lfht_add(state->sessions_ht, hash_key_str(name, lttng_ht_seed),
1530 &session->sessions_ht_node);
1531 end:
1532 rcu_read_unlock();
1533 return session;
1534 error:
1535 rcu_read_unlock();
1536 session_info_put(session);
1537 return NULL;
1538 }
1539
1540 static
1541 int handle_notification_thread_command_add_channel(
1542 struct notification_thread_state *state,
1543 const char *session_name, uid_t session_uid, gid_t session_gid,
1544 const char *channel_name, enum lttng_domain_type channel_domain,
1545 uint64_t channel_key_int, uint64_t channel_capacity,
1546 enum lttng_error_code *cmd_result)
1547 {
1548 struct cds_list_head trigger_list;
1549 struct channel_info *new_channel_info = NULL;
1550 struct channel_key channel_key = {
1551 .key = channel_key_int,
1552 .domain = channel_domain,
1553 };
1554 struct lttng_channel_trigger_list *channel_trigger_list = NULL;
1555 struct lttng_trigger_ht_element *trigger_ht_element = NULL;
1556 int trigger_count = 0;
1557 struct cds_lfht_iter iter;
1558 struct session_info *session_info = NULL;
1559
1560 DBG("[notification-thread] Adding channel %s from session %s, channel key = %" PRIu64 " in %s domain",
1561 channel_name, session_name, channel_key_int,
1562 channel_domain == LTTNG_DOMAIN_KERNEL ? "kernel" : "user space");
1563
1564 CDS_INIT_LIST_HEAD(&trigger_list);
1565
1566 session_info = find_or_create_session_info(state, session_name,
1567 session_uid, session_gid);
1568 if (!session_info) {
1569 /* Allocation error or an internal error occurred. */
1570 goto error;
1571 }
1572
1573 new_channel_info = channel_info_create(channel_name, &channel_key,
1574 channel_capacity, session_info);
1575 if (!new_channel_info) {
1576 goto error;
1577 }
1578
1579 rcu_read_lock();
1580 /* Build a list of all triggers applying to the new channel. */
1581 cds_lfht_for_each_entry(state->triggers_ht, &iter, trigger_ht_element,
1582 node) {
1583 struct lttng_trigger_list_element *new_element;
1584
1585 if (!trigger_applies_to_channel(trigger_ht_element->trigger,
1586 new_channel_info)) {
1587 continue;
1588 }
1589
1590 new_element = zmalloc(sizeof(*new_element));
1591 if (!new_element) {
1592 rcu_read_unlock();
1593 goto error;
1594 }
1595 CDS_INIT_LIST_HEAD(&new_element->node);
1596 new_element->trigger = trigger_ht_element->trigger;
1597 cds_list_add(&new_element->node, &trigger_list);
1598 trigger_count++;
1599 }
1600 rcu_read_unlock();
1601
1602 DBG("[notification-thread] Found %i triggers that apply to newly added channel",
1603 trigger_count);
1604 channel_trigger_list = zmalloc(sizeof(*channel_trigger_list));
1605 if (!channel_trigger_list) {
1606 goto error;
1607 }
1608 channel_trigger_list->channel_key = new_channel_info->key;
1609 CDS_INIT_LIST_HEAD(&channel_trigger_list->list);
1610 cds_lfht_node_init(&channel_trigger_list->channel_triggers_ht_node);
1611 cds_list_splice(&trigger_list, &channel_trigger_list->list);
1612
1613 rcu_read_lock();
1614 /* Add channel to the channel_ht which owns the channel_infos. */
1615 cds_lfht_add(state->channels_ht,
1616 hash_channel_key(&new_channel_info->key),
1617 &new_channel_info->channels_ht_node);
1618 /*
1619 * Add the list of triggers associated with this channel to the
1620 * channel_triggers_ht.
1621 */
1622 cds_lfht_add(state->channel_triggers_ht,
1623 hash_channel_key(&new_channel_info->key),
1624 &channel_trigger_list->channel_triggers_ht_node);
1625 rcu_read_unlock();
1626 session_info_put(session_info);
1627 *cmd_result = LTTNG_OK;
1628 return 0;
1629 error:
1630 channel_info_destroy(new_channel_info);
1631 session_info_put(session_info);
1632 return 1;
1633 }
1634
1635 static
1636 void free_channel_trigger_list_rcu(struct rcu_head *node)
1637 {
1638 free(caa_container_of(node, struct lttng_channel_trigger_list,
1639 rcu_node));
1640 }
1641
1642 static
1643 void free_channel_state_sample_rcu(struct rcu_head *node)
1644 {
1645 free(caa_container_of(node, struct channel_state_sample,
1646 rcu_node));
1647 }
1648
1649 static
1650 int handle_notification_thread_command_remove_channel(
1651 struct notification_thread_state *state,
1652 uint64_t channel_key, enum lttng_domain_type domain,
1653 enum lttng_error_code *cmd_result)
1654 {
1655 struct cds_lfht_node *node;
1656 struct cds_lfht_iter iter;
1657 struct lttng_channel_trigger_list *trigger_list;
1658 struct lttng_trigger_list_element *trigger_list_element, *tmp;
1659 struct channel_key key = { .key = channel_key, .domain = domain };
1660 struct channel_info *channel_info;
1661
1662 DBG("[notification-thread] Removing channel key = %" PRIu64 " in %s domain",
1663 channel_key, domain == LTTNG_DOMAIN_KERNEL ? "kernel" : "user space");
1664
1665 rcu_read_lock();
1666
1667 cds_lfht_lookup(state->channel_triggers_ht,
1668 hash_channel_key(&key),
1669 match_channel_trigger_list,
1670 &key,
1671 &iter);
1672 node = cds_lfht_iter_get_node(&iter);
1673 /*
1674 * There is a severe internal error if we are being asked to remove a
1675 * channel that doesn't exist.
1676 */
1677 if (!node) {
1678 ERR("[notification-thread] Channel being removed is unknown to the notification thread");
1679 goto end;
1680 }
1681
1682 /* Free the list of triggers associated with this channel. */
1683 trigger_list = caa_container_of(node, struct lttng_channel_trigger_list,
1684 channel_triggers_ht_node);
1685 cds_list_for_each_entry_safe(trigger_list_element, tmp,
1686 &trigger_list->list, node) {
1687 cds_list_del(&trigger_list_element->node);
1688 free(trigger_list_element);
1689 }
1690 cds_lfht_del(state->channel_triggers_ht, node);
1691 call_rcu(&trigger_list->rcu_node, free_channel_trigger_list_rcu);
1692
1693 /* Free sampled channel state. */
1694 cds_lfht_lookup(state->channel_state_ht,
1695 hash_channel_key(&key),
1696 match_channel_state_sample,
1697 &key,
1698 &iter);
1699 node = cds_lfht_iter_get_node(&iter);
1700 /*
1701 * This is expected to be NULL if the channel is destroyed before we
1702 * received a sample.
1703 */
1704 if (node) {
1705 struct channel_state_sample *sample = caa_container_of(node,
1706 struct channel_state_sample,
1707 channel_state_ht_node);
1708
1709 cds_lfht_del(state->channel_state_ht, node);
1710 call_rcu(&sample->rcu_node, free_channel_state_sample_rcu);
1711 }
1712
1713 /* Remove the channel from the channels_ht and free it. */
1714 cds_lfht_lookup(state->channels_ht,
1715 hash_channel_key(&key),
1716 match_channel_info,
1717 &key,
1718 &iter);
1719 node = cds_lfht_iter_get_node(&iter);
1720 assert(node);
1721 channel_info = caa_container_of(node, struct channel_info,
1722 channels_ht_node);
1723 cds_lfht_del(state->channels_ht, node);
1724 channel_info_destroy(channel_info);
1725 end:
1726 rcu_read_unlock();
1727 *cmd_result = LTTNG_OK;
1728 return 0;
1729 }
1730
1731 static
1732 int handle_notification_thread_command_session_rotation(
1733 struct notification_thread_state *state,
1734 enum notification_thread_command_type cmd_type,
1735 const char *session_name, uid_t session_uid, gid_t session_gid,
1736 uint64_t trace_archive_chunk_id,
1737 struct lttng_trace_archive_location *location,
1738 enum lttng_error_code *_cmd_result)
1739 {
1740 int ret = 0;
1741 enum lttng_error_code cmd_result = LTTNG_OK;
1742 struct lttng_session_trigger_list *trigger_list;
1743 struct lttng_trigger_list_element *trigger_list_element;
1744 struct session_info *session_info;
1745
1746 rcu_read_lock();
1747
1748 session_info = find_or_create_session_info(state, session_name,
1749 session_uid, session_gid);
1750 if (!session_info) {
1751 /* Allocation error or an internal error occurred. */
1752 ret = -1;
1753 cmd_result = LTTNG_ERR_NOMEM;
1754 goto end;
1755 }
1756
1757 session_info->rotation.ongoing =
1758 cmd_type == NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING;
1759 session_info->rotation.id = trace_archive_chunk_id;
1760 trigger_list = get_session_trigger_list(state, session_name);
1761 if (!trigger_list) {
1762 DBG("[notification-thread] No triggers applying to session \"%s\" found",
1763 session_name);
1764 goto end;
1765 }
1766
1767 cds_list_for_each_entry(trigger_list_element, &trigger_list->list,
1768 node) {
1769 const struct lttng_condition *condition;
1770 const struct lttng_action *action;
1771 const struct lttng_trigger *trigger;
1772 struct notification_client_list *client_list;
1773 struct lttng_evaluation *evaluation = NULL;
1774 enum lttng_condition_type condition_type;
1775
1776 trigger = trigger_list_element->trigger;
1777 condition = lttng_trigger_get_const_condition(trigger);
1778 assert(condition);
1779 condition_type = lttng_condition_get_type(condition);
1780
1781 if (condition_type == LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING &&
1782 cmd_type != NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING) {
1783 continue;
1784 } else if (condition_type == LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED &&
1785 cmd_type != NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_COMPLETED) {
1786 continue;
1787 }
1788
1789 action = lttng_trigger_get_const_action(trigger);
1790
1791 /* Notify actions are the only type currently supported. */
1792 assert(lttng_action_get_type_const(action) ==
1793 LTTNG_ACTION_TYPE_NOTIFY);
1794
1795 client_list = get_client_list_from_condition(state, condition);
1796 assert(client_list);
1797
1798 if (cds_list_empty(&client_list->list)) {
1799 /*
1800 * No clients interested in the evaluation's result,
1801 * skip it.
1802 */
1803 continue;
1804 }
1805
1806 if (cmd_type == NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING) {
1807 evaluation = lttng_evaluation_session_rotation_ongoing_create(
1808 trace_archive_chunk_id);
1809 } else {
1810 evaluation = lttng_evaluation_session_rotation_completed_create(
1811 trace_archive_chunk_id, location);
1812 }
1813
1814 if (!evaluation) {
1815 /* Internal error */
1816 ret = -1;
1817 cmd_result = LTTNG_ERR_UNK;
1818 goto end;
1819 }
1820
1821 /* Dispatch evaluation result to all clients. */
1822 ret = send_evaluation_to_clients(trigger_list_element->trigger,
1823 evaluation, client_list, state,
1824 session_info->uid,
1825 session_info->gid);
1826 lttng_evaluation_destroy(evaluation);
1827 if (caa_unlikely(ret)) {
1828 goto end;
1829 }
1830 }
1831 end:
1832 session_info_put(session_info);
1833 *_cmd_result = cmd_result;
1834 rcu_read_unlock();
1835 return ret;
1836 }
1837
1838 static
1839 int condition_is_supported(struct lttng_condition *condition)
1840 {
1841 int ret;
1842
1843 switch (lttng_condition_get_type(condition)) {
1844 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW:
1845 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH:
1846 {
1847 enum lttng_domain_type domain;
1848
1849 ret = lttng_condition_buffer_usage_get_domain_type(condition,
1850 &domain);
1851 if (ret) {
1852 ret = -1;
1853 goto end;
1854 }
1855
1856 if (domain != LTTNG_DOMAIN_KERNEL) {
1857 ret = 1;
1858 goto end;
1859 }
1860
1861 /*
1862 * Older kernel tracers don't expose the API to monitor their
1863 * buffers. Therefore, we reject triggers that require that
1864 * mechanism to be available to be evaluated.
1865 */
1866 ret = kernel_supports_ring_buffer_snapshot_sample_positions();
1867 break;
1868 }
1869 default:
1870 ret = 1;
1871 }
1872 end:
1873 return ret;
1874 }
1875
1876 /* Must be called with RCU read lock held. */
1877 static
1878 int bind_trigger_to_matching_session(const struct lttng_trigger *trigger,
1879 struct notification_thread_state *state)
1880 {
1881 int ret = 0;
1882 const struct lttng_condition *condition;
1883 const char *session_name;
1884 struct lttng_session_trigger_list *trigger_list;
1885
1886 condition = lttng_trigger_get_const_condition(trigger);
1887 switch (lttng_condition_get_type(condition)) {
1888 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_ONGOING:
1889 case LTTNG_CONDITION_TYPE_SESSION_ROTATION_COMPLETED:
1890 {
1891 enum lttng_condition_status status;
1892
1893 status = lttng_condition_session_rotation_get_session_name(
1894 condition, &session_name);
1895 if (status != LTTNG_CONDITION_STATUS_OK) {
1896 ERR("[notification-thread] Failed to bind trigger to session: unable to get 'session_rotation' condition's session name");
1897 ret = -1;
1898 goto end;
1899 }
1900 break;
1901 }
1902 default:
1903 ret = -1;
1904 goto end;
1905 }
1906
1907 trigger_list = get_session_trigger_list(state, session_name);
1908 if (!trigger_list) {
1909 DBG("[notification-thread] Unable to bind trigger applying to session \"%s\" as it is not yet known to the notification system",
1910 session_name);
1911 goto end;
1912
1913 }
1914
1915 DBG("[notification-thread] Newly registered trigger bound to session \"%s\"",
1916 session_name);
1917 ret = lttng_session_trigger_list_add(trigger_list, trigger);
1918 end:
1919 return ret;
1920 }
1921
1922 /* Must be called with RCU read lock held. */
1923 static
1924 int bind_trigger_to_matching_channels(const struct lttng_trigger *trigger,
1925 struct notification_thread_state *state)
1926 {
1927 int ret = 0;
1928 struct cds_lfht_node *node;
1929 struct cds_lfht_iter iter;
1930 struct channel_info *channel;
1931
1932 cds_lfht_for_each_entry(state->channels_ht, &iter, channel,
1933 channels_ht_node) {
1934 struct lttng_trigger_list_element *trigger_list_element;
1935 struct lttng_channel_trigger_list *trigger_list;
1936 struct cds_lfht_iter lookup_iter;
1937
1938 if (!trigger_applies_to_channel(trigger, channel)) {
1939 continue;
1940 }
1941
1942 cds_lfht_lookup(state->channel_triggers_ht,
1943 hash_channel_key(&channel->key),
1944 match_channel_trigger_list,
1945 &channel->key,
1946 &lookup_iter);
1947 node = cds_lfht_iter_get_node(&lookup_iter);
1948 assert(node);
1949 trigger_list = caa_container_of(node,
1950 struct lttng_channel_trigger_list,
1951 channel_triggers_ht_node);
1952
1953 trigger_list_element = zmalloc(sizeof(*trigger_list_element));
1954 if (!trigger_list_element) {
1955 ret = -1;
1956 goto end;
1957 }
1958 CDS_INIT_LIST_HEAD(&trigger_list_element->node);
1959 trigger_list_element->trigger = trigger;
1960 cds_list_add(&trigger_list_element->node, &trigger_list->list);
1961 DBG("[notification-thread] Newly registered trigger bound to channel \"%s\"",
1962 channel->name);
1963 }
1964 end:
1965 return ret;
1966 }
1967
1968 /*
1969 * FIXME A client's credentials are not checked when registering a trigger, nor
1970 * are they stored alongside with the trigger.
1971 *
1972 * The effects of this are benign since:
1973 * - The client will succeed in registering the trigger, as it is valid,
1974 * - The trigger will, internally, be bound to the channel/session,
1975 * - The notifications will not be sent since the client's credentials
1976 * are checked against the channel at that moment.
1977 *
1978 * If this function returns a non-zero value, it means something is
1979 * fundamentally broken and the whole subsystem/thread will be torn down.
1980 *
1981 * If a non-fatal error occurs, just set the cmd_result to the appropriate
1982 * error code.
1983 */
1984 static
1985 int handle_notification_thread_command_register_trigger(
1986 struct notification_thread_state *state,
1987 struct lttng_trigger *trigger,
1988 enum lttng_error_code *cmd_result)
1989 {
1990 int ret = 0;
1991 struct lttng_condition *condition;
1992 struct notification_client *client;
1993 struct notification_client_list *client_list = NULL;
1994 struct lttng_trigger_ht_element *trigger_ht_element = NULL;
1995 struct notification_client_list_element *client_list_element, *tmp;
1996 struct cds_lfht_node *node;
1997 struct cds_lfht_iter iter;
1998 bool free_trigger = true;
1999
2000 rcu_read_lock();
2001
2002 condition = lttng_trigger_get_condition(trigger);
2003 assert(condition);
2004
2005 ret = condition_is_supported(condition);
2006 if (ret < 0) {
2007 goto error;
2008 } else if (ret == 0) {
2009 *cmd_result = LTTNG_ERR_NOT_SUPPORTED;
2010 goto error;
2011 } else {
2012 /* Feature is supported, continue. */
2013 ret = 0;
2014 }
2015
2016 trigger_ht_element = zmalloc(sizeof(*trigger_ht_element));
2017 if (!trigger_ht_element) {
2018 ret = -1;
2019 goto error;
2020 }
2021
2022 /* Add trigger to the trigger_ht. */
2023 cds_lfht_node_init(&trigger_ht_element->node);
2024 trigger_ht_element->trigger = trigger;
2025
2026 node = cds_lfht_add_unique(state->triggers_ht,
2027 lttng_condition_hash(condition),
2028 match_condition,
2029 condition,
2030 &trigger_ht_element->node);
2031 if (node != &trigger_ht_element->node) {
2032 /* Not a fatal error, simply report it to the client. */
2033 *cmd_result = LTTNG_ERR_TRIGGER_EXISTS;
2034 goto error_free_ht_element;
2035 }
2036
2037 /*
2038 * Ownership of the trigger and of its wrapper was transfered to
2039 * the triggers_ht.
2040 */
2041 trigger_ht_element = NULL;
2042 free_trigger = false;
2043
2044 /*
2045 * The rest only applies to triggers that have a "notify" action.
2046 * It is not skipped as this is the only action type currently
2047 * supported.
2048 */
2049 client_list = zmalloc(sizeof(*client_list));
2050 if (!client_list) {
2051 ret = -1;
2052 goto error_free_ht_element;
2053 }
2054 cds_lfht_node_init(&client_list->notification_trigger_ht_node);
2055 CDS_INIT_LIST_HEAD(&client_list->list);
2056 client_list->trigger = trigger;
2057
2058 /* Build a list of clients to which this new trigger applies. */
2059 cds_lfht_for_each_entry(state->client_socket_ht, &iter, client,
2060 client_socket_ht_node) {
2061 if (!trigger_applies_to_client(trigger, client)) {
2062 continue;
2063 }
2064
2065 client_list_element = zmalloc(sizeof(*client_list_element));
2066 if (!client_list_element) {
2067 ret = -1;
2068 goto error_free_client_list;
2069 }
2070 CDS_INIT_LIST_HEAD(&client_list_element->node);
2071 client_list_element->client = client;
2072 cds_list_add(&client_list_element->node, &client_list->list);
2073 }
2074
2075 cds_lfht_add(state->notification_trigger_clients_ht,
2076 lttng_condition_hash(condition),
2077 &client_list->notification_trigger_ht_node);
2078
2079 switch (get_condition_binding_object(condition)) {
2080 case LTTNG_OBJECT_TYPE_SESSION:
2081 /* Add the trigger to the list if it matches a known session. */
2082 ret = bind_trigger_to_matching_session(trigger, state);
2083 if (ret) {
2084 goto error_free_client_list;
2085 }
2086 break;
2087 case LTTNG_OBJECT_TYPE_CHANNEL:
2088 /*
2089 * Add the trigger to list of triggers bound to the channels
2090 * currently known.
2091 */
2092 ret = bind_trigger_to_matching_channels(trigger, state);
2093 if (ret) {
2094 goto error_free_client_list;
2095 }
2096 break;
2097 case LTTNG_OBJECT_TYPE_NONE:
2098 break;
2099 default:
2100 ERR("[notification-thread] Unknown object type on which to bind a newly registered trigger was encountered");
2101 ret = -1;
2102 goto error_free_client_list;
2103 }
2104
2105 /*
2106 * Since there is nothing preventing clients from subscribing to a
2107 * condition before the corresponding trigger is registered, we have
2108 * to evaluate this new condition right away.
2109 *
2110 * At some point, we were waiting for the next "evaluation" (e.g. on
2111 * reception of a channel sample) to evaluate this new condition, but
2112 * that was broken.
2113 *
2114 * The reason it was broken is that waiting for the next sample
2115 * does not allow us to properly handle transitions for edge-triggered
2116 * conditions.
2117 *
2118 * Consider this example: when we handle a new channel sample, we
2119 * evaluate each conditions twice: once with the previous state, and
2120 * again with the newest state. We then use those two results to
2121 * determine whether a state change happened: a condition was false and
2122 * became true. If a state change happened, we have to notify clients.
2123 *
2124 * Now, if a client subscribes to a given notification and registers
2125 * a trigger *after* that subscription, we have to make sure the
2126 * condition is evaluated at this point while considering only the
2127 * current state. Otherwise, the next evaluation cycle may only see
2128 * that the evaluations remain the same (true for samples n-1 and n) and
2129 * the client will never know that the condition has been met.
2130 */
2131 cds_list_for_each_entry_safe(client_list_element, tmp,
2132 &client_list->list, node) {
2133 ret = evaluate_condition_for_client(trigger, condition,
2134 client_list_element->client, state);
2135 if (ret) {
2136 goto error_free_client_list;
2137 }
2138 }
2139
2140 /*
2141 * Client list ownership transferred to the
2142 * notification_trigger_clients_ht.
2143 */
2144 client_list = NULL;
2145
2146 *cmd_result = LTTNG_OK;
2147 error_free_client_list:
2148 if (client_list) {
2149 cds_list_for_each_entry_safe(client_list_element, tmp,
2150 &client_list->list, node) {
2151 free(client_list_element);
2152 }
2153 free(client_list);
2154 }
2155 error_free_ht_element:
2156 free(trigger_ht_element);
2157 error:
2158 if (free_trigger) {
2159 struct lttng_action *action = lttng_trigger_get_action(trigger);
2160
2161 lttng_condition_destroy(condition);
2162 lttng_action_destroy(action);
2163 lttng_trigger_destroy(trigger);
2164 }
2165 rcu_read_unlock();
2166 return ret;
2167 }
2168
2169 static
2170 void free_notification_client_list_rcu(struct rcu_head *node)
2171 {
2172 free(caa_container_of(node, struct notification_client_list,
2173 rcu_node));
2174 }
2175
2176 static
2177 void free_lttng_trigger_ht_element_rcu(struct rcu_head *node)
2178 {
2179 free(caa_container_of(node, struct lttng_trigger_ht_element,
2180 rcu_node));
2181 }
2182
2183 static
2184 int handle_notification_thread_command_unregister_trigger(
2185 struct notification_thread_state *state,
2186 struct lttng_trigger *trigger,
2187 enum lttng_error_code *_cmd_reply)
2188 {
2189 struct cds_lfht_iter iter;
2190 struct cds_lfht_node *triggers_ht_node;
2191 struct lttng_channel_trigger_list *trigger_list;
2192 struct notification_client_list *client_list;
2193 struct notification_client_list_element *client_list_element, *tmp;
2194 struct lttng_trigger_ht_element *trigger_ht_element = NULL;
2195 struct lttng_condition *condition = lttng_trigger_get_condition(
2196 trigger);
2197 struct lttng_action *action;
2198 enum lttng_error_code cmd_reply;
2199
2200 rcu_read_lock();
2201
2202 cds_lfht_lookup(state->triggers_ht,
2203 lttng_condition_hash(condition),
2204 match_condition,
2205 condition,
2206 &iter);
2207 triggers_ht_node = cds_lfht_iter_get_node(&iter);
2208 if (!triggers_ht_node) {
2209 cmd_reply = LTTNG_ERR_TRIGGER_NOT_FOUND;
2210 goto end;
2211 } else {
2212 cmd_reply = LTTNG_OK;
2213 }
2214
2215 /* Remove trigger from channel_triggers_ht. */
2216 cds_lfht_for_each_entry(state->channel_triggers_ht, &iter, trigger_list,
2217 channel_triggers_ht_node) {
2218 struct lttng_trigger_list_element *trigger_element, *tmp;
2219
2220 cds_list_for_each_entry_safe(trigger_element, tmp,
2221 &trigger_list->list, node) {
2222 const struct lttng_condition *current_condition =
2223 lttng_trigger_get_const_condition(
2224 trigger_element->trigger);
2225
2226 assert(current_condition);
2227 if (!lttng_condition_is_equal(condition,
2228 current_condition)) {
2229 continue;
2230 }
2231
2232 DBG("[notification-thread] Removed trigger from channel_triggers_ht");
2233 cds_list_del(&trigger_element->node);
2234 /* A trigger can only appear once per channel */
2235 break;
2236 }
2237 }
2238
2239 /*
2240 * Remove and release the client list from
2241 * notification_trigger_clients_ht.
2242 */
2243 client_list = get_client_list_from_condition(state, condition);
2244 assert(client_list);
2245
2246 cds_list_for_each_entry_safe(client_list_element, tmp,
2247 &client_list->list, node) {
2248 free(client_list_element);
2249 }
2250 cds_lfht_del(state->notification_trigger_clients_ht,
2251 &client_list->notification_trigger_ht_node);
2252 call_rcu(&client_list->rcu_node, free_notification_client_list_rcu);
2253
2254 /* Remove trigger from triggers_ht. */
2255 trigger_ht_element = caa_container_of(triggers_ht_node,
2256 struct lttng_trigger_ht_element, node);
2257 cds_lfht_del(state->triggers_ht, triggers_ht_node);
2258
2259 condition = lttng_trigger_get_condition(trigger_ht_element->trigger);
2260 lttng_condition_destroy(condition);
2261 action = lttng_trigger_get_action(trigger_ht_element->trigger);
2262 lttng_action_destroy(action);
2263 lttng_trigger_destroy(trigger_ht_element->trigger);
2264 call_rcu(&trigger_ht_element->rcu_node, free_lttng_trigger_ht_element_rcu);
2265 end:
2266 rcu_read_unlock();
2267 if (_cmd_reply) {
2268 *_cmd_reply = cmd_reply;
2269 }
2270 return 0;
2271 }
2272
2273 /* Returns 0 on success, 1 on exit requested, negative value on error. */
2274 int handle_notification_thread_command(
2275 struct notification_thread_handle *handle,
2276 struct notification_thread_state *state)
2277 {
2278 int ret;
2279 uint64_t counter;
2280 struct notification_thread_command *cmd;
2281
2282 /* Read the event pipe to put it back into a quiescent state. */
2283 ret = lttng_read(lttng_pipe_get_readfd(handle->cmd_queue.event_pipe), &counter,
2284 sizeof(counter));
2285 if (ret != sizeof(counter)) {
2286 goto error;
2287 }
2288
2289 pthread_mutex_lock(&handle->cmd_queue.lock);
2290 cmd = cds_list_first_entry(&handle->cmd_queue.list,
2291 struct notification_thread_command, cmd_list_node);
2292 switch (cmd->type) {
2293 case NOTIFICATION_COMMAND_TYPE_REGISTER_TRIGGER:
2294 DBG("[notification-thread] Received register trigger command");
2295 ret = handle_notification_thread_command_register_trigger(
2296 state, cmd->parameters.trigger,
2297 &cmd->reply_code);
2298 break;
2299 case NOTIFICATION_COMMAND_TYPE_UNREGISTER_TRIGGER:
2300 DBG("[notification-thread] Received unregister trigger command");
2301 ret = handle_notification_thread_command_unregister_trigger(
2302 state, cmd->parameters.trigger,
2303 &cmd->reply_code);
2304 break;
2305 case NOTIFICATION_COMMAND_TYPE_ADD_CHANNEL:
2306 DBG("[notification-thread] Received add channel command");
2307 ret = handle_notification_thread_command_add_channel(
2308 state,
2309 cmd->parameters.add_channel.session.name,
2310 cmd->parameters.add_channel.session.uid,
2311 cmd->parameters.add_channel.session.gid,
2312 cmd->parameters.add_channel.channel.name,
2313 cmd->parameters.add_channel.channel.domain,
2314 cmd->parameters.add_channel.channel.key,
2315 cmd->parameters.add_channel.channel.capacity,
2316 &cmd->reply_code);
2317 break;
2318 case NOTIFICATION_COMMAND_TYPE_REMOVE_CHANNEL:
2319 DBG("[notification-thread] Received remove channel command");
2320 ret = handle_notification_thread_command_remove_channel(
2321 state, cmd->parameters.remove_channel.key,
2322 cmd->parameters.remove_channel.domain,
2323 &cmd->reply_code);
2324 break;
2325 case NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING:
2326 case NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_COMPLETED:
2327 DBG("[notification-thread] Received session rotation %s command",
2328 cmd->type == NOTIFICATION_COMMAND_TYPE_SESSION_ROTATION_ONGOING ?
2329 "ongoing" : "completed");
2330 ret = handle_notification_thread_command_session_rotation(
2331 state,
2332 cmd->type,
2333 cmd->parameters.session_rotation.session_name,
2334 cmd->parameters.session_rotation.uid,
2335 cmd->parameters.session_rotation.gid,
2336 cmd->parameters.session_rotation.trace_archive_chunk_id,
2337 cmd->parameters.session_rotation.location,
2338 &cmd->reply_code);
2339 break;
2340 case NOTIFICATION_COMMAND_TYPE_QUIT:
2341 DBG("[notification-thread] Received quit command");
2342 cmd->reply_code = LTTNG_OK;
2343 ret = 1;
2344 goto end;
2345 default:
2346 ERR("[notification-thread] Unknown internal command received");
2347 goto error_unlock;
2348 }
2349
2350 if (ret) {
2351 goto error_unlock;
2352 }
2353 end:
2354 cds_list_del(&cmd->cmd_list_node);
2355 lttng_waiter_wake_up(&cmd->reply_waiter);
2356 pthread_mutex_unlock(&handle->cmd_queue.lock);
2357 return ret;
2358 error_unlock:
2359 /* Wake-up and return a fatal error to the calling thread. */
2360 lttng_waiter_wake_up(&cmd->reply_waiter);
2361 pthread_mutex_unlock(&handle->cmd_queue.lock);
2362 cmd->reply_code = LTTNG_ERR_FATAL;
2363 error:
2364 /* Indicate a fatal error to the caller. */
2365 return -1;
2366 }
2367
2368 static
2369 unsigned long hash_client_socket(int socket)
2370 {
2371 return hash_key_ulong((void *) (unsigned long) socket, lttng_ht_seed);
2372 }
2373
2374 static
2375 int socket_set_non_blocking(int socket)
2376 {
2377 int ret, flags;
2378
2379 /* Set the pipe as non-blocking. */
2380 ret = fcntl(socket, F_GETFL, 0);
2381 if (ret == -1) {
2382 PERROR("fcntl get socket flags");
2383 goto end;
2384 }
2385 flags = ret;
2386
2387 ret = fcntl(socket, F_SETFL, flags | O_NONBLOCK);
2388 if (ret == -1) {
2389 PERROR("fcntl set O_NONBLOCK socket flag");
2390 goto end;
2391 }
2392 DBG("Client socket (fd = %i) set as non-blocking", socket);
2393 end:
2394 return ret;
2395 }
2396
2397 static
2398 int client_reset_inbound_state(struct notification_client *client)
2399 {
2400 int ret;
2401
2402 ret = lttng_dynamic_buffer_set_size(
2403 &client->communication.inbound.buffer, 0);
2404 assert(!ret);
2405
2406 client->communication.inbound.bytes_to_receive =
2407 sizeof(struct lttng_notification_channel_message);
2408 client->communication.inbound.msg_type =
2409 LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_UNKNOWN;
2410 LTTNG_SOCK_SET_UID_CRED(&client->communication.inbound.creds, -1);
2411 LTTNG_SOCK_SET_GID_CRED(&client->communication.inbound.creds, -1);
2412 ret = lttng_dynamic_buffer_set_size(
2413 &client->communication.inbound.buffer,
2414 client->communication.inbound.bytes_to_receive);
2415 return ret;
2416 }
2417
2418 int handle_notification_thread_client_connect(
2419 struct notification_thread_state *state)
2420 {
2421 int ret;
2422 struct notification_client *client;
2423
2424 DBG("[notification-thread] Handling new notification channel client connection");
2425
2426 client = zmalloc(sizeof(*client));
2427 if (!client) {
2428 /* Fatal error. */
2429 ret = -1;
2430 goto error;
2431 }
2432 CDS_INIT_LIST_HEAD(&client->condition_list);
2433 lttng_dynamic_buffer_init(&client->communication.inbound.buffer);
2434 lttng_dynamic_buffer_init(&client->communication.outbound.buffer);
2435 client->communication.inbound.expect_creds = true;
2436 ret = client_reset_inbound_state(client);
2437 if (ret) {
2438 ERR("[notification-thread] Failed to reset client communication's inbound state");
2439 ret = 0;
2440 goto error;
2441 }
2442
2443 ret = lttcomm_accept_unix_sock(state->notification_channel_socket);
2444 if (ret < 0) {
2445 ERR("[notification-thread] Failed to accept new notification channel client connection");
2446 ret = 0;
2447 goto error;
2448 }
2449
2450 client->socket = ret;
2451
2452 ret = socket_set_non_blocking(client->socket);
2453 if (ret) {
2454 ERR("[notification-thread] Failed to set new notification channel client connection socket as non-blocking");
2455 goto error;
2456 }
2457
2458 ret = lttcomm_setsockopt_creds_unix_sock(client->socket);
2459 if (ret < 0) {
2460 ERR("[notification-thread] Failed to set socket options on new notification channel client socket");
2461 ret = 0;
2462 goto error;
2463 }
2464
2465 ret = lttng_poll_add(&state->events, client->socket,
2466 LPOLLIN | LPOLLERR |
2467 LPOLLHUP | LPOLLRDHUP);
2468 if (ret < 0) {
2469 ERR("[notification-thread] Failed to add notification channel client socket to poll set");
2470 ret = 0;
2471 goto error;
2472 }
2473 DBG("[notification-thread] Added new notification channel client socket (%i) to poll set",
2474 client->socket);
2475
2476 rcu_read_lock();
2477 cds_lfht_add(state->client_socket_ht,
2478 hash_client_socket(client->socket),
2479 &client->client_socket_ht_node);
2480 rcu_read_unlock();
2481
2482 return ret;
2483 error:
2484 notification_client_destroy(client, state);
2485 return ret;
2486 }
2487
2488 int handle_notification_thread_client_disconnect(
2489 int client_socket,
2490 struct notification_thread_state *state)
2491 {
2492 int ret = 0;
2493 struct notification_client *client;
2494
2495 rcu_read_lock();
2496 DBG("[notification-thread] Closing client connection (socket fd = %i)",
2497 client_socket);
2498 client = get_client_from_socket(client_socket, state);
2499 if (!client) {
2500 /* Internal state corruption, fatal error. */
2501 ERR("[notification-thread] Unable to find client (socket fd = %i)",
2502 client_socket);
2503 ret = -1;
2504 goto end;
2505 }
2506
2507 ret = lttng_poll_del(&state->events, client_socket);
2508 if (ret) {
2509 ERR("[notification-thread] Failed to remove client socket from poll set");
2510 }
2511 cds_lfht_del(state->client_socket_ht,
2512 &client->client_socket_ht_node);
2513 notification_client_destroy(client, state);
2514 end:
2515 rcu_read_unlock();
2516 return ret;
2517 }
2518
2519 int handle_notification_thread_client_disconnect_all(
2520 struct notification_thread_state *state)
2521 {
2522 struct cds_lfht_iter iter;
2523 struct notification_client *client;
2524 bool error_encoutered = false;
2525
2526 rcu_read_lock();
2527 DBG("[notification-thread] Closing all client connections");
2528 cds_lfht_for_each_entry(state->client_socket_ht, &iter, client,
2529 client_socket_ht_node) {
2530 int ret;
2531
2532 ret = handle_notification_thread_client_disconnect(
2533 client->socket, state);
2534 if (ret) {
2535 error_encoutered = true;
2536 }
2537 }
2538 rcu_read_unlock();
2539 return error_encoutered ? 1 : 0;
2540 }
2541
2542 int handle_notification_thread_trigger_unregister_all(
2543 struct notification_thread_state *state)
2544 {
2545 bool error_occurred = false;
2546 struct cds_lfht_iter iter;
2547 struct lttng_trigger_ht_element *trigger_ht_element;
2548
2549 rcu_read_lock();
2550 cds_lfht_for_each_entry(state->triggers_ht, &iter, trigger_ht_element,
2551 node) {
2552 int ret = handle_notification_thread_command_unregister_trigger(
2553 state, trigger_ht_element->trigger, NULL);
2554 if (ret) {
2555 error_occurred = true;
2556 }
2557 }
2558 rcu_read_unlock();
2559 return error_occurred ? -1 : 0;
2560 }
2561
2562 static
2563 int client_flush_outgoing_queue(struct notification_client *client,
2564 struct notification_thread_state *state)
2565 {
2566 ssize_t ret;
2567 size_t to_send_count;
2568
2569 assert(client->communication.outbound.buffer.size != 0);
2570 to_send_count = client->communication.outbound.buffer.size;
2571 DBG("[notification-thread] Flushing client (socket fd = %i) outgoing queue",
2572 client->socket);
2573
2574 ret = lttcomm_send_unix_sock_non_block(client->socket,
2575 client->communication.outbound.buffer.data,
2576 to_send_count);
2577 if ((ret >= 0 && ret < to_send_count)) {
2578 DBG("[notification-thread] Client (socket fd = %i) outgoing queue could not be completely flushed",
2579 client->socket);
2580 to_send_count -= max(ret, 0);
2581
2582 memmove(client->communication.outbound.buffer.data,
2583 client->communication.outbound.buffer.data +
2584 client->communication.outbound.buffer.size - to_send_count,
2585 to_send_count);
2586 ret = lttng_dynamic_buffer_set_size(
2587 &client->communication.outbound.buffer,
2588 to_send_count);
2589 if (ret) {
2590 goto error;
2591 }
2592
2593 /*
2594 * We want to be notified whenever there is buffer space
2595 * available to send the rest of the payload.
2596 */
2597 ret = lttng_poll_mod(&state->events, client->socket,
2598 CLIENT_POLL_MASK_IN_OUT);
2599 if (ret) {
2600 goto error;
2601 }
2602 } else if (ret < 0) {
2603 /* Generic error, disconnect the client. */
2604 ERR("[notification-thread] Failed to send flush outgoing queue, disconnecting client (socket fd = %i)",
2605 client->socket);
2606 ret = handle_notification_thread_client_disconnect(
2607 client->socket, state);
2608 if (ret) {
2609 goto error;
2610 }
2611 } else {
2612 /* No error and flushed the queue completely. */
2613 ret = lttng_dynamic_buffer_set_size(
2614 &client->communication.outbound.buffer, 0);
2615 if (ret) {
2616 goto error;
2617 }
2618 ret = lttng_poll_mod(&state->events, client->socket,
2619 CLIENT_POLL_MASK_IN);
2620 if (ret) {
2621 goto error;
2622 }
2623
2624 client->communication.outbound.queued_command_reply = false;
2625 client->communication.outbound.dropped_notification = false;
2626 }
2627
2628 return 0;
2629 error:
2630 return -1;
2631 }
2632
2633 static
2634 int client_send_command_reply(struct notification_client *client,
2635 struct notification_thread_state *state,
2636 enum lttng_notification_channel_status status)
2637 {
2638 int ret;
2639 struct lttng_notification_channel_command_reply reply = {
2640 .status = (int8_t) status,
2641 };
2642 struct lttng_notification_channel_message msg = {
2643 .type = (int8_t) LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_COMMAND_REPLY,
2644 .size = sizeof(reply),
2645 };
2646 char buffer[sizeof(msg) + sizeof(reply)];
2647
2648 if (client->communication.outbound.queued_command_reply) {
2649 /* Protocol error. */
2650 goto error;
2651 }
2652
2653 memcpy(buffer, &msg, sizeof(msg));
2654 memcpy(buffer + sizeof(msg), &reply, sizeof(reply));
2655 DBG("[notification-thread] Send command reply (%i)", (int) status);
2656
2657 /* Enqueue buffer to outgoing queue and flush it. */
2658 ret = lttng_dynamic_buffer_append(
2659 &client->communication.outbound.buffer,
2660 buffer, sizeof(buffer));
2661 if (ret) {
2662 goto error;
2663 }
2664
2665 ret = client_flush_outgoing_queue(client, state);
2666 if (ret) {
2667 goto error;
2668 }
2669
2670 if (client->communication.outbound.buffer.size != 0) {
2671 /* Queue could not be emptied. */
2672 client->communication.outbound.queued_command_reply = true;
2673 }
2674
2675 return 0;
2676 error:
2677 return -1;
2678 }
2679
2680 static
2681 int client_dispatch_message(struct notification_client *client,
2682 struct notification_thread_state *state)
2683 {
2684 int ret = 0;
2685
2686 if (client->communication.inbound.msg_type !=
2687 LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_HANDSHAKE &&
2688 client->communication.inbound.msg_type !=
2689 LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_UNKNOWN &&
2690 !client->validated) {
2691 WARN("[notification-thread] client attempted a command before handshake");
2692 ret = -1;
2693 goto end;
2694 }
2695
2696 switch (client->communication.inbound.msg_type) {
2697 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_UNKNOWN:
2698 {
2699 /*
2700 * Receiving message header. The function will be called again
2701 * once the rest of the message as been received and can be
2702 * interpreted.
2703 */
2704 const struct lttng_notification_channel_message *msg;
2705
2706 assert(sizeof(*msg) ==
2707 client->communication.inbound.buffer.size);
2708 msg = (const struct lttng_notification_channel_message *)
2709 client->communication.inbound.buffer.data;
2710
2711 if (msg->size == 0 || msg->size > DEFAULT_MAX_NOTIFICATION_CLIENT_MESSAGE_PAYLOAD_SIZE) {
2712 ERR("[notification-thread] Invalid notification channel message: length = %u", msg->size);
2713 ret = -1;
2714 goto end;
2715 }
2716
2717 switch (msg->type) {
2718 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_SUBSCRIBE:
2719 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_UNSUBSCRIBE:
2720 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_HANDSHAKE:
2721 break;
2722 default:
2723 ret = -1;
2724 ERR("[notification-thread] Invalid notification channel message: unexpected message type");
2725 goto end;
2726 }
2727
2728 client->communication.inbound.bytes_to_receive = msg->size;
2729 client->communication.inbound.msg_type =
2730 (enum lttng_notification_channel_message_type) msg->type;
2731 ret = lttng_dynamic_buffer_set_size(
2732 &client->communication.inbound.buffer, msg->size);
2733 if (ret) {
2734 goto end;
2735 }
2736 break;
2737 }
2738 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_HANDSHAKE:
2739 {
2740 struct lttng_notification_channel_command_handshake *handshake_client;
2741 struct lttng_notification_channel_command_handshake handshake_reply = {
2742 .major = LTTNG_NOTIFICATION_CHANNEL_VERSION_MAJOR,
2743 .minor = LTTNG_NOTIFICATION_CHANNEL_VERSION_MINOR,
2744 };
2745 struct lttng_notification_channel_message msg_header = {
2746 .type = LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_HANDSHAKE,
2747 .size = sizeof(handshake_reply),
2748 };
2749 enum lttng_notification_channel_status status =
2750 LTTNG_NOTIFICATION_CHANNEL_STATUS_OK;
2751 char send_buffer[sizeof(msg_header) + sizeof(handshake_reply)];
2752
2753 memcpy(send_buffer, &msg_header, sizeof(msg_header));
2754 memcpy(send_buffer + sizeof(msg_header), &handshake_reply,
2755 sizeof(handshake_reply));
2756
2757 handshake_client =
2758 (struct lttng_notification_channel_command_handshake *)
2759 client->communication.inbound.buffer.data;
2760 client->major = handshake_client->major;
2761 client->minor = handshake_client->minor;
2762 if (!client->communication.inbound.creds_received) {
2763 ERR("[notification-thread] No credentials received from client");
2764 ret = -1;
2765 goto end;
2766 }
2767
2768 client->uid = LTTNG_SOCK_GET_UID_CRED(
2769 &client->communication.inbound.creds);
2770 client->gid = LTTNG_SOCK_GET_GID_CRED(
2771 &client->communication.inbound.creds);
2772 DBG("[notification-thread] Received handshake from client (uid = %u, gid = %u) with version %i.%i",
2773 client->uid, client->gid, (int) client->major,
2774 (int) client->minor);
2775
2776 if (handshake_client->major != LTTNG_NOTIFICATION_CHANNEL_VERSION_MAJOR) {
2777 status = LTTNG_NOTIFICATION_CHANNEL_STATUS_UNSUPPORTED_VERSION;
2778 }
2779
2780 ret = lttng_dynamic_buffer_append(&client->communication.outbound.buffer,
2781 send_buffer, sizeof(send_buffer));
2782 if (ret) {
2783 ERR("[notification-thread] Failed to send protocol version to notification channel client");
2784 goto end;
2785 }
2786
2787 ret = client_flush_outgoing_queue(client, state);
2788 if (ret) {
2789 goto end;
2790 }
2791
2792 ret = client_send_command_reply(client, state, status);
2793 if (ret) {
2794 ERR("[notification-thread] Failed to send reply to notification channel client");
2795 goto end;
2796 }
2797
2798 /* Set reception state to receive the next message header. */
2799 ret = client_reset_inbound_state(client);
2800 if (ret) {
2801 ERR("[notification-thread] Failed to reset client communication's inbound state");
2802 goto end;
2803 }
2804 client->validated = true;
2805 break;
2806 }
2807 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_SUBSCRIBE:
2808 case LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_UNSUBSCRIBE:
2809 {
2810 struct lttng_condition *condition;
2811 enum lttng_notification_channel_status status =
2812 LTTNG_NOTIFICATION_CHANNEL_STATUS_OK;
2813 const struct lttng_buffer_view condition_view =
2814 lttng_buffer_view_from_dynamic_buffer(
2815 &client->communication.inbound.buffer,
2816 0, -1);
2817 size_t expected_condition_size =
2818 client->communication.inbound.buffer.size;
2819
2820 ret = lttng_condition_create_from_buffer(&condition_view,
2821 &condition);
2822 if (ret != expected_condition_size) {
2823 ERR("[notification-thread] Malformed condition received from client");
2824 goto end;
2825 }
2826
2827 if (client->communication.inbound.msg_type ==
2828 LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_SUBSCRIBE) {
2829 ret = notification_thread_client_subscribe(client,
2830 condition, state, &status);
2831 } else {
2832 ret = notification_thread_client_unsubscribe(client,
2833 condition, state, &status);
2834 }
2835 if (ret) {
2836 goto end;
2837 }
2838
2839 ret = client_send_command_reply(client, state, status);
2840 if (ret) {
2841 ERR("[notification-thread] Failed to send reply to notification channel client");
2842 goto end;
2843 }
2844
2845 /* Set reception state to receive the next message header. */
2846 ret = client_reset_inbound_state(client);
2847 if (ret) {
2848 ERR("[notification-thread] Failed to reset client communication's inbound state");
2849 goto end;
2850 }
2851 break;
2852 }
2853 default:
2854 abort();
2855 }
2856 end:
2857 return ret;
2858 }
2859
2860 /* Incoming data from client. */
2861 int handle_notification_thread_client_in(
2862 struct notification_thread_state *state, int socket)
2863 {
2864 int ret = 0;
2865 struct notification_client *client;
2866 ssize_t recv_ret;
2867 size_t offset;
2868
2869 client = get_client_from_socket(socket, state);
2870 if (!client) {
2871 /* Internal error, abort. */
2872 ret = -1;
2873 goto end;
2874 }
2875
2876 offset = client->communication.inbound.buffer.size -
2877 client->communication.inbound.bytes_to_receive;
2878 if (client->communication.inbound.expect_creds) {
2879 recv_ret = lttcomm_recv_creds_unix_sock(socket,
2880 client->communication.inbound.buffer.data + offset,
2881 client->communication.inbound.bytes_to_receive,
2882 &client->communication.inbound.creds);
2883 if (recv_ret > 0) {
2884 client->communication.inbound.expect_creds = false;
2885 client->communication.inbound.creds_received = true;
2886 }
2887 } else {
2888 recv_ret = lttcomm_recv_unix_sock_non_block(socket,
2889 client->communication.inbound.buffer.data + offset,
2890 client->communication.inbound.bytes_to_receive);
2891 }
2892 if (recv_ret < 0) {
2893 goto error_disconnect_client;
2894 }
2895
2896 client->communication.inbound.bytes_to_receive -= recv_ret;
2897 if (client->communication.inbound.bytes_to_receive == 0) {
2898 ret = client_dispatch_message(client, state);
2899 if (ret) {
2900 /*
2901 * Only returns an error if this client must be
2902 * disconnected.
2903 */
2904 goto error_disconnect_client;
2905 }
2906 } else {
2907 goto end;
2908 }
2909 end:
2910 return ret;
2911 error_disconnect_client:
2912 ret = handle_notification_thread_client_disconnect(socket, state);
2913 return ret;
2914 }
2915
2916 /* Client ready to receive outgoing data. */
2917 int handle_notification_thread_client_out(
2918 struct notification_thread_state *state, int socket)
2919 {
2920 int ret;
2921 struct notification_client *client;
2922
2923 client = get_client_from_socket(socket, state);
2924 if (!client) {
2925 /* Internal error, abort. */
2926 ret = -1;
2927 goto end;
2928 }
2929
2930 ret = client_flush_outgoing_queue(client, state);
2931 if (ret) {
2932 goto end;
2933 }
2934 end:
2935 return ret;
2936 }
2937
2938 static
2939 bool evaluate_buffer_usage_condition(const struct lttng_condition *condition,
2940 const struct channel_state_sample *sample,
2941 uint64_t buffer_capacity)
2942 {
2943 bool result = false;
2944 uint64_t threshold;
2945 enum lttng_condition_type condition_type;
2946 const struct lttng_condition_buffer_usage *use_condition = container_of(
2947 condition, struct lttng_condition_buffer_usage,
2948 parent);
2949
2950 if (use_condition->threshold_bytes.set) {
2951 threshold = use_condition->threshold_bytes.value;
2952 } else {
2953 /*
2954 * Threshold was expressed as a ratio.
2955 *
2956 * TODO the threshold (in bytes) of conditions expressed
2957 * as a ratio of total buffer size could be cached to
2958 * forego this double-multiplication or it could be performed
2959 * as fixed-point math.
2960 *
2961 * Note that caching should accomodate the case where the
2962 * condition applies to multiple channels (i.e. don't assume
2963 * that all channels matching my_chann* have the same size...)
2964 */
2965 threshold = (uint64_t) (use_condition->threshold_ratio.value *
2966 (double) buffer_capacity);
2967 }
2968
2969 condition_type = lttng_condition_get_type(condition);
2970 if (condition_type == LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW) {
2971 DBG("[notification-thread] Low buffer usage condition being evaluated: threshold = %" PRIu64 ", highest usage = %" PRIu64,
2972 threshold, sample->highest_usage);
2973
2974 /*
2975 * The low condition should only be triggered once _all_ of the
2976 * streams in a channel have gone below the "low" threshold.
2977 */
2978 if (sample->highest_usage <= threshold) {
2979 result = true;
2980 }
2981 } else {
2982 DBG("[notification-thread] High buffer usage condition being evaluated: threshold = %" PRIu64 ", highest usage = %" PRIu64,
2983 threshold, sample->highest_usage);
2984
2985 /*
2986 * For high buffer usage scenarios, we want to trigger whenever
2987 * _any_ of the streams has reached the "high" threshold.
2988 */
2989 if (sample->highest_usage >= threshold) {
2990 result = true;
2991 }
2992 }
2993
2994 return result;
2995 }
2996
2997 static
2998 bool evaluate_session_consumed_size_condition(
2999 const struct lttng_condition *condition,
3000 uint64_t session_consumed_size)
3001 {
3002 uint64_t threshold;
3003 const struct lttng_condition_session_consumed_size *size_condition =
3004 container_of(condition,
3005 struct lttng_condition_session_consumed_size,
3006 parent);
3007
3008 threshold = size_condition->consumed_threshold_bytes.value;
3009 DBG("[notification-thread] Session consumed size condition being evaluated: threshold = %" PRIu64 ", current size = %" PRIu64,
3010 threshold, session_consumed_size);
3011 return session_consumed_size >= threshold;
3012 }
3013
3014 static
3015 int evaluate_buffer_condition(const struct lttng_condition *condition,
3016 struct lttng_evaluation **evaluation,
3017 const struct notification_thread_state *state,
3018 const struct channel_state_sample *previous_sample,
3019 const struct channel_state_sample *latest_sample,
3020 uint64_t previous_session_consumed_total,
3021 uint64_t latest_session_consumed_total,
3022 struct channel_info *channel_info)
3023 {
3024 int ret = 0;
3025 enum lttng_condition_type condition_type;
3026 const bool previous_sample_available = !!previous_sample;
3027 bool previous_sample_result = false;
3028 bool latest_sample_result;
3029
3030 condition_type = lttng_condition_get_type(condition);
3031
3032 switch (condition_type) {
3033 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW:
3034 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH:
3035 if (caa_likely(previous_sample_available)) {
3036 previous_sample_result =
3037 evaluate_buffer_usage_condition(condition,
3038 previous_sample, channel_info->capacity);
3039 }
3040 latest_sample_result = evaluate_buffer_usage_condition(
3041 condition, latest_sample,
3042 channel_info->capacity);
3043 break;
3044 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE:
3045 if (caa_likely(previous_sample_available)) {
3046 previous_sample_result =
3047 evaluate_session_consumed_size_condition(
3048 condition,
3049 previous_session_consumed_total);
3050 }
3051 latest_sample_result =
3052 evaluate_session_consumed_size_condition(
3053 condition,
3054 latest_session_consumed_total);
3055 break;
3056 default:
3057 /* Unknown condition type; internal error. */
3058 abort();
3059 }
3060
3061 if (!latest_sample_result ||
3062 (previous_sample_result == latest_sample_result)) {
3063 /*
3064 * Only trigger on a condition evaluation transition.
3065 *
3066 * NOTE: This edge-triggered logic may not be appropriate for
3067 * future condition types.
3068 */
3069 goto end;
3070 }
3071
3072 if (!evaluation || !latest_sample_result) {
3073 goto end;
3074 }
3075
3076 switch (condition_type) {
3077 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_LOW:
3078 case LTTNG_CONDITION_TYPE_BUFFER_USAGE_HIGH:
3079 *evaluation = lttng_evaluation_buffer_usage_create(
3080 condition_type,
3081 latest_sample->highest_usage,
3082 channel_info->capacity);
3083 break;
3084 case LTTNG_CONDITION_TYPE_SESSION_CONSUMED_SIZE:
3085 *evaluation = lttng_evaluation_session_consumed_size_create(
3086 latest_session_consumed_total);
3087 break;
3088 default:
3089 abort();
3090 }
3091
3092 if (!*evaluation) {
3093 ret = -1;
3094 goto end;
3095 }
3096 end:
3097 return ret;
3098 }
3099
3100 static
3101 int client_enqueue_dropped_notification(struct notification_client *client,
3102 struct notification_thread_state *state)
3103 {
3104 int ret;
3105 struct lttng_notification_channel_message msg = {
3106 .type = (int8_t) LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_NOTIFICATION_DROPPED,
3107 .size = 0,
3108 };
3109
3110 ret = lttng_dynamic_buffer_append(
3111 &client->communication.outbound.buffer, &msg,
3112 sizeof(msg));
3113 return ret;
3114 }
3115
3116 static
3117 int send_evaluation_to_clients(const struct lttng_trigger *trigger,
3118 const struct lttng_evaluation *evaluation,
3119 struct notification_client_list* client_list,
3120 struct notification_thread_state *state,
3121 uid_t channel_uid, gid_t channel_gid)
3122 {
3123 int ret = 0;
3124 struct lttng_dynamic_buffer msg_buffer;
3125 struct notification_client_list_element *client_list_element, *tmp;
3126 const struct lttng_notification notification = {
3127 .condition = (struct lttng_condition *) lttng_trigger_get_const_condition(trigger),
3128 .evaluation = (struct lttng_evaluation *) evaluation,
3129 };
3130 struct lttng_notification_channel_message msg_header = {
3131 .type = (int8_t) LTTNG_NOTIFICATION_CHANNEL_MESSAGE_TYPE_NOTIFICATION,
3132 };
3133
3134 lttng_dynamic_buffer_init(&msg_buffer);
3135
3136 ret = lttng_dynamic_buffer_append(&msg_buffer, &msg_header,
3137 sizeof(msg_header));
3138 if (ret) {
3139 goto end;
3140 }
3141
3142 ret = lttng_notification_serialize(&notification, &msg_buffer);
3143 if (ret) {
3144 ERR("[notification-thread] Failed to serialize notification");
3145 ret = -1;
3146 goto end;
3147 }
3148
3149 /* Update payload size. */
3150 ((struct lttng_notification_channel_message * ) msg_buffer.data)->size =
3151 (uint32_t) (msg_buffer.size - sizeof(msg_header));
3152
3153 cds_list_for_each_entry_safe(client_list_element, tmp,
3154 &client_list->list, node) {
3155 struct notification_client *client =
3156 client_list_element->client;
3157
3158 if (client->uid != channel_uid && client->gid != channel_gid &&
3159 client->uid != 0) {
3160 /* Client is not allowed to monitor this channel. */
3161 DBG("[notification-thread] Skipping client at it does not have the permission to receive notification for this channel");
3162 continue;
3163 }
3164
3165 DBG("[notification-thread] Sending notification to client (fd = %i, %zu bytes)",
3166 client->socket, msg_buffer.size);
3167 if (client->communication.outbound.buffer.size) {
3168 /*
3169 * Outgoing data is already buffered for this client;
3170 * drop the notification and enqueue a "dropped
3171 * notification" message if this is the first dropped
3172 * notification since the socket spilled-over to the
3173 * queue.
3174 */
3175 DBG("[notification-thread] Dropping notification addressed to client (socket fd = %i)",
3176 client->socket);
3177 if (!client->communication.outbound.dropped_notification) {
3178 client->communication.outbound.dropped_notification = true;
3179 ret = client_enqueue_dropped_notification(
3180 client, state);
3181 if (ret) {
3182 goto end;
3183 }
3184 }
3185 continue;
3186 }
3187
3188 ret = lttng_dynamic_buffer_append_buffer(
3189 &client->communication.outbound.buffer,
3190 &msg_buffer);
3191 if (ret) {
3192 goto end;
3193 }
3194
3195 ret = client_flush_outgoing_queue(client, state);
3196 if (ret) {
3197 goto end;
3198 }
3199 }
3200 ret = 0;
3201 end:
3202 lttng_dynamic_buffer_reset(&msg_buffer);
3203 return ret;
3204 }
3205
3206 int handle_notification_thread_channel_sample(
3207 struct notification_thread_state *state, int pipe,
3208 enum lttng_domain_type domain)
3209 {
3210 int ret = 0;
3211 struct lttcomm_consumer_channel_monitor_msg sample_msg;
3212 struct channel_info *channel_info;
3213 struct cds_lfht_node *node;
3214 struct cds_lfht_iter iter;
3215 struct lttng_channel_trigger_list *trigger_list;
3216 struct lttng_trigger_list_element *trigger_list_element;
3217 bool previous_sample_available = false;
3218 struct channel_state_sample previous_sample, latest_sample;
3219 uint64_t previous_session_consumed_total, latest_session_consumed_total;
3220
3221 /*
3222 * The monitoring pipe only holds messages smaller than PIPE_BUF,
3223 * ensuring that read/write of sampling messages are atomic.
3224 */
3225 ret = lttng_read(pipe, &sample_msg, sizeof(sample_msg));
3226 if (ret != sizeof(sample_msg)) {
3227 ERR("[notification-thread] Failed to read from monitoring pipe (fd = %i)",
3228 pipe);
3229 ret = -1;
3230 goto end;
3231 }
3232
3233 ret = 0;
3234 latest_sample.key.key = sample_msg.key;
3235 latest_sample.key.domain = domain;
3236 latest_sample.highest_usage = sample_msg.highest;
3237 latest_sample.lowest_usage = sample_msg.lowest;
3238 latest_sample.channel_total_consumed = sample_msg.total_consumed;
3239
3240 rcu_read_lock();
3241
3242 /* Retrieve the channel's informations */
3243 cds_lfht_lookup(state->channels_ht,
3244 hash_channel_key(&latest_sample.key),
3245 match_channel_info,
3246 &latest_sample.key,
3247 &iter);
3248 node = cds_lfht_iter_get_node(&iter);
3249 if (caa_unlikely(!node)) {
3250 /*
3251 * Not an error since the consumer can push a sample to the pipe
3252 * and the rest of the session daemon could notify us of the
3253 * channel's destruction before we get a chance to process that
3254 * sample.
3255 */
3256 DBG("[notification-thread] Received a sample for an unknown channel from consumerd, key = %" PRIu64 " in %s domain",
3257 latest_sample.key.key,
3258 domain == LTTNG_DOMAIN_KERNEL ? "kernel" :
3259 "user space");
3260 goto end_unlock;
3261 }
3262 channel_info = caa_container_of(node, struct channel_info,
3263 channels_ht_node);
3264 DBG("[notification-thread] Handling channel sample for channel %s (key = %" PRIu64 ") in session %s (highest usage = %" PRIu64 ", lowest usage = %" PRIu64", total consumed = %" PRIu64")",
3265 channel_info->name,
3266 latest_sample.key.key,
3267 channel_info->session_info->name,
3268 latest_sample.highest_usage,
3269 latest_sample.lowest_usage,
3270 latest_sample.channel_total_consumed);
3271
3272 previous_session_consumed_total =
3273 channel_info->session_info->consumed_data_size;
3274
3275 /* Retrieve the channel's last sample, if it exists, and update it. */
3276 cds_lfht_lookup(state->channel_state_ht,
3277 hash_channel_key(&latest_sample.key),
3278 match_channel_state_sample,
3279 &latest_sample.key,
3280 &iter);
3281 node = cds_lfht_iter_get_node(&iter);
3282 if (caa_likely(node)) {
3283 struct channel_state_sample *stored_sample;
3284
3285 /* Update the sample stored. */
3286 stored_sample = caa_container_of(node,
3287 struct channel_state_sample,
3288 channel_state_ht_node);
3289
3290 memcpy(&previous_sample, stored_sample,
3291 sizeof(previous_sample));
3292 stored_sample->highest_usage = latest_sample.highest_usage;
3293 stored_sample->lowest_usage = latest_sample.lowest_usage;
3294 stored_sample->channel_total_consumed = latest_sample.channel_total_consumed;
3295 previous_sample_available = true;
3296
3297 latest_session_consumed_total =
3298 previous_session_consumed_total +
3299 (latest_sample.channel_total_consumed - previous_sample.channel_total_consumed);
3300 } else {
3301 /*
3302 * This is the channel's first sample, allocate space for and
3303 * store the new sample.
3304 */
3305 struct channel_state_sample *stored_sample;
3306
3307 stored_sample = zmalloc(sizeof(*stored_sample));
3308 if (!stored_sample) {
3309 ret = -1;
3310 goto end_unlock;
3311 }
3312
3313 memcpy(stored_sample, &latest_sample, sizeof(*stored_sample));
3314 cds_lfht_node_init(&stored_sample->channel_state_ht_node);
3315 cds_lfht_add(state->channel_state_ht,
3316 hash_channel_key(&stored_sample->key),
3317 &stored_sample->channel_state_ht_node);
3318
3319 latest_session_consumed_total =
3320 previous_session_consumed_total +
3321 latest_sample.channel_total_consumed;
3322 }
3323
3324 channel_info->session_info->consumed_data_size =
3325 latest_session_consumed_total;
3326
3327 /* Find triggers associated with this channel. */
3328 cds_lfht_lookup(state->channel_triggers_ht,
3329 hash_channel_key(&latest_sample.key),
3330 match_channel_trigger_list,
3331 &latest_sample.key,
3332 &iter);
3333 node = cds_lfht_iter_get_node(&iter);
3334 if (caa_likely(!node)) {
3335 goto end_unlock;
3336 }
3337
3338 trigger_list = caa_container_of(node, struct lttng_channel_trigger_list,
3339 channel_triggers_ht_node);
3340 cds_list_for_each_entry(trigger_list_element, &trigger_list->list,
3341 node) {
3342 const struct lttng_condition *condition;
3343 const struct lttng_action *action;
3344 const struct lttng_trigger *trigger;
3345 struct notification_client_list *client_list;
3346 struct lttng_evaluation *evaluation = NULL;
3347
3348 trigger = trigger_list_element->trigger;
3349 condition = lttng_trigger_get_const_condition(trigger);
3350 assert(condition);
3351 action = lttng_trigger_get_const_action(trigger);
3352
3353 /* Notify actions are the only type currently supported. */
3354 assert(lttng_action_get_type_const(action) ==
3355 LTTNG_ACTION_TYPE_NOTIFY);
3356
3357 /*
3358 * Check if any client is subscribed to the result of this
3359 * evaluation.
3360 */
3361 client_list = get_client_list_from_condition(state, condition);
3362 assert(client_list);
3363 if (cds_list_empty(&client_list->list)) {
3364 /*
3365 * No clients interested in the evaluation's result,
3366 * skip it.
3367 */
3368 continue;
3369 }
3370
3371 ret = evaluate_buffer_condition(condition, &evaluation, state,
3372 previous_sample_available ? &previous_sample : NULL,
3373 &latest_sample,
3374 previous_session_consumed_total,
3375 latest_session_consumed_total,
3376 channel_info);
3377 if (caa_unlikely(ret)) {
3378 goto end_unlock;
3379 }
3380
3381 if (caa_likely(!evaluation)) {
3382 continue;
3383 }
3384
3385 /* Dispatch evaluation result to all clients. */
3386 ret = send_evaluation_to_clients(trigger_list_element->trigger,
3387 evaluation, client_list, state,
3388 channel_info->session_info->uid,
3389 channel_info->session_info->gid);
3390 lttng_evaluation_destroy(evaluation);
3391 if (caa_unlikely(ret)) {
3392 goto end_unlock;
3393 }
3394 }
3395 end_unlock:
3396 rcu_read_unlock();
3397 end:
3398 return ret;
3399 }
This page took 0.14747 seconds and 4 git commands to generate.