Return and Reason Codes

When the system returns control to your program:

GPR 15 (and RETCODE, if specified) contains a return code.
If the return code is not zero, GPR 0 (and RSNCODE, if specified) contains a reason code.

Note: The return and reason codes will also be put into the answer area (mapped by IXLYCAA), if there is one, when the request completes.

The IXLYCON macro provides equate symbols for the return and reason codes. The equate symbols associated with each hexadecimal return code are as follows:

0: IXLRETCODEOK
4: IXLRETCODEWARNING
8: IXLRETCODEPARMERROR
C: IXLRETCODEENVERROR
10: IXLRETCODECOMPERROR

The following table contains hexadecimal return and reason codes, the equate symbols associated with each reason code, and the meaning and suggested action for each return and reason code.

Table 1. Return and Reason Codes for the IXLCACHE REQUEST=WRITE_DATALIST Macro
Hexadecimal Return Code	Hexadecimal Reason Code	Equate Symbol Meaning and Action
0	None.	Meaning: If you specified a MODE value of ASYNCECB, ASYNCEXIT, or ASYNCTOKEN, the request has been successfully initiated. The answer area (ANSAREA) fields will not contain valid information until the asynchronous processing has completed. For any other MODE value, the request has successfully completed. Action: If you specified MODE=ASYNCECB, wait on the ECB you specified in REQECB. If you specified MODE=ASYNCEXIT, the connection's complete exit will be given control when the request has completed. If you specified MODE=ASYNCTOKEN, use REQTOKEN when calling IXLFCOMP to determine when the request has completed.
4	xxxx0402	Equate Symbol: IXLRSNCODEASYNCH Meaning: The request could not be processed synchronously. It will be processed asynchronously. The answer area (ANSAREA) fields will not contain valid information until the asynchronous processing has completed. If you specified MODE=SYNCECB, the ECB specified in REQECB will be posted when the request has finished. If you specified MODE=SYNCEXIT, the connection's complete exit will be given control when the request has finished. If you specified MODE=SYNCTOKEN, the REQTOKEN contains an asynchronous request token that may be used on the IXLFCOMP macro to determine when the request has completed. Action: If you specified MODE=SYNCECB, wait on the ECB you specified in REQECB. If you specified MODE=SYNCEXIT, the connection's completion exit will be given control when the request has completed. If you specified MODE=SYNCTOKEN, use REQTOKEN when calling IXLFCOMP to determine when the request has completed.
4	xxxx0409	Equate Symbol: IXLRSNCODETIMEOUT Meaning: The request has completed prematurely because the model-dependent time-out criteria of the coupling facility has been exceeded. The index of the first unprocessed write-operation-block and the offset of the current data area have been returned in the answer area (fields CAAWDLINDEX and CAAWDLDATAOFFSET). All prior write-operation-blocks have been processed. Action: To restart the request, update STARTINDEX with the value of CAAWDLINDEX and DATAOFFSET with the value of CAAWDLDATAOFFSET. For more information about premature request completion, see z/OS MVS Programming: Sysplex Services Guide.
8	xxxx0801	Equate Symbol: IXLRSNCODEBADPARMLIST Meaning: The parameter list (mfctrl) for this request is not addressable. The answer area (ANSAREA) fields are not valid. Action: Verify the parameter list address. The parameter list must be addressable in the caller's primary address space or from the caller's PASN access list. If you are issuing this macro while disabled, the parameter list must reside in either page-fixed or DREF storage. If you are issuing this macro in AR-mode and you specified the parameter list address using explicit register notation, the corresponding access register must be updated appropriately. If you are issuing this macro in AR-mode, SYSSTATE ASCENV=AR must be issued before this macro.
8	xxxx0804	Equate Symbol: IXLRSNCODEBADVERSION# Meaning: The version number in the macro parameter list is not compatible with the level of XES currently being used. The answer area (ANSAREA) fields are not valid. Action: Verify that your program did not overlay the parameter list storage. Verify that your program was assembled with the correct macro library for the release of MVS™ on which your program is running. Verify that your program is running on an MVS system that supports the version of the macro you are using.
8	xxxx080A	Equate Symbol: IXLRSNCODEBADCONTOKEN Meaning: Program error. The specified connect token (CONTOKEN) was not valid for one of the following reasons: The user with the connection identifier represented by the token has disconnected from the structure. The connector's task (the task that issued IXLCONN) ended. The specified token is not the token that was returned from IXLCONN. The request was issued from an address space other than the address space in which IXLCONN was issued. The connect token was invalidated during rebuild. The connect token was invalidated by XES. Note: The answer area (ANSAREA) fields are not valid. Action: Verify that the CONTOKEN value specified was valid and for the correct structure. The numbers on the following actions correspond to the numbers above. Discontinue use. Perform recovery and cleanup for the structure and check protocol for use of structure to determine why you did not know of the disconnection. Discontinue use. Perform recovery and cleanup for the structure and check protocol for use of structure to determine why you did not know that the task ended. Issue IXLCONN to connect to the structure. The contoken is returned in the CONACONTOKEN field of the answer area specified on the IXLCONN request. Issue your request from the same address space the IXLCONN was issued. Participate in the rebuild. When it is complete, try again. Discontinue use. Perform recovery and cleanup for the structure and check protocol for use of structure. You may want to issue IXCQUERY to get more information about the structure.
8	xxxx0819	Equate Symbol: IXLRSNCODEBADVECTOROP Meaning: The vector index in the write-operation-block indexed by CAAWDLINDEX is not valid. None of the write-operation-blocks have been processed. Action: Correct the vector index value and reissue the WRITE_DATALIST request with the same STARTINDEX and ENDINDEX values.
8	xxxx0824	Equate Symbol: IXLRSNCODEWRONGSTRTYPE Meaning: The connect token specified by CONTOKEN is not to a cache structure. Action: Verify the connect token for this cache structure. Note: The connect token can be found in the IXLCONN answer area. Verify the value specified on the TYPE= parameter of the IXLCONN request for this structure.
8	xxxx0825	Equate Symbol: IXLRSNCODENOENTRY Meaning: Program error. The request failed because the assignment suppression control indication specified in the write-operation-block was set and the entry did not exist. The data is not written. The index of the failing write-operation-block and the offset in the data block of the data area for the write-operation-block being processed are returned in the answer area (fields CAAWDLINDEX and CAAWDLDATAOFFSET). All prior write-operation-blocks were processed. Action: Reissue the request specifying for STARTINDEX the index of the next valid name element to be processed and DATAOFFSET with the offset of the next data area to be processed.
8	xxxx0826	Equate Symbol: IXLRSNCODEINCOMPATSTATE Meaning: Program error. The request failed because the state of the named data item is incompatible with the request. This may be due to one of the following conditions: The change control indicator was not set in the write-operation-block, but the data in the cache structure was marked as changed. The get cast-out lock control was set in the write-operation-block, but the cast-out lock was already held from a previous request. The get cast-out lock control was set, but the entry was marked as changed or is already locked for castout by a CASTOUT_DATA or CASTOUT_DATALIST request. The get cast-out lock control was set, but the entry is already locked for castout by another connector. The change control was not set, but the entry is marked as changed. The change control was not set, but the entry is locked for castout by a CASTOUT_DATA or CASTOUT_DATALIST request. The data is not written. The index of the failing write-operation-block (CAAWDLINDEX), the offset in the data block of the data area for the write-operation-block being processed (CAAWDLDATAOFFSET), the changed indication (CAACHANGED), the cast-out lock value (CAACOLOCKVAL), the cast-out lock state (CAACOLOCKSTATE), and the value of the local cache entry number (CAALCVINUM) are returned in the answer area. All prior write-operation-blocks were processed. Action: Check the accuracy of the following values: CAAWDLINDEX, CAAWDLDATAOFFSET, CAACHANGED, CAACOLOCKVAL, CAACOLOCKSTATE, and CAALCVINUM. Correct the values as necessary and resubmit the request.
8	xxxx082D	Equate Symbol: IXLRSNCODEBADSTGCLASS Meaning: Program error. The storage class specified in the write-operation-block exceeds the maximum defined storage class for the structure. The data is not written. The index of the write-operation-block that failed and the offset in the data block of the data area for the write-operation-block being processed are returned in the answer area (fields CAAWDLINDEX and CAAWDLDATAOFFSET). All prior write-operation-blocks were processed. Action: Correct the storage class value in the write-operation-block indexed by CAAWDLINDEX and reissue the WRITE_DATALIST request starting with that write-operation-block.
8	xxxx082E	Equate Symbol: IXLRSNCODEBADCOCLASS Meaning: Program error. The cast-out class specified in the write-operation-block exceeds the maximum number of cast-out classes defined for the cache structure. The data is not written. The index of the write-operation-block that failed and the offset in the data block of the data area for the write-operation-block being processed are returned in the answer area (fields CAAWDLINDEX and CAAWDLDATAOFFSET). All prior write-operation-blocks were processed. Action: Correct the COCLASS value in the write-operation-block to specify a valid cast-out class. The valid range for COCLASS is from 1 to the maximum value specified by the NUMCOCLASS parameter on the IXLCONN macro.
8	xxxx082F	Equate Symbol: IXLRSNCODEBADPARITY Meaning: Program error. The parity value specified in the write-operation-block was not valid. The data is not written. The index of the write-operation-block that failed and the offset in the data block of the data area for the write-operation-block being processed are returned in the answer area (fields CAAWDLINDEX and CAAWDLDATAOFFSET). All prior write-operation-blocks were processed. Action: The value specified in the request contained parity bits that were not valid. The value for the parity bits may be 00, 01, or 11 in bits 2 and 3 of the PARITY specification (xxpp xxxx where pp is the parity bits).
8	xxxx0833	Equate Symbol: IXLRSNCODEBADPGBLATTR Meaning: Program error. The storage area specified by BUFFER, or one of the buffers in the BUFLIST list is specified as being pageable (PAGEABLE=YES) but is not. Action: Change the buffer area(s) to pageable storage, or specify PAGEABLE=NO. See the PAGEABLE parameter description for specification instructions.
8	xxxx0834	Equate Symbol: IXLRSNCODEBADNONPGBLATTR Meaning: Program error. The storage area specified by BUFFER, or one of the buffers in the BUFLIST list is specified as being nonpageable (PAGEABLE=NO) but is either pageable or not addressable. Action: Ensure that: The type of storage in the buffer area corresponds to the value you specified on the PAGEABLE parameter. See the PAGEABLE parameter description for specification instructions. The correct buffer address was used. The buffer area(s) were not previously freed. If BUFLIST was specified and your program is running in AR mode, ensure that: The BUFALET specification is correct. You specified SYSSTATE ASCENV=AR before issuing the macro. If the caller is running in AR-mode and the BUFFER or BUFLIST parameter was specified using explicit register notation, the corresponding access register was updated appropriately.
8	xxxx0835	Equate Symbol: IXLRSNCODEBADDATAADDR Meaning: Program error. The storage area specified by BUFFER, or one of the buffers in the BUFLIST list, is not addressable. Action: Ensure that: The correct buffer address was used for BUFFER or for a buffer within the BUFLIST. The buffer area(s) were not previously freed. The buffer area(s) were allocated in a storage key that matches the key specified using the BUFSTGKEY parameter, or, if BUFSTGKEY is omitted, the caller's PSW key. If the caller is running in AR-mode and the BUFFER or BUFLIST parameter was specified using explicit register notation, the corresponding access register was updated appropriately. If the caller is running in AR-mode, SYSSTATE ASCENV=AR must be specified before issuing this macro. If BUFLIST was specified and your program is running in AR mode the BUFALET specification is correct.
8	xxxx0838	Equate Symbol: IXLRSNCODEBADANSAREA Meaning: Program error. The storage area specified by ANSAREA is not addressable. Action: Verify the ANSAREA address. ANSAREA must be addressable in the caller's primary address space or from the caller's PASN access list. If you are calling IXLCACHE while disabled, ANSAREA must reside in either page-fixed or DREF storage. If you are calling IXLCACHE in AR-mode and you specified the ANSAREA address using explicit register notation, the corresponding access register must be updated appropriately. If you are calling IXLCACHE in AR-mode, SYSSTATE ASCENV=AR must be issued before the IXLCACHE macro.
8	xxxx0839	Equate Symbol: IXLRSNCODEBADREQTOKENAREA Meaning: Program error. The storage area specified by REQTOKEN is not addressable. Action: Ensure that the request token area specified by REQTOKEN is valid: Verify the REQTOKEN address. If you are calling IXLCACHE while disabled, REQTOKEN must reside in either page-fixed or DREF storage. If you are calling IXLCACHE in AR-mode and you specified the REQTOKEN address using explicit register notation, the corresponding access register must be updated appropriately. If you are calling IXLCACHE in AR-mode, SYSSTATE ASCENV=AR must be issued before the IXLCACHE macro.
8	xxxx083D	Equate Symbol: IXLRSNCODEBADANSLEN Meaning: Program error. The length of the answer area, as specified by ANSLEN, is not sufficient to contain answer area information. The answer area (ANSAREA) fields do not contain valid information. Action: Increase the size of the answer area provided for the request, and rerun your program. Depending on the macro version number, specify the length of the answer area as follows: CAALEVEL0LEN indicates the level 0 mapping of the answer area. CAALEVEL1LEN indicates the level 1 mapping of the answer area. IXLCACHE macro invocations at the version 4 and higher level require an answer area length of CAALEVEL1LEN.
8	xxxx083F	Equate Symbol: IXLRSNCODEBADENTRYVERSION Meaning: Program error. The version number specified in the write-operation-block does not meet the version number criteria specified in the write-operation-block. The data is not written. The index of the write-operation-block that failed, the offset in the data block of the data area for the write-operation-block being processed, and the structure entry version number are returned in the answer area (fields CAAWDLINDEX, CAAWDLDATAOFFSET, and CAAVERSION). All prior write-operation-blocks were processed. Action:
8	xxxx0851	Equate Symbol: IXLRSNCODENOSUSPENDISABLE Meaning: Program error. The request failed because MODE=SYNCSUSPEND was specified, but the caller is disabled and cannot be suspended. Action: Either specify another MODE value or become enabled (release the CPU lock); then reissue the request.
8	xxxx0865	Equate Symbol: IXLRSNCODEBADBUFSPEC Meaning: Program error. There is an error in the buffer specification. Action: Check the following: If BUFLIST was specified, check the requirements for BUFLIST, BUFNUM, and BUFINCRNUM. If BUFFER was specified, check the requirements for BUFFER and BUFSIZE. Buffer pointer(s) in BUFLIST. Buffer boundaries.
8	xxxx0866	Equate Symbol: IXLRSNCODEBADBUFKEY Meaning: Program error. The buffer storage key specified by BUFSTGKEY is incorrect or BUFSTGKEY was not specified and the caller's PSW key does not match the key of the buffers. The data cannot be fetched from the specified buffer area. Action: Check the following: Determine if the key of the storage being used for the buffers is different from the PSW key. If BUFSTGKEY was specified, verify that the key was put in the correct bits (see the explanation of this parameter for more information).
8	xxxx0867	Equate Symbol: IXLRSNCODEBADBUFLIST Meaning: Program error. The 128-byte storage area specified by BUFLIST is not addressable. Action: Ensure that: The correct BUFLIST address was used. The BUFLIST area was not previously freed. If the caller is running in AR-mode and the BUFLIST parameter was specified using explicit register notation, the corresponding access register was updated appropriately. If the caller is disabled, then the BUFLIST must reside in either nonpageable or disabled reference storage. If your program is running in AR mode, ensure that you specified SYSSTATE ASCENV=AR before issuing the macro.
8	xxxx086A	Equate Symbol: IXLRSNCODEBADELEMNUM Meaning: Program error. The ELEMNUM specified in the write-operation-block is not valid. The data is not written. The index of the write-operation-block that failed and the offset in the data block of the data area for the write-operation-block being processed are returned in the answer area (fields CAAWDLINDEX and CAAWDLDATAOFFSET). All prior write-operation-blocks were processed. Action: Check the element information specified on the IXLCONN for this structure. The number of elements is affected by MAXELEMNUM on IXLCONN.
8	xxxx0874	Equate Symbol: IXLRSNCODEBADWDLINDEX Meaning: Program error. The value specified for either STARTINDEX or ENDINDEX is not valid. No entries are processed. Action: Ensure that: The values specified by STARTINDEX and ENDINDEX are in the range of 1 to 256. The value specified by ENDINDEX is greater than or equal to the value of STARTINDEX. The value specified by ENDINDEX does not imply a larger BUFFER size than was actually specified on the WRITE_DATALIST request.
8	xxxx087D	Equate Symbol: IXLRSNCODEBADWORBAREA Meaning: Program error. The storage area specified by WORBAREA is not addressable. Action: Ensure that: The address passed in WORBAREA is valid. The WORBAREA area was not previously freed. The WORBAREA area is addressable from the caller's primary address space or from the caller's PASM access list. If the caller is running in AR-mode and WORBAREA was specified using explicit register notation, ensure that the corresponding access register was updated appropriately. If the caller is disabled, then WORBAREA must reside in either nonpageable or disabled reference storage. If your program is running in AR mode, ensure that you specified SYSSTATE ASCENV=AR before issuing the IXLCACHE macro.
8	xxxx08AA	Equate Symbol: IXLRSNCODEELEMNUMMISMATCH Meaning: Program error. The specified data area size in the write-operation-block does not match the actual size of the corresponding data area in the data block. The data is not written. The index of the write-operation-block that failed and the offset in the data block of the data area for the write-operation-block being processed are returned in the answer area (fields CAAWDLINDEX, and CAAWDLDATAOFFSET). All prior write-operation-blocks were processed.) Action: None required.
8	xxxx08AB	Equate Symbol: IXLRSNCODEBADDATAOFFSET Meaning: Program error. A DATAOFFSET was specified that is not valid. No entries are processed and no data is returned. Action:None required.
8	xxxx08AC	Equate Symbol: IXLRSNCODEBADGETCOLOCK Meaning: Program error. In the write-operation-block the change control indicator was set and the get castout lock control indicator was also set. The data is not written. The cast-out lock is not obtained and the index of the failing write-operation-block is returned in the answer area (field CAAWDLINDEX). None of the specified write-operation-blocks were processed. Processing of the entire request was suppressed. Action: None required.
8	xxxx08AD	Equate Symbol: IXLRSNCODEBADHIGHSHAREDVIRT Meaning: Program error. The request specified a high shared virtual storage area (above 2GB). Action: None required.
8	xxxx08AF	Equate Symbol: IxlRsnCodeBadWrtSuppressCntl Meaning: On a WRITE_DATALIST request, LOCALREGCNTL=YES was specified, but the change control indicator and assignment suppression indicator were not set in a WOB. The data is not written, and the index of the failing write-operation block is returned in the ANSAREA. None of the specified write-operation blocks were processed. Processing of the entire command was suppressed. Action: The assignment suppression control indicator and change control indicator must be set in each write-operation block when LOCALREGCNTL=YES is specified. Correct the content of the WOB in error and reissue the request.
C	xxxx0C06	Equate Symbol: IXLRSNCODENOCONN Meaning: Environmental error. No connectivity to the cache structure exists. This may occur due to operator commands such as VARY PATH,OFFLINE or CONFIG CHP,OFFLINE or hardware errors such as facility or path failures. The CONTOKEN is invalidated. The request fails. Action: Either disconnect from the structure (using IXLDISC) or initiate a rebuild of the structure, if allowed (using IXLREBLD).
C	xxxx0C13	Equate Symbol: IXLRSNCODEREQPURGED Meaning: Environmental error. The request was purged prior to completion of the request. Possible reasons include: The connector failed. The connector disconnected. The requestor failed. The request was purged by IXLPURGE. Requests were purged when the connector provided an IXLEERSP response for the Rebuild Quiesce, Rebuild Stop, or Rebuild Cleanup event. The connector invoked IXLREBLD REQUEST=COMPLETE. The secondary address space was no longer valid. Action: None if this is expected. Otherwise, determine why the connector failed.
C	xxxx0C14	Equate Symbol: IXLRSNCODESTATUSUNKNOWN Meaning: Environmental error. The IXLCACHE request has completed, but the final disposition of the request cannot be determined. The answer area (ANSAREA) fields do not contain valid information. Action: Verify the validity of your data by comparing the expected results with what is in the coupling facility.
C	xxxx0C17	Equate Symbol: IXLRSNCODESTRFULL Meaning: Environmental error. Allocation of a directory entry was necessary, but was unavailable or could not be reclaimed. The data was not written. In the answer area, CAASTGCLFULL contains the storage class from which the reclaiming operation failed, CAAWDLINDEX contains the index of the write-operation-block that was being processed when the error occurred, and CAAWDLDATAOFFSET contains the offset in the data block of the data area for the write-operation-block being processed. All prior write-operation-blocks were processed. Action: Determine if any data items may be cast-out to make room for this item. Check your usage of storage classes to see if some data items can be moved to a different storage class (preferably with a lower priority) so some entries in the structure can be freed. Determine if a rebuild or an alter of the structure is necessary to make room for more data entries/items. After correcting the error, restart the WRITE_DATALIST request starting with the write-operation-block indexed by CAAWDLINDEX.
C	xxxx0C25	Equate Symbol: IXLRSNCODESTRFAILURE Meaning: Environmental error. The cache structure failed prior to completion of the request. Action: Attempt to rebuild the structure using IXLREBLD, or disconnect from the structure using IXLDISC.
C	xxxx0C68	Equate Symbol: IXLRSNCODEBADREQCFLEVEL Meaning: Environmental error. The request type is not permitted for the level of coupling facility in which the target structure is allocated. Action: Disconnect from the structure (using IXLDISC) and request that the installation provide a coupling facility of the correct CFLEVEL (CFLEVEL=12 or higher).
C	xxxx0CA0	Equate Symbol: IXLRSNCODEQUIESCEDSUSPENDFAIL Meaning: Environmental error. The request is failed because the structure is quiesced for a system-managed process and SUSPEND=FAIL is specified on the IXLCONN. Action: None, if this is expected.
C	xxxxFFFF	Equate Symbol: IXLRSNCODENOTAVAILABLE Meaning: Environmental error. XES functions are not available. The coupling facility hardware might not be present. Action: XES may not be used when XCF is running local mode. XES requires that the coupling facility be installed.
10	xxxx10xx	Equate Symbol: IXLRSNCODECOMPERROR Meaning: System error. XES processing failure. The state of the structure and the disposition of the request are unpredictable. The answer area (ANSAREA) fields do not contain valid information. Action: Save the reason code information, and contact the IBM® support center.