scsi_transport_iscsi.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321
  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. #include <linux/device.h>
  26. #include <linux/list.h>
  27. #include <linux/mutex.h>
  28. #include <scsi/iscsi_if.h>
  29. struct scsi_transport_template;
  30. struct iscsi_transport;
  31. struct iscsi_endpoint;
  32. struct Scsi_Host;
  33. struct scsi_cmnd;
  34. struct iscsi_cls_conn;
  35. struct iscsi_conn;
  36. struct iscsi_task;
  37. struct sockaddr;
  38. struct iscsi_iface;
  39. struct bsg_job;
  40. /**
  41. * struct iscsi_transport - iSCSI Transport template
  42. *
  43. * @name: transport name
  44. * @caps: iSCSI Data-Path capabilities
  45. * @create_session: create new iSCSI session object
  46. * @destroy_session: destroy existing iSCSI session object
  47. * @create_conn: create new iSCSI connection
  48. * @bind_conn: associate this connection with existing iSCSI session
  49. * and specified transport descriptor
  50. * @destroy_conn: destroy inactive iSCSI connection
  51. * @set_param: set iSCSI parameter. Return 0 on success, -ENODATA
  52. * when param is not supported, and a -Exx value on other
  53. * error.
  54. * @get_param get iSCSI parameter. Must return number of bytes
  55. * copied to buffer on success, -ENODATA when param
  56. * is not supported, and a -Exx value on other error
  57. * @start_conn: set connection to be operational
  58. * @stop_conn: suspend/recover/terminate connection
  59. * @send_pdu: send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text.
  60. * @session_recovery_timedout: notify LLD a block during recovery timed out
  61. * @init_task: Initialize a iscsi_task and any internal structs.
  62. * When offloading the data path, this is called from
  63. * queuecommand with the session lock, or from the
  64. * iscsi_conn_send_pdu context with the session lock.
  65. * When not offloading the data path, this is called
  66. * from the scsi work queue without the session lock.
  67. * @xmit_task Requests LLD to transfer cmd task. Returns 0 or the
  68. * the number of bytes transferred on success, and -Exyz
  69. * value on error. When offloading the data path, this
  70. * is called from queuecommand with the session lock, or
  71. * from the iscsi_conn_send_pdu context with the session
  72. * lock. When not offloading the data path, this is called
  73. * from the scsi work queue without the session lock.
  74. * @cleanup_task: requests LLD to fail task. Called with session lock
  75. * and after the connection has been suspended and
  76. * terminated during recovery. If called
  77. * from abort task then connection is not suspended
  78. * or terminated but sk_callback_lock is held
  79. *
  80. * Template API provided by iSCSI Transport
  81. */
  82. struct iscsi_transport {
  83. struct module *owner;
  84. char *name;
  85. unsigned int caps;
  86. struct iscsi_cls_session *(*create_session) (struct iscsi_endpoint *ep,
  87. uint16_t cmds_max, uint16_t qdepth,
  88. uint32_t sn);
  89. void (*destroy_session) (struct iscsi_cls_session *session);
  90. struct iscsi_cls_conn *(*create_conn) (struct iscsi_cls_session *sess,
  91. uint32_t cid);
  92. int (*bind_conn) (struct iscsi_cls_session *session,
  93. struct iscsi_cls_conn *cls_conn,
  94. uint64_t transport_eph, int is_leading);
  95. int (*start_conn) (struct iscsi_cls_conn *conn);
  96. void (*stop_conn) (struct iscsi_cls_conn *conn, int flag);
  97. void (*destroy_conn) (struct iscsi_cls_conn *conn);
  98. int (*set_param) (struct iscsi_cls_conn *conn, enum iscsi_param param,
  99. char *buf, int buflen);
  100. int (*get_ep_param) (struct iscsi_endpoint *ep, enum iscsi_param param,
  101. char *buf);
  102. int (*get_conn_param) (struct iscsi_cls_conn *conn,
  103. enum iscsi_param param, char *buf);
  104. int (*get_session_param) (struct iscsi_cls_session *session,
  105. enum iscsi_param param, char *buf);
  106. int (*get_host_param) (struct Scsi_Host *shost,
  107. enum iscsi_host_param param, char *buf);
  108. int (*set_host_param) (struct Scsi_Host *shost,
  109. enum iscsi_host_param param, char *buf,
  110. int buflen);
  111. int (*send_pdu) (struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
  112. char *data, uint32_t data_size);
  113. void (*get_stats) (struct iscsi_cls_conn *conn,
  114. struct iscsi_stats *stats);
  115. int (*init_task) (struct iscsi_task *task);
  116. int (*xmit_task) (struct iscsi_task *task);
  117. void (*cleanup_task) (struct iscsi_task *task);
  118. int (*alloc_pdu) (struct iscsi_task *task, uint8_t opcode);
  119. int (*xmit_pdu) (struct iscsi_task *task);
  120. int (*init_pdu) (struct iscsi_task *task, unsigned int offset,
  121. unsigned int count);
  122. void (*parse_pdu_itt) (struct iscsi_conn *conn, itt_t itt,
  123. int *index, int *age);
  124. void (*session_recovery_timedout) (struct iscsi_cls_session *session);
  125. struct iscsi_endpoint *(*ep_connect) (struct Scsi_Host *shost,
  126. struct sockaddr *dst_addr,
  127. int non_blocking);
  128. int (*ep_poll) (struct iscsi_endpoint *ep, int timeout_ms);
  129. void (*ep_disconnect) (struct iscsi_endpoint *ep);
  130. int (*tgt_dscvr) (struct Scsi_Host *shost, enum iscsi_tgt_dscvr type,
  131. uint32_t enable, struct sockaddr *dst_addr);
  132. int (*set_path) (struct Scsi_Host *shost, struct iscsi_path *params);
  133. int (*set_iface_param) (struct Scsi_Host *shost, void *data,
  134. uint32_t len);
  135. int (*get_iface_param) (struct iscsi_iface *iface,
  136. enum iscsi_param_type param_type,
  137. int param, char *buf);
  138. umode_t (*attr_is_visible)(int param_type, int param);
  139. int (*bsg_request)(struct bsg_job *job);
  140. };
  141. /*
  142. * transport registration upcalls
  143. */
  144. extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt);
  145. extern int iscsi_unregister_transport(struct iscsi_transport *tt);
  146. /*
  147. * control plane upcalls
  148. */
  149. extern void iscsi_conn_error_event(struct iscsi_cls_conn *conn,
  150. enum iscsi_err error);
  151. extern void iscsi_conn_login_event(struct iscsi_cls_conn *conn,
  152. enum iscsi_conn_state state);
  153. extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
  154. char *data, uint32_t data_size);
  155. extern int iscsi_offload_mesg(struct Scsi_Host *shost,
  156. struct iscsi_transport *transport, uint32_t type,
  157. char *data, uint16_t data_size);
  158. extern void iscsi_post_host_event(uint32_t host_no,
  159. struct iscsi_transport *transport,
  160. enum iscsi_host_event_code code,
  161. uint32_t data_size,
  162. uint8_t *data);
  163. struct iscsi_cls_conn {
  164. struct list_head conn_list; /* item in connlist */
  165. void *dd_data; /* LLD private data */
  166. struct iscsi_transport *transport;
  167. uint32_t cid; /* connection id */
  168. struct mutex ep_mutex;
  169. struct iscsi_endpoint *ep;
  170. struct device dev; /* sysfs transport/container device */
  171. };
  172. #define iscsi_dev_to_conn(_dev) \
  173. container_of(_dev, struct iscsi_cls_conn, dev)
  174. #define transport_class_to_conn(_cdev) \
  175. iscsi_dev_to_conn(_cdev->parent)
  176. #define iscsi_conn_to_session(_conn) \
  177. iscsi_dev_to_session(_conn->dev.parent)
  178. /* iscsi class session state */
  179. enum {
  180. ISCSI_SESSION_LOGGED_IN,
  181. ISCSI_SESSION_FAILED,
  182. ISCSI_SESSION_FREE,
  183. };
  184. #define ISCSI_MAX_TARGET -1
  185. struct iscsi_cls_session {
  186. struct list_head sess_list; /* item in session_list */
  187. struct iscsi_transport *transport;
  188. spinlock_t lock;
  189. struct work_struct block_work;
  190. struct work_struct unblock_work;
  191. struct work_struct scan_work;
  192. struct work_struct unbind_work;
  193. /* recovery fields */
  194. int recovery_tmo;
  195. struct delayed_work recovery_work;
  196. unsigned int target_id;
  197. bool ida_used;
  198. /*
  199. * pid of userspace process that created session or -1 if
  200. * created by the kernel.
  201. */
  202. pid_t creator;
  203. int state;
  204. int sid; /* session id */
  205. void *dd_data; /* LLD private data */
  206. struct device dev; /* sysfs transport/container device */
  207. };
  208. #define iscsi_dev_to_session(_dev) \
  209. container_of(_dev, struct iscsi_cls_session, dev)
  210. #define transport_class_to_session(_cdev) \
  211. iscsi_dev_to_session(_cdev->parent)
  212. #define iscsi_session_to_shost(_session) \
  213. dev_to_shost(_session->dev.parent)
  214. #define starget_to_session(_stgt) \
  215. iscsi_dev_to_session(_stgt->dev.parent)
  216. struct iscsi_cls_host {
  217. atomic_t nr_scans;
  218. struct mutex mutex;
  219. struct request_queue *bsg_q;
  220. uint32_t port_speed;
  221. uint32_t port_state;
  222. };
  223. #define iscsi_job_to_shost(_job) \
  224. dev_to_shost(_job->dev)
  225. extern void iscsi_host_for_each_session(struct Scsi_Host *shost,
  226. void (*fn)(struct iscsi_cls_session *));
  227. struct iscsi_endpoint {
  228. void *dd_data; /* LLD private data */
  229. struct device dev;
  230. uint64_t id;
  231. struct iscsi_cls_conn *conn;
  232. };
  233. struct iscsi_iface {
  234. struct device dev;
  235. struct iscsi_transport *transport;
  236. uint32_t iface_type; /* IPv4 or IPv6 */
  237. uint32_t iface_num; /* iface number, 0 - n */
  238. void *dd_data; /* LLD private data */
  239. };
  240. #define iscsi_dev_to_iface(_dev) \
  241. container_of(_dev, struct iscsi_iface, dev)
  242. #define iscsi_iface_to_shost(_iface) \
  243. dev_to_shost(_iface->dev.parent)
  244. /*
  245. * session and connection functions that can be used by HW iSCSI LLDs
  246. */
  247. #define iscsi_cls_session_printk(prefix, _cls_session, fmt, a...) \
  248. dev_printk(prefix, &(_cls_session)->dev, fmt, ##a)
  249. #define iscsi_cls_conn_printk(prefix, _cls_conn, fmt, a...) \
  250. dev_printk(prefix, &(_cls_conn)->dev, fmt, ##a)
  251. extern int iscsi_session_chkready(struct iscsi_cls_session *session);
  252. extern int iscsi_is_session_online(struct iscsi_cls_session *session);
  253. extern struct iscsi_cls_session *iscsi_alloc_session(struct Scsi_Host *shost,
  254. struct iscsi_transport *transport, int dd_size);
  255. extern int iscsi_add_session(struct iscsi_cls_session *session,
  256. unsigned int target_id);
  257. extern int iscsi_session_event(struct iscsi_cls_session *session,
  258. enum iscsi_uevent_e event);
  259. extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost,
  260. struct iscsi_transport *t,
  261. int dd_size,
  262. unsigned int target_id);
  263. extern void iscsi_remove_session(struct iscsi_cls_session *session);
  264. extern void iscsi_free_session(struct iscsi_cls_session *session);
  265. extern int iscsi_destroy_session(struct iscsi_cls_session *session);
  266. extern struct iscsi_cls_conn *iscsi_create_conn(struct iscsi_cls_session *sess,
  267. int dd_size, uint32_t cid);
  268. extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn);
  269. extern void iscsi_unblock_session(struct iscsi_cls_session *session);
  270. extern void iscsi_block_session(struct iscsi_cls_session *session);
  271. extern int iscsi_scan_finished(struct Scsi_Host *shost, unsigned long time);
  272. extern struct iscsi_endpoint *iscsi_create_endpoint(int dd_size);
  273. extern void iscsi_destroy_endpoint(struct iscsi_endpoint *ep);
  274. extern struct iscsi_endpoint *iscsi_lookup_endpoint(u64 handle);
  275. extern int iscsi_block_scsi_eh(struct scsi_cmnd *cmd);
  276. extern struct iscsi_iface *iscsi_create_iface(struct Scsi_Host *shost,
  277. struct iscsi_transport *t,
  278. uint32_t iface_type,
  279. uint32_t iface_num, int dd_size);
  280. extern void iscsi_destroy_iface(struct iscsi_iface *iface);
  281. extern struct iscsi_iface *iscsi_lookup_iface(int handle);
  282. extern char *iscsi_get_port_speed_name(struct Scsi_Host *shost);
  283. extern char *iscsi_get_port_state_name(struct Scsi_Host *shost);
  284. #endif