Return and Reason Codes

When the IXLCSP macro returns control to your program:

GPR 15 (and retcode, you coded RETCODE) contains a return code.
GPR 0 (and rsncode, if you coded RSNCODE) contains a reason code if applicable.

Macro IXLYCON 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 identifies the hexadecimal return and reason codes and the equate symbol associated with each reason code.

Table 1. Return and Reason Codes for the IXLCSP Macro
Hexadecimal Return Code	Hexadecimal Reason Code	Equate Symbol Meaning and Action
0	None.	Meaning: IXLCSP request successful. Action: None.
4	xxxx0431	Equate Symbol: IXLRSNCODEWARNINGCFLEVEL Meaning: Warning. Request completed, but the target coupling facility was at a CFLEVEL too low to process some of the specified parameters. The computation did not take those parameters into account. The CSPA_DIAGNOSTICCODE field of the IXLYCSPA answer area identifies the parameters that required a higher CFLEVEL. Action: Repeat the IXLCSP request and specify a coupling facility at or above the CFLEVEL that is identified by the CSPA_NEEDEDCFLEVEL field of the IXLYCSPA answer area.
8	xxxx0801	Equate Symbol: IXLRSNCODEBADPARMLIST Meaning: Program error. The parameter list is either not addressable or not accessible. Action: Verify that the parameter list address is valid.
8	xxxx0802	Equate Symbol: IXLRSNCODEBADPARMLISTALET Meaning: Program error. The parameter list ALET does not represent either the caller's primary address space or an address or data space on the caller's DU-AL. Action: Verify that the parameter list ALET is valid.
8	xxxx0804	Equate Symbol: IXLRSNCODEBADVERSIONNUM Meaning: The version number in the parameter list is 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 z/OS on which your program is running.
8	xxxx0807	Equate Symbol: IXLRSNCODENOTENABLED Meaning: Program error. Caller is not enabled. Action: Verify that the program is enabled for I/O and external interrupts.
8	xxxx0809	Equate Symbol: IXLRSNCODEPRIMARYNOTHOME Meaning: Program error. The requestor's primary address space is not equal to the requestor's home address space. Action: Ensure that the IXLCSP service is invoked in the correct cross-memory environment.
8	xxxx080D	Equate Symbol: IXLRSNCODEAREATOOSMALL Meaning: Program error. ANSAREA is too small, as specified by ANSLEN. Action: Ensure that the ANSLEN parameter properly reflects the size of the area specified by ANSAREA. Also, make sure that the length of ANSAREA is large enough to contain the data returned.
8	xxxx080E	Equate Symbol: IXLRSNCODEBADAREA Meaning: Program error. The answer area specified by ANSAREA is either not addressable or not accessible. Action: Ensure that the address specified for ANSAREA is valid.
8	xxxx080F	Equate Symbol: IXLRSNCODEBADAREAALET Meaning: Program error. The ANSAREA ALET is not valid. Action: Verify that the ANSAREA ALET is valid.
8	xxxx081B	Equate Symbol: IXLRSNCODENOLENTRIES Meaning: Program error. The number of lock table entries specified was 0 for a size computation for a lock structure with record data, or was negative. Action: Verify that the number of lock table entries specified is correctly defined.
8	xxxx081C	Equate Symbol: IXLRSNCODENOLISTHDRS Meaning: Program error. The number of list headers specified on list structure computations must be greater than 0. Action: Verify that the number of list headers specified is correctly defined.
8	xxxx081D	Equate Symbol: IXLRSNCODEZEROLUSERS Meaning: Program error. The number of users specified on lock structure computations must be greater than 0. Action: Verify that the number of users specified is correctly defined.
8	xxxx085C	Equate Symbol: IXLRSNCODEINVALIDLISTATTR Meaning: Program error. List structure computations must specify one of the following: lock entries, data elements, or adjunct. None was specified. Action: Verify that a required list structure attribute is specified.
8	xxxx085D	Equate Symbol: IXLRSNCODEINVALIDSTGCLASS Meaning: Program error. The value of NUMSTGCLASS cannot be 0. Action: Verify that you have specified a correct value for NUMSTGCLASS.
8	xxxx085E	Equate Symbol: IXLRSNCODEINVALIDCOCLASS Meaning: Program error. The value of NUMCOCLASS cannot be 0. Action: Verify that you have specified a correct value for NUMCOCLASS.
8	xxxx0860	Equate Symbol: IXLRSNCODEDIRRATIO Meaning: Program error. The value of DIRRATIO or DIRENTRYCOUNT cannot be 0. Directory entries are required for a cache structure. Action: Verify that you have specified a correct value for DIRRATIO or DIRENTRYCOUNT.
8	xxxx0861	Equate Symbol: IXLRSNCODEENTRYRATIO Meaning: Program error. The value of ENTRYRATIO cannot be 0 when ELEMENTRATIO is greater than 0. ENTRYCOUNT cannot be 0 when either ELEMENTCOUNT is greater than 0 or ADJUNCT=YES. SCMENTRYCOUNT cannot be 0 when either SCMELEMENTCOUNT is greater than 0 or ADJUNCT=YES. Entries are required for a list structure with data. Action: Verify that you have specified a correct value for ENTRYRATIO, ENTRYCOUNT , or SCMENTRYCOUNT .
8	xxxx0862	Equate Symbol: IXLRSNCODEMAXELEMNUM Meaning: Program error. For a list structure, MAXELEMNUM must be greater than or equal to ELEMENTRATIO divided by ENTRYRATIO if ELEMENTRATIO is not 0. For a cache structure, MAXELEMNUM must be greater than or equal to ELEMENTRATIO divided by DIRRATIO if ELEMENTRATIO is not 0. The value of MAXELEMNUM cannot be 0. Action: Verify that you have specified a correct value for MAXELEMNUM.
8	xxxx086B	Equate Symbol: IXLRSNCODEELEMINCRNUM Meaning: Program error. The value specified for ELEMINCRNUM is not valid. It must be non-zero and be a power of 2. Action: Verify that you have specified a correct value for ELEMINCRNUM.
8	xxxx0871	Equate Symbol: IXLRSNCODEMAXELEMNUMELEMCHAR Meaning: Program error. The values specified in MAXELEMNUM and either ELEMCHAR or ELEMINCRNUM would result in entries of size greater than 64K. Action: Verify that you have specified correct values for MAXELEMNUM and ELEMCHAR or ELEMINCRNUM.
8	xxxx0881	Equate Symbol: IXLRSNCODEBADCFLEVEL Meaning: Program error. Parameters are not appropriate for the CFLEVEL supported by the designated coupling facility. The field at offset SCPA_DiagnosticCode in the answer area designated by ANSAREA further describes the problem. `Diag Specified Minimum Code Parameter CFLEVEL 5 KEYTYPE=SECONDARY 9` Action: Correct the parameter value in error.
8	xxxx0882	Equate Symbol: IXLRSNCODEBADREFOPTION Meaning: Program error. The request is rejected because the specified parameter is not appropriate for the value specified for REFOPTION. For PARAMETER REFOPTION must be EMCSTGPCT>0 KEY Action: Correct the parameter value in error.
8	xxxx0883	Equate Symbol: IXLRSNCODEBADEMCSTGPCT Meaning: Program error. The value specified for EMCSTGPCT is not valid. The value must be between 0 and 10000. Action: Correct the value of EMCSTGPCT.
8	xxxx0888	Equate Symbol: IXLRSNCODEBADSTRUCTURESIZE Meaning: Program error. The request is rejected because the specified structure size is greater than the specified maximum structure size, or smaller than the calculated marginal structure size. Action: Correct the value of STRSIZE.
8	xxxx0889	Equate Symbol: IXLRSNCODECALCULATIONOVERFLOW Meaning: Program error. The request is rejected because the calculation of the structure size or counts encountered an arithmetic overflow condition. Action: Verify that all values specified are correct.
8	xxxx088A	Equate Symbol: IXLRSNCODEBADASCMODE Meaning: Program error. The request is rejected because the caller is not in primary or AR mode. Action: Ensure that the caller is running in primary or AR ASC mode.
8	xxxx088B	Equate Symbol: IXLRSNCODEBADELEMCHARORINCRNUM Meaning: Program error. The request is rejected because the caller's ELEMCHAR or ELEMINCRNUM specification exceeds the maximum data element size of the input coupling facility. Action: Correct the value of either ELEMCHAR or ELEMINCRNUM and resubmit the job.
8	xxxx088C	Equate Symbol: IXLRSNCODECOMPUTEREJECTED Meaning: Program error. The request is rejected. The request could not be processed due to input that is not valid. The field at offset CSPA_DiagnosticCode in the answer area designated by ANSAREA further describes the problem. Applicable diagnostic codes are defined in IXLYCSPA. Action: Examine the CSPA_DiagnosticCode field to identify the input that is not valid.
8	xxxx088E	Equate Symbol: IXLRSNCODEINCONSISTENTPARM Meaning: Program error. Request rejected. A keyword specification was made that also requires one or more other keywords to be specified. The field at offset CSPA_DiagnosticCode in the answer area designated by ANSAREA further describes the problem. `Diag Specified Also Code Parameter Required 1 KEYTYPE=SECONDARY ADJUNCT=YES 2 LISTCNTLTYPE=ELEMENT data elements 5 SCMALGORITHM=KEYPRIORITY1 Data elements 6 SCMALGORITHM=KEYPRIORITY1 REFOPTION=KEY 7 SCMALGORITHM=KEYPRIORITY1 Lists` Action: Correct the parameter value in error.
8	xxxx08B0	Equate Symbol: IXLRSNCODEBADSCMALGORITHM Meaning: Program error. The value specified by the SCMALGORITHM keyword is not valid. Action: Verify that you have specified a correct value for SCMALGORITHM.
8	xxxx08B1	Equate Symbol: IXLRSNCODEVALUEOUTOFRANGE Meaning: Program error. The value that is specified by an input parameter is out of range; either too low or too high. The CSPA_DIAGNOSTICCODE field of the IXLYCSPA answer area identifies the parameter that was out of bounds. Action: Ensure that you specify a value within the acceptable range for the affected parameter.
8	xxxx08BB	Equate Symbol: IXLRSNCODEMINIMUMCOUNT Meaning: Program error. Computation would result in counts smaller than the minimum entry count or the minimum element count. Applicable only when the computation request specifies SCMMAXSIZE > 0. Action: When computing by counts, specify entry and element counts greater than or equal to the minimum amount that is required for use by SCM (20000x). When computing by size, specify a size that is sufficient to produce at least the minimum number of entries and elements.
C	xxxx0C06	Equate Symbol: IXLRSNCODENOCONN Meaning: Environmental error. The system from which the request is issued lost connectivity to the coupling facility named by the CFNAME after initial validation of the coupling facility. Action: Try the request again after connectivity has been restored, or specify a different coupling facility.
C	xxxx0C68	Equate Symbol: IXLRSNCODEBADREQCFLEVEL Meaning: Environmental error. The CFLEVEL of the coupling facility that is specified by the CFNAME keyword is insufficient to process the request. `Specified Minimum Request CFLevel Any 8 ComputeSCMSize 19` Action: Try the request again and specify a coupling facility with a CFLEVEL that is sufficient for the requested calculation .
C	xxxx0C98	Equate Symbol: ISLRSNCODECFNOTACCESSIBLE Meaning: Environmental error. The coupling facility specified by the CFNAME keyword cannot be accessed from this system. Possible causes include: The coupling facility is not described by the active CFRM policy. There is no CFRM couple data set. The system from which the request is issued does not have connectivity to the coupling facility. The coupling facility has failed. Action: Investigate the possible causes why the coupling facility cannot be accessed, correct the problem, and resubmit the request.
C	FFFFFFFF	Meaning: XES functions are not available. This can occur because the coupling facility hardware necessary to provide XES function is not present. Action: Re-IPL the system, or follow your particular management protocol.
10	xxxx10xx	Meaning: Failure in XES processing. The state of the resource request is unpredictable. Action: Save the reason code information and contact the IBM® support center.