gtps1m0fSystem Macros

$DCOLC-Data Collection Hook Insertion

This system macro is for use by TPF system data collection only. It must not be used and calls to it must not be modified by anyone. This system macro provides an interface for data collection information. Information can be collected for:

The $DCOLC macro generates either an SVC linkage to a hook (in E-type code) or the hook itself (in C-type code). When active, the hook calls the corresponding collection routine.

Required Authorizations
Key0 Restricted System Common Storage

X

Format




label
A symbolic name can be assigned to the macro statement.

HOOK
A required parameter specifying the intercept type of the inline code to be generated:

ATIMER
Intercepts CPU timer external interrupts on the application I-streams.

BACKC
Intercepts BACKC macros

ENTDC
Intercepts ENTDC macros

ENTNC
Intercepts ENTNC macros

ENTRC
Intercepts ENTRC macros

MSGIN
Intercepts incoming messages

MTIMER
Intercepts CPU timer external interrupts on the main I-streams.

ROUTC
Intercepts ROUTC macros

SENDCAC
Intercepts SENDC A/C macros

SENDCK
Intercepts SENDC K macros

SIPCC
Intercepts SIPCC macros

SLMTC
Intercepts SLMTC macros

SON
Intercepts find/file macros handled by SON

VFA
Intercepts find/file macros handled by VFA

VFAFP
Intercepts find/file macros handled by VFA fast path

Entry Requirements

The entry requirements for each HOOK type are:

Hook Register(s) Register Description Mode Restriction
BACKC R9 Address of ECB EVM CP only
ENTDC R9 Address of ECB EVM CP only
ENTNC R9 Address of ECB Note CP only
ENTRC R9 Address of ECB EVM CP only
MSGIN R9 Address of ECB EVM none
ROUTC R9 Address of ECB EVM CP only
SENDCAC R9 Address of ECB EVM CP only
SENDCK R9 Address of ECB EVM CP only
SIPCC R9 Address of ECB EVM CP only
SLMTC R9 Address of ECB EVM CP only
SON R1

R9

Address of MIO

Address of ECB

EVM CP only
VFA R1

R9

Address of MIO

Address of ECB

EVM CP only
VFAFP R1

R9

Address of MIO

Address of ECB

EVM CP only
Note:
In the case of the ENTNC hook, when CE3PAT is not equal to 0, the addressing mode is EVM. When CE3PAT equals 0, the addressing mode is SVM.

Return Conditions

Programming Considerations

This macro is restricted to the data collection package only and should not be coded by any other user. The macro is called throughout the TPF system. It is used to provide an interface to data collection.

Examples

The following example generates the inline code for data collection to conditionally intercept the ENTDC macro call.

$DCOLC HOOK=ENTDC