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