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>
#include <zephyr/sys/internal/kobject_internal.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct k_thread;
struct k_mutex;
struct z_futex_data;

enum k_objects {
        K_OBJ_ANY,         
        K_OBJ_DRIVER_ANY,  

#include <zephyr/kobj-types-enum.h>
 
        K_OBJ_LAST
};

 
#ifdef CONFIG_USERSPACE

#define K_THREAD_ACCESS_GRANT(name_, ...) \
        static void * const _CONCAT(_object_list_, name_)[] = \
                { __VA_ARGS__, NULL }; \
        static const STRUCT_SECTION_ITERABLE(k_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)

__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);

void k_object_access_revoke_others(const void *object);

__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);

__syscall int k_object_access_check(const void *object);
#else
/* LCOV_EXCL_START */
#define K_THREAD_ACCESS_GRANT(thread, ...)

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 k_object_access_revoke_others(const void *object)
{
        ARG_UNUSED(object);
}

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;
}

static inline int z_impl_k_object_access_check(const void *object)
{
        ARG_UNUSED(object);
 
        return 0;
}
 
/* LCOV_EXCL_STOP */
#endif /* !CONFIG_USERSPACE */
 
#if defined(CONFIG_DYNAMIC_OBJECTS) || defined(__DOXYGEN__)
__syscall void *k_object_alloc(enum k_objects otype);

__syscall void *k_object_alloc_size(enum k_objects otype, size_t 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 void k_object_free(void *obj)
{
        ARG_UNUSED(obj);
}
/* LCOV_EXCL_STOP */
#endif /* CONFIG_DYNAMIC_OBJECTS */

 
#include <zephyr/syscalls/kobject.h>
#ifdef __cplusplus
}
#endif
 
#endif