Commit 6d86242d authored by Tomasz Zawadzki's avatar Tomasz Zawadzki
Browse files

subsystem/iscsi: remove legacy config support 



This patch removes legacy config support in iscsi subsystem.
All options through the legacy config are already reflected in JSON.

Following RPCs are corresponding to removed legacy config sections:
Initiator groups - iscsi_create_initiator_group and iscsi_initiator_group_*
Subsystem options - iscsi_set_options
Portal groups - iscsi_create_portal_group
Target node - iscsi_create_target_node and iscsi_target_node_*

Signed-off-by: default avatarTomasz Zawadzki <tomasz.zawadzki@intel.com>
Change-Id: I11326a84d4d580b19db422b8522198eea5a5be0d
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/4747


Tested-by: default avatarSPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Broadcom CI
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
parent 28420560

lib/iscsi/Makefile

+1 −1
Original line number Diff line number Diff line
@@ -34,7 +34,7 @@ 
SPDK_ROOT_DIR := $(abspath $(CURDIR)/../..)

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



SO_VER := 3

SO_VER := 4

SO_MINOR := 0



CFLAGS += -I$(SPDK_ROOT_DIR)/lib

lib/iscsi/init_grp.c

+0 −188
Original line number Diff line number Diff line
@@ -325,121 +325,6 @@ cleanup: 
	return -1;

}



/* Read spdk iscsi target's config file and create initiator group */

static int

iscsi_parse_init_grp(struct spdk_conf_section *sp)

{

	int i, rc = 0;

	const char *val = NULL;

	int num_initiator_names;

	int num_initiator_masks;

	char **initiators = NULL, **netmasks = NULL;

	int tag = spdk_conf_section_get_num(sp);



	SPDK_DEBUGLOG(iscsi, "add initiator group %d\n", tag);



	val = spdk_conf_section_get_val(sp, "Comment");

	if (val != NULL) {

		SPDK_DEBUGLOG(iscsi, "Comment %s\n", val);

	}



	/* counts number of definitions */

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

		val = spdk_conf_section_get_nval(sp, "InitiatorName", i);

		if (val == NULL) {

			break;

		}

	}

	if (i == 0) {

		SPDK_ERRLOG("num_initiator_names = 0\n");

		return -EINVAL;

	}

	num_initiator_names = i;

	if (num_initiator_names > MAX_INITIATOR) {

		SPDK_ERRLOG("%d > MAX_INITIATOR\n", num_initiator_names);

		return -E2BIG;

	}

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

		val = spdk_conf_section_get_nval(sp, "Netmask", i);

		if (val == NULL) {

			break;

		}

	}

	if (i == 0) {

		SPDK_ERRLOG("num_initiator_mask = 0\n");

		return -EINVAL;

	}

	num_initiator_masks = i;

	if (num_initiator_masks > MAX_NETMASK) {

		SPDK_ERRLOG("%d > MAX_NETMASK\n", num_initiator_masks);

		return -E2BIG;

	}



	initiators = calloc(num_initiator_names, sizeof(char *));

	if (!initiators) {

		SPDK_ERRLOG("calloc() failed for temp initiator name array\n");

		return -ENOMEM;

	}

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

		val = spdk_conf_section_get_nval(sp, "InitiatorName", i);

		if (!val) {

			SPDK_ERRLOG("InitiatorName %d not found\n", i);

			rc = -EINVAL;

			goto cleanup;

		}

		SPDK_DEBUGLOG(iscsi, "InitiatorName %s\n", val);

		initiators[i] = strdup(val);

		if (!initiators[i]) {

			SPDK_ERRLOG("strdup() failed for temp initiator name\n");

			rc = -ENOMEM;

			goto cleanup;

		}

	}

	netmasks = calloc(num_initiator_masks, sizeof(char *));

	if (!netmasks) {

		SPDK_ERRLOG("malloc() failed for portal group\n");

		rc = -ENOMEM;

		goto cleanup;

	}

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

		val = spdk_conf_section_get_nval(sp, "Netmask", i);

		if (!val) {

			SPDK_ERRLOG("Netmask %d not found\n", i);

			rc = -EINVAL;

			goto cleanup;

		}

		SPDK_DEBUGLOG(iscsi, "Netmask %s\n", val);

		netmasks[i] = strdup(val);

		if (!netmasks[i]) {

			SPDK_ERRLOG("strdup() failed for temp initiator mask\n");

			rc = -ENOMEM;

			goto cleanup;

		}

	}



	rc = iscsi_init_grp_create_from_initiator_list(tag,

			num_initiator_names, initiators, num_initiator_masks, netmasks);



cleanup:

	if (initiators) {

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

			if (initiators[i]) {

				free(initiators[i]);

			}

		}

		free(initiators);

	}

	if (netmasks) {

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

			if (netmasks[i]) {

				free(netmasks[i]);

			}

		}

		free(netmasks);

	}

	return rc;

}



int

iscsi_init_grp_register(struct spdk_iscsi_init_grp *ig)

{
@@ -621,30 +506,6 @@ iscsi_init_grp_find_by_tag(int tag) 
	return NULL;

}



int

iscsi_parse_init_grps(void)

{

	struct spdk_conf_section *sp;

	int rc;



	sp = spdk_conf_first_section(NULL);

	while (sp != NULL) {

		if (spdk_conf_section_match_prefix(sp, "InitiatorGroup")) {

			if (spdk_conf_section_get_num(sp) == 0) {

				SPDK_ERRLOG("Group 0 is invalid\n");

				return -1;

			}

			rc = iscsi_parse_init_grp(sp);

			if (rc < 0) {

				SPDK_ERRLOG("parse_init_group() failed\n");

				return -1;

			}

		}

		sp = spdk_conf_next_section(sp);

	}

	return 0;

}



void

iscsi_init_grps_destroy(void)

{
@@ -676,55 +537,6 @@ iscsi_init_grp_unregister(int tag) 
	return NULL;

}



static const char *initiator_group_section = \

		"\n"

		"# Users must change the InitiatorGroup section(s) to match the IP\n"

		"#  addresses and initiator configuration in their environment.\n"

		"# Netmask can be used to specify a single IP address or a range of IP addresses\n"

		"#  Netmask 192.168.1.20   <== single IP address\n"

		"#  Netmask 192.168.1.0/24 <== IP range 192.168.1.*\n";



#define INITIATOR_GROUP_TMPL \

"[InitiatorGroup%d]\n" \

"  Comment \"Initiator Group%d\"\n"



#define INITIATOR_TMPL \

"  InitiatorName "



#define NETMASK_TMPL \

"  Netmask "



void

iscsi_init_grps_config_text(FILE *fp)

{

	struct spdk_iscsi_init_grp *ig;

	struct spdk_iscsi_initiator_name *iname;

	struct spdk_iscsi_initiator_netmask *imask;



	/* Create initiator group section */

	fprintf(fp, "%s", initiator_group_section);



	/* Dump initiator groups */

	TAILQ_FOREACH(ig, &g_iscsi.ig_head, tailq) {

		if (NULL == ig) { continue; }

		fprintf(fp, INITIATOR_GROUP_TMPL, ig->tag, ig->tag);



		/* Dump initiators */

		fprintf(fp, INITIATOR_TMPL);

		TAILQ_FOREACH(iname, &ig->initiator_head, tailq) {

			fprintf(fp, "%s ", iname->name);

		}

		fprintf(fp, "\n");



		/* Dump netmasks */

		fprintf(fp, NETMASK_TMPL);

		TAILQ_FOREACH(imask, &ig->netmask_head, tailq) {

			fprintf(fp, "%s ", imask->mask);

		}

		fprintf(fp, "\n");

	}

}



static void

iscsi_init_grp_info_json(struct spdk_iscsi_init_grp *ig,

			 struct spdk_json_write_ctx *w)

lib/iscsi/init_grp.h

+0 −2
Original line number Diff line number Diff line
@@ -35,7 +35,6 @@ 
#ifndef SPDK_INIT_GRP_H

#define SPDK_INIT_GRP_H



#include "spdk/conf.h"

#include "iscsi/iscsi.h"

#include "iscsi/conn.h"
@@ -75,7 +74,6 @@ struct spdk_iscsi_init_grp *iscsi_init_grp_find_by_tag(int tag); 
void iscsi_init_grp_destroy(struct spdk_iscsi_init_grp *ig);

int iscsi_parse_init_grps(void);

void iscsi_init_grps_destroy(void);

void iscsi_init_grps_config_text(FILE *fp);

void iscsi_init_grps_info_json(struct spdk_json_write_ctx *w);

void iscsi_init_grps_config_json(struct spdk_json_write_ctx *w);

#endif /* SPDK_INIT_GRP_H */

lib/iscsi/iscsi.h

+0 −1
Original line number Diff line number Diff line
@@ -407,7 +407,6 @@ void spdk_iscsi_init(spdk_iscsi_init_cb cb_fn, void *cb_arg); 
typedef void (*spdk_iscsi_fini_cb)(void *arg);

void spdk_iscsi_fini(spdk_iscsi_fini_cb cb_fn, void *cb_arg);

void shutdown_iscsi_conns_done(void);

void spdk_iscsi_config_text(FILE *fp);

void spdk_iscsi_config_json(struct spdk_json_write_ctx *w);



struct spdk_iscsi_opts *iscsi_opts_alloc(void);

lib/iscsi/iscsi_subsystem.c

+5 −274
Original line number Diff line number Diff line
@@ -56,73 +56,6 @@ static void *g_init_cb_arg = NULL; 
static spdk_iscsi_fini_cb g_fini_cb_fn;

static void *g_fini_cb_arg;



#define ISCSI_CONFIG_TMPL \

"[iSCSI]\n" \

"  # node name (not include optional part)\n" \

"  # Users can optionally change this to fit their environment.\n" \

"  NodeBase \"%s\"\n" \

"\n" \

"  # files\n" \

"  %s %s\n" \

"\n" \

"  # socket I/O timeout sec. (polling is infinity)\n" \

"  Timeout %d\n" \

"\n" \

"  # authentication information for discovery session\n" \

"  DiscoveryAuthMethod %s\n" \

"  DiscoveryAuthGroup %s\n" \

"\n" \

"  MaxSessions %d\n" \

"  MaxConnectionsPerSession %d\n" \

"  MaxConnections %d\n" \

"  MaxQueueDepth %d\n" \

"\n" \

"  # iSCSI initial parameters negotiate with initiators\n" \

"  # NOTE: incorrect values might crash\n" \

"  DefaultTime2Wait %d\n" \

"  DefaultTime2Retain %d\n" \

"\n" \

"  FirstBurstLength %d\n" \

"  ImmediateData %s\n" \

"  ErrorRecoveryLevel %d\n" \

"\n"



static void

iscsi_globals_config_text(FILE *fp)

{

	const char *authmethod = "None";

	char authgroup[32] = "None";



	if (NULL == fp) {

		return;

	}



	if (g_iscsi.require_chap) {

		authmethod = "CHAP";

	} else if (g_iscsi.mutual_chap) {

		authmethod = "CHAP Mutual";

	} else if (!g_iscsi.disable_chap) {

		authmethod = "Auto";

	}



	if (g_iscsi.chap_group) {

		snprintf(authgroup, sizeof(authgroup), "AuthGroup%d", g_iscsi.chap_group);

	}



	fprintf(fp, ISCSI_CONFIG_TMPL,

		g_iscsi.nodebase,

		g_iscsi.authfile ? "AuthFile" : "",

		g_iscsi.authfile ? g_iscsi.authfile : "",

		g_iscsi.timeout, authmethod, authgroup,

		g_iscsi.MaxSessions, g_iscsi.MaxConnectionsPerSession,

		g_iscsi.MaxConnections,

		g_iscsi.MaxQueueDepth,

		g_iscsi.DefaultTime2Wait, g_iscsi.DefaultTime2Retain,

		g_iscsi.FirstBurstLength,

		(g_iscsi.ImmediateData) ? "Yes" : "No",

		g_iscsi.ErrorRecoveryLevel);

}



#define ISCSI_DATA_BUFFER_ALIGNMENT	(0x1000)

#define ISCSI_DATA_BUFFER_MASK		(ISCSI_DATA_BUFFER_ALIGNMENT - 1)
@@ -485,151 +418,6 @@ iscsi_opts_copy(struct spdk_iscsi_opts *src) 
	return dst;

}



static int

iscsi_read_config_file_params(struct spdk_conf_section *sp,

			      struct spdk_iscsi_opts *opts)

{

	const char *val;

	int MaxSessions;

	int MaxConnectionsPerSession;

	int MaxQueueDepth;

	int DefaultTime2Wait;

	int DefaultTime2Retain;

	int FirstBurstLength;

	int ErrorRecoveryLevel;

	int timeout;

	int nopininterval;

	const char *ag_tag;

	int ag_tag_i;

	int i;



	val = spdk_conf_section_get_val(sp, "Comment");

	if (val != NULL) {

		SPDK_DEBUGLOG(iscsi, "Comment %s\n", val);

	}



	val = spdk_conf_section_get_val(sp, "AuthFile");

	if (val != NULL) {

		opts->authfile = strdup(val);

		if (!opts->authfile) {

			SPDK_ERRLOG("strdup() failed for AuthFile\n");

			return -ENOMEM;

		}

	}



	val = spdk_conf_section_get_val(sp, "NodeBase");

	if (val != NULL) {

		opts->nodebase = strdup(val);

		if (!opts->nodebase) {

			free(opts->authfile);

			SPDK_ERRLOG("strdup() failed for NodeBase\n");

			return -ENOMEM;

		}

	}



	MaxSessions = spdk_conf_section_get_intval(sp, "MaxSessions");

	if (MaxSessions >= 0) {

		opts->MaxSessions = MaxSessions;

	}



	MaxConnectionsPerSession = spdk_conf_section_get_intval(sp, "MaxConnectionsPerSession");

	if (MaxConnectionsPerSession >= 0) {

		opts->MaxConnectionsPerSession = MaxConnectionsPerSession;

	}



	MaxQueueDepth = spdk_conf_section_get_intval(sp, "MaxQueueDepth");

	if (MaxQueueDepth >= 0) {

		opts->MaxQueueDepth = MaxQueueDepth;

	}



	DefaultTime2Wait = spdk_conf_section_get_intval(sp, "DefaultTime2Wait");

	if (DefaultTime2Wait >= 0) {

		opts->DefaultTime2Wait = DefaultTime2Wait;

	}



	DefaultTime2Retain = spdk_conf_section_get_intval(sp, "DefaultTime2Retain");

	if (DefaultTime2Retain >= 0) {

		opts->DefaultTime2Retain = DefaultTime2Retain;

	}



	FirstBurstLength = spdk_conf_section_get_intval(sp, "FirstBurstLength");

	if (FirstBurstLength >= 0) {

		opts->FirstBurstLength = FirstBurstLength;

	}



	opts->ImmediateData = spdk_conf_section_get_boolval(sp, "ImmediateData",

			      opts->ImmediateData);



	/* This option is only for test.

	 * If AllowDuplicateIsid is enabled, it allows different connections carrying

	 * TSIH=0 login the target within the same session.

	 */

	opts->AllowDuplicateIsid = spdk_conf_section_get_boolval(sp, "AllowDuplicateIsid",

				   opts->AllowDuplicateIsid);



	ErrorRecoveryLevel = spdk_conf_section_get_intval(sp, "ErrorRecoveryLevel");

	if (ErrorRecoveryLevel >= 0) {

		opts->ErrorRecoveryLevel = ErrorRecoveryLevel;

	}

	timeout = spdk_conf_section_get_intval(sp, "Timeout");

	if (timeout >= 0) {

		opts->timeout = timeout;

	}

	nopininterval = spdk_conf_section_get_intval(sp, "NopInInterval");

	if (nopininterval >= 0) {

		opts->nopininterval = nopininterval;

	}

	val = spdk_conf_section_get_val(sp, "DiscoveryAuthMethod");

	if (val != NULL) {

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

			val = spdk_conf_section_get_nmval(sp, "DiscoveryAuthMethod", 0, i);

			if (val == NULL) {

				break;

			}

			if (strcasecmp(val, "CHAP") == 0) {

				opts->require_chap = true;

			} else if (strcasecmp(val, "Mutual") == 0) {

				opts->require_chap = true;

				opts->mutual_chap = true;

			} else if (strcasecmp(val, "Auto") == 0) {

				opts->disable_chap = false;

				opts->require_chap = false;

				opts->mutual_chap = false;

			} else if (strcasecmp(val, "None") == 0) {

				opts->disable_chap = true;

				opts->require_chap = false;

				opts->mutual_chap = false;

			} else {

				SPDK_ERRLOG("unknown CHAP mode %s\n", val);

			}

		}

		if (opts->mutual_chap && !opts->require_chap) {

			free(opts->authfile);

			free(opts->nodebase);

			SPDK_ERRLOG("CHAP must set to be required when using mutual CHAP.\n");

			return -EINVAL;

		}

	}

	val = spdk_conf_section_get_val(sp, "DiscoveryAuthGroup");

	if (val != NULL) {

		ag_tag = val;

		if (strcasecmp(ag_tag, "None") == 0) {

			opts->chap_group = 0;

		} else {

			if (strncasecmp(ag_tag, "AuthGroup",

					strlen("AuthGroup")) != 0

			    || sscanf(ag_tag, "%*[^0-9]%d", &ag_tag_i) != 1

			    || ag_tag_i == 0) {

				SPDK_ERRLOG("invalid auth group %s, ignoring\n", ag_tag);

			} else {

				opts->chap_group = ag_tag_i;

			}

		}

	}



	return 0;

}



static int

iscsi_opts_verify(struct spdk_iscsi_opts *opts)

{
@@ -718,36 +506,6 @@ iscsi_opts_verify(struct spdk_iscsi_opts *opts) 
	return 0;

}



static int

iscsi_parse_options(struct spdk_iscsi_opts **popts)

{

	struct spdk_iscsi_opts *opts;

	struct spdk_conf_section *sp;

	int rc;



	opts = iscsi_opts_alloc();

	if (!opts) {

		SPDK_ERRLOG("iscsi_opts_alloc_failed() failed\n");

		return -ENOMEM;

	}



	/* Process parameters */

	SPDK_DEBUGLOG(iscsi, "iscsi_read_config_file_parmas\n");

	sp = spdk_conf_find_section(NULL, "iSCSI");

	if (sp != NULL) {

		rc = iscsi_read_config_file_params(sp, opts);

		if (rc != 0) {

			free(opts);

			SPDK_ERRLOG("iscsi_read_config_file_params() failed\n");

			return rc;

		}

	}



	*popts = opts;



	return 0;

}



static int

iscsi_set_global_params(struct spdk_iscsi_opts *opts)

{
@@ -1136,10 +894,10 @@ iscsi_initialize_global_params(void) 
	int rc;



	if (!g_spdk_iscsi_opts) {

		rc = iscsi_parse_options(&g_spdk_iscsi_opts);

		if (rc != 0) {

			SPDK_ERRLOG("iscsi_parse_options() failed\n");

			return rc;

		g_spdk_iscsi_opts = iscsi_opts_alloc();

		if (!g_spdk_iscsi_opts) {

			SPDK_ERRLOG("iscsi_opts_alloc_failed() failed\n");

			return -ENOMEM;

		}

	}
@@ -1169,24 +927,7 @@ iscsi_init_complete(int rc) 
static void

iscsi_parse_configuration(void)

{

	int rc;



	rc = iscsi_parse_portal_grps();

	if (rc < 0) {

		SPDK_ERRLOG("iscsi_parse_portal_grps() failed\n");

		goto end;

	}



	rc = iscsi_parse_init_grps();

	if (rc < 0) {

		SPDK_ERRLOG("iscsi_parse_init_grps() failed\n");

		goto end;

	}



	rc = iscsi_parse_tgt_nodes();

	if (rc < 0) {

		SPDK_ERRLOG("iscsi_parse_tgt_nodes() failed\n");

	}

	int rc = 0;



	if (g_iscsi.authfile != NULL) {

		if (access(g_iscsi.authfile, R_OK) == 0) {
@@ -1200,7 +941,6 @@ iscsi_parse_configuration(void) 
		}

	}



end:

	iscsi_init_complete(rc);

}
@@ -1462,15 +1202,6 @@ shutdown_iscsi_conns_done(void) 
	spdk_for_each_channel(&g_iscsi, _iscsi_fini_thread, NULL, _iscsi_fini_dev_unreg);

}



void

spdk_iscsi_config_text(FILE *fp)

{

	iscsi_globals_config_text(fp);

	iscsi_portal_grps_config_text(fp);

	iscsi_init_grps_config_text(fp);

	iscsi_tgt_nodes_config_text(fp);

}



void

iscsi_opts_info_json(struct spdk_json_write_ctx *w)

{