obj_core.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023, Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_KERNEL_OBJ_CORE_H_
#define ZEPHYR_INCLUDE_KERNEL_OBJ_CORE_H_
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <zephyr/sys/slist.h>
#include <zephyr/sys/iterable_sections.h>


#define K_OBJ_CORE(kobj)  (&((kobj)->obj_core))

#define K_OBJ_TYPE_ID_GEN(s)     ((s[0] << 24) | (s[1] << 16) | (s[2] << 8) | (s[3]))
 
/* Known kernel object types */

#define K_OBJ_TYPE_CONDVAR_ID    K_OBJ_TYPE_ID_GEN("COND")
#define K_OBJ_TYPE_CPU_ID        K_OBJ_TYPE_ID_GEN("CPU_")
#define K_OBJ_TYPE_EVENT_ID      K_OBJ_TYPE_ID_GEN("EVNT")
#define K_OBJ_TYPE_FIFO_ID       K_OBJ_TYPE_ID_GEN("FIFO")
#define K_OBJ_TYPE_KERNEL_ID     K_OBJ_TYPE_ID_GEN("KRNL")
#define K_OBJ_TYPE_LIFO_ID       K_OBJ_TYPE_ID_GEN("LIFO")
#define K_OBJ_TYPE_MEM_BLOCK_ID  K_OBJ_TYPE_ID_GEN("MBLK")
#define K_OBJ_TYPE_MBOX_ID       K_OBJ_TYPE_ID_GEN("MBOX")
#define K_OBJ_TYPE_MEM_SLAB_ID   K_OBJ_TYPE_ID_GEN("SLAB")
#define K_OBJ_TYPE_MSGQ_ID       K_OBJ_TYPE_ID_GEN("MSGQ")
#define K_OBJ_TYPE_MUTEX_ID      K_OBJ_TYPE_ID_GEN("MUTX")
#define K_OBJ_TYPE_PIPE_ID       K_OBJ_TYPE_ID_GEN("PIPE")
#define K_OBJ_TYPE_QUEUE_ID      K_OBJ_TYPE_ID_GEN("QUEU")
#define K_OBJ_TYPE_SEM_ID        K_OBJ_TYPE_ID_GEN("SEM4")
#define K_OBJ_TYPE_STACK_ID      K_OBJ_TYPE_ID_GEN("STCK")
#define K_OBJ_TYPE_THREAD_ID     K_OBJ_TYPE_ID_GEN("THRD")
#define K_OBJ_TYPE_TIMER_ID      K_OBJ_TYPE_ID_GEN("TIMR")
 
struct k_obj_type;
struct k_obj_core;

 
#ifdef CONFIG_OBJ_CORE
#define K_OBJ_CORE_INIT(_objp, _obj_type)   \
        extern struct k_obj_type _obj_type; \
        k_obj_core_init(_objp, &_obj_type)
 
#define K_OBJ_CORE_LINK(objp) k_obj_core_link(objp)
#else
#define K_OBJ_CORE_INIT(objp, type)   do { } while (0)
#define K_OBJ_CORE_LINK(objp)         do { } while (0)
#endif /* CONFIG_OBJ_CORE */


extern sys_slist_t z_obj_type_list;

struct k_obj_core_stats_desc {
        size_t  raw_size;   
        size_t  query_size; 

        int (*raw)(struct k_obj_core *obj_core, void *stats);
        int (*query)(struct k_obj_core *obj_core, void *stats);
        int (*reset)(struct k_obj_core *obj_core);
        int (*disable)(struct k_obj_core *obj_core);
        int (*enable)(struct k_obj_core *obj_core);
};

struct k_obj_range {
        const void *start;   
        const void *end;     
        size_t      stride;  
        bool        indirect; 
};

#define K_OBJ_TYPE_MAX_RANGES 3

struct k_obj_type {
        sys_snode_t    node;   
        uint32_t       id;     
        size_t         obj_core_offset;  
        struct k_obj_range statics[K_OBJ_TYPE_MAX_RANGES];
        uint32_t       dropped;
        uint32_t       skipped;
#ifdef CONFIG_OBJ_CORE_STATS
        struct k_obj_core_stats_desc *stats_desc;
        size_t         stats_offset;
        size_t         stats_size;
#endif /* CONFIG_OBJ_CORE_STATS */
};

struct k_obj_core {
        struct k_obj_type *type;   
#ifdef CONFIG_OBJ_CORE_STATS
        void  *stats;              
#endif /* CONFIG_OBJ_CORE_STATS */
};

 
#ifdef CONFIG_OBJ_CORE_STATS
#define K_OBJ_TYPE_STATS_INITIALIZER(_stats, _soff, _ssz) \
        .stats_desc = (_stats), .stats_offset = (_soff), .stats_size = (_ssz),
#else
#define K_OBJ_TYPE_STATS_INITIALIZER(_stats, _soff, _ssz)
#endif /* CONFIG_OBJ_CORE_STATS */

#define K_OBJ_TYPE_INITIALIZER(_struct, _id, _stats, _soff, _ssz, ...)        \
        {                                                                      \
                .id = (_id),                                                   \
                .obj_core_offset = offsetof(struct _struct, obj_core),         \
                .statics = { __VA_ARGS__ },                                    \
                K_OBJ_TYPE_STATS_INITIALIZER(_stats, _soff, _ssz)              \
        }

#define K_OBJ_RANGE_SECTION(_struct)                                           \
        {                                                                      \
                .start = STRUCT_SECTION_START(_struct),                        \
                .end = STRUCT_SECTION_END(_struct),                            \
                .stride = sizeof(struct _struct),                              \
                .indirect = false,                                             \
        }

#define K_OBJ_TYPE_DEFINE(_type_var, _struct, _id, _stats)                     \
        STRUCT_SECTION_START_EXTERN(_struct);                                  \
        STRUCT_SECTION_END_EXTERN(_struct);                                    \
        static STRUCT_SECTION_ITERABLE(k_obj_type, _type_var) =                \
                K_OBJ_TYPE_INITIALIZER(_struct, _id, _stats, 0, 0,             \
                                       K_OBJ_RANGE_SECTION(_struct))

#define K_OBJ_TYPE_DEFINE_STATS(_type_var, _struct, _id, _stats, _member)      \
        STRUCT_SECTION_START_EXTERN(_struct);                                  \
        STRUCT_SECTION_END_EXTERN(_struct);                                    \
        static STRUCT_SECTION_ITERABLE(k_obj_type, _type_var) =                \
                K_OBJ_TYPE_INITIALIZER(_struct, _id, _stats,                   \
                                       offsetof(struct _struct, _member),      \
                                       sizeof(((struct _struct *)0)->_member), \
                                       K_OBJ_RANGE_SECTION(_struct))

#define K_OBJ_TYPE_DEFINE_TYPE_ONLY(_type_var, _struct, _id, _stats)           \
        static STRUCT_SECTION_ITERABLE(k_obj_type, _type_var) =                \
                K_OBJ_TYPE_INITIALIZER(_struct, _id, _stats, 0, 0, { 0 })

#define K_OBJ_TYPE_DEFINE_RANGES(_type_var, _struct, _id, _stats, ...)         \
        static STRUCT_SECTION_ITERABLE(k_obj_type, _type_var) =                \
                K_OBJ_TYPE_INITIALIZER(_struct, _id, _stats, 0, 0, __VA_ARGS__)


struct k_obj_type *z_obj_type_init(struct k_obj_type *type,
                                   uint32_t id, size_t off);

void k_obj_type_init_range(struct k_obj_type *type, const void *start,
                           const void *end, size_t stride, bool indirect);

struct k_obj_type *k_obj_type_find(uint32_t type_id);

int k_obj_type_walk_locked(struct k_obj_type *type,
                           int (*func)(struct k_obj_core *obj_core, void *data),
                                  void *data);

int k_obj_type_walk_unlocked(struct k_obj_type *type,
                             int (*func)(struct k_obj_core *obj_core, void *data),
                             void *data);

void k_obj_core_init(struct k_obj_core *obj_core, struct k_obj_type *type);

void k_obj_core_link(struct k_obj_core *obj_core);

void k_obj_core_init_and_link(struct k_obj_core *obj_core,
                              struct k_obj_type *type);

void k_obj_core_unlink(struct k_obj_core *obj_core);

void k_obj_core_evict_range(const void *addr, size_t len);


 
#ifdef CONFIG_OBJ_CORE_STATS
static inline void k_obj_type_stats_init(struct k_obj_type *type,
                                         struct k_obj_core_stats_desc *stats_desc)
{
        type->stats_desc = stats_desc;
}

static inline void k_obj_core_stats_init(struct k_obj_core *obj_core,
                                         void *stats)
{
        obj_core->stats = stats;
}
#endif /* CONFIG_OBJ_CORE_STATS */

int k_obj_core_stats_register(struct k_obj_core *obj_core, void *stats,
                              size_t stats_len);

int k_obj_core_stats_deregister(struct k_obj_core *obj_core);

int k_obj_core_stats_raw(struct k_obj_core *obj_core, void *stats,
                         size_t stats_len);

int k_obj_core_stats_query(struct k_obj_core *obj_core, void *stats,
                           size_t stats_len);

int k_obj_core_stats_reset(struct k_obj_core *obj_core);

int k_obj_core_stats_disable(struct k_obj_core *obj_core);

int k_obj_core_stats_enable(struct k_obj_core *obj_core);

#endif /* ZEPHYR_INCLUDE_KERNEL_OBJ_CORE_H_ */