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