VxWorks Reference Manual : Libraries

memShow

NAME

memShow - memory show routines

ROUTINES

memShowInit( ) - initialize the memory partition show facility
memShow( ) - show system memory partition blocks and statistics
memPartShow( ) - show partition blocks and statistics
memPartInfoGet( ) - get partition information

DESCRIPTION

This library contains memory partition information display routines. To use this facility, it must first be installed using memShowInit( ), which is called automatically when the memory partition show facility is configured into VxWorks using either of the following methods:

• If you use the configuration header files, define INCLUDE_SHOW_ROUTINES in config.h.
• If you use the Tornado project facility, select INCLUDE_MEM_SHOW.

SEE ALSO

memShow, memLib, memPartLib, VxWorks Programmer's Guide: Target Shell, windsh, Tornado User's Guide: Shell

---

Libraries : Routines

memShowInit( )

NAME

memShowInit( ) - initialize the memory partition show facility

SYNOPSIS

void memShowInit (void)

DESCRIPTION

This routine links the memory partition show facility into the VxWorks system. These routines are included automatically when this show facility is configured into VxWorks using either of the following methods:

• If you use the configuration header files, define INCLUDE_SHOW_ROUTINES in config.h.
• If you use the Tornado project facility, select INCLUDE_MEM_SHOW.

RETURNS

 N/A

SEE ALSO

memShow

---

Libraries : Routines

memShow( )

NAME

memShow( ) - show system memory partition blocks and statistics

SYNOPSIS

void memShow
    (
    int type /* 1 = list all blocks in the free list */
    )

DESCRIPTION

This routine displays statistics about the available and allocated memory in the system memory partition. It shows the number of bytes, the number of blocks, and the average block size in both free and allocated memory, and also the maximum block size of free memory. It also shows the number of blocks currently allocated and the average allocated block size.

In addition, if type is 1, the routine displays a list of all the blocks in the free list of the system partition.

EXAMPLE

    -> memShow 1

    FREE LIST:
      num     addr      size
      --- ---------- ----------
        1   0x3fee18         16
        2   0x3b1434         20
        3    0x4d188    2909400

    SUMMARY:
     status   bytes    blocks   avg block  max block
     ------ --------- -------- ---------- ----------
    current
       free   2909436        3     969812   2909400
      alloc    969060    16102         60        -
    cumulative
      alloc   1143340    16365         69        -

RETURNS

N/A

SEE ALSO

memShow, memPartShow( ), VxWorks Programmer's Guide: Target Shell, windsh, Tornado User's Guide: Shell

---

Libraries : Routines

memPartShow( )

NAME

memPartShow( ) - show partition blocks and statistics

SYNOPSIS

STATUS memPartShow
    (
    PART_ID partId, /* partition ID */
    int     type    /* 0 = statistics, 1 = statistics & list */
    )

DESCRIPTION

This routine displays statistics about the available and allocated memory in a specified memory partition. It shows the number of bytes, the number of blocks, and the average block size in both free and allocated memory, and also the maximum block size of free memory. It also shows the number of blocks currently allocated and the average allocated block size.

In addition, if type is 1, the routine displays a list of all the blocks in the free list of the specified partition.

RETURNS

OK or ERROR.

ERRNO

S_smObjLib_NOT_INITIALIZED

SEE ALSO

memShow( ), VxWorks Programmer's Guide: Target Shell, windsh, Tornado User's Guide: Shell

---

Libraries : Routines

memPartInfoGet( )

NAME

memPartInfoGet( ) - get partition information

SYNOPSIS

STATUS memPartInfoGet
    (
    PART_ID          partId,    /* partition ID */
    MEM_PART_STATS * ppartStats /* partition stats structure */
    )

DESCRIPTION

This routine takes a partition ID and a pointer to a MEM_PART_STATS structure. All the parameters of the structure are filled in with the current partition information.

RETURNS

OK if the structure has valid data, otherwise ERROR.

SEE ALSO

memShow( )