xref: /spdk/test/unit/lib/scsi/scsi_pr.c/scsi_pr_ut.c (revision cde2142cd008f2fa6b0edb2a9194c36c7df6da52)

/*   SPDX-License-Identifier: BSD-3-Clause
 *   Copyright (C) 2019 Intel Corporation.
 *   All rights reserved.
 */

#include "spdk/stdinc.h"

#include "scsi/port.c"
#include "scsi/scsi_pr.c"

#include "spdk_internal/cunit.h"

#include "spdk_internal/mock.h"

SPDK_LOG_REGISTER_COMPONENT(scsi)

void
spdk_scsi_task_set_status(struct spdk_scsi_task *task, int sc, int sk,
			  int asc, int ascq)
{
	task->status = sc;
}

/*
 * Reservation Unit Test Configuration
 *
 *  --------      --------      -------
 * | Host A |    | Host B |    | Host C|
 *  --------      --------      -------
 *     |             |             |
 *   ------        ------        ------
 *  |Port A|      |Port B|      |Port C|
 *   ------        ------        ------
 *      \            |             /
 *       \           |            /
 *        \          |           /
 *        ------------------------
 *       |  Target Node 1 Port 0  |
 *        ------------------------
 *                   |
 *   ----------------------------------
 *  |           Target Node            |
 *   ----------------------------------
 *                  |
 *                -----
 *               |LUN 0|
 *                -----
 *
 */

static struct spdk_scsi_lun g_lun;
static struct spdk_scsi_port g_i_port_a;
static struct spdk_scsi_port g_i_port_b;
static struct spdk_scsi_port g_i_port_c;
static struct spdk_scsi_port g_t_port_0;

static void
ut_lun_deinit(void)
{
	struct spdk_scsi_pr_registrant *reg, *tmp;

	TAILQ_FOREACH_SAFE(reg, &g_lun.reg_head, link, tmp) {
		TAILQ_REMOVE(&g_lun.reg_head, reg, link);
		free(reg);
	}
	g_lun.reservation.rtype = 0;
	g_lun.reservation.crkey = 0;
	g_lun.reservation.holder = NULL;
	g_lun.pr_generation = 0;
}

static void
ut_port_init(void)
{
	int rc;

	/* g_i_port_a */
	rc = scsi_port_construct(&g_i_port_a, 0xa, 0,
				 "iqn.2016-06.io.spdk:fe5aacf7420a,i,0x00023d00000a");
	SPDK_CU_ASSERT_FATAL(rc == 0);
	spdk_scsi_port_set_iscsi_transport_id(&g_i_port_a,
					      "iqn.2016-06.io.spdk:fe5aacf7420a", 0x00023d00000a);
	/* g_i_port_b */
	rc = scsi_port_construct(&g_i_port_b, 0xb, 0,
				 "iqn.2016-06.io.spdk:fe5aacf7420b,i,0x00023d00000b");
	SPDK_CU_ASSERT_FATAL(rc == 0);
	spdk_scsi_port_set_iscsi_transport_id(&g_i_port_b,
					      "iqn.2016-06.io.spdk:fe5aacf7420b", 0x00023d00000b);
	/* g_i_port_c */
	rc = scsi_port_construct(&g_i_port_c, 0xc, 0,
				 "iqn.2016-06.io.spdk:fe5aacf7420c,i,0x00023d00000c");
	SPDK_CU_ASSERT_FATAL(rc == 0);
	spdk_scsi_port_set_iscsi_transport_id(&g_i_port_c,
					      "iqn.2016-06.io.spdk:fe5aacf7420c", 0x00023d00000c);
	/* g_t_port_0 */
	rc = scsi_port_construct(&g_t_port_0, 0x0, 1,
				 "iqn.2016-06.io.spdk:fe5aacf74200,t,0x00023d000000");
	SPDK_CU_ASSERT_FATAL(rc == 0);
	spdk_scsi_port_set_iscsi_transport_id(&g_t_port_0,
					      "iqn.2016-06.io.spdk:fe5aacf74200", 0x00023d000000);
}

static void
ut_lun_init(void)
{
	TAILQ_INIT(&g_lun.reg_head);
}

static void
ut_init_reservation_test(void)
{
	ut_lun_init();
	ut_port_init();
	ut_lun_init();
}

static void
ut_deinit_reservation_test(void)
{
	ut_lun_deinit();
}

/* Host A: register with key 0xa.
 * Host B: register with key 0xb.
 * Host C: register with key 0xc.
 */
static void
test_build_registrants(void)
{
	struct spdk_scsi_pr_registrant *reg;
	struct spdk_scsi_task task = {0};
	uint32_t gen;
	int rc;

	task.lun = &g_lun;
	task.target_port = &g_t_port_0;

	gen = g_lun.pr_generation;

	/* I_T nexus: Initiator Port A to Target Port 0 */
	task.initiator_port = &g_i_port_a;
	/* Test Case: Host A registers with a new key */
	task.status = 0;
	rc = scsi_pr_out_register(&task, SPDK_SCSI_PR_OUT_REGISTER,
				  0x0, 0xa1, 0, 0, 0);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	reg = scsi_pr_get_registrant(&g_lun, &g_i_port_a, &g_t_port_0);
	SPDK_CU_ASSERT_FATAL(reg != NULL);
	SPDK_CU_ASSERT_FATAL(reg->rkey == 0xa1);
	SPDK_CU_ASSERT_FATAL(g_lun.pr_generation == gen + 1);

	/* Test Case: Host A replaces with a new key */
	task.status = 0;
	rc = scsi_pr_out_register(&task, SPDK_SCSI_PR_OUT_REGISTER,
				  0xa1, 0xa, 0, 0, 0);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	reg = scsi_pr_get_registrant(&g_lun, &g_i_port_a, &g_t_port_0);
	SPDK_CU_ASSERT_FATAL(reg != NULL);
	SPDK_CU_ASSERT_FATAL(reg->rkey == 0xa);
	SPDK_CU_ASSERT_FATAL(g_lun.pr_generation == gen + 2);

	/* Test Case: Host A replaces with a new key, reservation conflict is expected */
	task.status = 0;
	rc = scsi_pr_out_register(&task, SPDK_SCSI_PR_OUT_REGISTER,
				  0xa1, 0xdead, 0, 0, 0);
	SPDK_CU_ASSERT_FATAL(rc < 0);
	reg = scsi_pr_get_registrant(&g_lun, &g_i_port_a, &g_t_port_0);
	SPDK_CU_ASSERT_FATAL(reg != NULL);
	SPDK_CU_ASSERT_FATAL(reg->rkey == 0xa);
	SPDK_CU_ASSERT_FATAL(g_lun.pr_generation == gen + 2);
	SPDK_CU_ASSERT_FATAL(task.status == SPDK_SCSI_STATUS_RESERVATION_CONFLICT);

	/* I_T nexus: Initiator Port B to Target Port 0 */
	task.initiator_port = &g_i_port_b;
	/* Test Case: Host B registers with a new key */
	task.status = 0;
	rc = scsi_pr_out_register(&task, SPDK_SCSI_PR_OUT_REGISTER,
				  0x0, 0xb, 0, 0, 0);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	reg = scsi_pr_get_registrant(&g_lun, &g_i_port_b, &g_t_port_0);
	SPDK_CU_ASSERT_FATAL(reg != NULL);
	SPDK_CU_ASSERT_FATAL(reg->rkey == 0xb);
	SPDK_CU_ASSERT_FATAL(g_lun.pr_generation == gen + 3);

	/* I_T nexus: Initiator Port C to Target Port 0 */
	task.initiator_port = &g_i_port_c;
	/* Test Case: Host C registers with a new key */
	task.status = 0;
	rc = scsi_pr_out_register(&task, SPDK_SCSI_PR_OUT_REGISTER,
				  0x0, 0xc, 0, 0, 0);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	reg = scsi_pr_get_registrant(&g_lun, &g_i_port_c, &g_t_port_0);
	SPDK_CU_ASSERT_FATAL(reg != NULL);
	SPDK_CU_ASSERT_FATAL(reg->rkey == 0xc);
	SPDK_CU_ASSERT_FATAL(g_lun.pr_generation == gen + 4);
}

static void
test_reservation_register(void)
{
	ut_init_reservation_test();

	test_build_registrants();

	ut_deinit_reservation_test();
}

static void
test_all_registrant_reservation_reserve(void)
{
	struct spdk_scsi_pr_registrant *reg;
	struct spdk_scsi_task task = {0};
	uint32_t gen;
	int rc;

	task.lun = &g_lun;
	task.target_port = &g_t_port_0;

	ut_init_reservation_test();

	test_build_registrants();
	gen = g_lun.pr_generation;
	/* Test Case: Host A takes all registrant reservation */
	task.initiator_port = &g_i_port_a;
	task.status = 0;
	rc = scsi_pr_out_reserve(&task, SPDK_SCSI_PR_WRITE_EXCLUSIVE_ALL_REGS,
				 0xa, 0, 0, 0);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	SPDK_CU_ASSERT_FATAL(task.status == 0);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.rtype == SPDK_SCSI_PR_WRITE_EXCLUSIVE_ALL_REGS);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.crkey == 0xa);
	SPDK_CU_ASSERT_FATAL(g_lun.pr_generation == gen);

	/* Test case: Host A release reservation - which should pass to next inline -> Host B */
	task.initiator_port = &g_i_port_a;
	task.status = 0;
	rc = scsi_pr_out_release(&task, SPDK_SCSI_PR_WRITE_EXCLUSIVE_ALL_REGS, 0xa);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	SPDK_CU_ASSERT_FATAL(task.status == 0);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.rtype == SPDK_SCSI_PR_WRITE_EXCLUSIVE_ALL_REGS);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.crkey == 0xb);
	SPDK_CU_ASSERT_FATAL(g_lun.pr_generation == gen);

	/* Test case: Host A unregister + Host C unregister: Host B left alone.
	 * Host B than releases reservation - lun should not have any reservation holder *
	 */
	task.initiator_port = &g_i_port_a;
	task.status = 0;
	rc = scsi_pr_out_register(&task, SPDK_SCSI_PR_OUT_REGISTER,
				  0xa, 0, 0, 0, 0);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	SPDK_CU_ASSERT_FATAL(task.status == 0);
	reg = scsi_pr_get_registrant(&g_lun, &g_i_port_a, &g_t_port_0);
	SPDK_CU_ASSERT_FATAL(reg == NULL);
	SPDK_CU_ASSERT_FATAL(g_lun.pr_generation == ++gen);

	task.initiator_port = &g_i_port_c;
	task.status = 0;
	rc = scsi_pr_out_register(&task, SPDK_SCSI_PR_OUT_REGISTER,
				  0xc, 0, 0, 0, 0);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	SPDK_CU_ASSERT_FATAL(task.status == 0);
	reg = scsi_pr_get_registrant(&g_lun, &g_i_port_c, &g_t_port_0);
	SPDK_CU_ASSERT_FATAL(reg == NULL);
	SPDK_CU_ASSERT_FATAL(g_lun.pr_generation == ++gen);

	task.initiator_port = &g_i_port_b;
	task.status = 0;
	rc = scsi_pr_out_release(&task, SPDK_SCSI_PR_WRITE_EXCLUSIVE_ALL_REGS, 0xb);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	SPDK_CU_ASSERT_FATAL(task.status == 0);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.rtype == 0x0);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.crkey == 0x0);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.holder == NULL);
	SPDK_CU_ASSERT_FATAL(g_lun.pr_generation == gen);

	ut_deinit_reservation_test();
}

static void
test_all_registrant_reservation_access(void)
{
	struct spdk_scsi_pr_registrant *reg;
	struct spdk_scsi_task task = {0};
	uint8_t cdb[32] = {0};
	uint32_t gen;
	int rc;

	task.lun = &g_lun;
	task.target_port = &g_t_port_0;
	task.cdb = cdb;

	ut_init_reservation_test();

	test_build_registrants();
	gen = g_lun.pr_generation;

	/* Test case: registered host A takes EXCLUSIVE_ACCESS_ALL_REGS reservation */
	task.initiator_port = &g_i_port_a;
	task.status = 0;
	rc = scsi_pr_out_reserve(&task, SPDK_SCSI_PR_EXCLUSIVE_ACCESS_ALL_REGS,
				 0xa, 0, 0, 0);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	SPDK_CU_ASSERT_FATAL(task.status == 0);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.rtype == SPDK_SCSI_PR_EXCLUSIVE_ACCESS_ALL_REGS);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.crkey == 0xa);
	SPDK_CU_ASSERT_FATAL(g_lun.pr_generation == gen);

	/* Test case: registered host B tries getting read access */
	task.initiator_port = &g_i_port_b;
	task.status = 0;
	task.cdb[0] = SPDK_SBC_READ_6;
	rc = scsi_pr_check(&task);
	SPDK_CU_ASSERT_FATAL(rc == 0);

	/* Test case: registered host B tries getting write access */
	task.initiator_port = &g_i_port_b;
	task.status = 0;
	task.cdb[0] = SPDK_SBC_WRITE_12;
	rc = scsi_pr_check(&task);
	SPDK_CU_ASSERT_FATAL(rc == 0);

	/* Test case: B unregisters */
	task.initiator_port = &g_i_port_b;
	task.status = 0;
	rc = scsi_pr_out_register(&task, SPDK_SCSI_PR_OUT_REGISTER,
				  0xb, 0, 0, 0, 0);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	SPDK_CU_ASSERT_FATAL(task.status == 0);
	SPDK_CU_ASSERT_FATAL(g_lun.pr_generation == ++gen);
	reg = scsi_pr_get_registrant(&g_lun, &g_i_port_b, &g_t_port_0);
	SPDK_CU_ASSERT_FATAL(reg == NULL);

	/* Test case: un register host B tries getting read access */
	task.initiator_port = &g_i_port_b;
	task.status = 0;
	task.cdb[0] = SPDK_SBC_READ_6;
	rc = scsi_pr_check(&task);
	SPDK_CU_ASSERT_FATAL(rc < 0);

	/* Test case: un register host B tries getting write access */
	task.initiator_port = &g_i_port_b;
	task.status = 0;
	task.cdb[0] = SPDK_SBC_WRITE_12;
	rc = scsi_pr_check(&task);
	SPDK_CU_ASSERT_FATAL(rc < 0);

	ut_deinit_reservation_test();
}

static void
test_reservation_reserve(void)
{
	struct spdk_scsi_pr_registrant *reg;
	struct spdk_scsi_task task = {0};
	uint32_t gen;
	int rc;

	task.lun = &g_lun;
	task.target_port = &g_t_port_0;

	ut_init_reservation_test();
	/* Test Case: call Release without a reservation */
	rc = scsi2_release(&task);
	CU_ASSERT(rc == -EINVAL);
	CU_ASSERT(task.status == SPDK_SCSI_STATUS_CHECK_CONDITION);

	test_build_registrants();

	gen = g_lun.pr_generation;

	task.initiator_port = &g_i_port_a;
	task.status = 0;
	/* Test Case: Host A acquires the reservation */
	rc = scsi_pr_out_reserve(&task, SPDK_SCSI_PR_WRITE_EXCLUSIVE,
				 0xa, 0, 0, 0);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.rtype == SPDK_SCSI_PR_WRITE_EXCLUSIVE);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.crkey == 0xa);
	SPDK_CU_ASSERT_FATAL(g_lun.pr_generation == gen);

	/* Test Case: Host B acquires the reservation, reservation
	 * conflict is expected.
	 */
	task.initiator_port = &g_i_port_b;
	task.status = 0;
	rc = scsi_pr_out_reserve(&task, SPDK_SCSI_PR_WRITE_EXCLUSIVE,
				 0xb, 0, 0, 0);
	SPDK_CU_ASSERT_FATAL(rc < 0);
	SPDK_CU_ASSERT_FATAL(task.status == SPDK_SCSI_STATUS_RESERVATION_CONFLICT);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.rtype == SPDK_SCSI_PR_WRITE_EXCLUSIVE);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.crkey == 0xa);
	SPDK_CU_ASSERT_FATAL(g_lun.pr_generation == gen);

	/* Test Case: Host A unregister with reservation */
	task.initiator_port = &g_i_port_a;
	task.status = 0;
	rc = scsi_pr_out_register(&task, SPDK_SCSI_PR_OUT_REGISTER,
				  0xa, 0, 0, 0, 0);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.rtype == 0);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.crkey == 0);
	SPDK_CU_ASSERT_FATAL(g_lun.pr_generation == gen + 1);
	reg = scsi_pr_get_registrant(&g_lun, &g_i_port_a, &g_t_port_0);
	SPDK_CU_ASSERT_FATAL(reg == NULL);

	/* Test Case: Host B acquires the reservation */
	task.initiator_port = &g_i_port_b;
	task.status = 0;
	rc = scsi_pr_out_reserve(&task, SPDK_SCSI_PR_WRITE_EXCLUSIVE_ALL_REGS,
				 0xb, 0, 0, 0);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.rtype == SPDK_SCSI_PR_WRITE_EXCLUSIVE_ALL_REGS);
	SPDK_CU_ASSERT_FATAL(g_lun.pr_generation == gen + 1);

	/* Test Case: Host C acquires the reservation with invalid type */
	task.initiator_port = &g_i_port_c;
	task.status = 0;
	rc = scsi_pr_out_reserve(&task, SPDK_SCSI_PR_WRITE_EXCLUSIVE,
				 0xc, 0, 0, 0);
	SPDK_CU_ASSERT_FATAL(rc < 0);
	SPDK_CU_ASSERT_FATAL(task.status == SPDK_SCSI_STATUS_RESERVATION_CONFLICT);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.rtype == SPDK_SCSI_PR_WRITE_EXCLUSIVE_ALL_REGS);
	SPDK_CU_ASSERT_FATAL(g_lun.pr_generation == gen + 1);

	/* Test Case: Host C acquires the reservation, all registrants type */
	task.status = 0;
	rc = scsi_pr_out_reserve(&task, SPDK_SCSI_PR_WRITE_EXCLUSIVE_ALL_REGS,
				 0xc, 0, 0, 0);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.rtype == SPDK_SCSI_PR_WRITE_EXCLUSIVE_ALL_REGS);
	SPDK_CU_ASSERT_FATAL(g_lun.pr_generation == gen + 1);

	ut_deinit_reservation_test();
}

static void
test_reservation_preempt_non_all_regs(void)
{
	struct spdk_scsi_pr_registrant *reg;
	struct spdk_scsi_task task = {0};
	uint32_t gen;
	int rc;

	task.lun = &g_lun;
	task.target_port = &g_t_port_0;

	ut_init_reservation_test();
	test_build_registrants();

	task.initiator_port = &g_i_port_a;
	task.status = 0;
	gen = g_lun.pr_generation;
	/* Host A acquires the reservation */
	rc = scsi_pr_out_reserve(&task, SPDK_SCSI_PR_WRITE_EXCLUSIVE_REGS_ONLY,
				 0xa, 0, 0, 0);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.rtype == SPDK_SCSI_PR_WRITE_EXCLUSIVE_REGS_ONLY);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.crkey == 0xa);
	SPDK_CU_ASSERT_FATAL(g_lun.pr_generation == gen);

	/* Test Case: Host B preempts Host A, Check condition is expected
	 * for zeroed service action reservation key */
	task.initiator_port = &g_i_port_b;
	task.status = 0;
	rc = scsi_pr_out_preempt(&task, SPDK_SCSI_PR_OUT_PREEMPT,
				 SPDK_SCSI_PR_WRITE_EXCLUSIVE_REGS_ONLY,
				 0xb, 0);
	SPDK_CU_ASSERT_FATAL(rc < 0);
	SPDK_CU_ASSERT_FATAL(task.status == SPDK_SCSI_STATUS_CHECK_CONDITION);

	/* Test Case: Host B preempts Host A, Host A is unregistered */
	task.status = 0;
	gen = g_lun.pr_generation;
	rc = scsi_pr_out_preempt(&task, SPDK_SCSI_PR_OUT_PREEMPT,
				 SPDK_SCSI_PR_WRITE_EXCLUSIVE,
				 0xb, 0xa);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.rtype == SPDK_SCSI_PR_WRITE_EXCLUSIVE);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.crkey == 0xb);
	SPDK_CU_ASSERT_FATAL(g_lun.pr_generation > gen);
	reg = scsi_pr_get_registrant(&g_lun, &g_i_port_a, &g_t_port_0);
	SPDK_CU_ASSERT_FATAL(reg == NULL);

	/* Test Case: Host B preempts itself */
	task.status = 0;
	gen = g_lun.pr_generation;
	rc = scsi_pr_out_preempt(&task, SPDK_SCSI_PR_OUT_PREEMPT,
				 SPDK_SCSI_PR_WRITE_EXCLUSIVE,
				 0xb, 0xb);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.rtype == SPDK_SCSI_PR_WRITE_EXCLUSIVE);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.crkey == 0xb);
	SPDK_CU_ASSERT_FATAL(g_lun.pr_generation > gen);

	/* Test Case: Host B preempts itself and remove registrants */
	task.status = 0;
	gen = g_lun.pr_generation;
	rc = scsi_pr_out_preempt(&task, SPDK_SCSI_PR_OUT_PREEMPT,
				 SPDK_SCSI_PR_WRITE_EXCLUSIVE,
				 0xb, 0xc);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.rtype == SPDK_SCSI_PR_WRITE_EXCLUSIVE);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.crkey == 0xb);
	reg = scsi_pr_get_registrant(&g_lun, &g_i_port_c, &g_t_port_0);
	SPDK_CU_ASSERT_FATAL(reg == NULL);
	SPDK_CU_ASSERT_FATAL(g_lun.pr_generation > gen);

	ut_deinit_reservation_test();
}

static void
test_reservation_preempt_all_regs(void)
{
	struct spdk_scsi_pr_registrant *reg;
	struct spdk_scsi_task task = {0};
	uint32_t gen;
	int rc;

	task.lun = &g_lun;
	task.target_port = &g_t_port_0;

	ut_init_reservation_test();
	test_build_registrants();

	/* Test Case: No reservation yet, Host B removes Host C's registrant */
	task.initiator_port = &g_i_port_b;
	task.status = 0;
	gen = g_lun.pr_generation;
	rc = scsi_pr_out_preempt(&task, SPDK_SCSI_PR_OUT_PREEMPT,
				 SPDK_SCSI_PR_WRITE_EXCLUSIVE_REGS_ONLY,
				 0xb, 0xc);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	reg = scsi_pr_get_registrant(&g_lun, &g_i_port_c, &g_t_port_0);
	SPDK_CU_ASSERT_FATAL(reg == NULL);
	SPDK_CU_ASSERT_FATAL(g_lun.pr_generation > gen);

	task.initiator_port = &g_i_port_a;
	task.status = 0;
	gen = g_lun.pr_generation;
	/* Host A acquires the reservation */
	rc = scsi_pr_out_reserve(&task, SPDK_SCSI_PR_WRITE_EXCLUSIVE_ALL_REGS,
				 0xa, 0, 0, 0);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.rtype == SPDK_SCSI_PR_WRITE_EXCLUSIVE_ALL_REGS);
	SPDK_CU_ASSERT_FATAL(g_lun.pr_generation == gen);

	/* Test Case: Host B removes Host A's registrant and preempt */
	task.initiator_port = &g_i_port_b;
	task.status = 0;
	gen = g_lun.pr_generation;
	rc = scsi_pr_out_preempt(&task, SPDK_SCSI_PR_OUT_PREEMPT,
				 SPDK_SCSI_PR_EXCLUSIVE_ACCESS_ALL_REGS,
				 0xb, 0x0);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	reg = scsi_pr_get_registrant(&g_lun, &g_i_port_a, &g_t_port_0);
	SPDK_CU_ASSERT_FATAL(reg == NULL);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.rtype == SPDK_SCSI_PR_EXCLUSIVE_ACCESS_ALL_REGS);
	SPDK_CU_ASSERT_FATAL(g_lun.pr_generation > gen);

	ut_deinit_reservation_test();
}

static void
test_reservation_cmds_conflict(void)
{
	struct spdk_scsi_pr_registrant *reg;
	struct spdk_scsi_task task = {0};
	uint8_t cdb[32];
	int rc;

	task.lun = &g_lun;
	task.target_port = &g_t_port_0;
	task.cdb = cdb;

	ut_init_reservation_test();
	test_build_registrants();

	/* Host A acquires the reservation */
	task.initiator_port = &g_i_port_a;
	rc = scsi_pr_out_reserve(&task, SPDK_SCSI_PR_WRITE_EXCLUSIVE_REGS_ONLY,
				 0xa, 0, 0, 0);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.rtype == SPDK_SCSI_PR_WRITE_EXCLUSIVE_REGS_ONLY);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.crkey == 0xa);

	/* Remove Host B registrant */
	task.initiator_port = &g_i_port_b;
	task.status = 0;
	rc = scsi_pr_out_register(&task, SPDK_SCSI_PR_OUT_REGISTER,
				  0xb, 0, 0, 0, 0);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	reg = scsi_pr_get_registrant(&g_lun, &g_i_port_b, &g_t_port_0);
	SPDK_CU_ASSERT_FATAL(reg == NULL);

	/* Test Case: Host B sends Read/Write commands,
	 * reservation conflict is expected.
	 */
	task.cdb[0] = SPDK_SBC_READ_10;
	task.status = 0;
	rc = scsi_pr_check(&task);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	task.cdb[0] = SPDK_SBC_WRITE_10;
	task.status = 0;
	rc = scsi_pr_check(&task);
	SPDK_CU_ASSERT_FATAL(rc < 0);
	SPDK_CU_ASSERT_FATAL(task.status == SPDK_SCSI_STATUS_RESERVATION_CONFLICT);

	/* Test Case: Host C sends Read/Write commands */
	task.initiator_port = &g_i_port_c;
	task.cdb[0] = SPDK_SBC_READ_10;
	task.status = 0;
	rc = scsi_pr_check(&task);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	task.cdb[0] = SPDK_SBC_WRITE_10;
	task.status = 0;
	rc = scsi_pr_check(&task);
	SPDK_CU_ASSERT_FATAL(rc == 0);

	/* Host A preempts itself with SPDK_SCSI_PR_EXCLUSIVE_ACCESS */
	task.initiator_port = &g_i_port_a;
	rc = scsi_pr_out_preempt(&task, SPDK_SCSI_PR_OUT_PREEMPT,
				 SPDK_SCSI_PR_EXCLUSIVE_ACCESS,
				 0xa, 0xa);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.rtype == SPDK_SCSI_PR_EXCLUSIVE_ACCESS);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.crkey == 0xa);

	/* Test Case: Host C sends Read/Write commands */
	task.initiator_port = &g_i_port_c;
	task.cdb[0] = SPDK_SBC_READ_10;
	task.status = 0;
	rc = scsi_pr_check(&task);
	SPDK_CU_ASSERT_FATAL(rc < 0);
	SPDK_CU_ASSERT_FATAL(task.status == SPDK_SCSI_STATUS_RESERVATION_CONFLICT);
	task.cdb[0] = SPDK_SBC_WRITE_10;
	task.status = 0;
	rc = scsi_pr_check(&task);
	SPDK_CU_ASSERT_FATAL(rc < 0);
	SPDK_CU_ASSERT_FATAL(task.status == SPDK_SCSI_STATUS_RESERVATION_CONFLICT);

	/* Test Case: Host B sends Read/Write commands */
	task.initiator_port = &g_i_port_b;
	task.cdb[0] = SPDK_SBC_READ_10;
	task.status = 0;
	rc = scsi_pr_check(&task);
	SPDK_CU_ASSERT_FATAL(rc < 0);
	SPDK_CU_ASSERT_FATAL(task.status == SPDK_SCSI_STATUS_RESERVATION_CONFLICT);
	task.cdb[0] = SPDK_SBC_WRITE_10;
	task.status = 0;
	rc = scsi_pr_check(&task);
	SPDK_CU_ASSERT_FATAL(rc < 0);
	SPDK_CU_ASSERT_FATAL(task.status == SPDK_SCSI_STATUS_RESERVATION_CONFLICT);

	ut_deinit_reservation_test();
}

static void
test_scsi2_reserve_release(void)
{
	struct spdk_scsi_task task = {0};
	uint8_t cdb[32] = {};
	int rc;

	task.lun = &g_lun;
	task.target_port = &g_t_port_0;
	task.cdb = cdb;

	ut_init_reservation_test();

	/* Test Case: SPC2 RESERVE from Host A */
	task.initiator_port = &g_i_port_a;
	task.cdb[0] = SPDK_SPC2_RESERVE_10;
	rc = scsi2_reserve(&task, task.cdb);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.holder != NULL);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.flags == SCSI_SPC2_RESERVE);

	/* Test Case: READ command from Host B */
	task.initiator_port = &g_i_port_b;
	task.cdb[0] = SPDK_SBC_READ_10;
	task.status = 0;
	rc = scsi2_reserve_check(&task);
	SPDK_CU_ASSERT_FATAL(rc < 0);
	SPDK_CU_ASSERT_FATAL(task.status == SPDK_SCSI_STATUS_RESERVATION_CONFLICT);

	/* Test Case: SPDK_SPC2_RELEASE10 command from Host B */
	task.initiator_port = &g_i_port_b;
	task.cdb[0] = SPDK_SPC2_RELEASE_10;
	task.status = 0;
	rc = scsi2_reserve_check(&task);
	SPDK_CU_ASSERT_FATAL(rc == 0);

	rc = scsi2_release(&task);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.holder == NULL);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.flags == 0);

	/* Test Case: SPC2 RESERVE from Host B */
	task.initiator_port = &g_i_port_b;
	task.cdb[0] = SPDK_SPC2_RESERVE_10;
	rc = scsi2_reserve(&task, task.cdb);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.holder != NULL);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.flags == SCSI_SPC2_RESERVE);

	/* Test Case: READ command from Host B */
	task.initiator_port = &g_i_port_b;
	task.cdb[0] = SPDK_SBC_READ_10;
	rc = scsi2_reserve_check(&task);
	SPDK_CU_ASSERT_FATAL(rc == 0);

	/* Test Case: SPDK_SPC2_RELEASE10 command from Host A */
	task.initiator_port = &g_i_port_a;
	task.cdb[0] = SPDK_SPC2_RELEASE_10;

	rc = scsi2_release(&task);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.holder == NULL);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.flags == 0);

	ut_deinit_reservation_test();
}

static void
test_pr_with_scsi2_reserve_release(void)
{
	struct spdk_scsi_task task = {0};
	uint8_t cdb[32] = {};
	int rc;

	task.lun = &g_lun;
	task.target_port = &g_t_port_0;
	task.cdb = cdb;

	ut_init_reservation_test();
	test_build_registrants();

	task.initiator_port = &g_i_port_a;
	task.status = 0;
	/* Test Case: Host A acquires the reservation */
	rc = scsi_pr_out_reserve(&task, SPDK_SCSI_PR_WRITE_EXCLUSIVE_REGS_ONLY,
				 0xa, 0, 0, 0);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.rtype == SPDK_SCSI_PR_WRITE_EXCLUSIVE_REGS_ONLY);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.crkey == 0xa);

	/* Test Case: SPDK_SPC2_RESERVE_10 command from Host B */
	task.initiator_port = &g_i_port_b;
	task.cdb[0] = SPDK_SPC2_RESERVE_10;
	/* SPC2 RESERVE/RELEASE will pass to scsi2_reserve/release */
	rc = scsi_pr_check(&task);
	SPDK_CU_ASSERT_FATAL(rc == 0);

	/* do nothing with PR but have good status */
	rc = scsi2_reserve(&task, task.cdb);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.holder != NULL);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.rtype == SPDK_SCSI_PR_WRITE_EXCLUSIVE_REGS_ONLY);

	rc = scsi2_release(&task);
	SPDK_CU_ASSERT_FATAL(rc == 0);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.holder != NULL);
	SPDK_CU_ASSERT_FATAL(g_lun.reservation.rtype == SPDK_SCSI_PR_WRITE_EXCLUSIVE_REGS_ONLY);

	ut_deinit_reservation_test();
}

int
main(int argc, char **argv)
{
	CU_pSuite	suite = NULL;
	unsigned int	num_failures;

	CU_initialize_registry();

	suite = CU_add_suite("reservation_suite", NULL, NULL);
	CU_ADD_TEST(suite, test_reservation_register);
	CU_ADD_TEST(suite, test_reservation_reserve);
	CU_ADD_TEST(suite, test_all_registrant_reservation_reserve);
	CU_ADD_TEST(suite, test_all_registrant_reservation_access);
	CU_ADD_TEST(suite, test_reservation_preempt_non_all_regs);
	CU_ADD_TEST(suite, test_reservation_preempt_all_regs);
	CU_ADD_TEST(suite, test_reservation_cmds_conflict);
	CU_ADD_TEST(suite, test_scsi2_reserve_release);
	CU_ADD_TEST(suite, test_pr_with_scsi2_reserve_release);

	num_failures = spdk_ut_run_tests(argc, argv, NULL);
	CU_cleanup_registry();
	return num_failures;

}