page.c 文件参考

XWOS内存管理：内存池：页分配器 更多...

#include <xwos/standard.h>
#include <xwos/lib/rbtree.h>
#include <xwos/lib/bclst.h>
#include <xwos/lib/xwbop.h>
#include <xwos/osal/lock/seqlock.h>
#include <xwos/mm/common.h>
#include <xwos/mm/mempool/i_allocator.h>
#include <xwos/mm/mempool/page.h>

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

浏览源代码.

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

函数
static xwer_t	xwmm_mempool_page_i_a_malloc (void *this, xwsz_t size, void **membuf)
	i_allocator接口函数：申请内存
static xwer_t	xwmm_mempool_page_i_a_free (void *this, void *mem)
	i_allocator接口函数：释放内存
static void	xwmm_mempool_page_divide_page (struct xwmm_mempool_page_allocator *pa, struct xwmm_mempool_page *pg, xwsq_t target_odr, struct xwmm_mempool_page_odrbtree *ot)
	将大的页拆分成小的页
static void	xwmm_mempool_page_combine (struct xwmm_mempool_page_allocator *pa, struct xwmm_mempool_page *pg)
	合并空闲的伙伴页
static xwer_t	xwmm_mempool_page_odrbtree_add (struct xwmm_mempool_page_odrbtree *ot, struct xwmm_mempool_page *pg)
	增加页到阶红黑树中
static xwer_t	xwmm_mempool_page_odrbtree_remove (struct xwmm_mempool_page_odrbtree *ot, struct xwmm_mempool_page *pg)
	从阶红黑树中删除页
static struct xwmm_mempool_page *	xwmm_mempool_page_odrbtree_choose (struct xwmm_mempool_page_odrbtree *ot)
	从阶红黑树中选择一页
static xwsq_t	xwmm_mempool_page_get_seq (struct xwmm_mempool_page_allocator *pa, struct xwmm_mempool_page *pg)
	获取页的序列值
static struct xwmm_mempool_page *	xwmm_mempool_mem_to_page (struct xwmm_mempool_page_allocator *pa, void *mem)
	从页内存地址获得其页控制块的指针
static struct xwmm_mempool_page *	xwmm_mempool_page_get_buddy (struct xwmm_mempool_page_allocator *pa, struct xwmm_mempool_page *pg)
	找到页的伙伴页
xwer_t	xwmm_mempool_page_allocator_init (struct xwmm_mempool_page_allocator *pa, const char *name, xwptr_t origin, xwsz_t size, xwsz_t pgsize, struct xwmm_mempool_page_odrbtree *odrbtree, struct xwmm_mempool_page *pgarray)
	XWMM API：初始化页分配器
xwer_t	xwmm_mempool_page_allocate (struct xwmm_mempool_page_allocator *pa, xwsq_t order, struct xwmm_mempool_page **pgbuf)
	XWMM API：申请一页内存
xwer_t	xwmm_mempool_page_free (struct xwmm_mempool_page_allocator *pa, struct xwmm_mempool_page *pg)
	XWMM API：释放一页内存
xwer_t	xwmm_mempool_page_find (struct xwmm_mempool_page_allocator *pa, void *mem, struct xwmm_mempool_page **pgbuf)
	依据内存地址查找页

详细描述

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/.

在文件 page.c 中定义.

宏定义说明

xwmm_mempoollogf

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

< 调试日志开关

在文件 page.c 第 27 行定义.

函数说明

xwmm_mempool_mem_to_page()

static struct xwmm_mempool_page * xwmm_mempool_mem_to_page ( struct xwmm_mempool_page_allocator *  pa, void *  mem  )

static

从页内存地址获得其页控制块的指针

参数

[in]	pa	页分配器的指针
[in]	mem	内存块的首地址

返回

页的控制块指针

在文件 page.c 第 477 行定义.

{
        xwsq_t seq;
        xwptr_t offset;
        struct xwmm_mempool_page * pg;
 
        offset = (xwptr_t)mem - pa->zone.origin;
        seq = offset / pa->pgsize;
        pg = &pa->pgarray[seq];
        return pg;
}

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

xwmm_mempool_page_combine()

static void xwmm_mempool_page_combine ( struct xwmm_mempool_page_allocator *  pa, struct xwmm_mempool_page *  pg  )

static

合并空闲的伙伴页

参数

[in]	pa	页分配器的指针
[in]	pg	页控制块的指针

在文件 page.c 第 252 行定义.

{
        struct xwmm_mempool_page * buddy;
        xwsq_t odr;
        xwer_t rc;
 
        odr = pg->order + 1U;
        while (odr < pa->max_order) {
                buddy = xwmm_mempool_page_get_buddy(pa, pg);
                /* `buddy->order` 不能在临界区外使用，
                   因为 `buddy` 在阶红黑树上时，是共享数据。
                   但可以使用 `pg->order` ，因为 `pg` 还未加入到阶红黑树，是本地数据。*/
                rc = xwmm_mempool_page_odrbtree_remove(&pa->odrbtree[pg->order], buddy);
                if (rc < 0) {
                        break;
                }
                if (buddy > pg) {
                        buddy->order = XWMM_MEMPOOL_PAGE_ORDER_CMB;
                        pg->order = odr;
                } else {
                        pg->order = XWMM_MEMPOOL_PAGE_ORDER_CMB;
                        buddy->order = odr;
                        pg = buddy;
                }
                odr++;
        }
        odr = pg->order;
        // cppcheck-suppress [misra-c2012-17.7]
        xwmm_mempool_page_odrbtree_add(&pa->odrbtree[odr], pg);
}

函数调用图:

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

xwmm_mempool_page_divide_page()

static void xwmm_mempool_page_divide_page ( struct xwmm_mempool_page_allocator *  pa, struct xwmm_mempool_page *  pg, xwsq_t  target_odr, struct xwmm_mempool_page_odrbtree *  ot  )

static

将大的页拆分成小的页

参数

[in]	pa	页分配器的指针
[in]	pg	被拆分的页控制块的指针
[in]	target_odr	目标页数量的阶
[in]	ot	被拆分的页所在的阶红黑树的指针

在文件 page.c 第 222 行定义.

{
        xwsq_t pg_odr;
        xwsq_t pg_seq;
        xwsq_t pg_offset;
        struct xwmm_mempool_page * buddy;
 
        pg_odr = pg->order;
        pg_seq = pg->attr.free.seq;
        pg_offset = 1U << pg_odr;
        while (pg_odr > target_odr) {
                ot--;
                pg_odr--;
                pg_offset >>= 1;
                buddy = &pa->pgarray[pg_seq + pg_offset];
                // cppcheck-suppress [misra-c2012-17.7]
                xwmm_mempool_page_odrbtree_add(ot, buddy);
                pg->order = pg_odr;
        }
}

函数调用图:

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

xwmm_mempool_page_get_buddy()

static struct xwmm_mempool_page * xwmm_mempool_page_get_buddy ( struct xwmm_mempool_page_allocator *  pa, struct xwmm_mempool_page *  pg  )

static

找到页的伙伴页

参数

[in]	pa	页分配器的指针
[in]	pg	页控制块的指针

返回

伙伴页控制块的指针

在文件 page.c 第 497 行定义.

{
        xwsq_t seq;
        xwsq_t odr;
 
        seq = pg->attr.free.seq;
        odr = pg->order;
        seq ^= (1U << odr);
        return &pa->pgarray[seq];
}

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

xwmm_mempool_page_get_seq()

static xwsq_t xwmm_mempool_page_get_seq ( struct xwmm_mempool_page_allocator *  pa, struct xwmm_mempool_page *  pg  )

static

获取页的序列值

参数

[in]	pa	页分配器的指针
[in]	pg	页控制块的指针

返回

序列值

在文件 page.c 第 459 行定义.

{
        xwsq_t offset;
 
        offset = (xwsq_t)((xwptr_t)pg - (xwptr_t)(pa->pgarray));
        offset /= (xwsq_t)sizeof(struct xwmm_mempool_page);
        return offset;
}

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

xwmm_mempool_page_i_a_free()

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

static

i_allocator接口函数：释放内存

参数

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

返回

错误码

返回值

XWOK	没有错误
-ENOMEM	内存不足

<No error

在文件 page.c 第 580 行定义.

{
        struct xwmm_mempool_page_allocator * pa;
        struct xwmm_mempool_page * pg;
        xwer_t rc;
 
        pa = this;
 
        if (((xwptr_t)mem < pa->zone.origin) ||
            (((xwptr_t)mem - pa->zone.origin) >= (xwptr_t)pa->zone.size)) {
                rc = -ERANGE;
                goto err_range;
        }
 
        pg = xwmm_mempool_mem_to_page(pa, mem);
        rc = xwmm_mempool_page_free(pa, pg);
        if (rc < 0) {
                goto err_page_free;
        }
        return XWOK;
 
err_page_free:
err_range:
        return rc;
}

函数调用图:

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

xwmm_mempool_page_i_a_malloc()

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

static

i_allocator接口函数：申请内存

参数

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

返回

错误码

返回值

XWOK	没有错误
-ENOMEM	内存不足

<No error

在文件 page.c 第 549 行定义.

{
        struct xwmm_mempool_page_allocator * pa;
        struct xwmm_mempool_page * pg;
        xwssq_t order;
        xwsz_t nr;
        xwer_t rc;
 
        pa = this;
        nr = size / pa->pgsize;
        order = xwbop_fls(xwsz_t, nr);
        if ((order < 0) || ((pa->pgsize << (xwsz_t)order) < size)) {
                order++;
        }
        rc = xwmm_mempool_page_allocate(pa, (xwsq_t)order, &pg);
        if (XWOK == rc) {
                pg->data.value = size;
                *membuf = (void *)pg->mapping;
        }
        return rc;
}

函数调用图:

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

xwmm_mempool_page_odrbtree_add()

static xwer_t xwmm_mempool_page_odrbtree_add ( struct xwmm_mempool_page_odrbtree *  ot, struct xwmm_mempool_page *  pg  )

static

增加页到阶红黑树中

参数

[in]	ot	阶红黑树的指针
[in]	pg	页控制块的指针

返回

错误码

返回值

XWOK	没有错误
-EEXIST	页已在阶红黑树中

< 报告BUG

<No error

在文件 page.c 第 293 行定义.

{
        struct xwlib_rbtree * tree;
        struct xwlib_rbtree_node ** new;
        xwptr_t lpc;
        struct xwlib_rbtree_node * rbn;
        xwsq_t pgseq;
        struct xwmm_mempool_page * b;
        struct xwmm_mempool_page * leftmost;
        xwreg_t flag;
        xwer_t rc;
 
        tree = &ot->tree;
        pgseq = pg->attr.free.seq;
        /* 即将加入的页不在阶红黑树中，是本地数据，对 `pg->mapping` 的读可在锁外。*/
        if (XWMM_MEMPOOL_PAGE_MAPPING_FREE == pg->mapping) {
                rc = -EEXIST;
                goto err_exist;
        }
 
        pg->order = ot->order;
        xwos_sqlk_wr_lock_cpuirqsv(&ot->lock, &flag);
        /* 当页被加入到阶红黑树中，就变成共享数据，对 `pg->mapping` 的写只在锁内。*/
        pg->mapping = XWMM_MEMPOOL_PAGE_MAPPING_FREE;
        new = &tree->root;
        lpc = (xwptr_t)new;
        leftmost = ot->leftmost;
        if (NULL == leftmost) { /* rbtree is empty. */
                ot->leftmost = pg;
        } else if (pgseq < leftmost->attr.free.seq) {
                new = &(leftmost->attr.free.rbnode.left);
                lpc = (xwptr_t)new;
                ot->leftmost = pg;
        } else {
                rbn = *new;
                while (NULL != rbn) {
                        b = xwlib_rbtree_entry(rbn, struct xwmm_mempool_page,
                                               attr.free.rbnode);
                        if (pgseq < b->attr.free.seq) {
                                new = &rbn->left;
                                lpc = (xwptr_t)new;
                                rbn = rbn->left;
                        } else if (pgseq > b->attr.free.seq) {
                                new = &rbn->right;
                                lpc = (xwptr_t)new | (xwptr_t)XWLIB_RBTREE_POS_RIGHT;
                                rbn = rbn->right;
                        } else {
                                XWOS_BUG();
                        }
                }
        }
        xwlib_rbtree_link(&pg->attr.free.rbnode, lpc);
        xwlib_rbtree_insert_color(tree, &pg->attr.free.rbnode);
        xwos_sqlk_wr_unlock_cpuirqrs(&ot->lock, flag);
        return XWOK;
 
err_exist:
        return rc;
}

函数调用图:

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

xwmm_mempool_page_odrbtree_choose()

static struct xwmm_mempool_page * xwmm_mempool_page_odrbtree_choose ( struct xwmm_mempool_page_odrbtree *  ot )

static

从阶红黑树中选择一页

参数

[in]

ot

阶红黑树的指针

返回

页控制块的指针或空指针

在文件 page.c 第 416 行定义.

{
        struct xwmm_mempool_page * leftmost;
        xwreg_t flag;
        struct xwlib_rbtree * tree;
        struct xwlib_rbtree_node * s;
 
        tree = &ot->tree;
        xwos_sqlk_wr_lock_cpuirqsv(&ot->lock, &flag);
        leftmost = ot->leftmost;
        if (NULL == leftmost) {
                xwos_sqlk_wr_unlock_cpuirqrs(&ot->lock, flag);
                goto err_empty;
        }
        /* 即将被选择的页在阶红黑树中，是共享数据。对 `pg->mapping` 的写只可在锁内。*/
        leftmost->mapping = XWMM_MEMPOOL_PAGE_MAPPING_INVAILD;
        s = leftmost->attr.free.rbnode.right;
        if (NULL == s) {
                s = xwlib_rbtree_get_parent(&leftmost->attr.free.rbnode);
        }
        if (s != (struct xwlib_rbtree_node *)&tree->root) {
                ot->leftmost = xwlib_rbtree_entry(s, struct xwmm_mempool_page,
                                                  attr.free.rbnode);
        } else {
                ot->leftmost = NULL;
        }
        xwlib_rbtree_remove(tree, &leftmost->attr.free.rbnode);
        xwos_sqlk_wr_unlock_cpuirqrs(&ot->lock, flag);
 
        xwlib_rbtree_init_node(&leftmost->attr.free.rbnode);
        return leftmost;
 
err_empty:
        return NULL;
}

函数调用图:

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

xwmm_mempool_page_odrbtree_remove()

static xwer_t xwmm_mempool_page_odrbtree_remove ( struct xwmm_mempool_page_odrbtree *  ot, struct xwmm_mempool_page *  pg  )

static

从阶红黑树中删除页

参数

[in]	ot	阶红黑树的指针
[in]	pg	页控制块的指针

返回

错误码

返回值

XWOK	没有错误
-ESRCH	页不在阶红黑树中
-EBUSY	页不在阶红黑树中

<No error

在文件 page.c 第 364 行定义.

{
        struct xwlib_rbtree * tree;
        struct xwlib_rbtree_node * s;
        xwreg_t flag;
        xwer_t rc;
 
        tree = &ot->tree;
        if (pg->order != ot->order) {
                rc = -ESRCH;
                goto err_odrerr;
        }
 
        xwos_sqlk_wr_lock_cpuirqsv(&ot->lock, &flag);
        /* 即将被删除的页在阶红黑树中，是共享数据。对 `pg->mapping` 的读只可在锁内。*/
        if (XWMM_MEMPOOL_PAGE_MAPPING_FREE != pg->mapping) {
                rc = -EBUSY;
                goto err_notfree;
        }
        pg->mapping = XWMM_MEMPOOL_PAGE_MAPPING_INVAILD;
        if (pg == ot->leftmost) {
                s = pg->attr.free.rbnode.right;
                if (NULL == s) {
                        s = xwlib_rbtree_get_parent(&pg->attr.free.rbnode);
                }
                if (s != (struct xwlib_rbtree_node *)&tree->root) {
                        ot->leftmost = xwlib_rbtree_entry(s,
                                                          struct xwmm_mempool_page,
                                                          attr.free.rbnode);
                } else {
                        ot->leftmost = NULL;
                }
        }
        xwlib_rbtree_remove(tree, &pg->attr.free.rbnode);
        xwos_sqlk_wr_unlock_cpuirqrs(&ot->lock, flag);
        xwlib_rbtree_init_node(&pg->attr.free.rbnode);
        return XWOK;
 
err_notfree:
        xwos_sqlk_wr_unlock_cpuirqrs(&ot->lock, flag);
err_odrerr:
        return rc;
}

函数调用图:

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