libiscsi.h 9.2 KB

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