xref: /spdk/test/unit/lib/bdev/compress.c/compress_ut.c (revision bb63fe6fc3a4d5f0f0639ad7712971da0ee607c4)
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_V(spdk_bdev_module_list_add, (struct spdk_bdev_module *bdev_module));
237 DEFINE_STUB_V(spdk_bdev_free_io, (struct spdk_bdev_io *g_bdev_io));
238 DEFINE_STUB(spdk_bdev_io_type_supported, bool, (struct spdk_bdev *bdev,
239 		enum spdk_bdev_io_type io_type), 0);
240 DEFINE_STUB_V(spdk_bdev_module_release_bdev, (struct spdk_bdev *bdev));
241 DEFINE_STUB_V(spdk_bdev_close, (struct spdk_bdev_desc *desc));
242 DEFINE_STUB(spdk_bdev_get_name, const char *, (const struct spdk_bdev *bdev), 0);
243 DEFINE_STUB(spdk_bdev_get_io_channel, struct spdk_io_channel *, (struct spdk_bdev_desc *desc), 0);
244 DEFINE_STUB_V(spdk_bdev_unregister, (struct spdk_bdev *bdev, spdk_bdev_unregister_cb cb_fn,
245 				     void *cb_arg));
246 DEFINE_STUB(spdk_bdev_open, int, (struct spdk_bdev *bdev, bool write,
247 				  spdk_bdev_remove_cb_t remove_cb,
248 				  void *remove_ctx, struct spdk_bdev_desc **_desc), 0);
249 DEFINE_STUB(spdk_bdev_module_claim_bdev, int, (struct spdk_bdev *bdev, struct spdk_bdev_desc *desc,
250 		struct spdk_bdev_module *module), 0);
251 DEFINE_STUB_V(spdk_bdev_module_examine_done, (struct spdk_bdev_module *module));
252 DEFINE_STUB(spdk_bdev_register, int, (struct spdk_bdev *bdev), 0);
253 DEFINE_STUB(spdk_bdev_get_by_name, struct spdk_bdev *, (const char *bdev_name), NULL);
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 	g_cdev_cap.comp_feature_flags = RTE_COMP_FF_SHAREABLE_PRIV_XFORM;
458 	g_device.cdev_info.driver_name = "compress_isal";
459 	g_device.cdev_info.capabilities = &g_cdev_cap;
460 
461 	g_src_mbufs[0] = calloc(1, sizeof(struct rte_mbuf));
462 	g_src_mbufs[1] = calloc(1, sizeof(struct rte_mbuf));
463 	g_dst_mbufs[0] = calloc(1, sizeof(struct rte_mbuf));
464 	g_dst_mbufs[1] = calloc(1, sizeof(struct rte_mbuf));
465 
466 	g_bdev_io = calloc(1, sizeof(struct spdk_bdev_io) + sizeof(struct comp_bdev_io));
467 	g_bdev_io->u.bdev.iovs = calloc(128, sizeof(struct iovec));
468 	g_bdev_io->bdev = &g_comp_bdev.comp_bdev;
469 	g_io_ch = calloc(1, sizeof(struct spdk_io_channel) + sizeof(struct comp_io_channel));
470 	g_comp_ch = (struct comp_io_channel *)((uint8_t *)g_io_ch + sizeof(struct spdk_io_channel));
471 	g_io_ctx = (struct comp_bdev_io *)g_bdev_io->driver_ctx;
472 
473 	g_io_ctx->comp_ch = g_comp_ch;
474 	g_io_ctx->comp_bdev = &g_comp_bdev;
475 	g_comp_bdev.device_qp = &g_device_qp;
476 
477 	g_test_config = calloc(1, sizeof(struct rte_config));
478 	g_test_config->lcore_count = 1;
479 
480 	return 0;
481 }
482 
483 /* Global teardown for all tests */
484 static int
485 test_cleanup(void)
486 {
487 	spdk_mempool_free((struct spdk_mempool *)g_mbuf_mp);
488 	free(g_dst_mbufs[0]);
489 	free(g_src_mbufs[0]);
490 	free(g_dst_mbufs[1]);
491 	free(g_src_mbufs[1]);
492 	free(g_bdev_io->u.bdev.iovs);
493 	free(g_bdev_io);
494 	free(g_io_ch);
495 	free(g_test_config);
496 	return 0;
497 }
498 
499 static void
500 test_compress_operation(void)
501 {
502 	struct iovec src_iovs[2] = {};
503 	int src_iovcnt;
504 	struct iovec dst_iovs[2] = {};
505 	int dst_iovcnt;
506 	struct spdk_reduce_vol_cb_args cb_arg;
507 	int rc;
508 	struct vbdev_comp_op *op;
509 
510 	src_iovcnt = dst_iovcnt = 2;
511 	src_iovs[0].iov_len = 1024 * 4;
512 	dst_iovs[0].iov_len = 1024 * 4;
513 
514 	src_iovs[1].iov_len = 1024 * 2;
515 	dst_iovs[1].iov_len = 1024 * 2;
516 
517 	src_iovs[0].iov_base = (void *)0xfeedbeef;
518 	dst_iovs[0].iov_base = (void *)0xdeadbeef;
519 
520 	src_iovs[1].iov_base = (void *)0xdeadbeef;
521 	dst_iovs[1].iov_base = (void *)0xfeedbeef;
522 
523 	/* test rte_comp_op_alloc failure */
524 	MOCK_SET(rte_comp_op_alloc, NULL);
525 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == true);
526 	rc = _compress_operation(&g_comp_bdev.backing_dev, &src_iovs[0], src_iovcnt,
527 				 &dst_iovs[0], dst_iovcnt, true, &cb_arg);
528 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == false);
529 	while (!TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops)) {
530 		op = TAILQ_FIRST(&g_comp_bdev.queued_comp_ops);
531 		TAILQ_REMOVE(&g_comp_bdev.queued_comp_ops, op, link);
532 		free(op);
533 	}
534 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == true);
535 	CU_ASSERT(rc == 0);
536 	MOCK_SET(rte_comp_op_alloc, &g_comp_op[0]);
537 
538 	/* test mempool get failure */
539 	ut_rte_pktmbuf_alloc_bulk = -1;
540 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == true);
541 	rc = _compress_operation(&g_comp_bdev.backing_dev, &src_iovs[0], src_iovcnt,
542 				 &dst_iovs[0], dst_iovcnt, true, &cb_arg);
543 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == false);
544 	while (!TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops)) {
545 		op = TAILQ_FIRST(&g_comp_bdev.queued_comp_ops);
546 		TAILQ_REMOVE(&g_comp_bdev.queued_comp_ops, op, link);
547 		free(op);
548 	}
549 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == true);
550 	CU_ASSERT(rc == 0);
551 	ut_rte_pktmbuf_alloc_bulk = 0;
552 
553 	/* test enqueue failure */
554 	ut_enqueue_value = 0;
555 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == true);
556 	rc = _compress_operation(&g_comp_bdev.backing_dev, &src_iovs[0], src_iovcnt,
557 				 &dst_iovs[0], dst_iovcnt, true, &cb_arg);
558 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == false);
559 	while (!TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops)) {
560 		op = TAILQ_FIRST(&g_comp_bdev.queued_comp_ops);
561 		TAILQ_REMOVE(&g_comp_bdev.queued_comp_ops, op, link);
562 		free(op);
563 	}
564 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == true);
565 	CU_ASSERT(rc == 0);
566 	ut_enqueue_value = 1;
567 
568 	/* test success with 2 vector iovec */
569 	ut_expected_op.private_xform = &g_decomp_xform;
570 	ut_expected_op.src.offset = 0;
571 	ut_expected_op.src.length = src_iovs[0].iov_len + src_iovs[1].iov_len;
572 	ut_expected_op.m_src = &g_expected_src_mbufs[0];
573 	ut_expected_op.m_src->buf_addr = src_iovs[0].iov_base;
574 	ut_expected_op.m_src->next = &g_expected_src_mbufs[1];
575 	ut_expected_op.m_src->next->buf_addr = src_iovs[1].iov_base;
576 	ut_expected_op.m_src->buf_iova = spdk_vtophys((void *)ut_expected_op.m_src->buf_addr, NULL);
577 	ut_expected_op.m_src->buf_len = src_iovs[0].iov_len;
578 	ut_expected_op.m_src->pkt_len = src_iovs[0].iov_len;
579 	ut_expected_op.m_src->userdata = &cb_arg;
580 
581 	ut_expected_op.dst.offset = 0;
582 	ut_expected_op.m_dst = &g_expected_dst_mbufs[0];
583 	ut_expected_op.m_dst->buf_addr = dst_iovs[0].iov_base;
584 	ut_expected_op.m_dst->next = &g_expected_dst_mbufs[1];
585 	ut_expected_op.m_dst->next->buf_addr = dst_iovs[1].iov_base;
586 	ut_expected_op.m_dst->buf_iova = spdk_vtophys((void *)ut_expected_op.m_dst->buf_addr, NULL);
587 	ut_expected_op.m_dst->buf_len = dst_iovs[0].iov_len;
588 	ut_expected_op.m_dst->pkt_len = dst_iovs[0].iov_len;
589 
590 	rc = _compress_operation(&g_comp_bdev.backing_dev, &src_iovs[0], src_iovcnt,
591 				 &dst_iovs[0], dst_iovcnt, false, &cb_arg);
592 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == true);
593 	CU_ASSERT(rc == 0);
594 }
595 
596 static void
597 test_poller(void)
598 {
599 	int rc;
600 	struct spdk_reduce_vol_cb_args *cb_args;
601 	struct rte_mbuf mbuf[2];
602 	struct vbdev_comp_op *op_to_queue;
603 	struct iovec src_iovs[2] = {};
604 	struct iovec dst_iovs[2] = {};
605 
606 	cb_args = calloc(1, sizeof(*cb_args));
607 	SPDK_CU_ASSERT_FATAL(cb_args != NULL);
608 	cb_args->cb_fn = _compress_done;
609 	memset(&g_comp_op[0], 0, sizeof(struct rte_comp_op));
610 	g_comp_op[0].m_src = &mbuf[0];
611 	g_comp_op[1].m_src = &mbuf[1];
612 
613 	/* Error from dequeue, nothing needing to be resubmitted.
614 	 */
615 	ut_rte_compressdev_dequeue_burst = 1;
616 	/* setup what we want dequeue to return for the op */
617 	g_comp_op[0].m_src->userdata = (void *)cb_args;
618 	g_comp_op[0].produced = 1;
619 	g_comp_op[0].status = 1;
620 	/* value asserted in the reduce callback */
621 	ut_compress_done[0] = -EINVAL;
622 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == true);
623 	rc = comp_dev_poller((void *)&g_comp_bdev);
624 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == true);
625 	CU_ASSERT(rc == 0);
626 
627 	/* Success from dequeue, 2 ops. nothing needing to be resubmitted.
628 	 */
629 	ut_rte_compressdev_dequeue_burst = 2;
630 	/* setup what we want dequeue to return for the op */
631 	g_comp_op[0].m_src->userdata = (void *)cb_args;
632 	g_comp_op[0].produced = 16;
633 	g_comp_op[0].status = 0;
634 	g_comp_op[1].m_src->userdata = (void *)cb_args;
635 	g_comp_op[1].produced = 32;
636 	g_comp_op[1].status = 0;
637 	/* value asserted in the reduce callback */
638 	ut_compress_done[0] = 16;
639 	ut_compress_done[1] = 32;
640 	done_count = 2;
641 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == true);
642 	rc = comp_dev_poller((void *)&g_comp_bdev);
643 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == true);
644 	CU_ASSERT(rc == 0);
645 
646 	/* Success from dequeue, one op to be resubmitted.
647 	 */
648 	ut_rte_compressdev_dequeue_burst = 1;
649 	/* setup what we want dequeue to return for the op */
650 	g_comp_op[0].m_src->userdata = (void *)cb_args;
651 	g_comp_op[0].produced = 16;
652 	g_comp_op[0].status = 0;
653 	/* value asserted in the reduce callback */
654 	ut_compress_done[0] = 16;
655 	done_count = 1;
656 	op_to_queue = calloc(1, sizeof(struct vbdev_comp_op));
657 	SPDK_CU_ASSERT_FATAL(op_to_queue != NULL);
658 	op_to_queue->backing_dev = &g_comp_bdev.backing_dev;
659 	op_to_queue->src_iovs = &src_iovs[0];
660 	op_to_queue->src_iovcnt = 2;
661 	op_to_queue->dst_iovs = &dst_iovs[0];
662 	op_to_queue->dst_iovcnt = 2;
663 	op_to_queue->compress = true;
664 	op_to_queue->cb_arg = cb_args;
665 	ut_enqueue_value = FAKE_ENQUEUE_SUCCESS;
666 	TAILQ_INSERT_TAIL(&g_comp_bdev.queued_comp_ops,
667 			  op_to_queue,
668 			  link);
669 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == false);
670 	rc = comp_dev_poller((void *)&g_comp_bdev);
671 	CU_ASSERT(TAILQ_EMPTY(&g_comp_bdev.queued_comp_ops) == true);
672 	CU_ASSERT(rc == 0);
673 
674 	/* op_to_queue is freed in code under test */
675 	free(cb_args);
676 }
677 
678 static void
679 test_vbdev_compress_submit_request(void)
680 {
681 	/* Single element block size write */
682 	g_bdev_io->internal.status = SPDK_BDEV_IO_STATUS_FAILED;
683 	g_bdev_io->type = SPDK_BDEV_IO_TYPE_WRITE;
684 	g_completion_called = false;
685 	MOCK_SET(spdk_bdev_io_get_io_channel, g_io_ch);
686 	vbdev_compress_submit_request(g_io_ch, g_bdev_io);
687 	CU_ASSERT(g_bdev_io->internal.status == SPDK_BDEV_IO_STATUS_SUCCESS);
688 	CU_ASSERT(g_completion_called == true);
689 	CU_ASSERT(g_io_ctx->orig_io == g_bdev_io);
690 	CU_ASSERT(g_io_ctx->comp_bdev == &g_comp_bdev);
691 	CU_ASSERT(g_io_ctx->comp_ch == g_comp_ch);
692 
693 	/* same write but now fail it */
694 	ut_spdk_reduce_vol_op_complete_err = 1;
695 	g_completion_called = false;
696 	vbdev_compress_submit_request(g_io_ch, g_bdev_io);
697 	CU_ASSERT(g_bdev_io->internal.status == SPDK_BDEV_IO_STATUS_FAILED);
698 	CU_ASSERT(g_completion_called == true);
699 
700 	/* test a read success */
701 	g_bdev_io->type = SPDK_BDEV_IO_TYPE_READ;
702 	ut_spdk_reduce_vol_op_complete_err = 0;
703 	g_completion_called = false;
704 	vbdev_compress_submit_request(g_io_ch, g_bdev_io);
705 	CU_ASSERT(g_bdev_io->internal.status == SPDK_BDEV_IO_STATUS_SUCCESS);
706 	CU_ASSERT(g_completion_called == true);
707 
708 	/* test a read failure */
709 	ut_spdk_reduce_vol_op_complete_err = 1;
710 	g_completion_called = false;
711 	vbdev_compress_submit_request(g_io_ch, g_bdev_io);
712 	CU_ASSERT(g_bdev_io->internal.status == SPDK_BDEV_IO_STATUS_FAILED);
713 	CU_ASSERT(g_completion_called == true);
714 }
715 
716 static void
717 test_passthru(void)
718 {
719 
720 }
721 
722 static void
723 test_reset(void)
724 {
725 	/* TODO: There are a few different ways to do this given that
726 	 * the code uses spdk_for_each_channel() to implement reset
727 	 * handling. SUbmitting w/o UT for this function for now and
728 	 * will follow up with something shortly.
729 	 */
730 }
731 
732 static void
733 test_initdrivers(void)
734 {
735 	int rc;
736 	static struct rte_mempool *orig_mbuf_mp;
737 	struct comp_device_qp *dev_qp;
738 	struct comp_device_qp *tmp_qp;
739 
740 	orig_mbuf_mp = g_mbuf_mp;
741 	g_mbuf_mp = NULL;
742 
743 	/* test return values from rte_vdev_init() */
744 	MOCK_SET(rte_eal_get_configuration, g_test_config);
745 	MOCK_SET(rte_vdev_init, -EEXIST);
746 	rc = vbdev_init_compress_drivers();
747 	/* This is not an error condition, we already have one */
748 	CU_ASSERT(rc == 0);
749 
750 	/* success */
751 	MOCK_SET(rte_vdev_init, 0);
752 	rc = vbdev_init_compress_drivers();
753 	CU_ASSERT(rc == 0);
754 
755 	/* error */
756 	MOCK_SET(rte_vdev_init, -2);
757 	rc = vbdev_init_compress_drivers();
758 	CU_ASSERT(rc == -EINVAL);
759 	CU_ASSERT(g_mbuf_mp == NULL);
760 	CU_ASSERT(g_comp_op_mp == NULL);
761 
762 	/* compressdev count 0 */
763 	ut_rte_compressdev_count = 0;
764 	MOCK_SET(rte_vdev_init, 0);
765 	rc = vbdev_init_compress_drivers();
766 	CU_ASSERT(rc == 0);
767 
768 	/* bogus count */
769 	ut_rte_compressdev_count = RTE_COMPRESS_MAX_DEVS + 1;
770 	rc = vbdev_init_compress_drivers();
771 	CU_ASSERT(rc == -EINVAL);
772 
773 	/* can't get mbuf pool */
774 	ut_rte_compressdev_count = 1;
775 	MOCK_SET(spdk_mempool_create, NULL);
776 	rc = vbdev_init_compress_drivers();
777 	CU_ASSERT(rc == -ENOMEM);
778 	MOCK_CLEAR(spdk_mempool_create);
779 
780 	/* can't get comp op pool */
781 	ut_rte_comp_op_pool_create = NULL;
782 	rc = vbdev_init_compress_drivers();
783 	CU_ASSERT(rc == -ENOMEM);
784 
785 	/* error on create_compress_dev() */
786 	ut_rte_comp_op_pool_create = (struct rte_mempool *)&test_initdrivers;
787 	ut_rte_compressdev_configure = -1;
788 	rc = vbdev_init_compress_drivers();
789 	CU_ASSERT(rc == -1);
790 
791 	/* error on create_compress_dev() but coverage for large num queues */
792 	ut_max_nb_queue_pairs = 99;
793 	rc = vbdev_init_compress_drivers();
794 	CU_ASSERT(rc == -1);
795 
796 	/* qpair setup fails */
797 	ut_rte_compressdev_configure = 0;
798 	ut_max_nb_queue_pairs = 0;
799 	ut_rte_compressdev_queue_pair_setup = -1;
800 	rc = vbdev_init_compress_drivers();
801 	CU_ASSERT(rc == -EINVAL);
802 
803 	/* rte_compressdev_start fails */
804 	ut_rte_compressdev_queue_pair_setup = 0;
805 	ut_rte_compressdev_start = -1;
806 	rc = vbdev_init_compress_drivers();
807 	CU_ASSERT(rc == -1);
808 
809 	/* rte_compressdev_private_xform_create() fails */
810 	ut_rte_compressdev_start = 0;
811 	ut_rte_compressdev_private_xform_create = -2;
812 	rc = vbdev_init_compress_drivers();
813 	CU_ASSERT(rc == -2);
814 
815 	/* rte_compressdev_private_xform_create()succeeds */
816 	ut_rte_compressdev_start = 0;
817 	ut_rte_compressdev_private_xform_create = 0;
818 	rc = vbdev_init_compress_drivers();
819 	CU_ASSERT(rc == 0);
820 
821 	TAILQ_FOREACH_SAFE(dev_qp, &g_comp_device_qp, link, tmp_qp) {
822 		TAILQ_REMOVE(&g_comp_device_qp, dev_qp, link);
823 		free(dev_qp->device);
824 		free(dev_qp);
825 	}
826 
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