OBJSTAT parameter

Summary

Default value

X'00'

Parameter type

User

Where set

User and $Resetn resettable

Related products

Janus SOAP

Introduced

Sirius Mods 6.7

Description

This bitmask parameter controls the display of journal messages that contain user statistics about Janus SOAP ULI object usage per request. The messages specify server table usage (VTBL and STBL) and object-swapping counts per object class and summed for all classes.

The meanings of the bits in the OBJSTAT parameter are:

X'01'

Display post-compilation object statistics to the journal.

X'02'

Display post-evaluation object statistics to the journal.

X'10'

Display post-compilation object statistics to both the terminal and the journal. If this bit is on, it doesn't matter whether the X'01' bit is on or off — post-compilation statistics will still go to the journal.

X'20'

Display post-evaluation object statistics to both the terminal and the journal. If this bit is on, it doesn't matter whether the X'02' bit is on or off — post-evaluation statistics will still go to the journal.

The layout for the OBJSTAT messages is:

• One message for each class of objects in the program, with this format:

    MSIR.0884: OBJECT classname: objects/VTBL/STBL - x/y/z, count/pages swapped a/b

• A single message that reports the sum of the counts of the preceding individual classes, with this format:

    MSIR.0884: *TOTAL*: objects/VTBL/STBL - x/y/z, count/pages swapped a/b

Where:

classname

Identifies the name of the class for which space for object instances is allocated. Sirius system classes are prefixed with 'SYSTEM:' or 'COLLECTION:', as applies. Sirius enumerations are excluded because they do not take up server space outside of what is used for the enumeration variables themselves.

x

The number of object instances for which server space is allocated for the indicated class for the request. Note that this is different from the number of object variables in a request. Object variables also take up table space, but they are fixed in size (and relatively small) and number at compile time. The actual objects, on the other hand, can be quite large, and they can often have a very large number of instances created at evaluation time. Unless a 'Sirius' compiler directive is specified, this number reflects the number of objects that Janus SOAP ULI has determined is the minimum required. Server and, in some cases for system classes, space might be required for three or four objects.

y

The VTBL units (32 bytes per unit) occupied by the allocated object instances. Each instance of an object in a given class requires the same amount of space: a fixed amount for an object header, and a non-fixed amount for each member variable (that is, every variable in the Public or Private — but not Public Shared or Private Shared — blocks). The VTBL units reported here do not include the VTBL space that is occupied by each local object reference in the main program routine. These references include object variables in declarations (including method parameter declarations and explicit and implicit method objects) and “work” object variables. These work variables are used to hold intermediate results in the evaluation of statements containing method concatenations. They may be reused within the class, and they typically do not add significantly to the VTBL space used. Object references use 2 VTBL units each, excepting XmlNodes, which use approximately 8.

a

The number of object swaps. This is the number of times objects of this class were swapped into or out of the server during the request. A swap out counts as one, and a swap in as one, so a swap in and out counts as two. Accessing a global/session object counts as a swap in, since objects do not stay in the server between requests, so they need to be swapped into/out of CCATEMP. Swaps happen only during evaluation, so this number should always be zero in the post-compilation statistics.

b

The number of 6144-byte pages swapped into or out of the server. This number should always be an integral multiple of 'count', and the multiplier should be one, except for very large objects (greater than 6144 bytes).

The following is an example of typical post-compilation OBJSTAT output:

    MSIR.0884: OBJECT LONG: objects/VTBL/STBL - 2/7/0, count/pages
                swapped 0/0
    MSIR.0884: OBJECT PT: objects/VTBL/STBL - 2/18/0, count/pages
                swapped 0/0
    MSIR.0884: OBJECT CELL: objects/VTBL/STBL - 2/20/0, count/pages
                swapped 0/0
    MSIR.0884: OBJECT BOX: objects/VTBL/STBL - 2/75/144, count/pages
                swapped 0/0
    MSIR.0884: COLLECTION SYSTEM:ARRAYLIST OF OBJECT PT:
                objects/VTBL/STBL - 3/25/0, count/pages swapped 0/0
    MSIR.0884: OBJECT SYSTEM:STRINGLIST: objects/VTBL/STBL - 3/18/0,
                count/pages swapped 0/0
    MSIR.0884: *TOTAL*: objects/VTBL/STBL - 14/163/144, count/pages
                swapped 0/0

And the following is an example of typical post-evaluation OBJSTAT output:

    MSIR.0884: OBJECT LONG: objects/VTBL/STBL - 2/7/0, count/pages
                swapped 571/571
    MSIR.0884: OBJECT PT: objects/VTBL/STBL - 2/18/0, count/pages
                swapped 310/310
    MSIR.0884: OBJECT CELL: objects/VTBL/STBL - 2/20/0, count/pages
                swapped 528/528
    MSIR.0884: OBJECT BOX: objects/VTBL/STBL - 2/75/144, count/pages
                swapped 0/0
    MSIR.0884: COLLECTION SYSTEM:ARRAYLIST OF OBJECT PT:
                objects/VTBL/STBL - 3/25/0, count/pages swapped 0/0
    MSIR.0884: OBJECT SYSTEM:STRINGLIST: objects/VTBL/STBL - 3/18/0,
                count/pages swapped 0/0
    MSIR.0884: *TOTAL*: objects/VTBL/STBL - 14/163/144, count/pages
                swapped 1409/1409

As can be seen from this example, the object statistics can take up a fair amount of space and, in many cases, be quite uninteresting — classes without any swapping are typically of not much interest in post-evaluation statistics. The OBJSTMIN parameter can be used to limit the quantity of object statistics logged to the journal to those statistics that are actually of interest.

Regardless of the setting of OBJSTAT and OBJSTMIN, the since-last, user, and system OBJSWAP statistics are incremented for every object swap. It is probably worth looking at these stats before deciding whether to try to track down the cause of object swapping using OBJSTAT — if the OBJSWAP numbers are relatively low, it's probably not worth much effort looking at detailed object-swapping statistics.

Note: Before Sirius Mods version 6.9, OBJSTAT was a system manager resettable system parameter.

For more information about object swapping, see the Janus SOAP Reference Manual.