stats.h

Go to the documentation of this file.

/*
 * Copyright Runtime.io 2018. All rights reserved.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

 
#ifndef ZEPHYR_INCLUDE_STATS_STATS_H_
#define ZEPHYR_INCLUDE_STATS_STATS_H_
 
#include <stddef.h>
#include <zephyr/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif


struct stats_name_map {
        uint16_t snm_off;
        const char *snm_name;
} __attribute__((packed));

struct stats_hdr {
        const char *s_name;
        uint8_t s_size;
        uint16_t s_cnt;
        uint8_t s_pad1;
#ifdef CONFIG_STATS_NAMES
        const struct stats_name_map *s_map;
        int s_map_cnt;
#endif
        struct stats_hdr *s_next;
};


#define STATS_SECT_DECL(group__) \
        struct stats_ ## group__

#define STATS_SECT_END }
 
/* The following macros depend on whether CONFIG_STATS is defined.  If it is
 * not defined, then invocations of these macros get compiled out.
 */
#if defined(CONFIG_STATS) || defined(__DOXYGEN__)

#define STATS_SECT_START(group__)  \
        STATS_SECT_DECL(group__) { \
                struct stats_hdr s_hdr;

#define STATS_SECT_ENTRY(var__) uint32_t var__;

#define STATS_SECT_ENTRY16(var__) uint16_t var__;

#define STATS_SECT_ENTRY32(var__) uint32_t var__;

#define STATS_SECT_ENTRY64(var__) uint64_t var__;

#define STATS_SIZE_16 (sizeof(uint16_t))
#define STATS_SIZE_32 (sizeof(uint32_t))
#define STATS_SIZE_64 (sizeof(uint64_t))



#define STATS_INCN(group__, var__, n__) \
        ((group__).var__ += (n__))

#define STATS_INC(group__, var__) \
        STATS_INCN(group__, var__, 1)

#define STATS_SET(group__, var__, n__)  \
        ((group__).var__ = (n__))

#define STATS_CLEAR(group__, var__) \
        ((group__).var__ = 0)


#define STATS_SIZE_INIT_PARMS(group__, size__) \
        (size__),                              \
        ((sizeof(group__)) - sizeof(struct stats_hdr)) / (size__)


#define STATS_INIT_AND_REG(group__, size__, name__)                      \
        stats_init_and_reg(                                              \
                &(group__).s_hdr,                                        \
                (size__),                                                \
                (sizeof(group__) - sizeof(struct stats_hdr)) / (size__), \
                STATS_NAME_INIT_PARMS(group__),                          \
                (name__))

void stats_init(struct stats_hdr *shdr, uint8_t size, uint16_t cnt,
                const struct stats_name_map *map, uint16_t map_cnt);

int stats_register(const char *name, struct stats_hdr *shdr);

int stats_init_and_reg(struct stats_hdr *hdr, uint8_t size, uint16_t cnt,
                       const struct stats_name_map *map, uint16_t map_cnt,
                       const char *name);

void stats_reset(struct stats_hdr *shdr);



typedef int stats_walk_fn(struct stats_hdr *hdr, void *arg,
                          const char *name, uint16_t off);

int stats_walk(struct stats_hdr *hdr, stats_walk_fn *walk_cb, void *arg);

typedef int stats_group_walk_fn(struct stats_hdr *hdr, void *arg);

int stats_group_walk(stats_group_walk_fn *walk_cb, void *arg);

struct stats_hdr *stats_group_get_next(const struct stats_hdr *cur);

struct stats_hdr *stats_group_find(const char *name);

 
#else /* CONFIG_STATS */
 
#define STATS_SECT_START(group__) \
        STATS_SECT_DECL(group__) {
 
#define STATS_SECT_ENTRY(var__)
#define STATS_SECT_ENTRY16(var__)
#define STATS_SECT_ENTRY32(var__)
#define STATS_SECT_ENTRY64(var__)
#define STATS_RESET(var__)
#define STATS_SIZE_INIT_PARMS(group__, size__)
#define STATS_INCN(group__, var__, n__)
#define STATS_INC(group__, var__)
#define STATS_SET(group__, var__, n__)
#define STATS_CLEAR(group__, var__)
#define STATS_INIT_AND_REG(group__, size__, name__) (0)
 
#endif /* CONFIG_STATS || __DOXYGEN__ */
 
#if defined(CONFIG_STATS_NAMES) || defined(__DOXYGEN__)

#define STATS_NAME_MAP_NAME(sectname__) stats_map_ ## sectname__


#define STATS_NAME_START(sectname__) \
        static const struct stats_name_map STATS_NAME_MAP_NAME(sectname__)[] = {

#define STATS_NAME(sectname__, entry__) \
        { offsetof(STATS_SECT_DECL(sectname__), entry__), #entry__ },

#define STATS_NAME_END(sectname__) }

#define STATS_NAME_INIT_PARMS(name__)       \
        &(STATS_NAME_MAP_NAME(name__)[0]), \
        (sizeof(STATS_NAME_MAP_NAME(name__)) / sizeof(struct stats_name_map))

 
#else /* CONFIG_STATS_NAMES */
 
#define STATS_NAME_START(name__)
#define STATS_NAME(name__, entry__)
#define STATS_NAME_END(name__)
#define STATS_NAME_INIT_PARMS(name__) NULL, 0
 
#endif /* CONFIG_STATS_NAMES */

 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_STATS_STATS_H_ */