Status Codes

Categories and Ranges of Status Codes

QPL_PROCESSING_ERROR_BASE 0U

Processing step errors

QPL_PARAMETER_ERROR_BASE 50U

Parameter check step errors

QPL_SERVICE_LOGIC_ERROR_BASE 100U

Operation preprocessing or postprocessing errors

QPL_OPERATION_ERROR_BASE 200U

Execution step errors

QPL_OPERATION_STATUS_BASE 300U

Execution step statuses

QPL_INIT_ERROR_BASE 500U

Initialization step errors

Internal Calculators for Status Codes

QPL_PROCESSING_ERROR(x) (QPL_PROCESSING_ERROR_BASE + (x))

Calculates status for processing step

QPL_PARAMETER_ERROR(x) (QPL_PARAMETER_ERROR_BASE + (x))

Calculates status for parameter check step

QPL_SERVICE_LOGIC_ERROR(x) (QPL_SERVICE_LOGIC_ERROR_BASE + (x))

Calculates status for operation preprocessing or postprocessing step

QPL_OPERATION_ERROR(x) (QPL_OPERATION_ERROR_BASE + (x))

Calculates status for operation execution step

QPL_OPERATION_STATUS(x) (QPL_OPERATION_STATUS_BASE + (x))

Calculates status for operation execution step

QPL_INIT_ERROR(x) (QPL_INIT_ERROR_BASE + (x))

Calculates status for initialization step

Complete List of Status Codes

enum qpl_status

Intel QPL return status list (Errors marked Internal indicate an issue within the library)

Values:

enumerator QPL_STS_OK = (0U + (0))

Operation completed successfully

enumerator QPL_STS_BEING_PROCESSED = (0U + (1U))

The job is still being processed

enumerator QPL_STS_MORE_OUTPUT_NEEDED = (0U + (2U))

Compression/Decompression operation filled output buffer before finishing input

enumerator QPL_STS_MORE_INPUT_NEEDED = (0U + (3U))

Compress/Decompress operation need more input

enumerator QPL_STS_JOB_NOT_CONTINUABLE_ERR = (0U + (4U))

A job after a LAST job was not marked as FIRST

enumerator QPL_STS_QUEUES_ARE_BUSY_ERR = (0U + (5U))

Descriptor can’t be submitted into filled work queue

enumerator QPL_STS_LIBRARY_INTERNAL_ERR = (0U + (6U))

Unexpected internal error condition

enumerator QPL_STS_JOB_NOT_SUBMITTED = (0U + (7U))

The job being checked/waited has not been submitted

enumerator QPL_STS_NOT_SUPPORTED_BY_WQ = (0U + (8U))

Work queue not configured to support operation

enumerator QPL_STS_NULL_PTR_ERR = (50U + (0U))

Null pointer error

enumerator QPL_STS_OPERATION_ERR = (50U + (1U))

Non-supported value in the qpl_job operation field

enumerator QPL_STS_NOT_SUPPORTED_MODE_ERR = (50U + (2U))

Indicates an error if the requested mode is not supported

enumerator QPL_STS_BAD_JOB_STRUCT_ERR = (50U + (3U))

Indicates that the qpl_job structure does not match the operation

enumerator QPL_STS_PATH_ERR = (50U + (4U))

Incorrect value for the qpl_path input parameter

enumerator QPL_STS_INVALID_PARAM_ERR = (50U + (5U))

Invalid combination of fields in the qpl_job structure

enumerator QPL_STS_FLAG_CONFLICT_ERR = (50U + (6U))

qpl_job flags field contains conflicted values

enumerator QPL_STS_SIZE_ERR = (50U + (7U))

Incorrect size error

enumerator QPL_STS_BUFFER_TOO_LARGE_ERR = (50U + (8U))

Buffer exceeds max size supported by library

enumerator QPL_STS_BUFFER_OVERLAP_ERR = (50U + (9U))

Buffers overlap

enumerator QPL_STS_CRC64_BAD_POLYNOM = (50U + (10U))

Incorrect polynomial value for CRC64

enumerator QPL_STS_SET_TOO_LARGE_ERR = (50U + (20U))

Set is too large for operation

enumerator QPL_STS_PARSER_ERR = (50U + (21U))

Non-supported value in the qpl_job parser field

enumerator QPL_STS_OUT_FORMAT_ERR = (50U + (22U))

qpl_job out_bit_width field contains invalid value or QPL_FLAG_FORCE_ARRAY_OUTPUT is set with nominal out_bit_width

enumerator QPL_STS_DROP_BITS_OVERFLOW_ERR = (50U + (23U))

Incorrect dropBits value (param_low + param_high must be beyond 0..32)

enumerator QPL_STS_BIT_WIDTH_OUT_EXTENDED_ERR = (50U + (24U))

qpl_job bit-width field contains an invalid value for current output format

enumerator QPL_STS_DROP_BYTES_ERR = (50U + (25U))

qpl_job drop_initial_bytes field contains an invalid value

enumerator QPL_STS_MISSING_HUFFMAN_TABLE_ERR = (50U + (30U))

Flags specify NO_HDRS and DYNAMIC_HUFFMAN, but no Huffman table provided

enumerator QPL_STS_INVALID_HUFFMAN_TABLE_ERR = (50U + (31U))

Invalid Huffman table data

enumerator QPL_STS_MISSING_INDEX_TABLE_ERR = (50U + (32U))

Indexing enabled but Indexing table is not set

enumerator QPL_STS_INVALID_COMPRESS_STYLE_ERR = (50U + (33U))

The style of a compression job does not match the style of the previous related job

enumerator QPL_STS_INFLATE_NEED_DICT_ERR = (50U + (34U))

Inflate needs dictionary to perform decompression

enumerator QPL_STS_INVALID_DECOMP_END_PROC_ERR = (50U + (35U))

The qpl_job field for decompression manipulation is incorrect

enumerator QPL_STS_INVALID_BLOCK_SIZE_ERR = (50U + (36U))

Invalid block size used during indexing

enumerator QPL_STS_UNSUPPORTED_COMPRESSION_LEVEL = (50U + (37U))

Compression level is not supported

enumerator QPL_STS_HUFFMAN_TABLE_TYPE_ERROR = (50U + (38U))

Incorrect table type used

enumerator QPL_STS_SERIALIZATION_FORMAT_ERROR = (50U + (40U))

Unsupported Serialization format

enumerator QPL_STS_SERIALIZATION_CORRUPTED_DUMP = (50U + (41U))

Deserialization can’t re-create the table from the input stream

enumerator QPL_STS_HUFFMAN_BE_IGNORE_MORE_THAN_7_BITS_ERR = (50U + (45U))

Limitation in IAA 1.0, Huffman only BE16 decompression cannot work if ignore_end_bits is greater than 7

enumerator QPL_STS_HUFFMAN_BE_ODD_INPUT_SIZE_ERR = (50U + (46U))

Huffman only BE16 decompression input has an odd number of bytes

enumerator QPL_STS_INVALID_DEFLATE_DATA_ERR = (100U + (0U))

Currently unused

enumerator QPL_STS_NO_MEM_ERR = (100U + (1U))

Not enough memory for the operation

enumerator QPL_STS_INDEX_ARRAY_TOO_SMALL = (100U + (2U))

Indexing buffer is too small

enumerator QPL_STS_INDEX_GENERATION_ERR = (100U + (3U))

Mini-block creation error

enumerator QPL_STS_ARCHIVE_HEADER_ERR = (100U + (4U))

Invalid GZIP/Zlib header

enumerator QPL_STS_ARCHIVE_UNSUP_METHOD_ERR = (100U + (5U))

Gzip/Zlib header specifies unsupported compress method

enumerator QPL_STS_OBJECT_ALLOCATION_ERR = (100U + (6U))

Not able to allocate Huffman table object

enumerator QPL_STS_BIG_HEADER_ERR = (200U + (1U))

Reached the end of the input stream before decoding header and header is too big to fit in input buffer

enumerator QPL_STS_UNDEF_CL_CODE_ERR = (200U + (2U))

Bad CL code

enumerator QPL_STS_FIRST_LL_CODE_16_ERR = (200U + (3U))

First code in LL tree is 16

enumerator QPL_STS_FIRST_D_CODE_16_ERR = (200U + (4U))

First code in D tree is 16

enumerator QPL_STS_NO_LL_CODE_ERR = (200U + (5U))

All LL codes are specified with 0 length

enumerator QPL_STS_WRONG_NUM_LL_CODES_ERR = (200U + (6U))

After parsing LL code lengths, total codes != expected value

enumerator QPL_STS_WRONG_NUM_DIST_CODES_ERR = (200U + (7U))

After parsing D code lengths, total codes != expected value

enumerator QPL_STS_BAD_CL_CODE_LEN_ERR = (200U + (8U))

First CL code of length N is greater than 2^N-1

enumerator QPL_STS_BAD_LL_CODE_LEN_ERR = (200U + (9U))

First LL code of length N is greater than 2^N-1

enumerator QPL_STS_BAD_DIST_CODE_LEN_ERR = (200U + (10U))

First D code of length N is greater than 2^N-1

enumerator QPL_STS_BAD_LL_CODE_ERR = (200U + (11U))

Incorrect LL code

enumerator QPL_STS_BAD_D_CODE_ERR = (200U + (12U))

Incorrect D code

enumerator QPL_STS_INVALID_BLOCK_TYPE = (200U + (13U))

Invalid type of deflate block

enumerator QPL_STS_INVALID_STORED_LEN_ERR = (200U + (14U))

Length of stored block doesn’t match inverse length

enumerator QPL_STS_BAD_EOF_ERR = (200U + (15U))

EOB flag was set but last token was not EOB

enumerator QPL_STS_BAD_LEN_ERR = (200U + (16U))

Decoded Length code is 0 or greater 258

enumerator QPL_STS_BAD_DIST_ERR = (200U + (17U))

Decoded Distance is 0 or greater than History Buffer

enumerator QPL_STS_REF_BEFORE_START_ERR = (200U + (18U))

Distance of reference is before start of file

enumerator QPL_STS_TIMEOUT_ERR = (200U + (19U))

Library has input data, but is not making forward progress

enumerator QPL_STS_PRLE_FORMAT_ERR = (200U + (20U))

PRLE format is incorrect or is truncated

enumerator QPL_STS_OUTPUT_OVERFLOW_ERR = (200U + (21U))

Output index value is greater than max available for current output data type

enumerator QPL_STS_INTL_AECS_ERR = (200U + (22U))

Internal Error Code

enumerator QPL_STS_SRC1_TOO_SMALL_ERR = (200U + (23U))

Source 1 contained fewer than expected elements/bytes

enumerator QPL_STS_SRC2_IS_SHORT_ERR = (200U + (24U))

Source 2 contained fewer than expected elements/bytes

enumerator QPL_STS_DST_IS_SHORT_ERR = (200U + (25U))

qpl_job destination buffer has less bytes than required to process num_input_elements/bytes

enumerator QPL_STS_INTL_DIST_SPANS_MINI_BLOCKS = (200U + (26U))

Internal Error Code

enumerator QPL_STS_INTL_LEN_SPANS_MINI_BLOCKS = (200U + (27U))

Internal Error Code

enumerator QPL_STS_INTL_VERIF_INVALID_BLOCK_SIZE = (200U + (28U))

Internal Error Code

enumerator QPL_STS_INTL_VERIFY_ERR = (200U + (29U))

Internal Error Code

enumerator QPL_STS_INVALID_HUFFCODE_ERR = (200U + (30U))

Compressor tried to use an invalid huffman code

enumerator QPL_STS_BIT_WIDTH_ERR = (200U + (31U))

Bit width is out of range [1..32]

enumerator QPL_STS_SRC_IS_SHORT_ERR = (200U + (32U))

The input stream ended before specified Number of input Element was seen

enumerator QPL_STS_INTL_INVALID_COUNT = (200U + (33U))

Internal Error Code

enumerator QPL_STS_TOO_MANY_LL_CODES_ERR = (200U + (35U))

The number of LL codes specified in the DEFLATE header exceed 286

enumerator QPL_STS_TOO_MANY_D_CODES_ERR = (200U + (36U))

The number of D codes specified in the DEFLATE header exceed 30

enumerator QPL_STS_INTL_INPROG = (300U + (0U))

Internal Status Code

enumerator QPL_STS_INTL_SUCCESS = (300U + (1U))

Internal Status Code

enumerator QPL_STS_INTL_PAGE_FAULT = (300U + (3U))

Page Fault occurred on Read

enumerator QPL_STS_INTL_INVALID_PAGE_REQ = (300U + (4U))

Internal Status Code

enumerator QPL_STS_INTL_ANALYTIC_ERROR = (300U + (10U))

Internal Status Code

enumerator QPL_STS_INTL_OUTPUT_OVERFLOW = (300U + (11U))

Internal Status Code

enumerator QPL_STS_INTL_UNSUPPORTED_OPCODE = (300U + (16U))

Internal Status Code

enumerator QPL_STS_INTL_INVALID_OP_FLAG = (300U + (17U))

Internal Status Code

enumerator QPL_STS_INTL_NONZERO_RESERVED_FIELD = (300U + (18U))

Internal Status Code

enumerator QPL_STS_TRANSFER_SIZE_INVALID = (300U + (19U))

Invalid value for transfer size or maximum destination size

enumerator QPL_STS_INTL_OVERLAPPING_BUFFERS = (300U + (22U))

Internal Status Code

enumerator QPL_STS_INTL_INVALID_COMP_HANDLE = (300U + (25U))

Internal Status Code

enumerator QPL_STS_INTL_TRANSLATION_PAGE_FAULT = (300U + (26U))

Internal Status Code

enumerator QPL_STS_INTL_COMPL_RECORD_UNALIGN = (300U + (27U))

Internal Status Code

enumerator QPL_STS_INTL_MISALIGNED_ADDRESS = (300U + (28U))

Internal Status Code

enumerator QPL_STS_INTL_PRIVILIGE_ERROR = (300U + (29U))

Internal Status Code

enumerator QPL_STS_INTL_TRAFFIC_CLASS_ERROR = (300U + (30U))

Internal Status Code

enumerator QPL_STS_INTL_DRAIN_PAGE_FAULT = (300U + (31U))

Internal Status Code

enumerator QPL_STS_INTL_INVALID_UR_CA_RESPONSE = (300U + (32U))

Internal Status Code

enumerator QPL_STS_INTL_READBACK_TIMEOUT = (300U + (33U))

Internal Status Code

enumerator QPL_STS_INTL_HARDWARE_TIMEOUT = (300U + (34U))

Internal Status Code

enumerator QPL_STS_INTL_PAGE_REQUEST_TIMEOUT = (300U + (35U))

Internal Status Code

enumerator QPL_STS_INTL_WATCHDOG_TIMER_EXPIRE = (300U + (36U))

Internal Status Code

enumerator QPL_STS_INTL_PASID_ERROR = (300U + (40U))

Internal Status Code

enumerator QPL_STS_INTL_INVALID_IDPTE_HANDLE = (300U + (41U))

Internal Status Code

enumerator QPL_STS_INTL_IDTPE_PERMISSION_ERROR = (300U + (42U))

Internal Status Code

enumerator QPL_STS_INTL_ID_WINDOW_ERROR = (300U + (43U))

Internal Status Code

enumerator QPL_STS_INTL_UPDATE_INVALID_IDPTE = (300U + (44U))

Internal Status Code

enumerator QPL_STS_INTL_INVALID_WINDOW_CONTROL = (300U + (45U))

Internal Status Code

enumerator QPL_STS_INTL_INACCESSIBLE_DOMAIN = (300U + (46U))

Internal Status Code

enumerator QPL_STS_INTL_INVALID_DECOMP_FLAG = (300U + (48U))

Internal Status Code

enumerator QPL_STS_INTL_INVALID_FILTER_FLAG = (300U + (49U))

Internal Status Code

enumerator QPL_STS_INTL_INVALID_INPUT_SIZE = (300U + (50U))

Internal Status Code

enumerator QPL_STS_INVALID_NUM_ELEM = (300U + (51U))

Number Elements for Filter operation is 0

enumerator QPL_STS_INVALID_SRC1_WIDTH = (300U + (52U))

Invalid source-1 bit-width

enumerator QPL_STS_INV_OUTPUT = (300U + (53U))

Invert Output flag was used when the output was not a bit-vector

enumerator QPL_STS_INTL_W_PAGE_FAULT = (300U + (131U))

Page Fault occurred on Write

enumerator QPL_STS_INTL_W_INVALID_PAGE_REQ = (300U + (132U))

Internal Status Code

enumerator QPL_STS_INTL_W_TRANSLATION_PF = (300U + (154U))

Internal Status Code

enumerator QPL_STS_INIT_HW_NOT_SUPPORTED = (500U + (0U))

Executing using qpl_path_hardware is not supported, check library System Requirements

enumerator QPL_STS_INIT_LIBACCEL_NOT_FOUND = (500U + (1U))

libaccel is not found or not compatible

enumerator QPL_STS_INIT_LIBACCEL_ERROR = (500U + (2U))

libaccel internal error

enumerator QPL_STS_INIT_WORK_QUEUES_NOT_AVAILABLE = (500U + (3U))

Supported and enabled work queues are not found (May be due to lack of privileges e.g. lack of sudo on linux)