Commit 1e92d78a authored by Ben Walker's avatar Ben Walker
Browse files

iscsi: Add an iscsi target application 



Similar to our NVMf target, this is an iSCSI target that
can interoperate with the Linux and Windows standard iSCSI
initiators.

Change-Id: I6961c5ef99f7b161c396330ed5b543ea29b0ca7b
Signed-off-by: default avatarBen Walker <benjamin.walker@intel.com>
parent b91c6e0e

app/Makefile

+3 −0
Original line number Diff line number Diff line
@@ -36,6 +36,9 @@ include $(SPDK_ROOT_DIR)/mk/spdk.common.mk 


DIRS-y += trace

DIRS-$(CONFIG_RDMA) += nvmf_tgt

ifeq ($(OS),Linux)

DIRS-y += iscsi_tgt

endif



.PHONY: all clean $(DIRS-y)

app/iscsi_tgt/.gitignore

0 → 100644
+1 −0
Original line number Diff line number Diff line 
iscsi_tgt

app/iscsi_tgt/Makefile

0 → 100644
+79 −0
Original line number Diff line number Diff line 
#

#  BSD LICENSE

#

#  Copyright (c) Intel Corporation.

#  All rights reserved.

#

#  Redistribution and use in source and binary forms, with or without

#  modification, are permitted provided that the following conditions

#  are met:

#

#    * Redistributions of source code must retain the above copyright

#      notice, this list of conditions and the following disclaimer.

#    * Redistributions in binary form must reproduce the above copyright

#      notice, this list of conditions and the following disclaimer in

#      the documentation and/or other materials provided with the

#      distribution.

#    * Neither the name of Intel Corporation nor the names of its

#      contributors may be used to endorse or promote products derived

#      from this software without specific prior written permission.

#

#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

#  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

#  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

#  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

#  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

#  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

#  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

#  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

#  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

#  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

#  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#



SPDK_ROOT_DIR := $(abspath $(CURDIR)/../..)

include $(SPDK_ROOT_DIR)/mk/spdk.common.mk

include $(SPDK_ROOT_DIR)/mk/spdk.modules.mk



APP = iscsi_tgt



CFLAGS += $(DPDK_INC)



# Add iSCSI library directory to include path

# TODO: remove this once iSCSI has a public API header

CFLAGS += -I$(SPDK_ROOT_DIR)/lib



C_SRCS := iscsi_tgt.c



SPDK_LIBS = \

	$(SPDK_ROOT_DIR)/lib/json/libspdk_json.a \

	$(SPDK_ROOT_DIR)/lib/jsonrpc/libspdk_jsonrpc.a \

	$(SPDK_ROOT_DIR)/lib/rpc/libspdk_rpc.a \

	$(SPDK_ROOT_DIR)/lib/bdev/libspdk_bdev.a \

	$(SPDK_ROOT_DIR)/lib/iscsi/libspdk_iscsi.a \

	$(SPDK_ROOT_DIR)/lib/scsi/libspdk_scsi.a \

	$(SPDK_ROOT_DIR)/lib/net/libspdk_net.a \

	$(SPDK_ROOT_DIR)/lib/copy/libspdk_copy.a \

	$(SPDK_ROOT_DIR)/lib/trace/libspdk_trace.a \

	$(SPDK_ROOT_DIR)/lib/conf/libspdk_conf.a \

	$(SPDK_ROOT_DIR)/lib/util/libspdk_util.a \

	$(SPDK_ROOT_DIR)/lib/memory/libspdk_memory.a \

	$(SPDK_ROOT_DIR)/lib/log/libspdk_log.a \

	$(SPDK_ROOT_DIR)/lib/log/rpc/libspdk_log_rpc.a \

	$(SPDK_ROOT_DIR)/lib/event/libspdk_event.a \

	$(SPDK_ROOT_DIR)/lib/event/rpc/libspdk_app_rpc.a \



LIBS += -Wl,--whole-archive $(SPDK_LIBS) -Wl,--no-whole-archive

LIBS += -lcrypto $(PCIACCESS_LIB) $(DPDK_LIB)

LIBS += $(BLOCKDEV_MODULES_LINKER_ARGS) \

	$(COPY_MODULES_LINKER_ARGS)



all : $(APP)



$(APP) : $(OBJS) $(SPDK_LIBS)

	$(LINK_C)



clean :

	$(CLEAN_C) $(APP)



include $(SPDK_ROOT_DIR)/mk/spdk.deps.mk

app/iscsi_tgt/iscsi_tgt.c

0 → 100644
+243 −0
Original line number Diff line number Diff line 
/*-

 *   BSD LICENSE

 *

 *   Copyright (c) Intel Corporation.

 *   All rights reserved.

 *

 *   Redistribution and use in source and binary forms, with or without

 *   modification, are permitted provided that the following conditions

 *   are met:

 *

 *     * Redistributions of source code must retain the above copyright

 *       notice, this list of conditions and the following disclaimer.

 *     * Redistributions in binary form must reproduce the above copyright

 *       notice, this list of conditions and the following disclaimer in

 *       the documentation and/or other materials provided with the

 *       distribution.

 *     * Neither the name of Intel Corporation nor the names of its

 *       contributors may be used to endorse or promote products derived

 *       from this software without specific prior written permission.

 *

 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 */



#include <inttypes.h>

#include <stdint.h>

#include <signal.h>



#include <sys/types.h>



#include <rte_config.h>

#include <rte_memzone.h>

#include <rte_eal.h>

#include <rte_lcore.h>

#include <rte_malloc.h>

#include <rte_memory.h>



#include "spdk/event.h"

#include "spdk/net.h"

#include "iscsi/iscsi.h"

#include "spdk/scsi.h"

#include "spdk/log.h"

#include "spdk/bdev.h"

#include "spdk/copy_engine.h"



uint64_t g_flush_timeout;



static void

spdk_iscsi_dump_memory_info(void)

{

	struct rte_malloc_socket_stats stats;

	int i;



	for (i = 0; i < RTE_MAX_NUMA_NODES; i++) {

		rte_malloc_get_socket_stats(i, &stats);

		if (stats.heap_totalsz_bytes > 0)

			fprintf(stderr, "Socket %d: Total memory %"PRIu64" MB,"

				" Free memory %"PRIu64" MB\n",

				i, stats.heap_totalsz_bytes >> 20,

				stats.heap_freesz_bytes >> 20);

	}

}



static void

spdk_sigusr1(int signo __attribute__((__unused__)))

{

	char *config_str = NULL;

	if (spdk_app_get_running_config(&config_str, "iscsi.conf") < 0)

		fprintf(stderr, "Error getting config\n");

	else {

		fprintf(stdout, "============================\n");

		fprintf(stdout, " iSCSI target running config\n");

		fprintf(stdout, "=============================\n");

		fprintf(stdout, "%s", config_str);

	}

	free(config_str);

}



static void

usage(char *executable_name)

{

	printf("%s [options]\n", executable_name);

	printf("options:\n");

	printf(" -c config  config file (default %s)\n", SPDK_ISCSI_DEFAULT_CONFIG);

	printf(" -e mask    tracepoint group mask for spdk trace buffers (default 0x0)\n");

	printf(" -m mask    core mask for DPDK\n");

	printf(" -i instance ID\n");

	printf(" -l facility use specific syslog facility (default %s)\n",

	       SPDK_APP_DEFAULT_LOG_FACILITY);

	printf(" -n channel number of memory channels used for DPDK\n");

	printf(" -p core    master (primary) core for DPDK\n");

	printf(" -s size    memory size in MB for DPDK\n");

#ifdef DEBUG

	printf(" -t flag    trace flag (all, net, iscsi, scsi, target, debug)\n");

#else

	printf(" -t flag    trace flag (not supported - must rebuild with CONFIG_DEBUG=y)\n");

#endif

	printf(" -v         verbose (enable warnings)\n");

	printf(" -H         show this usage\n");

	printf(" -V         show version\n");

	printf(" -d         disable coredump file enabling\n");

}



/*! \file



This is the main file.



*/



/*!



\brief This is the main function for the iSCSI server application.



\msc



	c_runtime [label="C Runtime"],libuns,dpdk [label="DPDK"], iSCSI [label="iSCSI Server"];

	c_runtime=>libuns [label="__msa_init()"];

	libuns=>dpdk [label="rte_eal_init()"];

	libuns<<dpdk;

	c_runtime<<libuns;

	c_runtime=>iSCSI [label="main()"];

	iSCSI=>iSCSI [label="spdk_dpdk_framework_init()"];

	iSCSI=>iSCSI [label="spdk_app_init()"];

	iSCSI=>iSCSI [label="spdk_event_allocate()"];

	iSCSI=>iSCSI [label="spdk_app_start()"];

	iSCSI=>iSCSI [label="spdk_app_fini()"];

	c_runtime<<iSCSI;



\endmsc



*/



static void

spdk_startup(spdk_event_t event)

{

	if (getenv("MEMZONE_DUMP") != NULL) {

		rte_memzone_dump(stdout);

		fflush(stdout);

	}



	/* Dump socket memory information */

	spdk_iscsi_dump_memory_info();

}



int

main(int argc, char **argv)

{

	int ch;

	int rc;

	struct spdk_app_opts opts = {};



	/* default value in opts structure */

	spdk_app_opts_init(&opts);



	opts.config_file = SPDK_ISCSI_DEFAULT_CONFIG;

	opts.name = "iscsi";



	while ((ch = getopt(argc, argv, "c:de:i:l:m:n:p:qs:t:H")) != -1) {

		switch (ch) {

		case 'd':

			opts.enable_coredump = false;

			break;

		case 'c':

			opts.config_file = optarg;

			break;

		case 'i':

			opts.instance_id = atoi(optarg);

			break;

		case 'l':

			opts.log_facility = optarg;

			break;

		case 't':

			rc = spdk_log_set_trace_flag(optarg);

			if (rc < 0) {

				fprintf(stderr, "unknown flag\n");

				usage(argv[0]);

				exit(EXIT_FAILURE);

			}

#ifndef DEBUG

			fprintf(stderr, "%s must be built with CONFIG_DEBUG=y for -t flag\n",

				argv[0]);

			usage(argv[0]);

			exit(EXIT_FAILURE);

#endif

			break;

		case 'e':

			opts.tpoint_group_mask = optarg;

			break;

		case 'q':

			spdk_g_notice_stderr_flag = 0;

			break;

		case 'm':

			opts.reactor_mask = optarg;

			break;

		case 'n':

			opts.dpdk_mem_channel = atoi(optarg);

			break;

		case 'p':

			opts.dpdk_master_core = atoi(optarg);

			break;

		case 's':

			opts.dpdk_mem_size = atoi(optarg);

			break;

		case 'H':

		default:

			usage(argv[0]);

			exit(EXIT_SUCCESS);

		}

	}



	if (spdk_g_notice_stderr_flag == 1 &&

	    isatty(STDERR_FILENO) &&

	    !strncmp(ttyname(STDERR_FILENO), "/dev/tty", strlen("/dev/tty"))) {

		printf("Warning: printing stderr to console terminal without -q option specified.\n");

		printf("Suggest using -q to disable logging to stderr and monitor syslog, or\n");

		printf("redirect stderr to a file.\n");

		printf("(Delaying for 10 seconds...)\n");

		sleep(10);

	}



	optind = 1; /* reset the optind */



	opts.shutdown_cb = spdk_iscsi_shutdown;

	opts.usr1_handler = spdk_sigusr1;

	spdk_app_init(&opts);



	printf("Total cores available: %d\n", rte_lcore_count());

	/* Blocks until the application is exiting */

	rc = spdk_app_start(spdk_startup, NULL, NULL);



	spdk_app_fini();



	return rc;

}

autotest.sh

+15 −0
Original line number Diff line number Diff line
@@ -67,6 +67,21 @@ time test/lib/scsi/scsi.sh 


timing_exit lib





if [ $(uname -s) = Linux ]; then

	export TARGET_IP=127.0.0.1

	export INITIATOR_IP=127.0.0.1



	timing_enter iscsi_tgt



	time ./test/iscsi_tgt/filesystem/filesystem.sh

	time ./test/iscsi_tgt/fio/fio.sh

	time ./test/iscsi_tgt/reset/reset.sh

	time ./test/iscsi_tgt/rpc_config/rpc_config.sh



	timing_exit iscsi_tgt

fi



timing_enter nvmf



time test/nvmf/fio/fio.sh