1 /* 2 * Copyright (c) 2013-2019 Huawei Technologies Co., Ltd. All rights reserved. 3 * Copyright (c) 2020-2021 Huawei Device Co., Ltd. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without modification, 6 * are permitted provided that the following conditions are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright notice, this list of 9 * conditions and the following disclaimer. 10 * 11 * 2. Redistributions in binary form must reproduce the above copyright notice, this list 12 * of conditions and the following disclaimer in the documentation and/or other materials 13 * provided with the distribution. 14 * 15 * 3. Neither the name of the copyright holder nor the names of its contributors may be used 16 * to endorse or promote products derived from this software without specific prior written 17 * permission. 18 * 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 21 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 23 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 24 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 25 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 26 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 27 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 28 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 29 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 */ 31 32 #ifndef _LOS_STACK_INFO_PRI_H 33 #define _LOS_STACK_INFO_PRI_H 34 35 #include "los_typedef.h" 36 #include "arch_config.h" 37 38 #ifdef __cplusplus 39 #if __cplusplus 40 extern "C" { 41 #endif /* __cplusplus */ 42 #endif /* __cplusplus */ 43 44 typedef struct { 45 VOID *stackTop; 46 UINT32 stackSize; 47 CHAR *stackName; 48 } StackInfo; 49 50 #define OS_INVALID_WATERLINE 0xFFFFFFFF 51 #define OS_STACK_MAGIC_CHECK(topstack) (*(UINTPTR *)(topstack) == OS_STACK_MAGIC_WORD) /* 1:magic valid 0:invalid */ 52 53 extern VOID OsExcStackInfo(VOID); 54 extern VOID OsExcStackInfoReg(const StackInfo *stackInfo, UINT32 stackNum); 55 extern VOID OsStackInit(VOID *stacktop, UINT32 stacksize); 56 57 /** 58 * @ingroup los_task 59 * @brief Get stack waterline. 60 * 61 * @par Description: 62 * This API is used to get stack waterline size and check stack whether overflow. 63 * 64 * @attention None 65 * 66 * @param stackBottom [IN] Type #const UINTPTR * pointer to stack bottom. 67 * @param stackTop [IN] Type #const UINTPTR * pointer to stack top. 68 * @param peakUsed [OUT] Type #UINT32 * stack waterline. 69 * 70 * @retval #LOS_NOK stack overflow 71 * @retval #LOS_OK stack is normal, not overflow 72 * @par Dependency: 73 * <ul><li>los_stackinfo_pri.h: the header file that contains the API declaration.</li></ul> 74 * @see 75 */ 76 extern UINT32 OsStackWaterLineGet(const UINTPTR *stackBottom, const UINTPTR *stackTop, UINT32 *peakUsed); 77 78 #ifdef __cplusplus 79 #if __cplusplus 80 } 81 #endif /* __cplusplus */ 82 #endif /* __cplusplus */ 83 84 #endif /* _LOS_STACK_INFO_PRI_H */ 85