iscsiadm: add netconfig support

1. Current status:
Using iscsiadm one cannot do any network configuration for qla4xxx
adapters.
However an iface is created for the qla4xxx ports using the hwaddress.

\# ls /etc/iscsi/ifaces/
iface.example  iface0  qla4xxx.00:0e:1e:04:8b:2a
qla4xxx.00:0e:1e:04:8b:2e

This allows user to issue sendtargets via the qla4xxx iscsi offload.

2. Current Proposal:
Current proposal is to allow iscsiadm to configure the network settings
for qla4xxx ports.

This implementation is based on discussions at
 - http://marc.info/?l=linux-scsi&m=127066184916180&w=2
 - http://groups.google.com/group/open-iscsi/browse_thread/thread/d8e8c2df71c95d69/8f731d95d46141a0?lnk=gst&q=iscsi+hba#

2.1 Changes in iscsiadm/iscsid

2.1.1 Add a new event: ISCSI_UEVENT_SET_IFACE_PARAMS

2.1.2 New structure/enum to represent a single network parameter
 - enum iscsi_net_param;
 - struct iscsi_iface_param_info;

2.1.3 Added new parameters in iface

2.1.4 Change in operations
Add two new operations to iscsiadm
apply: Apply the single iface settings
applyall: Apply the iface settings of all iface having the same MAC
address

2.2 Changes in sysfs network representation
The new sysfs directory would look like this:-
/sys/class/iscsi_iface/-|
 _______________________|
|
|- ipv4-iface-<host_no>-<iface_no>/                             <-- for ipv4
                                |- bootproto
                                |- enabled
                                |- ipaddress
                                |- subnet
                                |- gateway
                                |- mtu
                                |- port
                                |- vlan
                                |- vlan_enabled
                                |- vlan_priority
|- ipv6-iface-<host_no>-<iface_no>/                             <-- for ipv6

                                |- enabled
                                |- ipaddr_autocfg
                                |- ipaddress
                                |- link_local_addr
                                |- linklocal_autocfg
                                |- mtu
                                |- port
                                |- router_addr
                                |- vlan
                                |- vlan_enabled
                                |- vlan_priority

3. Flow:
3.1 User space code:
            - If user specify --op=update, then just update the iface
              config file
            - If use specify --op=applyall then ifaces for the host
	      passed in.
              and build up the net config buffer.
            - Note: If --op is "apply" then only settings for single
              iface is read,
              the iface provided with -I option is only read.
            - The net config buffer will look like this.

        ----------------------------------------------------------------|
        | iscsi_net_param {						|
        |  iface_num = 0;						|
        |  len = 4;							|
        |  param = ISCSI_NET_PARAM_IPV4_ADDR;				|
        |  iface_type = ISCSI_IFACE_TYPE_IPV4;				|
        |  param_type = ISCSI_NET_PARAM;				|
        |  value[0] = ipaddress[0];					|
        |  value[1] = ipaddress[1];					|
        |  value[2] = ipaddress[2];					|
        |  value[3] = ipaddress[3];					|
        | }								|
        ----------------------------------------------------------------|
        |  iscsi_net_param {						|
        |  iface_num = 0;						|
        |  len = 4;							|
        |  param = ISCSI_NET_PARAM_IPV4_GW;				|
        |  iface_type = ISCSI_IFACE_TYPE_IPV4;				|
        |  param_type = ISCSI_NET_PARAM;				|
        |  value[0] = ipgateway[0];					|
        |  value[1] = ipgateway[1];					|
        |  value[2] = ipgateway[2];					|
        |  value[3] = ipgateway[3];					|
        | }								|
        -----------------------------------------------------------------
        |								|
        | iscsi_net_param {						|
        |  iface_num = 1;						|
        |  len = 4;							|
        |  param = ISCSI_NET_PARAM_IPV4_ADDR;				|
        |  iface_type = ISCSI_IFACE_TYPE_IPV4;				|
        |  param_type = ISCSI_NET_PARAM;				|
        |  value[0] = ipaddress[0];					|
        |  value[1] = ipaddress[1];					|
        |  value[2] = ipaddress[2];					|
        |  value[3] = ipaddress[3];					|
        | }								|
        -----------------------------------------------------------------
        -----------------------------------------------------------------
        | iscsi_net_param {						|
        |  iface_num = 0;						|
        |  len = 4;							|
        |  param = ISCSI_NET_PARAM_IPV4_GW;				|
        |  iface_type = ISCSI_IFACE_TYPE_IPV4;				|
        |  param_type = ISCSI_NET_PARAM;				|
        |  value[0] = ipgateway[0];					|
        |  value[1] = ipgateway[1];					|
        |  value[2] = ipgateway[2];					|
        |  value[3] = ipgateway[3];					|
        | }								|
        -----------------------------------------------------------------
        | iscsi_net_param {						|
        |  iface_num = 1;						|
        |  len = 1;							|
        |  param = ISCSI_NET_PARAM_IFACE_ENABLED;			|
        |  iface_type = ISCSI_IFACE_TYPE_IPV4;				|
        |  param_type = ISCSI_NET_PARAM;				|
        |  offset = 0;							|
        |  value[0] = 0; /* 0 = disable, default = 1 = enable */	|
        | }								|
        -----------------------------------------------------------------

Each netconfig parameter has different size requirement for value field.

e.g.: IPv4 address requires 4 bytes, IPv6 address requires 16 bytes etc.

        The memory allocated for each netconfig parameter is size of
        iscsi_net_param + length required for that parameter.

        The multiple IO Vector mechanism is used to send netconfig
        parameter from user space to kernel using Netlink interface.

        IO Vector 0 is used for Netlink message header.

        IO Vector 1 is used for iSCSI User Event (ev).
        - The ev will be sent down with event type =
          ISCSI_UEVENT_SET_NET_CONFIG

        IO Vector 2 onwards, each vector consists of the struct
iscsi_net_param
        with parameter name followed by its value.

        The total size will be addition of all the IO vector sizes.

3.2 Kernel space code:
        - Once event is received, the buffer will look like struct
          iscsi_net_param
          with parameter name followed by its value, then next parameter
and
          its value and so on.
        - the scsi_transport_iscsi would call the adapter's
          transport->set_net_config        - In set_net_config each
individual param can be decoded and set into the
          hardware.
4. qla4xxx configuration:
        iscsid, creates the iface for qla4xxx, based on the hwaddress.
To display
        the iface related to qla4xxx execute following
           \# iscsiadm -m iface
               qla4xxx.00:0e:1e:04:8b:2e
qla4xxx,00:0e:1e:04:8b:2e,<empty>,<empty>,<empty>
               qla4xxx.00:0e:1e:04:8b:2e.ipv6
qla4xxx,00:0e:1e:04:8b:2e,<empty>,<empty>,<e
mpty>
               qla4xxx.00:0e:1e:04:8b:2a
qla4xxx,00:0e:1e:04:8b:2a,20.15.0.66,<empty>,<emp
ty>
               qla4xxx.00:0e:1e:04:8b:2a.ipv6
               qla4xxx,00:0e:1e:04:8b:2a,2001:DB8:1111:2222::8888,<empty>,<empty>
               qla4xxx.00:0e:1e:04:8b:2a.ipv6.1
               qla4xxx,00:0e:1e:04:8b:2a,2001:DB8:4444:5555::9999,<empty>,<empty>
To setup network configuration there can be two methods
4. 1. User can manually modify the iface file, and issue an "apply"
command.
---------------------------------------------------------------------------
 \#cat /etc/iscsi/ifaces/
  iface.example  iface0  qla4xxx.00:0e:1e:04:8b:2a
qla4xxx.00:0e:1e:04:8b:2e

            Example:
            \# cat qla4xxx.00:0e:1e:04:8b:2a
            iface.iscsi_ifacename = qla4xxx.00:0e:1e:04:8b:2a
            iface.transport_name = qla4xxx
            iface.hwaddress = 00:0e:1e:04:8b:2a
            iface.state = enable
            iface.iface_num = 0 (default)
            iface.bootproto = static
            iface.ipaddress = 192.168.2.2 (decimal)
            iface.subnetmask = 255.255.255.0 (decimal)
            \# vi qla4xxx.00:0e:1e:04:8b:2a.ipv6
               (If file does not exist, the one can create it)
            iface.iscsi_ifacename = qla4xxx.00:0e:1e:04:8b:2a.ipv6
            iface.transport_name = qla4xxx
            iface.hwaddress = 00:0e:1e:04:8b:2a
            iface.ipaddress =  1111:2222::7777:8888 (hex)
            iface.iface_num = 0

            \# iscsiadm -m iface -H 00:0e:1e:04:8b:2a --op=applyall
            This will find the ifaces on the host with MAC address
	    00:0e:1e:04:8b:2a and apply the settings to the hardware..

            Note, this will read all the iface belonging to the same MAC
	    address.

	    Note2, Instead of a MAC address the host number can be
passed in.

4.2. User can use iscsiadm to specify the values and then apply
--------------------------------------------------------------
            \# ls /etc/iscsi/ifaces/
              iface.example  iface0  qla4xxx.00:0e:1e:04:8b:2a
qla4xxx.00:0e:1e:04:8b:2e
            \# iscsiadm -m iface -I qla4xxx.00:0e:1e:04:8b:2a -o update
\
               -n iface.ipaddress -v 192.168.1.2
            \# iscsiadm -m iface -I qla4xxx.00:0e:1e:04:8b:2a -o update
\
                           -n iface.gateway -v 192.168.1.1
            \# iscsiadm -m iface -I qla4xxx.00:0e:1e:04:8b:2a -o update
\
                           -n iface.subnet_mask -v 255.255.255.0
            \# iscsiadm -m iface -H 00:0e:1e:04:8b:2a -o applyall

            Setting up multiple IP:
            First interface (default, no need to set iface_num, it is 0
by default)
            \# iscsiadm -m iface -I qla4xxx.00:0e:1e:04:8b:2a -o update
\
                           -n iface.ipaddress -v 192.168.1.2
            Create the second one if it does not exist
            \# iscsiadm -m iface -I qla4xxx.00:0e:1e:04:8b:2a.1 -op=new
            \# iscsiadm -m iface -I qla4xxx.00:0e:1e:04:8b:2a -o update
\
                           -n iface.iface_num -v 1 (Mandatory)
            \# iscsiadm -m iface -I qla4xxx.00:0e:1e:04:8b:2a -o update
\
                           -n iface.ipaddress -v 192.168.1.3
            \# iscsiadm -m iface -H 00:0e:1e:04:8b:2a --op=applyall

            Note: If there are common settings for multiple interfaces
then the
            settings from 0th iface would be considered valid.

            Note: To apply settings for a single iface, just say
--op=apply

Signed-off-by: Lalit Chandivade <lalit.chandivade@qlogic.com>
Signed-off-by: Harish Zunjarrao <harish.zunjarrao@qlogic.com>
[formatting fixes and addition of host param for applyall]
Signed-off-by: Mike Christie <michaelc@cs.wisc.edu>
Signed-off-by: Vikas Chaudhary <vikas.chaudhary@qlogic.com>

1 files changed, 80 insertions, 3 deletions

diff --git a/include/iscsi_if.h b/include/iscsi_if.h
index 50a09cb..72d4c41 100644
--- a/include/iscsi_if.h
+++ b/include/iscsi_if.h
@@ -64,8 +64,9 @@ enum iscsi_uevent_e {
 	ISCSI_UEVENT_TRANSPORT_EP_CONNECT_THROUGH_HOST	= UEVENT_BASE + 19,
 
 	ISCSI_UEVENT_PATH_UPDATE	= UEVENT_BASE + 20,
+	ISCSI_UEVENT_SET_IFACE_PARAMS	= UEVENT_BASE + 21,
 
-	ISCSI_UEVENT_MAX		= ISCSI_UEVENT_PATH_UPDATE,
+	ISCSI_UEVENT_MAX		= ISCSI_UEVENT_SET_IFACE_PARAMS,
 
 	/* up events */
 	ISCSI_KEVENT_RECV_PDU		= KEVENT_BASE + 1,
@@ -181,6 +182,10 @@ struct iscsi_uevent {
 		struct msg_set_path {
 			uint32_t	host_no;
 		} set_path;
+		struct msg_set_iface_params {
+			uint32_t	host_no;
+			uint32_t	count;
+		} set_iface_params;
 	} u;
 	union {
 		/* messages k -> u */
@@ -223,6 +228,21 @@ struct iscsi_uevent {
 	} r;
 } __attribute__ ((aligned (sizeof(uint64_t))));
 
+enum iscsi_param_type {
+	ISCSI_PARAM,		/* iscsi_param (session, conn, target, LU) */
+	ISCSI_HOST_PARAM,	/* iscsi_host_param */
+	ISCSI_NET_PARAM,	/* iscsi_net_param */
+};
+
+struct iscsi_iface_param_info {
+	uint32_t iface_num;	/* iface number, 0 - n */
+	uint32_t len;		/* Actual length of the param */
+	uint16_t param;		/* iscsi param value */
+	uint8_t iface_type;	/* IPv4 or IPv6 */
+	uint8_t param_type;	/* iscsi_param_type */
+	uint8_t value[0];	/* length sized value follows */
+} __packed;
+
 /*
  * To keep the struct iscsi_uevent size the same for userspace code
  * compatibility, the main structure for ISCSI_UEVENT_PATH_UPDATE and
@@ -246,6 +266,60 @@ struct iscsi_path {
 	uint16_t	pmtu;
 } __attribute__ ((aligned (sizeof(uint64_t))));
 
+/* iscsi iface enabled/disabled setting */
+#define ISCSI_IFACE_DISABLE	0x01
+#define ISCSI_IFACE_ENABLE	0x02
+
+/* ipv4 bootproto */
+#define ISCSI_BOOTPROTO_STATIC		0x01
+#define ISCSI_BOOTPROTO_DHCP		0x02
+
+/* ipv6 addr autoconfig type */
+#define ISCSI_IPV6_AUTOCFG_DISABLE		0x01
+#define ISCSI_IPV6_AUTOCFG_ND_ENABLE		0x02
+#define ISCSI_IPV6_AUTOCFG_DHCPV6_ENABLE	0x03
+
+/* ipv6 link local addr type */
+#define ISCSI_IPV6_LINKLOCAL_AUTOCFG_ENABLE	0x01
+#define ISCSI_IPV6_LINKLOCAL_AUTOCFG_DISABLE	0x02
+
+/* ipv6 router addr type */
+#define ISCSI_IPV6_ROUTER_AUTOCFG_ENABLE	0x01
+#define ISCSI_IPV6_ROUTER_AUTOCFG_DISABLE	0x02
+
+#define ISCSI_IFACE_TYPE_IPV4		0x01
+#define ISCSI_IFACE_TYPE_IPV6		0x02
+
+#define ISCSI_MAX_VLAN_ID		4095
+#define ISCSI_MAX_VLAN_PRIORITY		7
+
+/* iscsi vlan enable/disabled setting */
+#define ISCSI_VLAN_DISABLE	0x01
+#define ISCSI_VLAN_ENABLE	0x02
+
+/* iSCSI network params */
+enum iscsi_net_param {
+	ISCSI_NET_PARAM_IPV4_ADDR		= 1,
+	ISCSI_NET_PARAM_IPV4_SUBNET		= 2,
+	ISCSI_NET_PARAM_IPV4_GW			= 3,
+	ISCSI_NET_PARAM_IPV4_BOOTPROTO		= 4,
+	ISCSI_NET_PARAM_MAC			= 5,
+	ISCSI_NET_PARAM_IPV6_LINKLOCAL		= 6,
+	ISCSI_NET_PARAM_IPV6_ADDR		= 7,
+	ISCSI_NET_PARAM_IPV6_ROUTER		= 8,
+	ISCSI_NET_PARAM_IPV6_ADDR_AUTOCFG	= 9,
+	ISCSI_NET_PARAM_IPV6_LINKLOCAL_AUTOCFG	= 10,
+	ISCSI_NET_PARAM_IPV6_ROUTER_AUTOCFG	= 11,
+	ISCSI_NET_PARAM_IFACE_ENABLE		= 12,
+	ISCSI_NET_PARAM_VLAN_ID			= 13,
+	ISCSI_NET_PARAM_VLAN_PRIORITY		= 14,
+	ISCSI_NET_PARAM_VLAN_ENABLED		= 15,
+	ISCSI_NET_PARAM_IFACE_TYPE		= 16,
+	ISCSI_NET_PARAM_IFACE_NAME		= 17,
+	ISCSI_NET_PARAM_MTU			= 18,
+	ISCSI_NET_PARAM_PORT			= 19,
+};
+
 /*
  * Common error codes
  */
@@ -272,6 +346,7 @@ enum iscsi_err {
 	ISCSI_ERR_INVALID_HOST		= ISCSI_ERR_BASE + 18,
 	ISCSI_ERR_XMIT_FAILED		= ISCSI_ERR_BASE + 19,
 	ISCSI_ERR_TCP_CONN_CLOSE	= ISCSI_ERR_BASE + 20,
+	ISCSI_ERR_SCSI_EH_SESSION_RST	= ISCSI_ERR_BASE + 21,
 };
 
 /*
@@ -300,7 +375,7 @@ enum iscsi_param {
 	ISCSI_PARAM_PERSISTENT_PORT,
 	ISCSI_PARAM_SESS_RECOVERY_TMO,
 
-	/* pased in through bind conn using transport_fd */
+	/* passed in through bind conn using transport_fd */
 	ISCSI_PARAM_CONN_PORT,
 	ISCSI_PARAM_CONN_ADDRESS,
 
@@ -322,6 +397,7 @@ enum iscsi_param {
 	ISCSI_PARAM_INITIATOR_NAME,
 
 	ISCSI_PARAM_TGT_RESET_TMO,
+	ISCSI_PARAM_TARGET_ALIAS,
 	/* must always be last */
 	ISCSI_PARAM_MAX,
 };
@@ -362,6 +438,7 @@ enum iscsi_param {
 #define ISCSI_ISID			(1ULL << ISCSI_PARAM_ISID)
 #define ISCSI_INITIATOR_NAME		(1ULL << ISCSI_PARAM_INITIATOR_NAME)
 #define ISCSI_TGT_RESET_TMO		(1ULL << ISCSI_PARAM_TGT_RESET_TMO)
+#define ISCSI_TARGET_ALIAS		(1ULL << ISCSI_PARAM_TARGET_ALIAS)
 
 /* iSCSI HBA params */
 enum iscsi_host_param {
@@ -390,7 +467,7 @@ enum iscsi_host_param {
 #define CAP_HDRDGST		0x10
 #define CAP_DATADGST		0x20
 #define CAP_MULTI_CONN		0x40
-#define CAP_TEXT_NEGO		0x80	/* support for text requests */
+#define CAP_TEXT_NEGO		0x80
 #define CAP_MARKERS		0x100
 #define CAP_FW_DB		0x200
 #define CAP_SENDTARGETS_OFFLOAD	0x400	/* offload discovery process */