CMP return and reason codes

RC_INFO X'04'   Reason Codes

The compression operation has finished successfully. CMP is still in the sampling phase. The input data has not been compressed. The output buffer contains an image copy of the input buffer. The compression operation has finished successfully.

The compression operation has finished successfully. The Dictionary Token has been determined and returned in the storage pointed to by the DICTIONARY_TOKEN_PTR. The input data has not been compressed. The output buffer contains an image copy of the input buffer.

The compression operation has finished successfully. A rejection dictionary token has been created and returned in the field pointed to by the DICTIONARY_TOKEN_PTR.

The caller should stop calling the CMS_COMPRESS service because the statistics from interrogation and sampling indicate that this is not a good compression candidate.

The output buffer contains an image copy of the input buffer.

The compression operation has finished successfully. Only part of the input buffer is compressed. The output buffer has been filled during the compression operation but the input buffer has not been exhausted. The caller may call CMPSVCCM again to compress the remaining data in the input buffer. Be sure to set the CMPSC_BITNUM to zero and reset the CMPSC_TARGETLEN and CMPSC_TARGETADDR fields.

The decompression operation has finished successfully. The target contains decompressed data. However, not all the source data has been decompressed due to the running out of space in the TARGET.

The compression operation has finished successfully. The output buffer has been filled during the compression operation. However, the actual number of compressed bytes is greater than the original number of processed input bytes. CMP has copied the CMPSC_TARGETLEN number of bytes from the beginning of the input buffer into the output buffer. The CMPSC_TARGETLEN has been decremented by CMPSC_SOURCELEN. The CMPSC_TARGETADDR has been incremented by CMPSC_SOURCELEN.

RC_WARN X'08' Reason Codes

MPSTCGI unable to subdivide storage area for TEXT_BLK.

MPSTCGI's STORAGE RELEASE failed.

MPSTCGI's SYS1.DBBLIB deallocation failed.

The MVS/Compression Services is not available on the system. No compression processing can be performed unless a level of MVS that supports compression is installed on this system.

DFSMS Compression Management Services is not available on this system. Make sure that SMS is started.

If SMS is started, refer to the SMF records to find out what might have happened during DFSMS Compression Management Services initialization that caused it to fail.

The global structure is partially created. No new allocation for compressed format data sets is allowed.

The hardware compression instruction is not on this system.

CMP has tried to perform the necessary resource cleanup. However, some of the resources may not be successfully freed.

RC_PARM X'0C' Reason Codes

The data set is not eligible for compression because it is not one of the supported types. Only extended SAM data sets and extended VSAM KSDS data sets are supported.

The data set is not eligible for compression.

The data set attributes show that the data set will not benefit in space utilization or number of I/O operations from the compression.

Compression might incur unnecessary overhead for its data processing.

The data set is not eligible for compression be cause the CISIZE is not big enough to accommodate one KSDS data record in its uncompressed format.

The CISIZE for a nonspanned compressed KSDS must be at least 10 bytes larger than the maximum record length.

The VSAM data set is not eligible for compression because the CISIZE is not large enough to contain the data record's key field. When a data record spans CIs, the record's key field must be contained within the first CI. The CISIZE for a spanned compressed KSDS must be at least fifteen (15) bytes larger than the key field.

Key field:  key length and displacement from the beginning of the record.

RC_CALR X'10' Reason Codes

Invalid CM_OPEN_TOKEN. Sequence number in the token does not match the one in the control block, or the CMSOP block cannot be located in the CMSAS_CM_OP_CHAIN.

A request to compress or decompress but some of the operands are not provided.

A request to decompress the data but the input Dictionary Token is null.

A request to decompress the data but the input Dictionary Token is null.

Either both JFCB pointer and the AMDSB pointer are given to CMPSVCAL, or neither of the pointers is given.

The input dictionary token indicates that the data set is a rejected candidate for compression.

A request to compress or decompress but the target or source is not large enough to hold even one compression symbol.

This operation code specified on the CMPSVCPC interface is undefined.

The CMS_OPEN_TOKEN has a sequence number of X'FFFFFFFF', which indicates that not all the CMP control structures are in place.

The CMS_OPEN_TOKEN is null when it should have a value. This reason code may be returned by CMPSVCCM, CMPSVCDE, or CMPSVCCL when the input open token is null.

RC_ENVR X'14' Reason Codes

CMP cannot obtain storage for its control structure or dictionaries.

CMP cannot obtain storage for the LZ-tree.

CMS cannot obtain storage for the hardware dictionaries.

CMP cannot obtain storage for the CMS_TEXT_BLK. CMS_TXT_BLK contains the UDCT data format that is required by the CMPDBCTB routine.

RC_SEVE X'24' Reason Codes

MPSTCGI is unable to create its ESTAEX environment.

MPSTCGI's STORAGE OBTAIN failed to get the global area needed to contain the CMS global control blocks.

MPSTCGI unable to subdivide storage area for GLBL_BLK.

MPSTCGI unable to subdivide storage area for CNTL_BLK.

MPSTCGI's save of CMS's Global token failed.

MPSTCGI's get of CMS's Global token failed.

MPSTCGI's SYS1.DBBLIB allocation failed.

MPSTCGI's OPEN of SYS1.DBBLIB for BSAM input failed.

MPSTCGI's OPEN of SYS1.DBBLIB for BPAM input failed.

MPSTCGI's STORAGE OBTAIN of input buffer failed.

MPSTCGI received unexpected EOF during directory read.

MPSTCGI received permanent error during directory read.

MPSTCGI unable to subdivide storage area for CNTL index.

MPSTCGI unable to acquire storage below the line.

MPSTCGI unable to FIND member pointed to by directory.

MPSTCGI unable to READ members control card.

MPSTCGI no members found in SYS1.DBBLIB to process.

The eye-catcher in the CM_OPEN control block is bad.

The dictionary cannot be built in storage. One or more of the dictionary blocks were not loaded at startup due to I/O error.

The dictionary was not built in storage because some of the DBBs were not loaded at startup due to logic error.

The dictionary has some format error. The MVS Compression Services cannot operate properly. The MVS return code will be propagated to the caller in the low order 2 bytes of the reason code.

Invalid Dictionary Token. The Dictionary Building Blocks cannot be located in the CMS_CNTL blocks. Or, the flag in the dictionary token indicates that the token is a rejection token but the DBBs are not NULL.

Internal CMS logic error occurred.

Cannot obtain the local lock.

Cannot locate the ASCB.

In CMPSVCRC, the footprint pointer passed in is null.

Cannot save the CMSAS token with the SSF IGWFTOKM macro.

Cannot set the recovery environment. FRR is set in CMPSVCOP, CMPSVCBD, and CMPSVCCL where they either GETMAIN or FREEMAIN storage and a local lock is required.

CMPDBCTI returns a nonzero return code. It failed in initializing the LZ-tree.

CMPDBCTB returns a nonzero return code. It failed in inserting text blocks into the LZ-tree.

CMPDBCTI returns a nonzero return code. It failed in converting the LZ-tree into the hardware compression format.

The DBB is bad. CMPSTCGI marked it as invalid in the CMS_CNTL block.

The CMSAS token retrieved by IGWFTOKM does not point to a valid CMSAS block.

The CMSTASK token retrieved by IGWFTOKM does not point to a valid CMSTASK block.

The CMSAS block has a valid eye-catcher, but some other information in it is suspicious.

A null CMSAS token is returned from IGWFTOKM when a non-null CMSAS is expected.

A null CMSTASK token is returned from IGWFTOKM when a non-null CMSTASK is expected.

This reason code is set whenever the recovery routine is entered.

Cannot save the CMSTASK token with the SSF IGWFTOKM macro.

The CMSDS block has an invalid eye-catcher.

The pointer to CMSDS in the CMSOP block is null but the file does not have a dictionary token yet.

The DI block is bad. It does not have a valid eye-catcher.

The caller requested to open an EMPTY data set but there exists a CMSDS that has a nonzero count.