Global Call IP over Host-based Stack Technology User's Guide: 9.2.1. Call Control Library and SIP Stack Debugging

9.2.1. Call Control Library and SIP Stack Debugging

The gc_h3r.cfg file can be used to customize the information written to the gc_h3r.log file by one or both of the following:

Call Control Library
SIP Stack

Customizing Call Control Library Logging to the gc_h3r.log File

The call control library comprises three library files; libgch3r.so, libsigal.so, and libsipsigal.so for Linux operating systems, and libgch3r.dll, libsigal.dll, and libsipsigal.dll for Windows operating systems. Table 50 shows the modules in libgch3r.dll or libgch3r.so and identifies the type of log information generated by each module.

Table 50. Modules in libgch3r.dll or libgch3r.so

Module

Type of Information

M_CRN Call Reference Number information and states.

M_SHM Interface to User information (for example, when calling gc_ReleaseCallEx( ), ShmReleaseCallEx is output to the log.

M_LD Line device operation and states.

M_MEDIA Media channel related information.

M_PDL Predefined Library information.

M_PACKER Packed event information to the application.

M_SH_DB Preconfiguration information saved in the control library.

M_SH_DEC Internal process communication information.

M_SH_ENC Internal process communication information.

M_SH_IPC Internal process communication information.

M_SH_UNPACK Information unpacked from the application.

M_BOARD Board-related information.

Table 51 shows the modules in libsigal.dll or libsigal.so and identifies the type of log information generated by each module.

Table 51. Modules in libsigal.dll or libsigal.so

Module

Type of Information

M_SIG_MAN DLL manager information.

M_CALL_MAN Call manager information.

M_SIGNAL Q.931 manager information.

M_CONTROL H.245 manager information.

M_CHAN_MAN Logical channel manager information.

M_CHAN Logical channel information.

M_IE Information element information.

M_SIG_DEC Internal process communication information.

M_SIG_ENC Internal process communication information.

M_SIG_IPC Internal process communication information.

M_RAS Registration, Admission and Status information.

M_CAPS Capability matching algorithm information.

Table 52 shows the modules in libsipsigal.dll or libsipsigal.so and identifies the type of log information generated by each module.

Table 52. Modules in libsipsigal.dll or libsipsigal.so

Module

Type of Information

M_S_SIGAL DLL manager information.

M_S_CALLM Call manager information.

M_S_SIGNL SIP manager information.

M_S_CHMGR Logical channel manager information.

M_SIP_IE Information element information.

M_SIP_CAP Capability matching algorithm information.

M_SIP_DEC Internal process communication information.

M_SIP_ENC Internal process communication information.

M_SIP_IPC Internal process communication information.

M_INFO Message send information (Not yet implemented).

M_REFER Call transfer information (Not yet implemented).

M_PRACK Provisional response information (Not yet implemented).

M_AUTHENT Authentication information (Not yet implemented).

In the gc_h3r.cfg file, you can set a different debug level for each module. Table 53 shows the valid bebug levels.

Table 53. Levels of Debug for Call Control Library Logging

Debug Level †

Debug Information

Call Control Library Output to Log File

0 L_NONE No information

1 L_SPECIAL Limited information describing call control library configuration

2 L_ERROR Error information. This is the default level.

3 L_WARNING Warning information

4 L_INFO Significant state transition information

5 L_EXTEND Additional relevant information

6 L_ALL All information

† Selecting a debug level automatically includes all lower debug levels. For example, selecting level 3 automatically includes levels 0, 1, and 2.

To set a module to the desired debug level for a module, use the following syntax:
    Module name = Debug Level Number 
Some examples are:

m_sip_enc = 2
sets the m_sip_enc module to the LEVEL_ERROR debug level

m_call_man = 6
sets the m_call_man module to the LEVEL_ALL debug level

m_media = 4
sets the m_media module to the LEVEL_INFO debug level

Customizing SIP Stack Logging to the gc_h3r.log File

The SIP stack comprises a number of modules as follows:

RvSipStack_Messge
RvSipStack_Core
RvSipStack_Transport
RvSipStack_Transaction
RvSipStack_Call
RvSipStack_Parser
RvSipStack_Stack
RvSipStack_Authenticator
RvSipStack_RegClient
RvSipStack_MsgBuilder

In the gc_h3r.cfg file, you can set different debug levels for each module. Table 54 shows the valid bebug levels that can be set. More than one level of debug can be set for each module. This is achieved by specifying a decimal number that is the binary equivalent of the binary values of each desired level ORed together. For example, a value of 31 decimal (11111 binary) enables all debug levels.

Table 54. Levels of Debug Information for SIP Stack Logging

Debug Level †

Debug Information

SIP Stack Output to Log File

0 None No information. This is the default level.

1 DEBUG Detailed information about SIP stack activity

2 INFO Information about SIP stack activity

4 WARNING Warnings about possible non-fatal errors

8 ERROR A non-fatal error occurred

16 EXCEP A fatal error occurred that blocks stack operation

† Uses a decimal representation of a bit mask, that is level 2 is 010, level 8 is 01000, level 16 is 010000 etc.

Special gc_h3r.cfg Configuration Parameters

In the gc_h3r.cfg file, two parameters that have special significance are:

outputdest - This parameter should be always be set to 0.
print_file_n_line - Controls whether filename and line numbers are written to the log. Possible values are:

1 - Filenames and line numbers are written to the log file.
0 - Filenames and line numbers are not written to the log file.

Sample Extract from gc_h3r.log File

The following is an extract from a gc_h3r.log file:
4 ! 09:35:54.558 ! M_MEDIA   ! L_INFO    !    2 ! >> eventHandler: 
ev CNTRL_EV_RX_CONNECT st TRL_ST_TXCONNECT
4 ! 09:35:54.558 ! M_MEDIA   ! L_INFO    !    2 ! >> Media::connectALL
4 ! 09:35:54.558 ! M_MEDIA   ! L_INFO    !    2 ! >> mediaEventHandler: 
ev EV_CONNECTALL st ST_WAIT_FOR_CALL
6 ! 09:35:54.558 ! M_MEDIA   ! L_ALL     !    2 ! >> MediaState::startTransaction
6 ! 09:35:54.558 ! M_MEDIA   ! L_ALL     !    2 ! >> Mediaipml::setEventMaskCALL : mode 32768,maskEvt 0x7f
6 ! 09:35:54.558 ! M_MEDIA   ! L_ALL     !    2 ! << Mediaipml::setEventMaskCALL
:m_EventMaskState 0x22 : [0]
6 ! 09:35:54.558 ! M_MEDIA   ! L_ALL     !    2 ! >> Mediaipml::setRemoteMediaInfoCALL
5 ! 09:35:54.558 ! M_MEDIA   ! L_EXTEND  !    2 ! LOCAL_RTP Port = 2720 Address : 10.242.212.44  
5 ! 09:35:54.568 ! M_MEDIA   ! L_EXTEND  !    2 ! LOCAL_RTCP Port = 2721 Address : 10.242.212.44  
5 ! 09:35:54.568 ! M_MEDIA   ! L_EXTEND  !    2 ! REMOTE_RTP  Port = 2710 Address : 10.242.212.44  
5 ! 09:35:54.568 ! M_MEDIA   ! L_EXTEND  !    2 ! LOCAL_CODER, G711ULAW64K,FSize 20,FPP 1,V 0,PT 0,RedPT 0
5 ! 09:35:54.568 ! M_MEDIA   ! L_EXTEND  !    2 ! REMOTE_RTCP Port = 2711 Address : 10.242.212.44  
5 ! 09:35:54.568 ! M_MEDIA   ! L_EXTEND  !    2 ! REMOTE_CODER, G711ULAW64K,FSize 20,FPP 1,V 0,PT 0,RedPT 0
6 ! 09:35:54.568 ! M_MEDIA   ! L_ALL     !    2 ! << Mediaipml::setRemoteMediaInfoCALL: [0]
6 ! 09:35:54.568 ! M_MEDIA   ! L_ALL     !    2 ! << MediaState::startTransaction: [0]
4 ! 09:35:54.568 ! M_MEDIA   ! L_INFO    !    2 ! << mediaEventHandler: ev EV_CONNECTALL st ST_STARTING: [0 
Notes:
1. Lines that begin with 4 (level 4) indicate state machine transitions.
2. Lines that begin with 5 (level 5) provide extended information (in this case the remote coder and the local coder and RTP/RTCP information starting the media channel).
3. Lines that begin with 6 (level 6) provide additional information (in this case the entry to and exit from functions).

**Table 50. Modules in libgch3r.dll or libgch3r.so**
Module	Type of Information
M_CRN	Call Reference Number information and states.
M_SHM	Interface to User information (for example, when calling gc_ReleaseCallEx( ), ShmReleaseCallEx is output to the log.
M_LD	Line device operation and states.
M_MEDIA	Media channel related information.
M_PDL	Predefined Library information.
M_PACKER	Packed event information to the application.
M_SH_DB	Preconfiguration information saved in the control library.
M_SH_DEC	Internal process communication information.
M_SH_ENC	Internal process communication information.
M_SH_IPC	Internal process communication information.
M_SH_UNPACK	Information unpacked from the application.
M_BOARD	Board-related information.

**Table 51. Modules in libsigal.dll or libsigal.so**
Module	Type of Information
M_SIG_MAN	DLL manager information.
M_CALL_MAN	Call manager information.
M_SIGNAL	Q.931 manager information.
M_CONTROL	H.245 manager information.
M_CHAN_MAN	Logical channel manager information.
M_CHAN	Logical channel information.
M_IE	Information element information.
M_SIG_DEC	Internal process communication information.
M_SIG_ENC	Internal process communication information.
M_SIG_IPC	Internal process communication information.
M_RAS	Registration, Admission and Status information.
M_CAPS	Capability matching algorithm information.

**Table 52. Modules in libsipsigal.dll or libsipsigal.so**
Module	Type of Information
M_S_SIGAL	DLL manager information.
M_S_CALLM	Call manager information.
M_S_SIGNL	SIP manager information.
M_S_CHMGR	Logical channel manager information.
M_SIP_IE	Information element information.
M_SIP_CAP	Capability matching algorithm information.
M_SIP_DEC	Internal process communication information.
M_SIP_ENC	Internal process communication information.
M_SIP_IPC	Internal process communication information.
M_INFO	Message send information (Not yet implemented).
M_REFER	Call transfer information (Not yet implemented).
M_PRACK	Provisional response information (Not yet implemented).
M_AUTHENT	Authentication information (Not yet implemented).

**Table 53. Levels of Debug for Call Control Library Logging**
Debug Level †	Debug Information	Call Control Library Output to Log File
0	L_NONE	No information
1	L_SPECIAL	Limited information describing call control library configuration
2	L_ERROR	Error information. This is the default level.
3	L_WARNING	Warning information
4	L_INFO	Significant state transition information
5	L_EXTEND	Additional relevant information
6	L_ALL	All information
† Selecting a debug level automatically includes all lower debug levels. For example, selecting level 3 automatically includes levels 0, 1, and 2.

**Table 54. Levels of Debug Information for SIP Stack Logging**
Debug Level †	Debug Information	SIP Stack Output to Log File
0	None	No information. This is the default level.
1	DEBUG	Detailed information about SIP stack activity
2	INFO	Information about SIP stack activity
4	WARNING	Warnings about possible non-fatal errors
8	ERROR	A non-fatal error occurred
16	EXCEP	A fatal error occurred that blocks stack operation
† Uses a decimal representation of a bit mask, that is level 2 is 010, level 8 is 01000, level 16 is 010000 etc.

Click here to contact Telecom Support Resources