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