usr/src/uts/common/sys/iscsit/isns_protocol.h

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License (the "License").
   6  * You may not use this file except in compliance with the License.
   7  *
   8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9  * or http://www.opensolaris.org/os/licensing.
  10  * See the License for the specific language governing permissions
  11  * and limitations under the License.
  12  *
  13  * When distributing Covered Code, include this CDDL HEADER in each
  14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15  * If applicable, add the following below this CDDL HEADER, with the
  16  * fields enclosed by brackets "[]" replaced with your own identifying
  17  * information: Portions Copyright [yyyy] [name of copyright owner]
  18  *
  19  * CDDL HEADER END
  20  */
  21
  22 /*
  23  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
  24  * Use is subject to license terms.
  25  */
  26
  27 #ifndef _ISNS_PROTOCOL_H
  28 #define _ISNS_PROTOCOL_H
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 #include <netinet/in.h>
  35 #include <sys/socket.h>
  36 #include <sys/types.h>
  37
  38 #define ISNSP_VERSION                   (0x01)
  39
  40 #define ISNS_DEFAULT_SERVER_PORT        (3205)
  41
  42 #define ISNSP_HEADER_SIZE               (12)
  43 #define ISNSP_RSP_CODE_SIZE             (4)
  44 #define ISNSP_MAX_PAYLOAD_SIZE          (65532)
  45 #define ISNSP_MAX_PDU_SIZE              (ISNSP_HEADER_SIZE + \
  46                                         ISNSP_MAX_PAYLOAD_SIZE)
  47
  48 #define ISNS_TLV_ATTR_ID_LEN            (4)
  49 #define ISNS_TLV_ATTR_LEN_LEN           (4)
  50 #define MAX_ISNS_MESG_ATTR_ENTRIES      (8)
  51 #define MAX_ISNS_OPER_ATTR_ENTRIES      (32)
  52
  53 /* iSNS Entity Protocol, iSNS Draft - section 6.2.2. */
  54 #define ISNS_ENTITY_PROTOCOL_NO         (1)
  55 #define ISNS_ENTITY_PROTOCOL_ISCSI      (2)
  56 #define ISNS_ENTITY_PROTOCOL_FCP        (3)
  57
  58 /* iSNS Function IDs, iSNS Draft - section 4.1.3. */
  59 #define ISNS_DEV_ATTR_REG               (0x0001)
  60 #define ISNS_DEV_ATTR_QRY               (0x0002)
  61 #define ISNS_DEV_GET_NEXT               (0x0003)
  62 #define ISNS_DEV_DEREG                  (0x0004)
  63 #define ISNS_SCN_REG                    (0x0005)
  64 #define ISNS_SCN_DEREG                  (0x0006)
  65 #define ISNS_SCN_EVENT                  (0x0007)
  66 #define ISNS_SCN                        (0x0008)
  67 #define ISNS_DD_REG                     (0x0009)
  68 #define ISNS_DD_DEREG                   (0x000A)
  69 #define ISNS_DDS_REG                    (0x000B)
  70 #define ISNS_DDS_DEREG                  (0x000C)
  71 #define ISNS_ESI                        (0x000D)
  72 #define ISNS_HEARTBEAT                  (0x000E)
  73 #define ISNS_DEV_ATTR_REG_RSP           (0x8001)
  74 #define ISNS_DEV_ATTR_QRY_RSP           (0x8002)
  75 #define ISNS_DEV_GET_NEXT_RSP           (0x8003)
  76 #define ISNS_DEV_DEREG_RSP              (0x8004)
  77 #define ISNS_SCN_REG_RSP                (0x8005)
  78 #define ISNS_SCN_DEREG_RSP              (0x8006)
  79 #define ISNS_SCN_EVENT_RSP              (0x8007)
  80 #define ISNS_SCN_RSP                    (0x8008)
  81 #define ISNS_DD_REG_RSP                 (0x8009)
  82 #define ISNS_DD_DEREG_RSP               (0x800A)
  83 #define ISNS_DDS_REG_RSP                (0x800B)
  84 #define ISNS_DDS_DEREG_RSP              (0x800C)
  85 #define ISNS_ESI_RSP                    (0x800D)
  86
  87 /* iSNS Flags, iSNS Draft - section 5.1.4. */
  88 #define ISNS_FLAG_FIRST_PDU             (0x0400)
  89 #define ISNS_FLAG_LAST_PDU              (0x0800)
  90 #define ISNS_FLAG_REPLACE_REG           (0x1000)
  91 #define ISNS_FLAG_AUTH_BLK_PRESENTED    (0x2000)
  92 #define ISNS_FLAG_SERVER                (0x4000)
  93 #define ISNS_FLAG_CLIENT                (0x8000)
  94
  95 /* iSNS Response Status, iSNS Draft - section 5.4 */
  96 #define ISNS_RSP_SUCCESSFUL             (0)
  97 #define ISNS_RSP_UNKNOWN_ERROR          (1)
  98 #define ISNS_RSP_MSG_FORMAT_ERROR       (2)
  99 #define ISNS_RSP_INVALID_REGIS          (3)
 100 #define ISNS_RSP_INVALID_QRY            (5)
 101 #define ISNS_RSP_SRC_UNKNOWN            (6)
 102 #define ISNS_RSP_SRC_ABSENT             (7)
 103 #define ISNS_RSP_SRC_UNAUTHORIZED       (8)
 104 #define ISNS_RSP_NO_SUCH_ENTRY          (9)
 105 #define ISNS_RSP_VER_NOT_SUPPORTED      (10)
 106 #define ISNS_RSP_INTERNAL_ERROR         (11)
 107 #define ISNS_RSP_BUSY                   (12)
 108 #define ISNS_RSP_OPTION_NOT_UNDERSTOOD  (13)
 109 #define ISNS_RSP_INVALID_UPDATE         (14)
 110 #define ISNS_RSP_MSG_NOT_SUPPORTED      (15)
 111 #define ISNS_RSP_SCN_EVENT_REJECTED     (16)
 112 #define ISNS_RSP_SCN_REGIS_REJECTED     (17)
 113 #define ISNS_RSP_ATTR_NOT_IMPL          (18)
 114 #define ISNS_RSP_ESI_NOT_AVAILABLE      (21)
 115 #define ISNS_RSP_INVALID_DEREGIS        (22)
 116 #define ISNS_RSP_REGIS_NOT_SUPPORTED    (23)
 117
 118 /* iSNS Attribute IDs, iSNS Draft - section 6.1. */
 119 #define ISNS_DELIMITER_ATTR_ID          (0)
 120 #define ISNS_EID_ATTR_ID                (1)
 121 #define ISNS_ENTITY_PROTOCOL_ATTR_ID    (2)
 122 #define ISNS_MGMT_IP_ADDR_ATTR_ID       (3)
 123 #define ISNS_TIMESTAMP_ATTR_ID          (4)
 124 #define ISNS_VERSION_RANGE_ATTR_ID      (5)
 125 #define ISNS_ENTITY_REG_PERIOD_ATTR_ID  (6)
 126 #define ISNS_ENTITY_INDEX_ATTR_ID       (7)
 127 #define ISNS_ENTITY_NEXT_INDEX_ATTR_ID  (8)
 128 #define ISNS_ENTITY_ISAKMP_P1_ATTR_ID   (11)
 129 #define ISNS_ENTITY_CERT_ATTR_ID        (12)
 130 #define ISNS_PORTAL_IP_ADDR_ATTR_ID     (16)
 131 #define ISNS_PORTAL_PORT_ATTR_ID        (17)
 132 #define ISNS_PORTAL_NAME_ATTR_ID        (18)
 133 #define ISNS_ESI_INTERVAL_ATTR_ID       (19)
 134 #define ISNS_ESI_PORT_ATTR_ID           (20)
 135 #define ISNS_PORTAL_INDEX_ATTR_ID       (22)
 136 #define ISNS_SCN_PORT_ATTR_ID           (23)
 137 #define ISNS_PORTAL_NEXT_INDEX_ATTR_ID  (24)
 138 #define ISNS_PORTAL_SEC_BMP_ATTR_ID     (27)
 139 #define ISNS_PORTAL_ISAKMP_P1_ATTR_ID   (28)
 140 #define ISNS_PORTAL_ISAKMP_P2_ATTR_ID   (29)
 141 #define ISNS_PORTAL_CERT_ATTR_ID        (31)
 142 #define ISNS_ISCSI_NAME_ATTR_ID         (32)
 143 #define ISNS_ISCSI_NODE_TYPE_ATTR_ID    (33)
 144 #define ISNS_ISCSI_ALIAS_ATTR_ID        (34)
 145 #define ISNS_ISCSI_SCN_BITMAP_ATTR_ID   (35)
 146 #define ISNS_ISCSI_NODE_INDEX_ATTR_ID   (36)
 147 #define ISNS_WWNN_TOKEN_ATTR_ID         (37)
 148 #define ISNS_NODE_NEXT_INDEX_ATTR_ID    (38)
 149 #define ISNS_ISCSI_AUTH_METHOD_ATTR_ID  (42)
 150 #define ISNS_PG_ISCSI_NAME_ATTR_ID      (48)
 151 #define ISNS_PG_PORTAL_IP_ADDR_ATTR_ID  (49)
 152 #define ISNS_PG_PORTAL_PORT_ATTR_ID     (50)
 153 #define ISNS_PG_TAG_ATTR_ID             (51)
 154 #define ISNS_PG_INDEX_ATTR_ID           (52)
 155 #define ISNS_PG_NEXT_ID_ATTR_ID         (53)
 156 #define ISNS_DD_SET_ID_ATTR_ID          (2049)
 157 #define ISNS_DD_SET_NAME_ATTR_ID        (2050)
 158 #define ISNS_DD_SET_STATUS_ATTR_ID      (2051)
 159 #define ISNS_DD_ID_ATTR_ID              (2065)
 160 #define ISNS_DD_NAME_ATTR_ID            (2066)
 161 #define ISNS_DD_ISCSI_INDEX_ATTR_ID     (2067)
 162 #define ISNS_DD_ISCSI_NAME_ATTR_ID      (2068)
 163 #define ISNS_DD_FC_PORT_NAME_ATTR_ID    (2069)
 164 #define ISNS_DD_PORTAL_INDEX_ATTR_ID    (2070)
 165 #define ISNS_DD_PORTAL_IP_ADDR_ATTR_ID  (2071)
 166 #define ISNS_DD_PORTAL_PORT_ATTR_ID     (2072)
 167 #define ISNS_DD_FEATURES_ATTR_ID        (2078)
 168
 169 /* Entity Protocol, RFC 4171 - section 6.2.2. */
 170 #define ISNS_ENTITY_NO_PROTOCOL         (1)
 171 #define ISNS_ENTITY_ISCSI               (2)
 172 #define ISNS_ENTITY_IFCP                (3)
 173
 174 /* Protocol Version Range, RFC 4171 - section 6.2.5. */
 175 #define ISNS_VER_SHIFT                  (16)
 176 #define ISNS_VERSION                    (0x0000FFFF)
 177
 178 /* Portal Port, RFC 4171 - section 6.3.2. */
 179 #define ISNS_PORT_BITS                  (0x0000FFFF)    /* Bits 16 - 31 */
 180 #define ISNS_PORT_TYPE                  (0x00010000)    /* Bit 15 */
 181
 182 /* Portal Security Bitmap, RFC 4171 - section 6.3.9. */
 183 #define ISNS_TUNNEL_MODE_PREFERRED      (0x0040)        /* Bit 25 */
 184 #define ISNS_TRANS_MODE_PREFERRED       (0x0020)        /* Bit 26 */
 185 #define ISNS_PFS_ENABLED                (0x0010)        /* Bit 27 */
 186 #define ISNS_AGGR_MODE_ENABLED          (0x0008)        /* Bit 28 */
 187 #define ISNS_MAIN_MODE_ENABLED          (0x0004)        /* Bit 29 */
 188 #define ISNS_IKE_IPSEC_ENABLED          (0x0002)        /* Bit 30 */
 189 #define ISNS_BITMAP_VALID               (0x0001)        /* Bit 31 */
 190
 191 /* iSCSI Node Type, RFC 4171 - section 6.4.2. */
 192 #define ISNS_TARGET_NODE_TYPE           (0x0001)
 193 #define ISNS_INITIATOR_NODE_TYPE        (0x0002)
 194 #define ISNS_CONTROL_NODE_TYPE          (0x0004)
 195
 196 /* iSCSI Node SCN Bitmap, RFC 4171 - section 6.4.4. */
 197 #define ISNS_INIT_SELF_INFO_ONLY        (0x0080)        /* Bit 24 */
 198 #define ISNS_TARGET_SELF_INFO_ONLY      (0x0040)        /* Bit 25 */
 199 #define ISNS_MGMT_REG                   (0x0020)        /* Bit 26 */
 200 #define ISNS_OBJECT_REMOVED             (0x0010)        /* Bit 27 */
 201 #define ISNS_OBJECT_ADDED               (0x0008)        /* Bit 28 */
 202 #define ISNS_OBJECT_UPDATED             (0x0004)        /* Bit 29 */
 203 #define ISNS_MEMBER_REMOVED             (0x0002)        /* Bit 30 */
 204 #define ISNS_MEMBER_ADDED               (0x0001)        /* Bit 31 */
 205
 206 /* Portal Group Tag, RFC 4171 - section 6.5.4. */
 207 #define ISNS_PG_TAG                     (0x0000FFFF)    /* Bits 16 - 31 */
 208
 209 /* DDS Status, RFC 4171 - section 6.11.1.3. */
 210 #define ISNS_DDS_STATUS                 (0x0001)        /* Bit 31 */
 211
 212 /* DD Feature, RFC 4171 - section 6.11.2.9. */
 213 #define ISNS_DD_BOOTLIST                (0x0001)        /* Bit 31 */
 214
 215 /* iSNS Defaults */
 216 #define ISNS_DEFAULT_PGT                (0x00000001)
 217 #define ISNS_DEFAULT_DD_SET_ID          (1)
 218 #define ISNS_DEFAULT_DD_ID              (1)
 219
 220 /* Min/Max length of names */
 221 #define ISNS_DDS_MAX_NAME_LEN           (256)
 222 #define ISNS_DD_MAX_NAME_LEN            (256)
 223 #define ISNS_ISCSI_MAX_NAME_LEN         (224)
 224 #define ISNS_ISCSI_MAX_ALIAS_LEN        (256)
 225 #define ISNS_ENTITY_MIN_EID_LEN         (3)
 226 #define ISNS_ENTITY_MAX_EID_LEN         (255)
 227
 228
 229 typedef struct isns_tlv {
 230         uint32_t attr_id;
 231         uint32_t attr_len;
 232         uint8_t attr_value[1];
 233 } isns_tlv_t;
 234
 235 typedef struct isns_packet_data {
 236         uint16_t version;
 237         uint16_t func_id;
 238         uint16_t payload_len;
 239         uint16_t flags;
 240         uint16_t xid;
 241         uint16_t seq;
 242
 243         int num_of_tlvs;
 244         isns_tlv_t tlvs[MAX_ISNS_OPER_ATTR_ENTRIES];
 245 } isns_packet_data_t;
 246
 247 typedef struct isns_reg_mesg {
 248         isns_tlv_t src_attr;
 249         int num_of_mesg_attrs;
 250         isns_tlv_t *mesg_attrs[MAX_ISNS_MESG_ATTR_ENTRIES];
 251         isns_tlv_t delimiter_attr;
 252         isns_tlv_t *operating_attrs[MAX_ISNS_OPER_ATTR_ENTRIES];
 253 } isns_reg_mesg_t;
 254
 255 typedef struct isns_resp_mesg {
 256         uint8_t status[4];
 257         isns_tlv_t messages_attrs[MAX_ISNS_MESG_ATTR_ENTRIES];
 258         isns_tlv_t delimiter_attr;
 259         isns_tlv_t operating_attrs[MAX_ISNS_OPER_ATTR_ENTRIES];
 260 } isns_resp_mesg_t;
 261
 262 typedef struct isns_pdu {
 263         uint16_t version;
 264         uint16_t func_id;
 265         uint16_t payload_len;
 266         uint16_t flags;
 267         uint16_t xid;
 268         uint16_t seq;
 269         uint8_t payload[1];
 270 } isns_pdu_t;
 271
 272 typedef struct isns_resp {
 273         uint32_t status;
 274         uint8_t data[1];
 275 } isns_resp_t;
 276
 277 #ifdef __cplusplus
 278 }
 279 #endif
 280
 281 #endif /* _ISNS_PROTOCOL_H */