kobject.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#ifndef ZEPHYR_INCLUDE_SYS_KOBJECT_H
#define ZEPHYR_INCLUDE_SYS_KOBJECT_H
 
#include <stdint.h>
#include <stddef.h>
 
#include <zephyr/sys/iterable_sections.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct k_thread;
struct k_mutex;
struct z_futex_data;
 
enum k_objects {
        K_OBJ_ANY,
 
#include <kobj-types-enum.h>
        K_OBJ_LAST
};
#ifdef CONFIG_USERSPACE
#ifdef CONFIG_GEN_PRIV_STACKS
/* Metadata struct for K_OBJ_THREAD_STACK_ELEMENT */
struct z_stack_data {
        /* Size of the entire stack object, including reserved areas */
        size_t size;
 
        /* Stack buffer for privilege mode elevations */
        uint8_t *priv;
};
#endif /* CONFIG_GEN_PRIV_STACKS */
 
/* Object extra data. Only some objects use this, determined by object type */
union z_object_data {
        /* Backing mutex for K_OBJ_SYS_MUTEX */
        struct k_mutex *mutex;
 
        /* Numerical thread ID for K_OBJ_THREAD */
        unsigned int thread_id;
 
#ifdef CONFIG_GEN_PRIV_STACKS
        /* Metadata for K_OBJ_THREAD_STACK_ELEMENT */
        const struct z_stack_data *stack_data;
#else
        /* Stack buffer size for K_OBJ_THREAD_STACK_ELEMENT */
        size_t stack_size;
#endif /* CONFIG_GEN_PRIV_STACKS */
 
        /* Futex wait queue and spinlock for K_OBJ_FUTEX */
        struct z_futex_data *futex_data;
 
        /* All other objects */
        int unused;
};
 
/* Table generated by gperf, these objects are retrieved via
 * z_object_find() */
struct z_object {
        void *name;
        uint8_t perms[CONFIG_MAX_THREAD_BYTES];
        uint8_t type;
        uint8_t flags;
        union z_object_data data;
} __packed __aligned(4);
 
struct z_object_assignment {
        struct k_thread *thread;
        void * const *objects;
};
 
#define K_THREAD_ACCESS_GRANT(name_, ...) \
        static void * const _CONCAT(_object_list_, name_)[] = \
                { __VA_ARGS__, NULL }; \
        static const STRUCT_SECTION_ITERABLE(z_object_assignment, \
                                        _CONCAT(_object_access_, name_)) = \
                        { (&_k_thread_obj_ ## name_), \
                          (_CONCAT(_object_list_, name_)) }
 
#define K_OBJ_FLAG_INITIALIZED  BIT(0)
#define K_OBJ_FLAG_PUBLIC       BIT(1)
#define K_OBJ_FLAG_ALLOC        BIT(2)
#define K_OBJ_FLAG_DRIVER       BIT(3)
 
void z_object_init(const void *obj);
 
__syscall void k_object_access_grant(const void *object,
                                     struct k_thread *thread);
 
void k_object_access_revoke(const void *object, struct k_thread *thread);
 
__syscall void k_object_release(const void *object);
 
void k_object_access_all_grant(const void *object);
 
bool k_object_is_valid(const void *obj, enum k_objects otype);
 
#else
/* LCOV_EXCL_START */
#define K_THREAD_ACCESS_GRANT(thread, ...)
 
static inline void z_object_init(const void *obj)
{
        ARG_UNUSED(obj);
}
 
static inline void z_impl_k_object_access_grant(const void *object,
                                                struct k_thread *thread)
{
        ARG_UNUSED(object);
        ARG_UNUSED(thread);
}
 
static inline void k_object_access_revoke(const void *object,
                                          struct k_thread *thread)
{
        ARG_UNUSED(object);
        ARG_UNUSED(thread);
}
 
static inline void z_impl_k_object_release(const void *object)
{
        ARG_UNUSED(object);
}
 
static inline void k_object_access_all_grant(const void *object)
{
        ARG_UNUSED(object);
}
 
static inline bool k_object_is_valid(const void *obj, enum k_objects otype)
{
        ARG_UNUSED(obj);
        ARG_UNUSED(otype);
 
        return true;
}
 
/* LCOV_EXCL_STOP */
#endif /* !CONFIG_USERSPACE */
 
#ifdef CONFIG_DYNAMIC_OBJECTS
__syscall void *k_object_alloc(enum k_objects otype);
 
__syscall void *k_object_alloc_size(enum k_objects otype, size_t size);
 
struct z_object *z_dynamic_object_aligned_create(size_t align, size_t size);
 
static inline struct z_object *z_dynamic_object_create(size_t size)
{
        return z_dynamic_object_aligned_create(0, size);
}
 
void k_object_free(void *obj);
#else
 
/* LCOV_EXCL_START */
static inline void *z_impl_k_object_alloc(enum k_objects otype)
{
        ARG_UNUSED(otype);
 
        return NULL;
}
 
static inline void *z_impl_k_object_alloc_size(enum k_objects otype,
                                        size_t size)
{
        ARG_UNUSED(otype);
        ARG_UNUSED(size);
 
        return NULL;
}
 
static inline struct z_object *z_dynamic_object_aligned_create(size_t align,
                                                               size_t size)
{
        ARG_UNUSED(align);
        ARG_UNUSED(size);
 
        return NULL;
}
 
static inline struct z_object *z_dynamic_object_create(size_t size)
{
        ARG_UNUSED(size);
 
        return NULL;
}
 
static inline void k_object_free(void *obj)
{
        ARG_UNUSED(obj);
}
/* LCOV_EXCL_STOP */
#endif /* CONFIG_DYNAMIC_OBJECTS */
 
#include <syscalls/kobject.h>
#ifdef __cplusplus
}
#endif
 
#endif