FPZ4ABC — Submit compression request

Description

The FPZ4ABC service submits a single autonomous compression request for Start of change one or more DEFLATE blocks End of change . The input and output buffers can be either direct buffers or scatter/gather lists. The maximum size of a request for FPZ4ABC is 1 MB.

Table 1. Environment for the FPZ4ABC service
Environmental factor	Requirement
Minimum authorization:	Supervisor State with Key 0
Dispatchable unit mode:	Task or SRB
Cross memory mode:	PASN=HASN=SASN
AMODE:	64-bit
Interrupt status:	Enabled for I/O and external interrupts
Locks:	No locks held

Table 2. Parameters for the FPZ4ABC service
Name	Type	Input/Output	Description
`ApplicationId`	Fixed(32)	Input	The application type to use. 0x01 is the application type for zEDC.
FPZ4ABC_options	Bit(64)	Input	Options for the FPZ4ABC service: Inflate (X'80000000 00000000') When ON, specifies that this is an inflation request. Input Scatter List (X'40000000 00000000') When ON, the area pointed to by input@ is a scatter/gather list. Output Scatter List (X'20000000 00000000') When ON, the area pointed to by output@ is a scatter/gather list.
Rendezvous token	Char(16)	Input	The rendezvous token.
Input@	Ptr(64)	Input	The address of the input area or input scatter/gather list.
Output@	Ptr(64)	Input	The address of the output area or output scatter/gather list.
Input@RMR Token	Char(8)	Input	The region memory registration (RMR) token for the input area or area pointed to by the input scatter/gather list.
Output@RMR Token	Char(8)	Input	The region memory registration (RMR) token for the output area or area pointed to by the output scatter/gather list.
InputLen	Fixed(64)	Input	The length of the area pointed to by Input@. In the event that a scatter/gather list was provided using Input@, the total length of the areas provided by the scatter/gather areas must be provided.
OutputLen	Fixed(64)	Input	The length of the area pointed to by Output@. In the event that a scatter/gather list was provided using Output@, the total length of the areas provided by the scatter/gather areas must be provided.
GeneratedOutputLen	Fixed(64)	Output	This length describes how much output was generated and stored in either the Output@ or the scatter/gather list specified by Output@. This length spans across scatter/gather entries.
Return code	Fixed(31)	Output	The return code for the service.
Reason code	Fixed(32)	Output	The reason code for the service.

The FPZ4ABC service allows for the input and output areas to span several non-contiguous areas. The header of the FPZ4ABC list is immediately followed by the list entries. Note: All entries in the scatter/gather list must be associated with the same RMR token.

Scatter/gather lists have alignment rules and every entry in the scatter/gather list is checked for the following conditions:

The start of the first buffer in the list can be on any byte boundary.
The end of the first buffer must be on the required byte boundary.
The start / end of the intermediate buffers must be on the required byte boundary.
The start of the last buffer must be on the required byte boundary.
The end of the last buffer can be on any boundary.

All required boundaries are on 128-byte alignment. A maximum of 8 scatter/gather entries are allowed.

Table 3. Header elements in the FPZ4ABC-generated list
Name	Type	Description
# Of Entries	Fixed(32)	The number of entries in the list.
Version	Fixed(8)	The version associated with the list.
Reserved	Char(3)	Reserved space.

Table 4. Entries elements in the FPZ4ABC-generated list
Name	Type	Description
Address	Fixed(64)	The address into the area mapped by the region memory registration (RMR) token.
Length	Fixed(32)	The length of the area, starting at address, to use.
Reserved	Fixed(32)	Reserved space.

Table 5. Return and Reason Codes for the FPZ4ABC service
Hexadecimal Return Code	Reason Code	Meaning and Action
00	0000	Meaning: The call completed successfully. Action: None.
04	2000	Meaning: No zEDC devices are available. Inflate is completed in software when hardware is not available. Action: None.
08	0000	Meaning: No zEDC devices are available. Action: If zEDC devices are available to this system, perform diagnostics to determine the reason for the failure.
0C	0202	Meaning: One of the buffers had a length of 0, or the first word of a length was non-zero. Action: Check the calling program for a probable coding error. Correct the program and rerun it.
0C	0203	Meaning: A failure occurred while accessing one of the provided scatter/gather buffers. Action: Check the calling program for a probable coding error. Correct the program and rerun it.
0C	0206	Meaning: The output area was not large enough to complete the request. Action: Check the calling program for a probable coding error. Correct the program and rerun it.
0C	0207	Meaning: The calling environment is invalid. The caller is either Problem State, non-zero key, or in XMEM mode. Action: Check the calling program for a probable coding error. Correct the program and rerun it.
0C	0208	Meaning: The rendezvous token is invalid. Action: Check the calling program for a probable coding error. Correct the program and rerun it.
0C	0209	Meaning: The region memory registration (RMR) token is invalid. Action: Check the calling program for a probable coding error. Correct the program and rerun it.
0C	0221	Meaning: The header of the FPZ4ABC-generated list was not formed correctly. Action: Check the calling program for a probable coding error. Correct the program and rerun it.
0C	0222	Meaning: Either zero or a number greater than the maximum supported was specified for the number of entries in the FPZ4ABC-generated list. Action: Check the calling program for a probable coding error. Correct the program and rerun it.
0C	0223	Meaning: A buffer in the scatter/gather list was not aligned properly. Action: Check the calling program for a probable coding error. Correct the program and rerun it.
0C	0224	Meaning: The total length of the buffers in the scatter/gather list does not match the length in the parmlist. Action: Check the calling program for a probable coding error. Correct the program and rerun it.
0C	0225	Meaning: Scatter/gather was requested, but it was not enabled for this rendezvous token. Action: Check the calling program for a probable coding error. Correct the program and rerun it.
0C	1202	Meaning: An address range is not contained in the region denoted by the region memory registration (RMR) token. Action: Check the calling program for a probable coding error. Correct the program and rerun it.
0C	1203	Meaning: An unsupported operation was requested. Action: Check the calling program for a probable coding error. Correct the program and rerun it.
0C	1205	Meaning: An inflate request failed because of malformed data. Action: Check the calling program for a probable coding error. Correct the program and rerun it.
0C	2101	Meaning: An inflate request failed in software mode due to malformed input data. Action: Check the calling program for a probable coding error. Correct the program and rerun it.
0C	2102	Meaning: Not enough space in the output buffer to process the request in software mode. Action: Check the calling program for a probable coding error. Correct the program and rerun it.
10	0301	Meaning: An internal component error occurred. Action: Search problem reporting databases for a fix for the problem. If no fix exists, contact the IBM Support Center.
10	0304	Meaning: A rendezvous has not yet occurred for this address space. Action: Check that the application successfully called the FPZ4RZV service.
10	1203	Meaning: There are no zEDC devices available and either the request was a deflate request or software inflate was not enabled. Action: Check the calling program for a probable coding error. Correct the program and rerun it.
10	1301	Meaning: The request failed unexpectedly for an unknown reason. Action: Search problem reporting databases for a fix for the problem. If no fix exists, contact the IBM Support Center.