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, 41 insertions, 7 deletions

diff --git a/README b/README
index ee69002..9f24659 100644
--- a/README
+++ b/README
@@ -371,9 +371,10 @@ Usage: iscsiadm [OPTION]
 			  iscsi_ifacename.
 
 			  See below for examples.
-  -m host --host=hostno --print=level
-			  Display information for a specific host if hostno
-			  is passed in. If no hostno is passed in then info
+  -m host --host=hostno|MAC --print=level
+			  Display information for a specific host. The host
+			  can be passed in by host number or by MAC address.
+			  If a host is not passed in then info
 			  for all hosts is printed.
 
 			  Print level can be 0 to 4.
@@ -515,10 +516,10 @@ some helpful management commands.
 5.1.2 Setting up a iface for a iSCSI offload card
 =================================================
 
-This section describes how to setup ifaces for use with Chelsio
-and Broadcom cards.
+This section describes how to setup ifaces for use with Chelsio, Broadcom and
+QLogic cards.
 
-By default, iscsiadm will create a iface for each Broadcom and Chelsio
+By default, iscsiadm will create a iface for each Broadcom, QLogic and Chelsio
 port. The iface name will be of the form:
 
 $transport/driver_name.$MAC_ADDRESS
@@ -529,6 +530,7 @@ Running:
 default tcp,<empty>,<empty>,<empty>,<empty>
 iser iser,<empty>,<empty>,<empty>,<empty>
 cxgb3i.00:07:43:05:97:07 cxgb3i,00:07:43:05:97:07,<empty>,<empty>,<empty>
+qla4xxx.00:0e:1e:04:8b:2e qla4xxx,00:0e:1e:04:8b:2e,<empty>,<empty>,<empty>
 
 
 Will report iface configurations that are setup in /etc/iscsi/ifaces.
@@ -547,7 +549,7 @@ default one in /etc/iscsi/initiatorname.iscsi.
 
 
 
-To display these values in a more friendly run:
+To display these values in a more friendly way, run:
 
 iscsiadm -m iface -I cxgb3i.00:07:43:05:97:07
 # BEGIN RECORD 2.0-871
@@ -571,6 +573,38 @@ For the name of the value we want to update we use the name from
 the "iscsiadm -m iface -I cxgb3i.00:07:43:05:97:07" command which is
 "iface.ipaddress".
 
+Note2.
+
+For QLogic ports after updating the iface record, for network settings to take
+effect, one must apply or applyall the settings.
+
+iscsiadm -m iface -I qla4xxx.00:0e:1e:04:8b:2e -o apply or
+iscsiadm -m iface -H 00:0e:1e:04:8b:2e -o applyall
+
+With operation "apply" network setting for the specified iface will take effect.
+With operation "applyall" network settings for all ifaces on a specific host
+will take take effect. The host can be specified using the -H/--host argument
+by either the MAC address of the host or the host number.
+
+
+Here is an example of setting multiple IPv6 address on single iSCSI interface
+port.
+First interface (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 fec0:ce00:7014:0041:1111:2222:1e04:9392
+
+Create the second interface 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 (iface_num is mandatory for second iface)
+iscsiadm -m iface -I qla4xxx.00:0e:1e:04:8b:2a -o update \
+	 -n iface.ipaddress -v = fec0:ce00:7014:0041:1111:2222:1e04:9393
+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.
 
 Now, we can use this iface to login into targets, which is described in the
 next section.