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