| 6.16. Trace functionalities | ||
|---|---|---|
 | Chapter 6. Command language |  |
| 6.16. Trace functionalities | ||
|---|---|---|
| | Chapter 6. Command language | |
By typing the following command, an informative message about every trace command syntax will be shown.
[18:01:34] ABILIS_CPX:trace ??TRACE ACT [par:val] [par:val] Activate Tracer using given settings and using saved values for omitted parameters 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] Transfer trace using 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] [par:val] Run Tracer with eventually given settings TRACE STOP Stop running Tracer
![[Tip]](../images/tip.png) | Tip |
|---|---|
Interesting chapter: Section 82.32, “How to trace the internal events for debugging purposes”. |
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 [par:val] [par:val] Activate Tracer using given settings and using saved values for omitted parameters RES: Resources to be traced (max 50) <Optional> PO: Ports to be traced (max 50) <Optional> SIZE: Tracer buffer size [3..262144 Kibyte] <Optional> DATA: Max event buffer size [10..2100 bytes] <Optional> CMD: Commands type [RSP, RSA, STD, CTIRSIG, 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 parameters settings of the internal events trace and its working mode; the information shown will depend on the trace state.
[11:19:41]ABILIS_CPX:trace param ?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 [10:54:14]ABILIS_CPX:trace paramConfigured Value Active Value Description ------------------------------------------------------------------------------- PO: 43 Eth-2 43 Eth-2 Ports to be traced 58 Ike 67 CtiSip 22 CtiSys ----------------------------------------------------------------------- SIZE: 25000 (Kibyte) 25000 (Kibyte) Tracer buffer size DATA: 1600 (bytes) 1600 (bytes) Max event buffer size CMD: STD STD Command(s) to be traced LSN: ALL ALL SD/RV lsn to be traced TYPE: ALL ALL SD/RV type to be traced STATE: - ACTIVE/READY Current Tracer state tact: YES YES Trace activation at boot TSAVE: YES YES Automatic trace saving EVENTS: - 0 Number of events SNDRCV: - 0 Number of send & receive LENGTH: - 0 (Kibyte) Current trace length
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 6.8.7, “D PSTACK” to have more
information about ports;
SIZE sets the maximum allocable memory size
for the trace function. If the parameter isn't 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 isn't 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 |
|---|---|
It's possible to enable the automatic trace activation at system
start-up, if the parameter
|
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 isn't 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 isn't 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 [par:val] [par:val] Run Tracer with eventually given settings DATA: Max event buffer size [10..2100 bytes] <Optional> CMD: Commands type [RSP, RSA, STD, CTIRSIG, 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>
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 isn't active, the following message will be displayed “TRACE INACTIVE”. If the trace function isn't running, the message “TRACE NOT RUNNING” will be displayed.
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-1k or ZModem protocol.
By default, the whole content of the trace, starting from the beginning of the saving, it's transferred. It's 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 isn't 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] Transfer trace using 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) <file> Select the name of the file on the target host (ZMODEM protocol only) <Optional> ST: Trace buffer start value [in Kibyte] <Optional> LEN: Number of Kibyte to be transmitted, starting from the beginning of the Tracer buffer or from the "ST:" value <Optional> LAST: Number of Kibyte 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 the disk with trace delete <filename>. For example:
[21:22:34] ABILIS_CPX:trace save trace.cpxCOMMAND EXECUTED[21:22:34] ABILIS_CPX:d iAbilis CPX - Ver. 8.8.1/STD - Build 4456.36 - Branch 8.8 - 28/03/2019 (c) 1994/2019 - Abilis ABILIS-ID: 800733 Free/Total Memory (in byte): 15,780,632/528,482,304 Free/Used/Total HD/CF space (in Kibyte): 381,102/111,852/492,954 File Version Date Time Size Note ------------------------------------------------------------------------------- CPX.RTB ....... 28/03/2019 13:59:48 6693721 BM.RTB 2053 28/03/2019 13:59:46 283126 DRIVERS.CFG 8.8 28/03/2019 15:11:44 61440 Ok DRIVERS.BCK 8.8 28/03/2019 15:11:44 61440 Ok PROVISIO.CFG ....... .......... ........ .......... Not found FACTORY.CFG ....... .......... ........ .......... Not found CPX.LOG 1.0 09/04/2019 14:17:16 51200 CPX.DBG 2.0 28/03/2019 15:11:12 1048576 CPX.XCP ....... 04/04/2019 14:27:08 51200 BS44.BIN 13.15 27/12/2018 17:46:44 90112 BSXXXI.BIN 2.6 14/08/2015 12:33:24 109568 BSXXXV.BIN 2.2 14/08/2015 12:33:24 108544 D1K.BIN 312.9 14/08/2015 12:33:24 1024 D1C4F3.BIN 312.9 14/08/2015 12:33:22 100352 D1C5F3.BIN 312.9 14/08/2015 12:33:24 100352 D2K.BIN 312.9 14/08/2015 12:33:24 1024 D2C4F3.BIN 312.9 14/08/2015 12:33:24 102400 D2C4F6.BIN 312.9 14/08/2015 12:33:24 102400 HFC2E4.BIN 21.0 14/08/2015 12:33:24 16384 HFC2E8.BIN 21.0 14/08/2015 12:33:24 16384 HFC3E4.BIN 57.0 14/08/2015 12:33:24 83968 HFC3E8.BIN 57.0 14/08/2015 12:33:24 83968 QPRI2B.BIN 5.0 14/08/2015 12:33:24 17408 QPRI2E.BIN 6.0 14/08/2015 12:33:24 17408 CTIHA2.BIN 8.0 14/08/2015 12:33:24 18432 D64A.BIN 33.22 14/08/2015 12:33:24 73728 D64V.BIN 8.15 14/08/2015 12:33:24 143360 QPRIX.BIN 33.0 14/08/2015 12:33:24 241664 OCTASIC.BIN 16.0 14/08/2015 12:33:24 175104 WING-P.BIN 1.0 14/08/2015 12:33:24 264192 SL-IT.BIN 1.0 14/08/2015 12:33:24 1024 SRVSSL.CER ....... 07/04/2017 20:38:40 832 CLISSL.CER ....... 07/04/2017 20:38:40 824 SRVSSL.KEY ....... 07/04/2017 20:38:40 981 CLISSL.KEY ....... 07/04/2017 20:38:40 981 Other system relevant files: File Version Date Time Size Note ------------------------------------------------------------------------------- C:\LICENCE\LIC1-0000800733.TXT ....... 02/01/2019 09:53:46 349 C:\APP\CTI\ADDRBOOK\ADDRBOOK-3-0.DAT 3.0 26/12/2017 12:11:50 1536082 C:\APP\CTI\LCS\LCSTABLE.DAT 1.0 05/04/2019 15:12:10 60066 C:\APP\IPBAN\IPBAN.DAT 1.0 09/04/2019 15:18:48 192066 C:\APP\DHCP\DHCP.BND 1.0 06/04/2019 17:18:48 25600 C:\APP\IKE\IKE.CNS 1.0 23/03/2019 14:42:02 1024 C:\APP\DNS\BLACKLIST.DAT 1.0 10/08/2015 14:43:50 66 C:\APP\DNS\WHITELIST.DAT 1.0 15/05/2018 16:05:36 66 Other files in 'C:\8-8-1': File Date Time Size Note ------------------------------------------------------------------------------- trace.cpx 22/08/2017 09:00:18 79872
| Tip |
|---|---|
The automatic tracer saving feature can be activated, if the
parameter
|
| Tip |
|---|---|
Interesting chapter: Section 82.32.2, “How to convert Abilis CPX traces”. |
| |  | |
| 6.15. Test functionalities |  | 6.17. DEBUG commands |