LXR linux/include/scsi/iscsi

   1/*
   2 * iSCSI User/Kernel Shares (Defines, Constants, Protocol definitions, etc)
   3 *
   4 * Copyright (C) 2005 Dmitry Yusupov
   5 * Copyright (C) 2005 Alex Aizman
   6 * maintained by open-iscsi@googlegroups.com
   7 *
   8 * This program is free software; you can redistribute it and/or modify
   9 * it under the terms of the GNU General Public License as published
  10 * by the Free Software Foundation; either version 2 of the License, or
  11 * (at your option) any later version.
  12 *
  13 * This program is distributed in the hope that it will be useful, but
  14 * WITHOUT ANY WARRANTY; without even the implied warranty of
  15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16 * General Public License for more details.
  17 *
  18 * See the file COPYING included with this distribution for more details.
  19 */
  20
  21#ifndef ISCSI_IF_H
  22#define ISCSI_IF_H
  23
  24#include <scsi/iscsi_proto.h>
  25#include <linux/in.h>
  26#include <linux/in6.h>
  27
  28#define ISCSI_NL_GRP_ISCSID     1
  29#define ISCSI_NL_GRP_UIP        2
  30
  31#define UEVENT_BASE                     10
  32#define KEVENT_BASE                     100
  33#define ISCSI_ERR_BASE                  1000
  34
  35enum iscsi_uevent_e {
  36        ISCSI_UEVENT_UNKNOWN            = 0,
  37
  38        /* down events */
  39        ISCSI_UEVENT_CREATE_SESSION     = UEVENT_BASE + 1,
  40        ISCSI_UEVENT_DESTROY_SESSION    = UEVENT_BASE + 2,
  41        ISCSI_UEVENT_CREATE_CONN        = UEVENT_BASE + 3,
  42        ISCSI_UEVENT_DESTROY_CONN       = UEVENT_BASE + 4,
  43        ISCSI_UEVENT_BIND_CONN          = UEVENT_BASE + 5,
  44        ISCSI_UEVENT_SET_PARAM          = UEVENT_BASE + 6,
  45        ISCSI_UEVENT_START_CONN         = UEVENT_BASE + 7,
  46        ISCSI_UEVENT_STOP_CONN          = UEVENT_BASE + 8,
  47        ISCSI_UEVENT_SEND_PDU           = UEVENT_BASE + 9,
  48        ISCSI_UEVENT_GET_STATS          = UEVENT_BASE + 10,
  49        ISCSI_UEVENT_GET_PARAM          = UEVENT_BASE + 11,
  50
  51        ISCSI_UEVENT_TRANSPORT_EP_CONNECT       = UEVENT_BASE + 12,
  52        ISCSI_UEVENT_TRANSPORT_EP_POLL          = UEVENT_BASE + 13,
  53        ISCSI_UEVENT_TRANSPORT_EP_DISCONNECT    = UEVENT_BASE + 14,
  54
  55        ISCSI_UEVENT_TGT_DSCVR          = UEVENT_BASE + 15,
  56        ISCSI_UEVENT_SET_HOST_PARAM     = UEVENT_BASE + 16,
  57        ISCSI_UEVENT_UNBIND_SESSION     = UEVENT_BASE + 17,
  58        ISCSI_UEVENT_CREATE_BOUND_SESSION               = UEVENT_BASE + 18,
  59        ISCSI_UEVENT_TRANSPORT_EP_CONNECT_THROUGH_HOST  = UEVENT_BASE + 19,
  60
  61        ISCSI_UEVENT_PATH_UPDATE        = UEVENT_BASE + 20,
  62
  63        /* up events */
  64        ISCSI_KEVENT_RECV_PDU           = KEVENT_BASE + 1,
  65        ISCSI_KEVENT_CONN_ERROR         = KEVENT_BASE + 2,
  66        ISCSI_KEVENT_IF_ERROR           = KEVENT_BASE + 3,
  67        ISCSI_KEVENT_DESTROY_SESSION    = KEVENT_BASE + 4,
  68        ISCSI_KEVENT_UNBIND_SESSION     = KEVENT_BASE + 5,
  69        ISCSI_KEVENT_CREATE_SESSION     = KEVENT_BASE + 6,
  70
  71        ISCSI_KEVENT_PATH_REQ           = KEVENT_BASE + 7,
  72        ISCSI_KEVENT_IF_DOWN            = KEVENT_BASE + 8,
  73};
  74
  75enum iscsi_tgt_dscvr {
  76        ISCSI_TGT_DSCVR_SEND_TARGETS    = 1,
  77        ISCSI_TGT_DSCVR_ISNS            = 2,
  78        ISCSI_TGT_DSCVR_SLP             = 3,
  79};
  80
  81struct iscsi_uevent {
  82        uint32_t type; /* k/u events type */
  83        uint32_t iferror; /* carries interface or resource errors */
  84        uint64_t transport_handle;
  85
  86        union {
  87                /* messages u -> k */
  88                struct msg_create_session {
  89                        uint32_t        initial_cmdsn;
  90                        uint16_t        cmds_max;
  91                        uint16_t        queue_depth;
  92                } c_session;
  93                struct msg_create_bound_session {
  94                        uint64_t        ep_handle;
  95                        uint32_t        initial_cmdsn;
  96                        uint16_t        cmds_max;
  97                        uint16_t        queue_depth;
  98                } c_bound_session;
  99                struct msg_destroy_session {
 100                        uint32_t        sid;
 101                } d_session;
 102                struct msg_create_conn {
 103                        uint32_t        sid;
 104                        uint32_t        cid;
 105                } c_conn;
 106                struct msg_bind_conn {
 107                        uint32_t        sid;
 108                        uint32_t        cid;
 109                        uint64_t        transport_eph;
 110                        uint32_t        is_leading;
 111                } b_conn;
 112                struct msg_destroy_conn {
 113                        uint32_t        sid;
 114                        uint32_t        cid;
 115                } d_conn;
 116                struct msg_send_pdu {
 117                        uint32_t        sid;
 118                        uint32_t        cid;
 119                        uint32_t        hdr_size;
 120                        uint32_t        data_size;
 121                } send_pdu;
 122                struct msg_set_param {
 123                        uint32_t        sid;
 124                        uint32_t        cid;
 125                        uint32_t        param; /* enum iscsi_param */
 126                        uint32_t        len;
 127                } set_param;
 128                struct msg_start_conn {
 129                        uint32_t        sid;
 130                        uint32_t        cid;
 131                } start_conn;
 132                struct msg_stop_conn {
 133                        uint32_t        sid;
 134                        uint32_t        cid;
 135                        uint64_t        conn_handle;
 136                        uint32_t        flag;
 137                } stop_conn;
 138                struct msg_get_stats {
 139                        uint32_t        sid;
 140                        uint32_t        cid;
 141                } get_stats;
 142                struct msg_transport_connect {
 143                        uint32_t        non_blocking;
 144                } ep_connect;
 145                struct msg_transport_connect_through_host {
 146                        uint32_t        host_no;
 147                        uint32_t        non_blocking;
 148                } ep_connect_through_host;
 149                struct msg_transport_poll {
 150                        uint64_t        ep_handle;
 151                        uint32_t        timeout_ms;
 152                } ep_poll;
 153                struct msg_transport_disconnect {
 154                        uint64_t        ep_handle;
 155                } ep_disconnect;
 156                struct msg_tgt_dscvr {
 157                        enum iscsi_tgt_dscvr    type;
 158                        uint32_t        host_no;
 159                        /*
 160                         * enable = 1 to establish a new connection
 161                         * with the server. enable = 0 to disconnect
 162                         * from the server. Used primarily to switch
 163                         * from one iSNS server to another.
 164                         */
 165                        uint32_t        enable;
 166                } tgt_dscvr;
 167                struct msg_set_host_param {
 168                        uint32_t        host_no;
 169                        uint32_t        param; /* enum iscsi_host_param */
 170                        uint32_t        len;
 171                } set_host_param;
 172                struct msg_set_path {
 173                        uint32_t        host_no;
 174                } set_path;
 175        } u;
 176        union {
 177                /* messages k -> u */
 178                int                     retcode;
 179                struct msg_create_session_ret {
 180                        uint32_t        sid;
 181                        uint32_t        host_no;
 182                } c_session_ret;
 183                struct msg_create_conn_ret {
 184                        uint32_t        sid;
 185                        uint32_t        cid;
 186                } c_conn_ret;
 187                struct msg_unbind_session {
 188                        uint32_t        sid;
 189                        uint32_t        host_no;
 190                } unbind_session;
 191                struct msg_recv_req {
 192                        uint32_t        sid;
 193                        uint32_t        cid;
 194                        uint64_t        recv_handle;
 195                } recv_req;
 196                struct msg_conn_error {
 197                        uint32_t        sid;
 198                        uint32_t        cid;
 199                        uint32_t        error; /* enum iscsi_err */
 200                } connerror;
 201                struct msg_session_destroyed {
 202                        uint32_t        host_no;
 203                        uint32_t        sid;
 204                } d_session;
 205                struct msg_transport_connect_ret {
 206                        uint64_t        handle;
 207                } ep_connect_ret;
 208                struct msg_req_path {
 209                        uint32_t        host_no;
 210                } req_path;
 211                struct msg_notify_if_down {
 212                        uint32_t        host_no;
 213                } notify_if_down;
 214        } r;
 215} __attribute__ ((aligned (sizeof(uint64_t))));
 216
 217/*
 218 * To keep the struct iscsi_uevent size the same for userspace code
 219 * compatibility, the main structure for ISCSI_UEVENT_PATH_UPDATE and
 220 * ISCSI_KEVENT_PATH_REQ is defined separately and comes after the
 221 * struct iscsi_uevent in the NETLINK_ISCSI message.
 222 */
 223struct iscsi_path {
 224        uint64_t        handle;
 225        uint8_t         mac_addr[6];
 226        uint8_t         mac_addr_old[6];
 227        uint32_t        ip_addr_len;    /* 4 or 16 */
 228        union {
 229                struct in_addr  v4_addr;
 230                struct in6_addr v6_addr;
 231        } src;
 232        union {
 233                struct in_addr  v4_addr;
 234                struct in6_addr v6_addr;
 235        } dst;
 236        uint16_t        vlan_id;
 237        uint16_t        pmtu;
 238} __attribute__ ((aligned (sizeof(uint64_t))));
 239
 240/*
 241 * Common error codes
 242 */
 243enum iscsi_err {
 244        ISCSI_OK                        = 0,
 245
 246        ISCSI_ERR_DATASN                = ISCSI_ERR_BASE + 1,
 247        ISCSI_ERR_DATA_OFFSET           = ISCSI_ERR_BASE + 2,
 248        ISCSI_ERR_MAX_CMDSN             = ISCSI_ERR_BASE + 3,
 249        ISCSI_ERR_EXP_CMDSN             = ISCSI_ERR_BASE + 4,
 250        ISCSI_ERR_BAD_OPCODE            = ISCSI_ERR_BASE + 5,
 251        ISCSI_ERR_DATALEN               = ISCSI_ERR_BASE + 6,
 252        ISCSI_ERR_AHSLEN                = ISCSI_ERR_BASE + 7,
 253        ISCSI_ERR_PROTO                 = ISCSI_ERR_BASE + 8,
 254        ISCSI_ERR_LUN                   = ISCSI_ERR_BASE + 9,
 255        ISCSI_ERR_BAD_ITT               = ISCSI_ERR_BASE + 10,
 256        ISCSI_ERR_CONN_FAILED           = ISCSI_ERR_BASE + 11,
 257        ISCSI_ERR_R2TSN                 = ISCSI_ERR_BASE + 12,
 258        ISCSI_ERR_SESSION_FAILED        = ISCSI_ERR_BASE + 13,
 259        ISCSI_ERR_HDR_DGST              = ISCSI_ERR_BASE + 14,
 260        ISCSI_ERR_DATA_DGST             = ISCSI_ERR_BASE + 15,
 261        ISCSI_ERR_PARAM_NOT_FOUND       = ISCSI_ERR_BASE + 16,
 262        ISCSI_ERR_NO_SCSI_CMD           = ISCSI_ERR_BASE + 17,
 263        ISCSI_ERR_INVALID_HOST          = ISCSI_ERR_BASE + 18,
 264        ISCSI_ERR_XMIT_FAILED           = ISCSI_ERR_BASE + 19,
 265        ISCSI_ERR_TCP_CONN_CLOSE        = ISCSI_ERR_BASE + 20,
 266};
 267
 268/*
 269 * iSCSI Parameters (RFC3720)
 270 */
 271enum iscsi_param {
 272        /* passed in using netlink set param */
 273        ISCSI_PARAM_MAX_RECV_DLENGTH,
 274        ISCSI_PARAM_MAX_XMIT_DLENGTH,
 275        ISCSI_PARAM_HDRDGST_EN,
 276        ISCSI_PARAM_DATADGST_EN,
 277        ISCSI_PARAM_INITIAL_R2T_EN,
 278        ISCSI_PARAM_MAX_R2T,
 279        ISCSI_PARAM_IMM_DATA_EN,
 280        ISCSI_PARAM_FIRST_BURST,
 281        ISCSI_PARAM_MAX_BURST,
 282        ISCSI_PARAM_PDU_INORDER_EN,
 283        ISCSI_PARAM_DATASEQ_INORDER_EN,
 284        ISCSI_PARAM_ERL,
 285        ISCSI_PARAM_IFMARKER_EN,
 286        ISCSI_PARAM_OFMARKER_EN,
 287        ISCSI_PARAM_EXP_STATSN,
 288        ISCSI_PARAM_TARGET_NAME,
 289        ISCSI_PARAM_TPGT,
 290        ISCSI_PARAM_PERSISTENT_ADDRESS,
 291        ISCSI_PARAM_PERSISTENT_PORT,
 292        ISCSI_PARAM_SESS_RECOVERY_TMO,
 293
 294        /* pased in through bind conn using transport_fd */
 295        ISCSI_PARAM_CONN_PORT,
 296        ISCSI_PARAM_CONN_ADDRESS,
 297
 298        ISCSI_PARAM_USERNAME,
 299        ISCSI_PARAM_USERNAME_IN,
 300        ISCSI_PARAM_PASSWORD,
 301        ISCSI_PARAM_PASSWORD_IN,
 302
 303        ISCSI_PARAM_FAST_ABORT,
 304        ISCSI_PARAM_ABORT_TMO,
 305        ISCSI_PARAM_LU_RESET_TMO,
 306        ISCSI_PARAM_HOST_RESET_TMO,
 307
 308        ISCSI_PARAM_PING_TMO,
 309        ISCSI_PARAM_RECV_TMO,
 310
 311        ISCSI_PARAM_IFACE_NAME,
 312        ISCSI_PARAM_ISID,
 313        ISCSI_PARAM_INITIATOR_NAME,
 314        /* must always be last */
 315        ISCSI_PARAM_MAX,
 316};
 317
 318#define ISCSI_MAX_RECV_DLENGTH          (1ULL << ISCSI_PARAM_MAX_RECV_DLENGTH)
 319#define ISCSI_MAX_XMIT_DLENGTH          (1ULL << ISCSI_PARAM_MAX_XMIT_DLENGTH)
 320#define ISCSI_HDRDGST_EN                (1ULL << ISCSI_PARAM_HDRDGST_EN)
 321#define ISCSI_DATADGST_EN               (1ULL << ISCSI_PARAM_DATADGST_EN)
 322#define ISCSI_INITIAL_R2T_EN            (1ULL << ISCSI_PARAM_INITIAL_R2T_EN)
 323#define ISCSI_MAX_R2T                   (1ULL << ISCSI_PARAM_MAX_R2T)
 324#define ISCSI_IMM_DATA_EN               (1ULL << ISCSI_PARAM_IMM_DATA_EN)
 325#define ISCSI_FIRST_BURST               (1ULL << ISCSI_PARAM_FIRST_BURST)
 326#define ISCSI_MAX_BURST                 (1ULL << ISCSI_PARAM_MAX_BURST)
 327#define ISCSI_PDU_INORDER_EN            (1ULL << ISCSI_PARAM_PDU_INORDER_EN)
 328#define ISCSI_DATASEQ_INORDER_EN        (1ULL << ISCSI_PARAM_DATASEQ_INORDER_EN)
 329#define ISCSI_ERL                       (1ULL << ISCSI_PARAM_ERL)
 330#define ISCSI_IFMARKER_EN               (1ULL << ISCSI_PARAM_IFMARKER_EN)
 331#define ISCSI_OFMARKER_EN               (1ULL << ISCSI_PARAM_OFMARKER_EN)
 332#define ISCSI_EXP_STATSN                (1ULL << ISCSI_PARAM_EXP_STATSN)
 333#define ISCSI_TARGET_NAME               (1ULL << ISCSI_PARAM_TARGET_NAME)
 334#define ISCSI_TPGT                      (1ULL << ISCSI_PARAM_TPGT)
 335#define ISCSI_PERSISTENT_ADDRESS        (1ULL << ISCSI_PARAM_PERSISTENT_ADDRESS)
 336#define ISCSI_PERSISTENT_PORT           (1ULL << ISCSI_PARAM_PERSISTENT_PORT)
 337#define ISCSI_SESS_RECOVERY_TMO         (1ULL << ISCSI_PARAM_SESS_RECOVERY_TMO)
 338#define ISCSI_CONN_PORT                 (1ULL << ISCSI_PARAM_CONN_PORT)
 339#define ISCSI_CONN_ADDRESS              (1ULL << ISCSI_PARAM_CONN_ADDRESS)
 340#define ISCSI_USERNAME                  (1ULL << ISCSI_PARAM_USERNAME)
 341#define ISCSI_USERNAME_IN               (1ULL << ISCSI_PARAM_USERNAME_IN)
 342#define ISCSI_PASSWORD                  (1ULL << ISCSI_PARAM_PASSWORD)
 343#define ISCSI_PASSWORD_IN               (1ULL << ISCSI_PARAM_PASSWORD_IN)
 344#define ISCSI_FAST_ABORT                (1ULL << ISCSI_PARAM_FAST_ABORT)
 345#define ISCSI_ABORT_TMO                 (1ULL << ISCSI_PARAM_ABORT_TMO)
 346#define ISCSI_LU_RESET_TMO              (1ULL << ISCSI_PARAM_LU_RESET_TMO)
 347#define ISCSI_HOST_RESET_TMO            (1ULL << ISCSI_PARAM_HOST_RESET_TMO)
 348#define ISCSI_PING_TMO                  (1ULL << ISCSI_PARAM_PING_TMO)
 349#define ISCSI_RECV_TMO                  (1ULL << ISCSI_PARAM_RECV_TMO)
 350#define ISCSI_IFACE_NAME                (1ULL << ISCSI_PARAM_IFACE_NAME)
 351#define ISCSI_ISID                      (1ULL << ISCSI_PARAM_ISID)
 352#define ISCSI_INITIATOR_NAME            (1ULL << ISCSI_PARAM_INITIATOR_NAME)
 353
 354/* iSCSI HBA params */
 355enum iscsi_host_param {
 356        ISCSI_HOST_PARAM_HWADDRESS,
 357        ISCSI_HOST_PARAM_INITIATOR_NAME,
 358        ISCSI_HOST_PARAM_NETDEV_NAME,
 359        ISCSI_HOST_PARAM_IPADDRESS,
 360        ISCSI_HOST_PARAM_MAX,
 361};
 362
 363#define ISCSI_HOST_HWADDRESS            (1ULL << ISCSI_HOST_PARAM_HWADDRESS)
 364#define ISCSI_HOST_INITIATOR_NAME       (1ULL << ISCSI_HOST_PARAM_INITIATOR_NAME)
 365#define ISCSI_HOST_NETDEV_NAME          (1ULL << ISCSI_HOST_PARAM_NETDEV_NAME)
 366#define ISCSI_HOST_IPADDRESS            (1ULL << ISCSI_HOST_PARAM_IPADDRESS)
 367
 368#define iscsi_ptr(_handle) ((void*)(unsigned long)_handle)
 369#define iscsi_handle(_ptr) ((uint64_t)(unsigned long)_ptr)
 370
 371/*
 372 * These flags presents iSCSI Data-Path capabilities.
 373 */
 374#define CAP_RECOVERY_L0         0x1
 375#define CAP_RECOVERY_L1         0x2
 376#define CAP_RECOVERY_L2         0x4
 377#define CAP_MULTI_R2T           0x8
 378#define CAP_HDRDGST             0x10
 379#define CAP_DATADGST            0x20
 380#define CAP_MULTI_CONN          0x40
 381#define CAP_TEXT_NEGO           0x80
 382#define CAP_MARKERS             0x100
 383#define CAP_FW_DB               0x200
 384#define CAP_SENDTARGETS_OFFLOAD 0x400   /* offload discovery process */
 385#define CAP_DATA_PATH_OFFLOAD   0x800   /* offload entire IO path */
 386#define CAP_DIGEST_OFFLOAD      0x1000  /* offload hdr and data digests */
 387#define CAP_PADDING_OFFLOAD     0x2000  /* offload padding insertion, removal,
 388                                         and verification */
 389
 390/*
 391 * These flags describes reason of stop_conn() call
 392 */
 393#define STOP_CONN_TERM          0x1
 394#define STOP_CONN_SUSPEND       0x2
 395#define STOP_CONN_RECOVER       0x3
 396
 397#define ISCSI_STATS_CUSTOM_MAX          32
 398#define ISCSI_STATS_CUSTOM_DESC_MAX     64
 399struct iscsi_stats_custom {
 400        char desc[ISCSI_STATS_CUSTOM_DESC_MAX];
 401        uint64_t value;
 402};
 403
 404/*
 405 * struct iscsi_stats - iSCSI Statistics (iSCSI MIB)
 406 *
 407 * Note: this structure contains counters collected on per-connection basis.
 408 */
 409struct iscsi_stats {
 410        /* octets */
 411        uint64_t txdata_octets;
 412        uint64_t rxdata_octets;
 413
 414        /* xmit pdus */
 415        uint32_t noptx_pdus;
 416        uint32_t scsicmd_pdus;
 417        uint32_t tmfcmd_pdus;
 418        uint32_t login_pdus;
 419        uint32_t text_pdus;
 420        uint32_t dataout_pdus;
 421        uint32_t logout_pdus;
 422        uint32_t snack_pdus;
 423
 424        /* recv pdus */
 425        uint32_t noprx_pdus;
 426        uint32_t scsirsp_pdus;
 427        uint32_t tmfrsp_pdus;
 428        uint32_t textrsp_pdus;
 429        uint32_t datain_pdus;
 430        uint32_t logoutrsp_pdus;
 431        uint32_t r2t_pdus;
 432        uint32_t async_pdus;
 433        uint32_t rjt_pdus;
 434
 435        /* errors */
 436        uint32_t digest_err;
 437        uint32_t timeout_err;
 438
 439        /*
 440         * iSCSI Custom Statistics support, i.e. Transport could
 441         * extend existing MIB statistics with its own specific statistics
 442         * up to ISCSI_STATS_CUSTOM_MAX
 443         */
 444        uint32_t custom_length;
 445        struct iscsi_stats_custom custom[0]
 446                __attribute__ ((aligned (sizeof(uint64_t))));
 447};
 448
 449#endif
 450