VxWorks Reference Manual : Libraries

strmShow

NAME

strmShow - library for STREAMS debugging (STREAMS Option)

ROUTINES

strmDebugInit( ) - include STREAMS debugging facility in VxWorks (STREAMS Option)
strmOpenStreamsShow( ) - display all open streams in the STREAMS subsystem (STREAMS Option)
strmQueueShow( ) - display all queues in a particular stream (STREAMS Option)
strmBandShow( ) - display messages in a particular band (STREAMS Option)
strmMessageShow( ) - display information about all messages in a stream (STREAMS Option)
strmQueueStatShow( ) - display statistics about queues system-wide (STREAMS Option)
strmMsgStatShow( ) - display statistics about system-wide usage of message blocks (STREAMS Option)
strmStatShow( ) - display statistics about streams (STREAMS Option)
strmDriverModShow( ) - list configuration information for modules and devices (STREAMS Option)

DESCRIPTION

This library consists of routines to facilitate debugging of STREAMS drivers developed under VxWorks. This library provides information about streams, queues, and messages. It supports the provision of system-wide statistics, as well as information about specific streams and queues.

SEE ALSO

strmShow

---

Libraries : Routines

strmDebugInit( )

NAME

strmDebugInit( ) - include STREAMS debugging facility in VxWorks (STREAMS Option)

SYNOPSIS

STATUS strmDebugInit ()

DESCRIPTION

This routine includes the STREAMS debugging facility in VxWorks. It is called in usrNetwork.c to ensure the inclusion of this library into VxWorks.

RETURNS

N/A

SEE ALSO

strmShow

---

Libraries : Routines

strmOpenStreamsShow( )

NAME

strmOpenStreamsShow( ) - display all open streams in the STREAMS subsystem (STREAMS Option)

SYNOPSIS

void strmOpenStreamsShow
    (
    char * msg /* message to display */
    )

DESCRIPTION

This routine displays information about all open streams in the system. If msg is not NULL, it is displayed before the open streams information. This routine displays the following information: address of the stream, flags, major number associated with the stream, and minor number associated with the stream

RETURNS

N/A

SEE ALSO

strmShow

---

Libraries : Routines

strmQueueShow( )

NAME

strmQueueShow( ) - display all queues in a particular stream (STREAMS Option)

SYNOPSIS

int strmQueueShow
    (
    STHP   sth, /* pointer to the Stream Head */
    char * msg  /* message to display */
    )

DESCRIPTION

This routine displays all queues on the stream sth. If msg is not NULL, it is displayed before the rest of the information.

RETURNS

N/A

SEE ALSO

strmShow

---

Libraries : Routines

strmBandShow( )

NAME

strmBandShow( ) - display messages in a particular band (STREAMS Option)

SYNOPSIS

void strmBandShow
    (
    char *    msg, /* user specified Message to display */
    queue_t * q,   /* queue pointer to display messages from */
    int       pri  /* priority Band to display */
    )

DESCRIPTION

This routine displays information about all messages in a particular band. It displays the message type, band, and length.

RETURNS

N/A

SEE ALSO

strmShow

---

Libraries : Routines

strmMessageShow( )

NAME

strmMessageShow( ) - display information about all messages in a stream (STREAMS Option)

SYNOPSIS

void strmMessageShow
    (
    queue_t * q /* pointer to a queue in the stream */
    )

DESCRIPTION

This routine displays information about all messages in a stream. The information shown is the message type, band, and size, and the address of the message block.

RETURNS

N/A

SEE ALSO

strmShow

---

Libraries : Routines

strmQueueStatShow( )

NAME

strmQueueStatShow( ) - display statistics about queues system-wide (STREAMS Option)

SYNOPSIS

void strmQueueStatShow ( void )

DESCRIPTION

This routine displays statistics about the system-wide usage of queues. The statistics shown are:

• the number of queues allocated,
• the number of queues in use,
• the total number of queues configured,
• the maximum number of queues that can be allocated,
• the number of queue allocation failures.

RETURNS

 N/A

SEE ALSO

strmShow

---

Libraries : Routines

strmMsgStatShow( )

NAME

strmMsgStatShow( ) - display statistics about system-wide usage of message blocks (STREAMS Option)

SYNOPSIS

void strmMsgStatShow ( void )

DESCRIPTION

This routine displays statistics about the system-wide usage of STREAMS message blocks. The statistics shown are:

• the size of the message block,
• the number of message blocks available for this size,
• the number of message blocks of this size in use,
• the total number of message blocks allocated for this size,
• the total memory used by all the message blocks of this size,
• the number of calls to allocb( ) that have failed for this message-block size,
• the number of bufcall( ) requests pending due to allocb( ) failure for message blocks of this size.

This routine also prints a brief summary of:

• the number of message blocks allocated for all sizes,
• the number of data blocks allocated for all sizes,
• the total memory used by STREAMS buffers system-wide.

RETURNS

N/A

SEE ALSO

strmShow

---

Libraries : Routines

strmStatShow( )

NAME

strmStatShow( ) - display statistics about streams (STREAMS Option)

SYNOPSIS

void strmStatShow ( void )

DESCRIPTION

This routine displays the following statistics about streams:

• the number of streams allocated,
• the number of streams in use,
• the total number of streams configured,
• the maximum number of streams that can be configured,
• the number of stream allocation failures.

RETURNS

 N/A

SEE ALSO

strmShow

---

Libraries : Routines

strmDriverModShow( )

NAME

strmDriverModShow( ) - list configuration information for modules and devices (STREAMS Option)

SYNOPSIS

void strmDriverModShow
    (
    int format
    )

DESCRIPTION

This routine displays configuration information about the STREAMS modules and devices. It displays the following information under the respective column heads.

Name

name of the device

Type

STREAMS module or STREAMS device

Major

device major number, applicable only to devices

idnum

module ID number

idname

name as specified in the module_info structure

minpsz

minimum packet size allowed in the module or driver

maxpsz

maximum packet size allowed in the module or driver

lowat

low water mark

hiwat

high water mark

RETURNS

  N/A

SEE ALSO

strmShow