objcache.c 文件参考

XWOS内存管理：内存池：对象缓存 更多...

#include <xwos/standard.h>
#include <xwos/lib/xwbop.h>
#include <xwos/lib/xwaop.h>
#include <xwos/lib/bclst.h>
#include <xwos/lib/lfq.h>
#include <xwos/osal/lock/seqlock.h>
#include <xwos/mm/common.h>
#include <xwos/mm/mempool/page.h>
#include <xwos/mm/mempool/objcache.h>

objcache.c 的引用(Include)关系图:

浏览源代码.

宏定义
#define	xwmm_mempoollogf(lv, thd, fmt, ...)

函数
static void	xwmm_mempool_objcache_page_init (struct xwmm_mempool_objcache *oc, struct xwmm_mempool_page *pg)
	初始化新页
static xwsz_t	xwmm_mempool_objcache_free_idle_page (struct xwmm_mempool_objcache *oc, xwsz_t nr)
	释放空闲页
static void	xwmm_mempool_objcache_page_put (struct xwmm_mempool_objcache *oc, struct xwmm_mempool_page *pg)
	减少页的引用计数
static xwer_t	xwmm_mempool_objcache_page_get (struct xwmm_mempool_objcache *oc, struct xwmm_mempool_page **pgbuf)
	获取一页，准备从页内存中分配对象
static xwer_t	xwmm_mempool_objcache_i_a_malloc (void *this, xwsz_t size, void **membuf)
	i_allocator接口函数：申请内存
static xwer_t	xwmm_mempool_objcache_i_a_free (void *this, void *mem)
	i_allocator接口函数：释放内存
xwer_t	xwmm_mempool_objcache_init (struct xwmm_mempool_objcache *oc, struct xwmm_mempool_page_allocator *pa, const char *name, xwsz_t objsize, xwsz_t alignment, xwsq_t pg_order, ctor_f ctor, dtor_f dtor)
	XWMM API：初始化对象缓存
xwer_t	xwmm_mempool_objcache_alloc (struct xwmm_mempool_objcache *oc, void **objbuf)
	XWMM API：从对象缓存中申请一个对象
xwer_t	xwmm_mempool_objcache_free (struct xwmm_mempool_objcache *oc, void *obj)
	XWMM API：释放对象到对象缓存中
xwer_t	xwmm_mempool_objcache_reserve (struct xwmm_mempool_objcache *oc, xwsz_t reserved)
	XWMM API：预留对象到对象缓存中
xwer_t	xwmm_mempool_objcache_get_capacity (struct xwmm_mempool_objcache *oc, xwsz_t *capacity)
	XWMM API：获取对象缓存的容量

详细描述

XWOS内存管理：内存池：对象缓存

作者

• 隐星魂 (Roy Sun) xwos@.nosp@m.xwos.nosp@m..tech

版权所有

• Copyright © 2015 xwos.tech, All Rights Reserved.

  ‍This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

在文件 objcache.c 中定义.

宏定义说明

xwmm_mempoollogf

#define xwmm_mempoollogf	(		lv,
			thd,
			fmt,
			...
	)

< 调试日志开关

在文件 objcache.c 第 28 行定义.

函数说明

xwmm_mempool_objcache_free_idle_page()

static xwsz_t xwmm_mempool_objcache_free_idle_page ( struct xwmm_mempool_objcache *  oc, xwsz_t  nr  )

static

释放空闲页

参数

[in]	oc	对象缓存的指针
[in]	nr	期望释放的数量

返回

实际释放的数量

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

{
        struct xwmm_mempool_page * pg;
        xwreg_t flag;
        xwsz_t real;
 
        real = 0;
        while (real < nr) {
                xwos_sqlk_wr_lock_cpuirqsv(&oc->page_list.lock, &flag);
                if (xwlib_bclst_tst_empty(&oc->page_list.idle)) {
                        xwos_sqlk_wr_unlock_cpuirqrs(&oc->page_list.lock, flag);
                        break;
                }
                pg = xwlib_bclst_last_entry(&oc->page_list.idle,
                                            struct xwmm_mempool_page,
                                            attr.objcache.node);
                xwlib_bclst_del_init(&pg->attr.objcache.node);
                xwos_sqlk_wr_unlock_cpuirqrs(&oc->page_list.lock, flag);
                // cppcheck-suppress [misra-c2012-17.7]
                xwmm_mempool_page_free(oc->pa, pg);
                xwaop_sub(xwsz_t, &oc->capacity, oc->pg_objnr, NULL, NULL);
                xwaop_sub(xwsz_t, &oc->idleness, oc->pg_objnr, NULL, NULL);
                real++;
        }
        return real;
}

函数调用图:

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

xwmm_mempool_objcache_i_a_free()

static xwer_t xwmm_mempool_objcache_i_a_free ( void *  this, void *  mem  )

static

i_allocator接口函数：释放内存

参数

[in]	this	this指针(页分配器)
[in]	mem	内存的首地址

返回

错误码

返回值

XWOK	没有错误
-ENOMEM	内存不足

在文件 objcache.c 第 430 行定义.

{
        struct xwmm_mempool_objcache * oc;
        xwer_t rc;
 
        oc = this;
        rc = xwmm_mempool_objcache_free(oc, mem);
        return rc;
}

函数调用图:

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

xwmm_mempool_objcache_i_a_malloc()

static xwer_t xwmm_mempool_objcache_i_a_malloc ( void *  this, xwsz_t  size, void **  membuf  )

static

i_allocator接口函数：申请内存

参数

[in]	this	this指针(页分配器)
[in]	size	申请的大小
[out]	membuf	指向缓冲区的指针，通过此缓冲区返回申请到的内存的首地址

返回

错误码

返回值

XWOK	没有错误
-ENOMEM	内存不足

<Size error

<No error

在文件 objcache.c 第 400 行定义.

{
        struct xwmm_mempool_objcache * oc;
        xwer_t rc;
 
        oc = this;
        if (size > oc->objsize) {
                rc = -ESIZE;
                goto err_size;
        }
        rc = xwmm_mempool_objcache_alloc(oc, membuf);
        if (rc < 0) {
                goto err_alloc;
        }
        return XWOK;
 
err_alloc:
err_size:
        return rc;
}

函数调用图:

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

xwmm_mempool_objcache_page_get()

static xwer_t xwmm_mempool_objcache_page_get ( struct xwmm_mempool_objcache *  oc, struct xwmm_mempool_page **  pgbuf  )

static

获取一页，准备从页内存中分配对象

参数

[in]	oc	对象缓存的指针
[out]	pgbuf	指向缓冲区的指针，通过此缓冲区返回页控制块的指针

返回

错误码

返回值

XWOK	没有错误
-ENOMEM	内存不足

<No error

在文件 objcache.c 第 225 行定义.

{
        struct xwmm_mempool_page * pg;
        xwreg_t flag;
        xwer_t rc;
 
        xwos_sqlk_wr_lock_cpuirqsv(&oc->page_list.lock, &flag);
        if (!xwlib_bclst_tst_empty(&oc->page_list.available)) {
                pg = xwlib_bclst_first_entry(&oc->page_list.available,
                                             struct xwmm_mempool_page,
                                             attr.objcache.node);
                xwlib_bclst_del_init(&pg->attr.objcache.node);
                xwos_sqlk_wr_unlock_cpuirqrs(&oc->page_list.lock, flag);
        } else if (!xwlib_bclst_tst_empty(&oc->page_list.idle)) {
                pg = xwlib_bclst_first_entry(&oc->page_list.idle,
                                             struct xwmm_mempool_page,
                                             attr.objcache.node);
                xwlib_bclst_del_init(&pg->attr.objcache.node);
                xwos_sqlk_wr_unlock_cpuirqrs(&oc->page_list.lock, flag);
        } else {
                xwos_sqlk_wr_unlock_cpuirqrs(&oc->page_list.lock, flag);
                rc = xwmm_mempool_page_allocate(oc->pa, oc->pg_order, &pg);
                if (rc < 0) {
                        goto err_pg_alloc;
                }
                xwaop_add(xwsz_t, &oc->capacity, oc->pg_objnr, NULL, NULL);
                xwaop_add(xwsz_t, &oc->idleness, oc->pg_objnr, NULL, NULL);
                xwmm_mempool_objcache_page_init(oc, pg);
        }
        *pgbuf = pg;
        return XWOK;
 
err_pg_alloc:
        return rc;
}

函数调用图:

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

xwmm_mempool_objcache_page_init()

static void xwmm_mempool_objcache_page_init ( struct xwmm_mempool_objcache *  oc, struct xwmm_mempool_page *  pg  )

static

初始化新页

参数

[in]	oc	对象缓存的指针
[in]	pg	页控制块的指针

在文件 objcache.c 第 115 行定义.

{
        xwsz_t i;
        xwsz_t loop;
        xwptr_t curr;
        xwptr_t next;
 
        xwlib_bclst_init_node(&pg->attr.objcache.node);
        pg->attr.objcache.refcnt = 0;
        pg->data.value = oc->objsize;
 
        /* 构造所有对象 */
        if (NULL != oc->ctor) {
                curr = pg->mapping;
                next = curr;
                loop = oc->pg_objnr;
                for (i = 0; i < loop; i++) {
                        next += oc->objsize;
                        oc->ctor((void *)curr);
                        curr = next;
                }
        }
 
        /* 初始化无锁队列 */
        xwlib_lfq_init(&pg->attr.objcache.objhead);
        curr = pg->mapping;
        next = curr;
        loop = oc->pg_objnr;
        for (i = 0; i < loop; i++) {
                next += oc->objsize;
                xwlib_lfq_init((atomic_xwlfq_t *)curr);
                xwlib_lfq_push(&pg->attr.objcache.objhead,
                               (atomic_xwlfq_t *)curr);
                curr = next;
        }
}

函数调用图:

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

xwmm_mempool_objcache_page_put()

static void xwmm_mempool_objcache_page_put ( struct xwmm_mempool_objcache *  oc, struct xwmm_mempool_page *  pg  )

static

减少页的引用计数

参数

[in]	oc	对象缓存的指针
[in]	pg	页控制块的指针

返回

错误码

返回值

XWOK	没有错误
<0	失败

< 报告BUG

< 当条件x成立时报告BUG

在文件 objcache.c 第 197 行定义.

{
        xwreg_t flag;
 
        xwos_sqlk_wr_lock_cpuirqsv(&oc->page_list.lock, &flag);
        XWOS_BUG_ON((xwsq_t)0 == pg->attr.objcache.refcnt);
        pg->attr.objcache.refcnt--;
        xwlib_bclst_del_init(&pg->attr.objcache.node);
        if ((xwsq_t)0 == pg->attr.objcache.refcnt) {
                xwlib_bclst_add_head(&oc->page_list.idle,
                                     &pg->attr.objcache.node);
        } else {
                xwlib_bclst_add_head(&oc->page_list.available,
                                     &pg->attr.objcache.node);
        }
        xwos_sqlk_wr_unlock_cpuirqrs(&oc->page_list.lock, flag);
}

函数调用图:

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