scsi_transport_iscsi.h 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224
  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 <scsi/iscsi_if.h>
  27. struct scsi_transport_template;
  28. struct iscsi_transport;
  29. struct Scsi_Host;
  30. struct iscsi_cls_conn;
  31. struct iscsi_conn;
  32. struct iscsi_cmd_task;
  33. struct iscsi_mgmt_task;
  34. struct sockaddr;
  35. /**
  36. * struct iscsi_transport - iSCSI Transport template
  37. *
  38. * @name: transport name
  39. * @caps: iSCSI Data-Path capabilities
  40. * @create_session: create new iSCSI session object
  41. * @destroy_session: destroy existing iSCSI session object
  42. * @create_conn: create new iSCSI connection
  43. * @bind_conn: associate this connection with existing iSCSI session
  44. * and specified transport descriptor
  45. * @destroy_conn: destroy inactive iSCSI connection
  46. * @set_param: set iSCSI parameter. Return 0 on success, -ENODATA
  47. * when param is not supported, and a -Exx value on other
  48. * error.
  49. * @get_param get iSCSI parameter. Must return number of bytes
  50. * copied to buffer on success, -ENODATA when param
  51. * is not supported, and a -Exx value on other error
  52. * @start_conn: set connection to be operational
  53. * @stop_conn: suspend/recover/terminate connection
  54. * @send_pdu: send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text.
  55. * @session_recovery_timedout: notify LLD a block during recovery timed out
  56. * @init_cmd_task: Initialize a iscsi_cmd_task and any internal structs.
  57. * Called from queuecommand with session lock held.
  58. * @init_mgmt_task: Initialize a iscsi_mgmt_task and any internal structs.
  59. * Called from iscsi_conn_send_generic with xmitmutex.
  60. * @xmit_cmd_task: Requests LLD to transfer cmd task. Returns 0 or the
  61. * the number of bytes transferred on success, and -Exyz
  62. * value on error.
  63. * @xmit_mgmt_task: Requests LLD to transfer mgmt task. Returns 0 or the
  64. * the number of bytes transferred on success, and -Exyz
  65. * value on error.
  66. * @cleanup_cmd_task: requests LLD to fail cmd task. Called with xmitmutex
  67. * and session->lock after the connection has been
  68. * suspended and terminated during recovery. If called
  69. * from abort task then connection is not suspended
  70. * or terminated but sk_callback_lock is held
  71. *
  72. * Template API provided by iSCSI Transport
  73. */
  74. struct iscsi_transport {
  75. struct module *owner;
  76. char *name;
  77. unsigned int caps;
  78. /* LLD sets this to indicate what values it can export to sysfs */
  79. unsigned int param_mask;
  80. struct scsi_host_template *host_template;
  81. /* LLD connection data size */
  82. int conndata_size;
  83. /* LLD session data size */
  84. int sessiondata_size;
  85. int max_lun;
  86. unsigned int max_conn;
  87. unsigned int max_cmd_len;
  88. struct iscsi_cls_session *(*create_session) (struct iscsi_transport *it,
  89. struct scsi_transport_template *t, uint32_t sn, uint32_t *hn);
  90. void (*destroy_session) (struct iscsi_cls_session *session);
  91. struct iscsi_cls_conn *(*create_conn) (struct iscsi_cls_session *sess,
  92. uint32_t cid);
  93. int (*bind_conn) (struct iscsi_cls_session *session,
  94. struct iscsi_cls_conn *cls_conn,
  95. uint64_t transport_eph, int is_leading);
  96. int (*start_conn) (struct iscsi_cls_conn *conn);
  97. void (*stop_conn) (struct iscsi_cls_conn *conn, int flag);
  98. void (*destroy_conn) (struct iscsi_cls_conn *conn);
  99. int (*set_param) (struct iscsi_cls_conn *conn, enum iscsi_param param,
  100. char *buf, int buflen);
  101. int (*get_conn_param) (struct iscsi_cls_conn *conn,
  102. enum iscsi_param param, char *buf);
  103. int (*get_session_param) (struct iscsi_cls_session *session,
  104. enum iscsi_param param, char *buf);
  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. void (*init_cmd_task) (struct iscsi_cmd_task *ctask);
  110. void (*init_mgmt_task) (struct iscsi_conn *conn,
  111. struct iscsi_mgmt_task *mtask,
  112. char *data, uint32_t data_size);
  113. int (*xmit_cmd_task) (struct iscsi_conn *conn,
  114. struct iscsi_cmd_task *ctask);
  115. void (*cleanup_cmd_task) (struct iscsi_conn *conn,
  116. struct iscsi_cmd_task *ctask);
  117. int (*xmit_mgmt_task) (struct iscsi_conn *conn,
  118. struct iscsi_mgmt_task *mtask);
  119. void (*session_recovery_timedout) (struct iscsi_cls_session *session);
  120. int (*ep_connect) (struct sockaddr *dst_addr, int non_blocking,
  121. uint64_t *ep_handle);
  122. int (*ep_poll) (uint64_t ep_handle, int timeout_ms);
  123. void (*ep_disconnect) (uint64_t ep_handle);
  124. int (*tgt_dscvr) (enum iscsi_tgt_dscvr type, uint32_t host_no,
  125. uint32_t enable, struct sockaddr *dst_addr);
  126. };
  127. /*
  128. * transport registration upcalls
  129. */
  130. extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt);
  131. extern int iscsi_unregister_transport(struct iscsi_transport *tt);
  132. /*
  133. * control plane upcalls
  134. */
  135. extern void iscsi_conn_error(struct iscsi_cls_conn *conn, enum iscsi_err error);
  136. extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr,
  137. char *data, uint32_t data_size);
  138. /* Connection's states */
  139. #define ISCSI_CONN_INITIAL_STAGE 0
  140. #define ISCSI_CONN_STARTED 1
  141. #define ISCSI_CONN_STOPPED 2
  142. #define ISCSI_CONN_CLEANUP_WAIT 3
  143. struct iscsi_cls_conn {
  144. struct list_head conn_list; /* item in connlist */
  145. void *dd_data; /* LLD private data */
  146. struct iscsi_transport *transport;
  147. uint32_t cid; /* connection id */
  148. int active; /* must be accessed with the connlock */
  149. struct device dev; /* sysfs transport/container device */
  150. };
  151. #define iscsi_dev_to_conn(_dev) \
  152. container_of(_dev, struct iscsi_cls_conn, dev)
  153. /* Session's states */
  154. #define ISCSI_STATE_FREE 1
  155. #define ISCSI_STATE_LOGGED_IN 2
  156. #define ISCSI_STATE_FAILED 3
  157. #define ISCSI_STATE_TERMINATE 4
  158. #define ISCSI_STATE_IN_RECOVERY 5
  159. #define ISCSI_STATE_RECOVERY_FAILED 6
  160. struct iscsi_cls_session {
  161. struct list_head sess_list; /* item in session_list */
  162. struct list_head host_list;
  163. struct iscsi_transport *transport;
  164. /* recovery fields */
  165. int recovery_tmo;
  166. struct delayed_work recovery_work;
  167. int target_id;
  168. int sid; /* session id */
  169. void *dd_data; /* LLD private data */
  170. struct device dev; /* sysfs transport/container device */
  171. };
  172. #define iscsi_dev_to_session(_dev) \
  173. container_of(_dev, struct iscsi_cls_session, dev)
  174. #define iscsi_session_to_shost(_session) \
  175. dev_to_shost(_session->dev.parent)
  176. #define starget_to_session(_stgt) \
  177. iscsi_dev_to_session(_stgt->dev.parent)
  178. struct iscsi_host {
  179. struct list_head sessions;
  180. struct mutex mutex;
  181. };
  182. /*
  183. * session and connection functions that can be used by HW iSCSI LLDs
  184. */
  185. extern struct iscsi_cls_session *iscsi_alloc_session(struct Scsi_Host *shost,
  186. struct iscsi_transport *transport);
  187. extern int iscsi_add_session(struct iscsi_cls_session *session,
  188. unsigned int target_id);
  189. extern int iscsi_if_create_session_done(struct iscsi_cls_conn *conn);
  190. extern int iscsi_if_destroy_session_done(struct iscsi_cls_conn *conn);
  191. extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost,
  192. struct iscsi_transport *t,
  193. unsigned int target_id);
  194. extern void iscsi_remove_session(struct iscsi_cls_session *session);
  195. extern void iscsi_free_session(struct iscsi_cls_session *session);
  196. extern int iscsi_destroy_session(struct iscsi_cls_session *session);
  197. extern struct iscsi_cls_conn *iscsi_create_conn(struct iscsi_cls_session *sess,
  198. uint32_t cid);
  199. extern int iscsi_destroy_conn(struct iscsi_cls_conn *conn);
  200. extern void iscsi_unblock_session(struct iscsi_cls_session *session);
  201. extern void iscsi_block_session(struct iscsi_cls_session *session);
  202. #endif