CFDISC: Disconnect from a coupling facility list or cache structure

Use this system macro to disconnect from a coupling facility (CF) list or cache structure on a CF when you no longer require access to it.

Last updated

  • Changed in 2020 (information only; no code change).
  • Changed for PUT00.

Format

Read syntax diagramSkip visual syntax diagram CFDISC CONTOKEN= contoken,AMODE= amodedef,AMODE=3164
CONTOKEN=contoken
Specifies the connect token that was returned by the CFCONC macro. The connect token uniquely identifies the connection to a CF list or cache structure in your processor configuration.

To code, specify the name or address of the 16-character field that contains the connect token.

AMODE
specifies the format that is used by all address parameters. The valid address format values are:
amodedef
The default value specified by the AMODE parameter of the BEGIN general macro. If the AMODE parameter is not specified on the BEGIN macro, the default value is 31.
31
Indicates that addresses are specified in 31-bit format.
64
Indicates that addresses are specified in 64-bit format.

Entry requirements

The CFDISC macro must be issued from an E-type program.

Return conditions

When the CFDISC macro returns control to your program you will receive a return code in the high-order 2 bytes of register 15 (R15) and a reason code in the low-order 2 bytes of R15. All other registers remain unchanged.

Table 2 shows the hexadecimal return code, reason code, and equate symbol associated with each reason code. The ICFEQ DSECT provides equate symbols for the return and reason codes.

Table 1 indicates the equate symbols associated with each hexadecimal return code.
Table 1. Equate symbols for return codes for the CFDISC macro
Return code Equate symbol
0000 ICFRRCOK
0004 ICFRRCWARNING
0008 ICFRRCPARMERROR
000C ICFRRCENVERROR
0010 ICFRRCCOMPONENT
Table 2. Return and reason codes for the CFDISC macro
Hexadecimal Return Code Hexadecimal Reason Code Equate Symbol Meaning and Action
0000 0000 Equate Symbol: None.

Meaning: The request to disconnect from a CF structure is successful. The connect token is no longer valid and will be rejected for any subsequent disconnect requests.

Action: None.
0008 0801 Equate Symbol: ICFRRCBADPARMLIST

Meaning: A program error occurred because the address of the CFDISC parameter list is zero.

Action: Verify that the address of the CFDISC parameter list is not corrupted.
0008 0804 Equate Symbol: ICFRRCBADVERSIONNUM

Meaning: A program error occurred because the CFDISC parameter list contains a version number that is not valid.

Action: Complete the following steps:
  1. Verify that your program did not overlay the CFDISC parameter list storage.
  2. Verify that your program was assembled with the correct macro library for the z/TPF system.
0008 080A Equate Symbol: ICFRRCBADCONTOKEN

Meaning: A program error occurred because the requesting processor specified a connect token that is not valid.

Action: Correct your program to use the original connect token that was received in the CFCONC answer area after the connection request was issued.
0008 080B Equate Symbol: ICFRRCCONNINUSE

Meaning: A program error occurred because the requesting processor tried to disconnect from a CF structure that was still in use.

Action: Complete the following steps:
  1. Let all outstanding requests for the CF structure end.
  2. Issue the CFDISC macro again.
0008 08F2 Equate Symbol: ICFRRCRESTARTINCOMPLETE

Meaning: An error occurred because CF restart has not yet completed. The disconnect request is rejected because the z/TPF system has not yet completed CF restart.

Action: Complete the following steps:
  1. Wait until CF restart has completed successfully.
  2. Issue the disconnect request again.
000C 0CF0 Equate Symbol: ICFRRCAUTHLOCKERROR

Meaning: The disconnect request was rejected because the CF lock was not obtained because of an error that occurred. This error occurs when the CF fails to respond to CF commands.

Action: None.

Programming considerations

  • For information about macro register conventions, see Register conventions.
  • You can disconnect from only one CF list or cache structure at a time. If you want to disconnect from multiple CF list or cache structures, issue the CFDISC macro once for each CF list or cache structure.
  • Applications should use the deleteCache function to discontinue use of a CF cache structure by a processor rather than using the CFDISC macro.

Examples

None.