Previous Page Contents Page Next Page

3.3 ADD_DLC_TRACE

This verb specifies tracing on SNA messages sent on a DLC. It can be used to activate tracing on a particular DLC, port, LS, or HPR RTP connection, or on a particular session on a specified LS, and to specify which types of messages are to be traced. It can also be used to activate tracing on all DLCs, ports, link stations, and HPR RTP connections. For more information about how to use SNAP-IX tracing, see the SNAP-IX Administration Guide.

If multiple ADD_DLC_TRACE verbs relating to the same resource are issued, a message will be traced if it matches any of the verbs currently active. For example:

If you are tracing an SDLC line and would like more detailed trace information, you can get this by using internal tracing on SDLC as well as line tracing. The additional detail is formatted as part of the output for line tracing, so that you will see all of the SDLC tracing in one file. For more information, see SET_TRACE_TYPE.

3.3.1 VCB Structure

typedef struct add_dlc_trace
{
      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       */
      DLC_TRACE_FILTER    filter;             /* resource to be traced       */
} ADD_DLC_TRACE;

typedef struct dlc_trace_filter
{
      unsigned char       resource_type;      /* type of resource            */
      unsigned char       resource_name[8];   /* name of resource            */
      SNA_LFSID           lfsid;              /* session identifier          */
      unsigned char       message_type;       /* type of messages            */
} DLC_TRACE_FILTER;

typedef struct sna_lfsid
{
      union
      {
         AP_UINT16        session_id;
         struct
         {
           unsigned char  sidh;
           unsigned char  sidl;
         } s;
      } uu;
      AP_UINT16           odai;
} SNA_LFSID;

3.3.2 Supplied Parameters

The application supplies the following parameters:

opcode

AP_ADD_DLC_TRACE

filter.resource_type

Specifies the resource to be traced, and optionally the specific message types to be traced for this resource. Possible values are:

AP_ALL_RESOURCES

Set up tracing options for all DLCs, ports, link stations, and HPR RTP connections.

AP_DLC

Set up tracing options for the DLC named in resource_name , and for all ports and LSs that use this DLC.

AP_PORT

Set up tracing options for the port named in resource_name , and for all LSs that use this port.

AP_LS

Set up tracing options for the LS named in resource_name .

AP_RTP_RESOURCE_TYPE

Specify tracing options for the RTP connection named in resource_name.

AP_PORT_DEFINED_LS

Set up tracing options for the port named in resource_name , and for all defined LSs (but not implicit LSs) that use this port.

AP_PORT_IMPLICIT_LS

Set up tracing options for the port named in resource_name , and for all implicit LSs (but not defined LSs) that use this port.

filter.resource_name

The name of the DLC, port, LS, or RTP connection for which tracing is being activated. This parameter is reserved if resource_type is set to AP_ALL_RESOURCES.

If resource_type is set to AP_RTP_RESOURCE_TYPE, you can specify the name of a particular RTP connection (this name begins with the @ character), or you can set this parameter to all zeros to indicate that all RTP traffic is to be traced.

filter.lfsid

The Local Form Session Identifier for a session on the specified LS. This is only valid for resource_type AP_LS, and indicates that only messages on this session are to be traced. The structure contains the following three values, which are returned in the SESSION_STATS section of a QUERY_SESSION verb:

filter.lfsid.uu.s.sidh

Session ID high byte.

filter.lfsid.uu.s.sidl

Session ID low byte.

filter.lfsid.odai

Origin Destination Assignor Indicator.

filter.message_type

The type of messages to trace for the specified resource or session. Set this parameter to AP_TRACE_ALL to trace all messages, or specify one or more of the following values (combined using a logical OR):

AP_TRACE_XID

XID messages

AP_TRACE_SC

Session Control RUs

AP_TRACE_DFC

Data Flow Control RUs

AP_TRACE_FMD

FMD messages

AP_TRACE_SEGS

Non-BBIU segments that do not contain an RH

AP_TRACE_CTL

Messages other then MUs and XIDs

AP_TRACE_NLP

Trace Network-Layer Protocol messages

AP_TRACE_NC

Trace Network Control messages

For tracing on an RTP connection, the values AP_TRACE_XID, AP_TRACE_NLP, and AP_TRACE_CTL are ignored. At least one of the other values listed must be specified for RTP tracing.

3.3.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.3.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

Possible values are:

AP_INVALID_RESOURCE_TYPE

The resource_type parameter specified a value that was not valid.

AP_INVALID_MESSAGE_TYPE

The message_type parameter specified a value that was not valid.

INVALID_RTP_CONNECTION

The resource_name parameter does not match any RTP connection.

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

3.3.5 Returned Parameters: Other Conditions

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

Previous Page Contents Page Top of Page Next page