4 * Copyright (c) Intel Corporation.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
34 #include "spdk/stdinc.h"
36 #include "CUnit/Basic.h"
37 #include "spdk_cunit.h"
39 #include "spdk/util.h"
42 #include "scsi/port.c"
44 /* Unit test bdev mockup */
49 static struct spdk_bdev g_bdevs
[] = {
55 spdk_bdev_get_name(const struct spdk_bdev
*bdev
)
60 static struct spdk_scsi_task
*
61 spdk_get_task(uint32_t *owner_task_ctr
)
63 struct spdk_scsi_task
*task
;
65 task
= calloc(1, sizeof(*task
));
74 spdk_scsi_task_put(struct spdk_scsi_task
*task
)
80 spdk_scsi_lun_construct(struct spdk_bdev
*bdev
,
81 void (*hotremove_cb
)(const struct spdk_scsi_lun
*, void *),
84 struct spdk_scsi_lun
*lun
;
86 lun
= calloc(1, sizeof(struct spdk_scsi_lun
));
87 SPDK_CU_ASSERT_FATAL(lun
!= NULL
);
95 spdk_scsi_lun_destruct(struct spdk_scsi_lun
*lun
)
101 spdk_bdev_get_by_name(const char *bdev_name
)
105 for (i
= 0; i
< SPDK_COUNTOF(g_bdevs
); i
++) {
106 if (strcmp(bdev_name
, g_bdevs
[i
].name
) == 0) {
115 spdk_scsi_lun_task_mgmt_execute(struct spdk_scsi_task
*task
, enum spdk_scsi_task_func func
)
121 spdk_scsi_lun_execute_task(struct spdk_scsi_lun
*lun
, struct spdk_scsi_task
*task
)
126 _spdk_scsi_lun_allocate_io_channel(struct spdk_scsi_lun
*lun
)
132 _spdk_scsi_lun_free_io_channel(struct spdk_scsi_lun
*lun
)
137 spdk_scsi_lun_has_pending_tasks(const struct spdk_scsi_lun
*lun
)
143 dev_destruct_null_dev(void)
145 /* pass null for the dev */
146 spdk_scsi_dev_destruct(NULL
);
150 dev_destruct_zero_luns(void)
152 struct spdk_scsi_dev dev
= { .is_allocated
= 1 };
154 /* No luns attached to the dev */
157 spdk_scsi_dev_destruct(&dev
);
161 dev_destruct_null_lun(void)
163 struct spdk_scsi_dev dev
= { .is_allocated
= 1 };
165 /* pass null for the lun */
169 spdk_scsi_dev_destruct(&dev
);
173 dev_destruct_success(void)
175 struct spdk_scsi_dev dev
= { .is_allocated
= 1 };
178 /* dev with a single lun */
179 rc
= spdk_scsi_dev_add_lun(&dev
, "malloc0", 0, NULL
, NULL
);
184 spdk_scsi_dev_destruct(&dev
);
189 dev_construct_num_luns_zero(void)
191 struct spdk_scsi_dev
*dev
;
192 const char *bdev_name_list
[1] = {};
193 int lun_id_list
[1] = { 0 };
195 dev
= spdk_scsi_dev_construct("Name", bdev_name_list
, lun_id_list
, 0,
196 SPDK_SPC_PROTOCOL_IDENTIFIER_ISCSI
, NULL
, NULL
);
198 /* dev should be null since we passed num_luns = 0 */
199 CU_ASSERT_TRUE(dev
== NULL
);
203 dev_construct_no_lun_zero(void)
205 struct spdk_scsi_dev
*dev
;
206 const char *bdev_name_list
[1] = {};
207 int lun_id_list
[1] = { 0 };
211 dev
= spdk_scsi_dev_construct("Name", bdev_name_list
, lun_id_list
, 1,
212 SPDK_SPC_PROTOCOL_IDENTIFIER_ISCSI
, NULL
, NULL
);
214 /* dev should be null since no LUN0 was specified (lun_id_list[0] = 1) */
215 CU_ASSERT_TRUE(dev
== NULL
);
219 dev_construct_null_lun(void)
221 struct spdk_scsi_dev
*dev
;
222 const char *bdev_name_list
[1] = {};
223 int lun_id_list
[1] = { 0 };
225 dev
= spdk_scsi_dev_construct("Name", bdev_name_list
, lun_id_list
, 1,
226 SPDK_SPC_PROTOCOL_IDENTIFIER_ISCSI
, NULL
, NULL
);
228 /* dev should be null since no LUN0 was specified (lun_list[0] = NULL) */
229 CU_ASSERT_TRUE(dev
== NULL
);
233 dev_construct_name_too_long(void)
235 struct spdk_scsi_dev
*dev
;
236 const char *bdev_name_list
[1] = {"malloc0"};
237 int lun_id_list
[1] = { 0 };
238 char name
[SPDK_SCSI_DEV_MAX_NAME
+ 1 + 1];
240 /* Try to construct a dev with a name that is one byte longer than allowed. */
241 memset(name
, 'x', sizeof(name
) - 1);
242 name
[sizeof(name
) - 1] = '\0';
244 dev
= spdk_scsi_dev_construct(name
, bdev_name_list
, lun_id_list
, 1,
245 SPDK_SPC_PROTOCOL_IDENTIFIER_ISCSI
, NULL
, NULL
);
247 CU_ASSERT(dev
== NULL
);
251 dev_construct_success(void)
253 struct spdk_scsi_dev
*dev
;
254 const char *bdev_name_list
[1] = {"malloc0"};
255 int lun_id_list
[1] = { 0 };
257 dev
= spdk_scsi_dev_construct("Name", bdev_name_list
, lun_id_list
, 1,
258 SPDK_SPC_PROTOCOL_IDENTIFIER_ISCSI
, NULL
, NULL
);
260 /* Successfully constructs and returns a dev */
261 CU_ASSERT_TRUE(dev
!= NULL
);
264 spdk_scsi_dev_destruct(dev
);
268 dev_construct_success_lun_zero_not_first(void)
270 struct spdk_scsi_dev
*dev
;
271 const char *bdev_name_list
[2] = {"malloc1", "malloc0"};
272 int lun_id_list
[2] = { 1, 0 };
274 dev
= spdk_scsi_dev_construct("Name", bdev_name_list
, lun_id_list
, 2,
275 SPDK_SPC_PROTOCOL_IDENTIFIER_ISCSI
, NULL
, NULL
);
277 /* Successfully constructs and returns a dev */
278 CU_ASSERT_TRUE(dev
!= NULL
);
281 spdk_scsi_dev_destruct(dev
);
285 dev_queue_mgmt_task_success(void)
287 struct spdk_scsi_dev
*dev
;
288 const char *bdev_name_list
[1] = {"malloc0"};
289 int lun_id_list
[1] = { 0 };
290 struct spdk_scsi_task
*task
;
292 dev
= spdk_scsi_dev_construct("Name", bdev_name_list
, lun_id_list
, 1,
293 SPDK_SPC_PROTOCOL_IDENTIFIER_ISCSI
, NULL
, NULL
);
295 /* Successfully constructs and returns a dev */
296 CU_ASSERT_TRUE(dev
!= NULL
);
298 task
= spdk_get_task(NULL
);
300 spdk_scsi_dev_queue_mgmt_task(dev
, task
, SPDK_SCSI_TASK_FUNC_LUN_RESET
);
302 spdk_scsi_task_put(task
);
304 spdk_scsi_dev_destruct(dev
);
308 dev_queue_task_success(void)
310 struct spdk_scsi_dev
*dev
;
311 const char *bdev_name_list
[1] = {"malloc0"};
312 int lun_id_list
[1] = { 0 };
313 struct spdk_scsi_task
*task
;
315 dev
= spdk_scsi_dev_construct("Name", bdev_name_list
, lun_id_list
, 1,
316 SPDK_SPC_PROTOCOL_IDENTIFIER_ISCSI
, NULL
, NULL
);
318 /* Successfully constructs and returns a dev */
319 CU_ASSERT_TRUE(dev
!= NULL
);
321 task
= spdk_get_task(NULL
);
323 spdk_scsi_dev_queue_task(dev
, task
);
325 spdk_scsi_task_put(task
);
327 spdk_scsi_dev_destruct(dev
);
331 dev_stop_success(void)
333 struct spdk_scsi_dev dev
= { 0 };
334 struct spdk_scsi_task
*task
;
335 struct spdk_scsi_task
*task_mgmt
;
337 task
= spdk_get_task(NULL
);
339 spdk_scsi_dev_queue_task(&dev
, task
);
341 task_mgmt
= spdk_get_task(NULL
);
343 /* Enqueue the tasks into dev->task_mgmt_submit_queue */
344 spdk_scsi_dev_queue_mgmt_task(&dev
, task_mgmt
, SPDK_SCSI_TASK_FUNC_LUN_RESET
);
346 spdk_scsi_task_put(task
);
347 spdk_scsi_task_put(task_mgmt
);
351 dev_add_port_max_ports(void)
353 struct spdk_scsi_dev dev
= { 0 };
357 /* dev is set to SPDK_SCSI_DEV_MAX_PORTS */
358 dev
.num_ports
= SPDK_SCSI_DEV_MAX_PORTS
;
359 name
= "Name of Port";
362 rc
= spdk_scsi_dev_add_port(&dev
, id
, name
);
364 /* returns -1; since the dev already has maximum
365 * number of ports (SPDK_SCSI_DEV_MAX_PORTS) */
366 CU_ASSERT_TRUE(rc
< 0);
370 dev_add_port_construct_failure1(void)
372 struct spdk_scsi_dev dev
= { 0 };
373 const int port_name_length
= SPDK_SCSI_PORT_MAX_NAME_LENGTH
+ 2;
374 char name
[port_name_length
];
379 /* Set the name such that the length exceeds SPDK_SCSI_PORT_MAX_NAME_LENGTH
380 * SPDK_SCSI_PORT_MAX_NAME_LENGTH = 256 */
381 memset(name
, 'a', port_name_length
- 1);
382 name
[port_name_length
- 1] = '\0';
385 rc
= spdk_scsi_dev_add_port(&dev
, id
, name
);
387 /* returns -1; since the length of the name exceeds
388 * SPDK_SCSI_PORT_MAX_NAME_LENGTH */
389 CU_ASSERT_TRUE(rc
< 0);
393 dev_add_port_construct_failure2(void)
395 struct spdk_scsi_dev dev
= { 0 };
401 name
= "Name of Port";
404 /* Initialize port[0] to be valid and its index is set to 1 */
406 dev
.port
[0].is_used
= 1;
408 rc
= spdk_scsi_dev_add_port(&dev
, id
, name
);
410 /* returns -1; since the dev already has a port whose index to be 1 */
411 CU_ASSERT_TRUE(rc
< 0);
415 dev_add_port_success1(void)
417 struct spdk_scsi_dev dev
= { 0 };
422 name
= "Name of Port";
425 rc
= spdk_scsi_dev_add_port(&dev
, id
, name
);
427 /* successfully adds a port */
428 CU_ASSERT_EQUAL(rc
, 0);
429 /* Assert num_ports has been incremented to 2 */
430 CU_ASSERT_EQUAL(dev
.num_ports
, 2);
434 dev_add_port_success2(void)
436 struct spdk_scsi_dev dev
= { 0 };
442 name
= "Name of Port";
444 /* set id of invalid port[0] to 1. This must be ignored */
446 dev
.port
[0].is_used
= 0;
448 rc
= spdk_scsi_dev_add_port(&dev
, id
, name
);
450 /* successfully adds a port */
451 CU_ASSERT_EQUAL(rc
, 0);
452 /* Assert num_ports has been incremented to 1 */
453 CU_ASSERT_EQUAL(dev
.num_ports
, 2);
457 dev_add_port_success3(void)
459 struct spdk_scsi_dev dev
= { 0 };
465 name
= "Name of Port";
467 dev
.port
[0].is_used
= 1;
470 /* Add a port with id = 2 */
471 rc
= spdk_scsi_dev_add_port(&dev
, add_id
, name
);
473 /* successfully adds a port */
474 CU_ASSERT_EQUAL(rc
, 0);
475 /* Assert num_ports has been incremented to 2 */
476 CU_ASSERT_EQUAL(dev
.num_ports
, 2);
480 dev_find_port_by_id_num_ports_zero(void)
482 struct spdk_scsi_dev dev
= { 0 };
483 struct spdk_scsi_port
*rp_port
;
489 rp_port
= spdk_scsi_dev_find_port_by_id(&dev
, id
);
491 /* returns null; since dev's num_ports is 0 */
492 CU_ASSERT_TRUE(rp_port
== NULL
);
496 dev_find_port_by_id_id_not_found_failure(void)
498 struct spdk_scsi_dev dev
= { 0 };
499 struct spdk_scsi_port
*rp_port
;
502 uint64_t id
, find_id
;
506 name
= "Name of Port";
509 /* Add a port with id = 1 */
510 rc
= spdk_scsi_dev_add_port(&dev
, id
, name
);
512 CU_ASSERT_EQUAL(rc
, 0);
514 /* Find port with id = 2 */
515 rp_port
= spdk_scsi_dev_find_port_by_id(&dev
, find_id
);
517 /* returns null; failed to find port specified by id = 2 */
518 CU_ASSERT_TRUE(rp_port
== NULL
);
522 dev_find_port_by_id_success(void)
524 struct spdk_scsi_dev dev
= { 0 };
525 struct spdk_scsi_port
*rp_port
;
532 name
= "Name of Port";
535 rc
= spdk_scsi_dev_add_port(&dev
, id
, name
);
537 CU_ASSERT_EQUAL(rc
, 0);
539 /* Find port by the same id as the one added above */
540 rp_port
= spdk_scsi_dev_find_port_by_id(&dev
, id
);
542 /* Successfully found port specified by id */
543 CU_ASSERT_TRUE(rp_port
!= NULL
);
544 if (rp_port
!= NULL
) {
545 /* Assert the found port's id and name are same as
547 CU_ASSERT_EQUAL(rp_port
->id
, 1);
548 CU_ASSERT_STRING_EQUAL(rp_port
->name
, "Name of Port");
553 dev_add_lun_bdev_not_found(void)
556 struct spdk_scsi_dev dev
= {0};
558 rc
= spdk_scsi_dev_add_lun(&dev
, "malloc2", 0, NULL
, NULL
);
560 SPDK_CU_ASSERT_FATAL(dev
.lun
[0] == NULL
);
561 CU_ASSERT_NOT_EQUAL(rc
, 0);
565 dev_add_lun_no_free_lun_id(void)
569 struct spdk_scsi_dev dev
= {0};
570 struct spdk_scsi_lun lun
;
572 for (i
= 0; i
< SPDK_SCSI_DEV_MAX_LUN
; i
++) {
576 rc
= spdk_scsi_dev_add_lun(&dev
, "malloc0", -1, NULL
, NULL
);
578 CU_ASSERT_NOT_EQUAL(rc
, 0);
582 dev_add_lun_success1(void)
585 struct spdk_scsi_dev dev
= {0};
587 rc
= spdk_scsi_dev_add_lun(&dev
, "malloc0", -1, NULL
, NULL
);
589 CU_ASSERT_EQUAL(rc
, 0);
591 spdk_scsi_dev_destruct(&dev
);
595 dev_add_lun_success2(void)
598 struct spdk_scsi_dev dev
= {0};
600 rc
= spdk_scsi_dev_add_lun(&dev
, "malloc0", 0, NULL
, NULL
);
602 CU_ASSERT_EQUAL(rc
, 0);
604 spdk_scsi_dev_destruct(&dev
);
608 main(int argc
, char **argv
)
610 CU_pSuite suite
= NULL
;
611 unsigned int num_failures
;
613 if (CU_initialize_registry() != CUE_SUCCESS
) {
614 return CU_get_error();
617 suite
= CU_add_suite("dev_suite", NULL
, NULL
);
619 CU_cleanup_registry();
620 return CU_get_error();
624 CU_add_test(suite
, "destruct - null dev",
625 dev_destruct_null_dev
) == NULL
626 || CU_add_test(suite
, "destruct - zero luns", dev_destruct_zero_luns
) == NULL
627 || CU_add_test(suite
, "destruct - null lun", dev_destruct_null_lun
) == NULL
628 || CU_add_test(suite
, "destruct - success", dev_destruct_success
) == NULL
629 || CU_add_test(suite
, "construct - queue depth gt max depth",
630 dev_construct_num_luns_zero
) == NULL
631 || CU_add_test(suite
, "construct - no lun0",
632 dev_construct_no_lun_zero
) == NULL
633 || CU_add_test(suite
, "construct - null lun",
634 dev_construct_null_lun
) == NULL
635 || CU_add_test(suite
, "construct - name too long", dev_construct_name_too_long
) == NULL
636 || CU_add_test(suite
, "construct - success", dev_construct_success
) == NULL
637 || CU_add_test(suite
, "construct - success - LUN zero not first",
638 dev_construct_success_lun_zero_not_first
) == NULL
639 || CU_add_test(suite
, "dev queue task mgmt - success",
640 dev_queue_mgmt_task_success
) == NULL
641 || CU_add_test(suite
, "dev queue task - success",
642 dev_queue_task_success
) == NULL
643 || CU_add_test(suite
, "dev stop - success", dev_stop_success
) == NULL
644 || CU_add_test(suite
, "dev add port - max ports",
645 dev_add_port_max_ports
) == NULL
646 || CU_add_test(suite
, "dev add port - construct port failure 1",
647 dev_add_port_construct_failure1
) == NULL
648 || CU_add_test(suite
, "dev add port - construct port failure 2",
649 dev_add_port_construct_failure2
) == NULL
650 || CU_add_test(suite
, "dev add port - success 1",
651 dev_add_port_success1
) == NULL
652 || CU_add_test(suite
, "dev add port - success 2",
653 dev_add_port_success2
) == NULL
654 || CU_add_test(suite
, "dev add port - success 3",
655 dev_add_port_success3
) == NULL
656 || CU_add_test(suite
, "dev find port by id - num ports zero",
657 dev_find_port_by_id_num_ports_zero
) == NULL
658 || CU_add_test(suite
, "dev find port by id - different port id failure",
659 dev_find_port_by_id_id_not_found_failure
) == NULL
660 || CU_add_test(suite
, "dev find port by id - success",
661 dev_find_port_by_id_success
) == NULL
662 || CU_add_test(suite
, "dev add lun - bdev not found",
663 dev_add_lun_bdev_not_found
) == NULL
664 || CU_add_test(suite
, "dev add lun - no free lun id",
665 dev_add_lun_no_free_lun_id
) == NULL
666 || CU_add_test(suite
, "dev add lun - success 1",
667 dev_add_lun_success1
) == NULL
668 || CU_add_test(suite
, "dev add lun - success 2",
669 dev_add_lun_success2
) == NULL
671 CU_cleanup_registry();
672 return CU_get_error();
675 CU_basic_set_mode(CU_BRM_VERBOSE
);
676 CU_basic_run_tests();
677 num_failures
= CU_get_number_of_failures();
678 CU_cleanup_registry();