SAFE public projects git trees. - safe/jmp/linux-2.6/blob - include/scsi/iscsi_if.h

   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
  26 #define UEVENT_BASE                     10
  27 #define KEVENT_BASE                     100
  28 #define ISCSI_ERR_BASE                  1000
  29
  30 enum iscsi_uevent_e {
  31         ISCSI_UEVENT_UNKNOWN            = 0,
  32
  33         /* down events */
  34         ISCSI_UEVENT_CREATE_SESSION     = UEVENT_BASE + 1,
  35         ISCSI_UEVENT_DESTROY_SESSION    = UEVENT_BASE + 2,
  36         ISCSI_UEVENT_CREATE_CONN        = UEVENT_BASE + 3,
  37         ISCSI_UEVENT_DESTROY_CONN       = UEVENT_BASE + 4,
  38         ISCSI_UEVENT_BIND_CONN          = UEVENT_BASE + 5,
  39         ISCSI_UEVENT_SET_PARAM          = UEVENT_BASE + 6,
  40         ISCSI_UEVENT_START_CONN         = UEVENT_BASE + 7,
  41         ISCSI_UEVENT_STOP_CONN          = UEVENT_BASE + 8,
  42         ISCSI_UEVENT_SEND_PDU           = UEVENT_BASE + 9,
  43         ISCSI_UEVENT_GET_STATS          = UEVENT_BASE + 10,
  44         ISCSI_UEVENT_GET_PARAM          = UEVENT_BASE + 11,
  45
  46         /* up events */
  47         ISCSI_KEVENT_RECV_PDU           = KEVENT_BASE + 1,
  48         ISCSI_KEVENT_CONN_ERROR         = KEVENT_BASE + 2,
  49         ISCSI_KEVENT_IF_ERROR           = KEVENT_BASE + 3,
  50 };
  51
  52 struct iscsi_uevent {
  53         uint32_t type; /* k/u events type */
  54         uint32_t iferror; /* carries interface or resource errors */
  55         uint64_t transport_handle;
  56
  57         union {
  58                 /* messages u -> k */
  59                 struct msg_create_session {
  60                         uint32_t        initial_cmdsn;
  61                 } c_session;
  62                 struct msg_destroy_session {
  63                         uint32_t        sid;
  64                 } d_session;
  65                 struct msg_create_conn {
  66                         uint32_t        sid;
  67                         uint32_t        cid;
  68                 } c_conn;
  69                 struct msg_bind_conn {
  70                         uint32_t        sid;
  71                         uint32_t        cid;
  72                         uint32_t        transport_fd;
  73                         uint32_t        is_leading;
  74                 } b_conn;
  75                 struct msg_destroy_conn {
  76                         uint32_t        sid;
  77                         uint32_t        cid;
  78                 } d_conn;
  79                 struct msg_send_pdu {
  80                         uint32_t        sid;
  81                         uint32_t        cid;
  82                         uint32_t        hdr_size;
  83                         uint32_t        data_size;
  84                 } send_pdu;
  85                 struct msg_set_param {
  86                         uint32_t        sid;
  87                         uint32_t        cid;
  88                         uint32_t        param; /* enum iscsi_param */
  89                         uint32_t        len;
  90                 } set_param;
  91                 struct msg_start_conn {
  92                         uint32_t        sid;
  93                         uint32_t        cid;
  94                 } start_conn;
  95                 struct msg_stop_conn {
  96                         uint32_t        sid;
  97                         uint32_t        cid;
  98                         uint64_t        conn_handle;
  99                         uint32_t        flag;
 100                 } stop_conn;
 101                 struct msg_get_stats {
 102                         uint32_t        sid;
 103                         uint32_t        cid;
 104                 } get_stats;
 105         } u;
 106         union {
 107                 /* messages k -> u */
 108                 int                     retcode;
 109                 struct msg_create_session_ret {
 110                         uint32_t        sid;
 111                         uint32_t        host_no;
 112                 } c_session_ret;
 113                 struct msg_create_conn_ret {
 114                         uint32_t        sid;
 115                         uint32_t        cid;
 116                 } c_conn_ret;
 117                 struct msg_recv_req {
 118                         uint32_t        sid;
 119                         uint32_t        cid;
 120                         uint64_t        recv_handle;
 121                 } recv_req;
 122                 struct msg_conn_error {
 123                         uint32_t        sid;
 124                         uint32_t        cid;
 125                         uint32_t        error; /* enum iscsi_err */
 126                 } connerror;
 127         } r;
 128 } __attribute__ ((aligned (sizeof(uint64_t))));
 129
 130 /*
 131  * Common error codes
 132  */
 133 enum iscsi_err {
 134         ISCSI_OK                        = 0,
 135
 136         ISCSI_ERR_DATASN                = ISCSI_ERR_BASE + 1,
 137         ISCSI_ERR_DATA_OFFSET           = ISCSI_ERR_BASE + 2,
 138         ISCSI_ERR_MAX_CMDSN             = ISCSI_ERR_BASE + 3,
 139         ISCSI_ERR_EXP_CMDSN             = ISCSI_ERR_BASE + 4,
 140         ISCSI_ERR_BAD_OPCODE            = ISCSI_ERR_BASE + 5,
 141         ISCSI_ERR_DATALEN               = ISCSI_ERR_BASE + 6,
 142         ISCSI_ERR_AHSLEN                = ISCSI_ERR_BASE + 7,
 143         ISCSI_ERR_PROTO                 = ISCSI_ERR_BASE + 8,
 144         ISCSI_ERR_LUN                   = ISCSI_ERR_BASE + 9,
 145         ISCSI_ERR_BAD_ITT               = ISCSI_ERR_BASE + 10,
 146         ISCSI_ERR_CONN_FAILED           = ISCSI_ERR_BASE + 11,
 147         ISCSI_ERR_R2TSN                 = ISCSI_ERR_BASE + 12,
 148         ISCSI_ERR_SESSION_FAILED        = ISCSI_ERR_BASE + 13,
 149         ISCSI_ERR_HDR_DGST              = ISCSI_ERR_BASE + 14,
 150         ISCSI_ERR_DATA_DGST             = ISCSI_ERR_BASE + 15,
 151         ISCSI_ERR_PARAM_NOT_FOUND       = ISCSI_ERR_BASE + 16
 152 };
 153
 154 /*
 155  * iSCSI Parameters (RFC3720)
 156  */
 157 enum iscsi_param {
 158         /* passed in using netlink set param */
 159         ISCSI_PARAM_MAX_RECV_DLENGTH,
 160         ISCSI_PARAM_MAX_XMIT_DLENGTH,
 161         ISCSI_PARAM_HDRDGST_EN,
 162         ISCSI_PARAM_DATADGST_EN,
 163         ISCSI_PARAM_INITIAL_R2T_EN,
 164         ISCSI_PARAM_MAX_R2T,
 165         ISCSI_PARAM_IMM_DATA_EN,
 166         ISCSI_PARAM_FIRST_BURST,
 167         ISCSI_PARAM_MAX_BURST,
 168         ISCSI_PARAM_PDU_INORDER_EN,
 169         ISCSI_PARAM_DATASEQ_INORDER_EN,
 170         ISCSI_PARAM_ERL,
 171         ISCSI_PARAM_IFMARKER_EN,
 172         ISCSI_PARAM_OFMARKER_EN,
 173         ISCSI_PARAM_TARGET_NAME,
 174         ISCSI_PARAM_TPGT,
 175         ISCSI_PARAM_PERSISTENT_ADDRESS,
 176         ISCSI_PARAM_PERSISTENT_PORT,
 177         ISCSI_PARAM_SESS_RECOVERY_TMO,
 178
 179         /* pased in through bind conn using transport_fd */
 180         ISCSI_PARAM_CONN_PORT,
 181         ISCSI_PARAM_CONN_ADDRESS,
 182
 183         /* must always be last */
 184         ISCSI_PARAM_MAX,
 185 };
 186
 187 #define ISCSI_MAX_RECV_DLENGTH          (1 << ISCSI_PARAM_MAX_RECV_DLENGTH)
 188 #define ISCSI_MAX_XMIT_DLENGTH          (1 << ISCSI_PARAM_MAX_XMIT_DLENGTH)
 189 #define ISCSI_HDRDGST_EN                (1 << ISCSI_PARAM_HDRDGST_EN)
 190 #define ISCSI_DATADGST_EN               (1 << ISCSI_PARAM_DATADGST_EN)
 191 #define ISCSI_INITIAL_R2T_EN            (1 << ISCSI_PARAM_INITIAL_R2T_EN)
 192 #define ISCSI_MAX_R2T                   (1 << ISCSI_PARAM_MAX_R2T)
 193 #define ISCSI_IMM_DATA_EN               (1 << ISCSI_PARAM_IMM_DATA_EN)
 194 #define ISCSI_FIRST_BURST               (1 << ISCSI_PARAM_FIRST_BURST)
 195 #define ISCSI_MAX_BURST                 (1 << ISCSI_PARAM_MAX_BURST)
 196 #define ISCSI_PDU_INORDER_EN            (1 << ISCSI_PARAM_PDU_INORDER_EN)
 197 #define ISCSI_DATASEQ_INORDER_EN        (1 << ISCSI_PARAM_DATASEQ_INORDER_EN)
 198 #define ISCSI_ERL                       (1 << ISCSI_PARAM_ERL)
 199 #define ISCSI_IFMARKER_EN               (1 << ISCSI_PARAM_IFMARKER_EN)
 200 #define ISCSI_OFMARKER_EN               (1 << ISCSI_PARAM_OFMARKER_EN)
 201 #define ISCSI_TARGET_NAME               (1 << ISCSI_PARAM_TARGET_NAME)
 202 #define ISCSI_TPGT                      (1 << ISCSI_PARAM_TPGT)
 203 #define ISCSI_PERSISTENT_ADDRESS        (1 << ISCSI_PARAM_PERSISTENT_ADDRESS)
 204 #define ISCSI_PERSISTENT_PORT           (1 << ISCSI_PARAM_PERSISTENT_PORT)
 205 #define ISCSI_SESS_RECOVERY_TMO         (1 << ISCSI_PARAM_SESS_RECOVERY_TMO)
 206 #define ISCSI_CONN_PORT                 (1 << ISCSI_PARAM_CONN_PORT)
 207 #define ISCSI_CONN_ADDRESS              (1 << ISCSI_PARAM_CONN_ADDRESS)
 208
 209 #define iscsi_ptr(_handle) ((void*)(unsigned long)_handle)
 210 #define iscsi_handle(_ptr) ((uint64_t)(unsigned long)_ptr)
 211 #define hostdata_session(_hostdata) (iscsi_ptr(*(unsigned long *)_hostdata))
 212
 213 /**
 214  * iscsi_hostdata - get LLD hostdata from scsi_host
 215  * @_hostdata: pointer to scsi host's hostdata
 216  **/
 217 #define iscsi_hostdata(_hostdata) ((void*)_hostdata + sizeof(unsigned long))
 218
 219 /*
 220  * These flags presents iSCSI Data-Path capabilities.
 221  */
 222 #define CAP_RECOVERY_L0         0x1
 223 #define CAP_RECOVERY_L1         0x2
 224 #define CAP_RECOVERY_L2         0x4
 225 #define CAP_MULTI_R2T           0x8
 226 #define CAP_HDRDGST             0x10
 227 #define CAP_DATADGST            0x20
 228 #define CAP_MULTI_CONN          0x40
 229 #define CAP_TEXT_NEGO           0x80
 230 #define CAP_MARKERS             0x100
 231
 232 /*
 233  * These flags describes reason of stop_conn() call
 234  */
 235 #define STOP_CONN_TERM          0x1
 236 #define STOP_CONN_SUSPEND       0x2
 237 #define STOP_CONN_RECOVER       0x3
 238
 239 #define ISCSI_STATS_CUSTOM_MAX          32
 240 #define ISCSI_STATS_CUSTOM_DESC_MAX     64
 241 struct iscsi_stats_custom {
 242         char desc[ISCSI_STATS_CUSTOM_DESC_MAX];
 243         uint64_t value;
 244 };
 245
 246 /*
 247  * struct iscsi_stats - iSCSI Statistics (iSCSI MIB)
 248  *
 249  * Note: this structure contains counters collected on per-connection basis.
 250  */
 251 struct iscsi_stats {
 252         /* octets */
 253         uint64_t txdata_octets;
 254         uint64_t rxdata_octets;
 255
 256         /* xmit pdus */
 257         uint32_t noptx_pdus;
 258         uint32_t scsicmd_pdus;
 259         uint32_t tmfcmd_pdus;
 260         uint32_t login_pdus;
 261         uint32_t text_pdus;
 262         uint32_t dataout_pdus;
 263         uint32_t logout_pdus;
 264         uint32_t snack_pdus;
 265
 266         /* recv pdus */
 267         uint32_t noprx_pdus;
 268         uint32_t scsirsp_pdus;
 269         uint32_t tmfrsp_pdus;
 270         uint32_t textrsp_pdus;
 271         uint32_t datain_pdus;
 272         uint32_t logoutrsp_pdus;
 273         uint32_t r2t_pdus;
 274         uint32_t async_pdus;
 275         uint32_t rjt_pdus;
 276
 277         /* errors */
 278         uint32_t digest_err;
 279         uint32_t timeout_err;
 280
 281         /*
 282          * iSCSI Custom Statistics support, i.e. Transport could
 283          * extend existing MIB statistics with its own specific statistics
 284          * up to ISCSI_STATS_CUSTOM_MAX
 285          */
 286         uint32_t custom_length;
 287         struct iscsi_stats_custom custom[0]
 288                 __attribute__ ((aligned (sizeof(uint64_t))));
 289 };
 290
 291 #endif