Previous Page Contents Page Next Page

3.180 SET_TRACE_TYPE

This verb specifies tracing options for SNAP-IX kernel components. You can use this verb to specify the state of tracing (on or off) at all interfaces, or to turn tracing on or off at specific interfaces (leaving tracing at other interfaces unchanged). For more information about tracing options, see the SNAP-IX Administration Guide.

This verb does not control DLC line tracing. To do this, use the ADD_DLC_TRACE verb.

This verb must be issued to a running node.

3.180.1 VCB Structure

typedef struct set_trace_type
{
   AP_UINT16        opcode;                /* verb operation code            */
   unsigned char    reserv2;               /* reserved                       */
   unsigned char    format;                /* reserved                       */
   AP_UINT16        primary_rc;            /* primary return code            */
   AP_UINT32        secondary_rc;          /* secondary return code          */
   AP_UINT16        trace_flags;           /* trace flags                    */
   AP_UINT32        truncation_length;     /* truncate each msg to this size */
   unsigned char    init_flags;            /* TRUE if initializing flags     */
   unsigned char    set_flags;             /* TRUE if setting flags          */
                                           /*  FALSE if unsetting flags      */
   unsigned char    set_internal;          /* reserved                       */
   AP_UINT16        internal_level;        /* reserved                       */
   AP_UINT32        api_flags;             /* reserved                       */
} SET_TRACE_TYPE;

3.180.2 Supplied Parameters

The application supplies the following parameters:

opcode

AP_SET_TRACE_TYPE

trace_flags

The types of tracing required. To turn off all tracing, or to turn on tracing of all types, specify one of the following values:

AP_NO_TRACE

No tracing.

AP_ALL_TRACE

Tracing of all types.

To control tracing on specific interfaces, select one or more values from the list below, combined using a logical OR operation. For more information about these trace types, see Trace Types.

If init_flags is set to AP_YES, select the values corresponding to the interfaces where you want tracing to be active, and do not select the values corresponding to the interfaces where you want it to be inactive. If init_flags is set to AP_NO, select the values corresponding to the interfaces where you want to change the state of tracing.

AP_APPC_MSG

APPC messages

AP_FM_MSG

FM messages

AP_LUA_MSG

LUA messages

AP_NOF_MSG

NOF messages

AP_MS_MSG

MS messages

AP_LLC2_MSG

LLC2 messages

AP_LLI_MSG

LLI messages

AP_MAC_MSG

MAC messages

AP_SDLC_MSG

SDLC messages (note that this option also provides additional detail in SDLC line tracing)

AP_NLI_MSG

NLI messages

AP_IPDL_MSG

Enterprise Extender (HPR/IP) messages

AP_DLC_MSG

Node to DLC messages

AP_NODE_MSG

Node messages

AP_SLIM_MSG

Messages sent between master and backup servers

AP_DATAGRAM

Datagram messages

truncation_length

Specify the maximum length, in bytes, of the information to be written to the trace file for each message. This value must be at least 256.

If a trace message is longer than the length specified in this parameter, SNAP-IX writes only the start of the message to the trace file, and discards the data beyond truncation_length. This allows you to record the most important information for each message but avoid filling up the file with long messages.

To specify no truncation (all the data from each message is written to the file), set this parameter to zero.

init_flags

Specifies whether to initialize tracing (define the tracing state at all interfaces), or to change the state of tracing at one or more interfaces (leaving the others unchanged). Possible values are:

AP_YES

Tracing is being initialized. The trace_flags parameter defines the required state of tracing at all interfaces.

AP_NO

Tracing is being changed. The trace_flags parameter defines the interfaces where tracing is being activated or deactivated; other interfaces will not be affected.

set_flags

If init_flags is set to AP_NO, this parameter specifies whether tracing is to be activated or deactivated at the requested interfaces. Possible values are:

AP_YES

Tracing is to be activated at the interfaces specified by the trace_flags parameter.

AP_NO

Tracing is to be deactivated at the interfaces specified by the trace_flags parameter.

If init_flags is set to AP_YES, this parameter is ignored.

3.180.3 Returned Parameters: Successful Execution

If the verb executes successfully, SNAP-IX returns the following parameters:

primary_rc

AP_OK

secondary_rc

Not used.

3.180.4 Returned Parameters: Parameter Check

If the verb does not execute because of a parameter error, SNAP-IX returns the following parameters:

primary_rc

AP_PARAMETER_CHECK

secondary_rc

AP_INVALID_TRUNC_LEN

The truncation_length parameter specified a length of less than 256 bytes.

Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.

3.180.5 Returned Parameters: Other Conditions

Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs.

3.180.6 Trace Types

Overall Structure of SNAP-IX, shows the overall structure of SNAP-IX. Each kernel-space trace type, relating to data transferred across a particular interface between SNAP-IX components, is shown in the diagram at the interface where it is traced.

Overall Structure of SNAP-IX

Overall Structure of SNAP-IX shows the following types of tracing, each of which can be controlled separately:

APPC messages

Messages between the APPC library and the node

FM messages

Messages between a 3270 emulation program, LU0 application, or RJE workstation and the node

LUA messages

Messages between the LUA library and the node

NOF messages

Messages between the NOF library and the node

MS messages

Messages between the MS library and the node

DLC line trace

SNA data sent on a DLC (tracing on these messages is controlled by the ADD_DLC_TRACE verb, not by SET_TRACE_TYPE)

Node to DLC messages

Messages between the APPN node and the DLC component

In addition, the following message types (internal to SNAP-IX) can be traced:

Node messages

Messages between components within the APPN protocol code

SLIM messages

Messages sent between master and backup servers in a client-server system

Control messages

Internal control messages between system components

Previous Page Contents Page Top of Page Next page