include/scsi/scsi_transport_iscsi.h

   1 /*
   2  * iSCSI transport class definitions
   3  *
   4  * Copyright (C) IBM Corporation, 2004
   5  * Copyright (C) Mike Christie, 2004 - 2006
   6  * Copyright (C) Dmitry Yusupov, 2004 - 2005
   7  * Copyright (C) Alex Aizman, 2004 - 2005
   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 SCSI_TRANSPORT_ISCSI_H
  24 #define SCSI_TRANSPORT_ISCSI_H
  25
  26 #include <linux/device.h>
  27 #include <linux/list.h>
  28 #include <linux/mutex.h>
  29 #include <scsi/iscsi_if.h>
  30
  31 struct scsi_transport_template;
  32 struct iscsi_transport;
  33 struct iscsi_endpoint;
  34 struct Scsi_Host;
  35 struct scsi_cmnd;
  36 struct iscsi_cls_conn;
  37 struct iscsi_conn;
  38 struct iscsi_task;
  39 struct sockaddr;
  40 struct iscsi_iface;
  41 struct bsg_job;
  42 struct iscsi_bus_flash_session;
  43 struct iscsi_bus_flash_conn;
  44
  45 /**
  46  * struct iscsi_transport - iSCSI Transport template
  47  *
  48  * @name:               transport name
  49  * @caps:               iSCSI Data-Path capabilities
  50  * @create_session:     create new iSCSI session object
  51  * @destroy_session:    destroy existing iSCSI session object
  52  * @create_conn:        create new iSCSI connection
  53  * @bind_conn:          associate this connection with existing iSCSI session
  54  *                      and specified transport descriptor
  55  * @destroy_conn:       destroy inactive iSCSI connection
  56  * @set_param:          set iSCSI parameter. Return 0 on success, -ENODATA
  57  *                      when param is not supported, and a -Exx value on other
  58  *                      error.
  59  * @get_param           get iSCSI parameter. Must return number of bytes
  60  *                      copied to buffer on success, -ENODATA when param
  61  *                      is not supported, and a -Exx value on other error
  62  * @start_conn:         set connection to be operational
  63  * @stop_conn:          suspend/recover/terminate connection
  64  * @send_pdu:           send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text.
  65  * @session_recovery_timedout: notify LLD a block during recovery timed out
  66  * @init_task:          Initialize a iscsi_task and any internal structs.
  67  *                      When offloading the data path, this is called from
  68  *                      queuecommand with the session lock, or from the
  69  *                      iscsi_conn_send_pdu context with the session lock.
  70  *                      When not offloading the data path, this is called
  71  *                      from the scsi work queue without the session lock.
  72  * @xmit_task           Requests LLD to transfer cmd task. Returns 0 or the
  73  *                      the number of bytes transferred on success, and -Exyz
  74  *                      value on error. When offloading the data path, this
  75  *                      is called from queuecommand with the session lock, or
  76  *                      from the iscsi_conn_send_pdu context with the session
  77  *                      lock. When not offloading the data path, this is called
  78  *                      from the scsi work queue without the session lock.
  79  * @cleanup_task:       requests LLD to fail task. Called with session lock
  80  *                      and after the connection has been suspended and
  81  *                      terminated during recovery. If called
  82  *                      from abort task then connection is not suspended
  83  *                      or terminated but sk_callback_lock is held
  84  *
  85  * Template API provided by iSCSI Transport
  86  */
  87 struct iscsi_transport {
  88         struct module *owner;
  89         char *name;
  90         unsigned int caps;
  91
  92         struct iscsi_cls_session *(*create_session) (struct iscsi_endpoint *ep,
  93                                         uint16_t cmds_max, uint16_t qdepth,
  94                                         uint32_t sn);
  95         void (*destroy_session) (struct iscsi_cls_session *session);
  96         struct iscsi_cls_conn *(*create_conn) (struct iscsi_cls_session *sess,
  97                                 uint32_t cid);
  98         int (*bind_conn) (struct iscsi_cls_session *session,
  99                           struct iscsi_cls_conn *cls_conn,
 100                           uint64_t transport_eph, int is_leading);
 101         int (*start_conn) (struct iscsi_cls_conn *conn);
 102         void (*stop_conn) (struct iscsi_cls_conn *conn, int flag);
 103         void (*destroy_conn) (struct iscsi_cls_conn *conn);
 104         int (*set_param) (struct iscsi_cls_conn *conn, enum iscsi_param param,
 105                           char *buf, int buflen);
 106         int (*get_ep_param) (struct iscsi_endpoint *ep, enum iscsi_param param,
 107                              char *buf);
 108         int (*get_conn_param) (struct iscsi_cls_conn *conn,
 109                                enum iscsi_param param, char *buf);
 110         int (*get_session_param) (struct iscsi_cls_session *session,
 111                                   enum iscsi_param param, char *buf);
 112         int (*get_host_param) (struct Scsi_Host *shost,
 113                                 enum iscsi_host_param param, char *buf);
 114         int (*set_host_param) (struct Scsi_Host *shost,
 115                                enum iscsi_host_param param, char *buf,
 116                                int buflen);
 117         int (*send_pdu) (struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
 118                          char *data, uint32_t data_size);
 119         void (*get_stats) (struct iscsi_cls_conn *conn,
 120                            struct iscsi_stats *stats);
 121
 122         int (*init_task) (struct iscsi_task *task);
 123         int (*xmit_task) (struct iscsi_task *task);
 124         void (*cleanup_task) (struct iscsi_task *task);
 125
 126         int (*alloc_pdu) (struct iscsi_task *task, uint8_t opcode);
 127         int (*xmit_pdu) (struct iscsi_task *task);
 128         int (*init_pdu) (struct iscsi_task *task, unsigned int offset,
 129                          unsigned int count);
 130         void (*parse_pdu_itt) (struct iscsi_conn *conn, itt_t itt,
 131                                int *index, int *age);
 132
 133         void (*session_recovery_timedout) (struct iscsi_cls_session *session);
 134         struct iscsi_endpoint *(*ep_connect) (struct Scsi_Host *shost,
 135                                               struct sockaddr *dst_addr,
 136                                               int non_blocking);
 137         int (*ep_poll) (struct iscsi_endpoint *ep, int timeout_ms);
 138         void (*ep_disconnect) (struct iscsi_endpoint *ep);
 139         int (*tgt_dscvr) (struct Scsi_Host *shost, enum iscsi_tgt_dscvr type,
 140                           uint32_t enable, struct sockaddr *dst_addr);
 141         int (*set_path) (struct Scsi_Host *shost, struct iscsi_path *params);
 142         int (*set_iface_param) (struct Scsi_Host *shost, void *data,
 143                                 uint32_t len);
 144         int (*get_iface_param) (struct iscsi_iface *iface,
 145                                 enum iscsi_param_type param_type,
 146                                 int param, char *buf);
 147         umode_t (*attr_is_visible)(int param_type, int param);
 148         int (*bsg_request)(struct bsg_job *job);
 149         int (*send_ping) (struct Scsi_Host *shost, uint32_t iface_num,
 150                           uint32_t iface_type, uint32_t payload_size,
 151                           uint32_t pid, struct sockaddr *dst_addr);
 152         int (*get_chap) (struct Scsi_Host *shost, uint16_t chap_tbl_idx,
 153                          uint32_t *num_entries, char *buf);
 154         int (*delete_chap) (struct Scsi_Host *shost, uint16_t chap_tbl_idx);
 155         int (*set_chap) (struct Scsi_Host *shost, void *data, int len);
 156         int (*get_flashnode_param) (struct iscsi_bus_flash_session *fnode_sess,
 157                                     int param, char *buf);
 158         int (*set_flashnode_param) (struct iscsi_bus_flash_session *fnode_sess,
 159                                     struct iscsi_bus_flash_conn *fnode_conn,
 160                                     void *data, int len);
 161         int (*new_flashnode) (struct Scsi_Host *shost, const char *buf,
 162                               int len);
 163         int (*del_flashnode) (struct iscsi_bus_flash_session *fnode_sess);
 164         int (*login_flashnode) (struct iscsi_bus_flash_session *fnode_sess,
 165                                 struct iscsi_bus_flash_conn *fnode_conn);
 166         int (*logout_flashnode) (struct iscsi_bus_flash_session *fnode_sess,
 167                                  struct iscsi_bus_flash_conn *fnode_conn);
 168         int (*logout_flashnode_sid) (struct iscsi_cls_session *cls_sess);
 169         int (*get_host_stats) (struct Scsi_Host *shost, char *buf, int len);
 170 };
 171
 172 /*
 173  * transport registration upcalls
 174  */
 175 extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt);
 176 extern int iscsi_unregister_transport(struct iscsi_transport *tt);
 177
 178 /*
 179  * control plane upcalls
 180  */
 181 extern void iscsi_conn_error_event(struct iscsi_cls_conn *conn,
 182                                    enum iscsi_err error);
 183 extern void iscsi_conn_login_event(struct iscsi_cls_conn *conn,
 184                                    enum iscsi_conn_state state);
 185 extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
 186                           char *data, uint32_t data_size);
 187
 188 extern int iscsi_offload_mesg(struct Scsi_Host *shost,
 189                               struct iscsi_transport *transport, uint32_t type,
 190                               char *data, uint16_t data_size);
 191
 192 extern void iscsi_post_host_event(uint32_t host_no,
 193                                   struct iscsi_transport *transport,
 194                                   enum iscsi_host_event_code code,
 195                                   uint32_t data_size,
 196                                   uint8_t *data);
 197
 198 extern void iscsi_ping_comp_event(uint32_t host_no,
 199                                   struct iscsi_transport *transport,
 200                                   uint32_t status, uint32_t pid,
 201                                   uint32_t data_size, uint8_t *data);
 202
 203 struct iscsi_cls_conn {
 204         struct list_head conn_list;     /* item in connlist */
 205         void *dd_data;                  /* LLD private data */
 206         struct iscsi_transport *transport;
 207         uint32_t cid;                   /* connection id */
 208         struct mutex ep_mutex;
 209         struct iscsi_endpoint *ep;
 210
 211         struct device dev;              /* sysfs transport/container device */
 212 };
 213
 214 #define iscsi_dev_to_conn(_dev) \
 215         container_of(_dev, struct iscsi_cls_conn, dev)
 216
 217 #define transport_class_to_conn(_cdev) \
 218         iscsi_dev_to_conn(_cdev->parent)
 219
 220 #define iscsi_conn_to_session(_conn) \
 221         iscsi_dev_to_session(_conn->dev.parent)
 222
 223 /* iscsi class session state */
 224 enum {
 225         ISCSI_SESSION_LOGGED_IN,
 226         ISCSI_SESSION_FAILED,
 227         ISCSI_SESSION_FREE,
 228 };
 229
 230 #define ISCSI_MAX_TARGET -1
 231
 232 struct iscsi_cls_session {
 233         struct list_head sess_list;             /* item in session_list */
 234         struct iscsi_transport *transport;
 235         spinlock_t lock;
 236         struct work_struct block_work;
 237         struct work_struct unblock_work;
 238         struct work_struct scan_work;
 239         struct work_struct unbind_work;
 240
 241         /* recovery fields */
 242         int recovery_tmo;
 243         struct delayed_work recovery_work;
 244
 245         unsigned int target_id;
 246         bool ida_used;
 247
 248         /*
 249          * pid of userspace process that created session or -1 if
 250          * created by the kernel.
 251          */
 252         pid_t creator;
 253         int state;
 254         int sid;                                /* session id */
 255         void *dd_data;                          /* LLD private data */
 256         struct device dev;      /* sysfs transport/container device */
 257 };
 258
 259 #define iscsi_dev_to_session(_dev) \
 260         container_of(_dev, struct iscsi_cls_session, dev)
 261
 262 #define transport_class_to_session(_cdev) \
 263         iscsi_dev_to_session(_cdev->parent)
 264
 265 #define iscsi_session_to_shost(_session) \
 266         dev_to_shost(_session->dev.parent)
 267
 268 #define starget_to_session(_stgt) \
 269         iscsi_dev_to_session(_stgt->dev.parent)
 270
 271 struct iscsi_cls_host {
 272         atomic_t nr_scans;
 273         struct mutex mutex;
 274         struct request_queue *bsg_q;
 275         uint32_t port_speed;
 276         uint32_t port_state;
 277 };
 278
 279 #define iscsi_job_to_shost(_job) \
 280         dev_to_shost(_job->dev)
 281
 282 extern void iscsi_host_for_each_session(struct Scsi_Host *shost,
 283                                 void (*fn)(struct iscsi_cls_session *));
 284
 285 struct iscsi_endpoint {
 286         void *dd_data;                  /* LLD private data */
 287         struct device dev;
 288         uint64_t id;
 289         struct iscsi_cls_conn *conn;
 290 };
 291
 292 struct iscsi_iface {
 293         struct device dev;
 294         struct iscsi_transport *transport;
 295         uint32_t iface_type;    /* IPv4 or IPv6 */
 296         uint32_t iface_num;     /* iface number, 0 - n */
 297         void *dd_data;          /* LLD private data */
 298 };
 299
 300 #define iscsi_dev_to_iface(_dev) \
 301         container_of(_dev, struct iscsi_iface, dev)
 302
 303 #define iscsi_iface_to_shost(_iface) \
 304         dev_to_shost(_iface->dev.parent)
 305
 306
 307 struct iscsi_bus_flash_conn {
 308         struct list_head conn_list;     /* item in connlist */
 309         void *dd_data;                  /* LLD private data */
 310         struct iscsi_transport *transport;
 311         struct device dev;              /* sysfs transport/container device */
 312         /* iscsi connection parameters */
 313         uint32_t                exp_statsn;
 314         uint32_t                statsn;
 315         unsigned                max_recv_dlength; /* initiator_max_recv_dsl*/
 316         unsigned                max_xmit_dlength; /* target_max_recv_dsl */
 317         unsigned                max_segment_size;
 318         unsigned                tcp_xmit_wsf;
 319         unsigned                tcp_recv_wsf;
 320         int                     hdrdgst_en;
 321         int                     datadgst_en;
 322         int                     port;
 323         char                    *ipaddress;
 324         char                    *link_local_ipv6_addr;
 325         char                    *redirect_ipaddr;
 326         uint16_t                keepalive_timeout;
 327         uint16_t                local_port;
 328         uint8_t                 snack_req_en;
 329         /* tcp timestamp negotiation status */
 330         uint8_t                 tcp_timestamp_stat;
 331         uint8_t                 tcp_nagle_disable;
 332         /* tcp window scale factor */
 333         uint8_t                 tcp_wsf_disable;
 334         uint8_t                 tcp_timer_scale;
 335         uint8_t                 tcp_timestamp_en;
 336         uint8_t                 ipv4_tos;
 337         uint8_t                 ipv6_traffic_class;
 338         uint8_t                 ipv6_flow_label;
 339         uint8_t                 fragment_disable;
 340         /* Link local IPv6 address is assigned by firmware or driver */
 341         uint8_t                 is_fw_assigned_ipv6;
 342 };
 343
 344 #define iscsi_dev_to_flash_conn(_dev) \
 345         container_of(_dev, struct iscsi_bus_flash_conn, dev)
 346
 347 #define iscsi_flash_conn_to_flash_session(_conn) \
 348         iscsi_dev_to_flash_session(_conn->dev.parent)
 349
 350 #define ISID_SIZE 6
 351
 352 struct iscsi_bus_flash_session {
 353         struct list_head sess_list;             /* item in session_list */
 354         struct iscsi_transport *transport;
 355         unsigned int target_id;
 356         int flash_state;        /* persistent or non-persistent */
 357         void *dd_data;                          /* LLD private data */
 358         struct device dev;      /* sysfs transport/container device */
 359         /* iscsi session parameters */
 360         unsigned                first_burst;
 361         unsigned                max_burst;
 362         unsigned short          max_r2t;
 363         int                     default_taskmgmt_timeout;
 364         int                     initial_r2t_en;
 365         int                     imm_data_en;
 366         int                     time2wait;
 367         int                     time2retain;
 368         int                     pdu_inorder_en;
 369         int                     dataseq_inorder_en;
 370         int                     erl;
 371         int                     tpgt;
 372         char                    *username;
 373         char                    *username_in;
 374         char                    *password;
 375         char                    *password_in;
 376         char                    *targetname;
 377         char                    *targetalias;
 378         char                    *portal_type;
 379         uint16_t                tsid;
 380         uint16_t                chap_in_idx;
 381         uint16_t                chap_out_idx;
 382         /* index of iSCSI discovery session if the entry is
 383          * discovered by iSCSI discovery session
 384          */
 385         uint16_t                discovery_parent_idx;
 386         /* indicates if discovery was done through iSNS discovery service
 387          * or through sendTarget */
 388         uint16_t                discovery_parent_type;
 389         /* Firmware auto sendtarget discovery disable */
 390         uint8_t                 auto_snd_tgt_disable;
 391         uint8_t                 discovery_sess;
 392         /* indicates if this flashnode entry is enabled or disabled */
 393         uint8_t                 entry_state;
 394         uint8_t                 chap_auth_en;
 395         /* enables firmware to auto logout the discovery session on discovery
 396          * completion
 397          */
 398         uint8_t                 discovery_logout_en;
 399         uint8_t                 bidi_chap_en;
 400         /* makes authentication for discovery session optional */
 401         uint8_t                 discovery_auth_optional;
 402         uint8_t                 isid[ISID_SIZE];
 403         uint8_t                 is_boot_target;
 404 };
 405
 406 #define iscsi_dev_to_flash_session(_dev) \
 407         container_of(_dev, struct iscsi_bus_flash_session, dev)
 408
 409 #define iscsi_flash_session_to_shost(_session) \
 410         dev_to_shost(_session->dev.parent)
 411
 412 /*
 413  * session and connection functions that can be used by HW iSCSI LLDs
 414  */
 415 #define iscsi_cls_session_printk(prefix, _cls_session, fmt, a...) \
 416         dev_printk(prefix, &(_cls_session)->dev, fmt, ##a)
 417
 418 #define iscsi_cls_conn_printk(prefix, _cls_conn, fmt, a...) \
 419         dev_printk(prefix, &(_cls_conn)->dev, fmt, ##a)
 420
 421 extern int iscsi_session_chkready(struct iscsi_cls_session *session);
 422 extern int iscsi_is_session_online(struct iscsi_cls_session *session);
 423 extern struct iscsi_cls_session *iscsi_alloc_session(struct Scsi_Host *shost,
 424                                 struct iscsi_transport *transport, int dd_size);
 425 extern int iscsi_add_session(struct iscsi_cls_session *session,
 426                              unsigned int target_id);
 427 extern int iscsi_session_event(struct iscsi_cls_session *session,
 428                                enum iscsi_uevent_e event);
 429 extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost,
 430                                                 struct iscsi_transport *t,
 431                                                 int dd_size,
 432                                                 unsigned int target_id);
 433 extern void iscsi_remove_session(struct iscsi_cls_session *session);
 434 extern void iscsi_free_session(struct iscsi_cls_session *session);
 435 extern int iscsi_destroy_session(struct iscsi_cls_session *session);
 436 extern struct iscsi_cls_conn *iscsi_create_conn(struct iscsi_cls_session *sess,
 437                                                 int dd_size, uint32_t cid);
 438 extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn);
 439 extern void iscsi_unblock_session(struct iscsi_cls_session *session);
 440 extern void iscsi_block_session(struct iscsi_cls_session *session);
 441 extern int iscsi_scan_finished(struct Scsi_Host *shost, unsigned long time);
 442 extern struct iscsi_endpoint *iscsi_create_endpoint(int dd_size);
 443 extern void iscsi_destroy_endpoint(struct iscsi_endpoint *ep);
 444 extern struct iscsi_endpoint *iscsi_lookup_endpoint(u64 handle);
 445 extern int iscsi_block_scsi_eh(struct scsi_cmnd *cmd);
 446 extern struct iscsi_iface *iscsi_create_iface(struct Scsi_Host *shost,
 447                                               struct iscsi_transport *t,
 448                                               uint32_t iface_type,
 449                                               uint32_t iface_num, int dd_size);
 450 extern void iscsi_destroy_iface(struct iscsi_iface *iface);
 451 extern struct iscsi_iface *iscsi_lookup_iface(int handle);
 452 extern char *iscsi_get_port_speed_name(struct Scsi_Host *shost);
 453 extern char *iscsi_get_port_state_name(struct Scsi_Host *shost);
 454 extern int iscsi_is_session_dev(const struct device *dev);
 455
 456 extern char *iscsi_get_discovery_parent_name(int parent_type);
 457 extern struct device *
 458 iscsi_find_flashnode(struct Scsi_Host *shost, void *data,
 459                      int (*fn)(struct device *dev, void *data));
 460
 461 extern struct iscsi_bus_flash_session *
 462 iscsi_create_flashnode_sess(struct Scsi_Host *shost, int index,
 463                             struct iscsi_transport *transport, int dd_size);
 464
 465 extern struct iscsi_bus_flash_conn *
 466 iscsi_create_flashnode_conn(struct Scsi_Host *shost,
 467                             struct iscsi_bus_flash_session *fnode_sess,
 468                             struct iscsi_transport *transport, int dd_size);
 469
 470 extern void
 471 iscsi_destroy_flashnode_sess(struct iscsi_bus_flash_session *fnode_sess);
 472
 473 extern void iscsi_destroy_all_flashnode(struct Scsi_Host *shost);
 474 extern int iscsi_flashnode_bus_match(struct device *dev,
 475                                      struct device_driver *drv);
 476 extern struct device *
 477 iscsi_find_flashnode_sess(struct Scsi_Host *shost, void *data,
 478                           int (*fn)(struct device *dev, void *data));
 479 extern struct device *
 480 iscsi_find_flashnode_conn(struct iscsi_bus_flash_session *fnode_sess);
 481
 482 extern char *
 483 iscsi_get_ipaddress_state_name(enum iscsi_ipaddress_state port_state);
 484 extern char *iscsi_get_router_state_name(enum iscsi_router_state router_state);
 485 #endif