Low-Level C API Key References#
This document describes the Intel® Query Processing Library (Intel® QPL) Low-Level C API. The document provides descriptions of the main entities and operations used.
- Job APIs
- Functions
- Structures
qpl_jobnext_in_ptravailable_intotal_innext_out_ptravailable_outtotal_outopflagscrcxor_checksumlast_bit_offsetlevelstatistics_modehuffman_tabledictionarymini_block_sizeidx_arrayidx_max_sizeidx_num_writtendecomp_end_processingignore_start_bitsignore_end_bitscrc64_polycrc64next_src2_ptravailable_src2src1_bit_widthsrc2_bit_widthnum_input_elementsout_bit_widthparam_lowparam_highdrop_initial_bytesinitial_output_indexparserfirst_index_min_valuelast_index_max_valuesum_valuenuma_iddata_ptr
- Huffman Table APIs
- Common Definitions
- Flags
QPL_FLAG_FIRSTQPL_FLAG_LASTQPL_FLAG_CRC32CQPL_FLAG_GZIP_MODEQPL_FLAG_HUFFMAN_BEQPL_FLAG_NO_HDRSQPL_FLAG_DECOMPRESS_ENABLEQPL_FLAG_SRC2_BEQPL_FLAG_OUT_BEQPL_FLAG_RND_ACCESSQPL_FLAG_DECOMP_FLUSH_ALWAYSQPL_FLAG_START_NEW_BLOCKQPL_FLAG_DYNAMIC_HUFFMANQPL_FLAG_OMIT_VERIFYQPL_FLAG_GEN_LITERALSQPL_FLAG_CANNED_MODEQPL_FLAG_CRC64_BEQPL_FLAG_CRC64_INVQPL_FLAG_INV_OUTQPL_FLAG_ZLIB_MODEQPL_FLAG_OMIT_CHECKSUMSQPL_FLAG_OMIT_AGGREGATESQPL_FLAG_FORCE_ARRAY_OUTPUTQPL_DEVICE_NUMA_ID_SOCKETQPL_DEVICE_NUMA_ID_CURRENTQPL_DEVICE_NUMA_ID_ANY
- Enums
- Structures
- Flags
- Status Codes
- Categories and Ranges of Status Codes
- Internal Calculators for Status Codes
- Complete List of Status Codes
qpl_statusQPL_STS_OKQPL_STS_BEING_PROCESSEDQPL_STS_MORE_OUTPUT_NEEDEDQPL_STS_MORE_INPUT_NEEDEDQPL_STS_JOB_NOT_CONTINUABLE_ERRQPL_STS_QUEUES_ARE_BUSY_ERRQPL_STS_LIBRARY_INTERNAL_ERRQPL_STS_JOB_NOT_SUBMITTEDQPL_STS_NOT_SUPPORTED_BY_WQQPL_STS_NULL_PTR_ERRQPL_STS_OPERATION_ERRQPL_STS_NOT_SUPPORTED_MODE_ERRQPL_STS_BAD_JOB_STRUCT_ERRQPL_STS_PATH_ERRQPL_STS_INVALID_PARAM_ERRQPL_STS_FLAG_CONFLICT_ERRQPL_STS_SIZE_ERRQPL_STS_BUFFER_TOO_LARGE_ERRQPL_STS_BUFFER_OVERLAP_ERRQPL_STS_CRC64_BAD_POLYNOMQPL_STS_SET_TOO_LARGE_ERRQPL_STS_PARSER_ERRQPL_STS_OUT_FORMAT_ERRQPL_STS_DROP_BITS_OVERFLOW_ERRQPL_STS_BIT_WIDTH_OUT_EXTENDED_ERRQPL_STS_DROP_BYTES_ERRQPL_STS_MISSING_HUFFMAN_TABLE_ERRQPL_STS_INVALID_HUFFMAN_TABLE_ERRQPL_STS_MISSING_INDEX_TABLE_ERRQPL_STS_INVALID_COMPRESS_STYLE_ERRQPL_STS_INFLATE_NEED_DICT_ERRQPL_STS_INVALID_DECOMP_END_PROC_ERRQPL_STS_INVALID_BLOCK_SIZE_ERRQPL_STS_UNSUPPORTED_COMPRESSION_LEVELQPL_STS_HUFFMAN_TABLE_TYPE_ERRORQPL_STS_SERIALIZATION_FORMAT_ERRORQPL_STS_SERIALIZATION_CORRUPTED_DUMPQPL_STS_HUFFMAN_BE_IGNORE_MORE_THAN_7_BITS_ERRQPL_STS_HUFFMAN_BE_ODD_INPUT_SIZE_ERRQPL_STS_INVALID_DEFLATE_DATA_ERRQPL_STS_NO_MEM_ERRQPL_STS_INDEX_ARRAY_TOO_SMALLQPL_STS_INDEX_GENERATION_ERRQPL_STS_ARCHIVE_HEADER_ERRQPL_STS_ARCHIVE_UNSUP_METHOD_ERRQPL_STS_OBJECT_ALLOCATION_ERRQPL_STS_BIG_HEADER_ERRQPL_STS_UNDEF_CL_CODE_ERRQPL_STS_FIRST_LL_CODE_16_ERRQPL_STS_FIRST_D_CODE_16_ERRQPL_STS_NO_LL_CODE_ERRQPL_STS_WRONG_NUM_LL_CODES_ERRQPL_STS_WRONG_NUM_DIST_CODES_ERRQPL_STS_BAD_CL_CODE_LEN_ERRQPL_STS_BAD_LL_CODE_LEN_ERRQPL_STS_BAD_DIST_CODE_LEN_ERRQPL_STS_BAD_LL_CODE_ERRQPL_STS_BAD_D_CODE_ERRQPL_STS_INVALID_BLOCK_TYPEQPL_STS_INVALID_STORED_LEN_ERRQPL_STS_BAD_EOF_ERRQPL_STS_BAD_LEN_ERRQPL_STS_BAD_DIST_ERRQPL_STS_REF_BEFORE_START_ERRQPL_STS_TIMEOUT_ERRQPL_STS_PRLE_FORMAT_ERRQPL_STS_OUTPUT_OVERFLOW_ERRQPL_STS_INTL_AECS_ERRQPL_STS_SRC1_TOO_SMALL_ERRQPL_STS_SRC2_IS_SHORT_ERRQPL_STS_DST_IS_SHORT_ERRQPL_STS_INTL_DIST_SPANS_MINI_BLOCKSQPL_STS_INTL_LEN_SPANS_MINI_BLOCKSQPL_STS_INTL_VERIF_INVALID_BLOCK_SIZEQPL_STS_INTL_VERIFY_ERRQPL_STS_INVALID_HUFFCODE_ERRQPL_STS_BIT_WIDTH_ERRQPL_STS_SRC_IS_SHORT_ERRQPL_STS_INTL_INVALID_COUNTQPL_STS_TOO_MANY_LL_CODES_ERRQPL_STS_TOO_MANY_D_CODES_ERRQPL_STS_INTL_INPROGQPL_STS_INTL_SUCCESSQPL_STS_INTL_PAGE_FAULTQPL_STS_INTL_INVALID_PAGE_REQQPL_STS_INTL_ANALYTIC_ERRORQPL_STS_INTL_OUTPUT_OVERFLOWQPL_STS_INTL_UNSUPPORTED_OPCODEQPL_STS_INTL_INVALID_OP_FLAGQPL_STS_INTL_NONZERO_RESERVED_FIELDQPL_STS_TRANSFER_SIZE_INVALIDQPL_STS_INTL_OVERLAPPING_BUFFERSQPL_STS_INTL_INVALID_COMP_HANDLEQPL_STS_INTL_TRANSLATION_PAGE_FAULTQPL_STS_INTL_COMPL_RECORD_UNALIGNQPL_STS_INTL_MISALIGNED_ADDRESSQPL_STS_INTL_PRIVILIGE_ERRORQPL_STS_INTL_TRAFFIC_CLASS_ERRORQPL_STS_INTL_DRAIN_PAGE_FAULTQPL_STS_INTL_INVALID_UR_CA_RESPONSEQPL_STS_INTL_READBACK_TIMEOUTQPL_STS_INTL_HARDWARE_TIMEOUTQPL_STS_INTL_PAGE_REQUEST_TIMEOUTQPL_STS_INTL_WATCHDOG_TIMER_EXPIREQPL_STS_INTL_PASID_ERRORQPL_STS_INTL_INVALID_IDPTE_HANDLEQPL_STS_INTL_IDTPE_PERMISSION_ERRORQPL_STS_INTL_ID_WINDOW_ERRORQPL_STS_INTL_UPDATE_INVALID_IDPTEQPL_STS_INTL_INVALID_WINDOW_CONTROLQPL_STS_INTL_INACCESSIBLE_DOMAINQPL_STS_INTL_INVALID_DECOMP_FLAGQPL_STS_INTL_INVALID_FILTER_FLAGQPL_STS_INTL_INVALID_INPUT_SIZEQPL_STS_INVALID_NUM_ELEMQPL_STS_INVALID_SRC1_WIDTHQPL_STS_INV_OUTPUTQPL_STS_INTL_W_PAGE_FAULTQPL_STS_INTL_W_INVALID_PAGE_REQQPL_STS_INTL_W_TRANSLATION_PFQPL_STS_INIT_HW_NOT_SUPPORTEDQPL_STS_INIT_LIBACCEL_NOT_FOUNDQPL_STS_INIT_LIBACCEL_ERRORQPL_STS_INIT_WORK_QUEUES_NOT_AVAILABLE
- Utility APIs