mempool.c

浏览该文件的文档.

/*
 * Copyright (c) 2006-2022, RT-Thread Development Team
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Change Logs:
 * Date           Author       Notes
 * 2006-05-27     Bernard      implement memory pool
 * 2006-06-03     Bernard      fix the thread timer init bug
 * 2006-06-30     Bernard      fix the allocate/free block bug
 * 2006-08-04     Bernard      add hook support
 * 2006-08-10     Bernard      fix interrupt bug in rt_mp_alloc
 * 2010-07-13     Bernard      fix RT_ALIGN issue found by kuronca
 * 2010-10-26     yi.qiu       add module support in rt_mp_delete
 * 2011-01-24     Bernard      add object allocation check.
 * 2012-03-22     Bernard      fix align issue in rt_mp_init and rt_mp_create.
 * 2022-01-07     Gabriel      Moving __on_rt_xxxxx_hook to mempool.c
 * 2023-09-15     xqyjlj       perf rt_hw_interrupt_disable/enable
 * 2023-12-10     xqyjlj       fix spinlock assert
 */
 
#include <rthw.h>
#include <rtthread.h>
 
#ifdef RT_USING_MEMPOOL
 
#if defined(RT_USING_HOOK) && defined(RT_HOOK_USING_FUNC_PTR)
static void (*rt_mp_alloc_hook)(struct rt_mempool *mp, void *block);
static void (*rt_mp_free_hook)(struct rt_mempool *mp, void *block);



void rt_mp_alloc_sethook(void (*hook)(struct rt_mempool *mp, void *block))
{
    rt_mp_alloc_hook = hook;
}

void rt_mp_free_sethook(void (*hook)(struct rt_mempool *mp, void *block))
{
    rt_mp_free_hook = hook;
}

#endif /* RT_USING_HOOK */



rt_err_t rt_mp_init(struct rt_mempool *mp,
                    const char        *name,
                    void              *start,
                    rt_size_t          size,
                    rt_size_t          block_size)
{
    rt_uint8_t *block_ptr;
    rt_size_t offset;
 
    /* parameter check */
    RT_ASSERT(mp != RT_NULL);
    RT_ASSERT(name != RT_NULL);
    RT_ASSERT(start != RT_NULL);
    RT_ASSERT(size > 0 && block_size > 0);
 
    /* initialize object */
    rt_object_init(&(mp->parent), RT_Object_Class_MemPool, name);
 
    /* initialize memory pool */
    mp->start_address = start;
    mp->size = RT_ALIGN_DOWN(size, RT_ALIGN_SIZE);
 
    /* align the block size */
    block_size = RT_ALIGN(block_size, RT_ALIGN_SIZE);
    mp->block_size = block_size;
 
    /* align to align size byte */
    mp->block_total_count = mp->size / (mp->block_size + sizeof(rt_uint8_t *));
    mp->block_free_count  = mp->block_total_count;
 
    /* initialize suspended thread list */
    rt_list_init(&(mp->suspend_thread));
 
    /* initialize free block list */
    block_ptr = (rt_uint8_t *)mp->start_address;
    for (offset = 0; offset < mp->block_total_count; offset ++)
    {
        *(rt_uint8_t **)(block_ptr + offset * (block_size + sizeof(rt_uint8_t *))) =
            (rt_uint8_t *)(block_ptr + (offset + 1) * (block_size + sizeof(rt_uint8_t *)));
    }
 
    *(rt_uint8_t **)(block_ptr + (offset - 1) * (block_size + sizeof(rt_uint8_t *))) =
        RT_NULL;
 
    mp->block_list = block_ptr;
    rt_spin_lock_init(&(mp->spinlock));
 
    return RT_EOK;
}
RTM_EXPORT(rt_mp_init);

rt_err_t rt_mp_detach(struct rt_mempool *mp)
{
    rt_base_t level;
 
    /* parameter check */
    RT_ASSERT(mp != RT_NULL);
    RT_ASSERT(rt_object_get_type(&mp->parent) == RT_Object_Class_MemPool);
    RT_ASSERT(rt_object_is_systemobject(&mp->parent));
 
    level = rt_spin_lock_irqsave(&(mp->spinlock));
    /* wake up all suspended threads */
    rt_susp_list_resume_all(&mp->suspend_thread, RT_ERROR);
 
    /* detach object */
    rt_object_detach(&(mp->parent));
    rt_spin_unlock_irqrestore(&(mp->spinlock), level);
 
    return RT_EOK;
}
RTM_EXPORT(rt_mp_detach);
 
#ifdef RT_USING_HEAP
rt_mp_t rt_mp_create(const char *name,
                     rt_size_t   block_count,
                     rt_size_t   block_size)
{
    rt_uint8_t *block_ptr;
    struct rt_mempool *mp;
    rt_size_t offset;
 
    RT_DEBUG_NOT_IN_INTERRUPT;
 
    /* parameter check */
    RT_ASSERT(name != RT_NULL);
    RT_ASSERT(block_count > 0 && block_size > 0);
 
    /* allocate object */
    mp = (struct rt_mempool *)rt_object_allocate(RT_Object_Class_MemPool, name);
    /* allocate object failed */
    if (mp == RT_NULL)
        return RT_NULL;
 
    /* initialize memory pool */
    block_size     = RT_ALIGN(block_size, RT_ALIGN_SIZE);
    mp->block_size = block_size;
    mp->size       = (block_size + sizeof(rt_uint8_t *)) * block_count;
 
    /* allocate memory */
    mp->start_address = rt_malloc((block_size + sizeof(rt_uint8_t *)) *
                                  block_count);
    if (mp->start_address == RT_NULL)
    {
        /* no memory, delete memory pool object */
        rt_object_delete(&(mp->parent));
 
        return RT_NULL;
    }
 
    mp->block_total_count = block_count;
    mp->block_free_count  = mp->block_total_count;
 
    /* initialize suspended thread list */
    rt_list_init(&(mp->suspend_thread));
 
    /* initialize free block list */
    block_ptr = (rt_uint8_t *)mp->start_address;
    for (offset = 0; offset < mp->block_total_count; offset ++)
    {
        *(rt_uint8_t **)(block_ptr + offset * (block_size + sizeof(rt_uint8_t *)))
            = block_ptr + (offset + 1) * (block_size + sizeof(rt_uint8_t *));
    }
 
    *(rt_uint8_t **)(block_ptr + (offset - 1) * (block_size + sizeof(rt_uint8_t *)))
        = RT_NULL;
 
    mp->block_list = block_ptr;
    rt_spin_lock_init(&(mp->spinlock));
 
    return mp;
}
RTM_EXPORT(rt_mp_create);

rt_err_t rt_mp_delete(rt_mp_t mp)
{
    rt_base_t level;
 
    RT_DEBUG_NOT_IN_INTERRUPT;
 
    /* parameter check */
    RT_ASSERT(mp != RT_NULL);
    RT_ASSERT(rt_object_get_type(&mp->parent) == RT_Object_Class_MemPool);
    RT_ASSERT(rt_object_is_systemobject(&mp->parent) == RT_FALSE);
 
    level = rt_spin_lock_irqsave(&(mp->spinlock));
    /* wake up all suspended threads */
    rt_susp_list_resume_all(&mp->suspend_thread, RT_ERROR);
 
    rt_spin_unlock_irqrestore(&(mp->spinlock), level);
 
    /* release allocated room */
    rt_free(mp->start_address);
 
    /* detach object */
    rt_object_delete(&(mp->parent));
 
    return RT_EOK;
}
RTM_EXPORT(rt_mp_delete);
#endif /* RT_USING_HEAP */

void *rt_mp_alloc(rt_mp_t mp, rt_int32_t time)
{
    rt_uint8_t *block_ptr;
    rt_base_t level;
    struct rt_thread *thread;
    rt_uint32_t before_sleep = 0;
 
    /* parameter check */
    RT_ASSERT(mp != RT_NULL);
 
    /* get current thread */
    thread = rt_thread_self();
 
    level = rt_spin_lock_irqsave(&(mp->spinlock));
 
    while (mp->block_free_count == 0)
    {
        /* memory block is unavailable. */
        if (time == 0)
        {
            rt_spin_unlock_irqrestore(&(mp->spinlock), level);
 
            rt_set_errno(-RT_ETIMEOUT);
 
            return RT_NULL;
        }
 
        RT_DEBUG_NOT_IN_INTERRUPT;
 
        thread->error = RT_EOK;
 
        /* need suspend thread */
        rt_thread_suspend_to_list(thread, &mp->suspend_thread, RT_IPC_FLAG_FIFO, RT_UNINTERRUPTIBLE);
 
        if (time > 0)
        {
            /* get the start tick of timer */
            before_sleep = rt_tick_get();
 
            /* init thread timer and start it */
            rt_timer_control(&(thread->thread_timer),
                             RT_TIMER_CTRL_SET_TIME,
                             &time);
            rt_timer_start(&(thread->thread_timer));
        }
 
        /* enable interrupt */
        rt_spin_unlock_irqrestore(&(mp->spinlock), level);
 
        /* do a schedule */
        rt_schedule();
 
        if (thread->error != RT_EOK)
            return RT_NULL;
 
        if (time > 0)
        {
            time -= rt_tick_get() - before_sleep;
            if (time < 0)
                time = 0;
        }
        level = rt_spin_lock_irqsave(&(mp->spinlock));
    }
 
    /* memory block is available. decrease the free block counter */
    mp->block_free_count--;
 
    /* get block from block list */
    block_ptr = mp->block_list;
    RT_ASSERT(block_ptr != RT_NULL);
 
    /* Setup the next free node. */
    mp->block_list = *(rt_uint8_t **)block_ptr;
 
    /* point to memory pool */
    *(rt_uint8_t **)block_ptr = (rt_uint8_t *)mp;
 
    rt_spin_unlock_irqrestore(&(mp->spinlock), level);
 
    RT_OBJECT_HOOK_CALL(rt_mp_alloc_hook,
                        (mp, (rt_uint8_t *)(block_ptr + sizeof(rt_uint8_t *))));
 
    return (rt_uint8_t *)(block_ptr + sizeof(rt_uint8_t *));
}
RTM_EXPORT(rt_mp_alloc);

void rt_mp_free(void *block)
{
    rt_uint8_t **block_ptr;
    struct rt_mempool *mp;
    rt_base_t level;
 
    /* parameter check */
    if (block == RT_NULL) return;
 
    /* get the control block of pool which the block belongs to */
    block_ptr = (rt_uint8_t **)((rt_uint8_t *)block - sizeof(rt_uint8_t *));
    mp        = (struct rt_mempool *)*block_ptr;
 
    RT_OBJECT_HOOK_CALL(rt_mp_free_hook, (mp, block));
 
    level = rt_spin_lock_irqsave(&(mp->spinlock));
 
    /* increase the free block count */
    mp->block_free_count ++;
 
    /* link the block into the block list */
    *block_ptr = mp->block_list;
    mp->block_list = (rt_uint8_t *)block_ptr;
 
    if (rt_susp_list_dequeue(&mp->suspend_thread, RT_EOK))
    {
        rt_spin_unlock_irqrestore(&(mp->spinlock), level);
 
        /* do a schedule */
        rt_schedule();
 
        return;
    }
    rt_spin_unlock_irqrestore(&(mp->spinlock), level);
}
RTM_EXPORT(rt_mp_free);

 
#endif /* RT_USING_MEMPOOL */