/** @file DHL_DBG.h @brief DHL Debug support APIs Copyright 2006~2010 Digital STREAM Technology, Inc. All Rights Reserved */ #ifndef __DHL_DEBUG_API_H__ #define __DHL_DEBUG_API_H__ #include "DHL_OSAL.h" //#include /* for va_list */ #include "bstd_defs.h" /* for va_list */ #include "ministd.h" #ifdef __cplusplus extern "C" { #endif #if COMMENT ____Overview____(){} #endif /** @file DHL_DBG.h 이곳에 이 모듈에 대해 설명이 필요한 각종 내용 기술.. module overview - - APIs implementations dependencies nv parameters */ #if COMMENT ____Config____(){} #endif /* 이 부분은 별도의 DHL_XXX_Config configuration file 을 활용하는 것이 좋을 것 같음. */ #if COMMENT ____Types____(){} #endif #if COMMENT ____Defines____(){} #endif /** @brief 주어진 조건이 true가 아니면 fault 발생. 주어진 조건이 참이 아니면 assert를 발생시킨다. 현재 assert는 인터럽트를 disable 하고 무한대기상태로 빠지는 것이다. @param[in] cond true/false를 판단할 조건. @param[in] msg formatted 텍스트는 입력받지 못함. */ #define DHL_ASSERT(cond, msg) DHL_DBG_GenerateAssert(cond, msg, __FILE__, __LINE__) /** @brief 이 함수는 내부용이다. DHL_ASSERT를 사용하기 바람. */ void DHL_DBG_GenerateAssert(BOOL cond, const char *msg, const char *file, unsigned line); #define DHL_UNUSED(p) (void)p #if COMMENT ____Module_Print____(){} #endif /* cafrii 090721 change if same module_name is specified in different source file, keep previous module level settings. to do this, we first check that 'module' is really new one. */ #if 0 // 아직 ModulePrint가 구현이 안되었을 경우 OS printf를 이용한 임시 구현.. #define DHL_MODULE(str,lvl) \ static int dprint(int level, char *fmt, ...) /* selective print by module level */\ {\ char tmpbuf[200];\ va_list v;\ va_start(v, fmt);\ vsnprintf(tmpbuf, sizeof(tmpbuf)-1, fmt, v);\ DHL_OS_Printf(fmt, v);\ va_end(v);\ return 1;\ }\ static int dprint(int level, char *fmt, ...) #else #define DHL_MODULE(str,lvl) \ static char *p_module_name=str; \ static BOOL p_is_dbg_inited; \ static int dprint(int level, char *fmt, ...) /* selective print by module level */\ {\ va_list v;\ int n;\ if(!p_is_dbg_inited) {\ DHL_DBG_CheckAndInitModuleLevel(p_module_name, lvl); \ p_is_dbg_inited=TRUE;\ }\ va_start(v, fmt);\ n = DHL_DBG_LevelPrint(p_module_name, level, fmt, v);\ va_end(v);\ return n;\ }\ /* 사실 이 dprint2 함수는 반드시 필요하지는 않다. 그냥 DHL API로 제공해도 되는 함수임. */ \ static int dprint2(char *key, char *fmt, ...) /* selective print by keyword */\ {\ va_list v;\ int n;\ va_start(v, fmt);\ n = DHL_DBG_KeyPrint(key, fmt, v);\ va_end(v);\ return n;\ }\ static inline BOOL dprintable(int level) \ { return DHL_DBG_CheckPrintable(DHL_DBG_GetModuleLevel(p_module_name), level); } \ static BOOL dprintable(int level) /* cafrii 090720 comment 마지막 라인 선언 부분은 extra ';' 로 인한 warning을 없애기 위한 trick임. 각 소스 파일에서는 DHL_DBG("module", 0); 와 같은 식으로 마지막에 ';'를 붙여줘야 source insight 에서 symbol 인식에 문제가 없다. */ #endif #if COMMENT dprintable(){} // this is linker for source insight to find here.. dprint(){} dprint2(){} #endif /** @brief 모듈 및 print 레벨 - 용도: 이 값은 두 군데서 사용 가능하다. - DHL_MODULE(.., m) 에서 모듈 레벨을 지정할 때 - Silent 이상의 값을 지정 가능하다. - 각 print 레벨이 모듈 레벨보다 작거나 같으면 출력된다. - dprint(n, ..) 에서 print 레벨을 지정할 경우. - Error 이상의 값을 사용할 수 있다. - 이 레벨이 모듈 레벨 이상이라면 출력 된다. - print 레벨은 아래의 usage를 따르며, (Error, Warn, Info, ..) 일반적으로 모듈 레벨을 Error를 지정한다. (에러 메시지만 출력되도록 함) - 특별히 특정 모듈을 디버깅 하고자 한다면.. - 모듈 레벨을 Warn 이상으로 올린다. - 의도적으로 해당 모듈의 모든 메시지를 막고 싶다면.. - 그 모듈의 레벨을 Silent로 설정한다. */ typedef enum { eDBG_MODULE_LVL_Unknown = -100, eDBG_MODULE_LVL_Silent = -1, ///< 이 값은 print 레벨로는 사용 금지! 모듈 레벨로만 적용 가능. eDBG_MODULE_LVL_Error = 0, ///< 에러 메시지만 표시하라는 의미. eDBG_MODULE_LVL_Warn = 1, ///< 에러와 경고 메시지만 표시하라는 의미. eDBG_MODULE_LVL_Info = 2, ///< 에러, 경고, 인포 메시지를 표시하라는 의미. eDBG_MODULE_LVL_Verbose = 3, ///< 아무 많은 메시지를 표시하라.. /* you can use bigger values.. */ } tDBG_MODULE_LVL; /* source code 내에서 run-time 시에 debug level 관리를 하고자 하는 경우 사용. Shell 상에서 조작하는 경우는 pml, sml, pdt, sdt 등의 alias 이용하면 편하다. */ /** @brief 모듈의 디버그 레벨을 변경한다. 이름은 정확하게 일치해야 한다. 만약 모듈 리스트에 지정한 이름의 모듈이 없다면 새롭게 추가된다. @param[in] name 변경하고자 하는 모듈 이름 @param[in] level 변경할 레벨. Silent 이상의 값 지정 가능. */ void DHL_DBG_SetModuleLevel(char *name, int level); /** @brief 모듈의 레벨을 리턴한다. @param[in] name 알고자 하는 모듈 이름 return 모듈 레벨 */ int DHL_DBG_GetModuleLevel(char *name); /** */ int DHL_DBG_CheckAndInitModuleLevel(char *module_name, int level); /* level check 하는 루틴을 한 군데로 통합한다. DHL_DBG_LevelPrint, dprintable, 기타 필요한 곳에서 이 macro를 사용하도록 한다. TRUE 이면 해당 print 문은 출력이 가능하다는 의미임. FALSE이는 출력이 불가능한 레벨. */ #define DHL_DBG_CheckPrintable(module_level, print_level) \ ((module_level) >= (print_level) ? TRUE : FALSE) /** @brief 해당 Level을 판단하여 Print의 여부를 결정한다. @param[in] prefix 모듈 구분 문자열. 최대 6자 까지만 지원한다. @param[in] level print 레벨. enum 대신 그냥 숫자로 지정을 한다. @param[in] format @param[in] ap */ int DHL_DBG_LevelPrint(char *prefix, int level, char *format, va_list ap); /* */ int DHL_DBG_KeyPrint(char *prefix, char *format, va_list ap); /* */ int DHL_DBG_SetDbgKey(char *text_name, BOOL is_on); /** */ void DHL_DBG_PrintModuleLevel(const char *substr); #if COMMENT ____Alias_Symbol____(){} #endif /** @name DHL Symbol Table (Alias Symbol) @{ DHL 에서 제공하는 symbol table. 개발 툴, 또는 OS에서 자체적으로 제공하는 symtab이 없는 경우 사용하면 된다. 다른 symtab이 있는 경우에도 short cut 기능 등을 사용할 경우 필요하다. */ #define DHL_SYM_NONE 0 #define DHL_SYM_V1 1 // == sizeof(UINT8) #define DHL_SYM_V2 2 // == sizeof(UINT16) #define DHL_SYM_V4 4 // == sizeof(UINT32) #define DHL_SYM_Vx 8 // no information about data size. #define DHL_SYM_FN 0x10 #define DHL_SYM_ALL 0xf // purpose?? /** @brief DHL에서 관리하는 alias symbol node. 정확히 표현하자면 SymbolEntry 라고 해야 맞다. 그러나 이 타입을 사용하는 곳이 너무 많으므로 이 이름을 그대로 사용하도록 한다. */ typedef struct { char *name; void *ptr; UINT8 type; // DHL_SYM_XX } DHL_SymbolTable; #define DHL_NUMSYMBOLS(tbl) (sizeof((tbl))/sizeof((tbl)[0])) // // symbol table 정의를 쉽게 할 수 있는 macro // #define DHL_FNC_SYM_ENTRY(fn) { #fn, (void *)fn, DHL_SYM_FN, } #define DHL_VAR_SYM_ENTRY(va) { #va, &va, sizeof(va), } #define DHL_FNC_SYM_ENTRY2(name, fn) { name, (void *)fn, DHL_SYM_FN, } #define DHL_FNC_SYM_ARGS(fn) #fn, fn #define DHL_VAR_SYM_ARGS(va) #va, &va, sizeof(va) /** @brief Symbol 테이블 출력. 지정한 문자열을 substring으로 갖는 symbol table을 모두 출력한다. 출력은 OS DbgPrintf 를 사용한다. Shell의 내부 "show" 명령에서 사용한다. */ void DHL_DBG_PrintSymbolTable(int showmask, char *substr); /** @brief 함수 symbol 등록 API 매크로를 사용하면 더 쉽게 등록할 수 있다. */ void DHL_DBG_RegisterFunctionSymbol(char *name, void *ptr); /** @brief 변수 symbol 등록 API 매크로를 사용하면 더 쉽게 등록할 수 있다. */ void DHL_DBG_RegisterVarSymbol(char *name, void *ptr, int size); /** @brief 함수/변수 symbol list 등록 API 미리 정의된 symbol list를 한꺼번에 등록한다. */ void DHL_DBG_RegisterSymbols(DHL_SymbolTable *tbls, int n); /** @brief DHL Symbol 검색 API 이름으로 symbol 정보를 찾는 함수. symbol pointer와 type이 리턴된다. 발견되지 않으면 에러 리턴. Shell 에서 입력한 command를 parsing하여 실행할 때 사용된다. */ DHL_RESULT DHL_DBG_QuerySymbol(char *name, void **pptr, int *ptype); /*@}*/ #if COMMENT ____Shell____(){} #endif typedef struct { BOOL started; ///< true if dbg shell running. DHL_OS_TASK_ID tid; ///< task id of running shell. } DHL_DBG_SHELL_INFO; /** @brief Debug shell 을 기동한다. shell 에서 지원 가능한 명령어는 해당 module 소스 참고. 사실 이 함수는 외부에서 사용할 경우는 없고, DHL 내부 구현시 사용한다. 따라서 API에 포함될 필요는 없으나, 일단 여기에 두도록 하자. @todo DHL DBG Private 헤더 파일 필요. */ void DHL_DBG_StartDbgShell(void); /** @brief Debug shell의 정보를 가져온다. @param[out] pInfo 쉘 정보가 저장될 곳. */ void DHL_DBG_GetDbgShellInfo(DHL_DBG_SHELL_INFO *pInfo); /** @brief 현재 task가 shell task인지 체크. @return 현재 task가 shell 이라면 TRUE를 리턴한다. */ BOOL DHL_DBG_IsDbgShell(void); /** @brief shell에서 명령 입력이 되는 것처럼 emulation 한다. @param[in] cmd 에뮬레이션 수행 할 명령. */ void DHL_DBG_EmulateCommand(const char *cmd); #if COMMENT ____MemDump____(){} #endif #define MEMDUMP_ALIGN 0x1 #define MEMDUMP_NOHDR 0x2 /** @brief 정해진 메모리 영역의 내용을 화면에 출력한다. @param[in] buf 덤프할 메모리 영역. @param[in] size 메모리 덤프 사이즈. @param[in] msg @param[in] off off는 displayed address를 맞추기 위해 사용되는 offset @param[in] flag */ void DHL_DBG_MemDump3(void *buf, int size, char *msg, UINT32 off, UINT32 flag); /** @brief DHL_MemDump3(buf0, size, msg, off, MEMDUMP_ALIGN); */ void DHL_DBG_MemDump2(void *buf, int size, char *msg, UINT32 off); /** @brief DHL_MemDump3(buf, size, msg, 0, MEMDUMP_ALIGN); */ void DHL_DBG_MemDump (void *buf, int size, char *msg); #define memdump DHL_DBG_MemDump #define memdump2 DHL_DBG_MemDump2 #define memdump3 DHL_DBG_MemDump3 /** @brief 두 개의 메모리 영역을 비교한다. C standard library에 있는 memcmp와 비슷한 기능을 하지만 리턴값이 다르다. 같으면 -1을 리턴하고, 다르면 mismatch가 시작된 그 offset을 리턴한다. @param[in] s1 첫 번째 비교 대상 메모리 영역 @param[in] s2 두 번째 비교 대상 메모리 영역 @param[in] len 비교 검사할 영역의 길이 */ int DHL_DBG_MemCmp(const unsigned char *s1, const unsigned char *s2, int len); #if COMMENT ____Init____(){} #endif /** */ void DHL_DBG_Init(void); //void DHL_DBG_Uninit(void); #ifdef __cplusplus } /* extern "C" */ #endif #endif /* __DHL_DEBUG_API_H__ */