2 * Copyright (C) 2020 Francis Deslauriers <francis.deslauriers@efficios.com>
4 * SPDX-License-Identifier: GPL-2.0-only
12 #include <urcu/compiler.h>
15 #include <common/error.h>
16 #include <common/hashtable/hashtable.h>
17 #include <common/index-allocator.h>
18 #include <common/kernel-ctl/kernel-ctl.h>
19 #include <common/shm.h>
20 #include <lttng/trigger/trigger-internal.h>
22 #include "event-notifier-error-accounting.h"
23 #include "lttng-ust-error.h"
26 #define ERROR_COUNTER_INDEX_HT_INITIAL_SIZE 16
28 struct index_ht_entry
{
29 struct lttng_ht_node_u64 node
;
30 uint64_t error_counter_index
;
31 struct rcu_head rcu_head
;
34 struct ust_error_accounting_entry
{
37 struct lttng_ht_node_u64 node
;
38 struct rcu_head rcu_head
;
39 struct lttng_ust_ctl_daemon_counter
*daemon_counter
;
41 * Those `lttng_ust_abi_object_data` are anonymous handles to the
43 * They are only used to be duplicated for each new applications of the
44 * user. To destroy them, call with the `sock` parameter set to -1.
45 * e.g. `lttng_ust_ctl_release_object(-1, data)`;
47 struct lttng_ust_abi_object_data
*counter
;
48 struct lttng_ust_abi_object_data
**cpu_counters
;
49 int nr_counter_cpu_fds
;
52 struct kernel_error_accounting_entry
{
56 static struct kernel_error_accounting_entry kernel_error_accounting_entry
;
58 /* Hashtable mapping uid to error_account_entry. */
59 static struct lttng_ht
*error_counter_uid_ht
;
61 struct error_accounting_state
{
62 struct lttng_index_allocator
*index_allocator
;
63 /* Hashtable mapping event notifier token to index_ht_entry. */
64 struct lttng_ht
*indices_ht
;
65 uint64_t number_indices
;
68 static struct error_accounting_state ust_state
;
69 static struct error_accounting_state kernel_state
;
71 static inline void get_trigger_info_for_log(const struct lttng_trigger
*trigger
,
72 const char **trigger_name
,
73 uid_t
*trigger_owner_uid
)
75 enum lttng_trigger_status trigger_status
;
77 trigger_status
= lttng_trigger_get_name(trigger
, trigger_name
);
78 switch (trigger_status
) {
79 case LTTNG_TRIGGER_STATUS_OK
:
81 case LTTNG_TRIGGER_STATUS_UNSET
:
82 *trigger_name
= "(anonymous)";
88 trigger_status
= lttng_trigger_get_owner_uid(trigger
,
90 assert(trigger_status
== LTTNG_TRIGGER_STATUS_OK
);
94 const char *error_accounting_status_str(
95 enum event_notifier_error_accounting_status status
)
98 case EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
:
100 case EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_ERR
:
102 case EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_NOT_FOUND
:
104 case EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_NOMEM
:
106 case EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_NO_INDEX_AVAILABLE
:
107 return "NO_INDEX_AVAILABLE";
108 case EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_APP_DEAD
:
115 #ifdef HAVE_LIBLTTNG_UST_CTL
116 struct event_notifier_counter
{
117 pthread_mutex_t lock
;
121 static struct event_notifier_counter the_event_notifier_counter
;
123 static void free_ust_error_accounting_entry(struct rcu_head
*head
)
126 struct ust_error_accounting_entry
*entry
=
127 caa_container_of(head
, typeof(*entry
), rcu_head
);
129 for (i
= 0; i
< entry
->nr_counter_cpu_fds
; i
++) {
130 lttng_ust_ctl_release_object(-1, entry
->cpu_counters
[i
]);
131 free(entry
->cpu_counters
[i
]);
134 free(entry
->cpu_counters
);
136 lttng_ust_ctl_release_object(-1, entry
->counter
);
137 free(entry
->counter
);
139 lttng_ust_ctl_destroy_counter(entry
->daemon_counter
);
145 bool ust_error_accounting_entry_get(struct ust_error_accounting_entry
*entry
)
147 return urcu_ref_get_unless_zero(&entry
->ref
);
151 void ust_error_accounting_entry_release(struct urcu_ref
*entry_ref
)
153 struct ust_error_accounting_entry
*entry
=
154 container_of(entry_ref
, typeof(*entry
), ref
);
157 cds_lfht_del(error_counter_uid_ht
->ht
, &entry
->node
.node
);
158 call_rcu(&entry
->rcu_head
, free_ust_error_accounting_entry
);
164 void ust_error_accounting_entry_put(struct ust_error_accounting_entry
*entry
)
170 urcu_ref_put(&entry
->ref
, ust_error_accounting_entry_release
);
174 * Put one reference to every UID entries.
177 void put_ref_all_ust_error_accounting_entry(void)
179 struct lttng_ht_iter iter
;
180 struct ust_error_accounting_entry
*uid_entry
;
182 ASSERT_LOCKED(the_event_notifier_counter
.lock
);
185 cds_lfht_for_each_entry(error_counter_uid_ht
->ht
, &iter
.iter
,
186 uid_entry
, node
.node
) {
187 ust_error_accounting_entry_put(uid_entry
);
194 * Get one reference to every UID entries.
197 void get_ref_all_ust_error_accounting_entry(void)
199 struct lttng_ht_iter iter
;
200 struct ust_error_accounting_entry
*uid_entry
;
202 ASSERT_LOCKED(the_event_notifier_counter
.lock
);
205 cds_lfht_for_each_entry(error_counter_uid_ht
->ht
, &iter
.iter
,
206 uid_entry
, node
.node
) {
207 ust_error_accounting_entry_get(uid_entry
);
213 #endif /* HAVE_LIBLTTNG_UST_CTL */
216 enum event_notifier_error_accounting_status
217 init_error_accounting_state(struct error_accounting_state
*state
,
218 uint64_t index_count
)
220 enum event_notifier_error_accounting_status status
;
224 state
->number_indices
= index_count
;
226 state
->index_allocator
= lttng_index_allocator_create(index_count
);
227 if (!state
->index_allocator
) {
228 ERR("Failed to allocate event notifier error counter index allocator");
229 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_NOMEM
;
233 state
->indices_ht
= lttng_ht_new(ERROR_COUNTER_INDEX_HT_INITIAL_SIZE
,
235 if (!state
->indices_ht
) {
236 ERR("Failed to allocate error counter indices hash table");
237 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_NOMEM
;
238 goto error_indices_ht
;
241 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
;
245 lttng_index_allocator_destroy(state
->index_allocator
);
246 state
->index_allocator
= NULL
;
252 void fini_error_accounting_state(struct error_accounting_state
*state
)
257 * Will assert if some error counter indices were not released (an
260 lttng_ht_destroy(state
->indices_ht
);
261 lttng_index_allocator_destroy(state
->index_allocator
);
264 enum event_notifier_error_accounting_status
265 event_notifier_error_accounting_init(uint64_t buffer_size_kernel
,
266 uint64_t buffer_size_ust
)
268 enum event_notifier_error_accounting_status status
;
270 status
= init_error_accounting_state(&kernel_state
, buffer_size_kernel
);
271 if (status
!= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
) {
272 ERR("Failed to initialize kernel event notifier accounting state: status = %s",
273 error_accounting_status_str(status
));
277 status
= init_error_accounting_state(&ust_state
, buffer_size_ust
);
278 if (status
!= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
) {
279 ERR("Failed to initialize UST event notifier accounting state: status = %s",
280 error_accounting_status_str(status
));
281 goto error_ust_state
;
284 error_counter_uid_ht
= lttng_ht_new(
285 ERROR_COUNTER_INDEX_HT_INITIAL_SIZE
, LTTNG_HT_TYPE_U64
);
286 if (!error_counter_uid_ht
) {
287 ERR("Failed to allocate UID to error counter accountant hash table");
288 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_NOMEM
;
292 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
;
296 fini_error_accounting_state(&ust_state
);
298 fini_error_accounting_state(&kernel_state
);
304 * Return the error counteur index associated to this event notifier tracer
305 * token. Returns _STATUS_OK if found and _STATUS_NOT_FOUND otherwise.
308 enum event_notifier_error_accounting_status
get_error_counter_index_for_token(
309 struct error_accounting_state
*state
, uint64_t tracer_token
,
310 uint64_t *error_counter_index
)
312 struct lttng_ht_node_u64
*node
;
313 struct lttng_ht_iter iter
;
314 const struct index_ht_entry
*index_entry
;
315 enum event_notifier_error_accounting_status status
;
318 lttng_ht_lookup(state
->indices_ht
, &tracer_token
, &iter
);
319 node
= lttng_ht_iter_get_node_u64(&iter
);
321 index_entry
= caa_container_of(
322 node
, const struct index_ht_entry
, node
);
323 *error_counter_index
= index_entry
->error_counter_index
;
324 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
;
326 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_NOT_FOUND
;
333 #ifdef HAVE_LIBLTTNG_UST_CTL
335 * Find the entry for this app's UID, the caller acquires a reference if the
339 struct ust_error_accounting_entry
*ust_error_accounting_entry_find(
340 struct lttng_ht
*uid_ht
, const struct ust_app
*app
)
342 struct ust_error_accounting_entry
*entry
;
343 struct lttng_ht_node_u64
*node
;
344 struct lttng_ht_iter iter
;
345 uint64_t key
= app
->uid
;
347 lttng_ht_lookup(uid_ht
, &key
, &iter
);
348 node
= lttng_ht_iter_get_node_u64(&iter
);
354 entry
= caa_container_of(node
,
355 struct ust_error_accounting_entry
, node
);
357 got_ref
= ust_error_accounting_entry_get(entry
);
367 * Create the entry for this app's UID, the caller acquires a reference to the
371 struct ust_error_accounting_entry
*ust_error_accounting_entry_create(
372 struct lttng_ht
*uid_ht
, const struct ust_app
*app
)
374 int i
, ret
, *cpu_counter_fds
= NULL
;
375 struct lttng_ust_ctl_daemon_counter
*daemon_counter
;
376 struct lttng_ust_abi_object_data
*counter
, **cpu_counters
;
377 struct ust_error_accounting_entry
*entry
= NULL
;
378 const struct lttng_ust_ctl_counter_dimension dimension
= {
379 .size
= ust_state
.number_indices
,
380 .has_underflow
= false,
381 .has_overflow
= false,
384 entry
= zmalloc(sizeof(struct ust_error_accounting_entry
));
386 PERROR("Failed to allocate event notifier error acounting entry")
390 urcu_ref_init(&entry
->ref
);
391 entry
->uid
= app
->uid
;
392 entry
->nr_counter_cpu_fds
= lttng_ust_ctl_get_nr_cpu_per_counter();
394 cpu_counter_fds
= zmalloc(entry
->nr_counter_cpu_fds
* sizeof(*cpu_counter_fds
));
395 if (!cpu_counter_fds
) {
396 PERROR("Failed to allocate event notifier error counter file descriptors array: application uid = %d, application name = '%s', pid = %d, allocation size = %zu",
397 (int) app
->uid
, app
->name
, (int) app
->pid
,
398 entry
->nr_counter_cpu_fds
* sizeof(*cpu_counter_fds
));
399 goto error_counter_cpu_fds_alloc
;
402 /* Initialize to an invalid fd value to closes fds in case of error. */
403 for (i
= 0; i
< entry
->nr_counter_cpu_fds
; i
++) {
404 cpu_counter_fds
[i
] = -1;
407 cpu_counters
= zmalloc(entry
->nr_counter_cpu_fds
* sizeof(struct lttng_ust_abi_object_data
*));
409 PERROR("Failed to allocate event notifier error counter lttng_ust_abi_object_data array: application uid = %d, application name = '%s', pid = %d, allocation size = %zu",
410 (int) app
->uid
, app
->name
, (int) app
->pid
,
411 entry
->nr_counter_cpu_fds
* sizeof(struct lttng_ust_abi_object_data
*));
412 goto error_counter_cpus_alloc
;
415 for (i
= 0; i
< entry
->nr_counter_cpu_fds
; i
++) {
416 cpu_counter_fds
[i
] = shm_create_anonymous("event-notifier-error-accounting");
417 if (cpu_counter_fds
[i
] == -1) {
418 ERR("Failed to create event notifier error accounting shared memory for application user: application uid = %d, pid = %d, application name = '%s'",
419 (int) app
->uid
, (int) app
->pid
, app
->name
);
420 goto error_shm_alloc
;
425 * Ownership of the file descriptors transferred to the ustctl object.
427 daemon_counter
= lttng_ust_ctl_create_counter(1, &dimension
, 0, -1,
428 entry
->nr_counter_cpu_fds
, cpu_counter_fds
,
429 LTTNG_UST_CTL_COUNTER_BITNESS_32
,
430 LTTNG_UST_CTL_COUNTER_ARITHMETIC_MODULAR
,
431 LTTNG_UST_CTL_COUNTER_ALLOC_PER_CPU
,
433 if (!daemon_counter
) {
434 goto error_create_daemon_counter
;
437 ret
= lttng_ust_ctl_create_counter_data(daemon_counter
, &counter
);
439 ERR("Failed to create userspace tracer counter data for application user: uid = %d, pid = %d, application name = '%s'",
440 (int) app
->uid
, (int) app
->pid
, app
->name
);
441 goto error_create_counter_data
;
444 for (i
= 0; i
< entry
->nr_counter_cpu_fds
; i
++) {
445 ret
= lttng_ust_ctl_create_counter_cpu_data(daemon_counter
, i
,
448 ERR("Failed to create userspace tracer counter cpu data for application user: uid = %d, pid = %d, application name = '%s'",
449 (int) app
->uid
, (int) app
->pid
,
451 goto error_create_counter_cpu_data
;
455 entry
->daemon_counter
= daemon_counter
;
456 entry
->counter
= counter
;
457 entry
->cpu_counters
= cpu_counters
;
459 lttng_ht_node_init_u64(&entry
->node
, entry
->uid
);
460 lttng_ht_add_unique_u64(error_counter_uid_ht
, &entry
->node
);
464 error_create_counter_cpu_data
:
465 /* Teardown any allocated cpu counters. */
466 for (i
= 0; i
< entry
->nr_counter_cpu_fds
; i
++) {
467 if (!cpu_counters
[i
]) {
469 * Early-exit when error occurred before all cpu
470 * counters could be initialized.
475 lttng_ust_ctl_release_object(-1, cpu_counters
[i
]);
476 free(cpu_counters
[i
]);
479 lttng_ust_ctl_release_object(-1, entry
->counter
);
480 free(entry
->counter
);
481 error_create_counter_data
:
482 lttng_ust_ctl_destroy_counter(daemon_counter
);
483 error_create_daemon_counter
:
485 /* Error occured before per-cpu SHMs were handed-off to ustctl. */
486 if (cpu_counter_fds
) {
487 for (i
= 0; i
< entry
->nr_counter_cpu_fds
; i
++) {
488 if (cpu_counter_fds
[i
] < 0) {
490 * Early-exit when error occurred before all cpu
491 * counter shm fds could be initialized.
496 ret
= close(cpu_counter_fds
[i
]);
498 PERROR("Failed to close error counter per-CPU shm file descriptor: fd = %d",
505 error_counter_cpus_alloc
:
506 error_counter_cpu_fds_alloc
:
511 free(cpu_counter_fds
);
516 enum event_notifier_error_accounting_status
send_counter_data_to_ust(
518 struct lttng_ust_abi_object_data
*new_counter
)
521 enum event_notifier_error_accounting_status status
;
523 /* Attach counter to trigger group. */
524 pthread_mutex_lock(&app
->sock_lock
);
525 ret
= lttng_ust_ctl_send_counter_data_to_ust(app
->sock
,
526 app
->event_notifier_group
.object
->handle
, new_counter
);
527 pthread_mutex_unlock(&app
->sock_lock
);
529 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
530 ERR("Failed to send counter data to application: application name = '%s', pid = %d, ret = %d",
531 app
->name
, app
->pid
, ret
);
532 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_ERR
;
534 DBG3("Failed to send counter data to application (application is dead): application name = '%s', pid = %d, ret = %d",
535 app
->name
, app
->pid
, ret
);
536 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_APP_DEAD
;
542 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
;
548 enum event_notifier_error_accounting_status
send_counter_cpu_data_to_ust(
550 struct lttng_ust_abi_object_data
*counter
,
551 struct lttng_ust_abi_object_data
*counter_cpu
)
554 enum event_notifier_error_accounting_status status
;
556 pthread_mutex_lock(&app
->sock_lock
);
557 ret
= lttng_ust_ctl_send_counter_cpu_data_to_ust(app
->sock
,
558 counter
, counter_cpu
);
559 pthread_mutex_unlock(&app
->sock_lock
);
561 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
562 ERR("Failed to send counter CPU data to application: application name = '%s', pid = %d, ret = %d",
563 app
->name
, app
->pid
, ret
);
564 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_ERR
;
566 DBG3("Failed to send counter CPU data to application: application name = '%s', pid = %d, ret = %d",
567 app
->name
, app
->pid
, ret
);
568 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_APP_DEAD
;
574 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
;
579 enum event_notifier_error_accounting_status
580 event_notifier_error_accounting_register_app(struct ust_app
*app
)
584 struct lttng_ust_abi_object_data
*new_counter
;
585 struct ust_error_accounting_entry
*entry
;
586 enum event_notifier_error_accounting_status status
;
587 struct lttng_ust_abi_object_data
**cpu_counters
;
590 * Check if we already have a error counter for the user id of this
591 * app. If not, create one.
594 entry
= ust_error_accounting_entry_find(error_counter_uid_ht
, app
);
597 * Take the event notifier counter lock before creating the new
598 * entry to ensure that no event notifier is registered between
599 * the the entry creation and event notifier count check.
601 pthread_mutex_lock(&the_event_notifier_counter
.lock
);
603 entry
= ust_error_accounting_entry_create(error_counter_uid_ht
,
606 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_ERR
;
607 pthread_mutex_unlock(&the_event_notifier_counter
.lock
);
608 goto error_creating_entry
;
612 * We just created a new UID entry, If there are event
613 * notifiers already registered, take one reference on their
616 if (the_event_notifier_counter
.count
> 0) {
617 ust_error_accounting_entry_get(entry
);
620 pthread_mutex_unlock(&the_event_notifier_counter
.lock
);
623 /* Duplicate counter object data. */
624 ret
= lttng_ust_ctl_duplicate_ust_object_data(&new_counter
,
627 ERR("Failed to duplicate event notifier error accounting counter for application user: application uid = %d, pid = %d, application name = '%s'",
628 (int) app
->uid
, (int) app
->pid
, app
->name
);
629 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_ERR
;
630 goto error_duplicate_counter
;
633 status
= send_counter_data_to_ust(app
, new_counter
);
634 if (status
!= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
) {
635 if (status
== EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_APP_DEAD
) {
636 goto error_send_counter_data
;
639 ERR("Failed to send counter data to application tracer: status = %s, application uid = %d, pid = %d, application name = '%s'",
640 error_accounting_status_str(status
),
641 (int) app
->uid
, (int) app
->pid
, app
->name
);
642 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_ERR
;
643 goto error_send_counter_data
;
646 cpu_counters
= zmalloc(entry
->nr_counter_cpu_fds
* sizeof(struct lttng_ust_abi_object_data
*));
648 PERROR("Failed to allocate event notifier error counter lttng_ust_abi_object_data array: application uid = %d, application name = '%s', pid = %d, allocation size = %zu",
649 (int) app
->uid
, app
->name
, (int) app
->pid
,
650 entry
->nr_counter_cpu_fds
* sizeof(**cpu_counters
));
651 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_NOMEM
;
652 goto error_allocate_cpu_counters
;
655 for (i
= 0; i
< entry
->nr_counter_cpu_fds
; i
++) {
656 struct lttng_ust_abi_object_data
*new_counter_cpu
= NULL
;
658 ret
= lttng_ust_ctl_duplicate_ust_object_data(&new_counter_cpu
,
659 entry
->cpu_counters
[i
]);
661 ERR("Failed to duplicate userspace tracer counter cpu data for application user: uid = %d, pid = %d, application name = '%s'",
662 (int) app
->uid
, (int) app
->pid
,
664 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_NOMEM
;
665 goto error_duplicate_cpu_counter
;
668 cpu_counters
[i
] = new_counter_cpu
;
670 status
= send_counter_cpu_data_to_ust(app
, new_counter
,
672 if (status
!= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
) {
673 if (status
== EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_APP_DEAD
) {
674 goto error_send_cpu_counter_data
;
677 ERR("Failed to send counter cpu data to application tracer: status = %s, application uid = %d, pid = %d, application name = '%s'",
678 error_accounting_status_str(status
),
679 (int) app
->uid
, (int) app
->pid
,
681 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_ERR
;
682 goto error_send_cpu_counter_data
;
686 app
->event_notifier_group
.counter
= new_counter
;
688 app
->event_notifier_group
.nr_counter_cpu
= entry
->nr_counter_cpu_fds
;
689 app
->event_notifier_group
.counter_cpu
= cpu_counters
;
693 error_send_cpu_counter_data
:
694 error_duplicate_cpu_counter
:
695 /* Teardown any duplicated cpu counters. */
696 for (i
= 0; i
< entry
->nr_counter_cpu_fds
; i
++) {
697 if (!cpu_counters
[i
]) {
699 * Early-exit when error occurred before all cpu
700 * counters could be initialized.
705 lttng_ust_ctl_release_object(-1, cpu_counters
[i
]);
706 free(cpu_counters
[i
]);
711 error_allocate_cpu_counters
:
712 error_send_counter_data
:
713 lttng_ust_ctl_release_object(-1, new_counter
);
715 error_duplicate_counter
:
716 ust_error_accounting_entry_put(entry
);
717 error_creating_entry
:
718 app
->event_notifier_group
.counter
= NULL
;
724 enum event_notifier_error_accounting_status
725 event_notifier_error_accounting_unregister_app(struct ust_app
*app
)
727 enum event_notifier_error_accounting_status status
;
728 struct ust_error_accounting_entry
*entry
;
733 /* If an error occurred during app registration no entry was created. */
734 if (!app
->event_notifier_group
.counter
) {
735 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
;
739 entry
= ust_error_accounting_entry_find(error_counter_uid_ht
, app
);
741 ERR("Failed to find event notitifier error accounting entry on application teardown: pid = %d, application name = '%s'",
742 app
->pid
, app
->name
);
743 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_ERR
;
747 * Put the entry twice as we acquired a reference from the
748 * `ust_error_accounting_entry_find()` above.
750 ust_error_accounting_entry_put(entry
);
751 ust_error_accounting_entry_put(entry
);
754 for (i
= 0; i
< app
->event_notifier_group
.nr_counter_cpu
; i
++) {
755 lttng_ust_ctl_release_object(app
->sock
,
756 app
->event_notifier_group
.counter_cpu
[i
]);
757 free(app
->event_notifier_group
.counter_cpu
[i
]);
760 free(app
->event_notifier_group
.counter_cpu
);
762 lttng_ust_ctl_release_object(app
->sock
, app
->event_notifier_group
.counter
);
763 free(app
->event_notifier_group
.counter
);
765 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
;
772 enum event_notifier_error_accounting_status
773 event_notifier_error_accounting_ust_get_count(
774 const struct lttng_trigger
*trigger
, uint64_t *count
)
776 struct lttng_ht_iter iter
;
777 struct ust_error_accounting_entry
*uid_entry
;
778 uint64_t error_counter_index
, global_sum
= 0;
779 enum event_notifier_error_accounting_status status
;
780 size_t dimension_indexes
[1];
781 const uint64_t tracer_token
= lttng_trigger_get_tracer_token(trigger
);
782 uid_t trigger_owner_uid
;
783 const char *trigger_name
;
788 get_trigger_info_for_log(trigger
, &trigger_name
, &trigger_owner_uid
);
790 status
= get_error_counter_index_for_token(&ust_state
, tracer_token
,
791 &error_counter_index
);
792 if (status
!= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
) {
794 ERR("Failed to retrieve index for tracer token: token = %" PRIu64
", trigger name = '%s', trigger owner uid = %d, status = %s",
795 tracer_token
, trigger_name
,
796 (int) trigger_owner_uid
,
797 error_accounting_status_str(status
));
801 dimension_indexes
[0] = error_counter_index
;
804 * Iterate over all the UID entries.
805 * We aggregate the value of all uid entries regardless of if the uid
806 * matches the trigger's uid because a user that is allowed to register
807 * a trigger to a given sessiond is also allowed to create an event
808 * notifier on all apps that this sessiond is aware of.
810 cds_lfht_for_each_entry(error_counter_uid_ht
->ht
, &iter
.iter
,
811 uid_entry
, node
.node
) {
813 int64_t local_value
= 0;
814 bool overflow
= false, underflow
= false;
816 ret
= lttng_ust_ctl_counter_aggregate(uid_entry
->daemon_counter
,
817 dimension_indexes
, &local_value
, &overflow
,
819 if (ret
|| local_value
< 0) {
821 ERR("Failed to aggregate event notifier error counter values of trigger: trigger name = '%s', trigger owner uid = %d",
823 (int) trigger_owner_uid
);
824 } else if (local_value
< 0) {
825 ERR("Negative event notifier error counter value encountered during aggregation: trigger name = '%s', trigger owner uid = %d, value = %" PRId64
,
827 (int) trigger_owner_uid
,
833 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_ERR
;
837 /* Cast is safe as negative values are checked-for above. */
838 global_sum
+= (uint64_t) local_value
;
842 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
;
850 enum event_notifier_error_accounting_status
event_notifier_error_accounting_ust_clear(
851 const struct lttng_trigger
*trigger
)
853 struct lttng_ht_iter iter
;
854 struct ust_error_accounting_entry
*uid_entry
;
855 uint64_t error_counter_index
;
856 enum event_notifier_error_accounting_status status
;
857 size_t dimension_index
;
858 const uint64_t tracer_token
= lttng_trigger_get_tracer_token(trigger
);
861 status
= get_error_counter_index_for_token(&ust_state
, tracer_token
,
862 &error_counter_index
);
863 if (status
!= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
) {
864 uid_t trigger_owner_uid
;
865 const char *trigger_name
;
867 get_trigger_info_for_log(trigger
, &trigger_name
,
870 ERR("Failed to retrieve index for tracer token: token = %" PRIu64
", trigger name = '%s', trigger owner uid = %d, status = %s",
871 tracer_token
, trigger_name
,
872 (int) trigger_owner_uid
,
873 error_accounting_status_str(status
));
877 dimension_index
= error_counter_index
;
880 * Go over all error counters (ignoring uid) as a trigger (and trigger
881 * errors) can be generated from any applications that this session
882 * daemon is managing.
884 cds_lfht_for_each_entry(error_counter_uid_ht
->ht
, &iter
.iter
,
885 uid_entry
, node
.node
) {
886 const int ret
= lttng_ust_ctl_counter_clear(uid_entry
->daemon_counter
,
890 uid_t trigger_owner_uid
;
891 const char *trigger_name
;
893 get_trigger_info_for_log(trigger
, &trigger_name
,
895 ERR("Failed to clear event notifier counter value for trigger: counter uid = %d, trigger name = '%s', trigger owner uid = %d",
896 (int) uid_entry
->node
.key
, trigger_name
,
897 (int) trigger_owner_uid
);
898 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_ERR
;
903 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
;
908 #endif /* HAVE_LIBLTTNG_UST_CTL */
911 enum event_notifier_error_accounting_status
912 event_notifier_error_accounting_kernel_clear(
913 const struct lttng_trigger
*trigger
)
916 uint64_t error_counter_index
;
917 enum event_notifier_error_accounting_status status
;
918 struct lttng_kernel_counter_clear counter_clear
= {};
920 status
= get_error_counter_index_for_token(&kernel_state
,
921 lttng_trigger_get_tracer_token(trigger
),
922 &error_counter_index
);
923 if (status
!= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
) {
924 uid_t trigger_owner_uid
;
925 const char *trigger_name
;
927 get_trigger_info_for_log(
928 trigger
, &trigger_name
, &trigger_owner_uid
);
930 ERR("Failed to get event notifier error counter index: trigger owner uid = %d, trigger name = '%s', status = '%s'",
931 trigger_owner_uid
, trigger_name
,
932 error_accounting_status_str(status
));
936 counter_clear
.index
.number_dimensions
= 1;
937 counter_clear
.index
.dimension_indexes
[0] = error_counter_index
;
939 ret
= kernctl_counter_clear(
940 kernel_error_accounting_entry
.error_counter_fd
,
943 uid_t trigger_owner_uid
;
944 const char *trigger_name
;
946 get_trigger_info_for_log(
947 trigger
, &trigger_name
, &trigger_owner_uid
);
949 ERR("Failed to clear kernel event notifier error counter: trigger owner uid = %d, trigger name = '%s'",
950 trigger_owner_uid
, trigger_name
);
951 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_ERR
;
955 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
;
960 enum event_notifier_error_accounting_status
961 event_notifier_error_accounting_register_kernel(
962 int kernel_event_notifier_group_fd
)
964 int error_counter_fd
= -1, ret
;
965 enum event_notifier_error_accounting_status status
;
966 const struct lttng_kernel_counter_conf error_counter_conf
= {
967 .arithmetic
= LTTNG_KERNEL_COUNTER_ARITHMETIC_MODULAR
,
968 .bitness
= sizeof(void *) == sizeof(uint32_t) ?
969 LTTNG_KERNEL_COUNTER_BITNESS_32
:
970 LTTNG_KERNEL_COUNTER_BITNESS_64
,
971 .global_sum_step
= 0,
972 .number_dimensions
= 1,
973 .dimensions
[0].size
= kernel_state
.number_indices
,
974 .dimensions
[0].has_underflow
= false,
975 .dimensions
[0].has_overflow
= false,
978 ret
= kernctl_create_event_notifier_group_error_counter(
979 kernel_event_notifier_group_fd
, &error_counter_conf
);
981 PERROR("Failed to create event notifier group error counter through kernel ioctl: kernel_event_notifier_group_fd = %d",
982 kernel_event_notifier_group_fd
);
983 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_ERR
;
987 error_counter_fd
= ret
;
989 /* Prevent fd duplication after execlp(). */
990 ret
= fcntl(error_counter_fd
, F_SETFD
, FD_CLOEXEC
);
992 PERROR("Failed to set FD_CLOEXEC flag on event notifier error counter file descriptor: error_counter_fd = %d",
994 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_ERR
;
998 DBG("Created kernel event notifier group error counter: fd = %d",
1001 kernel_error_accounting_entry
.error_counter_fd
=
1003 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
;
1010 enum event_notifier_error_accounting_status
create_error_counter_index_for_token(
1011 struct error_accounting_state
*state
, uint64_t tracer_token
,
1012 uint64_t *error_counter_index
)
1014 struct index_ht_entry
*index_entry
;
1015 enum lttng_index_allocator_status index_alloc_status
;
1016 uint64_t local_error_counter_index
;
1017 enum event_notifier_error_accounting_status status
;
1021 /* Allocate a new index for that counter. */
1022 index_alloc_status
= lttng_index_allocator_alloc(state
->index_allocator
,
1023 &local_error_counter_index
);
1024 switch (index_alloc_status
) {
1025 case LTTNG_INDEX_ALLOCATOR_STATUS_EMPTY
:
1026 DBG("No indices left in the configured event notifier error counter: "
1027 "number-of-indices = %"PRIu64
,
1028 lttng_index_allocator_get_index_count(
1029 state
->index_allocator
));
1030 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_NO_INDEX_AVAILABLE
;
1032 case LTTNG_INDEX_ALLOCATOR_STATUS_OK
:
1035 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_ERR
;
1039 index_entry
= zmalloc(sizeof(*index_entry
));
1040 if (index_entry
== NULL
) {
1041 PERROR("Failed to allocate event notifier error counter hash table entry");
1042 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_NOMEM
;
1046 index_entry
->error_counter_index
= local_error_counter_index
;
1047 lttng_ht_node_init_u64(&index_entry
->node
, tracer_token
);
1048 lttng_ht_add_unique_u64(state
->indices_ht
, &index_entry
->node
);
1050 DBG("Allocated error counter index for tracer token: tracer token = %" PRIu64
", index = %" PRIu64
,
1051 tracer_token
, local_error_counter_index
);
1052 *error_counter_index
= local_error_counter_index
;
1053 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
;
1058 enum event_notifier_error_accounting_status
1059 event_notifier_error_accounting_register_event_notifier(
1060 const struct lttng_trigger
*trigger
,
1061 uint64_t *error_counter_index
)
1063 enum event_notifier_error_accounting_status status
;
1064 uint64_t local_error_counter_index
;
1065 struct error_accounting_state
*state
;
1067 switch (lttng_trigger_get_underlying_domain_type_restriction(trigger
)) {
1068 case LTTNG_DOMAIN_KERNEL
:
1069 state
= &kernel_state
;
1071 case LTTNG_DOMAIN_UST
:
1079 * Check if this event notifier already has a error counter index
1082 status
= get_error_counter_index_for_token(state
,
1083 lttng_trigger_get_tracer_token(trigger
),
1084 &local_error_counter_index
);
1086 case EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_NOT_FOUND
:
1088 uid_t trigger_owner_uid
;
1089 const char *trigger_name
;
1091 get_trigger_info_for_log(
1092 trigger
, &trigger_name
, &trigger_owner_uid
);
1094 DBG("Event notifier error counter index not found for tracer token (allocating a new one): trigger name = '%s', trigger owner uid = %d, tracer token = %" PRIu64
,
1095 trigger_name
, trigger_owner_uid
,
1096 lttng_trigger_get_tracer_token(trigger
));
1098 status
= create_error_counter_index_for_token(state
,
1099 lttng_trigger_get_tracer_token(trigger
),
1100 &local_error_counter_index
);
1101 if (status
!= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
) {
1102 ERR("Error creating index for token: status = %s, trigger name = '%s', trigger owner uid = %d",
1103 error_accounting_status_str(status
),
1104 trigger_name
, trigger_owner_uid
);
1109 case EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
:
1110 *error_counter_index
= local_error_counter_index
;
1111 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
;
1117 #ifdef HAVE_LIBLTTNG_UST_CTL
1118 switch (lttng_trigger_get_underlying_domain_type_restriction(trigger
)) {
1119 case LTTNG_DOMAIN_UST
:
1120 pthread_mutex_lock(&the_event_notifier_counter
.lock
);
1121 the_event_notifier_counter
.count
++;
1122 if (the_event_notifier_counter
.count
== 1) {
1124 * On the first event notifier, we get a reference to
1125 * every existing UID entries. This ensures that the
1126 * entries are kept around if there are still
1127 * registered event notifiers but no apps.
1129 get_ref_all_ust_error_accounting_entry();
1131 pthread_mutex_unlock(&the_event_notifier_counter
.lock
);
1136 #endif /* HAVE_LIBLTTNG_UST_CTL */
1144 enum event_notifier_error_accounting_status
1145 event_notifier_error_accounting_kernel_get_count(
1146 const struct lttng_trigger
*trigger
, uint64_t *count
)
1148 struct lttng_kernel_counter_aggregate counter_aggregate
= {};
1149 enum event_notifier_error_accounting_status status
;
1150 uint64_t error_counter_index
;
1153 status
= get_error_counter_index_for_token(&kernel_state
,
1154 lttng_trigger_get_tracer_token(trigger
),
1155 &error_counter_index
);
1156 if (status
!= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
) {
1157 ERR("Error getting index for token: status=%s",
1158 error_accounting_status_str(status
));
1162 counter_aggregate
.index
.number_dimensions
= 1;
1163 counter_aggregate
.index
.dimension_indexes
[0] = error_counter_index
;
1165 assert(kernel_error_accounting_entry
.error_counter_fd
);
1167 ret
= kernctl_counter_get_aggregate_value(
1168 kernel_error_accounting_entry
.error_counter_fd
,
1169 &counter_aggregate
);
1170 if (ret
|| counter_aggregate
.value
.value
< 0) {
1171 uid_t trigger_owner_uid
;
1172 const char *trigger_name
;
1174 get_trigger_info_for_log(trigger
, &trigger_name
,
1175 &trigger_owner_uid
);
1177 if (counter_aggregate
.value
.value
< 0) {
1178 ERR("Invalid negative event notifier error counter value: trigger owner = %d, trigger name = '%s', value = %" PRId64
,
1179 trigger_owner_uid
, trigger_name
,
1180 counter_aggregate
.value
.value
);
1182 ERR("Failed to getting event notifier error count: trigger owner = %d, trigger name = '%s', ret = %d",
1183 trigger_owner_uid
, trigger_name
, ret
);
1186 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_ERR
;
1190 /* Error count can't be negative. */
1191 assert(counter_aggregate
.value
.value
>= 0);
1192 *count
= (uint64_t) counter_aggregate
.value
.value
;
1194 status
= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
;
1200 enum event_notifier_error_accounting_status
1201 event_notifier_error_accounting_get_count(
1202 const struct lttng_trigger
*trigger
, uint64_t *count
)
1204 switch (lttng_trigger_get_underlying_domain_type_restriction(trigger
)) {
1205 case LTTNG_DOMAIN_KERNEL
:
1206 return event_notifier_error_accounting_kernel_get_count(
1208 case LTTNG_DOMAIN_UST
:
1209 #ifdef HAVE_LIBLTTNG_UST_CTL
1210 return event_notifier_error_accounting_ust_get_count(trigger
,
1214 return EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
;
1215 #endif /* HAVE_LIBLTTNG_UST_CTL */
1222 enum event_notifier_error_accounting_status
1223 event_notifier_error_accounting_clear(const struct lttng_trigger
*trigger
)
1225 switch (lttng_trigger_get_underlying_domain_type_restriction(trigger
)) {
1226 case LTTNG_DOMAIN_KERNEL
:
1227 return event_notifier_error_accounting_kernel_clear(trigger
);
1228 case LTTNG_DOMAIN_UST
:
1229 #ifdef HAVE_LIBLTTNG_UST_CTL
1230 return event_notifier_error_accounting_ust_clear(trigger
);
1232 return EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
;
1233 #endif /* HAVE_LIBLTTNG_UST_CTL */
1239 static void free_index_ht_entry(struct rcu_head
*head
)
1241 struct index_ht_entry
*entry
= caa_container_of(head
,
1242 struct index_ht_entry
, rcu_head
);
1247 void event_notifier_error_accounting_unregister_event_notifier(
1248 const struct lttng_trigger
*trigger
)
1250 struct lttng_ht_iter iter
;
1251 struct lttng_ht_node_u64
*node
;
1252 const uint64_t tracer_token
= lttng_trigger_get_tracer_token(trigger
);
1253 enum event_notifier_error_accounting_status status
;
1254 struct error_accounting_state
*state
;
1256 status
= event_notifier_error_accounting_clear(trigger
);
1257 if (status
!= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
) {
1258 /* Trigger details already logged by callee on error. */
1259 ERR("Failed to clear event notifier error counter during unregistration of event notifier: status = '%s'",
1260 error_accounting_status_str(status
));
1266 switch (lttng_trigger_get_underlying_domain_type_restriction(trigger
)) {
1267 case LTTNG_DOMAIN_KERNEL
:
1268 state
= &kernel_state
;
1270 #ifdef HAVE_LIBLTTNG_UST_CTL
1271 case LTTNG_DOMAIN_UST
:
1274 pthread_mutex_lock(&the_event_notifier_counter
.lock
);
1275 the_event_notifier_counter
.count
--;
1276 if (the_event_notifier_counter
.count
== 0) {
1279 * When unregistering the last event notifier, put one
1280 * reference to every uid entries on the behalf of all
1283 put_ref_all_ust_error_accounting_entry();
1286 pthread_mutex_unlock(&the_event_notifier_counter
.lock
);
1289 #endif /* HAVE_LIBLTTNG_UST_CTL */
1294 lttng_ht_lookup(state
->indices_ht
, &tracer_token
, &iter
);
1295 node
= lttng_ht_iter_get_node_u64(&iter
);
1298 struct index_ht_entry
*index_entry
= caa_container_of(
1299 node
, typeof(*index_entry
), node
);
1300 enum lttng_index_allocator_status index_alloc_status
;
1302 index_alloc_status
= lttng_index_allocator_release(
1303 state
->index_allocator
,
1304 index_entry
->error_counter_index
);
1305 if (index_alloc_status
!= LTTNG_INDEX_ALLOCATOR_STATUS_OK
) {
1306 uid_t trigger_owner_uid
;
1307 const char *trigger_name
;
1309 get_trigger_info_for_log(trigger
, &trigger_name
,
1310 &trigger_owner_uid
);
1312 ERR("Failed to release event notifier error counter index: index = %" PRIu64
", trigger name = '%s', trigger owner uid = %d",
1313 index_entry
->error_counter_index
,
1314 trigger_name
, (int) trigger_owner_uid
);
1315 /* Don't exit, perform the rest of the clean-up. */
1318 del_ret
= lttng_ht_del(state
->indices_ht
, &iter
);
1320 call_rcu(&index_entry
->rcu_head
, free_index_ht_entry
);
1327 void event_notifier_error_accounting_fini(void)
1329 if (kernel_error_accounting_entry
.error_counter_fd
) {
1330 const int ret
= close(kernel_error_accounting_entry
.error_counter_fd
);
1333 PERROR("Failed to close kernel event notifier error counter");
1337 lttng_ht_destroy(error_counter_uid_ht
);
1339 fini_error_accounting_state(&kernel_state
);
1340 fini_error_accounting_state(&ust_state
);