Previous Page Contents Page Next Page

3.164 QUERY_TRACE_FILE

This verb returns information about the files that SNAP-IX uses to record trace data.

This verb may be issued to a running node, or (for client-server trace files only) to a Solaris client computer on which the SNAP-IX software is running. To obtain a target handle for the client in order to issue this verb, use the CONNECT_NODE verb without specifying a node name; the NOF application must be running on the client.

On Windows clients, tracing is controlled by options in the Windows Program Registry. For more information, see the SNAP-IX Administration Guide.

3.164.1 VCB Structure

typedef struct query_trace_file
{
   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     */
   unsigned char    trace_file_type;            /* type of trace file        */
   unsigned char    dual_files;                 /* dual trace files          */
   AP_UINT32        trace_file_size;            /* trace file size           */
   unsigned char    reserv3[4];                 /* reserved                  */
   unsigned char    file_name[81];              /* file name                 */
   unsigned char    file_name_2[81];            /* second file name          */
} QUERY_TRACE_FILE;

3.164.2 Supplied Parameters

The application supplies the following parameters:

opcode

AP_QUERY_TRACE_FILE

trace_file_type

The type of trace file. Possible values are:

AP_CS_TRACE

File contains tracing on data transferred across the SNAP-IX LAN between the specified computer and other nodes (activated by the SET_CS_TRACE verb).

AP_TN_SERVER_TRACE

File contains tracing on the SNAP-IX TN server component.

AP_IPS_TRACE

File contains tracing on kernel components for the specified node (activated by the SET_TRACE_TYPE or ADD_DLC_TRACE verb).

3.164.3 Returned Parameters: Successful Execution

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

primary_rc

AP_OK

secondary_rc

Not used.

dual_files

Specifies whether tracing is to one file or to two files. Possible values are:

AP_YES

Tracing is to two files. When the first file reaches the size specified by trace_file_size, the second file is cleared, and tracing continues to the second file. When this file then reaches the size specified by trace_file_size, the first file is cleared, and tracing continues to the first file. This ensures that tracing can continue for long periods without using excessive disk space; the maximum space required is approximately twice the value of trace_file_size.

AP_NO

Tracing is to one file.

trace_file_size

The maximum size of the trace file. If dual_files is set to AP_YES, tracing will switch between the two files when the current file reaches this size. If dual_files is set to AP_NO, this parameter is ignored; the file size is not limited.

file_name

Name of the trace file, or of the first trace file if dual_files is set to AP_YES. This parameter is an ASCII string of 1-80 characters, followed by a NULL character (binary zero).

If no path is included, the file is stored in the default directory for diagnostics files, /var/opt/sna if a path is included, this is either a full path (starting with a / character) or the path relative to the default directory.

file_name_2

Name of the second trace file; this parameter is used only if dual_files is set to AP_YES. This parameter is an ASCII string of 1-80 characters, followed by a NULL character (binary zero).

If no path is included, the file is stored in the default directory for diagnostics files, /var/opt/sna if a path is included, this is either a full path (starting with a / character) or the path relative to the default directory.

3.164.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_FILE_TYPE

The trace_file_type parameter was not set to a valid value.

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

3.164.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