1 /* 2 * Copyright (c) 2022-2022 Huawei Device Co., Ltd. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without modification, 5 * are permitted provided that the following conditions are met: 6 * 7 * 1. Redistributions of source code must retain the above copyright notice, this list of 8 * conditions and the following disclaimer. 9 * 10 * 2. Redistributions in binary form must reproduce the above copyright notice, this list 11 * of conditions and the following disclaimer in the documentation and/or other materials 12 * provided with the distribution. 13 * 14 * 3. Neither the name of the copyright holder nor the names of its contributors may be used 15 * to endorse or promote products derived from this software without specific prior written 16 * permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 20 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 21 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 22 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 23 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 24 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 25 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 26 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 27 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 28 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31 #ifndef _LOS_DEBUGTOOLS_H 32 #define _LOS_DEBUGTOOLS_H 33 34 #include "los_config.h" 35 #include "los_task.h" 36 37 #ifdef __cplusplus 38 #if __cplusplus 39 extern "C" { 40 #endif /* __cplusplus */ 41 #endif /* __cplusplus */ 42 43 44 /* StackDump print format */ 45 #define PRINT_PER_ROW 4 46 47 /* SchedTrace records number */ 48 #define TRACE_NUM 200 49 50 /* sched trace info, users can add their own */ 51 typedef struct { 52 UINT32 newTaskID; 53 CHAR newTaskName[LOS_TASK_NAMELEN]; 54 UINT32 runTaskID; 55 CHAR runTaskName[LOS_TASK_NAMELEN]; 56 } SchedTraceInfo; 57 58 /* SchedTrace record callback */ 59 typedef void (*SchedTraceRecordCB)(LosTaskCB *newTask, LosTaskCB *runTask); 60 61 /* SchedTrace show callback, buf is overwrite ringbuf, max amount of storage is TRACE_NUM */ 62 typedef void (*SchedTraceShowCB)(SchedTraceInfo *ringBuf, UINT32 count); 63 64 /* Shell callback */ 65 extern UINT32 OsShellCmdStackDump(INT32 argc, const CHAR **argv); 66 extern UINT32 OsShellCmdHwiDump(INT32 argc, const CHAR **argv); 67 extern UINT32 OsShellCmdSchedTrace(INT32 argc, const CHAR **argv); 68 69 /* Other module callback */ 70 extern VOID OsSchedTraceRecord(LosTaskCB *newTask, LosTaskCB *runTask); 71 72 /* External interface */ 73 /* dump stack by task id, can be called at any time */ 74 extern VOID LOS_TaskStackDump(UINT32 taskID); 75 76 /* register sched trace handle, If not registered, the default fun will be used */ 77 extern VOID LOS_SchedTraceHandleRegister(SchedTraceRecordCB recordCB, SchedTraceShowCB showCB); 78 /* start sched trace, will alloc buf, and start write to buf when sched */ 79 extern VOID LOS_SchedTraceStart(VOID); 80 /* stop sched trace, will stop record and free buf */ 81 extern VOID LOS_SchedTraceStop(VOID); 82 83 #ifdef __cplusplus 84 #if __cplusplus 85 } 86 #endif /* __cplusplus */ 87 #endif /* __cplusplus */ 88 89 #endif 90