5.16. Trace functionalities

By typing the following command, an informative message about every trace command syntax will be shown.

[18:01:34] ABILIS_CPX:trace ??

TRACE ACT                          Activate Tracer using saved values
TRACE ACT PO:xx,yy,... [par:val]   Activate Tracer on specified ports
TRACE CLEAR                        Clear the current trace
TRACE DELETE <file>                Delete trace saved on disk in <file> file
TRACE DISPLAY [par:val]            Display trace of sent and received data
TRACE DISPLAY EXTENDED [par:val]   Display trace of all commands
TRACE DISPLAY INFO                 Display trace informative header
TRACE GET [X][1K]                  Transfer trace using XMODEM or XMODEM-1K
          [ST: and/or LEN:] or [LAST:]
TRACE GET Z [<file>]               Transfer trace using ZMODEM
          [ST: and/or LEN:] or [LAST:]
TRACE INACT                        Deactivate Tracer
TRACE PARAM                        Display Tracer configured parameters, active
                                   parameters and the current Tracer state
TRACE PARAM SAVE                   Save current Tracer parameters values
TRACE PARAM SET par:val [par:val]  Set Tracer parameters
TRACE SAVE <file>                  Save trace on disk in <file> file
TRACE START [par:val]              Run Tracer
TRACE STOP                         Stop Tracer
[Tip]Tip

Interesting chapter: Section 63.19, “How to trace the internal events for debugging purposes”.

5.16.1. Trace act

The trace act command activates the internal events trace function. By typing the command trace act ?, an informative message about trace activation syntax will be shown.

[18:01:34] ABILIS_CPX:trace act ?

TRACE ACT                          Activate Tracer using saved values
TRACE ACT PO:xx,yy,... [par:val]   Activate Tracer on specified ports

PO:        Ports to be traced (max. 50)                            <Mandatory>
SIZE:      Tracer buffer size [3..262144 Kbytes]                    <Optional>
DATA:      Max event buffer size [10..2100 bytes]                   <Optional>
CMD:       Commands type [RSP, RSA, STD, CTIRSIG, FR-LMI, ALL]      <Optional>
LSN:       SD/RV lsn to be traced [ALL, 0000..FFFE (Hex.)]          <Optional>
TYPE:      SD/RV type to be traced [ALL, DATA, CHK, VOICE]          <Optional>
-M         Force Tracer activation                                  <Reserved>

If no parameter is specified, the following message is displayed: “NO PARAMETER SPECIFIED: USING SAVED VALUES...”, so the trace function is activated using the setting already saved through the commands trace param set and trace param save. The first one modifies the trace parameters that will be used for further activations of the trace, while the second saves, in the configuration file drivers.cfg, the parameters previously activated.

The trace param command shows the parameters settings of the internal events trace and its working mode; the information shown will depend on the trace state.

Here's the meaning of parameters:

  • PO sets the list of ports (minimum 1, maximum 50) which can be traced; their values must be in the interval [0 - 999]. Ports to be traced, must be “RUNNING”, if not, the following message will be displayed “RES:xxx PORT NOT PRESENT OR NOT RUNNING” and the trace function won't be activated; “xxx” stands for the identifier of the not present or not running port. Refer to Section 5.8.7, “D PSTACK” to have more information about ports;

  • SIZE sets the maximum allocable memory size for the trace function. If the parameter is not specified, all the available memory will be used by the system for trace activating, except the needed quantity for system management. If the system memory is not enough for activating the trace function, it won't be activated and the following message will be displayed “NOT ENOUGH MEMORY TO RUN TRACE”;

  • DATA sets the maximum allocable memory size for saving the single event, remaining optional parameters CMD, LSN and TYPE make possible the activation of filters on the events traced.

[Tip]Tip

It is possible to enable the automatic trace activation at system start-up, if the parameter tact, in general system block, is set to YES.

[18:01:34] ABILIS_CPX:d g

         Conf.Value Act.Value                Description
------------------------------------------------------------------------------
tact:        YES       YES    Automatic TRACE activation at start-up [NO, YES]
TSAVE:       YES       YES    Automatic TRACE saving [NO, YES]
sound:        ON        ON    Alarm sound enable/disable [OFF, ON]
wdg-use:     YES       YES    Enable/disable Watchdog usage [NO, YES]
wdg:           -    MFIDE2    Front Panel/WatchDog interface type  <Read Only>
------------------------------------------------------------------------------
DBGF:      ALL
CONTACT:
SYSNAME:
LOCATION:
SYSUPTIME: 5 days 17:41:45 (Monday 03/12/2007 03:24:12)            <Read Only>
SYSRBTIME: # (System Reboot time not set)
DATE&TIME: Saturday 08/12/2007 21:05:57 (GMT+1.00)                 <Read Only>
TIMEZONE:  CET - Central Europe (Rome, Paris, Berlin, Prague, Brussels)

5.16.2. Trace start

The trace start command starts saving the events exchanged among the ports specified in the list, which has been defined during the trace activation (through the command trace act).

If in the command row is not indicated any additional parameter, the trace will start using the settings defined during its activation. The following optional parameters can be specified LSN, DATA, TYPE, CMD. In this way trace parameters setting may be edited again.

If the trace is not active the following message will be displayed “TRACE INACTIVE”. By typing the following command, an informative message about the command syntax and options will be shown.

[18:01:34] ABILIS_CPX:trace start ?

TRACE START [DATA:val][CMD:val]    Run Tracer
            [LSN:hex-val][TYPE:val]

DATA:           Max event buffer size [10..2100 bytes]              <Optional>
CMD:            Commands type [RSP, RSA, STD, CTIRSIG, FR-LMI, ALL] <Optional>
LSN:            SD/RV lsn to be traced [ALL, 0000..FFFE (Hex.)]     <Optional>
TYPE:           SD/RV type to be traced [ALL, DATA, CHK, VOICE]     <Optional>

5.16.3. Trace stop

The trace stop command stops tracing the events and stores the trace content in memory until the next trace start, through the command trace start or the deactivation of the function (command trace inact). If the trace is not active the following message will be displayed “TRACE INACTIVE”. If the trace function is not running, the message “TRACE NOT RUNNING” will be displayed.

5.16.4. Trace get

The trace get command transfers the content of the internal events trace, previously saved by Abilis CPX to a remote destination, by using the XModem or ZModem protocol. Option “1K” activates file transferring through the XModem 1K protocol.

By default, the whole content of the trace, starting from the beginning of the saving, it is transferred. It is also possible, by using the proper optional parameter, to transfer only a part of the content:

If the trace buffer is empty or got empty by the command trace clear, the message “TRACE EMPTY” will be shown.

Before executing this command, the trace function has to be stopped, by using the command trace stop, otherwise the message “TRACE RUNNING” will be displayed. If the trace is not active, the message “TRACE INACTIVE” will be shown.

The transfer procedure signals its availability to transfer the trace file by the message “READY TO SEND TRACE BUFFER...” When the transfer is completed the following message is shown: “TRACE BUFFER TRANSFER ENDED, PRESS <ENTER> TO CONTINUE...”, after pressing the <ENTER> button, an informative message, “TRACE BUFFER TRANSFER SUCCESSFULLY COMPLETED”, will be shown if it was successful.

[18:01:34] ABILIS_CPX:trace get ?

TRACE GET [X][1K]                  Transfer trace using XMODEM or XMODEM-1K
          [ST: and/or LEN:] or [LAST:]
TRACE GET Z [<file>]               Transfer trace using ZMODEM
          [ST: and/or LEN:] or [LAST:]

X or Z          Select the X or Z MODEM protocol (by default XMODEM is used)
1K              Use the XMODEM-1K transfer protocol                 <Optional>
<file>          Select the name of the file on the target host
                (ZMODEM protocol only)                              <Optional>
ST:             Trace buffer start value [in Kbytes]                <Optional>
LEN:            Number of Kbytes to be transmitted, starting
                from the beginning of the Tracer buffer or
                from the "ST:" value                                <Optional>
LAST:           Number of Kbytes to be transmitted, starting
                from the end of the Tracer buffer                   <Optional>

The trace can also be transferred from the memory to a file with the command trace save <filename>. The file can be downloaded with the command file get and deleted from disk with trace delete <filename>. For example:

[21:22:34] ABILIS_CPX:trace save trace.cpx

COMMAND EXECUTED

[21:22:34] ABILIS_CPX:d i

      Abilis CPX - Ver. 7.0.2/STD - 12/10/2010 - Build 3357.4 - 12/10/2010
                            (c) 1994/2010 - Abilis

Free/Total Memory: 175,849,376/268,435,456  Largest Block: 175,844,640
Free/Used/Total HD/CF space (in KB): 90,122/32,228/122,350

File           Version   Date         Time             Size   Note
-------------------------------------------------------------------------------
CPX.RTB        .......   12/10/2010   19:36:26      4163974
DRIVERS.CFG    v.7.0     30/11/2010   15:43:02        15360   Ok
DRIVERS.BCK    v.7.0     30/11/2010   15:43:02        15360   Ok
CPX.LOG        v.1.0     30/11/2010   15:43:30        51200
CPX.DBG        v.1.1     29/10/2010   15:35:32        20480
CPX.XCP        .......   29/10/2010   15:35:30        51200
BS44.BIN       v.13.3    16/04/2010   20:25:10        91136
BS48.BIN       v.4.7     16/04/2010   20:25:10        90112
ESB2.BIN       v.13.0    28/10/2004   19:38:20        17408
DELICPRG.BIN   v.16.0    28/10/2004   19:38:20         6144
D1K.BIN        v.312.9   30/05/2008   19:31:16         1024
D1C4F3.BIN     v.312.9   30/05/2008   19:31:16       100352
D1C5F3.BIN     v.312.9   30/05/2008   19:31:16       100352
D2K.BIN        v.312.9   30/05/2008   19:31:16         1024
D2C4F3.BIN     v.312.9   30/05/2008   19:31:16       102400
D2C4F6.BIN     v.312.9   30/05/2008   19:31:16       102400
D8K.BIN        v.312.9   30/05/2008   19:31:16         1024
D8C2F1.BIN     v.312.9   30/05/2008   19:31:16        91136
D8C2F2.BIN     v.312.9   30/05/2008   19:31:16        94208
D8C2F3.BIN     v.312.9   30/05/2008   19:31:16        96256
HFC2B4.BIN     v.21.0    30/07/2009   10:57:22        16384
HFC2E4.BIN     v.21.0    30/07/2009   10:57:22        16384
HFC2B8.BIN     v.21.0    30/07/2009   10:57:22        16384
HFC2E8.BIN     v.21.0    30/07/2009   10:57:22        16384
HFC3E4.BIN     v.48.0    13/08/2009   20:53:22        86016
HFC3E8.BIN     v.48.0    13/08/2009   20:53:22        87040
QPRI2B.BIN     v.5.0     29/12/2004   16:00:34        17408
QPRI2E.BIN     v.6.0     03/03/2005   20:44:34        17408
CTIHA2.BIN     v.8.0     29/06/2005   11:33:42        18432
D64A.BIN       v.31.10   11/02/2010   14:32:50        68608
D64V.BIN       v.6.7     11/05/2010   21:51:16       138240
QPRIX.BIN      v.24.0    13/08/2009   20:53:22       251904
OCTASIC.BIN    v.16.0    18/06/2008   20:31:40       175104
STH330-P.BIN   v.30.12   24/02/2005   21:25:46       388096
STHUSB-I.BIN   .......   ..........   ........   ..........   Not found
SL-IT.BIN      v.1.0     28/10/2004   19:38:20         1024
SRVSSL.CER     .......   28/10/2004   19:38:20          820
CLISSL.CER     .......   28/10/2004   19:38:20          820
SRVSSL.KEY     .......   28/10/2004   19:38:20          981
CLISSL.KEY     .......   28/10/2004   19:38:20          969

Other system relevant files:

File           Version   Date         Time             Size   Note
-------------------------------------------------------------------------------
C:\APP\CTI\ADDRBOOK\ADDRBOOK.DAT
               v.1.0     03/11/2010   12:12:32       140066
C:\APP\CTI\LCS\LCSTABLE.DAT
               .......   ..........   ........   ..........   Not found
C:\APP\DHCP\DHCP.BND
               v.1.0     30/11/2010   15:42:58        25600

Other files in 'C:\7-0-2':

File                     Date         Time             Size   Note
-------------------------------------------------------------------------------
TRACE.CPX                30/11/2010   16:15:22      4829184
[Tip]Tip

The automatic tracer saving feature can be activated, if the parameter TSAVE, in general system block, is set to YES. If the CTISYS port is traced and a FRMWR (Firmware warning) event occurs, all drivers which are part of CTISYS (CTIDISA, CTIIAX, CTISIP, CTIH323, CTIGKC) autosave the trace. Up to 5 traces are kept on disk, subsequent traces causes the older to be deleted. Each trace stores up to 900 kbytes before the event, and up to 100 kbytes or 2 minutes after the event. Also system and debug log are saved in addition to trace.

[18:01:34] ABILIS_CPX:d g

         Conf.Value Act.Value                Description
------------------------------------------------------------------------------
tact:         NO        NO    Automatic TRACE activation at start-up [NO, YES]
TSAVE:       YES       YES    Automatic TRACE saving [NO, YES]
sound:        ON        ON    Alarm sound enable/disable [OFF, ON]
wdg-use:     YES       YES    Enable/disable Watchdog usage [NO, YES]
wdg:           -    MFIDE2    Front Panel/WatchDog interface type  <Read Only>
------------------------------------------------------------------------------
DBGF:      ALL
CONTACT:
SYSNAME:
LOCATION:
SYSUPTIME: 5 days 17:41:45 (Monday 03/12/2007 03:24:12)            <Read Only>
SYSRBTIME: # (System Reboot time not set)
DATE&TIME: Saturday 08/12/2007 21:05:57 (GMT+1.00)                 <Read Only>
TIMEZONE:  CET - Central Europe (Rome, Paris, Berlin, Prague, Brussels)