Kernel Object Management

Kernel Object Management 的协作图:

结构体
struct	rt_object
struct	rt_object_information

宏定义
#define	RT_OBJECT_FLAG_MODULE   0x80
#define	_RT_OBJECT_HOOK_CALL(func, argv)
#define	RT_OBJECT_HOOK_CALL(func, argv)
#define	__ON_HOOK_ARGS(__hook, argv)
#define	RT_OBJECT_HOOKLIST_DECLARE(handler_type, name)
#define	RT_OBJECT_HOOKLIST_DEFINE_NODE(hookname, nodename, hooker_handler)
#define	RT_OBJECT_HOOKLIST_DEFINE(name)
#define	RT_OBJECT_HOOKLIST_CALL(name, argv)

类型定义
typedef struct rt_object *	rt_object_t
typedef rt_err_t(*	rt_object_iter_t) (rt_object_t object, void *data)

枚举
enum	rt_object_class_type {   RT_Object_Class_Null = 0x00 , RT_Object_Class_Thread = 0x01 , RT_Object_Class_Semaphore = 0x02 , RT_Object_Class_Mutex = 0x03 ,   RT_Object_Class_Event = 0x04 , RT_Object_Class_MailBox = 0x05 , RT_Object_Class_MessageQueue = 0x06 , RT_Object_Class_MemHeap = 0x07 ,   RT_Object_Class_MemPool = 0x08 , RT_Object_Class_Device = 0x09 , RT_Object_Class_Timer = 0x0a , RT_Object_Class_Module = 0x0b ,   RT_Object_Class_Memory = 0x0c , RT_Object_Class_Channel = 0x0d , RT_Object_Class_ProcessGroup = 0x0e , RT_Object_Class_Session = 0x0f ,   RT_Object_Class_Custom = 0x10 , RT_Object_Class_Unknown = 0x11 , RT_Object_Class_Static = 0x80 }

函数
struct rt_object_information *	rt_object_get_information (enum rt_object_class_type type)
	RTM_EXPORT (rt_object_get_information)
int	rt_object_get_length (enum rt_object_class_type type)
	RTM_EXPORT (rt_object_get_length)
int	rt_object_get_pointers (enum rt_object_class_type type, rt_object_t *pointers, int maxlen)
	RTM_EXPORT (rt_object_get_pointers)
void	rt_object_init (struct rt_object *object, enum rt_object_class_type type, const char *name)
void	rt_object_detach (rt_object_t object)
rt_object_t	rt_object_allocate (enum rt_object_class_type type, const char *name)
void	rt_object_delete (rt_object_t object)
rt_bool_t	rt_object_is_systemobject (rt_object_t object)
rt_uint8_t	rt_object_get_type (rt_object_t object)
rt_err_t	rt_object_for_each (rt_uint8_t type, rt_object_iter_t iter, void *data)
rt_object_t	rt_object_find (const char *name, rt_uint8_t type)
rt_err_t	rt_object_get_name (rt_object_t object, char *name, rt_uint8_t name_size)
rt_object_t	rt_custom_object_create (const char *name, void *data, rt_err_t(*data_destroy)(void *))
rt_err_t	rt_custom_object_destroy (rt_object_t obj)
void	rt_object_attach_sethook (void(*hook)(struct rt_object *object))
void	rt_object_detach_sethook (void(*hook)(struct rt_object *object))
void	rt_object_trytake_sethook (void(*hook)(struct rt_object *object))
void	rt_object_take_sethook (void(*hook)(struct rt_object *object))
void	rt_object_put_sethook (void(*hook)(struct rt_object *object))

详细描述

kernel object management

The Kernel object system can access and manage all of the kernel objects.

Kernel objects include most of the facilities in the kernel:

• thread
• semaphore and mutex
• event/fast event, mailbox, messagequeue
• memory pool
• timer
  

  Figure 2: Kernel Object

Kernel objects can be static objects, whose memory is allocated in compiling. It can be dynamic objects as well, whose memory is allocated from system heaps in runtime.

宏定义说明

RT_OBJECT_FLAG_MODULE

#define RT_OBJECT_FLAG_MODULE   0x80

is module object.

在文件 rtdef.h 第 275 行定义.

_RT_OBJECT_HOOK_CALL

#define _RT_OBJECT_HOOK_CALL	(		func,
			argv )

值:

__ON_HOOK_ARGS(func, argv)

Add hook point in the routines

The hook function call macro

注解

Usage: void foo() { do_something();

RT_OBJECT_HOOK_CALL(foo);

do_other_things(); }

在文件 rtdef.h 第 381 行定义.

RT_OBJECT_HOOK_CALL

#define RT_OBJECT_HOOK_CALL	(		func,
			argv )

值:

_RT_OBJECT_HOOK_CALL(func, argv)

在文件 rtdef.h 第 382 行定义.

__ON_HOOK_ARGS

#define __ON_HOOK_ARGS	(		__hook,
			argv )

在文件 rtdef.h 第 387 行定义.

RT_OBJECT_HOOKLIST_DECLARE

#define RT_OBJECT_HOOKLIST_DECLARE	(		handler_type,
			name )

在文件 rtdef.h 第 507 行定义.

RT_OBJECT_HOOKLIST_DEFINE_NODE

#define RT_OBJECT_HOOKLIST_DEFINE_NODE	(		hookname,
			nodename,
			hooker_handler )

在文件 rtdef.h 第 508 行定义.

RT_OBJECT_HOOKLIST_DEFINE

#define RT_OBJECT_HOOKLIST_DEFINE

(

name

)

在文件 rtdef.h 第 509 行定义.

RT_OBJECT_HOOKLIST_CALL

#define RT_OBJECT_HOOKLIST_CALL	(		name,
			argv )

在文件 rtdef.h 第 510 行定义.

类型定义说明

rt_object_t

typedef struct rt_object* rt_object_t

Type for kernel objects.

在文件 rtdef.h 第 300 行定义.

rt_object_iter_t

typedef rt_err_t(* rt_object_iter_t) (rt_object_t object, void *data)

iterator of rt_object_for_each()

data is the data passing in to rt_object_for_each(). iterator can return RT_EOK to continue the iteration; or any positive value to break the loop successfully; or any negative errno to break the loop on failure.

在文件 rtdef.h 第 309 行定义.

枚举类型说明

rt_object_class_type

enum rt_object_class_type

The object type can be one of the follows with specific macros enabled:

• Thread
• Semaphore
• Mutex
• Event
• MailBox
• MessageQueue
• MemHeap
• MemPool
• Device
• Timer
• Module
• Unknown
• Static

枚举值
RT_Object_Class_Null	0x00	The object is not used.
RT_Object_Class_Thread	0x01	The object is a thread.
RT_Object_Class_Semaphore	0x02	The object is a semaphore.
RT_Object_Class_Mutex	0x03	The object is a mutex.
RT_Object_Class_Event	0x04	The object is a event.
RT_Object_Class_MailBox	0x05	The object is a mail box.
RT_Object_Class_MessageQueue	0x06	The object is a message queue.
RT_Object_Class_MemHeap	0x07	The object is a memory heap.
RT_Object_Class_MemPool	0x08	The object is a memory pool.
RT_Object_Class_Device	0x09	The object is a device.
RT_Object_Class_Timer	0x0a	The object is a timer.
RT_Object_Class_Module	0x0b	The object is a module.
RT_Object_Class_Memory	0x0c	The object is a memory.
RT_Object_Class_Channel	0x0d	The object is a channel
RT_Object_Class_ProcessGroup	0x0e	The object is a process group
RT_Object_Class_Session	0x0f	The object is a session
RT_Object_Class_Custom	0x10	The object is a custom object
RT_Object_Class_Unknown	0x11	The object is unknown.
RT_Object_Class_Static	0x80	The object is a static object.

在文件 rtdef.h 第 328 行定义.

{
    RT_Object_Class_Null          = 0x00,      
    RT_Object_Class_Thread        = 0x01,      
    RT_Object_Class_Semaphore     = 0x02,      
    RT_Object_Class_Mutex         = 0x03,      
    RT_Object_Class_Event         = 0x04,      
    RT_Object_Class_MailBox       = 0x05,      
    RT_Object_Class_MessageQueue  = 0x06,      
    RT_Object_Class_MemHeap       = 0x07,      
    RT_Object_Class_MemPool       = 0x08,      
    RT_Object_Class_Device        = 0x09,      
    RT_Object_Class_Timer         = 0x0a,      
    RT_Object_Class_Module        = 0x0b,      
    RT_Object_Class_Memory        = 0x0c,      
    RT_Object_Class_Channel       = 0x0d,      
    RT_Object_Class_ProcessGroup  = 0x0e,      
    RT_Object_Class_Session       = 0x0f,      
    RT_Object_Class_Custom        = 0x10,      
    RT_Object_Class_Unknown       = 0x11,      
    RT_Object_Class_Static        = 0x80       
};

函数说明

rt_object_get_information()

struct rt_object_information * rt_object_get_information

(

enum rt_object_class_type

type

)

This function will return the specified type of object information.

参数

type	is the type of object, which can be RT_Object_Class_Thread/Semaphore/Mutex... etc

返回

the object type information or RT_NULL

在文件 object.c 第 248 行定义.

{
    int index;
 
    type = (enum rt_object_class_type)(type & ~RT_Object_Class_Static);
 
    for (index = 0; index < RT_Object_Info_Unknown; index ++)
        if (_object_container[index].type == type) return &_object_container[index];
 
    return RT_NULL;
}

引用了 RT_NULL, RT_Object_Class_Static , 以及 RT_Object_Info_Unknown.

这是这个函数的调用关系图:

RTM_EXPORT() [1/3]

RTM_EXPORT

(

rt_object_get_information

)

引用了 rt_object_get_information().

函数调用图:

rt_object_get_length()

int rt_object_get_length

(

enum rt_object_class_type

type

)

This function will return the length of object list in object container.

参数

type	is the type of object, which can be RT_Object_Class_Thread/Semaphore/Mutex... etc

返回

the length of object list

在文件 object.c 第 269 行定义.

{
    int count = 0;
    rt_base_t level;
    struct rt_list_node *node = RT_NULL;
    struct rt_object_information *information = RT_NULL;
 
    information = rt_object_get_information((enum rt_object_class_type)type);
    if (information == RT_NULL) return 0;
 
    level = rt_spin_lock_irqsave(&(information->spinlock));
    rt_list_for_each(node, &(information->object_list))
    {
        count ++;
    }
    rt_spin_unlock_irqrestore(&(information->spinlock), level);
 
    return count;
}

引用了 rt_object_information::object_list, rt_list_for_each, RT_NULL, rt_object_get_information(), rt_spin_lock_irqsave(), rt_spin_unlock_irqrestore() , 以及 rt_object_information::spinlock.

函数调用图:

这是这个函数的调用关系图:

RTM_EXPORT() [2/3]

RTM_EXPORT

(

rt_object_get_length

)

引用了 rt_object_get_length().

函数调用图:

rt_object_get_pointers()

int rt_object_get_pointers	(	enum rt_object_class_type	type,
		rt_object_t *	pointers,
		int	maxlen )

This function will copy the object pointer of the specified type, with the maximum size specified by maxlen.

参数

type	is the type of object, which can be RT_Object_Class_Thread/Semaphore/Mutex... etc
pointers	is the pointer will be saved to.
maxlen	is the maximum number of pointers can be saved.

返回

the copied number of object pointers.

在文件 object.c 第 303 行定义.

{
    int index = 0;
    rt_base_t level;
 
    struct rt_object *object;
    struct rt_list_node *node = RT_NULL;
    struct rt_object_information *information = RT_NULL;
 
    if (maxlen <= 0) return 0;
 
    information = rt_object_get_information(type);
    if (information == RT_NULL) return 0;
 
    level = rt_spin_lock_irqsave(&(information->spinlock));
    /* retrieve pointer of object */
    rt_list_for_each(node, &(information->object_list))
    {
        object = rt_list_entry(node, struct rt_object, list);
 
        pointers[index] = object;
        index ++;
 
        if (index >= maxlen) break;
    }
    rt_spin_unlock_irqrestore(&(information->spinlock), level);
 
    return index;
}

引用了 rt_object_information::object_list, rt_list_entry, rt_list_for_each, RT_NULL, rt_object_get_information(), rt_spin_lock_irqsave(), rt_spin_unlock_irqrestore() , 以及 rt_object_information::spinlock.

函数调用图:

这是这个函数的调用关系图:

RTM_EXPORT() [3/3]

RTM_EXPORT

(

rt_object_get_pointers

)

引用了 rt_object_get_pointers().

函数调用图:

rt_object_init()

void rt_object_init	(	struct rt_object *	object,
		enum rt_object_class_type	type,
		const char *	name )

This function will initialize an object and add it to object system management.

参数

object	is the specified object to be initialized.
type	is the object type.
name	is the object name. In system, the object's name must be unique.

在文件 object.c 第 344 行定义.

{
    rt_base_t level;
#ifdef RT_DEBUGING_ASSERT
    struct rt_list_node *node = RT_NULL;
#endif /* RT_DEBUGING_ASSERT */
    struct rt_object_information *information;
#ifdef RT_USING_MODULE
    struct rt_dlmodule *module = dlmodule_self();
#endif /* RT_USING_MODULE */
 
    /* get object information */
    information = rt_object_get_information(type);
    RT_ASSERT(information != RT_NULL);
 
#ifdef RT_DEBUGING_ASSERT
    /* check object type to avoid re-initialization */
 
    /* enter critical */
    level = rt_spin_lock_irqsave(&(information->spinlock));
    /* try to find object */
    for (node  = information->object_list.next;
            node != &(information->object_list);
            node  = node->next)
    {
        struct rt_object *obj;
 
        obj = rt_list_entry(node, struct rt_object, list);
        RT_ASSERT(obj != object);
    }
    /* leave critical */
    rt_spin_unlock_irqrestore(&(information->spinlock), level);
#endif /* RT_DEBUGING_ASSERT */
 
    /* initialize object's parameters */
    /* set object type to static */
    object->type = type | RT_Object_Class_Static;
#if RT_NAME_MAX > 0
    rt_strncpy(object->name, name, RT_NAME_MAX);  /* copy name */
#else
    object->name = name;
#endif /* RT_NAME_MAX > 0 */
 
    RT_OBJECT_HOOK_CALL(rt_object_attach_hook, (object));
 
    level = rt_spin_lock_irqsave(&(information->spinlock));
 
#ifdef RT_USING_MODULE
    if (module)
    {
        rt_list_insert_after(&(module->object_list), &(object->list));
        object->module_id = (void *)module;
    }
    else
#endif /* RT_USING_MODULE */
    {
        /* insert object into information object list */
        rt_list_insert_after(&(information->object_list), &(object->list));
    }
    rt_spin_unlock_irqrestore(&(information->spinlock), level);
}

引用了 rt_object::list, rt_object::name, rt_list_node::next, rt_object_information::object_list, RT_ASSERT, rt_list_entry, rt_list_insert_after(), RT_NULL, RT_Object_Class_Static, rt_object_get_information(), RT_OBJECT_HOOK_CALL, rt_spin_lock_irqsave(), rt_spin_unlock_irqrestore() , 以及 rt_object_information::spinlock.

函数调用图:

这是这个函数的调用关系图:

rt_object_detach()

void rt_object_detach

(

rt_object_t

object

)

This function will detach a static object from object system, and the memory of static object is not freed.

参数

object

the specified object to be detached.

在文件 object.c 第 414 行定义.

{
    rt_base_t level;
    struct rt_object_information *information;
 
    /* object check */
    RT_ASSERT(object != RT_NULL);
 
    RT_OBJECT_HOOK_CALL(rt_object_detach_hook, (object));
 
    information = rt_object_get_information((enum rt_object_class_type)object->type);
    RT_ASSERT(information != RT_NULL);
 
    level = rt_spin_lock_irqsave(&(information->spinlock));
    /* remove from old list */
    rt_list_remove(&(object->list));
    rt_spin_unlock_irqrestore(&(information->spinlock), level);
 
    object->type = RT_Object_Class_Null;
}

引用了 rt_object::list, RT_ASSERT, rt_list_remove(), RT_NULL, RT_Object_Class_Null, rt_object_get_information(), RT_OBJECT_HOOK_CALL, rt_spin_lock_irqsave(), rt_spin_unlock_irqrestore(), rt_object_information::spinlock , 以及 rt_object::type.

函数调用图:

这是这个函数的调用关系图:

rt_object_allocate()

rt_object_t rt_object_allocate	(	enum rt_object_class_type	type,
		const char *	name )

This function will allocate an object from object system.

参数

type	is the type of object.
name	is the object name. In system, the object's name must be unique.

返回

object

在文件 object.c 第 445 行定义.

{
    struct rt_object *object;
    rt_base_t level;
    struct rt_object_information *information;
#ifdef RT_USING_MODULE
    struct rt_dlmodule *module = dlmodule_self();
#endif /* RT_USING_MODULE */
 
    RT_DEBUG_NOT_IN_INTERRUPT;
 
    /* get object information */
    information = rt_object_get_information(type);
    RT_ASSERT(information != RT_NULL);
 
    object = (struct rt_object *)RT_KERNEL_MALLOC(information->object_size);
    if (object == RT_NULL)
    {
        /* no memory can be allocated */
        return RT_NULL;
    }
 
    /* clean memory data of object */
    rt_memset(object, 0x0, information->object_size);
 
    /* initialize object's parameters */
 
    /* set object type */
    object->type = type;
 
    /* set object flag */
    object->flag = 0;
 
#if RT_NAME_MAX > 0
    rt_strncpy(object->name, name, RT_NAME_MAX - 1); /* copy name */
#else
    object->name = name;
#endif /* RT_NAME_MAX > 0 */
 
    RT_OBJECT_HOOK_CALL(rt_object_attach_hook, (object));
 
    level = rt_spin_lock_irqsave(&(information->spinlock));
 
#ifdef RT_USING_MODULE
    if (module)
    {
        rt_list_insert_after(&(module->object_list), &(object->list));
        object->module_id = (void *)module;
    }
    else
#endif /* RT_USING_MODULE */
    {
        /* insert object into information object list */
        rt_list_insert_after(&(information->object_list), &(object->list));
    }
    rt_spin_unlock_irqrestore(&(information->spinlock), level);
 
    return object;
}

引用了 rt_object::list, rt_object::name, rt_object_information::object_list, rt_object_information::object_size, RT_ASSERT, RT_DEBUG_NOT_IN_INTERRUPT, RT_KERNEL_MALLOC, rt_list_insert_after(), RT_NULL, rt_object_get_information(), RT_OBJECT_HOOK_CALL, rt_spin_lock_irqsave(), rt_spin_unlock_irqrestore() , 以及 rt_object_information::spinlock.

函数调用图:

这是这个函数的调用关系图:

rt_object_delete()

void rt_object_delete

(

rt_object_t

object

)

This function will delete an object and release object memory.

参数

object

is the specified object to be deleted.

在文件 object.c 第 510 行定义.

{
    rt_base_t level;
    struct rt_object_information *information;
 
    /* object check */
    RT_ASSERT(object != RT_NULL);
    RT_ASSERT(!(object->type & RT_Object_Class_Static));
 
    RT_OBJECT_HOOK_CALL(rt_object_detach_hook, (object));
 
 
    information = rt_object_get_information((enum rt_object_class_type)object->type);
    RT_ASSERT(information != RT_NULL);
 
    level = rt_spin_lock_irqsave(&(information->spinlock));
 
    /* remove from old list */
    rt_list_remove(&(object->list));
 
    rt_spin_unlock_irqrestore(&(information->spinlock), level);
 
    /* reset object type */
    object->type = RT_Object_Class_Null;
 
    /* free the memory of object */
    RT_KERNEL_FREE(object);
}

引用了 rt_object::list, RT_ASSERT, RT_KERNEL_FREE, rt_list_remove(), RT_NULL, RT_Object_Class_Null, RT_Object_Class_Static, rt_object_get_information(), RT_OBJECT_HOOK_CALL, rt_spin_lock_irqsave(), rt_spin_unlock_irqrestore(), rt_object_information::spinlock , 以及 rt_object::type.

函数调用图:

这是这个函数的调用关系图:

rt_object_is_systemobject()

rt_bool_t rt_object_is_systemobject

(

rt_object_t

object

)

This function will judge the object is system object or not.

注解

Normally, the system object is a static object and the type of object set to RT_Object_Class_Static.

参数

object

is the specified object to be judged.

返回

RT_TRUE if a system object, RT_FALSE for others.

在文件 object.c 第 550 行定义.

{
    /* object check */
    RT_ASSERT(object != RT_NULL);
 
    if (object->type & RT_Object_Class_Static)
        return RT_TRUE;
 
    return RT_FALSE;
}

引用了 RT_ASSERT, RT_FALSE, RT_NULL, RT_Object_Class_Static, RT_TRUE , 以及 rt_object::type.

rt_object_get_type()

rt_uint8_t rt_object_get_type

(

rt_object_t

object

)

This function will return the type of object without RT_Object_Class_Static flag.

参数

object

is the specified object to be get type.

返回

the type of object.

在文件 object.c 第 569 行定义.

{
    /* object check */
    RT_ASSERT(object != RT_NULL);
 
    return object->type & ~RT_Object_Class_Static;
}

引用了 RT_ASSERT, RT_NULL , 以及 RT_Object_Class_Static.

rt_object_for_each()

rt_err_t rt_object_for_each	(	rt_uint8_t	type,
		rt_object_iter_t	iter,
		void *	data )

This function will iterate through each object from object container.

参数

type	is the type of object
iter	is the iterator
data	is the specified data passed to iterator

返回

RT_EOK on succeed, otherwise the error from iter

注解

this function shall not be invoked in interrupt status.

在文件 object.c 第 589 行定义.

{
    struct rt_object *object = RT_NULL;
    struct rt_list_node *node = RT_NULL;
    struct rt_object_information *information = RT_NULL;
    rt_base_t level;
    rt_err_t error;
 
    information = rt_object_get_information((enum rt_object_class_type)type);
 
    /* parameter check */
    if (information == RT_NULL)
    {
        return -RT_EINVAL;
    }
 
    /* which is invoke in interrupt status */
    RT_DEBUG_NOT_IN_INTERRUPT;
 
    /* enter critical */
    level = rt_spin_lock_irqsave(&(information->spinlock));
 
    /* try to find object */
    rt_list_for_each(node, &(information->object_list))
    {
        object = rt_list_entry(node, struct rt_object, list);
        if ((error = iter(object, data)) != RT_EOK)
        {
            rt_spin_unlock_irqrestore(&(information->spinlock), level);
 
            return error >= 0 ? RT_EOK : error;
        }
    }
 
    rt_spin_unlock_irqrestore(&(information->spinlock), level);
 
    return RT_EOK;
}

引用了 rt_object_information::object_list, RT_DEBUG_NOT_IN_INTERRUPT, rt_list_entry, rt_list_for_each, RT_NULL, rt_object_get_information(), rt_spin_lock_irqsave(), rt_spin_unlock_irqrestore() , 以及 rt_object_information::spinlock.

函数调用图:

这是这个函数的调用关系图:

rt_object_find()

rt_object_t rt_object_find	(	const char *	name,
		rt_uint8_t	type )

This function will find specified name object from object container.

参数

name	is the specified name of object.
type	is the type of object

返回

the found object or RT_NULL if there is no this object in object container.

注解

this function shall not be invoked in interrupt status.

在文件 object.c 第 662 行定义.

{
    struct _obj_find_param param =
    {
        .match_name = name,
        .matched_obj = RT_NULL,
    };
 
    /* parameter check */
    if (name == RT_NULL) return RT_NULL;
 
    /* which is invoke in interrupt status */
    RT_DEBUG_NOT_IN_INTERRUPT;
 
    rt_object_for_each(type, _match_name, &param);
    return param.matched_obj;
}

引用了 RT_DEBUG_NOT_IN_INTERRUPT, RT_NULL , 以及 rt_object_for_each().

函数调用图:

这是这个函数的调用关系图:

rt_object_get_name()

rt_err_t rt_object_get_name	(	rt_object_t	object,
		char *	name,
		rt_uint8_t	name_size )

This function will return the name of the specified object container

参数

object	the specified object to be get name
name	buffer to store the object name string
name_size	maximum size of the buffer to store object name

返回

-RT_EINVAL if any parameter is invalid or RT_EOK if the operation is successfully executed

注解

this function shall not be invoked in interrupt status

在文件 object.c 第 691 行定义.

{
    rt_err_t result = -RT_EINVAL;
    if ((object != RT_NULL) && (name != RT_NULL) && (name_size != 0U))
    {
        const char *obj_name = object->name;
        (void) rt_strncpy(name, obj_name, (rt_size_t)name_size);
        result = RT_EOK;
    }
 
    return result;
}

引用了 RT_NULL.

这是这个函数的调用关系图:

rt_custom_object_create()

rt_object_t rt_custom_object_create	(	const char *	name,
		void *	data,
		rt_err_t(*	data_destroy )(void *) )

This function will create a custom object container.

参数

name	the specified name of object.
data	the custom data
data_destroy	the custom object destroy callback

返回

the found object or RT_NULL if there is no this object in object container.

注解

this function shall not be invoked in interrupt status.

在文件 object.c 第 719 行定义.

{
    struct rt_custom_object *cobj = RT_NULL;
 
    cobj = (struct rt_custom_object *)rt_object_allocate(RT_Object_Class_Custom, name);
    if (!cobj)
    {
        return RT_NULL;
    }
    cobj->destroy = data_destroy;
    cobj->data = data;
    return (struct rt_object *)cobj;
}

引用了 RT_NULL, rt_object_allocate() , 以及 RT_Object_Class_Custom.

函数调用图:

rt_custom_object_destroy()

rt_err_t rt_custom_object_destroy

(

rt_object_t

obj

)

This function will destroy a custom object container.

参数

obj	the specified name of object.

注解

this function shall not be invoked in interrupt status.

在文件 object.c 第 741 行定义.

{
    rt_err_t ret = -1;
 
    struct rt_custom_object *cobj = (struct rt_custom_object *)obj;
 
    if (obj && obj->type == RT_Object_Class_Custom)
    {
        if (cobj->destroy)
        {
            ret = cobj->destroy(cobj->data);
        }
        rt_object_delete(obj);
    }
    return ret;
}

引用了 RT_Object_Class_Custom, rt_object_delete() , 以及 rt_object::type.

函数调用图:

rt_object_attach_sethook()

void rt_object_attach_sethook

(

void(*

hook )(struct rt_object *object)

)

rt_object_detach_sethook()

void rt_object_detach_sethook

(

void(*

hook )(struct rt_object *object)

)

rt_object_trytake_sethook()

void rt_object_trytake_sethook

(

void(*

hook )(struct rt_object *object)

)

rt_object_take_sethook()

void rt_object_take_sethook

(

void(*

hook )(struct rt_object *object)

)

rt_object_put_sethook()

void rt_object_put_sethook

(

void(*

hook )(struct rt_object *object)

)