Commit 57e13a2e authored by Ming Lei's avatar Ming Lei Committed by Jens Axboe
Browse files

selftests: ublk: support user recovery 



Add user recovery feature.

Meantime add user recovery test: generic_04 and generic_05(zero copy)

Signed-off-by: default avatarMing Lei <ming.lei@redhat.com>
Link: https://lore.kernel.org/r/20250412023035.2649275-12-ming.lei@redhat.com


Signed-off-by: default avatarJens Axboe <axboe@kernel.dk>
parent 810b88f3

tools/testing/selftests/ublk/Makefile

+2 −0
Original line number Diff line number Diff line
@@ -6,6 +6,8 @@ LDLIBS += -lpthread -lm -luring 
TEST_PROGS := test_generic_01.sh

TEST_PROGS += test_generic_02.sh

TEST_PROGS += test_generic_03.sh

TEST_PROGS += test_generic_04.sh

TEST_PROGS += test_generic_05.sh



TEST_PROGS += test_null_01.sh

TEST_PROGS += test_null_02.sh

tools/testing/selftests/ublk/kublk.c

+88 −8
Original line number Diff line number Diff line
@@ -119,6 +119,27 @@ static int ublk_ctrl_start_dev(struct ublk_dev *dev, 
	return __ublk_ctrl_cmd(dev, &data);

}



static int ublk_ctrl_start_user_recovery(struct ublk_dev *dev)

{

	struct ublk_ctrl_cmd_data data = {

		.cmd_op	= UBLK_U_CMD_START_USER_RECOVERY,

	};



	return __ublk_ctrl_cmd(dev, &data);

}



static int ublk_ctrl_end_user_recovery(struct ublk_dev *dev, int daemon_pid)

{

	struct ublk_ctrl_cmd_data data = {

		.cmd_op	= UBLK_U_CMD_END_USER_RECOVERY,

		.flags	= CTRL_CMD_HAS_DATA,

	};



	dev->dev_info.ublksrv_pid = data.data[0] = daemon_pid;



	return __ublk_ctrl_cmd(dev, &data);

}



static int ublk_ctrl_add_dev(struct ublk_dev *dev)

{

	struct ublk_ctrl_cmd_data data = {
@@ -812,8 +833,12 @@ static int ublk_start_daemon(const struct dev_ctx *ctx, struct ublk_dev *dev) 
	free(affinity_buf);



	/* everything is fine now, start us */

	if (ctx->recovery)

		ret = ublk_ctrl_end_user_recovery(dev, getpid());

	else {

		ublk_set_parameters(dev);

		ret = ublk_ctrl_start_dev(dev, getpid());

	}

	if (ret < 0) {

		ublk_err("%s: ublk_ctrl_start_dev failed: %d\n", __func__, ret);

		goto fail;
@@ -988,6 +1013,9 @@ static int __cmd_dev_add(const struct dev_ctx *ctx) 
		}

	}



	if (ctx->recovery)

		ret = ublk_ctrl_start_user_recovery(dev);

	else

		ret = ublk_ctrl_add_dev(dev);

	if (ret < 0) {

		ublk_err("%s: can't add dev id %d, type %s ret %d\n",
@@ -1202,12 +1230,14 @@ static int cmd_dev_get_features(void) 
	return ret;

}



static int cmd_dev_help(char *exe)

static void __cmd_create_help(char *exe, bool recovery)

{

	int i;



	printf("%s add -t [null|loop|stripe] [-q nr_queues] [-d depth] [-n dev_id]\n", exe);

	printf("\t[--foreground] [--quiet] [-z] [--debug_mask mask]\n");

	printf("%s %s -t [null|loop|stripe] [-q nr_queues] [-d depth] [-n dev_id]\n",

			exe, recovery ? "recover" : "add");

	printf("\t[--foreground] [--quiet] [-z] [--debug_mask mask] [-r 0|1 ] [-g 0|1]\n");

	printf("\t[-e 0|1 ] [-i 0|1]\n");

	printf("\t[target options] [backfile1] [backfile2] ...\n");

	printf("\tdefault: nr_queues=2(max 32), depth=128(max 1024), dev_id=-1(auto allocation)\n");
@@ -1217,7 +1247,25 @@ static int cmd_dev_help(char *exe) 
		if (ops->usage)

			ops->usage(ops);

	}

}



static void cmd_add_help(char *exe)

{

	__cmd_create_help(exe, false);

	printf("\n");

}



static void cmd_recover_help(char *exe)

{

	__cmd_create_help(exe, true);

	printf("\tPlease provide exact command line for creating this device with real dev_id\n");

	printf("\n");

}



static int cmd_dev_help(char *exe)

{

	cmd_add_help(exe);

	cmd_recover_help(exe);



	printf("%s del [-n dev_id] -a \n", exe);

	printf("\t -a delete all devices -n delete specified device\n\n");
@@ -1239,6 +1287,10 @@ int main(int argc, char *argv[]) 
		{ "quiet",		0,	NULL,  0  },

		{ "zero_copy",          0,      NULL, 'z' },

		{ "foreground",		0,	NULL,  0  },

		{ "recovery", 		1,      NULL, 'r' },

		{ "recovery_fail_io",	1,	NULL, 'e'},

		{ "recovery_reissue",	1,	NULL, 'i'},

		{ "get_data",		1,	NULL, 'g'},

		{ 0, 0, 0, 0 }

	};

	const struct ublk_tgt_ops *ops = NULL;
@@ -1253,13 +1305,14 @@ int main(int argc, char *argv[]) 
	int ret = -EINVAL, i;

	int tgt_argc = 1;

	char *tgt_argv[MAX_NR_TGT_ARG] = { NULL };

	int value;



	if (argc == 1)

		return ret;



	opterr = 0;

	optind = 2;

	while ((opt = getopt_long(argc, argv, "t:n:d:q:az",

	while ((opt = getopt_long(argc, argv, "t:n:d:q:r:e:i:az",

				  longopts, &option_idx)) != -1) {

		switch (opt) {

		case 'a':
@@ -1281,6 +1334,25 @@ int main(int argc, char *argv[]) 
		case 'z':

			ctx.flags |= UBLK_F_SUPPORT_ZERO_COPY | UBLK_F_USER_COPY;

			break;

		case 'r':

			value = strtol(optarg, NULL, 10);

			if (value)

				ctx.flags |= UBLK_F_USER_RECOVERY;

			break;

		case 'e':

			value = strtol(optarg, NULL, 10);

			if (value)

				ctx.flags |= UBLK_F_USER_RECOVERY | UBLK_F_USER_RECOVERY_FAIL_IO;

			break;

		case 'i':

			value = strtol(optarg, NULL, 10);

			if (value)

				ctx.flags |= UBLK_F_USER_RECOVERY | UBLK_F_USER_RECOVERY_REISSUE;

			break;

		case 'g':

			value = strtol(optarg, NULL, 10);

			if (value)

				ctx.flags |= UBLK_F_NEED_GET_DATA;

		case 0:

			if (!strcmp(longopts[option_idx].name, "debug_mask"))

				ublk_dbg_mask = strtol(optarg, NULL, 16);
@@ -1326,7 +1398,15 @@ int main(int argc, char *argv[]) 


	if (!strcmp(cmd, "add"))

		ret = cmd_dev_add(&ctx);

	else if (!strcmp(cmd, "del"))

	else if (!strcmp(cmd, "recover")) {

		if (ctx.dev_id < 0) {

			fprintf(stderr, "device id isn't provided for recovering\n");

			ret = -EINVAL;

		} else {

			ctx.recovery = 1;

			ret = cmd_dev_add(&ctx);

		}

	} else if (!strcmp(cmd, "del"))

		ret = cmd_dev_del(&ctx);

	else if (!strcmp(cmd, "list")) {

		ctx.all = 1;

tools/testing/selftests/ublk/kublk.h

+1 −0
Original line number Diff line number Diff line
@@ -79,6 +79,7 @@ struct dev_ctx { 
	unsigned int	logging:1;

	unsigned int	all:1;

	unsigned int	fg:1;

	unsigned int	recovery:1;



	int _evtfd;

	int _shmid;

tools/testing/selftests/ublk/test_common.sh

+55 −2
Original line number Diff line number Diff line
@@ -169,8 +169,11 @@ _have_feature() 
	return 1

}



_add_ublk_dev() {

_create_ublk_dev() {

	local dev_id;

	local cmd=$1



	shift 1



	if [ ! -c /dev/ublk-control ]; then

		return ${UBLK_SKIP_CODE}
@@ -181,7 +184,7 @@ _add_ublk_dev() { 
		fi

	fi



	if ! dev_id=$("${UBLK_PROG}" add "$@" | grep "dev id" | awk -F '[ :]' '{print $3}'); then

	if ! dev_id=$("${UBLK_PROG}" "$cmd" "$@" | grep "dev id" | awk -F '[ :]' '{print $3}'); then

		echo "fail to add ublk dev $*"

		return 255

	fi
@@ -194,6 +197,23 @@ _add_ublk_dev() { 
	fi

}



_add_ublk_dev() {

	_create_ublk_dev "add" "$@"

}



_recover_ublk_dev() {

	local dev_id

	local state



	dev_id=$(_create_ublk_dev "recover" "$@")

	for ((j=0;j<20;j++)); do

		state=$(_get_ublk_dev_state "${dev_id}")

		[ "$state" == "LIVE" ] && break

		sleep 1

	done

	echo "$state"

}



# kill the ublk daemon and return ublk device state

__ublk_kill_daemon()

{
@@ -280,6 +300,39 @@ run_io_and_kill_daemon() 
	fi

}



run_io_and_recover()

{

	local state

	local dev_id



	dev_id=$(_add_ublk_dev "$@")

	_check_add_dev "$TID" $?



	fio --name=job1 --filename=/dev/ublkb"${dev_id}" --ioengine=libaio \

		--rw=readwrite --iodepth=256 --size="${size}" --numjobs=4 \

		--runtime=20 --time_based > /dev/null 2>&1 &

	sleep 4



	state=$(__ublk_kill_daemon "${dev_id}" "QUIESCED")

	if [ "$state" != "QUIESCED" ]; then

		echo "device isn't quiesced($state) after killing daemon"

		return 255

	fi



	state=$(_recover_ublk_dev -n "$dev_id" "$@")

	if [ "$state" != "LIVE" ]; then

		echo "faile to recover to LIVE($state)"

		return 255

	fi



	if ! __remove_ublk_dev_return "${dev_id}"; then

		echo "delete dev ${dev_id} failed"

		return 255

	fi

	wait

}





_ublk_test_top_dir()

{

	cd "$(dirname "$0")" && pwd

tools/testing/selftests/ublk/test_generic_04.sh

0 → 100755
+40 −0
Original line number Diff line number Diff line 
#!/bin/bash

# SPDX-License-Identifier: GPL-2.0



. "$(cd "$(dirname "$0")" && pwd)"/test_common.sh



TID="generic_04"

ERR_CODE=0



ublk_run_recover_test()

{

	run_io_and_recover "$@"

	ERR_CODE=$?

	if [ ${ERR_CODE} -ne 0 ]; then

		echo "$TID failure: $*"

		_show_result $TID $ERR_CODE

	fi

}



if ! _have_program fio; then

	exit "$UBLK_SKIP_CODE"

fi



_prep_test "recover" "basic recover function verification"



_create_backfile 0 256M

_create_backfile 1 128M

_create_backfile 2 128M



ublk_run_recover_test -t null -q 2 -r 1 &

ublk_run_recover_test -t loop -q 2 -r 1 "${UBLK_BACKFILES[0]}" &

ublk_run_recover_test -t stripe -q 2 -r 1 "${UBLK_BACKFILES[1]}" "${UBLK_BACKFILES[2]}" &

wait



ublk_run_recover_test -t null -q 2 -r 1 -i 1 &

ublk_run_recover_test -t loop -q 2 -r 1 -i 1 "${UBLK_BACKFILES[0]}" &

ublk_run_recover_test -t stripe -q 2 -r 1 -i 1 "${UBLK_BACKFILES[1]}" "${UBLK_BACKFILES[2]}" &

wait



_cleanup_test "recover"

_show_result $TID $ERR_CODE