/**
	@file
		DHL_SYS_Platform.c

	@brief
		

	이 모듈에 대한 간단한 설명.. 
	ex: AudioVideo decoding/capture/output implementation

	Copyright 2006~2010 Digital STREAM Technology, Inc.
	All Rights Reserved
*/


#include "DHL_OSAL.h"
#include "DHL_DBG.h"

#include "DHL_DBG_Priv.h"


/*
	모든 헤더 파일을 포함하지는 않으며, compile time을 줄이기 위해
	각 모듈은 필요한 만큼의 헤더를 선언하도록 함.
*/



/*
	DHL 디버그 모듈 이름 정의 룰 참고:

	DHL 모듈들은 모두 * 로 시작.
	API는 대문자, Platform 및 기타는 소문자 사용.

	디폴트 레벨은 0으로 설정한다. (0: 에러 메시지만 출력)
	
	
*/

//DHL_MODULE("*MMM", 0);



#if COMMENT
____Config____(){}
#endif

#define SUPPORT_DBG_SYMBOL 1


/*
	이 모듈 내부에서 사용되는 각종 configuration 정의.
*/


/* #define SUPPORT_FAST_SWITCHING_OPTIMIZATION 1 */
/* #define FUNC_MONITOR_TIMER_ID TIMER_ID_FUNC_MONITOR */



#if COMMENT
____Types____(){}
#endif

/*
	이 모듈 내부에서 사용되는 structure 및 enumerations.
*/



#if COMMENT
____Variables____(){}
#endif

/*
	global로 적용되는 variable 정의.
	각 function 별로 특수한 용도의 variable은 각 functionX block 에서 정의 가능.
*/




#if COMMENT
_____DHL_Symbol______(){}
#endif

#if SUPPORT_DBG_SYMBOL

// cafrii 060630 add
//  memory check exception을 자동으로 등록하기 위한 변수
int g_dhl_memtrace_skip_line1;
//int g_dhl_memtrace_skip_line2;
//int g_dhl_memtrace_skip_line3;
//int g_dhl_memtrace_skip_line4;

static DHL_SymbolTable *p_SymbolTable;

static int p_nNumberOfSymbols;
static int p_nSizeOfSymbolTable;

static DHL_OS_SEMA_ID p_dhl_MutexSymTbl;


static void p_dbg_LockSymTbl(BOOL bLock)
{
	if (p_dhl_MutexSymTbl == 0) {
		p_dhl_MutexSymTbl = DHL_OS_CreateMutexSemaphore("DhlSymTbl");
		if (p_dhl_MutexSymTbl == 0)
			return;
	}
	
	if (bLock)
		DHL_OS_TakeSemaphore(p_dhl_MutexSymTbl, DHL_TIMEOUT_FOREVER);
	else
		DHL_OS_GiveSemaphore(p_dhl_MutexSymTbl);
}


// todo..
//
// symbol table을 위한 메모리는 별도로 할당/관리 되는데,
// user(app/mw)에서 별도로 symbol table 등록을 위해 준비하는 table이 있으므로
// 실제로 필요한 메모리의 두배가 소모되는 문제가 있다.
// 
// 대신 이렇게 메모리가 소모되지만 sorting을 할 수 있기 때문에 좀 효율적이다.
//
// user에서 건네준 table을 그냥 사용하는 방법도 고려해보자.
//  - 하나씩 symbol 등록을 하는 경우는 내부 관리 table을 사용,
//  - 복수개의 symbol을 등록을 하는 경우는 그냥 전달된 table을 사용하는 방법 고려.
// 

//
// symbol 등록하는 함수들..
//
void dhl_dbg_register_one_symbol(char *name, void *ptr, int type)
{
	char *pNameDup = NULL;
	int i, idx;
	
	if (name == NULL || name[0] == 0) {
		DHL_OS_Printf("!! register func symbol: invalid argument\n");
		return;
	}

	if (type != DHL_SYM_FN && type != DHL_SYM_V4 &&
		type != DHL_SYM_V2 && type != DHL_SYM_V1) {
		DHL_OS_Printf("!! invalid symbol type %d\n", type);
		return;
	}

	if (type == DHL_SYM_FN && ((UINT32)ptr & 0x3)) {  // it is not 4-byte aligned.
		DHL_OS_Printf("!! FN symbol '%s' address 0x%x should be 4-byte aligned.\n", name, (UINT32)ptr);
		return;
	}
	else if (type == DHL_SYM_V4 && ((UINT32)ptr & 0x3)) {
		DHL_OS_Printf("!! V4 symbol '%s' address 0x%x should be 4-byte aligned.\n", name, (UINT32)ptr);
		return;
	}
	else if (type == DHL_SYM_V2 && ((UINT32)ptr & 0x1)) {
		DHL_OS_Printf("!! V2 symbol '%s' address 0x%x should be 2-byte aligned.\n", name, (UINT32)ptr);
		return;
	}

	p_dbg_LockSymTbl(TRUE);

	//tbl = p_SymbolTable;
	
	// 동일한 name이 있으면 overwrite..
	
	for (i=0; i<p_nNumberOfSymbols; i++) {
		if (p_SymbolTable[i].name == NULL)
			continue;
		if (strcmp(name, p_SymbolTable[i].name) == 0) {
			//DHL_OS_Printf("symbol '%s' replaced 0x%08x->0x%08x\n",
			//	name, p_SymbolTable[i].ptr, ptr);
			p_SymbolTable[i].ptr = ptr;
			goto label_done;
		}
	}
	
	// symbol name을 duplicate..   
	pNameDup = DHL_OS_Malloc(strlen(name)+1);
	g_dhl_memtrace_skip_line1 |= (__LINE__ - 1); // 꼭 바로 아래 라인에 사용할 것.. 

	if (pNameDup == NULL) {
		DHL_OS_Printf("!! out of memory for new symbol name\n");
		goto label_done;
	}
	strcpy(pNameDup, name);
	
	if (p_nNumberOfSymbols == p_nSizeOfSymbolTable)
	{
		// symbol table buffer is full. increase symbol table buffer memory
		//
		int nNewSize = p_nSizeOfSymbolTable == 0 ? 16 : p_nSizeOfSymbolTable*2;
		
		DHL_SymbolTable *pNewTbl = DHL_OS_Malloc(nNewSize*sizeof(DHL_SymbolTable));
		
		if (pNewTbl == NULL) {
			DHL_OS_Printf("!! out of memory for new symbol table\n");
			//DHL_OS_Free(&pNameDup);
			goto label_done;
		}
		
		if (p_nSizeOfSymbolTable) {
			// duplicate
			memcpy(pNewTbl, p_SymbolTable, sizeof(DHL_SymbolTable)*p_nSizeOfSymbolTable);
			
			// free original small table..
			DHL_OS_Free((void **)&p_SymbolTable);
		}
				
		p_SymbolTable = pNewTbl;
		p_nSizeOfSymbolTable = nNewSize;
	}
	
	
	// sorting을 할 필요가 있다면 이 시점에서 수행한다.
	
	for (i=0; i<p_nNumberOfSymbols; i++) {
		if (p_SymbolTable[i].name == NULL)
			continue;
		if (strcmp(name, p_SymbolTable[i].name) > 0) {
			break;
		}
	}
	idx = i;
	
	// idx 번째부터 마지막까지 한칸씩 shift 
	
	for (i=p_nNumberOfSymbols-1; i>=idx; i--)
		p_SymbolTable[i+1] = p_SymbolTable[i];
	memset(&p_SymbolTable[idx], 0, sizeof(DHL_SymbolTable));
	
	// idx 번째의 entry에 새로운 symbol 정보를 등록한다.
	//DHL_OS_Printf("register symbol '%s' to %d th entry..\n", name, idx);

	p_SymbolTable[idx].name = pNameDup;
	p_SymbolTable[idx].ptr  = ptr;
	p_SymbolTable[idx].type = type;
	pNameDup = NULL;
	
	p_nNumberOfSymbols++;
	
label_done:

	if (pNameDup)
		DHL_OS_Free((void **)&pNameDup);
		
	p_dbg_LockSymTbl(FALSE);

}


#endif /* SUPPORT_DBG_SYMBOL */

#if COMMENT
_____API______(){}
#endif

//
// 지정한 문자열을 substring으로 갖는 symbol table을 모두 출력한다.
// 
void DHL_DBG_PrintSymbolTable(int showmask, char *substr)
{
#if SUPPORT_DBG_SYMBOL
	int i;
	DHL_SymbolTable *tbl;
	
	if (substr == NULL) substr = "";
	
	if (showmask == 0)  // show all..
		showmask = DHL_SYM_FN | DHL_SYM_V1 | DHL_SYM_V2 | DHL_SYM_V4;
		
	p_dbg_LockSymTbl(TRUE);
	
	DHL_OS_Printf("Total %d Symbols registerred, tbl size %d\n",
		p_nNumberOfSymbols, p_nSizeOfSymbolTable);
	
	for (i=0; i<p_nNumberOfSymbols; i++) {
		tbl = &p_SymbolTable[i];
		if ((showmask & tbl->type) == 0)
			continue;
		
		if (substr[0] && strstr(tbl->name, substr)==NULL)
			continue;

		if (tbl->type == DHL_SYM_V1 ||
			tbl->type == DHL_SYM_V2 ||
			tbl->type == DHL_SYM_V4) 
		{
			UINT32 value = tbl->type==DHL_SYM_V1 ? *(INT8*)tbl->ptr : 
					tbl->type==DHL_SYM_V2 ? *(INT16*)tbl->ptr : *(INT32*)tbl->ptr;
			DHL_OS_Printf(" (%03d)  0x%08x  %s  %s = %d (0x%x)\n", 
				i, (UINT32)tbl->ptr, 
				tbl->type == DHL_SYM_V1 ? "V1" :
				tbl->type == DHL_SYM_V2 ? "V2" : 
				tbl->type == DHL_SYM_V4 ? "V4" : "??",
				tbl->name ? tbl->name : "(NULL)",
				value, value);
		}
		else 
			DHL_OS_Printf(" (%03d)  0x%08x  %s  %s \n", 
				i, (UINT32)tbl->ptr, 
				tbl->type == DHL_SYM_FN ? "FN" : "??",
				tbl->name ? tbl->name : "(NULL)");
	}
	p_dbg_LockSymTbl(FALSE);
#endif
}



void DHL_DBG_RegisterFunctionSymbol(char *name, void *ptr)
{
#if SUPPORT_DBG_SYMBOL
	dhl_dbg_register_one_symbol(name, ptr, DHL_SYM_FN);	
#endif
}
void DHL_DBG_RegisterVarSymbol(char *name, void *ptr, int size)
{
#if SUPPORT_DBG_SYMBOL
	dhl_dbg_register_one_symbol(name, ptr, 
		size==1 ? DHL_SYM_V1 : size==2 ? DHL_SYM_V2 : DHL_SYM_V4);	
#endif
}

void DHL_DBG_RegisterSymbols(DHL_SymbolTable *tbls, int n)
{
#if SUPPORT_DBG_SYMBOL
	int i;
	
	if (tbls == NULL)
		return;

	/* cafrii 090721, null symbol name also means end of list. */
	for (i=0; i<n && tbls[i].name; i++)
		dhl_dbg_register_one_symbol(tbls[i].name, tbls[i].ptr, tbls[i].type);	
#endif
}


//
// 이름으로 symbol 정보를 찾는 함수. symbol pointer와 type이 리턴된다.
// 발견되지 않으면 에러 리턴.
//
DHL_RESULT DHL_DBG_QuerySymbol(char *name, void **pptr, int *ptype)
{
#if SUPPORT_DBG_SYMBOL
	DHL_RESULT err = DHL_FAIL_NOT_FOUND;
	int i;
	
	// todo..
	// 갯수가 많으면 binary search 적용..
	p_dbg_LockSymTbl(TRUE);
	
	for (i=0; i<p_nNumberOfSymbols; i++) {
		if (p_SymbolTable[i].name == NULL) 
			continue;
		if (strcmp(p_SymbolTable[i].name, name) == 0) {
			if (pptr)
				*pptr = p_SymbolTable[i].ptr;
			if (ptype)
				*ptype = p_SymbolTable[i].type;
			err = DHL_OK;
			break;
		}
	}
	p_dbg_LockSymTbl(FALSE);
	
	return err;
#endif
}



#if COMMENT
_____BUILD_Symbol______(){}
#endif


/**
	@todo
		symtab 정렬..
*/
void dhl_dbg_init_symtab(void)
{
}

/**

*/
void dhl_dbg_print_symtab(char *substr)
{
}


UINT32 dhl_dbg_find_sym_by_name(char *name)
{
	return 0;
}

BOOL dhl_dbg_is_text_symbol(UINT32 addr)
{
		return FALSE;
}

BOOL dhl_dbg_is_data_symbol(UINT32 addr)
{
		return FALSE;
}


/* end of file */