src/bin/lttng-sessiond/event-notifier-error-accounting.hpp

   1 /*
   2  * Copyright (C) 2020 Francis Deslauriers <francis.deslauriers@efficios.com>
   3  *
   4  * SPDX-License-Identifier: GPL-2.0-only
   5  *
   6  */
   7
   8 #ifndef _EVENT_NOTIFIER_ERROR_ACCOUNTING_H
   9 #define _EVENT_NOTIFIER_ERROR_ACCOUNTING_H
  10
  11 #include "ust-app.hpp"
  12
  13 #include <lttng/trigger/trigger.h>
  14
  15 #include <stdint.h>
  16
  17 enum event_notifier_error_accounting_status {
  18         EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK,
  19         EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_ERR,
  20         EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_NOT_FOUND,
  21         EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_NOMEM,
  22         EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_NO_INDEX_AVAILABLE,
  23         EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_APP_DEAD,
  24         EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_UNSUPPORTED,
  25 };
  26
  27 /*
  28  * Initialize the event notifier error accounting system.
  29  * `buffer_size_kernel` and `buffer_size_ust` represent the number of buckets
  30  * to be allocated for each domain.
  31  */
  32 enum event_notifier_error_accounting_status
  33 event_notifier_error_accounting_init(uint64_t buffer_size_kernel, uint64_t buffer_size_ust);
  34
  35 /*
  36  * Register the kernel event notifier group.
  37  * This allocates the counter object on the kernel side.
  38  */
  39 enum event_notifier_error_accounting_status
  40 event_notifier_error_accounting_register_kernel(int kernel_event_notifier_group_fd);
  41
  42 #ifdef HAVE_LIBLTTNG_UST_CTL
  43
  44 /*
  45  * Register a UST application.
  46  *
  47  * This reuses (or creates) the counter object of the app UID.
  48  */
  49 enum event_notifier_error_accounting_status
  50 event_notifier_error_accounting_register_app(struct ust_app *app);
  51
  52 /*
  53  * Unregister a UST application.
  54  */
  55 enum event_notifier_error_accounting_status
  56 event_notifier_error_accounting_unregister_app(struct ust_app *app);
  57
  58 #else /* HAVE_LIBLTTNG_UST_CTL */
  59
  60 static inline enum event_notifier_error_accounting_status
  61 event_notifier_error_accounting_register_app(struct ust_app *app __attribute__((unused)))
  62 {
  63         return EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK;
  64 }
  65
  66 static inline enum event_notifier_error_accounting_status
  67 event_notifier_error_accounting_unregister_app(struct ust_app *app __attribute__((unused)))
  68 {
  69         return EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK;
  70 }
  71 #endif /* HAVE_LIBLTTNG_UST_CTL */
  72
  73 /*
  74  * Allocates, reserves and returns the error counter index for that trigger.
  75  */
  76 enum event_notifier_error_accounting_status
  77 event_notifier_error_accounting_register_event_notifier(const struct lttng_trigger *trigger,
  78                                                         uint64_t *error_counter_index);
  79
  80 enum event_notifier_error_accounting_status
  81 event_notifier_error_accounting_get_count(const struct lttng_trigger *trigger, uint64_t *count);
  82
  83 void event_notifier_error_accounting_unregister_event_notifier(const struct lttng_trigger *trigger);
  84
  85 void event_notifier_error_accounting_fini();
  86
  87 #endif /* _EVENT_NOTIFIER_ERROR_ACCOUNTING_H */