include/osmocom/core/rate_ctr.h

   1 #ifndef _RATE_CTR_H
   2 #define _RATE_CTR_H
   3
   4 /*! \defgroup rate_ctr Rate counters
   5  *  @{
   6  */
   7
   8 /*! \file rate_ctr.h */
   9
  10 #include <stdint.h>
  11
  12 #include <osmocom/core/linuxlist.h>
  13
  14 /*! \brief Number of rate counter intervals */
  15 #define RATE_CTR_INTV_NUM       4
  16
  17 /*! \brief Rate counter interval */
  18 enum rate_ctr_intv {
  19         RATE_CTR_INTV_SEC,      /*!< \brief last second */
  20         RATE_CTR_INTV_MIN,      /*!< \brief last minute */
  21         RATE_CTR_INTV_HOUR,     /*!< \brief last hour */
  22         RATE_CTR_INTV_DAY,      /*!< \brief last day */
  23 };
  24
  25 /*! \brief data we keep for each of the intervals */
  26 struct rate_ctr_per_intv {
  27         uint64_t last;          /*!< \brief counter value in last interval */
  28         uint64_t rate;          /*!< \brief counter rate */
  29 };
  30
  31 /*! \brief data we keep for each actual value */
  32 struct rate_ctr {
  33         uint64_t current;       /*!< \brief current value */
  34         /*! \brief per-interval data */
  35         struct rate_ctr_per_intv intv[RATE_CTR_INTV_NUM];
  36 };
  37
  38 /*! \brief rate counter description */
  39 struct rate_ctr_desc {
  40         const char *name;       /*!< \brief name of the counter */
  41         const char *description;/*!< \brief description of the counter */
  42 };
  43
  44 /*! \brief description of a rate counter group */
  45 struct rate_ctr_group_desc {
  46         /*! \brief The prefix to the name of all counters in this group */
  47         const char *group_name_prefix;
  48         /*! \brief The human-readable description of the group */
  49         const char *group_description;
  50         /*! \brief The number of counters in this group */
  51         const unsigned int num_ctr;
  52         /*! \brief Pointer to array of counter names */
  53         const struct rate_ctr_desc *ctr_desc;
  54 };
  55
  56 /*! \brief One instance of a counter group class */
  57 struct rate_ctr_group {
  58         /*! \brief Linked list of all counter groups in the system */
  59         struct llist_head list;
  60         /*! \brief Pointer to the counter group class */
  61         const struct rate_ctr_group_desc *desc;
  62         /*! \brief The index of this ctr_group within its class */
  63         unsigned int idx;
  64         /*! \brief Actual counter structures below */
  65         struct rate_ctr ctr[0];
  66 };
  67
  68 struct rate_ctr_group *rate_ctr_group_alloc(void *ctx,
  69                                             const struct rate_ctr_group_desc *desc,
  70                                             unsigned int idx);
  71
  72 void rate_ctr_group_free(struct rate_ctr_group *grp);
  73
  74 void rate_ctr_add(struct rate_ctr *ctr, int inc);
  75
  76 /*! \brief Increment the counter by 1 */
  77 static inline void rate_ctr_inc(struct rate_ctr *ctr)
  78 {
  79         rate_ctr_add(ctr, 1);
  80 }
  81
  82 int rate_ctr_init(void *tall_ctx);
  83
  84 struct rate_ctr_group *rate_ctr_get_group_by_name_idx(const char *name, const unsigned int idx);
  85 const struct rate_ctr *rate_ctr_get_by_name(const struct rate_ctr_group *ctrg, const char *name);
  86
  87 /*! }@ */
  88 #endif /* RATE_CTR_H */