diff options
author | Jacob Erlbeck <jerlbeck@sysmocom.de> | 2015-10-29 00:55:58 +0100 |
---|---|---|
committer | Holger Hans Peter Freyther <holger@moiji-mobile.com> | 2015-11-02 15:39:01 +0100 |
commit | fc9533d6c4bde795dc0e18f02f91f54ab92888a2 (patch) | |
tree | 4ef9968929667894b99a42992d0a5c63d65ae011 /include/osmocom/core/stat_item.h | |
parent | bc4f7ae512b32fa4b569dfc5242d0b7a5da3f81b (diff) |
stats: Add osmo_ name prefix to identifiers
Since the the stat_item and stats functions and data types are meant
to be exported, they get an osmo_ prefix.
Sponsored-by: On-Waves ehf
[hfreyther: Prepended the enum values too. This was requested by
Jacob]
Diffstat (limited to 'include/osmocom/core/stat_item.h')
-rw-r--r-- | include/osmocom/core/stat_item.h | 68 |
1 files changed, 34 insertions, 34 deletions
diff --git a/include/osmocom/core/stat_item.h b/include/osmocom/core/stat_item.h index 0786a3ba..40474958 100644 --- a/include/osmocom/core/stat_item.h +++ b/include/osmocom/core/stat_item.h @@ -1,6 +1,6 @@ #pragma once -/*! \defgroup stat_item Statistics value item +/*! \defgroup osmo_stat_item Statistics value item * @{ */ @@ -10,28 +10,28 @@ #include <osmocom/core/linuxlist.h> -struct stat_item_desc; +struct osmo_stat_item_desc; #define STAT_ITEM_NOVALUE_ID 0 -struct stat_item_value { +struct osmo_stat_item_value { int32_t id; int32_t value; }; /*! \brief data we keep for each actual value */ -struct stat_item { - const struct stat_item_desc *desc; +struct osmo_stat_item { + const struct osmo_stat_item_desc *desc; /*! \brief the index of the freshest value */ int32_t last_value_index; /*! \brief offset to the freshest value in the value fifo */ int16_t last_offs; /*! \brief value fifo */ - struct stat_item_value values[0]; + struct osmo_stat_item_value values[0]; }; /*! \brief statistics value description */ -struct stat_item_desc { +struct osmo_stat_item_desc { const char *name; /*!< \brief name of the item */ const char *description;/*!< \brief description of the item */ const char *unit; /*!< \brief unit of a value */ @@ -40,7 +40,7 @@ struct stat_item_desc { }; /*! \brief description of a statistics value group */ -struct stat_item_group_desc { +struct osmo_stat_item_group_desc { /*! \brief The prefix to the name of all values in this group */ const char *group_name_prefix; /*! \brief The human-readable description of the group */ @@ -48,80 +48,80 @@ struct stat_item_group_desc { /*! \brief The number of values in this group */ const unsigned int num_items; /*! \brief Pointer to array of value names */ - const struct stat_item_desc *item_desc; + const struct osmo_stat_item_desc *item_desc; }; /*! \brief One instance of a counter group class */ -struct stat_item_group { +struct osmo_stat_item_group { /*! \brief Linked list of all value groups in the system */ struct llist_head list; /*! \brief Pointer to the counter group class */ - const struct stat_item_group_desc *desc; + const struct osmo_stat_item_group_desc *desc; /*! \brief The index of this value group within its class */ unsigned int idx; /*! \brief Actual counter structures below */ - struct stat_item *items[0]; + struct osmo_stat_item *items[0]; }; -struct stat_item_group *stat_item_group_alloc( +struct osmo_stat_item_group *osmo_stat_item_group_alloc( void *ctx, - const struct stat_item_group_desc *desc, + const struct osmo_stat_item_group_desc *desc, unsigned int idx); -void stat_item_group_free(struct stat_item_group *statg); +void osmo_stat_item_group_free(struct osmo_stat_item_group *statg); -void stat_item_set(struct stat_item *item, int32_t value); +void osmo_stat_item_set(struct osmo_stat_item *item, int32_t value); -int stat_item_init(void *tall_ctx); +int osmo_stat_item_init(void *tall_ctx); -struct stat_item_group *stat_item_get_group_by_name_idx( +struct osmo_stat_item_group *osmo_stat_item_get_group_by_name_idx( const char *name, const unsigned int idx); -const struct stat_item *stat_item_get_by_name( - const struct stat_item_group *statg, const char *name); +const struct osmo_stat_item *osmo_stat_item_get_by_name( + const struct osmo_stat_item_group *statg, const char *name); -/*! \brief Retrieve the next value from the stat_item object. +/*! \brief Retrieve the next value from the osmo_stat_item object. * If a new value has been set, it is returned. The idx is used to decide * which value to return. * On success, *idx is updated to refer to the next unread value. If * values have been missed due to FIFO overflow, *idx is incremented by * (1 + num_lost). - * This way, the stat_item object can be kept stateless from the reader's + * This way, the osmo_stat_item object can be kept stateless from the reader's * perspective and therefore be used by several backends simultaneously. * - * \param val the stat_item object + * \param val the osmo_stat_item object * \param idx identifies the next value to be read * \param value a pointer to store the value * \returns the increment of the index (0: no value has been read, * 1: one value has been taken, * (1+n): n values have been skipped, one has been taken) */ -int stat_item_get_next(const struct stat_item *item, int32_t *idx, int32_t *value); +int osmo_stat_item_get_next(const struct osmo_stat_item *item, int32_t *idx, int32_t *value); /*! \brief Get the last (freshest) value */ -static int32_t stat_item_get_last(const struct stat_item *item); +static int32_t osmo_stat_item_get_last(const struct osmo_stat_item *item); /*! \brief Skip all values of the item and update idx accordingly */ -int stat_item_discard(const struct stat_item *item, int32_t *idx); +int osmo_stat_item_discard(const struct osmo_stat_item *item, int32_t *idx); /*! \brief Skip all values of all items and update idx accordingly */ -int stat_item_discard_all(int32_t *idx); +int osmo_stat_item_discard_all(int32_t *idx); -typedef int (*stat_item_handler_t)( - struct stat_item_group *, struct stat_item *, void *); +typedef int (*osmo_stat_item_handler_t)( + struct osmo_stat_item_group *, struct osmo_stat_item *, void *); -typedef int (*stat_item_group_handler_t)(struct stat_item_group *, void *); +typedef int (*osmo_stat_item_group_handler_t)(struct osmo_stat_item_group *, void *); /*! \brief Iteate over all items * \param[in] handle_item Call-back function, aborts if rc < 0 * \param[in] data Private data handed through to \a handle_item */ -int stat_item_for_each_item(struct stat_item_group *statg, - stat_item_handler_t handle_item, void *data); +int osmo_stat_item_for_each_item(struct osmo_stat_item_group *statg, + osmo_stat_item_handler_t handle_item, void *data); -int stat_item_for_each_group(stat_item_group_handler_t handle_group, void *data); +int osmo_stat_item_for_each_group(osmo_stat_item_group_handler_t handle_group, void *data); -static inline int32_t stat_item_get_last(const struct stat_item *item) +static inline int32_t osmo_stat_item_get_last(const struct osmo_stat_item *item) { return item->values[item->last_offs].value; } |