iscsi_if.h 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335
  1. /*
  2. * iSCSI User/Kernel Shares (Defines, Constants, Protocol definitions, etc)
  3. *
  4. * Copyright (C) 2005 Dmitry Yusupov
  5. * Copyright (C) 2005 Alex Aizman
  6. * maintained by open-iscsi@googlegroups.com
  7. *
  8. * This program is free software; you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License as published
  10. * by the Free Software Foundation; either version 2 of the License, or
  11. * (at your option) any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful, but
  14. * WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  16. * General Public License for more details.
  17. *
  18. * See the file COPYING included with this distribution for more details.
  19. */
  20. #ifndef ISCSI_IF_H
  21. #define ISCSI_IF_H
  22. #include <scsi/iscsi_proto.h>
  23. #define UEVENT_BASE 10
  24. #define KEVENT_BASE 100
  25. #define ISCSI_ERR_BASE 1000
  26. enum iscsi_uevent_e {
  27. ISCSI_UEVENT_UNKNOWN = 0,
  28. /* down events */
  29. ISCSI_UEVENT_CREATE_SESSION = UEVENT_BASE + 1,
  30. ISCSI_UEVENT_DESTROY_SESSION = UEVENT_BASE + 2,
  31. ISCSI_UEVENT_CREATE_CONN = UEVENT_BASE + 3,
  32. ISCSI_UEVENT_DESTROY_CONN = UEVENT_BASE + 4,
  33. ISCSI_UEVENT_BIND_CONN = UEVENT_BASE + 5,
  34. ISCSI_UEVENT_SET_PARAM = UEVENT_BASE + 6,
  35. ISCSI_UEVENT_START_CONN = UEVENT_BASE + 7,
  36. ISCSI_UEVENT_STOP_CONN = UEVENT_BASE + 8,
  37. ISCSI_UEVENT_SEND_PDU = UEVENT_BASE + 9,
  38. ISCSI_UEVENT_GET_STATS = UEVENT_BASE + 10,
  39. ISCSI_UEVENT_GET_PARAM = UEVENT_BASE + 11,
  40. ISCSI_UEVENT_TRANSPORT_EP_CONNECT = UEVENT_BASE + 12,
  41. ISCSI_UEVENT_TRANSPORT_EP_POLL = UEVENT_BASE + 13,
  42. ISCSI_UEVENT_TRANSPORT_EP_DISCONNECT = UEVENT_BASE + 14,
  43. ISCSI_UEVENT_TGT_DSCVR = UEVENT_BASE + 15,
  44. /* up events */
  45. ISCSI_KEVENT_RECV_PDU = KEVENT_BASE + 1,
  46. ISCSI_KEVENT_CONN_ERROR = KEVENT_BASE + 2,
  47. ISCSI_KEVENT_IF_ERROR = KEVENT_BASE + 3,
  48. ISCSI_KEVENT_DESTROY_SESSION = KEVENT_BASE + 4,
  49. };
  50. enum iscsi_tgt_dscvr {
  51. ISCSI_TGT_DSCVR_SEND_TARGETS = 1,
  52. ISCSI_TGT_DSCVR_ISNS = 2,
  53. ISCSI_TGT_DSCVR_SLP = 3,
  54. };
  55. struct iscsi_uevent {
  56. uint32_t type; /* k/u events type */
  57. uint32_t iferror; /* carries interface or resource errors */
  58. uint64_t transport_handle;
  59. union {
  60. /* messages u -> k */
  61. struct msg_create_session {
  62. uint32_t initial_cmdsn;
  63. } c_session;
  64. struct msg_destroy_session {
  65. uint32_t sid;
  66. } d_session;
  67. struct msg_create_conn {
  68. uint32_t sid;
  69. uint32_t cid;
  70. } c_conn;
  71. struct msg_bind_conn {
  72. uint32_t sid;
  73. uint32_t cid;
  74. uint64_t transport_eph;
  75. uint32_t is_leading;
  76. } b_conn;
  77. struct msg_destroy_conn {
  78. uint32_t sid;
  79. uint32_t cid;
  80. } d_conn;
  81. struct msg_send_pdu {
  82. uint32_t sid;
  83. uint32_t cid;
  84. uint32_t hdr_size;
  85. uint32_t data_size;
  86. } send_pdu;
  87. struct msg_set_param {
  88. uint32_t sid;
  89. uint32_t cid;
  90. uint32_t param; /* enum iscsi_param */
  91. uint32_t len;
  92. } set_param;
  93. struct msg_start_conn {
  94. uint32_t sid;
  95. uint32_t cid;
  96. } start_conn;
  97. struct msg_stop_conn {
  98. uint32_t sid;
  99. uint32_t cid;
  100. uint64_t conn_handle;
  101. uint32_t flag;
  102. } stop_conn;
  103. struct msg_get_stats {
  104. uint32_t sid;
  105. uint32_t cid;
  106. } get_stats;
  107. struct msg_transport_connect {
  108. uint32_t non_blocking;
  109. } ep_connect;
  110. struct msg_transport_poll {
  111. uint64_t ep_handle;
  112. uint32_t timeout_ms;
  113. } ep_poll;
  114. struct msg_transport_disconnect {
  115. uint64_t ep_handle;
  116. } ep_disconnect;
  117. struct msg_tgt_dscvr {
  118. enum iscsi_tgt_dscvr type;
  119. uint32_t host_no;
  120. /*
  121. * enable = 1 to establish a new connection
  122. * with the server. enable = 0 to disconnect
  123. * from the server. Used primarily to switch
  124. * from one iSNS server to another.
  125. */
  126. uint32_t enable;
  127. } tgt_dscvr;
  128. } u;
  129. union {
  130. /* messages k -> u */
  131. int retcode;
  132. struct msg_create_session_ret {
  133. uint32_t sid;
  134. uint32_t host_no;
  135. } c_session_ret;
  136. struct msg_create_conn_ret {
  137. uint32_t sid;
  138. uint32_t cid;
  139. } c_conn_ret;
  140. struct msg_recv_req {
  141. uint32_t sid;
  142. uint32_t cid;
  143. uint64_t recv_handle;
  144. } recv_req;
  145. struct msg_conn_error {
  146. uint32_t sid;
  147. uint32_t cid;
  148. uint32_t error; /* enum iscsi_err */
  149. } connerror;
  150. struct msg_session_destroyed {
  151. uint32_t host_no;
  152. uint32_t sid;
  153. } d_session;
  154. struct msg_transport_connect_ret {
  155. uint64_t handle;
  156. } ep_connect_ret;
  157. } r;
  158. } __attribute__ ((aligned (sizeof(uint64_t))));
  159. /*
  160. * Common error codes
  161. */
  162. enum iscsi_err {
  163. ISCSI_OK = 0,
  164. ISCSI_ERR_DATASN = ISCSI_ERR_BASE + 1,
  165. ISCSI_ERR_DATA_OFFSET = ISCSI_ERR_BASE + 2,
  166. ISCSI_ERR_MAX_CMDSN = ISCSI_ERR_BASE + 3,
  167. ISCSI_ERR_EXP_CMDSN = ISCSI_ERR_BASE + 4,
  168. ISCSI_ERR_BAD_OPCODE = ISCSI_ERR_BASE + 5,
  169. ISCSI_ERR_DATALEN = ISCSI_ERR_BASE + 6,
  170. ISCSI_ERR_AHSLEN = ISCSI_ERR_BASE + 7,
  171. ISCSI_ERR_PROTO = ISCSI_ERR_BASE + 8,
  172. ISCSI_ERR_LUN = ISCSI_ERR_BASE + 9,
  173. ISCSI_ERR_BAD_ITT = ISCSI_ERR_BASE + 10,
  174. ISCSI_ERR_CONN_FAILED = ISCSI_ERR_BASE + 11,
  175. ISCSI_ERR_R2TSN = ISCSI_ERR_BASE + 12,
  176. ISCSI_ERR_SESSION_FAILED = ISCSI_ERR_BASE + 13,
  177. ISCSI_ERR_HDR_DGST = ISCSI_ERR_BASE + 14,
  178. ISCSI_ERR_DATA_DGST = ISCSI_ERR_BASE + 15,
  179. ISCSI_ERR_PARAM_NOT_FOUND = ISCSI_ERR_BASE + 16,
  180. ISCSI_ERR_NO_SCSI_CMD = ISCSI_ERR_BASE + 17,
  181. };
  182. /*
  183. * iSCSI Parameters (RFC3720)
  184. */
  185. enum iscsi_param {
  186. /* passed in using netlink set param */
  187. ISCSI_PARAM_MAX_RECV_DLENGTH,
  188. ISCSI_PARAM_MAX_XMIT_DLENGTH,
  189. ISCSI_PARAM_HDRDGST_EN,
  190. ISCSI_PARAM_DATADGST_EN,
  191. ISCSI_PARAM_INITIAL_R2T_EN,
  192. ISCSI_PARAM_MAX_R2T,
  193. ISCSI_PARAM_IMM_DATA_EN,
  194. ISCSI_PARAM_FIRST_BURST,
  195. ISCSI_PARAM_MAX_BURST,
  196. ISCSI_PARAM_PDU_INORDER_EN,
  197. ISCSI_PARAM_DATASEQ_INORDER_EN,
  198. ISCSI_PARAM_ERL,
  199. ISCSI_PARAM_IFMARKER_EN,
  200. ISCSI_PARAM_OFMARKER_EN,
  201. ISCSI_PARAM_EXP_STATSN,
  202. ISCSI_PARAM_TARGET_NAME,
  203. ISCSI_PARAM_TPGT,
  204. ISCSI_PARAM_PERSISTENT_ADDRESS,
  205. ISCSI_PARAM_PERSISTENT_PORT,
  206. ISCSI_PARAM_SESS_RECOVERY_TMO,
  207. /* pased in through bind conn using transport_fd */
  208. ISCSI_PARAM_CONN_PORT,
  209. ISCSI_PARAM_CONN_ADDRESS,
  210. /* must always be last */
  211. ISCSI_PARAM_MAX,
  212. };
  213. #define ISCSI_MAX_RECV_DLENGTH (1 << ISCSI_PARAM_MAX_RECV_DLENGTH)
  214. #define ISCSI_MAX_XMIT_DLENGTH (1 << ISCSI_PARAM_MAX_XMIT_DLENGTH)
  215. #define ISCSI_HDRDGST_EN (1 << ISCSI_PARAM_HDRDGST_EN)
  216. #define ISCSI_DATADGST_EN (1 << ISCSI_PARAM_DATADGST_EN)
  217. #define ISCSI_INITIAL_R2T_EN (1 << ISCSI_PARAM_INITIAL_R2T_EN)
  218. #define ISCSI_MAX_R2T (1 << ISCSI_PARAM_MAX_R2T)
  219. #define ISCSI_IMM_DATA_EN (1 << ISCSI_PARAM_IMM_DATA_EN)
  220. #define ISCSI_FIRST_BURST (1 << ISCSI_PARAM_FIRST_BURST)
  221. #define ISCSI_MAX_BURST (1 << ISCSI_PARAM_MAX_BURST)
  222. #define ISCSI_PDU_INORDER_EN (1 << ISCSI_PARAM_PDU_INORDER_EN)
  223. #define ISCSI_DATASEQ_INORDER_EN (1 << ISCSI_PARAM_DATASEQ_INORDER_EN)
  224. #define ISCSI_ERL (1 << ISCSI_PARAM_ERL)
  225. #define ISCSI_IFMARKER_EN (1 << ISCSI_PARAM_IFMARKER_EN)
  226. #define ISCSI_OFMARKER_EN (1 << ISCSI_PARAM_OFMARKER_EN)
  227. #define ISCSI_EXP_STATSN (1 << ISCSI_PARAM_EXP_STATSN)
  228. #define ISCSI_TARGET_NAME (1 << ISCSI_PARAM_TARGET_NAME)
  229. #define ISCSI_TPGT (1 << ISCSI_PARAM_TPGT)
  230. #define ISCSI_PERSISTENT_ADDRESS (1 << ISCSI_PARAM_PERSISTENT_ADDRESS)
  231. #define ISCSI_PERSISTENT_PORT (1 << ISCSI_PARAM_PERSISTENT_PORT)
  232. #define ISCSI_SESS_RECOVERY_TMO (1 << ISCSI_PARAM_SESS_RECOVERY_TMO)
  233. #define ISCSI_CONN_PORT (1 << ISCSI_PARAM_CONN_PORT)
  234. #define ISCSI_CONN_ADDRESS (1 << ISCSI_PARAM_CONN_ADDRESS)
  235. #define iscsi_ptr(_handle) ((void*)(unsigned long)_handle)
  236. #define iscsi_handle(_ptr) ((uint64_t)(unsigned long)_ptr)
  237. #define hostdata_session(_hostdata) (iscsi_ptr(*(unsigned long *)_hostdata))
  238. /**
  239. * iscsi_hostdata - get LLD hostdata from scsi_host
  240. * @_hostdata: pointer to scsi host's hostdata
  241. **/
  242. #define iscsi_hostdata(_hostdata) ((void*)_hostdata + sizeof(unsigned long))
  243. /*
  244. * These flags presents iSCSI Data-Path capabilities.
  245. */
  246. #define CAP_RECOVERY_L0 0x1
  247. #define CAP_RECOVERY_L1 0x2
  248. #define CAP_RECOVERY_L2 0x4
  249. #define CAP_MULTI_R2T 0x8
  250. #define CAP_HDRDGST 0x10
  251. #define CAP_DATADGST 0x20
  252. #define CAP_MULTI_CONN 0x40
  253. #define CAP_TEXT_NEGO 0x80
  254. #define CAP_MARKERS 0x100
  255. /*
  256. * These flags describes reason of stop_conn() call
  257. */
  258. #define STOP_CONN_TERM 0x1
  259. #define STOP_CONN_SUSPEND 0x2
  260. #define STOP_CONN_RECOVER 0x3
  261. #define ISCSI_STATS_CUSTOM_MAX 32
  262. #define ISCSI_STATS_CUSTOM_DESC_MAX 64
  263. struct iscsi_stats_custom {
  264. char desc[ISCSI_STATS_CUSTOM_DESC_MAX];
  265. uint64_t value;
  266. };
  267. /*
  268. * struct iscsi_stats - iSCSI Statistics (iSCSI MIB)
  269. *
  270. * Note: this structure contains counters collected on per-connection basis.
  271. */
  272. struct iscsi_stats {
  273. /* octets */
  274. uint64_t txdata_octets;
  275. uint64_t rxdata_octets;
  276. /* xmit pdus */
  277. uint32_t noptx_pdus;
  278. uint32_t scsicmd_pdus;
  279. uint32_t tmfcmd_pdus;
  280. uint32_t login_pdus;
  281. uint32_t text_pdus;
  282. uint32_t dataout_pdus;
  283. uint32_t logout_pdus;
  284. uint32_t snack_pdus;
  285. /* recv pdus */
  286. uint32_t noprx_pdus;
  287. uint32_t scsirsp_pdus;
  288. uint32_t tmfrsp_pdus;
  289. uint32_t textrsp_pdus;
  290. uint32_t datain_pdus;
  291. uint32_t logoutrsp_pdus;
  292. uint32_t r2t_pdus;
  293. uint32_t async_pdus;
  294. uint32_t rjt_pdus;
  295. /* errors */
  296. uint32_t digest_err;
  297. uint32_t timeout_err;
  298. /*
  299. * iSCSI Custom Statistics support, i.e. Transport could
  300. * extend existing MIB statistics with its own specific statistics
  301. * up to ISCSI_STATS_CUSTOM_MAX
  302. */
  303. uint32_t custom_length;
  304. struct iscsi_stats_custom custom[0]
  305. __attribute__ ((aligned (sizeof(uint64_t))));
  306. };
  307. #endif