los_memory.h

浏览该文件的文档.

/* ----------------------------------------------------------------------------
 * Copyright (c) Huawei Technologies Co., Ltd. 2013-2019. All rights reserved.
 * Description: LiteOS Mem Module HeadFile
 * Author: Huawei LiteOS Team
 * Create: 2013-01-01
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 * 1. Redistributions of source code must retain the above copyright notice, this list of
 * conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
 * of conditions and the following disclaimer in the documentation and/or other materials
 * provided with the distribution.
 * 3. Neither the name of the copyright holder nor the names of its contributors may be used
 * to endorse or promote products derived from this software without specific prior written
 * permission.
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * --------------------------------------------------------------------------- */
 
#ifndef _LOS_MEMORY_H
#define _LOS_MEMORY_H
 
#include "los_config.h"
#include "los_base.h"
#include "los_toolchain.h"
#include "los_membox.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#define OS_MEM_ALIGN(p, alignSize)   (((UINTPTR)(p) + (alignSize) - 1) & ~((UINTPTR)((alignSize) - 1)))
#define OS_MEM_ALIGN_SIZE   (sizeof(UINTPTR))
 
typedef VOID (*MALLOC_HOOK)(VOID);
 
extern MALLOC_HOOK g_MALLOC_HOOK;
 
extern UINT8 *m_aucSysMem0;
 
extern UINT8 *m_aucSysMem1;
 
#define MEM_MODULE_MAX 0x20
 
extern VOID *LOS_MemMalloc(VOID *pool, UINT32 size, UINT32 moduleId);
 
extern VOID *LOS_MemMallocAlign(VOID *pool, UINT32 size, UINT32 boundary, UINT32 moduleId);
 
extern UINT32 LOS_MemMfree(VOID *pool, VOID *ptr, UINT32 moduleId);
 
extern VOID *LOS_MemMrealloc(VOID *pool, VOID *ptr, UINT32 size, UINT32 moduleId);
 
extern UINT32 LOS_MemMusedGet(UINT32 moduleId);
 
extern UINT32 LOS_MemDeInit(VOID *pool);
 
extern UINT32 LOS_MemPoolList(VOID);
 
typedef struct {
    UINT32 uwTotalUsedSize;
    UINT32 uwTotalFreeSize;
    UINT32 uwMaxFreeNodeSize;
    UINT32 uwUsedNodeNum;
    UINT32 uwFreeNodeNum;
#ifdef LOSCFG_MEM_TASK_STAT
    UINT32 uwUsageWaterLine;  
#endif
} LOS_MEM_POOL_STATUS;
 
#define LOS_MEM_INIT_ATTR_SLAB_POS 0U
#define LOS_MEM_INIT_ATTR_SLAB_MSK 1U /* << LOS_MEM_INIT_ATTR_SLAB_POS */
 
extern UINT32 LOS_MemPoolInit(VOID *pool, UINT32 size, UINT32 attr);
 
extern UINT32 LOS_MemInit(VOID *pool, UINT32 size);
 
extern VOID *LOS_MemAlloc(VOID *pool, UINT32 size);
 
extern UINT32 LOS_MemFree(VOID *pool, VOID *ptr);
 
extern VOID *LOS_MemRealloc(VOID *pool, VOID *ptr, UINT32 size);
 
extern VOID *LOS_MemAllocAlign(VOID *pool, UINT32 size, UINT32 boundary);
 
extern UINT32 LOS_MemPoolSizeGet(const VOID *pool);
 
extern UINT32 LOS_MemTotalUsedGet(VOID *pool);
 
extern UINT32 LOS_MemFreeBlksGet(VOID *pool);
 
extern UINT32 LOS_MemUsedBlksGet(VOID *pool);
 
extern UINT32 LOS_MemTaskIdGet(const VOID *ptr);
 
extern UINTPTR LOS_MemLastUsedGet(VOID *pool);
 
extern UINT32 LOS_MemInfoGet(VOID *pool, LOS_MEM_POOL_STATUS *poolStatus);
 
extern UINT32 LOS_MemFreeNodeShow(VOID *pool);
 
extern UINT32 LOS_MemIntegrityCheck(const VOID *pool);
 
#ifdef LOSCFG_BASE_MEM_NODE_SIZE_CHECK
extern UINT32 LOS_MemNodeSizeCheck(VOID *pool, VOID *ptr, UINT32 *totalSize, UINT32 *availSize);
 
extern UINT32 LOS_MemCheckLevelSet(UINT8 checkLevel);
 
extern UINT8 LOS_MemCheckLevelGet(VOID);
#endif
 
#define LOS_MEM_CHECK_LEVEL_LOW 0
 
#define LOS_MEM_CHECK_LEVEL_HIGH 1
 
#define LOS_MEM_CHECK_LEVEL_DISABLE 0xff
 
#define LOS_MEM_CHECK_LEVEL_DEFAULT LOS_MEM_CHECK_LEVEL_DISABLE
 
#define LOS_ERRNO_MEMCHECK_PARA_NULL LOS_ERRNO_OS_ERROR(LOS_MOD_MEM, 0x1)
 
#define LOS_ERRNO_MEMCHECK_OUTSIDE LOS_ERRNO_OS_ERROR(LOS_MOD_MEM, 0x2)
 
#define LOS_ERRNO_MEMCHECK_NO_HEAD LOS_ERRNO_OS_ERROR(LOS_MOD_MEM, 0x3)
 
#define LOS_ERRNO_MEMCHECK_WRONG_LEVEL LOS_ERRNO_OS_ERROR(LOS_MOD_MEM, 0x4)
 
#define LOS_ERRNO_MEMCHECK_DISABLED LOS_ERRNO_OS_ERROR(LOS_MOD_MEM, 0x5)
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* _LOS_MEMORY_H */