Description

Functions
int	processTopPattern (char logfile, GList pchead, int pcIndex)
	This API processes the top command log file patterns to retrieve load average and process usage. More...

int	addToJson (GList *pchead)
	This function adds the value to the telemetry output json object. More...

int	getIPVideo (char line, pcdata_t pcnode)
	Function to process pattern if it has split text in the header. More...

int	getErrorCode (char str, char ec, int ec_length)
	To get RDK error code. More...

int	handleRDKErrCodes (GList *rdkec_head, char line)
	Function to handle error codes received from the log file. More...

int	processCountPattern (char logfile, GList pchead, int pcIndex, GList **rdkec_head)
	Function to process pattern count (loggrep) More...

int	processPattern (char *prev_file, char logfile, GList *rdkec_head, GList pchead, int pcIndex)
	Generic pattern function based on pattern to call top/count or using ccsp message bus. More...

char *	strSplit (char str, char delim)
	Function like strstr but based on the string delimiter. More...

void	getDType (char filename, char header, DType_t *dtype)
	To get node data type based on pattern. More...

int	parseFile (char *fname)
	Main logic function to parse sorted MAP file and to process pattern list. More...

int	main (int argc, char *argv[])
	Main Function. More...

int	main ()

void	initSearchResultJson (cJSON root, cJSON sr)
	This API creates "searchResult" JSON array. More...

void	addToSearchResult (char key, char value)
	This API is to append the key/value pair to the SearchResult JSON array . More...

void	clearSearchResultJson (cJSON **root)
	This API deletes the result JSON object. More...

void	printJson (cJSON *root)
	This API is to print Json result. More...

int	getProcUsage (char *processName)
	To get process usage. More...

int	getProcPidStat (int pid, procinfo *pinfo)
	To get status of a process from its process ID. More...

char *	getResidentMemory (procMemCpuInfo pInfo, int processPid)
	To get the reserve memory of a given process in pages. More...

int	ccsp_handler_init ()
	This API initalizes the ccsp message bus. More...

void	ccsp_handler_exit ()
	This API is to uninitialize message bus.

int	get_tr181param_value (const char path_namespace, char parm_value, int len)
	This API is to retrieve the value of TR181 telemetry. More...

int	getLoadAvg ()
	This API is to find the load average of system and add it to the SearchResult JSON. More...

static int	fsize (FILE *fp)
	This function returns file size. More...

void	clearConfVal (void)
	This function is to clear/free the global paths.

void	updateExecCounter ()
	To update current dca execution count.

void	saveExecCounter ()

int	isSkipParam (int skipInterval)
	This API is to verify whether to skip this telemetry marker. More...

char *	getsRotatedLog (char buf, int buflen, char name)
	Function to return rotated log file. More...

void	updateIncludeConfVal (char logpath, char perspath)
	Function to update the global paths like PERSISTENT_PATH,LOG_PATH from include.properties file. More...

void	updateConfVal (char logpath, char perspath)
	Function to update the configuration values from device.properties file. More...

int	readLogSeek (char name, long seek_value)
	Function to read the rotated Log file. More...

void	writeLogSeek (char *name, long seek_value)
	Function to write the rotated Log file. More...

int	getProcInfo (procMemCpuInfo *pmInfo)
	To get CPU and mem info. More...

int	getMemInfo (procMemCpuInfo *pmInfo)
	To get the reserve memory of a given process. More...

int	getCPUInfo (procMemCpuInfo *pInfo)
	To get CPU info. More...

Function Documentation

◆ processTopPattern()

int processTopPattern	(	char *	logfile,
		GList *	pchead,
		int	pcIndex
	)

This API processes the top command log file patterns to retrieve load average and process usage.

Parameters

[in]	logfile	top_log file
[in]	pchead	Node head
[in]	pcIndex	Node count

Returns: Returns the status of the operation.

Return values

Returns zero on success, appropriate errorcode otherwise.

Definition at line 150 of file dca.c.

◆ addToJson()

int addToJson ( GList * pchead )

This function adds the value to the telemetry output json object.

Parameters

[in] pchead Header field in the telemetry profile

Returns: Returns status of operation.

Definition at line 347 of file dca.c.

◆ getIPVideo()

int getIPVideo	(	char *	line,
		pcdata_t *	pcnode
	)

Function to process pattern if it has split text in the header.

Parameters

[in]	line	Log file matched line
[in]	pcnode	Pattern to be verified.

Returns: Returns status of operation.

Return values

Return 0 on success, -1 on failure

Definition at line 390 of file dca.c.

◆ getErrorCode()

int getErrorCode	(	char *	str,
		char *	ec,
		int	ec_length
	)

To get RDK error code.

Parameters

[in]	str	Source string.
[out]	ec	Error code.

Returns: Returns status of operation.

Return values

Return 0 upon success.

Definition at line 439 of file dca.c.

◆ handleRDKErrCodes()

int handleRDKErrCodes	(	GList **	rdkec_head,
		char *	line
	)

Function to handle error codes received from the log file.

Parameters

[in]	rdkec_head	Node head.
[in]	line	Logfile matched line.

Returns: Returns status of operation.

Return values

Return 0 upon success, -1 on failure.

Definition at line 486 of file dca.c.

◆ processCountPattern()

int processCountPattern	(	char *	logfile,
		GList *	pchead,
		int	pcIndex,
		GList **	rdkec_head
	)

Function to process pattern count (loggrep)

Parameters

[in]	logfile	Current log file
[in]	pchead	Node head
[in]	pcIndex	Node count
[in]	rdkec_head	RDK errorcode head

Returns: Returns status of operation.

Return values

Return 0 upon success, -1 on failure.

Definition at line 524 of file dca.c.

◆ processPattern()

int processPattern	(	char **	prev_file,
		char *	logfile,
		GList **	rdkec_head,
		GList *	pchead,
		int	pcIndex
	)

Generic pattern function based on pattern to call top/count or using ccsp message bus.

Parameters

[in]	prev_file	The previous log file.
[in]	logfile	The current log file.
[in]	rdkec_head	RDK errorcode head
[in]	pchead	Node head
[in]	pcIndex	Node count

Returns: Returns status on operation.

Return values

Returns 0 upon success.

Definition at line 567 of file dca.c.

◆ strSplit()

char* strSplit	(	char *	str,
		char *	delim
	)

Function like strstr but based on the string delimiter.

Parameters

[in]	str	String.
[in]	delim	Delimiter.

Returns: Returns the output string.

Definition at line 658 of file dca.c.

◆ getDType()

void getDType	(	char *	filename,
		char *	header,
		DType_t *	dtype
	)

To get node data type based on pattern.

Parameters

[in]	filename	Conf filename.
[in]	header	node header.
[out]	dtype	Data type

Returns: Returns status of operation.

Definition at line 692 of file dca.c.

◆ parseFile()

int parseFile ( char * fname )

Main logic function to parse sorted MAP file and to process pattern list.

MAP file is of the form $header<#=#>$content<#=#>$logFileName<#=#>$skipInterval.

Parameters

[in] fname Configuration file.

Returns: Returns status of the operation.

Return values

Return 0 upon success, -1 on failure.

Definition at line 732 of file dca.c.

◆ main()

int main	(	int	argc,
		char *	argv[]
	)

Main Function.

Parameters

[in] Command line arguments(Sorted pattern conf file, previous log path, Custom persistent path).

Returns: Returns status of the operation.

Return values

Returns the return code of parseFile function.

Definition at line 857 of file dca.c.

◆ initSearchResultJson()

void initSearchResultJson	(	cJSON **	root,
		cJSON **	sr
	)

This API creates "searchResult" JSON array.

The search result list contains collection of telemetry marker headers with their value.

Eg: {"searchResult":[{"MOCA_INFO_pnc_enabled":"1"},{"samv2_boardver_split":" V3.0 ##"},{"RF_ERR_DS_lockfail":"1"},{"RF_ERR_T3_timeout":"2"}]}

Parameters

[out]	root	JSON object
[in]	sr	Search result JSON array

Definition at line 57 of file dcajson.c.

◆ addToSearchResult()

void addToSearchResult	(	char *	key,
		char *	value
	)

This API is to append the key/value pair to the SearchResult JSON array .

Parameters

[in]	key	marker name
[in]	value	metric count

Definition at line 71 of file dcajson.c.

◆ clearSearchResultJson()

void clearSearchResultJson ( cJSON ** root )

This API deletes the result JSON object.

Parameters

[in] root JSON object to be deleted.

Definition at line 87 of file dcajson.c.

◆ printJson()

void printJson ( cJSON * root )

This API is to print Json result.

Parameters

[in] root JSON object.

Returns: Returns the status of the operation.

Definition at line 99 of file dcajson.c.

◆ getProcUsage()

int getProcUsage ( char * processName )

To get process usage.

Parameters

[in] processName Process name.

Returns: Returns status of operation.

Return values

0	on sucess, appropiate errorcode otherwise.

Definition at line 106 of file dcaproc.c.

◆ getProcPidStat()

int getProcPidStat	(	int	pid,
		procinfo *	pinfo
	)

To get status of a process from its process ID.

This will return information such as process priority, virtual memory size, signals etc.

Parameters

[in]	pid	PID value of the process.
[in]	pinfo	Process info.

Returns: Returns status of operation.

Return values

Return 1 on success, appropiate errorcode otherwise.

Definition at line 290 of file dcaproc.c.

◆ getResidentMemory()

char* getResidentMemory	(	procMemCpuInfo *	pInfo,
		int *	processPid
	)

To get the reserve memory of a given process in pages.

Parameters

[in]	pInfo	Process Name.
[in]	processPid	Process Id.

Returns: Returns reserve memory of the requested process.

Definition at line 128 of file dcaprocess.cpp.

◆ ccsp_handler_init()

int ccsp_handler_init ( )

This API initalizes the ccsp message bus.

Returns: Returns status of operation.

Return values

Returns zero on success, appropiate errorcode otherwise.

Definition at line 68 of file dcatr181.c.

◆ get_tr181param_value()

int get_tr181param_value	(	const char *	path_namespace,
		char *	parm_value,
		int	len
	)

This API is to retrieve the value of TR181 telemetry.

Returns: Returns status of operation.

Return values

Returns zero on success, appropiate errorcode otherwise.

Definition at line 101 of file dcatr181.c.

◆ getLoadAvg()

int getLoadAvg ( )

This API is to find the load average of system and add it to the SearchResult JSON.

Returns: Returns status of operation.

Return values

Return 1 on success.

Definition at line 57 of file dcautils.c.

◆ fsize()

static int fsize ( FILE * fp )

static

This function returns file size.

Parameters

[in] fp File name

Returns: Returns size of file.

Definition at line 85 of file dcautils.c.

◆ isSkipParam()

int isSkipParam ( int skipInterval )

This API is to verify whether to skip this telemetry marker.

Parameters

[in] skipInterval Polling frequency

Returns: Retuns 0 or 1 depening upon the polling frequency.

Definition at line 163 of file dcautils.c.

◆ getsRotatedLog()

char* getsRotatedLog	(	char *	buf,
		int	buflen,
		char *	name
	)

Function to return rotated log file.

Parameters

[in]	buf	Buffer
[in]	buflen	Maximum buffer length
[in]	name	Current Log file

Returns: Returns Seek Log file.

Definition at line 190 of file dcautils.c.

◆ updateIncludeConfVal()

void updateIncludeConfVal	(	char *	logpath,
		char *	perspath
	)

Function to update the global paths like PERSISTENT_PATH,LOG_PATH from include.properties file.

Parameters

[in]	logpath	Log file path
[in]	perspath	Persistent path

Definition at line 397 of file dcautils.c.

◆ updateConfVal()

void updateConfVal	(	char *	logpath,
		char *	perspath
	)

Function to update the configuration values from device.properties file.

Parameters

[in]	logpath	Log file path
[in]	perspath	Persistent path

Definition at line 491 of file dcautils.c.

◆ readLogSeek()

int readLogSeek	(	char *	name,
		long *	seek_value
	)

Function to read the rotated Log file.

Parameters

[in]	name	Log file name.
[in]	seek_value	Position to seek.

Returns: Returns the status of the operation.

Return values

Returns -1 on failure, appropriate errorcode otherwise.

Definition at line 635 of file dcautils.c.

◆ writeLogSeek()

void writeLogSeek	(	char *	name,
		long	seek_value
	)

Function to write the rotated Log file.

Parameters

[in]	name	Log file name.
[in]	seek_value	Position to seek.

Returns: Returns the status of the operation.

Return values

Returns -1 on failure, appropriate errorcode otherwise.

Definition at line 678 of file dcautils.c.

◆ getProcInfo()

bool getProcInfo ( procMemCpuInfo * pmInfo )

To get CPU and mem info.

Parameters

[out] pmInfo Memory/CPU Info.

Returns: Returns status of operation.

Return values

Return 1 on success.

Definition at line 397 of file dcaproc.c.

◆ getMemInfo()

int getMemInfo ( procMemCpuInfo * pmInfo )

To get the reserve memory of a given process.

Parameters

[out] pmInfo Memory Info.

Returns: Returns status of operation.

Return values

Return 1 on success.

Definition at line 417 of file dcaproc.c.

◆ getCPUInfo()

int getCPUInfo ( procMemCpuInfo * pInfo )

To get CPU info.

Parameters

[out] pInfo CPU info.

Returns: Returns status of operation.

Return values

Return 1 on success,appropiate errorcode otherwise.

Definition at line 468 of file dcaproc.c.

Description

Functions

Function Documentation

◆ processTopPattern()

◆ addToJson()

◆ getIPVideo()

◆ getErrorCode()

◆ handleRDKErrCodes()

◆ processCountPattern()

◆ processPattern()

◆ strSplit()

◆ getDType()

◆ parseFile()

◆ main()

◆ initSearchResultJson()

◆ addToSearchResult()

◆ clearSearchResultJson()

◆ printJson()

◆ getProcUsage()

◆ getProcPidStat()

◆ getResidentMemory()

◆ ccsp_handler_init()

◆ get_tr181param_value()

◆ getLoadAvg()

◆ fsize()

◆ isSkipParam()

◆ getsRotatedLog()

◆ updateIncludeConfVal()

◆ updateConfVal()

◆ readLogSeek()

◆ writeLogSeek()

◆ getProcInfo()

◆ getMemInfo()

◆ getCPUInfo()