include/scsi/libiscsi.h

   1 /*
   2  * iSCSI lib definitions
   3  *
   4  * Copyright (C) 2006 Red Hat, Inc.  All rights reserved.
   5  * Copyright (C) 2004 - 2006 Mike Christie
   6  * Copyright (C) 2004 - 2005 Dmitry Yusupov
   7  * Copyright (C) 2004 - 2005 Alex Aizman
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  22  */
  23 #ifndef LIBISCSI_H
  24 #define LIBISCSI_H
  25
  26 #include <linux/types.h>
  27 #include <linux/mutex.h>
  28 #include <linux/timer.h>
  29 #include <linux/workqueue.h>
  30 #include <scsi/iscsi_proto.h>
  31 #include <scsi/iscsi_if.h>
  32
  33 struct scsi_transport_template;
  34 struct scsi_device;
  35 struct Scsi_Host;
  36 struct scsi_cmnd;
  37 struct socket;
  38 struct iscsi_transport;
  39 struct iscsi_cls_session;
  40 struct iscsi_cls_conn;
  41 struct iscsi_session;
  42 struct iscsi_nopin;
  43
  44 /* #define DEBUG_SCSI */
  45 #ifdef DEBUG_SCSI
  46 #define debug_scsi(fmt...) printk(KERN_INFO "iscsi: " fmt)
  47 #else
  48 #define debug_scsi(fmt...)
  49 #endif
  50
  51 #define ISCSI_XMIT_CMDS_MAX     128     /* must be power of 2 */
  52 #define ISCSI_MGMT_CMDS_MAX     32      /* must be power of 2 */
  53 #define ISCSI_CONN_MAX                  1
  54
  55 #define ISCSI_MGMT_ITT_OFFSET   0xa00
  56
  57 #define ISCSI_DEF_CMD_PER_LUN           32
  58 #define ISCSI_MAX_CMD_PER_LUN           128
  59
  60 /* Task Mgmt states */
  61 #define TMABORT_INITIAL                 0x0
  62 #define TMABORT_SUCCESS                 0x1
  63 #define TMABORT_FAILED                  0x2
  64 #define TMABORT_TIMEDOUT                0x3
  65 #define TMABORT_NOT_FOUND               0x4
  66
  67 /* Connection suspend "bit" */
  68 #define ISCSI_SUSPEND_BIT               1
  69
  70 #define ISCSI_ITT_MASK                  (0xfff)
  71 #define ISCSI_CID_SHIFT                 12
  72 #define ISCSI_CID_MASK                  (0xffff << ISCSI_CID_SHIFT)
  73 #define ISCSI_AGE_SHIFT                 28
  74 #define ISCSI_AGE_MASK                  (0xf << ISCSI_AGE_SHIFT)
  75
  76 struct iscsi_mgmt_task {
  77         /*
  78          * Becuae LLDs allocate their hdr differently, this is a pointer to
  79          * that storage. It must be setup at session creation time.
  80          */
  81         struct iscsi_hdr        *hdr;
  82         char                    *data;          /* mgmt payload */
  83         unsigned                data_count;     /* counts data to be sent */
  84         uint32_t                itt;            /* this ITT */
  85         void                    *dd_data;       /* driver/transport data */
  86         struct list_head        running;
  87 };
  88
  89 enum {
  90         ISCSI_TASK_COMPLETED,
  91         ISCSI_TASK_PENDING,
  92         ISCSI_TASK_RUNNING,
  93         ISCSI_TASK_ABORTING,
  94 };
  95
  96 struct iscsi_cmd_task {
  97         /*
  98          * Becuae LLDs allocate their hdr differently, this is a pointer to
  99          * that storage. It must be setup at session creation time.
 100          */
 101         struct iscsi_cmd        *hdr;
 102         int                     itt;            /* this ITT */
 103
 104         uint32_t                unsol_datasn;
 105         unsigned                imm_count;      /* imm-data (bytes)   */
 106         unsigned                unsol_count;    /* unsolicited (bytes)*/
 107         /* offset in unsolicited stream (bytes); */
 108         unsigned                unsol_offset;
 109         unsigned                data_count;     /* remaining Data-Out */
 110         struct scsi_cmnd        *sc;            /* associated SCSI cmd*/
 111         struct iscsi_conn       *conn;          /* used connection    */
 112         struct iscsi_mgmt_task  *mtask;         /* tmf mtask in progr */
 113
 114         /* state set/tested under session->lock */
 115         int                     state;
 116         atomic_t                refcount;
 117         struct list_head        running;        /* running cmd list */
 118         void                    *dd_data;       /* driver/transport data */
 119 };
 120
 121 struct iscsi_conn {
 122         struct iscsi_cls_conn   *cls_conn;      /* ptr to class connection */
 123         void                    *dd_data;       /* iscsi_transport data */
 124         struct iscsi_session    *session;       /* parent session */
 125         /*
 126          * LLDs should set this lock. It protects the transport recv
 127          * code
 128          */
 129         rwlock_t                *recv_lock;
 130         /*
 131          * conn_stop() flag: stop to recover, stop to terminate
 132          */
 133         int                     stop_stage;
 134
 135         /* iSCSI connection-wide sequencing */
 136         uint32_t                exp_statsn;
 137
 138         /* control data */
 139         int                     id;             /* CID */
 140         int                     c_stage;        /* connection state */
 141         /*
 142          * Preallocated buffer for pdus that have data but do not
 143          * originate from scsi-ml. We never have two pdus using the
 144          * buffer at the same time. It is only allocated to
 145          * the default max recv size because the pdus we support
 146          * should always fit in this buffer
 147          */
 148         char                    *data;
 149         struct iscsi_mgmt_task  *login_mtask;   /* mtask used for login/text */
 150         struct iscsi_mgmt_task  *mtask;         /* xmit mtask in progress */
 151         struct iscsi_cmd_task   *ctask;         /* xmit ctask in progress */
 152
 153         /* xmit */
 154         struct kfifo            *mgmtqueue;     /* mgmt (control) xmit queue */
 155         struct list_head        mgmt_run_list;  /* list of control tasks */
 156         struct list_head        xmitqueue;      /* data-path cmd queue */
 157         struct list_head        run_list;       /* list of cmds in progress */
 158         struct work_struct      xmitwork;       /* per-conn. xmit workqueue */
 159         unsigned long           suspend_tx;     /* suspend Tx */
 160         unsigned long           suspend_rx;     /* suspend Rx */
 161
 162         /* abort */
 163         wait_queue_head_t       ehwait;         /* used in eh_abort() */
 164         struct iscsi_tm         tmhdr;
 165         struct timer_list       tmabort_timer;
 166         int                     tmabort_state;  /* see TMABORT_INITIAL, etc.*/
 167
 168         /* negotiated params */
 169         unsigned                max_recv_dlength; /* initiator_max_recv_dsl*/
 170         unsigned                max_xmit_dlength; /* target_max_recv_dsl */
 171         int                     hdrdgst_en;
 172         int                     datadgst_en;
 173         int                     ifmarker_en;
 174         int                     ofmarker_en;
 175         /* values userspace uses to id a conn */
 176         int                     persistent_port;
 177         char                    *persistent_address;
 178
 179         /* MIB-statistics */
 180         uint64_t                txdata_octets;
 181         uint64_t                rxdata_octets;
 182         uint32_t                scsicmd_pdus_cnt;
 183         uint32_t                dataout_pdus_cnt;
 184         uint32_t                scsirsp_pdus_cnt;
 185         uint32_t                datain_pdus_cnt;
 186         uint32_t                r2t_pdus_cnt;
 187         uint32_t                tmfcmd_pdus_cnt;
 188         int32_t                 tmfrsp_pdus_cnt;
 189
 190         /* custom statistics */
 191         uint32_t                eh_abort_cnt;
 192 };
 193
 194 struct iscsi_queue {
 195         struct kfifo            *queue;         /* FIFO Queue */
 196         void                    **pool;         /* Pool of elements */
 197         int                     max;            /* Max number of elements */
 198 };
 199
 200 struct iscsi_session {
 201         /* iSCSI session-wide sequencing */
 202         uint32_t                cmdsn;
 203         uint32_t                exp_cmdsn;
 204         uint32_t                max_cmdsn;
 205
 206         /* configuration */
 207         int                     initial_r2t_en;
 208         unsigned                max_r2t;
 209         int                     imm_data_en;
 210         unsigned                first_burst;
 211         unsigned                max_burst;
 212         int                     time2wait;
 213         int                     time2retain;
 214         int                     pdu_inorder_en;
 215         int                     dataseq_inorder_en;
 216         int                     erl;
 217         int                     tpgt;
 218         char                    *username;
 219         char                    *username_in;
 220         char                    *password;
 221         char                    *password_in;
 222         char                    *targetname;
 223         char                    *initiatorname;
 224         /* hw address being used for iscsi connection */
 225         char                    *hwaddress;
 226         /* control data */
 227         struct iscsi_transport  *tt;
 228         struct Scsi_Host        *host;
 229         struct iscsi_conn       *leadconn;      /* leading connection */
 230         spinlock_t              lock;           /* protects session state, *
 231                                                  * sequence numbers,       *
 232                                                  * session resources:      *
 233                                                  * - cmdpool,              *
 234                                                  * - mgmtpool,             *
 235                                                  * - r2tpool               */
 236         int                     state;          /* session state           */
 237         int                     age;            /* counts session re-opens */
 238
 239         int                     cmds_max;       /* size of cmds array */
 240         struct iscsi_cmd_task   **cmds;         /* Original Cmds arr */
 241         struct iscsi_queue      cmdpool;        /* PDU's pool */
 242         int                     mgmtpool_max;   /* size of mgmt array */
 243         struct iscsi_mgmt_task  **mgmt_cmds;    /* Original mgmt arr */
 244         struct iscsi_queue      mgmtpool;       /* Mgmt PDU's pool */
 245 };
 246
 247 /*
 248  * scsi host template
 249  */
 250 extern int iscsi_change_queue_depth(struct scsi_device *sdev, int depth);
 251 extern int iscsi_eh_abort(struct scsi_cmnd *sc);
 252 extern int iscsi_eh_host_reset(struct scsi_cmnd *sc);
 253 extern int iscsi_queuecommand(struct scsi_cmnd *sc,
 254                               void (*done)(struct scsi_cmnd *));
 255
 256
 257 /*
 258  * iSCSI host helpers.
 259  */
 260 extern int iscsi_host_set_param(struct Scsi_Host *shost,
 261                                 enum iscsi_host_param param, char *buf,
 262                                 int buflen);
 263 extern int iscsi_host_get_param(struct Scsi_Host *shost,
 264                                 enum iscsi_host_param param, char *buf);
 265
 266 /*
 267  * session management
 268  */
 269 extern struct iscsi_cls_session *
 270 iscsi_session_setup(struct iscsi_transport *, struct scsi_transport_template *,
 271                     int, int, uint32_t, uint32_t *);
 272 extern void iscsi_session_teardown(struct iscsi_cls_session *);
 273 extern struct iscsi_session *class_to_transport_session(struct iscsi_cls_session *);
 274 extern void iscsi_session_recovery_timedout(struct iscsi_cls_session *);
 275 extern int iscsi_set_param(struct iscsi_cls_conn *cls_conn,
 276                            enum iscsi_param param, char *buf, int buflen);
 277 extern int iscsi_session_get_param(struct iscsi_cls_session *cls_session,
 278                                    enum iscsi_param param, char *buf);
 279
 280 #define session_to_cls(_sess) \
 281         hostdata_session(_sess->host->hostdata)
 282
 283 /*
 284  * connection management
 285  */
 286 extern struct iscsi_cls_conn *iscsi_conn_setup(struct iscsi_cls_session *,
 287                                                uint32_t);
 288 extern void iscsi_conn_teardown(struct iscsi_cls_conn *);
 289 extern int iscsi_conn_start(struct iscsi_cls_conn *);
 290 extern void iscsi_conn_stop(struct iscsi_cls_conn *, int);
 291 extern int iscsi_conn_bind(struct iscsi_cls_session *, struct iscsi_cls_conn *,
 292                            int);
 293 extern void iscsi_conn_failure(struct iscsi_conn *conn, enum iscsi_err err);
 294 extern int iscsi_conn_get_param(struct iscsi_cls_conn *cls_conn,
 295                                 enum iscsi_param param, char *buf);
 296
 297 /*
 298  * pdu and task processing
 299  */
 300 extern void iscsi_update_cmdsn(struct iscsi_session *, struct iscsi_nopin *);
 301 extern void iscsi_prep_unsolicit_data_pdu(struct iscsi_cmd_task *,
 302                                         struct iscsi_data *hdr);
 303 extern int iscsi_conn_send_pdu(struct iscsi_cls_conn *, struct iscsi_hdr *,
 304                                 char *, uint32_t);
 305 extern int iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *,
 306                               char *, int);
 307 extern int __iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *,
 308                                 char *, int);
 309 extern int iscsi_verify_itt(struct iscsi_conn *, struct iscsi_hdr *,
 310                             uint32_t *);
 311
 312 /*
 313  * generic helpers
 314  */
 315 extern void iscsi_pool_free(struct iscsi_queue *, void **);
 316 extern int iscsi_pool_init(struct iscsi_queue *, int, void ***, int);
 317
 318 #endif