xref: /dpdk/drivers/compress/isal/isal_compress_pmd.c (revision 2d0c29a37a9c080c1cccb1ad7941aba2ccf5437e)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2018 Intel Corporation
3  */
4 #include <isa-l.h>
5 
6 #include <rte_bus_vdev.h>
7 #include <rte_common.h>
8 #include <rte_malloc.h>
9 #include <rte_mbuf.h>
10 #include <rte_compressdev_pmd.h>
11 
12 #include "isal_compress_pmd_private.h"
13 
14 #define RTE_COMP_ISAL_WINDOW_SIZE 15
15 #define RTE_COMP_ISAL_LEVEL_ZERO 0 /* ISA-L Level 0 used for fixed Huffman */
16 #define RTE_COMP_ISAL_LEVEL_ONE 1
17 #define RTE_COMP_ISAL_LEVEL_TWO 2
18 #define RTE_COMP_ISAL_LEVEL_THREE 3 /* Optimised for AVX512 & AVX2 only */
19 #define CHKSUM_SZ_CRC 8
20 #define CHKSUM_SZ_ADLER 4
21 
22 #define STRINGIFY(s) #s
23 #define ISAL_TOSTRING(maj, min, patch) \
24 	STRINGIFY(maj)"."STRINGIFY(min)"."STRINGIFY(patch)
25 #define ISAL_VERSION_STRING \
26 	ISAL_TOSTRING(ISAL_MAJOR_VERSION, ISAL_MINOR_VERSION, ISAL_PATCH_VERSION)
27 
28 int isal_logtype_driver;
29 
30 /* Verify and set private xform parameters */
31 int
32 isal_comp_set_priv_xform_parameters(struct isal_priv_xform *priv_xform,
33 		const struct rte_comp_xform *xform)
34 {
35 	if (xform == NULL)
36 		return -EINVAL;
37 
38 	/* Set compression private xform variables */
39 	if (xform->type == RTE_COMP_COMPRESS) {
40 		/* Set private xform type - COMPRESS/DECOMPRESS */
41 		priv_xform->type = RTE_COMP_COMPRESS;
42 
43 		/* Set private xform algorithm */
44 		if (xform->compress.algo != RTE_COMP_ALGO_DEFLATE) {
45 			if (xform->compress.algo == RTE_COMP_ALGO_NULL) {
46 				ISAL_PMD_LOG(ERR, "By-pass not supported\n");
47 				return -ENOTSUP;
48 			}
49 			ISAL_PMD_LOG(ERR, "Algorithm not supported\n");
50 			return -ENOTSUP;
51 		}
52 		priv_xform->compress.algo = RTE_COMP_ALGO_DEFLATE;
53 
54 		/* Set private xform window size, 32K supported */
55 		if (xform->compress.window_size == RTE_COMP_ISAL_WINDOW_SIZE)
56 			priv_xform->compress.window_size =
57 					RTE_COMP_ISAL_WINDOW_SIZE;
58 		else {
59 			ISAL_PMD_LOG(ERR, "Window size not supported\n");
60 			return -ENOTSUP;
61 		}
62 
63 		/* Set private xform huffman type */
64 		switch (xform->compress.deflate.huffman) {
65 		case(RTE_COMP_HUFFMAN_DEFAULT):
66 			priv_xform->compress.deflate.huffman =
67 					RTE_COMP_HUFFMAN_DEFAULT;
68 			break;
69 		case(RTE_COMP_HUFFMAN_FIXED):
70 			priv_xform->compress.deflate.huffman =
71 					RTE_COMP_HUFFMAN_FIXED;
72 			break;
73 		case(RTE_COMP_HUFFMAN_DYNAMIC):
74 			priv_xform->compress.deflate.huffman =
75 					RTE_COMP_HUFFMAN_DYNAMIC;
76 			break;
77 		default:
78 			ISAL_PMD_LOG(ERR, "Huffman code not supported\n");
79 			return -ENOTSUP;
80 		}
81 
82 		/* Set private xform checksum */
83 		switch (xform->compress.chksum) {
84 		/* Raw deflate by default */
85 		case(RTE_COMP_CHECKSUM_NONE):
86 			priv_xform->compress.chksum = IGZIP_DEFLATE;
87 			break;
88 		case(RTE_COMP_CHECKSUM_CRC32):
89 			priv_xform->compress.chksum = IGZIP_GZIP_NO_HDR;
90 			break;
91 		case(RTE_COMP_CHECKSUM_ADLER32):
92 			priv_xform->compress.chksum = IGZIP_ZLIB_NO_HDR;
93 			break;
94 		case(RTE_COMP_CHECKSUM_CRC32_ADLER32):
95 			ISAL_PMD_LOG(ERR, "Combined CRC and ADLER checksum not"
96 					" supported\n");
97 			return -ENOTSUP;
98 		default:
99 			ISAL_PMD_LOG(ERR, "Checksum type not supported\n");
100 			priv_xform->compress.chksum = IGZIP_DEFLATE;
101 			break;
102 		}
103 
104 		/* Set private xform level.
105 		 * Checking compliance with compressdev API, -1 <= level => 9
106 		 */
107 		if (xform->compress.level < RTE_COMP_LEVEL_PMD_DEFAULT ||
108 				xform->compress.level > RTE_COMP_LEVEL_MAX) {
109 			ISAL_PMD_LOG(ERR, "Compression level out of range\n");
110 			return -EINVAL;
111 		}
112 		/* Check for Compressdev API level 0, No compression
113 		 * not supported in ISA-L
114 		 */
115 		else if (xform->compress.level == RTE_COMP_LEVEL_NONE) {
116 			ISAL_PMD_LOG(ERR, "No Compression not supported\n");
117 			return -ENOTSUP;
118 		}
119 		/* If using fixed huffman code, level must be 0 */
120 		else if (priv_xform->compress.deflate.huffman ==
121 				RTE_COMP_HUFFMAN_FIXED) {
122 			ISAL_PMD_LOG(DEBUG, "ISA-L level 0 used due to a"
123 					" fixed huffman code\n");
124 			priv_xform->compress.level = RTE_COMP_ISAL_LEVEL_ZERO;
125 			priv_xform->level_buffer_size =
126 					ISAL_DEF_LVL0_DEFAULT;
127 		} else {
128 			/* Mapping API levels to ISA-L levels 1,2 & 3 */
129 			switch (xform->compress.level) {
130 			case RTE_COMP_LEVEL_PMD_DEFAULT:
131 				/* Default is 1 if not using fixed huffman */
132 				priv_xform->compress.level =
133 						RTE_COMP_ISAL_LEVEL_ONE;
134 				priv_xform->level_buffer_size =
135 						ISAL_DEF_LVL1_DEFAULT;
136 				break;
137 			case RTE_COMP_LEVEL_MIN:
138 				priv_xform->compress.level =
139 						RTE_COMP_ISAL_LEVEL_ONE;
140 				priv_xform->level_buffer_size =
141 						ISAL_DEF_LVL1_DEFAULT;
142 				break;
143 			case RTE_COMP_ISAL_LEVEL_TWO:
144 				priv_xform->compress.level =
145 						RTE_COMP_ISAL_LEVEL_TWO;
146 				priv_xform->level_buffer_size =
147 						ISAL_DEF_LVL2_DEFAULT;
148 				break;
149 			/* Level 3 or higher requested */
150 			default:
151 				/* Check for AVX512, to use ISA-L level 3 */
152 				if (rte_cpu_get_flag_enabled(
153 						RTE_CPUFLAG_AVX512F)) {
154 					priv_xform->compress.level =
155 						RTE_COMP_ISAL_LEVEL_THREE;
156 					priv_xform->level_buffer_size =
157 						ISAL_DEF_LVL3_DEFAULT;
158 				}
159 				/* Check for AVX2, to use ISA-L level 3 */
160 				else if (rte_cpu_get_flag_enabled(
161 						RTE_CPUFLAG_AVX2)) {
162 					priv_xform->compress.level =
163 						RTE_COMP_ISAL_LEVEL_THREE;
164 					priv_xform->level_buffer_size =
165 						ISAL_DEF_LVL3_DEFAULT;
166 				} else {
167 					ISAL_PMD_LOG(DEBUG, "Requested ISA-L level"
168 						" 3 or above; Level 3 optimized"
169 						" for AVX512 & AVX2 only."
170 						" level changed to 2.\n");
171 					priv_xform->compress.level =
172 						RTE_COMP_ISAL_LEVEL_TWO;
173 					priv_xform->level_buffer_size =
174 						ISAL_DEF_LVL2_DEFAULT;
175 				}
176 			}
177 		}
178 	}
179 
180 	/* Set decompression private xform variables */
181 	else if (xform->type == RTE_COMP_DECOMPRESS) {
182 
183 		/* Set private xform type - COMPRESS/DECOMPRESS */
184 		priv_xform->type = RTE_COMP_DECOMPRESS;
185 
186 		/* Set private xform algorithm */
187 		if (xform->decompress.algo != RTE_COMP_ALGO_DEFLATE) {
188 			if (xform->decompress.algo == RTE_COMP_ALGO_NULL) {
189 				ISAL_PMD_LOG(ERR, "By pass not supported\n");
190 				return -ENOTSUP;
191 			}
192 			ISAL_PMD_LOG(ERR, "Algorithm not supported\n");
193 			return -ENOTSUP;
194 		}
195 		priv_xform->decompress.algo = RTE_COMP_ALGO_DEFLATE;
196 
197 		/* Set private xform checksum */
198 		switch (xform->decompress.chksum) {
199 		/* Raw deflate by default */
200 		case(RTE_COMP_CHECKSUM_NONE):
201 			priv_xform->decompress.chksum = ISAL_DEFLATE;
202 			break;
203 		case(RTE_COMP_CHECKSUM_CRC32):
204 			priv_xform->decompress.chksum = ISAL_GZIP_NO_HDR;
205 			break;
206 		case(RTE_COMP_CHECKSUM_ADLER32):
207 			priv_xform->decompress.chksum = ISAL_ZLIB_NO_HDR;
208 			break;
209 		case(RTE_COMP_CHECKSUM_CRC32_ADLER32):
210 			ISAL_PMD_LOG(ERR, "Combined CRC and ADLER checksum not"
211 					" supported\n");
212 			return -ENOTSUP;
213 		default:
214 			ISAL_PMD_LOG(ERR, "Checksum type not supported\n");
215 			priv_xform->decompress.chksum = ISAL_DEFLATE;
216 			break;
217 		}
218 
219 		/* Set private xform window size, 32K supported */
220 		if (xform->decompress.window_size == RTE_COMP_ISAL_WINDOW_SIZE)
221 			priv_xform->decompress.window_size =
222 					RTE_COMP_ISAL_WINDOW_SIZE;
223 		else {
224 			ISAL_PMD_LOG(ERR, "Window size not supported\n");
225 			return -ENOTSUP;
226 		}
227 	}
228 	return 0;
229 }
230 
231 /* Compression using chained mbufs for input/output data */
232 static int
233 chained_mbuf_compression(struct rte_comp_op *op, struct isal_comp_qp *qp)
234 {
235 	int ret;
236 	uint32_t remaining_offset;
237 	uint32_t remaining_data = op->src.length;
238 	struct rte_mbuf *src = op->m_src;
239 	struct rte_mbuf *dst = op->m_dst;
240 
241 	/* check for source/destination offset passing multiple segments
242 	 * and point compression stream to input/output buffer.
243 	 */
244 	remaining_offset = op->src.offset;
245 	while (remaining_offset >= src->data_len) {
246 		remaining_offset -= src->data_len;
247 		src = src->next;
248 	}
249 	qp->stream->avail_in = RTE_MIN(src->data_len - remaining_offset,
250 			op->src.length);
251 	qp->stream->next_in = rte_pktmbuf_mtod_offset(src, uint8_t *,
252 			remaining_offset);
253 
254 	remaining_offset = op->dst.offset;
255 	while (remaining_offset >= dst->data_len) {
256 		remaining_offset -= dst->data_len;
257 		dst = dst->next;
258 	}
259 	qp->stream->avail_out = dst->data_len - remaining_offset;
260 	qp->stream->next_out = rte_pktmbuf_mtod_offset(dst, uint8_t *,
261 			remaining_offset);
262 
263 	if (unlikely(!qp->stream->next_in || !qp->stream->next_out)) {
264 		ISAL_PMD_LOG(ERR, "Invalid source or destination buffer\n");
265 		op->status = RTE_COMP_OP_STATUS_INVALID_ARGS;
266 		return -1;
267 	}
268 
269 	while (qp->stream->internal_state.state != ZSTATE_END) {
270 		/* Last segment of data */
271 		if (remaining_data <= src->data_len)
272 			qp->stream->end_of_stream = 1;
273 
274 		/* Execute compression operation */
275 		ret = isal_deflate(qp->stream);
276 
277 		remaining_data = op->src.length - qp->stream->total_in;
278 
279 		if (ret != COMP_OK) {
280 			ISAL_PMD_LOG(ERR, "Compression operation failed\n");
281 			op->status = RTE_COMP_OP_STATUS_ERROR;
282 			return ret;
283 		}
284 
285 		if (qp->stream->avail_in == 0 &&
286 				qp->stream->total_in != op->src.length) {
287 			if (src->next != NULL) {
288 				src = src->next;
289 				qp->stream->next_in =
290 						rte_pktmbuf_mtod(src, uint8_t *);
291 				qp->stream->avail_in =
292 					RTE_MIN(remaining_data, src->data_len);
293 			} else {
294 				ISAL_PMD_LOG(ERR,
295 				"Not enough input buffer segments\n");
296 				op->status = RTE_COMP_OP_STATUS_INVALID_ARGS;
297 				return -1;
298 			}
299 		}
300 
301 		if (qp->stream->avail_out == 0 &&
302 				qp->stream->internal_state.state != ZSTATE_END) {
303 			if (dst->next != NULL) {
304 				dst = dst->next;
305 				qp->stream->next_out =
306 						rte_pktmbuf_mtod(dst, uint8_t *);
307 				qp->stream->avail_out = dst->data_len;
308 			} else {
309 				ISAL_PMD_LOG(ERR,
310 				"Not enough output buffer segments\n");
311 				op->status =
312 				RTE_COMP_OP_STATUS_OUT_OF_SPACE_TERMINATED;
313 				return -1;
314 			}
315 		}
316 	}
317 
318 	return 0;
319 }
320 
321 /* Decompression using chained mbufs for input/output data */
322 static int
323 chained_mbuf_decompression(struct rte_comp_op *op, struct isal_comp_qp *qp)
324 {
325 	int ret;
326 	uint32_t consumed_data, src_remaining_offset, dst_remaining_offset;
327 	uint32_t remaining_data = op->src.length;
328 	struct rte_mbuf *src = op->m_src;
329 	struct rte_mbuf *dst = op->m_dst;
330 
331 	/* check for offset passing multiple segments
332 	 * and point decompression state to input/output buffer
333 	 */
334 	src_remaining_offset = op->src.offset;
335 	while (src_remaining_offset >= src->data_len) {
336 		src_remaining_offset -= src->data_len;
337 		src = src->next;
338 	}
339 	qp->state->avail_in = RTE_MIN(src->data_len - src_remaining_offset,
340 			op->src.length);
341 	qp->state->next_in = rte_pktmbuf_mtod_offset(src, uint8_t *,
342 			src_remaining_offset);
343 
344 	dst_remaining_offset = op->dst.offset;
345 	while (dst_remaining_offset >= dst->data_len) {
346 		dst_remaining_offset -= dst->data_len;
347 		dst = dst->next;
348 	}
349 	qp->state->avail_out = dst->data_len - dst_remaining_offset;
350 	qp->state->next_out = rte_pktmbuf_mtod_offset(dst, uint8_t *,
351 			dst_remaining_offset);
352 
353 	while (qp->state->block_state != ISAL_BLOCK_FINISH) {
354 
355 		ret = isal_inflate(qp->state);
356 
357 		if (ret != ISAL_DECOMP_OK) {
358 			ISAL_PMD_LOG(ERR, "Decompression operation failed\n");
359 			op->status = RTE_COMP_OP_STATUS_ERROR;
360 			return ret;
361 		}
362 
363 		/* Check for first segment, offset needs to be accounted for */
364 		if (remaining_data == op->src.length) {
365 			consumed_data = src->data_len - src_remaining_offset;
366 		} else
367 			consumed_data = src->data_len;
368 
369 		if (qp->state->avail_in == 0
370 				&& op->consumed != op->src.length) {
371 			op->consumed += consumed_data;
372 			remaining_data -= consumed_data;
373 
374 			if (src->next != NULL) {
375 				src = src->next;
376 				qp->state->next_in =
377 						rte_pktmbuf_mtod(src, uint8_t *);
378 				qp->state->avail_in =
379 					RTE_MIN(remaining_data, src->data_len);
380 			}
381 		}
382 
383 		if (qp->state->avail_out == 0 &&
384 				qp->state->block_state != ISAL_BLOCK_FINISH) {
385 			if (dst->next != NULL) {
386 				dst = dst->next;
387 				qp->state->next_out =
388 						rte_pktmbuf_mtod(dst, uint8_t *);
389 				qp->state->avail_out = dst->data_len;
390 			} else {
391 				ISAL_PMD_LOG(ERR,
392 				"Not enough output buffer segments\n");
393 				op->status =
394 				RTE_COMP_OP_STATUS_OUT_OF_SPACE_TERMINATED;
395 				return -1;
396 			}
397 		}
398 	}
399 
400 	return 0;
401 }
402 
403 /* Stateless Compression Function */
404 static int
405 process_isal_deflate(struct rte_comp_op *op, struct isal_comp_qp *qp,
406 		struct isal_priv_xform *priv_xform)
407 {
408 	int ret = 0;
409 	op->status = RTE_COMP_OP_STATUS_SUCCESS;
410 
411 	/* Required due to init clearing level_buf */
412 	uint8_t *temp_level_buf = qp->stream->level_buf;
413 
414 	/* Initialize compression stream */
415 	isal_deflate_init(qp->stream);
416 
417 	qp->stream->level_buf = temp_level_buf;
418 
419 	/* Set Checksum flag */
420 	qp->stream->gzip_flag = priv_xform->compress.chksum;
421 
422 	/* Stateless operation, input will be consumed in one go */
423 	qp->stream->flush = NO_FLUSH;
424 
425 	/* set compression level & intermediate level buffer size */
426 	qp->stream->level = priv_xform->compress.level;
427 	qp->stream->level_buf_size = priv_xform->level_buffer_size;
428 
429 	/* Set op huffman code */
430 	if (priv_xform->compress.deflate.huffman == RTE_COMP_HUFFMAN_FIXED)
431 		isal_deflate_set_hufftables(qp->stream, NULL,
432 				IGZIP_HUFFTABLE_STATIC);
433 	else if (priv_xform->compress.deflate.huffman ==
434 			RTE_COMP_HUFFMAN_DEFAULT)
435 		isal_deflate_set_hufftables(qp->stream, NULL,
436 			IGZIP_HUFFTABLE_DEFAULT);
437 	/* Dynamically change the huffman code to suit the input data */
438 	else if (priv_xform->compress.deflate.huffman ==
439 			RTE_COMP_HUFFMAN_DYNAMIC)
440 		isal_deflate_set_hufftables(qp->stream, NULL,
441 				IGZIP_HUFFTABLE_DEFAULT);
442 
443 	if (op->m_src->pkt_len < (op->src.length + op->src.offset)) {
444 		ISAL_PMD_LOG(ERR, "Input mbuf(s) not big enough.\n");
445 		op->status = RTE_COMP_OP_STATUS_INVALID_ARGS;
446 		return -1;
447 	}
448 
449 	if (op->dst.offset >= op->m_dst->pkt_len) {
450 		ISAL_PMD_LOG(ERR, "Output mbuf(s) not big enough"
451 				" for offset provided.\n");
452 		op->status = RTE_COMP_OP_STATUS_INVALID_ARGS;
453 		return -1;
454 	}
455 
456 	/* Chained mbufs */
457 	if (op->m_src->nb_segs > 1 || op->m_dst->nb_segs > 1) {
458 		ret = chained_mbuf_compression(op, qp);
459 		if (ret < 0)
460 			return ret;
461 	} else {
462 		/* Linear buffer */
463 		qp->stream->end_of_stream = 1; /* All input consumed in one */
464 		/* Point compression stream to input buffer */
465 		qp->stream->avail_in = op->src.length;
466 		qp->stream->next_in = rte_pktmbuf_mtod_offset(op->m_src,
467 				uint8_t *, op->src.offset);
468 
469 		/*  Point compression stream to output buffer */
470 		qp->stream->avail_out = op->m_dst->data_len - op->dst.offset;
471 		qp->stream->next_out  = rte_pktmbuf_mtod_offset(op->m_dst,
472 				uint8_t *, op->dst.offset);
473 
474 		if (unlikely(!qp->stream->next_in || !qp->stream->next_out)) {
475 			ISAL_PMD_LOG(ERR, "Invalid source or destination"
476 					" buffers\n");
477 			op->status = RTE_COMP_OP_STATUS_INVALID_ARGS;
478 			return -1;
479 		}
480 
481 		/* Execute compression operation */
482 		ret =  isal_deflate_stateless(qp->stream);
483 
484 		/* Check that output buffer did not run out of space */
485 		if (ret == STATELESS_OVERFLOW) {
486 			ISAL_PMD_LOG(ERR, "Output buffer not big enough\n");
487 			op->status = RTE_COMP_OP_STATUS_OUT_OF_SPACE_TERMINATED;
488 			return ret;
489 		}
490 
491 		/* Check that input buffer has been fully consumed */
492 		if (qp->stream->avail_in != (uint32_t)0) {
493 			ISAL_PMD_LOG(ERR, "Input buffer could not be read"
494 					" entirely\n");
495 			op->status = RTE_COMP_OP_STATUS_ERROR;
496 			return -1;
497 		}
498 
499 		if (ret != COMP_OK) {
500 			ISAL_PMD_LOG(ERR, "Compression operation failed\n");
501 			op->status = RTE_COMP_OP_STATUS_ERROR;
502 			return ret;
503 		}
504 	}
505 
506 	op->consumed = qp->stream->total_in;
507 	if (qp->stream->gzip_flag == IGZIP_DEFLATE) {
508 		op->produced = qp->stream->total_out;
509 	} else if (qp->stream->gzip_flag == IGZIP_ZLIB_NO_HDR) {
510 		op->produced = qp->stream->total_out - CHKSUM_SZ_ADLER;
511 		op->output_chksum = qp->stream->internal_state.crc + 1;
512 	} else {
513 		op->produced = qp->stream->total_out - CHKSUM_SZ_CRC;
514 		op->output_chksum = qp->stream->internal_state.crc;
515 	}
516 
517 	return ret;
518 }
519 
520 /* Stateless Decompression Function */
521 static int
522 process_isal_inflate(struct rte_comp_op *op, struct isal_comp_qp *qp,
523 		struct isal_priv_xform *priv_xform)
524 {
525 	int ret = 0;
526 
527 	op->status = RTE_COMP_OP_STATUS_SUCCESS;
528 
529 	/* Initialize decompression state */
530 	isal_inflate_init(qp->state);
531 
532 	/* Set Checksum flag */
533 	qp->state->crc_flag = priv_xform->decompress.chksum;
534 
535 	if (op->m_src->pkt_len < (op->src.length + op->src.offset)) {
536 		ISAL_PMD_LOG(ERR, "Input mbuf(s) not big enough.\n");
537 		op->status = RTE_COMP_OP_STATUS_INVALID_ARGS;
538 		return -1;
539 	}
540 
541 	if (op->dst.offset >= op->m_dst->pkt_len) {
542 		ISAL_PMD_LOG(ERR, "Output mbuf not big enough for "
543 				"offset provided.\n");
544 		op->status = RTE_COMP_OP_STATUS_INVALID_ARGS;
545 		return -1;
546 	}
547 
548 	/* Chained mbufs */
549 	if (op->m_src->nb_segs > 1 || op->m_dst->nb_segs > 1) {
550 		ret = chained_mbuf_decompression(op, qp);
551 		if (ret !=  0)
552 			return ret;
553 	} else {
554 		/* Linear buffer */
555 		/* Point decompression state to input buffer */
556 		qp->state->avail_in = op->src.length;
557 		qp->state->next_in = rte_pktmbuf_mtod_offset(op->m_src,
558 				uint8_t *, op->src.offset);
559 
560 		/* Point decompression state to output buffer */
561 		qp->state->avail_out = op->m_dst->data_len - op->dst.offset;
562 		qp->state->next_out  = rte_pktmbuf_mtod_offset(op->m_dst,
563 				uint8_t *, op->dst.offset);
564 
565 		if (unlikely(!qp->state->next_in || !qp->state->next_out)) {
566 			ISAL_PMD_LOG(ERR, "Invalid source or destination"
567 					" buffers\n");
568 			op->status = RTE_COMP_OP_STATUS_INVALID_ARGS;
569 			return -1;
570 		}
571 
572 		/* Execute decompression operation */
573 		ret = isal_inflate_stateless(qp->state);
574 
575 		if (ret == ISAL_OUT_OVERFLOW) {
576 			ISAL_PMD_LOG(ERR, "Output buffer not big enough\n");
577 			op->status = RTE_COMP_OP_STATUS_OUT_OF_SPACE_TERMINATED;
578 			return ret;
579 		}
580 
581 		/* Check that input buffer has been fully consumed */
582 		if (qp->state->avail_in != (uint32_t)0) {
583 			ISAL_PMD_LOG(ERR, "Input buffer could not be read"
584 					" entirely\n");
585 			op->status = RTE_COMP_OP_STATUS_ERROR;
586 			return -1;
587 		}
588 
589 		if (ret != ISAL_DECOMP_OK && ret != ISAL_END_INPUT) {
590 			ISAL_PMD_LOG(ERR, "Decompression operation failed\n");
591 			op->status = RTE_COMP_OP_STATUS_ERROR;
592 			return ret;
593 		}
594 		op->consumed = op->src.length - qp->state->avail_in;
595 	}
596 	op->produced = qp->state->total_out;
597 	op->output_chksum = qp->state->crc;
598 
599 	return ret;
600 }
601 
602 /* Process compression/decompression operation */
603 static int
604 process_op(struct isal_comp_qp *qp, struct rte_comp_op *op,
605 		struct isal_priv_xform *priv_xform)
606 {
607 	switch (priv_xform->type) {
608 	case RTE_COMP_COMPRESS:
609 		process_isal_deflate(op, qp, priv_xform);
610 		break;
611 	case RTE_COMP_DECOMPRESS:
612 		process_isal_inflate(op, qp, priv_xform);
613 		break;
614 	default:
615 		ISAL_PMD_LOG(ERR, "Operation Not Supported\n");
616 		return -ENOTSUP;
617 	}
618 	return 0;
619 }
620 
621 /* Enqueue burst */
622 static uint16_t
623 isal_comp_pmd_enqueue_burst(void *queue_pair, struct rte_comp_op **ops,
624 			uint16_t nb_ops)
625 {
626 	struct isal_comp_qp *qp = queue_pair;
627 	uint16_t i;
628 	int retval;
629 	int16_t num_enq = RTE_MIN(qp->num_free_elements, nb_ops);
630 
631 	for (i = 0; i < num_enq; i++) {
632 		if (unlikely(ops[i]->op_type != RTE_COMP_OP_STATELESS)) {
633 			ops[i]->status = RTE_COMP_OP_STATUS_INVALID_ARGS;
634 			ISAL_PMD_LOG(ERR, "Stateful operation not Supported\n");
635 			qp->qp_stats.enqueue_err_count++;
636 			continue;
637 		}
638 		retval = process_op(qp, ops[i], ops[i]->private_xform);
639 		if (unlikely(retval < 0) ||
640 				ops[i]->status != RTE_COMP_OP_STATUS_SUCCESS) {
641 			qp->qp_stats.enqueue_err_count++;
642 		}
643 	}
644 
645 	retval = rte_ring_enqueue_burst(qp->processed_pkts, (void *)ops,
646 			num_enq, NULL);
647 	qp->num_free_elements -= retval;
648 	qp->qp_stats.enqueued_count += retval;
649 
650 	return retval;
651 }
652 
653 /* Dequeue burst */
654 static uint16_t
655 isal_comp_pmd_dequeue_burst(void *queue_pair, struct rte_comp_op **ops,
656 		uint16_t nb_ops)
657 {
658 	struct isal_comp_qp *qp = queue_pair;
659 	uint16_t nb_dequeued;
660 
661 	nb_dequeued = rte_ring_dequeue_burst(qp->processed_pkts, (void **)ops,
662 			nb_ops, NULL);
663 	qp->num_free_elements += nb_dequeued;
664 	qp->qp_stats.dequeued_count += nb_dequeued;
665 
666 	return nb_dequeued;
667 }
668 
669 /* Create ISA-L compression device */
670 static int
671 compdev_isal_create(const char *name, struct rte_vdev_device *vdev,
672 		struct rte_compressdev_pmd_init_params *init_params)
673 {
674 	struct rte_compressdev *dev;
675 
676 	dev = rte_compressdev_pmd_create(name, &vdev->device,
677 			sizeof(struct isal_comp_private), init_params);
678 	if (dev == NULL) {
679 		ISAL_PMD_LOG(ERR, "failed to create compressdev vdev");
680 		return -EFAULT;
681 	}
682 
683 	dev->dev_ops = isal_compress_pmd_ops;
684 
685 	/* register rx/tx burst functions for data path */
686 	dev->dequeue_burst = isal_comp_pmd_dequeue_burst;
687 	dev->enqueue_burst = isal_comp_pmd_enqueue_burst;
688 
689 	ISAL_PMD_LOG(INFO, "\nISA-L library version used: "ISAL_VERSION_STRING);
690 
691 	return 0;
692 }
693 
694 /** Remove compression device */
695 static int
696 compdev_isal_remove_dev(struct rte_vdev_device *vdev)
697 {
698 	struct rte_compressdev *compdev;
699 	const char *name;
700 
701 	name = rte_vdev_device_name(vdev);
702 	if (name == NULL)
703 		return -EINVAL;
704 
705 	compdev = rte_compressdev_pmd_get_named_dev(name);
706 	if (compdev == NULL)
707 		return -ENODEV;
708 
709 	return rte_compressdev_pmd_destroy(compdev);
710 }
711 
712 /** Initialise ISA-L compression device */
713 static int
714 compdev_isal_probe(struct rte_vdev_device *dev)
715 {
716 	struct rte_compressdev_pmd_init_params init_params = {
717 		"",
718 		rte_socket_id(),
719 	};
720 	const char *name, *args;
721 	int retval;
722 
723 	name = rte_vdev_device_name(dev);
724 	if (name == NULL)
725 		return -EINVAL;
726 
727 	args = rte_vdev_device_args(dev);
728 
729 	retval = rte_compressdev_pmd_parse_input_args(&init_params, args);
730 	if (retval) {
731 		ISAL_PMD_LOG(ERR,
732 			"Failed to parse initialisation arguments[%s]\n", args);
733 		return -EINVAL;
734 	}
735 
736 	return compdev_isal_create(name, dev, &init_params);
737 }
738 
739 static struct rte_vdev_driver compdev_isal_pmd_drv = {
740 	.probe = compdev_isal_probe,
741 	.remove = compdev_isal_remove_dev,
742 };
743 
744 RTE_PMD_REGISTER_VDEV(COMPDEV_NAME_ISAL_PMD, compdev_isal_pmd_drv);
745 RTE_PMD_REGISTER_PARAM_STRING(COMPDEV_NAME_ISAL_PMD,
746 	"socket_id=<int>");
747 
748 RTE_INIT(isal_init_log)
749 {
750 	isal_logtype_driver = rte_log_register("pmd.compress.isal");
751 	if (isal_logtype_driver >= 0)
752 		rte_log_set_level(isal_logtype_driver, RTE_LOG_INFO);
753 }
754