XWOS的对象的协作图:

结构体
struct	xwos_object
	XWOS对象更多...

struct	xwobj_d
	XWOS对象描述符更多...

宏定义
#define	xwos_cast(type, obj) ((type)(obj))
	将对象强制类型转换

#define	XWOS_OBJ_MAGIC 0x58574F53U

#define	XWOBJ_NILD ((xwobj_d){NULL, 0,})
	空的XWOS对象对象描述符

类型定义
typedef xwer_t(*	xwobj_gc_f) (struct xwos_object *)
	垃圾回收函数指针类型

函数
void	xwos_objtik_init (void)
	初始化对象标签分配器

void	xwos_object_construct (struct xwos_object *obj)
	XWOS对象的构造函数

void	xwos_object_destruct (struct xwos_object *obj)
	XWOS对象的析构函数

xwer_t	xwos_object_activate (struct xwos_object *obj, xwobj_gc_f gcfunc)
	激活一个XWOS对象（将其引用计数初始化位1）

void	xwos_object_setgc (struct xwos_object *obj, xwobj_gc_f gcfunc)
	设置XWOS对象的垃圾回收函数

xwer_t	xwos_object_acquire (struct xwos_object *obj, xwsq_t tik)
	检查对象的标签并增加引用计数

xwer_t	xwos_object_release (struct xwos_object *obj, xwsq_t tik)
	检查对象的标签并减少引用计数

xwer_t	xwos_object_grab (struct xwos_object *obj)
	增加对象的引用计数

xwer_t	xwos_object_put (struct xwos_object *obj)
	减少对象的引用计数

xwer_t	xwos_object_rawput (struct xwos_object *obj)
	减少对象的引用计数，不触发垃圾回收函数

xwsq_t	xwos_object_get_refcnt (struct xwos_object *obj)
	获取XWOS对象的引用计数

详细描述

宏定义说明

◆ xwos_cast

#define xwos_cast	(	type,
		obj
	)	((type)(obj))

将对象强制类型转换

参数

[in]	type	类型
[in]	obj	对象

注解

类似于C++中的关键字： static_cast<type>(obj)

在文件 object.h 第 33 行定义.

◆ XWOS_OBJ_MAGIC

#define XWOS_OBJ_MAGIC 0x58574F53U

所有XWOS的对象都有相同的幻数

在文件 object.h 第 35 行定义.

◆ XWOBJ_NILD

#define XWOBJ_NILD ((xwobj_d){NULL, 0,})

空的XWOS对象对象描述符

在文件 object.h 第 71 行定义.

类型定义说明

◆ xwobj_gc_f

typedef xwer_t(* xwobj_gc_f) (struct xwos_object *)

垃圾回收函数指针类型

在文件 object.h 第 42 行定义.

函数说明

◆ xwos_objtik_init()

void xwos_objtik_init ( void )

初始化对象标签分配器

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

{
        xwsq_t i;
 
        xwos_objtik_dispatcher = (CPUCFG_CPU_NUM * XWOS_OBJTIK_CHUNK);
        for (i = 0; i < CPUCFG_CPU_NUM; i++) {
                xwos_objtik[i] = (i * XWOS_OBJTIK_CHUNK);
        }
}

◆ xwos_object_construct()

void xwos_object_construct ( struct xwos_object * obj )

XWOS对象的构造函数

参数

[in] obj 对象指针

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

{
        obj->refcnt = 0;
        obj->gcfunc = NULL;
        obj->tik = 0;
}

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

◆ xwos_object_destruct()

void xwos_object_destruct ( struct xwos_object * obj )

XWOS对象的析构函数

参数

[in] obj 对象指针

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

{
        obj->gcfunc = NULL;
        obj->tik = 0;
        obj->magic = 0;
}

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

◆ xwos_object_activate()

xwer_t xwos_object_activate	(	struct xwos_object *	obj,
		xwobj_gc_f	gcfunc
	)

激活一个XWOS对象（将其引用计数初始化位1）

参数

[in]	obj	对象指针
[in]	gcfunc	垃圾回收函数：当对象应用计数为0，调用此函数回收资源

返回: 错误码

返回值

XWOK	没有错误
-EOBJACTIVE	对象已激活

<No error

< 所有XWOS的对象都有相同的幻数

<Object active

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

{
        xwer_t rc;
 
        rc = xwaop_teq_then_add(xwsq_t, &obj->refcnt, 0, 1, NULL, NULL);
        if (XWOK == rc) {
                obj->tik = xwos_objtik_get();
                obj->magic = XWOS_OBJ_MAGIC;
                obj->gcfunc = gcfunc;
        } else {
                rc = -EOBJACTIVE;
        }
        return rc;
}

函数调用图:

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

◆ xwos_object_setgc()

void xwos_object_setgc	(	struct xwos_object *	obj,
		xwobj_gc_f	gcfunc
	)

设置XWOS对象的垃圾回收函数

参数

[in]	obj	对象指针
[in]	gcfunc	垃圾回收函数：当对象应用计数为0，调用此函数回收资源

< 所有XWOS的对象都有相同的幻数

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

{
        if (XWOS_OBJ_MAGIC == obj->magic) {
                obj->gcfunc = gcfunc;
        }
}

◆ xwos_object_acquire()

xwer_t xwos_object_acquire	(	struct xwos_object *	obj,
		xwsq_t	tik
	)

检查对象的标签并增加引用计数

参数

[in]	obj	对象指针
[in]	tik	标签

返回: 错误码

返回值

XWOK	没有错误
-ENILOBJD	空的对象描述符
-EOBJDEAD	对象无效
-EACCES	对象标签检查失败

<Nil object descriptor

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

{
        xwobj_d objd = {obj, tik};
        xwer_t rc;
 
        if ((NULL == obj) || ((xwsq_t)0 == tik)) {
                rc = -ENILOBJD;
        } else {
                rc = xwaop_tst_then_op(xwsq_t, &obj->refcnt,
                                       xwos_object_acquire_refaop_tst, &objd,
                                       xwos_object_acquire_refaop_op, &objd,
                                       NULL, NULL);
        }
        return rc;
}

函数调用图:

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

◆ xwos_object_release()

xwer_t xwos_object_release	(	struct xwos_object *	obj,
		xwsq_t	tik
	)

检查对象的标签并减少引用计数

参数

[in]	obj	对象指针
[in]	tik	标签

返回: 错误码

返回值

XWOK	没有错误
-ENILOBJD	空的对象描述符
-EOBJDEAD	对象无效
-EACCES	对象标签检查失败

<Nil object descriptor

<No error

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

{
        xwobj_d objd = {obj, tik};
        xwsq_t nv;
        xwer_t rc;
 
        if ((NULL == obj) || ((xwsq_t)0 == tik)) {
                rc = -ENILOBJD;
        } else {
                rc = xwaop_tst_then_op(xwsq_t, &obj->refcnt,
                                       xwos_object_release_refaop_tst, &objd,
                                       xwos_object_release_refaop_op, &objd,
                                       &nv, NULL);
                if (XWOK == rc) {
                        if ((xwsq_t)0 == nv) {
                                if (NULL != obj->gcfunc) {
                                        rc = obj->gcfunc(obj);
                                }
                        }
                }
        }
        return rc;
}

函数调用图:

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

◆ xwos_object_grab()

xwer_t xwos_object_grab ( struct xwos_object * obj )

增加对象的引用计数

参数

[in] obj 对象指针

返回: 错误码

返回值

XWOK	没有错误
-EOBJDEAD	对象已销毁

<Object dead

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

{
        xwer_t rc;
 
        rc = xwaop_tge_then_add(xwsq_t, &obj->refcnt, 1, 1, NULL, NULL);
        if (rc < 0) {
                rc = -EOBJDEAD;
        }
        return rc;
}

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

◆ xwos_object_put()

xwer_t xwos_object_put ( struct xwos_object * obj )

减少对象的引用计数

参数

[in] obj 对象指针

返回: 错误码

返回值

XWOK	没有错误
-EOBJDEAD	对象已销毁

<No error

<Object dead

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

{
        xwer_t rc;
        xwsq_t nv;
 
        rc = xwaop_tgt_then_sub(xwsq_t, &obj->refcnt,
                                0, 1,
                                &nv, NULL);
        if (XWOK == rc) {
                if ((xwsq_t)0 == nv) {
                        if (NULL != obj->gcfunc) {
                                rc = obj->gcfunc(obj);
                        }
                }
        } else {
                rc = -EOBJDEAD;
        }
        return rc;
}

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

◆ xwos_object_rawput()

xwer_t xwos_object_rawput ( struct xwos_object * obj )

减少对象的引用计数，不触发垃圾回收函数

参数

[in] obj 对象指针

返回: 错误码

返回值

XWOK	没有错误
-EOBJDEAD	对象已销毁

<Object dead

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

{
        xwer_t rc;
 
        rc = xwaop_tgt_then_sub(xwsq_t, &obj->refcnt,
                                0, 1,
                                NULL, NULL);
        if (rc < 0) {
                rc = -EOBJDEAD;
        }
        return rc;
}

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

◆ xwos_object_get_refcnt()

xwsq_t xwos_object_get_refcnt ( struct xwos_object * obj )

获取XWOS对象的引用计数

参数

[in] obj 对象指针

返回: 引用计数

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

{
        return xwaop_load(xwsq_t, &obj->refcnt, xwaop_mo_relaxed);
}

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

结构体

宏定义

类型定义

函数

详细描述

宏定义说明

◆ xwos_cast

◆ XWOS_OBJ_MAGIC

◆ XWOBJ_NILD

类型定义说明

◆ xwobj_gc_f

函数说明

◆ xwos_objtik_init()

◆ xwos_object_construct()

◆ xwos_object_destruct()

◆ xwos_object_activate()

◆ xwos_object_setgc()

◆ xwos_object_acquire()

◆ xwos_object_release()

◆ xwos_object_grab()

◆ xwos_object_put()

◆ xwos_object_rawput()

◆ xwos_object_get_refcnt()