z/OS Cryptographic Services ICSF System Programmer's Guide
Previous topic | Next topic | Contents | Index | Contact z/OS | Library | PDF


Component Trace

z/OS Cryptographic Services ICSF System Programmer's Guide
SA22-7520-17

The ICSF component trace is written to a single buffer that is addressed from the ICSF CCVE. This buffer contains the number of entries you specify in the installation options data set TRACEENTRY parameter. If you do not specify this installation option, the default is 10000. Each entry is 96 bytes long, and the maximum number of entries allowed is 500,000. When the buffer is full, the trace is wrapped.

In addition to the service and exit trace entry information that is always provided, you can also activate ICSF component tracing for:

  • instruction trace entries
  • Sysplex CKDS trace entries
  • Sysplex PKDS trace entries
  • Sysplex TKDS trace entries

To turn tracing on for all these additional entries, use the TRACE ON command:

   TRACE CT,ON,COMP=CSF

Follow the TRACE ON command with this reply:

   R nn,END

To deactivate tracing for these additional entries, use this TRACE OFF command:

   TRACE CT,OFF,COMP=CSF

Examining the Trace Entry Buffer

To examine the trace buffer, use the CTRACE facility of the Interactive Problem Control System (IPCS) in either batch or online mode.

CSF TRACE Common Header

These items are present in every trace entry:

ASCB@
Address of the (application) ASCB
TCB@
Address of the (application) TCB
ASID
Application's address space identifier

These items are omitted in the IPCS trace SUMMARY output, and the type-specific data appears after this common header.

Service and Exit Trace Entry Types

ICSF component trace is always active, and these types of trace entries are always written to the buffer:

MISC:
Miscellaneous ICSF internal call
BSERVICE:
Before the call to service
ASERVICE:
After the call to service
BEXIT:
Before the call to exit
AEXIT:
After the call to exit
Type-Specific Data for Misc Trace Entries

These items are traced for MISC entries:

Module:
Name of the ICSF module which issued this entry
X'8':
Returned PSMID
X'4A':
CCPA pointer
X'4B'
A 4 byte field.
ID:
Internal ICSF identifier

These items appear in both IPCS SUMMARY and IPCS FULL output.

Type-Specific Data for Service Trace Entries

These items are traced for BSERVICE and ASERVICE entries:

Module:
Name of the service called
Rcode:
Return code from the service
Reason:
Reason code from the service

Rcode and Reason are meaningless for BSERVICE.

These items appear in both IPCS SUMMARY and IPCS FULL output, and the exit trace entries are not called.

Instruction Trace Entry Types

If you have activated ICSF component tracing, instruction trace entries are written to the buffer in addition to the service and exit trace entry information that is always provided:

BCRYPTO:
Before the cryptographic instruction
ACRYPTO:
After the cryptographic instruction
Type-Specific Data for Instruction Trace Entries

These items are traced for BCRYPTO and ACRYPTO entries:

GPRnn:
General Registers 0-13
ARnn:
Access Registers 3 and 8
Instruction:
The cryptographic instruction

These items appear in both IPCS SUMMARY and IPCS FULL output.

The precise meanings of the register differ for each cryptographic instruction. Indeed, the registers GPR10-GPR13 are not used by any cryptographic instruction. However, the more common registers are:

GPR00
Function called (for example, for CMD, encipher or decipher).
GPR01
Cryptographic status (only valid for ACRYPTO).
GPR02
Address of the local instruction parameter block. The length and usage of the parameter block differ from instruction to instruction and the usage from function to function within the instruction.
GPR03
Address of output text when this is of variable length (for example, ciphertext for encipher command).
GPR08
Address of input text when this is of variable length (for example, plain text for encipher command).
AR03
Access Register 3 (only useful if GPR03 is useful).
AR08
Access Register 8 (only useful if GPR08 is useful).
Sysplex CKDS Entry Types

If you have activated ICSF component tracing, these trace entries are written to the buffer in addition to the service and exit trace entry information that is always provided.

XCFMSGS:
Traces the Send of an XCF message relating to an update to a CKDS in a sysplex
XCFMSGR:
Traces the Receipt of an XCF message relating to an update to a CKDS in a sysplex
XCFENQX:
Traces the return of control to the CKDS I/O subtask following the request for an exclusive ENQ on the SYSZCKDS.ckdsdsn resource. (The difference in the timestamp values between the XCFENQX entry and the XCFMSGS entry can be used to determine the delay due to multi-system effects of using the SYSPLEXCKDS option for sysplex-wide consistency of CKDS data.)
Type-Specific Data for Sysplex CKDS Trace Entries

These items are traced for XCFMSGS, XCFMSGR, and XCFENQX entries:

ASCB:
ASCB address
TCB:
TCB address
ASID:
Address Space ID
GPRnn:
General Registers 0-12
GPRLEN:
The length of the General Registers (8 for AMODE(64) operation, 4 otherwise)
CSS:
Address of ICSF Cross-System Services (CSS) block
SYSID:
The System ID of the system originating the XCF message
MsgInfo:
The message type and CKDS action (create, update, delete)
IOStatus:
The status of the CKDS I/O operation

These items appear in both IPCS SUMMARY and IPCS FULL output.

Sysplex PKDS Entry Types

If you have activated ICSF component tracing, these trace entries are written to the buffer in addition to the service and exit trace entry information that is always provided.

XCFPMSGS:
Traces the broadcast of an XCF message related to PKDS I/O.
XCFPMSGR:
Traces the Receipt of an XCF message relating to an update to a PKDS I/O.
XCFPENQ:
Traces the return of control to the PKDS I/O subtask following the request for an exclusive ENQ on the SYSZTKDS.PKDSdsn resource.
Type-Specific Data for Sysplex PKDS Trace Entries

These items are traced for XCFTMSGS, XCFTMSGR, and XCFTENQ entries:

ASCB:
ASCB address
TCB:
TCB address
ASID:
Address Space ID
GPRnn:
General Registers 0-12
GPRLEN:
The length of the General Registers (8 for AMODE(64) operation, 4 otherwise)
CSS:
Address of ICSF Cross-System Services (CSS) block

These items appear in both IPCS SUMMARY and IPCS FULL output.

Sysplex TKDS Entry Types

If you have activated ICSF component tracing, these trace entries are written to the buffer in addition to the service and exit trace entry information that is always provided.

XCFTMSGS:
Traces the broadcast of an XCF message related to TKDS I/O.
XCFTMSGR:
Traces the Receipt of an XCF message relating to an update to a TKDS I/O.
XCFTENQ:
Traces the return of control to the TKDS I/O subtask following the request for an exclusive ENQ on the SYSZTKDS.TKDSdsn resource.
Type-Specific Data for Sysplex TKDS Trace Entries

These items are traced for XCFTMSGS, XCFTMSGR, and XCFTENQ entries:

ASCB:
ASCB address
TCB:
TCB address
ASID:
Address Space ID
GPRnn:
General Registers 0-12
GPRLEN:
The length of the General Registers (8 for AMODE(64) operation, 4 otherwise)
CSS:
Address of ICSF Cross-System Services (CSS) block

These items appear in both IPCS SUMMARY and IPCS FULL output.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014