xref: /freebsd-src/sys/dev/qat/qat_api/common/compression/dc_header_footer.c (revision 71625ec9ad2a9bc8c09784fbd23b759830e0ee5f)

/* SPDX-License-Identifier: BSD-3-Clause */
/* Copyright(c) 2007-2022 Intel Corporation */
/**
 *****************************************************************************
 * @file dc_header_footer.c
 *
 * @ingroup Dc_DataCompression
 *
 * @description
 *      Implementation of the Data Compression header and footer operations.
 *
 *****************************************************************************/

/*
 *******************************************************************************
 * Include public/global header files
 *******************************************************************************
 */
#include "cpa.h"
#include "cpa_dc.h"
#include "icp_adf_init.h"

/*
 *******************************************************************************
 * Include private header files
 *******************************************************************************
 */
#include "dc_header_footer.h"
#include "dc_session.h"
#include "dc_datapath.h"

CpaStatus
cpaDcGenerateHeader(CpaDcSessionHandle pSessionHandle,
		    CpaFlatBuffer *pDestBuff,
		    Cpa32U *count)
{
	dc_session_desc_t *pSessionDesc = NULL;

	LAC_CHECK_NULL_PARAM(pSessionHandle);
	LAC_CHECK_NULL_PARAM(pDestBuff);
	LAC_CHECK_NULL_PARAM(pDestBuff->pData);
	LAC_CHECK_NULL_PARAM(count);

	pSessionDesc = DC_SESSION_DESC_FROM_CTX_GET(pSessionHandle);

	if (NULL == pSessionDesc) {
		QAT_UTILS_LOG("Session handle not as expected\n");
		return CPA_STATUS_INVALID_PARAM;
	}

	if (CPA_DC_DIR_DECOMPRESS == pSessionDesc->sessDirection) {
		QAT_UTILS_LOG("Invalid session direction\n");
		return CPA_STATUS_INVALID_PARAM;
	}

	if (CPA_DC_DEFLATE == pSessionDesc->compType) {
		/* Adding a Gzip header */
		if (CPA_DC_CRC32 == pSessionDesc->checksumType) {
			Cpa8U *pDest = pDestBuff->pData;

			if (pDestBuff->dataLenInBytes < DC_GZIP_HEADER_SIZE) {
				QAT_UTILS_LOG(
				    "The dataLenInBytes of the dest buffer is too small.\n");
				return CPA_STATUS_INVALID_PARAM;
			}

			pDest[0] = DC_GZIP_ID1; /* ID1 */
			pDest[1] = DC_GZIP_ID2; /* ID2 */
			pDest[2] =
			    0x08; /* CM = 8 denotes "deflate" compression */
			pDest[3] = 0x00; /* FLG = 0 denotes "No extra fields" */
			pDest[4] = 0x00;
			pDest[5] = 0x00;
			pDest[6] = 0x00;
			pDest[7] = 0x00; /* MTIME = 0x00 means time stamp not
					    available */

			/* XFL = 4 - compressor used fastest compression, */
			/* XFL = 2 - compressor used maximum compression. */
			pDest[8] = 0;
			if (CPA_DC_L1 == pSessionDesc->compLevel)
				pDest[8] = DC_GZIP_FAST_COMP;
			else if (CPA_DC_L4 >= pSessionDesc->compLevel)
				pDest[8] = DC_GZIP_MAX_COMP;

			pDest[9] =
			    DC_GZIP_FILESYSTYPE; /* OS = 0 means FAT filesystem
				  (MS-DOS, OS/2, NT/Win32), 3 - Unix */

			/* Set to the number of bytes added to the buffer */
			*count = DC_GZIP_HEADER_SIZE;
		}

		/* Adding a Zlib header */
		else if (CPA_DC_ADLER32 == pSessionDesc->checksumType) {
			Cpa8U *pDest = pDestBuff->pData;
			Cpa16U header = 0, level = 0;

			if (pDestBuff->dataLenInBytes < DC_ZLIB_HEADER_SIZE) {
				QAT_UTILS_LOG(
				    "The dataLenInBytes of the dest buffer is too small.\n");
				return CPA_STATUS_INVALID_PARAM;
			}

			/*  CMF = CM | CMINFO.
			    CM = 8 denotes "deflate" compression,
			    CMINFO = 7 indicates a 32K window size */
			/* Depending on the device, at compression levels above
			   L1, the
			   window size can be 8 or 16K bytes.
			   The file will decompress ok if a greater window size
			   is specified
			   in the header. */
			header =
			    (DC_ZLIB_CM_DEFLATE +
			     (DC_32K_WINDOW_SIZE << DC_ZLIB_WINDOWSIZE_OFFSET))
			    << LAC_NUM_BITS_IN_BYTE;

			switch (pSessionDesc->compLevel) {
			case CPA_DC_L1:
				level = DC_ZLIB_LEVEL_0;
				break;
			case CPA_DC_L2:
				level = DC_ZLIB_LEVEL_1;
				break;
			case CPA_DC_L3:
				level = DC_ZLIB_LEVEL_2;
				break;
			default:
				level = DC_ZLIB_LEVEL_3;
			}

			/* Bits 6 - 7: FLEVEL, compression level */
			header |= level << DC_ZLIB_FLEVEL_OFFSET;

			/* The header has to be a multiple of 31 */
			header += DC_ZLIB_HEADER_OFFSET -
			    (header % DC_ZLIB_HEADER_OFFSET);

			pDest[0] = (Cpa8U)(header >> LAC_NUM_BITS_IN_BYTE);
			pDest[1] = (Cpa8U)header;

			/* Set to the number of bytes added to the buffer */
			*count = DC_ZLIB_HEADER_SIZE;
		}

		/* If deflate but no checksum required */
		else {
			*count = 0;
		}
	} else {
		/* There is no header for other compressed data */
		*count = 0;
	}
	return CPA_STATUS_SUCCESS;
}

CpaStatus
cpaDcGenerateFooter(CpaDcSessionHandle pSessionHandle,
		    CpaFlatBuffer *pDestBuff,
		    CpaDcRqResults *pRes)
{
	dc_session_desc_t *pSessionDesc = NULL;

	LAC_CHECK_NULL_PARAM(pSessionHandle);
	LAC_CHECK_NULL_PARAM(pDestBuff);
	LAC_CHECK_NULL_PARAM(pDestBuff->pData);
	LAC_CHECK_NULL_PARAM(pRes);

	pSessionDesc = DC_SESSION_DESC_FROM_CTX_GET(pSessionHandle);

	if (NULL == pSessionDesc) {
		QAT_UTILS_LOG("Session handle not as expected\n");
		return CPA_STATUS_INVALID_PARAM;
	}

	if (CPA_DC_DIR_DECOMPRESS == pSessionDesc->sessDirection) {
		QAT_UTILS_LOG("Invalid session direction\n");
		return CPA_STATUS_INVALID_PARAM;
	}

	if (CPA_DC_DEFLATE == pSessionDesc->compType) {
		if (CPA_DC_CRC32 == pSessionDesc->checksumType) {
			Cpa8U *pDest = pDestBuff->pData;
			Cpa32U crc32 = pRes->checksum;
			Cpa64U totalLenBeforeCompress =
			    pSessionDesc->cumulativeConsumedBytes;

			if (pDestBuff->dataLenInBytes < DC_GZIP_FOOTER_SIZE) {
				QAT_UTILS_LOG(
				    "The dataLenInBytes of the dest buffer is too small.\n");
				return CPA_STATUS_INVALID_PARAM;
			}

			/* Crc32 of the uncompressed data */
			pDest[0] = (Cpa8U)crc32;
			pDest[1] = (Cpa8U)(crc32 >> LAC_NUM_BITS_IN_BYTE);
			pDest[2] = (Cpa8U)(crc32 >> 2 * LAC_NUM_BITS_IN_BYTE);
			pDest[3] = (Cpa8U)(crc32 >> 3 * LAC_NUM_BITS_IN_BYTE);

			/* Length of the uncompressed data */
			pDest[4] = (Cpa8U)totalLenBeforeCompress;
			pDest[5] = (Cpa8U)(totalLenBeforeCompress >>
					   LAC_NUM_BITS_IN_BYTE);
			pDest[6] = (Cpa8U)(totalLenBeforeCompress >>
					   2 * LAC_NUM_BITS_IN_BYTE);
			pDest[7] = (Cpa8U)(totalLenBeforeCompress >>
					   3 * LAC_NUM_BITS_IN_BYTE);

			/* Increment produced by the number of bytes added to
			 * the buffer */
			pRes->produced += DC_GZIP_FOOTER_SIZE;
		} else if (CPA_DC_ADLER32 == pSessionDesc->checksumType) {
			Cpa8U *pDest = pDestBuff->pData;
			Cpa32U adler32 = pRes->checksum;

			if (pDestBuff->dataLenInBytes < DC_ZLIB_FOOTER_SIZE) {
				QAT_UTILS_LOG(
				    "The dataLenInBytes of the dest buffer is too small.\n");
				return CPA_STATUS_INVALID_PARAM;
			}

			/* Adler32 of the uncompressed data */
			pDest[0] = (Cpa8U)(adler32 >> 3 * LAC_NUM_BITS_IN_BYTE);
			pDest[1] = (Cpa8U)(adler32 >> 2 * LAC_NUM_BITS_IN_BYTE);
			pDest[2] = (Cpa8U)(adler32 >> LAC_NUM_BITS_IN_BYTE);
			pDest[3] = (Cpa8U)adler32;

			/* Increment produced by the number of bytes added to
			 * the buffer */
			pRes->produced += DC_ZLIB_FOOTER_SIZE;
		}
	}

	return CPA_STATUS_SUCCESS;
}