xref: /spdk/test/unit/lib/bdev/compress.c/compress_ut.c (revision ae7b5890ef728af40bd233a5011b924c482603bf)
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright (c) Intel Corporation.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 #include "spdk_cunit.h"
35 
36 #include "common/lib/test_env.c"
37 #include "spdk_internal/mock.h"
38 #include "unit/lib/json_mock.c"
39 #include "spdk/reduce.h"
40 
41 #include <rte_compressdev.h>
42 
43 struct spdk_bdev_io *g_bdev_io;
44 struct spdk_io_channel *g_io_ch;
45 struct rte_comp_op g_comp_op[2];
46 struct vbdev_compress g_comp_bdev;
47 struct comp_device_qp g_device_qp;
48 struct compress_dev g_device;
49 struct rte_compressdev_capabilities g_cdev_cap;
50 static struct rte_mbuf *g_src_mbufs[2];
51 static struct rte_mbuf *g_dst_mbufs[2];
52 static struct rte_mbuf g_expected_src_mbufs[2];
53 static struct rte_mbuf g_expected_dst_mbufs[2];
54 struct comp_bdev_io *g_io_ctx;
55 struct comp_io_channel *g_comp_ch;
56 struct rte_config *g_test_config;
57 
58 /* Those functions are defined as static inline in DPDK, so we can't
59  * mock them straight away. We use defines to redirect them into
60  * our custom functions.
61  */
62 
63 static void mock_rte_pktmbuf_attach_extbuf(struct rte_mbuf *m, void *buf_addr, rte_iova_t buf_iova,
64 		uint16_t buf_len, struct rte_mbuf_ext_shared_info *shinfo);
65 #define rte_pktmbuf_attach_extbuf mock_rte_pktmbuf_attach_extbuf
66 static void mock_rte_pktmbuf_attach_extbuf(struct rte_mbuf *m, void *buf_addr, rte_iova_t buf_iova,
67 		uint16_t buf_len, struct rte_mbuf_ext_shared_info *shinfo)
68 {
69 	assert(m != NULL);
70 	m->buf_addr = buf_addr;
71 	m->buf_iova = buf_iova;
72 	m->buf_len = buf_len;
73 	m->data_len = m->pkt_len = 0;
74 }
75 
76 static char *mock_rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len);
77 #define rte_pktmbuf_append mock_rte_pktmbuf_append
78 static char *mock_rte_pktmbuf_append(struct rte_mbuf *m, uint16_t len)
79 {
80 	m->pkt_len = m->pkt_len + len;
81 	return NULL;
82 }
83 
84 static inline int mock_rte_pktmbuf_chain(struct rte_mbuf *head, struct rte_mbuf *tail);
85 #define rte_pktmbuf_chain mock_rte_pktmbuf_chain
86 static inline int mock_rte_pktmbuf_chain(struct rte_mbuf *head, struct rte_mbuf *tail)
87 {
88 	head->next = tail;
89 	return 0;
90 }
91 
92 uint16_t ut_max_nb_queue_pairs = 0;
93 void __rte_experimental mock_rte_compressdev_info_get(uint8_t dev_id,
94 		struct rte_compressdev_info *dev_info);
95 #define rte_compressdev_info_get mock_rte_compressdev_info_get
96 void __rte_experimental
97 mock_rte_compressdev_info_get(uint8_t dev_id, struct rte_compressdev_info *dev_info)
98 {
99 	dev_info->max_nb_queue_pairs = ut_max_nb_queue_pairs;
100 	dev_info->capabilities = &g_cdev_cap;
101 	dev_info->driver_name = "compress_isal";
102 }
103 
104 int ut_rte_compressdev_configure = 0;
105 int __rte_experimental mock_rte_compressdev_configure(uint8_t dev_id,
106 		struct rte_compressdev_config *config);
107 #define rte_compressdev_configure mock_rte_compressdev_configure
108 int __rte_experimental
109 mock_rte_compressdev_configure(uint8_t dev_id, struct rte_compressdev_config *config)
110 {
111 	return ut_rte_compressdev_configure;
112 }
113 
114 int ut_rte_compressdev_queue_pair_setup = 0;
115 int __rte_experimental mock_rte_compressdev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
116 		uint32_t max_inflight_ops, int socket_id);
117 #define rte_compressdev_queue_pair_setup mock_rte_compressdev_queue_pair_setup
118 int __rte_experimental
119 mock_rte_compressdev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
120 				      uint32_t max_inflight_ops, int socket_id)
121 {
122 	return ut_rte_compressdev_queue_pair_setup;
123 }
124 
125 int ut_rte_compressdev_start = 0;
126 int __rte_experimental mock_rte_compressdev_start(uint8_t dev_id);
127 #define rte_compressdev_start mock_rte_compressdev_start
128 int __rte_experimental
129 mock_rte_compressdev_start(uint8_t dev_id)
130 {
131 	return ut_rte_compressdev_start;
132 }
133 
134 int ut_rte_compressdev_private_xform_create = 0;
135 int __rte_experimental mock_rte_compressdev_private_xform_create(uint8_t dev_id,
136 		const struct rte_comp_xform *xform, void **private_xform);
137 #define rte_compressdev_private_xform_create mock_rte_compressdev_private_xform_create
138 int __rte_experimental
139 mock_rte_compressdev_private_xform_create(uint8_t dev_id,
140 		const struct rte_comp_xform *xform, void **private_xform)
141 {
142 	return ut_rte_compressdev_private_xform_create;
143 }
144 
145 uint8_t ut_rte_compressdev_count = 0;
146 uint8_t __rte_experimental mock_rte_compressdev_count(void);
147 #define rte_compressdev_count mock_rte_compressdev_count
148 uint8_t __rte_experimental
149 mock_rte_compressdev_count(void)
150 {
151 	return ut_rte_compressdev_count;
152 }
153 
154 struct rte_mempool *ut_rte_comp_op_pool_create = NULL;
155 struct rte_mempool *__rte_experimental mock_rte_comp_op_pool_create(const char *name,
156 		unsigned int nb_elts, unsigned int cache_size, uint16_t user_size,
157 		int socket_id);
158 #define rte_comp_op_pool_create mock_rte_comp_op_pool_create
159 struct rte_mempool *__rte_experimental
160 mock_rte_comp_op_pool_create(const char *name, unsigned int nb_elts,
161 			     unsigned int cache_size, uint16_t user_size, int socket_id)
162 {
163 	return ut_rte_comp_op_pool_create;
164 }
165 
166 void mock_rte_pktmbuf_free(struct rte_mbuf *m);
167 #define rte_pktmbuf_free mock_rte_pktmbuf_free
168 void mock_rte_pktmbuf_free(struct rte_mbuf *m)
169 {
170 }
171 
172 static int ut_rte_pktmbuf_alloc_bulk = 0;
173 int mock_rte_pktmbuf_alloc_bulk(struct rte_mempool *pool, struct rte_mbuf **mbufs,
174 				unsigned count);
175 #define rte_pktmbuf_alloc_bulk mock_rte_pktmbuf_alloc_bulk
176 int mock_rte_pktmbuf_alloc_bulk(struct rte_mempool *pool, struct rte_mbuf **mbufs,
177 				unsigned count)
178 {
179 	/* This mocked function only supports the alloc of 2 src and 2 dst. */
180 	CU_ASSERT(count == 2);
181 	ut_rte_pktmbuf_alloc_bulk += count;
182 	if (ut_rte_pktmbuf_alloc_bulk == 2) {
183 		*mbufs++ = g_src_mbufs[0];
184 		*mbufs = g_src_mbufs[1];
185 	} else if (ut_rte_pktmbuf_alloc_bulk == 4) {
186 		*mbufs++ = g_dst_mbufs[0];
187 		*mbufs = g_dst_mbufs[1];
188 		ut_rte_pktmbuf_alloc_bulk = 0;
189 	} else {
190 		return -1;
191 	}
192 	return 0;
193 }
194 
195 struct rte_mempool *
196 rte_pktmbuf_pool_create(const char *name, unsigned n, unsigned cache_size,
197 			uint16_t priv_size, uint16_t data_room_size, int socket_id)
198 {
199 	struct spdk_mempool *tmp;
200 
201 	tmp = spdk_mempool_create("mbuf_mp", 1024, sizeof(struct rte_mbuf),
202 				  SPDK_MEMPOOL_DEFAULT_CACHE_SIZE,
203 				  SPDK_ENV_SOCKET_ID_ANY);
204 
205 	return (struct rte_mempool *)tmp;
206 }
207 
208 void
209 rte_mempool_free(struct rte_mempool *mp)
210 {
211 	if (mp) {
212 		spdk_mempool_free((struct spdk_mempool *)mp);
213 	}
214 }
215 
216 static int ut_spdk_reduce_vol_op_complete_err = 0;
217 void
218 spdk_reduce_vol_writev(struct spdk_reduce_vol *vol, struct iovec *iov, int iovcnt,
219 		       uint64_t offset, uint64_t length, spdk_reduce_vol_op_complete cb_fn,
220 		       void *cb_arg)
221 {
222 	cb_fn(cb_arg, ut_spdk_reduce_vol_op_complete_err);
223 }
224 
225 void
226 spdk_reduce_vol_readv(struct spdk_reduce_vol *vol, struct iovec *iov, int iovcnt,
227 		      uint64_t offset, uint64_t length, spdk_reduce_vol_op_complete cb_fn,
228 		      void *cb_arg)
229 {
230 	cb_fn(cb_arg, ut_spdk_reduce_vol_op_complete_err);
231 }
232 
233 #include "bdev/compress/vbdev_compress.c"
234 
235 /* SPDK stubs */
236 DEFINE_STUB(spdk_bdev_get_aliases, const struct spdk_bdev_aliases_list *,
237 	    (const struct spdk_bdev *bdev), NULL);
238 DEFINE_STUB_V(spdk_bdev_module_list_add, (struct spdk_bdev_module *bdev_module));
239 DEFINE_STUB_V(spdk_bdev_free_io, (struct spdk_bdev_io *g_bdev_io));
240 DEFINE_STUB(spdk_bdev_io_type_supported, bool, (struct spdk_bdev *bdev,
241 		enum spdk_bdev_io_type io_type), 0);
242 DEFINE_STUB_V(spdk_bdev_module_release_bdev, (struct spdk_bdev *bdev));
243 DEFINE_STUB_V(spdk_bdev_close, (struct spdk_bdev_desc *desc));
244 DEFINE_STUB(spdk_bdev_get_name, const char *, (const struct spdk_bdev *bdev), 0);
245 DEFINE_STUB(spdk_bdev_get_io_channel, struct spdk_io_channel *, (struct spdk_bdev_desc *desc), 0);
246 DEFINE_STUB_V(spdk_bdev_unregister, (struct spdk_bdev *bdev, spdk_bdev_unregister_cb cb_fn,
247 				     void *cb_arg));
248 DEFINE_STUB(spdk_bdev_open, int, (struct spdk_bdev *bdev, bool write,
249 				  spdk_bdev_remove_cb_t remove_cb,
250 				  void *remove_ctx, struct spdk_bdev_desc **_desc), 0);
251 DEFINE_STUB(spdk_bdev_module_claim_bdev, int, (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc,
252 		struct spdk_bdev_module *module), 0);
253 DEFINE_STUB_V(spdk_bdev_module_examine_done, (struct spdk_bdev_module *module));
254 DEFINE_STUB(spdk_bdev_register, int, (struct spdk_bdev *bdev), 0);
255 DEFINE_STUB(spdk_bdev_get_by_name, struct spdk_bdev *, (const char *bdev_name), NULL);
256 DEFINE_STUB(spdk_bdev_io_get_io_channel, struct spdk_io_channel *, (struct spdk_bdev_io *bdev_io),
257 	    0);
258 DEFINE_STUB(spdk_bdev_queue_io_wait, int, (struct spdk_bdev *bdev, struct spdk_io_channel *ch,
259 		struct spdk_bdev_io_wait_entry *entry), 0);
260 DEFINE_STUB_V(spdk_reduce_vol_unload, (struct spdk_reduce_vol *vol,
261 				       spdk_reduce_vol_op_complete cb_fn, void *cb_arg));
262 DEFINE_STUB_V(spdk_reduce_vol_load, (struct spdk_reduce_backing_dev *backing_dev,
263 				     spdk_reduce_vol_op_with_handle_complete cb_fn, void *cb_arg));
264 DEFINE_STUB(spdk_reduce_vol_get_params, const struct spdk_reduce_vol_params *,
265 	    (struct spdk_reduce_vol *vol), NULL);
266 
267 /* DPDK stubs */
268 DEFINE_STUB(rte_socket_id, unsigned, (void), 0);
269 DEFINE_STUB(rte_eal_get_configuration, struct rte_config *, (void), NULL);
270 DEFINE_STUB(rte_vdev_init, int, (const char *name, const char *args), 0);
271 DEFINE_STUB_V(rte_comp_op_free, (struct rte_comp_op *op));
272 DEFINE_STUB(rte_comp_op_alloc, struct rte_comp_op *, (struct rte_mempool *mempool), NULL);
273 
274 void
275 spdk_bdev_io_get_buf(struct spdk_bdev_io *bdev_io, spdk_bdev_io_get_buf_cb cb, uint64_t len)
276 {
277 	cb(g_io_ch, g_bdev_io, true);
278 }
279 
280 /* Mock these functions to call the callback and then return the value we require */
281 int ut_spdk_bdev_readv_blocks = 0;
282 int
283 spdk_bdev_readv_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
284 		       struct iovec *iov, int iovcnt,
285 		       uint64_t offset_blocks, uint64_t num_blocks,
286 		       spdk_bdev_io_completion_cb cb, void *cb_arg)
287 {
288 	cb(g_bdev_io, !ut_spdk_bdev_readv_blocks, cb_arg);
289 	return ut_spdk_bdev_readv_blocks;
290 }
291 
292 int ut_spdk_bdev_writev_blocks = 0;
293 bool ut_spdk_bdev_writev_blocks_mocked = false;
294 int
295 spdk_bdev_writev_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
296 			struct iovec *iov, int iovcnt,
297 			uint64_t offset_blocks, uint64_t num_blocks,
298 			spdk_bdev_io_completion_cb cb, void *cb_arg)
299 {
300 	cb(g_bdev_io, !ut_spdk_bdev_writev_blocks, cb_arg);
301 	return ut_spdk_bdev_writev_blocks;
302 }
303 
304 int ut_spdk_bdev_unmap_blocks = 0;
305 bool ut_spdk_bdev_unmap_blocks_mocked = false;
306 int
307 spdk_bdev_unmap_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
308 		       uint64_t offset_blocks, uint64_t num_blocks,
309 		       spdk_bdev_io_completion_cb cb, void *cb_arg)
310 {
311 	cb(g_bdev_io, !ut_spdk_bdev_unmap_blocks, cb_arg);
312 	return ut_spdk_bdev_unmap_blocks;
313 }
314 
315 int ut_spdk_bdev_flush_blocks = 0;
316 bool ut_spdk_bdev_flush_blocks_mocked = false;
317 int
318 spdk_bdev_flush_blocks(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
319 		       uint64_t offset_blocks, uint64_t num_blocks, spdk_bdev_io_completion_cb cb,
320 		       void *cb_arg)
321 {
322 	cb(g_bdev_io, !ut_spdk_bdev_flush_blocks, cb_arg);
323 	return ut_spdk_bdev_flush_blocks;
324 }
325 
326 int ut_spdk_bdev_reset = 0;
327 bool ut_spdk_bdev_reset_mocked = false;
328 int
329 spdk_bdev_reset(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
330 		spdk_bdev_io_completion_cb cb, void *cb_arg)
331 {
332 	cb(g_bdev_io, !ut_spdk_bdev_reset, cb_arg);
333 	return ut_spdk_bdev_reset;
334 }
335 
336 bool g_completion_called = false;
337 void
338 spdk_bdev_io_complete(struct spdk_bdev_io *bdev_io, enum spdk_bdev_io_status status)
339 {
340 	bdev_io->internal.status = status;
341 	g_completion_called = true;
342 }
343 
344 static uint16_t ut_rte_compressdev_dequeue_burst = 0;
345 uint16_t
346 rte_compressdev_dequeue_burst(uint8_t dev_id, uint16_t qp_id, struct rte_comp_op **ops,
347 			      uint16_t nb_op)
348 {
349 	if (ut_rte_compressdev_dequeue_burst == 0) {
350 		return 0;
351 	}
352 
353 	ops[0] = &g_comp_op[0];
354 	ops[1] = &g_comp_op[1];
355 
356 	return ut_rte_compressdev_dequeue_burst;
357 }
358 
359 static int ut_compress_done[2];
360 /* done_count and done_idx together control which expected assertion
361  * value to use when dequeuing 2 operations.
362  */
363 static uint16_t done_count = 1;
364 static uint16_t done_idx = 0;
365 static void
366 _compress_done(void *_req, int reduce_errno)
367 {
368 	if (done_count == 1) {
369 		CU_ASSERT(reduce_errno == ut_compress_done[0]);
370 	} else if (done_count == 2) {
371 		CU_ASSERT(reduce_errno == ut_compress_done[done_idx++]);
372 	}
373 }
374 
375 #define FAKE_ENQUEUE_SUCCESS 255
376 static uint16_t ut_enqueue_value = 0;
377 static struct rte_comp_op ut_expected_op;
378 uint16_t
379 rte_compressdev_enqueue_burst(uint8_t dev_id, uint16_t qp_id, struct rte_comp_op **ops,
380 			      uint16_t nb_ops)
381 {
382 	struct rte_comp_op *op = *ops;
383 
384 	if (ut_enqueue_value == 0) {
385 		return 0;
386 	}
387 
388 	if (ut_enqueue_value == FAKE_ENQUEUE_SUCCESS) {
389 		return 1;
390 	}
391 	/* by design the compress module will never send more than 1 op at a time */
392 	CU_ASSERT(op->private_xform == ut_expected_op.private_xform);
393 
394 	/* check src mbuf values, some that are faked in our stub are done so
395 	 * to indirectly test functionality in the code under test.
396 	 */
397 	CU_ASSERT(op->m_src->buf_addr == ut_expected_op.m_src->buf_addr);
398 	CU_ASSERT(op->m_src->buf_iova == ut_expected_op.m_src->buf_iova);
399 	CU_ASSERT(op->m_src->buf_len == ut_expected_op.m_src->buf_len);
400 	CU_ASSERT(op->m_src->pkt_len == ut_expected_op.m_src->pkt_len);
401 	CU_ASSERT(op->m_src->userdata == ut_expected_op.m_src->userdata);
402 	CU_ASSERT(op->src.offset == ut_expected_op.src.offset);
403 	CU_ASSERT(op->src.length == ut_expected_op.src.length);
404 
405 	/* check dst mbuf values */
406 	CU_ASSERT(op->m_dst->buf_addr == ut_expected_op.m_dst->buf_addr);
407 	CU_ASSERT(op->m_dst->buf_iova == ut_expected_op.m_dst->buf_iova);
408 	CU_ASSERT(op->m_dst->buf_len == ut_expected_op.m_dst->buf_len);
409 	CU_ASSERT(op->m_dst->pkt_len == ut_expected_op.m_dst->pkt_len);
410 	CU_ASSERT(op->dst.offset == ut_expected_op.dst.offset);
411 
412 	return ut_enqueue_value;
413 }
414 
415 /* Global setup for all tests that share a bunch of preparation... */
416 static int
417 test_setup(void)
418 {
419 	g_mbuf_mp = rte_pktmbuf_pool_create("mbuf_mp", NUM_MBUFS, POOL_CACHE_SIZE,
420 					    sizeof(struct rte_mbuf), 0, rte_socket_id());
421 	assert(g_mbuf_mp != NULL);
422 
423 	g_comp_bdev.backing_dev.unmap = _comp_reduce_unmap;
424 	g_comp_bdev.backing_dev.readv = _comp_reduce_readv;
425 	g_comp_bdev.backing_dev.writev = _comp_reduce_writev;
426 	g_comp_bdev.backing_dev.compress = _comp_reduce_compress;
427 	g_comp_bdev.backing_dev.decompress = _comp_reduce_decompress;
428 	g_comp_bdev.backing_dev.blocklen = 512;
429 	g_comp_bdev.backing_dev.blockcnt = 1024 * 16;
430 
431 	g_comp_bdev.device_qp = &g_device_qp;
432 	g_comp_bdev.device_qp->device = &g_device;
433 
434 	TAILQ_INIT(&g_comp_bdev.queued_comp_ops);
435 
436 	g_comp_xform = (struct rte_comp_xform) {
437 		.type = RTE_COMP_COMPRESS,
438 		.compress = {
439 			.algo = RTE_COMP_ALGO_DEFLATE,
440 			.deflate.huffman = RTE_COMP_HUFFMAN_DEFAULT,
441 			.level = RTE_COMP_LEVEL_MAX,
442 			.window_size = DEFAULT_WINDOW_SIZE,
443 			.chksum = RTE_COMP_CHECKSUM_NONE,
444 			.hash_algo = RTE_COMP_HASH_ALGO_NONE
445 		}
446 	};
447 
448 	g_decomp_xform = (struct rte_comp_xform) {
449 		.type = RTE_COMP_DECOMPRESS,
450 		.decompress = {
451 			.algo = RTE_COMP_ALGO_DEFLATE,
452 			.chksum = RTE_COMP_CHECKSUM_NONE,
453 			.window_size = DEFAULT_WINDOW_SIZE,
454 			.hash_algo = RTE_COMP_HASH_ALGO_NONE
455 		}
456 	};
457 	g_device.comp_xform = &g_comp_xform;
458 	g_device.decomp_xform = &g_decomp_xform;
459 	g_cdev_cap.comp_feature_flags = RTE_COMP_FF_SHAREABLE_PRIV_XFORM;
460 	g_device.cdev_info.driver_name = "compress_isal";
461 	g_device.cdev_info.capabilities = &g_cdev_cap;
462 
463 	g_src_mbufs[0] = calloc(1, sizeof(struct rte_mbuf));
464 	g_src_mbufs[1] = calloc(1, sizeof(struct rte_mbuf));
465 	g_dst_mbufs[0] = calloc(1, sizeof(struct rte_mbuf));
466 	g_dst_mbufs[1] = calloc(1, sizeof(struct rte_mbuf));
467 
468 	g_bdev_io = calloc(1, sizeof(struct spdk_bdev_io) + sizeof(struct comp_bdev_io));
469 	g_bdev_io->u.bdev.iovs = calloc(128, sizeof(struct iovec));
470 	g_bdev_io->bdev = &g_comp_bdev.comp_bdev;
471 	g_io_ch = calloc(1, sizeof(struct spdk_io_channel) + sizeof(struct comp_io_channel));
472 	g_comp_ch = (struct comp_io_channel *)((uint8_t *)g_io_ch + sizeof(struct spdk_io_channel));
473 	g_io_ctx = (struct comp_bdev_io *)g_bdev_io->driver_ctx;
474 
475 	g_io_ctx->comp_ch = g_comp_ch;
476 	g_io_ctx->comp_bdev = &g_comp_bdev;
477 	g_comp_bdev.device_qp = &g_device_qp;
478 
479 	g_test_config = calloc(1, sizeof(struct rte_config));
480 	g_test_config->lcore_count = 1;
481 
482 	return 0;
483 }
484 
485 /* Global teardown for all tests */
486 static int
487 test_cleanup(void)
488 {
489 	spdk_mempool_free((struct spdk_mempool *)g_mbuf_mp);
490 	free(g_dst_mbufs[0]);
491 	free(g_src_mbufs[0]);
492 	free(g_dst_mbufs[1]);
493 	free(g_src_mbufs[1]);
494 	free(g_bdev_io->u.bdev.iovs);
495 	free(g_bdev_io);
496 	free(g_io_ch);
497 	free(g_test_config);
498 	return 0;
499 }
500 
501 static void
502 test_compress_operation(void)
503 {
504 	struct iovec src_iovs[2] = {};
505 	int src_iovcnt;
506 	struct iovec dst_iovs[2] = {};
507 	int dst_iovcnt;
508 	struct spdk_reduce_vol_cb_args cb_arg;
509 	int rc;
510 	struct vbdev_comp_op *op;
511 
512 	src_iovcnt = dst_iovcnt = 2;
513 	src_iovs[0].iov_len = 1024 * 4;
514 	dst_iovs[0].iov_len = 1024 * 4;
515 
516 	src_iovs[1].iov_len = 1024 * 2;
517 	dst_iovs[1].iov_len = 1024 * 2;
518 
519 	src_iovs[0].iov_base = (void *)0xfeedbeef;
520 	dst_iovs[0].iov_base = (void *)0xdeadbeef;
521 
522 	src_iovs[1].iov_base = (void *)0xdeadbeef;
523 	dst_iovs[1].iov_base = (void *)0xfeedbeef;
524 
525 	/* test rte_comp_op_alloc failure */
526 	MOCK_SET(rte_comp_op_alloc, NULL);
527 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == true);
528 	rc = _compress_operation(&g_comp_bdev.backing_dev, &src_iovs[0], src_iovcnt,
529 				 &dst_iovs[0], dst_iovcnt, true, &cb_arg);
530 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == false);
531 	while (!TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops)) {
532 		op = TAILQ_FIRST(&g_comp_bdev.queued_comp_ops);
533 		TAILQ_REMOVE(&g_comp_bdev.queued_comp_ops, op, link);
534 		free(op);
535 	}
536 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == true);
537 	CU_ASSERT(rc == 0);
538 	MOCK_SET(rte_comp_op_alloc, &g_comp_op[0]);
539 
540 	/* test mempool get failure */
541 	ut_rte_pktmbuf_alloc_bulk = -1;
542 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == true);
543 	rc = _compress_operation(&g_comp_bdev.backing_dev, &src_iovs[0], src_iovcnt,
544 				 &dst_iovs[0], dst_iovcnt, true, &cb_arg);
545 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == false);
546 	while (!TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops)) {
547 		op = TAILQ_FIRST(&g_comp_bdev.queued_comp_ops);
548 		TAILQ_REMOVE(&g_comp_bdev.queued_comp_ops, op, link);
549 		free(op);
550 	}
551 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == true);
552 	CU_ASSERT(rc == 0);
553 	ut_rte_pktmbuf_alloc_bulk = 0;
554 
555 	/* test enqueue failure */
556 	ut_enqueue_value = 0;
557 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == true);
558 	rc = _compress_operation(&g_comp_bdev.backing_dev, &src_iovs[0], src_iovcnt,
559 				 &dst_iovs[0], dst_iovcnt, true, &cb_arg);
560 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == false);
561 	while (!TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops)) {
562 		op = TAILQ_FIRST(&g_comp_bdev.queued_comp_ops);
563 		TAILQ_REMOVE(&g_comp_bdev.queued_comp_ops, op, link);
564 		free(op);
565 	}
566 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == true);
567 	CU_ASSERT(rc == 0);
568 	ut_enqueue_value = 1;
569 
570 	/* test success with 2 vector iovec */
571 	ut_expected_op.private_xform = &g_decomp_xform;
572 	ut_expected_op.src.offset = 0;
573 	ut_expected_op.src.length = src_iovs[0].iov_len + src_iovs[1].iov_len;
574 	ut_expected_op.m_src = &g_expected_src_mbufs[0];
575 	ut_expected_op.m_src->buf_addr = src_iovs[0].iov_base;
576 	ut_expected_op.m_src->next = &g_expected_src_mbufs[1];
577 	ut_expected_op.m_src->next->buf_addr = src_iovs[1].iov_base;
578 	ut_expected_op.m_src->buf_iova = spdk_vtophys((void *)ut_expected_op.m_src->buf_addr, NULL);
579 	ut_expected_op.m_src->buf_len = src_iovs[0].iov_len;
580 	ut_expected_op.m_src->pkt_len = src_iovs[0].iov_len;
581 	ut_expected_op.m_src->userdata = &cb_arg;
582 
583 	ut_expected_op.dst.offset = 0;
584 	ut_expected_op.m_dst = &g_expected_dst_mbufs[0];
585 	ut_expected_op.m_dst->buf_addr = dst_iovs[0].iov_base;
586 	ut_expected_op.m_dst->next = &g_expected_dst_mbufs[1];
587 	ut_expected_op.m_dst->next->buf_addr = dst_iovs[1].iov_base;
588 	ut_expected_op.m_dst->buf_iova = spdk_vtophys((void *)ut_expected_op.m_dst->buf_addr, NULL);
589 	ut_expected_op.m_dst->buf_len = dst_iovs[0].iov_len;
590 	ut_expected_op.m_dst->pkt_len = dst_iovs[0].iov_len;
591 
592 	rc = _compress_operation(&g_comp_bdev.backing_dev, &src_iovs[0], src_iovcnt,
593 				 &dst_iovs[0], dst_iovcnt, false, &cb_arg);
594 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == true);
595 	CU_ASSERT(rc == 0);
596 }
597 
598 static void
599 test_poller(void)
600 {
601 	int rc;
602 	struct spdk_reduce_vol_cb_args *cb_args;
603 	struct rte_mbuf mbuf[2];
604 	struct vbdev_comp_op *op_to_queue;
605 	struct iovec src_iovs[2] = {};
606 	struct iovec dst_iovs[2] = {};
607 
608 	cb_args = calloc(1, sizeof(*cb_args));
609 	SPDK_CU_ASSERT_FATAL(cb_args != NULL);
610 	cb_args->cb_fn = _compress_done;
611 	memset(&g_comp_op[0], 0, sizeof(struct rte_comp_op));
612 	g_comp_op[0].m_src = &mbuf[0];
613 	g_comp_op[1].m_src = &mbuf[1];
614 
615 	/* Error from dequeue, nothing needing to be resubmitted.
616 	 */
617 	ut_rte_compressdev_dequeue_burst = 1;
618 	/* setup what we want dequeue to return for the op */
619 	g_comp_op[0].m_src->userdata = (void *)cb_args;
620 	g_comp_op[0].produced = 1;
621 	g_comp_op[0].status = 1;
622 	/* value asserted in the reduce callback */
623 	ut_compress_done[0] = -EINVAL;
624 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == true);
625 	rc = comp_dev_poller((void *)&g_comp_bdev);
626 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == true);
627 	CU_ASSERT(rc == 0);
628 
629 	/* Success from dequeue, 2 ops. nothing needing to be resubmitted.
630 	 */
631 	ut_rte_compressdev_dequeue_burst = 2;
632 	/* setup what we want dequeue to return for the op */
633 	g_comp_op[0].m_src->userdata = (void *)cb_args;
634 	g_comp_op[0].produced = 16;
635 	g_comp_op[0].status = 0;
636 	g_comp_op[1].m_src->userdata = (void *)cb_args;
637 	g_comp_op[1].produced = 32;
638 	g_comp_op[1].status = 0;
639 	/* value asserted in the reduce callback */
640 	ut_compress_done[0] = 16;
641 	ut_compress_done[1] = 32;
642 	done_count = 2;
643 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == true);
644 	rc = comp_dev_poller((void *)&g_comp_bdev);
645 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == true);
646 	CU_ASSERT(rc == 0);
647 
648 	/* Success from dequeue, one op to be resubmitted.
649 	 */
650 	ut_rte_compressdev_dequeue_burst = 1;
651 	/* setup what we want dequeue to return for the op */
652 	g_comp_op[0].m_src->userdata = (void *)cb_args;
653 	g_comp_op[0].produced = 16;
654 	g_comp_op[0].status = 0;
655 	/* value asserted in the reduce callback */
656 	ut_compress_done[0] = 16;
657 	done_count = 1;
658 	op_to_queue = calloc(1, sizeof(struct vbdev_comp_op));
659 	SPDK_CU_ASSERT_FATAL(op_to_queue != NULL);
660 	op_to_queue->backing_dev = &g_comp_bdev.backing_dev;
661 	op_to_queue->src_iovs = &src_iovs[0];
662 	op_to_queue->src_iovcnt = 2;
663 	op_to_queue->dst_iovs = &dst_iovs[0];
664 	op_to_queue->dst_iovcnt = 2;
665 	op_to_queue->compress = true;
666 	op_to_queue->cb_arg = cb_args;
667 	ut_enqueue_value = FAKE_ENQUEUE_SUCCESS;
668 	TAILQ_INSERT_TAIL(&g_comp_bdev.queued_comp_ops,
669 			  op_to_queue,
670 			  link);
671 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == false);
672 	rc = comp_dev_poller((void *)&g_comp_bdev);
673 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == true);
674 	CU_ASSERT(rc == 0);
675 
676 	/* op_to_queue is freed in code under test */
677 	free(cb_args);
678 }
679 
680 static void
681 test_vbdev_compress_submit_request(void)
682 {
683 	/* Single element block size write */
684 	g_bdev_io->internal.status = SPDK_BDEV_IO_STATUS_FAILED;
685 	g_bdev_io->type = SPDK_BDEV_IO_TYPE_WRITE;
686 	g_completion_called = false;
687 	MOCK_SET(spdk_bdev_io_get_io_channel, g_io_ch);
688 	vbdev_compress_submit_request(g_io_ch, g_bdev_io);
689 	CU_ASSERT(g_bdev_io->internal.status == SPDK_BDEV_IO_STATUS_SUCCESS);
690 	CU_ASSERT(g_completion_called == true);
691 	CU_ASSERT(g_io_ctx->orig_io == g_bdev_io);
692 	CU_ASSERT(g_io_ctx->comp_bdev == &g_comp_bdev);
693 	CU_ASSERT(g_io_ctx->comp_ch == g_comp_ch);
694 
695 	/* same write but now fail it */
696 	ut_spdk_reduce_vol_op_complete_err = 1;
697 	g_completion_called = false;
698 	vbdev_compress_submit_request(g_io_ch, g_bdev_io);
699 	CU_ASSERT(g_bdev_io->internal.status == SPDK_BDEV_IO_STATUS_FAILED);
700 	CU_ASSERT(g_completion_called == true);
701 
702 	/* test a read success */
703 	g_bdev_io->type = SPDK_BDEV_IO_TYPE_READ;
704 	ut_spdk_reduce_vol_op_complete_err = 0;
705 	g_completion_called = false;
706 	vbdev_compress_submit_request(g_io_ch, g_bdev_io);
707 	CU_ASSERT(g_bdev_io->internal.status == SPDK_BDEV_IO_STATUS_SUCCESS);
708 	CU_ASSERT(g_completion_called == true);
709 
710 	/* test a read failure */
711 	ut_spdk_reduce_vol_op_complete_err = 1;
712 	g_completion_called = false;
713 	vbdev_compress_submit_request(g_io_ch, g_bdev_io);
714 	CU_ASSERT(g_bdev_io->internal.status == SPDK_BDEV_IO_STATUS_FAILED);
715 	CU_ASSERT(g_completion_called == true);
716 }
717 
718 static void
719 test_passthru(void)
720 {
721 
722 }
723 
724 static void
725 test_reset(void)
726 {
727 	/* TODO: There are a few different ways to do this given that
728 	 * the code uses spdk_for_each_channel() to implement reset
729 	 * handling. SUbmitting w/o UT for this function for now and
730 	 * will follow up with something shortly.
731 	 */
732 }
733 
734 static void
735 test_initdrivers(void)
736 {
737 	int rc;
738 	static struct rte_mempool *orig_mbuf_mp;
739 	struct comp_device_qp *dev_qp;
740 	struct comp_device_qp *tmp_qp;
741 
742 	orig_mbuf_mp = g_mbuf_mp;
743 	g_mbuf_mp = NULL;
744 
745 	/* test return values from rte_vdev_init() */
746 	MOCK_SET(rte_eal_get_configuration, g_test_config);
747 	MOCK_SET(rte_vdev_init, -EEXIST);
748 	rc = vbdev_init_compress_drivers();
749 	/* This is not an error condition, we already have one */
750 	CU_ASSERT(rc == 0);
751 
752 	/* success */
753 	MOCK_SET(rte_vdev_init, 0);
754 	rc = vbdev_init_compress_drivers();
755 	CU_ASSERT(rc == 0);
756 
757 	/* error */
758 	MOCK_SET(rte_vdev_init, -2);
759 	rc = vbdev_init_compress_drivers();
760 	CU_ASSERT(rc == -EINVAL);
761 	CU_ASSERT(g_mbuf_mp == NULL);
762 	CU_ASSERT(g_comp_op_mp == NULL);
763 
764 	/* compressdev count 0 */
765 	ut_rte_compressdev_count = 0;
766 	MOCK_SET(rte_vdev_init, 0);
767 	rc = vbdev_init_compress_drivers();
768 	CU_ASSERT(rc == 0);
769 
770 	/* bogus count */
771 	ut_rte_compressdev_count = RTE_COMPRESS_MAX_DEVS + 1;
772 	rc = vbdev_init_compress_drivers();
773 	CU_ASSERT(rc == -EINVAL);
774 
775 	/* can't get mbuf pool */
776 	ut_rte_compressdev_count = 1;
777 	MOCK_SET(spdk_mempool_create, NULL);
778 	rc = vbdev_init_compress_drivers();
779 	CU_ASSERT(rc == -ENOMEM);
780 	MOCK_CLEAR(spdk_mempool_create);
781 
782 	/* can't get comp op pool */
783 	ut_rte_comp_op_pool_create = NULL;
784 	rc = vbdev_init_compress_drivers();
785 	CU_ASSERT(rc == -ENOMEM);
786 
787 	/* error on create_compress_dev() */
788 	ut_rte_comp_op_pool_create = (struct rte_mempool *)&test_initdrivers;
789 	ut_rte_compressdev_configure = -1;
790 	rc = vbdev_init_compress_drivers();
791 	CU_ASSERT(rc == -1);
792 
793 	/* error on create_compress_dev() but coverage for large num queues */
794 	ut_max_nb_queue_pairs = 99;
795 	rc = vbdev_init_compress_drivers();
796 	CU_ASSERT(rc == -1);
797 
798 	/* qpair setup fails */
799 	ut_rte_compressdev_configure = 0;
800 	ut_max_nb_queue_pairs = 0;
801 	ut_rte_compressdev_queue_pair_setup = -1;
802 	rc = vbdev_init_compress_drivers();
803 	CU_ASSERT(rc == -EINVAL);
804 
805 	/* rte_compressdev_start fails */
806 	ut_rte_compressdev_queue_pair_setup = 0;
807 	ut_rte_compressdev_start = -1;
808 	rc = vbdev_init_compress_drivers();
809 	CU_ASSERT(rc == -1);
810 
811 	/* rte_compressdev_private_xform_create() fails */
812 	ut_rte_compressdev_start = 0;
813 	ut_rte_compressdev_private_xform_create = -2;
814 	rc = vbdev_init_compress_drivers();
815 	CU_ASSERT(rc == -2);
816 
817 	/* rte_compressdev_private_xform_create()succeeds */
818 	ut_rte_compressdev_start = 0;
819 	ut_rte_compressdev_private_xform_create = 0;
820 	rc = vbdev_init_compress_drivers();
821 	CU_ASSERT(rc == 0);
822 
823 	TAILQ_FOREACH_SAFE(dev_qp, &g_comp_device_qp, link, tmp_qp) {
824 		TAILQ_REMOVE(&g_comp_device_qp, dev_qp, link);
825 		free(dev_qp->device);
826 		free(dev_qp);
827 	}
828 
829 	g_mbuf_mp = orig_mbuf_mp;
830 }
831 
832 static void
833 test_supported_io(void)
834 {
835 
836 }
837 
838 int
839 main(int argc, char **argv)
840 {
841 	CU_pSuite	suite = NULL;
842 	unsigned int	num_failures;
843 
844 	if (CU_initialize_registry() != CUE_SUCCESS) {
845 		return CU_get_error();
846 	}
847 
848 	suite = CU_add_suite("compress", test_setup, test_cleanup);
849 	if (suite == NULL) {
850 		CU_cleanup_registry();
851 		return CU_get_error();
852 	}
853 
854 	if (CU_add_test(suite, "test_compress_operation",
855 			test_compress_operation) == NULL ||
856 	    CU_add_test(suite, "vbdev_compress_submit_request",
857 			test_vbdev_compress_submit_request) == NULL ||
858 	    CU_add_test(suite, "test_passthru",
859 			test_passthru) == NULL ||
860 	    CU_add_test(suite, "test_initdrivers",
861 			test_initdrivers) == NULL ||
862 	    CU_add_test(suite, "test_supported_io",
863 			test_supported_io) == NULL ||
864 	    CU_add_test(suite, "test_poller",
865 			test_poller) == NULL ||
866 	    CU_add_test(suite, "test_reset",
867 			test_reset) == NULL
868 	   ) {
869 		CU_cleanup_registry();
870 		return CU_get_error();
871 	}
872 
873 	CU_basic_set_mode(CU_BRM_VERBOSE);
874 	CU_basic_run_tests();
875 	num_failures = CU_get_number_of_failures();
876 	CU_cleanup_registry();
877 	return num_failures;
878 }
879