FairCom ISAM for C

Function Timing Support

The SnapShot API function supports profiling of c-tree API function calls (function timing) and timing of user-defined operations. The supported operations include:

• Starting and stopping the collection of c-tree API function timing statistics.
• Resetting the function timing statistics.
• Accumulating timings in user-defined timing baskets. Users may define up to 8 different timing baskets. A begin mark call establishes a high resolution starting time for the specified basket. An end mark call causes the specified basket counter to be incremented, and the elapsed time is added to the timing basket. The baskets are numbered from 0 to 7.

Note: Function timings require a significant number of calls to the high-resolution timer, and are more consistent with diagnostic or testing modes of operation.

The following table shows the parameters to pass to SnapShot to perform these operations.

Snapshot action	opcode	rqstdesc	snapbufr
Start collecting function-timing statistics. This can be called whether or not automatic snapshots are currently active. It affects the contents of snapshots written to SYSLOG, not when or if they occur. Note: The function timing controls are not available in the Server DLL model.	ctPSStimeWorkOn	NULL	NULL
Turn off function timings. Note: The function timing controls are not available in the Server DLL model.	ctPSStimeWorkOff	NULL	NULL
Mark beginning time for one of 8 user specified timing baskets.	ctPSSbegMark	Small integer between 0 and 7 (e.g., ‘3’)	NULL
Mark ending time for user specified timing basket.	ctPSSendMark	Small integer between 0 and 7 (e.g., ‘3’)	NULL
Clear all function-timing statistics.	ctPSStimeWorkClear	NULL	NULL