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 <scsi/iscsi_proto.h>
  29 #include <scsi/iscsi_if.h>
  30
  31 struct scsi_transport_template;
  32 struct scsi_device;
  33 struct Scsi_Host;
  34 struct scsi_cmnd;
  35 struct socket;
  36 struct iscsi_transport;
  37 struct iscsi_cls_session;
  38 struct iscsi_cls_conn;
  39 struct iscsi_session;
  40 struct iscsi_nopin;
  41
  42 /* #define DEBUG_SCSI */
  43 #ifdef DEBUG_SCSI
  44 #define debug_scsi(fmt...) printk(KERN_INFO "iscsi: " fmt)
  45 #else
  46 #define debug_scsi(fmt...)
  47 #endif
  48
  49 #define ISCSI_XMIT_CMDS_MAX     128     /* must be power of 2 */
  50 #define ISCSI_MGMT_CMDS_MAX     32      /* must be power of 2 */
  51 #define ISCSI_CONN_MAX                  1
  52
  53 #define ISCSI_MGMT_ITT_OFFSET   0xa00
  54
  55 #define ISCSI_DEF_CMD_PER_LUN           32
  56 #define ISCSI_MAX_CMD_PER_LUN           128
  57
  58 /* Task Mgmt states */
  59 #define TMABORT_INITIAL                 0x0
  60 #define TMABORT_SUCCESS                 0x1
  61 #define TMABORT_FAILED                  0x2
  62 #define TMABORT_TIMEDOUT                0x3
  63
  64 /* Connection suspend "bit" */
  65 #define ISCSI_SUSPEND_BIT               1
  66
  67 #define ISCSI_ITT_MASK                  (0xfff)
  68 #define ISCSI_CID_SHIFT                 12
  69 #define ISCSI_CID_MASK                  (0xffff << ISCSI_CID_SHIFT)
  70 #define ISCSI_AGE_SHIFT                 28
  71 #define ISCSI_AGE_MASK                  (0xf << ISCSI_AGE_SHIFT)
  72
  73 struct iscsi_mgmt_task {
  74         /*
  75          * Becuae LLDs allocate their hdr differently, this is a pointer to
  76          * that storage. It must be setup at session creation time.
  77          */
  78         struct iscsi_hdr        *hdr;
  79         char                    *data;          /* mgmt payload */
  80         int                     data_count;     /* counts data to be sent */
  81         uint32_t                itt;            /* this ITT */
  82         void                    *dd_data;       /* driver/transport data */
  83         struct list_head        running;
  84 };
  85
  86 enum {
  87         ISCSI_TASK_COMPLETED,
  88         ISCSI_TASK_PENDING,
  89         ISCSI_TASK_RUNNING,
  90 };
  91
  92 struct iscsi_cmd_task {
  93         /*
  94          * Becuae LLDs allocate their hdr differently, this is a pointer to
  95          * that storage. It must be setup at session creation time.
  96          */
  97         struct iscsi_cmd        *hdr;
  98         int                     itt;            /* this ITT */
  99         int                     datasn;         /* DataSN */
 100
 101         uint32_t                unsol_datasn;
 102         int                     imm_count;      /* imm-data (bytes)   */
 103         int                     unsol_count;    /* unsolicited (bytes)*/
 104         int                     data_count;     /* remaining Data-Out */
 105         struct scsi_cmnd        *sc;            /* associated SCSI cmd*/
 106         int                     total_length;
 107         struct iscsi_conn       *conn;          /* used connection    */
 108         struct iscsi_mgmt_task  *mtask;         /* tmf mtask in progr */
 109
 110         /* state set/tested under session->lock */
 111         int                     state;
 112         struct list_head        running;        /* running cmd list */
 113         void                    *dd_data;       /* driver/transport data */
 114 };
 115
 116 struct iscsi_conn {
 117         struct iscsi_cls_conn   *cls_conn;      /* ptr to class connection */
 118         void                    *dd_data;       /* iscsi_transport data */
 119         struct iscsi_session    *session;       /* parent session */
 120         /*
 121          * LLDs should set this lock. It protects the transport recv
 122          * code
 123          */
 124         rwlock_t                *recv_lock;
 125         /*
 126          * conn_stop() flag: stop to recover, stop to terminate
 127          */
 128         int                     stop_stage;
 129
 130         /* iSCSI connection-wide sequencing */
 131         uint32_t                exp_statsn;
 132
 133         /* control data */
 134         int                     id;             /* CID */
 135         struct list_head        item;           /* maintains list of conns */
 136         int                     c_stage;        /* connection state */
 137         struct iscsi_mgmt_task  *login_mtask;   /* mtask used for login/text */
 138         struct iscsi_mgmt_task  *mtask;         /* xmit mtask in progress */
 139         struct iscsi_cmd_task   *ctask;         /* xmit ctask in progress */
 140
 141         /* xmit */
 142         struct kfifo            *immqueue;      /* immediate xmit queue */
 143         struct kfifo            *mgmtqueue;     /* mgmt (control) xmit queue */
 144         struct list_head        mgmt_run_list;  /* list of control tasks */
 145         struct list_head        xmitqueue;      /* data-path cmd queue */
 146         struct list_head        run_list;       /* list of cmds in progress */
 147         struct work_struct      xmitwork;       /* per-conn. xmit workqueue */
 148         /*
 149          * serializes connection xmit, access to kfifos:
 150          * xmitqueue, immqueue, mgmtqueue
 151          */
 152         struct mutex            xmitmutex;
 153
 154         unsigned long           suspend_tx;     /* suspend Tx */
 155         unsigned long           suspend_rx;     /* suspend Rx */
 156
 157         /* abort */
 158         wait_queue_head_t       ehwait;         /* used in eh_abort() */
 159         struct iscsi_tm         tmhdr;
 160         struct timer_list       tmabort_timer;
 161         int                     tmabort_state;  /* see TMABORT_INITIAL, etc.*/
 162
 163         /* negotiated params */
 164         int                     max_recv_dlength; /* initiator_max_recv_dsl*/
 165         int                     max_xmit_dlength; /* target_max_recv_dsl */
 166         int                     hdrdgst_en;
 167         int                     datadgst_en;
 168         int                     ifmarker_en;
 169         int                     ofmarker_en;
 170         /* values userspace uses to id a conn */
 171         int                     persistent_port;
 172         char                    *persistent_address;
 173
 174         /* MIB-statistics */
 175         uint64_t                txdata_octets;
 176         uint64_t                rxdata_octets;
 177         uint32_t                scsicmd_pdus_cnt;
 178         uint32_t                dataout_pdus_cnt;
 179         uint32_t                scsirsp_pdus_cnt;
 180         uint32_t                datain_pdus_cnt;
 181         uint32_t                r2t_pdus_cnt;
 182         uint32_t                tmfcmd_pdus_cnt;
 183         int32_t                 tmfrsp_pdus_cnt;
 184
 185         /* custom statistics */
 186         uint32_t                eh_abort_cnt;
 187 };
 188
 189 struct iscsi_queue {
 190         struct kfifo            *queue;         /* FIFO Queue */
 191         void                    **pool;         /* Pool of elements */
 192         int                     max;            /* Max number of elements */
 193 };
 194
 195 struct iscsi_session {
 196         /* iSCSI session-wide sequencing */
 197         uint32_t                cmdsn;
 198         uint32_t                exp_cmdsn;
 199         uint32_t                max_cmdsn;
 200
 201         /* configuration */
 202         int                     initial_r2t_en;
 203         int                     max_r2t;
 204         int                     imm_data_en;
 205         int                     first_burst;
 206         int                     max_burst;
 207         int                     time2wait;
 208         int                     time2retain;
 209         int                     pdu_inorder_en;
 210         int                     dataseq_inorder_en;
 211         int                     erl;
 212         int                     tpgt;
 213         char                    *targetname;
 214
 215         /* control data */
 216         struct iscsi_transport  *tt;
 217         struct Scsi_Host        *host;
 218         struct iscsi_conn       *leadconn;      /* leading connection */
 219         spinlock_t              lock;           /* protects session state, *
 220                                                  * sequence numbers,       *
 221                                                  * session resources:      *
 222                                                  * - cmdpool,              *
 223                                                  * - mgmtpool,             *
 224                                                  * - r2tpool               */
 225         int                     state;          /* session state           */
 226         struct list_head        item;
 227         int                     age;            /* counts session re-opens */
 228
 229         struct list_head        connections;    /* list of connections */
 230         int                     cmds_max;       /* size of cmds array */
 231         struct iscsi_cmd_task   **cmds;         /* Original Cmds arr */
 232         struct iscsi_queue      cmdpool;        /* PDU's pool */
 233         int                     mgmtpool_max;   /* size of mgmt array */
 234         struct iscsi_mgmt_task  **mgmt_cmds;    /* Original mgmt arr */
 235         struct iscsi_queue      mgmtpool;       /* Mgmt PDU's pool */
 236 };
 237
 238 /*
 239  * scsi host template
 240  */
 241 extern int iscsi_change_queue_depth(struct scsi_device *sdev, int depth);
 242 extern int iscsi_eh_abort(struct scsi_cmnd *sc);
 243 extern int iscsi_eh_host_reset(struct scsi_cmnd *sc);
 244 extern int iscsi_queuecommand(struct scsi_cmnd *sc,
 245                               void (*done)(struct scsi_cmnd *));
 246
 247 /*
 248  * session management
 249  */
 250 extern struct iscsi_cls_session *
 251 iscsi_session_setup(struct iscsi_transport *, struct scsi_transport_template *,
 252                     int, int, uint32_t, uint32_t *);
 253 extern void iscsi_session_teardown(struct iscsi_cls_session *);
 254 extern struct iscsi_session *class_to_transport_session(struct iscsi_cls_session *);
 255 extern void iscsi_session_recovery_timedout(struct iscsi_cls_session *);
 256 extern int iscsi_set_param(struct iscsi_cls_conn *cls_conn,
 257                            enum iscsi_param param, char *buf, int buflen);
 258 extern int iscsi_session_get_param(struct iscsi_cls_session *cls_session,
 259                                    enum iscsi_param param, char *buf);
 260
 261 #define session_to_cls(_sess) \
 262         hostdata_session(_sess->host->hostdata)
 263
 264 /*
 265  * connection management
 266  */
 267 extern struct iscsi_cls_conn *iscsi_conn_setup(struct iscsi_cls_session *,
 268                                                uint32_t);
 269 extern void iscsi_conn_teardown(struct iscsi_cls_conn *);
 270 extern int iscsi_conn_start(struct iscsi_cls_conn *);
 271 extern void iscsi_conn_stop(struct iscsi_cls_conn *, int);
 272 extern int iscsi_conn_bind(struct iscsi_cls_session *, struct iscsi_cls_conn *,
 273                            int);
 274 extern void iscsi_conn_failure(struct iscsi_conn *conn, enum iscsi_err err);
 275 extern int iscsi_conn_get_param(struct iscsi_cls_conn *cls_conn,
 276                                 enum iscsi_param param, char *buf);
 277
 278 /*
 279  * pdu and task processing
 280  */
 281 extern int iscsi_check_assign_cmdsn(struct iscsi_session *,
 282                                     struct iscsi_nopin *);
 283 extern void iscsi_prep_unsolicit_data_pdu(struct iscsi_cmd_task *,
 284                                         struct iscsi_data *hdr,
 285                                         int transport_data_cnt);
 286 extern int iscsi_conn_send_pdu(struct iscsi_cls_conn *, struct iscsi_hdr *,
 287                                 char *, uint32_t);
 288 extern int iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *,
 289                               char *, int);
 290 extern int __iscsi_complete_pdu(struct iscsi_conn *, struct iscsi_hdr *,
 291                                 char *, int);
 292 extern int iscsi_verify_itt(struct iscsi_conn *, struct iscsi_hdr *,
 293                             uint32_t *);
 294
 295 /*
 296  * generic helpers
 297  */
 298 extern void iscsi_pool_free(struct iscsi_queue *, void **);
 299 extern int iscsi_pool_init(struct iscsi_queue *, int, void ***, int);
 300
 301 #endif