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