rt-thread/components/lwp/lwp_memheap.h

/*
 * File      : lwp_memheap.h
 * This file is part of RT-Thread RTOS
 * COPYRIGHT (C) 2006 - 2018, RT-Thread Development Team
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Change Logs:
 * Date           Author       Notes
 */

#ifndef __LWP_MEMHEAP_H__
#define __LWP_MEMHEAP_H__

#include <stdint.h>
#include <rtthread.h>

/**
 * memory item on the heap
 */
struct rt_lwp_memheap_item
{
    rt_uint32_t                 magic;                  /**< magic number for memheap */
    struct rt_lwp_memheap      *pool_ptr;               /**< point of pool */

    struct rt_lwp_memheap_item *next;                   /**< next memheap item */
    struct rt_lwp_memheap_item *prev;                   /**< prev memheap item */

    struct rt_lwp_memheap_item *next_free;              /**< next free memheap item */
    struct rt_lwp_memheap_item *prev_free;              /**< prev free memheap item */
};

/**
 * Base structure of memory heap object
 */
struct rt_lwp_memheap
{
    struct rt_object        parent;                     /**< inherit from rt_object */

    void                   *start_addr;                 /**< pool start address and size */

    rt_uint32_t             pool_size;                  /**< pool size */
    rt_uint32_t             available_size;             /**< available size */
    rt_uint32_t             max_used_size;              /**< maximum allocated size */

    struct rt_lwp_memheap_item *block_list;             /**< used block list */
    struct rt_lwp_memheap_item *free_list;              /**< free block list */
    struct rt_lwp_memheap_item  free_header;            /**< free block list header */

    struct rt_semaphore     lock;                       /**< semaphore lock */

    rt_list_t mlist;
};

extern rt_err_t rt_lwp_memheap_init(struct rt_lwp_memheap *memheap, const char *name, void *start_addr, rt_uint32_t size);
extern void *rt_lwp_memheap_alloc(struct rt_lwp_memheap *heap, rt_uint32_t size);
extern void rt_lwp_memheap_free(void *ptr);
extern void *rt_lwp_memheap_realloc(struct rt_lwp_memheap *heap, void *ptr, rt_size_t newsize);
extern rt_bool_t rt_lwp_memheap_is_empty(struct rt_lwp_memheap *memheap);
extern rt_bool_t rt_lwp_memheap_unavailable_size_get(void);

#endif